Mercurial > emacs
annotate lispref/debugging.texi @ 18797:e9aa787f0154
(quail-translate-key): Fix previous change.
author | Kenichi Handa <handa@m17n.org> |
---|---|
date | Tue, 15 Jul 1997 08:24:47 +0000 |
parents | bf32c17c153b |
children | 66d807bdc5b4 |
rev | line source |
---|---|
6558 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994 Free Software Foundation, Inc. | |
4 @c See the file elisp.texi for copying conditions. | |
5 @setfilename ../info/debugging | |
7336 | 6 @node Debugging, Read and Print, Byte Compilation, Top |
6558 | 7 @chapter Debugging Lisp Programs |
8 | |
9 There are three ways to investigate a problem in an Emacs Lisp program, | |
10 depending on what you are doing with the program when the problem appears. | |
11 | |
12 @itemize @bullet | |
13 @item | |
14 If the problem occurs when you run the program, you can use a Lisp | |
15 debugger (either the default debugger or Edebug) to investigate what is | |
16 happening during execution. | |
17 | |
18 @item | |
19 If the problem is syntactic, so that Lisp cannot even read the program, | |
20 you can use the Emacs facilities for editing Lisp to localize it. | |
21 | |
22 @item | |
23 If the problem occurs when trying to compile the program with the byte | |
24 compiler, you need to know how to examine the compiler's input buffer. | |
25 @end itemize | |
26 | |
27 @menu | |
28 * Debugger:: How the Emacs Lisp debugger is implemented. | |
29 * Syntax Errors:: How to find syntax errors. | |
30 * Compilation Errors:: How to find errors that show up in byte compilation. | |
31 * Edebug:: A source-level Emacs Lisp debugger. | |
32 @end menu | |
33 | |
34 Another useful debugging tool is the dribble file. When a dribble | |
35 file is open, Emacs copies all keyboard input characters to that file. | |
36 Afterward, you can examine the file to find out what input was used. | |
37 @xref{Terminal Input}. | |
38 | |
39 For debugging problems in terminal descriptions, the | |
40 @code{open-termscript} function can be useful. @xref{Terminal Output}. | |
41 | |
42 @node Debugger | |
43 @section The Lisp Debugger | |
44 @cindex debugger | |
45 @cindex Lisp debugger | |
46 @cindex break | |
47 | |
48 The @dfn{Lisp debugger} provides the ability to suspend evaluation of | |
49 a form. While evaluation is suspended (a state that is commonly known | |
50 as a @dfn{break}), you may examine the run time stack, examine the | |
51 values of local or global variables, or change those values. Since a | |
52 break is a recursive edit, all the usual editing facilities of Emacs are | |
53 available; you can even run programs that will enter the debugger | |
54 recursively. @xref{Recursive Editing}. | |
55 | |
56 @menu | |
57 * Error Debugging:: Entering the debugger when an error happens. | |
58 * Infinite Loops:: Stopping and debugging a program that doesn't exit. | |
59 * Function Debugging:: Entering it when a certain function is called. | |
60 * Explicit Debug:: Entering it at a certain point in the program. | |
61 * Using Debugger:: What the debugger does; what you see while in it. | |
62 * Debugger Commands:: Commands used while in the debugger. | |
63 * Invoking the Debugger:: How to call the function @code{debug}. | |
64 * Internals of Debugger:: Subroutines of the debugger, and global variables. | |
65 @end menu | |
66 | |
67 @node Error Debugging | |
68 @subsection Entering the Debugger on an Error | |
69 @cindex error debugging | |
70 @cindex debugging errors | |
71 | |
72 The most important time to enter the debugger is when a Lisp error | |
73 happens. This allows you to investigate the immediate causes of the | |
74 error. | |
75 | |
76 However, entry to the debugger is not a normal consequence of an | |
77 error. Many commands frequently get Lisp errors when invoked in | |
78 inappropriate contexts (such as @kbd{C-f} at the end of the buffer) and | |
79 during ordinary editing it would be very unpleasant to enter the | |
80 debugger each time this happens. If you want errors to enter the | |
81 debugger, set the variable @code{debug-on-error} to non-@code{nil}. | |
82 | |
83 @defopt debug-on-error | |
7214
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
84 This variable determines whether the debugger is called when an error is |
6558 | 85 signaled and not handled. If @code{debug-on-error} is @code{t}, all |
86 errors call the debugger. If it is @code{nil}, none call the debugger. | |
87 | |
88 The value can also be a list of error conditions that should call the | |
89 debugger. For example, if you set it to the list | |
90 @code{(void-variable)}, then only errors about a variable that has no | |
91 value invoke the debugger. | |
12067 | 92 |
93 When this variable is non-@code{nil}, Emacs does not catch errors that | |
94 happen in process filter functions and sentinels. Therefore, these | |
95 errors also can invoke the debugger. @xref{Processes}. | |
6558 | 96 @end defopt |
97 | |
15725 | 98 @defopt debug-ignored-errors |
99 This variable specifies certain kinds of errors that should not enter | |
100 the debugger. Its value is a list of error condition symbols and/or | |
101 regular expressions. If the error has any of those condition symbols, | |
102 or if the error message matches any of the regular expressions, then | |
103 that error does not enter the debugger, regardless of the value of | |
104 @code{debug-on-error}. | |
105 | |
106 The normal value of this variable lists several errors that happen often | |
107 during editing but rarely result from bugs in Lisp programs. | |
108 @end defopt | |
109 | |
6558 | 110 To debug an error that happens during loading of the @file{.emacs} |
111 file, use the option @samp{-debug-init}, which binds | |
7214
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
112 @code{debug-on-error} to @code{t} while @file{.emacs} is loaded and |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
113 inhibits use of @code{condition-case} to catch init file errors. |
6558 | 114 |
7214
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
115 If your @file{.emacs} file sets @code{debug-on-error}, the effect may |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
116 not last past the end of loading @file{.emacs}. (This is an undesirable |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
117 byproduct of the code that implements the @samp{-debug-init} command |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
118 line option.) The best way to make @file{.emacs} set |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
119 @code{debug-on-error} permanently is with @code{after-init-hook}, like |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
120 this: |
6558 | 121 |
122 @example | |
123 (add-hook 'after-init-hook | |
124 '(lambda () (setq debug-on-error t))) | |
125 @end example | |
126 | |
127 @node Infinite Loops | |
128 @subsection Debugging Infinite Loops | |
129 @cindex infinite loops | |
130 @cindex loops, infinite | |
131 @cindex quitting from infinite loop | |
132 @cindex stopping an infinite loop | |
133 | |
134 When a program loops infinitely and fails to return, your first | |
135 problem is to stop the loop. On most operating systems, you can do this | |
136 with @kbd{C-g}, which causes quit. | |
137 | |
138 Ordinary quitting gives no information about why the program was | |
139 looping. To get more information, you can set the variable | |
140 @code{debug-on-quit} to non-@code{nil}. Quitting with @kbd{C-g} is not | |
141 considered an error, and @code{debug-on-error} has no effect on the | |
7214
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
142 handling of @kbd{C-g}. Likewise, @code{debug-on-quit} has no effect on |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
143 errors. |
6558 | 144 |
145 Once you have the debugger running in the middle of the infinite loop, | |
146 you can proceed from the debugger using the stepping commands. If you | |
147 step through the entire loop, you will probably get enough information | |
148 to solve the problem. | |
149 | |
150 @defopt debug-on-quit | |
151 This variable determines whether the debugger is called when @code{quit} | |
152 is signaled and not handled. If @code{debug-on-quit} is non-@code{nil}, | |
153 then the debugger is called whenever you quit (that is, type @kbd{C-g}). | |
154 If @code{debug-on-quit} is @code{nil}, then the debugger is not called | |
155 when you quit. @xref{Quitting}. | |
156 @end defopt | |
157 | |
158 @node Function Debugging | |
159 @subsection Entering the Debugger on a Function Call | |
160 @cindex function call debugging | |
161 @cindex debugging specific functions | |
162 | |
163 To investigate a problem that happens in the middle of a program, one | |
164 useful technique is to enter the debugger whenever a certain function is | |
165 called. You can do this to the function in which the problem occurs, | |
166 and then step through the function, or you can do this to a function | |
167 called shortly before the problem, step quickly over the call to that | |
168 function, and then step through its caller. | |
169 | |
170 @deffn Command debug-on-entry function-name | |
171 This function requests @var{function-name} to invoke the debugger each time | |
172 it is called. It works by inserting the form @code{(debug 'debug)} into | |
173 the function definition as the first form. | |
174 | |
175 Any function defined as Lisp code may be set to break on entry, | |
176 regardless of whether it is interpreted code or compiled code. If the | |
177 function is a command, it will enter the debugger when called from Lisp | |
178 and when called interactively (after the reading of the arguments). You | |
179 can't debug primitive functions (i.e., those written in C) this way. | |
180 | |
181 When @code{debug-on-entry} is called interactively, it prompts | |
182 for @var{function-name} in the minibuffer. | |
183 | |
184 If the function is already set up to invoke the debugger on entry, | |
185 @code{debug-on-entry} does nothing. | |
186 | |
12098 | 187 @strong{Note:} if you redefine a function after using |
188 @code{debug-on-entry} on it, the code to enter the debugger is lost. | |
6558 | 189 |
190 @code{debug-on-entry} returns @var{function-name}. | |
191 | |
192 @example | |
193 @group | |
194 (defun fact (n) | |
195 (if (zerop n) 1 | |
196 (* n (fact (1- n))))) | |
197 @result{} fact | |
198 @end group | |
199 @group | |
200 (debug-on-entry 'fact) | |
201 @result{} fact | |
202 @end group | |
203 @group | |
204 (fact 3) | |
205 @end group | |
206 | |
207 @group | |
208 ------ Buffer: *Backtrace* ------ | |
209 Entering: | |
210 * fact(3) | |
211 eval-region(4870 4878 t) | |
212 byte-code("...") | |
213 eval-last-sexp(nil) | |
214 (let ...) | |
215 eval-insert-last-sexp(nil) | |
216 * call-interactively(eval-insert-last-sexp) | |
217 ------ Buffer: *Backtrace* ------ | |
218 @end group | |
219 | |
220 @group | |
221 (symbol-function 'fact) | |
222 @result{} (lambda (n) | |
223 (debug (quote debug)) | |
224 (if (zerop n) 1 (* n (fact (1- n))))) | |
225 @end group | |
226 @end example | |
227 @end deffn | |
228 | |
229 @deffn Command cancel-debug-on-entry function-name | |
230 This function undoes the effect of @code{debug-on-entry} on | |
231 @var{function-name}. When called interactively, it prompts for | |
12098 | 232 @var{function-name} in the minibuffer. If @var{function-name} is |
233 @code{nil} or the empty string, it cancels debugging for all functions. | |
6558 | 234 |
235 If @code{cancel-debug-on-entry} is called more than once on the same | |
236 function, the second call does nothing. @code{cancel-debug-on-entry} | |
237 returns @var{function-name}. | |
238 @end deffn | |
239 | |
240 @node Explicit Debug | |
241 @subsection Explicit Entry to the Debugger | |
242 | |
243 You can cause the debugger to be called at a certain point in your | |
244 program by writing the expression @code{(debug)} at that point. To do | |
245 this, visit the source file, insert the text @samp{(debug)} at the | |
246 proper place, and type @kbd{C-M-x}. Be sure to undo this insertion | |
247 before you save the file! | |
248 | |
249 The place where you insert @samp{(debug)} must be a place where an | |
250 additional form can be evaluated and its value ignored. (If the value | |
7214
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
251 of @code{(debug)} isn't ignored, it will alter the execution of the |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
252 program!) The most common suitable places are inside a @code{progn} or |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
253 an implicit @code{progn} (@pxref{Sequencing}). |
6558 | 254 |
255 @node Using Debugger | |
256 @subsection Using the Debugger | |
257 | |
258 When the debugger is entered, it displays the previously selected | |
259 buffer in one window and a buffer named @samp{*Backtrace*} in another | |
260 window. The backtrace buffer contains one line for each level of Lisp | |
261 function execution currently going on. At the beginning of this buffer | |
262 is a message describing the reason that the debugger was invoked (such | |
263 as the error message and associated data, if it was invoked due to an | |
264 error). | |
265 | |
266 The backtrace buffer is read-only and uses a special major mode, | |
267 Debugger mode, in which letters are defined as debugger commands. The | |
268 usual Emacs editing commands are available; thus, you can switch windows | |
269 to examine the buffer that was being edited at the time of the error, | |
270 switch buffers, visit files, or do any other sort of editing. However, | |
271 the debugger is a recursive editing level (@pxref{Recursive Editing}) | |
272 and it is wise to go back to the backtrace buffer and exit the debugger | |
273 (with the @kbd{q} command) when you are finished with it. Exiting | |
274 the debugger gets out of the recursive edit and kills the backtrace | |
275 buffer. | |
276 | |
277 @cindex current stack frame | |
7214
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
278 The backtrace buffer shows you the functions that are executing and |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
279 their argument values. It also allows you to specify a stack frame by |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
280 moving point to the line describing that frame. (A stack frame is the |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
281 place where the Lisp interpreter records information about a particular |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
282 invocation of a function.) The frame whose line point is on is |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
283 considered the @dfn{current frame}. Some of the debugger commands |
6558 | 284 operate on the current frame. |
285 | |
286 The debugger itself must be run byte-compiled, since it makes | |
287 assumptions about how many stack frames are used for the debugger | |
288 itself. These assumptions are false if the debugger is running | |
289 interpreted. | |
290 | |
291 @need 3000 | |
292 | |
293 @node Debugger Commands | |
294 @subsection Debugger Commands | |
295 @cindex debugger command list | |
296 | |
297 Inside the debugger (in Debugger mode), these special commands are | |
298 available in addition to the usual cursor motion commands. (Keep in | |
299 mind that all the usual facilities of Emacs, such as switching windows | |
300 or buffers, are still available.) | |
301 | |
302 The most important use of debugger commands is for stepping through | |
303 code, so that you can see how control flows. The debugger can step | |
304 through the control structures of an interpreted function, but cannot do | |
305 so in a byte-compiled function. If you would like to step through a | |
306 byte-compiled function, replace it with an interpreted definition of the | |
307 same function. (To do this, visit the source file for the function and | |
308 type @kbd{C-M-x} on its definition.) | |
309 | |
310 Here is a list of Debugger mode commands: | |
311 | |
312 @table @kbd | |
313 @item c | |
314 Exit the debugger and continue execution. When continuing is possible, | |
315 it resumes execution of the program as if the debugger had never been | |
316 entered (aside from the effect of any variables or data structures you | |
317 may have changed while inside the debugger). | |
318 | |
319 Continuing is possible after entry to the debugger due to function entry | |
320 or exit, explicit invocation, or quitting. You cannot continue if the | |
321 debugger was entered because of an error. | |
322 | |
323 @item d | |
324 Continue execution, but enter the debugger the next time any Lisp | |
325 function is called. This allows you to step through the | |
326 subexpressions of an expression, seeing what values the subexpressions | |
327 compute, and what else they do. | |
328 | |
329 The stack frame made for the function call which enters the debugger in | |
330 this way will be flagged automatically so that the debugger will be | |
331 called again when the frame is exited. You can use the @kbd{u} command | |
332 to cancel this flag. | |
333 | |
334 @item b | |
335 Flag the current frame so that the debugger will be entered when the | |
336 frame is exited. Frames flagged in this way are marked with stars | |
337 in the backtrace buffer. | |
338 | |
339 @item u | |
340 Don't enter the debugger when the current frame is exited. This | |
341 cancels a @kbd{b} command on that frame. | |
342 | |
343 @item e | |
344 Read a Lisp expression in the minibuffer, evaluate it, and print the | |
12098 | 345 value in the echo area. The debugger alters certain important |
346 variables, and the current buffer, as part of its operation; @kbd{e} | |
347 temporarily restores their outside-the-debugger values so you can | |
348 examine them. This makes the debugger more transparent. By contrast, | |
349 @kbd{M-:} does nothing special in the debugger; it shows you the | |
350 variable values within the debugger. | |
6558 | 351 |
352 @item q | |
353 Terminate the program being debugged; return to top-level Emacs | |
354 command execution. | |
355 | |
356 If the debugger was entered due to a @kbd{C-g} but you really want | |
357 to quit, and not debug, use the @kbd{q} command. | |
358 | |
359 @item r | |
360 Return a value from the debugger. The value is computed by reading an | |
361 expression with the minibuffer and evaluating it. | |
362 | |
7214
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
363 The @kbd{r} command is useful when the debugger was invoked due to exit |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
364 from a Lisp call frame (as requested with @kbd{b}); then the value |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
365 specified in the @kbd{r} command is used as the value of that frame. It |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
366 is also useful if you call @code{debug} and use its return value. |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
367 Otherwise, @kbd{r} has the same effect as @kbd{c}, and the specified |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
368 return value does not matter. |
6558 | 369 |
370 You can't use @kbd{r} when the debugger was entered due to an error. | |
371 @end table | |
372 | |
373 @node Invoking the Debugger | |
374 @subsection Invoking the Debugger | |
375 | |
376 Here we describe fully the function used to invoke the debugger. | |
377 | |
378 @defun debug &rest debugger-args | |
379 This function enters the debugger. It switches buffers to a buffer | |
380 named @samp{*Backtrace*} (or @samp{*Backtrace*<2>} if it is the second | |
381 recursive entry to the debugger, etc.), and fills it with information | |
382 about the stack of Lisp function calls. It then enters a recursive | |
383 edit, showing the backtrace buffer in Debugger mode. | |
384 | |
385 The Debugger mode @kbd{c} and @kbd{r} commands exit the recursive edit; | |
386 then @code{debug} switches back to the previous buffer and returns to | |
387 whatever called @code{debug}. This is the only way the function | |
388 @code{debug} can return to its caller. | |
389 | |
390 If the first of the @var{debugger-args} passed to @code{debug} is | |
391 @code{nil} (or if it is not one of the special values in the table | |
12098 | 392 below), then @code{debug} displays the rest of its arguments at the |
6558 | 393 top of the @samp{*Backtrace*} buffer. This mechanism is used to display |
394 a message to the user. | |
395 | |
396 However, if the first argument passed to @code{debug} is one of the | |
397 following special values, then it has special significance. Normally, | |
398 these values are passed to @code{debug} only by the internals of Emacs | |
399 and the debugger, and not by programmers calling @code{debug}. | |
400 | |
401 The special values are: | |
402 | |
403 @table @code | |
404 @item lambda | |
405 @cindex @code{lambda} in debug | |
406 A first argument of @code{lambda} means @code{debug} was called because | |
407 of entry to a function when @code{debug-on-next-call} was | |
408 non-@code{nil}. The debugger displays @samp{Entering:} as a line of | |
409 text at the top of the buffer. | |
410 | |
411 @item debug | |
412 @code{debug} as first argument indicates a call to @code{debug} because | |
413 of entry to a function that was set to debug on entry. The debugger | |
414 displays @samp{Entering:}, just as in the @code{lambda} case. It also | |
415 marks the stack frame for that function so that it will invoke the | |
416 debugger when exited. | |
417 | |
418 @item t | |
419 When the first argument is @code{t}, this indicates a call to | |
420 @code{debug} due to evaluation of a list form when | |
421 @code{debug-on-next-call} is non-@code{nil}. The debugger displays the | |
422 following as the top line in the buffer: | |
423 | |
424 @smallexample | |
425 Beginning evaluation of function call form: | |
426 @end smallexample | |
427 | |
428 @item exit | |
429 When the first argument is @code{exit}, it indicates the exit of a | |
430 stack frame previously marked to invoke the debugger on exit. The | |
431 second argument given to @code{debug} in this case is the value being | |
432 returned from the frame. The debugger displays @samp{Return value:} on | |
433 the top line of the buffer, followed by the value being returned. | |
434 | |
435 @item error | |
436 @cindex @code{error} in debug | |
437 When the first argument is @code{error}, the debugger indicates that | |
438 it is being entered because an error or @code{quit} was signaled and not | |
439 handled, by displaying @samp{Signaling:} followed by the error signaled | |
440 and any arguments to @code{signal}. For example, | |
441 | |
442 @example | |
443 @group | |
444 (let ((debug-on-error t)) | |
445 (/ 1 0)) | |
446 @end group | |
447 | |
448 @group | |
449 ------ Buffer: *Backtrace* ------ | |
450 Signaling: (arith-error) | |
451 /(1 0) | |
452 ... | |
453 ------ Buffer: *Backtrace* ------ | |
454 @end group | |
455 @end example | |
456 | |
457 If an error was signaled, presumably the variable | |
458 @code{debug-on-error} is non-@code{nil}. If @code{quit} was signaled, | |
459 then presumably the variable @code{debug-on-quit} is non-@code{nil}. | |
460 | |
461 @item nil | |
462 Use @code{nil} as the first of the @var{debugger-args} when you want | |
463 to enter the debugger explicitly. The rest of the @var{debugger-args} | |
464 are printed on the top line of the buffer. You can use this feature to | |
465 display messages---for example, to remind yourself of the conditions | |
466 under which @code{debug} is called. | |
467 @end table | |
468 @end defun | |
469 | |
470 @node Internals of Debugger | |
471 @subsection Internals of the Debugger | |
472 | |
473 This section describes functions and variables used internally by the | |
474 debugger. | |
475 | |
476 @defvar debugger | |
477 The value of this variable is the function to call to invoke the | |
478 debugger. Its value must be a function of any number of arguments (or, | |
479 more typically, the name of a function). Presumably this function will | |
480 enter some kind of debugger. The default value of the variable is | |
481 @code{debug}. | |
482 | |
483 The first argument that Lisp hands to the function indicates why it | |
484 was called. The convention for arguments is detailed in the description | |
485 of @code{debug}. | |
486 @end defvar | |
487 | |
488 @deffn Command backtrace | |
489 @cindex run time stack | |
490 @cindex call stack | |
491 This function prints a trace of Lisp function calls currently active. | |
492 This is the function used by @code{debug} to fill up the | |
493 @samp{*Backtrace*} buffer. It is written in C, since it must have access | |
494 to the stack to determine which function calls are active. The return | |
495 value is always @code{nil}. | |
496 | |
497 In the following example, a Lisp expression calls @code{backtrace} | |
498 explicitly. This prints the backtrace to the stream | |
499 @code{standard-output}: in this case, to the buffer | |
500 @samp{backtrace-output}. Each line of the backtrace represents one | |
501 function call. The line shows the values of the function's arguments if | |
502 they are all known. If they are still being computed, the line says so. | |
503 The arguments of special forms are elided. | |
504 | |
505 @smallexample | |
506 @group | |
507 (with-output-to-temp-buffer "backtrace-output" | |
508 (let ((var 1)) | |
509 (save-excursion | |
510 (setq var (eval '(progn | |
511 (1+ var) | |
512 (list 'testing (backtrace)))))))) | |
513 | |
514 @result{} nil | |
515 @end group | |
516 | |
517 @group | |
518 ----------- Buffer: backtrace-output ------------ | |
519 backtrace() | |
520 (list ...computing arguments...) | |
521 (progn ...) | |
522 eval((progn (1+ var) (list (quote testing) (backtrace)))) | |
523 (setq ...) | |
524 (save-excursion ...) | |
525 (let ...) | |
526 (with-output-to-temp-buffer ...) | |
527 eval-region(1973 2142 #<buffer *scratch*>) | |
528 byte-code("... for eval-print-last-sexp ...") | |
529 eval-print-last-sexp(nil) | |
530 * call-interactively(eval-print-last-sexp) | |
531 ----------- Buffer: backtrace-output ------------ | |
532 @end group | |
533 @end smallexample | |
534 | |
535 The character @samp{*} indicates a frame whose debug-on-exit flag is | |
536 set. | |
537 @end deffn | |
538 | |
539 @ignore @c Not worth mentioning | |
540 @defopt stack-trace-on-error | |
541 @cindex stack trace | |
542 This variable controls whether Lisp automatically displays a | |
543 backtrace buffer after every error that is not handled. A quit signal | |
544 counts as an error for this variable. If it is non-@code{nil} then a | |
545 backtrace is shown in a pop-up buffer named @samp{*Backtrace*} on every | |
546 error. If it is @code{nil}, then a backtrace is not shown. | |
547 | |
548 When a backtrace is shown, that buffer is not selected. If either | |
549 @code{debug-on-quit} or @code{debug-on-error} is also non-@code{nil}, then | |
550 a backtrace is shown in one buffer, and the debugger is popped up in | |
551 another buffer with its own backtrace. | |
552 | |
553 We consider this feature to be obsolete and superseded by the debugger | |
554 itself. | |
555 @end defopt | |
556 @end ignore | |
557 | |
558 @defvar debug-on-next-call | |
559 @cindex @code{eval}, and debugging | |
560 @cindex @code{apply}, and debugging | |
561 @cindex @code{funcall}, and debugging | |
562 If this variable is non-@code{nil}, it says to call the debugger before | |
563 the next @code{eval}, @code{apply} or @code{funcall}. Entering the | |
564 debugger sets @code{debug-on-next-call} to @code{nil}. | |
565 | |
566 The @kbd{d} command in the debugger works by setting this variable. | |
567 @end defvar | |
568 | |
569 @defun backtrace-debug level flag | |
570 This function sets the debug-on-exit flag of the stack frame @var{level} | |
7214
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
571 levels down the stack, giving it the value @var{flag}. If @var{flag} is |
6558 | 572 non-@code{nil}, this will cause the debugger to be entered when that |
573 frame later exits. Even a nonlocal exit through that frame will enter | |
574 the debugger. | |
575 | |
7214
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
576 This function is used only by the debugger. |
6558 | 577 @end defun |
578 | |
579 @defvar command-debug-status | |
12098 | 580 This variable records the debugging status of the current interactive |
6558 | 581 command. Each time a command is called interactively, this variable is |
582 bound to @code{nil}. The debugger can set this variable to leave | |
583 information for future debugger invocations during the same command. | |
584 | |
7214
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
585 The advantage, for the debugger, of using this variable rather than |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
586 another global variable is that the data will never carry over to a |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
587 subsequent command invocation. |
6558 | 588 @end defvar |
589 | |
590 @defun backtrace-frame frame-number | |
591 The function @code{backtrace-frame} is intended for use in Lisp | |
592 debuggers. It returns information about what computation is happening | |
593 in the stack frame @var{frame-number} levels down. | |
594 | |
595 If that frame has not evaluated the arguments yet (or is a special | |
596 form), the value is @code{(nil @var{function} @var{arg-forms}@dots{})}. | |
597 | |
598 If that frame has evaluated its arguments and called its function | |
599 already, the value is @code{(t @var{function} | |
600 @var{arg-values}@dots{})}. | |
601 | |
7214
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
602 In the return value, @var{function} is whatever was supplied as the |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
603 @sc{car} of the evaluated list, or a @code{lambda} expression in the |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
604 case of a macro call. If the function has a @code{&rest} argument, that |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
605 is represented as the tail of the list @var{arg-values}. |
6558 | 606 |
7214
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
607 If @var{frame-number} is out of range, @code{backtrace-frame} returns |
6558 | 608 @code{nil}. |
609 @end defun | |
610 | |
611 @node Syntax Errors | |
612 @section Debugging Invalid Lisp Syntax | |
613 | |
614 The Lisp reader reports invalid syntax, but cannot say where the real | |
615 problem is. For example, the error ``End of file during parsing'' in | |
616 evaluating an expression indicates an excess of open parentheses (or | |
617 square brackets). The reader detects this imbalance at the end of the | |
618 file, but it cannot figure out where the close parenthesis should have | |
619 been. Likewise, ``Invalid read syntax: ")"'' indicates an excess close | |
620 parenthesis or missing open parenthesis, but does not say where the | |
621 missing parenthesis belongs. How, then, to find what to change? | |
622 | |
623 If the problem is not simply an imbalance of parentheses, a useful | |
624 technique is to try @kbd{C-M-e} at the beginning of each defun, and see | |
625 if it goes to the place where that defun appears to end. If it does | |
626 not, there is a problem in that defun. | |
627 | |
628 However, unmatched parentheses are the most common syntax errors in | |
629 Lisp, and we can give further advice for those cases. | |
630 | |
631 @menu | |
632 * Excess Open:: How to find a spurious open paren or missing close. | |
633 * Excess Close:: How to find a spurious close paren or missing open. | |
634 @end menu | |
635 | |
636 @node Excess Open | |
637 @subsection Excess Open Parentheses | |
638 | |
639 The first step is to find the defun that is unbalanced. If there is | |
640 an excess open parenthesis, the way to do this is to insert a | |
641 close parenthesis at the end of the file and type @kbd{C-M-b} | |
642 (@code{backward-sexp}). This will move you to the beginning of the | |
643 defun that is unbalanced. (Then type @kbd{C-@key{SPC} C-_ C-u | |
644 C-@key{SPC}} to set the mark there, undo the insertion of the | |
645 close parenthesis, and finally return to the mark.) | |
646 | |
647 The next step is to determine precisely what is wrong. There is no | |
648 way to be sure of this except to study the program, but often the | |
649 existing indentation is a clue to where the parentheses should have | |
650 been. The easiest way to use this clue is to reindent with @kbd{C-M-q} | |
651 and see what moves. | |
652 | |
653 Before you do this, make sure the defun has enough close parentheses. | |
654 Otherwise, @kbd{C-M-q} will get an error, or will reindent all the rest | |
655 of the file until the end. So move to the end of the defun and insert a | |
656 close parenthesis there. Don't use @kbd{C-M-e} to move there, since | |
657 that too will fail to work until the defun is balanced. | |
658 | |
659 Now you can go to the beginning of the defun and type @kbd{C-M-q}. | |
660 Usually all the lines from a certain point to the end of the function | |
661 will shift to the right. There is probably a missing close parenthesis, | |
662 or a superfluous open parenthesis, near that point. (However, don't | |
663 assume this is true; study the code to make sure.) Once you have found | |
7214
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
664 the discrepancy, undo the @kbd{C-M-q} with @kbd{C-_}, since the old |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
665 indentation is probably appropriate to the intended parentheses. |
6558 | 666 |
667 After you think you have fixed the problem, use @kbd{C-M-q} again. If | |
668 the old indentation actually fit the intended nesting of parentheses, | |
669 and you have put back those parentheses, @kbd{C-M-q} should not change | |
670 anything. | |
671 | |
672 @node Excess Close | |
673 @subsection Excess Close Parentheses | |
674 | |
7214
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
675 To deal with an excess close parenthesis, first insert an open |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
676 parenthesis at the beginning of the file, back up over it, and type |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
677 @kbd{C-M-f} to find the end of the unbalanced defun. (Then type |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
678 @kbd{C-@key{SPC} C-_ C-u C-@key{SPC}} to set the mark there, undo the |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
679 insertion of the open parenthesis, and finally return to the mark.) |
6558 | 680 |
681 Then find the actual matching close parenthesis by typing @kbd{C-M-f} | |
682 at the beginning of the defun. This will leave you somewhere short of | |
683 the place where the defun ought to end. It is possible that you will | |
684 find a spurious close parenthesis in that vicinity. | |
685 | |
686 If you don't see a problem at that point, the next thing to do is to | |
687 type @kbd{C-M-q} at the beginning of the defun. A range of lines will | |
688 probably shift left; if so, the missing open parenthesis or spurious | |
689 close parenthesis is probably near the first of those lines. (However, | |
690 don't assume this is true; study the code to make sure.) Once you have | |
7214
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
691 found the discrepancy, undo the @kbd{C-M-q} with @kbd{C-_}, since the |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
692 old indentation is probably appropriate to the intended parentheses. |
6558 | 693 |
7214
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
694 After you think you have fixed the problem, use @kbd{C-M-q} again. If |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
695 the old indentation actually fit the intended nesting of parentheses, |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
696 and you have put back those parentheses, @kbd{C-M-q} should not change |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
697 anything. |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
698 |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
699 @node Compilation Errors, Edebug, Syntax Errors, Debugging |
6558 | 700 @section Debugging Problems in Compilation |
701 | |
702 When an error happens during byte compilation, it is normally due to | |
703 invalid syntax in the program you are compiling. The compiler prints a | |
704 suitable error message in the @samp{*Compile-Log*} buffer, and then | |
705 stops. The message may state a function name in which the error was | |
706 found, or it may not. Either way, here is how to find out where in the | |
707 file the error occurred. | |
708 | |
709 What you should do is switch to the buffer @w{@samp{ *Compiler Input*}}. | |
710 (Note that the buffer name starts with a space, so it does not show | |
711 up in @kbd{M-x list-buffers}.) This buffer contains the program being | |
712 compiled, and point shows how far the byte compiler was able to read. | |
713 | |
714 If the error was due to invalid Lisp syntax, point shows exactly where | |
715 the invalid syntax was @emph{detected}. The cause of the error is not | |
716 necessarily near by! Use the techniques in the previous section to find | |
717 the error. | |
718 | |
719 If the error was detected while compiling a form that had been read | |
720 successfully, then point is located at the end of the form. In this | |
7214
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
721 case, this technique can't localize the error precisely, but can still |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
722 show you which function to check. |
6558 | 723 |
724 @include edebug.texi |