annotate man/programs.texi @ 64883:848c94718037

*** empty log message ***
author Richard M. Stallman <rms@gnu.org>
date Tue, 09 Aug 2005 23:54:01 +0000
parents 8db373573379
children 3723093a21fd f042e7c0fe20
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.
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2 @c Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1997, 1999, 2000,
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
3 @c 2001, 2005 Free Software Foundation, Inc.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4 @c See file emacs.texi for copying conditions.
Dave Love <fx@gnu.org>
parents:
diff changeset
5 @node Programs, Building, Text, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
6 @chapter Editing Programs
Dave Love <fx@gnu.org>
parents:
diff changeset
7 @cindex Lisp editing
Dave Love <fx@gnu.org>
parents:
diff changeset
8 @cindex C editing
Dave Love <fx@gnu.org>
parents:
diff changeset
9 @cindex program editing
Dave Love <fx@gnu.org>
parents:
diff changeset
10
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
11 Emacs provides many features to facilitate editing programs. Some
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
12 of these features can
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
13
Dave Love <fx@gnu.org>
parents:
diff changeset
14 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
15 @item
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
16 Find or move over top-level definitions (@pxref{Defuns}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
17 @item
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
18 Apply the usual indentation conventions of the language
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
19 (@pxref{Program Indent}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
20 @item
59371
364d233a8dc3 Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents: 56809
diff changeset
21 Balance parentheses (@pxref{Parentheses}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
22 @item
59371
364d233a8dc3 Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents: 56809
diff changeset
23 Insert, kill or align comments (@pxref{Comments}).
38136
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
24 @item
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
25 Highlight program syntax (@pxref{Font Lock}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
26 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
27
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
28 This chapter describes these features and many more.
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
29
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
30 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
31 * Program Modes:: Major modes for editing programs.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
32 * Defuns:: Commands to operate on major top-level parts
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
33 of a program.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
34 * Program Indent:: Adjusting indentation to show the nesting.
56809
bc1eb92f6563 Interchange nodes (for correct numbering).
Luc Teirlinck <teirllm@auburn.edu>
parents: 56164
diff changeset
35 * Parentheses:: Commands that operate on parentheses.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
36 * Comments:: Inserting, killing, and aligning comments.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
37 * Documentation:: Getting documentation of functions you plan to call.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
38 * Hideshow:: Displaying blocks selectively.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
39 * Symbol Completion:: Completion on symbol names of your program or language.
30810
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
40 * Glasses:: Making identifiersLikeThis more readable.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
41 * Misc for Programs:: Other Emacs features useful for editing programs.
26264
Francesco Potortì <pot@gnu.org>
parents: 26106
diff changeset
42 * C Modes:: Special commands of C, C++, Objective-C,
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
43 Java, and Pike modes.
28329
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
44 * Fortran:: Fortran mode and its special features.
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
45 * Asm Mode:: Asm mode and its special features.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
46 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
47
Dave Love <fx@gnu.org>
parents:
diff changeset
48 @node Program Modes
Dave Love <fx@gnu.org>
parents:
diff changeset
49 @section Major Modes for Programming Languages
Dave Love <fx@gnu.org>
parents:
diff changeset
50 @cindex modes for programming languages
38136
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
51
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
52 Emacs has specialized major modes for various programming languages.
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
53 @xref{Major Modes}. A programming language major mode typically
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
54 specifies the syntax of expressions, the customary rules for
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
55 indentation, how to do syntax highlighting for the language, and how
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
56 to find the beginning of a function definition. It often customizes
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
57 or provides facilities for compiling and debugging programs as well.
38136
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
58
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
59 Ideally, Emacs should provide a major mode for each programming
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
60 language that you might want to edit; if it doesn't have a mode for
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
61 your favorite language, you can contribute one. But often the mode
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
62 for one language can serve for other syntactically similar languages.
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
63 The major mode for language @var{l} is called @code{@var{l}-mode},
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
64 and you can select it by typing @kbd{M-x @var{l}-mode @key{RET}}.
38136
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
65 @xref{Choosing Modes}.
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
66
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
67 @cindex Perl mode
Dave Love <fx@gnu.org>
parents:
diff changeset
68 @cindex Icon mode
Dave Love <fx@gnu.org>
parents:
diff changeset
69 @cindex Makefile mode
Dave Love <fx@gnu.org>
parents:
diff changeset
70 @cindex Tcl mode
Dave Love <fx@gnu.org>
parents:
diff changeset
71 @cindex CPerl mode
26106
19c8f63a59f1 List additional modes.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
72 @cindex DSSSL mode
19c8f63a59f1 List additional modes.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
73 @cindex Octave mode
19c8f63a59f1 List additional modes.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
74 @cindex Metafont mode
19c8f63a59f1 List additional modes.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
75 @cindex Modula2 mode
19c8f63a59f1 List additional modes.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
76 @cindex Prolog mode
60112
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
77 @cindex Python mode
26106
19c8f63a59f1 List additional modes.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
78 @cindex Simula mode
19c8f63a59f1 List additional modes.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
79 @cindex VHDL mode
19c8f63a59f1 List additional modes.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
80 @cindex M4 mode
19c8f63a59f1 List additional modes.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
81 @cindex Shell-script mode
30810
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
82 @cindex Delphi mode
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
83 @cindex PostScript mode
61053
bfca4745d9a3 (Program Modes): Add Conf mode and DNS mode.
Richard M. Stallman <rms@gnu.org>
parents: 61022
diff changeset
84 @cindex Conf mode
bfca4745d9a3 (Program Modes): Add Conf mode and DNS mode.
Richard M. Stallman <rms@gnu.org>
parents: 61022
diff changeset
85 @cindex DNS mode
38136
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
86 The existing programming language major modes include Lisp, Scheme (a
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
87 variant of Lisp) and the Scheme-based DSSSL expression language, Ada,
59371
364d233a8dc3 Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents: 56809
diff changeset
88 ASM, AWK, C, C++, Delphi (Object Pascal), Fortran (free format and fixed
38136
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
89 format), Icon, IDL (CORBA), IDLWAVE, Java, Metafont (@TeX{}'s
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
90 companion for font creation), Modula2, Objective-C, Octave, Pascal,
61053
bfca4745d9a3 (Program Modes): Add Conf mode and DNS mode.
Richard M. Stallman <rms@gnu.org>
parents: 61022
diff changeset
91 Perl, Pike, PostScript, Prolog, Python, Simula, Tcl, and VHDL. An
bfca4745d9a3 (Program Modes): Add Conf mode and DNS mode.
Richard M. Stallman <rms@gnu.org>
parents: 61022
diff changeset
92 alternative mode for Perl is called CPerl mode. Modes are available for
bfca4745d9a3 (Program Modes): Add Conf mode and DNS mode.
Richard M. Stallman <rms@gnu.org>
parents: 61022
diff changeset
93 the scripting languages of the common GNU and Unix shells, VMS DCL, and
38136
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
94 MS-DOS/MS-Windows @samp{BAT} files. There are also major modes for
61053
bfca4745d9a3 (Program Modes): Add Conf mode and DNS mode.
Richard M. Stallman <rms@gnu.org>
parents: 61022
diff changeset
95 editing makefiles, DNS master files, and various sorts of configuration
bfca4745d9a3 (Program Modes): Add Conf mode and DNS mode.
Richard M. Stallman <rms@gnu.org>
parents: 61022
diff changeset
96 files.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
97
Dave Love <fx@gnu.org>
parents:
diff changeset
98 @kindex DEL @r{(programming modes)}
37978
c41356c953a0 Correct names of some C mode indentation commands.
Richard M. Stallman <rms@gnu.org>
parents: 37868
diff changeset
99 @findex c-electric-backspace
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
100 In most programming languages, indentation should vary from line to
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
101 line to illustrate the structure of the program. So the major modes
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
102 for programming languages arrange for @key{TAB} to update the
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
103 indentation of the current line. They also rebind @key{DEL} to treat
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
104 a tab as if it were the equivalent number of spaces; this lets you
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
105 delete one column of indentation without worrying whether the
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
106 whitespace consists of spaces or tabs. Use @kbd{C-b C-d} to delete a
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
107 tab character before point, in these modes.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
108
38136
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
109 Separate manuals are available for the modes for Ada (@pxref{Top, , Ada
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
110 Mode, ada-mode, Ada Mode}), C/C++/Objective C/Java/Corba IDL/Pike/AWK
38136
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
111 (@pxref{Top, , CC Mode, ccmode, CC Mode}) and the IDLWAVE modes
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
112 (@pxref{Top, , IDLWAVE, idlwave, IDLWAVE User Manual}).
38122
4aeb215906f3 Proofreading fixes from Peter Milliken <Peter.Milliken@GTECH.COM>.
Eli Zaretskii <eliz@gnu.org>
parents: 38090
diff changeset
113
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
114 @cindex mode hook
Dave Love <fx@gnu.org>
parents:
diff changeset
115 @vindex c-mode-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
116 @vindex lisp-mode-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
117 @vindex emacs-lisp-mode-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
118 @vindex lisp-interaction-mode-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
119 @vindex scheme-mode-hook
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
120 Turning on a major mode runs a normal hook called the @dfn{mode
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
121 hook}, which is the value of a Lisp variable. Each major mode has a
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
122 mode hook, and the hook's name is always made from the mode command's
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
123 name by adding @samp{-hook}. For example, turning on C mode runs the
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
124 hook @code{c-mode-hook}, while turning on Lisp mode runs the hook
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
125 @code{lisp-mode-hook}. The purpose of the mode hook is to give you a
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
126 place to set up customizations for that major mode. @xref{Hooks}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
127
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
128 @node Defuns
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
129 @section Top-Level Definitions, or Defuns
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
130
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
131 In Emacs, a major definition at the top level in the buffer is
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
132 called a @dfn{defun}. The name comes from Lisp, but in Emacs we use
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
133 it for all languages.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
134
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
135 In most programming language modes, Emacs assumes that a defun is
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
136 any pair of parentheses (or braces, if the language uses braces this
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
137 way) that starts at the left margin. For example, in C, the body of a
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
138 function definition is normally a defun, because the open-brace that
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
139 begins it is normally at the left margin. A variable's initializer
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
140 can also count as a defun, if the open-brace that begins the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
141 initializer is at the left margin.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
142
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
143 However, some language modes provide their own code for recognizing
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
144 defuns in a way that suits the language syntax and conventions better.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
145
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
146 @menu
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
147 * Left Margin Paren:: An open-paren or similar opening delimiter
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
148 starts a defun if it is at the left margin.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
149 * Moving by Defuns:: Commands to move over or mark a major definition.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
150 * Imenu:: Making buffer indexes as menus.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
151 * Which Function:: Which Function mode shows which function you are in.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
152 @end menu
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
153
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
154 @node Left Margin Paren
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
155 @subsection Left Margin Convention
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
156
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
157 @cindex open-parenthesis in leftmost column
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
158 @cindex ( in leftmost column
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
159 In most major modes, Emacs assumes that any opening delimiter found
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
160 at the left margin is the start of a top-level definition, or defun.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
161 Therefore, @strong{never put an opening delimiter at the left margin
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
162 unless it should have that significance.} For instance, never put an
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
163 open-parenthesis at the left margin in a Lisp file unless it is the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
164 start of a top-level list. Never put an open-brace or other opening
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
165 delimiter at the beginning of a line of C code unless it is at top
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
166 level.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
167
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
168 If you don't follow this convention, not only will you have trouble
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
169 when you explicitly use the commands for motion by defuns; other
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
170 features that use them will also give you trouble. This includes
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
171 the indentation commands (@pxref{Program Indent}) and Font Lock
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
172 mode (@pxref{Font Lock}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
173
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
174 The most likely problem case is when you want an opening delimiter
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
175 at the start of a line inside a string. To avoid trouble, put an
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
176 escape character (@samp{\}, in C and Emacs Lisp, @samp{/} in some
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
177 other Lisp dialects) before the opening delimiter. This will not
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
178 affect the contents of the string, but will prevent that opening
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
179 delimiter from starting a defun. Here's an example:
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
180
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
181 @example
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
182 (insert "Foo:
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
183 \(bar)
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
184 ")
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
185 @end example
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
186
46035
11e7a6a33a8c Explain font lock highlighting of opening delims that should be quoted.
Richard M. Stallman <rms@gnu.org>
parents: 45997
diff changeset
187 To help you catch violations of this convention, Font Lock mode
11e7a6a33a8c Explain font lock highlighting of opening delims that should be quoted.
Richard M. Stallman <rms@gnu.org>
parents: 45997
diff changeset
188 highlights confusing opening delimiters (those that ought to be
11e7a6a33a8c Explain font lock highlighting of opening delims that should be quoted.
Richard M. Stallman <rms@gnu.org>
parents: 45997
diff changeset
189 quoted) in bold red.
11e7a6a33a8c Explain font lock highlighting of opening delims that should be quoted.
Richard M. Stallman <rms@gnu.org>
parents: 45997
diff changeset
190
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
191 In the earliest days, the original Emacs found defuns by moving
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
192 upward a level of parentheses or braces until there were no more
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
193 levels to go up. This always required scanning all the way back to
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
194 the beginning of the buffer, even for a small function. To speed up
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
195 the operation, we changed Emacs to assume that any opening delimiter
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
196 at the left margin is the start of a defun. This heuristic is nearly
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
197 always right, and avoids the need to scan back to the beginning of the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
198 buffer. However, it mandates following the convention described
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
199 above.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
200
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
201 @node Moving by Defuns
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
202 @subsection Moving by Defuns
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
203 @cindex defuns
Dave Love <fx@gnu.org>
parents:
diff changeset
204
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
205 These commands move point or set up the region based on top-level
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
206 major definitions, also called @dfn{defuns}.
38123
af8117970ca7 More proofreading fixes from Peter Milliken.
Eli Zaretskii <eliz@gnu.org>
parents: 38122
diff changeset
207
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
208 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
209 @item C-M-a
Dave Love <fx@gnu.org>
parents:
diff changeset
210 Move to beginning of current or preceding defun
Dave Love <fx@gnu.org>
parents:
diff changeset
211 (@code{beginning-of-defun}).
Dave Love <fx@gnu.org>
parents:
diff changeset
212 @item C-M-e
Dave Love <fx@gnu.org>
parents:
diff changeset
213 Move to end of current or following defun (@code{end-of-defun}).
Dave Love <fx@gnu.org>
parents:
diff changeset
214 @item C-M-h
Dave Love <fx@gnu.org>
parents:
diff changeset
215 Put region around whole current or following defun (@code{mark-defun}).
Dave Love <fx@gnu.org>
parents:
diff changeset
216 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
217
38164
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
218 @cindex move to beginning or end of function
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
219 @cindex function, move to beginning or end
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
220 @kindex C-M-a
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
221 @kindex C-M-e
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
222 @kindex C-M-h
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
223 @findex beginning-of-defun
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
224 @findex end-of-defun
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
225 @findex mark-defun
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
226 The commands to move to the beginning and end of the current defun
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
227 are @kbd{C-M-a} (@code{beginning-of-defun}) and @kbd{C-M-e}
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
228 (@code{end-of-defun}). If you repeat one of these commands, or use a
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
229 positive numeric argument, each repetition moves to the next defun in
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
230 the direction of motion.
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
231
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
232 @kbd{C-M-a} with a negative argument @minus{}@var{n} moves forward
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
233 @var{n} times to the next beginning of a defun. This is not exactly
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
234 the same place that @kbd{C-M-e} with argument @var{n} would move to;
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
235 the end of this defun is not usually exactly the same place as the
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
236 beginning of the following defun. (Whitespace, comments, and perhaps
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
237 declarations can separate them.) Likewise, @kbd{C-M-e} with a
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
238 negative argument moves back to an end of a defun, which is not quite
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
239 the same as @kbd{C-M-a} with a positive argument.
38164
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
240
36263
11db0318031d Remove redundant index entries.
Eli Zaretskii <eliz@gnu.org>
parents: 36198
diff changeset
241 @kindex C-M-h @r{(C mode)}
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
242 @findex c-mark-function
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
243 To operate on the current defun, use @kbd{C-M-h} (@code{mark-defun})
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
244 which puts point at the beginning and mark at the end of the current
38238
6d50c21307ed Minor clarifications. Explain how to use imenu-sort-function.
Richard M. Stallman <rms@gnu.org>
parents: 38231
diff changeset
245 defun. This is the easiest way to get ready to kill the defun in
6d50c21307ed Minor clarifications. Explain how to use imenu-sort-function.
Richard M. Stallman <rms@gnu.org>
parents: 38231
diff changeset
246 order to move it to a different place in the file. If you use the
6d50c21307ed Minor clarifications. Explain how to use imenu-sort-function.
Richard M. Stallman <rms@gnu.org>
parents: 38231
diff changeset
247 command while point is between defuns, it uses the following defun.
60112
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
248 Successive uses of @kbd{C-M-h}, or using it in Transient Mark mode
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
249 when the mark is active, includes an additional defun in the region
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
250 each time.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
251
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
252 In C mode, @kbd{C-M-h} runs the function @code{c-mark-function},
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
253 which is almost the same as @code{mark-defun}; the difference is that
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
254 it backs up over the argument declarations, function name and returned
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
255 data type so that the entire C function is inside the region. This is
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
256 an example of how major modes adjust the standard key bindings so that
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
257 they do their standard jobs in a way better fitting a particular
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
258 language. Other major modes may replace any or all of these key
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
259 bindings for that purpose.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
260
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
261 @node Imenu
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
262 @subsection Imenu
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
263 @cindex index of buffer definitions
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
264 @cindex buffer definitions index
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
265 @cindex tags
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
266
42675
640c0fcaebf1 Fix typos.
Pavel Janík <Pavel@Janik.cz>
parents: 41495
diff changeset
267 The Imenu facility offers a way to find the major definitions in
38238
6d50c21307ed Minor clarifications. Explain how to use imenu-sort-function.
Richard M. Stallman <rms@gnu.org>
parents: 38231
diff changeset
268 a file by name. It is also useful in text formatter major modes,
6d50c21307ed Minor clarifications. Explain how to use imenu-sort-function.
Richard M. Stallman <rms@gnu.org>
parents: 38231
diff changeset
269 where it treats each chapter, section, etc., as a definition.
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
270 (@xref{Tags}, for a more powerful feature that handles multiple files
38238
6d50c21307ed Minor clarifications. Explain how to use imenu-sort-function.
Richard M. Stallman <rms@gnu.org>
parents: 38231
diff changeset
271 together.)
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
272
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
273 @findex imenu
38238
6d50c21307ed Minor clarifications. Explain how to use imenu-sort-function.
Richard M. Stallman <rms@gnu.org>
parents: 38231
diff changeset
274 If you type @kbd{M-x imenu}, it reads the name of a definition using
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
275 the minibuffer, then moves point to that definition. You can use
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
276 completion to specify the name; the command always displays the whole
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
277 list of valid names.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
278
38238
6d50c21307ed Minor clarifications. Explain how to use imenu-sort-function.
Richard M. Stallman <rms@gnu.org>
parents: 38231
diff changeset
279 @findex imenu-add-menubar-index
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
280 Alternatively, you can bind the command @code{imenu} to a mouse
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
281 click. Then it displays mouse menus for you to select a definition
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
282 name. You can also add the buffer's index to the menu bar by calling
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
283 @code{imenu-add-menubar-index}. If you want to have this menu bar
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
284 item available for all buffers in a certain major mode, you can do
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
285 this by adding @code{imenu-add-menubar-index} to its mode hook. But
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
286 if you have done that, you will have to wait each time you visit a
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
287 file in that mode, while Emacs finds all the definitions in that
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
288 buffer.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
289
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
290 @vindex imenu-auto-rescan
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
291 When you change the contents of a buffer, if you add or delete
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
292 definitions, you can update the buffer's index based on the
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
293 new contents by invoking the @samp{*Rescan*} item in the menu.
39063
6ecd6d3c0630 (Imenu): Fix a typo.
Eli Zaretskii <eliz@gnu.org>
parents: 38946
diff changeset
294 Rescanning happens automatically if you set @code{imenu-auto-rescan} to
6ecd6d3c0630 (Imenu): Fix a typo.
Eli Zaretskii <eliz@gnu.org>
parents: 38946
diff changeset
295 a non-@code{nil} value. There is no need to rescan because of small
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
296 changes in the text.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
297
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
298 @vindex imenu-sort-function
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
299 You can customize the way the menus are sorted by setting the
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
300 variable @code{imenu-sort-function}. By default, names are ordered as
38238
6d50c21307ed Minor clarifications. Explain how to use imenu-sort-function.
Richard M. Stallman <rms@gnu.org>
parents: 38231
diff changeset
301 they occur in the buffer; if you want alphabetic sorting, use the
6d50c21307ed Minor clarifications. Explain how to use imenu-sort-function.
Richard M. Stallman <rms@gnu.org>
parents: 38231
diff changeset
302 symbol @code{imenu--sort-by-name} as the value. You can also
6d50c21307ed Minor clarifications. Explain how to use imenu-sort-function.
Richard M. Stallman <rms@gnu.org>
parents: 38231
diff changeset
303 define your own comparison function by writing Lisp code.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
304
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
305 Imenu provides the information to guide Which Function mode
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
306 @ifnottex
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
307 (@pxref{Which Function}).
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
308 @end ifnottex
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
309 @iftex
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
310 (see below).
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
311 @end iftex
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
312 The Speedbar can also use it (@pxref{Speedbar}).
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
313
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
314 @node Which Function
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
315 @subsection Which Function Mode
40175
ba769a5fb855 (Which Function): Add a cindex entry.
Eli Zaretskii <eliz@gnu.org>
parents: 39063
diff changeset
316 @cindex current function name in mode line
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
317
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
318 Which Function mode is a minor mode that displays the current
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
319 function name in the mode line, updating it as you move around in a
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
320 buffer.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
321
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
322 @findex which-function-mode
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
323 @vindex which-func-modes
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
324 To enable (or disable) Which Function mode, use the command @kbd{M-x
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
325 which-function-mode}. This command is global; it applies to all
59371
364d233a8dc3 Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents: 56809
diff changeset
326 buffers, both existing ones and those yet to be created. However, it
59475
279e43932b6f (Multi-line Indent): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 59461
diff changeset
327 takes effect only in certain major modes, those listed in the value of
59371
364d233a8dc3 Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents: 56809
diff changeset
328 @code{which-func-modes}. If the value is @code{t}, then Which Function
364d233a8dc3 Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents: 56809
diff changeset
329 mode applies to all major modes that know how to support it---in other
364d233a8dc3 Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents: 56809
diff changeset
330 words, all the major modes that support Imenu.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
331
Dave Love <fx@gnu.org>
parents:
diff changeset
332 @node Program Indent
Dave Love <fx@gnu.org>
parents:
diff changeset
333 @section Indentation for Programs
Dave Love <fx@gnu.org>
parents:
diff changeset
334 @cindex indentation for programs
Dave Love <fx@gnu.org>
parents:
diff changeset
335
Dave Love <fx@gnu.org>
parents:
diff changeset
336 The best way to keep a program properly indented is to use Emacs to
Dave Love <fx@gnu.org>
parents:
diff changeset
337 reindent it as you change it. Emacs has commands to indent properly
Dave Love <fx@gnu.org>
parents:
diff changeset
338 either a single line, a specified number of lines, or all of the lines
Dave Love <fx@gnu.org>
parents:
diff changeset
339 inside a single parenthetical grouping.
Dave Love <fx@gnu.org>
parents:
diff changeset
340
Dave Love <fx@gnu.org>
parents:
diff changeset
341 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
342 * Basic Indent:: Indenting a single line.
Dave Love <fx@gnu.org>
parents:
diff changeset
343 * Multi-line Indent:: Commands to reindent many lines at once.
Dave Love <fx@gnu.org>
parents:
diff changeset
344 * Lisp Indent:: Specifying how each Lisp function should be indented.
Dave Love <fx@gnu.org>
parents:
diff changeset
345 * C Indent:: Extra features for indenting C and related modes.
Dave Love <fx@gnu.org>
parents:
diff changeset
346 * Custom C Indent:: Controlling indentation style for C and related modes.
Dave Love <fx@gnu.org>
parents:
diff changeset
347 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
348
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
349 @cindex pretty-printer
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
350 Emacs also provides a Lisp pretty-printer in the library @code{pp}.
Dave Love <fx@gnu.org>
parents:
diff changeset
351 This program reformats a Lisp object with indentation chosen to look nice.
Dave Love <fx@gnu.org>
parents:
diff changeset
352
Dave Love <fx@gnu.org>
parents:
diff changeset
353 @node Basic Indent
Dave Love <fx@gnu.org>
parents:
diff changeset
354 @subsection Basic Program Indentation Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
355
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
356 The basic indentation commands indent a single line according to the
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
357 usual conventions of the language you are editing.
38136
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
358
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
359 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
360 @item @key{TAB}
Dave Love <fx@gnu.org>
parents:
diff changeset
361 Adjust indentation of current line.
Dave Love <fx@gnu.org>
parents:
diff changeset
362 @item C-j
Dave Love <fx@gnu.org>
parents:
diff changeset
363 Equivalent to @key{RET} followed by @key{TAB} (@code{newline-and-indent}).
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
364 @item @key{LINEFEED}
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
365 This key, if the keyboard has it, is another way to enter @kbd{C-j}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
366 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
367
Dave Love <fx@gnu.org>
parents:
diff changeset
368 @kindex TAB @r{(programming modes)}
37978
c41356c953a0 Correct names of some C mode indentation commands.
Richard M. Stallman <rms@gnu.org>
parents: 37868
diff changeset
369 @findex c-indent-command
c41356c953a0 Correct names of some C mode indentation commands.
Richard M. Stallman <rms@gnu.org>
parents: 37868
diff changeset
370 @findex indent-line-function
38164
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
371 @findex indent-for-tab-command
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
372 The basic indentation command is @key{TAB}, which gives the current line
Dave Love <fx@gnu.org>
parents:
diff changeset
373 the correct indentation as determined from the previous lines. The
38136
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
374 function that @key{TAB} runs depends on the major mode; it is
59461
26a204697252 Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents: 59371
diff changeset
375 @code{lisp-indent-line}
37978
c41356c953a0 Correct names of some C mode indentation commands.
Richard M. Stallman <rms@gnu.org>
parents: 37868
diff changeset
376 in Lisp mode, @code{c-indent-command} in C mode, etc. These functions
38136
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
377 understand the syntax and conventions of different languages, but they all do
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
378 conceptually the same job: @key{TAB} in any programming-language major mode
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
379 inserts or deletes whitespace at the beginning of the current line,
38136
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
380 independent of where point is in the line. If point was inside the
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
381 whitespace at the beginning of the line, @key{TAB} puts it at the end of
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
382 that whitespace; otherwise, @key{TAB} keeps point fixed with respect to
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
383 the characters around it.
Dave Love <fx@gnu.org>
parents:
diff changeset
384
60112
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
385 Use @kbd{C-q @key{TAB}} to insert a tab character at point.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
386
Dave Love <fx@gnu.org>
parents:
diff changeset
387 @kindex C-j
Dave Love <fx@gnu.org>
parents:
diff changeset
388 @findex newline-and-indent
38136
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
389 When entering lines of new code, use @kbd{C-j}
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
390 (@code{newline-and-indent}), which is equivalent to a @key{RET}
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
391 followed by a @key{TAB}. @kbd{C-j} at the end of a line creates a
278f2295cde6 New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents: 38123
diff changeset
392 blank line and then gives it the appropriate indentation.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
393
60112
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
394 @key{TAB} indents a line that starts within a parenthetical grouping
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
395 under the preceding line within the grouping, or the text after the
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
396 parenthesis. Therefore, if you manually give one of these lines a
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
397 nonstandard indentation, the lines below will tend to follow it. This
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
398 behavior is convenient in cases where you have overridden the standard
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
399 result of @key{TAB} because you find it unaesthetic for a particular
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
400 line.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
401
Dave Love <fx@gnu.org>
parents:
diff changeset
402 Remember that an open-parenthesis, open-brace or other opening delimiter
Dave Love <fx@gnu.org>
parents:
diff changeset
403 at the left margin is assumed by Emacs (including the indentation routines)
Dave Love <fx@gnu.org>
parents:
diff changeset
404 to be the start of a function. Therefore, you must never have an opening
Dave Love <fx@gnu.org>
parents:
diff changeset
405 delimiter in column zero that is not the beginning of a function, not even
Dave Love <fx@gnu.org>
parents:
diff changeset
406 inside a string. This restriction is vital for making the indentation
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
407 commands fast; you must simply accept it. @xref{Left Margin Paren},
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
408 for more information on this.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
409
38009
b6036155d1ca (Basic Indent): Add a cross-reference to description of indent-tabs-mode.
Eli Zaretskii <eliz@gnu.org>
parents: 37997
diff changeset
410 Normally, lines are indented with tabs and spaces. If you want Emacs
b6036155d1ca (Basic Indent): Add a cross-reference to description of indent-tabs-mode.
Eli Zaretskii <eliz@gnu.org>
parents: 37997
diff changeset
411 to use spaces only, see @ref{Just Spaces}.
b6036155d1ca (Basic Indent): Add a cross-reference to description of indent-tabs-mode.
Eli Zaretskii <eliz@gnu.org>
parents: 37997
diff changeset
412
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
413 @node Multi-line Indent
Dave Love <fx@gnu.org>
parents:
diff changeset
414 @subsection Indenting Several Lines
Dave Love <fx@gnu.org>
parents:
diff changeset
415
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
416 When you wish to reindent several lines of code which have been
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
417 altered or moved to a different level in the parenthesis structure,
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
418 you have several commands available.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
419
Dave Love <fx@gnu.org>
parents:
diff changeset
420 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
421 @item C-M-q
59475
279e43932b6f (Multi-line Indent): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 59461
diff changeset
422 Reindent all the lines within one parenthetical grouping (@code{indent-pp-sexp}).
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
423 @item C-M-\
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
424 Reindent all lines in the region (@code{indent-region}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
425 @item C-u @key{TAB}
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
426 Shift an entire parenthetical grouping rigidly sideways so that its
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
427 first line is properly indented.
38149
a07facd0bdf8 (Multi-line Indent): Document indent-code-rigidly.
Eli Zaretskii <eliz@gnu.org>
parents: 38148
diff changeset
428 @item M-x indent-code-rigidly
a07facd0bdf8 (Multi-line Indent): Document indent-code-rigidly.
Eli Zaretskii <eliz@gnu.org>
parents: 38148
diff changeset
429 Shift all the lines in the region rigidly sideways, but do not alter
a07facd0bdf8 (Multi-line Indent): Document indent-code-rigidly.
Eli Zaretskii <eliz@gnu.org>
parents: 38148
diff changeset
430 lines that start inside comments and strings.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
431 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
432
Dave Love <fx@gnu.org>
parents:
diff changeset
433 @kindex C-M-q
59475
279e43932b6f (Multi-line Indent): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 59461
diff changeset
434 @findex indent-pp-sexp
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
435 You can reindent the contents of a single parenthetical grouping by
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
436 positioning point before the beginning of it and typing @kbd{C-M-q}
59461
26a204697252 Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents: 59371
diff changeset
437 (@code{indent-pp-sexp} in Lisp mode, @code{c-indent-exp} in C mode; also
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
438 bound to other suitable commands in other modes). The indentation of
59475
279e43932b6f (Multi-line Indent): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 59461
diff changeset
439 the line where the grouping starts is not changed; therefore this
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
440 changes only the relative indentation within the grouping, not its
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
441 overall indentation. To correct that as well, type @key{TAB} first.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
442
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
443 Another way to specify the range to be reindented is with the
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
444 region. The command @kbd{C-M-\} (@code{indent-region}) applies
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
445 @key{TAB} to every line whose first character is between point and
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
446 mark.
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
447
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
448 @kindex C-u TAB
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
449 If you like the relative indentation within a grouping, but not the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
450 indentation of its first line, you can type @kbd{C-u @key{TAB}} to
38323
1241890094ae C-u TAB works only in certain modes.
Richard M. Stallman <rms@gnu.org>
parents: 38287
diff changeset
451 reindent the whole grouping as a rigid unit. (This works in Lisp
1241890094ae C-u TAB works only in certain modes.
Richard M. Stallman <rms@gnu.org>
parents: 38287
diff changeset
452 modes and C and related modes.) @key{TAB} with a numeric argument
1241890094ae C-u TAB works only in certain modes.
Richard M. Stallman <rms@gnu.org>
parents: 38287
diff changeset
453 reindents the current line as usual, then reindents by the same amount
1241890094ae C-u TAB works only in certain modes.
Richard M. Stallman <rms@gnu.org>
parents: 38287
diff changeset
454 all the lines in the parenthetical grouping starting on the current
1241890094ae C-u TAB works only in certain modes.
Richard M. Stallman <rms@gnu.org>
parents: 38287
diff changeset
455 line. It is clever, though, and does not alter lines that start
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
456 inside strings. Neither does it alter C preprocessor lines when in C
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
457 mode, but it does reindent any continuation lines that may be attached
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
458 to them.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
459
38149
a07facd0bdf8 (Multi-line Indent): Document indent-code-rigidly.
Eli Zaretskii <eliz@gnu.org>
parents: 38148
diff changeset
460 @findex indent-code-rigidly
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
461 You can also perform this operation on the region, using the command
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
462 @kbd{M-x indent-code-rigidly}. It rigidly shifts all the lines in the
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
463 region sideways, like @code{indent-rigidly} does (@pxref{Indentation
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
464 Commands}). It doesn't alter the indentation of lines that start
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
465 inside a string, unless the region also starts inside that string.
59461
26a204697252 Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents: 59371
diff changeset
466 The prefix arg specifies the number of columns to indent.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
467
Dave Love <fx@gnu.org>
parents:
diff changeset
468 @node Lisp Indent
Dave Love <fx@gnu.org>
parents:
diff changeset
469 @subsection Customizing Lisp Indentation
Dave Love <fx@gnu.org>
parents:
diff changeset
470 @cindex customizing Lisp indentation
Dave Love <fx@gnu.org>
parents:
diff changeset
471
Dave Love <fx@gnu.org>
parents:
diff changeset
472 The indentation pattern for a Lisp expression can depend on the function
Dave Love <fx@gnu.org>
parents:
diff changeset
473 called by the expression. For each Lisp function, you can choose among
Dave Love <fx@gnu.org>
parents:
diff changeset
474 several predefined patterns of indentation, or define an arbitrary one with
Dave Love <fx@gnu.org>
parents:
diff changeset
475 a Lisp program.
Dave Love <fx@gnu.org>
parents:
diff changeset
476
Dave Love <fx@gnu.org>
parents:
diff changeset
477 The standard pattern of indentation is as follows: the second line of the
Dave Love <fx@gnu.org>
parents:
diff changeset
478 expression is indented under the first argument, if that is on the same
Dave Love <fx@gnu.org>
parents:
diff changeset
479 line as the beginning of the expression; otherwise, the second line is
Dave Love <fx@gnu.org>
parents:
diff changeset
480 indented underneath the function name. Each following line is indented
Dave Love <fx@gnu.org>
parents:
diff changeset
481 under the previous line whose nesting depth is the same.
Dave Love <fx@gnu.org>
parents:
diff changeset
482
Dave Love <fx@gnu.org>
parents:
diff changeset
483 @vindex lisp-indent-offset
Dave Love <fx@gnu.org>
parents:
diff changeset
484 If the variable @code{lisp-indent-offset} is non-@code{nil}, it overrides
Dave Love <fx@gnu.org>
parents:
diff changeset
485 the usual indentation pattern for the second line of an expression, so that
Dave Love <fx@gnu.org>
parents:
diff changeset
486 such lines are always indented @code{lisp-indent-offset} more columns than
Dave Love <fx@gnu.org>
parents:
diff changeset
487 the containing list.
Dave Love <fx@gnu.org>
parents:
diff changeset
488
Dave Love <fx@gnu.org>
parents:
diff changeset
489 @vindex lisp-body-indent
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
490 Certain functions override the standard pattern. Functions whose
42675
640c0fcaebf1 Fix typos.
Pavel Janík <Pavel@Janik.cz>
parents: 41495
diff changeset
491 names start with @code{def} treat the second lines as the start of
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
492 a @dfn{body}, by indenting the second line @code{lisp-body-indent}
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
493 additional columns beyond the open-parenthesis that starts the
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
494 expression.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
495
41409
9cea749ef5c3 (Lisp Indent): Add index entry for lisp-indent-function.
Eli Zaretskii <eliz@gnu.org>
parents: 40175
diff changeset
496 @cindex @code{lisp-indent-function} property
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
497 You can override the standard pattern in various ways for individual
52153
6b84fb503a42 (Lisp Indent): Don't describe lisp-indent-function property here.
Richard M. Stallman <rms@gnu.org>
parents: 51451
diff changeset
498 functions, according to the @code{lisp-indent-function} property of
6b84fb503a42 (Lisp Indent): Don't describe lisp-indent-function property here.
Richard M. Stallman <rms@gnu.org>
parents: 51451
diff changeset
499 the function name. Normally you would use this for macro definitions
6b84fb503a42 (Lisp Indent): Don't describe lisp-indent-function property here.
Richard M. Stallman <rms@gnu.org>
parents: 51451
diff changeset
500 and specify it using the @code{declare} construct (@pxref{Defining
6b84fb503a42 (Lisp Indent): Don't describe lisp-indent-function property here.
Richard M. Stallman <rms@gnu.org>
parents: 51451
diff changeset
501 Macros,,, elisp, the Emacs Lisp Reference Manual}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
502
Dave Love <fx@gnu.org>
parents:
diff changeset
503 @node C Indent
Dave Love <fx@gnu.org>
parents:
diff changeset
504 @subsection Commands for C Indentation
Dave Love <fx@gnu.org>
parents:
diff changeset
505
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
506 Here are special features for indentation in C mode and related modes:
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
507
Dave Love <fx@gnu.org>
parents:
diff changeset
508 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
509 @item C-c C-q
Dave Love <fx@gnu.org>
parents:
diff changeset
510 @kindex C-c C-q @r{(C mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
511 @findex c-indent-defun
Dave Love <fx@gnu.org>
parents:
diff changeset
512 Reindent the current top-level function definition or aggregate type
Dave Love <fx@gnu.org>
parents:
diff changeset
513 declaration (@code{c-indent-defun}).
Dave Love <fx@gnu.org>
parents:
diff changeset
514
Dave Love <fx@gnu.org>
parents:
diff changeset
515 @item C-M-q
Dave Love <fx@gnu.org>
parents:
diff changeset
516 @kindex C-M-q @r{(C mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
517 @findex c-indent-exp
Dave Love <fx@gnu.org>
parents:
diff changeset
518 Reindent each line in the balanced expression that follows point
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
519 (@code{c-indent-exp}). A prefix argument inhibits warning messages
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
520 about invalid syntax.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
521
Dave Love <fx@gnu.org>
parents:
diff changeset
522 @item @key{TAB}
Dave Love <fx@gnu.org>
parents:
diff changeset
523 @findex c-indent-command
Dave Love <fx@gnu.org>
parents:
diff changeset
524 Reindent the current line, and/or in some cases insert a tab character
Dave Love <fx@gnu.org>
parents:
diff changeset
525 (@code{c-indent-command}).
Dave Love <fx@gnu.org>
parents:
diff changeset
526
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
527 @vindex c-tab-always-indent
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
528 If @code{c-tab-always-indent} is @code{t}, this command always reindents
Dave Love <fx@gnu.org>
parents:
diff changeset
529 the current line and does nothing else. This is the default.
Dave Love <fx@gnu.org>
parents:
diff changeset
530
Dave Love <fx@gnu.org>
parents:
diff changeset
531 If that variable is @code{nil}, this command reindents the current line
Dave Love <fx@gnu.org>
parents:
diff changeset
532 only if point is at the left margin or in the line's indentation;
Dave Love <fx@gnu.org>
parents:
diff changeset
533 otherwise, it inserts a tab (or the equivalent number of spaces,
Dave Love <fx@gnu.org>
parents:
diff changeset
534 if @code{indent-tabs-mode} is @code{nil}).
Dave Love <fx@gnu.org>
parents:
diff changeset
535
Dave Love <fx@gnu.org>
parents:
diff changeset
536 Any other value (not @code{nil} or @code{t}) means always reindent the
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
537 line, and also insert a tab if within a comment or a string.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
538 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
539
Dave Love <fx@gnu.org>
parents:
diff changeset
540 To reindent the whole current buffer, type @kbd{C-x h C-M-\}. This
Dave Love <fx@gnu.org>
parents:
diff changeset
541 first selects the whole buffer as the region, then reindents that
Dave Love <fx@gnu.org>
parents:
diff changeset
542 region.
Dave Love <fx@gnu.org>
parents:
diff changeset
543
Dave Love <fx@gnu.org>
parents:
diff changeset
544 To reindent the current block, use @kbd{C-M-u C-M-q}. This moves
Dave Love <fx@gnu.org>
parents:
diff changeset
545 to the front of the block and then reindents it all.
Dave Love <fx@gnu.org>
parents:
diff changeset
546
Dave Love <fx@gnu.org>
parents:
diff changeset
547 @node Custom C Indent
Dave Love <fx@gnu.org>
parents:
diff changeset
548 @subsection Customizing C Indentation
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
549 @cindex style (for indentation)
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
550
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
551 C mode and related modes use a flexible mechanism for customizing
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
552 indentation. C mode indents a source line in two steps: first it
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
553 classifies the line syntactically according to its contents and
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
554 context; second, it determines the indentation offset associated by
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
555 your selected @dfn{style} with the syntactic construct and adds this
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
556 onto the indentation of the @dfn{anchor statement}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
557
Dave Love <fx@gnu.org>
parents:
diff changeset
558 @table @kbd
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
559 @item C-c . @key{RET} @var{style} @key{RET}
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
560 Select a predefined style @var{style} (@code{c-set-style}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
561 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
562
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
563 A @dfn{style} is a named collection of customizations that can
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
564 be used in C mode and the related modes. Emacs comes with several
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
565 predefined styles, including @code{gnu}, @code{k&r}, @code{bsd},
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
566 @code{stroustrup}, @code{linux}, @code{python}, @code{java},
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
567 @code{whitesmith}, @code{ellemtel}, @code{cc-mode}, and @code{user}.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
568 Some of these styles are primarily intended for one language, but any
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
569 of them can be used with any of the languages supported by these
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
570 modes. To find out what a style looks like, select it and reindent
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
571 some code, e.g., by typing @key{C-M-q} at the start of a function
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
572 definition.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
573
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
574 @kindex C-c . @r{(C mode)}
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
575 @findex c-set-style
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
576 To choose a style for the current buffer, use the command @kbd{C-c
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
577 .}. Specify a style name as an argument (case is not significant).
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
578 This command affects the current buffer only, and it affects only
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
579 future invocations of the indentation commands; it does not reindent
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
580 the code in the buffer. To reindent the whole buffer in the new
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
581 style, you can type @kbd{C-x h C-M-\}.
38148
071d97105015 Proofreading fixes from Peter Milliken.
Eli Zaretskii <eliz@gnu.org>
parents: 38136
diff changeset
582
071d97105015 Proofreading fixes from Peter Milliken.
Eli Zaretskii <eliz@gnu.org>
parents: 38136
diff changeset
583 @vindex c-default-style
071d97105015 Proofreading fixes from Peter Milliken.
Eli Zaretskii <eliz@gnu.org>
parents: 38136
diff changeset
584 You can also set the variable @code{c-default-style} to specify the
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
585 default style for various major modes. Its value should be either the
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
586 style's name (a string) or an alist, in which each element specifies
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
587 one major mode and which indentation style to use for it. For
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
588 example,
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
589
Dave Love <fx@gnu.org>
parents:
diff changeset
590 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
591 (setq c-default-style
Dave Love <fx@gnu.org>
parents:
diff changeset
592 '((java-mode . "java") (other . "gnu")))
Dave Love <fx@gnu.org>
parents:
diff changeset
593 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
594
Dave Love <fx@gnu.org>
parents:
diff changeset
595 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
596 specifies an explicit choice for Java mode, and the default @samp{gnu}
60112
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
597 style for the other C-like modes. (These settings are actually the
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
598 defaults.) This variable takes effect when you select one of the
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
599 C-like major modes; thus, if you specify a new default style for Java
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
600 mode, you can make it take effect in an existing Java mode buffer by
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
601 typing @kbd{M-x java-mode} there.
38164
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
602
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
603 The @code{gnu} style specifies the formatting recommended by the GNU
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
604 Project for C; it is the default, so as to encourage use of our
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
605 recommended style.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
606
38871
9cefdb98080f (Custom C Indent): Fix an invalid xref.
Eli Zaretskii <eliz@gnu.org>
parents: 38867
diff changeset
607 @xref{Customizing Indentation,,, ccmode, the CC Mode Manual}, for
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
608 more information on customizing indentation for C and related modes,
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
609 including how to override parts of an existing style and how to define
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
610 your own styles.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
611
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
612 @node Parentheses
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
613 @section Commands for Editing with Parentheses
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
614
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
615 @findex check-parens
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
616 @cindex unbalanced parentheses and quotes
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
617 This section describes the commands and features that take advantage
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
618 of the parenthesis structure in a program, or help you keep it
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
619 balanced.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
620
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
621 When talking about these facilities, the term ``parenthesis'' also
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
622 includes braces, brackets, or whatever delimiters are defined to match
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
623 in pairs. The major mode controls which delimiters are significant,
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
624 through the syntax table (@pxref{Syntax}). In Lisp, only parentheses
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
625 count; in C, these commands apply to braces and brackets too.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
626
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
627 You can use @kbd{M-x check-parens} to find any unbalanced
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
628 parentheses and unbalanced string quotes in the buffer.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
629
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
630 @menu
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
631 * Expressions:: Expressions with balanced parentheses.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
632 * Moving by Parens:: Commands for moving up, down and across
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
633 in the structure of parentheses.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
634 * Matching:: Insertion of a close-delimiter flashes matching open.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
635 @end menu
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
636
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
637 @node Expressions
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
638 @subsection Expressions with Balanced Parentheses
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
639
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
640 @cindex sexp
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
641 @cindex expression
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
642 @cindex balanced expression
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
643 These commands deal with balanced expressions, also called
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
644 @dfn{sexps}@footnote{The word ``sexp'' is used to refer to an
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
645 expression in Lisp.}.
28627
1f6ba3e73fe9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 28391
diff changeset
646
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
647 @table @kbd
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
648 @item C-M-f
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
649 Move forward over a balanced expression (@code{forward-sexp}).
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
650 @item C-M-b
59371
364d233a8dc3 Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents: 56809
diff changeset
651 Move backward over a balanced expression (@code{backward-sexp}).
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
652 @item C-M-k
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
653 Kill balanced expression forward (@code{kill-sexp}).
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
654 @item C-M-t
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
655 Transpose expressions (@code{transpose-sexps}).
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
656 @item C-M-@@
54272
3fd0ea9feede (Expressions): Doc C-M-SPC as alias for C-M-@.
Richard M. Stallman <rms@gnu.org>
parents: 53386
diff changeset
657 @itemx C-M-@key{SPC}
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
658 Put mark after following expression (@code{mark-sexp}).
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
659 @end table
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
660
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
661 Each programming language major mode customizes the definition of
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
662 balanced expressions to suit that language. Balanced expressions
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
663 typically include symbols, numbers, and string constants, as well as
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
664 any pair of matching delimiters and their contents. Some languages
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
665 have obscure forms of expression syntax that nobody has bothered to
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
666 implement in Emacs.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
667
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
668 @cindex Control-Meta
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
669 By convention, the keys for these commands are all Control-Meta
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
670 characters. They usually act on expressions just as the corresponding
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
671 Meta characters act on words. For instance, the command @kbd{C-M-b}
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
672 moves backward over a balanced expression, just as @kbd{M-b} moves
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
673 back over a word.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
674
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
675 @kindex C-M-f
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
676 @kindex C-M-b
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
677 @findex forward-sexp
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
678 @findex backward-sexp
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
679 To move forward over a balanced expression, use @kbd{C-M-f}
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
680 (@code{forward-sexp}). If the first significant character after point
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
681 is an opening delimiter (@samp{(} in Lisp; @samp{(}, @samp{[} or
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
682 @samp{@{} in C), @kbd{C-M-f} moves past the matching closing
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
683 delimiter. If the character begins a symbol, string, or number,
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
684 @kbd{C-M-f} moves over that.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
685
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
686 The command @kbd{C-M-b} (@code{backward-sexp}) moves backward over a
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
687 balanced expression. The detailed rules are like those above for
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
688 @kbd{C-M-f}, but with directions reversed. If there are prefix
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
689 characters (single-quote, backquote and comma, in Lisp) preceding the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
690 expression, @kbd{C-M-b} moves back over them as well. The balanced
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
691 expression commands move across comments as if they were whitespace,
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
692 in most modes.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
693
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
694 @kbd{C-M-f} or @kbd{C-M-b} with an argument repeats that operation the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
695 specified number of times; with a negative argument, it moves in the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
696 opposite direction.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
697
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
698 @cindex killing expressions
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
699 @kindex C-M-k
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
700 @findex kill-sexp
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
701 Killing a whole balanced expression can be done with @kbd{C-M-k}
51451
75df22371834 (Expressions): Delete C-M-DEL.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
702 (@code{kill-sexp}). @kbd{C-M-k} kills the characters that @kbd{C-M-f}
75df22371834 (Expressions): Delete C-M-DEL.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
703 would move over.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
704
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
705 @cindex transposition of expressions
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
706 @kindex C-M-t
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
707 @findex transpose-sexps
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
708 A somewhat random-sounding command which is nevertheless handy is
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
709 @kbd{C-M-t} (@code{transpose-sexps}), which drags the previous
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
710 balanced expression across the next one. An argument serves as a
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
711 repeat count, and a negative argument drags the previous balanced
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
712 expression backwards across those before it (thus canceling out the
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
713 effect of @kbd{C-M-t} with a positive argument). An argument of zero,
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
714 rather than doing nothing, transposes the balanced expressions ending
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
715 at or after point and the mark.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
716
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
717 @kindex C-M-@@
54272
3fd0ea9feede (Expressions): Doc C-M-SPC as alias for C-M-@.
Richard M. Stallman <rms@gnu.org>
parents: 53386
diff changeset
718 @kindex C-M-@key{SPC}
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
719 @findex mark-sexp
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
720 To set the region around the next balanced expression in the buffer,
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
721 use @kbd{C-M-@@} (@code{mark-sexp}), which sets mark at the same place
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
722 that @kbd{C-M-f} would move to. @kbd{C-M-@@} takes arguments like
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
723 @kbd{C-M-f}. In particular, a negative argument is useful for putting
60112
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
724 the mark at the beginning of the previous balanced expression. The
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
725 alias @kbd{C-M-@key{SPC}} is equivalent to @kbd{C-M-@@}. If you use
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
726 this command repeatedly, or in Transient Mark mode whenever the mark
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
727 is active, it extends the region by one sexp each time.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
728
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
729 In languages that use infix operators, such as C, it is not possible
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
730 to recognize all balanced expressions as such because there can be
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
731 multiple possibilities at a given position. For example, C mode does
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
732 not treat @samp{foo + bar} as a single expression, even though it
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
733 @emph{is} one C expression; instead, it recognizes @samp{foo} as one
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
734 expression and @samp{bar} as another, with the @samp{+} as punctuation
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
735 between them. Both @samp{foo + bar} and @samp{foo} are legitimate
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
736 choices for ``the expression following point'' when point is at the
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
737 @samp{f}, so the expression commands must perforce choose one or the
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
738 other to operate on. Note that @samp{(foo + bar)} is recognized as a
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
739 single expression in C mode, because of the parentheses.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
740
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
741 @node Moving by Parens
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
742 @subsection Moving in the Parenthesis Structure
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
743
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
744 @cindex parenthetical groupings
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
745 @cindex parentheses, moving across
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
746 @cindex matching parenthesis and braces, moving to
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
747 @cindex braces, moving across
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
748 @cindex list commands
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
749 The Emacs commands for handling parenthetical groupings see nothing
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
750 except parentheses (or whatever characters must balance in the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
751 language you are working with), and the escape characters that might
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
752 be used to quote those. They are mainly intended for editing
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
753 programs, but can be useful for editing any text that has parentheses.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
754 They are sometimes called ``list'' commands because in Lisp these
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
755 groupings are lists.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
756
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
757 @table @kbd
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
758 @item C-M-n
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
759 Move forward over a parenthetical group (@code{forward-list}).
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
760 @item C-M-p
59371
364d233a8dc3 Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents: 56809
diff changeset
761 Move backward over a parenthetical group (@code{backward-list}).
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
762 @item C-M-u
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
763 Move up in parenthesis structure (@code{backward-up-list}).
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
764 @item C-M-d
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
765 Move down in parenthesis structure (@code{down-list}).
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
766 @end table
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
767
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
768 @kindex C-M-n
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
769 @kindex C-M-p
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
770 @findex forward-list
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
771 @findex backward-list
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
772 The ``list'' commands @kbd{C-M-n} (@code{forward-list}) and
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
773 @kbd{C-M-p} (@code{backward-list}) move over one (or @var{n})
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
774 parenthetical groupings, skipping blithely over any amount of text
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
775 that doesn't include meaningful parentheses (symbols, strings, etc.).
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
776
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
777 @kindex C-M-u
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
778 @kindex C-M-d
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
779 @findex backward-up-list
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
780 @findex down-list
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
781 @kbd{C-M-n} and @kbd{C-M-p} try to stay at the same level in the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
782 parenthesis structure. To move @emph{up} one (or @var{n}) levels, use
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
783 @kbd{C-M-u} (@code{backward-up-list}). @kbd{C-M-u} moves backward up
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
784 past one unmatched opening delimiter. A positive argument serves as a
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
785 repeat count; a negative argument reverses the direction of motion, so
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
786 that the command moves forward and up one or more levels.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
787
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
788 To move @emph{down} in the parenthesis structure, use @kbd{C-M-d}
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
789 (@code{down-list}). In Lisp mode, where @samp{(} is the only opening
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
790 delimiter, this is nearly the same as searching for a @samp{(}. An
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
791 argument specifies the number of levels to go down.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
792
Dave Love <fx@gnu.org>
parents:
diff changeset
793 @node Matching
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
794 @subsection Automatic Display Of Matching Parentheses
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
795 @cindex matching parentheses
Dave Love <fx@gnu.org>
parents:
diff changeset
796 @cindex parentheses, displaying matches
Dave Love <fx@gnu.org>
parents:
diff changeset
797
Dave Love <fx@gnu.org>
parents:
diff changeset
798 The Emacs parenthesis-matching feature is designed to show
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
799 automatically how parentheses (and other matching delimiters) match in
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
800 the text. Whenever you type a self-inserting character that is a
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
801 closing delimiter, the cursor moves momentarily to the location of the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
802 matching opening delimiter, provided that is on the screen. If it is
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
803 not on the screen, Emacs displays some of the text near it in the echo
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
804 area. Either way, you can tell which grouping you are closing off.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
805
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
806 If the opening delimiter and closing delimiter are mismatched---such
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
807 as in @samp{[x)}---a warning message is displayed in the echo area.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
808
Dave Love <fx@gnu.org>
parents:
diff changeset
809 @vindex blink-matching-paren
Dave Love <fx@gnu.org>
parents:
diff changeset
810 @vindex blink-matching-paren-distance
Dave Love <fx@gnu.org>
parents:
diff changeset
811 @vindex blink-matching-delay
59461
26a204697252 Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents: 59371
diff changeset
812 Three variables control parenthesis match display:
26a204697252 Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents: 59371
diff changeset
813
26a204697252 Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents: 59371
diff changeset
814 @code{blink-matching-paren} turns the feature on or off: @code{nil}
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
815 disables it, but the default is @code{t} to enable match display.
38164
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
816
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
817 @code{blink-matching-delay} says how many seconds to leave the
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
818 cursor on the matching opening delimiter, before bringing it back to
38164
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
819 the real location of point; the default is 1, but on some systems it
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
820 is useful to specify a fraction of a second.
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
821
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
822 @code{blink-matching-paren-distance} specifies how many characters
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
823 back to search to find the matching opening delimiter. If the match
38287
d6fff7f22127 Minor change.
Richard M. Stallman <rms@gnu.org>
parents: 38238
diff changeset
824 is not found in that distance, scanning stops, and nothing is displayed.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
825 This is to prevent the scan for the matching delimiter from wasting
38164
ec15967a5cf7 Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents: 38149
diff changeset
826 lots of time when there is no match. The default is 25600.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
827
Dave Love <fx@gnu.org>
parents:
diff changeset
828 @cindex Show Paren mode
34122
c42bb7d4437b Don't tell that show-paren only works on X. Explain how to customize
Eli Zaretskii <eliz@gnu.org>
parents: 31188
diff changeset
829 @cindex highlighting matching parentheses
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
830 @findex show-paren-mode
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
831 Show Paren mode provides a more powerful kind of automatic matching.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
832 Whenever point is after a closing delimiter, that delimiter and its
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
833 matching opening delimiter are both highlighted; otherwise, if point
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
834 is before an opening delimiter, the matching closing delimiter is
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
835 highlighted. (There is no need to highlight the opening delimiter in
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
836 that case, because the cursor appears on top of that character.) Use
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
837 the command @kbd{M-x show-paren-mode} to enable or disable this mode.
34122
c42bb7d4437b Don't tell that show-paren only works on X. Explain how to customize
Eli Zaretskii <eliz@gnu.org>
parents: 31188
diff changeset
838
c42bb7d4437b Don't tell that show-paren only works on X. Explain how to customize
Eli Zaretskii <eliz@gnu.org>
parents: 31188
diff changeset
839 By default, @code{show-paren-mode} uses colors to highlight the
c42bb7d4437b Don't tell that show-paren only works on X. Explain how to customize
Eli Zaretskii <eliz@gnu.org>
parents: 31188
diff changeset
840 parentheses. However, if your display doesn't support colors, you can
c42bb7d4437b Don't tell that show-paren only works on X. Explain how to customize
Eli Zaretskii <eliz@gnu.org>
parents: 31188
diff changeset
841 customize the faces @code{show-paren-match-face} and
c42bb7d4437b Don't tell that show-paren only works on X. Explain how to customize
Eli Zaretskii <eliz@gnu.org>
parents: 31188
diff changeset
842 @code{show-paren-mismatch-face} to use other attributes, such as bold or
c42bb7d4437b Don't tell that show-paren only works on X. Explain how to customize
Eli Zaretskii <eliz@gnu.org>
parents: 31188
diff changeset
843 underline. @xref{Face Customization}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
844
Dave Love <fx@gnu.org>
parents:
diff changeset
845 @node Comments
Dave Love <fx@gnu.org>
parents:
diff changeset
846 @section Manipulating Comments
Dave Love <fx@gnu.org>
parents:
diff changeset
847 @cindex comments
Dave Love <fx@gnu.org>
parents:
diff changeset
848
Dave Love <fx@gnu.org>
parents:
diff changeset
849 Because comments are such an important part of programming, Emacs
47502
e8faddf96f0f Add ref for Flyspell Prog mode.
Richard M. Stallman <rms@gnu.org>
parents: 46035
diff changeset
850 provides special commands for editing and inserting comments. It can
e8faddf96f0f Add ref for Flyspell Prog mode.
Richard M. Stallman <rms@gnu.org>
parents: 46035
diff changeset
851 also do spell checking on comments with Flyspell Prog mode
e8faddf96f0f Add ref for Flyspell Prog mode.
Richard M. Stallman <rms@gnu.org>
parents: 46035
diff changeset
852 (@pxref{Spelling}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
853
Dave Love <fx@gnu.org>
parents:
diff changeset
854 @menu
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
855 * Comment Commands:: Inserting, killing, and indenting comments.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
856 * Multi-Line Comments:: Commands for adding and editing multi-line comments.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
857 * Options for Comments::Customizing the comment features.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
858 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
859
Dave Love <fx@gnu.org>
parents:
diff changeset
860 @node Comment Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
861 @subsection Comment Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
862 @cindex indentation for comments
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
863
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
864 The comment commands in this table insert, kill and align comments.
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
865 They are described in this section and following sections.
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
866
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
867 @table @asis
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
868 @item @kbd{M-;}
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
869 Insert or realign comment on current line; alternatively, comment or
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
870 uncomment the region (@code{comment-dwim}).
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
871 @item @kbd{C-u M-;}
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
872 Kill comment on current line (@code{comment-kill}).
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
873 @item @kbd{C-x ;}
38018
f802bdff6c2c Update various command names and variable defaults.
Richard M. Stallman <rms@gnu.org>
parents: 38009
diff changeset
874 Set comment column (@code{comment-set-column}).
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
875 @item @kbd{C-M-j}
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
876 @itemx @kbd{M-j}
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
877 Like @key{RET} followed by inserting and aligning a comment
38018
f802bdff6c2c Update various command names and variable defaults.
Richard M. Stallman <rms@gnu.org>
parents: 38009
diff changeset
878 (@code{comment-indent-new-line}).
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
879 @item @kbd{M-x comment-region}
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
880 @itemx @kbd{C-c C-c} (in C-like modes)
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
881 Add or remove comment delimiters on all the lines in the region.
Dave Love <fx@gnu.org>
parents:
diff changeset
882 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
883
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
884 @kindex M-;
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
885 @findex comment-dwim
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
886 The command to create or align a comment is @kbd{M-;}
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
887 (@code{comment-dwim}). The word ``dwim'' is an acronym for ``Do What
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
888 I Mean''; it indicates that this command can be used for many
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
889 different jobs relating to comments, depending on the situation where
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
890 you use it.
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
891
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
892 If there is no comment already on the line, @kbd{M-;} inserts a new
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
893 comment, aligned at a specific column called the @dfn{comment column}.
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
894 The new comment begins with the string Emacs thinks comments should
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
895 start with (the value of @code{comment-start}; see below). Point is
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
896 after that string, so you can insert the text of the comment right
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
897 away. If the major mode has specified a string to terminate comments,
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
898 @kbd{M-;} inserts that too, to keep the syntax valid.
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
899
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
900 If the text of the line extends past the comment column, then the
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
901 comment start string is indented to a suitable boundary (usually, at
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
902 least one space is inserted).
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
903
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
904 You can also use @kbd{M-;} to align an existing comment. If a line
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
905 already contains the comment-start string, @kbd{M-;} reindents it to
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
906 the conventional alignment and moves point after it. (Exception:
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
907 comments starting in column 0 are not moved.) Even when an existing
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
908 comment is properly aligned, @kbd{M-;} is still useful for moving
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
909 directly to the start of the text inside the comment.
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
910
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
911 @findex comment-kill
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
912 @kindex C-u M-;
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
913 @kbd{C-u M-;} kills any comment on the current line, along with the
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
914 whitespace before it. To reinsert the comment on another line, move
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
915 to the end of that line, do @kbd{C-y}, and then do @kbd{M-;} to
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
916 realign it.
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
917
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
918 Note that @kbd{C-u M-;} is not a distinct key; it is @kbd{M-;}
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
919 (@code{comment-dwim}) with a prefix argument. That command is
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
920 programmed so that when it receives a prefix argument it calls
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
921 @code{comment-kill}. However, @code{comment-kill} is a valid command
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
922 in its own right, and you can bind it directly to a key if you wish.
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
923
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
924 @kbd{M-;} does two other jobs when used with an active region in
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
925 Transient Mark mode (@pxref{Transient Mark}). Then it either adds or
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
926 removes comment delimiters on each line of the region. (If every line
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
927 is a comment, it removes comment delimiters from each; otherwise, it
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
928 adds comment delimiters to each.) If you are not using Transient Mark
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
929 mode, then you should use the commands @code{comment-region} and
36198
47124bb72465 Fix typo.
Andreas Schwab <schwab@suse.de>
parents: 36185
diff changeset
930 @code{uncomment-region} to do these jobs (@pxref{Multi-Line Comments}).
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
931 A prefix argument used in these circumstances specifies how many
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
932 comment delimiters to add or how many to delete.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
933
Dave Love <fx@gnu.org>
parents:
diff changeset
934 Some major modes have special rules for indenting certain kinds of
Dave Love <fx@gnu.org>
parents:
diff changeset
935 comments in certain contexts. For example, in Lisp code, comments which
Dave Love <fx@gnu.org>
parents:
diff changeset
936 start with two semicolons are indented as if they were lines of code,
Dave Love <fx@gnu.org>
parents:
diff changeset
937 instead of at the comment column. Comments which start with three
Dave Love <fx@gnu.org>
parents:
diff changeset
938 semicolons are supposed to start at the left margin. Emacs understands
Dave Love <fx@gnu.org>
parents:
diff changeset
939 these conventions by indenting a double-semicolon comment using @key{TAB},
Dave Love <fx@gnu.org>
parents:
diff changeset
940 and by not changing the indentation of a triple-semicolon comment at all.
Dave Love <fx@gnu.org>
parents:
diff changeset
941
Dave Love <fx@gnu.org>
parents:
diff changeset
942 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
943 ;; This function is just an example
Dave Love <fx@gnu.org>
parents:
diff changeset
944 ;;; Here either two or three semicolons are appropriate.
Dave Love <fx@gnu.org>
parents:
diff changeset
945 (defun foo (x)
Dave Love <fx@gnu.org>
parents:
diff changeset
946 ;;; And now, the first part of the function:
Dave Love <fx@gnu.org>
parents:
diff changeset
947 ;; The following line adds one.
Dave Love <fx@gnu.org>
parents:
diff changeset
948 (1+ x)) ; This line adds one.
Dave Love <fx@gnu.org>
parents:
diff changeset
949 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
950
Dave Love <fx@gnu.org>
parents:
diff changeset
951 In C code, a comment preceded on its line by nothing but whitespace
Dave Love <fx@gnu.org>
parents:
diff changeset
952 is indented like a line of code.
Dave Love <fx@gnu.org>
parents:
diff changeset
953
Dave Love <fx@gnu.org>
parents:
diff changeset
954 @node Multi-Line Comments
Dave Love <fx@gnu.org>
parents:
diff changeset
955 @subsection Multiple Lines of Comments
Dave Love <fx@gnu.org>
parents:
diff changeset
956
Dave Love <fx@gnu.org>
parents:
diff changeset
957 @kindex C-M-j
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
958 @kindex M-j
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
959 @cindex blank lines in programs
38018
f802bdff6c2c Update various command names and variable defaults.
Richard M. Stallman <rms@gnu.org>
parents: 38009
diff changeset
960 @findex comment-indent-new-line
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
961 If you are typing a comment and wish to continue it on another line,
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
962 you can use the command @kbd{C-M-j} or @kbd{M-j}
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
963 (@code{comment-indent-new-line}). This terminates the comment you are
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
964 typing, creates a new blank line afterward, and begins a new comment
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
965 indented under the old one. When Auto Fill mode is on, going past the
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
966 fill column while typing a comment causes the comment to be continued
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
967 in just this fashion. If point is not at the end of the line when you
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
968 type the command, the text on the rest of the line becomes part of the
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
969 new comment line.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
970
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
971 @kindex C-c C-c (C mode)
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
972 @findex comment-region
Dave Love <fx@gnu.org>
parents:
diff changeset
973 To turn existing lines into comment lines, use the @kbd{M-x
Dave Love <fx@gnu.org>
parents:
diff changeset
974 comment-region} command. It adds comment delimiters to the lines that start
Dave Love <fx@gnu.org>
parents:
diff changeset
975 in the region, thus commenting them out. With a negative argument, it
Dave Love <fx@gnu.org>
parents:
diff changeset
976 does the opposite---it deletes comment delimiters from the lines in the
Dave Love <fx@gnu.org>
parents:
diff changeset
977 region.
Dave Love <fx@gnu.org>
parents:
diff changeset
978
Dave Love <fx@gnu.org>
parents:
diff changeset
979 With a positive argument, @code{comment-region} duplicates the last
Dave Love <fx@gnu.org>
parents:
diff changeset
980 character of the comment start sequence it adds; the argument specifies
Dave Love <fx@gnu.org>
parents:
diff changeset
981 how many copies of the character to insert. Thus, in Lisp mode,
Dave Love <fx@gnu.org>
parents:
diff changeset
982 @kbd{C-u 2 M-x comment-region} adds @samp{;;} to each line. Duplicating
Dave Love <fx@gnu.org>
parents:
diff changeset
983 the comment delimiter is a way of calling attention to the comment. It
Dave Love <fx@gnu.org>
parents:
diff changeset
984 can also affect how the comment is indented. In Lisp, for proper
38018
f802bdff6c2c Update various command names and variable defaults.
Richard M. Stallman <rms@gnu.org>
parents: 38009
diff changeset
985 indentation, you should use an argument of two or three, if between defuns;
f802bdff6c2c Update various command names and variable defaults.
Richard M. Stallman <rms@gnu.org>
parents: 38009
diff changeset
986 if within a defun, it must be three.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
987
Dave Love <fx@gnu.org>
parents:
diff changeset
988 @node Options for Comments
Dave Love <fx@gnu.org>
parents:
diff changeset
989 @subsection Options Controlling Comments
Dave Love <fx@gnu.org>
parents:
diff changeset
990
Dave Love <fx@gnu.org>
parents:
diff changeset
991 @vindex comment-column
Dave Love <fx@gnu.org>
parents:
diff changeset
992 @kindex C-x ;
38018
f802bdff6c2c Update various command names and variable defaults.
Richard M. Stallman <rms@gnu.org>
parents: 38009
diff changeset
993 @findex comment-set-column
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
994 The @dfn{comment column}, the column at which Emacs tries to place
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
995 comments, is stored in the variable @code{comment-column}. You can
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
996 set it to a number explicitly. Alternatively, the command @kbd{C-x ;}
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
997 (@code{comment-set-column}) sets the comment column to the column
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
998 point is at. @kbd{C-u C-x ;} sets the comment column to match the
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
999 last comment before point in the buffer, and then does a @kbd{M-;} to
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1000 align the current line's comment under the previous one.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1001
Dave Love <fx@gnu.org>
parents:
diff changeset
1002 The variable @code{comment-column} is per-buffer: setting the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1003 in the normal fashion affects only the current buffer, but there is a
Dave Love <fx@gnu.org>
parents:
diff changeset
1004 default value which you can change with @code{setq-default}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1005 @xref{Locals}. Many major modes initialize this variable for the
Dave Love <fx@gnu.org>
parents:
diff changeset
1006 current buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
1007
Dave Love <fx@gnu.org>
parents:
diff changeset
1008 @vindex comment-start-skip
Dave Love <fx@gnu.org>
parents:
diff changeset
1009 The comment commands recognize comments based on the regular
Dave Love <fx@gnu.org>
parents:
diff changeset
1010 expression that is the value of the variable @code{comment-start-skip}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1011 Make sure this regexp does not match the null string. It may match more
Dave Love <fx@gnu.org>
parents:
diff changeset
1012 than the comment starting delimiter in the strictest sense of the word;
38018
f802bdff6c2c Update various command names and variable defaults.
Richard M. Stallman <rms@gnu.org>
parents: 38009
diff changeset
1013 for example, in C mode the value of the variable is
f802bdff6c2c Update various command names and variable defaults.
Richard M. Stallman <rms@gnu.org>
parents: 38009
diff changeset
1014 @c This stops M-q from breaking the line inside that @code.
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1015 @code{@w{"/\\*+ *\\|//+ *"}}, which matches extra stars and spaces
38018
f802bdff6c2c Update various command names and variable defaults.
Richard M. Stallman <rms@gnu.org>
parents: 38009
diff changeset
1016 after the @samp{/*} itself, and accepts C++ style comments also.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1017 (Note that @samp{\\} is needed in Lisp syntax to include a @samp{\} in
Dave Love <fx@gnu.org>
parents:
diff changeset
1018 the string, which is needed to deny the first star its special meaning
Dave Love <fx@gnu.org>
parents:
diff changeset
1019 in regexp syntax. @xref{Regexps}.)
Dave Love <fx@gnu.org>
parents:
diff changeset
1020
Dave Love <fx@gnu.org>
parents:
diff changeset
1021 @vindex comment-start
Dave Love <fx@gnu.org>
parents:
diff changeset
1022 @vindex comment-end
Dave Love <fx@gnu.org>
parents:
diff changeset
1023 When a comment command makes a new comment, it inserts the value of
Dave Love <fx@gnu.org>
parents:
diff changeset
1024 @code{comment-start} to begin it. The value of @code{comment-end} is
Dave Love <fx@gnu.org>
parents:
diff changeset
1025 inserted after point, so that it will follow the text that you will insert
Dave Love <fx@gnu.org>
parents:
diff changeset
1026 into the comment. In C mode, @code{comment-start} has the value
Dave Love <fx@gnu.org>
parents:
diff changeset
1027 @w{@code{"/* "}} and @code{comment-end} has the value @w{@code{" */"}}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1028
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1029 @vindex comment-padding
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1030 The variable @code{comment-padding} specifies how many spaces
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1031 @code{comment-region} should insert on each line between the comment
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1032 delimiter and the line's original text. The default is 1, to insert
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1033 one space. @code{nil} means 0. Alternatively, @code{comment-padding}
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1034 can hold the actual string to insert.
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1035
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1036 @vindex comment-multi-line
Dave Love <fx@gnu.org>
parents:
diff changeset
1037 The variable @code{comment-multi-line} controls how @kbd{C-M-j}
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1038 (@code{indent-new-comment-line}) behaves when used inside a comment.
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1039 Specifically, when @code{comment-multi-line} is @code{nil} (the
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1040 default value), the command inserts a comment terminator, begins a new
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1041 line, and finally inserts a comment starter. Otherwise it does not
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1042 insert the terminator and starter, so it effectively continues the
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1043 current comment across multiple lines. In languages that allow
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1044 multi-line comments, the choice of value for this variable is a matter
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1045 of taste.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1046
41495
0bac781ea0d6 Undo previous change.
Richard M. Stallman <rms@gnu.org>
parents: 41472
diff changeset
1047 @vindex comment-indent-function
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1048 The variable @code{comment-indent-function} should contain a function
Dave Love <fx@gnu.org>
parents:
diff changeset
1049 that will be called to compute the indentation for a newly inserted
Dave Love <fx@gnu.org>
parents:
diff changeset
1050 comment or for aligning an existing comment. It is set differently by
Dave Love <fx@gnu.org>
parents:
diff changeset
1051 various major modes. The function is called with no arguments, but with
Dave Love <fx@gnu.org>
parents:
diff changeset
1052 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
1053 comment is to be inserted. It should return the column in which the
Dave Love <fx@gnu.org>
parents:
diff changeset
1054 comment ought to start. For example, in Lisp mode, the indent hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1055 function bases its decision on how many semicolons begin an existing
Dave Love <fx@gnu.org>
parents:
diff changeset
1056 comment, and on the code in the preceding lines.
Dave Love <fx@gnu.org>
parents:
diff changeset
1057
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1058 @node Documentation
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1059 @section Documentation Lookup
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1060
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1061 Emacs provides several features you can use to look up the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1062 documentation of functions, variables and commands that you plan to
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1063 use in your program.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1064
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1065 @menu
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1066 * Info Lookup:: Looking up library functions and commands
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1067 in Info files.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1068 * Man Page:: Looking up man pages of library functions and commands.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1069 * Lisp Doc:: Looking up Emacs Lisp functions, etc.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1070 @end menu
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1071
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1072 @node Info Lookup
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1073 @subsection Info Documentation Lookup
27221
4a723a7bc25a Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents: 26462
diff changeset
1074
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1075 @findex info-lookup-symbol
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1076 @findex info-lookup-file
56164
f5e9166d3954 (Info Lookup): Fix keybinding for
Jesper Harder <harder@ifa.au.dk>
parents: 56086
diff changeset
1077 @kindex C-h S
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1078 For C, Lisp, and other languages that have documentation in Info,
56164
f5e9166d3954 (Info Lookup): Fix keybinding for
Jesper Harder <harder@ifa.au.dk>
parents: 56086
diff changeset
1079 you can use @kbd{C-h S} (@code{info-lookup-symbol}) to view the Info
60112
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
1080 documentation for a symbol used in the program. You specify the
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
1081 symbol with the minibuffer; the default is the symbol appearing in the
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
1082 buffer at point. For example, in C mode this looks for the symbol in
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
1083 the C Library Manual.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1084
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1085 The major mode determines where to look for documentation for the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1086 symbol---which Info files to look in, and which indices to search.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1087 You can also use @kbd{M-x info-lookup-file} to look for documentation
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1088 for a file name.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1089
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1090 This feature currently supports the modes AWK, Autoconf, Bison, C,
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1091 Emacs Lisp, LaTeX, M4, Makefile, Octave, Perl, Scheme, and Texinfo,
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1092 provided you have installed the relevant Info files, which are
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1093 typically available with the appropriate GNU package.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1094
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1095 @node Man Page
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1096 @subsection Man Page Lookup
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1097
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1098 @cindex manual page
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1099 On Unix, the main form of on-line documentation was the @dfn{manual
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1100 page} or @dfn{man page}. In the GNU operating system, we hope to
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1101 replace man pages with better-organized manuals that you can browse
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1102 with Info (@pxref{Misc Help}). This process is not finished, so it is
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1103 still useful to read manual pages.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1104
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1105 @findex manual-entry
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1106 You can read the man page for an operating system command, library
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1107 function, or system call, with the @kbd{M-x man} command. It
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1108 runs the @code{man} program to format the man page; if the system
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1109 permits, it runs @code{man} asynchronously, so that you can keep on
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1110 editing while the page is being formatted. (On MS-DOS and MS-Windows
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1111 3, you cannot edit while Emacs waits for @code{man} to finish.) The
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1112 result goes in a buffer named @samp{*Man @var{topic}*}. These buffers
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1113 use a special major mode, Man mode, that facilitates scrolling and
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1114 jumping to other manual pages. For details, type @kbd{C-h m} while in
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1115 a man page buffer.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1116
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1117 @cindex sections of manual pages
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1118 Each man page belongs to one of ten or more @dfn{sections}, each
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1119 named by a digit or by a digit and a letter. Sometimes there are
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1120 multiple man pages with the same name in different sections. To read
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1121 a man page from a specific section, type
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1122 @samp{@var{topic}(@var{section})} or @samp{@var{section} @var{topic}}
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1123 when @kbd{M-x manual-entry} prompts for the topic. For example, to
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1124 read the man page for the C library function @code{chmod} (as opposed
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1125 to a command of the same name), type @kbd{M-x manual-entry @key{RET}
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1126 chmod(2) @key{RET}} (@code{chmod} is a system call, so it is in
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1127 section @samp{2}).
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1128
38667
6ed2cc05e016 (Man Page): Mention the -a switch to `man' in a footnote.
Eli Zaretskii <eliz@gnu.org>
parents: 38323
diff changeset
1129 @vindex Man-switches
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1130 If you do not specify a section, the results depend on how the
38667
6ed2cc05e016 (Man Page): Mention the -a switch to `man' in a footnote.
Eli Zaretskii <eliz@gnu.org>
parents: 38323
diff changeset
1131 @code{man} program works on your system. Some of them display only
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1132 the first man page they find. Others display all man pages that have
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1133 the specified name, so you can move between them with the @kbd{M-n}
38667
6ed2cc05e016 (Man Page): Mention the -a switch to `man' in a footnote.
Eli Zaretskii <eliz@gnu.org>
parents: 38323
diff changeset
1134 and @kbd{M-p} keys@footnote{On some systems, the @code{man} program
6ed2cc05e016 (Man Page): Mention the -a switch to `man' in a footnote.
Eli Zaretskii <eliz@gnu.org>
parents: 38323
diff changeset
1135 accepts a @samp{-a} command-line option which tells it to display all
6ed2cc05e016 (Man Page): Mention the -a switch to `man' in a footnote.
Eli Zaretskii <eliz@gnu.org>
parents: 38323
diff changeset
1136 the man pages for the specified topic. If you want this behavior, you
6ed2cc05e016 (Man Page): Mention the -a switch to `man' in a footnote.
Eli Zaretskii <eliz@gnu.org>
parents: 38323
diff changeset
1137 can add this option to the value of the variable @code{Man-switches}.}.
6ed2cc05e016 (Man Page): Mention the -a switch to `man' in a footnote.
Eli Zaretskii <eliz@gnu.org>
parents: 38323
diff changeset
1138 The mode line shows how many manual pages are present in the Man buffer.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1139
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1140 @vindex Man-fontify-manpage-flag
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1141 By default, Emacs highlights the text in man pages. For a long man
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1142 page, highlighting can take substantial time. You can turn off
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1143 highlighting of man pages by setting the variable
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1144 @code{Man-fontify-manpage-flag} to @code{nil}.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1145
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1146 @findex Man-fontify-manpage
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1147 If you insert the text of a man page into an Emacs buffer in some
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1148 other fashion, you can use the command @kbd{M-x Man-fontify-manpage} to
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1149 perform the same conversions that @kbd{M-x manual-entry} does.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1150
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1151 @findex woman
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1152 @cindex manual pages, on MS-DOS/MS-Windows
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1153 An alternative way of reading manual pages is the @kbd{M-x woman}
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1154 command@footnote{The name of the command, @code{woman}, is an acronym
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1155 for ``w/o (without) man,'' since it doesn't use the @code{man}
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1156 program.}. Unlike @kbd{M-x man}, it does not run any external
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1157 programs to format and display the man pages; instead it does the job
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1158 in Emacs Lisp, so it works on systems such as MS-Windows, where the
59371
364d233a8dc3 Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents: 56809
diff changeset
1159 @code{man} program (and other programs it uses) are not generally
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1160 available.
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1161
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1162 @kbd{M-x woman} prompts for a name of a manual page, and provides
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1163 completion based on the list of manual pages that are installed on
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1164 your machine; the list of available manual pages is computed
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1165 automatically the first time you invoke @code{woman}. The word at
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1166 point in the current buffer is used to suggest the default for the
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1167 name the manual page.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1168
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1169 With a numeric argument, @kbd{M-x woman} recomputes the list of the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1170 manual pages used for completion. This is useful if you add or delete
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1171 manual pages.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1172
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1173 If you type a name of a manual page and @kbd{M-x woman} finds that
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1174 several manual pages by the same name exist in different sections, it
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1175 pops up a window with possible candidates asking you to choose one of
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1176 them.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1177
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1178 @vindex woman-manpath
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1179 By default, @kbd{M-x woman} looks for manual pages in the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1180 directories specified in the @code{MANPATH} environment variable. (If
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1181 @code{MANPATH} is not set, @code{woman} uses a suitable default value,
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1182 which can be customized.) More precisely, @code{woman} looks for
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1183 subdirectories that match the shell wildcard pattern @file{man*} in each one
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1184 of these directories, and tries to find the manual pages in those
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1185 subdirectories. When first invoked, @kbd{M-x woman} converts the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1186 value of @code{MANPATH} to a list of directory names and stores that
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1187 list in the @code{woman-manpath} variable. Changing the value of this
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1188 variable is another way to control the list of directories used.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1189
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1190 @vindex woman-path
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1191 You can also augment the list of directories searched by
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1192 @code{woman} by setting the value of the @code{woman-path} variable.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1193 This variable should hold a list of specific directories which
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1194 @code{woman} should search, in addition to those in
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1195 @code{woman-manpath}. Unlike @code{woman-manpath}, the directories in
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1196 @code{woman-path} are searched for the manual pages, not for
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1197 @file{man*} subdirectories.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1198
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1199 @findex woman-find-file
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1200 Occasionally, you might need to display manual pages that are not in
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1201 any of the directories listed by @code{woman-manpath} and
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1202 @code{woman-path}. The @kbd{M-x woman-find-file} command prompts for a
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1203 name of a manual page file, with completion, and then formats and
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1204 displays that file like @kbd{M-x woman} does.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1205
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1206 @vindex woman-dired-keys
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1207 The first time you invoke @kbd{M-x woman}, it defines the Dired
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1208 @kbd{W} key to run the @code{woman-find-file} command on the current
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1209 line's file. You can disable this by setting the variable
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1210 @code{woman-dired-keys} to @code{nil}. @xref{Dired}. In addition,
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1211 the Tar-mode @kbd{w} key is define to invoke @code{woman-find-file} on
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1212 the current line's archive member.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1213
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1214 For more information about setting up and using @kbd{M-x woman}, see
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1215 @ref{Top, WoMan, Browse UN*X Manual Pages WithOut Man, woman, The WoMan
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1216 Manual}.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1217
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1218 @node Lisp Doc
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1219 @subsection Emacs Lisp Documentation Lookup
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1220
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1221 As you edit Lisp code to be run in Emacs, you can use the commands
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1222 @kbd{C-h f} (@code{describe-function}) and @kbd{C-h v}
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1223 (@code{describe-variable}) to view documentation of functions and
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1224 variables that you want to use. These commands use the minibuffer to
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1225 read the name of a function or variable to document, and display the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1226 documentation in a window. Their default arguments are based on the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1227 code in the neighborhood of point. For @kbd{C-h f}, the default is
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1228 the function called in the innermost list containing point. @kbd{C-h
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1229 v} uses the symbol name around or adjacent to point as its default.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1230
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1231 @cindex Eldoc mode
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1232 @findex eldoc-mode
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1233 A more automatic but less powerful method is Eldoc mode. This minor
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1234 mode constantly displays in the echo area the argument list for the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1235 function being called at point. (In other words, it finds the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1236 function call that point is contained in, and displays the argument
59461
26a204697252 Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents: 59371
diff changeset
1237 list of that function.) If point is over a documented variable, it
62482
8db373573379 (Lisp Doc): Eldoc mode shows only the first line of a variable's docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61133
diff changeset
1238 shows the first line of the variable's docstring. Eldoc mode applies
8db373573379 (Lisp Doc): Eldoc mode shows only the first line of a variable's docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61133
diff changeset
1239 in Emacs Lisp and Lisp Interaction modes, and perhaps a few others
8db373573379 (Lisp Doc): Eldoc mode shows only the first line of a variable's docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61133
diff changeset
1240 that provide special support for looking up doc strings. Use the
8db373573379 (Lisp Doc): Eldoc mode shows only the first line of a variable's docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61133
diff changeset
1241 command @kbd{M-x eldoc-mode} to enable or disable this feature.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1242
28329
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1243 @node Hideshow
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1244 @section Hideshow minor mode
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1245
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1246 @findex hs-minor-mode
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1247 Hideshow minor mode provides selective display of portions of a
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1248 program, known as @dfn{blocks}. You can use @kbd{M-x hs-minor-mode}
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1249 to enable or disable this mode, or add @code{hs-minor-mode} to the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1250 mode hook for certain major modes in order to enable it automatically
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1251 for those modes.
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1252
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1253 Just what constitutes a block depends on the major mode. In C mode
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1254 or C++ mode, they are delimited by braces, while in Lisp mode and
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1255 similar modes they are delimited by parentheses. Multi-line comments
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1256 also count as blocks.
28329
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1257
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1258 @findex hs-hide-all
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1259 @findex hs-hide-block
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1260 @findex hs-show-all
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1261 @findex hs-show-block
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1262 @findex hs-show-region
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1263 @findex hs-hide-level
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1264 @findex hs-minor-mode
37997
c329103798cc (Hideshow): Fix the docs of keybindings which used a single `@'.
Eli Zaretskii <eliz@gnu.org>
parents: 37978
diff changeset
1265 @kindex C-c @@ C-h
c329103798cc (Hideshow): Fix the docs of keybindings which used a single `@'.
Eli Zaretskii <eliz@gnu.org>
parents: 37978
diff changeset
1266 @kindex C-c @@ C-s
c329103798cc (Hideshow): Fix the docs of keybindings which used a single `@'.
Eli Zaretskii <eliz@gnu.org>
parents: 37978
diff changeset
1267 @kindex C-c @@ C-M-h
c329103798cc (Hideshow): Fix the docs of keybindings which used a single `@'.
Eli Zaretskii <eliz@gnu.org>
parents: 37978
diff changeset
1268 @kindex C-c @@ C-M-s
c329103798cc (Hideshow): Fix the docs of keybindings which used a single `@'.
Eli Zaretskii <eliz@gnu.org>
parents: 37978
diff changeset
1269 @kindex C-c @@ C-r
c329103798cc (Hideshow): Fix the docs of keybindings which used a single `@'.
Eli Zaretskii <eliz@gnu.org>
parents: 37978
diff changeset
1270 @kindex C-c @@ C-l
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1271 @kindex S-Mouse-2
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1272 @table @kbd
37997
c329103798cc (Hideshow): Fix the docs of keybindings which used a single `@'.
Eli Zaretskii <eliz@gnu.org>
parents: 37978
diff changeset
1273 @item C-c @@ C-h
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1274 Hide the current block (@code{hs-hide-block}).
37997
c329103798cc (Hideshow): Fix the docs of keybindings which used a single `@'.
Eli Zaretskii <eliz@gnu.org>
parents: 37978
diff changeset
1275 @item C-c @@ C-s
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1276 Show the current block (@code{hs-show-block}).
37997
c329103798cc (Hideshow): Fix the docs of keybindings which used a single `@'.
Eli Zaretskii <eliz@gnu.org>
parents: 37978
diff changeset
1277 @item C-c @@ C-c
59371
364d233a8dc3 Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents: 56809
diff changeset
1278 Either hide or show the current block (@code{hs-toggle-hiding}).
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1279 @item S-Mouse-2
59371
364d233a8dc3 Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents: 56809
diff changeset
1280 Either hide or show the block you click on (@code{hs-mouse-toggle-hiding}).
37997
c329103798cc (Hideshow): Fix the docs of keybindings which used a single `@'.
Eli Zaretskii <eliz@gnu.org>
parents: 37978
diff changeset
1281 @item C-c @@ C-M-h
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1282 Hide all top-level blocks (@code{hs-hide-all}).
37997
c329103798cc (Hideshow): Fix the docs of keybindings which used a single `@'.
Eli Zaretskii <eliz@gnu.org>
parents: 37978
diff changeset
1283 @item C-c @@ C-M-s
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1284 Show everything in the buffer (@code{hs-show-all}).
37997
c329103798cc (Hideshow): Fix the docs of keybindings which used a single `@'.
Eli Zaretskii <eliz@gnu.org>
parents: 37978
diff changeset
1285 @item C-c @@ C-l
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1286 Hide all blocks @var{n} levels below this block
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1287 (@code{hs-hide-level}).
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1288 @end table
28329
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1289
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1290 @vindex hs-hide-comments-when-hiding-all
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1291 @vindex hs-isearch-open
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1292 @vindex hs-special-modes-alist
59798
0816b427495a Don't say just "option" when talking about variables.
Richard M. Stallman <rms@gnu.org>
parents: 59475
diff changeset
1293 These variables exist for customizing Hideshow mode.
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1294
28329
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1295 @table @code
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1296 @item hs-hide-comments-when-hiding-all
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1297 Non-@code{nil} says that @kbd{hs-hide-all} should hide comments too.
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1298
28329
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1299 @item hs-isearch-open
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1300 Specifies what kind of hidden blocks to open in Isearch mode.
59371
364d233a8dc3 Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents: 56809
diff changeset
1301 The value should be one of these four symbols:
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1302
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1303 @table @code
38946
9a1045bcf43c Update values of hs-isearch-open.
Richard M. Stallman <rms@gnu.org>
parents: 38871
diff changeset
1304 @item code
9a1045bcf43c Update values of hs-isearch-open.
Richard M. Stallman <rms@gnu.org>
parents: 38871
diff changeset
1305 Open only code blocks.
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1306 @item comment
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1307 Open only comments.
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1308 @item t
38946
9a1045bcf43c Update values of hs-isearch-open.
Richard M. Stallman <rms@gnu.org>
parents: 38871
diff changeset
1309 Open both code blocks and comments.
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1310 @item nil
38946
9a1045bcf43c Update values of hs-isearch-open.
Richard M. Stallman <rms@gnu.org>
parents: 38871
diff changeset
1311 Open neither code blocks nor comments.
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1312 @end table
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1313
28329
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1314 @item hs-special-modes-alist
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1315 A list of elements, each specifying how to initialize Hideshow
38231
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1316 variables for one major mode. See the variable's documentation string
a94c26975e95 Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents: 38212
diff changeset
1317 for more information.
28329
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1318 @end table
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1319
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1320 @node Symbol Completion
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1321 @section Completion for Symbol Names
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1322 @cindex completion (symbol names)
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1323
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1324 In Emacs, completion is something you normally do in the minibuffer.
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1325 But one kind of completion is available in all buffers: completion for
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1326 symbol names.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1327
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1328 @kindex M-TAB
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1329 The character @kbd{M-@key{TAB}} runs a command to complete the
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1330 partial symbol before point against the set of meaningful symbol
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1331 names. This command inserts at point any additional characters that
60112
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
1332 it can determine from the partial name. (If your window manager
60434
e6fb531ca25b (Symbol Completion): C-M-i like M-TAB.
Richard M. Stallman <rms@gnu.org>
parents: 60112
diff changeset
1333 defines @kbd{M-@key{TAB}} to switch windows, you can type
e6fb531ca25b (Symbol Completion): C-M-i like M-TAB.
Richard M. Stallman <rms@gnu.org>
parents: 60112
diff changeset
1334 @kbd{@key{ESC} @key{TAB}} or @kbd{C-M-i}.)
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1335
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1336 If the partial name in the buffer has multiple possible completions
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1337 that differ in the very next character, so that it is impossible to
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1338 complete even one more character, @kbd{M-@key{TAB}} displays a list of
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1339 all possible completions in another window.
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1340
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1341 @cindex tags-based completion
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1342 @cindex Info index completion
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1343 @findex complete-symbol
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1344 In most programming language major modes, @kbd{M-@key{TAB}} runs the
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1345 command @code{complete-symbol}, which provides two kinds of completion.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1346 Normally it does completion based on a tags table (@pxref{Tags}); with a
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1347 numeric argument (regardless of the value), it does completion based on
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1348 the names listed in the Info file indexes for your language. Thus, to
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1349 complete the name of a symbol defined in your own program, use
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1350 @kbd{M-@key{TAB}} with no argument; to complete the name of a standard
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1351 library function, use @kbd{C-u M-@key{TAB}}. Of course, Info-based
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1352 completion works only if there is an Info file for the standard library
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1353 functions of your language, and only if it is installed at your site.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1354
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1355 @cindex Lisp symbol completion
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1356 @cindex completion (Lisp symbols)
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1357 @findex lisp-complete-symbol
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1358 In Emacs-Lisp mode, the name space for completion normally consists of
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1359 nontrivial symbols present in Emacs---those that have function
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1360 definitions, values or properties. However, if there is an
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1361 open-parenthesis immediately before the beginning of the partial symbol,
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1362 only symbols with function definitions are considered as completions.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1363 The command which implements this is @code{lisp-complete-symbol}.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1364
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1365 In Text mode and related modes, @kbd{M-@key{TAB}} completes words
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1366 based on the spell-checker's dictionary. @xref{Spelling}.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1367
30810
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1368 @node Glasses
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1369 @section Glasses minor mode
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1370 @cindex Glasses mode
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1371 @cindex identifiers, making long ones readable
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1372 @cindex StudlyCaps, making them readable
30810
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1373 @findex glasses-mode
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1374
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1375 Glasses minor mode makes @samp{unreadableIdentifiersLikeThis}
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1376 readable by altering the way they display. It knows two different
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1377 ways to do this: by displaying underscores between a lower-case letter
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1378 and the following capital letter, and by emboldening the capital
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1379 letters. It does not alter the buffer text, only the way they
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1380 display, so you can use it even on read-only buffers. You can use the
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1381 command @kbd{M-x glasses-mode} to enable or disable the mode in the
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1382 current buffer; you can also add @code{glasses-mode} to the mode hook
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1383 of the programming language major modes in which you normally want
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48700
diff changeset
1384 to use Glasses mode.
30810
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1385
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1386 @node Misc for Programs
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1387 @section Other Features Useful for Editing Programs
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1388
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1389 A number of Emacs commands that aren't designed specifically for
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1390 editing programs are useful for that nonetheless.
26292
81cd0c225dd9 Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents: 26289
diff changeset
1391
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1392 The Emacs commands that operate on words, sentences and paragraphs
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1393 are useful for editing code. Most symbols names contain words
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1394 (@pxref{Words}); sentences can be found in strings and comments
38867
bd208373c5a8 Many clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38667
diff changeset
1395 (@pxref{Sentences}). Paragraphs in the strict sense can be found in
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1396 program code (in long comments), but the paragraph commands are useful
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1397 in other places too, because programming language major modes define
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1398 paragraphs to begin and end at blank lines (@pxref{Paragraphs}).
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1399 Judicious use of blank lines to make the program clearer will also
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1400 provide useful chunks of text for the paragraph commands to work on.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1401 Auto Fill mode, if enabled in a programming language major mode,
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1402 indents the new lines which it creates.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1403
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1404 The selective display feature is useful for looking at the overall
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1405 structure of a function (@pxref{Selective Display}). This feature
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1406 hides the lines that are indented more than a specified amount.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1407 Programming modes often support Outline minor mode (@pxref{Outline
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1408 Mode}). The Foldout package provides folding-editor features
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1409 (@pxref{Foldout}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1410
38212
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1411 The ``automatic typing'' features may be useful for writing programs.
6b14cc47a4f2 Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents: 38164
diff changeset
1412 @xref{Top,,Autotyping, autotype, Autotyping}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1413
Dave Love <fx@gnu.org>
parents:
diff changeset
1414 @node C Modes
Dave Love <fx@gnu.org>
parents:
diff changeset
1415 @section C and Related Modes
Dave Love <fx@gnu.org>
parents:
diff changeset
1416 @cindex C mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1417 @cindex Java mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1418 @cindex Pike mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1419 @cindex IDL mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1420 @cindex CORBA IDL mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1421 @cindex Objective C mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1422 @cindex C++ mode
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1423 @cindex AWK mode
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1424 @cindex mode, Java
Dave Love <fx@gnu.org>
parents:
diff changeset
1425 @cindex mode, C
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1426 @cindex mode, C++
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1427 @cindex mode, Objective C
Dave Love <fx@gnu.org>
parents:
diff changeset
1428 @cindex mode, CORBA IDL
Dave Love <fx@gnu.org>
parents:
diff changeset
1429 @cindex mode, Pike
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1430 @cindex mode, AWK
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1431
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1432 This section gives a brief description of the special features
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1433 available in C, C++, Objective-C, Java, CORBA IDL, Pike and AWK modes.
53386
8bacf8f6aa0c (C Modes): Fix the xref.
Eli Zaretskii <eliz@is.elta.co.il>
parents: 52401
diff changeset
1434 (These are called ``C mode and related modes.'') @xref{Top, , CC Mode,
8bacf8f6aa0c (C Modes): Fix the xref.
Eli Zaretskii <eliz@is.elta.co.il>
parents: 52401
diff changeset
1435 ccmode, CC Mode}, for a more extensive description of these modes
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1436 and their special features.
28329
6e740f27f255 (Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents: 27221
diff changeset
1437
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1438 @menu
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1439 * Motion in C:: Commands to move by C statements, etc.
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1440 * Electric C:: Colon and other chars can automatically reindent.
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1441 * Hungry Delete:: A more powerful DEL command.
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1442 * Other C Commands:: Filling comments, viewing expansion of macros,
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1443 and other neat features.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1444 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
1445
Dave Love <fx@gnu.org>
parents:
diff changeset
1446 @node Motion in C
Dave Love <fx@gnu.org>
parents:
diff changeset
1447 @subsection C Mode Motion Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
1448
Dave Love <fx@gnu.org>
parents:
diff changeset
1449 This section describes commands for moving point, in C mode and
Dave Love <fx@gnu.org>
parents:
diff changeset
1450 related modes.
Dave Love <fx@gnu.org>
parents:
diff changeset
1451
Dave Love <fx@gnu.org>
parents:
diff changeset
1452 @table @code
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1453 @item M-x c-beginning-of-defun
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1454 @itemx M-x c-end-of-defun
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1455 @findex c-beginning-of-defun
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1456 @findex c-end-of-defun
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1457 Move point to the beginning or end of the current function or
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1458 top-level definition. These are found by searching for the least
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1459 enclosing braces. (By contrast, @code{beginning-of-defun} and
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1460 @code{end-of-defun} search for braces in column zero.) If you are
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1461 editing code where the opening brace of a function isn't placed in
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1462 column zero, you may wish to bind @code{C-M-a} and @code{C-M-e} to
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1463 these commands. @xref{Moving by Defuns}.
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1464
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1465 @item C-c C-u
Dave Love <fx@gnu.org>
parents:
diff changeset
1466 @kindex C-c C-u @r{(C mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
1467 @findex c-up-conditional
Dave Love <fx@gnu.org>
parents:
diff changeset
1468 Move point back to the containing preprocessor conditional, leaving the
Dave Love <fx@gnu.org>
parents:
diff changeset
1469 mark behind. A prefix argument acts as a repeat count. With a negative
Dave Love <fx@gnu.org>
parents:
diff changeset
1470 argument, move point forward to the end of the containing
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1471 preprocessor conditional.
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1472
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1473 @samp{#elif} is equivalent to @samp{#else} followed by @samp{#if}, so
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1474 the function will stop at a @samp{#elif} when going backward, but not
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1475 when going forward.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1476
Dave Love <fx@gnu.org>
parents:
diff changeset
1477 @item C-c C-p
Dave Love <fx@gnu.org>
parents:
diff changeset
1478 @kindex C-c C-p @r{(C mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
1479 @findex c-backward-conditional
Dave Love <fx@gnu.org>
parents:
diff changeset
1480 Move point back over a preprocessor conditional, leaving the mark
Dave Love <fx@gnu.org>
parents:
diff changeset
1481 behind. A prefix argument acts as a repeat count. With a negative
Dave Love <fx@gnu.org>
parents:
diff changeset
1482 argument, move forward.
Dave Love <fx@gnu.org>
parents:
diff changeset
1483
Dave Love <fx@gnu.org>
parents:
diff changeset
1484 @item C-c C-n
Dave Love <fx@gnu.org>
parents:
diff changeset
1485 @kindex C-c C-n @r{(C mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
1486 @findex c-forward-conditional
Dave Love <fx@gnu.org>
parents:
diff changeset
1487 Move point forward across a preprocessor conditional, leaving the mark
Dave Love <fx@gnu.org>
parents:
diff changeset
1488 behind. A prefix argument acts as a repeat count. With a negative
Dave Love <fx@gnu.org>
parents:
diff changeset
1489 argument, move backward.
Dave Love <fx@gnu.org>
parents:
diff changeset
1490
Dave Love <fx@gnu.org>
parents:
diff changeset
1491 @item M-a
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1492 @kindex M-a (C mode)
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1493 @findex c-beginning-of-statement
Dave Love <fx@gnu.org>
parents:
diff changeset
1494 Move point to the beginning of the innermost C statement
Dave Love <fx@gnu.org>
parents:
diff changeset
1495 (@code{c-beginning-of-statement}). If point is already at the beginning
Dave Love <fx@gnu.org>
parents:
diff changeset
1496 of a statement, move to the beginning of the preceding statement. With
Dave Love <fx@gnu.org>
parents:
diff changeset
1497 prefix argument @var{n}, move back @var{n} @minus{} 1 statements.
Dave Love <fx@gnu.org>
parents:
diff changeset
1498
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1499 In comments or in strings which span more than one line, this command
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1500 moves by sentences instead of statements.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1501
Dave Love <fx@gnu.org>
parents:
diff changeset
1502 @item M-e
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1503 @kindex M-e (C mode)
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1504 @findex c-end-of-statement
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1505 Move point to the end of the innermost C statement or sentence; like
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1506 @kbd{M-a} except that it moves in the other direction
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1507 (@code{c-end-of-statement}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1508
Dave Love <fx@gnu.org>
parents:
diff changeset
1509 @item M-x c-backward-into-nomenclature
Dave Love <fx@gnu.org>
parents:
diff changeset
1510 @findex c-backward-into-nomenclature
Dave Love <fx@gnu.org>
parents:
diff changeset
1511 Move point backward to beginning of a C++ nomenclature section or word.
Dave Love <fx@gnu.org>
parents:
diff changeset
1512 With prefix argument @var{n}, move @var{n} times. If @var{n} is
Dave Love <fx@gnu.org>
parents:
diff changeset
1513 negative, move forward. C++ nomenclature means a symbol name in the
Dave Love <fx@gnu.org>
parents:
diff changeset
1514 style of NamingSymbolsWithMixedCaseAndNoUnderlines; each capital letter
Dave Love <fx@gnu.org>
parents:
diff changeset
1515 begins a section or word.
Dave Love <fx@gnu.org>
parents:
diff changeset
1516
Dave Love <fx@gnu.org>
parents:
diff changeset
1517 In the GNU project, we recommend using underscores to separate words
Dave Love <fx@gnu.org>
parents:
diff changeset
1518 within an identifier in C or C++, rather than using case distinctions.
Dave Love <fx@gnu.org>
parents:
diff changeset
1519
Dave Love <fx@gnu.org>
parents:
diff changeset
1520 @item M-x c-forward-into-nomenclature
Dave Love <fx@gnu.org>
parents:
diff changeset
1521 @findex c-forward-into-nomenclature
Dave Love <fx@gnu.org>
parents:
diff changeset
1522 Move point forward to end of a C++ nomenclature section or word.
Dave Love <fx@gnu.org>
parents:
diff changeset
1523 With prefix argument @var{n}, move @var{n} times.
Dave Love <fx@gnu.org>
parents:
diff changeset
1524 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1525
Dave Love <fx@gnu.org>
parents:
diff changeset
1526 @node Electric C
Dave Love <fx@gnu.org>
parents:
diff changeset
1527 @subsection Electric C Characters
Dave Love <fx@gnu.org>
parents:
diff changeset
1528
Dave Love <fx@gnu.org>
parents:
diff changeset
1529 In C mode and related modes, certain printing characters are
Dave Love <fx@gnu.org>
parents:
diff changeset
1530 ``electric''---in addition to inserting themselves, they also reindent
60112
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
1531 the current line, and optionally also insert newlines. The
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
1532 ``electric'' characters are @kbd{@{}, @kbd{@}}, @kbd{:}, @kbd{#},
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
1533 @kbd{;}, @kbd{,}, @kbd{<}, @kbd{>}, @kbd{/}, @kbd{*}, @kbd{(}, and
7cb4576800fa (Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
1534 @kbd{)}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1535
Dave Love <fx@gnu.org>
parents:
diff changeset
1536 Electric characters insert newlines only when the @dfn{auto-newline}
Dave Love <fx@gnu.org>
parents:
diff changeset
1537 feature is enabled (indicated by @samp{/a} in the mode line after the
Dave Love <fx@gnu.org>
parents:
diff changeset
1538 mode name). This feature is controlled by the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1539 @code{c-auto-newline}. You can turn this feature on or off with the
Dave Love <fx@gnu.org>
parents:
diff changeset
1540 command @kbd{C-c C-a}:
Dave Love <fx@gnu.org>
parents:
diff changeset
1541
Dave Love <fx@gnu.org>
parents:
diff changeset
1542 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
1543 @item C-c C-a
Dave Love <fx@gnu.org>
parents:
diff changeset
1544 @kindex C-c C-a @r{(C mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
1545 @findex c-toggle-auto-state
Dave Love <fx@gnu.org>
parents:
diff changeset
1546 Toggle the auto-newline feature (@code{c-toggle-auto-state}). With a
Dave Love <fx@gnu.org>
parents:
diff changeset
1547 prefix argument, this command turns the auto-newline feature on if the
Dave Love <fx@gnu.org>
parents:
diff changeset
1548 argument is positive, and off if it is negative.
Dave Love <fx@gnu.org>
parents:
diff changeset
1549 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1550
Dave Love <fx@gnu.org>
parents:
diff changeset
1551 The colon character is electric because that is appropriate for a
Dave Love <fx@gnu.org>
parents:
diff changeset
1552 single colon. But when you want to insert a double colon in C++, the
Dave Love <fx@gnu.org>
parents:
diff changeset
1553 electric behavior of colon is inconvenient. You can insert a double
Dave Love <fx@gnu.org>
parents:
diff changeset
1554 colon with no reindentation or newlines by typing @kbd{C-c :}:
Dave Love <fx@gnu.org>
parents:
diff changeset
1555
Dave Love <fx@gnu.org>
parents:
diff changeset
1556 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
1557 @item C-c :
44088
d22891dea363 (Electric C Characters, Evaluating Emacs-Lisp Expressions): Use <colon>
Eli Zaretskii <eliz@gnu.org>
parents: 43889
diff changeset
1558 @ifinfo
43889
c5ea7e769ffd (Electric C, Lisp Eval): Avoid makeinfo warnings about colons in indices.
Eli Zaretskii <eliz@gnu.org>
parents: 42675
diff changeset
1559 @c This uses ``colon'' instead of a literal `:' because Info cannot
c5ea7e769ffd (Electric C, Lisp Eval): Avoid makeinfo warnings about colons in indices.
Eli Zaretskii <eliz@gnu.org>
parents: 42675
diff changeset
1560 @c cope with a `:' in a menu
c5ea7e769ffd (Electric C, Lisp Eval): Avoid makeinfo warnings about colons in indices.
Eli Zaretskii <eliz@gnu.org>
parents: 42675
diff changeset
1561 @kindex C-c @key{colon} @r{(C mode)}
44088
d22891dea363 (Electric C Characters, Evaluating Emacs-Lisp Expressions): Use <colon>
Eli Zaretskii <eliz@gnu.org>
parents: 43889
diff changeset
1562 @end ifinfo
d22891dea363 (Electric C Characters, Evaluating Emacs-Lisp Expressions): Use <colon>
Eli Zaretskii <eliz@gnu.org>
parents: 43889
diff changeset
1563 @ifnotinfo
d22891dea363 (Electric C Characters, Evaluating Emacs-Lisp Expressions): Use <colon>
Eli Zaretskii <eliz@gnu.org>
parents: 43889
diff changeset
1564 @kindex C-c : @r{(C mode)}
d22891dea363 (Electric C Characters, Evaluating Emacs-Lisp Expressions): Use <colon>
Eli Zaretskii <eliz@gnu.org>
parents: 43889
diff changeset
1565 @end ifnotinfo
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1566 @findex c-scope-operator
Dave Love <fx@gnu.org>
parents:
diff changeset
1567 Insert a double colon scope operator at point, without reindenting the
Dave Love <fx@gnu.org>
parents:
diff changeset
1568 line or adding any newlines (@code{c-scope-operator}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1569 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1570
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1571 @vindex c-electric-pound-behavior
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1572 The electric @kbd{#} key reindents the line if it appears to be the
Dave Love <fx@gnu.org>
parents:
diff changeset
1573 beginning of a preprocessor directive. This happens when the value of
Dave Love <fx@gnu.org>
parents:
diff changeset
1574 @code{c-electric-pound-behavior} is @code{(alignleft)}. You can turn
Dave Love <fx@gnu.org>
parents:
diff changeset
1575 this feature off by setting @code{c-electric-pound-behavior} to
Dave Love <fx@gnu.org>
parents:
diff changeset
1576 @code{nil}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1577
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1578 @vindex c-hanging-braces-alist
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1579 The variable @code{c-hanging-braces-alist} controls the insertion of
Dave Love <fx@gnu.org>
parents:
diff changeset
1580 newlines before and after inserted braces. It is an association list
Dave Love <fx@gnu.org>
parents:
diff changeset
1581 with elements of the following form: @code{(@var{syntactic-symbol}
Dave Love <fx@gnu.org>
parents:
diff changeset
1582 . @var{nl-list})}. Most of the syntactic symbols that appear in
Dave Love <fx@gnu.org>
parents:
diff changeset
1583 @code{c-offsets-alist} are meaningful here as well.
Dave Love <fx@gnu.org>
parents:
diff changeset
1584
Dave Love <fx@gnu.org>
parents:
diff changeset
1585 The list @var{nl-list} may contain either of the symbols
Dave Love <fx@gnu.org>
parents:
diff changeset
1586 @code{before} or @code{after}, or both; or it may be @code{nil}. When a
Dave Love <fx@gnu.org>
parents:
diff changeset
1587 brace is inserted, the syntactic context it defines is looked up in
Dave Love <fx@gnu.org>
parents:
diff changeset
1588 @code{c-hanging-braces-alist}; if it is found, the @var{nl-list} is used
Dave Love <fx@gnu.org>
parents:
diff changeset
1589 to determine where newlines are inserted: either before the brace,
Dave Love <fx@gnu.org>
parents:
diff changeset
1590 after, or both. If not found, the default is to insert a newline both
Dave Love <fx@gnu.org>
parents:
diff changeset
1591 before and after braces.
Dave Love <fx@gnu.org>
parents:
diff changeset
1592
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1593 @vindex c-hanging-colons-alist
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1594 The variable @code{c-hanging-colons-alist} controls the insertion of
Dave Love <fx@gnu.org>
parents:
diff changeset
1595 newlines before and after inserted colons. It is an association list
Dave Love <fx@gnu.org>
parents:
diff changeset
1596 with elements of the following form: @code{(@var{syntactic-symbol}
Dave Love <fx@gnu.org>
parents:
diff changeset
1597 . @var{nl-list})}. The list @var{nl-list} may contain either of the
Dave Love <fx@gnu.org>
parents:
diff changeset
1598 symbols @code{before} or @code{after}, or both; or it may be @code{nil}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1599
Dave Love <fx@gnu.org>
parents:
diff changeset
1600 When a colon is inserted, the syntactic symbol it defines is looked
Dave Love <fx@gnu.org>
parents:
diff changeset
1601 up in this list, and if found, the @var{nl-list} is used to determine
Dave Love <fx@gnu.org>
parents:
diff changeset
1602 where newlines are inserted: either before the brace, after, or both.
Dave Love <fx@gnu.org>
parents:
diff changeset
1603 If the syntactic symbol is not found in this list, no newlines are
Dave Love <fx@gnu.org>
parents:
diff changeset
1604 inserted.
Dave Love <fx@gnu.org>
parents:
diff changeset
1605
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1606 @vindex c-cleanup-list
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1607 Electric characters can also delete newlines automatically when the
Dave Love <fx@gnu.org>
parents:
diff changeset
1608 auto-newline feature is enabled. This feature makes auto-newline more
Dave Love <fx@gnu.org>
parents:
diff changeset
1609 acceptable, by deleting the newlines in the most common cases where you
Dave Love <fx@gnu.org>
parents:
diff changeset
1610 do not want them. Emacs can recognize several cases in which deleting a
Dave Love <fx@gnu.org>
parents:
diff changeset
1611 newline might be desirable; by setting the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1612 @code{c-cleanup-list}, you can specify @emph{which} of these cases that
Dave Love <fx@gnu.org>
parents:
diff changeset
1613 should happen. The variable's value is a list of symbols, each
Dave Love <fx@gnu.org>
parents:
diff changeset
1614 describing one case for possible deletion of a newline. Here are the
Dave Love <fx@gnu.org>
parents:
diff changeset
1615 meaningful symbols, and their meanings:
Dave Love <fx@gnu.org>
parents:
diff changeset
1616
Dave Love <fx@gnu.org>
parents:
diff changeset
1617 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
1618 @item brace-catch-brace
Dave Love <fx@gnu.org>
parents:
diff changeset
1619 Clean up @samp{@} catch (@var{condition}) @{} constructs by placing the
Dave Love <fx@gnu.org>
parents:
diff changeset
1620 entire construct on a single line. The clean-up occurs when you type
Dave Love <fx@gnu.org>
parents:
diff changeset
1621 the @samp{@{}, if there is nothing between the braces aside from
Dave Love <fx@gnu.org>
parents:
diff changeset
1622 @code{catch} and @var{condition}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1623
Dave Love <fx@gnu.org>
parents:
diff changeset
1624 @item brace-else-brace
Dave Love <fx@gnu.org>
parents:
diff changeset
1625 Clean up @samp{@} else @{} constructs by placing the entire construct on
Dave Love <fx@gnu.org>
parents:
diff changeset
1626 a single line. The clean-up occurs when you type the @samp{@{} after
Dave Love <fx@gnu.org>
parents:
diff changeset
1627 the @code{else}, but only if there is nothing but white space between
Dave Love <fx@gnu.org>
parents:
diff changeset
1628 the braces and the @code{else}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1629
Dave Love <fx@gnu.org>
parents:
diff changeset
1630 @item brace-elseif-brace
Dave Love <fx@gnu.org>
parents:
diff changeset
1631 Clean up @samp{@} else if (@dots{}) @{} constructs by placing the entire
Dave Love <fx@gnu.org>
parents:
diff changeset
1632 construct on a single line. The clean-up occurs when you type the
Dave Love <fx@gnu.org>
parents:
diff changeset
1633 @samp{@{}, if there is nothing but white space between the @samp{@}} and
Dave Love <fx@gnu.org>
parents:
diff changeset
1634 @samp{@{} aside from the keywords and the @code{if}-condition.
Dave Love <fx@gnu.org>
parents:
diff changeset
1635
Dave Love <fx@gnu.org>
parents:
diff changeset
1636 @item empty-defun-braces
Dave Love <fx@gnu.org>
parents:
diff changeset
1637 Clean up empty defun braces by placing the braces on the same
Dave Love <fx@gnu.org>
parents:
diff changeset
1638 line. Clean-up occurs when you type the closing brace.
Dave Love <fx@gnu.org>
parents:
diff changeset
1639
Dave Love <fx@gnu.org>
parents:
diff changeset
1640 @item defun-close-semi
Dave Love <fx@gnu.org>
parents:
diff changeset
1641 Clean up the semicolon after a @code{struct} or similar type
Dave Love <fx@gnu.org>
parents:
diff changeset
1642 declaration, by placing the semicolon on the same line as the closing
Dave Love <fx@gnu.org>
parents:
diff changeset
1643 brace. Clean-up occurs when you type the semicolon.
Dave Love <fx@gnu.org>
parents:
diff changeset
1644
Dave Love <fx@gnu.org>
parents:
diff changeset
1645 @item list-close-comma
Dave Love <fx@gnu.org>
parents:
diff changeset
1646 Clean up commas following braces in array and aggregate
Dave Love <fx@gnu.org>
parents:
diff changeset
1647 initializers. Clean-up occurs when you type the comma.
Dave Love <fx@gnu.org>
parents:
diff changeset
1648
Dave Love <fx@gnu.org>
parents:
diff changeset
1649 @item scope-operator
Dave Love <fx@gnu.org>
parents:
diff changeset
1650 Clean up double colons which may designate a C++ scope operator, by
Dave Love <fx@gnu.org>
parents:
diff changeset
1651 placing the colons together. Clean-up occurs when you type the second
Dave Love <fx@gnu.org>
parents:
diff changeset
1652 colon, but only when the two colons are separated by nothing but
Dave Love <fx@gnu.org>
parents:
diff changeset
1653 whitespace.
Dave Love <fx@gnu.org>
parents:
diff changeset
1654 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1655
Dave Love <fx@gnu.org>
parents:
diff changeset
1656 @node Hungry Delete
Dave Love <fx@gnu.org>
parents:
diff changeset
1657 @subsection Hungry Delete Feature in C
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1658 @cindex hungry deletion (C Mode)
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1659
Dave Love <fx@gnu.org>
parents:
diff changeset
1660 When the @dfn{hungry-delete} feature is enabled (indicated by
Dave Love <fx@gnu.org>
parents:
diff changeset
1661 @samp{/h} or @samp{/ah} in the mode line after the mode name), a single
Dave Love <fx@gnu.org>
parents:
diff changeset
1662 @key{DEL} command deletes all preceding whitespace, not just one space.
Dave Love <fx@gnu.org>
parents:
diff changeset
1663 To turn this feature on or off, use @kbd{C-c C-d}:
Dave Love <fx@gnu.org>
parents:
diff changeset
1664
Dave Love <fx@gnu.org>
parents:
diff changeset
1665 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
1666 @item C-c C-d
Dave Love <fx@gnu.org>
parents:
diff changeset
1667 @kindex C-c C-d @r{(C mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
1668 @findex c-toggle-hungry-state
Dave Love <fx@gnu.org>
parents:
diff changeset
1669 Toggle the hungry-delete feature (@code{c-toggle-hungry-state}). With a
Dave Love <fx@gnu.org>
parents:
diff changeset
1670 prefix argument, this command turns the hungry-delete feature on if the
Dave Love <fx@gnu.org>
parents:
diff changeset
1671 argument is positive, and off if it is negative.
Dave Love <fx@gnu.org>
parents:
diff changeset
1672
Dave Love <fx@gnu.org>
parents:
diff changeset
1673 @item C-c C-t
Dave Love <fx@gnu.org>
parents:
diff changeset
1674 @kindex C-c C-t @r{(C mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
1675 @findex c-toggle-auto-hungry-state
Dave Love <fx@gnu.org>
parents:
diff changeset
1676 Toggle the auto-newline and hungry-delete features, both at once
Dave Love <fx@gnu.org>
parents:
diff changeset
1677 (@code{c-toggle-auto-hungry-state}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1678 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1679
Dave Love <fx@gnu.org>
parents:
diff changeset
1680 @vindex c-hungry-delete-key
Dave Love <fx@gnu.org>
parents:
diff changeset
1681 The variable @code{c-hungry-delete-key} controls whether the
Dave Love <fx@gnu.org>
parents:
diff changeset
1682 hungry-delete feature is enabled.
Dave Love <fx@gnu.org>
parents:
diff changeset
1683
Dave Love <fx@gnu.org>
parents:
diff changeset
1684 @node Other C Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
1685 @subsection Other Commands for C Mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1686
Dave Love <fx@gnu.org>
parents:
diff changeset
1687 @table @kbd
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1688 @item M-x c-context-line-break
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1689 @findex c-context-line-break
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1690 This command inserts a line break and indents the new line in a manner
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1691 appropriate to the context. In normal code, it does the work of
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1692 @kbd{C-j} (@code{newline-and-indent}), in a C preprocessor line it
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1693 additionally inserts a @samp{\} at the line break, and within comments
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1694 it's like @kbd{M-j} (@code{c-indent-new-comment-line}).
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1695
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1696 @code{c-context-line-break} isn't bound to a key by default, but it
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1697 needs a binding to be useful. The following code will bind it to
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1698 @kbd{C-j}.
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1699 @example
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1700 (define-key c-mode-base-map "\C-j" 'c-context-line-break)
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1701 @end example
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1702
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1703 @item C-M-h
Dave Love <fx@gnu.org>
parents:
diff changeset
1704 Put mark at the end of a function definition, and put point at the
Dave Love <fx@gnu.org>
parents:
diff changeset
1705 beginning (@code{c-mark-function}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1706
Dave Love <fx@gnu.org>
parents:
diff changeset
1707 @item M-q
Dave Love <fx@gnu.org>
parents:
diff changeset
1708 @kindex M-q @r{(C mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
1709 @findex c-fill-paragraph
Dave Love <fx@gnu.org>
parents:
diff changeset
1710 Fill a paragraph, handling C and C++ comments (@code{c-fill-paragraph}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1711 If any part of the current line is a comment or within a comment, this
Dave Love <fx@gnu.org>
parents:
diff changeset
1712 command fills the comment or the paragraph of it that point is in,
Dave Love <fx@gnu.org>
parents:
diff changeset
1713 preserving the comment indentation and comment delimiters.
Dave Love <fx@gnu.org>
parents:
diff changeset
1714
Dave Love <fx@gnu.org>
parents:
diff changeset
1715 @item C-c C-e
Dave Love <fx@gnu.org>
parents:
diff changeset
1716 @cindex macro expansion in C
Dave Love <fx@gnu.org>
parents:
diff changeset
1717 @cindex expansion of C macros
Dave Love <fx@gnu.org>
parents:
diff changeset
1718 @findex c-macro-expand
Dave Love <fx@gnu.org>
parents:
diff changeset
1719 @kindex C-c C-e @r{(C mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
1720 Run the C preprocessor on the text in the region, and show the result,
Dave Love <fx@gnu.org>
parents:
diff changeset
1721 which includes the expansion of all the macro calls
Dave Love <fx@gnu.org>
parents:
diff changeset
1722 (@code{c-macro-expand}). The buffer text before the region is also
Dave Love <fx@gnu.org>
parents:
diff changeset
1723 included in preprocessing, for the sake of macros defined there, but the
Dave Love <fx@gnu.org>
parents:
diff changeset
1724 output from this part isn't shown.
Dave Love <fx@gnu.org>
parents:
diff changeset
1725
Dave Love <fx@gnu.org>
parents:
diff changeset
1726 When you are debugging C code that uses macros, sometimes it is hard to
Dave Love <fx@gnu.org>
parents:
diff changeset
1727 figure out precisely how the macros expand. With this command, you
Dave Love <fx@gnu.org>
parents:
diff changeset
1728 don't have to figure it out; you can see the expansions.
Dave Love <fx@gnu.org>
parents:
diff changeset
1729
Dave Love <fx@gnu.org>
parents:
diff changeset
1730 @item C-c C-\
Dave Love <fx@gnu.org>
parents:
diff changeset
1731 @findex c-backslash-region
Dave Love <fx@gnu.org>
parents:
diff changeset
1732 @kindex C-c C-\ @r{(C mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
1733 Insert or align @samp{\} characters at the ends of the lines of the
Dave Love <fx@gnu.org>
parents:
diff changeset
1734 region (@code{c-backslash-region}). This is useful after writing or
Dave Love <fx@gnu.org>
parents:
diff changeset
1735 editing a C macro definition.
Dave Love <fx@gnu.org>
parents:
diff changeset
1736
Dave Love <fx@gnu.org>
parents:
diff changeset
1737 If a line already ends in @samp{\}, this command adjusts the amount of
Dave Love <fx@gnu.org>
parents:
diff changeset
1738 whitespace before it. Otherwise, it inserts a new @samp{\}. However,
Dave Love <fx@gnu.org>
parents:
diff changeset
1739 the last line in the region is treated specially; no @samp{\} is
Dave Love <fx@gnu.org>
parents:
diff changeset
1740 inserted on that line, and any @samp{\} there is deleted.
Dave Love <fx@gnu.org>
parents:
diff changeset
1741
Dave Love <fx@gnu.org>
parents:
diff changeset
1742 @item M-x cpp-highlight-buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1743 @cindex preprocessor highlighting
Dave Love <fx@gnu.org>
parents:
diff changeset
1744 @findex cpp-highlight-buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1745 Highlight parts of the text according to its preprocessor conditionals.
Dave Love <fx@gnu.org>
parents:
diff changeset
1746 This command displays another buffer named @samp{*CPP Edit*}, which
Dave Love <fx@gnu.org>
parents:
diff changeset
1747 serves as a graphic menu for selecting how to display particular kinds
Dave Love <fx@gnu.org>
parents:
diff changeset
1748 of conditionals and their contents. After changing various settings,
Dave Love <fx@gnu.org>
parents:
diff changeset
1749 click on @samp{[A]pply these settings} (or go to that buffer and type
Dave Love <fx@gnu.org>
parents:
diff changeset
1750 @kbd{a}) to rehighlight the C mode buffer accordingly.
Dave Love <fx@gnu.org>
parents:
diff changeset
1751
Dave Love <fx@gnu.org>
parents:
diff changeset
1752 @item C-c C-s
Dave Love <fx@gnu.org>
parents:
diff changeset
1753 @findex c-show-syntactic-information
Dave Love <fx@gnu.org>
parents:
diff changeset
1754 @kindex C-c C-s @r{(C mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
1755 Display the syntactic information about the current source line
59461
26a204697252 Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents: 59371
diff changeset
1756 (@code{c-show-syntactic-information}). This information directs how
26a204697252 Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents: 59371
diff changeset
1757 the line is indented.
30810
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1758
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1759 @item M-x cwarn-mode
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1760 @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
1761 @findex cwarn-mode
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1762 @findex global-cwarn-mode
56086
c5c08e52e9d6 Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents: 54272
diff changeset
1763 @vindex global-cwarn-mode
30810
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1764 @cindex CWarn mode
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1765 @cindex suspicious constructions in C, C++
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1766 CWarn minor mode highlights certain suspicious C and C++ constructions:
30810
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1767
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1768 @itemize @bullet{}
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1769 @item
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1770 Assignments inside expressions.
30810
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1771 @item
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1772 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
1773 (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
1774 @item
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1775 C++ functions with reference parameters.
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1776 @end itemize
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1777
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1778 @noindent
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1779 You can enable the mode for one buffer with the command @kbd{M-x
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1780 cwarn-mode}, or for all suitable buffers with the command @kbd{M-x
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1781 global-cwarn-mode} or by customizing the variable
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1782 @code{global-cwarn-mode}. You must also enable Font Lock mode to make
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1783 it work.
30810
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1784
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1785 @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
1786 @findex hide-ifdef-mode
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1787 @cindex Hide-ifdef mode
6c6b0162bae2 Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents: 30793
diff changeset
1788 Hide-ifdef minor mode hides selected code within @samp{#if} and
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1789 @samp{#ifdef} preprocessor blocks. See the documentation string of
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1790 @code{hide-ifdef-mode} for more information.
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1791
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1792 @item M-x ff-find-related-file
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1793 @cindex related files
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1794 @findex ff-find-related-file
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1795 @vindex ff-related-file-alist
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1796 Find a file ``related'' in a special way to the file visited by the
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1797 current buffer. Typically this will be the header file corresponding
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1798 to a C/C++ source file, or vice versa. The variable
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1799 @code{ff-related-file-alist} specifies how to compute related file
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1800 names.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1801 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1802
Dave Love <fx@gnu.org>
parents:
diff changeset
1803 @node Fortran
Dave Love <fx@gnu.org>
parents:
diff changeset
1804 @section Fortran Mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1805 @cindex Fortran mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1806 @cindex mode, Fortran
Dave Love <fx@gnu.org>
parents:
diff changeset
1807
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1808 Fortran mode provides special motion commands for Fortran statements
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1809 and subprograms, and indentation commands that understand Fortran
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1810 conventions of nesting, line numbers and continuation statements.
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1811 Fortran mode has support for Auto Fill mode that breaks long lines into
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1812 proper Fortran continuation lines.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1813
Dave Love <fx@gnu.org>
parents:
diff changeset
1814 Special commands for comments are provided because Fortran comments
Dave Love <fx@gnu.org>
parents:
diff changeset
1815 are unlike those of other languages. Built-in abbrevs optionally save
Dave Love <fx@gnu.org>
parents:
diff changeset
1816 typing when you insert Fortran keywords.
Dave Love <fx@gnu.org>
parents:
diff changeset
1817
Dave Love <fx@gnu.org>
parents:
diff changeset
1818 Use @kbd{M-x fortran-mode} to switch to this major mode. This command
Dave Love <fx@gnu.org>
parents:
diff changeset
1819 runs the hook @code{fortran-mode-hook} (@pxref{Hooks}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1820
36263
11db0318031d Remove redundant index entries.
Eli Zaretskii <eliz@gnu.org>
parents: 36198
diff changeset
1821 @cindex Fortran77 and Fortran90
26106
19c8f63a59f1 List additional modes.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1822 @findex f90-mode
19c8f63a59f1 List additional modes.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1823 @findex fortran-mode
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1824 Fortran mode is meant for editing Fortran77 ``fixed format'' (and also
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1825 ``tab format'') source code. For editing the modern Fortran90 or
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1826 Fortran95 ``free format'' source code, use F90 mode (@code{f90-mode}).
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1827 Emacs normally uses Fortran mode for files with extension @samp{.f},
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1828 @samp{.F} or @samp{.for}, and F90 mode for the extension @samp{.f90} and
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1829 @samp{.f95}. GNU Fortran supports both kinds of format.
26106
19c8f63a59f1 List additional modes.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1830
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1831 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
1832 * Motion: Fortran Motion. Moving point by statements or subprograms.
Dave Love <fx@gnu.org>
parents:
diff changeset
1833 * Indent: Fortran Indent. Indentation commands for Fortran.
Dave Love <fx@gnu.org>
parents:
diff changeset
1834 * Comments: Fortran Comments. Inserting and aligning comments.
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1835 * Autofill: Fortran Autofill. Auto fill support for Fortran.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1836 * Columns: Fortran Columns. Measuring columns for valid Fortran.
Dave Love <fx@gnu.org>
parents:
diff changeset
1837 * Abbrev: Fortran Abbrev. Built-in abbrevs for Fortran keywords.
Dave Love <fx@gnu.org>
parents:
diff changeset
1838 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
1839
Dave Love <fx@gnu.org>
parents:
diff changeset
1840 @node Fortran Motion
Dave Love <fx@gnu.org>
parents:
diff changeset
1841 @subsection Motion Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
1842
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1843 In addition to the normal commands for moving by and operating on
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1844 ``defuns'' (Fortran subprograms---functions and subroutines, as well as
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1845 modules for F90 mode), Fortran mode provides special commands to move by
61108
6ce7613a2c0e (Fortran Motion): Add fortran-end-of-block,
Glenn Morris <rgm@gnu.org>
parents: 61099
diff changeset
1846 statements and other program units.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1847
Dave Love <fx@gnu.org>
parents:
diff changeset
1848 @table @kbd
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1849 @kindex C-c C-n @r{(Fortran mode)}
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1850 @findex fortran-next-statement
60801
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1851 @findex f90-next-statement
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1852 @item C-c C-n
60801
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1853 Move to the beginning of the next statement
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1854 (@code{fortran-next-statement}/@code{f90-next-statement}).
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1855
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1856 @kindex C-c C-p @r{(Fortran mode)}
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1857 @findex fortran-previous-statement
60801
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1858 @findex f90-previous-statement
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1859 @item C-c C-p
60801
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1860 Move to the beginning of the previous statement
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1861 (@code{fortran-previous-statement}/@code{f90-previous-statement}).
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1862 If there is no previous statement (i.e. if called from the first
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1863 statement in the buffer), move to the start of the buffer.
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1864
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1865 @kindex C-c C-e @r{(F90 mode)}
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1866 @findex f90-next-block
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1867 @item C-c C-e
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1868 Move point forward to the start of the next code block
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1869 (@code{f90-next-block}). A code block is a subroutine,
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1870 @code{if}--@code{endif} statement, and so forth. This command exists
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1871 for F90 mode only, not Fortran mode. With a numeric argument, this
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1872 moves forward that many blocks.
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1873
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1874 @kindex C-c C-a @r{(F90 mode)}
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1875 @findex f90-previous-block
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1876 @item C-c C-a
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1877 Move point backward to the previous code block
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1878 (@code{f90-previous-block}). This is like @code{f90-next-block}, but
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1879 moves backwards.
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1880
61108
6ce7613a2c0e (Fortran Motion): Add fortran-end-of-block,
Glenn Morris <rgm@gnu.org>
parents: 61099
diff changeset
1881 @kindex C-M-n @r{(Fortran mode)}
6ce7613a2c0e (Fortran Motion): Add fortran-end-of-block,
Glenn Morris <rgm@gnu.org>
parents: 61099
diff changeset
1882 @findex fortran-end-of-block
60801
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1883 @findex f90-end-of-block
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1884 @item C-M-n
61133
2338a101c46a (Fortran Motion): Fix previous change.
Glenn Morris <rgm@gnu.org>
parents: 61108
diff changeset
1885 Move to the end of the current code block
2338a101c46a (Fortran Motion): Fix previous change.
Glenn Morris <rgm@gnu.org>
parents: 61108
diff changeset
1886 (@code{fortran-end-of-block}/@code{f90-end-of-block}). With a numeric
2338a101c46a (Fortran Motion): Fix previous change.
Glenn Morris <rgm@gnu.org>
parents: 61108
diff changeset
1887 agument, move forward that number of blocks. The mark is set before
2338a101c46a (Fortran Motion): Fix previous change.
Glenn Morris <rgm@gnu.org>
parents: 61108
diff changeset
1888 moving point. The F90 mode version of this command checks for
2338a101c46a (Fortran Motion): Fix previous change.
Glenn Morris <rgm@gnu.org>
parents: 61108
diff changeset
1889 consistency of block types and labels (if present), but it does not
2338a101c46a (Fortran Motion): Fix previous change.
Glenn Morris <rgm@gnu.org>
parents: 61108
diff changeset
1890 check the outermost block since that may be incomplete.
60801
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1891
61108
6ce7613a2c0e (Fortran Motion): Add fortran-end-of-block,
Glenn Morris <rgm@gnu.org>
parents: 61099
diff changeset
1892 @kindex C-M-p @r{(Fortran mode)}
6ce7613a2c0e (Fortran Motion): Add fortran-end-of-block,
Glenn Morris <rgm@gnu.org>
parents: 61099
diff changeset
1893 @findex fortran-beginning-of-block
60801
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1894 @findex f90-beginning-of-block
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1895 @item C-M-p
3b533b854268 (Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents: 60434
diff changeset
1896 Move to the start of the current code block
61133
2338a101c46a (Fortran Motion): Fix previous change.
Glenn Morris <rgm@gnu.org>
parents: 61108
diff changeset
1897 (@code{fortran-beginning-of-block}/@code{f90-beginning-of-block}). This
61108
6ce7613a2c0e (Fortran Motion): Add fortran-end-of-block,
Glenn Morris <rgm@gnu.org>
parents: 61099
diff changeset
1898 is like @code{fortran-end-of-block}, but moves backwards.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1899 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1900
Dave Love <fx@gnu.org>
parents:
diff changeset
1901 @node Fortran Indent
Dave Love <fx@gnu.org>
parents:
diff changeset
1902 @subsection Fortran Indentation
Dave Love <fx@gnu.org>
parents:
diff changeset
1903
Dave Love <fx@gnu.org>
parents:
diff changeset
1904 Special commands and features are needed for indenting Fortran code in
Dave Love <fx@gnu.org>
parents:
diff changeset
1905 order to make sure various syntactic entities (line numbers, comment line
Dave Love <fx@gnu.org>
parents:
diff changeset
1906 indicators and continuation line flags) appear in the columns that are
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1907 required for standard, fixed (or tab) format Fortran.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1908
Dave Love <fx@gnu.org>
parents:
diff changeset
1909 @menu
27221
4a723a7bc25a Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents: 26462
diff changeset
1910 * Commands: ForIndent Commands. Commands for indenting and filling Fortran.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1911 * Contline: ForIndent Cont. How continuation lines indent.
Dave Love <fx@gnu.org>
parents:
diff changeset
1912 * Numbers: ForIndent Num. How line numbers auto-indent.
Dave Love <fx@gnu.org>
parents:
diff changeset
1913 * Conv: ForIndent Conv. Conventions you must obey to avoid trouble.
Dave Love <fx@gnu.org>
parents:
diff changeset
1914 * Vars: ForIndent Vars. Variables controlling Fortran indent style.
Dave Love <fx@gnu.org>
parents:
diff changeset
1915 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
1916
Dave Love <fx@gnu.org>
parents:
diff changeset
1917 @node ForIndent Commands
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1918 @subsubsection Fortran Indentation and Filling Commands
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1919
Dave Love <fx@gnu.org>
parents:
diff changeset
1920 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
1921 @item C-M-j
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1922 Break the current line at point and set up a continuation line
27221
4a723a7bc25a Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents: 26462
diff changeset
1923 (@code{fortran-split-line}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1924 @item M-^
27221
4a723a7bc25a Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents: 26462
diff changeset
1925 Join this line to the previous line (@code{fortran-join-line}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1926 @item C-M-q
Dave Love <fx@gnu.org>
parents:
diff changeset
1927 Indent all the lines of the subprogram point is in
Dave Love <fx@gnu.org>
parents:
diff changeset
1928 (@code{fortran-indent-subprogram}).
27221
4a723a7bc25a Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents: 26462
diff changeset
1929 @item M-q
4a723a7bc25a Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents: 26462
diff changeset
1930 Fill a comment block or statement.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1931 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1932
Dave Love <fx@gnu.org>
parents:
diff changeset
1933 @kindex C-M-q @r{(Fortran mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
1934 @findex fortran-indent-subprogram
Dave Love <fx@gnu.org>
parents:
diff changeset
1935 The key @kbd{C-M-q} runs @code{fortran-indent-subprogram}, a command
Dave Love <fx@gnu.org>
parents:
diff changeset
1936 to reindent all the lines of the Fortran subprogram (function or
Dave Love <fx@gnu.org>
parents:
diff changeset
1937 subroutine) containing point.
Dave Love <fx@gnu.org>
parents:
diff changeset
1938
Dave Love <fx@gnu.org>
parents:
diff changeset
1939 @kindex C-M-j @r{(Fortran mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
1940 @findex fortran-split-line
Dave Love <fx@gnu.org>
parents:
diff changeset
1941 The key @kbd{C-M-j} runs @code{fortran-split-line}, which splits
Dave Love <fx@gnu.org>
parents:
diff changeset
1942 a line in the appropriate fashion for Fortran. In a non-comment line,
Dave Love <fx@gnu.org>
parents:
diff changeset
1943 the second half becomes a continuation line and is indented
Dave Love <fx@gnu.org>
parents:
diff changeset
1944 accordingly. In a comment line, both halves become separate comment
Dave Love <fx@gnu.org>
parents:
diff changeset
1945 lines.
Dave Love <fx@gnu.org>
parents:
diff changeset
1946
Dave Love <fx@gnu.org>
parents:
diff changeset
1947 @kindex M-^ @r{(Fortran mode)}
26106
19c8f63a59f1 List additional modes.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1948 @kindex C-c C-d @r{(Fortran mode)}
19c8f63a59f1 List additional modes.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1949 @findex fortran-join-line
27221
4a723a7bc25a Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents: 26462
diff changeset
1950 @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
1951 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
1952 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
1953 continuation line when this command is invoked.
19c8f63a59f1 List additional modes.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1954
27221
4a723a7bc25a Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents: 26462
diff changeset
1955 @kindex M-q @r{(Fortran mode)}
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1956 @kbd{M-q} in Fortran mode fills the comment block or statement that
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
1957 point is in. This removes any excess statement continuations.
27221
4a723a7bc25a Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents: 26462
diff changeset
1958
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1959 @node ForIndent Cont
Dave Love <fx@gnu.org>
parents:
diff changeset
1960 @subsubsection Continuation Lines
Dave Love <fx@gnu.org>
parents:
diff changeset
1961 @cindex Fortran continuation lines
Dave Love <fx@gnu.org>
parents:
diff changeset
1962
Dave Love <fx@gnu.org>
parents:
diff changeset
1963 @vindex fortran-continuation-string
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1964 Most Fortran77 compilers allow two ways of writing continuation lines.
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1965 If the first non-space character on a line is in column 5, then that
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1966 line is a continuation of the previous line. We call this @dfn{fixed
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1967 format}. (In GNU Emacs we always count columns from 0; but note that
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1968 the Fortran standard counts from 1.) The variable
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1969 @code{fortran-continuation-string} specifies what character to put in
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1970 column 5. A line that starts with a tab character followed by any digit
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1971 except @samp{0} is also a continuation line. We call this style of
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1972 continuation @dfn{tab format}. (Fortran90 introduced ``free format'',
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1973 with another style of continuation lines).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1974
Dave Love <fx@gnu.org>
parents:
diff changeset
1975 @vindex indent-tabs-mode @r{(Fortran mode)}
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1976 @vindex fortran-analyze-depth
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1977 @vindex fortran-tab-mode-default
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1978 Fortran mode can use either style of continuation line. When you
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1979 enter Fortran mode, it tries to deduce the proper continuation style
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1980 automatically from the buffer contents. It does this by scanning up to
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1981 @code{fortran-analyze-depth} (default 100) lines from the start of the
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1982 buffer. The first line that begins with either a tab character or six
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1983 spaces determines the choice. If the scan fails (for example, if the
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1984 buffer is new and therefore empty), the value of
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1985 @code{fortran-tab-mode-default} (@code{nil} for fixed format, and
61057
0e16dd096eb2 (Fortran): Small fixes to previous changes.
Richard M. Stallman <rms@gnu.org>
parents: 61053
diff changeset
1986 non-@code{nil} for tab format) is used. @samp{/t} in the mode line
0e16dd096eb2 (Fortran): Small fixes to previous changes.
Richard M. Stallman <rms@gnu.org>
parents: 61053
diff changeset
1987 indicates tab format is selected. Fortran mode sets the value of
0e16dd096eb2 (Fortran): Small fixes to previous changes.
Richard M. Stallman <rms@gnu.org>
parents: 61053
diff changeset
1988 @code{indent-tabs-mode} accordingly (@pxref{Just Spaces}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1989
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1990 If the text on a line starts with the Fortran continuation marker
61057
0e16dd096eb2 (Fortran): Small fixes to previous changes.
Richard M. Stallman <rms@gnu.org>
parents: 61053
diff changeset
1991 @samp{$}, or if it begins with any non-whitespace character in column
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1992 5, Fortran mode treats it as a continuation line. When you indent a
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1993 continuation line with @key{TAB}, it converts the line to the current
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1994 continuation style. When you split a Fortran statement with
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1995 @kbd{C-M-j}, the continuation marker on the newline is created according
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
1996 to the continuation style.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1997
Dave Love <fx@gnu.org>
parents:
diff changeset
1998 The setting of continuation style affects several other aspects of
Dave Love <fx@gnu.org>
parents:
diff changeset
1999 editing in Fortran mode. In fixed format mode, the minimum column
Dave Love <fx@gnu.org>
parents:
diff changeset
2000 number for the body of a statement is 6. Lines inside of Fortran
Dave Love <fx@gnu.org>
parents:
diff changeset
2001 blocks that are indented to larger column numbers always use only the
Dave Love <fx@gnu.org>
parents:
diff changeset
2002 space character for whitespace. In tab format mode, the minimum
Dave Love <fx@gnu.org>
parents:
diff changeset
2003 column number for the statement body is 8, and the whitespace before
Dave Love <fx@gnu.org>
parents:
diff changeset
2004 column 8 must always consist of one tab character.
Dave Love <fx@gnu.org>
parents:
diff changeset
2005
Dave Love <fx@gnu.org>
parents:
diff changeset
2006 @node ForIndent Num
Dave Love <fx@gnu.org>
parents:
diff changeset
2007 @subsubsection Line Numbers
Dave Love <fx@gnu.org>
parents:
diff changeset
2008
Dave Love <fx@gnu.org>
parents:
diff changeset
2009 If a number is the first non-whitespace in the line, Fortran
Dave Love <fx@gnu.org>
parents:
diff changeset
2010 indentation assumes it is a line number and moves it to columns 0
Dave Love <fx@gnu.org>
parents:
diff changeset
2011 through 4. (Columns always count from 0 in GNU Emacs.)
Dave Love <fx@gnu.org>
parents:
diff changeset
2012
Dave Love <fx@gnu.org>
parents:
diff changeset
2013 @vindex fortran-line-number-indent
Dave Love <fx@gnu.org>
parents:
diff changeset
2014 Line numbers of four digits or less are normally indented one space.
Dave Love <fx@gnu.org>
parents:
diff changeset
2015 The variable @code{fortran-line-number-indent} controls this; it
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2016 specifies the maximum indentation a line number can have. The default
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2017 value of the variable is 1. Fortran mode tries to prevent line number
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2018 digits passing column 4, reducing the indentation below the specified
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2019 maximum if necessary. If @code{fortran-line-number-indent} has the
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2020 value 5, line numbers are right-justified to end in column 4.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2021
Dave Love <fx@gnu.org>
parents:
diff changeset
2022 @vindex fortran-electric-line-number
Dave Love <fx@gnu.org>
parents:
diff changeset
2023 Simply inserting a line number is enough to indent it according to
Dave Love <fx@gnu.org>
parents:
diff changeset
2024 these rules. As each digit is inserted, the indentation is recomputed.
Dave Love <fx@gnu.org>
parents:
diff changeset
2025 To turn off this feature, set the variable
62482
8db373573379 (Lisp Doc): Eldoc mode shows only the first line of a variable's docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61133
diff changeset
2026 @code{fortran-electric-line-number} to @code{nil}.
59371
364d233a8dc3 Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents: 56809
diff changeset
2027
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2028
Dave Love <fx@gnu.org>
parents:
diff changeset
2029 @node ForIndent Conv
Dave Love <fx@gnu.org>
parents:
diff changeset
2030 @subsubsection Syntactic Conventions
Dave Love <fx@gnu.org>
parents:
diff changeset
2031
Dave Love <fx@gnu.org>
parents:
diff changeset
2032 Fortran mode assumes that you follow certain conventions that simplify
Dave Love <fx@gnu.org>
parents:
diff changeset
2033 the task of understanding a Fortran program well enough to indent it
Dave Love <fx@gnu.org>
parents:
diff changeset
2034 properly:
Dave Love <fx@gnu.org>
parents:
diff changeset
2035
Dave Love <fx@gnu.org>
parents:
diff changeset
2036 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
2037 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2038 Two nested @samp{do} loops never share a @samp{continue} statement.
Dave Love <fx@gnu.org>
parents:
diff changeset
2039
Dave Love <fx@gnu.org>
parents:
diff changeset
2040 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2041 Fortran keywords such as @samp{if}, @samp{else}, @samp{then}, @samp{do}
Dave Love <fx@gnu.org>
parents:
diff changeset
2042 and others are written without embedded whitespace or line breaks.
Dave Love <fx@gnu.org>
parents:
diff changeset
2043
Dave Love <fx@gnu.org>
parents:
diff changeset
2044 Fortran compilers generally ignore whitespace outside of string
Dave Love <fx@gnu.org>
parents:
diff changeset
2045 constants, but Fortran mode does not recognize these keywords if they
Dave Love <fx@gnu.org>
parents:
diff changeset
2046 are not contiguous. Constructs such as @samp{else if} or @samp{end do}
Dave Love <fx@gnu.org>
parents:
diff changeset
2047 are acceptable, but the second word should be on the same line as the
Dave Love <fx@gnu.org>
parents:
diff changeset
2048 first and not on a continuation line.
Dave Love <fx@gnu.org>
parents:
diff changeset
2049 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
2050
Dave Love <fx@gnu.org>
parents:
diff changeset
2051 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2052 If you fail to follow these conventions, the indentation commands may
Dave Love <fx@gnu.org>
parents:
diff changeset
2053 indent some lines unaesthetically. However, a correct Fortran program
Dave Love <fx@gnu.org>
parents:
diff changeset
2054 retains its meaning when reindented even if the conventions are not
Dave Love <fx@gnu.org>
parents:
diff changeset
2055 followed.
Dave Love <fx@gnu.org>
parents:
diff changeset
2056
Dave Love <fx@gnu.org>
parents:
diff changeset
2057 @node ForIndent Vars
Dave Love <fx@gnu.org>
parents:
diff changeset
2058 @subsubsection Variables for Fortran Indentation
Dave Love <fx@gnu.org>
parents:
diff changeset
2059
Dave Love <fx@gnu.org>
parents:
diff changeset
2060 @vindex fortran-do-indent
Dave Love <fx@gnu.org>
parents:
diff changeset
2061 @vindex fortran-if-indent
Dave Love <fx@gnu.org>
parents:
diff changeset
2062 @vindex fortran-structure-indent
Dave Love <fx@gnu.org>
parents:
diff changeset
2063 @vindex fortran-continuation-indent
Dave Love <fx@gnu.org>
parents:
diff changeset
2064 @vindex fortran-check-all-num@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
2065 @vindex fortran-minimum-statement-indent@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
2066 Several additional variables control how Fortran indentation works:
Dave Love <fx@gnu.org>
parents:
diff changeset
2067
Dave Love <fx@gnu.org>
parents:
diff changeset
2068 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
2069 @item fortran-do-indent
Dave Love <fx@gnu.org>
parents:
diff changeset
2070 Extra indentation within each level of @samp{do} statement (default 3).
Dave Love <fx@gnu.org>
parents:
diff changeset
2071
Dave Love <fx@gnu.org>
parents:
diff changeset
2072 @item fortran-if-indent
61099
09d1980656d1 (ForIndent Vars): `fortran-if-indent' does other constructs as well.
Glenn Morris <rgm@gnu.org>
parents: 61057
diff changeset
2073 Extra indentation within each level of @samp{if}, @samp{select case}, or
09d1980656d1 (ForIndent Vars): `fortran-if-indent' does other constructs as well.
Glenn Morris <rgm@gnu.org>
parents: 61057
diff changeset
2074 @samp{where} statements (default 3).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2075
Dave Love <fx@gnu.org>
parents:
diff changeset
2076 @item fortran-structure-indent
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2077 Extra indentation within each level of @samp{structure}, @samp{union},
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2078 @samp{map}, or @samp{interface} statements (default 3).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2079
Dave Love <fx@gnu.org>
parents:
diff changeset
2080 @item fortran-continuation-indent
Dave Love <fx@gnu.org>
parents:
diff changeset
2081 Extra indentation for bodies of continuation lines (default 5).
Dave Love <fx@gnu.org>
parents:
diff changeset
2082
Dave Love <fx@gnu.org>
parents:
diff changeset
2083 @item fortran-check-all-num-for-matching-do
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2084 In Fortran77, a numbered @samp{do} statement is ended by any statement
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2085 with a matching line number. It is common (but not compulsory) to use a
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2086 @samp{continue} statement for this purpose. If this variable has a
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2087 non-@code{nil} value, indenting any numbered statement must check for a
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2088 @samp{do} that ends there. If you always end @samp{do} statements with
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2089 a @samp{continue} line (or if you use the more modern @samp{enddo}),
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2090 then you can speed up indentation by setting this variable to
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2091 @code{nil}. The default is @code{nil}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2092
Dave Love <fx@gnu.org>
parents:
diff changeset
2093 @item fortran-blink-matching-if
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2094 If this is @code{t}, indenting an @samp{endif} (or @samp{enddo}
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2095 statement moves the cursor momentarily to the matching @samp{if} (or
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2096 @samp{do}) statement to show where it is. The default is @code{nil}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2097
Dave Love <fx@gnu.org>
parents:
diff changeset
2098 @item fortran-minimum-statement-indent-fixed
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2099 Minimum indentation for Fortran statements when using fixed format
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2100 continuation line style. Statement bodies are never indented less than
Dave Love <fx@gnu.org>
parents:
diff changeset
2101 this much. The default is 6.
Dave Love <fx@gnu.org>
parents:
diff changeset
2102
Dave Love <fx@gnu.org>
parents:
diff changeset
2103 @item fortran-minimum-statement-indent-tab
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2104 Minimum indentation for Fortran statements for tab format continuation line
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2105 style. Statement bodies are never indented less than this much. The
Dave Love <fx@gnu.org>
parents:
diff changeset
2106 default is 8.
Dave Love <fx@gnu.org>
parents:
diff changeset
2107 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
2108
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2109 The variables controlling the indentation of comments are described in
61057
0e16dd096eb2 (Fortran): Small fixes to previous changes.
Richard M. Stallman <rms@gnu.org>
parents: 61053
diff changeset
2110 the following section.
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2111
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2112 @node Fortran Comments
Dave Love <fx@gnu.org>
parents:
diff changeset
2113 @subsection Fortran Comments
Dave Love <fx@gnu.org>
parents:
diff changeset
2114
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2115 The usual Emacs comment commands assume that a comment can follow a
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2116 line of code. In Fortran77, the standard comment syntax requires an
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2117 entire line to be just a comment. Therefore, Fortran mode replaces the
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2118 standard Emacs comment commands and defines some new variables.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2119
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2120 @vindex fortran-comment-line-start
27221
4a723a7bc25a Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents: 26462
diff changeset
2121 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
2122 start with @samp{!} and can follow other text. Because only some Fortran77
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2123 compilers accept this syntax, Fortran mode will not insert such comments
Dave Love <fx@gnu.org>
parents:
diff changeset
2124 unless you have said in advance to do so. To do this, set the variable
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2125 @code{fortran-comment-line-start} to @samp{"!"}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2126
Dave Love <fx@gnu.org>
parents:
diff changeset
2127 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
2128 @item M-;
59461
26a204697252 Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents: 59371
diff changeset
2129 Align comment or insert new comment (@code{fortran-indent-comment}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2130
Dave Love <fx@gnu.org>
parents:
diff changeset
2131 @item C-x ;
Dave Love <fx@gnu.org>
parents:
diff changeset
2132 Applies to nonstandard @samp{!} comments only.
Dave Love <fx@gnu.org>
parents:
diff changeset
2133
Dave Love <fx@gnu.org>
parents:
diff changeset
2134 @item C-c ;
Dave Love <fx@gnu.org>
parents:
diff changeset
2135 Turn all lines of the region into comments, or (with argument) turn them back
Dave Love <fx@gnu.org>
parents:
diff changeset
2136 into real code (@code{fortran-comment-region}).
Dave Love <fx@gnu.org>
parents:
diff changeset
2137 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
2138
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2139 @findex fortran-indent-comment
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2140 @kbd{M-;} in Fortran mode is redefined as the command
59461
26a204697252 Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents: 59371
diff changeset
2141 @code{fortran-indent-comment}. Like the usual @kbd{M-;} command, this
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2142 recognizes any kind of existing comment and aligns its text appropriately;
Dave Love <fx@gnu.org>
parents:
diff changeset
2143 if there is no existing comment, a comment is inserted and aligned. But
Dave Love <fx@gnu.org>
parents:
diff changeset
2144 inserting and aligning comments are not the same in Fortran mode as in
Dave Love <fx@gnu.org>
parents:
diff changeset
2145 other modes.
Dave Love <fx@gnu.org>
parents:
diff changeset
2146
Dave Love <fx@gnu.org>
parents:
diff changeset
2147 When a new comment must be inserted, if the current line is blank, a
Dave Love <fx@gnu.org>
parents:
diff changeset
2148 full-line comment is inserted. On a non-blank line, a nonstandard @samp{!}
Dave Love <fx@gnu.org>
parents:
diff changeset
2149 comment is inserted if you have said you want to use them. Otherwise a
Dave Love <fx@gnu.org>
parents:
diff changeset
2150 full-line comment is inserted on a new line before the current line.
Dave Love <fx@gnu.org>
parents:
diff changeset
2151
Dave Love <fx@gnu.org>
parents:
diff changeset
2152 Nonstandard @samp{!} comments are aligned like comments in other
Dave Love <fx@gnu.org>
parents:
diff changeset
2153 languages, but full-line comments are different. In a standard full-line
Dave Love <fx@gnu.org>
parents:
diff changeset
2154 comment, the comment delimiter itself must always appear in column zero.
Dave Love <fx@gnu.org>
parents:
diff changeset
2155 What can be aligned is the text within the comment. You can choose from
Dave Love <fx@gnu.org>
parents:
diff changeset
2156 three styles of alignment by setting the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
2157 @code{fortran-comment-indent-style} to one of these values:
Dave Love <fx@gnu.org>
parents:
diff changeset
2158
Dave Love <fx@gnu.org>
parents:
diff changeset
2159 @vindex fortran-comment-indent-style
Dave Love <fx@gnu.org>
parents:
diff changeset
2160 @vindex fortran-comment-line-extra-indent
Dave Love <fx@gnu.org>
parents:
diff changeset
2161 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
2162 @item fixed
Dave Love <fx@gnu.org>
parents:
diff changeset
2163 Align the text at a fixed column, which is the sum of
Dave Love <fx@gnu.org>
parents:
diff changeset
2164 @code{fortran-comment-line-extra-indent} and the minimum statement
Dave Love <fx@gnu.org>
parents:
diff changeset
2165 indentation. This is the default.
Dave Love <fx@gnu.org>
parents:
diff changeset
2166
Dave Love <fx@gnu.org>
parents:
diff changeset
2167 The minimum statement indentation is
Dave Love <fx@gnu.org>
parents:
diff changeset
2168 @code{fortran-minimum-statement-indent-fixed} for fixed format
Dave Love <fx@gnu.org>
parents:
diff changeset
2169 continuation line style and @code{fortran-minimum-statement-indent-tab}
Dave Love <fx@gnu.org>
parents:
diff changeset
2170 for tab format style.
Dave Love <fx@gnu.org>
parents:
diff changeset
2171
Dave Love <fx@gnu.org>
parents:
diff changeset
2172 @item relative
Dave Love <fx@gnu.org>
parents:
diff changeset
2173 Align the text as if it were a line of code, but with an additional
Dave Love <fx@gnu.org>
parents:
diff changeset
2174 @code{fortran-comment-line-extra-indent} columns of indentation.
Dave Love <fx@gnu.org>
parents:
diff changeset
2175
Dave Love <fx@gnu.org>
parents:
diff changeset
2176 @item nil
59371
364d233a8dc3 Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents: 56809
diff changeset
2177 Don't move text in full-line comments automatically.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2178 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
2179
Dave Love <fx@gnu.org>
parents:
diff changeset
2180 @vindex fortran-comment-indent-char
Dave Love <fx@gnu.org>
parents:
diff changeset
2181 In addition, you can specify the character to be used to indent within
Dave Love <fx@gnu.org>
parents:
diff changeset
2182 full-line comments by setting the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
2183 @code{fortran-comment-indent-char} to the single-character string you want
Dave Love <fx@gnu.org>
parents:
diff changeset
2184 to use.
Dave Love <fx@gnu.org>
parents:
diff changeset
2185
45997
9ee4a7e22180 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 44088
diff changeset
2186 @vindex fortran-directive-re
9ee4a7e22180 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 44088
diff changeset
2187 Compiler directive lines, or preprocessor lines, have much the same
9ee4a7e22180 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 44088
diff changeset
2188 appearance as comment lines. It is important, though, that such lines
9ee4a7e22180 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 44088
diff changeset
2189 never be indented at all, no matter what the value of
9ee4a7e22180 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 44088
diff changeset
2190 @code{fortran-comment-indent-style}. The variable
9ee4a7e22180 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 44088
diff changeset
2191 @code{fortran-directive-re} is a regular expression that specifies which
9ee4a7e22180 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 44088
diff changeset
2192 lines are directives. Matching lines are never indented, and receive
9ee4a7e22180 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 44088
diff changeset
2193 distinctive font-locking.
9ee4a7e22180 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 44088
diff changeset
2194
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2195 The normal Emacs comment command @kbd{C-x ;} has not been redefined. If
Dave Love <fx@gnu.org>
parents:
diff changeset
2196 you use @samp{!} comments, this command can be used with them. Otherwise
Dave Love <fx@gnu.org>
parents:
diff changeset
2197 it is useless in Fortran mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
2198
Dave Love <fx@gnu.org>
parents:
diff changeset
2199 @kindex C-c ; @r{(Fortran mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
2200 @findex fortran-comment-region
Dave Love <fx@gnu.org>
parents:
diff changeset
2201 @vindex fortran-comment-region
Dave Love <fx@gnu.org>
parents:
diff changeset
2202 The command @kbd{C-c ;} (@code{fortran-comment-region}) turns all the
Dave Love <fx@gnu.org>
parents:
diff changeset
2203 lines of the region into comments by inserting the string @samp{C$$$} at
Dave Love <fx@gnu.org>
parents:
diff changeset
2204 the front of each one. With a numeric argument, it turns the region
Dave Love <fx@gnu.org>
parents:
diff changeset
2205 back into live code by deleting @samp{C$$$} from the front of each line
Dave Love <fx@gnu.org>
parents:
diff changeset
2206 in it. The string used for these comments can be controlled by setting
Dave Love <fx@gnu.org>
parents:
diff changeset
2207 the variable @code{fortran-comment-region}. Note that here we have an
Dave Love <fx@gnu.org>
parents:
diff changeset
2208 example of a command and a variable with the same name; these two uses
Dave Love <fx@gnu.org>
parents:
diff changeset
2209 of the name never conflict because in Lisp and in Emacs it is always
Dave Love <fx@gnu.org>
parents:
diff changeset
2210 clear from the context which one is meant.
Dave Love <fx@gnu.org>
parents:
diff changeset
2211
Dave Love <fx@gnu.org>
parents:
diff changeset
2212 @node Fortran Autofill
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2213 @subsection Auto Fill in Fortran Mode
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2214
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2215 Fortran mode has specialized support for Auto Fill mode, which is a
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2216 minor mode that automatically splits statements as you insert them when
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2217 they become too wide. Splitting a statement involves making
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2218 continuation lines using @code{fortran-continuation-string}
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2219 (@pxref{ForIndent Cont}). This splitting happens when you type
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2220 @key{SPC}, @key{RET}, or @key{TAB}, and also in the Fortran indentation
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2221 commands. You activate Auto Fill in Fortran mode in the normal way
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2222 (@pxref{Auto Fill}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2223
Dave Love <fx@gnu.org>
parents:
diff changeset
2224 @vindex fortran-break-before-delimiters
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2225 Auto Fill breaks lines at spaces or delimiters when the lines get
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2226 longer than the desired width (the value of @code{fill-column}). The
61057
0e16dd096eb2 (Fortran): Small fixes to previous changes.
Richard M. Stallman <rms@gnu.org>
parents: 61053
diff changeset
2227 delimiters (besides whitespace) that Auto Fill can break at are
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2228 @samp{+}, @samp{-}, @samp{/}, @samp{*}, @samp{=}, @samp{<}, @samp{>},
61057
0e16dd096eb2 (Fortran): Small fixes to previous changes.
Richard M. Stallman <rms@gnu.org>
parents: 61053
diff changeset
2229 and @samp{,}. The line break comes after the delimiter if the
0e16dd096eb2 (Fortran): Small fixes to previous changes.
Richard M. Stallman <rms@gnu.org>
parents: 61053
diff changeset
2230 variable @code{fortran-break-before-delimiters} is @code{nil}.
0e16dd096eb2 (Fortran): Small fixes to previous changes.
Richard M. Stallman <rms@gnu.org>
parents: 61053
diff changeset
2231 Otherwise (and by default), the break comes before the delimiter.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2232
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2233 To enable Auto Fill in all Fortran buffers, add
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2234 @code{turn-on-auto-fill} to @code{fortran-mode-hook}. @xref{Hooks}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2235
Dave Love <fx@gnu.org>
parents:
diff changeset
2236 @node Fortran Columns
Dave Love <fx@gnu.org>
parents:
diff changeset
2237 @subsection Checking Columns in Fortran
Dave Love <fx@gnu.org>
parents:
diff changeset
2238
Dave Love <fx@gnu.org>
parents:
diff changeset
2239 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
2240 @item C-c C-r
Dave Love <fx@gnu.org>
parents:
diff changeset
2241 Display a ``column ruler'' momentarily above the current line
Dave Love <fx@gnu.org>
parents:
diff changeset
2242 (@code{fortran-column-ruler}).
Dave Love <fx@gnu.org>
parents:
diff changeset
2243 @item C-c C-w
Dave Love <fx@gnu.org>
parents:
diff changeset
2244 Split the current window horizontally temporarily so that it is 72
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
2245 columns wide (@code{fortran-window-create-momentarily}). This may
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
2246 help you avoid making lines longer than the 72-character limit that
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
2247 some Fortran compilers impose.
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
2248 @item C-u C-c C-w
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
2249 Split the current window horizontally so that it is 72 columns wide
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
2250 (@code{fortran-window-create}). You can then continue editing.
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
2251 @item M-x fortran-strip-sequence-nos
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
2252 Delete all text in column 72 and beyond.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2253 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
2254
Dave Love <fx@gnu.org>
parents:
diff changeset
2255 @kindex C-c C-r @r{(Fortran mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
2256 @findex fortran-column-ruler
Dave Love <fx@gnu.org>
parents:
diff changeset
2257 The command @kbd{C-c C-r} (@code{fortran-column-ruler}) shows a column
Dave Love <fx@gnu.org>
parents:
diff changeset
2258 ruler momentarily above the current line. The comment ruler is two lines
Dave Love <fx@gnu.org>
parents:
diff changeset
2259 of text that show you the locations of columns with special significance in
Dave Love <fx@gnu.org>
parents:
diff changeset
2260 Fortran programs. Square brackets show the limits of the columns for line
Dave Love <fx@gnu.org>
parents:
diff changeset
2261 numbers, and curly brackets show the limits of the columns for the
Dave Love <fx@gnu.org>
parents:
diff changeset
2262 statement body. Column numbers appear above them.
Dave Love <fx@gnu.org>
parents:
diff changeset
2263
Dave Love <fx@gnu.org>
parents:
diff changeset
2264 Note that the column numbers count from zero, as always in GNU Emacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
2265 As a result, the numbers may be one less than those you are familiar
Dave Love <fx@gnu.org>
parents:
diff changeset
2266 with; but the positions they indicate in the line are standard for
Dave Love <fx@gnu.org>
parents:
diff changeset
2267 Fortran.
Dave Love <fx@gnu.org>
parents:
diff changeset
2268
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
2269 @vindex fortran-column-ruler-fixed
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
2270 @vindex fortran-column-ruler-tabs
59371
364d233a8dc3 Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents: 56809
diff changeset
2271 The text used to display the column ruler depends on the value of the
364d233a8dc3 Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents: 56809
diff changeset
2272 variable @code{indent-tabs-mode}. If @code{indent-tabs-mode} is
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2273 @code{nil}, then the value of the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
2274 @code{fortran-column-ruler-fixed} is used as the column ruler.
59371
364d233a8dc3 Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents: 56809
diff changeset
2275 Otherwise, the value of the variable @code{fortran-column-ruler-tab} is
364d233a8dc3 Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents: 56809
diff changeset
2276 displayed. By changing these variables, you can change the column ruler
364d233a8dc3 Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents: 56809
diff changeset
2277 display.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2278
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
2279 @kindex C-c C-w @r{(Fortran mode)}
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
2280 @findex fortran-window-create-momentarily
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
2281 @kbd{C-c C-w} (@code{fortran-window-create-momentarily}) temporarily
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
2282 splits the current window horizontally, making a window 72 columns
61021
6fb8ff7dc693 Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 60801
diff changeset
2283 wide, so you can see any lines that are too long. Type a space to
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
2284 restore the normal width.
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
2285
26106
19c8f63a59f1 List additional modes.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
2286 @kindex C-u C-c C-w @r{(Fortran mode)}
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2287 @findex fortran-window-create
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
2288 You can also split the window horizontally and continue editing with
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
2289 the split in place. To do this, use @kbd{C-u C-c C-w} (@code{M-x
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
2290 fortran-window-create}). By editing in this window you can
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
2291 immediately see when you make a line too wide to be correct Fortran.
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
2292
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
2293 @findex fortran-strip-sequence-nos
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
2294 The command @kbd{M-x fortran-strip-sequence-nos} deletes all text in
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
2295 column 72 and beyond, on all lines in the current buffer. This is the
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
2296 easiest way to get rid of old sequence numbers.
26106
19c8f63a59f1 List additional modes.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
2297
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2298 @node Fortran Abbrev
Dave Love <fx@gnu.org>
parents:
diff changeset
2299 @subsection Fortran Keyword Abbrevs
Dave Love <fx@gnu.org>
parents:
diff changeset
2300
Dave Love <fx@gnu.org>
parents:
diff changeset
2301 Fortran mode provides many built-in abbrevs for common keywords and
Dave Love <fx@gnu.org>
parents:
diff changeset
2302 declarations. These are the same sort of abbrev that you can define
Dave Love <fx@gnu.org>
parents:
diff changeset
2303 yourself. To use them, you must turn on Abbrev mode. @xref{Abbrevs}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2304
Dave Love <fx@gnu.org>
parents:
diff changeset
2305 The built-in abbrevs are unusual in one way: they all start with a
Dave Love <fx@gnu.org>
parents:
diff changeset
2306 semicolon. You cannot normally use semicolon in an abbrev, but Fortran
Dave Love <fx@gnu.org>
parents:
diff changeset
2307 mode makes this possible by changing the syntax of semicolon to ``word
Dave Love <fx@gnu.org>
parents:
diff changeset
2308 constituent.''
Dave Love <fx@gnu.org>
parents:
diff changeset
2309
Dave Love <fx@gnu.org>
parents:
diff changeset
2310 For example, one built-in Fortran abbrev is @samp{;c} for
Dave Love <fx@gnu.org>
parents:
diff changeset
2311 @samp{continue}. If you insert @samp{;c} and then insert a punctuation
Dave Love <fx@gnu.org>
parents:
diff changeset
2312 character such as a space or a newline, the @samp{;c} expands automatically
Dave Love <fx@gnu.org>
parents:
diff changeset
2313 to @samp{continue}, provided Abbrev mode is enabled.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2314
Dave Love <fx@gnu.org>
parents:
diff changeset
2315 Type @samp{;?} or @samp{;C-h} to display a list of all the built-in
Dave Love <fx@gnu.org>
parents:
diff changeset
2316 Fortran abbrevs and what they stand for.
Dave Love <fx@gnu.org>
parents:
diff changeset
2317
Dave Love <fx@gnu.org>
parents:
diff changeset
2318 @node Asm Mode
Dave Love <fx@gnu.org>
parents:
diff changeset
2319 @section Asm Mode
Dave Love <fx@gnu.org>
parents:
diff changeset
2320
Dave Love <fx@gnu.org>
parents:
diff changeset
2321 @cindex Asm mode
36183
d3f65290e6b2 Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents: 35477
diff changeset
2322 @cindex assembler mode
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2323 Asm mode is a major mode for editing files of assembler code. It
Dave Love <fx@gnu.org>
parents:
diff changeset
2324 defines these commands:
Dave Love <fx@gnu.org>
parents:
diff changeset
2325
Dave Love <fx@gnu.org>
parents:
diff changeset
2326 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
2327 @item @key{TAB}
Dave Love <fx@gnu.org>
parents:
diff changeset
2328 @code{tab-to-tab-stop}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2329 @item C-j
Dave Love <fx@gnu.org>
parents:
diff changeset
2330 Insert a newline and then indent using @code{tab-to-tab-stop}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2331 @item :
Dave Love <fx@gnu.org>
parents:
diff changeset
2332 Insert a colon and then remove the indentation from before the label
Dave Love <fx@gnu.org>
parents:
diff changeset
2333 preceding colon. Then do @code{tab-to-tab-stop}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2334 @item ;
Dave Love <fx@gnu.org>
parents:
diff changeset
2335 Insert or align a comment.
Dave Love <fx@gnu.org>
parents:
diff changeset
2336 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
2337
Dave Love <fx@gnu.org>
parents:
diff changeset
2338 The variable @code{asm-comment-char} specifies which character
Dave Love <fx@gnu.org>
parents:
diff changeset
2339 starts comments in assembler syntax.
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52153
diff changeset
2340
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52153
diff changeset
2341 @ignore
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52153
diff changeset
2342 arch-tag: c7ee7409-40a4-45c7-bfb7-ae7f2c74d0c0
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52153
diff changeset
2343 @end ignore