Mercurial > emacs
annotate man/programs.texi @ 69357:1f70898570ca
(mh-profile-component): Drop `s' from mhparam -components for
Mailutils compatibility (closes SF #1446985).
author | Bill Wohler <wohler@newt.com> |
---|---|
date | Fri, 10 Mar 2006 16:56:16 +0000 |
parents | 353348d5ce78 |
children | 91970b147f39 d57ee9eab157 |
rev | line source |
---|---|
25829 | 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, |
68639
dc2d5a6655a3
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
68257
diff
changeset
|
3 @c 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc. |
25829 | 4 @c See file emacs.texi for copying conditions. |
5 @node Programs, Building, Text, Top | |
6 @chapter Editing Programs | |
7 @cindex Lisp editing | |
8 @cindex C editing | |
9 @cindex program editing | |
10 | |
38867 | 11 Emacs provides many features to facilitate editing programs. Some |
12 of these features can | |
25829 | 13 |
14 @itemize @bullet | |
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 | 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 | 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 | 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 | 26 @end itemize |
27 | |
38867 | 28 This chapter describes these features and many more. |
29 | |
25829 | 30 @menu |
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 | 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 | 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 | 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 | 42 * C Modes:: Special commands of C, C++, Objective-C, |
25829 | 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 | 46 @end menu |
47 | |
48 @node Program Modes | |
49 @section Major Modes for Programming Languages | |
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 | 56 to find the beginning of a function definition. It often customizes |
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 | 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 | 67 @cindex Perl mode |
68 @cindex Icon mode | |
69 @cindex Makefile mode | |
70 @cindex Tcl mode | |
71 @cindex CPerl mode | |
26106 | 72 @cindex DSSSL mode |
73 @cindex Octave mode | |
74 @cindex Metafont mode | |
75 @cindex Modula2 mode | |
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 | 78 @cindex Simula mode |
79 @cindex VHDL mode | |
80 @cindex M4 mode | |
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 | 97 |
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 | 102 for programming languages arrange for @key{TAB} to update the |
103 indentation of the current line. They also rebind @key{DEL} to treat | |
104 a tab as if it were the equivalent number of spaces; this lets you | |
105 delete one column of indentation without worrying whether the | |
106 whitespace consists of spaces or tabs. Use @kbd{C-b C-d} to delete a | |
107 tab character before point, in these modes. | |
25829 | 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 | 114 @cindex mode hook |
115 @vindex c-mode-hook | |
116 @vindex lisp-mode-hook | |
117 @vindex emacs-lisp-mode-hook | |
118 @vindex lisp-interaction-mode-hook | |
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 | 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 | 130 |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
131 In Emacs, a major definition at the top level in the buffer, |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
132 something like a function, is called a @dfn{defun}. The name comes |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
133 from Lisp, but in Emacs we use it for all languages. |
25829 | 134 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
135 @menu |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
136 * 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
|
137 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
|
138 * 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
|
139 * 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
|
140 * 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
|
141 @end menu |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
142 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
143 @node Left Margin Paren |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
144 @subsection Left Margin Convention |
25829 | 145 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
146 @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
|
147 @cindex ( in leftmost column |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
148 Emacs assumes by default that any opening delimiter found at the |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
149 left margin is the start of a top-level definition, or defun. You can |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
150 override this default by setting this user option: |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
151 |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
152 @defvar open-paren-in-column-0-is-defun-start |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
153 If this user option is set to @code{t} (the default), opening |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
154 parentheses or braces at column zero always start defuns. When it's |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
155 @code{nil}, defuns are found by searching for parens or braces at the |
67683
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
156 outermost level. Some major modes, including C and related modes, set |
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
157 @code{open-paren-in-column-0-is-defun-start} buffer-locally to |
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
158 @code{nil} |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
159 @end defvar |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
160 |
67683
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
161 In modes where @code{open-paren-in-column-0-is-defun-start} is |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
162 @code{t}, @strong{don't put an opening delimiter at the left margin |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
163 unless it is a defun start}. For instance, never put an |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
164 open-parenthesis at the left margin in a Lisp file unless it is the |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
165 start of a top-level list. |
25829 | 166 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
167 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
|
168 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
|
169 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
|
170 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
|
171 mode (@pxref{Font Lock}). |
25829 | 172 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
173 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
|
174 at the start of a line inside a string. To avoid trouble, put an |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
175 escape character (@samp{\}, in Emacs Lisp, @samp{/} in some other Lisp |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
176 dialects) before the opening delimiter. This will not affect the |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
177 contents of the string, but will prevent that opening delimiter from |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
178 starting a defun. Here's an example: |
25829 | 179 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
180 @example |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
181 (insert "Foo: |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
182 \(bar) |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
183 ") |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
184 @end example |
25829 | 185 |
46035
11e7a6a33a8c
Explain font lock highlighting of opening delims that should be quoted.
Richard M. Stallman <rms@gnu.org>
parents:
45997
diff
changeset
|
186 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
|
187 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
|
188 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
|
189 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
190 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
|
191 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
|
192 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
|
193 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
|
194 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
|
195 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
|
196 always right, and avoids the need to scan back to the beginning of the |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
197 buffer. However, now that modern computers are so powerful, this |
67683
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
198 scanning is rarely slow enough to annoy, so we've provided a way to |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
199 disable the heuristic. |
25829 | 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 | 203 @cindex defuns |
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 | 208 @table @kbd |
209 @item C-M-a | |
210 Move to beginning of current or preceding defun | |
211 (@code{beginning-of-defun}). | |
212 @item C-M-e | |
213 Move to end of current or following defun (@code{end-of-defun}). | |
214 @item C-M-h | |
215 Put region around whole current or following defun (@code{mark-defun}). | |
216 @end table | |
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 | 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 |
68697 | 249 when the mark is active, extends the end of the region to include one |
250 more defun 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 | 255 data type so that the entire C function is inside the region. This is |
256 an example of how major modes adjust the standard key bindings so that | |
257 they do their standard jobs in a way better fitting a particular | |
258 language. Other major modes may replace any or all of these key | |
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 | 263 @cindex index of buffer definitions |
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 | 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 | 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 | 275 the minibuffer, then moves point to that definition. You can use |
276 completion to specify the name; the command always displays the whole | |
277 list of valid names. | |
25829 | 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 | 281 click. Then it displays mouse menus for you to select a definition |
282 name. You can also add the buffer's index to the menu bar by calling | |
283 @code{imenu-add-menubar-index}. If you want to have this menu bar | |
284 item available for all buffers in a certain major mode, you can do | |
285 this by adding @code{imenu-add-menubar-index} to its mode hook. But | |
68697 | 286 if you have done that, you will have to wait a little while each time |
287 you visit a file in that mode, while Emacs finds all the definitions | |
288 in that 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 | 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 | 294 Rescanning happens automatically if you set @code{imenu-auto-rescan} to |
295 a non-@code{nil} value. There is no need to rescan because of small | |
38867 | 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 | 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 | 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 | 331 |
332 @node Program Indent | |
333 @section Indentation for Programs | |
334 @cindex indentation for programs | |
335 | |
336 The best way to keep a program properly indented is to use Emacs to | |
337 reindent it as you change it. Emacs has commands to indent properly | |
338 either a single line, a specified number of lines, or all of the lines | |
339 inside a single parenthetical grouping. | |
340 | |
341 @menu | |
342 * Basic Indent:: Indenting a single line. | |
343 * Multi-line Indent:: Commands to reindent many lines at once. | |
344 * Lisp Indent:: Specifying how each Lisp function should be indented. | |
345 * C Indent:: Extra features for indenting C and related modes. | |
346 * Custom C Indent:: Controlling indentation style for C and related modes. | |
347 @end menu | |
348 | |
38231
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
349 @cindex pretty-printer |
25829 | 350 Emacs also provides a Lisp pretty-printer in the library @code{pp}. |
351 This program reformats a Lisp object with indentation chosen to look nice. | |
352 | |
353 @node Basic Indent | |
354 @subsection Basic Program Indentation Commands | |
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 | 359 @table @kbd |
360 @item @key{TAB} | |
361 Adjust indentation of current line. | |
362 @item C-j | |
363 Equivalent to @key{RET} followed by @key{TAB} (@code{newline-and-indent}). | |
364 @end table | |
365 | |
366 @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
|
367 @findex c-indent-command |
c41356c953a0
Correct names of some C mode indentation commands.
Richard M. Stallman <rms@gnu.org>
parents:
37868
diff
changeset
|
368 @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
|
369 @findex indent-for-tab-command |
25829 | 370 The basic indentation command is @key{TAB}, which gives the current line |
371 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
|
372 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
|
373 @code{lisp-indent-line} |
37978
c41356c953a0
Correct names of some C mode indentation commands.
Richard M. Stallman <rms@gnu.org>
parents:
37868
diff
changeset
|
374 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
|
375 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
|
376 conceptually the same job: @key{TAB} in any programming-language major mode |
25829 | 377 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
|
378 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
|
379 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
|
380 that whitespace; otherwise, @key{TAB} keeps point fixed with respect to |
25829 | 381 the characters around it. |
382 | |
60112
7cb4576800fa
(Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents:
59798
diff
changeset
|
383 Use @kbd{C-q @key{TAB}} to insert a tab character at point. |
25829 | 384 |
385 @kindex C-j | |
386 @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
|
387 When entering lines of new code, use @kbd{C-j} |
68697 | 388 (@code{newline-and-indent}), which is equivalent to @key{RET} |
389 followed by @key{TAB}. @kbd{C-j} at the end of a line creates a | |
38136
278f2295cde6
New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents:
38123
diff
changeset
|
390 blank line and then gives it the appropriate indentation. |
25829 | 391 |
60112
7cb4576800fa
(Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents:
59798
diff
changeset
|
392 @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
|
393 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
|
394 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
|
395 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
|
396 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
|
397 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
|
398 line. |
25829 | 399 |
68697 | 400 In some modes, an open-parenthesis, open-brace or other opening |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
401 delimiter at the left margin is assumed by Emacs (including the |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
402 indentation routines) to be the start of a function. This speeds up |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
403 indentation commands. If you will be editing text which contains |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
404 opening delimiters in column zero that aren't the beginning of a |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
405 functions, even inside strings or comments, you must set |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
406 @code{open-paren-in-column-0-is-defun-start}. @xref{Left Margin |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
407 Paren}, for more information on this. |
25829 | 408 |
38009
b6036155d1ca
(Basic Indent): Add a cross-reference to description of indent-tabs-mode.
Eli Zaretskii <eliz@gnu.org>
parents:
37997
diff
changeset
|
409 Normally, lines are indented with tabs and spaces. If you want Emacs |
68717
e9bbbd27de3f
(Basic Indent): Fix typo.
Luc Teirlinck <teirllm@auburn.edu>
parents:
68697
diff
changeset
|
410 to use spaces only, set @code{indent-tabs-mode} (@pxref{Just Spaces}). |
38009
b6036155d1ca
(Basic Indent): Add a cross-reference to description of indent-tabs-mode.
Eli Zaretskii <eliz@gnu.org>
parents:
37997
diff
changeset
|
411 |
25829 | 412 @node Multi-line Indent |
413 @subsection Indenting Several Lines | |
414 | |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
415 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
|
416 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
|
417 you have several commands available. |
25829 | 418 |
419 @table @kbd | |
420 @item C-M-q | |
59475
279e43932b6f
(Multi-line Indent): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
59461
diff
changeset
|
421 Reindent all the lines within one parenthetical grouping (@code{indent-pp-sexp}). |
38867 | 422 @item C-M-\ |
423 Reindent all lines in the region (@code{indent-region}). | |
25829 | 424 @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
|
425 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
|
426 first line is properly indented. |
38149
a07facd0bdf8
(Multi-line Indent): Document indent-code-rigidly.
Eli Zaretskii <eliz@gnu.org>
parents:
38148
diff
changeset
|
427 @item M-x indent-code-rigidly |
a07facd0bdf8
(Multi-line Indent): Document indent-code-rigidly.
Eli Zaretskii <eliz@gnu.org>
parents:
38148
diff
changeset
|
428 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
|
429 lines that start inside comments and strings. |
25829 | 430 @end table |
431 | |
432 @kindex C-M-q | |
59475
279e43932b6f
(Multi-line Indent): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
59461
diff
changeset
|
433 @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
|
434 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
|
435 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
|
436 (@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
|
437 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
|
438 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
|
439 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
|
440 overall indentation. To correct that as well, type @key{TAB} first. |
25829 | 441 |
38867 | 442 Another way to specify the range to be reindented is with the |
443 region. The command @kbd{C-M-\} (@code{indent-region}) applies | |
444 @key{TAB} to every line whose first character is between point and | |
445 mark. | |
446 | |
25829 | 447 @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
|
448 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
|
449 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
|
450 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
|
451 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
|
452 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
|
453 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
|
454 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
|
455 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
|
456 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
|
457 to them. |
25829 | 458 |
38149
a07facd0bdf8
(Multi-line Indent): Document indent-code-rigidly.
Eli Zaretskii <eliz@gnu.org>
parents:
38148
diff
changeset
|
459 @findex indent-code-rigidly |
38867 | 460 You can also perform this operation on the region, using the command |
461 @kbd{M-x indent-code-rigidly}. It rigidly shifts all the lines in the | |
462 region sideways, like @code{indent-rigidly} does (@pxref{Indentation | |
463 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
|
464 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
|
465 The prefix arg specifies the number of columns to indent. |
25829 | 466 |
467 @node Lisp Indent | |
468 @subsection Customizing Lisp Indentation | |
469 @cindex customizing Lisp indentation | |
470 | |
471 The indentation pattern for a Lisp expression can depend on the function | |
472 called by the expression. For each Lisp function, you can choose among | |
473 several predefined patterns of indentation, or define an arbitrary one with | |
474 a Lisp program. | |
475 | |
476 The standard pattern of indentation is as follows: the second line of the | |
477 expression is indented under the first argument, if that is on the same | |
478 line as the beginning of the expression; otherwise, the second line is | |
479 indented underneath the function name. Each following line is indented | |
480 under the previous line whose nesting depth is the same. | |
481 | |
482 @vindex lisp-indent-offset | |
483 If the variable @code{lisp-indent-offset} is non-@code{nil}, it overrides | |
484 the usual indentation pattern for the second line of an expression, so that | |
485 such lines are always indented @code{lisp-indent-offset} more columns than | |
486 the containing list. | |
487 | |
488 @vindex lisp-body-indent | |
38231
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
489 Certain functions override the standard pattern. Functions whose |
42675 | 490 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
|
491 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
|
492 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
|
493 expression. |
25829 | 494 |
41409
9cea749ef5c3
(Lisp Indent): Add index entry for lisp-indent-function.
Eli Zaretskii <eliz@gnu.org>
parents:
40175
diff
changeset
|
495 @cindex @code{lisp-indent-function} property |
38231
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
496 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
|
497 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
|
498 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
|
499 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
|
500 Macros,,, elisp, the Emacs Lisp Reference Manual}). |
25829 | 501 |
502 @node C Indent | |
503 @subsection Commands for C Indentation | |
504 | |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
505 Here are special features for indentation in C mode and related modes: |
25829 | 506 |
507 @table @code | |
508 @item C-c C-q | |
509 @kindex C-c C-q @r{(C mode)} | |
510 @findex c-indent-defun | |
511 Reindent the current top-level function definition or aggregate type | |
512 declaration (@code{c-indent-defun}). | |
513 | |
514 @item C-M-q | |
515 @kindex C-M-q @r{(C mode)} | |
516 @findex c-indent-exp | |
517 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
|
518 (@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
|
519 about invalid syntax. |
25829 | 520 |
521 @item @key{TAB} | |
522 @findex c-indent-command | |
523 Reindent the current line, and/or in some cases insert a tab character | |
524 (@code{c-indent-command}). | |
525 | |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
526 @vindex c-tab-always-indent |
25829 | 527 If @code{c-tab-always-indent} is @code{t}, this command always reindents |
528 the current line and does nothing else. This is the default. | |
529 | |
530 If that variable is @code{nil}, this command reindents the current line | |
531 only if point is at the left margin or in the line's indentation; | |
532 otherwise, it inserts a tab (or the equivalent number of spaces, | |
533 if @code{indent-tabs-mode} is @code{nil}). | |
534 | |
535 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
|
536 line, and also insert a tab if within a comment or a string. |
25829 | 537 @end table |
538 | |
539 To reindent the whole current buffer, type @kbd{C-x h C-M-\}. This | |
540 first selects the whole buffer as the region, then reindents that | |
541 region. | |
542 | |
543 To reindent the current block, use @kbd{C-M-u C-M-q}. This moves | |
544 to the front of the block and then reindents it all. | |
545 | |
546 @node Custom C Indent | |
547 @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
|
548 @cindex style (for indentation) |
25829 | 549 |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
550 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
|
551 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
|
552 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
|
553 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
|
554 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
|
555 onto the indentation of the @dfn{anchor statement}. |
25829 | 556 |
557 @table @kbd | |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
558 @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
|
559 Select a predefined style @var{style} (@code{c-set-style}). |
25829 | 560 @end table |
561 | |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
562 A @dfn{style} is a named collection of customizations that can be |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
563 used in C mode and the related modes. @ref{Styles,,, ccmode, The CC |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
564 Mode Manual}, for a complete description. Emacs comes with several |
38212
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}, |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
567 @code{whitesmith}, @code{ellemtel}, and @code{awk}. Some of these |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
568 styles are primarily intended for one language, but any of them can be |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
569 used with any of the languages supported by these modes. To find out |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
570 what a style looks like, select it and reindent some code, e.g., by |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
571 typing @key{C-M-q} at the start of a function definition. |
25829 | 572 |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
573 @kindex C-c . @r{(C mode)} |
25829 | 574 @findex c-set-style |
68697 | 575 To choose a style for the current buffer, use the command @w{@kbd{C-c |
576 .}}. Specify a style name as an argument (case is not significant). | |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
577 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
|
578 future invocations of the indentation commands; it does not reindent |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
579 the code already in the buffer. To reindent the whole buffer in the |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
580 new 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
|
581 |
071d97105015
Proofreading fixes from Peter Milliken.
Eli Zaretskii <eliz@gnu.org>
parents:
38136
diff
changeset
|
582 @vindex c-default-style |
071d97105015
Proofreading fixes from Peter Milliken.
Eli Zaretskii <eliz@gnu.org>
parents:
38136
diff
changeset
|
583 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
|
584 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
|
585 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
|
586 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
|
587 example, |
25829 | 588 |
589 @example | |
590 (setq c-default-style | |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
591 '((java-mode . "java") (awk-mode . "awk") (other . "gnu"))) |
25829 | 592 @end example |
593 | |
594 @noindent | |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
595 specifies explicit choices for Java and AWK modes, and the default |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
596 @samp{gnu} style for the other C-like modes. (These settings are |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
597 actually the defaults.) This variable takes effect when you select |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
598 one of the C-like major modes; thus, if you specify a new default |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
599 style for Java mode, you can make it take effect in an existing Java |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
600 mode buffer by 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
|
601 |
ec15967a5cf7
Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents:
38149
diff
changeset
|
602 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
|
603 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
|
604 recommended style. |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
605 |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
606 @xref{Indentation Engine Basics,,, ccmode, the CC Mode Manual}, and |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
607 @ref{Customizing Indentation,,, ccmode, the CC Mode Manual}, for more |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
608 information on customizing indentation for C and related modes, |
38212
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 | 623 in pairs. The major mode controls which delimiters are significant, |
624 through the syntax table (@pxref{Syntax}). In Lisp, only parentheses | |
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 | 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 | 669 By convention, the keys for these commands are all Control-Meta |
670 characters. They usually act on expressions just as the corresponding | |
671 Meta characters act on words. For instance, the command @kbd{C-M-b} | |
672 moves backward over a balanced expression, just as @kbd{M-b} moves | |
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 | 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 |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
711 repeat count, moving the previous expression over that many following |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
712 ones. A negative argument drags the previous balanced expression |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
713 backwards across those before it (thus canceling out the effect of |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
714 @kbd{C-M-t} with a positive argument). An argument of zero, rather |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
715 than doing nothing, transposes the balanced expressions ending at or |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
716 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
|
717 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
718 @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
|
719 @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
|
720 @findex mark-sexp |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
721 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
|
722 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
|
723 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
|
724 @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
|
725 the mark at the beginning of the previous balanced expression. The |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
726 alias @kbd{C-M-@key{SPC}} is equivalent to @kbd{C-M-@@}. When you |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
727 repeat this command, or use it in Transient Mark mode when the mark is |
68697 | 728 active, it extends the end of 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
|
729 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
730 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
|
731 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
|
732 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
|
733 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
|
734 @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
|
735 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
|
736 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
|
737 choices for ``the expression following point'' when point is at the |
38867 | 738 @samp{f}, so the expression commands must perforce choose one or the |
739 other to operate on. Note that @samp{(foo + bar)} is recognized as a | |
740 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
|
741 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
742 @node Moving by Parens |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
743 @subsection Moving in the Parenthesis Structure |
25829 | 744 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
745 @cindex parenthetical groupings |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
746 @cindex parentheses, moving across |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
747 @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
|
748 @cindex braces, moving across |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
749 @cindex list commands |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
750 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
|
751 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
|
752 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
|
753 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
|
754 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
|
755 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
|
756 groupings are lists. |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
757 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
758 @table @kbd |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
759 @item C-M-n |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
760 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
|
761 @item C-M-p |
59371
364d233a8dc3
Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents:
56809
diff
changeset
|
762 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
|
763 @item C-M-u |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
764 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
|
765 @item C-M-d |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
766 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
|
767 @end table |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
768 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
769 @kindex C-M-n |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
770 @kindex C-M-p |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
771 @findex forward-list |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
772 @findex backward-list |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
773 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
|
774 @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
|
775 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
|
776 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
|
777 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
778 @kindex C-M-u |
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 @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
|
781 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
|
782 @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
|
783 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
|
784 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
|
785 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
|
786 |
68697 | 787 @kindex C-M-d |
788 @findex down-list | |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
789 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
|
790 (@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
|
791 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
|
792 argument specifies the number of levels to go down. |
25829 | 793 |
794 @node Matching | |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
795 @subsection Automatic Display Of Matching Parentheses |
25829 | 796 @cindex matching parentheses |
797 @cindex parentheses, displaying matches | |
798 | |
799 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
|
800 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
|
801 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
|
802 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
|
803 matching opening delimiter, provided that is on the screen. If it is |
38867 | 804 not on the screen, Emacs displays some of the text near it in the echo |
805 area. Either way, you can tell which grouping you are closing off. | |
25829 | 806 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
807 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
|
808 as in @samp{[x)}---a warning message is displayed in the echo area. |
25829 | 809 |
810 @vindex blink-matching-paren | |
811 @vindex blink-matching-paren-distance | |
812 @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
|
813 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
|
814 |
26a204697252
Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents:
59371
diff
changeset
|
815 @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
|
816 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
|
817 |
ec15967a5cf7
Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents:
38149
diff
changeset
|
818 @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
|
819 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
|
820 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
|
821 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
|
822 |
ec15967a5cf7
Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents:
38149
diff
changeset
|
823 @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
|
824 back to search to find the matching opening delimiter. If the match |
38287 | 825 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
|
826 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
|
827 lots of time when there is no match. The default is 25600. |
25829 | 828 |
829 @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
|
830 @cindex highlighting matching parentheses |
25829 | 831 @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
|
832 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
|
833 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
|
834 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
|
835 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
|
836 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
|
837 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
|
838 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
|
839 |
68697 | 840 Show Paren mode uses the faces @code{show-paren-match} and |
841 @code{show-paren-mismatch} to highlight parentheses; you can customize | |
842 them to control how highlighting looks. @xref{Face Customization}. | |
25829 | 843 |
844 @node Comments | |
845 @section Manipulating Comments | |
846 @cindex comments | |
847 | |
848 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
|
849 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
|
850 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
|
851 (@pxref{Spelling}). |
25829 | 852 |
853 @menu | |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
854 * 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
|
855 * 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
|
856 * Options for Comments::Customizing the comment features. |
25829 | 857 @end menu |
858 | |
859 @node Comment Commands | |
860 @subsection Comment Commands | |
861 @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
|
862 |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
863 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
|
864 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
|
865 |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
866 @table @asis |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
867 @item @kbd{M-;} |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
868 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
|
869 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
|
870 @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
|
871 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
|
872 @item @kbd{C-x ;} |
38018
f802bdff6c2c
Update various command names and variable defaults.
Richard M. Stallman <rms@gnu.org>
parents:
38009
diff
changeset
|
873 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
|
874 @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
|
875 @itemx @kbd{M-j} |
25829 | 876 Like @key{RET} followed by inserting and aligning a comment |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
877 (@code{comment-indent-new-line}). @xref{Multi-Line Comments}. |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
878 @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
|
879 @itemx @kbd{C-c C-c} (in C-like modes) |
25829 | 880 Add or remove comment delimiters on all the lines in the region. |
881 @end table | |
882 | |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
883 @kindex M-; |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
884 @findex comment-dwim |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
885 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
|
886 (@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
|
887 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
|
888 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
|
889 you use it. |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
890 |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
891 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
|
892 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
|
893 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
|
894 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
|
895 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
|
896 away. If the major mode has specified a string to terminate comments, |
68697 | 897 @kbd{M-;} inserts that after point, to keep the syntax valid. |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
898 |
68697 | 899 If the text of the line extends past the comment column, this |
900 command indents the comment start string to a suitable boundary | |
901 (usually, at least one space is inserted). | |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
902 |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
903 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
|
904 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
|
905 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
|
906 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
|
907 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
|
908 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
|
909 |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
910 @findex comment-kill |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
911 @kindex C-u M-; |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
912 @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
|
913 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
|
914 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
|
915 realign it. |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
916 |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
917 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
|
918 (@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
|
919 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
|
920 @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
|
921 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
|
922 |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
923 @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
|
924 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
|
925 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
|
926 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
|
927 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
|
928 mode, then you should use the commands @code{comment-region} and |
68697 | 929 @code{uncomment-region} to do these jobs (@pxref{Multi-Line Comments}), |
930 or else enable Transient Mark mode momentarily (@pxref{Momentary Mark}). | |
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 | 933 |
934 Some major modes have special rules for indenting certain kinds of | |
935 comments in certain contexts. For example, in Lisp code, comments which | |
936 start with two semicolons are indented as if they were lines of code, | |
937 instead of at the comment column. Comments which start with three | |
938 semicolons are supposed to start at the left margin. Emacs understands | |
939 these conventions by indenting a double-semicolon comment using @key{TAB}, | |
940 and by not changing the indentation of a triple-semicolon comment at all. | |
941 | |
942 @example | |
943 ;; This function is just an example | |
944 ;;; Here either two or three semicolons are appropriate. | |
945 (defun foo (x) | |
946 ;;; And now, the first part of the function: | |
947 ;; The following line adds one. | |
948 (1+ x)) ; This line adds one. | |
949 @end example | |
950 | |
68697 | 951 For C-like modes, you can configure the exact effect of @kbd{M-;} |
952 more flexibly than for most buffers by setting the variables | |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
953 @code{c-indent-comment-alist} and |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
954 @code{c-indent-comments-syntactically-p}. For example, on a line |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
955 ending in a closing brace, @kbd{M-;} puts the comment one space after |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
956 the brace rather than at @code{comment-column}. For full details see |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
957 @ref{Comment Commands,,, ccmode, The CC Mode Manual}. |
25829 | 958 |
959 @node Multi-Line Comments | |
960 @subsection Multiple Lines of Comments | |
961 | |
962 @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
|
963 @kindex M-j |
25829 | 964 @cindex blank lines in programs |
38018
f802bdff6c2c
Update various command names and variable defaults.
Richard M. Stallman <rms@gnu.org>
parents:
38009
diff
changeset
|
965 @findex comment-indent-new-line |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
966 |
25829 | 967 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
|
968 you can use the command @kbd{C-M-j} or @kbd{M-j} |
67683
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
969 (@code{comment-indent-new-line}). If @code{comment-multi-line} |
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
970 (@pxref{Options for Comments}) is non-@code{nil}, it moves to a new |
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
971 line within the comment. Otherwise it closes the comment and starts a |
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
972 new comment on a new line. When Auto Fill mode is on, going past the |
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
973 fill column while typing a comment causes the comment to be continued |
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
974 in just this fashion. |
25829 | 975 |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
976 @kindex C-c C-c (C mode) |
25829 | 977 @findex comment-region |
978 To turn existing lines into comment lines, use the @kbd{M-x | |
68697 | 979 comment-region} command (or type @kbd{C-c C-c} in C-like modes). It |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
980 adds comment delimiters to the lines that start in the region, thus |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
981 commenting them out. With a negative argument, it does the |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
982 opposite---it deletes comment delimiters from the lines in the region. |
25829 | 983 |
984 With a positive argument, @code{comment-region} duplicates the last | |
985 character of the comment start sequence it adds; the argument specifies | |
986 how many copies of the character to insert. Thus, in Lisp mode, | |
987 @kbd{C-u 2 M-x comment-region} adds @samp{;;} to each line. Duplicating | |
988 the comment delimiter is a way of calling attention to the comment. It | |
989 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
|
990 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
|
991 if within a defun, it must be three. |
25829 | 992 |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
993 You can configure C Mode such that when you type a @samp{/} at the |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
994 start of a line in a multi-line block comment, this closes the |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
995 comment. Enable the @code{comment-close-slash} clean-up for this. |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
996 @xref{Clean-ups,,, ccmode, The CC Mode Manual}. |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
997 |
25829 | 998 @node Options for Comments |
999 @subsection Options Controlling Comments | |
1000 | |
1001 @vindex comment-column | |
1002 @kindex C-x ; | |
38018
f802bdff6c2c
Update various command names and variable defaults.
Richard M. Stallman <rms@gnu.org>
parents:
38009
diff
changeset
|
1003 @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
|
1004 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
|
1005 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
|
1006 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
|
1007 (@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
|
1008 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
|
1009 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
|
1010 align the current line's comment under the previous one. |
25829 | 1011 |
1012 The variable @code{comment-column} is per-buffer: setting the variable | |
1013 in the normal fashion affects only the current buffer, but there is a | |
1014 default value which you can change with @code{setq-default}. | |
1015 @xref{Locals}. Many major modes initialize this variable for the | |
1016 current buffer. | |
1017 | |
1018 @vindex comment-start-skip | |
1019 The comment commands recognize comments based on the regular | |
1020 expression that is the value of the variable @code{comment-start-skip}. | |
1021 Make sure this regexp does not match the null string. It may match more | |
1022 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
|
1023 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
|
1024 @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
|
1025 @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
|
1026 after the @samp{/*} itself, and accepts C++ style comments also. |
25829 | 1027 (Note that @samp{\\} is needed in Lisp syntax to include a @samp{\} in |
1028 the string, which is needed to deny the first star its special meaning | |
64920
e736a91dd7b5
(Options for Comments): Fix xref.
Richard M. Stallman <rms@gnu.org>
parents:
64890
diff
changeset
|
1029 in regexp syntax. @xref{Regexp Backslash}.) |
25829 | 1030 |
1031 @vindex comment-start | |
1032 @vindex comment-end | |
1033 When a comment command makes a new comment, it inserts the value of | |
1034 @code{comment-start} to begin it. The value of @code{comment-end} is | |
67513
375a247b599e
(Options for Comments): Comment-end starts with space.
Richard M. Stallman <rms@gnu.org>
parents:
64920
diff
changeset
|
1035 inserted after point, so that it will follow the text that you will |
375a247b599e
(Options for Comments): Comment-end starts with space.
Richard M. Stallman <rms@gnu.org>
parents:
64920
diff
changeset
|
1036 insert into the comment. When @code{comment-end} is non-empty, it |
375a247b599e
(Options for Comments): Comment-end starts with space.
Richard M. Stallman <rms@gnu.org>
parents:
64920
diff
changeset
|
1037 should start with a space. For example, in C mode, |
375a247b599e
(Options for Comments): Comment-end starts with space.
Richard M. Stallman <rms@gnu.org>
parents:
64920
diff
changeset
|
1038 @code{comment-start} has the value @w{@code{"/* "}} and |
375a247b599e
(Options for Comments): Comment-end starts with space.
Richard M. Stallman <rms@gnu.org>
parents:
64920
diff
changeset
|
1039 @code{comment-end} has the value @w{@code{" */"}}. |
25829 | 1040 |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1041 @vindex comment-padding |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1042 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
|
1043 @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
|
1044 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
|
1045 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
|
1046 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
|
1047 |
25829 | 1048 @vindex comment-multi-line |
1049 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
|
1050 (@code{indent-new-comment-line}) behaves when used inside a comment. |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1051 Specifically, when @code{comment-multi-line} is @code{nil}, the |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1052 command inserts a comment terminator, begins a new line, and finally |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1053 inserts a comment starter. Otherwise it does not insert the |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1054 terminator and starter, so it effectively continues the current |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1055 comment across multiple lines. In languages that allow multi-line |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1056 comments, the choice of value for this variable is a matter of taste. |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1057 The default for this variable depends on the major mode. |
25829 | 1058 |
41495 | 1059 @vindex comment-indent-function |
25829 | 1060 The variable @code{comment-indent-function} should contain a function |
1061 that will be called to compute the indentation for a newly inserted | |
1062 comment or for aligning an existing comment. It is set differently by | |
1063 various major modes. The function is called with no arguments, but with | |
1064 point at the beginning of the comment, or at the end of a line if a new | |
1065 comment is to be inserted. It should return the column in which the | |
1066 comment ought to start. For example, in Lisp mode, the indent hook | |
1067 function bases its decision on how many semicolons begin an existing | |
1068 comment, and on the code in the preceding lines. | |
1069 | |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1070 @node Documentation |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1071 @section Documentation Lookup |
25829 | 1072 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1073 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
|
1074 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
|
1075 use in your program. |
25829 | 1076 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1077 @menu |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1078 * 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
|
1079 in Info files. |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1080 * 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
|
1081 * 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
|
1082 @end menu |
25829 | 1083 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1084 @node Info Lookup |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1085 @subsection Info Documentation Lookup |
27221
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
1086 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1087 @findex info-lookup-symbol |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1088 @findex info-lookup-file |
56164
f5e9166d3954
(Info Lookup): Fix keybinding for
Jesper Harder <harder@ifa.au.dk>
parents:
56086
diff
changeset
|
1089 @kindex C-h S |
68697 | 1090 For many major modes, that apply to languages that have |
1091 documentation in Info, you can use @kbd{C-h S} | |
1092 (@code{info-lookup-symbol}) to view the Info documentation for a | |
1093 symbol used in the program. You specify the symbol with the | |
1094 minibuffer; the default is the symbol appearing in the buffer at | |
1095 point. For example, in C mode this looks for the symbol in the C | |
1096 Library Manual. The command only works if the appropriate manual's | |
1097 Info files are installed. | |
25829 | 1098 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1099 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
|
1100 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
|
1101 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
|
1102 for a file name. |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1103 |
68697 | 1104 If you use @kbd{C-h S} in a major mode that does not support it, |
1105 it asks you to specify the ``symbol help mode''. You should enter | |
1106 a command such as @code{c-mode} that would select a major | |
1107 mode which @kbd{C-h S} does support. | |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1108 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1109 @node Man Page |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1110 @subsection Man Page Lookup |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1111 |
38867 | 1112 @cindex manual page |
1113 On Unix, the main form of on-line documentation was the @dfn{manual | |
68697 | 1114 page} or @dfn{man page}. In the GNU operating system, we aim to |
38867 | 1115 replace man pages with better-organized manuals that you can browse |
1116 with Info (@pxref{Misc Help}). This process is not finished, so it is | |
1117 still useful to read manual pages. | |
25829 | 1118 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1119 @findex manual-entry |
38867 | 1120 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
|
1121 function, or system call, with the @kbd{M-x man} command. It |
38867 | 1122 runs the @code{man} program to format the man page; if the system |
1123 permits, it runs @code{man} asynchronously, so that you can keep on | |
1124 editing while the page is being formatted. (On MS-DOS and MS-Windows | |
1125 3, you cannot edit while Emacs waits for @code{man} to finish.) The | |
1126 result goes in a buffer named @samp{*Man @var{topic}*}. These buffers | |
1127 use a special major mode, Man mode, that facilitates scrolling and | |
1128 jumping to other manual pages. For details, type @kbd{C-h m} while in | |
1129 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
|
1130 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1131 @cindex sections of manual pages |
38867 | 1132 Each man page belongs to one of ten or more @dfn{sections}, each |
1133 named by a digit or by a digit and a letter. Sometimes there are | |
1134 multiple man pages with the same name in different sections. To read | |
1135 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
|
1136 @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
|
1137 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
|
1138 read the man page for the C library function @code{chmod} (as opposed |
38867 | 1139 to a command of the same name), type @kbd{M-x manual-entry @key{RET} |
68697 | 1140 chmod(2) @key{RET}}. (@code{chmod} is a system call, so it is in |
1141 section @samp{2}.) | |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1142 |
38667
6ed2cc05e016
(Man Page): Mention the -a switch to `man' in a footnote.
Eli Zaretskii <eliz@gnu.org>
parents:
38323
diff
changeset
|
1143 @vindex Man-switches |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1144 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
|
1145 @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
|
1146 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
|
1147 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
|
1148 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
|
1149 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
|
1150 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
|
1151 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
|
1152 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
|
1153 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1154 @vindex Man-fontify-manpage-flag |
38867 | 1155 By default, Emacs highlights the text in man pages. For a long man |
1156 page, highlighting can take substantial time. You can turn off | |
1157 highlighting of man pages by setting the variable | |
1158 @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
|
1159 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1160 @findex Man-fontify-manpage |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1161 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
|
1162 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
|
1163 perform the same conversions that @kbd{M-x manual-entry} does. |
25829 | 1164 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1165 @findex woman |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1166 @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
|
1167 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
|
1168 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
|
1169 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
|
1170 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
|
1171 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
|
1172 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
|
1173 @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
|
1174 available. |
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
1175 |
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
1176 @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
|
1177 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
|
1178 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
|
1179 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
|
1180 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
|
1181 name the manual page. |
25829 | 1182 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1183 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
|
1184 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
|
1185 manual pages. |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1186 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1187 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
|
1188 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
|
1189 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
|
1190 them. |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1191 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1192 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
|
1193 @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
|
1194 Manual}. |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1195 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1196 @node Lisp Doc |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1197 @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
|
1198 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1199 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
|
1200 @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
|
1201 (@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
|
1202 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
|
1203 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
|
1204 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
|
1205 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
|
1206 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
|
1207 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
|
1208 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1209 @cindex Eldoc mode |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1210 @findex eldoc-mode |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1211 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
|
1212 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
|
1213 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
|
1214 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
|
1215 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
|
1216 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
|
1217 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
|
1218 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
|
1219 command @kbd{M-x eldoc-mode} to enable or disable this feature. |
25829 | 1220 |
28329
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1221 @node Hideshow |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1222 @section Hideshow minor mode |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1223 |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1224 @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
|
1225 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
|
1226 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
|
1227 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
|
1228 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
|
1229 for those modes. |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1230 |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1231 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
|
1232 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
|
1233 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
|
1234 also count as blocks. |
28329
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1235 |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1236 @findex hs-hide-all |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1237 @findex hs-hide-block |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1238 @findex hs-show-all |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1239 @findex hs-show-block |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1240 @findex hs-show-region |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1241 @findex hs-hide-level |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1242 @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
|
1243 @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
|
1244 @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
|
1245 @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
|
1246 @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
|
1247 @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
|
1248 @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
|
1249 @kindex S-Mouse-2 |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1250 @table @kbd |
37997
c329103798cc
(Hideshow): Fix the docs of keybindings which used a single `@'.
Eli Zaretskii <eliz@gnu.org>
parents:
37978
diff
changeset
|
1251 @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
|
1252 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
|
1253 @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
|
1254 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
|
1255 @item C-c @@ C-c |
59371
364d233a8dc3
Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents:
56809
diff
changeset
|
1256 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
|
1257 @item S-Mouse-2 |
59371
364d233a8dc3
Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents:
56809
diff
changeset
|
1258 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
|
1259 @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
|
1260 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
|
1261 @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
|
1262 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
|
1263 @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
|
1264 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
|
1265 (@code{hs-hide-level}). |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1266 @end table |
28329
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1267 |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1268 @vindex hs-hide-comments-when-hiding-all |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1269 @vindex hs-isearch-open |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1270 @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
|
1271 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
|
1272 |
28329
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1273 @table @code |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1274 @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
|
1275 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
|
1276 |
28329
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1277 @item hs-isearch-open |
68697 | 1278 Specifies what kind of hidden blocks incremental search should make |
1279 visible. 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
|
1280 |
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
1281 @table @code |
38946
9a1045bcf43c
Update values of hs-isearch-open.
Richard M. Stallman <rms@gnu.org>
parents:
38871
diff
changeset
|
1282 @item code |
9a1045bcf43c
Update values of hs-isearch-open.
Richard M. Stallman <rms@gnu.org>
parents:
38871
diff
changeset
|
1283 Open only code blocks. |
38231
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
1284 @item comment |
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
1285 Open only comments. |
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
1286 @item t |
38946
9a1045bcf43c
Update values of hs-isearch-open.
Richard M. Stallman <rms@gnu.org>
parents:
38871
diff
changeset
|
1287 Open both code blocks and comments. |
38231
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
1288 @item nil |
38946
9a1045bcf43c
Update values of hs-isearch-open.
Richard M. Stallman <rms@gnu.org>
parents:
38871
diff
changeset
|
1289 Open neither code blocks nor comments. |
38231
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
1290 @end table |
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
1291 |
28329
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1292 @item hs-special-modes-alist |
38867 | 1293 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
|
1294 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
|
1295 for more information. |
28329
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1296 @end table |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1297 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1298 @node Symbol Completion |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1299 @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
|
1300 @cindex completion (symbol names) |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1301 |
38867 | 1302 In Emacs, completion is something you normally do in the minibuffer. |
1303 But one kind of completion is available in all buffers: completion for | |
1304 symbol names. | |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1305 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1306 @kindex M-TAB |
38867 | 1307 The character @kbd{M-@key{TAB}} runs a command to complete the |
1308 partial symbol before point against the set of meaningful symbol | |
1309 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
|
1310 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
|
1311 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
|
1312 @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
|
1313 |
38867 | 1314 If the partial name in the buffer has multiple possible completions |
1315 that differ in the very next character, so that it is impossible to | |
1316 complete even one more character, @kbd{M-@key{TAB}} displays a list of | |
1317 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
|
1318 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1319 @cindex tags-based completion |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1320 @cindex Info index completion |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1321 @findex complete-symbol |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1322 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
|
1323 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
|
1324 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
|
1325 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
|
1326 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
|
1327 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
|
1328 @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
|
1329 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
|
1330 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
|
1331 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
|
1332 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1333 @cindex Lisp symbol completion |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1334 @cindex completion (Lisp symbols) |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1335 @findex lisp-complete-symbol |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1336 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
|
1337 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
|
1338 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
|
1339 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
|
1340 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
|
1341 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
|
1342 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1343 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
|
1344 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
|
1345 |
30810
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1346 @node Glasses |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1347 @section Glasses minor mode |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1348 @cindex Glasses mode |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1349 @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
|
1350 @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
|
1351 @findex glasses-mode |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1352 |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1353 Glasses minor mode makes @samp{unreadableIdentifiersLikeThis} |
38867 | 1354 readable by altering the way they display. It knows two different |
1355 ways to do this: by displaying underscores between a lower-case letter | |
1356 and the following capital letter, and by emboldening the capital | |
1357 letters. It does not alter the buffer text, only the way they | |
1358 display, so you can use it even on read-only buffers. You can use the | |
1359 command @kbd{M-x glasses-mode} to enable or disable the mode in the | |
1360 current buffer; you can also add @code{glasses-mode} to the mode hook | |
1361 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
|
1362 to use Glasses mode. |
30810
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1363 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1364 @node Misc for Programs |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1365 @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
|
1366 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1367 A number of Emacs commands that aren't designed specifically for |
38867 | 1368 editing programs are useful for that nonetheless. |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
1369 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1370 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
|
1371 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
|
1372 (@pxref{Words}); sentences can be found in strings and comments |
38867 | 1373 (@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
|
1374 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
|
1375 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
|
1376 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
|
1377 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
|
1378 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
|
1379 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
|
1380 indents the new lines which it creates. |
25829 | 1381 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1382 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
|
1383 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
|
1384 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
|
1385 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
|
1386 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
|
1387 (@pxref{Foldout}). |
25829 | 1388 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1389 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
|
1390 @xref{Top,,Autotyping, autotype, Autotyping}. |
25829 | 1391 |
1392 @node C Modes | |
1393 @section C and Related Modes | |
1394 @cindex C mode | |
1395 @cindex Java mode | |
1396 @cindex Pike mode | |
1397 @cindex IDL mode | |
1398 @cindex CORBA IDL mode | |
1399 @cindex Objective C mode | |
1400 @cindex C++ mode | |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1401 @cindex AWK mode |
25829 | 1402 @cindex mode, Java |
1403 @cindex mode, C | |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1404 @cindex mode, C++ |
25829 | 1405 @cindex mode, Objective C |
1406 @cindex mode, CORBA IDL | |
1407 @cindex mode, Pike | |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1408 @cindex mode, AWK |
25829 | 1409 |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1410 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
|
1411 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
|
1412 (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
|
1413 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
|
1414 and their special features. |
28329
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1415 |
25829 | 1416 @menu |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1417 * 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
|
1418 * 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
|
1419 * 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
|
1420 * 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
|
1421 and other neat features. |
25829 | 1422 @end menu |
1423 | |
1424 @node Motion in C | |
1425 @subsection C Mode Motion Commands | |
1426 | |
1427 This section describes commands for moving point, in C mode and | |
1428 related modes. | |
1429 | |
1430 @table @code | |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1431 @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
|
1432 @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
|
1433 @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
|
1434 @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
|
1435 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
|
1436 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
|
1437 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
|
1438 @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
|
1439 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
|
1440 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
|
1441 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
|
1442 |
25829 | 1443 @item C-c C-u |
1444 @kindex C-c C-u @r{(C mode)} | |
1445 @findex c-up-conditional | |
1446 Move point back to the containing preprocessor conditional, leaving the | |
1447 mark behind. A prefix argument acts as a repeat count. With a negative | |
1448 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
|
1449 preprocessor conditional. |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1450 |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1451 @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
|
1452 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
|
1453 when going forward. |
25829 | 1454 |
1455 @item C-c C-p | |
1456 @kindex C-c C-p @r{(C mode)} | |
1457 @findex c-backward-conditional | |
1458 Move point back over a preprocessor conditional, leaving the mark | |
1459 behind. A prefix argument acts as a repeat count. With a negative | |
1460 argument, move forward. | |
1461 | |
1462 @item C-c C-n | |
1463 @kindex C-c C-n @r{(C mode)} | |
1464 @findex c-forward-conditional | |
1465 Move point forward across a preprocessor conditional, leaving the mark | |
1466 behind. A prefix argument acts as a repeat count. With a negative | |
1467 argument, move backward. | |
1468 | |
1469 @item M-a | |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1470 @kindex M-a (C mode) |
25829 | 1471 @findex c-beginning-of-statement |
1472 Move point to the beginning of the innermost C statement | |
1473 (@code{c-beginning-of-statement}). If point is already at the beginning | |
1474 of a statement, move to the beginning of the preceding statement. With | |
1475 prefix argument @var{n}, move back @var{n} @minus{} 1 statements. | |
1476 | |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1477 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
|
1478 moves by sentences instead of statements. |
25829 | 1479 |
1480 @item M-e | |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1481 @kindex M-e (C mode) |
25829 | 1482 @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
|
1483 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
|
1484 @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
|
1485 (@code{c-end-of-statement}). |
25829 | 1486 @end table |
1487 | |
1488 @node Electric C | |
1489 @subsection Electric C Characters | |
1490 | |
1491 In C mode and related modes, certain printing characters are | |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1492 @dfn{electric}---in addition to inserting themselves, they also |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1493 reindent the current line, and optionally also insert newlines. The |
60112
7cb4576800fa
(Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents:
59798
diff
changeset
|
1494 ``electric'' characters are @kbd{@{}, @kbd{@}}, @kbd{:}, @kbd{#}, |
7cb4576800fa
(Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents:
59798
diff
changeset
|
1495 @kbd{;}, @kbd{,}, @kbd{<}, @kbd{>}, @kbd{/}, @kbd{*}, @kbd{(}, and |
67683
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
1496 @kbd{)}. |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1497 |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1498 You might find electric indentation inconvenient if you are editing |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1499 chaotically indented code. If you are new to CC Mode, you might find |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1500 it disconcerting. You can toggle electric action with the command |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1501 @kbd{C-c C-l}; when it is enabled, @samp{/l} appears in the mode line |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1502 after the mode name: |
25829 | 1503 |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1504 @table @kbd |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1505 @item C-c C-l |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1506 @kindex C-c C-l @r{(C mode)} |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1507 @findex c-toggle-electric-state |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1508 Toggle electric action (@code{c-toggle-electric-state}). With a |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1509 prefix argument, this command enables electric action if the argument |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1510 is positive, disables it if it is negative. |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1511 @end table |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1512 |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1513 Electric characters insert newlines only when, in addition to the |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1514 electric state, the @dfn{auto-newline} feature is enabled (indicated |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1515 by @samp{/la} in the mode line after the mode name). You can turn |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1516 this feature on or off with the command @kbd{C-c C-a}: |
25829 | 1517 |
1518 @table @kbd | |
1519 @item C-c C-a | |
1520 @kindex C-c C-a @r{(C mode)} | |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1521 @findex c-toggle-auto-newline |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1522 Toggle the auto-newline feature (@code{c-toggle-auto-newline}). With a |
25829 | 1523 prefix argument, this command turns the auto-newline feature on if the |
1524 argument is positive, and off if it is negative. | |
1525 @end table | |
1526 | |
67683
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
1527 Usually the CC Mode style configures the exact circumstances in |
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
1528 which Emacs inserts auto-newlines. You can also configure this |
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
1529 directly. @xref{Custom Auto-newlines,,, ccmode, The CC Mode Manual}. |
25829 | 1530 |
1531 @node Hungry Delete | |
1532 @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
|
1533 @cindex hungry deletion (C Mode) |
25829 | 1534 |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1535 If you want to delete an entire block of whitespace at point, you |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1536 can use @dfn{hungry deletion}. This deletes all the contiguous |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1537 whitespace either before point or after point in a single operation. |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1538 @dfn{Whitespace} here includes tabs and newlines, but not comments or |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1539 preprocessor commands. |
25829 | 1540 |
1541 @table @kbd | |
68801
e759a2258b51
programs.texi ("Hungry Delete"): Correct the appellation of the backspace
Alan Mackenzie <acm@muc.de>
parents:
68717
diff
changeset
|
1542 @item C-c C-@key{DEL} |
e759a2258b51
programs.texi ("Hungry Delete"): Correct the appellation of the backspace
Alan Mackenzie <acm@muc.de>
parents:
68717
diff
changeset
|
1543 @itemx C-c @key{DEL} |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1544 @findex c-hungry-backspace |
68801
e759a2258b51
programs.texi ("Hungry Delete"): Correct the appellation of the backspace
Alan Mackenzie <acm@muc.de>
parents:
68717
diff
changeset
|
1545 @kindex C-c C-@key{DEL} (C Mode) |
e759a2258b51
programs.texi ("Hungry Delete"): Correct the appellation of the backspace
Alan Mackenzie <acm@muc.de>
parents:
68717
diff
changeset
|
1546 @kindex C-c @key{DEL} (C Mode) |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1547 @code{c-hungry-backspace}---Delete the entire block of whitespace |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1548 preceding point. |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1549 |
25829 | 1550 @item C-c C-d |
68801
e759a2258b51
programs.texi ("Hungry Delete"): Correct the appellation of the backspace
Alan Mackenzie <acm@muc.de>
parents:
68717
diff
changeset
|
1551 @itemx C-c C-@key{DELETE} |
e759a2258b51
programs.texi ("Hungry Delete"): Correct the appellation of the backspace
Alan Mackenzie <acm@muc.de>
parents:
68717
diff
changeset
|
1552 @itemx C-c @key{DELETE} |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1553 @findex c-hungry-delete-forward |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1554 @kindex C-c C-d (C Mode) |
68801
e759a2258b51
programs.texi ("Hungry Delete"): Correct the appellation of the backspace
Alan Mackenzie <acm@muc.de>
parents:
68717
diff
changeset
|
1555 @kindex C-c C-@key{DELETE} (C Mode) |
e759a2258b51
programs.texi ("Hungry Delete"): Correct the appellation of the backspace
Alan Mackenzie <acm@muc.de>
parents:
68717
diff
changeset
|
1556 @kindex C-c @key{DELETE} (C Mode) |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1557 @code{c-hungry-delete-forward}---Delete the entire block of whitespace |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1558 following point. |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1559 @end table |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1560 |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1561 As an alternative to the above commands, you can enable @dfn{hungry |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1562 delete mode}. When this feature is enabled (indicated by @samp{/h} in |
68818
353348d5ce78
(Defuns): Delete duplicate explanation of left-margin paren convention.
Richard M. Stallman <rms@gnu.org>
parents:
68801
diff
changeset
|
1563 the mode line after the mode name), a single @key{DEL} deletes all |
353348d5ce78
(Defuns): Delete duplicate explanation of left-margin paren convention.
Richard M. Stallman <rms@gnu.org>
parents:
68801
diff
changeset
|
1564 preceding whitespace, not just one space, and a single @kbd{C-c C-d} |
353348d5ce78
(Defuns): Delete duplicate explanation of left-margin paren convention.
Richard M. Stallman <rms@gnu.org>
parents:
68801
diff
changeset
|
1565 (but @emph{not} plain @key{DELETE}) deletes all following whitespace. |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1566 |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1567 @table @kbd |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1568 @item M-x c-toggle-hungry-state |
25829 | 1569 @findex c-toggle-hungry-state |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1570 Toggle the hungry-delete feature |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1571 (@code{c-toggle-hungry-state})@footnote{This command had the binding |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1572 @kbd{C-c C-d} in earlier versions of Emacs. @kbd{C-c C-d} is now |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1573 bound to @code{c-hungry-delete-forward}.}. With a prefix argument, |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1574 this command turns the hungry-delete feature on if the argument is |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1575 positive, and off if it is negative. |
25829 | 1576 @end table |
1577 | |
1578 @vindex c-hungry-delete-key | |
1579 The variable @code{c-hungry-delete-key} controls whether the | |
1580 hungry-delete feature is enabled. | |
1581 | |
1582 @node Other C Commands | |
1583 @subsection Other Commands for C Mode | |
1584 | |
1585 @table @kbd | |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1586 @item C-c C-w |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1587 @itemx M-x c-subword-mode |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1588 @findex c-subword-mode |
67683
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
1589 Enable (or disable) @dfn{subword mode}. In subword mode, Emacs's word |
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
1590 commands then recognize upper case letters in |
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
1591 @samp{StudlyCapsIdentifiers} as word boundaries. This is indicated by |
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
1592 the flag @samp{/w} on the mode line after the mode name |
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
1593 (e.g. @samp{C/law}). You can even use @kbd{M-x c-subword-mode} in |
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
1594 non-CC Mode buffers. |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1595 |
68697 | 1596 In the GNU project, we recommend using underscores to separate words |
1597 within an identifier in C or C++, rather than using case distinctions. | |
1598 | |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1599 @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
|
1600 @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
|
1601 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
|
1602 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
|
1603 @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
|
1604 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
|
1605 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
|
1606 |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1607 @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
|
1608 needs a binding to be useful. The following code will bind it to |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1609 @kbd{C-j}. We use @code{c-initialization-hook} here to make sure |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1610 the keymap is loaded before we try to change it. |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1611 |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1612 @example |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1613 (defun my-bind-clb () |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1614 (define-key c-mode-base-map "\C-j" 'c-context-line-break)) |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1615 (add-hook 'c-initialization-hook 'my-bind-clb) |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1616 @end example |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1617 |
25829 | 1618 @item C-M-h |
1619 Put mark at the end of a function definition, and put point at the | |
1620 beginning (@code{c-mark-function}). | |
1621 | |
1622 @item M-q | |
1623 @kindex M-q @r{(C mode)} | |
1624 @findex c-fill-paragraph | |
1625 Fill a paragraph, handling C and C++ comments (@code{c-fill-paragraph}). | |
1626 If any part of the current line is a comment or within a comment, this | |
1627 command fills the comment or the paragraph of it that point is in, | |
1628 preserving the comment indentation and comment delimiters. | |
1629 | |
1630 @item C-c C-e | |
1631 @cindex macro expansion in C | |
1632 @cindex expansion of C macros | |
1633 @findex c-macro-expand | |
1634 @kindex C-c C-e @r{(C mode)} | |
1635 Run the C preprocessor on the text in the region, and show the result, | |
1636 which includes the expansion of all the macro calls | |
1637 (@code{c-macro-expand}). The buffer text before the region is also | |
1638 included in preprocessing, for the sake of macros defined there, but the | |
1639 output from this part isn't shown. | |
1640 | |
1641 When you are debugging C code that uses macros, sometimes it is hard to | |
1642 figure out precisely how the macros expand. With this command, you | |
1643 don't have to figure it out; you can see the expansions. | |
1644 | |
1645 @item C-c C-\ | |
1646 @findex c-backslash-region | |
1647 @kindex C-c C-\ @r{(C mode)} | |
1648 Insert or align @samp{\} characters at the ends of the lines of the | |
1649 region (@code{c-backslash-region}). This is useful after writing or | |
1650 editing a C macro definition. | |
1651 | |
1652 If a line already ends in @samp{\}, this command adjusts the amount of | |
1653 whitespace before it. Otherwise, it inserts a new @samp{\}. However, | |
1654 the last line in the region is treated specially; no @samp{\} is | |
1655 inserted on that line, and any @samp{\} there is deleted. | |
1656 | |
1657 @item M-x cpp-highlight-buffer | |
1658 @cindex preprocessor highlighting | |
1659 @findex cpp-highlight-buffer | |
1660 Highlight parts of the text according to its preprocessor conditionals. | |
1661 This command displays another buffer named @samp{*CPP Edit*}, which | |
1662 serves as a graphic menu for selecting how to display particular kinds | |
1663 of conditionals and their contents. After changing various settings, | |
1664 click on @samp{[A]pply these settings} (or go to that buffer and type | |
1665 @kbd{a}) to rehighlight the C mode buffer accordingly. | |
1666 | |
1667 @item C-c C-s | |
1668 @findex c-show-syntactic-information | |
1669 @kindex C-c C-s @r{(C mode)} | |
1670 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
|
1671 (@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
|
1672 the line is indented. |
30810
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1673 |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1674 @item M-x cwarn-mode |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1675 @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
|
1676 @findex cwarn-mode |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1677 @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
|
1678 @vindex global-cwarn-mode |
30810
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1679 @cindex CWarn mode |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1680 @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
|
1681 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
|
1682 |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1683 @itemize @bullet{} |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1684 @item |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1685 Assignments inside expressions. |
30810
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1686 @item |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1687 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
|
1688 (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
|
1689 @item |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1690 C++ functions with reference parameters. |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1691 @end itemize |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1692 |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1693 @noindent |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1694 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
|
1695 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
|
1696 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
|
1697 @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
|
1698 it work. |
30810
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1699 |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1700 @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
|
1701 @findex hide-ifdef-mode |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1702 @cindex Hide-ifdef mode |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1703 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
|
1704 @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
|
1705 @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
|
1706 |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1707 @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
|
1708 @cindex related files |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1709 @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
|
1710 @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
|
1711 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
|
1712 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
|
1713 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
|
1714 @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
|
1715 names. |
25829 | 1716 @end table |
1717 | |
1718 @node Fortran | |
1719 @section Fortran Mode | |
1720 @cindex Fortran mode | |
1721 @cindex mode, Fortran | |
1722 | |
61021
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
1723 Fortran mode provides special motion commands for Fortran statements |
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
1724 and subprograms, and indentation commands that understand Fortran |
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
1725 conventions of nesting, line numbers and continuation statements. |
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
1726 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
|
1727 proper Fortran continuation lines. |
25829 | 1728 |
1729 Special commands for comments are provided because Fortran comments | |
1730 are unlike those of other languages. Built-in abbrevs optionally save | |
1731 typing when you insert Fortran keywords. | |
1732 | |
1733 Use @kbd{M-x fortran-mode} to switch to this major mode. This command | |
1734 runs the hook @code{fortran-mode-hook} (@pxref{Hooks}). | |
1735 | |
36263
11db0318031d
Remove redundant index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36198
diff
changeset
|
1736 @cindex Fortran77 and Fortran90 |
26106 | 1737 @findex f90-mode |
1738 @findex fortran-mode | |
61021
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
1739 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
|
1740 ``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
|
1741 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
|
1742 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
|
1743 @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
|
1744 @samp{.f95}. GNU Fortran supports both kinds of format. |
26106 | 1745 |
25829 | 1746 @menu |
1747 * Motion: Fortran Motion. Moving point by statements or subprograms. | |
1748 * Indent: Fortran Indent. Indentation commands for Fortran. | |
1749 * Comments: Fortran Comments. Inserting and aligning comments. | |
61021
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
1750 * Autofill: Fortran Autofill. Auto fill support for Fortran. |
25829 | 1751 * Columns: Fortran Columns. Measuring columns for valid Fortran. |
1752 * Abbrev: Fortran Abbrev. Built-in abbrevs for Fortran keywords. | |
1753 @end menu | |
1754 | |
1755 @node Fortran Motion | |
1756 @subsection Motion Commands | |
1757 | |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1758 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
|
1759 ``defuns'' (Fortran subprograms---functions and subroutines, as well as |
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
1760 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
|
1761 statements and other program units. |
25829 | 1762 |
1763 @table @kbd | |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1764 @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
|
1765 @findex fortran-next-statement |
60801
3b533b854268
(Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents:
60434
diff
changeset
|
1766 @findex f90-next-statement |
25829 | 1767 @item C-c C-n |
60801
3b533b854268
(Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents:
60434
diff
changeset
|
1768 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
|
1769 (@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
|
1770 |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1771 @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
|
1772 @findex fortran-previous-statement |
60801
3b533b854268
(Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents:
60434
diff
changeset
|
1773 @findex f90-previous-statement |
25829 | 1774 @item C-c C-p |
60801
3b533b854268
(Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents:
60434
diff
changeset
|
1775 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
|
1776 (@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
|
1777 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
|
1778 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
|
1779 |
3b533b854268
(Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents:
60434
diff
changeset
|
1780 @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
|
1781 @findex f90-next-block |
3b533b854268
(Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents:
60434
diff
changeset
|
1782 @item C-c C-e |
3b533b854268
(Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents:
60434
diff
changeset
|
1783 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
|
1784 (@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
|
1785 @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
|
1786 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
|
1787 moves forward that many blocks. |
3b533b854268
(Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents:
60434
diff
changeset
|
1788 |
3b533b854268
(Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents:
60434
diff
changeset
|
1789 @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
|
1790 @findex f90-previous-block |
3b533b854268
(Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents:
60434
diff
changeset
|
1791 @item C-c C-a |
3b533b854268
(Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents:
60434
diff
changeset
|
1792 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
|
1793 (@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
|
1794 moves backwards. |
3b533b854268
(Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents:
60434
diff
changeset
|
1795 |
61108
6ce7613a2c0e
(Fortran Motion): Add fortran-end-of-block,
Glenn Morris <rgm@gnu.org>
parents:
61099
diff
changeset
|
1796 @kindex C-M-n @r{(Fortran mode)} |
6ce7613a2c0e
(Fortran Motion): Add fortran-end-of-block,
Glenn Morris <rgm@gnu.org>
parents:
61099
diff
changeset
|
1797 @findex fortran-end-of-block |
60801
3b533b854268
(Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents:
60434
diff
changeset
|
1798 @findex f90-end-of-block |
3b533b854268
(Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents:
60434
diff
changeset
|
1799 @item C-M-n |
61133
2338a101c46a
(Fortran Motion): Fix previous change.
Glenn Morris <rgm@gnu.org>
parents:
61108
diff
changeset
|
1800 Move to the end of the current code block |
2338a101c46a
(Fortran Motion): Fix previous change.
Glenn Morris <rgm@gnu.org>
parents:
61108
diff
changeset
|
1801 (@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
|
1802 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
|
1803 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
|
1804 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
|
1805 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
|
1806 |
61108
6ce7613a2c0e
(Fortran Motion): Add fortran-end-of-block,
Glenn Morris <rgm@gnu.org>
parents:
61099
diff
changeset
|
1807 @kindex C-M-p @r{(Fortran mode)} |
6ce7613a2c0e
(Fortran Motion): Add fortran-end-of-block,
Glenn Morris <rgm@gnu.org>
parents:
61099
diff
changeset
|
1808 @findex fortran-beginning-of-block |
60801
3b533b854268
(Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents:
60434
diff
changeset
|
1809 @findex f90-beginning-of-block |
3b533b854268
(Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents:
60434
diff
changeset
|
1810 @item C-M-p |
3b533b854268
(Fortran Motion): Document f90-next-statement,
Richard M. Stallman <rms@gnu.org>
parents:
60434
diff
changeset
|
1811 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
|
1812 (@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
|
1813 is like @code{fortran-end-of-block}, but moves backwards. |
25829 | 1814 @end table |
1815 | |
1816 @node Fortran Indent | |
1817 @subsection Fortran Indentation | |
1818 | |
1819 Special commands and features are needed for indenting Fortran code in | |
1820 order to make sure various syntactic entities (line numbers, comment line | |
1821 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
|
1822 required for standard, fixed (or tab) format Fortran. |
25829 | 1823 |
1824 @menu | |
27221
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
1825 * Commands: ForIndent Commands. Commands for indenting and filling Fortran. |
25829 | 1826 * Contline: ForIndent Cont. How continuation lines indent. |
1827 * Numbers: ForIndent Num. How line numbers auto-indent. | |
1828 * Conv: ForIndent Conv. Conventions you must obey to avoid trouble. | |
1829 * Vars: ForIndent Vars. Variables controlling Fortran indent style. | |
1830 @end menu | |
1831 | |
1832 @node ForIndent Commands | |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1833 @subsubsection Fortran Indentation and Filling Commands |
25829 | 1834 |
1835 @table @kbd | |
1836 @item C-M-j | |
61021
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
1837 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
|
1838 (@code{fortran-split-line}). |
25829 | 1839 @item M-^ |
27221
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
1840 Join this line to the previous line (@code{fortran-join-line}). |
25829 | 1841 @item C-M-q |
1842 Indent all the lines of the subprogram point is in | |
1843 (@code{fortran-indent-subprogram}). | |
27221
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
1844 @item M-q |
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
1845 Fill a comment block or statement. |
25829 | 1846 @end table |
1847 | |
1848 @kindex C-M-q @r{(Fortran mode)} | |
1849 @findex fortran-indent-subprogram | |
1850 The key @kbd{C-M-q} runs @code{fortran-indent-subprogram}, a command | |
1851 to reindent all the lines of the Fortran subprogram (function or | |
1852 subroutine) containing point. | |
1853 | |
1854 @kindex C-M-j @r{(Fortran mode)} | |
1855 @findex fortran-split-line | |
1856 The key @kbd{C-M-j} runs @code{fortran-split-line}, which splits | |
1857 a line in the appropriate fashion for Fortran. In a non-comment line, | |
1858 the second half becomes a continuation line and is indented | |
1859 accordingly. In a comment line, both halves become separate comment | |
1860 lines. | |
1861 | |
1862 @kindex M-^ @r{(Fortran mode)} | |
26106 | 1863 @kindex C-c C-d @r{(Fortran mode)} |
1864 @findex fortran-join-line | |
27221
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
1865 @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
|
1866 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
|
1867 the inverse of @code{fortran-split-line}. The point must be on a |
26106 | 1868 continuation line when this command is invoked. |
1869 | |
27221
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
1870 @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
|
1871 @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
|
1872 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
|
1873 |
25829 | 1874 @node ForIndent Cont |
1875 @subsubsection Continuation Lines | |
1876 @cindex Fortran continuation lines | |
1877 | |
1878 @vindex fortran-continuation-string | |
61021
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
1879 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
|
1880 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
|
1881 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
|
1882 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
|
1883 the Fortran standard counts from 1.) The variable |
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
1884 @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
|
1885 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
|
1886 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
|
1887 continuation @dfn{tab format}. (Fortran90 introduced ``free format'', |
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
1888 with another style of continuation lines). |
25829 | 1889 |
1890 @vindex indent-tabs-mode @r{(Fortran mode)} | |
61021
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
1891 @vindex fortran-analyze-depth |
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
1892 @vindex fortran-tab-mode-default |
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
1893 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
|
1894 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
|
1895 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
|
1896 @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
|
1897 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
|
1898 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
|
1899 buffer is new and therefore empty), the value of |
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
1900 @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
|
1901 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
|
1902 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
|
1903 @code{indent-tabs-mode} accordingly (@pxref{Just Spaces}). |
25829 | 1904 |
61021
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
1905 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
|
1906 @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
|
1907 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
|
1908 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
|
1909 continuation style. When you split a Fortran statement with |
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
1910 @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
|
1911 to the continuation style. |
25829 | 1912 |
1913 The setting of continuation style affects several other aspects of | |
1914 editing in Fortran mode. In fixed format mode, the minimum column | |
1915 number for the body of a statement is 6. Lines inside of Fortran | |
1916 blocks that are indented to larger column numbers always use only the | |
1917 space character for whitespace. In tab format mode, the minimum | |
1918 column number for the statement body is 8, and the whitespace before | |
1919 column 8 must always consist of one tab character. | |
1920 | |
1921 @node ForIndent Num | |
1922 @subsubsection Line Numbers | |
1923 | |
1924 If a number is the first non-whitespace in the line, Fortran | |
1925 indentation assumes it is a line number and moves it to columns 0 | |
1926 through 4. (Columns always count from 0 in GNU Emacs.) | |
1927 | |
1928 @vindex fortran-line-number-indent | |
1929 Line numbers of four digits or less are normally indented one space. | |
1930 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
|
1931 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
|
1932 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
|
1933 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
|
1934 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
|
1935 value 5, line numbers are right-justified to end in column 4. |
25829 | 1936 |
1937 @vindex fortran-electric-line-number | |
1938 Simply inserting a line number is enough to indent it according to | |
1939 these rules. As each digit is inserted, the indentation is recomputed. | |
1940 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
|
1941 @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
|
1942 |
25829 | 1943 |
1944 @node ForIndent Conv | |
1945 @subsubsection Syntactic Conventions | |
1946 | |
1947 Fortran mode assumes that you follow certain conventions that simplify | |
1948 the task of understanding a Fortran program well enough to indent it | |
1949 properly: | |
1950 | |
1951 @itemize @bullet | |
1952 @item | |
1953 Two nested @samp{do} loops never share a @samp{continue} statement. | |
1954 | |
1955 @item | |
1956 Fortran keywords such as @samp{if}, @samp{else}, @samp{then}, @samp{do} | |
1957 and others are written without embedded whitespace or line breaks. | |
1958 | |
1959 Fortran compilers generally ignore whitespace outside of string | |
1960 constants, but Fortran mode does not recognize these keywords if they | |
1961 are not contiguous. Constructs such as @samp{else if} or @samp{end do} | |
1962 are acceptable, but the second word should be on the same line as the | |
1963 first and not on a continuation line. | |
1964 @end itemize | |
1965 | |
1966 @noindent | |
1967 If you fail to follow these conventions, the indentation commands may | |
1968 indent some lines unaesthetically. However, a correct Fortran program | |
1969 retains its meaning when reindented even if the conventions are not | |
1970 followed. | |
1971 | |
1972 @node ForIndent Vars | |
1973 @subsubsection Variables for Fortran Indentation | |
1974 | |
1975 @vindex fortran-do-indent | |
1976 @vindex fortran-if-indent | |
1977 @vindex fortran-structure-indent | |
1978 @vindex fortran-continuation-indent | |
1979 @vindex fortran-check-all-num@dots{} | |
1980 @vindex fortran-minimum-statement-indent@dots{} | |
1981 Several additional variables control how Fortran indentation works: | |
1982 | |
1983 @table @code | |
1984 @item fortran-do-indent | |
1985 Extra indentation within each level of @samp{do} statement (default 3). | |
1986 | |
1987 @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
|
1988 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
|
1989 @samp{where} statements (default 3). |
25829 | 1990 |
1991 @item fortran-structure-indent | |
61021
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
1992 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
|
1993 @samp{map}, or @samp{interface} statements (default 3). |
25829 | 1994 |
1995 @item fortran-continuation-indent | |
1996 Extra indentation for bodies of continuation lines (default 5). | |
1997 | |
1998 @item fortran-check-all-num-for-matching-do | |
61021
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
1999 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
|
2000 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
|
2001 @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
|
2002 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
|
2003 @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
|
2004 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
|
2005 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
|
2006 @code{nil}. The default is @code{nil}. |
25829 | 2007 |
2008 @item fortran-blink-matching-if | |
61021
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
2009 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
|
2010 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
|
2011 @samp{do}) statement to show where it is. The default is @code{nil}. |
25829 | 2012 |
2013 @item fortran-minimum-statement-indent-fixed | |
61021
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
2014 Minimum indentation for Fortran statements when using fixed format |
25829 | 2015 continuation line style. Statement bodies are never indented less than |
2016 this much. The default is 6. | |
2017 | |
2018 @item fortran-minimum-statement-indent-tab | |
61021
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
2019 Minimum indentation for Fortran statements for tab format continuation line |
25829 | 2020 style. Statement bodies are never indented less than this much. The |
2021 default is 8. | |
2022 @end table | |
2023 | |
61021
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
2024 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
|
2025 the following section. |
61021
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
2026 |
25829 | 2027 @node Fortran Comments |
2028 @subsection Fortran Comments | |
2029 | |
61021
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
2030 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
|
2031 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
|
2032 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
|
2033 standard Emacs comment commands and defines some new variables. |
25829 | 2034 |
61021
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
2035 @vindex fortran-comment-line-start |
27221
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
2036 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
|
2037 start with @samp{!} and can follow other text. Because only some Fortran77 |
25829 | 2038 compilers accept this syntax, Fortran mode will not insert such comments |
2039 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
|
2040 @code{fortran-comment-line-start} to @samp{"!"}. |
25829 | 2041 |
2042 @table @kbd | |
2043 @item M-; | |
59461
26a204697252
Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents:
59371
diff
changeset
|
2044 Align comment or insert new comment (@code{fortran-indent-comment}). |
25829 | 2045 |
2046 @item C-x ; | |
2047 Applies to nonstandard @samp{!} comments only. | |
2048 | |
2049 @item C-c ; | |
2050 Turn all lines of the region into comments, or (with argument) turn them back | |
2051 into real code (@code{fortran-comment-region}). | |
2052 @end table | |
2053 | |
61021
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
2054 @findex fortran-indent-comment |
25829 | 2055 @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
|
2056 @code{fortran-indent-comment}. Like the usual @kbd{M-;} command, this |
25829 | 2057 recognizes any kind of existing comment and aligns its text appropriately; |
2058 if there is no existing comment, a comment is inserted and aligned. But | |
2059 inserting and aligning comments are not the same in Fortran mode as in | |
2060 other modes. | |
2061 | |
2062 When a new comment must be inserted, if the current line is blank, a | |
2063 full-line comment is inserted. On a non-blank line, a nonstandard @samp{!} | |
2064 comment is inserted if you have said you want to use them. Otherwise a | |
2065 full-line comment is inserted on a new line before the current line. | |
2066 | |
2067 Nonstandard @samp{!} comments are aligned like comments in other | |
2068 languages, but full-line comments are different. In a standard full-line | |
2069 comment, the comment delimiter itself must always appear in column zero. | |
2070 What can be aligned is the text within the comment. You can choose from | |
2071 three styles of alignment by setting the variable | |
2072 @code{fortran-comment-indent-style} to one of these values: | |
2073 | |
2074 @vindex fortran-comment-indent-style | |
2075 @vindex fortran-comment-line-extra-indent | |
2076 @table @code | |
2077 @item fixed | |
2078 Align the text at a fixed column, which is the sum of | |
2079 @code{fortran-comment-line-extra-indent} and the minimum statement | |
2080 indentation. This is the default. | |
2081 | |
2082 The minimum statement indentation is | |
2083 @code{fortran-minimum-statement-indent-fixed} for fixed format | |
2084 continuation line style and @code{fortran-minimum-statement-indent-tab} | |
2085 for tab format style. | |
2086 | |
2087 @item relative | |
2088 Align the text as if it were a line of code, but with an additional | |
2089 @code{fortran-comment-line-extra-indent} columns of indentation. | |
2090 | |
2091 @item nil | |
59371
364d233a8dc3
Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents:
56809
diff
changeset
|
2092 Don't move text in full-line comments automatically. |
25829 | 2093 @end table |
2094 | |
2095 @vindex fortran-comment-indent-char | |
2096 In addition, you can specify the character to be used to indent within | |
2097 full-line comments by setting the variable | |
2098 @code{fortran-comment-indent-char} to the single-character string you want | |
2099 to use. | |
2100 | |
45997 | 2101 @vindex fortran-directive-re |
2102 Compiler directive lines, or preprocessor lines, have much the same | |
2103 appearance as comment lines. It is important, though, that such lines | |
2104 never be indented at all, no matter what the value of | |
2105 @code{fortran-comment-indent-style}. The variable | |
2106 @code{fortran-directive-re} is a regular expression that specifies which | |
2107 lines are directives. Matching lines are never indented, and receive | |
2108 distinctive font-locking. | |
2109 | |
25829 | 2110 The normal Emacs comment command @kbd{C-x ;} has not been redefined. If |
2111 you use @samp{!} comments, this command can be used with them. Otherwise | |
2112 it is useless in Fortran mode. | |
2113 | |
2114 @kindex C-c ; @r{(Fortran mode)} | |
2115 @findex fortran-comment-region | |
2116 @vindex fortran-comment-region | |
2117 The command @kbd{C-c ;} (@code{fortran-comment-region}) turns all the | |
2118 lines of the region into comments by inserting the string @samp{C$$$} at | |
2119 the front of each one. With a numeric argument, it turns the region | |
2120 back into live code by deleting @samp{C$$$} from the front of each line | |
2121 in it. The string used for these comments can be controlled by setting | |
2122 the variable @code{fortran-comment-region}. Note that here we have an | |
2123 example of a command and a variable with the same name; these two uses | |
2124 of the name never conflict because in Lisp and in Emacs it is always | |
2125 clear from the context which one is meant. | |
2126 | |
2127 @node Fortran Autofill | |
61021
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
2128 @subsection Auto Fill in Fortran Mode |
25829 | 2129 |
61021
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
2130 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
|
2131 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
|
2132 they become too wide. Splitting a statement involves making |
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
2133 continuation lines using @code{fortran-continuation-string} |
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
2134 (@pxref{ForIndent Cont}). This splitting happens when you type |
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
2135 @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
|
2136 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
|
2137 (@pxref{Auto Fill}). |
25829 | 2138 |
2139 @vindex fortran-break-before-delimiters | |
61021
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
2140 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
|
2141 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
|
2142 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
|
2143 @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
|
2144 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
|
2145 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
|
2146 Otherwise (and by default), the break comes before the delimiter. |
25829 | 2147 |
61021
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
2148 To enable Auto Fill in all Fortran buffers, add |
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
2149 @code{turn-on-auto-fill} to @code{fortran-mode-hook}. @xref{Hooks}. |
25829 | 2150 |
2151 @node Fortran Columns | |
2152 @subsection Checking Columns in Fortran | |
2153 | |
2154 @table @kbd | |
2155 @item C-c C-r | |
2156 Display a ``column ruler'' momentarily above the current line | |
2157 (@code{fortran-column-ruler}). | |
2158 @item C-c C-w | |
2159 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
|
2160 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
|
2161 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
|
2162 some Fortran compilers impose. |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
2163 @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
|
2164 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
|
2165 (@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
|
2166 @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
|
2167 Delete all text in column 72 and beyond. |
25829 | 2168 @end table |
2169 | |
2170 @kindex C-c C-r @r{(Fortran mode)} | |
2171 @findex fortran-column-ruler | |
2172 The command @kbd{C-c C-r} (@code{fortran-column-ruler}) shows a column | |
2173 ruler momentarily above the current line. The comment ruler is two lines | |
2174 of text that show you the locations of columns with special significance in | |
2175 Fortran programs. Square brackets show the limits of the columns for line | |
2176 numbers, and curly brackets show the limits of the columns for the | |
2177 statement body. Column numbers appear above them. | |
2178 | |
2179 Note that the column numbers count from zero, as always in GNU Emacs. | |
2180 As a result, the numbers may be one less than those you are familiar | |
2181 with; but the positions they indicate in the line are standard for | |
2182 Fortran. | |
2183 | |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
2184 @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
|
2185 @vindex fortran-column-ruler-tabs |
59371
364d233a8dc3
Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents:
56809
diff
changeset
|
2186 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
|
2187 variable @code{indent-tabs-mode}. If @code{indent-tabs-mode} is |
25829 | 2188 @code{nil}, then the value of the variable |
2189 @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
|
2190 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
|
2191 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
|
2192 display. |
25829 | 2193 |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
2194 @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
|
2195 @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
|
2196 @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
|
2197 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
|
2198 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
|
2199 restore the normal width. |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
2200 |
26106 | 2201 @kindex C-u C-c C-w @r{(Fortran mode)} |
25829 | 2202 @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
|
2203 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
|
2204 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
|
2205 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
|
2206 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
|
2207 |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
2208 @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
|
2209 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
|
2210 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
|
2211 easiest way to get rid of old sequence numbers. |
26106 | 2212 |
25829 | 2213 @node Fortran Abbrev |
2214 @subsection Fortran Keyword Abbrevs | |
2215 | |
2216 Fortran mode provides many built-in abbrevs for common keywords and | |
2217 declarations. These are the same sort of abbrev that you can define | |
2218 yourself. To use them, you must turn on Abbrev mode. @xref{Abbrevs}. | |
2219 | |
2220 The built-in abbrevs are unusual in one way: they all start with a | |
2221 semicolon. You cannot normally use semicolon in an abbrev, but Fortran | |
2222 mode makes this possible by changing the syntax of semicolon to ``word | |
2223 constituent.'' | |
2224 | |
2225 For example, one built-in Fortran abbrev is @samp{;c} for | |
2226 @samp{continue}. If you insert @samp{;c} and then insert a punctuation | |
2227 character such as a space or a newline, the @samp{;c} expands automatically | |
2228 to @samp{continue}, provided Abbrev mode is enabled.@refill | |
2229 | |
2230 Type @samp{;?} or @samp{;C-h} to display a list of all the built-in | |
2231 Fortran abbrevs and what they stand for. | |
2232 | |
2233 @node Asm Mode | |
2234 @section Asm Mode | |
2235 | |
2236 @cindex Asm mode | |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
2237 @cindex assembler mode |
25829 | 2238 Asm mode is a major mode for editing files of assembler code. It |
2239 defines these commands: | |
2240 | |
2241 @table @kbd | |
2242 @item @key{TAB} | |
2243 @code{tab-to-tab-stop}. | |
2244 @item C-j | |
2245 Insert a newline and then indent using @code{tab-to-tab-stop}. | |
2246 @item : | |
2247 Insert a colon and then remove the indentation from before the label | |
2248 preceding colon. Then do @code{tab-to-tab-stop}. | |
2249 @item ; | |
2250 Insert or align a comment. | |
2251 @end table | |
2252 | |
2253 The variable @code{asm-comment-char} specifies which character | |
2254 starts comments in assembler syntax. | |
52401 | 2255 |
2256 @ignore | |
2257 arch-tag: c7ee7409-40a4-45c7-bfb7-ae7f2c74d0c0 | |
2258 @end ignore |