annotate lispref/debugging.texi @ 58388:23dfc76d3625

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