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