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