Mercurial > emacs
annotate lispref/debugging.texi @ 63464:2d56f65bd643
*** empty log message ***
author | David Ponce <david@dponce.com> |
---|---|
date | Wed, 15 Jun 2005 08:17:54 +0000 |
parents | f7610876f0d3 |
children | 8981e470ace7 a1b34dec1104 |
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 |
63283
911432fbdac4
(Error Debugging): Minor rewording.
Luc Teirlinck <teirllm@auburn.edu>
parents:
60403
diff
changeset
|
121 If this variable has a non-@code{nil} value, then |
911432fbdac4
(Error Debugging): Minor rewording.
Luc Teirlinck <teirllm@auburn.edu>
parents:
60403
diff
changeset
|
122 @code{debug-on-error} is set to @code{t} when evaluating with the |
60315 | 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 | |
63406
f7610876f0d3
(Function Debugging): Primitives can break on entry too.
Lute Kamstra <lute@gnu.org>
parents:
63329
diff
changeset
|
213 This function requests @var{function-name} to invoke the debugger each |
f7610876f0d3
(Function Debugging): Primitives can break on entry too.
Lute Kamstra <lute@gnu.org>
parents:
63329
diff
changeset
|
214 time it is called. It works by inserting the form |
f7610876f0d3
(Function Debugging): Primitives can break on entry too.
Lute Kamstra <lute@gnu.org>
parents:
63329
diff
changeset
|
215 @code{(implement-debug-on-entry)} into the function definition as the |
f7610876f0d3
(Function Debugging): Primitives can break on entry too.
Lute Kamstra <lute@gnu.org>
parents:
63329
diff
changeset
|
216 first form. |
6558 | 217 |
63406
f7610876f0d3
(Function Debugging): Primitives can break on entry too.
Lute Kamstra <lute@gnu.org>
parents:
63329
diff
changeset
|
218 Any function or macro defined as Lisp code may be set to break on |
f7610876f0d3
(Function Debugging): Primitives can break on entry too.
Lute Kamstra <lute@gnu.org>
parents:
63329
diff
changeset
|
219 entry, regardless of whether it is interpreted code or compiled code. |
f7610876f0d3
(Function Debugging): Primitives can break on entry too.
Lute Kamstra <lute@gnu.org>
parents:
63329
diff
changeset
|
220 If the function is a command, it will enter the debugger when called |
f7610876f0d3
(Function Debugging): Primitives can break on entry too.
Lute Kamstra <lute@gnu.org>
parents:
63329
diff
changeset
|
221 from Lisp and when called interactively (after the reading of the |
f7610876f0d3
(Function Debugging): Primitives can break on entry too.
Lute Kamstra <lute@gnu.org>
parents:
63329
diff
changeset
|
222 arguments). You can also set debug-on-entry for primitive functions |
f7610876f0d3
(Function Debugging): Primitives can break on entry too.
Lute Kamstra <lute@gnu.org>
parents:
63329
diff
changeset
|
223 (i.e., those written in C) this way, but it only takes effect when the |
f7610876f0d3
(Function Debugging): Primitives can break on entry too.
Lute Kamstra <lute@gnu.org>
parents:
63329
diff
changeset
|
224 primitive is called from Lisp code. Debug-on-entry is not allowed for |
f7610876f0d3
(Function Debugging): Primitives can break on entry too.
Lute Kamstra <lute@gnu.org>
parents:
63329
diff
changeset
|
225 special forms. |
6558 | 226 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
227 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
|
228 @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
|
229 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
|
230 @code{debug-on-entry} always returns @var{function-name}. |
6558 | 231 |
52626 | 232 @strong{Warning:} if you redefine a function after using |
233 @code{debug-on-entry} on it, the code to enter the debugger is | |
234 discarded by the redefinition. In effect, redefining the function | |
235 cancels the break-on-entry feature for that function. | |
6558 | 236 |
58279
76be0b364843
(Function Debugging, Explicit Debug): Clarified.
Richard M. Stallman <rms@gnu.org>
parents:
54022
diff
changeset
|
237 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
|
238 |
6558 | 239 @example |
240 @group | |
241 (defun fact (n) | |
242 (if (zerop n) 1 | |
243 (* n (fact (1- n))))) | |
244 @result{} fact | |
245 @end group | |
246 @group | |
247 (debug-on-entry 'fact) | |
248 @result{} fact | |
249 @end group | |
250 @group | |
251 (fact 3) | |
252 @end group | |
253 | |
254 @group | |
255 ------ Buffer: *Backtrace* ------ | |
60315 | 256 Debugger entered--entering a function: |
6558 | 257 * fact(3) |
60315 | 258 eval((fact 3)) |
259 eval-last-sexp-1(nil) | |
6558 | 260 eval-last-sexp(nil) |
60315 | 261 call-interactively(eval-last-sexp) |
6558 | 262 ------ Buffer: *Backtrace* ------ |
263 @end group | |
264 | |
265 @group | |
266 (symbol-function 'fact) | |
267 @result{} (lambda (n) | |
268 (debug (quote debug)) | |
269 (if (zerop n) 1 (* n (fact (1- n))))) | |
270 @end group | |
271 @end example | |
272 @end deffn | |
273 | |
63283
911432fbdac4
(Error Debugging): Minor rewording.
Luc Teirlinck <teirllm@auburn.edu>
parents:
60403
diff
changeset
|
274 @deffn Command cancel-debug-on-entry &optional function-name |
6558 | 275 This function undoes the effect of @code{debug-on-entry} on |
276 @var{function-name}. When called interactively, it prompts for | |
12098 | 277 @var{function-name} in the minibuffer. If @var{function-name} is |
63329
e039251ba8e4
(Function Debugging): Delete mention of empty string argument to
Luc Teirlinck <teirllm@auburn.edu>
parents:
63283
diff
changeset
|
278 omitted or @code{nil}, it cancels break-on-entry for all functions. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
279 Calling @code{cancel-debug-on-entry} does nothing to a function which is |
63329
e039251ba8e4
(Function Debugging): Delete mention of empty string argument to
Luc Teirlinck <teirllm@auburn.edu>
parents:
63283
diff
changeset
|
280 not currently set up to break on entry. |
6558 | 281 @end deffn |
282 | |
283 @node Explicit Debug | |
284 @subsection Explicit Entry to the Debugger | |
285 | |
286 You can cause the debugger to be called at a certain point in your | |
287 program by writing the expression @code{(debug)} at that point. To do | |
288 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
|
289 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
|
290 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
|
291 purposes, be sure to undo this insertion before you save the file! |
6558 | 292 |
293 The place where you insert @samp{(debug)} must be a place where an | |
294 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
|
295 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
|
296 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
|
297 an implicit @code{progn} (@pxref{Sequencing}). |
6558 | 298 |
299 @node Using Debugger | |
300 @subsection Using the Debugger | |
301 | |
302 When the debugger is entered, it displays the previously selected | |
303 buffer in one window and a buffer named @samp{*Backtrace*} in another | |
304 window. The backtrace buffer contains one line for each level of Lisp | |
305 function execution currently going on. At the beginning of this buffer | |
306 is a message describing the reason that the debugger was invoked (such | |
307 as the error message and associated data, if it was invoked due to an | |
308 error). | |
309 | |
310 The backtrace buffer is read-only and uses a special major mode, | |
311 Debugger mode, in which letters are defined as debugger commands. The | |
312 usual Emacs editing commands are available; thus, you can switch windows | |
313 to examine the buffer that was being edited at the time of the error, | |
314 switch buffers, visit files, or do any other sort of editing. However, | |
315 the debugger is a recursive editing level (@pxref{Recursive Editing}) | |
316 and it is wise to go back to the backtrace buffer and exit the debugger | |
317 (with the @kbd{q} command) when you are finished with it. Exiting | |
318 the debugger gets out of the recursive edit and kills the backtrace | |
319 buffer. | |
320 | |
321 @cindex current stack frame | |
7214
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
322 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
|
323 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
|
324 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
|
325 place where the Lisp interpreter records information about a particular |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
326 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
|
327 considered the @dfn{current frame}. Some of the debugger commands |
60315 | 328 operate on the current frame. If a line starts with a star, that means |
329 that exiting that frame will call the debugger again. This is useful | |
330 for examining the return value of a function. | |
6558 | 331 |
43286
3fda6d6f3078
Explain about underlined functions in debugger buffer.
Richard M. Stallman <rms@gnu.org>
parents:
34179
diff
changeset
|
332 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
|
333 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
|
334 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
|
335 |
6558 | 336 The debugger itself must be run byte-compiled, since it makes |
337 assumptions about how many stack frames are used for the debugger | |
338 itself. These assumptions are false if the debugger is running | |
339 interpreted. | |
340 | |
341 @node Debugger Commands | |
342 @subsection Debugger Commands | |
343 @cindex debugger command list | |
344 | |
43286
3fda6d6f3078
Explain about underlined functions in debugger buffer.
Richard M. Stallman <rms@gnu.org>
parents:
34179
diff
changeset
|
345 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
|
346 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
|
347 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
|
348 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
|
349 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
|
350 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
|
351 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
|
352 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
|
353 type @kbd{C-M-x} on its definition.) |
6558 | 354 |
355 Here is a list of Debugger mode commands: | |
356 | |
357 @table @kbd | |
358 @item c | |
359 Exit the debugger and continue execution. When continuing is possible, | |
360 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
|
361 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
|
362 variable values or data structures while inside the debugger). |
6558 | 363 |
364 Continuing is possible after entry to the debugger due to function entry | |
365 or exit, explicit invocation, or quitting. You cannot continue if the | |
366 debugger was entered because of an error. | |
367 | |
368 @item d | |
369 Continue execution, but enter the debugger the next time any Lisp | |
370 function is called. This allows you to step through the | |
371 subexpressions of an expression, seeing what values the subexpressions | |
372 compute, and what else they do. | |
373 | |
374 The stack frame made for the function call which enters the debugger in | |
375 this way will be flagged automatically so that the debugger will be | |
376 called again when the frame is exited. You can use the @kbd{u} command | |
377 to cancel this flag. | |
378 | |
379 @item b | |
380 Flag the current frame so that the debugger will be entered when the | |
381 frame is exited. Frames flagged in this way are marked with stars | |
382 in the backtrace buffer. | |
383 | |
384 @item u | |
385 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
|
386 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
|
387 remove the star from the line in the backtrace buffer. |
6558 | 388 |
60315 | 389 @item j |
390 Flag the current frame like @kbd{b}. Then continue execution like | |
391 @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
|
392 are set up to do so by @code{debug-on-entry}. |
60315 | 393 |
6558 | 394 @item e |
395 Read a Lisp expression in the minibuffer, evaluate it, and print the | |
12098 | 396 value in the echo area. The debugger alters certain important |
397 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
|
398 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
|
399 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
|
400 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
|
401 the variable values within the debugger. |
6558 | 402 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
403 @item R |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
404 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
|
405 buffer @samp{*Debugger-record*}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
406 |
6558 | 407 @item q |
408 Terminate the program being debugged; return to top-level Emacs | |
409 command execution. | |
410 | |
411 If the debugger was entered due to a @kbd{C-g} but you really want | |
412 to quit, and not debug, use the @kbd{q} command. | |
413 | |
414 @item r | |
415 Return a value from the debugger. The value is computed by reading an | |
416 expression with the minibuffer and evaluating it. | |
417 | |
7214
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
418 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
|
419 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
|
420 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
|
421 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
|
422 @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
|
423 effect as @kbd{c}, and the specified return value does not matter. |
6558 | 424 |
425 You can't use @kbd{r} when the debugger was entered due to an error. | |
60315 | 426 |
427 @item l | |
428 Display a list of functions that will invoke the debugger when called. | |
429 This is a list of functions that are set to break on entry by means of | |
430 @code{debug-on-entry}. @strong{Warning:} if you redefine such a | |
431 function and thus cancel the effect of @code{debug-on-entry}, it may | |
432 erroneously show up in this list. | |
6558 | 433 @end table |
434 | |
435 @node Invoking the Debugger | |
436 @subsection Invoking the Debugger | |
437 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
438 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
|
439 to invoke the debugger. |
6558 | 440 |
441 @defun debug &rest debugger-args | |
442 This function enters the debugger. It switches buffers to a buffer | |
443 named @samp{*Backtrace*} (or @samp{*Backtrace*<2>} if it is the second | |
444 recursive entry to the debugger, etc.), and fills it with information | |
445 about the stack of Lisp function calls. It then enters a recursive | |
446 edit, showing the backtrace buffer in Debugger mode. | |
447 | |
60315 | 448 The Debugger mode @kbd{c}, @kbd{d}, @kbd{j}, and @kbd{r} commands exit |
449 the recursive edit; then @code{debug} switches back to the previous | |
450 buffer and returns to whatever called @code{debug}. This is the only | |
451 way the function @code{debug} can return to its caller. | |
6558 | 452 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
453 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
|
454 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
|
455 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
|
456 @emph{only} way these arguments are used. |
6558 | 457 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
458 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
|
459 special significance. (Normally, these values are used only by the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
460 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
|
461 is a table of these special values: |
6558 | 462 |
463 @table @code | |
464 @item lambda | |
465 @cindex @code{lambda} in debug | |
60315 | 466 A first argument of @code{lambda} means @code{debug} was called |
467 because of entry to a function when @code{debug-on-next-call} was | |
468 non-@code{nil}. The debugger displays @samp{Debugger | |
469 entered--entering a function:} as a line of text at the top of the | |
470 buffer. | |
6558 | 471 |
472 @item debug | |
60315 | 473 @code{debug} as first argument indicates a call to @code{debug} |
474 because of entry to a function that was set to debug on entry. The | |
475 debugger displays @samp{Debugger entered--entering a function:}, just | |
476 as in the @code{lambda} case. It also marks the stack frame for that | |
477 function so that it will invoke the debugger when exited. | |
6558 | 478 |
479 @item t | |
480 When the first argument is @code{t}, this indicates a call to | |
481 @code{debug} due to evaluation of a list form when | |
60315 | 482 @code{debug-on-next-call} is non-@code{nil}. The debugger displays |
483 @samp{Debugger entered--beginning evaluation of function call form:} | |
484 as the top line in the buffer. | |
6558 | 485 |
486 @item exit | |
60315 | 487 When the first argument is @code{exit}, it indicates the exit of a |
488 stack frame previously marked to invoke the debugger on exit. The | |
489 second argument given to @code{debug} in this case is the value being | |
490 returned from the frame. The debugger displays @samp{Debugger | |
491 entered--returning value:} in the top line of the buffer, followed by | |
492 the value being returned. | |
6558 | 493 |
494 @item error | |
495 @cindex @code{error} in debug | |
496 When the first argument is @code{error}, the debugger indicates that | |
60315 | 497 it is being entered because an error or @code{quit} was signaled and |
498 not handled, by displaying @samp{Debugger entered--Lisp error:} | |
499 followed by the error signaled and any arguments to @code{signal}. | |
500 For example, | |
6558 | 501 |
502 @example | |
503 @group | |
504 (let ((debug-on-error t)) | |
505 (/ 1 0)) | |
506 @end group | |
507 | |
508 @group | |
509 ------ Buffer: *Backtrace* ------ | |
60315 | 510 Debugger entered--Lisp error: (arith-error) |
6558 | 511 /(1 0) |
512 ... | |
513 ------ Buffer: *Backtrace* ------ | |
514 @end group | |
515 @end example | |
516 | |
517 If an error was signaled, presumably the variable | |
518 @code{debug-on-error} is non-@code{nil}. If @code{quit} was signaled, | |
519 then presumably the variable @code{debug-on-quit} is non-@code{nil}. | |
520 | |
521 @item nil | |
522 Use @code{nil} as the first of the @var{debugger-args} when you want | |
523 to enter the debugger explicitly. The rest of the @var{debugger-args} | |
524 are printed on the top line of the buffer. You can use this feature to | |
525 display messages---for example, to remind yourself of the conditions | |
526 under which @code{debug} is called. | |
527 @end table | |
528 @end defun | |
529 | |
530 @node Internals of Debugger | |
531 @subsection Internals of the Debugger | |
532 | |
533 This section describes functions and variables used internally by the | |
534 debugger. | |
535 | |
536 @defvar debugger | |
537 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
|
538 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
|
539 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
|
540 some kind of debugger. The default value of the variable is |
6558 | 541 @code{debug}. |
542 | |
543 The first argument that Lisp hands to the function indicates why it | |
544 was called. The convention for arguments is detailed in the description | |
60315 | 545 of @code{debug} (@pxref{Invoking the Debugger}). |
6558 | 546 @end defvar |
547 | |
548 @deffn Command backtrace | |
549 @cindex run time stack | |
550 @cindex call stack | |
551 This function prints a trace of Lisp function calls currently active. | |
552 This is the function used by @code{debug} to fill up the | |
553 @samp{*Backtrace*} buffer. It is written in C, since it must have access | |
554 to the stack to determine which function calls are active. The return | |
555 value is always @code{nil}. | |
556 | |
557 In the following example, a Lisp expression calls @code{backtrace} | |
558 explicitly. This prints the backtrace to the stream | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
559 @code{standard-output}, which, in this case, is the buffer |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
560 @samp{backtrace-output}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
561 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
562 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
|
563 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
|
564 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
|
565 forms are elided. |
6558 | 566 |
567 @smallexample | |
568 @group | |
569 (with-output-to-temp-buffer "backtrace-output" | |
570 (let ((var 1)) | |
571 (save-excursion | |
572 (setq var (eval '(progn | |
573 (1+ var) | |
574 (list 'testing (backtrace)))))))) | |
575 | |
54022
118899be0578
(Internals of Debugger): Fix return value.
Richard M. Stallman <rms@gnu.org>
parents:
52626
diff
changeset
|
576 @result{} (testing nil) |
6558 | 577 @end group |
578 | |
579 @group | |
580 ----------- Buffer: backtrace-output ------------ | |
581 backtrace() | |
582 (list ...computing arguments...) | |
22274
f0cd03a7dac9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
583 @end group |
6558 | 584 (progn ...) |
585 eval((progn (1+ var) (list (quote testing) (backtrace)))) | |
586 (setq ...) | |
587 (save-excursion ...) | |
588 (let ...) | |
589 (with-output-to-temp-buffer ...) | |
60315 | 590 eval((with-output-to-temp-buffer ...)) |
591 eval-last-sexp-1(nil) | |
22274
f0cd03a7dac9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
592 @group |
60315 | 593 eval-last-sexp(nil) |
594 call-interactively(eval-last-sexp) | |
6558 | 595 ----------- Buffer: backtrace-output ------------ |
596 @end group | |
597 @end smallexample | |
598 @end deffn | |
599 | |
600 @ignore @c Not worth mentioning | |
601 @defopt stack-trace-on-error | |
602 @cindex stack trace | |
603 This variable controls whether Lisp automatically displays a | |
604 backtrace buffer after every error that is not handled. A quit signal | |
605 counts as an error for this variable. If it is non-@code{nil} then a | |
606 backtrace is shown in a pop-up buffer named @samp{*Backtrace*} on every | |
607 error. If it is @code{nil}, then a backtrace is not shown. | |
608 | |
609 When a backtrace is shown, that buffer is not selected. If either | |
610 @code{debug-on-quit} or @code{debug-on-error} is also non-@code{nil}, then | |
611 a backtrace is shown in one buffer, and the debugger is popped up in | |
612 another buffer with its own backtrace. | |
613 | |
614 We consider this feature to be obsolete and superseded by the debugger | |
615 itself. | |
616 @end defopt | |
617 @end ignore | |
618 | |
619 @defvar debug-on-next-call | |
620 @cindex @code{eval}, and debugging | |
621 @cindex @code{apply}, and debugging | |
622 @cindex @code{funcall}, and debugging | |
623 If this variable is non-@code{nil}, it says to call the debugger before | |
624 the next @code{eval}, @code{apply} or @code{funcall}. Entering the | |
625 debugger sets @code{debug-on-next-call} to @code{nil}. | |
626 | |
627 The @kbd{d} command in the debugger works by setting this variable. | |
628 @end defvar | |
629 | |
630 @defun backtrace-debug level flag | |
631 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
|
632 levels down the stack, giving it the value @var{flag}. If @var{flag} is |
6558 | 633 non-@code{nil}, this will cause the debugger to be entered when that |
634 frame later exits. Even a nonlocal exit through that frame will enter | |
635 the debugger. | |
636 | |
7214
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
637 This function is used only by the debugger. |
6558 | 638 @end defun |
639 | |
640 @defvar command-debug-status | |
12098 | 641 This variable records the debugging status of the current interactive |
6558 | 642 command. Each time a command is called interactively, this variable is |
643 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
|
644 information for future debugger invocations during the same command |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15725
diff
changeset
|
645 invocation. |
6558 | 646 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
647 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
|
648 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
|
649 invocation. |
6558 | 650 @end defvar |
651 | |
652 @defun backtrace-frame frame-number | |
653 The function @code{backtrace-frame} is intended for use in Lisp | |
654 debuggers. It returns information about what computation is happening | |
655 in the stack frame @var{frame-number} levels down. | |
656 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
657 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
|
658 form, the value is @code{(nil @var{function} @var{arg-forms}@dots{})}. |
6558 | 659 |
660 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
|
661 already, the return value is @code{(t @var{function} |
6558 | 662 @var{arg-values}@dots{})}. |
663 | |
7214
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
664 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
|
665 @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
|
666 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
|
667 is represented as the tail of the list @var{arg-values}. |
6558 | 668 |
7214
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
669 If @var{frame-number} is out of range, @code{backtrace-frame} returns |
6558 | 670 @code{nil}. |
671 @end defun | |
672 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
673 @include edebug.texi |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
674 |
6558 | 675 @node Syntax Errors |
676 @section Debugging Invalid Lisp Syntax | |
677 | |
678 The Lisp reader reports invalid syntax, but cannot say where the real | |
679 problem is. For example, the error ``End of file during parsing'' in | |
680 evaluating an expression indicates an excess of open parentheses (or | |
681 square brackets). The reader detects this imbalance at the end of the | |
682 file, but it cannot figure out where the close parenthesis should have | |
683 been. Likewise, ``Invalid read syntax: ")"'' indicates an excess close | |
684 parenthesis or missing open parenthesis, but does not say where the | |
685 missing parenthesis belongs. How, then, to find what to change? | |
686 | |
687 If the problem is not simply an imbalance of parentheses, a useful | |
688 technique is to try @kbd{C-M-e} at the beginning of each defun, and see | |
689 if it goes to the place where that defun appears to end. If it does | |
690 not, there is a problem in that defun. | |
691 | |
692 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
|
693 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
|
694 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
|
695 find the mismatch.) |
6558 | 696 |
697 @menu | |
698 * Excess Open:: How to find a spurious open paren or missing close. | |
699 * Excess Close:: How to find a spurious close paren or missing open. | |
700 @end menu | |
701 | |
702 @node Excess Open | |
703 @subsection Excess Open Parentheses | |
704 | |
705 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
|
706 an excess open parenthesis, the way to do this is to go to the end of |
60315 | 707 the file and type @kbd{C-u C-M-u}. This will move you to the |
708 beginning of the first defun that is unbalanced. | |
6558 | 709 |
710 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
|
711 way to be sure of this except by studying the program, but often the |
6558 | 712 existing indentation is a clue to where the parentheses should have |
713 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
|
714 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
|
715 first. |
6558 | 716 |
717 Before you do this, make sure the defun has enough close parentheses. | |
718 Otherwise, @kbd{C-M-q} will get an error, or will reindent all the rest | |
719 of the file until the end. So move to the end of the defun and insert a | |
720 close parenthesis there. Don't use @kbd{C-M-e} to move there, since | |
721 that too will fail to work until the defun is balanced. | |
722 | |
723 Now you can go to the beginning of the defun and type @kbd{C-M-q}. | |
724 Usually all the lines from a certain point to the end of the function | |
725 will shift to the right. There is probably a missing close parenthesis, | |
726 or a superfluous open parenthesis, near that point. (However, don't | |
727 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
|
728 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
|
729 indentation is probably appropriate to the intended parentheses. |
6558 | 730 |
731 After you think you have fixed the problem, use @kbd{C-M-q} again. If | |
732 the old indentation actually fit the intended nesting of parentheses, | |
733 and you have put back those parentheses, @kbd{C-M-q} should not change | |
734 anything. | |
735 | |
736 @node Excess Close | |
737 @subsection Excess Close Parentheses | |
738 | |
60315 | 739 To deal with an excess close parenthesis, first go to the beginning |
740 of the file, then type @kbd{C-u -1 C-M-u} to find the end of the first | |
741 unbalanced defun. | |
6558 | 742 |
743 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
|
744 at the beginning of that defun. This will leave you somewhere short of |
6558 | 745 the place where the defun ought to end. It is possible that you will |
746 find a spurious close parenthesis in that vicinity. | |
747 | |
748 If you don't see a problem at that point, the next thing to do is to | |
749 type @kbd{C-M-q} at the beginning of the defun. A range of lines will | |
750 probably shift left; if so, the missing open parenthesis or spurious | |
751 close parenthesis is probably near the first of those lines. (However, | |
752 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
|
753 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
|
754 old indentation is probably appropriate to the intended parentheses. |
6558 | 755 |
7214
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
756 After you think you have fixed the problem, use @kbd{C-M-q} again. If |
26254 | 757 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
|
758 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
|
759 anything. |
5a6f2a00002d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
760 |
52140
e00701b0e24f
(Test Coverage): New node.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
761 @node Test Coverage |
e00701b0e24f
(Test Coverage): New node.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
762 @section Test Coverage |
e00701b0e24f
(Test Coverage): New node.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
763 @cindex coverage testing |
e00701b0e24f
(Test Coverage): New node.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
764 |
e00701b0e24f
(Test Coverage): New node.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
765 @findex testcover-start |
e00701b0e24f
(Test Coverage): New node.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
766 @findex testcover-mark-all |
e00701b0e24f
(Test Coverage): New node.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
767 @findex testcover-next-mark |
58279
76be0b364843
(Function Debugging, Explicit Debug): Clarified.
Richard M. Stallman <rms@gnu.org>
parents:
54022
diff
changeset
|
768 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
|
769 @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
|
770 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
|
771 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
|
772 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
|
773 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
|
774 @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
|
775 highlighted spot. |
52140
e00701b0e24f
(Test Coverage): New node.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
776 |
58279
76be0b364843
(Function Debugging, Explicit Debug): Clarified.
Richard M. Stallman <rms@gnu.org>
parents:
54022
diff
changeset
|
777 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
|
778 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
|
779 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
|
780 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
|
781 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
|
782 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
|
783 the same value, such as @code{(setq x 14)}. |
e00701b0e24f
(Test Coverage): New node.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
784 |
e00701b0e24f
(Test Coverage): New node.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
785 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
|
786 give advice to the test coverage tool. |
e00701b0e24f
(Test Coverage): New node.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
787 |
e00701b0e24f
(Test Coverage): New node.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
788 @defmac 1value form |
e00701b0e24f
(Test Coverage): New node.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
789 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
|
790 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
|
791 @end defmac |
e00701b0e24f
(Test Coverage): New node.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
792 |
e00701b0e24f
(Test Coverage): New node.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
793 @defmac noreturn form |
e00701b0e24f
(Test Coverage): New node.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
794 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
|
795 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
|
796 @end defmac |
e00701b0e24f
(Test Coverage): New node.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
797 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
798 @node Compilation Errors |
6558 | 799 @section Debugging Problems in Compilation |
800 | |
801 When an error happens during byte compilation, it is normally due to | |
802 invalid syntax in the program you are compiling. The compiler prints a | |
803 suitable error message in the @samp{*Compile-Log*} buffer, and then | |
804 stops. The message may state a function name in which the error was | |
805 found, or it may not. Either way, here is how to find out where in the | |
806 file the error occurred. | |
807 | |
808 What you should do is switch to the buffer @w{@samp{ *Compiler Input*}}. | |
809 (Note that the buffer name starts with a space, so it does not show | |
810 up in @kbd{M-x list-buffers}.) This buffer contains the program being | |
811 compiled, and point shows how far the byte compiler was able to read. | |
812 | |
813 If the error was due to invalid Lisp syntax, point shows exactly where | |
814 the invalid syntax was @emph{detected}. The cause of the error is not | |
815 necessarily near by! Use the techniques in the previous section to find | |
816 the error. | |
817 | |
818 If the error was detected while compiling a form that had been read | |
819 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
|
820 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
|
821 show you which function to check. |
52401 | 822 |
823 @ignore | |
824 arch-tag: ddc57378-b0e6-4195-b7b6-43f8777395a7 | |
825 @end ignore |