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