annotate man/programs.texi @ 33411:a873b191d4c5

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