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