Commit | Line | Data |
---|---|---|
6bf7aab6 | 1 | @c This is part of the Emacs manual. |
b65d8176 | 2 | @c Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1997, 2000, 2001, |
4e6835db | 3 | @c 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc. |
6bf7aab6 | 4 | @c See file emacs.texi for copying conditions. |
ffb1af2b | 5 | @node Building, Maintaining, Programs, Top |
6bf7aab6 DL |
6 | @chapter Compiling and Testing Programs |
7 | @cindex building programs | |
8 | @cindex program building | |
9 | @cindex running Lisp functions | |
10 | ||
11 | The previous chapter discusses the Emacs commands that are useful for | |
12 | making changes in programs. This chapter deals with commands that assist | |
a6f0d581 | 13 | in the larger process of compiling and testing programs. |
6bf7aab6 DL |
14 | |
15 | @menu | |
16 | * Compilation:: Compiling programs in languages other | |
17 | than Lisp (C, Pascal, etc.). | |
6bf7aab6 DL |
18 | * Compilation Mode:: The mode for visiting compiler errors. |
19 | * Compilation Shell:: Customizing your shell properly | |
20 | for use in the compilation buffer. | |
ed4389af | 21 | * Grep Searching:: Searching with grep. |
ff994d96 | 22 | * Flymake:: Finding syntax errors on the fly. |
177c0ea7 JB |
23 | * Debuggers:: Running symbolic debuggers for non-Lisp programs. |
24 | * Executing Lisp:: Various modes for editing Lisp programs, | |
6bf7aab6 | 25 | with different facilities for running |
177c0ea7 | 26 | the Lisp programs. |
6bf7aab6 | 27 | * Libraries: Lisp Libraries. Creating Lisp programs to run in Emacs. |
6bf7aab6 | 28 | * Eval: Lisp Eval. Executing a single Lisp expression in Emacs. |
254196f5 | 29 | * Interaction: Lisp Interaction. Executing Lisp in an Emacs buffer. |
177c0ea7 | 30 | * External Lisp:: Communicating through Emacs with a separate Lisp. |
6bf7aab6 DL |
31 | @end menu |
32 | ||
33 | @node Compilation | |
34 | @section Running Compilations under Emacs | |
35 | @cindex inferior process | |
36 | @cindex make | |
37 | @cindex compilation errors | |
38 | @cindex error log | |
39 | ||
40 | Emacs can run compilers for noninteractive languages such as C and | |
41 | Fortran as inferior processes, feeding the error log into an Emacs buffer. | |
42 | It can also parse the error messages and show you the source lines where | |
43 | compilation errors occurred. | |
44 | ||
45 | @table @kbd | |
46 | @item M-x compile | |
74b1aac1 | 47 | Run a compiler asynchronously under Emacs, with error messages going to |
58fa012d | 48 | the @samp{*compilation*} buffer. |
9ee31341 EZ |
49 | @item M-x recompile |
50 | Invoke a compiler with the same command as in the last invocation of | |
51 | @kbd{M-x compile}. | |
6bf7aab6 | 52 | @item M-x kill-compilation |
b00d98ed | 53 | Kill the running compilation subprocess. |
6bf7aab6 DL |
54 | @end table |
55 | ||
56 | @findex compile | |
57 | To run @code{make} or another compilation command, do @kbd{M-x | |
58 | compile}. This command reads a shell command line using the minibuffer, | |
59 | and then executes the command in an inferior shell, putting output in | |
60 | the buffer named @samp{*compilation*}. The current buffer's default | |
61 | directory is used as the working directory for the execution of the | |
62 | command; normally, therefore, the compilation happens in this | |
63 | directory. | |
64 | ||
65 | @vindex compile-command | |
7d6596b8 RS |
66 | The default for the compilation command is normally @samp{make -k}, |
67 | which is correct most of the time for nontrivial programs. | |
68 | (@xref{Top,, Make, make, GNU Make Manual}.) If you have done @kbd{M-x | |
69 | compile} before, the default each time is the command you used the | |
70 | previous time. @code{compile} stores this command in the variable | |
71 | @code{compile-command}, so setting that variable specifies the default | |
72 | for the next use of @kbd{M-x compile}. If a file specifies a file | |
73 | local value for @code{compile-command}, that provides the default when | |
74 | you type @kbd{M-x compile} in that file's buffer. @xref{File | |
75 | Variables}. | |
6bf7aab6 DL |
76 | |
77 | Starting a compilation displays the buffer @samp{*compilation*} in | |
91f1fd02 RS |
78 | another window but does not select it. The buffer's mode line tells |
79 | you whether compilation is finished, with the word @samp{run}, | |
80 | @samp{signal} or @samp{exit} inside the parentheses. You do not have | |
81 | to keep this buffer visible; compilation continues in any case. While | |
82 | a compilation is going on, the string @samp{Compiling} appears in the | |
83 | mode lines of all windows. When this string disappears, the | |
84 | compilation is finished. | |
6bf7aab6 DL |
85 | |
86 | If you want to watch the compilation transcript as it appears, switch | |
87 | to the @samp{*compilation*} buffer and move point to the end of the | |
88 | buffer. When point is at the end, new compilation output is inserted | |
89 | above point, which remains at the end. If point is not at the end of | |
90 | the buffer, it remains fixed while more compilation output is added at | |
91 | the end of the buffer. | |
92 | ||
41f633c1 | 93 | @cindex compilation buffer, keeping point at end |
6bf7aab6 DL |
94 | @vindex compilation-scroll-output |
95 | If you set the variable @code{compilation-scroll-output} to a | |
96 | non-@code{nil} value, then the compilation buffer always scrolls to | |
97 | follow output as it comes in. | |
98 | ||
9ee31341 EZ |
99 | @findex recompile |
100 | To rerun the last compilation with the same command, type @kbd{M-x | |
3fce19f1 RS |
101 | recompile}. This automatically reuses the compilation command from |
102 | the last invocation of @kbd{M-x compile}. It also reuses the | |
103 | @samp{*compilation*} buffer and starts the compilation in its default | |
104 | directory, which is the directory in which the previous compilation | |
105 | was started. | |
9ee31341 | 106 | |
41f633c1 RS |
107 | When the compiler process terminates, for whatever reason, the mode |
108 | line of the @samp{*compilation*} buffer changes to say @samp{exit} | |
109 | (followed by the exit code, @samp{[0]} for a normal exit), or | |
110 | @samp{signal} (if a signal terminated the process), instead of | |
111 | @samp{run}. | |
112 | ||
113 | @findex kill-compilation | |
444246ca | 114 | Starting a new compilation also kills any compilation already |
41f633c1 RS |
115 | running in @samp{*compilation*}, as the buffer can only handle one |
116 | compilation at any time. However, @kbd{M-x compile} asks for | |
117 | confirmation before actually killing a compilation that is running. | |
118 | You can also kill the compilation process with @kbd{M-x | |
119 | kill-compilation}. | |
120 | ||
121 | If you want to run two compilations at once, you should start the | |
122 | first one, then rename the @samp{*compilation*} buffer (perhaps using | |
123 | @code{rename-uniquely}; @pxref{Misc Buffer}), and start the other | |
124 | compilation. That will create a new @samp{*compilation*} buffer. | |
125 | ||
43b4d3c0 | 126 | Emacs does not expect a compiler process to launch asynchronous |
266e712e | 127 | subprocesses; if it does, and they keep running after the main |
43b4d3c0 RS |
128 | compiler process has terminated, Emacs may kill them or their output |
129 | may not arrive in Emacs. To avoid this problem, make the main process | |
130 | wait for its subprocesses to finish. In a shell script, you can do this | |
131 | using @samp{$!} and @samp{wait}, like this: | |
132 | ||
133 | @example | |
134 | (sleep 10; echo 2nd)& pid=$! # @r{Record pid of subprocess} | |
135 | echo first message | |
136 | wait $pid # @r{Wait for subprocess} | |
137 | @end example | |
266e712e | 138 | |
9cad1898 RS |
139 | If the background process does not output to the compilation buffer, |
140 | so you only need to prevent it from being killed when the main | |
141 | compilation process terminates, this is sufficient: | |
142 | ||
143 | @example | |
144 | nohup @var{command}; sleep 1 | |
145 | @end example | |
146 | ||
147 | @vindex compilation-environment | |
148 | You can control the environment passed to the compilation command | |
149 | with the variable @code{compilation-environment}. Its value is a list | |
150 | of environment variable settings; each element should be a string of | |
151 | the form @code{"@var{envvarname}=@var{value}"}. These environment | |
152 | variable settings override the usual ones. | |
153 | ||
6bf7aab6 DL |
154 | @node Compilation Mode |
155 | @section Compilation Mode | |
156 | ||
6bf7aab6 DL |
157 | @cindex Compilation mode |
158 | @cindex mode, Compilation | |
41f633c1 RS |
159 | The @samp{*compilation*} buffer uses a special major mode, |
160 | Compilation mode, whose main feature is to provide a convenient way to | |
161 | visit the source line corresponding to an error message. These | |
162 | commands are also available in other special buffers that list | |
163 | locations in files, including those made by @kbd{M-x grep} and | |
164 | @kbd{M-x occur}. | |
6bf7aab6 DL |
165 | |
166 | @table @kbd | |
089ed565 KS |
167 | @item M-g M-n |
168 | @itemx M-g n | |
169 | @itemx C-x ` | |
41f633c1 | 170 | Visit the locus of the next error message or match. |
089ed565 KS |
171 | @item M-g M-p |
172 | @itemx M-g p | |
41f633c1 | 173 | Visit the locus of the previous error message or match. |
6bf7aab6 DL |
174 | @item @key{RET} |
175 | Visit the locus of the error message that point is on. | |
176 | This command is used in the compilation buffer. | |
177 | @item Mouse-2 | |
178 | Visit the locus of the error message that you click on. | |
ed4389af RS |
179 | @item M-n |
180 | Find and highlight the locus of the next error message, without | |
181 | selecting the source buffer. | |
182 | @item M-p | |
183 | Find and highlight the locus of the previous error message, without | |
184 | selecting the source buffer. | |
185 | @item M-@} | |
186 | Move point to the next error for a different file than the current | |
187 | one. | |
188 | @item M-@{ | |
189 | Move point to the previous error for a different file than the current | |
190 | one. | |
191 | @item C-c C-f | |
192 | Toggle Next Error Follow minor mode, which makes cursor motion in the | |
193 | compilation buffer produce automatic source display. | |
6bf7aab6 DL |
194 | @end table |
195 | ||
41f633c1 | 196 | @findex compile-goto-error |
6bf7aab6 | 197 | You can visit the source for any particular error message by moving |
58fa012d EZ |
198 | point in the @samp{*compilation*} buffer to that error message and |
199 | typing @key{RET} (@code{compile-goto-error}). Alternatively, you can | |
200 | click @kbd{Mouse-2} on the error message; you need not switch to the | |
201 | @samp{*compilation*} buffer first. | |
6bf7aab6 | 202 | |
41f633c1 RS |
203 | @kindex M-g M-n |
204 | @kindex M-g n | |
205 | @kindex C-x ` | |
206 | @findex next-error | |
ed4389af | 207 | @vindex next-error-highlight |
6bf7aab6 DL |
208 | To parse the compiler error messages sequentially, type @kbd{C-x `} |
209 | (@code{next-error}). The character following the @kbd{C-x} is the | |
210 | backquote or ``grave accent,'' not the single-quote. This command is | |
ed4389af RS |
211 | available in all buffers, not just in @samp{*compilation*}; it |
212 | displays the next error message at the top of one window and source | |
f489fc25 RS |
213 | location of the error in another window. It also temporarily |
214 | highlights the relevant source line, for a period controlled by the | |
215 | variable @code{next-error-highlight}. | |
6bf7aab6 | 216 | |
41f633c1 RS |
217 | The first time @w{@kbd{C-x `}} is used after the start of a compilation, |
218 | it moves to the first error's location. Subsequent uses of @kbd{C-x | |
219 | `} advance down to subsequent errors. If you visit a specific error | |
220 | message with @key{RET} or @kbd{Mouse-2}, subsequent @w{@kbd{C-x `}} | |
221 | commands advance from there. When @w{@kbd{C-x `}} gets to the end of the | |
6bf7aab6 | 222 | buffer and finds no more error messages to visit, it fails and signals |
41f633c1 RS |
223 | an Emacs error. @w{@kbd{C-u C-x `}} starts scanning from the beginning of |
224 | the compilation buffer, and goes to the first error's location. | |
6bf7aab6 | 225 | |
d938fad2 | 226 | @vindex compilation-skip-threshold |
41f633c1 | 227 | By default, @w{@kbd{C-x `}} skips less important messages. The variable |
d938fad2 | 228 | @code{compilation-skip-threshold} controls this. If its value is 2, |
41f633c1 RS |
229 | @w{@kbd{C-x `}} skips anything less than error, 1 skips anything less |
230 | than warning, and 0 doesn't skip any messages. The default is 1. | |
d938fad2 | 231 | |
41f633c1 RS |
232 | When the window has a left fringe, an arrow in the fringe points to |
233 | the current message in the compilation buffer. The variable | |
cb7b02c7 | 234 | @code{compilation-context-lines} controls the number of lines of |
41f633c1 RS |
235 | leading context to display before the current message. Going to an |
236 | error message location scrolls the @samp{*compilation*} buffer to put | |
237 | the message that far down from the top. The value @code{nil} is | |
238 | special: if there's a left fringe, the window doesn't scroll at all | |
239 | if the message is already visible. If there is no left fringe, | |
240 | @code{nil} means display the message at the top of the window. | |
cb7b02c7 | 241 | |
7d6596b8 RS |
242 | If you're not in the compilation buffer when you run |
243 | @code{next-error}, Emacs will look for a buffer that contains error | |
244 | messages. First, it looks for one displayed in the selected frame, | |
245 | then for one that previously had @code{next-error} called on it, and | |
246 | then at the current buffer. Finally, Emacs looks at all the remaining | |
247 | buffers. @code{next-error} signals an error if it can't find any such | |
248 | buffer. | |
249 | ||
0825052e EZ |
250 | @vindex compilation-error-regexp-alist |
251 | @vindex grep-regexp-alist | |
252 | To parse messages from the compiler, Compilation mode uses the | |
253 | variable @code{compilation-error-regexp-alist} which lists various | |
254 | formats of error messages and tells Emacs how to extract the source file | |
255 | and the line number from the text of a message. If your compiler isn't | |
256 | supported, you can tailor Compilation mode to it by adding elements to | |
257 | that list. A similar variable @code{grep-regexp-alist} tells Emacs how | |
258 | to parse output of a @code{grep} command. | |
259 | ||
ed4389af RS |
260 | @findex compilation-next-error |
261 | @findex compilation-previous-error | |
262 | @findex compilation-next-file | |
263 | @findex compilation-previous-file | |
6bf7aab6 | 264 | Compilation mode also redefines the keys @key{SPC} and @key{DEL} to |
ed4389af RS |
265 | scroll by screenfuls, and @kbd{M-n} (@code{compilation-next-error}) |
266 | and @kbd{M-p} (@code{compilation-previous-error}) to move to the next | |
267 | or previous error message. You can also use @kbd{M-@{} | |
268 | (@code{compilation-next-file} and @kbd{M-@}} | |
269 | (@code{compilation-previous-file}) to move up or down to an error | |
270 | message for a different source file. | |
271 | ||
272 | @cindex Next Error Follow mode | |
273 | @findex next-error-follow-minor-mode | |
274 | You can type @kbd{C-c C-f} to toggle Next Error Follow mode. In | |
275 | this minor mode, ordinary cursor motion in the compilation buffer | |
276 | automatically updates the source buffer. For instance, moving the | |
277 | cursor to the next error message causes the location of that error to | |
278 | be displayed immediately. | |
6bf7aab6 DL |
279 | |
280 | The features of Compilation mode are also available in a minor mode | |
281 | called Compilation Minor mode. This lets you parse error messages in | |
282 | any buffer, not just a normal compilation output buffer. Type @kbd{M-x | |
283 | compilation-minor-mode} to enable the minor mode. This defines the keys | |
284 | @key{RET} and @kbd{Mouse-2}, as in the Compilation major mode. | |
285 | ||
286 | Compilation minor mode works in any buffer, as long as the contents | |
287 | are in a format that it understands. In an Rlogin buffer (@pxref{Remote | |
288 | Host}), Compilation minor mode automatically accesses remote source | |
289 | files by FTP (@pxref{File Names}). | |
290 | ||
291 | @node Compilation Shell | |
292 | @section Subshells for Compilation | |
293 | ||
41f633c1 RS |
294 | Emacs uses a shell to run the compilation command, but specifies the |
295 | option for a noninteractive shell. This means, in particular, that | |
6bf7aab6 DL |
296 | the shell should start with no prompt. If you find your usual shell |
297 | prompt making an unsightly appearance in the @samp{*compilation*} | |
298 | buffer, it means you have made a mistake in your shell's init file by | |
299 | setting the prompt unconditionally. (This init file's name may be | |
41f633c1 RS |
300 | @file{.bashrc}, @file{.profile}, @file{.cshrc}, @file{.shrc}, or |
301 | various other things, depending on the shell you use.) The shell init | |
302 | file should set the prompt only if there already is a prompt. Here's | |
303 | how to do it in bash: | |
6bf7aab6 DL |
304 | |
305 | @example | |
41f633c1 RS |
306 | if [ "$@{PS1+set@}" = set ] |
307 | then PS1=@dots{} | |
308 | fi | |
6bf7aab6 DL |
309 | @end example |
310 | ||
311 | @noindent | |
41f633c1 | 312 | And here's how to do it in csh: |
6bf7aab6 DL |
313 | |
314 | @example | |
41f633c1 | 315 | if ($?prompt) set prompt = @dots{} |
6bf7aab6 DL |
316 | @end example |
317 | ||
318 | There may well be other things that your shell's init file | |
319 | ought to do only for an interactive shell. You can use the same | |
320 | method to conditionalize them. | |
321 | ||
322 | The MS-DOS ``operating system'' does not support asynchronous | |
323 | subprocesses; to work around this lack, @kbd{M-x compile} runs the | |
324 | compilation command synchronously on MS-DOS. As a consequence, you must | |
325 | wait until the command finishes before you can do anything else in | |
eca2d6cd EZ |
326 | Emacs. |
327 | @iftex | |
328 | @inforef{MS-DOS,,emacs-xtra}. | |
329 | @end iftex | |
330 | @ifnottex | |
331 | @xref{MS-DOS}. | |
332 | @end ifnottex | |
6bf7aab6 | 333 | |
ed4389af RS |
334 | @node Grep Searching |
335 | @section Searching with Grep under Emacs | |
336 | ||
ed4389af | 337 | Just as you can run a compiler from Emacs and then visit the lines |
f489fc25 RS |
338 | with compilation errors, you can also run @code{grep} and then visit |
339 | the lines on which matches were found. This works by treating the | |
340 | matches reported by @code{grep} as if they were ``errors.'' The | |
341 | buffer of matches uses Grep mode, which is a variant of Compilation | |
342 | mode (@pxref{Compilation Mode}). | |
ed4389af | 343 | |
b00d98ed JL |
344 | @table @kbd |
345 | @item M-x grep | |
b5eb27b3 | 346 | @item M-x lgrep |
b00d98ed JL |
347 | Run @code{grep} asynchronously under Emacs, with matching lines |
348 | listed in the buffer named @samp{*grep*}. | |
349 | @item M-x grep-find | |
350 | @itemx M-x find-grep | |
b5eb27b3 | 351 | @itemx M-x rgrep |
b00d98ed JL |
352 | Run @code{grep} via @code{find}, with user-specified arguments, and |
353 | collect output in the buffer named @samp{*grep*}. | |
354 | @item M-x kill-grep | |
355 | Kill the running @code{grep} subprocess. | |
356 | @end table | |
357 | ||
358 | @findex grep | |
41f633c1 RS |
359 | To run @code{grep}, type @kbd{M-x grep}, then enter a command line |
360 | that specifies how to run @code{grep}. Use the same arguments you | |
361 | would give @code{grep} when running it normally: a @code{grep}-style | |
362 | regexp (usually in single-quotes to quote the shell's special | |
363 | characters) followed by file names, which may use wildcards. If you | |
7ae038f0 RS |
364 | specify a prefix argument for @kbd{M-x grep}, it finds the tag |
365 | (@pxref{Tags}) in the buffer around point, and puts that into the | |
366 | default @code{grep} command. | |
367 | ||
368 | Your command need not simply run @code{grep}; you can use any shell | |
369 | command that produces output in the same format. For instance, you | |
370 | can chain @code{grep} commands, like this: | |
371 | ||
372 | @example | |
373 | grep -nH -e foo *.el | grep bar | grep toto | |
374 | @end example | |
ed4389af RS |
375 | |
376 | The output from @code{grep} goes in the @samp{*grep*} buffer. You | |
41f633c1 RS |
377 | can find the corresponding lines in the original files using @w{@kbd{C-x |
378 | `}}, @key{RET}, and so forth, just like compilation errors. | |
ed4389af RS |
379 | |
380 | Some grep programs accept a @samp{--color} option to output special | |
381 | markers around matches for the purpose of highlighting. You can make | |
d81dbd54 JB |
382 | use of this feature by setting @code{grep-highlight-matches} to |
383 | @code{t}. When displaying a match in the source buffer, the exact | |
384 | match will be highlighted, instead of the entire source line. | |
ed4389af RS |
385 | |
386 | @findex grep-find | |
387 | @findex find-grep | |
388 | The command @kbd{M-x grep-find} (also available as @kbd{M-x | |
389 | find-grep}) is similar to @kbd{M-x grep}, but it supplies a different | |
390 | initial default for the command---one that runs both @code{find} and | |
391 | @code{grep}, so as to search every file in a directory tree. See also | |
392 | the @code{find-grep-dired} command, in @ref{Dired and Find}. | |
393 | ||
b5eb27b3 KS |
394 | @findex lgrep |
395 | @findex rgrep | |
396 | The commands @kbd{M-x lgrep} (local grep) and @kbd{M-x rgrep} | |
397 | (recursive grep) are more user-friendly versions of @code{grep} and | |
398 | @code{grep-find}, which prompt separately for the regular expression | |
c341ae96 KS |
399 | to match, the files to search, and the base directory for the search. |
400 | Case sensitivity of the search is controlled by the | |
b5eb27b3 KS |
401 | current value of @code{case-fold-search}. |
402 | ||
403 | These commands build the shell commands based on the variables | |
404 | @code{grep-template} (for @code{lgrep}) and @code{grep-find-template} | |
405 | (for @code{rgrep}). | |
406 | ||
407 | The files to search can use aliases defined in the variable | |
408 | @code{grep-files-aliases}. | |
409 | ||
410 | Subdirectories listed in the variable | |
411 | @code{grep-find-ignored-directories} such as those typically used by | |
412 | various version control systems, like CVS and arch, are automatically | |
413 | skipped by @code{rgrep}. | |
414 | ||
ff994d96 RS |
415 | @node Flymake |
416 | @section Finding Syntax Errors On The Fly | |
417 | @cindex checking syntax | |
418 | ||
419 | Flymake mode is a minor mode that performs on-the-fly syntax | |
420 | checking for many programming and markup languages, including C, C++, | |
421 | Perl, HTML, and @TeX{}/La@TeX{}. It is somewhat analogous to Flyspell | |
422 | mode, which performs spell checking for ordinary human languages in a | |
423 | similar fashion (@pxref{Spelling}). As you edit a file, Flymake mode | |
424 | runs an appropriate syntax checking tool in the background, using a | |
425 | temporary copy of the buffer. It then parses the error and warning | |
426 | messages, and highlights the erroneous lines in the buffer. The | |
427 | syntax checking tool used depends on the language; for example, for | |
428 | C/C++ files this is usually the C compiler. Flymake can also use | |
429 | build tools such as @code{make} for checking complicated projects. | |
430 | ||
431 | To activate Flymake mode, type @kbd{M-x flymake-mode}. You can move | |
432 | to the errors spotted by Flymake mode with @kbd{M-x | |
433 | flymake-goto-next-error} and @kbd{M-x flymake-goto-prev-error}. To | |
434 | display any error messages associated with the current line, use | |
435 | @kbd{M-x flymake-display-err-menu-for-current-line}. | |
436 | ||
437 | For more details about using Flymake, see @ref{Top, Flymake, | |
438 | Flymake, flymake, The Flymake Manual}. | |
439 | ||
6bf7aab6 DL |
440 | @node Debuggers |
441 | @section Running Debuggers Under Emacs | |
442 | @cindex debuggers | |
443 | @cindex GUD library | |
444 | @cindex GDB | |
445 | @cindex DBX | |
446 | @cindex SDB | |
447 | @cindex XDB | |
448 | @cindex Perldb | |
449 | @cindex JDB | |
450 | @cindex PDB | |
451 | ||
452 | @c Do you believe in GUD? | |
453 | The GUD (Grand Unified Debugger) library provides an interface to | |
31b4c1b7 | 454 | various symbolic debuggers from within Emacs. We recommend the |
41f633c1 RS |
455 | debugger GDB, which is free software, but GUD can also run DBX, SDB or |
456 | XDB. GUD can also serve as an interface to Perl's debugging mode, the | |
e8388d28 | 457 | Python debugger PDB, and to JDB, the Java Debugger. |
41f633c1 RS |
458 | @xref{Debugging,, The Lisp Debugger, elisp, the Emacs Lisp Reference |
459 | Manual}, for information on debugging Emacs Lisp programs. | |
6bf7aab6 DL |
460 | |
461 | @menu | |
462 | * Starting GUD:: How to start a debugger subprocess. | |
463 | * Debugger Operation:: Connection between the debugger and source buffers. | |
464 | * Commands of GUD:: Key bindings for common commands. | |
465 | * GUD Customization:: Defining your own commands for GUD. | |
f9ad161b RS |
466 | * GDB Graphical Interface:: An enhanced mode that uses GDB features to |
467 | implement a graphical debugging environment through | |
468 | Emacs. | |
6bf7aab6 DL |
469 | @end menu |
470 | ||
471 | @node Starting GUD | |
472 | @subsection Starting GUD | |
473 | ||
474 | There are several commands for starting a debugger, each corresponding | |
475 | to a particular debugger program. | |
476 | ||
477 | @table @kbd | |
478 | @item M-x gdb @key{RET} @var{file} @key{RET} | |
479 | @findex gdb | |
41f633c1 RS |
480 | Run GDB as a subprocess of Emacs. By default, this uses an IDE-like |
481 | graphical interface; see @ref{GDB Graphical Interface}. Only GDB | |
482 | works with the graphical interface. | |
f9ad161b | 483 | |
6bf7aab6 DL |
484 | @item M-x dbx @key{RET} @var{file} @key{RET} |
485 | @findex dbx | |
41f633c1 RS |
486 | Run DBX as a subprocess of Emacs. Since Emacs does not implement a |
487 | graphical interface for DBX, communication with DBX works by typing | |
488 | commands in the GUD interaction buffer. The same is true for all | |
489 | the other supported debuggers. | |
6bf7aab6 DL |
490 | |
491 | @item M-x xdb @key{RET} @var{file} @key{RET} | |
492 | @findex xdb | |
493 | @vindex gud-xdb-directories | |
41f633c1 | 494 | Similar, but run XDB. Use the variable |
6bf7aab6 DL |
495 | @code{gud-xdb-directories} to specify directories to search for source |
496 | files. | |
497 | ||
498 | @item M-x sdb @key{RET} @var{file} @key{RET} | |
499 | @findex sdb | |
41f633c1 | 500 | Similar, but run SDB. |
6bf7aab6 DL |
501 | |
502 | Some versions of SDB do not mention source file names in their | |
503 | messages. When you use them, you need to have a valid tags table | |
504 | (@pxref{Tags}) in order for GUD to find functions in the source code. | |
505 | If you have not visited a tags table or the tags table doesn't list one | |
506 | of the functions, you get a message saying @samp{The sdb support | |
507 | requires a valid tags table to work}. If this happens, generate a valid | |
508 | tags table in the working directory and try again. | |
509 | ||
510 | @item M-x perldb @key{RET} @var{file} @key{RET} | |
511 | @findex perldb | |
512 | Run the Perl interpreter in debug mode to debug @var{file}, a Perl program. | |
513 | ||
514 | @item M-x jdb @key{RET} @var{file} @key{RET} | |
515 | @findex jdb | |
516 | Run the Java debugger to debug @var{file}. | |
517 | ||
518 | @item M-x pdb @key{RET} @var{file} @key{RET} | |
519 | @findex pdb | |
520 | Run the Python debugger to debug @var{file}. | |
521 | @end table | |
522 | ||
523 | Each of these commands takes one argument: a command line to invoke | |
524 | the debugger. In the simplest case, specify just the name of the | |
525 | executable file you want to debug. You may also use options that the | |
526 | debugger supports. However, shell wildcards and variables are not | |
527 | allowed. GUD assumes that the first argument not starting with a | |
528 | @samp{-} is the executable file name. | |
529 | ||
6bf7aab6 DL |
530 | @node Debugger Operation |
531 | @subsection Debugger Operation | |
532 | ||
3605e23f | 533 | @cindex fringes, and current execution line in GUD |
b95fd69b NR |
534 | Generally when you run a debugger with GUD, the debugger uses an Emacs |
535 | buffer for its ordinary input and output. This is called the GUD | |
536 | buffer. Input and output from the program you are debugging also use | |
537 | this buffer. We call this @dfn{text command mode}. The GDB Graphical | |
538 | Interface can use further buffers (@pxref{GDB Graphical Interface}). | |
41f633c1 RS |
539 | |
540 | The debugger displays the source files of the program by visiting | |
541 | them in Emacs buffers. An arrow in the left fringe indicates the | |
542 | current execution line.@footnote{On a text-only terminal, the arrow | |
543 | appears as @samp{=>} and overlays the first two text columns.} Moving | |
544 | point in this buffer does not move the arrow. The arrow is not part | |
545 | of the file's text; it appears only on the screen. | |
6bf7aab6 DL |
546 | |
547 | You can start editing these source files at any time in the buffers | |
41f633c1 RS |
548 | that display them. If you do modify a source file, keep in mind that |
549 | inserting or deleting lines will throw off the arrow's positioning; | |
550 | GUD has no way of figuring out which line corresponded before your | |
551 | changes to the line number in a debugger message. Also, you'll | |
552 | typically have to recompile and restart the program for your changes | |
553 | to be reflected in the debugger's tables. | |
6bf7aab6 | 554 | |
499de9ba RS |
555 | @cindex tooltips with GUD |
556 | @vindex tooltip-gud-modes | |
c2332b4f NR |
557 | @vindex gud-tooltip-mode |
558 | @vindex gud-tooltip-echo-area | |
499de9ba | 559 | The Tooltip facility (@pxref{Tooltips}) provides support for GUD@. |
8a25d51a NR |
560 | You activate this feature by turning on the minor mode |
561 | @code{gud-tooltip-mode}. Then you can display a variable's value in a | |
b95fd69b NR |
562 | tooltip simply by pointing at it with the mouse. This operates in the |
563 | GUD buffer and in source buffers with major modes in the list | |
564 | @code{gud-tooltip-modes}. If the variable @code{gud-tooltip-echo-area} | |
565 | is non-@code{nil} then the variable's value is displayed in the echo | |
566 | area. When debugging a C program using the GDB Graphical Interface, you | |
567 | can also display macro definitions associated with an identifier when | |
568 | the program is not executing. | |
499de9ba | 569 | |
41f633c1 RS |
570 | GUD tooltips are disabled when you use GDB in text command mode |
571 | (@pxref{GDB Graphical Interface}), because displaying an expression's | |
572 | value in GDB can sometimes expand a macro and result in a side effect | |
573 | that interferes with the program's operation. The GDB graphical | |
574 | interface supports GUD tooltips and assures they will not cause side | |
575 | effects. | |
b376642d | 576 | |
6bf7aab6 DL |
577 | @node Commands of GUD |
578 | @subsection Commands of GUD | |
579 | ||
580 | The GUD interaction buffer uses a variant of Shell mode, so the | |
41f633c1 RS |
581 | Emacs commands of Shell mode are available (@pxref{Shell Mode}). All |
582 | the usual commands for your debugger are available, and you can use | |
583 | the Shell mode history commands to repeat them. If you wish, you can | |
584 | control your debugger process entirely through this buffer. | |
585 | ||
586 | GUD mode also provides commands for setting and clearing | |
587 | breakpoints, for selecting stack frames, and for stepping through the | |
588 | program. These commands are available both in the GUD buffer and | |
589 | globally, but with different key bindings. It also has its own tool | |
590 | bar from which you can invoke the more common commands by clicking on | |
591 | the appropriate icon. This is particularly useful for repetitive | |
592 | commands like @code{gud-next} and @code{gud-step}, and allows you to | |
593 | keep the GUD buffer hidden. | |
6bf7aab6 | 594 | |
58fa012d EZ |
595 | The breakpoint commands are normally used in source file buffers, |
596 | because that is the easiest way to specify where to set or clear the | |
597 | breakpoint. Here's the global command to set a breakpoint: | |
6bf7aab6 DL |
598 | |
599 | @table @kbd | |
600 | @item C-x @key{SPC} | |
601 | @kindex C-x SPC | |
602 | Set a breakpoint on the source line that point is on. | |
603 | @end table | |
604 | ||
605 | @kindex C-x C-a @r{(GUD)} | |
41f633c1 | 606 | Here are the other special commands provided by GUD@. The keys |
6bf7aab6 | 607 | starting with @kbd{C-c} are available only in the GUD interaction |
55d5a463 NR |
608 | buffer. The key bindings that start with @kbd{C-x C-a} are available |
609 | in the GUD interaction buffer and also in source files. Some of these | |
610 | commands are not available to all the supported debuggers. | |
6bf7aab6 DL |
611 | |
612 | @table @kbd | |
613 | @item C-c C-l | |
614 | @kindex C-c C-l @r{(GUD)} | |
615 | @itemx C-x C-a C-l | |
616 | @findex gud-refresh | |
617 | Display in another window the last line referred to in the GUD | |
618 | buffer (that is, the line indicated in the last location message). | |
619 | This runs the command @code{gud-refresh}. | |
620 | ||
621 | @item C-c C-s | |
622 | @kindex C-c C-s @r{(GUD)} | |
623 | @itemx C-x C-a C-s | |
624 | @findex gud-step | |
625 | Execute a single line of code (@code{gud-step}). If the line contains | |
626 | a function call, execution stops after entering the called function. | |
627 | ||
628 | @item C-c C-n | |
629 | @kindex C-c C-n @r{(GUD)} | |
630 | @itemx C-x C-a C-n | |
631 | @findex gud-next | |
632 | Execute a single line of code, stepping across entire function calls | |
633 | at full speed (@code{gud-next}). | |
634 | ||
635 | @item C-c C-i | |
636 | @kindex C-c C-i @r{(GUD)} | |
637 | @itemx C-x C-a C-i | |
638 | @findex gud-stepi | |
639 | Execute a single machine instruction (@code{gud-stepi}). | |
640 | ||
55d5a463 NR |
641 | @item C-c C-p |
642 | @kindex C-c C-p @r{(GUD)} | |
643 | @itemx C-x C-a C-p | |
644 | @findex gud-print | |
645 | Evaluate the expression at point (@code{gud-print}). If Emacs | |
646 | does not print the exact expression that you want, mark it as a region | |
647 | first. | |
648 | ||
6bf7aab6 DL |
649 | @need 3000 |
650 | @item C-c C-r | |
651 | @kindex C-c C-r @r{(GUD)} | |
652 | @itemx C-x C-a C-r | |
653 | @findex gud-cont | |
654 | Continue execution without specifying any stopping point. The program | |
655 | will run until it hits a breakpoint, terminates, or gets a signal that | |
656 | the debugger is checking for (@code{gud-cont}). | |
657 | ||
658 | @need 1000 | |
659 | @item C-c C-d | |
660 | @kindex C-c C-d @r{(GUD)} | |
661 | @itemx C-x C-a C-d | |
662 | @findex gud-remove | |
663 | Delete the breakpoint(s) on the current source line, if any | |
664 | (@code{gud-remove}). If you use this command in the GUD interaction | |
665 | buffer, it applies to the line where the program last stopped. | |
666 | ||
667 | @item C-c C-t | |
668 | @kindex C-c C-t @r{(GUD)} | |
669 | @itemx C-x C-a C-t | |
670 | @findex gud-tbreak | |
41f633c1 RS |
671 | Set a temporary breakpoint on the current source line, if any |
672 | (@code{gud-tbreak}). If you use this command in the GUD interaction | |
673 | buffer, it applies to the line where the program last stopped. | |
6bf7aab6 | 674 | |
6bf7aab6 DL |
675 | @item C-c < |
676 | @kindex C-c < @r{(GUD)} | |
677 | @itemx C-x C-a < | |
678 | @findex gud-up | |
679 | Select the next enclosing stack frame (@code{gud-up}). This is | |
41f633c1 | 680 | equivalent to the GDB command @samp{up}. |
6bf7aab6 DL |
681 | |
682 | @item C-c > | |
683 | @kindex C-c > @r{(GUD)} | |
684 | @itemx C-x C-a > | |
685 | @findex gud-down | |
686 | Select the next inner stack frame (@code{gud-down}). This is | |
41f633c1 | 687 | equivalent to the GDB command @samp{down}. |
f9ad161b RS |
688 | |
689 | @item C-c C-u | |
690 | @kindex C-c C-u @r{(GUD)} | |
691 | @itemx C-x C-a C-u | |
692 | @findex gud-until | |
41f633c1 RS |
693 | Continue execution to the current line (@code{gud-until}). The |
694 | program will run until it hits a breakpoint, terminates, gets a signal | |
695 | that the debugger is checking for, or reaches the line on which the | |
696 | cursor currently sits. | |
f9ad161b | 697 | |
6bf7aab6 DL |
698 | @item C-c C-f |
699 | @kindex C-c C-f @r{(GUD)} | |
700 | @itemx C-x C-a C-f | |
701 | @findex gud-finish | |
b5eb27b3 | 702 | Run the program until the selected stack frame returns or |
41f633c1 | 703 | stops for some other reason (@code{gud-finish}). |
55d5a463 NR |
704 | @end table |
705 | ||
706 | If you are using GDB, these additional key bindings are available: | |
5b7fc395 | 707 | |
55d5a463 | 708 | @table @kbd |
44fa0ae8 RS |
709 | @item C-x C-a C-j |
710 | @kindex C-x C-a C-j @r{(GUD)} | |
5b7fc395 | 711 | @findex gud-jump |
41f633c1 | 712 | Only useful in a source buffer, @code{gud-jump} transfers the |
44fa0ae8 RS |
713 | program's execution point to the current line. In other words, the |
714 | next line that the program executes will be the one where you gave the | |
715 | command. If the new execution line is in a different function from | |
716 | the previously one, GDB prompts for confirmation since the results may | |
717 | be bizarre. See the GDB manual entry regarding @code{jump} for | |
718 | details. | |
55d5a463 NR |
719 | |
720 | @item @key{TAB} | |
721 | @kindex TAB @r{(GUD)} | |
722 | @findex gud-gdb-complete-command | |
723 | With GDB, complete a symbol name (@code{gud-gdb-complete-command}). | |
724 | This key is available only in the GUD interaction buffer. | |
6bf7aab6 DL |
725 | @end table |
726 | ||
727 | These commands interpret a numeric argument as a repeat count, when | |
728 | that makes sense. | |
729 | ||
730 | Because @key{TAB} serves as a completion command, you can't use it to | |
731 | enter a tab as input to the program you are debugging with GDB. | |
732 | Instead, type @kbd{C-q @key{TAB}} to enter a tab. | |
733 | ||
734 | @node GUD Customization | |
735 | @subsection GUD Customization | |
736 | ||
737 | @vindex gdb-mode-hook | |
738 | @vindex dbx-mode-hook | |
739 | @vindex sdb-mode-hook | |
740 | @vindex xdb-mode-hook | |
741 | @vindex perldb-mode-hook | |
742 | @vindex pdb-mode-hook | |
743 | @vindex jdb-mode-hook | |
744 | On startup, GUD runs one of the following hooks: @code{gdb-mode-hook}, | |
745 | if you are using GDB; @code{dbx-mode-hook}, if you are using DBX; | |
746 | @code{sdb-mode-hook}, if you are using SDB; @code{xdb-mode-hook}, if you | |
747 | are using XDB; @code{perldb-mode-hook}, for Perl debugging mode; | |
e8388d28 | 748 | @code{pdb-mode-hook}, for PDB; @code{jdb-mode-hook}, for JDB. You can |
6bf7aab6 DL |
749 | use these hooks to define custom key bindings for the debugger |
750 | interaction buffer. @xref{Hooks}. | |
751 | ||
752 | Here is a convenient way to define a command that sends a particular | |
753 | command string to the debugger, and set up a key binding for it in the | |
754 | debugger interaction buffer: | |
755 | ||
756 | @findex gud-def | |
757 | @example | |
758 | (gud-def @var{function} @var{cmdstring} @var{binding} @var{docstring}) | |
759 | @end example | |
760 | ||
761 | This defines a command named @var{function} which sends | |
762 | @var{cmdstring} to the debugger process, and gives it the documentation | |
7fb4961c | 763 | string @var{docstring}. You can then use the command @var{function} in any |
6bf7aab6 DL |
764 | buffer. If @var{binding} is non-@code{nil}, @code{gud-def} also binds |
765 | the command to @kbd{C-c @var{binding}} in the GUD buffer's mode and to | |
766 | @kbd{C-x C-a @var{binding}} generally. | |
767 | ||
768 | The command string @var{cmdstring} may contain certain | |
769 | @samp{%}-sequences that stand for data to be filled in at the time | |
770 | @var{function} is called: | |
771 | ||
772 | @table @samp | |
773 | @item %f | |
774 | The name of the current source file. If the current buffer is the GUD | |
775 | buffer, then the ``current source file'' is the file that the program | |
776 | stopped in. | |
6bf7aab6 DL |
777 | |
778 | @item %l | |
779 | The number of the current source line. If the current buffer is the GUD | |
780 | buffer, then the ``current source line'' is the line that the program | |
781 | stopped in. | |
782 | ||
783 | @item %e | |
d6802fc1 NR |
784 | In transient-mark-mode the text in the region, if it is active. |
785 | Otherwise the text of the C lvalue or function-call expression at or | |
786 | adjacent to point. | |
6bf7aab6 DL |
787 | |
788 | @item %a | |
789 | The text of the hexadecimal address at or adjacent to point. | |
790 | ||
791 | @item %p | |
792 | The numeric argument of the called function, as a decimal number. If | |
793 | the command is used without a numeric argument, @samp{%p} stands for the | |
794 | empty string. | |
795 | ||
796 | If you don't use @samp{%p} in the command string, the command you define | |
797 | ignores any numeric argument. | |
d6802fc1 NR |
798 | |
799 | @item %d | |
800 | The name of the directory of the current source file. | |
801 | ||
802 | @item %c | |
803 | Fully qualified class name derived from the expression surrounding point | |
804 | (jdb only). | |
6bf7aab6 DL |
805 | @end table |
806 | ||
f9ad161b RS |
807 | @node GDB Graphical Interface |
808 | @subsection GDB Graphical Interface | |
809 | ||
499de9ba | 810 | By default, the command @code{gdb} starts GDB using a graphical |
41f633c1 RS |
811 | interface, using Emacs windows for display program state information. |
812 | In effect, this makes Emacs into an IDE (interactive development | |
813 | environment). With it, you do not need to use textual GDB commands; | |
fc275000 NR |
814 | you can control the debugging session with the mouse. For example, |
815 | you can click in the fringe of a source buffer to set a breakpoint | |
816 | there, or on a stack frame in the stack buffer to select that frame. | |
41f633c1 RS |
817 | |
818 | This mode requires telling GDB that its ``screen size'' is | |
819 | unlimited, so it sets the height and width accordingly. For correct | |
820 | operation you must not change these values during the GDB session. | |
51344076 | 821 | |
499de9ba | 822 | @vindex gud-gdb-command-name |
f9ad161b | 823 | @findex gdba |
41f633c1 | 824 | You can also run GDB in text command mode, like other debuggers. To |
b95fd69b NR |
825 | do this, replace the GDB @code{"--annotate=3"} option with |
826 | @code{"--fullname"} either in the minibuffer for the current Emacs | |
827 | session, or the custom variable @code{gud-gdb-command-name} for all | |
828 | future sessions. You need to use text command mode to debug multiple | |
829 | programs within one Emacs session. If you have customized | |
830 | @code{gud-gdb-command-name} in this way, you can use @kbd{M-x gdba} to | |
71fed6f3 NR |
831 | invoke GDB in graphical mode. Moreover, this command succeeds where |
832 | @kbd{M-x gdb} fails, such as when your @file{.gdbinit} file contains | |
833 | executable GDB commands. | |
f9ad161b RS |
834 | |
835 | @menu | |
be0f250c | 836 | * GDB-UI Layout:: Control the number of displayed buffers. |
988fd256 NR |
837 | * Source Buffers:: Use the mouse in the fringe/margin to |
838 | control your program. | |
3e2546d7 NR |
839 | * Breakpoints Buffer:: A breakpoint control panel. |
840 | * Stack Buffer:: Select a frame from the call stack. | |
be0f250c | 841 | * Other GDB-UI Buffers:: Input/output, locals, registers, |
f72b052c | 842 | assembler, threads and memory buffers. |
fc275000 | 843 | * Watch Expressions:: Monitor variable values in the speedbar. |
f9ad161b RS |
844 | @end menu |
845 | ||
be0f250c | 846 | @node GDB-UI Layout |
3e2546d7 | 847 | @subsubsection GDB User Interface Layout |
96110242 NR |
848 | @cindex GDB User Interface layout |
849 | ||
96110242 | 850 | @vindex gdb-many-windows |
41f633c1 RS |
851 | If the variable @code{gdb-many-windows} is @code{nil} (the default |
852 | value) then @kbd{M-x gdb} normally displays only the GUD buffer. | |
853 | However, if the variable @code{gdb-show-main} is also non-@code{nil}, | |
854 | it starts with two windows: one displaying the GUD buffer, and the | |
855 | other showing the source for the @code{main} function of the program | |
856 | you are debugging. | |
96110242 | 857 | |
41f633c1 RS |
858 | If @code{gdb-many-windows} is non-@code{nil}, then @kbd{M-x gdb} |
859 | displays the following frame layout: | |
96110242 | 860 | |
444246ca KB |
861 | @smallexample |
862 | @group | |
1a0b66fe | 863 | +--------------------------------+--------------------------------+ |
31d7d340 | 864 | | GUD buffer (I/O of GDB) | Locals buffer | |
1a0b66fe | 865 | |--------------------------------+--------------------------------+ |
988fd256 | 866 | | Primary Source buffer | I/O buffer for debugged pgm | |
1a0b66fe | 867 | |--------------------------------+--------------------------------+ |
31d7d340 | 868 | | Stack buffer | Breakpoints buffer | |
1a0b66fe | 869 | +--------------------------------+--------------------------------+ |
444246ca KB |
870 | @end group |
871 | @end smallexample | |
96110242 | 872 | |
9fb0c6f5 | 873 | However, if @code{gdb-use-separate-io-buffer} is @code{nil}, the I/O |
988fd256 NR |
874 | buffer does not appear and the primary source buffer occupies the full |
875 | width of the frame. | |
96110242 NR |
876 | |
877 | @findex gdb-restore-windows | |
41f633c1 RS |
878 | If you change the window layout, for example, while editing and |
879 | re-compiling your program, then you can restore this standard window | |
880 | layout with the command @code{gdb-restore-windows}. | |
881 | ||
882 | @findex gdb-many-windows | |
883 | To switch between this standard layout and a simple layout | |
884 | containing just the GUD buffer and a source file, type @kbd{M-x | |
885 | gdb-many-windows}. | |
886 | ||
be0f250c | 887 | You may also specify additional GDB-related buffers to display, |
41f633c1 RS |
888 | either in the same frame or a different one. Select the buffers you |
889 | want with the @samp{GUD->GDB-windows} and @samp{GUD->GDB-Frames} | |
890 | sub-menus. If the menu-bar is unavailable, type @code{M-x | |
96110242 | 891 | gdb-display-@var{buffertype}-buffer} or @code{M-x |
1a0b66fe | 892 | gdb-frame-@var{buffertype}-buffer} respectively, where |
41f633c1 RS |
893 | @var{buffertype} is the relevant buffer type, such as |
894 | @samp{breakpoints}. Most of these buffers are read-only, and typing | |
895 | @kbd{q} in them kills them. | |
96110242 | 896 | |
41f633c1 | 897 | When you finish debugging, kill the GUD buffer with @kbd{C-x k}, |
31b4c1b7 NR |
898 | which will also kill all the buffers associated with the session. |
899 | However you need not do this if, after editing and re-compiling your | |
900 | source code within Emacs, you wish continue debugging. When you | |
901 | restart execution, GDB will automatically find your new executable. | |
902 | Keeping the GUD buffer has the advantage of keeping the shell history | |
41f633c1 RS |
903 | as well as GDB's breakpoints. You do need to check that the |
904 | breakpoints in recently edited source files are still in the right | |
905 | places. | |
31b4c1b7 | 906 | |
988fd256 NR |
907 | @node Source Buffers |
908 | @subsubsection Source Buffers | |
909 | @cindex GDB commands in Fringe | |
910 | ||
911 | @c @findex gdb-mouse-set-clear-breakpoint | |
912 | @c @findex gdb-mouse-toggle-breakpoint | |
913 | Many GDB commands can be entered using keybindings or the tool bar but | |
914 | sometimes it is quicker to use the fringe. These commands either | |
915 | manipulate breakpoints or control program execution. When there is no | |
916 | fringe, you can use the margin but this is only present when the | |
917 | source file already has a breakpoint. | |
918 | ||
919 | You can click @kbd{Mouse-1} in the fringe or display margin of a | |
920 | source buffer to set a breakpoint there and, on a graphical display, a | |
921 | red bullet will appear on that line. If a breakpoint already exists | |
922 | on that line, the same click will remove it. You can also enable or | |
923 | disable a breakpoint by clicking @kbd{C-Mouse-1} on the bullet. | |
924 | ||
925 | A solid arrow in the left fringe of a source buffer indicates the line | |
926 | of the innermost frame where the debugged program has stopped. A | |
927 | hollow arrow indicates the current execution line of higher level | |
928 | frames. | |
929 | ||
930 | If you drag the arrow in the fringe with @kbd{Mouse-1} | |
931 | (@code{gdb-mouse-until}), execution will continue to the line where | |
932 | you release the button, provided it is still in the same frame. | |
933 | Alternatively, you can click @kbd{Mouse-3} at some point in the fringe | |
934 | of this buffer and execution will advance to there. A similar command | |
935 | (@code{gdb-mouse-jump}) allows you to jump to a source line without | |
936 | executing the intermediate lines by clicking @kbd{C-Mouse-3}. This | |
937 | command allows you to go backwards which can be useful for running | |
938 | through code that has already executed, in order to examine its | |
939 | execution in more detail. | |
940 | ||
941 | @table @kbd | |
942 | @item Mouse-1 | |
943 | Set or clear a breakpoint. | |
944 | ||
945 | @item C-Mouse-1 | |
946 | Enable or disable a breakpoint. | |
947 | ||
948 | @item Mouse-3 | |
949 | Continue execution to here. | |
950 | ||
951 | @item C-Mouse-3 | |
952 | Jump to here. | |
953 | @end table | |
954 | ||
955 | If the variable @code{gdb-find-source-frame} is non-@code{nil} and | |
956 | execution stops in a frame for which there is no source code e.g after | |
957 | an interrupt, then Emacs finds and displays the first frame further up | |
958 | stack for which there is source. If it is @code{nil} then the source | |
959 | buffer continues to display the last frame which maybe more useful, | |
960 | for example, when re-setting a breakpoint. | |
961 | ||
f9ad161b RS |
962 | @node Breakpoints Buffer |
963 | @subsubsection Breakpoints Buffer | |
964 | ||
3ebde3fb NR |
965 | The breakpoints buffer shows the existing breakpoints, watchpoints and |
966 | catchpoints (@pxref{Breakpoints,,, gdb, The GNU debugger}). It has | |
41f633c1 RS |
967 | these special commands, which mostly apply to the @dfn{current |
968 | breakpoint}, the breakpoint which point is on. | |
f9ad161b RS |
969 | |
970 | @table @kbd | |
254196f5 | 971 | @item @key{SPC} |
f9ad161b RS |
972 | @kindex SPC @r{(GDB breakpoints buffer)} |
973 | @findex gdb-toggle-breakpoint | |
41f633c1 RS |
974 | Enable/disable the current breakpoint (@code{gdb-toggle-breakpoint}). |
975 | On a graphical display, this changes the color of a bullet in the | |
988fd256 | 976 | margin of a source buffer at the relevant line. This is red when |
41f633c1 RS |
977 | the breakpoint is enabled and grey when it is disabled. Text-only |
978 | terminals correspondingly display a @samp{B} or @samp{b}. | |
f9ad161b | 979 | |
c3287027 NR |
980 | @item D |
981 | @kindex D @r{(GDB breakpoints buffer)} | |
f9ad161b | 982 | @findex gdb-delete-breakpoint |
41f633c1 | 983 | Delete the current breakpoint (@code{gdb-delete-breakpoint}). |
f9ad161b RS |
984 | |
985 | @item @key{RET} | |
986 | @kindex RET @r{(GDB breakpoints buffer)} | |
987 | @findex gdb-goto-breakpoint | |
41f633c1 RS |
988 | Visit the source line for the current breakpoint |
989 | (@code{gdb-goto-breakpoint}). | |
990 | ||
991 | @item Mouse-2 | |
992 | @kindex Mouse-2 @r{(GDB breakpoints buffer)} | |
993 | Visit the source line for the breakpoint you click on. | |
f9ad161b RS |
994 | @end table |
995 | ||
996 | @node Stack Buffer | |
997 | @subsubsection Stack Buffer | |
998 | ||
41f633c1 | 999 | The stack buffer displays a @dfn{call stack}, with one line for each |
f9ad161b | 1000 | of the nested subroutine calls (@dfn{stack frames}) now active in the |
1a0b66fe | 1001 | program. @xref{Backtrace,, Backtraces, gdb, The GNU debugger}. |
f9ad161b | 1002 | |
e4481965 | 1003 | @findex gdb-frames-select |
a7acd30f NR |
1004 | An arrow in the fringe points to the selected frame or, if the fringe is |
1005 | not present, the number of the selected frame is displayed in reverse | |
1006 | contrast. To select a frame in GDB, move point in the stack buffer to | |
1007 | that stack frame and type @key{RET} (@code{gdb-frames-select}), or click | |
41f633c1 | 1008 | @kbd{Mouse-2} on a stack frame. If the locals buffer is visible, |
a7acd30f NR |
1009 | selecting a stack frame updates it to display the local variables of the |
1010 | new frame. | |
f9ad161b | 1011 | |
be0f250c | 1012 | @node Other GDB-UI Buffers |
f9ad161b RS |
1013 | @subsubsection Other Buffers |
1014 | ||
1015 | @table @asis | |
1016 | @item Input/Output Buffer | |
9fb0c6f5 NR |
1017 | @vindex gdb-use-separate-io-buffer |
1018 | If the variable @code{gdb-use-separate-io-buffer} is non-@code{nil}, | |
be0f250c NR |
1019 | the program being debugged takes its input and displays its output |
1020 | here. Otherwise it uses the GUD buffer for that. To toggle whether | |
1021 | GUD mode uses this buffer, do @kbd{M-x gdb-use-separate-io-buffer}. | |
a7acd30f | 1022 | This takes effect when you next restart the program you are debugging. |
d08a1c88 | 1023 | |
cf3a96a3 | 1024 | The history and replay commands from Shell mode are available here, |
be0f250c | 1025 | as are the commands to send signals to the debugged program. |
cf3a96a3 | 1026 | @xref{Shell Mode}. |
f9ad161b RS |
1027 | |
1028 | @item Locals Buffer | |
1029 | The locals buffer displays the values of local variables of the | |
1a0b66fe | 1030 | current frame for simple data types (@pxref{Frame Info, Frame Info, |
b1333d4f NR |
1031 | Information on a frame, gdb, The GNU debugger}). Press @key{RET} or |
1032 | click @kbd{Mouse-2} on the value if you want to edit it. | |
f9ad161b | 1033 | |
51344076 NR |
1034 | Arrays and structures display their type only. With GDB 6.4 or later, |
1035 | move point to their name and press @key{RET}, or alternatively click | |
1036 | @kbd{Mouse-2} there, to examine their values. With earlier versions | |
cf3a96a3 RS |
1037 | of GDB, use @kbd{Mouse-2} or @key{RET} on the type description |
1038 | (@samp{[struct/union]} or @samp{[array]}). @xref{Watch Expressions}. | |
f9ad161b RS |
1039 | |
1040 | @item Registers Buffer | |
e4481965 | 1041 | @findex toggle-gdb-all-registers |
f9ad161b | 1042 | The registers buffer displays the values held by the registers |
c3287027 | 1043 | (@pxref{Registers,,, gdb, The GNU debugger}). Press @key{RET} or |
b1333d4f | 1044 | click @kbd{Mouse-2} on a register if you want to edit its value. |
51344076 | 1045 | With GDB 6.4 or later, recently changed register values display with |
41f633c1 RS |
1046 | @code{font-lock-warning-face}. With earlier versions of GDB, you can |
1047 | press @key{SPC} to toggle the display of floating point registers | |
e4481965 | 1048 | (@code{toggle-gdb-all-registers}). |
f9ad161b RS |
1049 | |
1050 | @item Assembler Buffer | |
1051 | The assembler buffer displays the current frame as machine code. An | |
41f633c1 RS |
1052 | arrow points to the current instruction, and you can set and remove |
1053 | breakpoints as in a source buffer. Breakpoint icons also appear in | |
1054 | the fringe or margin. | |
8d66c08b NR |
1055 | |
1056 | @item Threads Buffer | |
e4481965 | 1057 | @findex gdb-threads-select |
8d66c08b | 1058 | The threads buffer displays a summary of all threads currently in your |
1a0b66fe NR |
1059 | program (@pxref{Threads, Threads, Debugging programs with multiple |
1060 | threads, gdb, The GNU debugger}). Move point to any thread in the | |
1061 | list and press @key{RET} to select it (@code{gdb-threads-select}) and | |
988fd256 NR |
1062 | display the associated source in the primary source buffer. |
1063 | Alternatively, click @kbd{Mouse-2} on a thread to select it. If the | |
1064 | locals buffer is visible, its contents update to display the variables | |
1065 | that are local in the new thread. | |
8d66c08b | 1066 | |
31b4c1b7 | 1067 | @item Memory Buffer |
41f633c1 RS |
1068 | The memory buffer lets you examine sections of program memory |
1069 | (@pxref{Memory, Memory, Examining memory, gdb, The GNU debugger}). | |
1070 | Click @kbd{Mouse-1} on the appropriate part of the header line to | |
1071 | change the starting address or number of data items that the buffer | |
1072 | displays. Click @kbd{Mouse-3} on the header line to select the | |
1a0b66fe | 1073 | display format or unit size for these data items. |
fc275000 NR |
1074 | @end table |
1075 | ||
fc275000 NR |
1076 | @node Watch Expressions |
1077 | @subsubsection Watch Expressions | |
1078 | @cindex Watching expressions in GDB | |
1079 | ||
1080 | @findex gud-watch | |
1081 | @kindex C-x C-a C-w @r{(GUD)} | |
1082 | If you want to see how a variable changes each time your program | |
1083 | stops, move point into the variable name and click on the watch icon | |
1084 | in the tool bar (@code{gud-watch}) or type @kbd{C-x C-a C-w}. If you | |
1085 | specify a prefix argument, you can enter the variable name in the | |
1086 | minibuffer. | |
1087 | ||
1088 | Each watch expression is displayed in the speedbar. Complex data | |
1089 | types, such as arrays, structures and unions are represented in a tree | |
1090 | format. Leaves and simple data types show the name of the expression | |
1091 | and its value and, when the speedbar frame is selected, display the | |
1092 | type as a tooltip. Higher levels show the name, type and address | |
1093 | value for pointers and just the name and type otherwise. Root expressions | |
1094 | also display the frame address as a tooltip to help identify the frame | |
1095 | in which they were defined. | |
1096 | ||
014361d8 NR |
1097 | To expand or contract a complex data type, click @kbd{Mouse-2} or |
1098 | press @key{SPC} on the tag to the left of the expression. Emacs asks | |
1099 | for confirmation before expanding the expression if its number of | |
1100 | immediate children exceeds the value of the variable | |
1101 | @code{gdb-max-children}. | |
fc275000 NR |
1102 | |
1103 | @kindex D @r{(GDB speedbar)} | |
1104 | @findex gdb-var-delete | |
1105 | To delete a complex watch expression, move point to the root | |
1106 | expression in the speedbar and type @kbd{D} (@code{gdb-var-delete}). | |
1107 | ||
1108 | @kindex RET @r{(GDB speedbar)} | |
1109 | @findex gdb-edit-value | |
1110 | To edit a variable with a simple data type, or a simple element of a | |
1111 | complex data type, move point there in the speedbar and type @key{RET} | |
1112 | (@code{gdb-edit-value}). Or you can click @kbd{Mouse-2} on a value to | |
1113 | edit it. Either way, this reads the new value using the minibuffer. | |
1114 | ||
1115 | @vindex gdb-show-changed-values | |
1116 | If you set the variable @code{gdb-show-changed-values} to | |
1117 | non-@code{nil} (the default value), Emacs uses | |
1118 | @code{font-lock-warning-face} to highlight values that have recently | |
1119 | changed and @code{shadow} face to make variables which have gone out of | |
1120 | scope less noticeable. When a variable goes out of scope you can't | |
1121 | edit its value. | |
1122 | ||
1123 | @vindex gdb-use-colon-colon-notation | |
1124 | If the variable @code{gdb-use-colon-colon-notation} is | |
1125 | non-@code{nil}, Emacs uses the @samp{@var{function}::@var{variable}} | |
1126 | format. This allows the user to display watch expressions which share | |
1127 | the same variable name. The default value is @code{nil}. | |
1128 | ||
1129 | @vindex gdb-speedbar-auto-raise | |
1130 | To automatically raise the speedbar every time the display of watch | |
1131 | expressions updates, set @code{gdb-speedbar-auto-raise} to | |
1132 | non-@code{nil}. This can be useful if you are debugging with a full | |
1133 | screen Emacs frame. | |
1134 | ||
6bf7aab6 DL |
1135 | @node Executing Lisp |
1136 | @section Executing Lisp Expressions | |
1137 | ||
1138 | Emacs has several different major modes for Lisp and Scheme. They are | |
1139 | the same in terms of editing commands, but differ in the commands for | |
1140 | executing Lisp expressions. Each mode has its own purpose. | |
1141 | ||
1142 | @table @asis | |
1143 | @item Emacs-Lisp mode | |
1144 | The mode for editing source files of programs to run in Emacs Lisp. | |
1145 | This mode defines @kbd{C-M-x} to evaluate the current defun. | |
1146 | @xref{Lisp Libraries}. | |
1147 | @item Lisp Interaction mode | |
1148 | The mode for an interactive session with Emacs Lisp. It defines | |
1149 | @kbd{C-j} to evaluate the sexp before point and insert its value in the | |
1150 | buffer. @xref{Lisp Interaction}. | |
1151 | @item Lisp mode | |
1152 | The mode for editing source files of programs that run in Lisps other | |
1153 | than Emacs Lisp. This mode defines @kbd{C-M-x} to send the current defun | |
1154 | to an inferior Lisp process. @xref{External Lisp}. | |
1155 | @item Inferior Lisp mode | |
1156 | The mode for an interactive session with an inferior Lisp process. | |
1157 | This mode combines the special features of Lisp mode and Shell mode | |
1158 | (@pxref{Shell Mode}). | |
1159 | @item Scheme mode | |
1160 | Like Lisp mode but for Scheme programs. | |
1161 | @item Inferior Scheme mode | |
1162 | The mode for an interactive session with an inferior Scheme process. | |
1163 | @end table | |
1164 | ||
1165 | Most editing commands for working with Lisp programs are in fact | |
1166 | available globally. @xref{Programs}. | |
1167 | ||
1168 | @node Lisp Libraries | |
1169 | @section Libraries of Lisp Code for Emacs | |
1170 | @cindex libraries | |
1171 | @cindex loading Lisp code | |
1172 | ||
1173 | Lisp code for Emacs editing commands is stored in files whose names | |
1174 | conventionally end in @file{.el}. This ending tells Emacs to edit them in | |
1175 | Emacs-Lisp mode (@pxref{Executing Lisp}). | |
1176 | ||
41f633c1 RS |
1177 | @cindex byte code |
1178 | Emacs Lisp code can be compiled into byte-code, which loads faster, | |
1179 | takes up less space, and executes faster. @xref{Byte Compilation,, | |
1180 | Byte Compilation, elisp, the Emacs Lisp Reference Manual}. By | |
1181 | convention, the compiled code for a library goes in a separate file | |
1182 | whose name ends in @samp{.elc}. Thus, the compiled code for | |
1183 | @file{foo.el} goes in @file{foo.elc}. | |
1184 | ||
6bf7aab6 DL |
1185 | @findex load-file |
1186 | To execute a file of Emacs Lisp code, use @kbd{M-x load-file}. This | |
1187 | command reads a file name using the minibuffer and then executes the | |
1188 | contents of that file as Lisp code. It is not necessary to visit the | |
1189 | file first; in any case, this command reads the file as found on disk, | |
1190 | not text in an Emacs buffer. | |
1191 | ||
1192 | @findex load | |
1193 | @findex load-library | |
1194 | Once a file of Lisp code is installed in the Emacs Lisp library | |
41f633c1 RS |
1195 | directories, users can load it using @kbd{M-x load-library}. Programs |
1196 | can load it by calling @code{load}, a more primitive function that is | |
1197 | similar but accepts some additional arguments. | |
6bf7aab6 DL |
1198 | |
1199 | @kbd{M-x load-library} differs from @kbd{M-x load-file} in that it | |
1200 | searches a sequence of directories and tries three file names in each | |
1201 | directory. Suppose your argument is @var{lib}; the three names are | |
1202 | @file{@var{lib}.elc}, @file{@var{lib}.el}, and lastly just | |
1203 | @file{@var{lib}}. If @file{@var{lib}.elc} exists, it is by convention | |
1204 | the result of compiling @file{@var{lib}.el}; it is better to load the | |
1205 | compiled file, since it will load and run faster. | |
1206 | ||
1207 | If @code{load-library} finds that @file{@var{lib}.el} is newer than | |
41f633c1 RS |
1208 | @file{@var{lib}.elc} file, it issues a warning, because it's likely |
1209 | that somebody made changes to the @file{.el} file and forgot to | |
1210 | recompile it. Nonetheless, it loads @file{@var{lib}.elc}. This is | |
1211 | because people often leave unfinished edits the source file, and don't | |
1212 | recompile it until they think it is ready to use. | |
6bf7aab6 DL |
1213 | |
1214 | Because the argument to @code{load-library} is usually not in itself | |
1215 | a valid file name, file name completion is not available. Indeed, when | |
1216 | using this command, you usually do not know exactly what file name | |
1217 | will be used. | |
1218 | ||
1219 | @vindex load-path | |
1220 | The sequence of directories searched by @kbd{M-x load-library} is | |
1221 | specified by the variable @code{load-path}, a list of strings that are | |
41f633c1 | 1222 | directory names. The default value of the list contains the directories where |
6bf7aab6 DL |
1223 | the Lisp code for Emacs itself is stored. If you have libraries of |
1224 | your own, put them in a single directory and add that directory | |
1225 | to @code{load-path}. @code{nil} in this list stands for the current default | |
1226 | directory, but it is probably not a good idea to put @code{nil} in the | |
1227 | list. If you find yourself wishing that @code{nil} were in the list, | |
1228 | most likely what you really want to do is use @kbd{M-x load-file} | |
1229 | this once. | |
1230 | ||
1231 | @cindex autoload | |
1232 | Often you do not have to give any command to load a library, because | |
1233 | the commands defined in the library are set up to @dfn{autoload} that | |
1234 | library. Trying to run any of those commands calls @code{load} to load | |
1235 | the library; this replaces the autoload definitions with the real ones | |
1236 | from the library. | |
1237 | ||
493c59e0 EZ |
1238 | @vindex load-dangerous-libraries |
1239 | @cindex Lisp files byte-compiled by XEmacs | |
a50c7a80 RS |
1240 | By default, Emacs refuses to load compiled Lisp files which were |
1241 | compiled with XEmacs, a modified versions of Emacs---they can cause | |
1242 | Emacs to crash. Set the variable @code{load-dangerous-libraries} to | |
1243 | @code{t} if you want to try loading them. | |
493c59e0 | 1244 | |
6bf7aab6 | 1245 | @node Lisp Eval |
dd525369 | 1246 | @section Evaluating Emacs Lisp Expressions |
6bf7aab6 DL |
1247 | @cindex Emacs-Lisp mode |
1248 | @cindex mode, Emacs-Lisp | |
1249 | ||
1250 | @findex emacs-lisp-mode | |
1251 | Lisp programs intended to be run in Emacs should be edited in | |
1252 | Emacs-Lisp mode; this happens automatically for file names ending in | |
1253 | @file{.el}. By contrast, Lisp mode itself is used for editing Lisp | |
1254 | programs intended for other Lisp systems. To switch to Emacs-Lisp mode | |
1255 | explicitly, use the command @kbd{M-x emacs-lisp-mode}. | |
1256 | ||
1257 | For testing of Lisp programs to run in Emacs, it is often useful to | |
1258 | evaluate part of the program as it is found in the Emacs buffer. For | |
1259 | example, after changing the text of a Lisp function definition, | |
1260 | evaluating the definition installs the change for future calls to the | |
1261 | function. Evaluation of Lisp expressions is also useful in any kind of | |
1262 | editing, for invoking noninteractive functions (functions that are | |
1263 | not commands). | |
1264 | ||
1265 | @table @kbd | |
1266 | @item M-: | |
1267 | Read a single Lisp expression in the minibuffer, evaluate it, and print | |
1268 | the value in the echo area (@code{eval-expression}). | |
1269 | @item C-x C-e | |
1270 | Evaluate the Lisp expression before point, and print the value in the | |
1271 | echo area (@code{eval-last-sexp}). | |
1272 | @item C-M-x | |
1273 | Evaluate the defun containing or after point, and print the value in | |
1274 | the echo area (@code{eval-defun}). | |
1275 | @item M-x eval-region | |
1276 | Evaluate all the Lisp expressions in the region. | |
4c242e96 | 1277 | @item M-x eval-buffer |
6bf7aab6 DL |
1278 | Evaluate all the Lisp expressions in the buffer. |
1279 | @end table | |
1280 | ||
09041c4b | 1281 | @ifinfo |
c668cdd0 EZ |
1282 | @c This uses ``colon'' instead of a literal `:' because Info cannot |
1283 | @c cope with a `:' in a menu | |
1284 | @kindex M-@key{colon} | |
09041c4b EZ |
1285 | @end ifinfo |
1286 | @ifnotinfo | |
1287 | @kindex M-: | |
1288 | @end ifnotinfo | |
6bf7aab6 DL |
1289 | @findex eval-expression |
1290 | @kbd{M-:} (@code{eval-expression}) is the most basic command for evaluating | |
1291 | a Lisp expression interactively. It reads the expression using the | |
1292 | minibuffer, so you can execute any expression on a buffer regardless of | |
1293 | what the buffer contains. When the expression is evaluated, the current | |
1294 | buffer is once again the buffer that was current when @kbd{M-:} was | |
1295 | typed. | |
1296 | ||
1297 | @kindex C-M-x @r{(Emacs-Lisp mode)} | |
1298 | @findex eval-defun | |
1299 | In Emacs-Lisp mode, the key @kbd{C-M-x} is bound to the command | |
1300 | @code{eval-defun}, which parses the defun containing or following point | |
1301 | as a Lisp expression and evaluates it. The value is printed in the echo | |
1302 | area. This command is convenient for installing in the Lisp environment | |
1303 | changes that you have just made in the text of a function definition. | |
1304 | ||
1305 | @kbd{C-M-x} treats @code{defvar} expressions specially. Normally, | |
1306 | evaluating a @code{defvar} expression does nothing if the variable it | |
1307 | defines already has a value. But @kbd{C-M-x} unconditionally resets the | |
1308 | variable to the initial value specified in the @code{defvar} expression. | |
9c8599ca | 1309 | @code{defcustom} expressions are treated similarly. |
6bf7aab6 | 1310 | This special feature is convenient for debugging Lisp programs. |
dc134342 JL |
1311 | Typing @kbd{C-M-x} on a @code{defface} expression reinitializes |
1312 | the face according to the @code{defface} specification. | |
6bf7aab6 DL |
1313 | |
1314 | @kindex C-x C-e | |
1315 | @findex eval-last-sexp | |
1316 | The command @kbd{C-x C-e} (@code{eval-last-sexp}) evaluates the Lisp | |
1317 | expression preceding point in the buffer, and displays the value in the | |
1318 | echo area. It is available in all major modes, not just Emacs-Lisp | |
1319 | mode. It does not treat @code{defvar} specially. | |
1320 | ||
ed4389af RS |
1321 | When the result of an evaluation is an integer, you can type |
1322 | @kbd{C-x C-e} a second time to display the value of the integer result | |
1323 | in additional formats (octal, hexadecimal, and character). | |
1324 | ||
c91809b2 RS |
1325 | If @kbd{C-x C-e}, or @kbd{M-:} is given a numeric argument, it |
1326 | inserts the value into the current buffer at point, rather than | |
1327 | displaying it in the echo area. The argument's value does not matter. | |
1328 | @kbd{C-M-x} with a numeric argument instruments the function | |
1329 | definition for Edebug (@pxref{Instrumenting, Instrumenting for Edebug,, elisp, the Emacs Lisp Reference Manual}). | |
6bf7aab6 DL |
1330 | |
1331 | @findex eval-region | |
4c242e96 | 1332 | @findex eval-buffer |
6bf7aab6 DL |
1333 | The most general command for evaluating Lisp expressions from a buffer |
1334 | is @code{eval-region}. @kbd{M-x eval-region} parses the text of the | |
1335 | region as one or more Lisp expressions, evaluating them one by one. | |
4c242e96 | 1336 | @kbd{M-x eval-buffer} is similar but evaluates the entire |
6bf7aab6 | 1337 | buffer. This is a reasonable way to install the contents of a file of |
58fa012d | 1338 | Lisp code that you are ready to test. Later, as you find bugs and |
6bf7aab6 DL |
1339 | change individual functions, use @kbd{C-M-x} on each function that you |
1340 | change. This keeps the Lisp world in step with the source file. | |
1341 | ||
9c8599ca DL |
1342 | @vindex eval-expression-print-level |
1343 | @vindex eval-expression-print-length | |
1344 | @vindex eval-expression-debug-on-error | |
444246ca | 1345 | The two customizable variables @code{eval-expression-print-level} and |
9c8599ca DL |
1346 | @code{eval-expression-print-length} control the maximum depth and length |
1347 | of lists to print in the result of the evaluation commands before | |
1348 | abbreviating them. @code{eval-expression-debug-on-error} controls | |
1349 | whether evaluation errors invoke the debugger when these commands are | |
41f633c1 | 1350 | used; its default is @code{t}. |
9c8599ca | 1351 | |
6bf7aab6 DL |
1352 | @node Lisp Interaction |
1353 | @section Lisp Interaction Buffers | |
1354 | ||
1355 | The buffer @samp{*scratch*} which is selected when Emacs starts up is | |
1356 | provided for evaluating Lisp expressions interactively inside Emacs. | |
1357 | ||
1358 | The simplest way to use the @samp{*scratch*} buffer is to insert Lisp | |
1359 | expressions and type @kbd{C-j} after each expression. This command | |
1360 | reads the Lisp expression before point, evaluates it, and inserts the | |
1361 | value in printed representation before point. The result is a complete | |
1362 | typescript of the expressions you have evaluated and their values. | |
1363 | ||
1364 | The @samp{*scratch*} buffer's major mode is Lisp Interaction mode, which | |
1365 | is the same as Emacs-Lisp mode except for the binding of @kbd{C-j}. | |
1366 | ||
1367 | @findex lisp-interaction-mode | |
1368 | The rationale for this feature is that Emacs must have a buffer when | |
1369 | it starts up, but that buffer is not useful for editing files since a | |
1370 | new buffer is made for every file that you visit. The Lisp interpreter | |
1371 | typescript is the most useful thing I can think of for the initial | |
1372 | buffer to do. Type @kbd{M-x lisp-interaction-mode} to put the current | |
1373 | buffer in Lisp Interaction mode. | |
1374 | ||
1375 | @findex ielm | |
1376 | An alternative way of evaluating Emacs Lisp expressions interactively | |
1377 | is to use Inferior Emacs-Lisp mode, which provides an interface rather | |
1378 | like Shell mode (@pxref{Shell Mode}) for evaluating Emacs Lisp | |
1379 | expressions. Type @kbd{M-x ielm} to create an @samp{*ielm*} buffer | |
b9195b52 RS |
1380 | which uses this mode. For more information see that command's |
1381 | documentation. | |
6bf7aab6 DL |
1382 | |
1383 | @node External Lisp | |
1384 | @section Running an External Lisp | |
1385 | ||
1386 | Emacs has facilities for running programs in other Lisp systems. You can | |
1387 | run a Lisp process as an inferior of Emacs, and pass expressions to it to | |
1388 | be evaluated. You can also pass changed function definitions directly from | |
1389 | the Emacs buffers in which you edit the Lisp programs to the inferior Lisp | |
1390 | process. | |
1391 | ||
1392 | @findex run-lisp | |
1393 | @vindex inferior-lisp-program | |
1394 | @kindex C-x C-z | |
1395 | To run an inferior Lisp process, type @kbd{M-x run-lisp}. This runs | |
1396 | the program named @code{lisp}, the same program you would run by typing | |
1397 | @code{lisp} as a shell command, with both input and output going through | |
1398 | an Emacs buffer named @samp{*lisp*}. That is to say, any ``terminal | |
1399 | output'' from Lisp will go into the buffer, advancing point, and any | |
1400 | ``terminal input'' for Lisp comes from text in the buffer. (You can | |
1401 | change the name of the Lisp executable file by setting the variable | |
1402 | @code{inferior-lisp-program}.) | |
1403 | ||
1404 | To give input to Lisp, go to the end of the buffer and type the input, | |
1405 | terminated by @key{RET}. The @samp{*lisp*} buffer is in Inferior Lisp | |
1406 | mode, which combines the special characteristics of Lisp mode with most | |
1407 | of the features of Shell mode (@pxref{Shell Mode}). The definition of | |
1408 | @key{RET} to send a line to a subprocess is one of the features of Shell | |
1409 | mode. | |
1410 | ||
1411 | @findex lisp-mode | |
1412 | For the source files of programs to run in external Lisps, use Lisp | |
41f633c1 RS |
1413 | mode. You can switch to this mode with @kbd{M-x lisp-mode}, and it is |
1414 | used automatically for files whose names end in @file{.l}, | |
1415 | @file{.lsp}, or @file{.lisp}. | |
6bf7aab6 DL |
1416 | |
1417 | @kindex C-M-x @r{(Lisp mode)} | |
1418 | @findex lisp-eval-defun | |
1419 | When you edit a function in a Lisp program you are running, the easiest | |
1420 | way to send the changed definition to the inferior Lisp process is the key | |
1421 | @kbd{C-M-x}. In Lisp mode, this runs the function @code{lisp-eval-defun}, | |
1422 | which finds the defun around or following point and sends it as input to | |
1423 | the Lisp process. (Emacs can send input to any inferior process regardless | |
1424 | of what buffer is current.) | |
1425 | ||
41f633c1 RS |
1426 | Contrast the meanings of @kbd{C-M-x} in Lisp mode (for editing |
1427 | programs to be run in another Lisp system) and Emacs-Lisp mode (for | |
1428 | editing Lisp programs to be run in Emacs; see @pxref{Lisp Eval}): in | |
1429 | both modes it has the effect of installing the function definition | |
1430 | that point is in, but the way of doing so is different according to | |
1431 | where the relevant Lisp environment is found. | |
1432 | ||
ab5796a9 MB |
1433 | |
1434 | @ignore | |
1435 | arch-tag: 9c3c2f71-b332-4144-8500-3ff9945a50ed | |
1436 | @end ignore |