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