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