annotate man/building.texi @ 30287:237a66bc6cea

(Info-title-face-alist): Removed.
author Gerd Moellmann <gerd@gnu.org>
date Tue, 18 Jul 2000 12:59:17 +0000
parents 315d6e79ea38
children 561ef681eab5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1 @c This is part of the Emacs manual.
27223
ac1bc60cf0b4 GUD tooltips.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
2 @c Copyright (C) 1985, 86, 87, 93, 94, 95, 97, 2000 Free Software Foundation, Inc.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3 @c See file emacs.texi for copying conditions.
Dave Love <fx@gnu.org>
parents:
diff changeset
4 @node Building, Abbrevs, Programs, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
5 @chapter Compiling and Testing Programs
Dave Love <fx@gnu.org>
parents:
diff changeset
6 @cindex building programs
Dave Love <fx@gnu.org>
parents:
diff changeset
7 @cindex program building
Dave Love <fx@gnu.org>
parents:
diff changeset
8 @cindex running Lisp functions
Dave Love <fx@gnu.org>
parents:
diff changeset
9
Dave Love <fx@gnu.org>
parents:
diff changeset
10 The previous chapter discusses the Emacs commands that are useful for
Dave Love <fx@gnu.org>
parents:
diff changeset
11 making changes in programs. This chapter deals with commands that assist
Dave Love <fx@gnu.org>
parents:
diff changeset
12 in the larger process of developing and maintaining programs.
Dave Love <fx@gnu.org>
parents:
diff changeset
13
Dave Love <fx@gnu.org>
parents:
diff changeset
14 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
15 * Compilation:: Compiling programs in languages other
Dave Love <fx@gnu.org>
parents:
diff changeset
16 than Lisp (C, Pascal, etc.).
Dave Love <fx@gnu.org>
parents:
diff changeset
17 * Grep Searching:: Running grep as if it were a compiler.
Dave Love <fx@gnu.org>
parents:
diff changeset
18 * Compilation Mode:: The mode for visiting compiler errors.
Dave Love <fx@gnu.org>
parents:
diff changeset
19 * Compilation Shell:: Customizing your shell properly
Dave Love <fx@gnu.org>
parents:
diff changeset
20 for use in the compilation buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
21 * Debuggers:: Running symbolic debuggers for non-Lisp programs.
Dave Love <fx@gnu.org>
parents:
diff changeset
22 * Executing Lisp:: Various modes for editing Lisp programs,
Dave Love <fx@gnu.org>
parents:
diff changeset
23 with different facilities for running
Dave Love <fx@gnu.org>
parents:
diff changeset
24 the Lisp programs.
Dave Love <fx@gnu.org>
parents:
diff changeset
25 * Libraries: Lisp Libraries. Creating Lisp programs to run in Emacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
26 * Interaction: Lisp Interaction. Executing Lisp in an Emacs buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
27 * Eval: Lisp Eval. Executing a single Lisp expression in Emacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
28 * External Lisp:: Communicating through Emacs with a separate Lisp.
Dave Love <fx@gnu.org>
parents:
diff changeset
29 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
30
Dave Love <fx@gnu.org>
parents:
diff changeset
31 @node Compilation
Dave Love <fx@gnu.org>
parents:
diff changeset
32 @section Running Compilations under Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
33 @cindex inferior process
Dave Love <fx@gnu.org>
parents:
diff changeset
34 @cindex make
Dave Love <fx@gnu.org>
parents:
diff changeset
35 @cindex compilation errors
Dave Love <fx@gnu.org>
parents:
diff changeset
36 @cindex error log
Dave Love <fx@gnu.org>
parents:
diff changeset
37
Dave Love <fx@gnu.org>
parents:
diff changeset
38 Emacs can run compilers for noninteractive languages such as C and
Dave Love <fx@gnu.org>
parents:
diff changeset
39 Fortran as inferior processes, feeding the error log into an Emacs buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
40 It can also parse the error messages and show you the source lines where
Dave Love <fx@gnu.org>
parents:
diff changeset
41 compilation errors occurred.
Dave Love <fx@gnu.org>
parents:
diff changeset
42
Dave Love <fx@gnu.org>
parents:
diff changeset
43 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
44 @item M-x compile
Dave Love <fx@gnu.org>
parents:
diff changeset
45 Run a compiler asynchronously under Emacs, with error messages to
Dave Love <fx@gnu.org>
parents:
diff changeset
46 @samp{*compilation*} buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
47 @item M-x grep
Dave Love <fx@gnu.org>
parents:
diff changeset
48 Run @code{grep} asynchronously under Emacs, with matching lines
Dave Love <fx@gnu.org>
parents:
diff changeset
49 listed in the buffer named @samp{*grep*}.
Dave Love <fx@gnu.org>
parents:
diff changeset
50 @item M-x grep-find
Dave Love <fx@gnu.org>
parents:
diff changeset
51 Run @code{grep} via @code{find}, with user-specified arguments, and
Dave Love <fx@gnu.org>
parents:
diff changeset
52 collect output in the buffer named @samp{*grep*}.
Dave Love <fx@gnu.org>
parents:
diff changeset
53 @item M-x kill-compilation
Dave Love <fx@gnu.org>
parents:
diff changeset
54 @itemx M-x kill-grep
Dave Love <fx@gnu.org>
parents:
diff changeset
55 Kill the running compilation or @code{grep} subprocess.
Dave Love <fx@gnu.org>
parents:
diff changeset
56 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
57
Dave Love <fx@gnu.org>
parents:
diff changeset
58 @findex compile
Dave Love <fx@gnu.org>
parents:
diff changeset
59 To run @code{make} or another compilation command, do @kbd{M-x
Dave Love <fx@gnu.org>
parents:
diff changeset
60 compile}. This command reads a shell command line using the minibuffer,
Dave Love <fx@gnu.org>
parents:
diff changeset
61 and then executes the command in an inferior shell, putting output in
Dave Love <fx@gnu.org>
parents:
diff changeset
62 the buffer named @samp{*compilation*}. The current buffer's default
Dave Love <fx@gnu.org>
parents:
diff changeset
63 directory is used as the working directory for the execution of the
Dave Love <fx@gnu.org>
parents:
diff changeset
64 command; normally, therefore, the compilation happens in this
Dave Love <fx@gnu.org>
parents:
diff changeset
65 directory.
Dave Love <fx@gnu.org>
parents:
diff changeset
66
Dave Love <fx@gnu.org>
parents:
diff changeset
67 @vindex compile-command
Dave Love <fx@gnu.org>
parents:
diff changeset
68 When the shell command line is read, the minibuffer appears containing
Dave Love <fx@gnu.org>
parents:
diff changeset
69 a default command line, which is the command you used the last time you
Dave Love <fx@gnu.org>
parents:
diff changeset
70 did @kbd{M-x compile}. If you type just @key{RET}, the same command
Dave Love <fx@gnu.org>
parents:
diff changeset
71 line is used again. For the first @kbd{M-x compile}, the default is
Dave Love <fx@gnu.org>
parents:
diff changeset
72 @samp{make -k}. The default compilation command comes from the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
73 @code{compile-command}; if the appropriate compilation command for a
Dave Love <fx@gnu.org>
parents:
diff changeset
74 file is something other than @samp{make -k}, it can be useful for the
Dave Love <fx@gnu.org>
parents:
diff changeset
75 file to specify a local value for @code{compile-command} (@pxref{File
Dave Love <fx@gnu.org>
parents:
diff changeset
76 Variables}).
Dave Love <fx@gnu.org>
parents:
diff changeset
77
Dave Love <fx@gnu.org>
parents:
diff changeset
78 Starting a compilation displays the buffer @samp{*compilation*} in
Dave Love <fx@gnu.org>
parents:
diff changeset
79 another window but does not select it. The buffer's mode line tells you
Dave Love <fx@gnu.org>
parents:
diff changeset
80 whether compilation is finished, with the word @samp{run} or @samp{exit}
Dave Love <fx@gnu.org>
parents:
diff changeset
81 inside the parentheses. You do not have to keep this buffer visible;
Dave Love <fx@gnu.org>
parents:
diff changeset
82 compilation continues in any case. While a compilation is going on, the
Dave Love <fx@gnu.org>
parents:
diff changeset
83 string @samp{Compiling} appears in the mode lines of all windows. When
Dave Love <fx@gnu.org>
parents:
diff changeset
84 this string disappears, the compilation is finished.
Dave Love <fx@gnu.org>
parents:
diff changeset
85
Dave Love <fx@gnu.org>
parents:
diff changeset
86 If you want to watch the compilation transcript as it appears, switch
Dave Love <fx@gnu.org>
parents:
diff changeset
87 to the @samp{*compilation*} buffer and move point to the end of the
Dave Love <fx@gnu.org>
parents:
diff changeset
88 buffer. When point is at the end, new compilation output is inserted
Dave Love <fx@gnu.org>
parents:
diff changeset
89 above point, which remains at the end. If point is not at the end of
Dave Love <fx@gnu.org>
parents:
diff changeset
90 the buffer, it remains fixed while more compilation output is added at
Dave Love <fx@gnu.org>
parents:
diff changeset
91 the end of the buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
92
Dave Love <fx@gnu.org>
parents:
diff changeset
93 @vindex compilation-scroll-output
Dave Love <fx@gnu.org>
parents:
diff changeset
94 If you set the variable @code{compilation-scroll-output} to a
Dave Love <fx@gnu.org>
parents:
diff changeset
95 non-@code{nil} value, then the compilation buffer always scrolls to
Dave Love <fx@gnu.org>
parents:
diff changeset
96 follow output as it comes in.
Dave Love <fx@gnu.org>
parents:
diff changeset
97
Dave Love <fx@gnu.org>
parents:
diff changeset
98 @findex kill-compilation
Dave Love <fx@gnu.org>
parents:
diff changeset
99 To kill the compilation process, do @kbd{M-x kill-compilation}. When
Dave Love <fx@gnu.org>
parents:
diff changeset
100 the compiler process terminates, the mode line of the
Dave Love <fx@gnu.org>
parents:
diff changeset
101 @samp{*compilation*} buffer changes to say @samp{signal} instead of
Dave Love <fx@gnu.org>
parents:
diff changeset
102 @samp{run}. Starting a new compilation also kills any running
Dave Love <fx@gnu.org>
parents:
diff changeset
103 compilation, as only one can exist at any time. However, @kbd{M-x
Dave Love <fx@gnu.org>
parents:
diff changeset
104 compile} asks for confirmation before actually killing a compilation
Dave Love <fx@gnu.org>
parents:
diff changeset
105 that is running.
Dave Love <fx@gnu.org>
parents:
diff changeset
106
Dave Love <fx@gnu.org>
parents:
diff changeset
107 @node Grep Searching
Dave Love <fx@gnu.org>
parents:
diff changeset
108 @section Searching with Grep under Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
109
Dave Love <fx@gnu.org>
parents:
diff changeset
110 @findex grep
Dave Love <fx@gnu.org>
parents:
diff changeset
111 Just as you can run a compiler from Emacs and then visit the lines
Dave Love <fx@gnu.org>
parents:
diff changeset
112 where there were compilation errors, you can also run @code{grep} and
Dave Love <fx@gnu.org>
parents:
diff changeset
113 then visit the lines on which matches were found. This works by
Dave Love <fx@gnu.org>
parents:
diff changeset
114 treating the matches reported by @code{grep} as if they were ``errors.''
Dave Love <fx@gnu.org>
parents:
diff changeset
115
Dave Love <fx@gnu.org>
parents:
diff changeset
116 To do this, type @kbd{M-x grep}, then enter a command line that
Dave Love <fx@gnu.org>
parents:
diff changeset
117 specifies how to run @code{grep}. Use the same arguments you would give
Dave Love <fx@gnu.org>
parents:
diff changeset
118 @code{grep} when running it normally: a @code{grep}-style regexp
Dave Love <fx@gnu.org>
parents:
diff changeset
119 (usually in single-quotes to quote the shell's special characters)
Dave Love <fx@gnu.org>
parents:
diff changeset
120 followed by file names, which may use wildcards. The output from
Dave Love <fx@gnu.org>
parents:
diff changeset
121 @code{grep} goes in the @samp{*grep*} buffer. You can find the
Dave Love <fx@gnu.org>
parents:
diff changeset
122 corresponding lines in the original files using @kbd{C-x `} and
Dave Love <fx@gnu.org>
parents:
diff changeset
123 @key{RET}, as with compilation errors.
Dave Love <fx@gnu.org>
parents:
diff changeset
124
Dave Love <fx@gnu.org>
parents:
diff changeset
125 If you specify a prefix argument for @kbd{M-x grep}, it figures out
Dave Love <fx@gnu.org>
parents:
diff changeset
126 the tag (@pxref{Tags}) around point, and puts that into the default
Dave Love <fx@gnu.org>
parents:
diff changeset
127 @code{grep} command.
Dave Love <fx@gnu.org>
parents:
diff changeset
128
Dave Love <fx@gnu.org>
parents:
diff changeset
129 @findex grep-find
Dave Love <fx@gnu.org>
parents:
diff changeset
130 The command @kbd{M-x grep-find} is similar to @kbd{M-x grep}, but it
Dave Love <fx@gnu.org>
parents:
diff changeset
131 supplies a different initial default for the command---one that runs
Dave Love <fx@gnu.org>
parents:
diff changeset
132 both @code{find} and @code{grep}, so as to search every file in a
Dave Love <fx@gnu.org>
parents:
diff changeset
133 directory tree. See also the @code{find-grep-dired} command,
Dave Love <fx@gnu.org>
parents:
diff changeset
134 in @ref{Dired and Find}.
Dave Love <fx@gnu.org>
parents:
diff changeset
135
Dave Love <fx@gnu.org>
parents:
diff changeset
136 @node Compilation Mode
Dave Love <fx@gnu.org>
parents:
diff changeset
137 @section Compilation Mode
Dave Love <fx@gnu.org>
parents:
diff changeset
138
Dave Love <fx@gnu.org>
parents:
diff changeset
139 @findex compile-goto-error
Dave Love <fx@gnu.org>
parents:
diff changeset
140 @cindex Compilation mode
Dave Love <fx@gnu.org>
parents:
diff changeset
141 @cindex mode, Compilation
Dave Love <fx@gnu.org>
parents:
diff changeset
142 The @samp{*compilation*} buffer uses a special major mode, Compilation
Dave Love <fx@gnu.org>
parents:
diff changeset
143 mode, whose main feature is to provide a convenient way to look at the
Dave Love <fx@gnu.org>
parents:
diff changeset
144 source line where the error happened.
Dave Love <fx@gnu.org>
parents:
diff changeset
145
Dave Love <fx@gnu.org>
parents:
diff changeset
146 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
147 @item C-x `
Dave Love <fx@gnu.org>
parents:
diff changeset
148 Visit the locus of the next compiler error message or @code{grep} match.
Dave Love <fx@gnu.org>
parents:
diff changeset
149 @item @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
150 Visit the locus of the error message that point is on.
Dave Love <fx@gnu.org>
parents:
diff changeset
151 This command is used in the compilation buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
152 @item Mouse-2
Dave Love <fx@gnu.org>
parents:
diff changeset
153 Visit the locus of the error message that you click on.
Dave Love <fx@gnu.org>
parents:
diff changeset
154 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
155
Dave Love <fx@gnu.org>
parents:
diff changeset
156 @kindex C-x `
Dave Love <fx@gnu.org>
parents:
diff changeset
157 @findex next-error
Dave Love <fx@gnu.org>
parents:
diff changeset
158 You can visit the source for any particular error message by moving
Dave Love <fx@gnu.org>
parents:
diff changeset
159 point in @samp{*compilation*} to that error message and typing @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
160 (@code{compile-goto-error}). Or click @kbd{Mouse-2} on the error message;
Dave Love <fx@gnu.org>
parents:
diff changeset
161 you need not switch to the @samp{*compilation*} buffer first.
Dave Love <fx@gnu.org>
parents:
diff changeset
162
Dave Love <fx@gnu.org>
parents:
diff changeset
163 To parse the compiler error messages sequentially, type @kbd{C-x `}
Dave Love <fx@gnu.org>
parents:
diff changeset
164 (@code{next-error}). The character following the @kbd{C-x} is the
Dave Love <fx@gnu.org>
parents:
diff changeset
165 backquote or ``grave accent,'' not the single-quote. This command is
Dave Love <fx@gnu.org>
parents:
diff changeset
166 available in all buffers, not just in @samp{*compilation*}; it displays
Dave Love <fx@gnu.org>
parents:
diff changeset
167 the next error message at the top of one window and source location of
Dave Love <fx@gnu.org>
parents:
diff changeset
168 the error in another window.
Dave Love <fx@gnu.org>
parents:
diff changeset
169
Dave Love <fx@gnu.org>
parents:
diff changeset
170 The first time @kbd{C-x `} is used after the start of a compilation,
Dave Love <fx@gnu.org>
parents:
diff changeset
171 it moves to the first error's location. Subsequent uses of @kbd{C-x `}
Dave Love <fx@gnu.org>
parents:
diff changeset
172 advance down to subsequent errors. If you visit a specific error
Dave Love <fx@gnu.org>
parents:
diff changeset
173 message with @key{RET} or @kbd{Mouse-2}, subsequent @kbd{C-x `}
Dave Love <fx@gnu.org>
parents:
diff changeset
174 commands advance from there. When @kbd{C-x `} gets to the end of the
Dave Love <fx@gnu.org>
parents:
diff changeset
175 buffer and finds no more error messages to visit, it fails and signals
Dave Love <fx@gnu.org>
parents:
diff changeset
176 an Emacs error.
Dave Love <fx@gnu.org>
parents:
diff changeset
177
Dave Love <fx@gnu.org>
parents:
diff changeset
178 @kbd{C-u C-x `} starts scanning from the beginning of the compilation
Dave Love <fx@gnu.org>
parents:
diff changeset
179 buffer. This is one way to process the same set of errors again.
Dave Love <fx@gnu.org>
parents:
diff changeset
180
Dave Love <fx@gnu.org>
parents:
diff changeset
181 Compilation mode also redefines the keys @key{SPC} and @key{DEL} to
Dave Love <fx@gnu.org>
parents:
diff changeset
182 scroll by screenfuls, and @kbd{M-n} and @kbd{M-p} to move to the next or
Dave Love <fx@gnu.org>
parents:
diff changeset
183 previous error message. You can also use @kbd{M-@{} and @kbd{M-@}} to
Dave Love <fx@gnu.org>
parents:
diff changeset
184 move up or down to an error message for a different source file.
Dave Love <fx@gnu.org>
parents:
diff changeset
185
Dave Love <fx@gnu.org>
parents:
diff changeset
186 The features of Compilation mode are also available in a minor mode
Dave Love <fx@gnu.org>
parents:
diff changeset
187 called Compilation Minor mode. This lets you parse error messages in
Dave Love <fx@gnu.org>
parents:
diff changeset
188 any buffer, not just a normal compilation output buffer. Type @kbd{M-x
Dave Love <fx@gnu.org>
parents:
diff changeset
189 compilation-minor-mode} to enable the minor mode. This defines the keys
Dave Love <fx@gnu.org>
parents:
diff changeset
190 @key{RET} and @kbd{Mouse-2}, as in the Compilation major mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
191
Dave Love <fx@gnu.org>
parents:
diff changeset
192 Compilation minor mode works in any buffer, as long as the contents
Dave Love <fx@gnu.org>
parents:
diff changeset
193 are in a format that it understands. In an Rlogin buffer (@pxref{Remote
Dave Love <fx@gnu.org>
parents:
diff changeset
194 Host}), Compilation minor mode automatically accesses remote source
Dave Love <fx@gnu.org>
parents:
diff changeset
195 files by FTP (@pxref{File Names}).
Dave Love <fx@gnu.org>
parents:
diff changeset
196
Dave Love <fx@gnu.org>
parents:
diff changeset
197 @node Compilation Shell
Dave Love <fx@gnu.org>
parents:
diff changeset
198 @section Subshells for Compilation
Dave Love <fx@gnu.org>
parents:
diff changeset
199
Dave Love <fx@gnu.org>
parents:
diff changeset
200 Emacs uses a shell to run the compilation command, but specifies
Dave Love <fx@gnu.org>
parents:
diff changeset
201 the option for a noninteractive shell. This means, in particular, that
Dave Love <fx@gnu.org>
parents:
diff changeset
202 the shell should start with no prompt. If you find your usual shell
Dave Love <fx@gnu.org>
parents:
diff changeset
203 prompt making an unsightly appearance in the @samp{*compilation*}
Dave Love <fx@gnu.org>
parents:
diff changeset
204 buffer, it means you have made a mistake in your shell's init file by
Dave Love <fx@gnu.org>
parents:
diff changeset
205 setting the prompt unconditionally. (This init file's name may be
Dave Love <fx@gnu.org>
parents:
diff changeset
206 @file{.bashrc}, @file{.profile}, @file{.cshrc}, @file{.shrc}, or various
Dave Love <fx@gnu.org>
parents:
diff changeset
207 other things, depending on the shell you use.) The shell init file
Dave Love <fx@gnu.org>
parents:
diff changeset
208 should set the prompt only if there already is a prompt. In csh, here
Dave Love <fx@gnu.org>
parents:
diff changeset
209 is how to do it:
Dave Love <fx@gnu.org>
parents:
diff changeset
210
Dave Love <fx@gnu.org>
parents:
diff changeset
211 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
212 if ($?prompt) set prompt = @dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
213 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
214
Dave Love <fx@gnu.org>
parents:
diff changeset
215 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
216 And here's how to do it in bash:
Dave Love <fx@gnu.org>
parents:
diff changeset
217
Dave Love <fx@gnu.org>
parents:
diff changeset
218 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
219 if [ "$@{PS1+set@}" = set ]
Dave Love <fx@gnu.org>
parents:
diff changeset
220 then PS1=@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
221 fi
Dave Love <fx@gnu.org>
parents:
diff changeset
222 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
223
Dave Love <fx@gnu.org>
parents:
diff changeset
224 There may well be other things that your shell's init file
Dave Love <fx@gnu.org>
parents:
diff changeset
225 ought to do only for an interactive shell. You can use the same
Dave Love <fx@gnu.org>
parents:
diff changeset
226 method to conditionalize them.
Dave Love <fx@gnu.org>
parents:
diff changeset
227
Dave Love <fx@gnu.org>
parents:
diff changeset
228 The MS-DOS ``operating system'' does not support asynchronous
Dave Love <fx@gnu.org>
parents:
diff changeset
229 subprocesses; to work around this lack, @kbd{M-x compile} runs the
Dave Love <fx@gnu.org>
parents:
diff changeset
230 compilation command synchronously on MS-DOS. As a consequence, you must
Dave Love <fx@gnu.org>
parents:
diff changeset
231 wait until the command finishes before you can do anything else in
Dave Love <fx@gnu.org>
parents:
diff changeset
232 Emacs. @xref{MS-DOS}.
Dave Love <fx@gnu.org>
parents:
diff changeset
233
Dave Love <fx@gnu.org>
parents:
diff changeset
234 @node Debuggers
Dave Love <fx@gnu.org>
parents:
diff changeset
235 @section Running Debuggers Under Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
236 @cindex debuggers
Dave Love <fx@gnu.org>
parents:
diff changeset
237 @cindex GUD library
Dave Love <fx@gnu.org>
parents:
diff changeset
238 @cindex GDB
Dave Love <fx@gnu.org>
parents:
diff changeset
239 @cindex DBX
Dave Love <fx@gnu.org>
parents:
diff changeset
240 @cindex SDB
Dave Love <fx@gnu.org>
parents:
diff changeset
241 @cindex XDB
Dave Love <fx@gnu.org>
parents:
diff changeset
242 @cindex Perldb
Dave Love <fx@gnu.org>
parents:
diff changeset
243 @cindex JDB
Dave Love <fx@gnu.org>
parents:
diff changeset
244 @cindex PDB
Dave Love <fx@gnu.org>
parents:
diff changeset
245
Dave Love <fx@gnu.org>
parents:
diff changeset
246 @c Do you believe in GUD?
Dave Love <fx@gnu.org>
parents:
diff changeset
247 The GUD (Grand Unified Debugger) library provides an interface to
Dave Love <fx@gnu.org>
parents:
diff changeset
248 various symbolic debuggers from within Emacs. We recommend the debugger
Dave Love <fx@gnu.org>
parents:
diff changeset
249 GDB, which is free software, but you can also run DBX, SDB or XDB if you
Dave Love <fx@gnu.org>
parents:
diff changeset
250 have them. GUD can also serve as an interface to the Perl's debugging
Dave Love <fx@gnu.org>
parents:
diff changeset
251 mode, the Python debugger PDB, and to JDB, the Java Debugger.
Dave Love <fx@gnu.org>
parents:
diff changeset
252
Dave Love <fx@gnu.org>
parents:
diff changeset
253 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
254 * Starting GUD:: How to start a debugger subprocess.
Dave Love <fx@gnu.org>
parents:
diff changeset
255 * Debugger Operation:: Connection between the debugger and source buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
256 * Commands of GUD:: Key bindings for common commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
257 * GUD Customization:: Defining your own commands for GUD.
27223
ac1bc60cf0b4 GUD tooltips.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
258 * GUD Tooltips:: Showing variable values by pointing with the mouse.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
259 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
260
Dave Love <fx@gnu.org>
parents:
diff changeset
261 @node Starting GUD
Dave Love <fx@gnu.org>
parents:
diff changeset
262 @subsection Starting GUD
Dave Love <fx@gnu.org>
parents:
diff changeset
263
Dave Love <fx@gnu.org>
parents:
diff changeset
264 There are several commands for starting a debugger, each corresponding
Dave Love <fx@gnu.org>
parents:
diff changeset
265 to a particular debugger program.
Dave Love <fx@gnu.org>
parents:
diff changeset
266
Dave Love <fx@gnu.org>
parents:
diff changeset
267 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
268 @item M-x gdb @key{RET} @var{file} @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
269 @findex gdb
Dave Love <fx@gnu.org>
parents:
diff changeset
270 Run GDB as a subprocess of Emacs. This command creates a buffer for
Dave Love <fx@gnu.org>
parents:
diff changeset
271 input and output to GDB, and switches to it. If a GDB buffer already
Dave Love <fx@gnu.org>
parents:
diff changeset
272 exists, it just switches to that buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
273
Dave Love <fx@gnu.org>
parents:
diff changeset
274 @item M-x dbx @key{RET} @var{file} @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
275 @findex dbx
Dave Love <fx@gnu.org>
parents:
diff changeset
276 Similar, but run DBX instead of GDB.
Dave Love <fx@gnu.org>
parents:
diff changeset
277
Dave Love <fx@gnu.org>
parents:
diff changeset
278 @item M-x xdb @key{RET} @var{file} @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
279 @findex xdb
Dave Love <fx@gnu.org>
parents:
diff changeset
280 @vindex gud-xdb-directories
Dave Love <fx@gnu.org>
parents:
diff changeset
281 Similar, but run XDB instead of GDB. Use the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
282 @code{gud-xdb-directories} to specify directories to search for source
Dave Love <fx@gnu.org>
parents:
diff changeset
283 files.
Dave Love <fx@gnu.org>
parents:
diff changeset
284
Dave Love <fx@gnu.org>
parents:
diff changeset
285 @item M-x sdb @key{RET} @var{file} @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
286 @findex sdb
Dave Love <fx@gnu.org>
parents:
diff changeset
287 Similar, but run SDB instead of GDB.
Dave Love <fx@gnu.org>
parents:
diff changeset
288
Dave Love <fx@gnu.org>
parents:
diff changeset
289 Some versions of SDB do not mention source file names in their
Dave Love <fx@gnu.org>
parents:
diff changeset
290 messages. When you use them, you need to have a valid tags table
Dave Love <fx@gnu.org>
parents:
diff changeset
291 (@pxref{Tags}) in order for GUD to find functions in the source code.
Dave Love <fx@gnu.org>
parents:
diff changeset
292 If you have not visited a tags table or the tags table doesn't list one
Dave Love <fx@gnu.org>
parents:
diff changeset
293 of the functions, you get a message saying @samp{The sdb support
Dave Love <fx@gnu.org>
parents:
diff changeset
294 requires a valid tags table to work}. If this happens, generate a valid
Dave Love <fx@gnu.org>
parents:
diff changeset
295 tags table in the working directory and try again.
Dave Love <fx@gnu.org>
parents:
diff changeset
296
Dave Love <fx@gnu.org>
parents:
diff changeset
297 @item M-x perldb @key{RET} @var{file} @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
298 @findex perldb
Dave Love <fx@gnu.org>
parents:
diff changeset
299 Run the Perl interpreter in debug mode to debug @var{file}, a Perl program.
Dave Love <fx@gnu.org>
parents:
diff changeset
300
Dave Love <fx@gnu.org>
parents:
diff changeset
301 @item M-x jdb @key{RET} @var{file} @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
302 @findex jdb
Dave Love <fx@gnu.org>
parents:
diff changeset
303 Run the Java debugger to debug @var{file}.
Dave Love <fx@gnu.org>
parents:
diff changeset
304
Dave Love <fx@gnu.org>
parents:
diff changeset
305 @item M-x pdb @key{RET} @var{file} @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
306 @findex pdb
Dave Love <fx@gnu.org>
parents:
diff changeset
307 Run the Python debugger to debug @var{file}.
Dave Love <fx@gnu.org>
parents:
diff changeset
308 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
309
Dave Love <fx@gnu.org>
parents:
diff changeset
310 Each of these commands takes one argument: a command line to invoke
Dave Love <fx@gnu.org>
parents:
diff changeset
311 the debugger. In the simplest case, specify just the name of the
Dave Love <fx@gnu.org>
parents:
diff changeset
312 executable file you want to debug. You may also use options that the
Dave Love <fx@gnu.org>
parents:
diff changeset
313 debugger supports. However, shell wildcards and variables are not
Dave Love <fx@gnu.org>
parents:
diff changeset
314 allowed. GUD assumes that the first argument not starting with a
Dave Love <fx@gnu.org>
parents:
diff changeset
315 @samp{-} is the executable file name.
Dave Love <fx@gnu.org>
parents:
diff changeset
316
Dave Love <fx@gnu.org>
parents:
diff changeset
317 Emacs can only run one debugger process at a time.
Dave Love <fx@gnu.org>
parents:
diff changeset
318
Dave Love <fx@gnu.org>
parents:
diff changeset
319 @node Debugger Operation
Dave Love <fx@gnu.org>
parents:
diff changeset
320 @subsection Debugger Operation
Dave Love <fx@gnu.org>
parents:
diff changeset
321
Dave Love <fx@gnu.org>
parents:
diff changeset
322 When you run a debugger with GUD, the debugger uses an Emacs buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
323 for its ordinary input and output. This is called the GUD buffer. The
Dave Love <fx@gnu.org>
parents:
diff changeset
324 debugger displays the source files of the program by visiting them in
Dave Love <fx@gnu.org>
parents:
diff changeset
325 Emacs buffers. An arrow (@samp{=>}) in one of these buffers indicates
28431
315d6e79ea38 Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents: 27223
diff changeset
326 the current execution line.@footnote{Under a window system the arrow is
315d6e79ea38 Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents: 27223
diff changeset
327 displayed in the marginal area of the Emacs window.} Moving point in
315d6e79ea38 Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents: 27223
diff changeset
328 this buffer does not move the arrow.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
329
Dave Love <fx@gnu.org>
parents:
diff changeset
330 You can start editing these source files at any time in the buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
331 that were made to display them. The arrow is not part of the file's
Dave Love <fx@gnu.org>
parents:
diff changeset
332 text; it appears only on the screen. If you do modify a source file,
Dave Love <fx@gnu.org>
parents:
diff changeset
333 keep in mind that inserting or deleting lines will throw off the arrow's
Dave Love <fx@gnu.org>
parents:
diff changeset
334 positioning; GUD has no way of figuring out which line corresponded
Dave Love <fx@gnu.org>
parents:
diff changeset
335 before your changes to the line number in a debugger message. Also,
Dave Love <fx@gnu.org>
parents:
diff changeset
336 you'll typically have to recompile and restart the program for your
Dave Love <fx@gnu.org>
parents:
diff changeset
337 changes to be reflected in the debugger's tables.
Dave Love <fx@gnu.org>
parents:
diff changeset
338
Dave Love <fx@gnu.org>
parents:
diff changeset
339 If you wish, you can control your debugger process entirely through the
Dave Love <fx@gnu.org>
parents:
diff changeset
340 debugger buffer, which uses a variant of Shell mode. All the usual
Dave Love <fx@gnu.org>
parents:
diff changeset
341 commands for your debugger are available, and you can use the Shell mode
Dave Love <fx@gnu.org>
parents:
diff changeset
342 history commands to repeat them. @xref{Shell Mode}.
Dave Love <fx@gnu.org>
parents:
diff changeset
343
Dave Love <fx@gnu.org>
parents:
diff changeset
344 @node Commands of GUD
Dave Love <fx@gnu.org>
parents:
diff changeset
345 @subsection Commands of GUD
Dave Love <fx@gnu.org>
parents:
diff changeset
346
Dave Love <fx@gnu.org>
parents:
diff changeset
347 The GUD interaction buffer uses a variant of Shell mode, so the
Dave Love <fx@gnu.org>
parents:
diff changeset
348 commands of Shell mode are available (@pxref{Shell Mode}). GUD mode
Dave Love <fx@gnu.org>
parents:
diff changeset
349 also provides commands for setting and clearing breakpoints, for
Dave Love <fx@gnu.org>
parents:
diff changeset
350 selecting stack frames, and for stepping through the program. These
Dave Love <fx@gnu.org>
parents:
diff changeset
351 commands are available both in the GUD buffer and globally, but with
Dave Love <fx@gnu.org>
parents:
diff changeset
352 different key bindings.
Dave Love <fx@gnu.org>
parents:
diff changeset
353
Dave Love <fx@gnu.org>
parents:
diff changeset
354 The breakpoint commands are usually used in source file buffers,
Dave Love <fx@gnu.org>
parents:
diff changeset
355 because that is the way to specify where to set or clear the breakpoint.
Dave Love <fx@gnu.org>
parents:
diff changeset
356 Here's the global command to set a breakpoint:
Dave Love <fx@gnu.org>
parents:
diff changeset
357
Dave Love <fx@gnu.org>
parents:
diff changeset
358 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
359 @item C-x @key{SPC}
Dave Love <fx@gnu.org>
parents:
diff changeset
360 @kindex C-x SPC
Dave Love <fx@gnu.org>
parents:
diff changeset
361 Set a breakpoint on the source line that point is on.
Dave Love <fx@gnu.org>
parents:
diff changeset
362 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
363
Dave Love <fx@gnu.org>
parents:
diff changeset
364 @kindex C-x C-a @r{(GUD)}
Dave Love <fx@gnu.org>
parents:
diff changeset
365 Here are the other special commands provided by GUD. The keys
Dave Love <fx@gnu.org>
parents:
diff changeset
366 starting with @kbd{C-c} are available only in the GUD interaction
Dave Love <fx@gnu.org>
parents:
diff changeset
367 buffer. The key bindings that start with @kbd{C-x C-a} are available in
Dave Love <fx@gnu.org>
parents:
diff changeset
368 the GUD interaction buffer and also in source files.
Dave Love <fx@gnu.org>
parents:
diff changeset
369
Dave Love <fx@gnu.org>
parents:
diff changeset
370 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
371 @item C-c C-l
Dave Love <fx@gnu.org>
parents:
diff changeset
372 @kindex C-c C-l @r{(GUD)}
Dave Love <fx@gnu.org>
parents:
diff changeset
373 @itemx C-x C-a C-l
Dave Love <fx@gnu.org>
parents:
diff changeset
374 @findex gud-refresh
Dave Love <fx@gnu.org>
parents:
diff changeset
375 Display in another window the last line referred to in the GUD
Dave Love <fx@gnu.org>
parents:
diff changeset
376 buffer (that is, the line indicated in the last location message).
Dave Love <fx@gnu.org>
parents:
diff changeset
377 This runs the command @code{gud-refresh}.
Dave Love <fx@gnu.org>
parents:
diff changeset
378
Dave Love <fx@gnu.org>
parents:
diff changeset
379 @item C-c C-s
Dave Love <fx@gnu.org>
parents:
diff changeset
380 @kindex C-c C-s @r{(GUD)}
Dave Love <fx@gnu.org>
parents:
diff changeset
381 @itemx C-x C-a C-s
Dave Love <fx@gnu.org>
parents:
diff changeset
382 @findex gud-step
Dave Love <fx@gnu.org>
parents:
diff changeset
383 Execute a single line of code (@code{gud-step}). If the line contains
Dave Love <fx@gnu.org>
parents:
diff changeset
384 a function call, execution stops after entering the called function.
Dave Love <fx@gnu.org>
parents:
diff changeset
385
Dave Love <fx@gnu.org>
parents:
diff changeset
386 @item C-c C-n
Dave Love <fx@gnu.org>
parents:
diff changeset
387 @kindex C-c C-n @r{(GUD)}
Dave Love <fx@gnu.org>
parents:
diff changeset
388 @itemx C-x C-a C-n
Dave Love <fx@gnu.org>
parents:
diff changeset
389 @findex gud-next
Dave Love <fx@gnu.org>
parents:
diff changeset
390 Execute a single line of code, stepping across entire function calls
Dave Love <fx@gnu.org>
parents:
diff changeset
391 at full speed (@code{gud-next}).
Dave Love <fx@gnu.org>
parents:
diff changeset
392
Dave Love <fx@gnu.org>
parents:
diff changeset
393 @item C-c C-i
Dave Love <fx@gnu.org>
parents:
diff changeset
394 @kindex C-c C-i @r{(GUD)}
Dave Love <fx@gnu.org>
parents:
diff changeset
395 @itemx C-x C-a C-i
Dave Love <fx@gnu.org>
parents:
diff changeset
396 @findex gud-stepi
Dave Love <fx@gnu.org>
parents:
diff changeset
397 Execute a single machine instruction (@code{gud-stepi}).
Dave Love <fx@gnu.org>
parents:
diff changeset
398
Dave Love <fx@gnu.org>
parents:
diff changeset
399 @need 3000
Dave Love <fx@gnu.org>
parents:
diff changeset
400 @item C-c C-r
Dave Love <fx@gnu.org>
parents:
diff changeset
401 @kindex C-c C-r @r{(GUD)}
Dave Love <fx@gnu.org>
parents:
diff changeset
402 @itemx C-x C-a C-r
Dave Love <fx@gnu.org>
parents:
diff changeset
403 @findex gud-cont
Dave Love <fx@gnu.org>
parents:
diff changeset
404 Continue execution without specifying any stopping point. The program
Dave Love <fx@gnu.org>
parents:
diff changeset
405 will run until it hits a breakpoint, terminates, or gets a signal that
Dave Love <fx@gnu.org>
parents:
diff changeset
406 the debugger is checking for (@code{gud-cont}).
Dave Love <fx@gnu.org>
parents:
diff changeset
407
Dave Love <fx@gnu.org>
parents:
diff changeset
408 @need 1000
Dave Love <fx@gnu.org>
parents:
diff changeset
409 @item C-c C-d
Dave Love <fx@gnu.org>
parents:
diff changeset
410 @kindex C-c C-d @r{(GUD)}
Dave Love <fx@gnu.org>
parents:
diff changeset
411 @itemx C-x C-a C-d
Dave Love <fx@gnu.org>
parents:
diff changeset
412 @findex gud-remove
Dave Love <fx@gnu.org>
parents:
diff changeset
413 Delete the breakpoint(s) on the current source line, if any
Dave Love <fx@gnu.org>
parents:
diff changeset
414 (@code{gud-remove}). If you use this command in the GUD interaction
Dave Love <fx@gnu.org>
parents:
diff changeset
415 buffer, it applies to the line where the program last stopped.
Dave Love <fx@gnu.org>
parents:
diff changeset
416
Dave Love <fx@gnu.org>
parents:
diff changeset
417 @item C-c C-t
Dave Love <fx@gnu.org>
parents:
diff changeset
418 @kindex C-c C-t @r{(GUD)}
Dave Love <fx@gnu.org>
parents:
diff changeset
419 @itemx C-x C-a C-t
Dave Love <fx@gnu.org>
parents:
diff changeset
420 @findex gud-tbreak
Dave Love <fx@gnu.org>
parents:
diff changeset
421 Set a temporary breakpoint on the current source line, if any.
Dave Love <fx@gnu.org>
parents:
diff changeset
422 If you use this command in the GUD interaction buffer,
Dave Love <fx@gnu.org>
parents:
diff changeset
423 it applies to the line where the program last stopped.
Dave Love <fx@gnu.org>
parents:
diff changeset
424 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
425
Dave Love <fx@gnu.org>
parents:
diff changeset
426 The above commands are common to all supported debuggers. If you are
Dave Love <fx@gnu.org>
parents:
diff changeset
427 using GDB or (some versions of) DBX, these additional commands are available:
Dave Love <fx@gnu.org>
parents:
diff changeset
428
Dave Love <fx@gnu.org>
parents:
diff changeset
429 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
430 @item C-c <
Dave Love <fx@gnu.org>
parents:
diff changeset
431 @kindex C-c < @r{(GUD)}
Dave Love <fx@gnu.org>
parents:
diff changeset
432 @itemx C-x C-a <
Dave Love <fx@gnu.org>
parents:
diff changeset
433 @findex gud-up
Dave Love <fx@gnu.org>
parents:
diff changeset
434 Select the next enclosing stack frame (@code{gud-up}). This is
Dave Love <fx@gnu.org>
parents:
diff changeset
435 equivalent to the @samp{up} command.
Dave Love <fx@gnu.org>
parents:
diff changeset
436
Dave Love <fx@gnu.org>
parents:
diff changeset
437 @item C-c >
Dave Love <fx@gnu.org>
parents:
diff changeset
438 @kindex C-c > @r{(GUD)}
Dave Love <fx@gnu.org>
parents:
diff changeset
439 @itemx C-x C-a >
Dave Love <fx@gnu.org>
parents:
diff changeset
440 @findex gud-down
Dave Love <fx@gnu.org>
parents:
diff changeset
441 Select the next inner stack frame (@code{gud-down}). This is
Dave Love <fx@gnu.org>
parents:
diff changeset
442 equivalent to the @samp{down} command.
Dave Love <fx@gnu.org>
parents:
diff changeset
443 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
444
Dave Love <fx@gnu.org>
parents:
diff changeset
445 If you are using GDB, these additional key bindings are available:
Dave Love <fx@gnu.org>
parents:
diff changeset
446
Dave Love <fx@gnu.org>
parents:
diff changeset
447 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
448 @item @key{TAB}
Dave Love <fx@gnu.org>
parents:
diff changeset
449 @kindex TAB @r{(GUD)}
Dave Love <fx@gnu.org>
parents:
diff changeset
450 @findex gud-gdb-complete-command
Dave Love <fx@gnu.org>
parents:
diff changeset
451 With GDB, complete a symbol name (@code{gud-gdb-complete-command}).
Dave Love <fx@gnu.org>
parents:
diff changeset
452 This key is available only in the GUD interaction buffer, and requires
Dave Love <fx@gnu.org>
parents:
diff changeset
453 GDB versions 4.13 and later.
Dave Love <fx@gnu.org>
parents:
diff changeset
454
Dave Love <fx@gnu.org>
parents:
diff changeset
455 @item C-c C-f
Dave Love <fx@gnu.org>
parents:
diff changeset
456 @kindex C-c C-f @r{(GUD)}
Dave Love <fx@gnu.org>
parents:
diff changeset
457 @itemx C-x C-a C-f
Dave Love <fx@gnu.org>
parents:
diff changeset
458 @findex gud-finish
Dave Love <fx@gnu.org>
parents:
diff changeset
459 Run the program until the selected stack frame returns (or until it
Dave Love <fx@gnu.org>
parents:
diff changeset
460 stops for some other reason).
Dave Love <fx@gnu.org>
parents:
diff changeset
461 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
462
Dave Love <fx@gnu.org>
parents:
diff changeset
463 These commands interpret a numeric argument as a repeat count, when
Dave Love <fx@gnu.org>
parents:
diff changeset
464 that makes sense.
Dave Love <fx@gnu.org>
parents:
diff changeset
465
Dave Love <fx@gnu.org>
parents:
diff changeset
466 Because @key{TAB} serves as a completion command, you can't use it to
Dave Love <fx@gnu.org>
parents:
diff changeset
467 enter a tab as input to the program you are debugging with GDB.
Dave Love <fx@gnu.org>
parents:
diff changeset
468 Instead, type @kbd{C-q @key{TAB}} to enter a tab.
Dave Love <fx@gnu.org>
parents:
diff changeset
469
Dave Love <fx@gnu.org>
parents:
diff changeset
470 @node GUD Customization
Dave Love <fx@gnu.org>
parents:
diff changeset
471 @subsection GUD Customization
Dave Love <fx@gnu.org>
parents:
diff changeset
472
Dave Love <fx@gnu.org>
parents:
diff changeset
473 @vindex gdb-mode-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
474 @vindex dbx-mode-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
475 @vindex sdb-mode-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
476 @vindex xdb-mode-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
477 @vindex perldb-mode-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
478 @vindex pdb-mode-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
479 @vindex jdb-mode-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
480 On startup, GUD runs one of the following hooks: @code{gdb-mode-hook},
Dave Love <fx@gnu.org>
parents:
diff changeset
481 if you are using GDB; @code{dbx-mode-hook}, if you are using DBX;
Dave Love <fx@gnu.org>
parents:
diff changeset
482 @code{sdb-mode-hook}, if you are using SDB; @code{xdb-mode-hook}, if you
Dave Love <fx@gnu.org>
parents:
diff changeset
483 are using XDB; @code{perldb-mode-hook}, for Perl debugging mode;
Dave Love <fx@gnu.org>
parents:
diff changeset
484 @code{jdb-mode-hook}, for PDB; @code{jdb-mode-hook}, for JDB. You can
Dave Love <fx@gnu.org>
parents:
diff changeset
485 use these hooks to define custom key bindings for the debugger
Dave Love <fx@gnu.org>
parents:
diff changeset
486 interaction buffer. @xref{Hooks}.
Dave Love <fx@gnu.org>
parents:
diff changeset
487
Dave Love <fx@gnu.org>
parents:
diff changeset
488 Here is a convenient way to define a command that sends a particular
Dave Love <fx@gnu.org>
parents:
diff changeset
489 command string to the debugger, and set up a key binding for it in the
Dave Love <fx@gnu.org>
parents:
diff changeset
490 debugger interaction buffer:
Dave Love <fx@gnu.org>
parents:
diff changeset
491
Dave Love <fx@gnu.org>
parents:
diff changeset
492 @findex gud-def
Dave Love <fx@gnu.org>
parents:
diff changeset
493 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
494 (gud-def @var{function} @var{cmdstring} @var{binding} @var{docstring})
Dave Love <fx@gnu.org>
parents:
diff changeset
495 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
496
Dave Love <fx@gnu.org>
parents:
diff changeset
497 This defines a command named @var{function} which sends
Dave Love <fx@gnu.org>
parents:
diff changeset
498 @var{cmdstring} to the debugger process, and gives it the documentation
Dave Love <fx@gnu.org>
parents:
diff changeset
499 string @var{docstring}. You can use the command thus defined in any
Dave Love <fx@gnu.org>
parents:
diff changeset
500 buffer. If @var{binding} is non-@code{nil}, @code{gud-def} also binds
Dave Love <fx@gnu.org>
parents:
diff changeset
501 the command to @kbd{C-c @var{binding}} in the GUD buffer's mode and to
Dave Love <fx@gnu.org>
parents:
diff changeset
502 @kbd{C-x C-a @var{binding}} generally.
Dave Love <fx@gnu.org>
parents:
diff changeset
503
Dave Love <fx@gnu.org>
parents:
diff changeset
504 The command string @var{cmdstring} may contain certain
Dave Love <fx@gnu.org>
parents:
diff changeset
505 @samp{%}-sequences that stand for data to be filled in at the time
Dave Love <fx@gnu.org>
parents:
diff changeset
506 @var{function} is called:
Dave Love <fx@gnu.org>
parents:
diff changeset
507
Dave Love <fx@gnu.org>
parents:
diff changeset
508 @table @samp
Dave Love <fx@gnu.org>
parents:
diff changeset
509 @item %f
Dave Love <fx@gnu.org>
parents:
diff changeset
510 The name of the current source file. If the current buffer is the GUD
Dave Love <fx@gnu.org>
parents:
diff changeset
511 buffer, then the ``current source file'' is the file that the program
Dave Love <fx@gnu.org>
parents:
diff changeset
512 stopped in.
Dave Love <fx@gnu.org>
parents:
diff changeset
513 @c This said, ``the name of the file the program counter was in at the last breakpoint.''
Dave Love <fx@gnu.org>
parents:
diff changeset
514 @c But I suspect it is really the last stop file.
Dave Love <fx@gnu.org>
parents:
diff changeset
515
Dave Love <fx@gnu.org>
parents:
diff changeset
516 @item %l
Dave Love <fx@gnu.org>
parents:
diff changeset
517 The number of the current source line. If the current buffer is the GUD
Dave Love <fx@gnu.org>
parents:
diff changeset
518 buffer, then the ``current source line'' is the line that the program
Dave Love <fx@gnu.org>
parents:
diff changeset
519 stopped in.
Dave Love <fx@gnu.org>
parents:
diff changeset
520
Dave Love <fx@gnu.org>
parents:
diff changeset
521 @item %e
Dave Love <fx@gnu.org>
parents:
diff changeset
522 The text of the C lvalue or function-call expression at or adjacent to point.
Dave Love <fx@gnu.org>
parents:
diff changeset
523
Dave Love <fx@gnu.org>
parents:
diff changeset
524 @item %a
Dave Love <fx@gnu.org>
parents:
diff changeset
525 The text of the hexadecimal address at or adjacent to point.
Dave Love <fx@gnu.org>
parents:
diff changeset
526
Dave Love <fx@gnu.org>
parents:
diff changeset
527 @item %p
Dave Love <fx@gnu.org>
parents:
diff changeset
528 The numeric argument of the called function, as a decimal number. If
Dave Love <fx@gnu.org>
parents:
diff changeset
529 the command is used without a numeric argument, @samp{%p} stands for the
Dave Love <fx@gnu.org>
parents:
diff changeset
530 empty string.
Dave Love <fx@gnu.org>
parents:
diff changeset
531
Dave Love <fx@gnu.org>
parents:
diff changeset
532 If you don't use @samp{%p} in the command string, the command you define
Dave Love <fx@gnu.org>
parents:
diff changeset
533 ignores any numeric argument.
Dave Love <fx@gnu.org>
parents:
diff changeset
534 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
535
27223
ac1bc60cf0b4 GUD tooltips.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
536 @node GUD Tooltips
ac1bc60cf0b4 GUD tooltips.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
537 @subsection GUD Tooltips
ac1bc60cf0b4 GUD tooltips.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
538
ac1bc60cf0b4 GUD tooltips.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
539 @cindex tooltips with GUD
ac1bc60cf0b4 GUD tooltips.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
540 The Tooltip facility (@pxref{Tooltips}) provides support for GUD@. If
ac1bc60cf0b4 GUD tooltips.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
541 GUD support is activated by customizing the @code{tooltip} group,
ac1bc60cf0b4 GUD tooltips.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
542 variable values can be displayed in tooltips by pointing at them with
ac1bc60cf0b4 GUD tooltips.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
543 the mouse in the GUD buffer or in source buffers with major modes in the
ac1bc60cf0b4 GUD tooltips.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
544 customizable list @code{tooltip-gud-modes}.
ac1bc60cf0b4 GUD tooltips.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
545
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
546 @node Executing Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
547 @section Executing Lisp Expressions
Dave Love <fx@gnu.org>
parents:
diff changeset
548
Dave Love <fx@gnu.org>
parents:
diff changeset
549 Emacs has several different major modes for Lisp and Scheme. They are
Dave Love <fx@gnu.org>
parents:
diff changeset
550 the same in terms of editing commands, but differ in the commands for
Dave Love <fx@gnu.org>
parents:
diff changeset
551 executing Lisp expressions. Each mode has its own purpose.
Dave Love <fx@gnu.org>
parents:
diff changeset
552
Dave Love <fx@gnu.org>
parents:
diff changeset
553 @table @asis
Dave Love <fx@gnu.org>
parents:
diff changeset
554 @item Emacs-Lisp mode
Dave Love <fx@gnu.org>
parents:
diff changeset
555 The mode for editing source files of programs to run in Emacs Lisp.
Dave Love <fx@gnu.org>
parents:
diff changeset
556 This mode defines @kbd{C-M-x} to evaluate the current defun.
Dave Love <fx@gnu.org>
parents:
diff changeset
557 @xref{Lisp Libraries}.
Dave Love <fx@gnu.org>
parents:
diff changeset
558 @item Lisp Interaction mode
Dave Love <fx@gnu.org>
parents:
diff changeset
559 The mode for an interactive session with Emacs Lisp. It defines
Dave Love <fx@gnu.org>
parents:
diff changeset
560 @kbd{C-j} to evaluate the sexp before point and insert its value in the
Dave Love <fx@gnu.org>
parents:
diff changeset
561 buffer. @xref{Lisp Interaction}.
Dave Love <fx@gnu.org>
parents:
diff changeset
562 @item Lisp mode
Dave Love <fx@gnu.org>
parents:
diff changeset
563 The mode for editing source files of programs that run in Lisps other
Dave Love <fx@gnu.org>
parents:
diff changeset
564 than Emacs Lisp. This mode defines @kbd{C-M-x} to send the current defun
Dave Love <fx@gnu.org>
parents:
diff changeset
565 to an inferior Lisp process. @xref{External Lisp}.
Dave Love <fx@gnu.org>
parents:
diff changeset
566 @item Inferior Lisp mode
Dave Love <fx@gnu.org>
parents:
diff changeset
567 The mode for an interactive session with an inferior Lisp process.
Dave Love <fx@gnu.org>
parents:
diff changeset
568 This mode combines the special features of Lisp mode and Shell mode
Dave Love <fx@gnu.org>
parents:
diff changeset
569 (@pxref{Shell Mode}).
Dave Love <fx@gnu.org>
parents:
diff changeset
570 @item Scheme mode
Dave Love <fx@gnu.org>
parents:
diff changeset
571 Like Lisp mode but for Scheme programs.
Dave Love <fx@gnu.org>
parents:
diff changeset
572 @item Inferior Scheme mode
Dave Love <fx@gnu.org>
parents:
diff changeset
573 The mode for an interactive session with an inferior Scheme process.
Dave Love <fx@gnu.org>
parents:
diff changeset
574 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
575
Dave Love <fx@gnu.org>
parents:
diff changeset
576 Most editing commands for working with Lisp programs are in fact
Dave Love <fx@gnu.org>
parents:
diff changeset
577 available globally. @xref{Programs}.
Dave Love <fx@gnu.org>
parents:
diff changeset
578
Dave Love <fx@gnu.org>
parents:
diff changeset
579 @node Lisp Libraries
Dave Love <fx@gnu.org>
parents:
diff changeset
580 @section Libraries of Lisp Code for Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
581 @cindex libraries
Dave Love <fx@gnu.org>
parents:
diff changeset
582 @cindex loading Lisp code
Dave Love <fx@gnu.org>
parents:
diff changeset
583
Dave Love <fx@gnu.org>
parents:
diff changeset
584 Lisp code for Emacs editing commands is stored in files whose names
Dave Love <fx@gnu.org>
parents:
diff changeset
585 conventionally end in @file{.el}. This ending tells Emacs to edit them in
Dave Love <fx@gnu.org>
parents:
diff changeset
586 Emacs-Lisp mode (@pxref{Executing Lisp}).
Dave Love <fx@gnu.org>
parents:
diff changeset
587
Dave Love <fx@gnu.org>
parents:
diff changeset
588 @findex load-file
Dave Love <fx@gnu.org>
parents:
diff changeset
589 To execute a file of Emacs Lisp code, use @kbd{M-x load-file}. This
Dave Love <fx@gnu.org>
parents:
diff changeset
590 command reads a file name using the minibuffer and then executes the
Dave Love <fx@gnu.org>
parents:
diff changeset
591 contents of that file as Lisp code. It is not necessary to visit the
Dave Love <fx@gnu.org>
parents:
diff changeset
592 file first; in any case, this command reads the file as found on disk,
Dave Love <fx@gnu.org>
parents:
diff changeset
593 not text in an Emacs buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
594
Dave Love <fx@gnu.org>
parents:
diff changeset
595 @findex load
Dave Love <fx@gnu.org>
parents:
diff changeset
596 @findex load-library
Dave Love <fx@gnu.org>
parents:
diff changeset
597 Once a file of Lisp code is installed in the Emacs Lisp library
Dave Love <fx@gnu.org>
parents:
diff changeset
598 directories, users can load it using @kbd{M-x load-library}. Programs can
Dave Love <fx@gnu.org>
parents:
diff changeset
599 load it by calling @code{load-library}, or with @code{load}, a more primitive
Dave Love <fx@gnu.org>
parents:
diff changeset
600 function that is similar but accepts some additional arguments.
Dave Love <fx@gnu.org>
parents:
diff changeset
601
Dave Love <fx@gnu.org>
parents:
diff changeset
602 @kbd{M-x load-library} differs from @kbd{M-x load-file} in that it
Dave Love <fx@gnu.org>
parents:
diff changeset
603 searches a sequence of directories and tries three file names in each
Dave Love <fx@gnu.org>
parents:
diff changeset
604 directory. Suppose your argument is @var{lib}; the three names are
Dave Love <fx@gnu.org>
parents:
diff changeset
605 @file{@var{lib}.elc}, @file{@var{lib}.el}, and lastly just
Dave Love <fx@gnu.org>
parents:
diff changeset
606 @file{@var{lib}}. If @file{@var{lib}.elc} exists, it is by convention
Dave Love <fx@gnu.org>
parents:
diff changeset
607 the result of compiling @file{@var{lib}.el}; it is better to load the
Dave Love <fx@gnu.org>
parents:
diff changeset
608 compiled file, since it will load and run faster.
Dave Love <fx@gnu.org>
parents:
diff changeset
609
Dave Love <fx@gnu.org>
parents:
diff changeset
610 If @code{load-library} finds that @file{@var{lib}.el} is newer than
Dave Love <fx@gnu.org>
parents:
diff changeset
611 @file{@var{lib}.elc} file, it prints a warning, because it's likely that
Dave Love <fx@gnu.org>
parents:
diff changeset
612 somebody made changes to the @file{.el} file and forgot to recompile
Dave Love <fx@gnu.org>
parents:
diff changeset
613 it.
Dave Love <fx@gnu.org>
parents:
diff changeset
614
Dave Love <fx@gnu.org>
parents:
diff changeset
615 Because the argument to @code{load-library} is usually not in itself
Dave Love <fx@gnu.org>
parents:
diff changeset
616 a valid file name, file name completion is not available. Indeed, when
Dave Love <fx@gnu.org>
parents:
diff changeset
617 using this command, you usually do not know exactly what file name
Dave Love <fx@gnu.org>
parents:
diff changeset
618 will be used.
Dave Love <fx@gnu.org>
parents:
diff changeset
619
Dave Love <fx@gnu.org>
parents:
diff changeset
620 @vindex load-path
Dave Love <fx@gnu.org>
parents:
diff changeset
621 The sequence of directories searched by @kbd{M-x load-library} is
Dave Love <fx@gnu.org>
parents:
diff changeset
622 specified by the variable @code{load-path}, a list of strings that are
Dave Love <fx@gnu.org>
parents:
diff changeset
623 directory names. The default value of the list contains the directory where
Dave Love <fx@gnu.org>
parents:
diff changeset
624 the Lisp code for Emacs itself is stored. If you have libraries of
Dave Love <fx@gnu.org>
parents:
diff changeset
625 your own, put them in a single directory and add that directory
Dave Love <fx@gnu.org>
parents:
diff changeset
626 to @code{load-path}. @code{nil} in this list stands for the current default
Dave Love <fx@gnu.org>
parents:
diff changeset
627 directory, but it is probably not a good idea to put @code{nil} in the
Dave Love <fx@gnu.org>
parents:
diff changeset
628 list. If you find yourself wishing that @code{nil} were in the list,
Dave Love <fx@gnu.org>
parents:
diff changeset
629 most likely what you really want to do is use @kbd{M-x load-file}
Dave Love <fx@gnu.org>
parents:
diff changeset
630 this once.
Dave Love <fx@gnu.org>
parents:
diff changeset
631
Dave Love <fx@gnu.org>
parents:
diff changeset
632 @cindex autoload
Dave Love <fx@gnu.org>
parents:
diff changeset
633 Often you do not have to give any command to load a library, because
Dave Love <fx@gnu.org>
parents:
diff changeset
634 the commands defined in the library are set up to @dfn{autoload} that
Dave Love <fx@gnu.org>
parents:
diff changeset
635 library. Trying to run any of those commands calls @code{load} to load
Dave Love <fx@gnu.org>
parents:
diff changeset
636 the library; this replaces the autoload definitions with the real ones
Dave Love <fx@gnu.org>
parents:
diff changeset
637 from the library.
Dave Love <fx@gnu.org>
parents:
diff changeset
638
Dave Love <fx@gnu.org>
parents:
diff changeset
639 @cindex byte code
Dave Love <fx@gnu.org>
parents:
diff changeset
640 Emacs Lisp code can be compiled into byte-code which loads faster,
Dave Love <fx@gnu.org>
parents:
diff changeset
641 takes up less space when loaded, and executes faster. @xref{Byte
Dave Love <fx@gnu.org>
parents:
diff changeset
642 Compilation,, Byte Compilation, elisp, the Emacs Lisp Reference Manual}.
Dave Love <fx@gnu.org>
parents:
diff changeset
643 By convention, the compiled code for a library goes in a separate file
Dave Love <fx@gnu.org>
parents:
diff changeset
644 whose name consists of the library source file with @samp{c} appended.
Dave Love <fx@gnu.org>
parents:
diff changeset
645 Thus, the compiled code for @file{foo.el} goes in @file{foo.elc}.
Dave Love <fx@gnu.org>
parents:
diff changeset
646 That's why @code{load-library} searches for @samp{.elc} files first.
Dave Love <fx@gnu.org>
parents:
diff changeset
647
Dave Love <fx@gnu.org>
parents:
diff changeset
648 @node Lisp Eval
Dave Love <fx@gnu.org>
parents:
diff changeset
649 @section Evaluating Emacs-Lisp Expressions
Dave Love <fx@gnu.org>
parents:
diff changeset
650 @cindex Emacs-Lisp mode
Dave Love <fx@gnu.org>
parents:
diff changeset
651 @cindex mode, Emacs-Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
652
Dave Love <fx@gnu.org>
parents:
diff changeset
653 @findex emacs-lisp-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
654 Lisp programs intended to be run in Emacs should be edited in
Dave Love <fx@gnu.org>
parents:
diff changeset
655 Emacs-Lisp mode; this happens automatically for file names ending in
Dave Love <fx@gnu.org>
parents:
diff changeset
656 @file{.el}. By contrast, Lisp mode itself is used for editing Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
657 programs intended for other Lisp systems. To switch to Emacs-Lisp mode
Dave Love <fx@gnu.org>
parents:
diff changeset
658 explicitly, use the command @kbd{M-x emacs-lisp-mode}.
Dave Love <fx@gnu.org>
parents:
diff changeset
659
Dave Love <fx@gnu.org>
parents:
diff changeset
660 For testing of Lisp programs to run in Emacs, it is often useful to
Dave Love <fx@gnu.org>
parents:
diff changeset
661 evaluate part of the program as it is found in the Emacs buffer. For
Dave Love <fx@gnu.org>
parents:
diff changeset
662 example, after changing the text of a Lisp function definition,
Dave Love <fx@gnu.org>
parents:
diff changeset
663 evaluating the definition installs the change for future calls to the
Dave Love <fx@gnu.org>
parents:
diff changeset
664 function. Evaluation of Lisp expressions is also useful in any kind of
Dave Love <fx@gnu.org>
parents:
diff changeset
665 editing, for invoking noninteractive functions (functions that are
Dave Love <fx@gnu.org>
parents:
diff changeset
666 not commands).
Dave Love <fx@gnu.org>
parents:
diff changeset
667
Dave Love <fx@gnu.org>
parents:
diff changeset
668 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
669 @item M-:
Dave Love <fx@gnu.org>
parents:
diff changeset
670 Read a single Lisp expression in the minibuffer, evaluate it, and print
Dave Love <fx@gnu.org>
parents:
diff changeset
671 the value in the echo area (@code{eval-expression}).
Dave Love <fx@gnu.org>
parents:
diff changeset
672 @item C-x C-e
Dave Love <fx@gnu.org>
parents:
diff changeset
673 Evaluate the Lisp expression before point, and print the value in the
Dave Love <fx@gnu.org>
parents:
diff changeset
674 echo area (@code{eval-last-sexp}).
Dave Love <fx@gnu.org>
parents:
diff changeset
675 @item C-M-x
Dave Love <fx@gnu.org>
parents:
diff changeset
676 Evaluate the defun containing or after point, and print the value in
Dave Love <fx@gnu.org>
parents:
diff changeset
677 the echo area (@code{eval-defun}).
Dave Love <fx@gnu.org>
parents:
diff changeset
678 @item M-x eval-region
Dave Love <fx@gnu.org>
parents:
diff changeset
679 Evaluate all the Lisp expressions in the region.
Dave Love <fx@gnu.org>
parents:
diff changeset
680 @item M-x eval-current-buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
681 Evaluate all the Lisp expressions in the buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
682 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
683
Dave Love <fx@gnu.org>
parents:
diff changeset
684 @kindex M-:
Dave Love <fx@gnu.org>
parents:
diff changeset
685 @findex eval-expression
Dave Love <fx@gnu.org>
parents:
diff changeset
686 @kbd{M-:} (@code{eval-expression}) is the most basic command for evaluating
Dave Love <fx@gnu.org>
parents:
diff changeset
687 a Lisp expression interactively. It reads the expression using the
Dave Love <fx@gnu.org>
parents:
diff changeset
688 minibuffer, so you can execute any expression on a buffer regardless of
Dave Love <fx@gnu.org>
parents:
diff changeset
689 what the buffer contains. When the expression is evaluated, the current
Dave Love <fx@gnu.org>
parents:
diff changeset
690 buffer is once again the buffer that was current when @kbd{M-:} was
Dave Love <fx@gnu.org>
parents:
diff changeset
691 typed.
Dave Love <fx@gnu.org>
parents:
diff changeset
692
Dave Love <fx@gnu.org>
parents:
diff changeset
693 @kindex C-M-x @r{(Emacs-Lisp mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
694 @findex eval-defun
Dave Love <fx@gnu.org>
parents:
diff changeset
695 In Emacs-Lisp mode, the key @kbd{C-M-x} is bound to the command
Dave Love <fx@gnu.org>
parents:
diff changeset
696 @code{eval-defun}, which parses the defun containing or following point
Dave Love <fx@gnu.org>
parents:
diff changeset
697 as a Lisp expression and evaluates it. The value is printed in the echo
Dave Love <fx@gnu.org>
parents:
diff changeset
698 area. This command is convenient for installing in the Lisp environment
Dave Love <fx@gnu.org>
parents:
diff changeset
699 changes that you have just made in the text of a function definition.
Dave Love <fx@gnu.org>
parents:
diff changeset
700
Dave Love <fx@gnu.org>
parents:
diff changeset
701 @kbd{C-M-x} treats @code{defvar} expressions specially. Normally,
Dave Love <fx@gnu.org>
parents:
diff changeset
702 evaluating a @code{defvar} expression does nothing if the variable it
Dave Love <fx@gnu.org>
parents:
diff changeset
703 defines already has a value. But @kbd{C-M-x} unconditionally resets the
Dave Love <fx@gnu.org>
parents:
diff changeset
704 variable to the initial value specified in the @code{defvar} expression.
28431
315d6e79ea38 Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents: 27223
diff changeset
705 @code{defcustom} expressions are treated similarly.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
706 This special feature is convenient for debugging Lisp programs.
Dave Love <fx@gnu.org>
parents:
diff changeset
707
Dave Love <fx@gnu.org>
parents:
diff changeset
708 @kindex C-x C-e
Dave Love <fx@gnu.org>
parents:
diff changeset
709 @findex eval-last-sexp
Dave Love <fx@gnu.org>
parents:
diff changeset
710 The command @kbd{C-x C-e} (@code{eval-last-sexp}) evaluates the Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
711 expression preceding point in the buffer, and displays the value in the
Dave Love <fx@gnu.org>
parents:
diff changeset
712 echo area. It is available in all major modes, not just Emacs-Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
713 mode. It does not treat @code{defvar} specially.
Dave Love <fx@gnu.org>
parents:
diff changeset
714
Dave Love <fx@gnu.org>
parents:
diff changeset
715 If @kbd{C-M-x}, @kbd{C-x C-e}, or @kbd{M-:} is given a numeric
Dave Love <fx@gnu.org>
parents:
diff changeset
716 argument, it inserts the value into the current buffer at point, rather
Dave Love <fx@gnu.org>
parents:
diff changeset
717 than displaying it in the echo area. The argument's value does not
Dave Love <fx@gnu.org>
parents:
diff changeset
718 matter.
Dave Love <fx@gnu.org>
parents:
diff changeset
719
Dave Love <fx@gnu.org>
parents:
diff changeset
720 @findex eval-region
Dave Love <fx@gnu.org>
parents:
diff changeset
721 @findex eval-current-buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
722 The most general command for evaluating Lisp expressions from a buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
723 is @code{eval-region}. @kbd{M-x eval-region} parses the text of the
Dave Love <fx@gnu.org>
parents:
diff changeset
724 region as one or more Lisp expressions, evaluating them one by one.
Dave Love <fx@gnu.org>
parents:
diff changeset
725 @kbd{M-x eval-current-buffer} is similar but evaluates the entire
Dave Love <fx@gnu.org>
parents:
diff changeset
726 buffer. This is a reasonable way to install the contents of a file of
Dave Love <fx@gnu.org>
parents:
diff changeset
727 Lisp code that you are just ready to test. Later, as you find bugs and
Dave Love <fx@gnu.org>
parents:
diff changeset
728 change individual functions, use @kbd{C-M-x} on each function that you
Dave Love <fx@gnu.org>
parents:
diff changeset
729 change. This keeps the Lisp world in step with the source file.
Dave Love <fx@gnu.org>
parents:
diff changeset
730
28431
315d6e79ea38 Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents: 27223
diff changeset
731 @vindex eval-expression-print-level
315d6e79ea38 Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents: 27223
diff changeset
732 @vindex eval-expression-print-length
315d6e79ea38 Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents: 27223
diff changeset
733 @vindex eval-expression-debug-on-error
315d6e79ea38 Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents: 27223
diff changeset
734 The customizable variables @code{eval-expression-print-level} and
315d6e79ea38 Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents: 27223
diff changeset
735 @code{eval-expression-print-length} control the maximum depth and length
315d6e79ea38 Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents: 27223
diff changeset
736 of lists to print in the result of the evaluation commands before
315d6e79ea38 Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents: 27223
diff changeset
737 abbreviating them. @code{eval-expression-debug-on-error} controls
315d6e79ea38 Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents: 27223
diff changeset
738 whether evaluation errors invoke the debugger when these commands are
315d6e79ea38 Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents: 27223
diff changeset
739 used.
315d6e79ea38 Overlay arrow in margin. eval-expression variables.
Dave Love <fx@gnu.org>
parents: 27223
diff changeset
740
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
741 @node Lisp Interaction
Dave Love <fx@gnu.org>
parents:
diff changeset
742 @section Lisp Interaction Buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
743
Dave Love <fx@gnu.org>
parents:
diff changeset
744 The buffer @samp{*scratch*} which is selected when Emacs starts up is
Dave Love <fx@gnu.org>
parents:
diff changeset
745 provided for evaluating Lisp expressions interactively inside Emacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
746
Dave Love <fx@gnu.org>
parents:
diff changeset
747 The simplest way to use the @samp{*scratch*} buffer is to insert Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
748 expressions and type @kbd{C-j} after each expression. This command
Dave Love <fx@gnu.org>
parents:
diff changeset
749 reads the Lisp expression before point, evaluates it, and inserts the
Dave Love <fx@gnu.org>
parents:
diff changeset
750 value in printed representation before point. The result is a complete
Dave Love <fx@gnu.org>
parents:
diff changeset
751 typescript of the expressions you have evaluated and their values.
Dave Love <fx@gnu.org>
parents:
diff changeset
752
Dave Love <fx@gnu.org>
parents:
diff changeset
753 The @samp{*scratch*} buffer's major mode is Lisp Interaction mode, which
Dave Love <fx@gnu.org>
parents:
diff changeset
754 is the same as Emacs-Lisp mode except for the binding of @kbd{C-j}.
Dave Love <fx@gnu.org>
parents:
diff changeset
755
Dave Love <fx@gnu.org>
parents:
diff changeset
756 @findex lisp-interaction-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
757 The rationale for this feature is that Emacs must have a buffer when
Dave Love <fx@gnu.org>
parents:
diff changeset
758 it starts up, but that buffer is not useful for editing files since a
Dave Love <fx@gnu.org>
parents:
diff changeset
759 new buffer is made for every file that you visit. The Lisp interpreter
Dave Love <fx@gnu.org>
parents:
diff changeset
760 typescript is the most useful thing I can think of for the initial
Dave Love <fx@gnu.org>
parents:
diff changeset
761 buffer to do. Type @kbd{M-x lisp-interaction-mode} to put the current
Dave Love <fx@gnu.org>
parents:
diff changeset
762 buffer in Lisp Interaction mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
763
Dave Love <fx@gnu.org>
parents:
diff changeset
764 @findex ielm
Dave Love <fx@gnu.org>
parents:
diff changeset
765 An alternative way of evaluating Emacs Lisp expressions interactively
Dave Love <fx@gnu.org>
parents:
diff changeset
766 is to use Inferior Emacs-Lisp mode, which provides an interface rather
Dave Love <fx@gnu.org>
parents:
diff changeset
767 like Shell mode (@pxref{Shell Mode}) for evaluating Emacs Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
768 expressions. Type @kbd{M-x ielm} to create an @samp{*ielm*} buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
769 which uses this mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
770
Dave Love <fx@gnu.org>
parents:
diff changeset
771 @node External Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
772 @section Running an External Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
773
Dave Love <fx@gnu.org>
parents:
diff changeset
774 Emacs has facilities for running programs in other Lisp systems. You can
Dave Love <fx@gnu.org>
parents:
diff changeset
775 run a Lisp process as an inferior of Emacs, and pass expressions to it to
Dave Love <fx@gnu.org>
parents:
diff changeset
776 be evaluated. You can also pass changed function definitions directly from
Dave Love <fx@gnu.org>
parents:
diff changeset
777 the Emacs buffers in which you edit the Lisp programs to the inferior Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
778 process.
Dave Love <fx@gnu.org>
parents:
diff changeset
779
Dave Love <fx@gnu.org>
parents:
diff changeset
780 @findex run-lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
781 @vindex inferior-lisp-program
Dave Love <fx@gnu.org>
parents:
diff changeset
782 @kindex C-x C-z
Dave Love <fx@gnu.org>
parents:
diff changeset
783 To run an inferior Lisp process, type @kbd{M-x run-lisp}. This runs
Dave Love <fx@gnu.org>
parents:
diff changeset
784 the program named @code{lisp}, the same program you would run by typing
Dave Love <fx@gnu.org>
parents:
diff changeset
785 @code{lisp} as a shell command, with both input and output going through
Dave Love <fx@gnu.org>
parents:
diff changeset
786 an Emacs buffer named @samp{*lisp*}. That is to say, any ``terminal
Dave Love <fx@gnu.org>
parents:
diff changeset
787 output'' from Lisp will go into the buffer, advancing point, and any
Dave Love <fx@gnu.org>
parents:
diff changeset
788 ``terminal input'' for Lisp comes from text in the buffer. (You can
Dave Love <fx@gnu.org>
parents:
diff changeset
789 change the name of the Lisp executable file by setting the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
790 @code{inferior-lisp-program}.)
Dave Love <fx@gnu.org>
parents:
diff changeset
791
Dave Love <fx@gnu.org>
parents:
diff changeset
792 To give input to Lisp, go to the end of the buffer and type the input,
Dave Love <fx@gnu.org>
parents:
diff changeset
793 terminated by @key{RET}. The @samp{*lisp*} buffer is in Inferior Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
794 mode, which combines the special characteristics of Lisp mode with most
Dave Love <fx@gnu.org>
parents:
diff changeset
795 of the features of Shell mode (@pxref{Shell Mode}). The definition of
Dave Love <fx@gnu.org>
parents:
diff changeset
796 @key{RET} to send a line to a subprocess is one of the features of Shell
Dave Love <fx@gnu.org>
parents:
diff changeset
797 mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
798
Dave Love <fx@gnu.org>
parents:
diff changeset
799 @findex lisp-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
800 For the source files of programs to run in external Lisps, use Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
801 mode. This mode can be selected with @kbd{M-x lisp-mode}, and is used
Dave Love <fx@gnu.org>
parents:
diff changeset
802 automatically for files whose names end in @file{.l}, @file{.lsp}, or
Dave Love <fx@gnu.org>
parents:
diff changeset
803 @file{.lisp}, as most Lisp systems usually expect.
Dave Love <fx@gnu.org>
parents:
diff changeset
804
Dave Love <fx@gnu.org>
parents:
diff changeset
805 @kindex C-M-x @r{(Lisp mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
806 @findex lisp-eval-defun
Dave Love <fx@gnu.org>
parents:
diff changeset
807 When you edit a function in a Lisp program you are running, the easiest
Dave Love <fx@gnu.org>
parents:
diff changeset
808 way to send the changed definition to the inferior Lisp process is the key
Dave Love <fx@gnu.org>
parents:
diff changeset
809 @kbd{C-M-x}. In Lisp mode, this runs the function @code{lisp-eval-defun},
Dave Love <fx@gnu.org>
parents:
diff changeset
810 which finds the defun around or following point and sends it as input to
Dave Love <fx@gnu.org>
parents:
diff changeset
811 the Lisp process. (Emacs can send input to any inferior process regardless
Dave Love <fx@gnu.org>
parents:
diff changeset
812 of what buffer is current.)
Dave Love <fx@gnu.org>
parents:
diff changeset
813
Dave Love <fx@gnu.org>
parents:
diff changeset
814 Contrast the meanings of @kbd{C-M-x} in Lisp mode (for editing programs
Dave Love <fx@gnu.org>
parents:
diff changeset
815 to be run in another Lisp system) and Emacs-Lisp mode (for editing Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
816 programs to be run in Emacs): in both modes it has the effect of installing
Dave Love <fx@gnu.org>
parents:
diff changeset
817 the function definition that point is in, but the way of doing so is
Dave Love <fx@gnu.org>
parents:
diff changeset
818 different according to where the relevant Lisp environment is found.
Dave Love <fx@gnu.org>
parents:
diff changeset
819 @xref{Executing Lisp}.