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