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