Mercurial > emacs
annotate lispref/edebug.texi @ 21811:180afb14ad52
(main): Fix bug report address.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Tue, 28 Apr 1998 21:33:28 +0000 |
parents | 90da2489c498 |
children | d4ac295a98b3 |
rev | line source |
---|---|
6558 | 1 @comment -*-texinfo-*- |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2 @c This is part of the GNU Emacs Lisp Reference Manual. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
3 @c Copyright (C) 1992, 1993, 1994, 1998 Free Software Foundation, Inc. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
4 @c See the file elisp.texi for copying conditions. |
6558 | 5 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
6 @c This file can also be used by an independent Edebug User |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
7 @c Manual in which case the Edebug node below should be used |
6558 | 8 @c with the following links to the Bugs section and to the top level: |
9 | |
10 @c , Bugs and Todo List, Top, Top | |
11 | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
12 @node Edebug,, Compilation Errors, Debugging |
6558 | 13 @section Edebug |
14 @cindex Edebug mode | |
15 | |
16 @cindex Edebug | |
17 Edebug is a source-level debugger for Emacs Lisp programs with which | |
18 you can: | |
19 | |
20 @itemize @bullet | |
21 @item | |
22 Step through evaluation, stopping before and after each expression. | |
23 | |
24 @item | |
25 Set conditional or unconditional breakpoints. | |
26 | |
27 @item | |
28 Stop when a specified condition is true (the global break event). | |
29 | |
30 @item | |
31 Trace slow or fast, stopping briefly at each stop point, or | |
32 at each breakpoint. | |
33 | |
34 @item | |
35 Display expression results and evaluate expressions as if outside of | |
36 Edebug. | |
37 | |
38 @item | |
39 Automatically reevaluate a list of expressions and | |
40 display their results each time Edebug updates the display. | |
41 | |
42 @item | |
43 Output trace info on function enter and exit. | |
44 | |
45 @item | |
46 Stop when an error occurs. | |
47 | |
48 @item | |
49 Display a backtrace, omitting Edebug's own frames. | |
50 | |
51 @item | |
52 Specify argument evaluation for macros and defining forms. | |
53 | |
54 @item | |
55 Obtain rudimentary coverage testing and frequency counts. | |
56 @end itemize | |
57 | |
58 The first three sections below should tell you enough about Edebug to | |
59 enable you to use it. | |
60 | |
61 @menu | |
62 * Using Edebug:: Introduction to use of Edebug. | |
63 * Instrumenting:: You must instrument your code | |
64 in order to debug it with Edebug. | |
65 * Modes: Edebug Execution Modes. Execution modes, stopping more or less often. | |
66 * Jumping:: Commands to jump to a specified place. | |
67 * Misc: Edebug Misc. Miscellaneous commands. | |
68 * Breakpoints:: Setting breakpoints to make the program stop. | |
69 * Trapping Errors:: trapping errors with Edebug. | |
70 * Views: Edebug Views. Views inside and outside of Edebug. | |
71 * Eval: Edebug Eval. Evaluating expressions within Edebug. | |
72 * Eval List:: Expressions whose values are displayed | |
73 each time you enter Edebug. | |
74 * Printing in Edebug:: Customization of printing. | |
75 * Trace Buffer:: How to produce trace output in a buffer. | |
76 * Coverage Testing:: How to test evaluation coverage. | |
77 * The Outside Context:: Data that Edebug saves and restores. | |
78 * Instrumenting Macro Calls:: Specifying how to handle macro calls. | |
79 * Options: Edebug Options. Option variables for customizing Edebug. | |
80 @end menu | |
81 | |
82 @node Using Edebug | |
83 @subsection Using Edebug | |
84 | |
85 To debug a Lisp program with Edebug, you must first @dfn{instrument} | |
86 the Lisp code that you want to debug. A simple way to do this is to | |
87 first move point into the definition of a function or macro and then do | |
88 @kbd{C-u C-M-x} (@code{eval-defun} with a prefix argument). See | |
89 @ref{Instrumenting}, for alternative ways to instrument code. | |
90 | |
91 Once a function is instrumented, any call to the function activates | |
92 Edebug. Activating Edebug may stop execution and let you step through | |
93 the function, or it may update the display and continue execution while | |
94 checking for debugging commands, depending on which Edebug execution | |
95 mode you have selected. The default execution mode is step, which does | |
96 stop execution. @xref{Edebug Execution Modes}. | |
97 | |
98 Within Edebug, you normally view an Emacs buffer showing the source of | |
99 the Lisp code you are debugging. This is referred to as the @dfn{source | |
100 code buffer}. This buffer is temporarily read-only. | |
101 | |
102 An arrow at the left margin indicates the line where the function is | |
103 executing. Point initially shows where within the line the function is | |
104 executing, but this ceases to be true if you move point yourself. | |
105 | |
106 If you instrument the definition of @code{fac} (shown below) and then | |
107 execute @code{(fac 3)}, here is what you normally see. Point is at the | |
108 open-parenthesis before @code{if}. | |
109 | |
110 @example | |
111 (defun fac (n) | |
112 =>@point{}(if (< 0 n) | |
113 (* n (fac (1- n))) | |
114 1)) | |
115 @end example | |
116 | |
117 @cindex stop points | |
118 The places within a function where Edebug can stop execution are called | |
119 @dfn{stop points}. These occur both before and after each subexpression | |
120 that is a list, and also after each variable reference. | |
121 Here we show with periods the stop points found in the function | |
122 @code{fac}: | |
123 | |
124 @example | |
125 (defun fac (n) | |
126 .(if .(< 0 n.). | |
127 .(* n. .(fac (1- n.).).). | |
128 1).) | |
129 @end example | |
130 | |
131 The special commands of Edebug are available in the source code buffer | |
132 in addition to the commands of Emacs Lisp mode. For example, you can | |
133 type the Edebug command @key{SPC} to execute until the next stop point. | |
134 If you type @key{SPC} once after entry to @code{fac}, here is the | |
135 display you will see: | |
136 | |
137 @example | |
138 (defun fac (n) | |
139 =>(if @point{}(< 0 n) | |
140 (* n (fac (1- n))) | |
141 1)) | |
142 @end example | |
143 | |
144 When Edebug stops execution after an expression, it displays the | |
145 expression's value in the echo area. | |
146 | |
147 Other frequently used commands are @kbd{b} to set a breakpoint at a stop | |
148 point, @kbd{g} to execute until a breakpoint is reached, and @kbd{q} to | |
149 exit Edebug and return to the top-level command loop. Type @kbd{?} to | |
150 display a list of all Edebug commands. | |
151 | |
152 @node Instrumenting | |
153 @subsection Instrumenting for Edebug | |
154 | |
155 In order to use Edebug to debug Lisp code, you must first | |
156 @dfn{instrument} the code. Instrumenting code inserts additional code | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
157 into it, to invoke Edebug at the proper places. |
6558 | 158 |
159 @kindex C-M-x | |
160 @findex eval-defun (Edebug) | |
161 Once you have loaded Edebug, the command @kbd{C-M-x} | |
162 (@code{eval-defun}) is redefined so that when invoked with a prefix | |
163 argument on a definition, it instruments the definition before | |
164 evaluating it. (The source code itself is not modified.) If the | |
165 variable @code{edebug-all-defs} is non-@code{nil}, that inverts the | |
166 meaning of the prefix argument: then @kbd{C-M-x} instruments the | |
167 definition @emph{unless} it has a prefix argument. The default value of | |
168 @code{edebug-all-defs} is @code{nil}. The command @kbd{M-x | |
169 edebug-all-defs} toggles the value of the variable | |
170 @code{edebug-all-defs}. | |
171 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
172 @findex eval-region @r{(Edebug)} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
173 @findex eval-current-buffer @r{(Edebug)} |
6558 | 174 If @code{edebug-all-defs} is non-@code{nil}, then the commands |
175 @code{eval-region}, @code{eval-current-buffer}, and @code{eval-buffer} | |
176 also instrument any definitions they evaluate. Similarly, | |
177 @code{edebug-all-forms} controls whether @code{eval-region} should | |
178 instrument @emph{any} form, even non-defining forms. This doesn't apply | |
179 to loading or evaluations in the minibuffer. The command @kbd{M-x | |
180 edebug-all-forms} toggles this option. | |
181 | |
182 @findex edebug-eval-top-level-form | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
183 Another command, @kbd{M-x edebug-eval-top-level-form}, is available to |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
184 instrument any top-level form regardless of the values of |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
185 @code{edebug-all-defs} and @code{edebug-all-forms}. |
6558 | 186 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
187 While Edebug is active, the command @kbd{I} |
6558 | 188 (@code{edebug-instrument-callee}) instruments the definition of the |
189 function or macro called by the list form after point, if is not already | |
190 instrumented. This is possible only if Edebug knows where to find the | |
191 source for that function; after loading Edebug, @code{eval-region} | |
192 records the position of every definition it evaluates, even if not | |
193 instrumenting it. See also the @kbd{i} command (@pxref{Jumping}), which | |
194 steps into the call after instrumenting the function. | |
195 | |
196 @cindex special forms (Edebug) | |
197 @cindex interactive commands (Edebug) | |
198 @cindex anonymous lambda expressions (Edebug) | |
199 @cindex Common Lisp (Edebug) | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
200 @pindex cl.el @r{(Edebug)} |
6558 | 201 @pindex cl-specs.el |
202 Edebug knows how to instrument all the standard special forms, an | |
203 interactive form with an expression argument, anonymous lambda | |
204 expressions, and other defining forms. Edebug cannot know what a | |
205 user-defined macro will do with the arguments of a macro call, so you | |
206 must tell it; @xref{Instrumenting Macro Calls}, for details. | |
207 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
208 When Edebug is about to instrument code for the first time in a |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
209 session, it runs the hook @code{edebug-setup-hook}, then sets it to |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
210 @code{nil}. You can use this to arrange to load Edebug specifications |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
211 (@pxref{Instrumenting Macro Calls}) associated with a package you are |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
212 using, but actually load them only if you use Edebug. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
213 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
214 @findex eval-expression @r{(Edebug)} |
6558 | 215 To remove instrumentation from a definition, simply reevaluate its |
216 definition in a way that does not instrument. There are two ways of | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
217 evaluating forms that never instrument them: from a file with |
6558 | 218 @code{load}, and from the minibuffer with @code{eval-expression} |
12098 | 219 (@kbd{M-:}). |
6558 | 220 |
221 If Edebug detects a syntax error while instrumenting, it leaves point | |
222 at the erroneous code and signals an @code{invalid-read-syntax} error. | |
223 | |
224 @xref{Edebug Eval}, for other evaluation functions available | |
225 inside of Edebug. | |
226 | |
227 @node Edebug Execution Modes | |
228 @subsection Edebug Execution Modes | |
229 | |
230 @cindex Edebug execution modes | |
231 Edebug supports several execution modes for running the program you are | |
232 debugging. We call these alternatives @dfn{Edebug execution modes}; do | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
233 not confuse them with major or minor modes. The current Edebug execution mode |
6558 | 234 determines how far Edebug continues execution before stopping---whether |
235 it stops at each stop point, or continues to the next breakpoint, for | |
236 example---and how much Edebug displays the progress of the evaluation | |
237 before it stops. | |
238 | |
239 Normally, you specify the Edebug execution mode by typing a command to | |
240 continue the program in a certain mode. Here is a table of these | |
241 commands. All except for @kbd{S} resume execution of the program, at | |
242 least for a certain distance. | |
243 | |
244 @table @kbd | |
245 @item S | |
246 Stop: don't execute any more of the program for now, just wait for more | |
247 Edebug commands (@code{edebug-stop}). | |
248 | |
249 @item @key{SPC} | |
250 Step: stop at the next stop point encountered (@code{edebug-step-mode}). | |
251 | |
252 @item n | |
253 Next: stop at the next stop point encountered after an expression | |
254 (@code{edebug-next-mode}). Also see @code{edebug-forward-sexp} in | |
255 @ref{Edebug Misc}. | |
256 | |
257 @item t | |
258 Trace: pause one second at each Edebug stop point (@code{edebug-trace-mode}). | |
259 | |
260 @item T | |
261 Rapid trace: update the display at each stop point, but don't actually | |
262 pause (@code{edebug-Trace-fast-mode}). | |
263 | |
264 @item g | |
265 Go: run until the next breakpoint (@code{edebug-go-mode}). @xref{Breakpoints}. | |
266 | |
267 @item c | |
268 Continue: pause one second at each breakpoint, and then continue | |
269 (@code{edebug-continue-mode}). | |
270 | |
271 @item C | |
272 Rapid continue: move point to each breakpoint, but don't pause | |
273 (@code{edebug-Continue-fast-mode}). | |
274 | |
275 @item G | |
276 Go non-stop: ignore breakpoints (@code{edebug-Go-nonstop-mode}). You | |
277 can still stop the program by typing @kbd{S}, or any editing command. | |
278 @end table | |
279 | |
280 In general, the execution modes earlier in the above list run the | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
281 program more slowly or stop sooner than the modes later in the list. |
6558 | 282 |
283 While executing or tracing, you can interrupt the execution by typing | |
284 any Edebug command. Edebug stops the program at the next stop point and | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
285 then executes the command you typed. For example, typing @kbd{t} during |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
286 execution switches to trace mode at the next stop point. You can use |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
287 @kbd{S} to stop execution without doing anything else. |
6558 | 288 |
289 If your function happens to read input, a character you type intending | |
290 to interrupt execution may be read by the function instead. You can | |
291 avoid such unintended results by paying attention to when your program | |
292 wants input. | |
293 | |
294 @cindex keyboard macros (Edebug) | |
295 Keyboard macros containing the commands in this section do not | |
296 completely work: exiting from Edebug, to resume the program, loses track | |
297 of the keyboard macro. This is not easy to fix. Also, defining or | |
298 executing a keyboard macro outside of Edebug does not affect commands | |
299 inside Edebug. This is usually an advantage. But see the | |
300 @code{edebug-continue-kbd-macro} option (@pxref{Edebug Options}). | |
301 | |
302 When you enter a new Edebug level, the initial execution mode comes from | |
303 the value of the variable @code{edebug-initial-mode}. By default, this | |
304 specifies step mode. Note that you may reenter the same Edebug level | |
305 several times if, for example, an instrumented function is called | |
306 several times from one command. | |
307 | |
308 | |
309 @node Jumping | |
310 @subsection Jumping | |
311 | |
312 The commands described in this section execute until they reach a | |
313 specified location. All except @kbd{i} make a temporary breakpoint to | |
314 establish the place to stop, then switch to go mode. Any other | |
315 breakpoint reached before the intended stop point will also stop | |
316 execution. @xref{Breakpoints}, for the details on breakpoints. | |
317 | |
318 These commands may fail to work as expected in case of nonlocal exit, | |
319 because a nonlocal exit can bypass the temporary breakpoint where you | |
320 expected the program to stop. | |
321 | |
322 @table @kbd | |
323 @item h | |
324 Proceed to the stop point near where point is (@code{edebug-goto-here}). | |
325 | |
326 @item f | |
327 Run the program forward over one expression | |
328 (@code{edebug-forward-sexp}). | |
329 | |
330 @item o | |
331 Run the program until the end of the containing sexp. | |
332 | |
333 @item i | |
334 Step into the function or macro called by the form after point. | |
335 @end table | |
336 | |
337 The @kbd{h} command proceeds to the stop point near the current location | |
338 if point, using a temporary breakpoint. See @ref{Breakpoints}, for more | |
339 about breakpoints. | |
340 | |
341 The @kbd{f} command runs the program forward over one expression. More | |
342 precisely, it sets a temporary breakpoint at the position that | |
343 @kbd{C-M-f} would reach, then executes in go mode so that the program | |
344 will stop at breakpoints. | |
345 | |
346 With a prefix argument @var{n}, the temporary breakpoint is placed | |
347 @var{n} sexps beyond point. If the containing list ends before @var{n} | |
348 more elements, then the place to stop is after the containing | |
349 expression. | |
350 | |
351 Be careful that the position @kbd{C-M-f} finds is a place that the | |
352 program will really get to; this may not be true in a | |
353 @code{cond}, for example. | |
354 | |
355 The @kbd{f} command does @code{forward-sexp} starting at point, rather | |
356 than at the stop point, for flexibility. If you want to execute one | |
357 expression @emph{from the current stop point}, type @kbd{w} first, to | |
358 move point there, and then type @kbd{f}. | |
359 | |
360 The @kbd{o} command continues ``out of'' an expression. It places a | |
361 temporary breakpoint at the end of the sexp containing point. If the | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
362 containing sexp is a function definition itself, @kbd{o} continues until |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
363 just before the last sexp in the definition. If that is where you are |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
364 now, it returns from the function and then stops. In other words, this |
6558 | 365 command does not exit the currently executing function unless you are |
366 positioned after the last sexp. | |
367 | |
368 The @kbd{i} command steps into the function or macro called by the list | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
369 form after point, and stops at its first stop point. Note that the form |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
370 need not be the one about to be evaluated. But if the form is a |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
371 function call about to be evaluated, remember to use this command before |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
372 any of the arguments are evaluated, since otherwise it will be too late. |
6558 | 373 |
374 The @kbd{i} command instruments the function or macro it's supposed to | |
375 step into, if it isn't instrumented already. This is convenient, but keep | |
376 in mind that the function or macro remains instrumented unless you explicitly | |
377 arrange to deinstrument it. | |
378 | |
379 @node Edebug Misc | |
380 @subsection Miscellaneous Edebug Commands | |
381 | |
382 Some miscellaneous Edebug commands are described here. | |
383 | |
384 @table @kbd | |
385 @item ? | |
386 Display the help message for Edebug (@code{edebug-help}). | |
387 | |
388 @item C-] | |
389 Abort one level back to the previous command level | |
390 (@code{abort-recursive-edit}). | |
391 | |
392 @item q | |
393 Return to the top level editor command loop (@code{top-level}). This | |
394 exits all recursive editing levels, including all levels of Edebug | |
395 activity. However, instrumented code protected with | |
396 @code{unwind-protect} or @code{condition-case} forms may resume | |
397 debugging. | |
398 | |
399 @item Q | |
400 Like @kbd{q} but don't stop even for protected code | |
401 (@code{top-level-nonstop}). | |
402 | |
403 @item r | |
404 Redisplay the most recently known expression result in the echo area | |
405 (@code{edebug-previous-result}). | |
406 | |
407 @item d | |
408 Display a backtrace, excluding Edebug's own functions for clarity | |
409 (@code{edebug-backtrace}). | |
410 | |
411 You cannot use debugger commands in the backtrace buffer in Edebug as | |
412 you would in the standard debugger. | |
413 | |
414 The backtrace buffer is killed automatically when you continue | |
415 execution. | |
416 @end table | |
417 | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
418 From the Edebug recursive edit, you may invoke commands that activate |
6558 | 419 Edebug again recursively. Any time Edebug is active, you can quit to |
420 the top level with @kbd{q} or abort one recursive edit level with | |
421 @kbd{C-]}. You can display a backtrace of all the | |
422 pending evaluations with @kbd{d}. | |
423 | |
424 @node Breakpoints | |
425 @subsection Breakpoints | |
426 | |
427 @cindex breakpoints | |
428 Edebug's step mode stops execution at the next stop point reached. | |
429 There are three other ways to stop Edebug execution once it has started: | |
430 breakpoints, the global break condition, and source breakpoints. | |
431 | |
432 While using Edebug, you can specify @dfn{breakpoints} in the program you | |
433 are testing: points where execution should stop. You can set a | |
434 breakpoint at any stop point, as defined in @ref{Using Edebug}. For | |
435 setting and unsetting breakpoints, the stop point that is affected is | |
436 the first one at or after point in the source code buffer. Here are the | |
437 Edebug commands for breakpoints: | |
438 | |
439 @table @kbd | |
440 @item b | |
441 Set a breakpoint at the stop point at or after point | |
442 (@code{edebug-set-breakpoint}). If you use a prefix argument, the | |
443 breakpoint is temporary (it turns off the first time it stops the | |
444 program). | |
445 | |
446 @item u | |
447 Unset the breakpoint (if any) at the stop point at or after | |
448 point (@code{edebug-unset-breakpoint}). | |
449 | |
450 @item x @var{condition} @key{RET} | |
451 Set a conditional breakpoint which stops the program only if | |
452 @var{condition} evaluates to a non-@code{nil} value | |
453 (@code{edebug-set-conditional-breakpoint}). With a prefix argument, the | |
454 breakpoint is temporary. | |
455 | |
456 @item B | |
16736
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
457 Move point to the next breakpoint in the current definition |
6558 | 458 (@code{edebug-next-breakpoint}). |
459 @end table | |
460 | |
461 While in Edebug, you can set a breakpoint with @kbd{b} and unset one | |
462 with @kbd{u}. First move point to the Edebug stop point of your choice, | |
463 then type @kbd{b} or @kbd{u} to set or unset a breakpoint there. | |
464 Unsetting a breakpoint where none has been set has no effect. | |
465 | |
466 Reevaluating or reinstrumenting a definition forgets all its breakpoints. | |
467 | |
468 A @dfn{conditional breakpoint} tests a condition each time the program | |
469 gets there. Any errors that occur as a result of evaluating the | |
470 condition are ignored, as if the result were @code{nil}. To set a | |
471 conditional breakpoint, use @kbd{x}, and specify the condition | |
472 expression in the minibuffer. Setting a conditional breakpoint at a | |
473 stop point that has a previously established conditional breakpoint puts | |
474 the previous condition expression in the minibuffer so you can edit it. | |
475 | |
476 You can make a conditional or unconditional breakpoint | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
477 @dfn{temporary} by using a prefix argument with the command to set the |
6558 | 478 breakpoint. When a temporary breakpoint stops the program, it is |
479 automatically unset. | |
480 | |
481 Edebug always stops or pauses at a breakpoint except when the Edebug | |
482 mode is Go-nonstop. In that mode, it ignores breakpoints entirely. | |
483 | |
484 To find out where your breakpoints are, use the @kbd{B} command, which | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
485 moves point to the next breakpoint following point, within the same |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
486 function, or to the first breakpoint if there are no following |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
487 breakpoints. This command does not continue execution---it just moves |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
488 point in the buffer. |
6558 | 489 |
490 @menu | |
491 * Global Break Condition:: Breaking on an event. | |
492 * Source Breakpoints:: Embedding breakpoints in source code. | |
493 @end menu | |
494 | |
495 | |
496 @node Global Break Condition | |
497 @subsubsection Global Break Condition | |
498 | |
499 @cindex stopping on events | |
500 @cindex global break condition | |
501 A @dfn{global break condition} stops execution when a specified | |
502 condition is satisfied, no matter where that may occur. Edebug | |
503 evaluates the global break condition at every stop point. If it | |
504 evaluates to a non-@code{nil} value, then execution stops or pauses | |
505 depending on the execution mode, as if a breakpoint had been hit. If | |
506 evaluating the condition gets an error, execution does not stop. | |
507 | |
508 @findex edebug-set-global-break-condition | |
16736
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
509 The condition expression is stored in |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
510 @code{edebug-global-break-condition}. You can specify a new expression |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
511 using the @kbd{X} command (@code{edebug-set-global-break-condition}). |
6558 | 512 |
513 The global break condition is the simplest way to find where in your | |
514 code some event occurs, but it makes code run much more slowly. So you | |
515 should reset the condition to @code{nil} when not using it. | |
516 | |
517 @node Source Breakpoints | |
518 @subsubsection Source Breakpoints | |
519 | |
520 @findex edebug | |
521 @cindex source breakpoints | |
522 All breakpoints in a definition are forgotten each time you | |
523 reinstrument it. To make a breakpoint that won't be forgotten, you can | |
524 write a @dfn{source breakpoint}, which is simply a call to the function | |
525 @code{edebug} in your source code. You can, of course, make such a call | |
526 conditional. For example, in the @code{fac} function, insert the first | |
527 line as shown below to stop when the argument reaches zero: | |
528 | |
529 @example | |
530 (defun fac (n) | |
531 (if (= n 0) (edebug)) | |
532 (if (< 0 n) | |
533 (* n (fac (1- n))) | |
534 1)) | |
535 @end example | |
536 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
537 When the @code{fac} definition is instrumented and the function is |
6558 | 538 called, the call to @code{edebug} acts as a breakpoint. Depending on |
539 the execution mode, Edebug stops or pauses there. | |
540 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
541 If no instrumented code is being executed when @code{edebug} is called, |
6558 | 542 that function calls @code{debug}. |
543 @c This may not be a good idea anymore. | |
544 | |
545 @node Trapping Errors | |
546 @subsection Trapping Errors | |
547 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
548 Emacs normally displays an error message when an error is signaled and |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
549 not handled with @code{condition-case}. While Edebug is active and |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
550 executing instrumented code, it normally responds to all unhandled |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
551 errors. You can customize this with the options @code{edebug-on-error} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
552 and @code{edebug-on-quit}; see @ref{Edebug Options}. |
6558 | 553 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
554 When Edebug responds to an error, it shows the last stop point |
6558 | 555 encountered before the error. This may be the location of a call to a |
556 function which was not instrumented, within which the error actually | |
557 occurred. For an unbound variable error, the last known stop point | |
558 might be quite distant from the offending variable reference. In that | |
559 case you might want to display a full backtrace (@pxref{Edebug Misc}). | |
560 | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
561 @c Edebug should be changed for the following: -- dan |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
562 If you change @code{debug-on-error} or @code{debug-on-quit} while |
6558 | 563 Edebug is active, these changes will be forgotten when Edebug becomes |
564 inactive. Furthermore, during Edebug's recursive edit, these variables | |
565 are bound to the values they had outside of Edebug. | |
566 | |
567 @node Edebug Views | |
568 @subsection Edebug Views | |
569 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
570 These Edebug commands let you view aspects of the buffer and window |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
571 status that obtained before entry to Edebug. The outside window |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
572 configuration is the collection of windows and contents that were in |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
573 effect outside of Edebug. |
6558 | 574 |
575 @table @kbd | |
576 @item v | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
577 Temporarily view the outside window configuration |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
578 (@code{edebug-view-outside}). |
6558 | 579 |
580 @item p | |
581 Temporarily display the outside current buffer with point at its outside | |
582 position (@code{edebug-bounce-point}). With a prefix argument @var{n}, | |
583 pause for @var{n} seconds instead. | |
584 | |
585 @item w | |
586 Move point back to the current stop point (@code{edebug-where}) in the | |
587 source code buffer. Also, if you use this command in a different window | |
588 displaying the same buffer, that window will be used instead to display | |
589 the current definition in the future. | |
590 | |
591 @item W | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
592 @c Its function is not simply to forget the saved configuration -- dan |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
593 Toggle whether Edebug saves and restores the outside window |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
594 configuration (@code{edebug-toggle-save-windows}). |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
595 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
596 With a prefix argument, @code{W} only toggles saving and restoring of |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
597 the selected window. To specify a window that is not displaying the |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
598 source code buffer, you must use @kbd{C-x X W} from the global keymap. |
6558 | 599 @end table |
600 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
601 You can view the outside window configuration with @kbd{v} or just |
6558 | 602 bounce to the point in the current buffer with @kbd{p}, even if |
603 it is not normally displayed. After moving point, you may wish to jump | |
604 back to the stop point with @kbd{w} from a source code buffer. | |
605 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
606 Each time you use @kbd{W} to turn saving @emph{off}, Edebug forgets the |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
607 saved outside window configuration---so that even if you turn saving |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
608 back @emph{on}, the current window configuration remains unchanged when |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
609 you next exit Edebug (by continuing the program). However, the |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
610 automatic redisplay of @samp{*edebug*} and @samp{*edebug-trace*} may |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
611 conflict with the buffers you wish to see unless you have enough windows |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
612 open. |
6558 | 613 |
614 @node Edebug Eval | |
615 @subsection Evaluation | |
616 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
617 While within Edebug, you can evaluate expressions ``as if'' Edebug were |
6558 | 618 not running. Edebug tries to be invisible to the expression's |
619 evaluation and printing. Evaluation of expressions that cause side | |
620 effects will work as expected except for things that Edebug explicitly | |
621 saves and restores. @xref{The Outside Context}, for details on this | |
622 process. | |
623 | |
624 @table @kbd | |
625 @item e @var{exp} @key{RET} | |
626 Evaluate expression @var{exp} in the context outside of Edebug | |
627 (@code{edebug-eval-expression}). That is, Edebug tries to minimize its | |
628 interference with the evaluation. | |
629 | |
12098 | 630 @item M-: @var{exp} @key{RET} |
6558 | 631 Evaluate expression @var{exp} in the context of Edebug itself. |
632 | |
633 @item C-x C-e | |
634 Evaluate the expression before point, in the context outside of Edebug | |
635 (@code{edebug-eval-last-sexp}). | |
636 @end table | |
637 | |
638 @cindex lexical binding (Edebug) | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
639 Edebug supports evaluation of expressions containing references to |
6558 | 640 lexically bound symbols created by the following constructs in |
641 @file{cl.el} (version 2.03 or later): @code{lexical-let}, | |
642 @code{macrolet}, and @code{symbol-macrolet}. | |
643 | |
644 @node Eval List | |
645 @subsection Evaluation List Buffer | |
646 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
647 You can use the @dfn{evaluation list buffer}, called @samp{*edebug*}, to |
6558 | 648 evaluate expressions interactively. You can also set up the |
649 @dfn{evaluation list} of expressions to be evaluated automatically each | |
650 time Edebug updates the display. | |
651 | |
652 @table @kbd | |
653 @item E | |
654 Switch to the evaluation list buffer @samp{*edebug*} | |
655 (@code{edebug-visit-eval-list}). | |
656 @end table | |
657 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
658 In the @samp{*edebug*} buffer you can use the commands of Lisp |
6558 | 659 Interaction mode (@pxref{Lisp Interaction,,, emacs, The GNU Emacs |
660 Manual}) as well as these special commands: | |
661 | |
662 @table @kbd | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
663 @item C-j |
6558 | 664 Evaluate the expression before point, in the outside context, and insert |
665 the value in the buffer (@code{edebug-eval-print-last-sexp}). | |
666 | |
667 @item C-x C-e | |
668 Evaluate the expression before point, in the context outside of Edebug | |
669 (@code{edebug-eval-last-sexp}). | |
670 | |
671 @item C-c C-u | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
672 Build a new evaluation list from the contents of the buffer |
6558 | 673 (@code{edebug-update-eval-list}). |
674 | |
675 @item C-c C-d | |
676 Delete the evaluation list group that point is in | |
677 (@code{edebug-delete-eval-item}). | |
678 | |
679 @item C-c C-w | |
680 Switch back to the source code buffer at the current stop point | |
681 (@code{edebug-where}). | |
682 @end table | |
683 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
684 You can evaluate expressions in the evaluation list window with |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
685 @kbd{C-j} or @kbd{C-x C-e}, just as you would in @samp{*scratch*}; |
6558 | 686 but they are evaluated in the context outside of Edebug. |
687 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
688 The expressions you enter interactively (and their results) are lost |
6558 | 689 when you continue execution; but you can set up an @dfn{evaluation list} |
690 consisting of expressions to be evaluated each time execution stops. | |
691 | |
692 @cindex evaluation list group | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
693 To do this, write one or more @dfn{evaluation list groups} in the |
6558 | 694 evaluation list buffer. An evaluation list group consists of one or |
695 more Lisp expressions. Groups are separated by comment lines. | |
696 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
697 The command @kbd{C-c C-u} (@code{edebug-update-eval-list}) rebuilds the |
6558 | 698 evaluation list, scanning the buffer and using the first expression of |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
699 each group. (The idea is that the second expression of the group is the |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
700 value previously computed and displayed.) |
6558 | 701 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
702 Each entry to Edebug redisplays the evaluation list by inserting each |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
703 expression in the buffer, followed by its current value. It also |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
704 inserts comment lines so that each expression becomes its own group. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
705 Thus, if you type @kbd{C-c C-u} again without changing the buffer text, |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
706 the evaluation list is effectively unchanged. |
6558 | 707 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
708 If an error occurs during an evaluation from the evaluation list, the |
6558 | 709 error message is displayed in a string as if it were the result. |
710 Therefore, expressions that use variables not currently valid do not | |
711 interrupt your debugging. | |
712 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
713 Here is an example of what the evaluation list window looks like after |
6558 | 714 several expressions have been added to it: |
715 | |
716 @smallexample | |
717 (current-buffer) | |
718 #<buffer *scratch*> | |
719 ;--------------------------------------------------------------- | |
720 (selected-window) | |
721 #<window 16 on *scratch*> | |
722 ;--------------------------------------------------------------- | |
723 (point) | |
724 196 | |
725 ;--------------------------------------------------------------- | |
726 bad-var | |
727 "Symbol's value as variable is void: bad-var" | |
728 ;--------------------------------------------------------------- | |
729 (recursion-depth) | |
730 0 | |
731 ;--------------------------------------------------------------- | |
732 this-command | |
733 eval-last-sexp | |
734 ;--------------------------------------------------------------- | |
735 @end smallexample | |
736 | |
737 To delete a group, move point into it and type @kbd{C-c C-d}, or simply | |
738 delete the text for the group and update the evaluation list with | |
739 @kbd{C-c C-u}. To add a new expression to the evaluation list, insert | |
740 the expression at a suitable place, and insert a new comment line. (You | |
741 need not insert dashes in the comment line---its contents don't matter.) | |
742 Then type @kbd{C-c C-u}. | |
743 | |
744 After selecting @samp{*edebug*}, you can return to the source code | |
745 buffer with @kbd{C-c C-w}. The @samp{*edebug*} buffer is killed when | |
746 you continue execution, and recreated next time it is needed. | |
747 | |
748 | |
749 @node Printing in Edebug | |
750 @subsection Printing in Edebug | |
751 | |
752 @cindex printing (Edebug) | |
753 @cindex printing circular structures | |
754 @pindex cust-print | |
755 If an expression in your program produces a value containing circular | |
756 list structure, you may get an error when Edebug attempts to print it. | |
757 | |
758 One way to cope with circular structure is to set @code{print-length} | |
759 or @code{print-level} to truncate the printing. Edebug does this for | |
760 you; it binds @code{print-length} and @code{print-level} to 50 if they | |
761 were @code{nil}. (Actually, the variables @code{edebug-print-length} | |
762 and @code{edebug-print-level} specify the values to use within Edebug.) | |
763 @xref{Output Variables}. | |
764 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
765 @defopt edebug-print-length |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
766 If non-@code{nil}, bind @code{print-length} to this while printing |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
767 results in Edebug. The default value is @code{50}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
768 @xref{Printing in Edebug}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
769 @end defopt |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
770 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
771 @defopt edebug-print-level |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
772 If non-@code{nil}, bind @code{print-level} to this while printing |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
773 results in Edebug. The default value is @code{50}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
774 @end defopt |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
775 |
6558 | 776 You can also print circular structures and structures that share |
777 elements more informatively by using the @file{cust-print} package. | |
778 | |
779 To load @file{cust-print} and activate custom printing only for | |
780 Edebug, simply use the command @kbd{M-x edebug-install-custom-print}. | |
781 To restore the standard print functions, use @kbd{M-x | |
782 edebug-uninstall-custom-print}. | |
783 | |
784 Here is an example of code that creates a circular structure: | |
785 | |
786 @example | |
787 (setq a '(x y)) | |
788 (setcar a a)) | |
789 @end example | |
790 | |
791 @noindent | |
792 Custom printing prints this as @samp{Result: #1=(#1# y)}. The | |
793 @samp{#1=} notation labels the structure that follows it with the label | |
794 @samp{1}, and the @samp{#1#} notation references the previously labelled | |
795 structure. This notation is used for any shared elements of lists or | |
796 vectors. | |
797 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
798 @defopt edebug-print-circle |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
799 If non-@code{nil}, bind @code{print-circle} to this while printing |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
800 results in Edebug. The default value is @code{nil}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
801 @end defopt |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
802 |
6558 | 803 Other programs can also use custom printing; see @file{cust-print.el} |
804 for details. | |
805 | |
806 @node Trace Buffer | |
807 @subsection Trace Buffer | |
808 @cindex trace buffer | |
809 | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
810 Edebug can record an execution trace, storing it in a buffer named |
6558 | 811 @samp{*edebug-trace*}. This is a log of function calls and returns, |
812 showing the function names and their arguments and values. To enable | |
813 trace recording, set @code{edebug-trace} to a non-@code{nil} value. | |
814 | |
815 Making a trace buffer is not the same thing as using trace execution | |
816 mode (@pxref{Edebug Execution Modes}). | |
817 | |
818 When trace recording is enabled, each function entry and exit adds | |
819 lines to the trace buffer. A function entry record looks like | |
820 @samp{::::@{} followed by the function name and argument values. A | |
821 function exit record looks like @samp{::::@}} followed by the function | |
822 name and result of the function. | |
823 | |
824 The number of @samp{:}s in an entry shows its recursion depth. You | |
825 can use the braces in the trace buffer to find the matching beginning or | |
826 end of function calls. | |
827 | |
828 @findex edebug-print-trace-before | |
829 @findex edebug-print-trace-after | |
830 You can customize trace recording for function entry and exit by | |
831 redefining the functions @code{edebug-print-trace-before} and | |
832 @code{edebug-print-trace-after}. | |
833 | |
834 @defmac edebug-tracing string body@dots{} | |
835 This macro requests additional trace information around the execution | |
836 of the @var{body} forms. The argument @var{string} specifies text | |
837 to put in the trace buffer. All the arguments are evaluated. | |
838 @code{edebug-tracing} returns the value of the last form in @var{body}. | |
839 @end defmac | |
840 | |
841 @defun edebug-trace format-string &rest format-args | |
842 This function inserts text in the trace buffer. It computes the text | |
843 with @code{(apply 'format @var{format-string} @var{format-args})}. | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
844 It also appends a newline to separate entries. |
6558 | 845 @end defun |
846 | |
847 @code{edebug-tracing} and @code{edebug-trace} insert lines in the trace | |
848 buffer even if Edebug is not active. | |
849 | |
850 Adding text to the trace buffer also scrolls its window to show the | |
851 last lines inserted. | |
852 | |
853 @node Coverage Testing | |
854 @subsection Coverage Testing | |
855 | |
856 @cindex coverage testing | |
857 @cindex frequency counts | |
858 @cindex performance analysis | |
859 Edebug provides rudimentary coverage testing and display of execution | |
860 frequency. All execution of an instrumented function accumulates | |
861 frequency counts, both before and after evaluation of each instrumented | |
862 expression, even if the execution mode is Go-nonstop. Coverage testing | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
863 is more expensive, so it is done only if @code{edebug-test-coverage} is |
6558 | 864 non-@code{nil}. The command @kbd{M-x edebug-display-freq-count} |
865 displays both the frequency data and the coverage data (if recorded). | |
866 | |
867 @deffn Command edebug-display-freq-count | |
868 This command displays the frequency count data for each line of the | |
869 current definition. | |
870 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
871 The frequency counts appear as comment lines after each line of code, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
872 and you can undo all insertions with one @code{undo} command. The |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
873 counts appear under the @samp{(} before an expression or the @samp{)} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
874 after an expression, or on the last character of a symbol. Values do |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
875 not appear if they are equal to the previous count on the same line. |
6558 | 876 |
877 The character @samp{=} following the count for an expression says that | |
878 the expression has returned the same value each time it was evaluated | |
879 This is the only coverage information that Edebug records. | |
880 | |
881 To clear the frequency count and coverage data for a definition, | |
882 reinstrument it. | |
883 @end deffn | |
884 | |
885 For example, after evaluating @code{(fac 5)} with a source | |
886 breakpoint, and setting @code{edebug-test-coverage} to @code{t}, when | |
887 the breakpoint is reached, the frequency data looks like this: | |
888 | |
889 @example | |
890 (defun fac (n) | |
891 (if (= n 0) (edebug)) | |
892 ;#6 1 0 =5 | |
893 (if (< 0 n) | |
894 ;#5 = | |
895 (* n (fac (1- n))) | |
896 ;# 5 0 | |
897 1)) | |
898 ;# 0 | |
899 @end example | |
900 | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
901 The comment lines show that @code{fac} was called 6 times. The |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
902 first @code{if} statement returned 5 times with the same result each |
6558 | 903 time; the same is true of the condition on the second @code{if}. |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
904 The recursive call of @code{fac} did not return at all. |
6558 | 905 |
906 | |
907 @node The Outside Context | |
908 @subsection The Outside Context | |
909 | |
910 Edebug tries to be transparent to the program you are debugging, but it | |
911 does not succeed completely. Edebug also tries to be transparent when | |
912 you evaluate expressions with @kbd{e} or with the evaluation list | |
913 buffer, by temporarily restoring the outside context. This section | |
914 explains precisely what context Edebug restores, and how Edebug fails to | |
915 be completely transparent. | |
916 | |
917 @menu | |
918 * Checking Whether to Stop:: When Edebug decides what to do. | |
919 * Edebug Display Update:: When Edebug updates the display. | |
920 * Edebug Recursive Edit:: When Edebug stops execution. | |
921 @end menu | |
922 | |
923 @node Checking Whether to Stop | |
924 @subsubsection Checking Whether to Stop | |
925 | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
926 Whenever Edebug is entered, it needs to save and restore certain data |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
927 before even deciding whether to make trace information or stop the |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
928 program. |
6558 | 929 |
930 @itemize @bullet | |
931 @item | |
932 @code{max-lisp-eval-depth} and @code{max-specpdl-size} are both | |
933 incremented one time to reduce Edebug's impact on the stack. | |
934 You could, however, still run out of stack space when using Edebug. | |
935 | |
936 @item | |
937 The state of keyboard macro execution is saved and restored. While | |
938 Edebug is active, @code{executing-macro} is bound to | |
939 @code{edebug-continue-kbd-macro}. | |
940 | |
941 @end itemize | |
942 | |
943 | |
944 @node Edebug Display Update | |
945 @subsubsection Edebug Display Update | |
946 | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
947 @c This paragraph is not filled, because LaLiberte's conversion script |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
948 @c needs an xref to be on just one line. |
6558 | 949 When Edebug needs to display something (e.g., in trace mode), it saves |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
950 the current window configuration from ``outside'' Edebug |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
951 (@pxref{Window Configurations}). When you exit Edebug (by continuing |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
952 the program), it restores the previous window configuration. |
6558 | 953 |
954 Emacs redisplays only when it pauses. Usually, when you continue | |
955 execution, the program comes back into Edebug at a breakpoint or after | |
956 stepping without pausing or reading input in between. In such cases, | |
957 Emacs never gets a chance to redisplay the ``outside'' configuration. | |
958 What you see is the same window configuration as the last time Edebug | |
959 was active, with no interruption. | |
960 | |
961 Entry to Edebug for displaying something also saves and restores the | |
962 following data, but some of these are deliberately not restored if an | |
963 error or quit signal occurs. | |
964 | |
965 @itemize @bullet | |
966 @item | |
967 @cindex current buffer point and mark (Edebug) | |
968 Which buffer is current, and the positions of point and the mark in the | |
969 current buffer, are saved and restored. | |
970 | |
971 @item | |
972 @cindex window configuration (Edebug) | |
973 The outside window configuration is saved and restored if | |
974 @code{edebug-save-windows} is non-@code{nil} (@pxref{Edebug Display Update}). | |
975 | |
976 The window configuration is not restored on error or quit, but the | |
977 outside selected window @emph{is} reselected even on error or quit in | |
978 case a @code{save-excursion} is active. If the value of | |
979 @code{edebug-save-windows} is a list, only the listed windows are saved | |
980 and restored. | |
981 | |
982 The window start and horizontal scrolling of the source code buffer are | |
983 not restored, however, so that the display remains coherent within Edebug. | |
984 | |
985 @item | |
986 The value of point in each displayed buffer is saved and restored if | |
987 @code{edebug-save-displayed-buffer-points} is non-@code{nil}. | |
988 | |
989 @item | |
990 The variables @code{overlay-arrow-position} and | |
991 @code{overlay-arrow-string} are saved and restored. So you can safely | |
992 invoke Edebug from the recursive edit elsewhere in the same buffer. | |
993 | |
994 @item | |
995 @code{cursor-in-echo-area} is locally bound to @code{nil} so that | |
996 the cursor shows up in the window. | |
997 @end itemize | |
998 | |
999 @node Edebug Recursive Edit | |
1000 @subsubsection Edebug Recursive Edit | |
1001 | |
1002 When Edebug is entered and actually reads commands from the user, it | |
1003 saves (and later restores) these additional data: | |
1004 | |
1005 @itemize @bullet | |
1006 @item | |
1007 The current match data. @xref{Match Data}. | |
1008 | |
1009 @item | |
1010 @code{last-command}, @code{this-command}, @code{last-command-char}, | |
1011 @code{last-input-char}, @code{last-input-event}, | |
1012 @code{last-command-event}, @code{last-event-frame}, | |
1013 @code{last-nonmenu-event}, and @code{track-mouse}. Commands used within | |
1014 Edebug do not affect these variables outside of Edebug. | |
1015 | |
1016 The key sequence returned by @code{this-command-keys} is changed by | |
1017 executing commands within Edebug and there is no way to reset | |
1018 the key sequence from Lisp. | |
1019 | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1020 Edebug cannot save and restore the value of |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1021 @code{unread-command-events}. Entering Edebug while this variable has a |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1022 nontrivial value can interfere with execution of the program you are |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1023 debugging. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1024 |
6558 | 1025 @item |
1026 Complex commands executed while in Edebug are added to the variable | |
1027 @code{command-history}. In rare cases this can alter execution. | |
1028 | |
1029 @item | |
1030 Within Edebug, the recursion depth appears one deeper than the recursion | |
1031 depth outside Edebug. This is not true of the automatically updated | |
1032 evaluation list window. | |
1033 | |
1034 @item | |
1035 @code{standard-output} and @code{standard-input} are bound to @code{nil} | |
1036 by the @code{recursive-edit}, but Edebug temporarily restores them during | |
1037 evaluations. | |
1038 | |
1039 @item | |
1040 The state of keyboard macro definition is saved and restored. While | |
1041 Edebug is active, @code{defining-kbd-macro} is bound to | |
1042 @code{edebug-continue-kbd-macro}. | |
1043 @end itemize | |
1044 | |
1045 @node Instrumenting Macro Calls | |
1046 @subsection Instrumenting Macro Calls | |
1047 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1048 When Edebug instruments an expression that calls a Lisp macro, it needs |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1049 additional information about the macro to do the job properly. This is |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1050 because there is no a-priori way to tell which subexpressions of the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1051 macro call are forms to be evaluated. (Evaluation may occur explicitly |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1052 in the macro body, or when the resulting expansion is evaluated, or any |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1053 time later.) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1054 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1055 Therefore, you must define an Edebug specification for each macro that |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1056 Edebug will encounter, to explain the format of calls to that macro. To |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1057 do this, use @code{def-edebug-spec}. |
6558 | 1058 |
1059 @deffn Macro def-edebug-spec macro specification | |
1060 Specify which expressions of a call to macro @var{macro} are forms to be | |
1061 evaluated. For simple macros, the @var{specification} often looks very | |
1062 similar to the formal argument list of the macro definition, but | |
1063 specifications are much more general than macro arguments. | |
1064 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1065 The @var{macro} argument can actually be any symbol, not just a macro |
6558 | 1066 name. |
1067 @end deffn | |
1068 | |
1069 Here is a simple example that defines the specification for the | |
1070 @code{for} macro described in the Emacs Lisp Reference Manual, followed | |
1071 by an alternative, equivalent specification. | |
1072 | |
1073 @example | |
1074 (def-edebug-spec for | |
1075 (symbolp "from" form "to" form "do" &rest form)) | |
1076 | |
1077 (def-edebug-spec for | |
1078 (symbolp ['from form] ['to form] ['do body])) | |
1079 @end example | |
1080 | |
1081 Here is a table of the possibilities for @var{specification} and how each | |
1082 directs processing of arguments. | |
1083 | |
7734 | 1084 @table @asis |
6558 | 1085 @item @code{t} |
1086 All arguments are instrumented for evaluation. | |
1087 | |
1088 @item @code{0} | |
1089 None of the arguments is instrumented. | |
1090 | |
1091 @item a symbol | |
1092 The symbol must have an Edebug specification which is used instead. | |
1093 This indirection is repeated until another kind of specification is | |
1094 found. This allows you to inherit the specification for another macro. | |
1095 | |
1096 @item a list | |
1097 The elements of the list describe the types of the arguments of a | |
1098 calling form. The possible elements of a specification list are | |
1099 described in the following sections. | |
1100 @end table | |
1101 | |
1102 @menu | |
1103 * Specification List:: How to specify complex patterns of evaluation. | |
1104 * Backtracking:: What Edebug does when matching fails. | |
1105 * Specification Examples:: To help understand specifications. | |
1106 @end menu | |
1107 | |
1108 | |
1109 @node Specification List | |
1110 @subsubsection Specification List | |
1111 | |
1112 @cindex Edebug specification list | |
1113 A @dfn{specification list} is required for an Edebug specification if | |
1114 some arguments of a macro call are evaluated while others are not. Some | |
1115 elements in a specification list match one or more arguments, but others | |
1116 modify the processing of all following elements. The latter, called | |
1117 @dfn{specification keywords}, are symbols beginning with @samp{&} (such | |
1118 as @code{&optional}). | |
1119 | |
1120 A specification list may contain sublists which match arguments that are | |
1121 themselves lists, or it may contain vectors used for grouping. Sublists | |
1122 and groups thus subdivide the specification list into a hierarchy of | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1123 levels. Specification keywords apply only to the remainder of the |
6558 | 1124 sublist or group they are contained in. |
1125 | |
1126 When a specification list involves alternatives or repetition, matching | |
1127 it against an actual macro call may require backtracking. | |
1128 @xref{Backtracking}, for more details. | |
1129 | |
1130 Edebug specifications provide the power of regular expression matching, | |
1131 plus some context-free grammar constructs: the matching of sublists with | |
1132 balanced parentheses, recursive processing of forms, and recursion via | |
1133 indirect specifications. | |
1134 | |
1135 Here's a table of the possible elements of a specification list, with | |
1136 their meanings: | |
1137 | |
1138 @table @code | |
1139 @item sexp | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1140 A single Lisp object, not unevaluated. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1141 @c "unevaluated expression" is not meaningful, because |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1142 @c an expression is a Lisp object intended for evaluation. |
6558 | 1143 |
1144 @item form | |
1145 A single evaluated expression, which is instrumented. | |
1146 | |
1147 @item place | |
1148 @findex edebug-unwrap | |
1149 A place to store a value, as in the Common Lisp @code{setf} construct. | |
1150 | |
1151 @item body | |
1152 Short for @code{&rest form}. See @code{&rest} below. | |
1153 | |
1154 @item function-form | |
1155 A function form: either a quoted function symbol, a quoted lambda | |
1156 expression, or a form (that should evaluate to a function symbol or | |
1157 lambda expression). This is useful when an argument that's a lambda | |
1158 expression might be quoted with @code{quote} rather than | |
1159 @code{function}, since it instruments the body of the lambda expression | |
1160 either way. | |
1161 | |
1162 @item lambda-expr | |
1163 A lambda expression with no quoting. | |
1164 | |
1165 @item &optional | |
1166 @kindex &optional @r{(Edebug)} | |
1167 All following elements in the specification list are optional; as soon | |
1168 as one does not match, Edebug stops matching at this level. | |
1169 | |
1170 To make just a few elements optional followed by non-optional elements, | |
1171 use @code{[&optional @var{specs}@dots{}]}. To specify that several | |
1172 elements must all match or none, use @code{&optional | |
1173 [@var{specs}@dots{}]}. See the @code{defun} example below. | |
1174 | |
1175 @item &rest | |
1176 @kindex &rest @r{(Edebug)} | |
1177 All following elements in the specification list are repeated zero or | |
1178 more times. All the elements need not match in the last repetition, | |
1179 however. | |
1180 | |
1181 To repeat only a few elements, use @code{[&rest @var{specs}@dots{}]}. | |
1182 To specify several elements that must all match on every repetition, use | |
1183 @code{&rest [@var{specs}@dots{}]}. | |
1184 | |
1185 @item &or | |
1186 @kindex &or @r{(Edebug)} | |
1187 Each of the following elements in the specification list is an | |
1188 alternative. One of the alternatives must match, or the @code{&or} | |
1189 specification fails. | |
1190 | |
1191 Each list element following @code{&or} is a single alternative. To | |
1192 group two or more list elements as a single alternative, enclose them in | |
1193 @code{[@dots{}]}. | |
1194 | |
1195 @item ¬ | |
1196 @kindex ¬ @r{(Edebug)} | |
1197 Each of the following elements is matched as alternatives as if by using | |
1198 @code{&or}, but if any of them match, the specification fails. If none | |
1199 of them match, nothing is matched, but the @code{¬} specification | |
1200 succeeds. | |
1201 | |
1202 @item &define | |
1203 @kindex &define @r{(Edebug)} | |
1204 Indicates that the specification is for a defining form. The defining | |
1205 form itself is not instrumented (i.e. Edebug does not stop before and | |
1206 after the defining form), but forms inside it typically will be | |
1207 instrumented. The @code{&define} keyword should be the first element in | |
1208 a list specification. | |
1209 | |
1210 @item nil | |
1211 This is successful when there are no more arguments to match at the | |
1212 current argument list level; otherwise it fails. See sublist | |
1213 specifications and the backquote example below. | |
1214 | |
1215 @item gate | |
1216 @cindex preventing backtracking | |
1217 No argument is matched but backtracking through the gate is disabled | |
1218 while matching the remainder of the specifications at this level. This | |
1219 is primarily used to generate more specific syntax error messages. See | |
1220 @ref{Backtracking}, for more details. Also see the @code{let} example | |
1221 below. | |
1222 | |
1223 @item @var{other-symbol} | |
1224 @cindex indirect specifications | |
1225 Any other symbol in a specification list may be a predicate or an | |
1226 indirect specification. | |
1227 | |
1228 If the symbol has an Edebug specification, this @dfn{indirect | |
1229 specification} should be either a list specification that is used in | |
1230 place of the symbol, or a function that is called to process the | |
1231 arguments. The specification may be defined with @code{def-edebug-spec} | |
1232 just as for macros. See the @code{defun} example below. | |
1233 | |
1234 Otherwise, the symbol should be a predicate. The predicate is called | |
1235 with the argument and the specification fails if the predicate returns | |
1236 @code{nil}. In either case, that argument is not instrumented. | |
1237 | |
1238 Some suitable predicates include @code{symbolp}, @code{integerp}, | |
1239 @code{stringp}, @code{vectorp}, and @code{atom}. | |
1240 | |
1241 @item [@var{elements}@dots{}] | |
1242 @cindex [@dots{}] (Edebug) | |
1243 A vector of elements groups the elements into a single @dfn{group | |
1244 specification}. Its meaning has nothing to do with vectors. | |
1245 | |
1246 @item "@var{string}" | |
1247 The argument should be a symbol named @var{string}. This specification | |
1248 is equivalent to the quoted symbol, @code{'@var{symbol}}, where the name | |
1249 of @var{symbol} is the @var{string}, but the string form is preferred. | |
1250 | |
1251 @item (vector @var{elements}@dots{}) | |
1252 The argument should be a vector whose elements must match the | |
1253 @var{elements} in the specification. See the backquote example below. | |
1254 | |
1255 @item (@var{elements}@dots{}) | |
1256 Any other list is a @dfn{sublist specification} and the argument must be | |
1257 a list whose elements match the specification @var{elements}. | |
1258 | |
1259 @cindex dotted lists (Edebug) | |
1260 A sublist specification may be a dotted list and the corresponding list | |
1261 argument may then be a dotted list. Alternatively, the last @sc{cdr} of a | |
1262 dotted list specification may be another sublist specification (via a | |
1263 grouping or an indirect specification, e.g. @code{(spec . [(more | |
1264 specs@dots{})])}) whose elements match the non-dotted list arguments. | |
1265 This is useful in recursive specifications such as in the backquote | |
1266 example below. Also see the description of a @code{nil} specification | |
1267 above for terminating such recursion. | |
1268 | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1269 Note that a sublist specification written as @code{(specs . nil)} |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1270 is equivalent to @code{(specs)}, and @code{(specs . |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1271 (sublist-elements@dots{}))} is equivalent to @code{(specs |
6558 | 1272 sublist-elements@dots{})}. |
1273 @end table | |
1274 | |
1275 @c Need to document extensions with &symbol and :symbol | |
1276 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1277 Here is a list of additional specifications that may appear only after |
6558 | 1278 @code{&define}. See the @code{defun} example below. |
1279 | |
1280 @table @code | |
1281 @item name | |
1282 The argument, a symbol, is the name of the defining form. | |
1283 | |
1284 A defining form is not required to have a name field; and it may have | |
1285 multiple name fields. | |
1286 | |
1287 @item :name | |
1288 This construct does not actually match an argument. The element | |
1289 following @code{:name} should be a symbol; it is used as an additional | |
1290 name component for the definition. You can use this to add a unique, | |
1291 static component to the name of the definition. It may be used more | |
1292 than once. | |
1293 | |
1294 @item arg | |
1295 The argument, a symbol, is the name of an argument of the defining form. | |
1296 However, lambda list keywords (symbols starting with @samp{@code{&}}) | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1297 are not allowed. |
6558 | 1298 |
1299 @item lambda-list | |
1300 @cindex lambda-list (Edebug) | |
1301 This matches a lambda list---the argument list of a lambda expression. | |
1302 | |
1303 @item def-body | |
1304 The argument is the body of code in a definition. This is like | |
1305 @code{body}, described above, but a definition body must be instrumented | |
1306 with a different Edebug call that looks up information associated with | |
1307 the definition. Use @code{def-body} for the highest level list of forms | |
1308 within the definition. | |
1309 | |
1310 @item def-form | |
1311 The argument is a single, highest-level form in a definition. This is | |
1312 like @code{def-body}, except use this to match a single form rather than | |
1313 a list of forms. As a special case, @code{def-form} also means that | |
1314 tracing information is not output when the form is executed. See the | |
1315 @code{interactive} example below. | |
1316 @end table | |
1317 | |
1318 @node Backtracking | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1319 @subsubsection Backtracking in Specifications |
6558 | 1320 |
1321 @cindex backtracking | |
1322 @cindex syntax error (Edebug) | |
1323 If a specification fails to match at some point, this does not | |
1324 necessarily mean a syntax error will be signaled; instead, | |
1325 @dfn{backtracking} will take place until all alternatives have been | |
1326 exhausted. Eventually every element of the argument list must be | |
1327 matched by some element in the specification, and every required element | |
1328 in the specification must match some argument. | |
1329 | |
1330 Backtracking is disabled for the remainder of a sublist or group when | |
1331 certain conditions occur, described below. Backtracking is reenabled | |
1332 when a new alternative is established by @code{&optional}, @code{&rest}, | |
1333 or @code{&or}. It is also reenabled initially when processing a | |
1334 sublist or group specification or an indirect specification. | |
1335 | |
1336 You might want to disable backtracking to commit to some alternative so | |
1337 that Edebug can provide a more specific syntax error message. Normally, | |
1338 if no alternative matches, Edebug reports that none matched, but if one | |
1339 alternative is committed to, Edebug can report how it failed to match. | |
1340 | |
1341 First, backtracking is disabled while matching any of the form | |
1342 specifications (i.e. @code{form}, @code{body}, @code{def-form}, and | |
1343 @code{def-body}). These specifications will match any form so any error | |
1344 must be in the form itself rather than at a higher level. | |
1345 | |
1346 Second, backtracking is disabled after successfully matching a quoted | |
1347 symbol or string specification, since this usually indicates a | |
1348 recognized construct. If you have a set of alternative constructs that | |
1349 all begin with the same symbol, you can usually work around this | |
1350 constraint by factoring the symbol out of the alternatives, e.g., | |
1351 @code{["foo" &or [first case] [second case] ...]}. | |
1352 | |
1353 Third, backtracking may be explicitly disabled by using the | |
1354 @code{gate} specification. This is useful when you know that | |
1355 no higher alternatives may apply. | |
1356 | |
1357 @node Specification Examples | |
1358 @subsubsection Specification Examples | |
1359 | |
1360 It may be easier to understand Edebug specifications by studying | |
1361 the examples provided here. | |
1362 | |
1363 A @code{let} special form has a sequence of bindings and a body. Each | |
1364 of the bindings is either a symbol or a sublist with a symbol and | |
1365 optional value. In the specification below, notice the @code{gate} | |
1366 inside of the sublist to prevent backtracking once a sublist is found. | |
1367 | |
1368 @example | |
1369 (def-edebug-spec let | |
1370 ((&rest | |
1371 &or symbolp (gate symbolp &optional form)) | |
1372 body)) | |
1373 @end example | |
1374 | |
1375 Edebug uses the following specifications for @code{defun} and | |
1376 @code{defmacro} and the associated argument list and @code{interactive} | |
1377 specifications. It is necessary to handle interactive forms specially | |
1378 since an expression argument it is actually evaluated outside of the | |
1379 function body. | |
1380 | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1381 @smallexample |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1382 (def-edebug-spec defmacro defun) ; @r{Indirect ref to @code{defun} spec.} |
6558 | 1383 (def-edebug-spec defun |
1384 (&define name lambda-list | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1385 [&optional stringp] ; @r{Match the doc string, if present.} |
6558 | 1386 [&optional ("interactive" interactive)] |
1387 def-body)) | |
1388 | |
1389 (def-edebug-spec lambda-list | |
1390 (([&rest arg] | |
1391 [&optional ["&optional" arg &rest arg]] | |
1392 &optional ["&rest" arg] | |
1393 ))) | |
1394 | |
1395 (def-edebug-spec interactive | |
1396 (&optional &or stringp def-form)) ; @r{Notice: @code{def-form}} | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1397 @end smallexample |
6558 | 1398 |
1399 The specification for backquote below illustrates how to match | |
1400 dotted lists and use @code{nil} to terminate recursion. It also | |
1401 illustrates how components of a vector may be matched. (The actual | |
1402 specification defined by Edebug does not support dotted lists because | |
1403 doing so causes very deep recursion that could fail.) | |
1404 | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1405 @smallexample |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1406 (def-edebug-spec ` (backquote-form)) ; @r{Alias just for clarity.} |
6558 | 1407 |
1408 (def-edebug-spec backquote-form | |
1409 (&or ([&or "," ",@@"] &or ("quote" backquote-form) form) | |
1410 (backquote-form . [&or nil backquote-form]) | |
1411 (vector &rest backquote-form) | |
1412 sexp)) | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1413 @end smallexample |
6558 | 1414 |
1415 | |
1416 @node Edebug Options | |
1417 @subsection Edebug Options | |
1418 | |
1419 These options affect the behavior of Edebug: | |
1420 | |
1421 @defopt edebug-setup-hook | |
1422 Functions to call before Edebug is used. Each time it is set to a new | |
1423 value, Edebug will call those functions once and then | |
1424 @code{edebug-setup-hook} is reset to @code{nil}. You could use this to | |
1425 load up Edebug specifications associated with a package you are using | |
1426 but only when you also use Edebug. | |
1427 @xref{Instrumenting}. | |
1428 @end defopt | |
1429 | |
1430 @defopt edebug-all-defs | |
1431 If this is non-@code{nil}, normal evaluation of defining forms such as | |
1432 @code{defun} and @code{defmacro} instruments them for Edebug. This | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1433 applies to @code{eval-defun}, @code{eval-region}, @code{eval-buffer}, |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1434 and @code{eval-current-buffer}. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1435 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1436 Use the command @kbd{M-x edebug-all-defs} to toggle the value of this |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1437 option. @xref{Instrumenting}. |
6558 | 1438 @end defopt |
1439 | |
1440 @defopt edebug-all-forms | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1441 If this is non-@code{nil}, the commands @code{eval-defun}, |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1442 @code{eval-region}, @code{eval-buffer}, and @code{eval-current-buffer} |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1443 instrument all forms, even those that don't define anything. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1444 This doesn't apply to loading or evaluations in the minibuffer. |
6558 | 1445 |
1446 Use the command @kbd{M-x edebug-all-forms} to toggle the value of this | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1447 option. @xref{Instrumenting}. |
6558 | 1448 @end defopt |
1449 | |
1450 @defopt edebug-save-windows | |
1451 If this is non-@code{nil}, Edebug saves and restores the window | |
1452 configuration. That takes some time, so if your program does not care | |
1453 what happens to the window configurations, it is better to set this | |
1454 variable to @code{nil}. | |
1455 | |
1456 If the value is a list, only the listed windows are saved and | |
1457 restored. | |
1458 | |
1459 You can use the @kbd{W} command in Edebug to change this variable | |
1460 interactively. @xref{Edebug Display Update}. | |
1461 @end defopt | |
1462 | |
1463 @defopt edebug-save-displayed-buffer-points | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1464 If this is non-@code{nil}, Edebug saves and restores point in all |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1465 displayed buffers. |
6558 | 1466 |
1467 Saving and restoring point in other buffers is necessary if you are | |
1468 debugging code that changes the point of a buffer which is displayed in | |
1469 a non-selected window. If Edebug or the user then selects the window, | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1470 point in that buffer will move to the window's value of point. |
6558 | 1471 |
1472 Saving and restoring point in all buffers is expensive, since it | |
1473 requires selecting each window twice, so enable this only if you need | |
1474 it. @xref{Edebug Display Update}. | |
1475 @end defopt | |
1476 | |
1477 @defopt edebug-initial-mode | |
1478 If this variable is non-@code{nil}, it specifies the initial execution | |
1479 mode for Edebug when it is first activated. Possible values are | |
1480 @code{step}, @code{next}, @code{go}, @code{Go-nonstop}, @code{trace}, | |
1481 @code{Trace-fast}, @code{continue}, and @code{Continue-fast}. | |
1482 | |
1483 The default value is @code{step}. | |
1484 @xref{Edebug Execution Modes}. | |
1485 @end defopt | |
1486 | |
1487 @defopt edebug-trace | |
1488 Non-@code{nil} means display a trace of function entry and exit. | |
1489 Tracing output is displayed in a buffer named @samp{*edebug-trace*}, one | |
1490 function entry or exit per line, indented by the recursion level. | |
1491 | |
1492 The default value is @code{nil}. | |
1493 | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1494 Also see @code{edebug-tracing}, in @xref{Trace Buffer}. |
6558 | 1495 @end defopt |
1496 | |
1497 @defopt edebug-test-coverage | |
1498 If non-@code{nil}, Edebug tests coverage of all expressions debugged. | |
1499 This is done by comparing the result of each expression | |
1500 with the previous result. Coverage is considered OK if two different | |
1501 results are found. So to sufficiently test the coverage of your code, | |
1502 try to execute it under conditions that evaluate all expressions more | |
1503 than once, and produce different results for each expression. | |
1504 | |
1505 Use @kbd{M-x edebug-display-freq-count} to display the frequency count | |
1506 and coverage information for a definition. | |
1507 @xref{Coverage Testing}. | |
1508 @end defopt | |
1509 | |
1510 @defopt edebug-continue-kbd-macro | |
1511 If non-@code{nil}, continue defining or executing any keyboard macro | |
1512 that is executing outside of Edebug. Use this with caution since it is not | |
1513 debugged. | |
1514 @xref{Edebug Execution Modes}. | |
1515 @end defopt | |
1516 | |
1517 @defopt edebug-on-error | |
1518 Edebug binds @code{debug-on-error} to this value, if | |
1519 @code{debug-on-error} was previously @code{nil}. @xref{Trapping | |
1520 Errors}. | |
1521 @end defopt | |
1522 | |
1523 @defopt edebug-on-quit | |
1524 Edebug binds @code{debug-on-quit} to this value, if | |
1525 @code{debug-on-quit} was previously @code{nil}. @xref{Trapping | |
1526 Errors}. | |
1527 @end defopt | |
1528 | |
1529 If you change the values of @code{edebug-on-error} or | |
1530 @code{edebug-on-quit} while Edebug is active, their values won't be used | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1531 until the @emph{next} time Edebug is invoked via a new command. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1532 @c Not necessarily a deeper command level. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1533 @c A new command is not precisely true, but that is close enough -- dan |
6558 | 1534 |
1535 @defopt edebug-global-break-condition | |
1536 If non-@code{nil}, an expression to test for at every stop point. | |
1537 If the result is non-nil, then break. Errors are ignored. | |
1538 @xref{Global Break Condition}. | |
1539 @end defopt |