Mercurial > emacs
annotate man/programs.texi @ 71879:d236eeffa8f7
*** empty log message ***
author | Kim F. Storm <storm@cua.dk> |
---|---|
date | Thu, 13 Jul 2006 22:52:49 +0000 |
parents | a745634e8067 |
children | c7e4f78b81a6 8a8e69664178 |
rev | line source |
---|---|
25829 | 1 @c This is part of the Emacs manual. |
61021
6fb8ff7dc693
Reformat and update copyright years.
Glenn Morris <rgm@gnu.org>
parents:
60801
diff
changeset
|
2 @c Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1997, 1999, 2000, |
68639
dc2d5a6655a3
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
68257
diff
changeset
|
3 @c 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc. |
25829 | 4 @c See file emacs.texi for copying conditions. |
5 @node Programs, Building, Text, Top | |
6 @chapter Editing Programs | |
7 @cindex Lisp editing | |
8 @cindex C editing | |
9 @cindex program editing | |
10 | |
38867 | 11 Emacs provides many features to facilitate editing programs. Some |
12 of these features can | |
25829 | 13 |
14 @itemize @bullet | |
15 @item | |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
16 Find or move over top-level definitions (@pxref{Defuns}). |
25829 | 17 @item |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
18 Apply the usual indentation conventions of the language |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
19 (@pxref{Program Indent}). |
25829 | 20 @item |
59371
364d233a8dc3
Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents:
56809
diff
changeset
|
21 Balance parentheses (@pxref{Parentheses}). |
25829 | 22 @item |
59371
364d233a8dc3
Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents:
56809
diff
changeset
|
23 Insert, kill or align comments (@pxref{Comments}). |
38136
278f2295cde6
New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents:
38123
diff
changeset
|
24 @item |
278f2295cde6
New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents:
38123
diff
changeset
|
25 Highlight program syntax (@pxref{Font Lock}). |
25829 | 26 @end itemize |
27 | |
38867 | 28 This chapter describes these features and many more. |
29 | |
25829 | 30 @menu |
31 * Program Modes:: Major modes for editing programs. | |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
32 * Defuns:: Commands to operate on major top-level parts |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
33 of a program. |
25829 | 34 * Program Indent:: Adjusting indentation to show the nesting. |
56809
bc1eb92f6563
Interchange nodes (for correct numbering).
Luc Teirlinck <teirllm@auburn.edu>
parents:
56164
diff
changeset
|
35 * Parentheses:: Commands that operate on parentheses. |
25829 | 36 * Comments:: Inserting, killing, and aligning comments. |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
37 * Documentation:: Getting documentation of functions you plan to call. |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
38 * Hideshow:: Displaying blocks selectively. |
25829 | 39 * Symbol Completion:: Completion on symbol names of your program or language. |
30810
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
40 * Glasses:: Making identifiersLikeThis more readable. |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
41 * Misc for Programs:: Other Emacs features useful for editing programs. |
26264 | 42 * C Modes:: Special commands of C, C++, Objective-C, |
25829 | 43 Java, and Pike modes. |
28329
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
44 * Asm Mode:: Asm mode and its special features. |
70442
284d18cd0af7
(Program Modes): Replace inforef to emacs-xtra by conditional xref's, depending
Eli Zaretskii <eliz@gnu.org>
parents:
69842
diff
changeset
|
45 @ifnottex |
284d18cd0af7
(Program Modes): Replace inforef to emacs-xtra by conditional xref's, depending
Eli Zaretskii <eliz@gnu.org>
parents:
69842
diff
changeset
|
46 * Fortran:: Fortran mode and its special features. |
284d18cd0af7
(Program Modes): Replace inforef to emacs-xtra by conditional xref's, depending
Eli Zaretskii <eliz@gnu.org>
parents:
69842
diff
changeset
|
47 @end ifnottex |
25829 | 48 @end menu |
49 | |
50 @node Program Modes | |
51 @section Major Modes for Programming Languages | |
52 @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
|
53 |
278f2295cde6
New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents:
38123
diff
changeset
|
54 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
|
55 @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
|
56 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
|
57 indentation, how to do syntax highlighting for the language, and how |
38867 | 58 to find the beginning of a function definition. It often customizes |
59 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
|
60 |
278f2295cde6
New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents:
38123
diff
changeset
|
61 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
|
62 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
|
63 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
|
64 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
|
65 The major mode for language @var{l} is called @code{@var{l}-mode}, |
38867 | 66 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
|
67 @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
|
68 |
25829 | 69 @cindex Perl mode |
70 @cindex Icon mode | |
71 @cindex Makefile mode | |
72 @cindex Tcl mode | |
73 @cindex CPerl mode | |
26106 | 74 @cindex DSSSL mode |
75 @cindex Octave mode | |
76 @cindex Metafont mode | |
77 @cindex Modula2 mode | |
78 @cindex Prolog mode | |
60112
7cb4576800fa
(Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents:
59798
diff
changeset
|
79 @cindex Python mode |
26106 | 80 @cindex Simula mode |
81 @cindex VHDL mode | |
82 @cindex M4 mode | |
83 @cindex Shell-script mode | |
30810
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
84 @cindex Delphi mode |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
85 @cindex PostScript mode |
61053
bfca4745d9a3
(Program Modes): Add Conf mode and DNS mode.
Richard M. Stallman <rms@gnu.org>
parents:
61022
diff
changeset
|
86 @cindex Conf mode |
bfca4745d9a3
(Program Modes): Add Conf mode and DNS mode.
Richard M. Stallman <rms@gnu.org>
parents:
61022
diff
changeset
|
87 @cindex DNS mode |
38136
278f2295cde6
New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents:
38123
diff
changeset
|
88 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
|
89 variant of Lisp) and the Scheme-based DSSSL expression language, Ada, |
59371
364d233a8dc3
Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents:
56809
diff
changeset
|
90 ASM, AWK, C, C++, Delphi (Object Pascal), Fortran (free format and fixed |
38136
278f2295cde6
New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents:
38123
diff
changeset
|
91 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
|
92 companion for font creation), Modula2, Objective-C, Octave, Pascal, |
61053
bfca4745d9a3
(Program Modes): Add Conf mode and DNS mode.
Richard M. Stallman <rms@gnu.org>
parents:
61022
diff
changeset
|
93 Perl, Pike, PostScript, Prolog, Python, Simula, Tcl, and VHDL. An |
bfca4745d9a3
(Program Modes): Add Conf mode and DNS mode.
Richard M. Stallman <rms@gnu.org>
parents:
61022
diff
changeset
|
94 alternative mode for Perl is called CPerl mode. Modes are available for |
bfca4745d9a3
(Program Modes): Add Conf mode and DNS mode.
Richard M. Stallman <rms@gnu.org>
parents:
61022
diff
changeset
|
95 the scripting languages of the common GNU and Unix shells, VMS DCL, and |
38136
278f2295cde6
New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents:
38123
diff
changeset
|
96 MS-DOS/MS-Windows @samp{BAT} files. There are also major modes for |
61053
bfca4745d9a3
(Program Modes): Add Conf mode and DNS mode.
Richard M. Stallman <rms@gnu.org>
parents:
61022
diff
changeset
|
97 editing makefiles, DNS master files, and various sorts of configuration |
bfca4745d9a3
(Program Modes): Add Conf mode and DNS mode.
Richard M. Stallman <rms@gnu.org>
parents:
61022
diff
changeset
|
98 files. |
25829 | 99 |
100 @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
|
101 @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
|
102 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
|
103 line to illustrate the structure of the program. So the major modes |
38867 | 104 for programming languages arrange for @key{TAB} to update the |
105 indentation of the current line. They also rebind @key{DEL} to treat | |
106 a tab as if it were the equivalent number of spaces; this lets you | |
107 delete one column of indentation without worrying whether the | |
108 whitespace consists of spaces or tabs. Use @kbd{C-b C-d} to delete a | |
109 tab character before point, in these modes. | |
25829 | 110 |
38136
278f2295cde6
New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents:
38123
diff
changeset
|
111 Separate manuals are available for the modes for Ada (@pxref{Top, , Ada |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
112 Mode, ada-mode, Ada Mode}), C/C++/Objective C/Java/Corba IDL/Pike/AWK |
38136
278f2295cde6
New node Program Misc; text about word and paragraph and selective
Richard M. Stallman <rms@gnu.org>
parents:
38123
diff
changeset
|
113 (@pxref{Top, , CC Mode, ccmode, CC Mode}) and the IDLWAVE modes |
69506
91970b147f39
* emacs-xtra.texi (Emerge, Picture Mode. Fortran): New chapters,
Chong Yidong <cyd@stupidchicken.com>
parents:
68818
diff
changeset
|
114 (@pxref{Top, , IDLWAVE, idlwave, IDLWAVE User Manual}). For Fortran |
70442
284d18cd0af7
(Program Modes): Replace inforef to emacs-xtra by conditional xref's, depending
Eli Zaretskii <eliz@gnu.org>
parents:
69842
diff
changeset
|
115 mode, see |
284d18cd0af7
(Program Modes): Replace inforef to emacs-xtra by conditional xref's, depending
Eli Zaretskii <eliz@gnu.org>
parents:
69842
diff
changeset
|
116 @iftex |
70472
8566e3f340ec
msdog.texi (Microsoft Windows):
Eli Zaretskii <eliz@gnu.org>
parents:
70442
diff
changeset
|
117 @ref{Fortran,,, emacs-xtra, Specialized Emacs Features}. |
70442
284d18cd0af7
(Program Modes): Replace inforef to emacs-xtra by conditional xref's, depending
Eli Zaretskii <eliz@gnu.org>
parents:
69842
diff
changeset
|
118 @end iftex |
284d18cd0af7
(Program Modes): Replace inforef to emacs-xtra by conditional xref's, depending
Eli Zaretskii <eliz@gnu.org>
parents:
69842
diff
changeset
|
119 @ifnottex |
284d18cd0af7
(Program Modes): Replace inforef to emacs-xtra by conditional xref's, depending
Eli Zaretskii <eliz@gnu.org>
parents:
69842
diff
changeset
|
120 @ref{Fortran}. |
284d18cd0af7
(Program Modes): Replace inforef to emacs-xtra by conditional xref's, depending
Eli Zaretskii <eliz@gnu.org>
parents:
69842
diff
changeset
|
121 @end ifnottex |
284d18cd0af7
(Program Modes): Replace inforef to emacs-xtra by conditional xref's, depending
Eli Zaretskii <eliz@gnu.org>
parents:
69842
diff
changeset
|
122 |
38122
4aeb215906f3
Proofreading fixes from Peter Milliken <Peter.Milliken@GTECH.COM>.
Eli Zaretskii <eliz@gnu.org>
parents:
38090
diff
changeset
|
123 |
25829 | 124 @cindex mode hook |
125 @vindex c-mode-hook | |
126 @vindex lisp-mode-hook | |
127 @vindex emacs-lisp-mode-hook | |
128 @vindex lisp-interaction-mode-hook | |
129 @vindex scheme-mode-hook | |
38231
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
130 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
|
131 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
|
132 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
|
133 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
|
134 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
|
135 @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
|
136 place to set up customizations for that major mode. @xref{Hooks}. |
25829 | 137 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
138 @node Defuns |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
139 @section Top-Level Definitions, or Defuns |
25829 | 140 |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
141 In Emacs, a major definition at the top level in the buffer, |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
142 something like a function, is called a @dfn{defun}. The name comes |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
143 from Lisp, but in Emacs we use it for all languages. |
25829 | 144 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
145 @menu |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
146 * 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
|
147 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
|
148 * 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
|
149 * 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
|
150 * 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
|
151 @end menu |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
152 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
153 @node Left Margin Paren |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
154 @subsection Left Margin Convention |
25829 | 155 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
156 @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
|
157 @cindex ( in leftmost column |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
158 Emacs assumes by default that any opening delimiter found at the |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
159 left margin is the start of a top-level definition, or defun. You can |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
160 override this default by setting this user option: |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
161 |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
162 @defvar open-paren-in-column-0-is-defun-start |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
163 If this user option is set to @code{t} (the default), opening |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
164 parentheses or braces at column zero always start defuns. When it's |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
165 @code{nil}, defuns are found by searching for parens or braces at the |
67683
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
166 outermost level. Some major modes, including C and related modes, set |
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
167 @code{open-paren-in-column-0-is-defun-start} buffer-locally to |
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
168 @code{nil} |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
169 @end defvar |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
170 |
67683
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
171 In modes where @code{open-paren-in-column-0-is-defun-start} is |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
172 @code{t}, @strong{don't put an opening delimiter at the left margin |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
173 unless it is a defun start}. For instance, never put an |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
174 open-parenthesis at the left margin in a Lisp file unless it is the |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
175 start of a top-level list. |
25829 | 176 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
177 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
|
178 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
|
179 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
|
180 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
|
181 mode (@pxref{Font Lock}). |
25829 | 182 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
183 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
|
184 at the start of a line inside a string. To avoid trouble, put an |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
185 escape character (@samp{\}, in Emacs Lisp, @samp{/} in some other Lisp |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
186 dialects) before the opening delimiter. This will not affect the |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
187 contents of the string, but will prevent that opening delimiter from |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
188 starting a defun. Here's an example: |
25829 | 189 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
190 @example |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
191 (insert "Foo: |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
192 \(bar) |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
193 ") |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
194 @end example |
25829 | 195 |
46035
11e7a6a33a8c
Explain font lock highlighting of opening delims that should be quoted.
Richard M. Stallman <rms@gnu.org>
parents:
45997
diff
changeset
|
196 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
|
197 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
|
198 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
|
199 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
200 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
|
201 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
|
202 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
|
203 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
|
204 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
|
205 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
|
206 always right, and avoids the need to scan back to the beginning of the |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
207 buffer. However, now that modern computers are so powerful, this |
67683
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
208 scanning is rarely slow enough to annoy, so we've provided a way to |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
209 disable the heuristic. |
25829 | 210 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
211 @node Moving by Defuns |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
212 @subsection Moving by Defuns |
25829 | 213 @cindex defuns |
214 | |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
215 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
|
216 major definitions, also called @dfn{defuns}. |
38123
af8117970ca7
More proofreading fixes from Peter Milliken.
Eli Zaretskii <eliz@gnu.org>
parents:
38122
diff
changeset
|
217 |
25829 | 218 @table @kbd |
219 @item C-M-a | |
220 Move to beginning of current or preceding defun | |
221 (@code{beginning-of-defun}). | |
222 @item C-M-e | |
223 Move to end of current or following defun (@code{end-of-defun}). | |
224 @item C-M-h | |
225 Put region around whole current or following defun (@code{mark-defun}). | |
226 @end table | |
227 | |
38164
ec15967a5cf7
Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents:
38149
diff
changeset
|
228 @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
|
229 @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
|
230 @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
|
231 @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
|
232 @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
|
233 @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
|
234 @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
|
235 @findex mark-defun |
ec15967a5cf7
Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents:
38149
diff
changeset
|
236 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
|
237 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
|
238 (@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
|
239 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
|
240 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
|
241 |
ec15967a5cf7
Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents:
38149
diff
changeset
|
242 @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
|
243 @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
|
244 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
|
245 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
|
246 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
|
247 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
|
248 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
|
249 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
|
250 |
36263
11db0318031d
Remove redundant index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36198
diff
changeset
|
251 @kindex C-M-h @r{(C mode)} |
25829 | 252 @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
|
253 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
|
254 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
|
255 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
|
256 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
|
257 command while point is between defuns, it uses the following defun. |
60112
7cb4576800fa
(Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents:
59798
diff
changeset
|
258 Successive uses of @kbd{C-M-h}, or using it in Transient Mark mode |
68697 | 259 when the mark is active, extends the end of the region to include one |
260 more defun each time. | |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
261 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
262 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
|
263 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
|
264 it backs up over the argument declarations, function name and returned |
38867 | 265 data type so that the entire C function is inside the region. This is |
266 an example of how major modes adjust the standard key bindings so that | |
267 they do their standard jobs in a way better fitting a particular | |
268 language. Other major modes may replace any or all of these key | |
269 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
|
270 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
271 @node Imenu |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
272 @subsection Imenu |
38867 | 273 @cindex index of buffer definitions |
274 @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
|
275 @cindex tags |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
276 |
42675 | 277 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
|
278 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
|
279 where it treats each chapter, section, etc., as a definition. |
38867 | 280 (@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
|
281 together.) |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
282 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
283 @findex imenu |
38238
6d50c21307ed
Minor clarifications. Explain how to use imenu-sort-function.
Richard M. Stallman <rms@gnu.org>
parents:
38231
diff
changeset
|
284 If you type @kbd{M-x imenu}, it reads the name of a definition using |
38867 | 285 the minibuffer, then moves point to that definition. You can use |
286 completion to specify the name; the command always displays the whole | |
287 list of valid names. | |
25829 | 288 |
38238
6d50c21307ed
Minor clarifications. Explain how to use imenu-sort-function.
Richard M. Stallman <rms@gnu.org>
parents:
38231
diff
changeset
|
289 @findex imenu-add-menubar-index |
38231
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
290 Alternatively, you can bind the command @code{imenu} to a mouse |
38867 | 291 click. Then it displays mouse menus for you to select a definition |
292 name. You can also add the buffer's index to the menu bar by calling | |
293 @code{imenu-add-menubar-index}. If you want to have this menu bar | |
294 item available for all buffers in a certain major mode, you can do | |
295 this by adding @code{imenu-add-menubar-index} to its mode hook. But | |
68697 | 296 if you have done that, you will have to wait a little while each time |
297 you visit a file in that mode, while Emacs finds all the definitions | |
298 in that buffer. | |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
299 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
300 @vindex imenu-auto-rescan |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
301 When you change the contents of a buffer, if you add or delete |
38867 | 302 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
|
303 new contents by invoking the @samp{*Rescan*} item in the menu. |
39063 | 304 Rescanning happens automatically if you set @code{imenu-auto-rescan} to |
305 a non-@code{nil} value. There is no need to rescan because of small | |
38867 | 306 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
|
307 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
308 @vindex imenu-sort-function |
38231
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
309 You can customize the way the menus are sorted by setting the |
38867 | 310 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
|
311 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
|
312 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
|
313 define your own comparison function by writing Lisp code. |
25829 | 314 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
315 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
|
316 @ifnottex |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
317 (@pxref{Which Function}). |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
318 @end ifnottex |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
319 @iftex |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
320 (see below). |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
321 @end iftex |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
322 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
|
323 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
324 @node Which Function |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
325 @subsection Which Function Mode |
40175
ba769a5fb855
(Which Function): Add a cindex entry.
Eli Zaretskii <eliz@gnu.org>
parents:
39063
diff
changeset
|
326 @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
|
327 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
328 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
|
329 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
|
330 buffer. |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
331 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
332 @findex which-function-mode |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
333 @vindex which-func-modes |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
334 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
|
335 which-function-mode}. This command is global; it applies to all |
59371
364d233a8dc3
Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents:
56809
diff
changeset
|
336 buffers, both existing ones and those yet to be created. However, it |
59475
279e43932b6f
(Multi-line Indent): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
59461
diff
changeset
|
337 takes effect only in certain major modes, those listed in the value of |
59371
364d233a8dc3
Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents:
56809
diff
changeset
|
338 @code{which-func-modes}. If the value is @code{t}, then Which Function |
364d233a8dc3
Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents:
56809
diff
changeset
|
339 mode applies to all major modes that know how to support it---in other |
364d233a8dc3
Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents:
56809
diff
changeset
|
340 words, all the major modes that support Imenu. |
25829 | 341 |
342 @node Program Indent | |
343 @section Indentation for Programs | |
344 @cindex indentation for programs | |
345 | |
346 The best way to keep a program properly indented is to use Emacs to | |
347 reindent it as you change it. Emacs has commands to indent properly | |
348 either a single line, a specified number of lines, or all of the lines | |
349 inside a single parenthetical grouping. | |
350 | |
351 @menu | |
352 * Basic Indent:: Indenting a single line. | |
353 * Multi-line Indent:: Commands to reindent many lines at once. | |
354 * Lisp Indent:: Specifying how each Lisp function should be indented. | |
355 * C Indent:: Extra features for indenting C and related modes. | |
356 * Custom C Indent:: Controlling indentation style for C and related modes. | |
357 @end menu | |
358 | |
38231
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
359 @cindex pretty-printer |
25829 | 360 Emacs also provides a Lisp pretty-printer in the library @code{pp}. |
361 This program reformats a Lisp object with indentation chosen to look nice. | |
362 | |
363 @node Basic Indent | |
364 @subsection Basic Program Indentation Commands | |
365 | |
38231
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
366 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
|
367 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
|
368 |
25829 | 369 @table @kbd |
370 @item @key{TAB} | |
371 Adjust indentation of current line. | |
372 @item C-j | |
69833
3bdd218d87df
(Basic Indent): Clarify relationship of C-j to TAB.
Richard M. Stallman <rms@gnu.org>
parents:
69506
diff
changeset
|
373 Insert a newline, then adjust indentation of following line |
3bdd218d87df
(Basic Indent): Clarify relationship of C-j to TAB.
Richard M. Stallman <rms@gnu.org>
parents:
69506
diff
changeset
|
374 (@code{newline-and-indent}). |
25829 | 375 @end table |
376 | |
377 @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
|
378 @findex c-indent-command |
c41356c953a0
Correct names of some C mode indentation commands.
Richard M. Stallman <rms@gnu.org>
parents:
37868
diff
changeset
|
379 @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
|
380 @findex indent-for-tab-command |
25829 | 381 The basic indentation command is @key{TAB}, which gives the current line |
382 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
|
383 function that @key{TAB} runs depends on the major mode; it is |
59461
26a204697252
Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents:
59371
diff
changeset
|
384 @code{lisp-indent-line} |
37978
c41356c953a0
Correct names of some C mode indentation commands.
Richard M. Stallman <rms@gnu.org>
parents:
37868
diff
changeset
|
385 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
|
386 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
|
387 conceptually the same job: @key{TAB} in any programming-language major mode |
25829 | 388 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
|
389 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
|
390 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
|
391 that whitespace; otherwise, @key{TAB} keeps point fixed with respect to |
25829 | 392 the characters around it. |
393 | |
60112
7cb4576800fa
(Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents:
59798
diff
changeset
|
394 Use @kbd{C-q @key{TAB}} to insert a tab character at point. |
25829 | 395 |
396 @kindex C-j | |
397 @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
|
398 When entering lines of new code, use @kbd{C-j} |
69833
3bdd218d87df
(Basic Indent): Clarify relationship of C-j to TAB.
Richard M. Stallman <rms@gnu.org>
parents:
69506
diff
changeset
|
399 (@code{newline-and-indent}), which inserts a newline and then adjusts |
69842
121db3a5c7ba
(Basic Indent): C-j deletes trailing whitespace before the newline.
Richard M. Stallman <rms@gnu.org>
parents:
69840
diff
changeset
|
400 indentation after it. (It also deletes any trailing whitespace which |
121db3a5c7ba
(Basic Indent): C-j deletes trailing whitespace before the newline.
Richard M. Stallman <rms@gnu.org>
parents:
69840
diff
changeset
|
401 remains before the new newline.) Thus, @kbd{C-j} at the end of a line |
121db3a5c7ba
(Basic Indent): C-j deletes trailing whitespace before the newline.
Richard M. Stallman <rms@gnu.org>
parents:
69840
diff
changeset
|
402 creates a blank line with appropriate indentation. In programming |
121db3a5c7ba
(Basic Indent): C-j deletes trailing whitespace before the newline.
Richard M. Stallman <rms@gnu.org>
parents:
69840
diff
changeset
|
403 language modes, it is equivalent to @key{RET} @key{TAB}. |
25829 | 404 |
60112
7cb4576800fa
(Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents:
59798
diff
changeset
|
405 @key{TAB} indents a line that starts within a parenthetical grouping |
7cb4576800fa
(Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents:
59798
diff
changeset
|
406 under the preceding line within the grouping, or the text after the |
7cb4576800fa
(Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents:
59798
diff
changeset
|
407 parenthesis. Therefore, if you manually give one of these lines a |
7cb4576800fa
(Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents:
59798
diff
changeset
|
408 nonstandard indentation, the lines below will tend to follow it. This |
7cb4576800fa
(Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents:
59798
diff
changeset
|
409 behavior is convenient in cases where you have overridden the standard |
7cb4576800fa
(Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents:
59798
diff
changeset
|
410 result of @key{TAB} because you find it unaesthetic for a particular |
7cb4576800fa
(Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents:
59798
diff
changeset
|
411 line. |
25829 | 412 |
68697 | 413 In some modes, an open-parenthesis, open-brace or other opening |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
414 delimiter at the left margin is assumed by Emacs (including the |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
415 indentation routines) to be the start of a function. This speeds up |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
416 indentation commands. If you will be editing text which contains |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
417 opening delimiters in column zero that aren't the beginning of a |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
418 functions, even inside strings or comments, you must set |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
419 @code{open-paren-in-column-0-is-defun-start}. @xref{Left Margin |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
420 Paren}, for more information on this. |
25829 | 421 |
38009
b6036155d1ca
(Basic Indent): Add a cross-reference to description of indent-tabs-mode.
Eli Zaretskii <eliz@gnu.org>
parents:
37997
diff
changeset
|
422 Normally, lines are indented with tabs and spaces. If you want Emacs |
68717
e9bbbd27de3f
(Basic Indent): Fix typo.
Luc Teirlinck <teirllm@auburn.edu>
parents:
68697
diff
changeset
|
423 to use spaces only, set @code{indent-tabs-mode} (@pxref{Just Spaces}). |
38009
b6036155d1ca
(Basic Indent): Add a cross-reference to description of indent-tabs-mode.
Eli Zaretskii <eliz@gnu.org>
parents:
37997
diff
changeset
|
424 |
25829 | 425 @node Multi-line Indent |
426 @subsection Indenting Several Lines | |
427 | |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
428 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
|
429 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
|
430 you have several commands available. |
25829 | 431 |
432 @table @kbd | |
433 @item C-M-q | |
59475
279e43932b6f
(Multi-line Indent): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
59461
diff
changeset
|
434 Reindent all the lines within one parenthetical grouping (@code{indent-pp-sexp}). |
38867 | 435 @item C-M-\ |
436 Reindent all lines in the region (@code{indent-region}). | |
25829 | 437 @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
|
438 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
|
439 first line is properly indented. |
38149
a07facd0bdf8
(Multi-line Indent): Document indent-code-rigidly.
Eli Zaretskii <eliz@gnu.org>
parents:
38148
diff
changeset
|
440 @item M-x indent-code-rigidly |
a07facd0bdf8
(Multi-line Indent): Document indent-code-rigidly.
Eli Zaretskii <eliz@gnu.org>
parents:
38148
diff
changeset
|
441 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
|
442 lines that start inside comments and strings. |
25829 | 443 @end table |
444 | |
445 @kindex C-M-q | |
59475
279e43932b6f
(Multi-line Indent): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
59461
diff
changeset
|
446 @findex indent-pp-sexp |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
447 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
|
448 positioning point before the beginning of it and typing @kbd{C-M-q} |
59461
26a204697252
Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents:
59371
diff
changeset
|
449 (@code{indent-pp-sexp} in Lisp mode, @code{c-indent-exp} in C mode; also |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
450 bound to other suitable commands in other modes). The indentation of |
59475
279e43932b6f
(Multi-line Indent): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
59461
diff
changeset
|
451 the line where the grouping starts is not changed; therefore this |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
452 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
|
453 overall indentation. To correct that as well, type @key{TAB} first. |
25829 | 454 |
38867 | 455 Another way to specify the range to be reindented is with the |
456 region. The command @kbd{C-M-\} (@code{indent-region}) applies | |
457 @key{TAB} to every line whose first character is between point and | |
458 mark. | |
459 | |
25829 | 460 @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
|
461 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
|
462 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
|
463 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
|
464 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
|
465 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
|
466 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
|
467 line. It is clever, though, and does not alter lines that start |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
468 inside strings. Neither does it alter C preprocessor lines when in C |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
469 mode, but it does reindent any continuation lines that may be attached |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
470 to them. |
25829 | 471 |
38149
a07facd0bdf8
(Multi-line Indent): Document indent-code-rigidly.
Eli Zaretskii <eliz@gnu.org>
parents:
38148
diff
changeset
|
472 @findex indent-code-rigidly |
38867 | 473 You can also perform this operation on the region, using the command |
474 @kbd{M-x indent-code-rigidly}. It rigidly shifts all the lines in the | |
475 region sideways, like @code{indent-rigidly} does (@pxref{Indentation | |
476 Commands}). It doesn't alter the indentation of lines that start | |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
477 inside a string, unless the region also starts inside that string. |
59461
26a204697252
Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents:
59371
diff
changeset
|
478 The prefix arg specifies the number of columns to indent. |
25829 | 479 |
480 @node Lisp Indent | |
481 @subsection Customizing Lisp Indentation | |
482 @cindex customizing Lisp indentation | |
483 | |
484 The indentation pattern for a Lisp expression can depend on the function | |
485 called by the expression. For each Lisp function, you can choose among | |
486 several predefined patterns of indentation, or define an arbitrary one with | |
487 a Lisp program. | |
488 | |
489 The standard pattern of indentation is as follows: the second line of the | |
490 expression is indented under the first argument, if that is on the same | |
491 line as the beginning of the expression; otherwise, the second line is | |
492 indented underneath the function name. Each following line is indented | |
493 under the previous line whose nesting depth is the same. | |
494 | |
495 @vindex lisp-indent-offset | |
496 If the variable @code{lisp-indent-offset} is non-@code{nil}, it overrides | |
497 the usual indentation pattern for the second line of an expression, so that | |
498 such lines are always indented @code{lisp-indent-offset} more columns than | |
499 the containing list. | |
500 | |
501 @vindex lisp-body-indent | |
38231
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
502 Certain functions override the standard pattern. Functions whose |
42675 | 503 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
|
504 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
|
505 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
|
506 expression. |
25829 | 507 |
41409
9cea749ef5c3
(Lisp Indent): Add index entry for lisp-indent-function.
Eli Zaretskii <eliz@gnu.org>
parents:
40175
diff
changeset
|
508 @cindex @code{lisp-indent-function} property |
38231
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
509 You can override the standard pattern in various ways for individual |
52153
6b84fb503a42
(Lisp Indent): Don't describe lisp-indent-function property here.
Richard M. Stallman <rms@gnu.org>
parents:
51451
diff
changeset
|
510 functions, according to the @code{lisp-indent-function} property of |
6b84fb503a42
(Lisp Indent): Don't describe lisp-indent-function property here.
Richard M. Stallman <rms@gnu.org>
parents:
51451
diff
changeset
|
511 the function name. Normally you would use this for macro definitions |
6b84fb503a42
(Lisp Indent): Don't describe lisp-indent-function property here.
Richard M. Stallman <rms@gnu.org>
parents:
51451
diff
changeset
|
512 and specify it using the @code{declare} construct (@pxref{Defining |
6b84fb503a42
(Lisp Indent): Don't describe lisp-indent-function property here.
Richard M. Stallman <rms@gnu.org>
parents:
51451
diff
changeset
|
513 Macros,,, elisp, the Emacs Lisp Reference Manual}). |
25829 | 514 |
515 @node C Indent | |
516 @subsection Commands for C Indentation | |
517 | |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
518 Here are special features for indentation in C mode and related modes: |
25829 | 519 |
520 @table @code | |
521 @item C-c C-q | |
522 @kindex C-c C-q @r{(C mode)} | |
523 @findex c-indent-defun | |
524 Reindent the current top-level function definition or aggregate type | |
525 declaration (@code{c-indent-defun}). | |
526 | |
527 @item C-M-q | |
528 @kindex C-M-q @r{(C mode)} | |
529 @findex c-indent-exp | |
530 Reindent each line in the balanced expression that follows point | |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
531 (@code{c-indent-exp}). A prefix argument inhibits warning messages |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
532 about invalid syntax. |
25829 | 533 |
534 @item @key{TAB} | |
535 @findex c-indent-command | |
536 Reindent the current line, and/or in some cases insert a tab character | |
537 (@code{c-indent-command}). | |
538 | |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
539 @vindex c-tab-always-indent |
25829 | 540 If @code{c-tab-always-indent} is @code{t}, this command always reindents |
541 the current line and does nothing else. This is the default. | |
542 | |
543 If that variable is @code{nil}, this command reindents the current line | |
544 only if point is at the left margin or in the line's indentation; | |
545 otherwise, it inserts a tab (or the equivalent number of spaces, | |
546 if @code{indent-tabs-mode} is @code{nil}). | |
547 | |
548 Any other value (not @code{nil} or @code{t}) means always reindent the | |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
549 line, and also insert a tab if within a comment or a string. |
25829 | 550 @end table |
551 | |
552 To reindent the whole current buffer, type @kbd{C-x h C-M-\}. This | |
553 first selects the whole buffer as the region, then reindents that | |
554 region. | |
555 | |
556 To reindent the current block, use @kbd{C-M-u C-M-q}. This moves | |
557 to the front of the block and then reindents it all. | |
558 | |
559 @node Custom C Indent | |
560 @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
|
561 @cindex style (for indentation) |
25829 | 562 |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
563 C mode and related modes use a flexible mechanism for customizing |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
564 indentation. C mode indents a source line in two steps: first it |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
565 classifies the line syntactically according to its contents and |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
566 context; second, it determines the indentation offset associated by |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
567 your selected @dfn{style} with the syntactic construct and adds this |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
568 onto the indentation of the @dfn{anchor statement}. |
25829 | 569 |
570 @table @kbd | |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
571 @item C-c . @key{RET} @var{style} @key{RET} |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
572 Select a predefined style @var{style} (@code{c-set-style}). |
25829 | 573 @end table |
574 | |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
575 A @dfn{style} is a named collection of customizations that can be |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
576 used in C mode and the related modes. @ref{Styles,,, ccmode, The CC |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
577 Mode Manual}, for a complete description. Emacs comes with several |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
578 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
|
579 @code{stroustrup}, @code{linux}, @code{python}, @code{java}, |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
580 @code{whitesmith}, @code{ellemtel}, and @code{awk}. Some of these |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
581 styles are primarily intended for one language, but any of them can be |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
582 used with any of the languages supported by these modes. To find out |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
583 what a style looks like, select it and reindent some code, e.g., by |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
584 typing @key{C-M-q} at the start of a function definition. |
25829 | 585 |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
586 @kindex C-c . @r{(C mode)} |
25829 | 587 @findex c-set-style |
68697 | 588 To choose a style for the current buffer, use the command @w{@kbd{C-c |
589 .}}. Specify a style name as an argument (case is not significant). | |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
590 This command affects the current buffer only, and it affects only |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
591 future invocations of the indentation commands; it does not reindent |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
592 the code already in the buffer. To reindent the whole buffer in the |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
593 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
|
594 |
071d97105015
Proofreading fixes from Peter Milliken.
Eli Zaretskii <eliz@gnu.org>
parents:
38136
diff
changeset
|
595 @vindex c-default-style |
071d97105015
Proofreading fixes from Peter Milliken.
Eli Zaretskii <eliz@gnu.org>
parents:
38136
diff
changeset
|
596 You can also set the variable @code{c-default-style} to specify the |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
597 default style for various major modes. Its value should be either the |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
598 style's name (a string) or an alist, in which each element specifies |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
599 one major mode and which indentation style to use for it. For |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
600 example, |
25829 | 601 |
602 @example | |
603 (setq c-default-style | |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
604 '((java-mode . "java") (awk-mode . "awk") (other . "gnu"))) |
25829 | 605 @end example |
606 | |
607 @noindent | |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
608 specifies explicit choices for Java and AWK modes, and the default |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
609 @samp{gnu} style for the other C-like modes. (These settings are |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
610 actually the defaults.) This variable takes effect when you select |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
611 one of the C-like major modes; thus, if you specify a new default |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
612 style for Java mode, you can make it take effect in an existing Java |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
613 mode buffer by typing @kbd{M-x java-mode} there. |
38164
ec15967a5cf7
Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents:
38149
diff
changeset
|
614 |
ec15967a5cf7
Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents:
38149
diff
changeset
|
615 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
|
616 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
|
617 recommended style. |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
618 |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
619 @xref{Indentation Engine Basics,,, ccmode, the CC Mode Manual}, and |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
620 @ref{Customizing Indentation,,, ccmode, the CC Mode Manual}, for more |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
621 information on customizing indentation for C and related modes, |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
622 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
|
623 your own styles. |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
624 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
625 @node Parentheses |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
626 @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
|
627 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
628 @findex check-parens |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
629 @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
|
630 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
|
631 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
|
632 balanced. |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
633 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
634 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
|
635 includes braces, brackets, or whatever delimiters are defined to match |
38867 | 636 in pairs. The major mode controls which delimiters are significant, |
637 through the syntax table (@pxref{Syntax}). In Lisp, only parentheses | |
638 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
|
639 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
640 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
|
641 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
|
642 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
643 @menu |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
644 * 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
|
645 * 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
|
646 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
|
647 * 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
|
648 @end menu |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
649 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
650 @node Expressions |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
651 @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
|
652 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
653 @cindex sexp |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
654 @cindex expression |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
655 @cindex balanced expression |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
656 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
|
657 @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
|
658 expression in Lisp.}. |
28627
1f6ba3e73fe9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
28391
diff
changeset
|
659 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
660 @table @kbd |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
661 @item C-M-f |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
662 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
|
663 @item C-M-b |
59371
364d233a8dc3
Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents:
56809
diff
changeset
|
664 Move backward over a balanced expression (@code{backward-sexp}). |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
665 @item C-M-k |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
666 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
|
667 @item C-M-t |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
668 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
|
669 @item C-M-@@ |
54272
3fd0ea9feede
(Expressions): Doc C-M-SPC as alias for C-M-@.
Richard M. Stallman <rms@gnu.org>
parents:
53386
diff
changeset
|
670 @itemx C-M-@key{SPC} |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
671 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
|
672 @end table |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
673 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
674 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
|
675 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
|
676 typically include symbols, numbers, and string constants, as well as |
38867 | 677 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
|
678 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
|
679 implement in Emacs. |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
680 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
681 @cindex Control-Meta |
38867 | 682 By convention, the keys for these commands are all Control-Meta |
683 characters. They usually act on expressions just as the corresponding | |
684 Meta characters act on words. For instance, the command @kbd{C-M-b} | |
685 moves backward over a balanced expression, just as @kbd{M-b} moves | |
686 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
|
687 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
688 @kindex C-M-f |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
689 @kindex C-M-b |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
690 @findex forward-sexp |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
691 @findex backward-sexp |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
692 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
|
693 (@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
|
694 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
|
695 @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
|
696 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
|
697 @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
|
698 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
699 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
|
700 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
|
701 @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
|
702 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
|
703 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
|
704 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
|
705 in most modes. |
25829 | 706 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
707 @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
|
708 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
|
709 opposite direction. |
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 @cindex killing expressions |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
712 @kindex C-M-k |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
713 @findex kill-sexp |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
714 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
|
715 (@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
|
716 would move over. |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
717 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
718 @cindex transposition of expressions |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
719 @kindex C-M-t |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
720 @findex transpose-sexps |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
721 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
|
722 @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
|
723 balanced expression across the next one. An argument serves as a |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
724 repeat count, moving the previous expression over that many following |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
725 ones. A negative argument drags the previous balanced expression |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
726 backwards across those before it (thus canceling out the effect of |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
727 @kbd{C-M-t} with a positive argument). An argument of zero, rather |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
728 than doing nothing, transposes the balanced expressions ending at or |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
729 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
|
730 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
731 @kindex C-M-@@ |
54272
3fd0ea9feede
(Expressions): Doc C-M-SPC as alias for C-M-@.
Richard M. Stallman <rms@gnu.org>
parents:
53386
diff
changeset
|
732 @kindex C-M-@key{SPC} |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
733 @findex mark-sexp |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
734 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
|
735 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
|
736 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
|
737 @kbd{C-M-f}. In particular, a negative argument is useful for putting |
60112
7cb4576800fa
(Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents:
59798
diff
changeset
|
738 the mark at the beginning of the previous balanced expression. The |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
739 alias @kbd{C-M-@key{SPC}} is equivalent to @kbd{C-M-@@}. When you |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
740 repeat this command, or use it in Transient Mark mode when the mark is |
68697 | 741 active, it extends the end of the region by one sexp each time. |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
742 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
743 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
|
744 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
|
745 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
|
746 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
|
747 @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
|
748 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
|
749 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
|
750 choices for ``the expression following point'' when point is at the |
38867 | 751 @samp{f}, so the expression commands must perforce choose one or the |
752 other to operate on. Note that @samp{(foo + bar)} is recognized as a | |
753 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
|
754 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
755 @node Moving by Parens |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
756 @subsection Moving in the Parenthesis Structure |
25829 | 757 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
758 @cindex parenthetical groupings |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
759 @cindex parentheses, moving across |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
760 @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
|
761 @cindex braces, moving across |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
762 @cindex list commands |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
763 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
|
764 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
|
765 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
|
766 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
|
767 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
|
768 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
|
769 groupings are lists. |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
770 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
771 @table @kbd |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
772 @item C-M-n |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
773 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
|
774 @item C-M-p |
59371
364d233a8dc3
Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents:
56809
diff
changeset
|
775 Move backward over a parenthetical group (@code{backward-list}). |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
776 @item C-M-u |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
777 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
|
778 @item C-M-d |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
779 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
|
780 @end table |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
781 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
782 @kindex C-M-n |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
783 @kindex C-M-p |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
784 @findex forward-list |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
785 @findex backward-list |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
786 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
|
787 @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
|
788 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
|
789 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
|
790 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
791 @kindex C-M-u |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
792 @findex backward-up-list |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
793 @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
|
794 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
|
795 @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
|
796 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
|
797 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
|
798 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
|
799 |
68697 | 800 @kindex C-M-d |
801 @findex down-list | |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
802 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
|
803 (@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
|
804 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
|
805 argument specifies the number of levels to go down. |
25829 | 806 |
807 @node Matching | |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
808 @subsection Automatic Display Of Matching Parentheses |
25829 | 809 @cindex matching parentheses |
810 @cindex parentheses, displaying matches | |
811 | |
812 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
|
813 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
|
814 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
|
815 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
|
816 matching opening delimiter, provided that is on the screen. If it is |
38867 | 817 not on the screen, Emacs displays some of the text near it in the echo |
818 area. Either way, you can tell which grouping you are closing off. | |
25829 | 819 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
820 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
|
821 as in @samp{[x)}---a warning message is displayed in the echo area. |
25829 | 822 |
823 @vindex blink-matching-paren | |
824 @vindex blink-matching-paren-distance | |
825 @vindex blink-matching-delay | |
59461
26a204697252
Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents:
59371
diff
changeset
|
826 Three variables control parenthesis match display: |
26a204697252
Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents:
59371
diff
changeset
|
827 |
26a204697252
Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents:
59371
diff
changeset
|
828 @code{blink-matching-paren} turns the feature on or off: @code{nil} |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
829 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
|
830 |
ec15967a5cf7
Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents:
38149
diff
changeset
|
831 @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
|
832 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
|
833 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
|
834 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
|
835 |
ec15967a5cf7
Add details about C-M-a and C-M-e.
Richard M. Stallman <rms@gnu.org>
parents:
38149
diff
changeset
|
836 @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
|
837 back to search to find the matching opening delimiter. If the match |
38287 | 838 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
|
839 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
|
840 lots of time when there is no match. The default is 25600. |
25829 | 841 |
842 @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
|
843 @cindex highlighting matching parentheses |
25829 | 844 @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
|
845 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
|
846 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
|
847 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
|
848 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
|
849 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
|
850 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
|
851 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
|
852 |
68697 | 853 Show Paren mode uses the faces @code{show-paren-match} and |
854 @code{show-paren-mismatch} to highlight parentheses; you can customize | |
855 them to control how highlighting looks. @xref{Face Customization}. | |
25829 | 856 |
857 @node Comments | |
858 @section Manipulating Comments | |
859 @cindex comments | |
860 | |
861 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
|
862 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
|
863 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
|
864 (@pxref{Spelling}). |
25829 | 865 |
866 @menu | |
69840
d138b536fbe5
(Comments, Comment Commands, Options for Comments, Multi-Line Comments):
Richard M. Stallman <rms@gnu.org>
parents:
69833
diff
changeset
|
867 * Comment Commands:: 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
|
868 * 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
|
869 * Options for Comments::Customizing the comment features. |
25829 | 870 @end menu |
871 | |
872 @node Comment Commands | |
873 @subsection Comment Commands | |
874 @cindex indentation for comments | |
69840
d138b536fbe5
(Comments, Comment Commands, Options for Comments, Multi-Line Comments):
Richard M. Stallman <rms@gnu.org>
parents:
69833
diff
changeset
|
875 @cindex alignment for comments |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
876 |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
877 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
|
878 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
|
879 |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
880 @table @asis |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
881 @item @kbd{M-;} |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
882 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
|
883 uncomment the region (@code{comment-dwim}). |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
884 @item @kbd{C-u M-;} |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
885 Kill comment on current line (@code{comment-kill}). |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
886 @item @kbd{C-x ;} |
38018
f802bdff6c2c
Update various command names and variable defaults.
Richard M. Stallman <rms@gnu.org>
parents:
38009
diff
changeset
|
887 Set comment column (@code{comment-set-column}). |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
888 @item @kbd{C-M-j} |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
889 @itemx @kbd{M-j} |
25829 | 890 Like @key{RET} followed by inserting and aligning a comment |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
891 (@code{comment-indent-new-line}). @xref{Multi-Line Comments}. |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
892 @item @kbd{M-x comment-region} |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
893 @itemx @kbd{C-c C-c} (in C-like modes) |
25829 | 894 Add or remove comment delimiters on all the lines in the region. |
895 @end table | |
896 | |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
897 @kindex M-; |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
898 @findex comment-dwim |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
899 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
|
900 (@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
|
901 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
|
902 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
|
903 you use it. |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
904 |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
905 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
|
906 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
|
907 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
|
908 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
|
909 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
|
910 away. If the major mode has specified a string to terminate comments, |
68697 | 911 @kbd{M-;} inserts that after point, to keep the syntax valid. |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
912 |
68697 | 913 If the text of the line extends past the comment column, this |
69840
d138b536fbe5
(Comments, Comment Commands, Options for Comments, Multi-Line Comments):
Richard M. Stallman <rms@gnu.org>
parents:
69833
diff
changeset
|
914 command aligns the comment start string to a suitable boundary |
68697 | 915 (usually, at least one space is inserted). |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
916 |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
917 You can also use @kbd{M-;} to align an existing comment. If a line |
69840
d138b536fbe5
(Comments, Comment Commands, Options for Comments, Multi-Line Comments):
Richard M. Stallman <rms@gnu.org>
parents:
69833
diff
changeset
|
918 already contains the comment-start string, @kbd{M-;} realigns it to |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
919 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
|
920 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
|
921 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
|
922 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
|
923 |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
924 @findex comment-kill |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
925 @kindex C-u M-; |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
926 @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
|
927 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
|
928 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
|
929 realign it. |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
930 |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
931 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
|
932 (@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
|
933 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
|
934 @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
|
935 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
|
936 |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
937 @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
|
938 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
|
939 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
|
940 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
|
941 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
|
942 mode, then you should use the commands @code{comment-region} and |
68697 | 943 @code{uncomment-region} to do these jobs (@pxref{Multi-Line Comments}), |
944 or else enable Transient Mark mode momentarily (@pxref{Momentary Mark}). | |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
945 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
|
946 comment delimiters to add or how many to delete. |
25829 | 947 |
69840
d138b536fbe5
(Comments, Comment Commands, Options for Comments, Multi-Line Comments):
Richard M. Stallman <rms@gnu.org>
parents:
69833
diff
changeset
|
948 Some major modes have special rules for aligning certain kinds of |
25829 | 949 comments in certain contexts. For example, in Lisp code, comments which |
950 start with two semicolons are indented as if they were lines of code, | |
951 instead of at the comment column. Comments which start with three | |
71668
a745634e8067
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
71612
diff
changeset
|
952 semicolons are supposed to start at the left margin and are often used |
a745634e8067
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
71612
diff
changeset
|
953 for sectioning purposes. Emacs understands |
25829 | 954 these conventions by indenting a double-semicolon comment using @key{TAB}, |
955 and by not changing the indentation of a triple-semicolon comment at all. | |
956 | |
957 @example | |
71612
77266daa9ec9
Use ;; instead of ;;; to better follow coding conventions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
71593
diff
changeset
|
958 ;; This function is just an example. |
71668
a745634e8067
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
71612
diff
changeset
|
959 ;;; Here either two or three semicolons are appropriate. |
25829 | 960 (defun foo (x) |
71612
77266daa9ec9
Use ;; instead of ;;; to better follow coding conventions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
71593
diff
changeset
|
961 ;;; And now, the first part of the function: |
25829 | 962 ;; The following line adds one. |
963 (1+ x)) ; This line adds one. | |
964 @end example | |
965 | |
68697 | 966 For C-like modes, you can configure the exact effect of @kbd{M-;} |
967 more flexibly than for most buffers by setting the variables | |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
968 @code{c-indent-comment-alist} and |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
969 @code{c-indent-comments-syntactically-p}. For example, on a line |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
970 ending in a closing brace, @kbd{M-;} puts the comment one space after |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
971 the brace rather than at @code{comment-column}. For full details see |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
972 @ref{Comment Commands,,, ccmode, The CC Mode Manual}. |
25829 | 973 |
974 @node Multi-Line Comments | |
975 @subsection Multiple Lines of Comments | |
976 | |
977 @kindex C-M-j | |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
978 @kindex M-j |
25829 | 979 @cindex blank lines in programs |
38018
f802bdff6c2c
Update various command names and variable defaults.
Richard M. Stallman <rms@gnu.org>
parents:
38009
diff
changeset
|
980 @findex comment-indent-new-line |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
981 |
25829 | 982 If you are typing a comment and wish to continue it on another line, |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
983 you can use the command @kbd{C-M-j} or @kbd{M-j} |
67683
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
984 (@code{comment-indent-new-line}). If @code{comment-multi-line} |
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
985 (@pxref{Options for Comments}) is non-@code{nil}, it moves to a new |
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
986 line within the comment. Otherwise it closes the comment and starts a |
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
987 new comment on a new line. When Auto Fill mode is on, going past the |
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
988 fill column while typing a comment causes the comment to be continued |
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
989 in just this fashion. |
25829 | 990 |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
991 @kindex C-c C-c (C mode) |
25829 | 992 @findex comment-region |
993 To turn existing lines into comment lines, use the @kbd{M-x | |
68697 | 994 comment-region} command (or type @kbd{C-c C-c} in C-like modes). It |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
995 adds comment delimiters to the lines that start in the region, thus |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
996 commenting them out. With a negative argument, it does the |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
997 opposite---it deletes comment delimiters from the lines in the region. |
25829 | 998 |
999 With a positive argument, @code{comment-region} duplicates the last | |
69840
d138b536fbe5
(Comments, Comment Commands, Options for Comments, Multi-Line Comments):
Richard M. Stallman <rms@gnu.org>
parents:
69833
diff
changeset
|
1000 character of the comment start sequence it adds; the argument |
d138b536fbe5
(Comments, Comment Commands, Options for Comments, Multi-Line Comments):
Richard M. Stallman <rms@gnu.org>
parents:
69833
diff
changeset
|
1001 specifies how many copies of the character to insert. Thus, in Lisp |
d138b536fbe5
(Comments, Comment Commands, Options for Comments, Multi-Line Comments):
Richard M. Stallman <rms@gnu.org>
parents:
69833
diff
changeset
|
1002 mode, @kbd{C-u 2 M-x comment-region} adds @samp{;;} to each line. |
d138b536fbe5
(Comments, Comment Commands, Options for Comments, Multi-Line Comments):
Richard M. Stallman <rms@gnu.org>
parents:
69833
diff
changeset
|
1003 Duplicating the comment delimiter is a way of calling attention to the |
d138b536fbe5
(Comments, Comment Commands, Options for Comments, Multi-Line Comments):
Richard M. Stallman <rms@gnu.org>
parents:
69833
diff
changeset
|
1004 comment. It can also affect how the comment is aligned or indented. |
d138b536fbe5
(Comments, Comment Commands, Options for Comments, Multi-Line Comments):
Richard M. Stallman <rms@gnu.org>
parents:
69833
diff
changeset
|
1005 In Lisp, for proper indentation, you should use an argument of two or |
d138b536fbe5
(Comments, Comment Commands, Options for Comments, Multi-Line Comments):
Richard M. Stallman <rms@gnu.org>
parents:
69833
diff
changeset
|
1006 three, if between defuns; if within a defun, it must be three. |
25829 | 1007 |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1008 You can configure C Mode such that when you type a @samp{/} at the |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1009 start of a line in a multi-line block comment, this closes the |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1010 comment. Enable the @code{comment-close-slash} clean-up for this. |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1011 @xref{Clean-ups,,, ccmode, The CC Mode Manual}. |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1012 |
25829 | 1013 @node Options for Comments |
1014 @subsection Options Controlling Comments | |
1015 | |
1016 @vindex comment-column | |
1017 @kindex C-x ; | |
38018
f802bdff6c2c
Update various command names and variable defaults.
Richard M. Stallman <rms@gnu.org>
parents:
38009
diff
changeset
|
1018 @findex comment-set-column |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1019 The @dfn{comment column}, the column at which Emacs tries to place |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1020 comments, is stored in the variable @code{comment-column}. You can |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1021 set it to a number explicitly. Alternatively, the command @kbd{C-x ;} |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1022 (@code{comment-set-column}) sets the comment column to the column |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1023 point is at. @kbd{C-u C-x ;} sets the comment column to match the |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1024 last comment before point in the buffer, and then does a @kbd{M-;} to |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1025 align the current line's comment under the previous one. |
25829 | 1026 |
1027 The variable @code{comment-column} is per-buffer: setting the variable | |
1028 in the normal fashion affects only the current buffer, but there is a | |
1029 default value which you can change with @code{setq-default}. | |
1030 @xref{Locals}. Many major modes initialize this variable for the | |
1031 current buffer. | |
1032 | |
1033 @vindex comment-start-skip | |
1034 The comment commands recognize comments based on the regular | |
1035 expression that is the value of the variable @code{comment-start-skip}. | |
1036 Make sure this regexp does not match the null string. It may match more | |
1037 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
|
1038 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
|
1039 @c This stops M-q from breaking the line inside that @code. |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1040 @code{@w{"/\\*+ *\\|//+ *"}}, which matches extra stars and spaces |
38018
f802bdff6c2c
Update various command names and variable defaults.
Richard M. Stallman <rms@gnu.org>
parents:
38009
diff
changeset
|
1041 after the @samp{/*} itself, and accepts C++ style comments also. |
25829 | 1042 (Note that @samp{\\} is needed in Lisp syntax to include a @samp{\} in |
1043 the string, which is needed to deny the first star its special meaning | |
64920
e736a91dd7b5
(Options for Comments): Fix xref.
Richard M. Stallman <rms@gnu.org>
parents:
64890
diff
changeset
|
1044 in regexp syntax. @xref{Regexp Backslash}.) |
25829 | 1045 |
1046 @vindex comment-start | |
1047 @vindex comment-end | |
1048 When a comment command makes a new comment, it inserts the value of | |
1049 @code{comment-start} to begin it. The value of @code{comment-end} is | |
67513
375a247b599e
(Options for Comments): Comment-end starts with space.
Richard M. Stallman <rms@gnu.org>
parents:
64920
diff
changeset
|
1050 inserted after point, so that it will follow the text that you will |
375a247b599e
(Options for Comments): Comment-end starts with space.
Richard M. Stallman <rms@gnu.org>
parents:
64920
diff
changeset
|
1051 insert into the comment. When @code{comment-end} is non-empty, it |
375a247b599e
(Options for Comments): Comment-end starts with space.
Richard M. Stallman <rms@gnu.org>
parents:
64920
diff
changeset
|
1052 should start with a space. For example, in C mode, |
375a247b599e
(Options for Comments): Comment-end starts with space.
Richard M. Stallman <rms@gnu.org>
parents:
64920
diff
changeset
|
1053 @code{comment-start} has the value @w{@code{"/* "}} and |
375a247b599e
(Options for Comments): Comment-end starts with space.
Richard M. Stallman <rms@gnu.org>
parents:
64920
diff
changeset
|
1054 @code{comment-end} has the value @w{@code{" */"}}. |
25829 | 1055 |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1056 @vindex comment-padding |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1057 The variable @code{comment-padding} specifies how many spaces |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1058 @code{comment-region} should insert on each line between the comment |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1059 delimiter and the line's original text. The default is 1, to insert |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1060 one space. @code{nil} means 0. Alternatively, @code{comment-padding} |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1061 can hold the actual string to insert. |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1062 |
25829 | 1063 @vindex comment-multi-line |
1064 The variable @code{comment-multi-line} controls how @kbd{C-M-j} | |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1065 (@code{indent-new-comment-line}) behaves when used inside a comment. |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1066 Specifically, when @code{comment-multi-line} is @code{nil}, the |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1067 command inserts a comment terminator, begins a new line, and finally |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1068 inserts a comment starter. Otherwise it does not insert the |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1069 terminator and starter, so it effectively continues the current |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1070 comment across multiple lines. In languages that allow multi-line |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1071 comments, the choice of value for this variable is a matter of taste. |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1072 The default for this variable depends on the major mode. |
25829 | 1073 |
41495 | 1074 @vindex comment-indent-function |
25829 | 1075 The variable @code{comment-indent-function} should contain a function |
69840
d138b536fbe5
(Comments, Comment Commands, Options for Comments, Multi-Line Comments):
Richard M. Stallman <rms@gnu.org>
parents:
69833
diff
changeset
|
1076 that will be called to compute the alignment for a newly inserted |
25829 | 1077 comment or for aligning an existing comment. It is set differently by |
1078 various major modes. The function is called with no arguments, but with | |
1079 point at the beginning of the comment, or at the end of a line if a new | |
1080 comment is to be inserted. It should return the column in which the | |
1081 comment ought to start. For example, in Lisp mode, the indent hook | |
1082 function bases its decision on how many semicolons begin an existing | |
1083 comment, and on the code in the preceding lines. | |
1084 | |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1085 @node Documentation |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1086 @section Documentation Lookup |
25829 | 1087 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1088 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
|
1089 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
|
1090 use in your program. |
25829 | 1091 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1092 @menu |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1093 * 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
|
1094 in Info files. |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1095 * 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
|
1096 * 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
|
1097 @end menu |
25829 | 1098 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1099 @node Info Lookup |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1100 @subsection Info Documentation Lookup |
27221
4a723a7bc25a
Mention outline-minor-mode, check-parens,
Dave Love <fx@gnu.org>
parents:
26462
diff
changeset
|
1101 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1102 @findex info-lookup-symbol |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1103 @findex info-lookup-file |
56164
f5e9166d3954
(Info Lookup): Fix keybinding for
Jesper Harder <harder@ifa.au.dk>
parents:
56086
diff
changeset
|
1104 @kindex C-h S |
68697 | 1105 For many major modes, that apply to languages that have |
1106 documentation in Info, you can use @kbd{C-h S} | |
1107 (@code{info-lookup-symbol}) to view the Info documentation for a | |
1108 symbol used in the program. You specify the symbol with the | |
1109 minibuffer; the default is the symbol appearing in the buffer at | |
1110 point. For example, in C mode this looks for the symbol in the C | |
1111 Library Manual. The command only works if the appropriate manual's | |
1112 Info files are installed. | |
25829 | 1113 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1114 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
|
1115 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
|
1116 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
|
1117 for a file name. |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1118 |
68697 | 1119 If you use @kbd{C-h S} in a major mode that does not support it, |
1120 it asks you to specify the ``symbol help mode''. You should enter | |
1121 a command such as @code{c-mode} that would select a major | |
1122 mode which @kbd{C-h S} does support. | |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1123 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1124 @node Man Page |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1125 @subsection Man Page Lookup |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1126 |
38867 | 1127 @cindex manual page |
1128 On Unix, the main form of on-line documentation was the @dfn{manual | |
68697 | 1129 page} or @dfn{man page}. In the GNU operating system, we aim to |
38867 | 1130 replace man pages with better-organized manuals that you can browse |
1131 with Info (@pxref{Misc Help}). This process is not finished, so it is | |
1132 still useful to read manual pages. | |
25829 | 1133 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1134 @findex manual-entry |
38867 | 1135 You can read the man page for an operating system command, library |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1136 function, or system call, with the @kbd{M-x man} command. It |
38867 | 1137 runs the @code{man} program to format the man page; if the system |
1138 permits, it runs @code{man} asynchronously, so that you can keep on | |
1139 editing while the page is being formatted. (On MS-DOS and MS-Windows | |
1140 3, you cannot edit while Emacs waits for @code{man} to finish.) The | |
1141 result goes in a buffer named @samp{*Man @var{topic}*}. These buffers | |
1142 use a special major mode, Man mode, that facilitates scrolling and | |
1143 jumping to other manual pages. For details, type @kbd{C-h m} while in | |
1144 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
|
1145 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1146 @cindex sections of manual pages |
38867 | 1147 Each man page belongs to one of ten or more @dfn{sections}, each |
1148 named by a digit or by a digit and a letter. Sometimes there are | |
1149 multiple man pages with the same name in different sections. To read | |
1150 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
|
1151 @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
|
1152 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
|
1153 read the man page for the C library function @code{chmod} (as opposed |
38867 | 1154 to a command of the same name), type @kbd{M-x manual-entry @key{RET} |
68697 | 1155 chmod(2) @key{RET}}. (@code{chmod} is a system call, so it is in |
1156 section @samp{2}.) | |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1157 |
38667
6ed2cc05e016
(Man Page): Mention the -a switch to `man' in a footnote.
Eli Zaretskii <eliz@gnu.org>
parents:
38323
diff
changeset
|
1158 @vindex Man-switches |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1159 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
|
1160 @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
|
1161 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
|
1162 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
|
1163 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
|
1164 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
|
1165 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
|
1166 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
|
1167 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
|
1168 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1169 @vindex Man-fontify-manpage-flag |
38867 | 1170 By default, Emacs highlights the text in man pages. For a long man |
1171 page, highlighting can take substantial time. You can turn off | |
1172 highlighting of man pages by setting the variable | |
1173 @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
|
1174 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1175 @findex Man-fontify-manpage |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1176 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
|
1177 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
|
1178 perform the same conversions that @kbd{M-x manual-entry} does. |
25829 | 1179 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1180 @findex woman |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1181 @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
|
1182 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
|
1183 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
|
1184 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
|
1185 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
|
1186 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
|
1187 in Emacs Lisp, so it works on systems such as MS-Windows, where the |
59371
364d233a8dc3
Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents:
56809
diff
changeset
|
1188 @code{man} program (and other programs it uses) are not generally |
38231
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
1189 available. |
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
1190 |
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
1191 @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
|
1192 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
|
1193 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
|
1194 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
|
1195 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
|
1196 name the manual page. |
25829 | 1197 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1198 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
|
1199 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
|
1200 manual pages. |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1201 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1202 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
|
1203 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
|
1204 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
|
1205 them. |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1206 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1207 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
|
1208 @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
|
1209 Manual}. |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1210 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1211 @node Lisp Doc |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1212 @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
|
1213 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1214 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
|
1215 @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
|
1216 (@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
|
1217 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
|
1218 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
|
1219 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
|
1220 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
|
1221 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
|
1222 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
|
1223 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1224 @cindex Eldoc mode |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1225 @findex eldoc-mode |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1226 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
|
1227 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
|
1228 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
|
1229 function call that point is contained in, and displays the argument |
59461
26a204697252
Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents:
59371
diff
changeset
|
1230 list of that function.) If point is over a documented variable, it |
62482
8db373573379
(Lisp Doc): Eldoc mode shows only the first line of a variable's docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61133
diff
changeset
|
1231 shows the first line of the variable's docstring. Eldoc mode applies |
8db373573379
(Lisp Doc): Eldoc mode shows only the first line of a variable's docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61133
diff
changeset
|
1232 in Emacs Lisp and Lisp Interaction modes, and perhaps a few others |
8db373573379
(Lisp Doc): Eldoc mode shows only the first line of a variable's docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61133
diff
changeset
|
1233 that provide special support for looking up doc strings. Use the |
8db373573379
(Lisp Doc): Eldoc mode shows only the first line of a variable's docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61133
diff
changeset
|
1234 command @kbd{M-x eldoc-mode} to enable or disable this feature. |
25829 | 1235 |
28329
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1236 @node Hideshow |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1237 @section Hideshow minor mode |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1238 |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1239 @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
|
1240 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
|
1241 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
|
1242 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
|
1243 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
|
1244 for those modes. |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1245 |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1246 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
|
1247 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
|
1248 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
|
1249 also count as blocks. |
28329
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1250 |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1251 @findex hs-hide-all |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1252 @findex hs-hide-block |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1253 @findex hs-show-all |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1254 @findex hs-show-block |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1255 @findex hs-show-region |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1256 @findex hs-hide-level |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1257 @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
|
1258 @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
|
1259 @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
|
1260 @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
|
1261 @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
|
1262 @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
|
1263 @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
|
1264 @kindex S-Mouse-2 |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1265 @table @kbd |
37997
c329103798cc
(Hideshow): Fix the docs of keybindings which used a single `@'.
Eli Zaretskii <eliz@gnu.org>
parents:
37978
diff
changeset
|
1266 @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
|
1267 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
|
1268 @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
|
1269 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
|
1270 @item C-c @@ C-c |
59371
364d233a8dc3
Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents:
56809
diff
changeset
|
1271 Either hide or show the current block (@code{hs-toggle-hiding}). |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1272 @item S-Mouse-2 |
59371
364d233a8dc3
Minor typos corrected, and some small re-wording.
Stephen Eglen <stephen@gnu.org>
parents:
56809
diff
changeset
|
1273 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
|
1274 @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
|
1275 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
|
1276 @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
|
1277 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
|
1278 @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
|
1279 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
|
1280 (@code{hs-hide-level}). |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1281 @end table |
28329
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1282 |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1283 @vindex hs-hide-comments-when-hiding-all |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1284 @vindex hs-isearch-open |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1285 @vindex hs-special-modes-alist |
59798
0816b427495a
Don't say just "option" when talking about variables.
Richard M. Stallman <rms@gnu.org>
parents:
59475
diff
changeset
|
1286 These variables exist for customizing Hideshow mode. |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1287 |
28329
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1288 @table @code |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1289 @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
|
1290 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
|
1291 |
28329
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1292 @item hs-isearch-open |
68697 | 1293 Specifies what kind of hidden blocks incremental search should make |
1294 visible. The value should be one of these four symbols: | |
38231
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
1295 |
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
1296 @table @code |
38946
9a1045bcf43c
Update values of hs-isearch-open.
Richard M. Stallman <rms@gnu.org>
parents:
38871
diff
changeset
|
1297 @item code |
9a1045bcf43c
Update values of hs-isearch-open.
Richard M. Stallman <rms@gnu.org>
parents:
38871
diff
changeset
|
1298 Open only code blocks. |
38231
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
1299 @item comment |
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
1300 Open only comments. |
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
1301 @item t |
38946
9a1045bcf43c
Update values of hs-isearch-open.
Richard M. Stallman <rms@gnu.org>
parents:
38871
diff
changeset
|
1302 Open both code blocks and comments. |
38231
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
1303 @item nil |
38946
9a1045bcf43c
Update values of hs-isearch-open.
Richard M. Stallman <rms@gnu.org>
parents:
38871
diff
changeset
|
1304 Open neither code blocks nor comments. |
38231
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
1305 @end table |
a94c26975e95
Explain purpose of mode hooks.
Richard M. Stallman <rms@gnu.org>
parents:
38212
diff
changeset
|
1306 |
28329
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1307 @item hs-special-modes-alist |
38867 | 1308 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
|
1309 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
|
1310 for more information. |
28329
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1311 @end table |
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1312 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1313 @node Symbol Completion |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1314 @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
|
1315 @cindex completion (symbol names) |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1316 |
38867 | 1317 In Emacs, completion is something you normally do in the minibuffer. |
1318 But one kind of completion is available in all buffers: completion for | |
1319 symbol names. | |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1320 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1321 @kindex M-TAB |
38867 | 1322 The character @kbd{M-@key{TAB}} runs a command to complete the |
1323 partial symbol before point against the set of meaningful symbol | |
1324 names. This command inserts at point any additional characters that | |
60112
7cb4576800fa
(Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents:
59798
diff
changeset
|
1325 it can determine from the partial name. (If your window manager |
60434
e6fb531ca25b
(Symbol Completion): C-M-i like M-TAB.
Richard M. Stallman <rms@gnu.org>
parents:
60112
diff
changeset
|
1326 defines @kbd{M-@key{TAB}} to switch windows, you can type |
e6fb531ca25b
(Symbol Completion): C-M-i like M-TAB.
Richard M. Stallman <rms@gnu.org>
parents:
60112
diff
changeset
|
1327 @kbd{@key{ESC} @key{TAB}} or @kbd{C-M-i}.) |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1328 |
38867 | 1329 If the partial name in the buffer has multiple possible completions |
1330 that differ in the very next character, so that it is impossible to | |
1331 complete even one more character, @kbd{M-@key{TAB}} displays a list of | |
1332 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
|
1333 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1334 @cindex tags-based completion |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1335 @cindex Info index completion |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1336 @findex complete-symbol |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1337 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
|
1338 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
|
1339 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
|
1340 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
|
1341 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
|
1342 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
|
1343 @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
|
1344 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
|
1345 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
|
1346 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
|
1347 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1348 @cindex Lisp symbol completion |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1349 @cindex completion (Lisp symbols) |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1350 @findex lisp-complete-symbol |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1351 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
|
1352 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
|
1353 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
|
1354 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
|
1355 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
|
1356 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
|
1357 |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1358 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
|
1359 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
|
1360 |
30810
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1361 @node Glasses |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1362 @section Glasses minor mode |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1363 @cindex Glasses mode |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1364 @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
|
1365 @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
|
1366 @findex glasses-mode |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1367 |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1368 Glasses minor mode makes @samp{unreadableIdentifiersLikeThis} |
38867 | 1369 readable by altering the way they display. It knows two different |
1370 ways to do this: by displaying underscores between a lower-case letter | |
1371 and the following capital letter, and by emboldening the capital | |
1372 letters. It does not alter the buffer text, only the way they | |
1373 display, so you can use it even on read-only buffers. You can use the | |
1374 command @kbd{M-x glasses-mode} to enable or disable the mode in the | |
1375 current buffer; you can also add @code{glasses-mode} to the mode hook | |
1376 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
|
1377 to use Glasses mode. |
30810
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1378 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1379 @node Misc for Programs |
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1380 @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
|
1381 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1382 A number of Emacs commands that aren't designed specifically for |
38867 | 1383 editing programs are useful for that nonetheless. |
26292
81cd0c225dd9
Last changes for etags (I hope).
Francesco Potortì <pot@gnu.org>
parents:
26289
diff
changeset
|
1384 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1385 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
|
1386 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
|
1387 (@pxref{Words}); sentences can be found in strings and comments |
38867 | 1388 (@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
|
1389 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
|
1390 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
|
1391 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
|
1392 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
|
1393 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
|
1394 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
|
1395 indents the new lines which it creates. |
25829 | 1396 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1397 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
|
1398 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
|
1399 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
|
1400 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
|
1401 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
|
1402 (@pxref{Foldout}). |
25829 | 1403 |
38212
6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
Richard M. Stallman <rms@gnu.org>
parents:
38164
diff
changeset
|
1404 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
|
1405 @xref{Top,,Autotyping, autotype, Autotyping}. |
25829 | 1406 |
1407 @node C Modes | |
1408 @section C and Related Modes | |
1409 @cindex C mode | |
1410 @cindex Java mode | |
1411 @cindex Pike mode | |
1412 @cindex IDL mode | |
1413 @cindex CORBA IDL mode | |
1414 @cindex Objective C mode | |
1415 @cindex C++ mode | |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1416 @cindex AWK mode |
25829 | 1417 @cindex mode, Java |
1418 @cindex mode, C | |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1419 @cindex mode, C++ |
25829 | 1420 @cindex mode, Objective C |
1421 @cindex mode, CORBA IDL | |
1422 @cindex mode, Pike | |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1423 @cindex mode, AWK |
25829 | 1424 |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1425 This section gives a brief description of the special features |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1426 available in C, C++, Objective-C, Java, CORBA IDL, Pike and AWK modes. |
53386
8bacf8f6aa0c
(C Modes): Fix the xref.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52401
diff
changeset
|
1427 (These are called ``C mode and related modes.'') @xref{Top, , CC Mode, |
8bacf8f6aa0c
(C Modes): Fix the xref.
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52401
diff
changeset
|
1428 ccmode, CC Mode}, for a more extensive description of these modes |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1429 and their special features. |
28329
6e740f27f255
(Programs): Mention outline features.
Dave Love <fx@gnu.org>
parents:
27221
diff
changeset
|
1430 |
25829 | 1431 @menu |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1432 * Motion in C:: Commands to move by C statements, etc. |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1433 * Electric C:: Colon and other chars can automatically reindent. |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1434 * Hungry Delete:: A more powerful DEL command. |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1435 * Other C Commands:: Filling comments, viewing expansion of macros, |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1436 and other neat features. |
25829 | 1437 @end menu |
1438 | |
1439 @node Motion in C | |
1440 @subsection C Mode Motion Commands | |
1441 | |
1442 This section describes commands for moving point, in C mode and | |
1443 related modes. | |
1444 | |
1445 @table @code | |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1446 @item M-x c-beginning-of-defun |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1447 @itemx M-x c-end-of-defun |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1448 @findex c-beginning-of-defun |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1449 @findex c-end-of-defun |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1450 Move point to the beginning or end of the current function or |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1451 top-level definition. These are found by searching for the least |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1452 enclosing braces. (By contrast, @code{beginning-of-defun} and |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1453 @code{end-of-defun} search for braces in column zero.) If you are |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1454 editing code where the opening brace of a function isn't placed in |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1455 column zero, you may wish to bind @code{C-M-a} and @code{C-M-e} to |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1456 these commands. @xref{Moving by Defuns}. |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1457 |
25829 | 1458 @item C-c C-u |
1459 @kindex C-c C-u @r{(C mode)} | |
1460 @findex c-up-conditional | |
1461 Move point back to the containing preprocessor conditional, leaving the | |
1462 mark behind. A prefix argument acts as a repeat count. With a negative | |
1463 argument, move point forward to the end of the containing | |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1464 preprocessor conditional. |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1465 |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1466 @samp{#elif} is equivalent to @samp{#else} followed by @samp{#if}, so |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1467 the function will stop at a @samp{#elif} when going backward, but not |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1468 when going forward. |
25829 | 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 | |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1485 @kindex M-a (C mode) |
25829 | 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 | |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1492 In comments or in strings which span more than one line, this command |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1493 moves by sentences instead of statements. |
25829 | 1494 |
1495 @item M-e | |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1496 @kindex M-e (C mode) |
25829 | 1497 @findex c-end-of-statement |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1498 Move point to the end of the innermost C statement or sentence; like |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1499 @kbd{M-a} except that it moves in the other direction |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1500 (@code{c-end-of-statement}). |
25829 | 1501 @end table |
1502 | |
1503 @node Electric C | |
1504 @subsection Electric C Characters | |
1505 | |
1506 In C mode and related modes, certain printing characters are | |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1507 @dfn{electric}---in addition to inserting themselves, they also |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1508 reindent the current line, and optionally also insert newlines. The |
60112
7cb4576800fa
(Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents:
59798
diff
changeset
|
1509 ``electric'' characters are @kbd{@{}, @kbd{@}}, @kbd{:}, @kbd{#}, |
7cb4576800fa
(Program Modes): Mention Python mode.
Richard M. Stallman <rms@gnu.org>
parents:
59798
diff
changeset
|
1510 @kbd{;}, @kbd{,}, @kbd{<}, @kbd{>}, @kbd{/}, @kbd{*}, @kbd{(}, and |
67683
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
1511 @kbd{)}. |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1512 |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1513 You might find electric indentation inconvenient if you are editing |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1514 chaotically indented code. If you are new to CC Mode, you might find |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1515 it disconcerting. You can toggle electric action with the command |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1516 @kbd{C-c C-l}; when it is enabled, @samp{/l} appears in the mode line |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1517 after the mode name: |
25829 | 1518 |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1519 @table @kbd |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1520 @item C-c C-l |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1521 @kindex C-c C-l @r{(C mode)} |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1522 @findex c-toggle-electric-state |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1523 Toggle electric action (@code{c-toggle-electric-state}). With a |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1524 prefix argument, this command enables electric action if the argument |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1525 is positive, disables it if it is negative. |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1526 @end table |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1527 |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1528 Electric characters insert newlines only when, in addition to the |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1529 electric state, the @dfn{auto-newline} feature is enabled (indicated |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1530 by @samp{/la} in the mode line after the mode name). You can turn |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1531 this feature on or off with the command @kbd{C-c C-a}: |
25829 | 1532 |
1533 @table @kbd | |
1534 @item C-c C-a | |
1535 @kindex C-c C-a @r{(C mode)} | |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1536 @findex c-toggle-auto-newline |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1537 Toggle the auto-newline feature (@code{c-toggle-auto-newline}). With a |
25829 | 1538 prefix argument, this command turns the auto-newline feature on if the |
1539 argument is positive, and off if it is negative. | |
1540 @end table | |
1541 | |
67683
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
1542 Usually the CC Mode style configures the exact circumstances in |
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
1543 which Emacs inserts auto-newlines. You can also configure this |
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
1544 directly. @xref{Custom Auto-newlines,,, ccmode, The CC Mode Manual}. |
25829 | 1545 |
1546 @node Hungry Delete | |
1547 @subsection Hungry Delete Feature in C | |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1548 @cindex hungry deletion (C Mode) |
25829 | 1549 |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1550 If you want to delete an entire block of whitespace at point, you |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1551 can use @dfn{hungry deletion}. This deletes all the contiguous |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1552 whitespace either before point or after point in a single operation. |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1553 @dfn{Whitespace} here includes tabs and newlines, but not comments or |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1554 preprocessor commands. |
25829 | 1555 |
1556 @table @kbd | |
68801
e759a2258b51
programs.texi ("Hungry Delete"): Correct the appellation of the backspace
Alan Mackenzie <acm@muc.de>
parents:
68717
diff
changeset
|
1557 @item C-c C-@key{DEL} |
e759a2258b51
programs.texi ("Hungry Delete"): Correct the appellation of the backspace
Alan Mackenzie <acm@muc.de>
parents:
68717
diff
changeset
|
1558 @itemx C-c @key{DEL} |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1559 @findex c-hungry-backspace |
68801
e759a2258b51
programs.texi ("Hungry Delete"): Correct the appellation of the backspace
Alan Mackenzie <acm@muc.de>
parents:
68717
diff
changeset
|
1560 @kindex C-c C-@key{DEL} (C Mode) |
e759a2258b51
programs.texi ("Hungry Delete"): Correct the appellation of the backspace
Alan Mackenzie <acm@muc.de>
parents:
68717
diff
changeset
|
1561 @kindex C-c @key{DEL} (C Mode) |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1562 @code{c-hungry-backspace}---Delete the entire block of whitespace |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1563 preceding point. |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1564 |
25829 | 1565 @item C-c C-d |
68801
e759a2258b51
programs.texi ("Hungry Delete"): Correct the appellation of the backspace
Alan Mackenzie <acm@muc.de>
parents:
68717
diff
changeset
|
1566 @itemx C-c C-@key{DELETE} |
e759a2258b51
programs.texi ("Hungry Delete"): Correct the appellation of the backspace
Alan Mackenzie <acm@muc.de>
parents:
68717
diff
changeset
|
1567 @itemx C-c @key{DELETE} |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1568 @findex c-hungry-delete-forward |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1569 @kindex C-c C-d (C Mode) |
68801
e759a2258b51
programs.texi ("Hungry Delete"): Correct the appellation of the backspace
Alan Mackenzie <acm@muc.de>
parents:
68717
diff
changeset
|
1570 @kindex C-c C-@key{DELETE} (C Mode) |
e759a2258b51
programs.texi ("Hungry Delete"): Correct the appellation of the backspace
Alan Mackenzie <acm@muc.de>
parents:
68717
diff
changeset
|
1571 @kindex C-c @key{DELETE} (C Mode) |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1572 @code{c-hungry-delete-forward}---Delete the entire block of whitespace |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1573 following point. |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1574 @end table |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1575 |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1576 As an alternative to the above commands, you can enable @dfn{hungry |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1577 delete mode}. When this feature is enabled (indicated by @samp{/h} in |
68818
353348d5ce78
(Defuns): Delete duplicate explanation of left-margin paren convention.
Richard M. Stallman <rms@gnu.org>
parents:
68801
diff
changeset
|
1578 the mode line after the mode name), a single @key{DEL} deletes all |
353348d5ce78
(Defuns): Delete duplicate explanation of left-margin paren convention.
Richard M. Stallman <rms@gnu.org>
parents:
68801
diff
changeset
|
1579 preceding whitespace, not just one space, and a single @kbd{C-c C-d} |
353348d5ce78
(Defuns): Delete duplicate explanation of left-margin paren convention.
Richard M. Stallman <rms@gnu.org>
parents:
68801
diff
changeset
|
1580 (but @emph{not} plain @key{DELETE}) deletes all following whitespace. |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1581 |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1582 @table @kbd |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1583 @item M-x c-toggle-hungry-state |
25829 | 1584 @findex c-toggle-hungry-state |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1585 Toggle the hungry-delete feature |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1586 (@code{c-toggle-hungry-state})@footnote{This command had the binding |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1587 @kbd{C-c C-d} in earlier versions of Emacs. @kbd{C-c C-d} is now |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1588 bound to @code{c-hungry-delete-forward}.}. With a prefix argument, |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1589 this command turns the hungry-delete feature on if the argument is |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1590 positive, and off if it is negative. |
25829 | 1591 @end table |
1592 | |
1593 @vindex c-hungry-delete-key | |
1594 The variable @code{c-hungry-delete-key} controls whether the | |
1595 hungry-delete feature is enabled. | |
1596 | |
1597 @node Other C Commands | |
1598 @subsection Other Commands for C Mode | |
1599 | |
1600 @table @kbd | |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1601 @item C-c C-w |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1602 @itemx M-x c-subword-mode |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1603 @findex c-subword-mode |
67683
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
1604 Enable (or disable) @dfn{subword mode}. In subword mode, Emacs's word |
70485 | 1605 commands recognize upper case letters in |
67683
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
1606 @samp{StudlyCapsIdentifiers} as word boundaries. This is indicated by |
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
1607 the flag @samp{/w} on the mode line after the mode name |
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
1608 (e.g. @samp{C/law}). You can even use @kbd{M-x c-subword-mode} in |
6fc6fd3c71cd
(Electric C): Delete the info about newline control.
Richard M. Stallman <rms@gnu.org>
parents:
67676
diff
changeset
|
1609 non-CC Mode buffers. |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1610 |
68697 | 1611 In the GNU project, we recommend using underscores to separate words |
1612 within an identifier in C or C++, rather than using case distinctions. | |
1613 | |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1614 @item M-x c-context-line-break |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1615 @findex c-context-line-break |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1616 This command inserts a line break and indents the new line in a manner |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1617 appropriate to the context. In normal code, it does the work of |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1618 @kbd{C-j} (@code{newline-and-indent}), in a C preprocessor line it |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1619 additionally inserts a @samp{\} at the line break, and within comments |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1620 it's like @kbd{M-j} (@code{c-indent-new-comment-line}). |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1621 |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1622 @code{c-context-line-break} isn't bound to a key by default, but it |
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1623 needs a binding to be useful. The following code will bind it to |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1624 @kbd{C-j}. We use @code{c-initialization-hook} here to make sure |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1625 the keymap is loaded before we try to change it. |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1626 |
71593 | 1627 @smallexample |
67676
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1628 (defun my-bind-clb () |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1629 (define-key c-mode-base-map "\C-j" 'c-context-line-break)) |
76931aba1936
Amend the file for CC Mode 5.31. In particular, relax the injunction
Alan Mackenzie <acm@muc.de>
parents:
67513
diff
changeset
|
1630 (add-hook 'c-initialization-hook 'my-bind-clb) |
71593 | 1631 @end smallexample |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1632 |
25829 | 1633 @item C-M-h |
1634 Put mark at the end of a function definition, and put point at the | |
1635 beginning (@code{c-mark-function}). | |
1636 | |
1637 @item M-q | |
1638 @kindex M-q @r{(C mode)} | |
1639 @findex c-fill-paragraph | |
1640 Fill a paragraph, handling C and C++ comments (@code{c-fill-paragraph}). | |
1641 If any part of the current line is a comment or within a comment, this | |
1642 command fills the comment or the paragraph of it that point is in, | |
1643 preserving the comment indentation and comment delimiters. | |
1644 | |
1645 @item C-c C-e | |
1646 @cindex macro expansion in C | |
1647 @cindex expansion of C macros | |
1648 @findex c-macro-expand | |
1649 @kindex C-c C-e @r{(C mode)} | |
1650 Run the C preprocessor on the text in the region, and show the result, | |
1651 which includes the expansion of all the macro calls | |
1652 (@code{c-macro-expand}). The buffer text before the region is also | |
1653 included in preprocessing, for the sake of macros defined there, but the | |
1654 output from this part isn't shown. | |
1655 | |
1656 When you are debugging C code that uses macros, sometimes it is hard to | |
1657 figure out precisely how the macros expand. With this command, you | |
1658 don't have to figure it out; you can see the expansions. | |
1659 | |
1660 @item C-c C-\ | |
1661 @findex c-backslash-region | |
1662 @kindex C-c C-\ @r{(C mode)} | |
1663 Insert or align @samp{\} characters at the ends of the lines of the | |
1664 region (@code{c-backslash-region}). This is useful after writing or | |
1665 editing a C macro definition. | |
1666 | |
1667 If a line already ends in @samp{\}, this command adjusts the amount of | |
1668 whitespace before it. Otherwise, it inserts a new @samp{\}. However, | |
1669 the last line in the region is treated specially; no @samp{\} is | |
1670 inserted on that line, and any @samp{\} there is deleted. | |
1671 | |
1672 @item M-x cpp-highlight-buffer | |
1673 @cindex preprocessor highlighting | |
1674 @findex cpp-highlight-buffer | |
1675 Highlight parts of the text according to its preprocessor conditionals. | |
1676 This command displays another buffer named @samp{*CPP Edit*}, which | |
1677 serves as a graphic menu for selecting how to display particular kinds | |
1678 of conditionals and their contents. After changing various settings, | |
1679 click on @samp{[A]pply these settings} (or go to that buffer and type | |
1680 @kbd{a}) to rehighlight the C mode buffer accordingly. | |
1681 | |
1682 @item C-c C-s | |
1683 @findex c-show-syntactic-information | |
1684 @kindex C-c C-s @r{(C mode)} | |
1685 Display the syntactic information about the current source line | |
59461
26a204697252
Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents:
59371
diff
changeset
|
1686 (@code{c-show-syntactic-information}). This information directs how |
26a204697252
Re-read for factual correctness; some lisp functions had changed, and
Stephen Eglen <stephen@gnu.org>
parents:
59371
diff
changeset
|
1687 the line is indented. |
30810
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1688 |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1689 @item M-x cwarn-mode |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1690 @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
|
1691 @findex cwarn-mode |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1692 @findex global-cwarn-mode |
56086
c5c08e52e9d6
Update for CC Mode 5.30 and incidental amendments.
Richard M. Stallman <rms@gnu.org>
parents:
54272
diff
changeset
|
1693 @vindex global-cwarn-mode |
30810
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1694 @cindex CWarn mode |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1695 @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
|
1696 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
|
1697 |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1698 @itemize @bullet{} |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1699 @item |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1700 Assignments inside expressions. |
30810
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1701 @item |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1702 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
|
1703 (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
|
1704 @item |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1705 C++ functions with reference parameters. |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1706 @end itemize |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1707 |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1708 @noindent |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1709 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
|
1710 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
|
1711 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
|
1712 @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
|
1713 it work. |
30810
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1714 |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1715 @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
|
1716 @findex hide-ifdef-mode |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1717 @cindex Hide-ifdef mode |
6c6b0162bae2
Tidy up previous additions. List more languages. Glasses mode.
Dave Love <fx@gnu.org>
parents:
30793
diff
changeset
|
1718 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
|
1719 @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
|
1720 @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
|
1721 |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1722 @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
|
1723 @cindex related files |
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1724 @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
|
1725 @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
|
1726 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
|
1727 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
|
1728 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
|
1729 @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
|
1730 names. |
25829 | 1731 @end table |
1732 | |
1733 @node Asm Mode | |
1734 @section Asm Mode | |
1735 | |
1736 @cindex Asm mode | |
36183
d3f65290e6b2
Clean up comment-dwim vs indent-for-comment, etc.
Richard M. Stallman <rms@gnu.org>
parents:
35477
diff
changeset
|
1737 @cindex assembler mode |
25829 | 1738 Asm mode is a major mode for editing files of assembler code. It |
1739 defines these commands: | |
1740 | |
1741 @table @kbd | |
1742 @item @key{TAB} | |
1743 @code{tab-to-tab-stop}. | |
1744 @item C-j | |
1745 Insert a newline and then indent using @code{tab-to-tab-stop}. | |
1746 @item : | |
1747 Insert a colon and then remove the indentation from before the label | |
1748 preceding colon. Then do @code{tab-to-tab-stop}. | |
1749 @item ; | |
1750 Insert or align a comment. | |
1751 @end table | |
1752 | |
1753 The variable @code{asm-comment-char} specifies which character | |
1754 starts comments in assembler syntax. | |
52401 | 1755 |
70442
284d18cd0af7
(Program Modes): Replace inforef to emacs-xtra by conditional xref's, depending
Eli Zaretskii <eliz@gnu.org>
parents:
69842
diff
changeset
|
1756 @ifnottex |
284d18cd0af7
(Program Modes): Replace inforef to emacs-xtra by conditional xref's, depending
Eli Zaretskii <eliz@gnu.org>
parents:
69842
diff
changeset
|
1757 @include fortran-xtra.texi |
284d18cd0af7
(Program Modes): Replace inforef to emacs-xtra by conditional xref's, depending
Eli Zaretskii <eliz@gnu.org>
parents:
69842
diff
changeset
|
1758 @end ifnottex |
284d18cd0af7
(Program Modes): Replace inforef to emacs-xtra by conditional xref's, depending
Eli Zaretskii <eliz@gnu.org>
parents:
69842
diff
changeset
|
1759 |
52401 | 1760 @ignore |
1761 arch-tag: c7ee7409-40a4-45c7-bfb7-ae7f2c74d0c0 | |
1762 @end ignore |