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