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