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