Mercurial > emacs
annotate man/programs.texi @ 29714:2557d0472f9b
(srcdir): Edit this variable.
author | Eli Zaretskii <eliz@gnu.org> |
---|---|
date | Sun, 18 Jun 2000 10:06:00 +0000 |
parents | 203ba1f77b7b |
children | 53f07097269e |
rev | line source |
---|---|
25829 | 1 @c This is part of the Emacs manual. |
27221
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
2 @c Copyright (C) 1985,86,87,93,94,95,97,99,2000 Free Software Foundation, Inc. |
25829 | 3 @c See file emacs.texi for copying conditions. |
4 @node Programs, Building, Text, Top | |
5 @chapter Editing Programs | |
6 @cindex Lisp editing | |
7 @cindex C editing | |
8 @cindex program editing | |
9 | |
10 Emacs has many commands designed to understand the syntax of programming | |
11 languages such as Lisp and C. These commands can | |
12 | |
13 @itemize @bullet | |
14 @item | |
15 Move over or kill balanced expressions or @dfn{sexps} (@pxref{Lists}). | |
16 @item | |
17 Move over or mark top-level expressions---@dfn{defuns}, in Lisp; | |
18 functions, in C (@pxref{Defuns}). | |
19 @item | |
20 Show how parentheses balance (@pxref{Matching}). | |
21 @item | |
22 Insert, kill or align comments (@pxref{Comments}). | |
23 @item | |
24 Follow the usual indentation conventions of the language | |
25 (@pxref{Program Indent}). | |
26 @end itemize | |
27 | |
28 The commands for words, sentences and paragraphs are very useful in | |
29 editing code even though their canonical application is for editing | |
30 human language text. Most symbols contain words (@pxref{Words}); | |
31 sentences can be found in strings and comments (@pxref{Sentences}). | |
32 Paragraphs per se don't exist in code, but the paragraph commands are | |
33 useful anyway, because programming language major modes define | |
34 paragraphs to begin and end at blank lines (@pxref{Paragraphs}). | |
35 Judicious use of blank lines to make the program clearer will also | |
36 provide useful chunks of text for the paragraph commands to work | |
37 on. | |
38 | |
28329
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
39 @cindex selective display |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
40 @cindex outline |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
41 @cindex folding |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
42 @findex outline-minor-mode |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
43 @cindex outlines |
25829 | 44 The selective display feature is useful for looking at the overall |
27221
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
45 structure of a function (@pxref{Selective Display}). This feature |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
46 causes only the lines that are indented less than a specified amount to |
28329
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
47 appear on the screen. Programming modes often support Outline minor |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
48 mode (@pxref{Outline Mode}). The Foldout package (@pxref{Foldout}) can |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
49 provide convenient folding-editor features on top of the minor mode. |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
50 The Hideshow package (@pxref{Hideshow}) can also be used to display |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
51 bocks of code selectively. |
27221
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
52 |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
53 The `automatic typing' features may be useful when writing programs. |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
54 @xref{Top, Autotyping, autotype, Features for Automatic Typing}. |
25829 | 55 |
56 @menu | |
57 * Program Modes:: Major modes for editing programs. | |
58 * Lists:: Expressions with balanced parentheses. | |
59 * List Commands:: The commands for working with list and sexps. | |
60 * Defuns:: Each program is made up of separate functions. | |
61 There are editing commands to operate on them. | |
62 * Program Indent:: Adjusting indentation to show the nesting. | |
63 * Matching:: Insertion of a close-delimiter flashes matching open. | |
64 * Comments:: Inserting, killing, and aligning comments. | |
65 * Balanced Editing:: Inserting two matching parentheses at once, etc. | |
66 * Symbol Completion:: Completion on symbol names of your program or language. | |
67 * Which Function:: Which Function mode shows which function you are in. | |
28329
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
68 * Hideshow:: Displaying blocks selectively. |
25829 | 69 * Documentation:: Getting documentation of functions you plan to call. |
70 * Change Log:: Maintaining a change history for your program. | |
71 * Tags:: Go direct to any function in your program in one | |
72 command. Tags remembers which file it is in. | |
28329
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
73 * Imenu:: Making buffer indexes as menus. |
25829 | 74 * Emerge:: A convenient way of merging two versions of a program. |
26264 | 75 * C Modes:: Special commands of C, C++, Objective-C, |
25829 | 76 Java, and Pike modes. |
28329
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
77 * Fortran:: Fortran mode and its special features. |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
78 * Asm Mode:: Asm mode and its special features. |
25829 | 79 @end menu |
80 | |
81 @node Program Modes | |
82 @section Major Modes for Programming Languages | |
83 | |
84 @cindex modes for programming languages | |
85 @cindex Perl mode | |
86 @cindex Icon mode | |
87 @cindex Awk mode | |
88 @cindex Makefile mode | |
89 @cindex Tcl mode | |
90 @cindex CPerl mode | |
26106 | 91 @cindex DSSSL mode |
92 @cindex Octave mode | |
93 @cindex Metafont mode | |
94 @cindex Modula2 mode | |
95 @cindex Prolog mode | |
96 @cindex Simula mode | |
97 @cindex VHDL mode | |
98 @cindex M4 mode | |
99 @cindex Shell-script mode | |
25829 | 100 Emacs also has major modes for the programming languages Lisp, Scheme |
28329
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
101 (a variant of Lisp) and the Scheme-based DSSSL expression language, Ada, |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
102 Awk, C, C++, Fortran (free and fixed format), Icon, IDLWAVE, |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
103 Java, Metafont (@TeX{}'s companion for font creation), Modula2, |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
104 Objective-C, Octave, Pascal, Perl, Pike, Prolog, Simula, VHDL, CORBA |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
105 IDL, and Tcl. There is also a major mode for makefiles, called Makefile |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
106 mode. An alternative mode for Perl is called CPerl mode. Modes |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
107 are available for scripts for the common Unix shells, VMS DCL and |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
108 MS-DOS/MS-Windows `BAT' files. In a similar fashion to programming |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
109 languages, modes are provided for editing various sorts of configuration |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
110 files. |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
111 |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
112 Separate manuals are available for th modes for Ada (@pxref{Top, , Ada Mode, |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
113 ada-mode, Ada Mode}), C/C++/Objective C/Java/Corba IDL (@pxref{Top, , CC Mode, |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
114 ccmode, CC Mode}) and the IDLWAVE modes (@pxref{Top, , IDLWAVE, |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
115 idlwave, IDLWAVE User Manual}). |
25829 | 116 |
117 Ideally, a major mode should be implemented for each programming | |
118 language that you might want to edit with Emacs; but often the mode for | |
119 one language can serve for other syntactically similar languages. The | |
120 language modes that exist are those that someone decided to take the | |
121 trouble to write. | |
122 | |
123 There are several forms of Lisp mode, which differ in the way they | |
124 interface to Lisp execution. @xref{Executing Lisp}. | |
125 | |
126 Each of the programming language major modes defines the @key{TAB} key | |
127 to run an indentation function that knows the indentation conventions of | |
128 that language and updates the current line's indentation accordingly. | |
129 For example, in C mode @key{TAB} is bound to @code{c-indent-line}. | |
130 @kbd{C-j} is normally defined to do @key{RET} followed by @key{TAB}; | |
131 thus, it too indents in a mode-specific fashion. | |
132 | |
133 @kindex DEL @r{(programming modes)} | |
134 @findex backward-delete-char-untabify | |
135 In most programming languages, indentation is likely to vary from line to | |
136 line. So the major modes for those languages rebind @key{DEL} to treat a | |
137 tab as if it were the equivalent number of spaces (using the command | |
138 @code{backward-delete-char-untabify}). This makes it possible to rub out | |
139 indentation one column at a time without worrying whether it is made up of | |
140 spaces or tabs. Use @kbd{C-b C-d} to delete a tab character before point, | |
141 in these modes. | |
142 | |
143 Programming language modes define paragraphs to be separated only by | |
144 blank lines, so that the paragraph commands remain useful. Auto Fill mode, | |
145 if enabled in a programming language major mode, indents the new lines | |
146 which it creates. | |
147 | |
148 @cindex mode hook | |
149 @vindex c-mode-hook | |
150 @vindex lisp-mode-hook | |
151 @vindex emacs-lisp-mode-hook | |
152 @vindex lisp-interaction-mode-hook | |
153 @vindex scheme-mode-hook | |
154 Turning on a major mode runs a normal hook called the @dfn{mode hook}, | |
155 which is the value of a Lisp variable. Each major mode has a mode hook, | |
156 and the hook's name is always made from the mode command's name by | |
157 adding @samp{-hook}. For example, turning on C mode runs the hook | |
158 @code{c-mode-hook}, while turning on Lisp mode runs the hook | |
159 @code{lisp-mode-hook}. @xref{Hooks}. | |
160 | |
161 @node Lists | |
162 @section Lists and Sexps | |
163 | |
164 @cindex Control-Meta | |
165 By convention, Emacs keys for dealing with balanced expressions are | |
166 usually Control-Meta characters. They tend to be analogous in | |
167 function to their Control and Meta equivalents. These commands are | |
168 usually thought of as pertaining to expressions in programming | |
169 languages, but can be useful with any language in which some sort of | |
170 parentheses exist (including human languages). | |
171 | |
172 @cindex list | |
173 @cindex sexp | |
174 @cindex expression | |
175 @cindex parentheses, moving across | |
176 @cindex matching parenthesis, moving to | |
177 These commands fall into two classes. Some deal only with @dfn{lists} | |
178 (parenthetical groupings). They see nothing except parentheses, brackets, | |
179 braces (whichever ones must balance in the language you are working with), | |
180 and escape characters that might be used to quote those. | |
181 | |
182 The other commands deal with expressions or @dfn{sexps}. The word `sexp' | |
183 is derived from @dfn{s-expression}, the ancient term for an expression in | |
184 Lisp. But in Emacs, the notion of `sexp' is not limited to Lisp. It | |
185 refers to an expression in whatever language your program is written in. | |
186 Each programming language has its own major mode, which customizes the | |
187 syntax tables so that expressions in that language count as sexps. | |
188 | |
189 Sexps typically include symbols, numbers, and string constants, as well | |
190 as anything contained in parentheses, brackets or braces. | |
191 | |
192 In languages that use prefix and infix operators, such as C, it is not | |
193 possible for all expressions to be sexps. For example, C mode does not | |
194 recognize @samp{foo + bar} as a sexp, even though it @emph{is} a C expression; | |
195 it recognizes @samp{foo} as one sexp and @samp{bar} as another, with the | |
196 @samp{+} as punctuation between them. This is a fundamental ambiguity: | |
197 both @samp{foo + bar} and @samp{foo} are legitimate choices for the sexp to | |
198 move over if point is at the @samp{f}. Note that @samp{(foo + bar)} is a | |
199 single sexp in C mode. | |
200 | |
201 Some languages have obscure forms of expression syntax that nobody | |
202 has bothered to make Emacs understand properly. | |
203 | |
204 @node List Commands | |
205 @section List And Sexp Commands | |
206 | |
207 @c doublewidecommands | |
208 @table @kbd | |
209 @item C-M-f | |
210 Move forward over a sexp (@code{forward-sexp}). | |
211 @item C-M-b | |
212 Move backward over a sexp (@code{backward-sexp}). | |
213 @item C-M-k | |
214 Kill sexp forward (@code{kill-sexp}). | |
215 @item C-M-@key{DEL} | |
216 Kill sexp backward (@code{backward-kill-sexp}). | |
217 @item C-M-u | |
218 Move up and backward in list structure (@code{backward-up-list}). | |
219 @item C-M-d | |
220 Move down and forward in list structure (@code{down-list}). | |
221 @item C-M-n | |
222 Move forward over a list (@code{forward-list}). | |
223 @item C-M-p | |
224 Move backward over a list (@code{backward-list}). | |
225 @item C-M-t | |
226 Transpose expressions (@code{transpose-sexps}). | |
227 @item C-M-@@ | |
228 Put mark after following expression (@code{mark-sexp}). | |
229 @end table | |
230 | |
231 @kindex C-M-f | |
232 @kindex C-M-b | |
233 @findex forward-sexp | |
234 @findex backward-sexp | |
235 To move forward over a sexp, use @kbd{C-M-f} (@code{forward-sexp}). If | |
236 the first significant character after point is an opening delimiter | |
237 (@samp{(} in Lisp; @samp{(}, @samp{[} or @samp{@{} in C), @kbd{C-M-f} | |
238 moves past the matching closing delimiter. If the character begins a | |
239 symbol, string, or number, @kbd{C-M-f} moves over that. | |
240 | |
241 The command @kbd{C-M-b} (@code{backward-sexp}) moves backward over a | |
242 sexp. The detailed rules are like those above for @kbd{C-M-f}, but with | |
243 directions reversed. If there are any prefix characters (single-quote, | |
244 backquote and comma, in Lisp) preceding the sexp, @kbd{C-M-b} moves back | |
245 over them as well. The sexp commands move across comments as if they | |
246 were whitespace in most modes. | |
247 | |
248 @kbd{C-M-f} or @kbd{C-M-b} with an argument repeats that operation the | |
249 specified number of times; with a negative argument, it moves in the | |
250 opposite direction. | |
251 | |
252 @kindex C-M-k | |
253 @findex kill-sexp | |
254 @kindex C-M-DEL | |
255 @findex backward-kill-sexp | |
256 Killing a whole sexp can be done with @kbd{C-M-k} (@code{kill-sexp}) | |
257 or @kbd{C-M-@key{DEL}} (@code{backward-kill-sexp}). @kbd{C-M-k} kills | |
258 the characters that @kbd{C-M-f} would move over, and @kbd{C-M-@key{DEL}} | |
259 kills the characters that @kbd{C-M-b} would move over. | |
260 | |
261 @kindex C-M-n | |
262 @kindex C-M-p | |
263 @findex forward-list | |
264 @findex backward-list | |
265 The @dfn{list commands} move over lists, as the sexp commands do, but skip | |
266 blithely over any number of other kinds of sexps (symbols, strings, etc.). | |
267 They are @kbd{C-M-n} (@code{forward-list}) and @kbd{C-M-p} | |
268 (@code{backward-list}). The main reason they are useful is that they | |
269 usually ignore comments (since the comments usually do not contain any | |
270 lists).@refill | |
271 | |
272 @kindex C-M-u | |
273 @kindex C-M-d | |
274 @findex backward-up-list | |
275 @findex down-list | |
276 @kbd{C-M-n} and @kbd{C-M-p} stay at the same level in parentheses, when | |
277 that's possible. To move @emph{up} one (or @var{n}) levels, use @kbd{C-M-u} | |
278 (@code{backward-up-list}). | |
279 @kbd{C-M-u} moves backward up past one unmatched opening delimiter. A | |
280 positive argument serves as a repeat count; a negative argument reverses | |
281 direction of motion and also requests repetition, so it moves forward and | |
282 up one or more levels.@refill | |
283 | |
284 To move @emph{down} in list structure, use @kbd{C-M-d} | |
285 (@code{down-list}). In Lisp mode, where @samp{(} is the only opening | |
286 delimiter, this is nearly the same as searching for a @samp{(}. An | |
287 argument specifies the number of levels of parentheses to go down. | |
288 | |
289 @cindex transposition | |
290 @kindex C-M-t | |
291 @findex transpose-sexps | |
292 A somewhat random-sounding command which is nevertheless handy is | |
293 @kbd{C-M-t} (@code{transpose-sexps}), which drags the previous sexp | |
294 across the next one. An argument serves as a repeat count, and a | |
295 negative argument drags backwards (thus canceling out the effect of | |
296 @kbd{C-M-t} with a positive argument). An argument of zero, rather than | |
297 doing nothing, transposes the sexps ending after point and the mark. | |
298 | |
299 @kindex C-M-@@ | |
300 @findex mark-sexp | |
301 To set the region around the next sexp in the buffer, use @kbd{C-M-@@} | |
302 (@code{mark-sexp}), which sets mark at the same place that @kbd{C-M-f} | |
303 would move to. @kbd{C-M-@@} takes arguments like @kbd{C-M-f}. In | |
304 particular, a negative argument is useful for putting the mark at the | |
305 beginning of the previous sexp. | |
306 | |
307 The list and sexp commands' understanding of syntax is completely | |
308 controlled by the syntax table. Any character can, for example, be | |
309 declared to be an opening delimiter and act like an open parenthesis. | |
310 @xref{Syntax}. | |
311 | |
312 @node Defuns | |
313 @section Defuns | |
314 @cindex defuns | |
315 | |
316 In Emacs, a parenthetical grouping at the top level in the buffer is | |
317 called a @dfn{defun}. The name derives from the fact that most top-level | |
318 lists in a Lisp file are instances of the special form @code{defun}, but | |
319 any top-level parenthetical grouping counts as a defun in Emacs parlance | |
320 regardless of what its contents are, and regardless of the programming | |
321 language in use. For example, in C, the body of a function definition is a | |
322 defun. | |
323 | |
324 @c doublewidecommands | |
325 @table @kbd | |
326 @item C-M-a | |
327 Move to beginning of current or preceding defun | |
328 (@code{beginning-of-defun}). | |
329 @item C-M-e | |
330 Move to end of current or following defun (@code{end-of-defun}). | |
331 @item C-M-h | |
332 Put region around whole current or following defun (@code{mark-defun}). | |
333 @end table | |
334 | |
335 @kindex C-M-a | |
336 @kindex C-M-e | |
337 @kindex C-M-h | |
338 @findex beginning-of-defun | |
339 @findex end-of-defun | |
340 @findex mark-defun | |
341 The commands to move to the beginning and end of the current defun are | |
342 @kbd{C-M-a} (@code{beginning-of-defun}) and @kbd{C-M-e} (@code{end-of-defun}). | |
343 | |
344 @findex c-mark-function | |
345 If you wish to operate on the current defun, use @kbd{C-M-h} | |
346 (@code{mark-defun}) which puts point at the beginning and mark at the end | |
347 of the current or next defun. For example, this is the easiest way to get | |
348 ready to move the defun to a different place in the text. In C mode, | |
349 @kbd{C-M-h} runs the function @code{c-mark-function}, which is almost the | |
350 same as @code{mark-defun}; the difference is that it backs up over the | |
351 argument declarations, function name and returned data type so that the | |
352 entire C function is inside the region. @xref{Marking Objects}. | |
353 | |
27221
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
354 @cindex open-parenthesis in leftmost column |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
355 @cindex ( in leftmost column |
25829 | 356 Emacs assumes that any open-parenthesis found in the leftmost column |
357 is the start of a defun. Therefore, @strong{never put an | |
358 open-parenthesis at the left margin in a Lisp file unless it is the | |
359 start of a top-level list. Never put an open-brace or other opening | |
360 delimiter at the beginning of a line of C code unless it starts the body | |
361 of a function.} The most likely problem case is when you want an | |
362 opening delimiter at the start of a line inside a string. To avoid | |
363 trouble, put an escape character (@samp{\}, in C and Emacs Lisp, | |
364 @samp{/} in some other Lisp dialects) before the opening delimiter. It | |
365 will not affect the contents of the string. | |
366 | |
367 In the remotest past, the original Emacs found defuns by moving upward a | |
368 level of parentheses until there were no more levels to go up. This always | |
369 required scanning all the way back to the beginning of the buffer, even for | |
370 a small function. To speed up the operation, Emacs was changed to assume | |
371 that any @samp{(} (or other character assigned the syntactic class of | |
372 opening-delimiter) at the left margin is the start of a defun. This | |
373 heuristic is nearly always right and avoids the costly scan; however, | |
374 it mandates the convention described above. | |
375 | |
376 @node Program Indent | |
377 @section Indentation for Programs | |
378 @cindex indentation for programs | |
379 | |
380 The best way to keep a program properly indented is to use Emacs to | |
381 reindent it as you change it. Emacs has commands to indent properly | |
382 either a single line, a specified number of lines, or all of the lines | |
383 inside a single parenthetical grouping. | |
384 | |
385 @menu | |
386 * Basic Indent:: Indenting a single line. | |
387 * Multi-line Indent:: Commands to reindent many lines at once. | |
388 * Lisp Indent:: Specifying how each Lisp function should be indented. | |
389 * C Indent:: Extra features for indenting C and related modes. | |
390 * Custom C Indent:: Controlling indentation style for C and related modes. | |
391 @end menu | |
392 | |
393 Emacs also provides a Lisp pretty-printer in the library @code{pp}. | |
394 This program reformats a Lisp object with indentation chosen to look nice. | |
395 | |
396 @node Basic Indent | |
397 @subsection Basic Program Indentation Commands | |
398 | |
399 @c WideCommands | |
400 @table @kbd | |
401 @item @key{TAB} | |
402 Adjust indentation of current line. | |
403 @item C-j | |
404 Equivalent to @key{RET} followed by @key{TAB} (@code{newline-and-indent}). | |
405 @end table | |
406 | |
407 @kindex TAB @r{(programming modes)} | |
408 @findex c-indent-line | |
409 @findex lisp-indent-line | |
410 The basic indentation command is @key{TAB}, which gives the current line | |
411 the correct indentation as determined from the previous lines. The | |
412 function that @key{TAB} runs depends on the major mode; it is @code{lisp-indent-line} | |
413 in Lisp mode, @code{c-indent-line} in C mode, etc. These functions | |
414 understand different syntaxes for different languages, but they all do | |
415 about the same thing. @key{TAB} in any programming-language major mode | |
416 inserts or deletes whitespace at the beginning of the current line, | |
417 independent of where point is in the line. If point is inside the | |
418 whitespace at the beginning of the line, @key{TAB} leaves it at the end of | |
419 that whitespace; otherwise, @key{TAB} leaves point fixed with respect to | |
420 the characters around it. | |
421 | |
422 Use @kbd{C-q @key{TAB}} to insert a tab at point. | |
423 | |
424 @kindex C-j | |
425 @findex newline-and-indent | |
426 When entering lines of new code, use @kbd{C-j} (@code{newline-and-indent}), | |
427 which is equivalent to a @key{RET} followed by a @key{TAB}. @kbd{C-j} creates | |
428 a blank line and then gives it the appropriate indentation. | |
429 | |
430 @key{TAB} indents the second and following lines of the body of a | |
431 parenthetical grouping each under the preceding one; therefore, if you | |
432 alter one line's indentation to be nonstandard, the lines below will | |
433 tend to follow it. This behavior is convenient in cases where you have | |
434 overridden the standard result of @key{TAB} because you find it | |
435 unaesthetic for a particular line. | |
436 | |
437 Remember that an open-parenthesis, open-brace or other opening delimiter | |
438 at the left margin is assumed by Emacs (including the indentation routines) | |
439 to be the start of a function. Therefore, you must never have an opening | |
440 delimiter in column zero that is not the beginning of a function, not even | |
441 inside a string. This restriction is vital for making the indentation | |
442 commands fast; you must simply accept it. @xref{Defuns}, for more | |
443 information on this. | |
444 | |
445 @node Multi-line Indent | |
446 @subsection Indenting Several Lines | |
447 | |
448 When you wish to reindent several lines of code which have been altered | |
449 or moved to a different level in the list structure, you have several | |
450 commands available. | |
451 | |
452 @table @kbd | |
453 @item C-M-q | |
454 Reindent all the lines within one list (@code{indent-sexp}). | |
455 @item C-u @key{TAB} | |
456 Shift an entire list rigidly sideways so that its first line | |
457 is properly indented. | |
458 @item C-M-\ | |
459 Reindent all lines in the region (@code{indent-region}). | |
460 @end table | |
461 | |
462 @kindex C-M-q | |
463 @findex indent-sexp | |
464 You can reindent the contents of a single list by positioning point | |
465 before the beginning of it and typing @kbd{C-M-q} (@code{indent-sexp} in | |
466 Lisp mode, @code{c-indent-exp} in C mode; also bound to other suitable | |
467 commands in other modes). The indentation of the line the sexp starts on | |
468 is not changed; therefore, only the relative indentation within the list, | |
469 and not its position, is changed. To correct the position as well, type a | |
470 @key{TAB} before the @kbd{C-M-q}. | |
471 | |
472 @kindex C-u TAB | |
473 If the relative indentation within a list is correct but the | |
474 indentation of its first line is not, go to that line and type @kbd{C-u | |
475 @key{TAB}}. @key{TAB} with a numeric argument reindents the current | |
476 line as usual, then reindents by the same amount all the lines in the | |
477 grouping starting on the current line. In other words, it reindents the | |
478 whole grouping rigidly as a unit. It is clever, though, and does not | |
479 alter lines that start inside strings, or C preprocessor lines when in C | |
480 mode. | |
481 | |
482 Another way to specify the range to be reindented is with the region. | |
483 The command @kbd{C-M-\} (@code{indent-region}) applies @key{TAB} to | |
484 every line whose first character is between point and mark. | |
485 | |
486 @node Lisp Indent | |
487 @subsection Customizing Lisp Indentation | |
488 @cindex customizing Lisp indentation | |
489 | |
490 The indentation pattern for a Lisp expression can depend on the function | |
491 called by the expression. For each Lisp function, you can choose among | |
492 several predefined patterns of indentation, or define an arbitrary one with | |
493 a Lisp program. | |
494 | |
495 The standard pattern of indentation is as follows: the second line of the | |
496 expression is indented under the first argument, if that is on the same | |
497 line as the beginning of the expression; otherwise, the second line is | |
498 indented underneath the function name. Each following line is indented | |
499 under the previous line whose nesting depth is the same. | |
500 | |
501 @vindex lisp-indent-offset | |
502 If the variable @code{lisp-indent-offset} is non-@code{nil}, it overrides | |
503 the usual indentation pattern for the second line of an expression, so that | |
504 such lines are always indented @code{lisp-indent-offset} more columns than | |
505 the containing list. | |
506 | |
507 @vindex lisp-body-indent | |
508 The standard pattern is overridden for certain functions. Functions | |
509 whose names start with @code{def} always indent the second line by | |
510 @code{lisp-body-indent} extra columns beyond the open-parenthesis | |
511 starting the expression. | |
512 | |
513 The standard pattern can be overridden in various ways for individual | |
514 functions, according to the @code{lisp-indent-function} property of the | |
515 function name. There are four possibilities for this property: | |
516 | |
517 @table @asis | |
518 @item @code{nil} | |
519 This is the same as no property; the standard indentation pattern is used. | |
520 @item @code{defun} | |
521 The pattern used for function names that start with @code{def} is used for | |
522 this function also. | |
523 @item a number, @var{number} | |
524 The first @var{number} arguments of the function are | |
525 @dfn{distinguished} arguments; the rest are considered the @dfn{body} | |
526 of the expression. A line in the expression is indented according to | |
527 whether the first argument on it is distinguished or not. If the | |
528 argument is part of the body, the line is indented @code{lisp-body-indent} | |
529 more columns than the open-parenthesis starting the containing | |
530 expression. If the argument is distinguished and is either the first | |
531 or second argument, it is indented @emph{twice} that many extra columns. | |
532 If the argument is distinguished and not the first or second argument, | |
533 the standard pattern is followed for that line. | |
534 @item a symbol, @var{symbol} | |
535 @var{symbol} should be a function name; that function is called to | |
536 calculate the indentation of a line within this expression. The | |
537 function receives two arguments: | |
538 @table @asis | |
539 @item @var{state} | |
540 The value returned by @code{parse-partial-sexp} (a Lisp primitive for | |
541 indentation and nesting computation) when it parses up to the | |
542 beginning of this line. | |
543 @item @var{pos} | |
544 The position at which the line being indented begins. | |
545 @end table | |
546 @noindent | |
547 It should return either a number, which is the number of columns of | |
548 indentation for that line, or a list whose car is such a number. The | |
549 difference between returning a number and returning a list is that a | |
550 number says that all following lines at the same nesting level should | |
551 be indented just like this one; a list says that following lines might | |
552 call for different indentations. This makes a difference when the | |
553 indentation is being computed by @kbd{C-M-q}; if the value is a | |
554 number, @kbd{C-M-q} need not recalculate indentation for the following | |
555 lines until the end of the list. | |
556 @end table | |
557 | |
558 @node C Indent | |
559 @subsection Commands for C Indentation | |
560 | |
561 Here are the commands for indentation in C mode and related modes: | |
562 | |
563 @table @code | |
564 @item C-c C-q | |
565 @kindex C-c C-q @r{(C mode)} | |
566 @findex c-indent-defun | |
567 Reindent the current top-level function definition or aggregate type | |
568 declaration (@code{c-indent-defun}). | |
569 | |
570 @item C-M-q | |
571 @kindex C-M-q @r{(C mode)} | |
572 @findex c-indent-exp | |
573 Reindent each line in the balanced expression that follows point | |
574 (@code{c-indent-exp}). A prefix argument inhibits error checking and | |
575 warning messages about invalid syntax. | |
576 | |
577 @item @key{TAB} | |
578 @findex c-indent-command | |
579 Reindent the current line, and/or in some cases insert a tab character | |
580 (@code{c-indent-command}). | |
581 | |
582 If @code{c-tab-always-indent} is @code{t}, this command always reindents | |
583 the current line and does nothing else. This is the default. | |
584 | |
585 If that variable is @code{nil}, this command reindents the current line | |
586 only if point is at the left margin or in the line's indentation; | |
587 otherwise, it inserts a tab (or the equivalent number of spaces, | |
588 if @code{indent-tabs-mode} is @code{nil}). | |
589 | |
590 Any other value (not @code{nil} or @code{t}) means always reindent the | |
591 line, and also insert a tab if within a comment, a string, or a | |
592 preprocessor directive. | |
593 | |
594 @item C-u @key{TAB} | |
595 Reindent the current line according to its syntax; also rigidly reindent | |
596 any other lines of the expression that starts on the current line. | |
597 @xref{Multi-line Indent}. | |
598 @end table | |
599 | |
600 To reindent the whole current buffer, type @kbd{C-x h C-M-\}. This | |
601 first selects the whole buffer as the region, then reindents that | |
602 region. | |
603 | |
604 To reindent the current block, use @kbd{C-M-u C-M-q}. This moves | |
605 to the front of the block and then reindents it all. | |
606 | |
607 @node Custom C Indent | |
608 @subsection Customizing C Indentation | |
609 | |
610 C mode and related modes use a simple yet flexible mechanism for | |
611 customizing indentation. The mechanism works in two steps: first it | |
612 classifies the line syntactically according to its contents and context; | |
613 second, it associates each kind of syntactic construct with an | |
614 indentation offset which you can customize. | |
615 | |
616 @menu | |
617 * Syntactic Analysis:: | |
618 * Indentation Calculation:: | |
619 * Changing Indent Style:: | |
620 * Syntactic Symbols:: | |
621 * Variables for C Indent:: | |
622 * C Indent Styles:: | |
623 @end menu | |
624 | |
625 @node Syntactic Analysis | |
626 @subsubsection Step 1---Syntactic Analysis | |
627 @cindex syntactic analysis | |
628 | |
629 In the first step, the C indentation mechanism looks at the line | |
630 before the one you are currently indenting and determines the syntactic | |
631 components of the construct on that line. It builds a list of these | |
632 syntactic components, each of which contains a @dfn{syntactic symbol} | |
633 and sometimes also a buffer position. Some syntactic symbols describe | |
634 grammatical elements, for example @code{statement} and | |
635 @code{substatement}; others describe locations amidst grammatical | |
636 elements, for example @code{class-open} and @code{knr-argdecl}. | |
637 | |
638 Conceptually, a line of C code is always indented relative to the | |
639 indentation of some line higher up in the buffer. This is represented | |
640 by the buffer positions in the syntactic component list. | |
641 | |
642 Here is an example. Suppose we have the following code in a C++ mode | |
643 buffer (the line numbers don't actually appear in the buffer): | |
644 | |
645 @example | |
646 1: void swap (int& a, int& b) | |
647 2: @{ | |
648 3: int tmp = a; | |
649 4: a = b; | |
650 5: b = tmp; | |
651 6: @} | |
652 @end example | |
653 | |
654 If you type @kbd{C-c C-s} (which runs the command | |
655 @code{c-show-syntactic-information}) on line 4, it shows the result of | |
656 the indentation mechanism for that line: | |
657 | |
658 @example | |
659 ((statement . 32)) | |
660 @end example | |
661 | |
662 This indicates that the line is a statement and it is indented | |
663 relative to buffer position 32, which happens to be the @samp{i} in | |
664 @code{int} on line 3. If you move the cursor to line 3 and type | |
665 @kbd{C-c C-s}, it displays this: | |
666 | |
667 @example | |
668 ((defun-block-intro . 28)) | |
669 @end example | |
670 | |
671 This indicates that the @code{int} line is the first statement in a | |
672 block, and is indented relative to buffer position 28, which is the | |
673 brace just after the function header. | |
674 | |
675 @noindent | |
676 Here is another example: | |
677 | |
678 @example | |
679 1: int add (int val, int incr, int doit) | |
680 2: @{ | |
681 3: if (doit) | |
682 4: @{ | |
683 5: return (val + incr); | |
684 6: @} | |
685 7: return (val); | |
686 8: @} | |
687 @end example | |
688 | |
689 @noindent | |
690 Typing @kbd{C-c C-s} on line 4 displays this: | |
691 | |
692 @example | |
693 ((substatement-open . 43)) | |
694 @end example | |
695 | |
696 This says that the brace @emph{opens} a substatement block. By the | |
697 way, a @dfn{substatement} indicates the line after an @code{if}, | |
698 @code{else}, @code{while}, @code{do}, @code{switch}, @code{for}, | |
699 @code{try}, @code{catch}, @code{finally}, or @code{synchronized} | |
700 statement. | |
701 | |
702 @cindex syntactic component | |
703 @cindex syntactic symbol | |
704 @vindex c-syntactic-context | |
705 Within the C indentation commands, after a line has been analyzed | |
706 syntactically for indentation, the variable @code{c-syntactic-context} | |
707 contains a list that describes the results. Each element in this list | |
708 is a @dfn{syntactic component}: a cons cell containing a syntactic | |
709 symbol and (optionally) its corresponding buffer position. There may be | |
710 several elements in a component list; typically only one element has a | |
711 buffer position. | |
712 | |
713 @node Indentation Calculation | |
714 @subsubsection Step 2---Indentation Calculation | |
715 @cindex Indentation Calculation | |
716 | |
717 The C indentation mechanism calculates the indentation for the current | |
718 line using the list of syntactic components, @code{c-syntactic-context}, | |
719 derived from syntactic analysis. Each component is a cons cell that | |
720 contains a syntactic symbol and may also contain a buffer position. | |
721 | |
722 Each component contributes to the final total indentation of the line | |
723 in two ways. First, the syntactic symbol identifies an element of | |
724 @code{c-offsets-alist}, which is an association list mapping syntactic | |
725 symbols into indentation offsets. Each syntactic symbol's offset adds | |
726 to the total indentation. Second, if the component includes a buffer | |
727 position, the column number of that position adds to the indentation. | |
728 All these offsets and column numbers, added together, give the total | |
729 indentation. | |
730 | |
731 The following examples demonstrate the workings of the C indentation | |
732 mechanism: | |
733 | |
734 @example | |
735 1: void swap (int& a, int& b) | |
736 2: @{ | |
737 3: int tmp = a; | |
738 4: a = b; | |
739 5: b = tmp; | |
740 6: @} | |
741 @end example | |
742 | |
743 Suppose that point is on line 3 and you type @key{TAB} to reindent the | |
744 line. As explained above (@pxref{Syntactic Analysis}), the syntactic | |
745 component list for that line is: | |
746 | |
747 @example | |
748 ((defun-block-intro . 28)) | |
749 @end example | |
750 | |
751 In this case, the indentation calculation first looks up | |
752 @code{defun-block-intro} in the @code{c-offsets-alist} alist. Suppose | |
753 that it finds the integer 2; it adds this to the running total | |
754 (initialized to zero), yielding a updated total indentation of 2 spaces. | |
755 | |
756 The next step is to find the column number of buffer position 28. | |
757 Since the brace at buffer position 28 is in column zero, this adds 0 to | |
758 the running total. Since this line has only one syntactic component, | |
759 the total indentation for the line is 2 spaces. | |
760 | |
761 @example | |
762 1: int add (int val, int incr, int doit) | |
763 2: @{ | |
764 3: if (doit) | |
765 4: @{ | |
766 5: return(val + incr); | |
767 6: @} | |
768 7: return(val); | |
769 8: @} | |
770 @end example | |
771 | |
772 If you type @key{TAB} on line 4, the same process is performed, but | |
773 with different data. The syntactic component list for this line is: | |
774 | |
775 @example | |
776 ((substatement-open . 43)) | |
777 @end example | |
778 | |
779 Here, the indentation calculation's first job is to look up the | |
780 symbol @code{substatement-open} in @code{c-offsets-alist}. Let's assume | |
781 that the offset for this symbol is 2. At this point the running total | |
782 is 2 (0 + 2 = 2). Then it adds the column number of buffer position 43, | |
783 which is the @samp{i} in @code{if} on line 3. This character is in | |
784 column 2 on that line. Adding this yields a total indentation of 4 | |
785 spaces. | |
786 | |
787 @vindex c-strict-syntax-p | |
788 If a syntactic symbol in the analysis of a line does not appear in | |
789 @code{c-offsets-alist}, it is ignored; if in addition the variable | |
790 @code{c-strict-syntax-p} is non-@code{nil}, it is an error. | |
791 | |
792 @node Changing Indent Style | |
793 @subsubsection Changing Indentation Style | |
794 | |
795 There are two ways to customize the indentation style for the C-like | |
796 modes. First, you can select one of several predefined styles, each of | |
797 which specifies offsets for all the syntactic symbols. For more | |
798 flexibility, you can customize the handling of individual syntactic | |
799 symbols. @xref{Syntactic Symbols}, for a list of all defined syntactic | |
800 symbols. | |
801 | |
802 @table @kbd | |
803 @item M-x c-set-style @key{RET} @var{style} @key{RET} | |
804 Select predefined indentation style @var{style}. Type @kbd{?} when | |
805 entering @var{style} to see a list of supported styles; to find out what | |
806 a style looks like, select it and reindent some C code. | |
807 | |
808 @item C-c C-o @var{symbol} @key{RET} @var{offset} @key{RET} | |
809 Set the indentation offset for syntactic symbol @var{symbol} | |
810 (@code{c-set-offset}). The second argument @var{offset} specifies the | |
811 new indentation offset. | |
812 @end table | |
813 | |
814 The @code{c-offsets-alist} variable controls the amount of | |
815 indentation to give to each syntactic symbol. Its value is an | |
816 association list, and each element of the list has the form | |
817 @code{(@var{syntactic-symbol} . @var{offset})}. By changing the offsets | |
818 for various syntactic symbols, you can customize indentation in fine | |
819 detail. To change this alist, use @code{c-set-offset} (see below). | |
820 | |
821 Each offset value in @code{c-offsets-alist} can be an integer, a | |
822 function or variable name, a list, or one of the following symbols: @code{+}, | |
823 @code{-}, @code{++}, @code{--}, @code{*}, or @code{/}, indicating positive or negative | |
824 multiples of the variable @code{c-basic-offset}. Thus, if you want to | |
825 change the levels of indentation to be 3 spaces instead of 2 spaces, set | |
826 @code{c-basic-offset} to 3. | |
827 | |
828 Using a function as the offset value provides the ultimate flexibility | |
829 in customizing indentation. The function is called with a single | |
830 argument containing the @code{cons} of the syntactic symbol and | |
831 the buffer position, if any. The function should return an integer | |
832 offset. | |
26264 | 833 |
25829 | 834 If the offset value is a list, its elements are processed according |
835 to the rules above until a non-@code{nil} value is found. That value is | |
836 then added to the total indentation in the normal manner. The primary | |
837 use for this is to combine the results of several functions. | |
838 | |
839 @kindex C-c C-o @r{(C mode)} | |
840 @findex c-set-offset | |
841 The command @kbd{C-c C-o} (@code{c-set-offset}) is the easiest way to | |
842 set offsets, both interactively or in your @file{~/.emacs} file. First | |
843 specify the syntactic symbol, then the offset you want. @xref{Syntactic | |
844 Symbols}, for a list of valid syntactic symbols and their meanings. | |
845 | |
846 @node Syntactic Symbols | |
847 @subsubsection Syntactic Symbols | |
848 | |
849 Here is a table of valid syntactic symbols for indentation in C and | |
850 related modes, with their syntactic meanings. Normally, most of these | |
851 symbols are assigned offsets in @code{c-offsets-alist}. | |
852 | |
853 @table @code | |
854 @item string | |
855 Inside a multi-line string. | |
856 | |
857 @item c | |
858 Inside a multi-line C style block comment. | |
859 | |
860 @item defun-open | |
861 On a brace that opens a function definition. | |
862 | |
863 @item defun-close | |
864 On a brace that closes a function definition. | |
865 | |
866 @item defun-block-intro | |
867 In the first line in a top-level defun. | |
868 | |
869 @item class-open | |
870 On a brace that opens a class definition. | |
871 | |
872 @item class-close | |
873 On a brace that closes a class definition. | |
874 | |
875 @item inline-open | |
876 On a brace that opens an in-class inline method. | |
877 | |
878 @item inline-close | |
879 On a brace that closes an in-class inline method. | |
880 | |
881 @item extern-lang-open | |
882 On a brace that opens an external language block. | |
883 | |
884 @item extern-lang-close | |
885 On a brace that closes an external language block. | |
886 | |
887 @item func-decl-cont | |
888 The region between a function definition's argument list and the defun | |
889 opening brace (excluding K&R function definitions). In C, you cannot | |
890 put anything but whitespace and comments between them; in C++ and Java, | |
891 @code{throws} declarations and other things can appear in this context. | |
892 | |
893 @item knr-argdecl-intro | |
894 On the first line of a K&R C argument declaration. | |
895 | |
896 @item knr-argdecl | |
897 In one of the subsequent lines in a K&R C argument declaration. | |
898 | |
899 @item topmost-intro | |
900 On the first line in a topmost construct definition. | |
901 | |
902 @item topmost-intro-cont | |
903 On the topmost definition continuation lines. | |
904 | |
905 @item member-init-intro | |
906 On the first line in a member initialization list. | |
907 | |
908 @item member-init-cont | |
909 On one of the subsequent member initialization list lines. | |
910 | |
911 @item inher-intro | |
912 On the first line of a multiple inheritance list. | |
913 | |
914 @item inher-cont | |
915 On one of the subsequent multiple inheritance lines. | |
916 | |
917 @item block-open | |
918 On a statement block open brace. | |
919 | |
920 @item block-close | |
921 On a statement block close brace. | |
922 | |
923 @item brace-list-open | |
924 On the opening brace of an @code{enum} or @code{static} array list. | |
925 | |
926 @item brace-list-close | |
927 On the closing brace of an @code{enum} or @code{static} array list. | |
928 | |
929 @item brace-list-intro | |
930 On the first line in an @code{enum} or @code{static} array list. | |
931 | |
932 @item brace-list-entry | |
933 On one of the subsequent lines in an @code{enum} or @code{static} array | |
934 list. | |
935 | |
936 @item brace-entry-open | |
937 On one of the subsequent lines in an @code{enum} or @code{static} array | |
938 list, when the line begins with an open brace. | |
939 | |
940 @item statement | |
941 On an ordinary statement. | |
942 | |
943 @item statement-cont | |
944 On a continuation line of a statement. | |
945 | |
946 @item statement-block-intro | |
947 On the first line in a new statement block. | |
948 | |
949 @item statement-case-intro | |
950 On the first line in a @code{case} ``block.'' | |
951 | |
952 @item statement-case-open | |
953 On the first line in a @code{case} block starting with brace. | |
954 | |
955 @item inexpr-statement | |
956 On a statement block inside an expression. This is used for a GNU | |
957 extension to the C language, and for Pike special functions that take a | |
958 statement block as an argument. | |
959 | |
960 @item inexpr-class | |
961 On a class definition inside an expression. This is used for anonymous | |
962 classes and anonymous array initializers in Java. | |
963 | |
964 @item substatement | |
965 On the first line after an @code{if}, @code{while}, @code{for}, | |
966 @code{do}, or @code{else}. | |
967 | |
968 @item substatement-open | |
969 On the brace that opens a substatement block. | |
970 | |
971 @item case-label | |
972 On a @code{case} or @code{default} label. | |
973 | |
974 @item access-label | |
975 On a C++ @code{private}, @code{protected}, or @code{public} access label. | |
976 | |
977 @item label | |
978 On any ordinary label. | |
979 | |
980 @item do-while-closure | |
981 On the @code{while} that ends a @code{do}-@code{while} construct. | |
982 | |
983 @item else-clause | |
984 On the @code{else} of an @code{if}-@code{else} construct. | |
985 | |
986 @item catch-clause | |
987 On the @code{catch} and @code{finally} lines in | |
988 @code{try}@dots{}@code{catch} constructs in C++ and Java. | |
989 | |
990 @item comment-intro | |
991 On a line containing only a comment introduction. | |
992 | |
993 @item arglist-intro | |
994 On the first line in an argument list. | |
995 | |
996 @item arglist-cont | |
997 On one of the subsequent argument list lines when no arguments follow on | |
998 the same line as the arglist opening parenthesis. | |
999 | |
1000 @item arglist-cont-nonempty | |
1001 On one of the subsequent argument list lines when at least one argument | |
1002 follows on the same line as the arglist opening parenthesis. | |
1003 | |
1004 @item arglist-close | |
1005 On the closing parenthesis of an argument list. | |
1006 | |
1007 @item stream-op | |
1008 On one of the lines continuing a stream operator construct. | |
1009 | |
1010 @item inclass | |
1011 On a construct that is nested inside a class definition. The | |
1012 indentation is relative to the open brace of the class definition. | |
1013 | |
1014 @item inextern-lang | |
1015 On a construct that is nested inside an external language block. | |
1016 | |
1017 @item inexpr-statement | |
1018 On the first line of statement block inside an expression. This is used | |
1019 for the GCC extension to C that uses the syntax @code{(@{ @dots{} @})}. | |
1020 It is also used for the special functions that takes a statement block | |
1021 as an argument in Pike. | |
1022 | |
1023 @item inexpr-class | |
1024 On the first line of a class definition inside an expression. This is | |
1025 used for anonymous classes and anonymous array initializers in Java. | |
1026 | |
1027 @item cpp-macro | |
1028 On the start of a cpp macro. | |
1029 | |
1030 @item friend | |
1031 On a C++ @code{friend} declaration. | |
1032 | |
1033 @item objc-method-intro | |
1034 On the first line of an Objective-C method definition. | |
1035 | |
1036 @item objc-method-args-cont | |
1037 On one of the lines continuing an Objective-C method definition. | |
1038 | |
1039 @item objc-method-call-cont | |
1040 On one of the lines continuing an Objective-C method call. | |
1041 | |
1042 @item inlambda | |
1043 Like @code{inclass}, but used inside lambda (i.e. anonymous) functions. Only | |
1044 used in Pike. | |
1045 | |
1046 @item lambda-intro-cont | |
1047 On a line continuing the header of a lambda function, between the | |
1048 @code{lambda} keyword and the function body. Only used in Pike. | |
1049 @end table | |
1050 | |
1051 @node Variables for C Indent | |
1052 @subsubsection Variables for C Indentation | |
1053 | |
1054 This section describes additional variables which control the | |
1055 indentation behavior of C mode and related mode. | |
1056 | |
1057 @table @code | |
1058 @item c-offsets-alist | |
1059 @vindex c-offsets-alist | |
1060 Association list of syntactic symbols and their indentation offsets. | |
1061 You should not set this directly, only with @code{c-set-offset}. | |
1062 @xref{Changing Indent Style}, for details. | |
1063 | |
1064 @item c-style-alist | |
1065 @vindex c-style-alist | |
1066 Variable for defining indentation styles; see below. | |
1067 | |
1068 @item c-basic-offset | |
1069 @vindex c-basic-offset | |
1070 Amount of basic offset used by @code{+} and @code{-} symbols in | |
26264 | 1071 @code{c-offsets-alist}.@refill |
25829 | 1072 |
1073 @item c-special-indent-hook | |
1074 @vindex c-special-indent-hook | |
1075 Hook for user-defined special indentation adjustments. This hook is | |
1076 called after a line is indented by C mode and related modes. | |
1077 @end table | |
1078 | |
1079 The variable @code{c-style-alist} specifies the predefined indentation | |
1080 styles. Each element has form @code{(@var{name} | |
1081 @var{variable-setting}@dots{})}, where @var{name} is the name of the | |
1082 style. Each @var{variable-setting} has the form @code{(@var{variable} | |
1083 . @var{value})}; @var{variable} is one of the customization variables | |
1084 used by C mode, and @var{value} is the value for that variable when | |
1085 using the selected style. | |
1086 | |
1087 When @var{variable} is @code{c-offsets-alist}, that is a special case: | |
1088 @var{value} is appended to the front of the value of @code{c-offsets-alist} | |
1089 instead of replacing that value outright. Therefore, it is not necessary | |
1090 for @var{value} to specify each and every syntactic symbol---only those | |
1091 for which the style differs from the default. | |
1092 | |
1093 The indentation of lines containing only comments is also affected by | |
1094 the variable @code{c-comment-only-line-offset} (@pxref{Comments in C}). | |
1095 | |
1096 @node C Indent Styles | |
1097 @subsubsection C Indentation Styles | |
1098 @cindex c indentation styles | |
1099 | |
1100 A @dfn{C style} is a collection of indentation style customizations. | |
1101 Emacs comes with several predefined indentation styles for C and related | |
1102 modes, including @code{gnu}, @code{k&r}, @code{bsd}, @code{stroustrup}, | |
1103 @code{linux}, @code{python}, @code{java}, @code{whitesmith}, | |
28627
1f6ba3e73fe9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28391
diff
changeset
|
1104 @code{ellemtel}, @code{cc-mode}, and @code{user}. |
25829 | 1105 |
1106 @findex c-set-style | |
1107 @vindex c-default-style | |
1108 To choose the style you want, use the command @kbd{M-x c-set-style}. | |
1109 Specify a style name as an argument (case is not significant in C style | |
1110 names). The chosen style only affects newly visited buffers, not those | |
1111 you are already editing. You can also set the variable | |
1112 @code{c-default-style} to specify the style for various major modes. | |
1113 Its value should be an alist, in which each element specifies one major | |
1114 mode and which indentation style to use for it. For example, | |
1115 | |
1116 @example | |
1117 (setq c-default-style | |
1118 '((java-mode . "java") (other . "gnu"))) | |
1119 @end example | |
1120 | |
1121 @noindent | |
1122 specifies an explicit choice for Java mode, and the default @samp{gnu} | |
1123 style for the other C-like modes. | |
1124 | |
28627
1f6ba3e73fe9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28391
diff
changeset
|
1125 The style @code{gnu} defines the formatting recommend by the GNU |
1f6ba3e73fe9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28391
diff
changeset
|
1126 Project; it is the default, so as to encourage the indentation we |
1f6ba3e73fe9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28391
diff
changeset
|
1127 recommend. The style @code{user} is the same as @code{gnu} but |
1f6ba3e73fe9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28391
diff
changeset
|
1128 incorporates any changes made in variables such as @code{c-basic-offset} |
1f6ba3e73fe9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28391
diff
changeset
|
1129 and @code{c-offsets-alist} by your @file{~/.emacs} file. To make them |
1f6ba3e73fe9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28391
diff
changeset
|
1130 take effect, you should select the style @code{user} with |
1f6ba3e73fe9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28391
diff
changeset
|
1131 @code{c-set-style} or @code{c-default-style}. |
1f6ba3e73fe9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28391
diff
changeset
|
1132 |
25829 | 1133 @findex c-add-style |
1134 To define a new C indentation style, call the function | |
1135 @code{c-add-style}: | |
1136 | |
1137 @example | |
1138 (c-add-style @var{name} @var{values} @var{use-now}) | |
1139 @end example | |
1140 | |
1141 @noindent | |
1142 Here @var{name} is the name of the new style (a string), and | |
1143 @var{values} is an alist whose elements have the form | |
1144 @code{(@var{variable} . @var{value})}. The variables you specify should | |
1145 be among those documented in @ref{Variables for C Indent}. | |
1146 | |
28627
1f6ba3e73fe9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28391
diff
changeset
|
1147 If @var{use-now} is non-@code{nil}, @code{c-add-style} selects the new |
1f6ba3e73fe9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28391
diff
changeset
|
1148 style after defining it. |
25829 | 1149 |
1150 @node Matching | |
1151 @section Automatic Display Of Matching Parentheses | |
1152 @cindex matching parentheses | |
1153 @cindex parentheses, displaying matches | |
1154 | |
1155 The Emacs parenthesis-matching feature is designed to show | |
1156 automatically how parentheses match in the text. Whenever you type a | |
1157 self-inserting character that is a closing delimiter, the cursor moves | |
1158 momentarily to the location of the matching opening delimiter, provided | |
1159 that is on the screen. If it is not on the screen, some text near it is | |
1160 displayed in the echo area. Either way, you can tell what grouping is | |
1161 being closed off. | |
1162 | |
1163 In Lisp, automatic matching applies only to parentheses. In C, it | |
1164 applies to braces and brackets too. Emacs knows which characters to regard | |
1165 as matching delimiters based on the syntax table, which is set by the major | |
1166 mode. @xref{Syntax}. | |
1167 | |
1168 If the opening delimiter and closing delimiter are mismatched---such as | |
1169 in @samp{[x)}---a warning message is displayed in the echo area. The | |
1170 correct matches are specified in the syntax table. | |
1171 | |
1172 @vindex blink-matching-paren | |
1173 @vindex blink-matching-paren-distance | |
1174 @vindex blink-matching-delay | |
1175 Three variables control parenthesis match display. | |
1176 @code{blink-matching-paren} turns the feature on or off; @code{nil} | |
1177 turns it off, but the default is @code{t} to turn match display on. | |
1178 @code{blink-matching-delay} says how many seconds to wait; the default | |
1179 is 1, but on some systems it is useful to specify a fraction of a | |
1180 second. @code{blink-matching-paren-distance} specifies how many | |
1181 characters back to search to find the matching opening delimiter. If | |
1182 the match is not found in that far, scanning stops, and nothing is | |
1183 displayed. This is to prevent scanning for the matching delimiter from | |
1184 wasting lots of time when there is no match. The default is 12,000. | |
1185 | |
1186 @cindex Show Paren mode | |
1187 @findex show-paren-mode | |
1188 When using X Windows, you can request a more powerful alternative kind | |
1189 of automatic parenthesis matching by enabling Show Paren mode. This | |
1190 mode turns off the usual kind of matching parenthesis display and | |
1191 instead uses highlighting to show what matches. Whenever point is after | |
1192 a close parenthesis, the close parenthesis and its matching open | |
1193 parenthesis are both highlighted; otherwise, if point is before an open | |
1194 parenthesis, the matching close parenthesis is highlighted. (There is | |
1195 no need to highlight the open parenthesis after point because the cursor | |
1196 appears on top of that character.) Use the command @kbd{M-x | |
1197 show-paren-mode} to enable or disable this mode. | |
1198 | |
1199 @node Comments | |
1200 @section Manipulating Comments | |
1201 @cindex comments | |
1202 | |
1203 Because comments are such an important part of programming, Emacs | |
1204 provides special commands for editing and inserting comments. | |
1205 | |
1206 @menu | |
1207 * Comment Commands:: | |
1208 * Multi-Line Comments:: | |
1209 * Options for Comments:: | |
1210 @end menu | |
1211 | |
1212 @node Comment Commands | |
1213 @subsection Comment Commands | |
1214 | |
1215 @kindex M-; | |
1216 @cindex indentation for comments | |
1217 @findex indent-for-comment | |
1218 | |
1219 The comment commands insert, kill and align comments. | |
1220 | |
1221 @c WideCommands | |
1222 @table @kbd | |
1223 @item M-; | |
1224 Insert or align comment (@code{indent-for-comment}). | |
1225 @item C-x ; | |
1226 Set comment column (@code{set-comment-column}). | |
1227 @item C-u - C-x ; | |
1228 Kill comment on current line (@code{kill-comment}). | |
1229 @item C-M-j | |
1230 Like @key{RET} followed by inserting and aligning a comment | |
1231 (@code{indent-new-comment-line}). | |
1232 @item M-x comment-region | |
1233 Add or remove comment delimiters on all the lines in the region. | |
1234 @end table | |
1235 | |
1236 The command that creates a comment is @kbd{M-;} (@code{indent-for-comment}). | |
1237 If there is no comment already on the line, a new comment is created, | |
1238 aligned at a specific column called the @dfn{comment column}. The comment | |
1239 is created by inserting the string Emacs thinks comments should start with | |
1240 (the value of @code{comment-start}; see below). Point is left after that | |
1241 string. If the text of the line extends past the comment column, then the | |
1242 indentation is done to a suitable boundary (usually, at least one space is | |
1243 inserted). If the major mode has specified a string to terminate comments, | |
1244 that is inserted after point, to keep the syntax valid. | |
1245 | |
1246 @kbd{M-;} can also be used to align an existing comment. If a line | |
1247 already contains the string that starts comments, then @kbd{M-;} just moves | |
1248 point after it and reindents it to the conventional place. Exception: | |
1249 comments starting in column 0 are not moved. | |
1250 | |
1251 Some major modes have special rules for indenting certain kinds of | |
1252 comments in certain contexts. For example, in Lisp code, comments which | |
1253 start with two semicolons are indented as if they were lines of code, | |
1254 instead of at the comment column. Comments which start with three | |
1255 semicolons are supposed to start at the left margin. Emacs understands | |
1256 these conventions by indenting a double-semicolon comment using @key{TAB}, | |
1257 and by not changing the indentation of a triple-semicolon comment at all. | |
1258 | |
1259 @example | |
1260 ;; This function is just an example | |
1261 ;;; Here either two or three semicolons are appropriate. | |
1262 (defun foo (x) | |
1263 ;;; And now, the first part of the function: | |
1264 ;; The following line adds one. | |
1265 (1+ x)) ; This line adds one. | |
1266 @end example | |
1267 | |
1268 In C code, a comment preceded on its line by nothing but whitespace | |
1269 is indented like a line of code. | |
1270 | |
1271 Even when an existing comment is properly aligned, @kbd{M-;} is still | |
1272 useful for moving directly to the start of the comment. | |
1273 | |
1274 @kindex C-u - C-x ; | |
1275 @findex kill-comment | |
1276 @kbd{C-u - C-x ;} (@code{kill-comment}) kills the comment on the current line, | |
1277 if there is one. The indentation before the start of the comment is killed | |
1278 as well. If there does not appear to be a comment in the line, nothing is | |
1279 done. To reinsert the comment on another line, move to the end of that | |
1280 line, do @kbd{C-y}, and then do @kbd{M-;} to realign it. Note that | |
1281 @kbd{C-u - C-x ;} is not a distinct key; it is @kbd{C-x ;} (@code{set-comment-column}) | |
1282 with a negative argument. That command is programmed so that when it | |
1283 receives a negative argument it calls @code{kill-comment}. However, | |
1284 @code{kill-comment} is a valid command which you could bind directly to a | |
1285 key if you wanted to. | |
1286 | |
1287 @node Multi-Line Comments | |
1288 @subsection Multiple Lines of Comments | |
1289 | |
1290 @kindex C-M-j | |
1291 @cindex blank lines in programs | |
1292 @findex indent-new-comment-line | |
1293 If you are typing a comment and wish to continue it on another line, | |
1294 you can use the command @kbd{C-M-j} (@code{indent-new-comment-line}). | |
1295 This terminates the comment you are typing, creates a new blank line | |
1296 afterward, and begins a new comment indented under the old one. When | |
1297 Auto Fill mode is on, going past the fill column while typing a comment | |
1298 causes the comment to be continued in just this fashion. If point is | |
1299 not at the end of the line when @kbd{C-M-j} is typed, the text on | |
1300 the rest of the line becomes part of the new comment line. | |
1301 | |
1302 @findex comment-region | |
1303 To turn existing lines into comment lines, use the @kbd{M-x | |
1304 comment-region} command. It adds comment delimiters to the lines that start | |
1305 in the region, thus commenting them out. With a negative argument, it | |
1306 does the opposite---it deletes comment delimiters from the lines in the | |
1307 region. | |
1308 | |
1309 With a positive argument, @code{comment-region} duplicates the last | |
1310 character of the comment start sequence it adds; the argument specifies | |
1311 how many copies of the character to insert. Thus, in Lisp mode, | |
1312 @kbd{C-u 2 M-x comment-region} adds @samp{;;} to each line. Duplicating | |
1313 the comment delimiter is a way of calling attention to the comment. It | |
1314 can also affect how the comment is indented. In Lisp, for proper | |
1315 indentation, you should use an argument of two, if between defuns, and | |
1316 three, if within a defun. | |
1317 | |
1318 @vindex comment-padding | |
1319 The variable @code{comment-padding} specifies how many spaces | |
1320 @code{comment-region} should insert on each line between the | |
1321 comment delimiter and the line's original text. The default is 1. | |
1322 | |
1323 @node Options for Comments | |
1324 @subsection Options Controlling Comments | |
1325 | |
1326 @vindex comment-column | |
1327 @kindex C-x ; | |
1328 @findex set-comment-column | |
1329 The comment column is stored in the variable @code{comment-column}. You | |
1330 can set it to a number explicitly. Alternatively, the command @kbd{C-x ;} | |
1331 (@code{set-comment-column}) sets the comment column to the column point is | |
1332 at. @kbd{C-u C-x ;} sets the comment column to match the last comment | |
1333 before point in the buffer, and then does a @kbd{M-;} to align the | |
1334 current line's comment under the previous one. Note that @kbd{C-u - C-x ;} | |
1335 runs the function @code{kill-comment} as described above. | |
1336 | |
1337 The variable @code{comment-column} is per-buffer: setting the variable | |
1338 in the normal fashion affects only the current buffer, but there is a | |
1339 default value which you can change with @code{setq-default}. | |
1340 @xref{Locals}. Many major modes initialize this variable for the | |
1341 current buffer. | |
1342 | |
1343 @vindex comment-start-skip | |
1344 The comment commands recognize comments based on the regular | |
1345 expression that is the value of the variable @code{comment-start-skip}. | |
1346 Make sure this regexp does not match the null string. It may match more | |
1347 than the comment starting delimiter in the strictest sense of the word; | |
1348 for example, in C mode the value of the variable is @code{@t{"/\\*+ | |
1349 *"}}, which matches extra stars and spaces after the @samp{/*} itself. | |
1350 (Note that @samp{\\} is needed in Lisp syntax to include a @samp{\} in | |
1351 the string, which is needed to deny the first star its special meaning | |
1352 in regexp syntax. @xref{Regexps}.) | |
1353 | |
1354 @vindex comment-start | |
1355 @vindex comment-end | |
1356 When a comment command makes a new comment, it inserts the value of | |
1357 @code{comment-start} to begin it. The value of @code{comment-end} is | |
1358 inserted after point, so that it will follow the text that you will insert | |
1359 into the comment. In C mode, @code{comment-start} has the value | |
1360 @w{@code{"/* "}} and @code{comment-end} has the value @w{@code{" */"}}. | |
1361 | |
1362 @vindex comment-multi-line | |
1363 The variable @code{comment-multi-line} controls how @kbd{C-M-j} | |
1364 (@code{indent-new-comment-line}) behaves when used inside a comment. If | |
1365 @code{comment-multi-line} is @code{nil}, as it normally is, then the | |
1366 comment on the starting line is terminated and a new comment is started | |
1367 on the new following line. If @code{comment-multi-line} is not | |
1368 @code{nil}, then the new following line is set up as part of the same | |
1369 comment that was found on the starting line. This is done by not | |
1370 inserting a terminator on the old line, and not inserting a starter on | |
1371 the new line. In languages where multi-line comments work, the choice | |
1372 of value for this variable is a matter of taste. | |
1373 | |
1374 @vindex comment-indent-function | |
1375 The variable @code{comment-indent-function} should contain a function | |
1376 that will be called to compute the indentation for a newly inserted | |
1377 comment or for aligning an existing comment. It is set differently by | |
1378 various major modes. The function is called with no arguments, but with | |
1379 point at the beginning of the comment, or at the end of a line if a new | |
1380 comment is to be inserted. It should return the column in which the | |
1381 comment ought to start. For example, in Lisp mode, the indent hook | |
1382 function bases its decision on how many semicolons begin an existing | |
1383 comment, and on the code in the preceding lines. | |
1384 | |
1385 @node Balanced Editing | |
1386 @section Editing Without Unbalanced Parentheses | |
1387 | |
1388 @table @kbd | |
1389 @item M-( | |
1390 Put parentheses around next sexp(s) (@code{insert-parentheses}). | |
1391 @item M-) | |
1392 Move past next close parenthesis and reindent | |
1393 (@code{move-past-close-and-reindent}). | |
1394 @end table | |
1395 | |
1396 @kindex M-( | |
1397 @kindex M-) | |
1398 @findex insert-parentheses | |
1399 @findex move-past-close-and-reindent | |
1400 The commands @kbd{M-(} (@code{insert-parentheses}) and @kbd{M-)} | |
1401 (@code{move-past-close-and-reindent}) are designed to facilitate a style | |
1402 of editing which keeps parentheses balanced at all times. @kbd{M-(} | |
1403 inserts a pair of parentheses, either together as in @samp{()}, or, if | |
1404 given an argument, around the next several sexps. It leaves point after | |
1405 the open parenthesis. The command @kbd{M-)} moves past the close | |
1406 parenthesis, deleting any indentation preceding it, and indenting with | |
1407 @kbd{C-j} after it. | |
1408 | |
1409 For example, instead of typing @kbd{( F O O )}, you can type @kbd{M-( | |
1410 F O O}, which has the same effect except for leaving the cursor before | |
1411 the close parenthesis. | |
1412 | |
1413 @vindex parens-require-spaces | |
1414 @kbd{M-(} may insert a space before the open parenthesis, depending on | |
1415 the syntax class of the preceding character. Set | |
1416 @code{parens-require-spaces} to @code{nil} value if you wish to inhibit | |
1417 this. | |
1418 | |
27221
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
1419 @findex check-parens |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
1420 You can use @kbd{M-x check-parens} to find any unbalanced parentheses in |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
1421 a buffer. |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
1422 |
25829 | 1423 @node Symbol Completion |
1424 @section Completion for Symbol Names | |
1425 @cindex completion (symbol names) | |
1426 | |
1427 Usually completion happens in the minibuffer. But one kind of completion | |
1428 is available in all buffers: completion for symbol names. | |
1429 | |
1430 @kindex M-TAB | |
1431 The character @kbd{M-@key{TAB}} runs a command to complete the partial | |
1432 symbol before point against the set of meaningful symbol names. Any | |
1433 additional characters determined by the partial name are inserted at | |
1434 point. | |
1435 | |
1436 If the partial name in the buffer has more than one possible completion | |
1437 and they have no additional characters in common, a list of all possible | |
1438 completions is displayed in another window. | |
1439 | |
1440 @cindex completion using tags | |
1441 @cindex tags completion | |
1442 @cindex Info index completion | |
1443 @findex complete-symbol | |
1444 In most programming language major modes, @kbd{M-@key{TAB}} runs the | |
1445 command @code{complete-symbol}, which provides two kinds of completion. | |
1446 Normally it does completion based on a tags table (@pxref{Tags}); with a | |
1447 numeric argument (regardless of the value), it does completion based on | |
1448 the names listed in the Info file indexes for your language. Thus, to | |
1449 complete the name of a symbol defined in your own program, use | |
1450 @kbd{M-@key{TAB}} with no argument; to complete the name of a standard | |
1451 library function, use @kbd{C-u M-@key{TAB}}. Of course, Info-based | |
1452 completion works only if there is an Info file for the standard library | |
1453 functions of your language, and only if it is installed at your site. | |
1454 | |
1455 @cindex Lisp symbol completion | |
1456 @cindex completion in Lisp | |
1457 @findex lisp-complete-symbol | |
1458 In Emacs-Lisp mode, the name space for completion normally consists of | |
1459 nontrivial symbols present in Emacs---those that have function | |
1460 definitions, values or properties. However, if there is an | |
1461 open-parenthesis immediately before the beginning of the partial symbol, | |
1462 only symbols with function definitions are considered as completions. | |
1463 The command which implements this is @code{lisp-complete-symbol}. | |
1464 | |
1465 In Text mode and related modes, @kbd{M-@key{TAB}} completes words | |
1466 based on the spell-checker's dictionary. @xref{Spelling}. | |
1467 | |
1468 @node Which Function | |
1469 @section Which Function Mode | |
1470 | |
1471 Which Function mode is a minor mode that displays the current function | |
1472 name in the mode line, as you move around in a buffer. | |
1473 | |
1474 @findex which-function-mode | |
1475 @vindex which-func-modes | |
1476 To enable (or disable) Which Function mode, use the command @kbd{M-x | |
1477 which-function-mode}. This command is global; it applies to all | |
1478 buffers, both existing ones and those yet to be created. However, this | |
1479 only affects certain major modes, those listed in the value of | |
1480 @code{which-func-modes}. (If the value is @code{t}, then Which Function | |
1481 mode applies to all major modes that know how to support it---which are | |
1482 the major modes that support Imenu.) | |
1483 | |
28329
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1484 @node Hideshow |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1485 @section Hideshow minor mode |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1486 |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1487 @findex hs-minor-mode |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1488 Hideshow minor mode provides selective display of blocks. Use @kbd{M-x |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1489 hs-minor-mode} to toggle the mode or add @code{hs-minor-mode} to the |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1490 hook for major modes with which you want to use it and which support it. |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1491 |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1492 Blocks are defined dependent on the mode. In C mode or C++ mode, they |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1493 are delimited by braces, while in Lisp-ish modes they are delimited by |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1494 parens. Multi-line comments can also be hidden. |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1495 |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1496 @findex hs-hide-all |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1497 @findex hs-hide-block |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1498 @findex hs-show-all |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1499 @findex hs-show-block |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1500 @findex hs-show-region |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1501 @findex hs-hide-level |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1502 @findex hs-minor-mode |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1503 @kindex C-c h |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1504 @kindex C-c s |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1505 @kindex C-c H |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1506 @kindex C-c S |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1507 @kindex C-c R |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1508 @kindex C-c L |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1509 @kindex S-mouse-2 |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1510 The mode provides the commands @kbd{C-c h} (@kbd{M-x hs-hide-all}), |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1511 @kbd{C-c s} (@kbd{M-x hs-hide-block}), @kbd{C-c H} (@kbd{M-x |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1512 hs-show-all}), @kbd{C-c S} (@kbd{M-x hs-show-block}), @kbd{C-c R} |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1513 (@kbd{M-x hs-show-region}) and @kbd{C-c L} (@kbd{M-x hs-hide-level}) |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1514 with obvious functions and @kbd{S-mouse-2} toggles hiding of a block |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1515 with the mouse. |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1516 |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1517 @vindex hs-hide-comments-when-hiding-all |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1518 @vindex hs-show-hidden-short-form |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1519 @vindex hs-isearch-open |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1520 @vindex hs-special-modes-alist |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1521 Hideshow is customized by the variables |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1522 @table @code |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1523 @item hs-hide-comments-when-hiding-all |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1524 Specifies whether @kbd{hs-hide-all} should hide comments too. |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1525 @item hs-show-hidden-short-form |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1526 Specifies whether or not the last line in a form is omitted (saving |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1527 screen space). |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1528 @item hs-isearch-open |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1529 Specifies what kind of hidden blocks to open in Isearch mode. |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1530 @item hs-special-modes-alist |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1531 Initializes Hideshow variables for different modes. |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1532 @end table |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1533 |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1534 @node Documentation, Change Log, Hideshow, Programs |
25829 | 1535 @section Documentation Commands |
1536 | |
1537 As you edit Lisp code to be run in Emacs, the commands @kbd{C-h f} | |
1538 (@code{describe-function}) and @kbd{C-h v} (@code{describe-variable}) can | |
1539 be used to print documentation of functions and variables that you want to | |
1540 call. These commands use the minibuffer to read the name of a function or | |
1541 variable to document, and display the documentation in a window. | |
1542 | |
1543 For extra convenience, these commands provide default arguments based on | |
1544 the code in the neighborhood of point. @kbd{C-h f} sets the default to the | |
1545 function called in the innermost list containing point. @kbd{C-h v} uses | |
1546 the symbol name around or adjacent to point as its default. | |
1547 | |
1548 @cindex Eldoc mode | |
1549 @findex eldoc-mode | |
1550 For Emacs Lisp code, you can also use Eldoc mode. This minor mode | |
1551 constantly displays in the echo area the argument list for the function | |
1552 being called at point. (In other words, it finds the function call that | |
1553 point is contained in, and displays the argument list of that function.) | |
1554 Eldoc mode applies in Emacs Lisp and Lisp Interaction modes only. Use | |
1555 the command @kbd{M-x eldoc-mode} to enable or disable this feature. | |
1556 | |
1557 @findex info-lookup-symbol | |
1558 @findex info-lookup-file | |
1559 @kindex C-h C-i | |
1560 For C, Lisp, and other languages, you can use @kbd{C-h C-i} | |
1561 (@code{info-lookup-symbol}) to view the Info documentation for a symbol. | |
1562 You specify the symbol with the minibuffer; by default, it uses the | |
1563 symbol that appears in the buffer at point. The major mode determines | |
1564 where to look for documentation for the symbol---which Info files and | |
1565 which indices. You can also use @kbd{M-x info-lookup-file} to look for | |
28329
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1566 documentation for a file name. Currently the modes supported by |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1567 Info-lookup are: Awk, Autoconf, Bison, C, Emacs Lisp, LaTeX, M4, |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1568 Makefile, Octave, Perl, Scheme and Texinfo. The relevant Info files |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1569 mostly must be obtained separately, typically from the appropriate GNU |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1570 package. |
25829 | 1571 |
1572 @findex manual-entry | |
28838
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1573 @cindex manual pages |
25829 | 1574 You can read the ``man page'' for an operating system command, library |
1575 function, or system call, with the @kbd{M-x manual-entry} command. It | |
1576 runs the @code{man} program to format the man page, and runs it | |
1577 asynchronously if your system permits, so that you can keep on editing | |
1578 while the page is being formatted. (MS-DOS and MS-Windows 3 do not | |
1579 permit asynchronous subprocesses, so on these systems you cannot edit | |
1580 while Emacs waits for @code{man} to exit.) The result goes in a buffer | |
1581 named @samp{*Man @var{topic}*}. These buffers use a special major mode, | |
1582 Man mode, that facilitates scrolling and examining other manual pages. | |
1583 For details, type @kbd{C-h m} while in a man page buffer. | |
1584 | |
1585 @vindex Man-fontify-manpage-flag | |
1586 For a long man page, setting the faces properly can take substantial | |
1587 time. By default, Emacs uses faces in man pages if Emacs can display | |
1588 different fonts or colors. You can turn off use of faces in man pages | |
1589 by setting the variable @code{Man-fontify-manpage-flag} to @code{nil}. | |
1590 | |
1591 @findex Man-fontify-manpage | |
1592 If you insert the text of a man page into an Emacs buffer in some | |
1593 other fashion, you can use the command @kbd{M-x Man-fontify-manpage} to | |
1594 perform the same conversions that @kbd{M-x manual-entry} does. | |
1595 | |
28838
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1596 @findex woman |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1597 @cindex manual pages, on MS-DOS/MS-Windows |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1598 An alternative way of reading manual pages is the @kbd{M-x woman} |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1599 command@footnote{The name of the command, @code{woman}, is an acronym |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1600 for ``w/o (without) man'', since it doesn't use the @code{man} |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1601 program.}. Unlike @kbd{M-x man}, it does not run any external programs |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1602 to format and display the man pages, instead it does that entirely in |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1603 Emacs Lisp. Thus, it is useful on systems such as MS-Windows, where the |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1604 @code{man} program and the programs it runs are not readily available. |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1605 When invoked, @kbd{M-x woman} prompts for a name of a manual page and |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1606 provides completion based on the list of manual pages that are installed |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1607 on your machine; the list of available manual pages is computed |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1608 automatically the first time you invoke @code{woman}. The word at point |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1609 in the current buffer is used to suggest the default name of the manual |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1610 page. |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1611 |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1612 With a numeric argument, @kbd{M-x woman} recomputes the list of the |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1613 manual pages used for completion. This is useful if you add or delete |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1614 manual pages. |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1615 |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1616 @vindex woman-manpath |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1617 By default, @kbd{M-x woman} looks up the manual pages in directories |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1618 listed by the @code{MANPATH} environment variable. (If @code{MANPATH} |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1619 is not set, @code{woman} uses a suitable default value, which can be |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1620 customized.) More precisely, @code{woman} looks for subdirectories that |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1621 match the shell wildcard @file{man*} in each one of these directories, |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1622 and tries to find the manual pages in those subdirectories. When first |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1623 invoked, @kbd{M-x woman} converts the value of @code{MANPATH} to a list |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1624 of directory names and stores that list in the @code{woman-manpath} |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1625 variable. By changing the value of this variable, you can customize the |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1626 list of directories where @code{woman} looks for manual pages. |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1627 |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1628 @vindex woman-path |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1629 In addition, you can augment the list of directories searched by |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1630 @code{woman} by setting the value of the @code{woman-path} variable. |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1631 This variable should hold a list of specific directories which |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1632 @code{woman} should search, in addition to those in |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1633 @code{woman-manpath}. Unlike @code{woman-manpath}, the directories in |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1634 @code{woman-path} are searched for the manual pages, not for @file{man*} |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1635 subdirectories. |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1636 |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1637 @findex woman-find-file |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1638 Occasionally, you might need to display manual pages that are not in |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1639 any of the directories listed by @code{woman-manpath} and |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1640 @code{woman-path}. The @kbd{M-x woman-find-file} command prompts for a |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1641 name of a manual page file, with completion, and then formats and |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1642 displays that file like @kbd{M-x woman} does. |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1643 |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1644 @vindex woman-dired-keys |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1645 First time you invoke @kbd{M-x woman}, it defines the Dired @kbd{W} |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1646 key to run the @code{woman-find-file} command on the current line's |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1647 file. You can disable this by setting the variable |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1648 @code{woman-dired-keys} to @code{nil}. @xref{Dired}. In addition, the |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1649 Tar-mode @kbd{w} key is bound to @code{woman-find-file} on the current |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1650 line's archive member. |
e3d33a77c205
(Documentation): Document woman.el features.
Eli Zaretskii <eliz@gnu.org>
parents:
28627
diff
changeset
|
1651 |
25829 | 1652 Eventually the GNU project hopes to replace most man pages with |
1653 better-organized manuals that you can browse with Info. @xref{Misc | |
1654 Help}. Since this process is only partially completed, it is still | |
1655 useful to read manual pages. | |
1656 | |
1657 @node Change Log | |
1658 @section Change Logs | |
1659 | |
1660 @cindex change log | |
1661 @kindex C-x 4 a | |
1662 @findex add-change-log-entry-other-window | |
1663 The Emacs command @kbd{C-x 4 a} adds a new entry to the change log | |
1664 file for the file you are editing | |
1665 (@code{add-change-log-entry-other-window}). | |
1666 | |
1667 A change log file contains a chronological record of when and why you | |
1668 have changed a program, consisting of a sequence of entries describing | |
1669 individual changes. Normally it is kept in a file called | |
1670 @file{ChangeLog} in the same directory as the file you are editing, or | |
1671 one of its parent directories. A single @file{ChangeLog} file can | |
1672 record changes for all the files in its directory and all its | |
1673 subdirectories. | |
1674 | |
1675 A change log entry starts with a header line that contains your name, | |
1676 your email address (taken from the variable @code{user-mail-address}), | |
1677 and the current date and time. Aside from these header lines, every | |
1678 line in the change log starts with a space or a tab. The bulk of the | |
1679 entry consists of @dfn{items}, each of which starts with a line starting | |
1680 with whitespace and a star. Here are two entries, both dated in May | |
1681 1993, each with two items: | |
1682 | |
1683 @iftex | |
1684 @medbreak | |
1685 @end iftex | |
1686 @smallexample | |
1687 1993-05-25 Richard Stallman <rms@@gnu.org> | |
1688 | |
1689 * man.el: Rename symbols `man-*' to `Man-*'. | |
1690 (manual-entry): Make prompt string clearer. | |
1691 | |
1692 * simple.el (blink-matching-paren-distance): | |
1693 Change default to 12,000. | |
1694 | |
1695 1993-05-24 Richard Stallman <rms@@gnu.org> | |
1696 | |
1697 * vc.el (minor-mode-map-alist): Don't use it if it's void. | |
1698 (vc-cancel-version): Doc fix. | |
1699 @end smallexample | |
1700 | |
1701 @noindent | |
1702 (Previous Emacs versions used a different format for the date.) | |
1703 | |
1704 One entry can describe several changes; each change should have its | |
1705 own item. Normally there should be a blank line between items. When | |
1706 items are related (parts of the same change, in different places), group | |
1707 them by leaving no blank line between them. The second entry above | |
1708 contains two items grouped in this way. | |
1709 | |
27221
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
1710 @vindex add-log-keep-changes-together |
25829 | 1711 @kbd{C-x 4 a} visits the change log file and creates a new entry |
1712 unless the most recent entry is for today's date and your name. It also | |
1713 creates a new item for the current file. For many languages, it can | |
1714 even guess the name of the function or other object that was changed. | |
27221
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
1715 When the option @code{add-log-keep-changes-together} is set, @kbd{C-x 4 |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
1716 a} adds to any existing entry for the file rather than starting a new |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
1717 entry. |
25829 | 1718 |
1719 @cindex Change Log mode | |
1720 @findex change-log-mode | |
1721 The change log file is visited in Change Log mode. In this major | |
1722 mode, each bunch of grouped items counts as one paragraph, and each | |
1723 entry is considered a page. This facilitates editing the entries. | |
1724 @kbd{C-j} and auto-fill indent each new line like the previous line; | |
1725 this is convenient for entering the contents of an entry. | |
1726 | |
27221
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
1727 @findex change-log-merge |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
1728 The command @kbd{M-x change-log-merge} can be used to merge other log |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
1729 files into a buffer in Change Log Mode, preserving the date ordering |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
1730 of entries with either the current or old-style date formats. |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
1731 |
25829 | 1732 Version control systems are another way to keep track of changes in your |
1733 program and keep a change log. @xref{Log Buffer}. | |
1734 | |
1735 @node Tags | |
1736 @section Tags Tables | |
1737 @cindex tags table | |
1738 | |
1739 A @dfn{tags table} is a description of how a multi-file program is | |
1740 broken up into files. It lists the names of the component files and the | |
1741 names and positions of the functions (or other named subunits) in each | |
1742 file. Grouping the related files makes it possible to search or replace | |
1743 through all the files with one command. Recording the function names | |
1744 and positions makes possible the @kbd{M-.} command which finds the | |
1745 definition of a function by looking up which of the files it is in. | |
1746 | |
1747 Tags tables are stored in files called @dfn{tags table files}. The | |
1748 conventional name for a tags table file is @file{TAGS}. | |
1749 | |
1750 Each entry in the tags table records the name of one tag, the name of the | |
1751 file that the tag is defined in (implicitly), and the position in that file | |
1752 of the tag's definition. | |
1753 | |
1754 Just what names from the described files are recorded in the tags table | |
1755 depends on the programming language of the described file. They | |
1756 normally include all functions and subroutines, and may also include | |
1757 global variables, data types, and anything else convenient. Each name | |
1758 recorded is called a @dfn{tag}. | |
1759 | |
1760 @menu | |
26264 | 1761 * Tag Syntax:: Tag syntax for various types of code and text files. |
25829 | 1762 * Create Tags Table:: Creating a tags table with @code{etags}. |
26289
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
1763 * Etags Regexps:: Create arbitrary tags using regular expressions. |
25829 | 1764 * Select Tags Table:: How to visit a tags table. |
26264 | 1765 * Find Tag:: Commands to find the definition of a specific tag. |
25829 | 1766 * Tags Search:: Using a tags table for searching and replacing. |
1767 * List Tags:: Listing and finding tags defined in a file. | |
1768 @end menu | |
1769 | |
1770 @node Tag Syntax | |
1771 @subsection Source File Tag Syntax | |
1772 | |
1773 Here is how tag syntax is defined for the most popular languages: | |
1774 | |
1775 @itemize @bullet | |
1776 @item | |
1777 In C code, any C function or typedef is a tag, and so are definitions of | |
26264 | 1778 @code{struct}, @code{union} and @code{enum}. You can tag function |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
1779 declarations and external variables in addition to function definitions |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
1780 by giving the @samp{--declarations} option to @code{etags}. |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
1781 @code{#define} macro definitions and @code{enum} constants are also |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
1782 tags, unless you specify @samp{--no-defines} when making the tags table. |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
1783 Similarly, global variables are tags, unless you specify |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
1784 @samp{--no-globals}. Use of @samp{--no-globals} and @samp{--no-defines} |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
1785 can make the tags table file much smaller. |
25829 | 1786 |
1787 @item | |
1788 In C++ code, in addition to all the tag constructs of C code, member | |
1789 functions are also recognized, and optionally member variables if you | |
1790 use the @samp{--members} option. Tags for variables and functions in | |
1791 classes are named @samp{@var{class}::@var{variable}} and | |
26264 | 1792 @samp{@var{class}::@var{function}}. @code{operator} functions tags are |
1793 named, for example @samp{operator+}. | |
25829 | 1794 |
1795 @item | |
1796 In Java code, tags include all the constructs recognized in C++, plus | |
26264 | 1797 the @code{interface}, @code{extends} and @code{implements} constructs. |
1798 Tags for variables and functions in classes are named | |
1799 @samp{@var{class}.@var{variable}} and @samp{@var{class}.@var{function}}. | |
25829 | 1800 |
1801 @item | |
1802 In La@TeX{} text, the argument of any of the commands @code{\chapter}, | |
1803 @code{\section}, @code{\subsection}, @code{\subsubsection}, | |
1804 @code{\eqno}, @code{\label}, @code{\ref}, @code{\cite}, @code{\bibitem}, | |
1805 @code{\part}, @code{\appendix}, @code{\entry}, or @code{\index}, is a | |
1806 tag.@refill | |
1807 | |
1808 Other commands can make tags as well, if you specify them in the | |
29107 | 1809 environment variable @env{TEXTAGS} before invoking @code{etags}. The |
25829 | 1810 value of this environment variable should be a colon-separated list of |
1811 command names. For example, | |
1812 | |
1813 @example | |
1814 TEXTAGS="def:newcommand:newenvironment" | |
1815 export TEXTAGS | |
1816 @end example | |
1817 | |
1818 @noindent | |
1819 specifies (using Bourne shell syntax) that the commands @samp{\def}, | |
1820 @samp{\newcommand} and @samp{\newenvironment} also define tags. | |
1821 | |
1822 @item | |
1823 In Lisp code, any function defined with @code{defun}, any variable | |
1824 defined with @code{defvar} or @code{defconst}, and in general the first | |
1825 argument of any expression that starts with @samp{(def} in column zero, is | |
1826 a tag. | |
1827 | |
1828 @item | |
1829 In Scheme code, tags include anything defined with @code{def} or with a | |
1830 construct whose name starts with @samp{def}. They also include variables | |
1831 set with @code{set!} at top level in the file. | |
1832 @end itemize | |
1833 | |
1834 Several other languages are also supported: | |
1835 | |
1836 @itemize @bullet | |
26264 | 1837 |
1838 @item | |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
1839 In Ada code, functions, procedures, packages, tasks, and types are |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
1840 tags. Use the @samp{--packages-only} option to create tags for packages |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
1841 only. |
26264 | 1842 |
25829 | 1843 @item |
1844 In assembler code, labels appearing at the beginning of a line, | |
1845 followed by a colon, are tags. | |
1846 | |
1847 @item | |
1848 In Bison or Yacc input files, each rule defines as a tag the nonterminal | |
1849 it constructs. The portions of the file that contain C code are parsed | |
1850 as C code. | |
1851 | |
1852 @item | |
1853 In Cobol code, tags are paragraph names; that is, any word starting in | |
1854 column 8 and followed by a period. | |
1855 | |
1856 @item | |
1857 In Erlang code, the tags are the functions, records, and macros defined | |
1858 in the file. | |
1859 | |
1860 @item | |
1861 In Fortran code, functions, subroutines and blockdata are tags. | |
1862 | |
1863 @item | |
1864 In Objective C code, tags include Objective C definitions for classes, | |
1865 class categories, methods, and protocols. | |
1866 | |
1867 @item | |
1868 In Pascal code, the tags are the functions and procedures defined in | |
1869 the file. | |
1870 | |
1871 @item | |
26264 | 1872 In Perl code, the tags are the procedures defined by the @code{sub}, |
1873 @code{my} and @code{local} keywords. Use @samp{--globals} if you want | |
1874 to tag global variables. | |
25829 | 1875 |
1876 @item | |
27221
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
1877 In PostScript code, the tags are the functions. |
25829 | 1878 |
1879 @item | |
1880 In Prolog code, a tag name appears at the left margin. | |
1881 | |
26264 | 1882 @item |
1883 In Python code, @code{def} or @code{class} at the beginning of a line | |
1884 generate a tag. | |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
1885 @end itemize |
26264 | 1886 |
26462 | 1887 You can also generate tags based on regexp matching (@pxref{Etags |
26264 | 1888 Regexps}) to handle other formats and languages. |
25829 | 1889 |
1890 @node Create Tags Table | |
1891 @subsection Creating Tags Tables | |
1892 @cindex @code{etags} program | |
1893 | |
1894 The @code{etags} program is used to create a tags table file. It knows | |
1895 the syntax of several languages, as described in | |
1896 @iftex | |
1897 the previous section. | |
1898 @end iftex | |
1899 @ifinfo | |
1900 @ref{Tag Syntax}. | |
1901 @end ifinfo | |
1902 Here is how to run @code{etags}: | |
1903 | |
1904 @example | |
1905 etags @var{inputfiles}@dots{} | |
1906 @end example | |
1907 | |
1908 @noindent | |
26264 | 1909 The @code{etags} program reads the specified files, and writes a tags |
1910 table named @file{TAGS} in the current working directory. You can | |
1911 intermix compressed and plain text source file names. @code{etags} | |
1912 knows about the most common compression formats, and does the right | |
1913 thing. So you can compress all your source files and have @code{etags} | |
1914 look for compressed versions of its file name arguments, if it does not | |
1915 find uncompressed versions. Under MS-DOS, @code{etags} also looks for | |
1916 file names like @samp{mycode.cgz} if it is given @samp{mycode.c} on the | |
1917 command line and @samp{mycode.c} does not exist. | |
1918 | |
1919 @code{etags} recognizes the language used in an input file based on | |
1920 its file name and contents. You can specify the language with the | |
25829 | 1921 @samp{--language=@var{name}} option, described below. |
1922 | |
1923 If the tags table data become outdated due to changes in the files | |
1924 described in the table, the way to update the tags table is the same way it | |
1925 was made in the first place. It is not necessary to do this often. | |
1926 | |
1927 If the tags table fails to record a tag, or records it for the wrong | |
1928 file, then Emacs cannot possibly find its definition. However, if the | |
1929 position recorded in the tags table becomes a little bit wrong (due to | |
1930 some editing in the file that the tag definition is in), the only | |
1931 consequence is a slight delay in finding the tag. Even if the stored | |
1932 position is very wrong, Emacs will still find the tag, but it must | |
1933 search the entire file for it. | |
1934 | |
1935 So you should update a tags table when you define new tags that you want | |
1936 to have listed, or when you move tag definitions from one file to another, | |
1937 or when changes become substantial. Normally there is no need to update | |
1938 the tags table after each edit, or even every day. | |
1939 | |
1940 One tags table can effectively include another. Specify the included | |
1941 tags file name with the @samp{--include=@var{file}} option when creating | |
1942 the file that is to include it. The latter file then acts as if it | |
1943 contained all the files specified in the included file, as well as the | |
1944 files it directly contains. | |
1945 | |
1946 If you specify the source files with relative file names when you run | |
1947 @code{etags}, the tags file will contain file names relative to the | |
1948 directory where the tags file was initially written. This way, you can | |
1949 move an entire directory tree containing both the tags file and the | |
1950 source files, and the tags file will still refer correctly to the source | |
1951 files. | |
1952 | |
1953 If you specify absolute file names as arguments to @code{etags}, then | |
1954 the tags file will contain absolute file names. This way, the tags file | |
1955 will still refer to the same files even if you move it, as long as the | |
1956 source files remain in the same place. Absolute file names start with | |
1957 @samp{/}, or with @samp{@var{device}:/} on MS-DOS and MS-Windows. | |
1958 | |
1959 When you want to make a tags table from a great number of files, you | |
1960 may have problems listing them on the command line, because some systems | |
1961 have a limit on its length. The simplest way to circumvent this limit | |
1962 is to tell @code{etags} to read the file names from its standard input, | |
1963 by typing a dash in place of the file names, like this: | |
1964 | |
26289
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
1965 @smallexample |
25829 | 1966 find . -name "*.[chCH]" -print | etags - |
26289
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
1967 @end smallexample |
25829 | 1968 |
1969 Use the option @samp{--language=@var{name}} to specify the language | |
1970 explicitly. You can intermix these options with file names; each one | |
1971 applies to the file names that follow it. Specify | |
1972 @samp{--language=auto} to tell @code{etags} to resume guessing the | |
1973 language from the file names and file contents. Specify | |
1974 @samp{--language=none} to turn off language-specific processing | |
26264 | 1975 entirely; then @code{etags} recognizes tags by regexp matching alone |
26289
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
1976 (@pxref{Etags Regexps}). |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
1977 |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
1978 @samp{etags --help} prints the list of the languages @code{etags} |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
1979 knows, and the file name rules for guessing the language. It also prints |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
1980 a list of all the available @code{etags} options, together with a short |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
1981 explanation. |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
1982 |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
1983 @node Etags Regexps |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
1984 @subsection Etags Regexps |
25829 | 1985 |
1986 The @samp{--regex} option provides a general way of recognizing tags | |
1987 based on regexp matching. You can freely intermix it with file names. | |
1988 Each @samp{--regex} option adds to the preceding ones, and applies only | |
1989 to the following files. The syntax is: | |
1990 | |
26289
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
1991 @smallexample |
25829 | 1992 --regex=/@var{tagregexp}[/@var{nameregexp}]/ |
26289
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
1993 @end smallexample |
26264 | 1994 |
25829 | 1995 @noindent |
26289
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
1996 where @var{tagregexp} is used to match the lines to tag. It is always |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
1997 anchored, that is, it behaves as if preceded by @samp{^}. If you want |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
1998 to account for indentation, just match any initial number of blanks by |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
1999 beginning your regular expression with @samp{[ \t]*}. In the regular |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2000 expressions, @samp{\} quotes the next character, and @samp{\t} stands |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2001 for the tab character. Note that @code{etags} does not handle the other |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2002 C escape sequences for special characters. |
25829 | 2003 |
2004 @cindex interval operator (in regexps) | |
2005 The syntax of regular expressions in @code{etags} is the same as in | |
2006 Emacs, augmented with the @dfn{interval operator}, which works as in | |
2007 @code{grep} and @code{ed}. The syntax of an interval operator is | |
2008 @samp{\@{@var{m},@var{n}\@}}, and its meaning is to match the preceding | |
2009 expression at least @var{m} times and up to @var{n} times. | |
2010 | |
2011 You should not match more characters with @var{tagregexp} than that | |
2012 needed to recognize what you want to tag. If the match is such that | |
26106 | 2013 more characters than needed are unavoidably matched by @var{tagregexp} |
2014 (as will usually be the case), you should add a @var{nameregexp}, to | |
2015 pick out just the tag. This will enable Emacs to find tags more | |
2016 accurately and to do completion on tag names more reliably. You can | |
2017 find some examples below. | |
2018 | |
26289
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2019 The option @samp{--ignore-case-regex} (or @samp{-c}) is like |
26106 | 2020 @samp{--regex}, except that the regular expression provided will be |
26289
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2021 matched without regard to case, which is appropriate for various |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2022 programming languages. |
25829 | 2023 |
2024 The @samp{-R} option deletes all the regexps defined with | |
2025 @samp{--regex} options. It applies to the file names following it, as | |
2026 you can see from the following example: | |
2027 | |
26289
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2028 @smallexample |
25829 | 2029 etags --regex=/@var{reg1}/ voo.doo --regex=/@var{reg2}/ \ |
2030 bar.ber -R --lang=lisp los.er | |
26289
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2031 @end smallexample |
25829 | 2032 |
2033 @noindent | |
2034 Here @code{etags} chooses the parsing language for @file{voo.doo} and | |
2035 @file{bar.ber} according to their contents. @code{etags} also uses | |
2036 @var{reg1} to recognize additional tags in @file{voo.doo}, and both | |
2037 @var{reg1} and @var{reg2} to recognize additional tags in | |
2038 @file{bar.ber}. @code{etags} uses the Lisp tags rules, and no regexp | |
2039 matching, to recognize tags in @file{los.er}. | |
2040 | |
26289
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2041 A regular expression can be bound to a given language, by prepending |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2042 it with @samp{@{lang@}}. When you do this, @code{etags} will use the |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2043 regular expression only for files of that language. @samp{etags --help} |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2044 prints the list of languages recognised by @code{etags}. The following |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2045 example tags the @code{DEFVAR} macros in the Emacs source files. |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2046 @code{etags} applies this regular expression to C files only: |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2047 |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2048 @smallexample |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2049 --regex='@{c@}/[ \t]*DEFVAR_[A-Z_ \t(]+"\([^"]+\)"/' |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2050 @end smallexample |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2051 |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2052 @noindent |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2053 This feature is particularly useful when storing a list of regular |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2054 expressions in a file. The following option syntax instructs |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2055 @code{etags} to read two files of regular expressions. The regular |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2056 expressions contained in the second file are matched without regard to |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2057 case. |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2058 |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2059 @smallexample |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2060 --regex=@@first-file --ignore-case-regex=@@second-file |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2061 @end smallexample |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2062 |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2063 @noindent |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2064 A regex file contains one regular expressions per line. Empty lines, |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2065 and lines beginning with space or tab are ignored. When the first |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2066 character in a line is @samp{@@}, @code{etags} assumes that the rest of |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2067 the line is the name of a file of regular expressions. This means that |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2068 such files can be nested. All the other lines are taken to be regular |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2069 expressions. For example, one can create a file called |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2070 @samp{emacs.tags} with the following contents (the first line in the |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2071 file is a comment): |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2072 |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2073 @smallexample |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2074 -- This is for GNU Emacs source files |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2075 @{c@}/[ \t]*DEFVAR_[A-Z_ \t(]+"\([^"]+\)"/\1/ |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2076 @end smallexample |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2077 |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2078 @noindent |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2079 and then use it like this: |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2080 |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2081 @smallexample |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2082 etags --regex=@@emacs.tags *.[ch] */*.[ch] |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2083 @end smallexample |
6651db4a4b1f
Document regexp changes in etags.
Francesco Potortì <pot@gnu.org>
parents:
26264
diff
changeset
|
2084 |
25829 | 2085 Here are some more examples. The regexps are quoted to protect them |
2086 from shell interpretation. | |
2087 | |
2088 @itemize @bullet | |
2089 | |
2090 @item | |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
2091 Tag Octave files: |
25829 | 2092 |
2093 @smallexample | |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
2094 etags --language=none \ |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
2095 --regex='/[ \t]*function.*=[ \t]*\([^ \t]*\)[ \t]*(/\1/' \ |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
2096 --regex='/###key \(.*\)/\1/' \ |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
2097 --regex='/[ \t]*global[ \t].*/' \ |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
2098 *.m |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
2099 @end smallexample |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
2100 |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
2101 @noindent |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
2102 Note that tags are not generated for scripts so that you have to add a |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
2103 line by yourself of the form `###key <script-name>' if you want to jump |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
2104 to it. |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
2105 |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
2106 @item |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
2107 Tag Tcl files: |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
2108 |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
2109 @smallexample |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
2110 etags --language=none --regex='/proc[ \t]+\([^ \t]+\)/\1/' *.tcl |
25829 | 2111 @end smallexample |
2112 | |
2113 @item | |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
2114 Tag VHDL files: |
25829 | 2115 |
2116 @smallexample | |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
2117 --language=none \ |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
2118 --regex='/[ \t]*\(ARCHITECTURE\|CONFIGURATION\) +[^ ]* +OF/' \ |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
2119 --regex='/[ \t]*\(ATTRIBUTE\|ENTITY\|FUNCTION\|PACKAGE\ |
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
2120 \( BODY\)?\|PROCEDURE\|PROCESS\|TYPE\)[ \t]+\([^ \t(]+\)/\3/' |
25829 | 2121 @end smallexample |
2122 @end itemize | |
2123 | |
2124 @node Select Tags Table | |
2125 @subsection Selecting a Tags Table | |
2126 | |
2127 @vindex tags-file-name | |
2128 @findex visit-tags-table | |
2129 Emacs has at any time one @dfn{selected} tags table, and all the commands | |
2130 for working with tags tables use the selected one. To select a tags table, | |
2131 type @kbd{M-x visit-tags-table}, which reads the tags table file name as an | |
2132 argument. The name @file{TAGS} in the default directory is used as the | |
2133 default file name. | |
2134 | |
2135 All this command does is store the file name in the variable | |
2136 @code{tags-file-name}. Emacs does not actually read in the tags table | |
2137 contents until you try to use them. Setting this variable yourself is just | |
2138 as good as using @code{visit-tags-table}. The variable's initial value is | |
2139 @code{nil}; that value tells all the commands for working with tags tables | |
2140 that they must ask for a tags table file name to use. | |
2141 | |
2142 Using @code{visit-tags-table} when a tags table is already loaded | |
2143 gives you a choice: you can add the new tags table to the current list | |
2144 of tags tables, or start a new list. The tags commands use all the tags | |
2145 tables in the current list. If you start a new list, the new tags table | |
2146 is used @emph{instead} of others. If you add the new table to the | |
2147 current list, it is used @emph{as well as} the others. When the tags | |
2148 commands scan the list of tags tables, they don't always start at the | |
2149 beginning of the list; they start with the first tags table (if any) | |
2150 that describes the current file, proceed from there to the end of the | |
2151 list, and then scan from the beginning of the list until they have | |
2152 covered all the tables in the list. | |
2153 | |
2154 @vindex tags-table-list | |
2155 You can specify a precise list of tags tables by setting the variable | |
2156 @code{tags-table-list} to a list of strings, like this: | |
2157 | |
2158 @c keep this on two lines for formatting in smallbook | |
2159 @example | |
2160 @group | |
2161 (setq tags-table-list | |
2162 '("~/emacs" "/usr/local/lib/emacs/src")) | |
2163 @end group | |
2164 @end example | |
2165 | |
2166 @noindent | |
2167 This tells the tags commands to look at the @file{TAGS} files in your | |
2168 @file{~/emacs} directory and in the @file{/usr/local/lib/emacs/src} | |
2169 directory. The order depends on which file you are in and which tags | |
2170 table mentions that file, as explained above. | |
2171 | |
2172 Do not set both @code{tags-file-name} and @code{tags-table-list}. | |
2173 | |
2174 @node Find Tag | |
2175 @subsection Finding a Tag | |
2176 | |
2177 The most important thing that a tags table enables you to do is to find | |
2178 the definition of a specific tag. | |
2179 | |
2180 @table @kbd | |
2181 @item M-.@: @var{tag} @key{RET} | |
2182 Find first definition of @var{tag} (@code{find-tag}). | |
2183 @item C-u M-. | |
2184 Find next alternate definition of last tag specified. | |
2185 @item C-u - M-. | |
2186 Go back to previous tag found. | |
2187 @item C-M-. @var{pattern} @key{RET} | |
2188 Find a tag whose name matches @var{pattern} (@code{find-tag-regexp}). | |
2189 @item C-u C-M-. | |
2190 Find the next tag whose name matches the last pattern used. | |
2191 @item C-x 4 .@: @var{tag} @key{RET} | |
2192 Find first definition of @var{tag}, but display it in another window | |
2193 (@code{find-tag-other-window}). | |
2194 @item C-x 5 .@: @var{tag} @key{RET} | |
2195 Find first definition of @var{tag}, and create a new frame to select the | |
2196 buffer (@code{find-tag-other-frame}). | |
2197 @item M-* | |
2198 Pop back to where you previously invoked @kbd{M-.} and friends. | |
2199 @end table | |
2200 | |
2201 @kindex M-. | |
2202 @findex find-tag | |
2203 @kbd{M-.}@: (@code{find-tag}) is the command to find the definition of | |
2204 a specified tag. It searches through the tags table for that tag, as a | |
2205 string, and then uses the tags table info to determine the file that the | |
2206 definition is in and the approximate character position in the file of | |
2207 the definition. Then @code{find-tag} visits that file, moves point to | |
2208 the approximate character position, and searches ever-increasing | |
2209 distances away to find the tag definition. | |
2210 | |
2211 If an empty argument is given (just type @key{RET}), the sexp in the | |
2212 buffer before or around point is used as the @var{tag} argument. | |
2213 @xref{Lists}, for info on sexps. | |
2214 | |
2215 You don't need to give @kbd{M-.} the full name of the tag; a part | |
2216 will do. This is because @kbd{M-.} finds tags in the table which | |
2217 contain @var{tag} as a substring. However, it prefers an exact match | |
2218 to a substring match. To find other tags that match the same | |
2219 substring, give @code{find-tag} a numeric argument, as in @kbd{C-u | |
2220 M-.}; this does not read a tag name, but continues searching the tags | |
2221 table's text for another tag containing the same substring last used. | |
2222 If you have a real @key{META} key, @kbd{M-0 M-.}@: is an easier | |
2223 alternative to @kbd{C-u M-.}. | |
2224 | |
2225 @kindex C-x 4 . | |
2226 @findex find-tag-other-window | |
2227 @kindex C-x 5 . | |
2228 @findex find-tag-other-frame | |
2229 Like most commands that can switch buffers, @code{find-tag} has a | |
2230 variant that displays the new buffer in another window, and one that | |
2231 makes a new frame for it. The former is @kbd{C-x 4 .}, which invokes | |
2232 the command @code{find-tag-other-window}. The latter is @kbd{C-x 5 .}, | |
2233 which invokes @code{find-tag-other-frame}. | |
2234 | |
2235 To move back to places you've found tags recently, use @kbd{C-u - | |
2236 M-.}; more generally, @kbd{M-.} with a negative numeric argument. This | |
2237 command can take you to another buffer. @kbd{C-x 4 .} with a negative | |
2238 argument finds the previous tag location in another window. | |
2239 | |
2240 @kindex M-* | |
2241 @findex pop-tag-mark | |
2242 @vindex find-tag-marker-ring-length | |
2243 As well as going back to places you've found tags recently, you can go | |
2244 back to places @emph{from where} you found them. Use @kbd{M-*}, which | |
2245 invokes the command @code{pop-tag-mark}, for this. Typically you would | |
2246 find and study the definition of something with @kbd{M-.} and then | |
2247 return to where you were with @kbd{M-*}. | |
2248 | |
2249 Both @kbd{C-u - M-.} and @kbd{M-*} allow you to retrace your steps to | |
2250 a depth determined by the variable @code{find-tag-marker-ring-length}. | |
2251 | |
2252 @findex find-tag-regexp | |
2253 @kindex C-M-. | |
2254 The command @kbd{C-M-.} (@code{find-tag-regexp}) visits the tags that | |
2255 match a specified regular expression. It is just like @kbd{M-.} except | |
2256 that it does regexp matching instead of substring matching. | |
2257 | |
2258 @node Tags Search | |
2259 @subsection Searching and Replacing with Tags Tables | |
2260 | |
2261 The commands in this section visit and search all the files listed in the | |
2262 selected tags table, one by one. For these commands, the tags table serves | |
2263 only to specify a sequence of files to search. | |
2264 | |
2265 @table @kbd | |
2266 @item M-x tags-search @key{RET} @var{regexp} @key{RET} | |
2267 Search for @var{regexp} through the files in the selected tags | |
2268 table. | |
2269 @item M-x tags-query-replace @key{RET} @var{regexp} @key{RET} @var{replacement} @key{RET} | |
2270 Perform a @code{query-replace-regexp} on each file in the selected tags table. | |
2271 @item M-, | |
2272 Restart one of the commands above, from the current location of point | |
2273 (@code{tags-loop-continue}). | |
2274 @end table | |
2275 | |
2276 @findex tags-search | |
2277 @kbd{M-x tags-search} reads a regexp using the minibuffer, then | |
2278 searches for matches in all the files in the selected tags table, one | |
2279 file at a time. It displays the name of the file being searched so you | |
2280 can follow its progress. As soon as it finds an occurrence, | |
2281 @code{tags-search} returns. | |
2282 | |
2283 @kindex M-, | |
2284 @findex tags-loop-continue | |
2285 Having found one match, you probably want to find all the rest. To find | |
2286 one more match, type @kbd{M-,} (@code{tags-loop-continue}) to resume the | |
2287 @code{tags-search}. This searches the rest of the current buffer, followed | |
2288 by the remaining files of the tags table.@refill | |
2289 | |
2290 @findex tags-query-replace | |
2291 @kbd{M-x tags-query-replace} performs a single | |
2292 @code{query-replace-regexp} through all the files in the tags table. It | |
2293 reads a regexp to search for and a string to replace with, just like | |
2294 ordinary @kbd{M-x query-replace-regexp}. It searches much like @kbd{M-x | |
2295 tags-search}, but repeatedly, processing matches according to your | |
2296 input. @xref{Replace}, for more information on query replace. | |
2297 | |
2298 It is possible to get through all the files in the tags table with a | |
2299 single invocation of @kbd{M-x tags-query-replace}. But often it is | |
2300 useful to exit temporarily, which you can do with any input event that | |
2301 has no special query replace meaning. You can resume the query replace | |
2302 subsequently by typing @kbd{M-,}; this command resumes the last tags | |
2303 search or replace command that you did. | |
2304 | |
2305 The commands in this section carry out much broader searches than the | |
2306 @code{find-tag} family. The @code{find-tag} commands search only for | |
2307 definitions of tags that match your substring or regexp. The commands | |
2308 @code{tags-search} and @code{tags-query-replace} find every occurrence | |
2309 of the regexp, as ordinary search commands and replace commands do in | |
2310 the current buffer. | |
2311 | |
2312 These commands create buffers only temporarily for the files that they | |
2313 have to search (those which are not already visited in Emacs buffers). | |
2314 Buffers in which no match is found are quickly killed; the others | |
2315 continue to exist. | |
2316 | |
2317 It may have struck you that @code{tags-search} is a lot like | |
2318 @code{grep}. You can also run @code{grep} itself as an inferior of | |
2319 Emacs and have Emacs show you the matching lines one by one. This works | |
2320 much like running a compilation; finding the source locations of the | |
2321 @code{grep} matches works like finding the compilation errors. | |
2322 @xref{Compilation}. | |
26264 | 2323 |
25829 | 2324 @node List Tags |
2325 @subsection Tags Table Inquiries | |
2326 | |
2327 @table @kbd | |
2328 @item M-x list-tags @key{RET} @var{file} @key{RET} | |
2329 Display a list of the tags defined in the program file @var{file}. | |
2330 @item M-x tags-apropos @key{RET} @var{regexp} @key{RET} | |
2331 Display a list of all tags matching @var{regexp}. | |
2332 @end table | |
2333 | |
2334 @findex list-tags | |
2335 @kbd{M-x list-tags} reads the name of one of the files described by | |
2336 the selected tags table, and displays a list of all the tags defined in | |
2337 that file. The ``file name'' argument is really just a string to | |
2338 compare against the file names recorded in the tags table; it is read as | |
2339 a string rather than as a file name. Therefore, completion and | |
2340 defaulting are not available, and you must enter the file name the same | |
2341 way it appears in the tags table. Do not include a directory as part of | |
2342 the file name unless the file name recorded in the tags table includes a | |
2343 directory. | |
2344 | |
2345 @findex tags-apropos | |
2346 @kbd{M-x tags-apropos} is like @code{apropos} for tags | |
2347 (@pxref{Apropos}). It reads a regexp, then finds all the tags in the | |
2348 selected tags table whose entries match that regexp, and displays the | |
2349 tag names found. | |
27221
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
2350 @vindex tags-apropos-additional-actions |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
2351 You can display additional output with @kbd{M-x tags-apropos} by customizing |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
2352 the variable @code{tags-apropos-additional-actions}. See its |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
2353 documentation for details. |
25829 | 2354 |
2355 You can also perform completion in the buffer on the name space of tag | |
2356 names in the current tags tables. @xref{Symbol Completion}. | |
2357 | |
28329
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2358 @node Imenu |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2359 @section Imenu |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2360 @cindex indexes of buffer contents |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2361 @cindex buffer content indexes |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2362 @cindex tags |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2363 |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2364 The Imenu package provides mode-specific indexes of the contents of |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2365 single buffers and provides selection from a menu. Selecting a menu |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2366 item takes you to the indexed point in the buffer, in a similar way to |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2367 the Tags facility. Indexing is typically by names of program routines |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2368 and variables but in Texinfo mode, for instance, node names are indexed. |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2369 Most major modes for which it is appropriate have Imenu support. |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2370 |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2371 @findex imenu |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2372 @findex imenu-add-menu-bar-index |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2373 @kbd{M-x imenu} builds the index if necessary and presents you with an |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2374 electric buffer menu from which to select an entry (with completion). |
29084 | 2375 If you bind @code{imenu} to a mouse event (@pxref{Mouse Buttons}) and |
2376 invoke it that way, the index will appear as a popup menu; there is no | |
2377 such binding by default. You can add an index menubar on the menubar | |
2378 with @kbd{imenu-add-menu-bar-index}. | |
28329
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2379 |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2380 Some major modes provide facilities for invoking Imenu; otherwise you |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2381 could add @code{imenu-add-menu-bar-index} to a major mode's hook to |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2382 generate an index for each buffer created in that mode. (If you do |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2383 that, it takes sime time to generate the index when finding a file, |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2384 depending on the file's size and the complexity of the indexing function |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2385 for that mode.) |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2386 |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2387 @vindex imenu-auto-rescan |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2388 The index should be regenerated (via the @samp{*Rescan*} menu item) when |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2389 indexable items are added to or deleted from the buffer. Rescanning is |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2390 done when a menu selction is requested if the option |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2391 @code{imenu-auto-rescan} is set. By default buffer positions are in |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2392 terms of markers, so that changing non-indexable text doesn't require |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2393 rescanning. |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2394 |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2395 @vindex imenu-sort-function |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2396 The way the menus are sorted can be customized via the option |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2397 @code{imenu-sort-function}. By default names are ordered as they occur |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2398 in the buffer; alphabetic sorting is provided as an alternative. |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2399 |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2400 Imenu provides the information used by Which Function mode (@pxref{Which |
28391 | 2401 Function}). It may also be used by Speedbar (@pxref{Speedbar}). |
28329
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2402 |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2403 @node Emerge, C Modes, Imenu, Programs |
25829 | 2404 @section Merging Files with Emerge |
2405 @cindex Emerge | |
2406 @cindex merging files | |
2407 | |
2408 It's not unusual for programmers to get their signals crossed and modify | |
2409 the same program in two different directions. To recover from this | |
2410 confusion, you need to merge the two versions. Emerge makes this | |
2411 easier. See also @ref{Comparing Files}, for commands to compare | |
2412 in a more manual fashion, and @ref{Emerge,,, ediff, The Ediff Manual}. | |
2413 | |
2414 @menu | |
2415 * Overview of Emerge:: How to start Emerge. Basic concepts. | |
2416 * Submodes of Emerge:: Fast mode vs. Edit mode. | |
2417 Skip Prefers mode and Auto Advance mode. | |
2418 * State of Difference:: You do the merge by specifying state A or B | |
2419 for each difference. | |
2420 * Merge Commands:: Commands for selecting a difference, | |
2421 changing states of differences, etc. | |
2422 * Exiting Emerge:: What to do when you've finished the merge. | |
2423 * Combining in Emerge:: How to keep both alternatives for a difference. | |
2424 * Fine Points of Emerge:: Misc. | |
2425 @end menu | |
2426 | |
2427 @node Overview of Emerge | |
2428 @subsection Overview of Emerge | |
2429 | |
2430 To start Emerge, run one of these four commands: | |
2431 | |
2432 @table @kbd | |
2433 @item M-x emerge-files | |
2434 @findex emerge-files | |
2435 Merge two specified files. | |
2436 | |
2437 @item M-x emerge-files-with-ancestor | |
2438 @findex emerge-files-with-ancestor | |
2439 Merge two specified files, with reference to a common ancestor. | |
2440 | |
2441 @item M-x emerge-buffers | |
2442 @findex emerge-buffers | |
2443 Merge two buffers. | |
2444 | |
2445 @item M-x emerge-buffers-with-ancestor | |
2446 @findex emerge-buffers-with-ancestor | |
2447 Merge two buffers with reference to a common ancestor in a third | |
2448 buffer. | |
2449 @end table | |
2450 | |
2451 @cindex merge buffer (Emerge) | |
2452 @cindex A and B buffers (Emerge) | |
2453 The Emerge commands compare two files or buffers, and display the | |
2454 comparison in three buffers: one for each input text (the @dfn{A buffer} | |
2455 and the @dfn{B buffer}), and one (the @dfn{merge buffer}) where merging | |
2456 takes place. The merge buffer shows the full merged text, not just the | |
2457 differences. Wherever the two input texts differ, you can choose which | |
2458 one of them to include in the merge buffer. | |
2459 | |
2460 The Emerge commands that take input from existing buffers use only the | |
2461 accessible portions of those buffers, if they are narrowed | |
2462 (@pxref{Narrowing}). | |
2463 | |
2464 If a common ancestor version is available, from which the two texts to | |
2465 be merged were both derived, Emerge can use it to guess which | |
2466 alternative is right. Wherever one current version agrees with the | |
2467 ancestor, Emerge presumes that the other current version is a deliberate | |
2468 change which should be kept in the merged version. Use the | |
2469 @samp{with-ancestor} commands if you want to specify a common ancestor | |
2470 text. These commands read three file or buffer names---variant A, | |
2471 variant B, and the common ancestor. | |
2472 | |
2473 After the comparison is done and the buffers are prepared, the | |
2474 interactive merging starts. You control the merging by typing special | |
2475 @dfn{merge commands} in the merge buffer. The merge buffer shows you a | |
2476 full merged text, not just differences. For each run of differences | |
2477 between the input texts, you can choose which one of them to keep, or | |
2478 edit them both together. | |
2479 | |
2480 The merge buffer uses a special major mode, Emerge mode, with commands | |
2481 for making these choices. But you can also edit the buffer with | |
2482 ordinary Emacs commands. | |
2483 | |
2484 At any given time, the attention of Emerge is focused on one | |
2485 particular difference, called the @dfn{selected} difference. This | |
2486 difference is marked off in the three buffers like this: | |
2487 | |
2488 @example | |
2489 vvvvvvvvvvvvvvvvvvvv | |
2490 @var{text that differs} | |
2491 ^^^^^^^^^^^^^^^^^^^^ | |
2492 @end example | |
2493 | |
2494 @noindent | |
2495 Emerge numbers all the differences sequentially and the mode | |
2496 line always shows the number of the selected difference. | |
2497 | |
2498 Normally, the merge buffer starts out with the A version of the text. | |
2499 But when the A version of a difference agrees with the common ancestor, | |
2500 then the B version is initially preferred for that difference. | |
2501 | |
2502 Emerge leaves the merged text in the merge buffer when you exit. At | |
2503 that point, you can save it in a file with @kbd{C-x C-w}. If you give a | |
2504 numeric argument to @code{emerge-files} or | |
2505 @code{emerge-files-with-ancestor}, it reads the name of the output file | |
2506 using the minibuffer. (This is the last file name those commands read.) | |
2507 Then exiting from Emerge saves the merged text in the output file. | |
2508 | |
2509 Normally, Emerge commands save the output buffer in its file when you | |
2510 exit. If you abort Emerge with @kbd{C-]}, the Emerge command does not | |
2511 save the output buffer, but you can save it yourself if you wish. | |
2512 | |
2513 @node Submodes of Emerge | |
2514 @subsection Submodes of Emerge | |
2515 | |
2516 You can choose between two modes for giving merge commands: Fast mode | |
2517 and Edit mode. In Fast mode, basic merge commands are single | |
2518 characters, but ordinary Emacs commands are disabled. This is | |
2519 convenient if you use only merge commands. In Edit mode, all merge | |
2520 commands start with the prefix key @kbd{C-c C-c}, and the normal Emacs | |
2521 commands are also available. This allows editing the merge buffer, but | |
2522 slows down Emerge operations. | |
2523 | |
2524 Use @kbd{e} to switch to Edit mode, and @kbd{C-c C-c f} to switch to | |
2525 Fast mode. The mode line indicates Edit and Fast modes with @samp{E} | |
2526 and @samp{F}. | |
2527 | |
2528 Emerge has two additional submodes that affect how particular merge | |
2529 commands work: Auto Advance mode and Skip Prefers mode. | |
2530 | |
2531 If Auto Advance mode is in effect, the @kbd{a} and @kbd{b} commands | |
2532 advance to the next difference. This lets you go through the merge | |
2533 faster as long as you simply choose one of the alternatives from the | |
2534 input. The mode line indicates Auto Advance mode with @samp{A}. | |
2535 | |
2536 If Skip Prefers mode is in effect, the @kbd{n} and @kbd{p} commands | |
2537 skip over differences in states prefer-A and prefer-B (@pxref{State of | |
2538 Difference}). Thus you see only differences for which neither version | |
2539 is presumed ``correct.'' The mode line indicates Skip Prefers mode with | |
2540 @samp{S}. | |
2541 | |
2542 @findex emerge-auto-advance-mode | |
2543 @findex emerge-skip-prefers-mode | |
2544 Use the command @kbd{s a} (@code{emerge-auto-advance-mode}) to set or | |
2545 clear Auto Advance mode. Use @kbd{s s} | |
2546 (@code{emerge-skip-prefers-mode}) to set or clear Skip Prefers mode. | |
2547 These commands turn on the mode with a positive argument, turns it off | |
2548 with a negative or zero argument, and toggle the mode with no argument. | |
2549 | |
2550 @node State of Difference | |
2551 @subsection State of a Difference | |
2552 | |
2553 In the merge buffer, a difference is marked with lines of @samp{v} and | |
2554 @samp{^} characters. Each difference has one of these seven states: | |
2555 | |
2556 @table @asis | |
2557 @item A | |
2558 The difference is showing the A version. The @kbd{a} command always | |
2559 produces this state; the mode line indicates it with @samp{A}. | |
2560 | |
2561 @item B | |
2562 The difference is showing the B version. The @kbd{b} command always | |
2563 produces this state; the mode line indicates it with @samp{B}. | |
2564 | |
2565 @item default-A | |
2566 @itemx default-B | |
2567 The difference is showing the A or the B state by default, because you | |
2568 haven't made a choice. All differences start in the default-A state | |
2569 (and thus the merge buffer is a copy of the A buffer), except those for | |
2570 which one alternative is ``preferred'' (see below). | |
2571 | |
2572 When you select a difference, its state changes from default-A or | |
2573 default-B to plain A or B. Thus, the selected difference never has | |
2574 state default-A or default-B, and these states are never displayed in | |
2575 the mode line. | |
2576 | |
2577 The command @kbd{d a} chooses default-A as the default state, and @kbd{d | |
2578 b} chooses default-B. This chosen default applies to all differences | |
2579 which you haven't ever selected and for which no alternative is preferred. | |
2580 If you are moving through the merge sequentially, the differences you | |
2581 haven't selected are those following the selected one. Thus, while | |
2582 moving sequentially, you can effectively make the A version the default | |
2583 for some sections of the merge buffer and the B version the default for | |
2584 others by using @kbd{d a} and @kbd{d b} between sections. | |
2585 | |
2586 @item prefer-A | |
2587 @itemx prefer-B | |
2588 The difference is showing the A or B state because it is | |
2589 @dfn{preferred}. This means that you haven't made an explicit choice, | |
2590 but one alternative seems likely to be right because the other | |
2591 alternative agrees with the common ancestor. Thus, where the A buffer | |
2592 agrees with the common ancestor, the B version is preferred, because | |
2593 chances are it is the one that was actually changed. | |
2594 | |
2595 These two states are displayed in the mode line as @samp{A*} and @samp{B*}. | |
2596 | |
2597 @item combined | |
2598 The difference is showing a combination of the A and B states, as a | |
2599 result of the @kbd{x c} or @kbd{x C} commands. | |
2600 | |
2601 Once a difference is in this state, the @kbd{a} and @kbd{b} commands | |
2602 don't do anything to it unless you give them a numeric argument. | |
2603 | |
2604 The mode line displays this state as @samp{comb}. | |
2605 @end table | |
2606 | |
2607 @node Merge Commands | |
2608 @subsection Merge Commands | |
2609 | |
2610 Here are the Merge commands for Fast mode; in Edit mode, precede them | |
2611 with @kbd{C-c C-c}: | |
2612 | |
2613 @table @kbd | |
2614 @item p | |
2615 Select the previous difference. | |
2616 | |
2617 @item n | |
2618 Select the next difference. | |
2619 | |
2620 @item a | |
2621 Choose the A version of this difference. | |
2622 | |
2623 @item b | |
2624 Choose the B version of this difference. | |
2625 | |
2626 @item C-u @var{n} j | |
2627 Select difference number @var{n}. | |
2628 | |
2629 @item . | |
2630 Select the difference containing point. You can use this command in the | |
2631 merge buffer or in the A or B buffer. | |
2632 | |
2633 @item q | |
2634 Quit---finish the merge. | |
2635 | |
2636 @item C-] | |
2637 Abort---exit merging and do not save the output. | |
2638 | |
2639 @item f | |
2640 Go into Fast mode. (In Edit mode, this is actually @kbd{C-c C-c f}.) | |
2641 | |
2642 @item e | |
2643 Go into Edit mode. | |
2644 | |
2645 @item l | |
2646 Recenter (like @kbd{C-l}) all three windows. | |
2647 | |
26264 | 2648 @item - |
25829 | 2649 Specify part of a prefix numeric argument. |
2650 | |
2651 @item @var{digit} | |
2652 Also specify part of a prefix numeric argument. | |
2653 | |
2654 @item d a | |
2655 Choose the A version as the default from here down in | |
2656 the merge buffer. | |
2657 | |
2658 @item d b | |
2659 Choose the B version as the default from here down in | |
2660 the merge buffer. | |
2661 | |
2662 @item c a | |
2663 Copy the A version of this difference into the kill ring. | |
2664 | |
2665 @item c b | |
2666 Copy the B version of this difference into the kill ring. | |
2667 | |
2668 @item i a | |
2669 Insert the A version of this difference at point. | |
2670 | |
2671 @item i b | |
2672 Insert the B version of this difference at point. | |
2673 | |
2674 @item m | |
2675 Put point and mark around the difference. | |
2676 | |
2677 @item ^ | |
2678 Scroll all three windows down (like @kbd{M-v}). | |
2679 | |
2680 @item v | |
2681 Scroll all three windows up (like @kbd{C-v}). | |
2682 | |
2683 @item < | |
2684 Scroll all three windows left (like @kbd{C-x <}). | |
2685 | |
2686 @item > | |
2687 Scroll all three windows right (like @kbd{C-x >}). | |
2688 | |
2689 @item | | |
2690 Reset horizontal scroll on all three windows. | |
2691 | |
2692 @item x 1 | |
2693 Shrink the merge window to one line. (Use @kbd{C-u l} to restore it | |
2694 to full size.) | |
2695 | |
2696 @item x c | |
2697 Combine the two versions of this difference (@pxref{Combining in | |
2698 Emerge}). | |
2699 | |
2700 @item x f | |
2701 Show the names of the files/buffers Emerge is operating on, in a Help | |
2702 window. (Use @kbd{C-u l} to restore windows.) | |
2703 | |
2704 @item x j | |
2705 Join this difference with the following one. | |
2706 (@kbd{C-u x j} joins this difference with the previous one.) | |
2707 | |
2708 @item x s | |
2709 Split this difference into two differences. Before you use this | |
2710 command, position point in each of the three buffers at the place where | |
2711 you want to split the difference. | |
2712 | |
2713 @item x t | |
2714 Trim identical lines off the top and bottom of the difference. | |
2715 Such lines occur when the A and B versions are | |
2716 identical but differ from the ancestor version. | |
2717 @end table | |
2718 | |
2719 @node Exiting Emerge | |
2720 @subsection Exiting Emerge | |
2721 | |
2722 The @kbd{q} command (@code{emerge-quit}) finishes the merge, storing | |
2723 the results into the output file if you specified one. It restores the | |
2724 A and B buffers to their proper contents, or kills them if they were | |
2725 created by Emerge and you haven't changed them. It also disables the | |
2726 Emerge commands in the merge buffer, since executing them later could | |
2727 damage the contents of the various buffers. | |
2728 | |
2729 @kbd{C-]} aborts the merge. This means exiting without writing the | |
2730 output file. If you didn't specify an output file, then there is no | |
2731 real difference between aborting and finishing the merge. | |
2732 | |
2733 If the Emerge command was called from another Lisp program, then its | |
2734 return value is @code{t} for successful completion, or @code{nil} if you | |
2735 abort. | |
2736 | |
2737 @node Combining in Emerge | |
2738 @subsection Combining the Two Versions | |
2739 | |
2740 Sometimes you want to keep @emph{both} alternatives for a particular | |
2741 difference. To do this, use @kbd{x c}, which edits the merge buffer | |
2742 like this: | |
2743 | |
2744 @example | |
2745 @group | |
2746 #ifdef NEW | |
2747 @var{version from A buffer} | |
2748 #else /* not NEW */ | |
2749 @var{version from B buffer} | |
2750 #endif /* not NEW */ | |
2751 @end group | |
2752 @end example | |
2753 | |
2754 @noindent | |
2755 @vindex emerge-combine-versions-template | |
2756 While this example shows C preprocessor conditionals delimiting the two | |
2757 alternative versions, you can specify the strings to use by setting | |
2758 the variable @code{emerge-combine-versions-template} to a string of your | |
2759 choice. In the string, @samp{%a} says where to put version A, and | |
2760 @samp{%b} says where to put version B. The default setting, which | |
2761 produces the results shown above, looks like this: | |
2762 | |
2763 @example | |
2764 @group | |
2765 "#ifdef NEW\n%a#else /* not NEW */\n%b#endif /* not NEW */\n" | |
2766 @end group | |
2767 @end example | |
2768 | |
2769 @node Fine Points of Emerge | |
2770 @subsection Fine Points of Emerge | |
2771 | |
2772 During the merge, you mustn't try to edit the A and B buffers yourself. | |
2773 Emerge modifies them temporarily, but ultimately puts them back the way | |
2774 they were. | |
2775 | |
2776 You can have any number of merges going at once---just don't use any one | |
2777 buffer as input to more than one merge at once, since the temporary | |
2778 changes made in these buffers would get in each other's way. | |
2779 | |
2780 Starting Emerge can take a long time because it needs to compare the | |
2781 files fully. Emacs can't do anything else until @code{diff} finishes. | |
2782 Perhaps in the future someone will change Emerge to do the comparison in | |
2783 the background when the input files are large---then you could keep on | |
2784 doing other things with Emacs until Emerge is ready to accept | |
2785 commands. | |
2786 | |
2787 @vindex emerge-startup-hook | |
2788 After setting up the merge, Emerge runs the hook | |
2789 @code{emerge-startup-hook} (@pxref{Hooks}). | |
2790 | |
2791 @node C Modes | |
2792 @section C and Related Modes | |
2793 @cindex C mode | |
2794 @cindex Java mode | |
2795 @cindex Pike mode | |
2796 @cindex IDL mode | |
2797 @cindex CORBA IDL mode | |
2798 @cindex Objective C mode | |
2799 @cindex C++ mode | |
2800 @cindex mode, Java | |
2801 @cindex mode, C | |
2802 @cindex mode, Objective C | |
2803 @cindex mode, CORBA IDL | |
2804 @cindex mode, Pike | |
2805 | |
2806 This section describes special features available in C, C++, | |
2807 Objective-C, Java, CORBA IDL, and Pike modes. When we say ``C mode and | |
2808 related modes,'' those are the modes we mean. | |
2809 | |
28329
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2810 Additional information is available in the separate manual for these |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2811 modes. @xref{Top, CC Mode, ccmode, , CC Mode}. |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
2812 |
25829 | 2813 @menu |
2814 * Motion in C:: | |
2815 * Electric C:: | |
2816 * Hungry Delete:: | |
2817 * Other C Commands:: | |
2818 * Comments in C:: | |
2819 @end menu | |
2820 | |
2821 @node Motion in C | |
2822 @subsection C Mode Motion Commands | |
2823 | |
2824 This section describes commands for moving point, in C mode and | |
2825 related modes. | |
2826 | |
2827 @table @code | |
2828 @item C-c C-u | |
2829 @kindex C-c C-u @r{(C mode)} | |
2830 @findex c-up-conditional | |
2831 Move point back to the containing preprocessor conditional, leaving the | |
2832 mark behind. A prefix argument acts as a repeat count. With a negative | |
2833 argument, move point forward to the end of the containing | |
2834 preprocessor conditional. When going backwards, @code{#elif} is treated | |
2835 like @code{#else} followed by @code{#if}. When going forwards, | |
2836 @code{#elif} is ignored.@refill | |
2837 | |
2838 @item C-c C-p | |
2839 @kindex C-c C-p @r{(C mode)} | |
2840 @findex c-backward-conditional | |
2841 Move point back over a preprocessor conditional, leaving the mark | |
2842 behind. A prefix argument acts as a repeat count. With a negative | |
2843 argument, move forward. | |
2844 | |
2845 @item C-c C-n | |
2846 @kindex C-c C-n @r{(C mode)} | |
2847 @findex c-forward-conditional | |
2848 Move point forward across a preprocessor conditional, leaving the mark | |
2849 behind. A prefix argument acts as a repeat count. With a negative | |
2850 argument, move backward. | |
2851 | |
2852 @item M-a | |
2853 @kindex ESC a | |
2854 @findex c-beginning-of-statement | |
2855 Move point to the beginning of the innermost C statement | |
2856 (@code{c-beginning-of-statement}). If point is already at the beginning | |
2857 of a statement, move to the beginning of the preceding statement. With | |
2858 prefix argument @var{n}, move back @var{n} @minus{} 1 statements. | |
2859 | |
2860 If point is within a string or comment, or next to a comment (only | |
2861 whitespace between them), this command moves by sentences instead of | |
2862 statements. | |
2863 | |
2864 When called from a program, this function takes three optional | |
2865 arguments: the numeric prefix argument, a buffer position limit | |
2866 (don't move back before that place), and a flag that controls whether | |
2867 to do sentence motion when inside of a comment. | |
2868 | |
2869 @item M-e | |
2870 @kindex ESC e | |
2871 @findex c-end-of-statement | |
2872 Move point to the end of the innermost C statement; like @kbd{M-a} | |
2873 except that it moves in the other direction (@code{c-end-of-statement}). | |
2874 | |
2875 @item M-x c-backward-into-nomenclature | |
2876 @findex c-backward-into-nomenclature | |
2877 Move point backward to beginning of a C++ nomenclature section or word. | |
2878 With prefix argument @var{n}, move @var{n} times. If @var{n} is | |
2879 negative, move forward. C++ nomenclature means a symbol name in the | |
2880 style of NamingSymbolsWithMixedCaseAndNoUnderlines; each capital letter | |
2881 begins a section or word. | |
2882 | |
2883 In the GNU project, we recommend using underscores to separate words | |
2884 within an identifier in C or C++, rather than using case distinctions. | |
2885 | |
2886 @item M-x c-forward-into-nomenclature | |
2887 @findex c-forward-into-nomenclature | |
2888 Move point forward to end of a C++ nomenclature section or word. | |
2889 With prefix argument @var{n}, move @var{n} times. | |
2890 @end table | |
2891 | |
2892 @node Electric C | |
2893 @subsection Electric C Characters | |
2894 | |
2895 In C mode and related modes, certain printing characters are | |
2896 ``electric''---in addition to inserting themselves, they also reindent | |
2897 the current line and may insert newlines. This feature is controlled by | |
2898 the variable @code{c-auto-newline}. The ``electric'' characters are | |
2899 @kbd{@{}, @kbd{@}}, @kbd{:}, @kbd{#}, @kbd{;}, @kbd{,}, @kbd{<}, | |
2900 @kbd{>}, @kbd{/}, @kbd{*}, @kbd{(}, and @kbd{)}. | |
2901 | |
2902 Electric characters insert newlines only when the @dfn{auto-newline} | |
2903 feature is enabled (indicated by @samp{/a} in the mode line after the | |
2904 mode name). This feature is controlled by the variable | |
2905 @code{c-auto-newline}. You can turn this feature on or off with the | |
2906 command @kbd{C-c C-a}: | |
2907 | |
2908 @table @kbd | |
2909 @item C-c C-a | |
2910 @kindex C-c C-a @r{(C mode)} | |
2911 @findex c-toggle-auto-state | |
2912 Toggle the auto-newline feature (@code{c-toggle-auto-state}). With a | |
2913 prefix argument, this command turns the auto-newline feature on if the | |
2914 argument is positive, and off if it is negative. | |
2915 @end table | |
2916 | |
2917 The colon character is electric because that is appropriate for a | |
2918 single colon. But when you want to insert a double colon in C++, the | |
2919 electric behavior of colon is inconvenient. You can insert a double | |
2920 colon with no reindentation or newlines by typing @kbd{C-c :}: | |
2921 | |
2922 @table @kbd | |
2923 @item C-c : | |
2924 @kindex C-c : @r{(C mode)} | |
2925 @findex c-scope-operator | |
2926 Insert a double colon scope operator at point, without reindenting the | |
2927 line or adding any newlines (@code{c-scope-operator}). | |
2928 @end table | |
2929 | |
2930 The electric @kbd{#} key reindents the line if it appears to be the | |
2931 beginning of a preprocessor directive. This happens when the value of | |
2932 @code{c-electric-pound-behavior} is @code{(alignleft)}. You can turn | |
2933 this feature off by setting @code{c-electric-pound-behavior} to | |
2934 @code{nil}. | |
2935 | |
2936 The variable @code{c-hanging-braces-alist} controls the insertion of | |
2937 newlines before and after inserted braces. It is an association list | |
2938 with elements of the following form: @code{(@var{syntactic-symbol} | |
2939 . @var{nl-list})}. Most of the syntactic symbols that appear in | |
2940 @code{c-offsets-alist} are meaningful here as well. | |
2941 | |
2942 The list @var{nl-list} may contain either of the symbols | |
2943 @code{before} or @code{after}, or both; or it may be @code{nil}. When a | |
2944 brace is inserted, the syntactic context it defines is looked up in | |
2945 @code{c-hanging-braces-alist}; if it is found, the @var{nl-list} is used | |
2946 to determine where newlines are inserted: either before the brace, | |
2947 after, or both. If not found, the default is to insert a newline both | |
2948 before and after braces. | |
2949 | |
2950 The variable @code{c-hanging-colons-alist} controls the insertion of | |
2951 newlines before and after inserted colons. It is an association list | |
2952 with elements of the following form: @code{(@var{syntactic-symbol} | |
2953 . @var{nl-list})}. The list @var{nl-list} may contain either of the | |
2954 symbols @code{before} or @code{after}, or both; or it may be @code{nil}. | |
2955 | |
2956 When a colon is inserted, the syntactic symbol it defines is looked | |
2957 up in this list, and if found, the @var{nl-list} is used to determine | |
2958 where newlines are inserted: either before the brace, after, or both. | |
2959 If the syntactic symbol is not found in this list, no newlines are | |
2960 inserted. | |
2961 | |
2962 Electric characters can also delete newlines automatically when the | |
2963 auto-newline feature is enabled. This feature makes auto-newline more | |
2964 acceptable, by deleting the newlines in the most common cases where you | |
2965 do not want them. Emacs can recognize several cases in which deleting a | |
2966 newline might be desirable; by setting the variable | |
2967 @code{c-cleanup-list}, you can specify @emph{which} of these cases that | |
2968 should happen. The variable's value is a list of symbols, each | |
2969 describing one case for possible deletion of a newline. Here are the | |
2970 meaningful symbols, and their meanings: | |
2971 | |
2972 @table @code | |
2973 @item brace-catch-brace | |
2974 Clean up @samp{@} catch (@var{condition}) @{} constructs by placing the | |
2975 entire construct on a single line. The clean-up occurs when you type | |
2976 the @samp{@{}, if there is nothing between the braces aside from | |
2977 @code{catch} and @var{condition}. | |
2978 | |
2979 @item brace-else-brace | |
2980 Clean up @samp{@} else @{} constructs by placing the entire construct on | |
2981 a single line. The clean-up occurs when you type the @samp{@{} after | |
2982 the @code{else}, but only if there is nothing but white space between | |
2983 the braces and the @code{else}. | |
2984 | |
2985 @item brace-elseif-brace | |
2986 Clean up @samp{@} else if (@dots{}) @{} constructs by placing the entire | |
2987 construct on a single line. The clean-up occurs when you type the | |
2988 @samp{@{}, if there is nothing but white space between the @samp{@}} and | |
2989 @samp{@{} aside from the keywords and the @code{if}-condition. | |
2990 | |
2991 @item empty-defun-braces | |
2992 Clean up empty defun braces by placing the braces on the same | |
2993 line. Clean-up occurs when you type the closing brace. | |
2994 | |
2995 @item defun-close-semi | |
2996 Clean up the semicolon after a @code{struct} or similar type | |
2997 declaration, by placing the semicolon on the same line as the closing | |
2998 brace. Clean-up occurs when you type the semicolon. | |
2999 | |
3000 @item list-close-comma | |
3001 Clean up commas following braces in array and aggregate | |
3002 initializers. Clean-up occurs when you type the comma. | |
3003 | |
3004 @item scope-operator | |
3005 Clean up double colons which may designate a C++ scope operator, by | |
3006 placing the colons together. Clean-up occurs when you type the second | |
3007 colon, but only when the two colons are separated by nothing but | |
3008 whitespace. | |
3009 @end table | |
3010 | |
3011 @node Hungry Delete | |
3012 @subsection Hungry Delete Feature in C | |
3013 | |
3014 When the @dfn{hungry-delete} feature is enabled (indicated by | |
3015 @samp{/h} or @samp{/ah} in the mode line after the mode name), a single | |
3016 @key{DEL} command deletes all preceding whitespace, not just one space. | |
3017 To turn this feature on or off, use @kbd{C-c C-d}: | |
3018 | |
3019 @table @kbd | |
3020 @item C-c C-d | |
3021 @kindex C-c C-d @r{(C mode)} | |
3022 @findex c-toggle-hungry-state | |
3023 Toggle the hungry-delete feature (@code{c-toggle-hungry-state}). With a | |
3024 prefix argument, this command turns the hungry-delete feature on if the | |
3025 argument is positive, and off if it is negative. | |
3026 | |
3027 @item C-c C-t | |
3028 @kindex C-c C-t @r{(C mode)} | |
3029 @findex c-toggle-auto-hungry-state | |
3030 Toggle the auto-newline and hungry-delete features, both at once | |
3031 (@code{c-toggle-auto-hungry-state}). | |
3032 @end table | |
3033 | |
3034 @vindex c-hungry-delete-key | |
3035 The variable @code{c-hungry-delete-key} controls whether the | |
3036 hungry-delete feature is enabled. | |
3037 | |
3038 @node Other C Commands | |
3039 @subsection Other Commands for C Mode | |
3040 | |
3041 @table @kbd | |
3042 @item C-M-h | |
3043 @findex c-mark-function | |
3044 @kindex C-M-h @r{(C mode)} | |
3045 Put mark at the end of a function definition, and put point at the | |
3046 beginning (@code{c-mark-function}). | |
3047 | |
3048 @item M-q | |
3049 @kindex M-q @r{(C mode)} | |
3050 @findex c-fill-paragraph | |
3051 Fill a paragraph, handling C and C++ comments (@code{c-fill-paragraph}). | |
3052 If any part of the current line is a comment or within a comment, this | |
3053 command fills the comment or the paragraph of it that point is in, | |
3054 preserving the comment indentation and comment delimiters. | |
3055 | |
3056 @item C-c C-e | |
3057 @cindex macro expansion in C | |
3058 @cindex expansion of C macros | |
3059 @findex c-macro-expand | |
3060 @kindex C-c C-e @r{(C mode)} | |
3061 Run the C preprocessor on the text in the region, and show the result, | |
3062 which includes the expansion of all the macro calls | |
3063 (@code{c-macro-expand}). The buffer text before the region is also | |
3064 included in preprocessing, for the sake of macros defined there, but the | |
3065 output from this part isn't shown. | |
3066 | |
3067 When you are debugging C code that uses macros, sometimes it is hard to | |
3068 figure out precisely how the macros expand. With this command, you | |
3069 don't have to figure it out; you can see the expansions. | |
3070 | |
3071 @item C-c C-\ | |
3072 @findex c-backslash-region | |
3073 @kindex C-c C-\ @r{(C mode)} | |
3074 Insert or align @samp{\} characters at the ends of the lines of the | |
3075 region (@code{c-backslash-region}). This is useful after writing or | |
3076 editing a C macro definition. | |
3077 | |
3078 If a line already ends in @samp{\}, this command adjusts the amount of | |
3079 whitespace before it. Otherwise, it inserts a new @samp{\}. However, | |
3080 the last line in the region is treated specially; no @samp{\} is | |
3081 inserted on that line, and any @samp{\} there is deleted. | |
3082 | |
3083 @item M-x cpp-highlight-buffer | |
3084 @cindex preprocessor highlighting | |
3085 @findex cpp-highlight-buffer | |
3086 Highlight parts of the text according to its preprocessor conditionals. | |
3087 This command displays another buffer named @samp{*CPP Edit*}, which | |
3088 serves as a graphic menu for selecting how to display particular kinds | |
3089 of conditionals and their contents. After changing various settings, | |
3090 click on @samp{[A]pply these settings} (or go to that buffer and type | |
3091 @kbd{a}) to rehighlight the C mode buffer accordingly. | |
3092 | |
3093 @item C-c C-s | |
3094 @findex c-show-syntactic-information | |
3095 @kindex C-c C-s @r{(C mode)} | |
3096 Display the syntactic information about the current source line | |
3097 (@code{c-show-syntactic-information}). This is the information that | |
3098 directs how the line is indented. | |
3099 @end table | |
3100 | |
3101 @node Comments in C | |
3102 @subsection Comments in C Modes | |
3103 | |
3104 C mode and related modes use a number of variables for controlling | |
3105 comment format. | |
3106 | |
3107 @table @code | |
3108 @item c-comment-only-line-offset | |
3109 @vindex c-comment-only-line-offset | |
3110 Extra offset for line which contains only the start of a comment. It | |
3111 can be either an integer or a cons cell of the form | |
3112 @code{(@var{non-anchored-offset} . @var{anchored-offset})}, where | |
3113 @var{non-anchored-offset} is the amount of offset given to | |
3114 non-column-zero anchored comment-only lines, and @var{anchored-offset} | |
3115 is the amount of offset to give column-zero anchored comment-only lines. | |
3116 Just an integer as value is equivalent to @code{(@var{val} . 0)}. | |
3117 | |
3118 @item c-comment-start-regexp | |
3119 @vindex c-comment-start-regexp | |
3120 This buffer-local variable specifies how to recognize the start of a comment. | |
3121 | |
3122 @item c-hanging-comment-ender-p | |
3123 @vindex c-hanging-comment-ender-p | |
3124 If this variable is @code{nil}, @code{c-fill-paragraph} leaves the | |
3125 comment terminator of a block comment on a line by itself. The default | |
3126 value is @code{t}, which puts the comment-end delimiter @samp{*/} at the | |
3127 end of the last line of the comment text. | |
3128 | |
3129 @item c-hanging-comment-starter-p | |
3130 @vindex c-hanging-comment-starter-p | |
3131 If this variable is @code{nil}, @code{c-fill-paragraph} leaves the | |
3132 starting delimiter of a block comment on a line by itself. The default | |
3133 value is @code{t}, which puts the comment-start delimiter @samp{/*} at | |
3134 the beginning of the first line of the comment text. | |
3135 @end table | |
3136 | |
3137 @node Fortran | |
3138 @section Fortran Mode | |
3139 @cindex Fortran mode | |
3140 @cindex mode, Fortran | |
3141 | |
3142 Fortran mode provides special motion commands for Fortran statements and | |
3143 subprograms, and indentation commands that understand Fortran conventions | |
3144 of nesting, line numbers and continuation statements. Fortran mode has | |
3145 its own Auto Fill mode that breaks long lines into proper Fortran | |
3146 continuation lines. | |
3147 | |
3148 Special commands for comments are provided because Fortran comments | |
3149 are unlike those of other languages. Built-in abbrevs optionally save | |
3150 typing when you insert Fortran keywords. | |
3151 | |
3152 @findex fortran-mode | |
3153 Use @kbd{M-x fortran-mode} to switch to this major mode. This command | |
3154 runs the hook @code{fortran-mode-hook} (@pxref{Hooks}). | |
3155 | |
26106 | 3156 @cindex Fortran77 |
3157 @cindex Fortran90 | |
3158 @findex f90-mode | |
3159 @findex fortran-mode | |
3160 Note that Fortan mode described here (obtained with the | |
3161 @code{fortran-mode} command) is for editing the old Fortran77 | |
3162 idiosyncratic `fixed format' source form. For editing the modern | |
3163 Fortran90 `free format' source form (which is supported by the GNU | |
3164 Fortran compiler) use @code{f90-mode}. | |
3165 | |
3166 By default @code{fortran-mode} is invoked on files with extension | |
3167 @samp{.f}, @samp{.F} or @samp{.for} and @code{f90-mode} is invoked for | |
3168 the extension @samp{.f90}. | |
3169 | |
25829 | 3170 @menu |
3171 * Motion: Fortran Motion. Moving point by statements or subprograms. | |
3172 * Indent: Fortran Indent. Indentation commands for Fortran. | |
3173 * Comments: Fortran Comments. Inserting and aligning comments. | |
3174 * Autofill: Fortran Autofill. Auto fill minor mode for Fortran. | |
3175 * Columns: Fortran Columns. Measuring columns for valid Fortran. | |
3176 * Abbrev: Fortran Abbrev. Built-in abbrevs for Fortran keywords. | |
3177 * Misc: Fortran Misc. Other Fortran mode features. | |
3178 @end menu | |
3179 | |
3180 @node Fortran Motion | |
3181 @subsection Motion Commands | |
3182 | |
27221
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
3183 In addition to the normal commands for moving by and operating on |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
3184 `defuns' (Fortran subprograms---functions |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
3185 and subroutines) Fortran mode provides special commands to move by statements. |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
3186 |
25829 | 3187 @kindex C-c C-p @r{(Fortran mode)} |
3188 @kindex C-c C-n @r{(Fortran mode)} | |
3189 @findex fortran-previous-statement | |
3190 @findex fortran-next-statement | |
3191 | |
3192 @table @kbd | |
3193 @item C-c C-n | |
3194 Move to beginning of current or next statement | |
3195 (@code{fortran-next-statement}). | |
3196 @item C-c C-p | |
3197 Move to beginning of current or previous statement | |
3198 (@code{fortran-previous-statement}). | |
3199 @end table | |
3200 | |
3201 @node Fortran Indent | |
3202 @subsection Fortran Indentation | |
3203 | |
3204 Special commands and features are needed for indenting Fortran code in | |
3205 order to make sure various syntactic entities (line numbers, comment line | |
3206 indicators and continuation line flags) appear in the columns that are | |
3207 required for standard Fortran. | |
3208 | |
3209 @menu | |
27221
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
3210 * Commands: ForIndent Commands. Commands for indenting and filling Fortran. |
25829 | 3211 * Contline: ForIndent Cont. How continuation lines indent. |
3212 * Numbers: ForIndent Num. How line numbers auto-indent. | |
3213 * Conv: ForIndent Conv. Conventions you must obey to avoid trouble. | |
3214 * Vars: ForIndent Vars. Variables controlling Fortran indent style. | |
3215 @end menu | |
3216 | |
3217 @node ForIndent Commands | |
27221
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
3218 @subsubsection Fortran-Specific Indentation and Filling Commands |
25829 | 3219 |
3220 @table @kbd | |
3221 @item C-M-j | |
27221
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
3222 Break the current line and set up a continuation line |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
3223 (@code{fortran-split-line}). |
25829 | 3224 @item M-^ |
27221
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
3225 Join this line to the previous line (@code{fortran-join-line}). |
25829 | 3226 @item C-M-q |
3227 Indent all the lines of the subprogram point is in | |
3228 (@code{fortran-indent-subprogram}). | |
27221
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
3229 @item M-q |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
3230 Fill a comment block or statement. |
25829 | 3231 @end table |
3232 | |
3233 @kindex C-M-q @r{(Fortran mode)} | |
3234 @findex fortran-indent-subprogram | |
3235 The key @kbd{C-M-q} runs @code{fortran-indent-subprogram}, a command | |
3236 to reindent all the lines of the Fortran subprogram (function or | |
3237 subroutine) containing point. | |
3238 | |
3239 @kindex C-M-j @r{(Fortran mode)} | |
3240 @findex fortran-split-line | |
3241 The key @kbd{C-M-j} runs @code{fortran-split-line}, which splits | |
3242 a line in the appropriate fashion for Fortran. In a non-comment line, | |
3243 the second half becomes a continuation line and is indented | |
3244 accordingly. In a comment line, both halves become separate comment | |
3245 lines. | |
3246 | |
3247 @kindex M-^ @r{(Fortran mode)} | |
26106 | 3248 @kindex C-c C-d @r{(Fortran mode)} |
3249 @findex fortran-join-line | |
27221
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
3250 @kbd{M-^} or @kbd{C-c C-d} runs the command @code{fortran-join-line}, |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
3251 which joins a continuation line back to the previous line, roughly as |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
3252 the inverse of @code{fortran-split-line}. The point must be on a |
26106 | 3253 continuation line when this command is invoked. |
3254 | |
27221
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
3255 @kindex M-q @r{(Fortran mode)} |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
3256 Fortran mode defines the function for filling paragraphs such that |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
3257 @kbd{M-q} fills the comment block or statement around point. Filling a |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
3258 statement removes excess statement continuations. |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
3259 |
25829 | 3260 @node ForIndent Cont |
3261 @subsubsection Continuation Lines | |
3262 @cindex Fortran continuation lines | |
3263 | |
3264 @vindex fortran-continuation-string | |
3265 Most modern Fortran compilers allow two ways of writing continuation | |
3266 lines. If the first non-space character on a line is in column 5, then | |
3267 that line is a continuation of the previous line. We call this | |
3268 @dfn{fixed format}. (In GNU Emacs we always count columns from 0.) The | |
3269 variable @code{fortran-continuation-string} specifies what character to | |
3270 put on column 5. A line that starts with a tab character followed by | |
3271 any digit except @samp{0} is also a continuation line. We call this | |
3272 style of continuation @dfn{tab format}. | |
3273 | |
3274 @vindex indent-tabs-mode @r{(Fortran mode)} | |
3275 Fortran mode can make either style of continuation line, but you | |
3276 must specify which one you prefer. The value of the variable | |
3277 @code{indent-tabs-mode} controls the choice: @code{nil} for fixed | |
3278 format, and non-@code{nil} for tab format. You can tell which style | |
3279 is presently in effect by the presence or absence of the string | |
3280 @samp{Tab} in the mode line. | |
3281 | |
3282 If the text on a line starts with the conventional Fortran | |
3283 continuation marker @samp{$}, or if it begins with any non-whitespace | |
3284 character in column 5, Fortran mode treats it as a continuation line. | |
3285 When you indent a continuation line with @key{TAB}, it converts the line | |
3286 to the current continuation style. When you split a Fortran statement | |
3287 with @kbd{C-M-j}, the continuation marker on the newline is created | |
3288 according to the continuation style. | |
3289 | |
3290 The setting of continuation style affects several other aspects of | |
3291 editing in Fortran mode. In fixed format mode, the minimum column | |
3292 number for the body of a statement is 6. Lines inside of Fortran | |
3293 blocks that are indented to larger column numbers always use only the | |
3294 space character for whitespace. In tab format mode, the minimum | |
3295 column number for the statement body is 8, and the whitespace before | |
3296 column 8 must always consist of one tab character. | |
3297 | |
3298 @vindex fortran-tab-mode-default | |
3299 @vindex fortran-analyze-depth | |
3300 When you enter Fortran mode for an existing file, it tries to deduce the | |
3301 proper continuation style automatically from the file contents. The first | |
3302 line that begins with either a tab character or six spaces determines the | |
3303 choice. The variable @code{fortran-analyze-depth} specifies how many lines | |
3304 to consider (at the beginning of the file); if none of those lines | |
3305 indicates a style, then the variable @code{fortran-tab-mode-default} | |
3306 specifies the style. If it is @code{nil}, that specifies fixed format, and | |
3307 non-@code{nil} specifies tab format. | |
3308 | |
3309 @node ForIndent Num | |
3310 @subsubsection Line Numbers | |
3311 | |
3312 If a number is the first non-whitespace in the line, Fortran | |
3313 indentation assumes it is a line number and moves it to columns 0 | |
3314 through 4. (Columns always count from 0 in GNU Emacs.) | |
3315 | |
3316 @vindex fortran-line-number-indent | |
3317 Line numbers of four digits or less are normally indented one space. | |
3318 The variable @code{fortran-line-number-indent} controls this; it | |
3319 specifies the maximum indentation a line number can have. Line numbers | |
3320 are indented to right-justify them to end in column 4 unless that would | |
3321 require more than this maximum indentation. The default value of the | |
3322 variable is 1. | |
3323 | |
3324 @vindex fortran-electric-line-number | |
3325 Simply inserting a line number is enough to indent it according to | |
3326 these rules. As each digit is inserted, the indentation is recomputed. | |
3327 To turn off this feature, set the variable | |
3328 @code{fortran-electric-line-number} to @code{nil}. Then inserting line | |
3329 numbers is like inserting anything else. | |
3330 | |
3331 @node ForIndent Conv | |
3332 @subsubsection Syntactic Conventions | |
3333 | |
3334 Fortran mode assumes that you follow certain conventions that simplify | |
3335 the task of understanding a Fortran program well enough to indent it | |
3336 properly: | |
3337 | |
3338 @itemize @bullet | |
3339 @item | |
3340 Two nested @samp{do} loops never share a @samp{continue} statement. | |
3341 | |
3342 @item | |
3343 Fortran keywords such as @samp{if}, @samp{else}, @samp{then}, @samp{do} | |
3344 and others are written without embedded whitespace or line breaks. | |
3345 | |
3346 Fortran compilers generally ignore whitespace outside of string | |
3347 constants, but Fortran mode does not recognize these keywords if they | |
3348 are not contiguous. Constructs such as @samp{else if} or @samp{end do} | |
3349 are acceptable, but the second word should be on the same line as the | |
3350 first and not on a continuation line. | |
3351 @end itemize | |
3352 | |
3353 @noindent | |
3354 If you fail to follow these conventions, the indentation commands may | |
3355 indent some lines unaesthetically. However, a correct Fortran program | |
3356 retains its meaning when reindented even if the conventions are not | |
3357 followed. | |
3358 | |
3359 @node ForIndent Vars | |
3360 @subsubsection Variables for Fortran Indentation | |
3361 | |
3362 @vindex fortran-do-indent | |
3363 @vindex fortran-if-indent | |
3364 @vindex fortran-structure-indent | |
3365 @vindex fortran-continuation-indent | |
3366 @vindex fortran-check-all-num@dots{} | |
3367 @vindex fortran-minimum-statement-indent@dots{} | |
3368 Several additional variables control how Fortran indentation works: | |
3369 | |
3370 @table @code | |
3371 @item fortran-do-indent | |
3372 Extra indentation within each level of @samp{do} statement (default 3). | |
3373 | |
3374 @item fortran-if-indent | |
3375 Extra indentation within each level of @samp{if} statement (default 3). | |
3376 This value is also used for extra indentation within each level of the | |
3377 Fortran 90 @samp{where} statement. | |
3378 | |
3379 @item fortran-structure-indent | |
3380 Extra indentation within each level of @samp{structure}, @samp{union}, or | |
3381 @samp{map} statements (default 3). | |
3382 | |
3383 @item fortran-continuation-indent | |
3384 Extra indentation for bodies of continuation lines (default 5). | |
3385 | |
3386 @item fortran-check-all-num-for-matching-do | |
3387 If this is @code{nil}, indentation assumes that each @samp{do} statement | |
3388 ends on a @samp{continue} statement. Therefore, when computing | |
3389 indentation for a statement other than @samp{continue}, it can save time | |
3390 by not checking for a @samp{do} statement ending there. If this is | |
3391 non-@code{nil}, indenting any numbered statement must check for a | |
3392 @samp{do} that ends there. The default is @code{nil}. | |
3393 | |
3394 @item fortran-blink-matching-if | |
3395 If this is @code{t}, indenting an @samp{endif} statement moves the | |
3396 cursor momentarily to the matching @samp{if} statement to show where it | |
3397 is. The default is @code{nil}. | |
3398 | |
3399 @item fortran-minimum-statement-indent-fixed | |
3400 Minimum indentation for fortran statements when using fixed format | |
3401 continuation line style. Statement bodies are never indented less than | |
3402 this much. The default is 6. | |
3403 | |
3404 @item fortran-minimum-statement-indent-tab | |
3405 Minimum indentation for fortran statements for tab format continuation line | |
3406 style. Statement bodies are never indented less than this much. The | |
3407 default is 8. | |
3408 @end table | |
3409 | |
3410 @node Fortran Comments | |
3411 @subsection Fortran Comments | |
3412 | |
3413 The usual Emacs comment commands assume that a comment can follow a line | |
3414 of code. In Fortran, the standard comment syntax requires an entire line | |
3415 to be just a comment. Therefore, Fortran mode replaces the standard Emacs | |
3416 comment commands and defines some new variables. | |
3417 | |
27221
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
3418 Fortran mode can also handle the Fortran90 comment syntax where comments |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
3419 start with @samp{!} and can follow other text. Because only some Fortran77 |
25829 | 3420 compilers accept this syntax, Fortran mode will not insert such comments |
3421 unless you have said in advance to do so. To do this, set the variable | |
3422 @code{comment-start} to @samp{"!"} (@pxref{Variables}). | |
3423 | |
3424 @table @kbd | |
3425 @item M-; | |
3426 Align comment or insert new comment (@code{fortran-comment-indent}). | |
3427 | |
3428 @item C-x ; | |
3429 Applies to nonstandard @samp{!} comments only. | |
3430 | |
3431 @item C-c ; | |
3432 Turn all lines of the region into comments, or (with argument) turn them back | |
3433 into real code (@code{fortran-comment-region}). | |
3434 @end table | |
3435 | |
3436 @kbd{M-;} in Fortran mode is redefined as the command | |
3437 @code{fortran-comment-indent}. Like the usual @kbd{M-;} command, this | |
3438 recognizes any kind of existing comment and aligns its text appropriately; | |
3439 if there is no existing comment, a comment is inserted and aligned. But | |
3440 inserting and aligning comments are not the same in Fortran mode as in | |
3441 other modes. | |
3442 | |
3443 When a new comment must be inserted, if the current line is blank, a | |
3444 full-line comment is inserted. On a non-blank line, a nonstandard @samp{!} | |
3445 comment is inserted if you have said you want to use them. Otherwise a | |
3446 full-line comment is inserted on a new line before the current line. | |
3447 | |
3448 Nonstandard @samp{!} comments are aligned like comments in other | |
3449 languages, but full-line comments are different. In a standard full-line | |
3450 comment, the comment delimiter itself must always appear in column zero. | |
3451 What can be aligned is the text within the comment. You can choose from | |
3452 three styles of alignment by setting the variable | |
3453 @code{fortran-comment-indent-style} to one of these values: | |
3454 | |
3455 @vindex fortran-comment-indent-style | |
3456 @vindex fortran-comment-line-extra-indent | |
3457 @table @code | |
3458 @item fixed | |
3459 Align the text at a fixed column, which is the sum of | |
3460 @code{fortran-comment-line-extra-indent} and the minimum statement | |
3461 indentation. This is the default. | |
3462 | |
3463 The minimum statement indentation is | |
3464 @code{fortran-minimum-statement-indent-fixed} for fixed format | |
3465 continuation line style and @code{fortran-minimum-statement-indent-tab} | |
3466 for tab format style. | |
3467 | |
3468 @item relative | |
3469 Align the text as if it were a line of code, but with an additional | |
3470 @code{fortran-comment-line-extra-indent} columns of indentation. | |
3471 | |
3472 @item nil | |
3473 Don't move text in full-line comments automatically at all. | |
3474 @end table | |
3475 | |
3476 @vindex fortran-comment-indent-char | |
3477 In addition, you can specify the character to be used to indent within | |
3478 full-line comments by setting the variable | |
3479 @code{fortran-comment-indent-char} to the single-character string you want | |
3480 to use. | |
3481 | |
3482 @vindex comment-line-start | |
3483 @vindex comment-line-start-skip | |
3484 Fortran mode introduces two variables @code{comment-line-start} and | |
3485 @code{comment-line-start-skip}, which play for full-line comments the same | |
3486 roles played by @code{comment-start} and @code{comment-start-skip} for | |
3487 ordinary text-following comments. Normally these are set properly by | |
3488 Fortran mode, so you do not need to change them. | |
3489 | |
3490 The normal Emacs comment command @kbd{C-x ;} has not been redefined. If | |
3491 you use @samp{!} comments, this command can be used with them. Otherwise | |
3492 it is useless in Fortran mode. | |
3493 | |
3494 @kindex C-c ; @r{(Fortran mode)} | |
3495 @findex fortran-comment-region | |
3496 @vindex fortran-comment-region | |
3497 The command @kbd{C-c ;} (@code{fortran-comment-region}) turns all the | |
3498 lines of the region into comments by inserting the string @samp{C$$$} at | |
3499 the front of each one. With a numeric argument, it turns the region | |
3500 back into live code by deleting @samp{C$$$} from the front of each line | |
3501 in it. The string used for these comments can be controlled by setting | |
3502 the variable @code{fortran-comment-region}. Note that here we have an | |
3503 example of a command and a variable with the same name; these two uses | |
3504 of the name never conflict because in Lisp and in Emacs it is always | |
3505 clear from the context which one is meant. | |
3506 | |
3507 @node Fortran Autofill | |
3508 @subsection Fortran Auto Fill Mode | |
3509 | |
3510 Fortran Auto Fill mode is a minor mode which automatically splits | |
3511 Fortran statements as you insert them when they become too wide. | |
3512 Splitting a statement involves making continuation lines using | |
3513 @code{fortran-continuation-string} (@pxref{ForIndent Cont}). This | |
3514 splitting happens when you type @key{SPC}, @key{RET}, or @key{TAB}, and | |
3515 also in the Fortran indentation commands. | |
3516 | |
3517 @findex fortran-auto-fill-mode | |
3518 @kbd{M-x fortran-auto-fill-mode} turns Fortran Auto Fill mode on if it | |
3519 was off, or off if it was on. This command works the same as @kbd{M-x | |
3520 auto-fill-mode} does for normal Auto Fill mode (@pxref{Filling}). A | |
3521 positive numeric argument turns Fortran Auto Fill mode on, and a | |
3522 negative argument turns it off. You can see when Fortran Auto Fill mode | |
3523 is in effect by the presence of the word @samp{Fill} in the mode line, | |
3524 inside the parentheses. Fortran Auto Fill mode is a minor mode, turned | |
3525 on or off for each buffer individually. @xref{Minor Modes}. | |
3526 | |
3527 @vindex fortran-break-before-delimiters | |
3528 Fortran Auto Fill mode breaks lines at spaces or delimiters when the | |
3529 lines get longer than the desired width (the value of @code{fill-column}). | |
3530 The delimiters that Fortran Auto Fill mode may break at are @samp{,}, | |
3531 @samp{'}, @samp{+}, @samp{-}, @samp{/}, @samp{*}, @samp{=}, and @samp{)}. | |
3532 The line break comes after the delimiter if the variable | |
3533 @code{fortran-break-before-delimiters} is @code{nil}. Otherwise (and by | |
3534 default), the break comes before the delimiter. | |
3535 | |
3536 By default, Fortran Auto Fill mode is not enabled. If you want this | |
3537 feature turned on permanently, add a hook function to | |
3538 @code{fortran-mode-hook} to execute @code{(fortran-auto-fill-mode 1)}. | |
3539 @xref{Hooks}. | |
3540 | |
3541 @node Fortran Columns | |
3542 @subsection Checking Columns in Fortran | |
3543 | |
3544 @table @kbd | |
3545 @item C-c C-r | |
3546 Display a ``column ruler'' momentarily above the current line | |
3547 (@code{fortran-column-ruler}). | |
3548 @item C-c C-w | |
3549 Split the current window horizontally temporarily so that it is 72 | |
3550 columns wide. This may help you avoid making lines longer than the | |
3551 72-character limit that some Fortran compilers impose | |
3552 (@code{fortran-window-create-momentarily}). | |
3553 @end table | |
3554 | |
3555 @kindex C-c C-r @r{(Fortran mode)} | |
3556 @findex fortran-column-ruler | |
3557 @vindex fortran-column-ruler | |
3558 The command @kbd{C-c C-r} (@code{fortran-column-ruler}) shows a column | |
3559 ruler momentarily above the current line. The comment ruler is two lines | |
3560 of text that show you the locations of columns with special significance in | |
3561 Fortran programs. Square brackets show the limits of the columns for line | |
3562 numbers, and curly brackets show the limits of the columns for the | |
3563 statement body. Column numbers appear above them. | |
3564 | |
3565 Note that the column numbers count from zero, as always in GNU Emacs. | |
3566 As a result, the numbers may be one less than those you are familiar | |
3567 with; but the positions they indicate in the line are standard for | |
3568 Fortran. | |
3569 | |
26264 | 3570 The text used to display the column ruler depends on the value of |
25829 | 3571 the variable @code{indent-tabs-mode}. If @code{indent-tabs-mode} is |
3572 @code{nil}, then the value of the variable | |
3573 @code{fortran-column-ruler-fixed} is used as the column ruler. | |
3574 Otherwise, the variable @code{fortran-column-ruler-tab} is displayed. | |
3575 By changing these variables, you can change the column ruler display. | |
3576 | |
26106 | 3577 @kindex C-u C-c C-w @r{(Fortran mode)} |
25829 | 3578 @findex fortran-window-create |
26106 | 3579 For even more help, use @kbd{M-x fortran-window-create}), a |
25829 | 3580 command which splits the current window horizontally, making a window 72 |
3581 columns wide. By editing in this window you can immediately see when you | |
3582 make a line too wide to be correct Fortran. | |
3583 | |
26106 | 3584 @kindex C-c C-w @r{(Fortran mode)} |
3585 @findex fortran-window-create-momentarily | |
3586 Also, @kbd{C-c C-w} (@code{fortran-window-create-momentarily}) can be | |
3587 used temporarily to split the current window horizontally, making a | |
3588 window 72 columns wide to check column widths rather than to edit in | |
3589 this mode. The normal width is restored when you type a space. | |
3590 | |
25829 | 3591 @node Fortran Abbrev |
3592 @subsection Fortran Keyword Abbrevs | |
3593 | |
3594 Fortran mode provides many built-in abbrevs for common keywords and | |
3595 declarations. These are the same sort of abbrev that you can define | |
3596 yourself. To use them, you must turn on Abbrev mode. @xref{Abbrevs}. | |
3597 | |
3598 The built-in abbrevs are unusual in one way: they all start with a | |
3599 semicolon. You cannot normally use semicolon in an abbrev, but Fortran | |
3600 mode makes this possible by changing the syntax of semicolon to ``word | |
3601 constituent.'' | |
3602 | |
3603 For example, one built-in Fortran abbrev is @samp{;c} for | |
3604 @samp{continue}. If you insert @samp{;c} and then insert a punctuation | |
3605 character such as a space or a newline, the @samp{;c} expands automatically | |
3606 to @samp{continue}, provided Abbrev mode is enabled.@refill | |
3607 | |
3608 Type @samp{;?} or @samp{;C-h} to display a list of all the built-in | |
3609 Fortran abbrevs and what they stand for. | |
3610 | |
3611 @node Fortran Misc | |
3612 @subsection Other Fortran Mode Commands | |
3613 | |
27221
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
3614 The command @kbd{fortran-strip-sqeuence-nos} can be used to remove text |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
3615 past Fortran column 72, which is typically old `sequence numbers'. |
25829 | 3616 |
3617 @node Asm Mode | |
3618 @section Asm Mode | |
3619 | |
3620 @cindex Asm mode | |
26106 | 3621 @cindex Assembler mode |
25829 | 3622 Asm mode is a major mode for editing files of assembler code. It |
3623 defines these commands: | |
3624 | |
3625 @table @kbd | |
3626 @item @key{TAB} | |
3627 @code{tab-to-tab-stop}. | |
3628 @item C-j | |
3629 Insert a newline and then indent using @code{tab-to-tab-stop}. | |
3630 @item : | |
3631 Insert a colon and then remove the indentation from before the label | |
3632 preceding colon. Then do @code{tab-to-tab-stop}. | |
3633 @item ; | |
3634 Insert or align a comment. | |
3635 @end table | |
3636 | |
3637 The variable @code{asm-comment-char} specifies which character | |
3638 starts comments in assembler syntax. |