annotate doc/misc/cc-mode.texi @ 98036:70619fdc3dac

*** empty log message ***
author Eli Zaretskii <eliz@gnu.org>
date Sat, 06 Sep 2008 13:43:36 +0000
parents 80392a5671b7
children 6de181810d0f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
84286
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1 \input texinfo
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2 @c Notes to self regarding line handling:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3 @c
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4 @c Empty lines are often significant before @end directives; avoid them.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5 @c
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6 @c Empty lines before and after @example directives are significant in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7 @c info output but not in TeX. Empty lines inside @example directives
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8 @c are significant.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10 @c Conventions for formatting examples:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11 @c o If the example contains empty lines then put the surrounding empty
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12 @c lines inside the @example directives. Put them outside otherwise.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13 @c o Use @group inside the example only if it shows indentation where
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14 @c the relation between lines inside is relevant.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15 @c o Format line number columns like this:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16 @c 1: foo
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17 @c 2: bar
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18 @c ^ one space
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19 @c ^^ two columns, right alignment
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20 @c o Check line lengths in TeX output; they can typically be no longer
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21 @c than 70 chars, 60 if the paragraph is indented.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
23 @comment TBD: Document the finer details of statement anchoring?
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
24
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
25 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
26 @comment %**start of header (This is for running Texinfo on a region)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
27 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
28
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
29
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
30 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
31 @comment How to make the various output formats:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
32 @comment (Thanks to Robert Chassell for supplying this information.)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
33 @comment Note that Texinfo 4.7 (or later) is needed.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
34 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
35 @ignore
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
36 In each of the following pairs of commands, the first generates a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
37 version with cross references pointing to the GNU Emacs manuals,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
38 the second with them pointing to the XEmacs manuals.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
39 ## Info output
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
40 makeinfo cc-mode.texi
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
41 makeinfo -DXEMACS cc-mode.texi
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
42
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
43 ## DVI output
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
44 ## You may need to set up the environment variable TEXINPUTS so
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
45 ## that tex can find the file texinfo.tex - See the tex
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
46 ## manpage.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
47 texi2dvi cc-mode.texi
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
48 texi2dvi -t "@set XEMACS " cc-mode.texi
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
49
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
50 ## HTML output. (The --no-split parameter is optional)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
51 makeinfo --html --no-split cc-mode.texi
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
52 makeinfo --html --no-split -DXEMACS cc-mode.texi
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
53
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
54 ## Plain text output
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
55 makeinfo --fill-column=70 --no-split --paragraph-indent=0 \
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
56 --no-headers --output=cc-mode.txt cc-mode.texi
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
57 makeinfo --fill-column=70 --no-split --paragraph-indent=0 \
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
58 --no-headers --output=cc-mode.txt -DXEMACS cc-mode.texi
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
59
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
60 ## DocBook output
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
61 makeinfo --docbook --no-split --paragraph-indent=0 \
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
62 cc-mode.texi
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
63 makeinfo --docbook --no-split --paragraph-indent=0 \
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
64 -DXEMACS cc-mode.texi
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
65
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
66 ## XML output
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
67 makeinfo --xml --no-split --paragraph-indent=0 \
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
68 cc-mode.texi
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
69 makeinfo --xml --no-split --paragraph-indent=0 \
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
70 -DXEMACS cc-mode.texi
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
71
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
72 #### (You must be in the same directory as the viewed file.)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
73
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
74 ## View DVI output
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
75 xdvi cc-mode.dvi &
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
76
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
77 ## View HTML output
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
78 mozilla cc-mode.html
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
79 @end ignore
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
80
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
81 @comment No overfull hbox marks in the dvi file.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
82 @finalout
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
83
84329
3d431f1997d8 (setfilename): Go up one more level to ../../info.
Glenn Morris <rgm@gnu.org>
parents: 84286
diff changeset
84 @setfilename ../../info/ccmode
84286
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
85 @settitle CC Mode Manual
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
86 @footnotestyle end
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
87
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
88 @c The following four macros generate the filenames and titles of the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
89 @c main (X)Emacs manual and the Elisp/Lispref manual. Leave the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
90 @c Texinfo variable `XEMACS' unset to generate a GNU Emacs version, set it
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
91 @c to generate an XEmacs version, e.g. with
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
92 @c "makeinfo -DXEMACS cc-mode.texi".
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
93 @ifset XEMACS
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
94 @macro emacsman
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
95 xemacs
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
96 @end macro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
97 @macro emacsmantitle
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
98 XEmacs User's Manual
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
99 @end macro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
100 @macro lispref
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
101 lispref
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
102 @end macro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
103 @macro lispreftitle
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
104 XEmacs Lisp Reference Manual
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
105 @end macro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
106 @end ifset
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
107
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
108 @ifclear XEMACS
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
109 @macro emacsman
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
110 emacs
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
111 @end macro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
112 @macro emacsmantitle
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
113 GNU Emacs Manual
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
114 @end macro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
115 @macro lispref
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
116 elisp
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
117 @end macro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
118 @macro lispreftitle
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
119 GNU Emacs Lisp Reference Manual
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
120 @end macro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
121 @end ifclear
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
122
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
123
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
124 @macro ccmode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
125 CC Mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
126 @end macro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
127
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
128 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
129 @comment @setchapternewpage odd !! we don't want blank pages !!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
130 @comment %**end of header (This is for running Texinfo on a region)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
131 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
132
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
133
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
134 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
135 @comment
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
136 @comment Texinfo manual for CC Mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
137 @comment Generated from the original README file by Krishna Padmasola
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
138 @comment <krishna@earth-gw.njit.edu>
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
139 @comment
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
140 @comment Authors:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
141 @comment Barry A. Warsaw
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
142 @comment Martin Stjernholm
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
143 @comment Alan Mackenzie
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
144 @comment
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
145 @comment Maintained by Martin Stjernholm and Alan Mackenzie <bug-cc-mode@gnu.org>
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
146 @comment
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
147 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
148
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
149 @comment Define an index for syntactic symbols.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
150 @ifnottex @c In texi2dvi, the @defindex would create an empty cc-mode.ss
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
151 @c For Info, unlike tex, @syncodeindex needs a matching @defindex.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
152 @defindex ss
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
153 @end ifnottex
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
154
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
155 @comment Combine key, syntactic symbol and concept indices into one.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
156 @syncodeindex ss cp
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
157 @syncodeindex ky cp
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
158
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
159 @copying
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
160 This manual is for CC Mode in Emacs.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
161
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
162 Copyright @copyright{} 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
87903
5d58981e6690 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 87453
diff changeset
163 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
84286
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
164
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
165 @quotation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
166 Permission is granted to copy, distribute and/or modify this document
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
167 under the terms of the GNU Free Documentation License, Version 1.2 or
95936
ce35dd677448 Remove references to external license, since doclicense is included.
Glenn Morris <rgm@gnu.org>
parents: 95874
diff changeset
168 any later version published by the Free Software Foundation; with no
ce35dd677448 Remove references to external license, since doclicense is included.
Glenn Morris <rgm@gnu.org>
parents: 95874
diff changeset
169 Invariant Sections, with the Front-Cover texts being ``A GNU Manual'',
ce35dd677448 Remove references to external license, since doclicense is included.
Glenn Morris <rgm@gnu.org>
parents: 95874
diff changeset
170 and with the Back-Cover Texts as in (a) below. A copy of the license
ce35dd677448 Remove references to external license, since doclicense is included.
Glenn Morris <rgm@gnu.org>
parents: 95874
diff changeset
171 is included in the section entitled ``GNU Free Documentation License''.
84286
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
172
95874
eafbd7a5c9be Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents: 92570
diff changeset
173 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
eafbd7a5c9be Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents: 92570
diff changeset
174 modify this GNU manual. Buying copies from the FSF supports it in
eafbd7a5c9be Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents: 92570
diff changeset
175 developing GNU and promoting software freedom.''
84286
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
176 @end quotation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
177 @end copying
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
178
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
179 @comment Info directory entry for use by install-info. The indentation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
180 @comment here is by request from the FSF folks.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
181 @dircategory Emacs
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
182 @direntry
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
183 * CC Mode: (ccmode). Emacs mode for editing C, C++, Objective-C,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
184 Java, Pike, AWK, and CORBA IDL code.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
185 @end direntry
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
186
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
187 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
188 @comment TeX title page
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
189 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
190
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
191 @titlepage
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
192 @sp 10
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
193
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
194 @center @titlefont{CC Mode 5.31}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
195 @sp 2
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
196 @center @subtitlefont{A GNU Emacs mode for editing C and C-like languages}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
197 @sp 2
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
198 @center Barry A. Warsaw, Martin Stjernholm, Alan Mackenzie
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
199
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
200 @page
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
201 @vskip 0pt plus 1filll
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
202 @insertcopying
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
203
85173
de920bbb6866 Remove RCS keywords from doc/misc/cc-mode.texi
Miles Bader <miles@gnu.org>
parents: 84329
diff changeset
204 This manual was generated from cc-mode.texi, which can be downloaded
de920bbb6866 Remove RCS keywords from doc/misc/cc-mode.texi
Miles Bader <miles@gnu.org>
parents: 84329
diff changeset
205 from
84329
3d431f1997d8 (setfilename): Go up one more level to ../../info.
Glenn Morris <rgm@gnu.org>
parents: 84286
diff changeset
206 @url{http://cvs.savannah.gnu.org/viewcvs/emacs/emacs/doc/misc/cc-mode.texi}.
84286
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
207 @end titlepage
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
208
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
209 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
210 @comment The Top node contains the master menu for the Info file.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
211 @comment This appears only in the Info file, not the printed manual.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
212 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
213
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
214 @node Top, Introduction, (dir), (dir)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
215 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
216
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
217 @ifinfo
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
218 @top @ccmode{}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
219
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
220 @ccmode{} is a GNU Emacs mode for editing files containing C, C++,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
221 Objective-C, Java, CORBA IDL (and the variants PSDL and CIDL), Pike
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
222 and AWK code. It provides syntax-based indentation, font locking, and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
223 has several handy commands and some minor modes to make the editing
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
224 easier. It does not provide tools to look up and navigate between
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
225 functions, classes etc - there are other packages for that.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
226 @end ifinfo
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
227
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
228 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
229 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
230
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
231 @menu
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
232 * Introduction::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
233 * Overview::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
234 * Getting Started::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
235 * Commands::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
236 * Font Locking::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
237 * Config Basics::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
238 * Custom Filling and Breaking::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
239 * Custom Auto-newlines::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
240 * Clean-ups::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
241 * Indentation Engine Basics::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
242 * Customizing Indentation::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
243 * Custom Macros::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
244 * Odds and Ends::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
245 * Sample .emacs File::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
246 * Performance Issues::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
247 * Limitations and Known Bugs::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
248 * FAQ::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
249 * Updating CC Mode::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
250 * Mailing Lists and Bug Reports::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
251 * GNU Free Documentation License::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
252 * Command and Function Index::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
253 * Variable Index::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
254 * Concept and Key Index::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
255
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
256 @detailmenu
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
257 --- The Detailed Node Listing ---
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
258
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
259 Commands
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
260
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
261 * Indentation Commands::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
262 * Comment Commands::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
263 * Movement Commands::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
264 * Filling and Breaking::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
265 * Minor Modes::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
266 * Electric Keys::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
267 * Auto-newlines::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
268 * Hungry WS Deletion::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
269 * Subword Movement::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
270 * Other Commands::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
271
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
272 Font Locking
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
273
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
274 * Font Locking Preliminaries::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
275 * Faces::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
276 * Doc Comments::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
277 * AWK Mode Font Locking::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
278
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
279 Configuration Basics
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
280
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
281 * CC Hooks::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
282 * Style Variables::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
283 * Styles::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
284
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
285 Styles
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
286
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
287 * Built-in Styles::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
288 * Choosing a Style::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
289 * Adding Styles::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
290 * File Styles::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
291
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
292 Customizing Auto-newlines
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
293
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
294 * Hanging Braces::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
295 * Hanging Colons::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
296 * Hanging Semicolons and Commas::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
297
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
298 Hanging Braces
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
299
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
300 * Custom Braces::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
301
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
302 Indentation Engine Basics
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
303
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
304 * Syntactic Analysis::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
305 * Syntactic Symbols::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
306 * Indentation Calculation::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
307
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
308 Syntactic Symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
309
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
310 * Function Symbols::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
311 * Class Symbols::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
312 * Conditional Construct Symbols::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
313 * Switch Statement Symbols::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
314 * Brace List Symbols::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
315 * External Scope Symbols::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
316 * Paren List Symbols::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
317 * Literal Symbols::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
318 * Multiline Macro Symbols::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
319 * Objective-C Method Symbols::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
320 * Anonymous Class Symbol::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
321 * Statement Block Symbols::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
322 * K&R Symbols::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
323
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
324 Customizing Indentation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
325
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
326 * c-offsets-alist::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
327 * Interactive Customization::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
328 * Line-Up Functions::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
329 * Custom Line-Up::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
330 * Other Indentation::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
331
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
332 Line-Up Functions
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
333
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
334 * Brace/Paren Line-Up::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
335 * List Line-Up::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
336 * Operator Line-Up::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
337 * Comment Line-Up::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
338 * Misc Line-Up::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
339
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
340 @end detailmenu
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
341 @end menu
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
342
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
343 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
344 @node Introduction, Overview, Top, Top
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
345 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
346 @chapter Introduction
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
347 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
348
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
349 @cindex BOCM
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
350 @cindex history
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
351 @cindex awk-mode.el
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
352 @cindex c-mode.el
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
353 @cindex c++-mode.el
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
354
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
355 Welcome to @ccmode{}, a GNU Emacs mode for editing files containing C,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
356 C++, Objective-C, Java, CORBA IDL (and the variants CORBA PSDL and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
357 CIDL), Pike and AWK code. This incarnation of the mode is descended
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
358 from @file{c-mode.el} (also called ``Boring Old C Mode'' or BOCM
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
359 @t{:-)}, @file{c++-mode.el} version 2, which Barry Warsaw had been
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
360 maintaining since 1992, and @file{awk-mode.el}, a long neglected mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
361 in the (X)Emacs base.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
362
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
363 Late in 1997, Martin Stjernholm joined Barry on the @ccmode{}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
364 Maintainers Team, and implemented the Pike support. In 2000 Martin
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
365 took over as the sole maintainer. In 2001 Alan Mackenzie joined the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
366 team, implementing AWK support in version 5.30. @ccmode{} did not
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
367 originally contain the font lock support for its languages --- that
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
368 was added in version 5.30.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
369
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
370 This manual describes @ccmode{}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
371 @comment The following line must appear on its own, so that the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
372 version 5.31.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
373 @comment Release.py script can update the version number automatically
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
374
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
375 @ccmode{} supports the editing of K&R and ANSI C, C++, Objective-C,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
376 Java, CORBA's Interface Definition Language, Pike@footnote{A C-like
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
377 scripting language with its roots in the LPC language used in some MUD
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
378 engines. See @uref{http://pike.ida.liu.se/}.} and AWK files. In this
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
379 way, you can easily set up consistent font locking and coding styles for
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
380 use in editing all of these languages, although AWK is not yet as
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
381 uniformly integrated as the other languages.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
382
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
383 @findex c-mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
384 @findex c++-mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
385 @findex objc-mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
386 @findex java-mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
387 @findex idl-mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
388 @findex pike-mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
389 @findex awk-mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
390 Note that the name of this package is ``@ccmode{}'', but there is no top
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
391 level @code{cc-mode} entry point. All of the variables, commands, and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
392 functions in @ccmode{} are prefixed with @code{c-@var{thing}}, and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
393 @code{c-mode}, @code{c++-mode}, @code{objc-mode}, @code{java-mode},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
394 @code{idl-mode}, @code{pike-mode}, and @code{awk-mode} entry points are
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
395 provided. This package is intended to be a replacement for
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
396 @file{c-mode.el}, @file{c++-mode.el} and @file{awk-mode.el}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
397
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
398 A special word of thanks goes to Krishna Padmasola for his work in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
399 converting the original @file{README} file to Texinfo format. I'd
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
400 also like to thank all the @ccmode{} victims who help enormously
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
401 during the early beta stages of @ccmode{}'s development.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
402
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
403 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
404 @node Overview, Getting Started, Introduction, Top
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
405 @comment node-name, next, previous, up@cindex organization of the manual
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
406 @chapter Overview of the Manual
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
407 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
408
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
409 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
410 The manual starts with several introductory chapters (including this
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
411 one).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
412
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
413 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
414 The next chunk of the manual describes the day to day @emph{use} of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
415 @ccmode{} (as contrasted with how to customize it).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
416
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
417 @itemize @bullet
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
418 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
419 The chapter ``Commands'' describes in detail how to use (nearly) all
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
420 of @ccmode{}'s features. There are extensive cross-references from
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
421 here to the corresponding sections later in the manual which tell you
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
422 how to customize these features.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
423
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
424 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
425 ``Font Locking'' describes how ``syntax highlighting'' is applied to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
426 your buffers. It is mainly background information and can be skipped
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
427 over at a first reading.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
428 @end itemize
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
429
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
430 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
431 The next chunk of the manual describes how to @emph{customize}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
432 @ccmode{}. Typically, an overview of a topic is given at the chapter
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
433 level, then the sections and subsections describe the material in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
434 increasing detail.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
435
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
436 @itemize @bullet
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
437 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
438 The chapter ``Configuration Basics'' tells you @emph{how} to write
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
439 customizations - whether in hooks, in styles, in both, or in neither,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
440 depending on your needs. It describes the @ccmode{} style system and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
441 lists the standard styles that @ccmode{} supplies.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
442
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
443 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
444 The next few chapters describe in detail how to customize the various
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
445 features of @ccmode{}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
446
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
447 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
448 Finally, there is a sample @file{.emacs} fragment, which might help you
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
449 in creating your own customization.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
450 @end itemize
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
451
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
452 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
453 The manual ends with ``this and that'', things that don't fit cleanly
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
454 into any of the previous chunks.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
455
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
456 @itemize @bullet
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
457 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
458 Two chapters discuss the performance of @ccmode{} and known
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
459 bugs/limitations.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
460
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
461 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
462 The FAQ contains a list of common problems and questions.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
463
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
464 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
465 The next two chapters tell you how to get in touch with the @ccmode{}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
466 project - whether for updating @ccmode{} or submitting bug reports.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
467 @end itemize
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
468
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
469 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
470 Finally, there are the customary indices.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
471
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
472 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
473 @node Getting Started, Commands, Overview, Top
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
474 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
475 @chapter Getting Started
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
476 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
477
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
478 If you got this version of @ccmode{} with Emacs or XEmacs, it should
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
479 work just fine right out of the box. Note however that you might not
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
480 have the latest @ccmode{} release and might want to upgrade your copy
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
481 (see below).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
482
87453
cdd30283527d Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 86093
diff changeset
483 You should probably start by skimming through the entire Commands chapter
cdd30283527d Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 86093
diff changeset
484 (@pxref{Commands}) to get an overview of @ccmode{}'s capabilities.
84286
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
485
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
486 After trying out some commands, you may dislike some aspects of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
487 @ccmode{}'s default configuration. Here is an outline of how to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
488 change some of the settings that newcomers to @ccmode{} most often
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
489 want to change:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
490
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
491 @table @asis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
492 @item c-basic-offset
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
493 This Lisp variable holds an integer, the number of columns @ccmode{}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
494 indents nested code. To set this value to 6, customize
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
495 @code{c-basic-offset} or put this into your @file{.emacs}:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
496
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
497 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
498 (setq c-basic-offset 6)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
499 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
500
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
501 @item The (indentation) style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
502 The basic ``shape'' of indentation created by @ccmode{}---by default,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
503 this is @code{gnu} style (except for Java and AWK buffers). A list of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
504 the available styles and their descriptions can be found in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
505 @ref{Built-in Styles}. A complete specification of the @ccmode{}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
506 style system, including how to create your own style, can be found in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
507 the chapter @ref{Styles}. To set your style to @code{linux}, either
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
508 customize @code{c-default-style} or put this into your @file{.emacs}:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
509
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
510 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
511 (setq c-default-style '((java-mode . "java")
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
512 (awk-mode . "awk")
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
513 (other . "linux")))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
514 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
515
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
516 @item Electric Indentation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
517 Normally, when you type ``punctuation'' characters such as @samp{;} or
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
518 @samp{@{}, @ccmode{} instantly reindents the current line. This can
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
519 be disconcerting until you get used to it. To disable @dfn{electric
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
520 indentation} in the current buffer, type @kbd{C-c C-l}. Type the same
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
521 thing to enable it again. To have electric indentation disabled by
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
522 default, put the following into your @file{.emacs} file@footnote{There
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
523 is no ``easy customization'' facility for making this change.}:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
524
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
525 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
526 (setq-default c-electric-flag nil)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
527 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
528
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
529 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
530 Details of this and other similar ``Minor Modes'' appear in the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
531 section @ref{Minor Modes}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
532
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
533 @item Making the @key{RET} key indent the new line
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
534 The standard Emacs binding for @key{RET} just adds a new line. If you
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
535 want it to reindent the new line as well, rebind the key. Note that
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
536 the action of rebinding would fail if the pertinent keymap didn't yet
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
537 exist---we thus need to delay the action until after @ccmode{} has
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
538 been loaded. Put the following code into your @file{.emacs}:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
539
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
540 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
541 (defun my-make-CR-do-indent ()
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
542 (define-key c-mode-base-map "\C-m" 'c-context-line-break))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
543 (add-hook 'c-initialization-hook 'my-make-CR-do-indent)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
544 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
545
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
546 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
547 This example demonstrates the use of a very powerful @ccmode{} (and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
548 Emacs) facility, the hook. The use of @ccmode{}'s hooks is described
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
549 in @ref{CC Hooks}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
550 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
551
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
552 All these settings should occur in your @file{.emacs} @emph{before}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
553 any @ccmode{} buffers get loaded---in particular, before any call of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
554 @code{desktop-read}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
555
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
556 As you get to know the mode better, you may want to make more
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
557 ambitious changes to your configuration. For this, you should start
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
558 reading the chapter @ref{Config Basics}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
559
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
560 If you are upgrading an existing @ccmode{} installation, please see
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
561 the @file{README} file for installation details. In particular, if
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
562 you are going to be editing AWK files, @file{README} describes how to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
563 configure your (X)Emacs so that @ccmode{} will supersede the obsolete
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
564 @code{awk-mode.el} which might have been supplied with your (X)Emacs.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
565 @ccmode{} might not work with older versions of Emacs or XEmacs. See
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
566 the @ccmode{} release notes at @uref{http://cc-mode.sourceforge.net}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
567 for the latest information on Emacs version and package compatibility
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
568 (@pxref{Updating CC Mode}).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
569
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
570 @deffn Command c-version
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
571 @findex version (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
572 You can find out what version of @ccmode{} you are using by visiting a C
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
573 file and entering @kbd{M-x c-version RET}. You should see this message in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
574 the echo area:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
575
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
576 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
577 Using CC Mode version 5.XX
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
578 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
579
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
580 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
581 where @samp{XX} is the minor release number.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
582 @end deffn
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
583
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
584 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
585 @node Commands, Font Locking, Getting Started, Top
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
586 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
587 @chapter Commands
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
588 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
589
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
590 This chapter specifies all of CC Mode's commands, and thus contains
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
591 nearly everything you need to know to @emph{use} @ccmode{} (as
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
592 contrasted with configuring it). @dfn{Commands} here means both
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
593 control key sequences and @dfn{electric keys}, these being characters
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
594 such as @samp{;} which, as well as inserting themselves into the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
595 buffer, also do other things.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
596
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
597 You might well want to review
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
598 @ifset XEMACS
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
599 @ref{Lists,,,@emacsman{}, @emacsmantitle{}},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
600 @end ifset
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
601 @ifclear XEMACS
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
602 @ref{Moving by Parens,,,@emacsman{}, @emacsmantitle{}},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
603 @end ifclear
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
604 which describes commands for moving around brace and parenthesis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
605 structures.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
606
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
607
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
608 @menu
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
609 * Indentation Commands::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
610 * Comment Commands::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
611 * Movement Commands::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
612 * Filling and Breaking::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
613 * Minor Modes::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
614 * Electric Keys::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
615 * Auto-newlines::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
616 * Hungry WS Deletion::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
617 * Subword Movement::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
618 * Other Commands::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
619 @end menu
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
620
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
621 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
622 @node Indentation Commands, Comment Commands, Commands, Commands
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
623 @comment node-name, next, previous,up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
624 @section Indentation Commands
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
625 @cindex indentation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
626 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
627
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
628 The following commands reindent C constructs. Note that when you
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
629 change your coding style, either interactively or through some other
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
630 means, your file does @emph{not} automatically get reindented. You
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
631 will need to execute one of the following commands to see the effects
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
632 of your changes.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
633
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
634 @cindex GNU indent program
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
635 Also, variables like @code{c-hanging-*} and @code{c-cleanup-list}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
636 (@pxref{Custom Auto-newlines}) only affect how on-the-fly code is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
637 formatted. Changing the ``hanginess'' of a brace and then
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
638 reindenting, will not move the brace to a different line. For this,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
639 you're better off getting an external program like GNU @code{indent},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
640 which will rearrange brace location, amongst other things.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
641
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
642 Preprocessor directives are handled as syntactic whitespace from other
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
643 code, i.e. they can be interspersed anywhere without affecting the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
644 indentation of the surrounding code, just like comments.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
645
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
646 The code inside macro definitions is, by default, still analyzed
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
647 syntactically so that you get relative indentation there just as you'd
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
648 get if the same code was outside a macro. However, since there is no
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
649 hint about the syntactic context, i.e. whether the macro expands to an
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
650 expression, to some statements, or perhaps to whole functions, the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
651 syntactic recognition can be wrong. @ccmode{} manages to figure it
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
652 out correctly most of the time, though.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
653
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
654 Reindenting large sections of code can take a long time. When
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
655 @ccmode{} reindents a region of code, it is essentially equivalent to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
656 hitting @key{TAB} on every line of the region.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
657
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
658 These commands indent code:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
659
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
660 @table @asis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
661 @item @kbd{@key{TAB}} (@code{c-indent-command})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
662 @kindex TAB
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
663 @findex c-indent-command
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
664 @findex indent-command (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
665 This command indents the current line. That is all you need to know
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
666 about it for normal use.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
667
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
668 @code{c-indent-command} does different things, depending on the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
669 setting of @code{c-syntactic-indentation} (@pxref{Indentation Engine
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
670 Basics}):
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
671
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
672 @itemize @bullet
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
673 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
674 When it's non-@code{nil} (which it normally is), the command indents
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
675 the line according to its syntactic context. With a prefix argument
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
676 (@kbd{C-u @key{TAB}}), it will re-indent the entire
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
677 expression@footnote{this is only useful for a line starting with a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
678 comment opener or an opening brace, parenthesis, or string quote.}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
679 that begins at the line's left margin.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
680
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
681 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
682 When it's @code{nil}, the command indents the line by an extra
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
683 @code{c-basic-offset} columns. A prefix argument acts as a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
684 multiplier. A bare prefix (@kbd{C-u @key{TAB}}) is equivalent to -1,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
685 removing @code{c-basic-offset} columns from the indentation.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
686 @end itemize
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
687
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
688 The precise behavior is modified by several variables: With
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
689 @code{c-tab-always-indent}, you can make @key{TAB} insert whitespace
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
690 in some circumstances---@code{c-insert-tab-function} then defines
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
691 precisely what sort of ``whitespace'' this will be. Set the standard
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
692 Emacs variable @code{indent-tabs-mode} to @code{t} if you want real
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
693 @samp{tab} characters to be used in the indentation, to @code{nil} if
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
694 you want only spaces. @xref{Just Spaces,,, @emacsman{},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
695 @emacsmantitle{}}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
696
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
697 @defopt c-tab-always-indent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
698 @vindex tab-always-indent (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
699 @cindex literal
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
700 This variable modifies how @key{TAB} operates.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
701 @itemize @bullet
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
702 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
703 When it is @code{t} (the default), @key{TAB} simply indents the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
704 current line.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
705 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
706 When it is @code{nil}, @key{TAB} (re)indents the line only if point is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
707 to the left of the first non-whitespace character on the line.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
708 Otherwise it inserts some whitespace (a tab or an equivalent number of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
709 spaces - see below) at point.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
710 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
711 With some other value, the line is reindented. Additionally, if point
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
712 is within a string or comment, some whitespace is inserted.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
713 @end itemize
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
714 @end defopt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
715
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
716 @defopt c-insert-tab-function
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
717 @vindex insert-tab-function (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
718 @findex tab-to-tab-stop
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
719 When ``some whitespace'' is inserted as described above, what actually
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
720 happens is that the function stored in @code{c-insert-tab-function} is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
721 called. Normally, this is @code{insert-tab}, which inserts a real tab
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
722 character or the equivalent number of spaces (depending on
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
723 @code{indent-tabs-mode}). Some people, however, set
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
724 @code{c-insert-tab-function} to @code{tab-to-tab-stop} so as to get
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
725 hard tab stops when indenting.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
726 @end defopt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
727 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
728
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
729 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
730 The kind of indentation the next five commands do depends on the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
731 setting of @code{c-syntactic-indentation} (@pxref{Indentation Engine
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
732 Basics}):
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
733 @itemize @bullet
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
734 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
735 when it is non-@code{nil} (the default), the commands indent lines
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
736 according to their syntactic context;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
737 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
738 when it is @code{nil}, they just indent each line the same amount as
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
739 the previous non-blank line. The commands that indent a region aren't
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
740 very useful in this case.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
741 @end itemize
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
742
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
743 @table @asis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
744 @item @kbd{C-j} (@code{newline-and-indent})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
745 @kindex C-j
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
746 @findex newline-and-indent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
747 Inserts a newline and indents the new blank line, ready to start
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
748 typing. This is a standard (X)Emacs command.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
749
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
750 @item @kbd{C-M-q} (@code{c-indent-exp})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
751 @kindex C-M-q
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
752 @findex c-indent-exp
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
753 @findex indent-exp (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
754 Indents an entire balanced brace or parenthesis expression. Note that
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
755 point must be on the opening brace or parenthesis of the expression
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
756 you want to indent.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
757
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
758 @item @kbd{C-c C-q} (@code{c-indent-defun})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
759 @kindex C-c C-q
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
760 @findex c-indent-defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
761 @findex indent-defun (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
762 Indents the entire top-level function, class or macro definition
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
763 encompassing point. It leaves point unchanged. This function can't be
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
764 used to reindent a nested brace construct, such as a nested class or
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
765 function, or a Java method. The top-level construct being reindented
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
766 must be complete, i.e. it must have both a beginning brace and an ending
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
767 brace.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
768
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
769 @item @kbd{C-M-\} (@code{indent-region})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
770 @kindex C-M-\
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
771 @findex indent-region
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
772 Indents an arbitrary region of code. This is a standard Emacs command,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
773 tailored for C code in a @ccmode{} buffer. Note, of course, that point
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
774 and mark must delineate the region you want to indent.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
775
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
776 @item @kbd{C-M-h} (@code{c-mark-function})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
777 @kindex C-M-h
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
778 @findex c-mark-function
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
779 @findex mark-function (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
780 While not strictly an indentation command, this is useful for marking
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
781 the current top-level function or class definition as the current
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
782 region. As with @code{c-indent-defun}, this command operates on
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
783 top-level constructs, and can't be used to mark say, a Java method.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
784 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
785
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
786 These variables are also useful when indenting code:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
787
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
788 @defopt indent-tabs-mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
789 This is a standard Emacs variable that controls how line indentation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
790 is composed. When it's non-@code{nil}, tabs can be used in a line's
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
791 indentation, otherwise only spaces are used.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
792 @end defopt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
793
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
794 @defopt c-progress-interval
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
795 @vindex progress-interval (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
796 When indenting large regions of code, this variable controls how often a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
797 progress message is displayed. Set this variable to @code{nil} to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
798 inhibit the progress messages, or set it to an integer which is how
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
799 often (in seconds) progress messages are to be displayed.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
800 @end defopt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
801
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
802 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
803 @node Comment Commands, Movement Commands, Indentation Commands, Commands
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
804 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
805 @section Comment Commands
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
806 @cindex comments (insertion of)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
807 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
808
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
809 @table @asis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
810 @item @kbd{C-c C-c} (@code{comment-region})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
811 @kindex C-c C-c
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
812 @findex comment-region
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
813 This command comments out the lines that start in the region. With a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
814 negative argument, it does the opposite - it deletes the comment
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
815 delimiters from these lines. @xref{Multi-Line Comments,,, emacs, GNU
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
816 Emacs Manual}, for fuller details. @code{comment-region} isn't
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
817 actually part of @ccmode{} - it is given a @ccmode{} binding for
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
818 convenience.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
819
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
820 @item @kbd{M-;} (@code{comment-dwim} or @code{indent-for-comment} @footnote{The name of this command varies between (X)Emacs versions.})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
821 @kindex M-;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
822 @findex comment-dwim
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
823 @findex indent-for-comment
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
824 Insert a comment at the end of the current line, if none is there
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
825 already. Then reindent the comment according to @code{comment-column}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
826 @ifclear XEMACS
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
827 (@pxref{Options for Comments,,, emacs, GNU Emacs Manual})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
828 @end ifclear
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
829 @ifset XEMACS
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
830 (@pxref{Comments,,, xemacs, XEmacs User's Manual})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
831 @end ifset
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
832 and the variables below. Finally, position the point after the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
833 comment starter. @kbd{C-u M-;} kills any comment on the current line,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
834 together with any whitespace before it. This is a standard Emacs
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
835 command, but @ccmode{} enhances it a bit with two variables:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
836
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
837 @defopt c-indent-comment-alist
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
838 @vindex indent-comment-alist (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
839 @vindex comment-column
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
840 This style variable allows you to vary the column that @kbd{M-;} puts
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
841 the comment at, depending on what sort of code is on the line, and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
842 possibly the indentation of any similar comment on the preceding line.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
843 It is an association list that maps different types of lines to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
844 actions describing how they should be handled. If a certain line type
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
845 isn't present on the list then the line is indented to the column
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
846 specified by @code{comment-column}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
847
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
848 See the documentation string for a full description of this
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
849 variable (use @kbd{C-h v c-indent-comment-alist}).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
850 @end defopt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
851
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
852 @defopt c-indent-comments-syntactically-p
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
853 @vindex indent-comments-syntactically-p (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
854 Normally, when this style variable is @code{nil}, @kbd{M-;} will
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
855 indent comment-only lines according to @code{c-indent-comment-alist},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
856 just as it does with lines where other code precede the comments.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
857 However, if you want it to act just like @key{TAB} for comment-only
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
858 lines you can get that by setting
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
859 @code{c-indent-comments-syntactically-p} to non-@code{nil}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
860
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
861 If @code{c-indent-comments-syntactically-p} is non-@code{nil} then
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
862 @code{c-indent-comment-alist} won't be consulted at all for comment-only
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
863 lines.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
864 @end defopt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
865 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
866
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
867 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
868 @node Movement Commands, Filling and Breaking, Comment Commands, Commands
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
869 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
870 @section Movement Commands
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
871 @cindex movement
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
872 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
873
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
874 @ccmode{} contains some useful commands for moving around in C code.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
875
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
876 @table @asis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
877 @item @kbd{C-M-a} (@code{c-beginning-of-defun})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
878 @itemx @kbd{C-M-e} (@code{c-end-of-defun})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
879 @findex c-beginning-of-defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
880 @findex c-end-of-defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
881
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
882 Move to the beginning or end of the current or next function. Other
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
883 constructs (such as a structs or classes) which have a brace block
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
884 also count as ``functions'' here. To move over several functions, you
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
885 can give these commands a repeat count.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
886
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
887 The start of a function is at its header. The end of the function is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
888 after its closing brace, or after the semicolon of a construct (such
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
889 as a @code{struct}) which doesn't end at the brace. These two
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
890 commands try to leave point at the beginning of a line near the actual
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
891 start or end of the function. This occasionally causes point not to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
892 move at all.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
893
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
894 These functions are analogous to the Emacs built-in commands
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
895 @code{beginning-of-defun} and @code{end-of-defun}, except they
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
896 eliminate the constraint that the top-level opening brace of the defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
897 must be in column zero. See @ref{Defuns,,,@emacsman{},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
898 @emacsmantitle{}}, for more information.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
899
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
900 @item @kbd{C-M-a} (AWK Mode) (@code{c-awk-beginning-of-defun})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
901 @itemx @kbd{C-M-e} (AWK Mode) (@code{c-awk-end-of-defun})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
902 @kindex C-M-a (AWK Mode)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
903 @kindex C-M-e (AWK Mode)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
904 @findex c-awk-beginning-of-defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
905 @findex awk-beginning-of-defun (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
906 @findex c-awk-end-of-defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
907 @findex awk-end-of-defun (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
908 Move to the beginning or end of the current or next AWK defun. These
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
909 commands can take prefix-arguments, their functionality being entirely
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
910 equivalent to @code{beginning-of-defun} and @code{end-of-defun}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
911
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
912 AWK Mode @dfn{defuns} are either pattern/action pairs (either of which
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
913 might be implicit) or user defined functions. Having the @samp{@{} and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
914 @samp{@}} (if there are any) in column zero, as is suggested for some
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
915 modes, is neither necessary nor helpful in AWK mode.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
916
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
917 @item @kbd{M-a} (@code{c-beginning-of-statement})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
918 @itemx @kbd{M-e} (@code{c-end-of-statement})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
919 @kindex M-a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
920 @kindex M-e
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
921 @findex c-beginning-of-statement
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
922 @findex c-end-of-statement
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
923 @findex beginning-of-statement (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
924 @findex end-of-statement (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
925 Move to the beginning or end of the innermost C statement. If point
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
926 is already there, move to the next beginning or end of a statement,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
927 even if that means moving into a block. (Use @kbd{C-M-b} or
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
928 @kbd{C-M-f} to move over a balanced block.) A prefix argument @var{n}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
929 means move over @var{n} statements.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
930
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
931 If point is within or next to a comment or a string which spans more
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
932 than one line, these commands move by sentences instead of statements.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
933
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
934 When called from a program, these functions take three optional
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
935 arguments: the repetition count, a buffer position limit which is the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
936 farthest back to search for the syntactic context, and a flag saying
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
937 whether to do sentence motion in or near comments and multiline
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
938 strings.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
939
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
940 @item @kbd{C-c C-u} (@code{c-up-conditional})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
941 @kindex C-c C-u
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
942 @findex c-up-conditional
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
943 @findex up-conditional (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
944 Move back to the containing preprocessor conditional, leaving the mark
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
945 behind. A prefix argument acts as a repeat count. With a negative
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
946 argument, move forward to the end of the containing preprocessor
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
947 conditional.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
948
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
949 @samp{#elif} is treated like @samp{#else} followed by @samp{#if}, so the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
950 function stops at them when going backward, but not when going
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
951 forward.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
952
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
953 This key sequence is not bound in AWK Mode, which doesn't have
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
954 preprocessor statements.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
955
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
956 @item @kbd{M-x c-up-conditional-with-else}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
957 @findex c-up-conditional-with-else
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
958 @findex up-conditional-with-else (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
959 A variety of @code{c-up-conditional} that also stops at @samp{#else}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
960 lines. Normally those lines are ignored.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
961
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
962 @item @kbd{M-x c-down-conditional}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
963 @findex c-down-conditional
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
964 @findex down-conditional (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
965 Move forward into the next nested preprocessor conditional, leaving
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
966 the mark behind. A prefix argument acts as a repeat count. With a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
967 negative argument, move backward into the previous nested preprocessor
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
968 conditional.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
969
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
970 @samp{#elif} is treated like @samp{#else} followed by @samp{#if}, so the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
971 function stops at them when going forward, but not when going backward.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
972
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
973 @item @kbd{M-x c-down-conditional-with-else}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
974 @findex c-down-conditional-with-else
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
975 @findex down-conditional-with-else (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
976 A variety of @code{c-down-conditional} that also stops at @samp{#else}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
977 lines. Normally those lines are ignored.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
978
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
979 @item @kbd{C-c C-p} (@code{c-backward-conditional})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
980 @itemx @kbd{C-c C-n} (@code{c-forward-conditional})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
981 @kindex C-c C-p
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
982 @kindex C-c C-n
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
983 @findex c-backward-conditional
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
984 @findex c-forward-conditional
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
985 @findex backward-conditional (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
986 @findex forward-conditional (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
987 Move backward or forward across a preprocessor conditional, leaving
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
988 the mark behind. A prefix argument acts as a repeat count. With a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
989 negative argument, move in the opposite direction.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
990
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
991 These key sequences are not bound in AWK Mode, which doesn't have
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
992 preprocessor statements.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
993
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
994 @item @kbd{M-x c-backward-into-nomenclature}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
995 @itemx @kbd{M-x c-forward-into-nomenclature}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
996 @findex c-backward-into-nomenclature
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
997 @findex c-forward-into-nomenclature
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
998 @findex backward-into-nomenclature (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
999 @findex forward-into-nomenclature (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1000 A popular programming style, especially for object-oriented languages
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1001 such as C++ is to write symbols in a mixed case format, where the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1002 first letter of each word is capitalized, and not separated by
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1003 underscores. E.g. @samp{SymbolsWithMixedCaseAndNoUnderlines}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1004
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1005 These commands move backward or forward to the beginning of the next
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1006 capitalized word. With prefix argument @var{n}, move @var{n} times.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1007 If @var{n} is negative, move in the opposite direction.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1008
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1009 Note that these two commands have been superseded by
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1010 @code{c-subword-mode}, which you should use instead. @xref{Subword
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1011 Movement}. They might be removed from a future release of @ccmode{}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1012 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1013
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1014 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1015 @node Filling and Breaking, Minor Modes, Movement Commands, Commands
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1016 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1017 @section Filling and Line Breaking Commands
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1018 @cindex text filling
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1019 @cindex line breaking
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1020 @cindex comment handling
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1021 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1022
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1023 Since there's a lot of normal text in comments and string literals,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1024 @ccmode{} provides features to edit these like in text mode. The goal
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1025 is to do it seamlessly, i.e. you can use auto fill mode, sentence and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1026 paragraph movement, paragraph filling, adaptive filling etc. wherever
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1027 there's a piece of normal text without having to think much about it.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1028 @ccmode{} keeps the indentation, fixes suitable comment line prefixes,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1029 and so on.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1030
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1031 You can configure the exact way comments get filled and broken, and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1032 where Emacs does auto-filling (see @pxref{Custom Filling and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1033 Breaking}). Typically, the style system (@pxref{Styles}) will have
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1034 set this up for you, so you probably won't have to bother.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1035
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1036 @findex auto-fill-mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1037 @cindex Auto Fill mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1038 @cindex paragraph filling
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1039 Line breaks are by default handled (almost) the same regardless of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1040 whether they are made by auto fill mode (@pxref{Auto Fill,,,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1041 @emacsman{}, @emacsmantitle{}}), by paragraph filling (e.g. with
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1042 @kbd{M-q}), or explicitly with @kbd{M-j} or similar methods. In
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1043 string literals, the new line gets the same indentation as the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1044 previous nonempty line.@footnote{You can change this default by
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1045 setting the @code{string} syntactic symbol (@pxref{Syntactic Symbols}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1046 and @pxref{Customizing Indentation})}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1047
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1048 @table @asis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1049 @item @kbd{M-q} (@code{c-fill-paragraph})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1050 @kindex M-q
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1051 @findex c-fill-paragraph
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1052 @findex fill-paragraph (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1053 @cindex Javadoc markup
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1054 @cindex Pike autodoc markup
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1055 This command fills multiline string literals and both block
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1056 and line style comments. In Java buffers, the Javadoc markup words
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1057 are recognized as paragraph starters. The line oriented Pike autodoc
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1058 markup words are recognized in the same way in Pike mode.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1059
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1060 The formatting of the starters (@code{/*}) and enders (@code{*/}) of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1061 block comments are kept as they were before the filling. I.e., if
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1062 either the starter or ender were on a line of its own, then it stays
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1063 on its own line; conversely, if the delimiter has comment text on its
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1064 line, it keeps at least one word of that text with it on the line.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1065
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1066 This command is the replacement for @code{fill-paragraph} in @ccmode{}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1067 buffers.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1068
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1069 @item @kbd{M-j} (@code{c-indent-new-comment-line})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1070 @kindex M-j
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1071 @findex c-indent-new-comment-line
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1072 @findex indent-new-comment-line (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1073 This breaks the current line at point and indents the new line. If
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1074 point was in a comment, the new line gets the proper comment line
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1075 prefix. If point was inside a macro, a backslash is inserted before
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1076 the line break. It is the replacement for
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1077 @code{indent-new-comment-line}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1078
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1079 @item @kbd{M-x c-context-line-break}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1080 @findex c-context-line-break
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1081 @findex context-line-break (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1082 Insert a line break suitable to the context: If the point is inside a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1083 comment, the new line gets the suitable indentation and comment line
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1084 prefix like @code{c-indent-new-comment-line}. In normal code it's
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1085 indented like @code{newline-and-indent} would do. In macros it acts
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1086 like @code{newline-and-indent} but additionally inserts and optionally
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1087 aligns the line ending backslash so that the macro remains unbroken.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1088 @xref{Custom Macros}, for details about the backslash alignment. In a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1089 string, a backslash is inserted only if the string is within a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1090 macro@footnote{In GCC, unescaped line breaks within strings are
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1091 valid.}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1092
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1093 This function is not bound to a key by default, but it's intended to be
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1094 used on the @kbd{RET} key. If you like the behavior of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1095 @code{newline-and-indent} on @kbd{RET}, you should consider switching to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1096 this function. @xref{Sample .emacs File}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1097
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1098 @item @kbd{M-x c-context-open-line}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1099 @findex c-context-open-line
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1100 @findex context-open-line (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1101 This is to @kbd{C-o} (@kbd{M-x open-line}) as
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1102 @code{c-context-line-break} is to @kbd{RET}. I.e. it works just like
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1103 @code{c-context-line-break} but leaves the point before the inserted
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1104 line break.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1105 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1106
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1107
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1108 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1109 @node Minor Modes, Electric Keys, Filling and Breaking, Commands
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1110 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1111 @section Minor Modes
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1112 @cindex Minor Modes
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1113 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1114
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1115 @ccmode{} contains several minor-mode-like features that you might
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1116 find useful while writing new code or editing old code:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1117
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1118 @table @asis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1119 @item electric mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1120 When this is enabled, certain visible characters cause reformatting as
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1121 they are typed. This is normally helpful, but can be a nuisance when
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1122 editing chaotically formatted code. It can also be disconcerting,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1123 especially for users who are new to @ccmode{}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1124 @item auto-newline mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1125 This automatically inserts newlines where you'd probably want to type
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1126 them yourself, e.g. after typing @samp{@}}s. Its action is suppressed
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1127 when electric mode is disabled.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1128 @item hungry-delete mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1129 This lets you delete a contiguous block of whitespace with a single
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1130 key - for example, the newline and indentation just inserted by
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1131 auto-newline when you want to back up and write a comment after the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1132 last statement.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1133 @item subword mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1134 This mode makes basic word movement commands like @kbd{M-f}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1135 (@code{forward-word}) and @kbd{M-b} (@code{backward-word}) treat the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1136 parts of sillycapsed symbols as different words.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1137 E.g. @samp{NSGraphicsContext} is treated as three words @samp{NS},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1138 @samp{Graphics}, and @samp{Context}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1139 @item syntactic-indentation mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1140 When this is enabled (which it normally is), indentation commands such
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1141 as @kbd{C-j} indent lines of code according to their syntactic
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1142 structure. Otherwise, a line is simply indented to the same level as
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1143 the previous one and @kbd{@key{TAB}} adjusts the indentation in steps
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1144 of `c-basic-offset'.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1145 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1146
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1147 Full details on how these minor modes work are at @ref{Electric Keys},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1148 @ref{Auto-newlines}, @ref{Hungry WS Deletion}, @ref{Subword Movement},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1149 and @ref{Indentation Engine Basics}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1150
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1151 You can toggle each of these minor modes on and off, and you can
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1152 configure @ccmode{} so that it starts up with your favourite
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1153 combination of them (@pxref{Sample .emacs File}). By default, when
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1154 you initialize a buffer, electric mode and syntactic-indentation mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1155 are enabled but the other two modes are disabled.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1156
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1157 @ccmode{} displays the current state of the first four of these minor
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1158 modes on the modeline by appending letters to the major mode's name,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1159 one letter for each enabled minor mode - @samp{l} for electric mode,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1160 @samp{a} for auto-newline mode, @samp{h} for hungry delete mode, and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1161 @samp{w} for subword mode. If all these modes were enabled, you'd see
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1162 @samp{C/lahw}@footnote{The @samp{C} would be replaced with the name of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1163 the language in question for the other languages @ccmode{} supports.}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1164
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1165 Here are the commands to toggle these modes:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1166
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1167 @table @asis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1168 @item @kbd{C-c C-l} (@code{c-toggle-electric-state})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1169 @kindex C-c C-l
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1170 @findex c-toggle-electric-state
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1171 @findex toggle-electric-state (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1172 Toggle electric minor mode. When the command turns the mode off, it
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1173 also suppresses auto-newline mode.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1174
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1175 @item @kbd{C-c C-a} (@code{c-toggle-auto-newline})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1176 @kindex C-c C-a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1177 @findex c-toggle-auto-newline
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1178 @findex toggle-auto-newline (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1179 Toggle auto-newline minor mode. When the command turns the mode on,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1180 it also enables electric minor mode.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1181
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1182 @item @kbd{M-x c-toggle-hungry-state}@footnote{Prior to @ccmode{} 5.31, this command was bound to @kbd{C-c C-d}.}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1183 @findex c-toggle-hungry-state
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1184 @findex toggle-hungry-state (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1185 Toggle hungry-delete minor mode.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1186
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1187 @item @kbd{M-x c-toggle-auto-hungry-state}@footnote{Prior to @ccmode{} 5.31, this command was bound to @kbd{C-c C-t}.}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1188 @findex c-toggle-auto-hungry-state
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1189 @findex toggle-auto-hungry-state (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1190 Toggle both auto-newline and hungry delete minor modes.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1191
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1192 @item @kbd{C-c C-w} (@code{M-x c-subword-mode})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1193 @kindex C-c C-w
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1194 @findex c-subword-mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1195 @findex subword-mode (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1196 Toggle subword mode.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1197
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1198 @item @kbd{M-x c-toggle-syntactic-indentation}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1199 @findex c-toggle-syntactic-indentation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1200 @findex toggle-syntactic-indentation (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1201 Toggle syntactic-indentation mode.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1202 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1203
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1204 Common to all the toggle functions above is that if they are called
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1205 programmatically, they take an optional numerical argument. A
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1206 positive value will turn on the minor mode (or both of them in the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1207 case of @code{c-toggle-auto-hungry-state}) and a negative value will
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1208 turn it (or them) off.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1209
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1210
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1211 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1212 @node Electric Keys, Auto-newlines, Minor Modes, Commands
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1213 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1214 @section Electric Keys and Keywords
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1215 @cindex electric characters
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1216 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1217
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1218 Most punctuation keys provide @dfn{electric} behavior - as well as
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1219 inserting themselves they perform some other action, such as
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1220 reindenting the line. This reindentation saves you from having to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1221 reindent a line manually after typing, say, a @samp{@}}. A few
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1222 keywords, such as @code{else}, also trigger electric action.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1223
86093
d223d695f3f3 (Electric Keys, Electric Keys, Custom Macros): Fix typos.
Juanma Barranquero <lekktu@gmail.com>
parents: 85173
diff changeset
1224 You can inhibit the electric behavior described here by disabling
84286
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1225 electric minor mode (@pxref{Minor Modes}).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1226
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1227 Common to all these keys is that they only behave electrically when
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1228 used in normal code (as contrasted with getting typed in a string
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1229 literal or comment). Those which cause re-indentation do so only when
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1230 @code{c-syntactic-indentation} has a non-@code{nil} value (which it
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1231 does by default).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1232
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1233 These keys and keywords are:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1234 @c ACM, 2004/8/24: c-electric-pound doesn't check c-s-i: this is more
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1235 @c like a bug in the code than a bug in this document. It'll get
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1236 @c fixed in the code sometime.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1237
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1238 @table @kbd
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1239 @item #
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1240 @kindex #
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1241 @findex c-electric-pound
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1242 @findex electric-pound (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1243 @vindex c-electric-pound-behavior
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1244 @vindex electric-pound-behavior (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1245 Pound (bound to @code{c-electric-pound}) is electric when typed as the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1246 first non-whitespace character on a line and not within a macro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1247 definition. In this case, the variable @code{c-electric-pound-behavior}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1248 is consulted for the electric behavior. This variable takes a list
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1249 value, although the only element currently defined is @code{alignleft},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1250 which tells this command to force the @samp{#} character into column
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1251 zero. This is useful for entering preprocessor macro definitions.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1252
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1253 Pound is not electric in AWK buffers, where @samp{#} starts a comment,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1254 and is bound to @code{self-insert-command} like any typical printable
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1255 character.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1256 @c ACM, 2004/8/24: Change this (and the code) to do AWK comment
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1257 @c reindentation.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1258
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1259 @item *
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1260 @kindex *
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1261 @itemx /
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1262 @kindex /
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1263 @findex c-electric-star
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1264 @findex electric-star (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1265 @findex c-electric-slash
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1266 @findex electric-slash (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1267 A star (bound to @code{c-electric-star}) or a slash
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1268 (@code{c-electric-slash}) causes reindentation when you type it as the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1269 second component of a C style block comment opener (@samp{/*}) or a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1270 C++ line comment opener (@samp{//}) respectively, but only if the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1271 comment opener is the first thing on the line (i.e. there's only
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1272 whitespace before it).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1273
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1274 Additionally, you can configure @ccmode{} so that typing a slash at
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1275 the start of a line within a block comment will terminate the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1276 comment. You don't need to have electric minor mode enabled to get
86093
d223d695f3f3 (Electric Keys, Electric Keys, Custom Macros): Fix typos.
Juanma Barranquero <lekktu@gmail.com>
parents: 85173
diff changeset
1277 this behavior. @xref{Clean-ups}.
84286
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1278
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1279 In AWK mode, @samp{*} and @samp{/} do not delimit comments and are not
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1280 electric.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1281
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1282 @item <
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1283 @kindex <
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1284 @itemx >
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1285 @kindex >
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1286 @findex c-electric-lt-gt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1287 @findex electric-lt-gt (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1288 A less-than or greater-than sign (bound to @code{c-electric-lt-gt}) is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1289 electric in two circumstances: when it is an angle bracket in a C++
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1290 @samp{template} declaration (and similar constructs in other
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1291 languages) and when it is the second of two @kbd{<} or @kbd{>}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1292 characters in a C++ style stream operator. In either case, the line
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1293 is reindented. Angle brackets in C @samp{#include} directives are not
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1294 electric.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1295
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1296 @item (
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1297 @kindex (
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1298 @itemx )
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1299 @kindex )
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1300 @findex c-electric-paren
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1301 @findex electric-paren (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1302 The normal parenthesis characters @samp{(} and @samp{)} (bound to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1303 @code{c-electric-paren}) reindent the current line. This is useful
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1304 for getting the closing parenthesis of an argument list aligned
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1305 automatically.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1306
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1307 You can also configure @ccmode{} to insert a space automatically
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1308 between a function name and the @samp{(} you've just typed, and to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1309 remove it automatically after typing @samp{)}, should the argument
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1310 list be empty. You don't need to have electric minor mode enabled to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1311 get these actions. @xref{Clean-ups}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1312
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1313 @item @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1314 @kindex @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1315 @itemx @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1316 @kindex @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1317 @findex c-electric-brace
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1318 @findex electric-brace (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1319 Typing a brace (bound to @code{c-electric-brace}) reindents the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1320 current line. Also, one or more newlines might be inserted if
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1321 auto-newline minor mode is enabled. @xref{Auto-newlines}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1322 Additionally, you can configure @ccmode{} to compact excess whitespace
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1323 inserted by auto-newline mode in certain circumstances.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1324 @xref{Clean-ups}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1325
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1326 @item :
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1327 @kindex :
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1328 @findex c-electric-colon
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1329 @findex electric-colon (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1330 Typing a colon (bound to @code{c-electric-colon}) reindents the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1331 current line. Additionally, one or more newlines might be inserted if
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1332 auto-newline minor mode is enabled. @xref{Auto-newlines}. If you
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1333 type a second colon immediately after such an auto-newline, by default
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1334 the whitespace between the two colons is removed, leaving a C++ scope
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1335 operator. @xref{Clean-ups}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1336
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1337 If you prefer, you can insert @samp{::} in a single operation,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1338 avoiding all these spurious reindentations, newlines, and clean-ups.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1339 @xref{Other Commands}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1340
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1341 @item ;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1342 @kindex ;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1343 @itemx ,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1344 @kindex ,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1345 @findex c-electric-semi&comma
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1346 @findex electric-semi&comma (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1347 Typing a semicolon or comma (bound to @code{c-electric-semi&comma})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1348 reindents the current line. Also, a newline might be inserted if
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1349 auto-newline minor mode is enabled. @xref{Auto-newlines}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1350 Additionally, you can configure @ccmode{} so that when auto-newline
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1351 has inserted whitespace after a @samp{@}}, it will be removed again
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1352 when you type a semicolon or comma just after it. @xref{Clean-ups}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1353
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1354 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1355
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1356 @deffn Command c-electric-continued-statement
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1357 @findex electric-continued-statement (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1358
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1359 Certain keywords are electric, causing reindentation when they are
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1360 preceded only by whitespace on the line. The keywords are those that
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1361 continue an earlier statement instead of starting a new one:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1362 @code{else}, @code{while}, @code{catch} (only in C++ and Java) and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1363 @code{finally} (only in Java).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1364
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1365 An example:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1366
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1367 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1368 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1369 for (i = 0; i < 17; i++)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1370 if (a[i])
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1371 res += a[i]->offset;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1372 else
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1373 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1374 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1375
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1376 Here, the @code{else} should be indented like the preceding @code{if},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1377 since it continues that statement. @ccmode{} will automatically
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1378 reindent it after the @code{else} has been typed in full, since only
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1379 then is it possible to decide whether it's a new statement or a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1380 continuation of the preceding @code{if}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1381
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1382 @vindex abbrev-mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1383 @findex abbrev-mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1384 @cindex Abbrev mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1385 @ccmode{} uses Abbrev mode (@pxref{Abbrevs,,, @emacsman{}, @emacsmantitle{}})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1386 to accomplish this. It's therefore turned on by default in all language
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1387 modes except IDL mode, since CORBA IDL doesn't have any statements.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1388 @end deffn
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1389
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1390
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1391 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1392 @node Auto-newlines, Hungry WS Deletion, Electric Keys, Commands
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1393 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1394 @section Auto-newline Insertion
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1395 @cindex auto-newline
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1396 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1397
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1398 When you have @dfn{Auto-newline minor mode} enabled (@pxref{Minor
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1399 Modes}), @ccmode{} inserts newlines for you automatically (in certain
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1400 syntactic contexts) when you type a left or right brace, a colon, a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1401 semicolon, or a comma. Sometimes a newline appears before the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1402 character you type, sometimes after it, sometimes both.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1403
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1404 Auto-newline only triggers when the following conditions hold:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1405
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1406 @itemize @bullet
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1407 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1408 Auto-newline minor mode is enabled, as evidenced by the indicator
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1409 @samp{a} after the mode name on the modeline (e.g. @samp{C/a} or
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1410 @samp{C/la}).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1411
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1412 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1413 The character was typed at the end of a line, or with only whitespace
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1414 after it, and possibly a @samp{\} escaping the newline.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1415
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1416 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1417 The character is not on its own line already. (This applies only to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1418 insertion of a newline @emph{before} the character.)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1419
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1420 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1421 @cindex literal
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1422 @cindex syntactic whitespace
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1423 The character was not typed inside of a literal @footnote{A
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1424 @dfn{literal} is defined as any comment, string, or preprocessor macro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1425 definition. These constructs are also known as @dfn{syntactic
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1426 whitespace} since they are usually ignored when scanning C code.}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1427
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1428 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1429 No numeric argument was supplied to the command (i.e. it was typed as
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1430 normal, with no @kbd{C-u} prefix).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1431 @end itemize
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1432
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1433 You can configure the precise circumstances in which newlines get
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1434 inserted (see @pxref{Custom Auto-newlines}). Typically, the style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1435 system (@pxref{Styles}) will have set this up for you, so you probably
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1436 won't have to bother.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1437
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1438 Sometimes @ccmode{} inserts an auto-newline where you don't want one,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1439 such as after a @samp{@}} when you're about to type a @samp{;}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1440 Hungry deletion can help here (@pxref{Hungry WS Deletion}), or you can
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1441 activate an appropriate @dfn{clean-up}, which will remove the excess
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1442 whitespace after you've typed the @samp{;}. See @ref{Clean-ups} for a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1443 full description. See also @ref{Electric Keys} for a summary of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1444 clean-ups listed by key.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1445
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1446
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1447 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1448 @node Hungry WS Deletion, Subword Movement, Auto-newlines, Commands
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1449 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1450 @section Hungry Deletion of Whitespace
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1451 @cindex hungry-deletion
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1452 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1453
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1454 If you want to delete an entire block of whitespace at point, you can
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1455 use @dfn{hungry deletion}. This deletes all the contiguous whitespace
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1456 either before point or after point in a single operation.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1457 ``Whitespace'' here includes tabs and newlines, but not comments or
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1458 preprocessor commands. Hungry deletion can markedly cut down on the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1459 number of times you have to hit deletion keys when, for example,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1460 you've made a mistake on the preceding line and have already pressed
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1461 @kbd{C-j}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1462
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1463 Hungry deletion is a simple feature that some people find extremely
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1464 useful. In fact, you might find yourself wanting it in @strong{all}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1465 your editing modes!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1466
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1467 Loosely speaking, in what follows, @dfn{@key{DEL}} means ``the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1468 backspace key'' and @dfn{@key{DELETE}} means ``the forward delete
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1469 key''. This is discussed in more detail below.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1470
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1471 There are two different ways you can use hungry deletion:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1472
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1473 @table @asis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1474 @item Using @dfn{Hungry Delete Mode} with @kbd{@key{DEL}} and @kbd{C-d}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1475 Here you toggle Hungry Delete minor mode with @kbd{M-x
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1476 c-toggle-hungry-state}@footnote{Prior to @ccmode{} 5.31, this command
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1477 was bound to @kbd{C-c C-d}. @kbd{C-c C-d} is now the default binding
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1478 for @code{c-hungry-delete-forward}.} (@pxref{Minor Modes}.) This
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1479 makes @kbd{@key{DEL}} and @kbd{C-d} do backwards and forward hungry
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1480 deletion.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1481
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1482 @table @asis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1483 @item @kbd{@key{DEL}} (@code{c-electric-backspace})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1484 @kindex DEL
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1485 @findex c-electric-backspace
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1486 @findex electric-backspace (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1487 This command is run by default when you hit the @kbd{DEL} key. When
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1488 hungry delete mode is enabled, it deletes any amount of whitespace in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1489 the backwards direction. Otherwise, or when used with a prefix
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1490 argument or in a literal (@pxref{Auto-newlines}), the command just
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1491 deletes backwards in the usual way. (More precisely, it calls the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1492 function contained in the variable @code{c-backspace-function},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1493 passing it the prefix argument, if any.)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1494
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1495 @item @code{c-backspace-function}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1496 @vindex c-backspace-function
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1497 @vindex backspace-function (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1498 @findex backward-delete-char-untabify
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1499 Hook that gets called by @code{c-electric-backspace} when it doesn't
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1500 do an ``electric'' deletion of the preceding whitespace. The default
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1501 value is @code{backward-delete-char-untabify}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1502 (@pxref{Deletion,,,@lispref{}, @lispreftitle{}}, the function which
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1503 deletes a single character.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1504
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1505 @item @kbd{C-d} (@code{c-electric-delete-forward})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1506 @kindex C-d
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1507 @findex c-electric-delete-forward
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1508 @findex electric-delete-forward (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1509 This function, which is bound to @kbd{C-d} by default, works just like
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1510 @code{c-electric-backspace} but in the forward direction. When it
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1511 doesn't do an ``electric'' deletion of the following whitespace, it
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1512 just does @code{delete-char}, more or less. (Strictly speaking, it
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1513 calls the function in @code{c-delete-function} with the prefix
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1514 argument.)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1515
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1516 @item @code{c-delete-function}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1517 @vindex c-delete-function
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1518 @vindex delete-function (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1519 @findex delete-char
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1520 Hook that gets called by @code{c-electric-delete-forward} when it
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1521 doesn't do an ``electric'' deletion of the following whitespace. The
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1522 default value is @code{delete-char}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1523 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1524
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1525 @item Using Distinct Bindings
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1526 The other (newer and recommended) way to use hungry deletion is to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1527 perform @code{c-hungry-delete-backwards} and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1528 @code{c-hungry-delete-forward} directly through their key sequences
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1529 rather than using the minor mode toggling.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1530
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1531 @table @asis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1532 @item @kbd{C-c C-@key{DEL}}, or @kbd{C-c @key{DEL}} (@code{c-hungry-delete-backwards})@footnote{This command was formerly known as @code{c-hungry-backspace}.}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1533 @kindex C-c C-<backspace>
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1534 @kindex C-c <backspace>
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1535 @kindex C-c C-DEL
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1536 @kindex C-c DEL
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1537 @findex c-hungry-delete-backwards
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1538 @findex hungry-delete-backwards (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1539 Delete any amount of whitespace in the backwards direction (regardless
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1540 whether hungry-delete mode is enabled or not). This command is bound
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1541 to both @kbd{C-c C-@key{DEL}} and @kbd{C-c @key{DEL}}, since the more
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1542 natural one, @kbd{C-c C-@key{DEL}}, is sometimes difficult to type at
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1543 a character terminal.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1544
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1545 @item @kbd{C-c C-d}, @kbd{C-c C-@key{DELETE}}, or @kbd{C-c @key{DELETE}} (@code{c-hungry-delete-forward})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1546 @kindex C-c C-d
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1547 @kindex C-c C-<DELETE>
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1548 @kindex C-c <DELETE>
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1549 @findex c-hungry-delete-forward
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1550 @findex hungry-delete-forward (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1551 Delete any amount of whitespace in the forward direction (regardless
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1552 whether hungry-delete mode is enabled or not). This command is bound
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1553 to both @kbd{C-c C-@key{DELETE}} and @kbd{C-c @key{DELETE}} for the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1554 same reason as for @key{DEL} above.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1555 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1556 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1557
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1558 @kindex <delete>
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1559 @kindex <backspace>
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1560
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1561 When we talk about @kbd{@key{DEL}}, and @kbd{@key{DELETE}} above, we
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1562 actually do so without connecting them to the physical keys commonly
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1563 known as @key{Backspace} and @key{Delete}. The default bindings to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1564 those two keys depends on the flavor of (X)Emacs you are using.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1565
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1566 @findex c-electric-delete
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1567 @findex electric-delete (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1568 @findex c-hungry-delete
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1569 @findex hungry-delete (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1570 @vindex delete-key-deletes-forward
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1571 In XEmacs 20.3 and beyond, the @key{Backspace} key is bound to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1572 @code{c-electric-backspace} and the @key{Delete} key is bound to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1573 @code{c-electric-delete}. You control the direction it deletes in by
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1574 setting the variable @code{delete-key-deletes-forward}, a standard
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1575 XEmacs variable.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1576 @c This variable is encapsulated by XEmacs's (defsubst delete-forward-p ...).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1577 When this variable is non-@code{nil}, @code{c-electric-delete} will do
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1578 forward deletion with @code{c-electric-delete-forward}, otherwise it
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1579 does backward deletion with @code{c-electric-backspace}. Similarly,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1580 @kbd{C-c @key{Delete}} and @kbd{C-c C-@key{Delete}} are bound to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1581 @code{c-hungry-delete} which is controlled in the same way by
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1582 @code{delete-key-deletes-forward}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1583
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1584 @findex normal-erase-is-backspace-mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1585
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1586 Emacs 21 and later automatically binds @key{Backspace} and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1587 @key{Delete} to @kbd{DEL} and @kbd{C-d} according to your environment,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1588 and @ccmode{} extends those bindings to @kbd{C-c C-@key{Backspace}}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1589 etc. If you need to change the bindings through
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1590 @code{normal-erase-is-backspace-mode} then @ccmode{} will also adapt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1591 its extended bindings accordingly.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1592
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1593 In earlier (X)Emacs versions, @ccmode{} doesn't bind either
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1594 @key{Backspace} or @key{Delete} directly. Only the key codes
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1595 @kbd{DEL} and @kbd{C-d} are bound, and it's up to the default bindings
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1596 to map the physical keys to them. You might need to modify this
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1597 yourself if the defaults are unsuitable.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1598
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1599 Getting your @key{Backspace} and @key{Delete} keys properly set up can
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1600 sometimes be tricky. The information in @ref{DEL Does Not
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1601 Delete,,,emacs, GNU Emacs Manual}, might be helpful if you're having
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1602 trouble with this in GNU Emacs.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1603
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1604
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1605 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1606 @node Subword Movement, Other Commands, Hungry WS Deletion, Commands
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1607 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1608 @section Subword Movement and Editing
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1609 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1610
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1611 @cindex nomenclature
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1612 @cindex subword
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1613 In spite of the GNU Coding Standards, it is popular to name a symbol
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1614 by mixing uppercase and lowercase letters, e.g. @samp{GtkWidget},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1615 @samp{EmacsFrameClass}, or @samp{NSGraphicsContext}. Here we call
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1616 these mixed case symbols @dfn{nomenclatures}. Also, each capitalized
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1617 (or completely uppercase) part of a nomenclature is called a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1618 @dfn{subword}. Here are some examples:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1619
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1620 @multitable {@samp{NSGraphicsContext}} {@samp{NS}, @samp{Graphics}, and @samp{Context}}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1621 @c This could be converted to @headitem when we require Texinfo 4.7
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1622 @iftex
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1623 @item @b{Nomenclature}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1624 @tab @b{Subwords}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1625 @end iftex
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1626 @ifnottex
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1627 @item Nomenclature
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1628 @tab Subwords
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1629 @item ---------------------------------------------------------
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1630 @end ifnottex
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1631 @item @samp{GtkWindow}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1632 @tab @samp{Gtk} and @samp{Window}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1633 @item @samp{EmacsFrameClass}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1634 @tab @samp{Emacs}, @samp{Frame}, and @samp{Class}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1635 @item @samp{NSGraphicsContext}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1636 @tab @samp{NS}, @samp{Graphics}, and @samp{Context}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1637 @end multitable
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1638
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1639 The subword minor mode replaces the basic word oriented movement and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1640 editing commands with variants that recognize subwords in a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1641 nomenclature and treat them as separate words:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1642
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1643 @findex c-forward-subword
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1644 @findex forward-subword (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1645 @findex c-backward-subword
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1646 @findex backward-subword (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1647 @findex c-mark-subword
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1648 @findex mark-subword (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1649 @findex c-kill-subword
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1650 @findex kill-subword (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1651 @findex c-backward-kill-subword
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1652 @findex backward-kill-subword (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1653 @findex c-transpose-subwords
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1654 @findex transpose-subwords (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1655 @findex c-capitalize-subword
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1656 @findex capitalize-subword (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1657 @findex c-upcase-subword
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1658 @findex upcase-subword (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1659 @findex c-downcase-subword
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1660 @findex downcase-subword (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1661 @multitable @columnfractions .20 .40 .40
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1662 @c This could be converted to @headitem when we require Texinfo 4.7
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1663 @iftex
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1664 @item @b{Key} @tab @b{Word oriented command} @tab @b{Subword oriented command}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1665 @end iftex
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1666 @ifnottex
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1667 @item Key @tab Word oriented command @tab Subword oriented command
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1668 @item ----------------------------------------------------------------------------
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1669 @end ifnottex
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1670 @item @kbd{M-f} @tab @code{forward-word} @tab @code{c-forward-subword}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1671 @item @kbd{M-b} @tab @code{backward-word} @tab @code{c-backward-subword}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1672 @item @kbd{M-@@} @tab @code{mark-word} @tab @code{c-mark-subword}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1673 @item @kbd{M-d} @tab @code{kill-word} @tab @code{c-kill-subword}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1674 @item @kbd{M-DEL} @tab @code{backward-kill-word} @tab @code{c-backward-kill-subword}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1675 @item @kbd{M-t} @tab @code{transpose-words} @tab @code{c-transpose-subwords}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1676 @item @kbd{M-c} @tab @code{capitalize-word} @tab @code{c-capitalize-subword}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1677 @item @kbd{M-u} @tab @code{upcase-word} @tab @code{c-upcase-subword}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1678 @item @kbd{M-l} @tab @code{downcase-word} @tab @code{c-downcase-subword}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1679 @end multitable
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1680
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1681 Note that if you have changed the key bindings for the word oriented
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1682 commands in your @file{.emacs} or a similar place, the keys you have
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1683 configured are also used for the corresponding subword oriented
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1684 commands.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1685
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1686 Type @kbd{C-c C-w} to toggle subword mode on and off. To make the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1687 mode turn on automatically, put the following code in your
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1688 @file{.emacs}:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1689
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1690 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1691 (add-hook 'c-mode-common-hook
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1692 (lambda () (c-subword-mode 1)))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1693 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1694
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1695 As a bonus, you can also use @code{c-subword-mode} in non-@ccmode{}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1696 buffers by typing @kbd{M-x c-subword-mode}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1697
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1698 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1699 @node Other Commands, , Subword Movement, Commands
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1700 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1701 @section Other Commands
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1702 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1703
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1704 Here are the various other commands that didn't fit anywhere else:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1705
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1706 @table @asis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1707 @item @kbd{C-c .} (@code{c-set-style})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1708 @kindex C-c .
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1709 @findex c-set-style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1710 @findex set-style (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1711 Switch to the specified style in the current buffer. Use like this:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1712
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1713 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1714 @kbd{C-c . @var{style-name} @key{RET}}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1715 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1716
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1717 You can use the @key{TAB} in the normal way to do completion on the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1718 style name. Note that all style names are case insensitive, even the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1719 ones you define yourself.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1720
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1721 Setting a style in this way does @emph{not} automatically reindent your
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1722 file. For commands that you can use to view the effect of your changes,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1723 see @ref{Indentation Commands} and @ref{Filling and Breaking}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1724
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1725 For details of the @ccmode{} style system, see @ref{Styles}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1726 @item @kbd{C-c :} (@code{c-scope-operator})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1727 @kindex C-c :
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1728 @findex c-scope-operator
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1729 @findex scope-operator (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1730 In C++, it is also sometimes desirable to insert the double-colon scope
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1731 operator without performing the electric behavior of colon insertion.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1732 @kbd{C-c :} does just this.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1733
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1734 @item @kbd{C-c C-\} (@code{c-backslash-region})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1735 @kindex C-c C-\
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1736 @findex c-backslash-region
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1737 @findex backslash-region (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1738 This function inserts and aligns or deletes end-of-line backslashes in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1739 the current region. These are typically used in multi-line macros.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1740
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1741 With no prefix argument, it inserts any missing backslashes and aligns
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1742 them according to the @code{c-backslash-column} and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1743 @code{c-backslash-max-column} variables. With a prefix argument, it
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1744 deletes any backslashes.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1745
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1746 The function does not modify blank lines at the start of the region. If
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1747 the region ends at the start of a line, it always deletes the backslash
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1748 (if any) at the end of the previous line.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1749
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1750 To customize the precise workings of this command, @ref{Custom Macros}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1751 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1752
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1753 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1754 The recommended line breaking function, @code{c-context-line-break}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1755 (@pxref{Filling and Breaking}), is especially nice if you edit
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1756 multiline macros frequently. When used inside a macro, it
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1757 automatically inserts and adjusts the mandatory backslash at the end
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1758 of the line to keep the macro together, and it leaves the point at the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1759 right indentation column for the code. Thus you can write code inside
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1760 macros almost exactly as you can elsewhere, without having to bother
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1761 with the trailing backslashes.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1762
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1763 @table @asis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1764 @item @kbd{C-c C-e} (@code{c-macro-expand})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1765 @kindex C-c C-e
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1766 @findex c-macro-expand
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1767 @findex macro-expand (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1768 This command expands C, C++, Objective C or Pike macros in the region,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1769 using an appropriate external preprocessor program. Normally it
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1770 displays its output in a temporary buffer, but if you give it a prefix
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1771 arg (with @kbd{C-u C-c C-e}) it will overwrite the original region
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1772 with the expansion.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1773
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1774 The command does not work in any of the other modes, and the key
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1775 sequence is not bound in these other modes.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1776
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1777 @code{c-macro-expand} isn't actually part of @ccmode{}, even though it
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1778 is bound to a @ccmode{} key sequence. If you need help setting it up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1779 or have other problems with it, you can either read its source code or
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1780 ask for help in the standard (X)Emacs forums.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1781 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1782
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1783 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1784 @node Font Locking, Config Basics, Commands, Top
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1785 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1786 @chapter Font Locking
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1787 @cindex font locking
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1788 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1789
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1790 @cindex Font Lock mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1791
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1792 @ccmode{} provides font locking for its supported languages by
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1793 supplying patterns for use with Font Lock mode. This means that you
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1794 get distinct faces on the various syntactic parts such as comments,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1795 strings, keywords and types, which is very helpful in telling them
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1796 apart at a glance and discovering syntactic errors. @xref{Font
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1797 Lock,,, emacs, GNU Emacs Manual}, for ways to enable font locking in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1798 @ccmode{} buffers.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1799
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1800 @strong{Please note:} The font locking in AWK mode is currently not
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1801 integrated with the rest of @ccmode{}. Only the last section of this
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1802 chapter, @ref{AWK Mode Font Locking}, applies to AWK. The other
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1803 sections apply to the other languages.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1804
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1805 @menu
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1806 * Font Locking Preliminaries::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1807 * Faces::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1808 * Doc Comments::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1809 * AWK Mode Font Locking::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1810 @end menu
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1811
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1812
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1813 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1814 @node Font Locking Preliminaries, Faces, Font Locking, Font Locking
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1815 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1816 @section Font Locking Preliminaries
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1817 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1818
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1819 The font locking for most of the @ccmode{} languages were provided
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1820 directly by the Font Lock package prior to version 5.30 of @ccmode{}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1821 In the transition to @ccmode{} the patterns have been reworked
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1822 completely and are applied uniformly across all the languages except AWK
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1823 mode, just like the indentation rules (although each language still has
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1824 some peculiarities of its own, of course). Since the languages
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1825 previously had completely separate font locking patterns, this means
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1826 that it's a bit different in most languages now.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1827
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1828 The main goal for the font locking in @ccmode{} is accuracy, to provide
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1829 a dependable aid in recognizing the various constructs. Some, like
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1830 strings and comments, are easy to recognize while others, like
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1831 declarations and types, can be very tricky. @ccmode{} can go to great
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1832 lengths to recognize declarations and casts correctly, especially when
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1833 the types aren't recognized by standard patterns. This is a fairly
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1834 demanding analysis which can be slow on older hardware, and it can
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1835 therefore be disabled by choosing a lower decoration level with the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1836 variable @code{font-lock-maximum-decoration} (@pxref{Font Lock,,,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1837 emacs, GNU Emacs Manual}).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1838
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1839 @vindex font-lock-maximum-decoration
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1840
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1841 The decoration levels are used as follows:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1842
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1843 @enumerate
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1844 @comment 1
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1845 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1846 Minimal font locking: Fontify only comments, strings and preprocessor
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1847 directives (in the languages that use cpp).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1848
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1849 @comment 2
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1850 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1851 Fast font locking: In addition to level 1, fontify keywords, simple
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1852 types and declarations that are easy to recognize. The variables
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1853 @code{*-font-lock-extra-types} (where @samp{*} is the name of the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1854 language) are used to recognize types (see below). Documentation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1855 comments like Javadoc are fontified according to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1856 @code{c-doc-comment-style} (@pxref{Doc Comments}).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1857
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1858 Use this if you think the font locking is too slow. It's the closest
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1859 corresponding level to level 3 in the old font lock patterns.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1860
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1861 @comment 3
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1862 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1863 Accurate font locking: Like level 2 but uses a different approach that
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1864 can recognize types and declarations much more accurately. The
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1865 @code{*-font-lock-extra-types} variables are still used, but user
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1866 defined types are recognized correctly anyway in most cases. Therefore
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1867 those variables should be fairly restrictive and not contain patterns
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1868 that are uncertain.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1869
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1870 @cindex Lazy Lock mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1871 @cindex Just-in-time Lock mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1872
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1873 This level is designed for fairly modern hardware and a font lock
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1874 support mode like Lazy Lock or Just-in-time Lock mode that only
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1875 fontifies the parts that are actually shown. Fontifying the whole
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1876 buffer at once can easily get bothersomely slow even on contemporary
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1877 hardware. @xref{Font Lock,,,@emacsman{}, @emacsmantitle{}}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1878 @end enumerate
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1879
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1880 @cindex user defined types
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1881 @cindex types, user defined
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1882
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1883 Since user defined types are hard to recognize you can provide
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1884 additional regexps to match those you use:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1885
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1886 @defopt c-font-lock-extra-types
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1887 @defoptx c++-font-lock-extra-types
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1888 @defoptx objc-font-lock-extra-types
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1889 @defoptx java-font-lock-extra-types
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1890 @defoptx idl-font-lock-extra-types
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1891 @defoptx pike-font-lock-extra-types
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1892 For each language there's a variable @code{*-font-lock-extra-types},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1893 where @samp{*} stands for the language in question. It contains a list
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1894 of regexps that matches identifiers that should be recognized as types,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1895 e.g. @samp{\\sw+_t} to recognize all identifiers ending with @samp{_t}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1896 as is customary in C code. Each regexp should not match more than a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1897 single identifier.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1898
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1899 The default values contain regexps for many types in standard runtime
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1900 libraries that are otherwise difficult to recognize, and patterns for
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1901 standard type naming conventions like the @samp{_t} suffix in C and C++.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1902 Java, Objective-C and Pike have as a convention to start class names
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1903 with capitals, so there are patterns for that in those languages.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1904
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1905 Despite the names of these variables, they are not only used for
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1906 fontification but in other places as well where @ccmode{} needs to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1907 recognize types.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1908 @end defopt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1909
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1910
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1911 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1912 @node Faces, Doc Comments, Font Locking Preliminaries, Font Locking
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1913 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1914 @section Faces
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1915 @cindex faces
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1916 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1917
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1918 @ccmode{} attempts to use the standard faces for programming languages
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1919 in accordance with their intended purposes as far as possible. No extra
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1920 faces are currently provided, with the exception of a replacement face
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1921 @code{c-invalid-face} for emacsen that don't provide
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1922 @code{font-lock-warning-face}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1923
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1924 @itemize @bullet
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1925 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1926 @vindex font-lock-comment-face
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1927 Normal comments are fontified in @code{font-lock-comment-face}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1928
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1929 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1930 @vindex font-lock-doc-face
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1931 @vindex font-lock-doc-string-face
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1932 @vindex font-lock-comment-face
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1933 Comments that are recognized as documentation (@pxref{Doc Comments})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1934 get @code{font-lock-doc-face} (Emacs) or
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1935 @code{font-lock-doc-string-face} (XEmacs) if those faces exist. If
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1936 they don't then @code{font-lock-comment-face} is used.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1937
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1938 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1939 @vindex font-lock-string-face
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1940 String and character literals are fontified in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1941 @code{font-lock-string-face}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1942
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1943 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1944 @vindex font-lock-keyword-face
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1945 Keywords are fontified with @code{font-lock-keyword-face}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1946
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1947 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1948 @vindex font-lock-function-name-face
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1949 @code{font-lock-function-name-face} is used for function names in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1950 declarations and definitions, and classes in those contexts. It's also
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1951 used for preprocessor defines with arguments.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1952
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1953 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1954 @vindex font-lock-variable-name-face
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1955 Variables in declarations and definitions, and other identifiers in such
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1956 variable contexts, get @code{font-lock-variable-name-face}. It's also
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1957 used for preprocessor defines without arguments.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1958
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1959 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1960 @vindex font-lock-constant-face
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1961 @vindex font-lock-reference-face
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1962 Builtin constants are fontified in @code{font-lock-constant-face} if it
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1963 exists, @code{font-lock-reference-face} otherwise. As opposed to the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1964 preceding two faces, this is used on the names in expressions, and it's
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1965 not used in declarations, even if there happen to be a @samp{const} in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1966 them somewhere.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1967
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1968 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1969 @vindex font-lock-type-face
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1970 @code{font-lock-type-face} is put on types (both predefined and user
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1971 defined) and classes in type contexts.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1972
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1973 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1974 @vindex font-lock-constant-face
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1975 @vindex font-lock-reference-face
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1976 Label identifiers get @code{font-lock-constant-face} if it exists,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1977 @code{font-lock-reference-face} otherwise.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1978
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1979 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1980 Name qualifiers and identifiers for scope constructs are fontified like
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1981 labels.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1982
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1983 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1984 Special markup inside documentation comments are also fontified like
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1985 labels.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1986
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1987 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1988 @vindex font-lock-preprocessor-face
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1989 @vindex font-lock-builtin-face
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1990 @vindex font-lock-reference-face
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1991 Preprocessor directives get @code{font-lock-preprocessor-face} if it
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1992 exists (i.e. XEmacs). In Emacs they get @code{font-lock-builtin-face}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1993 or @code{font-lock-reference-face}, for lack of a closer equivalent.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1994
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1995 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1996 @vindex font-lock-warning-face
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1997 @vindex c-invalid-face
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1998 @vindex invalid-face (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1999 Some kinds of syntactic errors are fontified with
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2000 @code{font-lock-warning-face} in Emacs. In older XEmacs versions
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2001 there's no corresponding standard face, so there a special
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2002 @code{c-invalid-face} is used, which is defined to stand out sharply by
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2003 default.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2004
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2005 Note that it's not used for @samp{#error} or @samp{#warning} directives,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2006 since those aren't syntactic errors in themselves.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2007 @end itemize
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2008
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2009
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2010 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2011 @node Doc Comments, AWK Mode Font Locking, Faces, Font Locking
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2012 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2013 @section Documentation Comments
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2014 @cindex documentation comments
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2015 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2016
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2017 There are various tools to supply documentation in the source as
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2018 specially structured comments, e.g. the standard Javadoc tool in Java.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2019 @ccmode{} provides an extensible mechanism to fontify such comments and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2020 the special markup inside them.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2021
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2022 @defopt c-doc-comment-style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2023 @vindex doc-comment-style (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2024 This is a style variable that specifies which documentation comment
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2025 style to recognize, e.g. @code{javadoc} for Javadoc comments.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2026
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2027 The value may also be a list of styles, in which case all of them are
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2028 recognized simultaneously (presumably with markup cues that don't
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2029 conflict).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2030
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2031 The value may also be an association list to specify different comment
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2032 styles for different languages. The symbol for the major mode is then
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2033 looked up in the alist, and the value of that element is interpreted as
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2034 above if found. If it isn't found then the symbol `other' is looked up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2035 and its value is used instead.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2036
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2037 The default value for @code{c-doc-comment-style} is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2038 @w{@code{((java-mode . javadoc) (pike-mode . autodoc) (c-mode . gtkdoc))}}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2039
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2040 Note that @ccmode{} uses this variable to set other variables that
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2041 handle fontification etc. That's done at mode initialization or when
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2042 you switch to a style which sets this variable. Thus, if you change it
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2043 in some other way, e.g. interactively in a CC Mode buffer, you will need
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2044 to do @kbd{M-x java-mode} (or whatever mode you're currently using) to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2045 reinitialize.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2046
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2047 @findex c-setup-doc-comment-style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2048 @findex setup-doc-comment-style (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2049 Note also that when @ccmode{} starts up, the other variables are
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2050 modified before the mode hooks are run. If you change this variable in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2051 a mode hook, you'll have to call @code{c-setup-doc-comment-style}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2052 afterwards to redo that work.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2053 @end defopt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2054
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2055 @ccmode{} currently provides handing of the following doc comment
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2056 styles:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2057
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2058 @table @code
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2059 @item javadoc
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2060 @cindex Javadoc markup
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2061 Javadoc comments, the standard tool in Java.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2062
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2063 @item autodoc
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2064 @cindex Pike autodoc markup
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2065 For Pike autodoc markup, the standard in Pike.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2066
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2067 @item gtkdoc
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2068 @cindex GtkDoc markup
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2069 For GtkDoc markup, widely used in the Gnome community.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2070 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2071
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2072 The above is by no means complete. If you'd like to see support for
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2073 other doc comment styles, please let us know (@pxref{Mailing Lists and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2074 Bug Reports}).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2075
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2076 You can also write your own doc comment fontification support to use
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2077 with @code{c-doc-comment-style}: Supply a variable or function
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2078 @code{*-font-lock-keywords} where @samp{*} is the name you want to use
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2079 in @code{c-doc-comment-style}. If it's a variable, it's prepended to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2080 @code{font-lock-keywords}. If it's a function, it's called at mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2081 initialization and the result is prepended. For an example, see
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2082 @code{javadoc-font-lock-keywords} in @file{cc-fonts.el}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2083
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2084 If you add support for another doc comment style, please consider
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2085 contributing it - send a note to @email{bug-cc-mode@@gnu.org}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2086
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2087
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2088 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2089 @node AWK Mode Font Locking, , Doc Comments, Font Locking
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2090 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2091 @section AWK Mode Font Locking
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2092 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2093
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2094 The general appearance of font-locking in AWK mode is much like in any
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2095 other programming mode. @xref{Faces For Font Lock,,,elisp, GNU Emacs
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2096 Lisp Reference Manual}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2097
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2098 The following faces are, however, used in a non-standard fashion in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2099 AWK mode:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2100
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2101 @table @asis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2102 @item @code{font-lock-variable-name-face}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2103 This face was intended for variable declarations. Since variables are
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2104 not declared in AWK, this face is used instead for AWK system
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2105 variables (such as @code{NF}) and ``Special File Names'' (such as
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2106 @code{"/dev/stderr"}).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2107
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2108 @item @code{font-lock-builtin-face} (Emacs)/@code{font-lock-preprocessor-face} (XEmacs)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2109 This face is normally used for preprocessor directives in @ccmode{}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2110 There are no such things in AWK, so this face is used instead for
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2111 standard functions (such as @code{match}).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2112
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2113 @item @code{font-lock-string-face}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2114 As well as being used for strings, including localizable strings,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2115 (delimited by @samp{"} and @samp{_"}), this face is also used for AWK
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2116 regular expressions (delimited by @samp{/}).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2117
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2118 @item @code{font-lock-warning-face} (Emacs)/@code{c-invalid-face} (XEmacs)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2119 This face highlights the following syntactically invalid AWK
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2120 constructs:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2121
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2122 @itemize @bullet
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2123 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2124 An unterminated string or regular expression. Here the opening
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2125 delimiter (@samp{"} or @samp{/} or @samp{_"}) is displayed in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2126 @code{font-lock-warning-face}. This is most noticeable when typing in a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2127 new string/regular expression into a buffer, when the warning-face
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2128 serves as a continual reminder to terminate the construct.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2129
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2130 AWK mode fontifies unterminated strings/regular expressions
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2131 differently from other modes: Only the text up to the end of the line
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2132 is fontified as a string (escaped newlines being handled correctly),
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2133 rather than the text up to the next string quote.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2134
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2135 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2136 A space between the function name and opening parenthesis when calling
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2137 a user function. The last character of the function name and the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2138 opening parenthesis are highlighted. This font-locking rule will
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2139 spuriously highlight a valid concatenation expression where an
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2140 identifier precedes a parenthesised expression. Unfortunately.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2141
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2142 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2143 Whitespace following the @samp{\} in what otherwise looks like an
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2144 escaped newline. The @samp{\} is highlighted.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2145 @end itemize
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2146 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2147
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2148
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2149 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2150 @node Config Basics, Custom Filling and Breaking, Font Locking, Top
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2151 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2152 @chapter Configuration Basics
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2153 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2154
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2155 @cindex Emacs Initialization File
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2156 @cindex Configuration
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2157 You configure @ccmode{} by setting Lisp variables and calling (and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2158 perhaps writing) Lisp functions@footnote{DON'T PANIC!!! This isn't
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2159 difficult.}, which is usually done by adding code to an Emacs
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2160 initialization file. This file might be @file{site-start.el} or
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2161 @file{.emacs} or @file{init.el} or @file{default.el} or perhaps some
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2162 other file. @xref{Init File,,,@emacsman{}, @emacsmantitle{}}. For
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2163 the sake of conciseness, we just call this file ``your @file{.emacs}''
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2164 throughout the rest of the manual.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2165
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2166 Several of these variables (currently 16), are known collectively as
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2167 @dfn{style variables}. @ccmode{} provides a special mechanism, known
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2168 as @dfn{styles} to make it easier to set these variables as a group,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2169 to ``inherit'' settings from one style into another, and so on. Style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2170 variables remain ordinary Lisp variables, whose values can be read and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2171 changed independently of the style system. @xref{Style Variables}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2172
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2173 There are several ways you can write the code, depending on the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2174 precise effect you want---they are described further down on this page.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2175 If you are new to @ccmode{}, we suggest you begin with the simplest
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2176 method, ``Top-level commands or the customization interface''.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2177
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2178 If you make conflicting settings in several of these ways, the way
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2179 that takes precedence is the one that appears latest in this list:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2180 @itemize @asis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2181 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2182 @table @asis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2183 @item Style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2184 @itemx Top-level command or ``customization interface''
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2185 @itemx Hook
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2186 @itemx File Style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2187 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2188 @end itemize
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2189
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2190 Here is a summary of the different ways of writing your configuration
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2191 settings:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2192
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2193 @table @asis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2194 @item Top-level commands or the ``customization interface''
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2195 Most simply, you can write @code{setq} and similar commands at the top
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2196 level of your @file{.emacs} file. When you load a @ccmode{} buffer,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2197 it initializes its configuration from these global values (at least,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2198 for those settings you have given values to), so it makes sense to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2199 have these @code{setq} commands run @emph{before} @ccmode{} is first
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2200 initialized---in particular, before any call to @code{desktop-read}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2201 (@pxref{Saving Emacs Sessions,,, emacs, GNU Emacs Manual}). For
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2202 example, you might set c-basic-offset thus:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2203
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2204 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2205 (setq c-basic-offset 4)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2206 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2207
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2208 You can use the more user friendly Customization interface instead,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2209 but this manual does not cover in detail how that works. To do this,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2210 start by typing @kbd{M-x customize-group @key{RET} c @key{RET}}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2211 @xref{Easy Customization,,,@emacsman{}, @emacsmantitle{}}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2212 @c The following note really belongs in the Emacs manual.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2213 Emacs normally writes the customizations at the end of your
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2214 @file{.emacs} file. If you use @code{desktop-read}, you should edit
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2215 your @file{.emacs} to place the call to @code{desktop-read} @emph{after}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2216 the customizations.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2217
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2218 The first initialization of @ccmode{} puts a snapshot of the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2219 configuration settings into the special style @code{user}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2220 @xref{Built-in Styles}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2221
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2222 For basic use of Emacs, either of these ways of configuring is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2223 adequate. However, the settings are then the same in all @ccmode{}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2224 buffers and it can be clumsy to communicate them between programmers.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2225 For more flexibility, you'll want to use one (or both) of @ccmode{}'s
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2226 more sophisticated facilities, hooks and styles.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2227
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2228 @item Hooks
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2229 An Emacs @dfn{hook} is a place to put Lisp functions that you want
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2230 Emacs to execute later in specific circumstances.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2231 @xref{Hooks,,,@lispref{}, @lispreftitle{}}. @ccmode{} supplies a main
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2232 hook and a language-specific hook for each language it supports - any
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2233 functions you put onto these hooks get executed as the last part of a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2234 buffer's initialization. Typically you put most of your customization
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2235 within the main hook, and use the language-specific hooks to vary the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2236 customization settings between language modes. For example, if you
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2237 wanted different (non-standard) values of @code{c-basic-offset} in C
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2238 Mode and Java Mode buffers, you could do it like this:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2239
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2240 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2241 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2242 (defun my-c-mode-hook ()
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2243 (setq c-basic-offset 3))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2244 (add-hook 'c-mode-hook 'my-c-mode-hook)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2245
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2246 (defun my-java-mode-hook ()
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2247 (setq c-basic-offset 6))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2248 (add-hook 'java-mode-hook 'my-java-mode-hook)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2249 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2250 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2251
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2252 See @ref{CC Hooks} for more details on the use of @ccmode{} hooks.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2253
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2254 @item Styles
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2255 A @ccmode{} @dfn{style} is a coherent collection of customizations
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2256 with a name. At any time, exactly one style is active in each
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2257 @ccmode{} buffer, either the one you have selected or a default.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2258 @ccmode{} is delivered with several existing styles. Additionally,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2259 you can create your own styles, possibly based on these existing
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2260 styles. If you worked in a programming team called the ``Free
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2261 Group'', which had its own coding standards, you might well have this
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2262 in your @file{.emacs} file:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2263
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2264 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2265 (setq c-default-style '((java-mode . "java")
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2266 (awk-mode . "awk")
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2267 (other . "free-group-style")))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2268 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2269
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2270 See @ref{Styles} for fuller details on using @ccmode{} styles and how
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2271 to create them.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2272
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2273 @item File Styles
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2274 A @dfn{file style} is a rarely used variant of the ``style'' mechanism
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2275 described above, which applies to an individual source file. To use
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2276 it, you set certain Emacs local variables in a special block at the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2277 end of the source file. @xref{File Styles}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2278
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2279 @item Hooks with Styles
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2280 For ultimate flexibility, you can use hooks and styles together. For
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2281 example, if your team were developing a product which required a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2282 Linux driver, you'd probably want to use the ``linux'' style for the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2283 driver, and your own team's style for the rest of the code. You
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2284 could achieve this with code like this in your @file{.emacs}:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2285
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2286 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2287 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2288 (defun my-c-mode-hook ()
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2289 (c-set-style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2290 (if (and (buffer-file-name)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2291 (string-match "/usr/src/linux" (buffer-file-name)))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2292 "linux"
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2293 "free-group-style")))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2294 (add-hook 'c-mode-hook 'my-c-mode-hook)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2295 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2296 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2297
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2298 In a programming team, a hook is a also a good place for each member
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2299 to put his own personal preferences. For example, you might be the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2300 only person in your team who likes Auto-newline minor mode. You could
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2301 have it enabled by default by placing the following in your
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2302 @file{.emacs}:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2303
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2304 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2305 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2306 (defun my-turn-on-auto-newline ()
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2307 (c-toggle-auto-newline 1))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2308 (add-hook 'c-mode-common-hook 'my-turn-on-auto-newline)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2309 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2310 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2311 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2312
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2313 @menu
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2314 * CC Hooks::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2315 * Style Variables::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2316 * Styles::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2317 @end menu
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2318
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2319 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2320 @node CC Hooks, Style Variables, Config Basics, Config Basics
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2321 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2322 @section Hooks
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2323 @cindex mode hooks
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2324 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2325 @c The node name is "CC Hooks" rather than "Hooks" because of a bug in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2326 @c some older versions of Info, e.g. the info.el in GNU Emacs 21.3.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2327 @c If you go to "Config Basics" and hit <CR> on the xref to "CC
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2328 @c Hooks" the function Info-follow-reference searches for "*Note: CC
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2329 @c Hooks" from the beginning of the page. If this node were instead
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2330 @c named "Hooks", that search would spuriously find "*Note:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2331 @c Hooks(elisp)" and go to the wrong node.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2332
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2333 @ccmode{} provides several hooks that you can use to customize the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2334 mode for your coding style. The main hook is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2335 @code{c-mode-common-hook}; typically, you'll put the bulk of your
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2336 customizations here. In addition, each language mode has its own
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2337 hook, allowing you to fine tune your settings individually for the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2338 different @ccmode{} languages, and there is a package initialization
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2339 hook. Finally, there is @code{c-special-indent-hook}, which enables
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2340 you to solve anomalous indentation problems. It is described in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2341 @ref{Other Indentation}, not here. All these hooks adhere to the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2342 standard Emacs conventions.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2343
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2344 When you open a buffer, @ccmode{} first initializes it with the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2345 currently active style (@pxref{Styles}). Then it calls
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2346 @code{c-mode-common-hook}, and finally it calls the language-specific
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2347 hook. Thus, any style settings done in these hooks will override
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2348 those set by @code{c-default-style}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2349
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2350 @defvar c-initialization-hook
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2351 @vindex initialization-hook (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2352 Hook run only once per Emacs session, when @ccmode{} is initialized.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2353 This is a good place to change key bindings (or add new ones) in any
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2354 of the @ccmode{} key maps. @xref{Sample .emacs File}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2355 @end defvar
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2356
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2357 @defvar c-mode-common-hook
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2358 @vindex mode-common-hook (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2359 Common hook across all languages. It's run immediately before the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2360 language specific hook.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2361 @end defvar
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2362
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2363 @defvar c-mode-hook
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2364 @defvarx c++-mode-hook
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2365 @defvarx objc-mode-hook
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2366 @defvarx java-mode-hook
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2367 @defvarx idl-mode-hook
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2368 @defvarx pike-mode-hook
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2369 @defvarx awk-mode-hook
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2370 The language specific mode hooks. The appropriate one is run as the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2371 last thing when you enter that language mode.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2372 @end defvar
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2373
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2374 Although these hooks are variables defined in @ccmode{}, you can give
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2375 them values before @ccmode{}'s code is loaded---indeed, this is the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2376 only way to use @code{c-initialization-hook}. Their values aren't
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2377 overwritten when @ccmode{} gets loaded.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2378
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2379 Here's a simplified example of what you can add to your @file{.emacs}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2380 file to do things whenever any @ccmode{} language is edited. See the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2381 Emacs manuals for more information on customizing Emacs via hooks.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2382 @xref{Sample .emacs File}, for a more complete sample @file{.emacs}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2383 file.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2384
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2385 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2386 (defun my-c-mode-common-hook ()
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2387 ;; my customizations for all of c-mode and related modes
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2388 (no-case-fold-search)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2389 )
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2390 (add-hook 'c-mode-common-hook 'my-c-mode-common-hook)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2391 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2392
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2393 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2394 @node Style Variables, Styles, CC Hooks, Config Basics
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2395 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2396 @section Style Variables
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2397 @cindex styles
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2398 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2399
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2400 @cindex style variables
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2401 The variables that @ccmode{}'s style system control are called
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2402 @dfn{style variables}. Note that style variables are ordinary Lisp
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2403 variables, which the style system initializes; you can change their
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2404 values at any time (e.g. in a hook function). The style system can
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2405 also set other variables, to some extent. @xref{Styles}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2406
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2407 @dfn{Style variables} are handled specially in several ways:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2408
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2409 @itemize @bullet
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2410 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2411 Style variables are by default buffer-local variables. However, they
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2412 can instead be made global by setting
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2413 @code{c-style-variables-are-local-p} to @code{nil} before @ccmode{} is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2414 initialized.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2415
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2416 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2417 @vindex c-old-style-variable-behavior
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2418 @vindex old-style-variable-behavior (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2419 The default global binding of any style variable (with two exceptions
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2420 - see below) is the special symbol @code{set-from-style}. When the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2421 style system initializes a buffer-local copy of a style variable for a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2422 @ccmode{} buffer, if its global binding is still that symbol then it
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2423 will be set from the current style. Otherwise it will retain its
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2424 global default@footnote{This is a big change from versions of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2425 @ccmode{} earlier than 5.26, where such settings would get overridden
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2426 by the style system unless special precautions were taken. That was
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2427 changed since it was counterintuitive and confusing, especially to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2428 novice users. If your configuration depends on the old overriding
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2429 behavior, you can set the variable
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2430 @code{c-old-style-variable-behavior} to non-@code{nil}.}. This
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2431 ``otherwise'' happens, for example, when you've set the variable with
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2432 @code{setq} at the top level of your @file{.emacs} (@pxref{Config
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2433 Basics}).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2434
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2435 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2436 The style variable @code{c-offsets-alist} (@pxref{c-offsets-alist}) is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2437 an association list with an element for each syntactic symbol. It's
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2438 handled a little differently from the other style variables. It's
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2439 default global binding is the empty list @code{nil}, rather than
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2440 @code{set-from-style}. Before the style system is initialized, you
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2441 can add individual elements to @code{c-offsets-alist} by calling
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2442 @code{c-set-offset}(@pxref{c-offsets-alist}) just like you would set
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2443 other style variables with @code{setq}. Those elements will then
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2444 prevail when the style system later initializes a buffer-local copy of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2445 @code{c-offsets-alist}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2446
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2447 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2448 The style variable @code{c-special-indent-hook} is also handled in a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2449 special way. Styles can only add functions to this hook, not remove
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2450 them, so any global settings you put on it are always
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2451 preserved@footnote{This did not change in version 5.26.}. The value
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2452 you give this variable in a style definition can be either a function
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2453 or a list of functions.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2454
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2455 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2456 The global bindings of the style variables get captured in the special
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2457 @code{user} style when the style system is first initialized.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2458 @xref{Built-in Styles}, for details.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2459 @end itemize
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2460
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2461 The style variables are:@*
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2462 @code{c-indent-comment-alist},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2463 @code{c-indent-comments-syntactically-p} (@pxref{Indentation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2464 Commands});@*
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2465 @code{c-doc-comment-style} (@pxref{Doc Comments});@*
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2466 @code{c-block-comment-prefix}, @code{c-comment-prefix-regexp}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2467 (@pxref{Custom Filling and Breaking});@*
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2468 @code{c-hanging-braces-alist} (@pxref{Hanging Braces});@*
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2469 @code{c-hanging-colons-alist} (@pxref{Hanging Colons});@*
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2470 @code{c-hanging-semi&comma-criteria} (@pxref{Hanging Semicolons and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2471 Commas});@*
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2472 @code{c-cleanup-list} (@pxref{Clean-ups});@*
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2473 @code{c-basic-offset} (@pxref{Customizing Indentation});@*
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2474 @code{c-offsets-alist} (@pxref{c-offsets-alist});@*
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2475 @code{c-comment-only-line-offset} (@pxref{Comment Line-Up});@*
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2476 @code{c-special-indent-hook}, @code{c-label-minimum-indentation}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2477 (@pxref{Other Indentation});@*
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2478 @code{c-backslash-column}, @code{c-backslash-max-column}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2479 (@pxref{Custom Macros}).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2480
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2481 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2482 @node Styles, , Style Variables, Config Basics
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2483 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2484 @section Styles
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2485 @cindex styles
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2486 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2487
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2488 By @dfn{style} we mean the layout of the code---things like how many
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2489 columns to indent a block of code, whether an opening brace gets
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2490 indented to the level of the code it encloses, or of the construct
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2491 that introduces it, or ``hangs'' at the end of a line.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2492
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2493 Most people only need to edit code formatted in just a few well-defined
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2494 and consistent styles. For example, their organization might impose a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2495 ``blessed'' style that all its programmers must conform to. Similarly,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2496 people who work on GNU software will have to use the GNU coding style.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2497 Some shops are more lenient, allowing a variety of coding styles, and as
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2498 programmers come and go, there could be a number of styles in use. For
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2499 this reason, @ccmode{} makes it convenient for you to set up logical
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2500 groupings of customizations called @dfn{styles}, associate a single name
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2501 for any particular style, and pretty easily start editing new or
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2502 existing code using these styles.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2503
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2504 @menu
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2505 * Built-in Styles::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2506 * Choosing a Style::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2507 * Adding Styles::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2508 * File Styles::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2509 @end menu
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2510
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2511
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2512 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2513 @node Built-in Styles, Choosing a Style, Styles, Styles
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2514 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2515 @subsection Built-in Styles
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2516 @cindex styles, built-in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2517 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2518
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2519 If you're lucky, one of @ccmode{}'s built-in styles might be just
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2520 what you're looking for. These are:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2521
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2522 @table @code
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2523 @item gnu
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2524 @cindex GNU style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2525 Coding style blessed by the Free Software Foundation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2526 for C code in GNU programs.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2527
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2528 @item k&r
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2529 @cindex K&R style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2530 The classic Kernighan and Ritchie style for C code.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2531
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2532 @item bsd
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2533 @cindex BSD style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2534 Also known as ``Allman style'' after Eric Allman.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2535
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2536 @item whitesmith
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2537 @cindex Whitesmith style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2538 Popularized by the examples that came with Whitesmiths C, an early
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2539 commercial C compiler.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2540
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2541 @item stroustrup
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2542 @cindex Stroustrup style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2543 The classic Stroustrup style for C++ code.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2544
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2545 @item ellemtel
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2546 @cindex Ellemtel style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2547 Popular C++ coding standards as defined by ``Programming in C++, Rules
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2548 and Recommendations,'' Erik Nyquist and Mats Henricson,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2549 Ellemtel@footnote{This document is available at
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2550 @uref{http://www.doc.ic.ac.uk/lab/cplus/c++.rules/} among other
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2551 places.}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2552 @c N.B. This URL was still valid at 2005/8/28 (ACM).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2553
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2554 @item linux
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2555 @cindex Linux style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2556 C coding standard for Linux (the kernel).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2557
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2558 @item python
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2559 @cindex Python style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2560 C coding standard for Python extension modules@footnote{Python is a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2561 high level scripting language with a C/C++ foreign function interface.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2562 For more information, see @uref{http://www.python.org/}.}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2563
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2564 @item java
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2565 @cindex Java style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2566 The style for editing Java code. Note that the default
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2567 value for @code{c-default-style} installs this style when you enter
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2568 @code{java-mode}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2569
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2570 @item awk
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2571 @cindex AWK style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2572 The style for editing AWK code. Note that the default value for
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2573 @code{c-default-style} installs this style when you enter
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2574 @code{awk-mode}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2575
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2576 @item user
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2577 @cindex User style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2578 This is a special style created by you. It consists of the factory
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2579 defaults for all the style variables as modified by the customizations
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2580 you do either with the Customization interface or by writing
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2581 @code{setq}s and @code{c-set-offset}s at the top level of your
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2582 @file{.emacs} file (@pxref{Config Basics}). The style system creates
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2583 this style as part of its initialization and doesn't modify it
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2584 afterwards.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2585 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2586
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2587
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2588 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2589 @node Choosing a Style, Adding Styles, Built-in Styles, Styles
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2590 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2591 @subsection Choosing a Style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2592 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2593
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2594 When you create a new buffer, its style will be set from
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2595 @code{c-default-style}. The factory default is the style @code{gnu},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2596 except in Java and AWK modes where it's @code{java} and @code{awk}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2597
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2598 Remember that if you set a style variable with the Customization
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2599 interface or at the top level of your @file{.emacs} file before the
96449
80392a5671b7 American English spelling fixes.
Glenn Morris <rgm@gnu.org>
parents: 95936
diff changeset
2600 style system is initialized (@pxref{Config Basics}), this setting will
84286
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2601 override the one that the style system would have given the variable.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2602
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2603 To set a buffer's style interactively, use the command @kbd{C-c .}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2604 (@pxref{Other Commands}). To set it from a file's local variable
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2605 list, @ref{File Styles}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2606
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2607 @defopt c-default-style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2608 @vindex default-style (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2609 This variable specifies which style to install by default in new
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2610 buffers. It takes either a style name string, or an association list
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2611 of major mode symbols to style names:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2612
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2613 @enumerate
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2614 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2615 When @code{c-default-style} is a string, it must be an existing style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2616 name. This style is then used for all modes.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2617
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2618 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2619 When @code{c-default-style} is an association list, the mode language
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2620 is looked up to find a style name string.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2621
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2622 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2623 If @code{c-default-style} is an association list where the mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2624 language mode isn't found then the special symbol @samp{other} is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2625 looked up. If it's found then the associated style is used.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2626
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2627 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2628 If @samp{other} is not found then the @samp{gnu} style is used.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2629 @end enumerate
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2630
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2631 In all cases, the style described in @code{c-default-style} is installed
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2632 @emph{before} the language hooks are run, so you can always override
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2633 this setting by including an explicit call to @code{c-set-style} in your
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2634 language mode hook, or in @code{c-mode-common-hook}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2635
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2636 The standard value of @code{c-default-style} is @w{@code{((java-mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2637 . "java") (awk-mode . "awk") (other . "gnu"))}}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2638 @end defopt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2639
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2640 @defvar c-indentation-style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2641 @vindex indentation-style (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2642 This variable always contains the buffer's current style name, as a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2643 string.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2644 @end defvar
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2645
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2646
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2647 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2648 @node Adding Styles, File Styles, Choosing a Style, Styles
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2649 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2650 @subsection Adding and Amending Styles
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2651 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2652
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2653 If none of the built-in styles is appropriate, you'll probably want to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2654 create a new @dfn{style definition}, possibly based on an existing
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2655 style. To do this, put the new style's settings into a list with the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2656 following format - the list can then be passed as an argument to the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2657 function @code{c-add-style}. You can see an example of a style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2658 definition in @ref{Sample .emacs File}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2659
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2660 @cindex style definition
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2661 @c @defvr {List} style definition
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2662 @table @asis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2663 @item Structure of a Style Definition List
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2664 ([@var{base-style}] [(@var{variable} . @var{value}) @dots{}])
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2665
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2666 Optional @var{base-style}, if present, must be a string which is the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2667 name of the @dfn{base style} from which this style inherits. At most
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2668 one @var{base-style} is allowed in a style definition. If
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2669 @var{base-style} is not specified, the style inherits from the table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2670 of factory default values@footnote{This table is stored internally in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2671 the variable c-fallback-style.} instead. All styles eventually
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2672 inherit from this internal table. Style loops generate errors. The
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2673 list of pre-existing styles can be seen in @ref{Built-in Styles}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2674
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2675 The dotted pairs (@var{variable} . @var{value}) each consist of a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2676 variable and the value it is to be set to when the style is later
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2677 activated.@footnote{Note that if the variable has been given a value
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2678 by the Customization interface or a @code{setq} at the top level of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2679 your @file{.emacs}, this value will override the one the style system
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2680 tries to give it. @xref{Config Basics}.} The variable can be either a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2681 @ccmode{} style variable or an arbitrary Emacs variable. In the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2682 latter case, it is @emph{not} made buffer-local by the @ccmode{} style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2683 system.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2684 @c @end defvr
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2685
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2686 Two variables are treated specially in the dotted pair list:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2687
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2688 @table @code
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2689 @item c-offsets-alist
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2690 The value is in turn a list of dotted pairs of the form
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2691
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2692 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2693 (@r{@var{syntactic-symbol}} . @r{@var{offset}})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2694 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2695
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2696 as described in @ref{c-offsets-alist}. These are passed to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2697 @code{c-set-offset} so there is no need to set every syntactic symbol
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2698 in your style, only those that are different from the inherited style.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2699
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2700 @item c-special-indent-hook
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2701 The value is added to @code{c-special-indent-hook} using
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2702 @code{add-hook}, so any functions already on it are kept. If the value
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2703 is a list, each element of the list is added with @code{add-hook}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2704 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2705 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2706
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2707 Styles are kept in the @code{c-style-alist} variable, but you
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2708 should never modify this variable directly. Instead, @ccmode{}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2709 provides the function @code{c-add-style} for this purpose.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2710
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2711 @defun c-add-style stylename description &optional set-p
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2712 @findex add-style (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2713 Add or update a style called @var{stylename}, a string.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2714 @var{description} is the new style definition in the form described
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2715 above. If @var{stylename} already exists in @code{c-style-alist} then
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2716 it is replaced by @var{description}. (Note, this replacement is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2717 total. The old style is @emph{not} merged into the new one.)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2718 Otherwise, a new style is added.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2719
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2720 If the optional @var{set-p} is non-@code{nil} then the new style is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2721 applied to the current buffer as well. The use of this facility is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2722 deprecated and it might be removed from @ccmode{} in a future release.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2723 You should use @code{c-set-style} instead.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2724
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2725 The sample @file{.emacs} file provides a concrete example of how a new
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2726 style can be added and automatically set. @xref{Sample .emacs File}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2727 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2728
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2729 @defvar c-style-alist
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2730 @vindex style-alist (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2731 This is the variable that holds the definitions for the styles. It
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2732 should not be changed directly; use @code{c-add-style} instead.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2733 @end defvar
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2734
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2735
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2736 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2737 @node File Styles, , Adding Styles, Styles
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2738 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2739 @subsection File Styles
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2740 @cindex styles, file local
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2741 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2742
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2743 @cindex file local variables
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2744
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2745 The Emacs manual describes how you can customize certain variables on a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2746 per-file basis by including a @dfn{file local variable} block at the end
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2747 of the file (@pxref{File Variables,, Local Variables in Files, @emacsman{},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2748 @emacsmantitle{}}).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2749
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2750 So far, you've only seen a functional interface for setting styles in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2751 @ccmode{}, and this can't be used here. @ccmode{} fills the gap by
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2752 providing two variables for use in a file's local variable list.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2753 Don't use them anywhere else! These allow you to customize the style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2754 on a per-file basis:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2755
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2756 @defvar c-file-style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2757 @vindex file-style (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2758 Set this variable to a style name string in the Local Variables list.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2759 From now on, when you visit the file, @ccmode{} will automatically set
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2760 the file's style to this one using @code{c-set-style}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2761 @end defvar
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2762
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2763 @defvar c-file-offsets
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2764 @vindex file-offsets (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2765 Set this variable (in the Local Variables list) to an association list
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2766 of the same format as @code{c-offsets-alist}. From now on, when you
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2767 visit the file, @ccmode{} will automatically institute these offsets
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2768 using @code{c-set-offset}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2769 @end defvar
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2770
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2771 Note that file style settings (i.e. @code{c-file-style}) are applied
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2772 before file offset settings
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2773 (i.e. @code{c-file-offsets})@footnote{Also, if either of these are set
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2774 in a file's local variable section, all the style variable values are
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2775 made local to that buffer, even if
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2776 @code{c-style-variables-are-local-p} is @code{nil}. Since this
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2777 variable is virtually always non-@code{nil} anyhow, you're unlikely to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2778 notice this effect.}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2779
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2780 If you set any variables, including style variables, by the file local
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2781 variables mechanism, these settings take priority over all other
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2782 settings, even those in your mode hooks (@pxref{CC Hooks}). If you
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2783 use @code{c-file-style} or @code{c-file-offsets} and also explicitly
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2784 set a style variable in a local variable block, the explicit setting
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2785 will take priority.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2786
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2787 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2788 @node Custom Filling and Breaking, Custom Auto-newlines, Config Basics, Top
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2789 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2790 @chapter Customizing Filling and Line Breaking
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2791 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2792
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2793 Since there's a lot of normal text in comments and string literals,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2794 @ccmode{} provides features to edit these like in text mode. It does
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2795 this by hooking in on the different line breaking functions and tuning
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2796 relevant variables as necessary.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2797
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2798 @vindex c-comment-prefix-regexp
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2799 @vindex comment-prefix-regexp (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2800 @cindex comment line prefix
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2801 @vindex comment-start
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2802 @vindex comment-end
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2803 @vindex comment-start-skip
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2804 @vindex paragraph-start
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2805 @vindex paragraph-separate
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2806 @vindex paragraph-ignore-fill-prefix
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2807 @vindex adaptive-fill-mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2808 @vindex adaptive-fill-regexp
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2809 @vindex adaptive-fill-first-line-regexp
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2810 To make Emacs recognize comments and treat text in them as normal
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2811 paragraphs, @ccmode{} makes several standard
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2812 variables@footnote{@code{comment-start}, @code{comment-end},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2813 @code{comment-start-skip}, @code{paragraph-start},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2814 @code{paragraph-separate}, @code{paragraph-ignore-fill-prefix},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2815 @code{adaptive-fill-mode}, @code{adaptive-fill-regexp}, and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2816 @code{adaptive-fill-first-line-regexp}.} buffer-local and modifies them
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2817 according to the language syntax and the comment line prefix.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2818
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2819 @defopt c-comment-prefix-regexp
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2820 @vindex comment-prefix-regexp (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2821 This style variable contains the regexp used to recognize the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2822 @dfn{comment line prefix}, which is the line decoration that starts
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2823 every line in a comment. The variable is either the comment line
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2824 prefix itself, or (more usually) an association list with different
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2825 values for different languages. The symbol for the major mode is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2826 looked up in the alist to get the regexp for the language, and if it
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2827 isn't found then the special symbol @samp{other} is looked up instead.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2828
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2829 When a comment line gets divided by @kbd{M-j} or the like, @ccmode{}
96449
80392a5671b7 American English spelling fixes.
Glenn Morris <rgm@gnu.org>
parents: 95936
diff changeset
2830 inserts the comment line prefix from a neighboring line at the start
84286
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2831 of the new line. The default value of c-comment-prefix-regexp is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2832 @samp{//+\\|\\**}, which matches C++ style line comments like
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2833
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2834 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2835 // blah blah
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2836 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2837
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2838 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2839 with two or more slashes in front of them, and the second and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2840 subsequent lines of C style block comments like
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2841
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2842 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2843 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2844 /*
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2845 * blah blah
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2846 */
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2847 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2848 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2849
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2850 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2851 with zero or more stars at the beginning of every line. If you change
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2852 this variable, please make sure it still matches the comment starter
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2853 (i.e. @code{//}) of line comments @emph{and} the line prefix inside
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2854 block comments.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2855
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2856 @findex c-setup-paragraph-variables
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2857 @findex setup-paragraph-variables (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2858 Also note that since @ccmode{} uses the value of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2859 @code{c-comment-prefix-regexp} to set up several other variables at
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2860 mode initialization, there won't be any effect if you just change it
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2861 inside a @ccmode{} buffer. You need to call the command
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2862 @code{c-setup-paragraph-variables} too, to update those other
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2863 variables. That's also the case if you modify
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2864 @code{c-comment-prefix-regexp} in a mode hook, since @ccmode{} will
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2865 already have set up these variables before calling the hook.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2866 @end defopt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2867
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2868 In comments, @ccmode{} uses @code{c-comment-prefix-regexp} to adapt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2869 the line prefix from the other lines in the comment.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2870
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2871 @vindex adaptive-fill-mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2872 @cindex Adaptive Fill mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2873 @ccmode{} uses adaptive fill mode (@pxref{Adaptive Fill,,, emacs, GNU
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2874 Emacs Manual}) to make Emacs correctly keep the line prefix when
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2875 filling paragraphs. That also makes Emacs preserve the text
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2876 indentation @emph{inside} the comment line prefix. E.g. in the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2877 following comment, both paragraphs will be filled with the left
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2878 margins of the texts kept intact:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2879
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2880 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2881 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2882 /* Make a balanced b-tree of the nodes in the incoming
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2883 * stream. But, to quote the famous words of Donald E.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2884 * Knuth,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2885 *
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2886 * Beware of bugs in the above code; I have only
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2887 * proved it correct, not tried it.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2888 */
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2889 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2890 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2891
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2892 @findex c-setup-filladapt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2893 @findex setup-filladapt (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2894 @findex filladapt-mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2895 @vindex filladapt-mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2896 @cindex Filladapt mode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2897 It's also possible to use other adaptive filling packages, notably Kyle
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2898 E. Jones' Filladapt package@footnote{It's available from
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2899 @uref{http://www.wonderworks.com/}. As of version 2.12, it does however
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2900 lack a feature that makes it work suboptimally when
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2901 @code{c-comment-prefix-regexp} matches the empty string (which it does
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2902 by default). A patch for that is available from
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2903 @uref{http://cc-mode.sourceforge.net/,, the CC Mode web site}.},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2904 @c 2005/11/22: The above is still believed to be the case.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2905 which handles things like bulleted lists nicely. There's a convenience
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2906 function @code{c-setup-filladapt} that tunes the relevant variables in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2907 Filladapt for use in @ccmode{}. Call it from a mode hook, e.g. with
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2908 something like this in your @file{.emacs}:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2909
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2910 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2911 (defun my-c-mode-common-hook ()
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2912 (c-setup-filladapt)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2913 (filladapt-mode 1))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2914 (add-hook 'c-mode-common-hook 'my-c-mode-common-hook)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2915 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2916
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2917 @defopt c-block-comment-prefix
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2918 @vindex block-comment-prefix (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2919 @vindex c-comment-continuation-stars
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2920 @vindex comment-continuation-stars (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2921 Normally the comment line prefix inserted for a new line inside a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2922 comment is deduced from other lines in it. However there's one
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2923 situation when there's no hint about what the prefix should look like,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2924 namely when a block comment is broken for the first time. This style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2925 variable@footnote{In versions before 5.26, this variable was called
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2926 @code{c-comment-continuation-stars}. As a compatibility measure,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2927 @ccmode{} still uses the value on that variable if it's set.} is used
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2928 then as the comment prefix. It defaults to @samp{*
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2929 }@footnote{Actually, this default setting of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2930 @code{c-block-comment-prefix} typically gets overridden by the default
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2931 style @code{gnu}, which sets it to blank. You can see the line
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2932 splitting effect described here by setting a different style,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2933 e.g. @code{k&r} @xref{Choosing a Style}.}, which makes a comment
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2934
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2935 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2936 /* Got O(n^2) here, which is a Bad Thing. */
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2937 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2938
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2939 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2940 break into
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2941
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2942 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2943 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2944 /* Got O(n^2) here, which
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2945 * is a Bad Thing. */
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2946 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2947 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2948
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2949 Note that it won't work to adjust the indentation by putting leading
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2950 spaces in @code{c-block-comment-prefix}, since @ccmode{} still uses the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2951 normal indentation engine to indent the line. Thus, the right way to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2952 fix the indentation is by customizing the @code{c} syntactic symbol. It
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2953 defaults to @code{c-lineup-C-comments}, which handles the indentation of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2954 most common comment styles, see @ref{Line-Up Functions}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2955 @end defopt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2956
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2957 @defopt c-ignore-auto-fill
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2958 @vindex ignore-auto-fill (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2959 When auto fill mode is enabled, @ccmode{} can selectively ignore it
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2960 depending on the context the line break would occur in, e.g. to never
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2961 break a line automatically inside a string literal. This variable
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2962 takes a list of symbols for the different contexts where auto-filling
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2963 never should occur:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2964
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2965 @table @code
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2966 @item string
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2967 Inside a string or character literal.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2968 @item c
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2969 Inside a C style block comment.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2970 @item c++
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2971 Inside a C++ style line comment.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2972 @item cpp
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2973 Inside a preprocessor directive.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2974 @item code
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2975 Anywhere else, i.e. in normal code.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2976 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2977
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2978 By default, @code{c-ignore-auto-fill} is set to @code{(string cpp
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2979 code)}, which means that when auto-fill mode is activated,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2980 auto-filling only occurs in comments. In literals, it's often
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2981 desirable to have explicit control over newlines. In preprocessor
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2982 directives, the necessary @samp{\} escape character before the newline
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2983 is not automatically inserted, so an automatic line break would
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2984 produce invalid code. In normal code, line breaks are normally
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2985 dictated by some logical structure in the code rather than the last
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2986 whitespace character, so automatic line breaks there will produce poor
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2987 results in the current implementation.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2988 @end defopt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2989
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2990 @vindex comment-multi-line
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2991 If inside a comment and @code{comment-multi-line} (@pxref{Auto Fill,,,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2992 @emacsman{}, @emacsmantitle{}} is non-@code{nil}, the indentation and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2993 line prefix are preserved. If inside a comment and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2994 @code{comment-multi-line} is @code{nil}, a new comment of the same
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2995 type is started on the next line and indented as appropriate for
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2996 comments.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2997
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2998 Note that @ccmode{} sets @code{comment-multi-line} to @code{t} at
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2999 startup. The reason is that @kbd{M-j} could otherwise produce sequences
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3000 of single line block comments for texts that should logically be treated
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3001 as one comment, and the rest of the paragraph handling code
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3002 (e.g. @kbd{M-q} and @kbd{M-a}) can't cope with that, which would lead to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3003 inconsistent behavior.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3004
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3005 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3006 @node Custom Auto-newlines, Clean-ups, Custom Filling and Breaking, Top
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3007 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3008 @chapter Customizing Auto-newlines
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3009 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3010
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3011 @ccmode{} determines whether to insert auto-newlines in two basically
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3012 different ways, depending on the character just typed:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3013
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3014 @table @asis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3015 @item Braces and Colons
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3016 @ccmode{} first determines the syntactic context of the brace or colon
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3017 (@pxref{Syntactic Symbols}), then looks for a corresponding element in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3018 an alist. This element specifies where to put newlines - this is any
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3019 combination of before and after the brace or colon. If no alist
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3020 element is found, newlines are inserted both before and after a brace,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3021 but none are inserted around a colon. See @ref{Hanging Braces} and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3022 @ref{Hanging Colons}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3023
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3024 @item Semicolons and Commas
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3025 The variable @code{c-hanging-semi&comma-criteria} contains a list of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3026 functions which determine whether to insert a newline after a newly
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3027 typed semicolon or comma. @xref{Hanging Semicolons and Commas}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3028 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3029
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3030 The names of these configuration variables contain @samp{hanging}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3031 because they let you @dfn{hang} the pertinent characters. A character
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3032 which introduces a C construct is said to @dfn{hang on the right} when
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3033 it appears at the end of a line after other code, being separated by a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3034 line break from the construct it introduces, like the opening brace in:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3035
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3036 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3037 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3038 while (i < MAX) @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3039 total += entry[i];
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3040 entry [i++] = 0;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3041 @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3042 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3043 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3044
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3045 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3046 A character @dfn{hangs on the left} when it appears at the start of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3047 the line after the construct it closes off, like the above closing
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3048 brace.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3049
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3050 The next chapter, ``Clean-ups'', describes how to configure @ccmode{}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3051 to remove these automatically added newlines in certain specific
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3052 circumstances. @xref{Clean-ups}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3053
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3054 @menu
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3055 * Hanging Braces::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3056 * Hanging Colons::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3057 * Hanging Semicolons and Commas::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3058 @end menu
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3059
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3060
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3061 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3062 @node Hanging Braces, Hanging Colons, Custom Auto-newlines, Custom Auto-newlines
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3063 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3064 @section Hanging Braces
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3065 @cindex hanging braces
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3066 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3067
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3068 To specify which kinds of braces you want auto-newlines put around,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3069 you set the style variable @code{c-hanging-braces-alist}. Its
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3070 structure and semantics are described in this section. Details of how
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3071 to set it up, and its relationship to CC Mode's style system are given
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3072 in @ref{Style Variables}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3073
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3074 Say you wanted an auto-newline after (but not before) the following
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3075 @samp{@{}:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3076
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3077 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3078 if (foo < 17) @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3079 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3080
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3081 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3082 First you need to find the @dfn{syntactic context} of the brace---type
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3083 a @key{RET} before the brace to get it on a line of its
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3084 own@footnote{Also insert a @samp{\} at the end of the previous line if
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3085 you're in AWK Mode.}, then type @kbd{C-c C-s}. That will tell you
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3086 something like:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3087
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3088 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3089 ((substatement-open 1061))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3090 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3091
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3092 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3093 So here you need to put the entry @code{(substatement-open . (after))}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3094 into @code{c-hanging-braces-alist}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3095
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3096 If you don't want any auto-newlines for a particular syntactic symbol,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3097 put this into @code{c-hanging-braces-alist}:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3098
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3099 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3100 (brace-entry-open)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3101 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3102
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3103 If some brace syntactic symbol is not in @code{c-hanging-brace-alist},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3104 its entry is taken by default as @code{(before after)}---insert a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3105 newline both before and after the brace. In place of a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3106 ``before/after'' list you can specify a function in this alist---this
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3107 is useful when the auto newlines depend on the code around the brace.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3108
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3109 @defopt c-hanging-braces-alist
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3110 @vindex hanging-braces-alist (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3111
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3112 This variable is an association list which maps syntactic symbols to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3113 lists of places to insert a newline. @xref{Association
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3114 Lists,,,@lispref{}, @lispreftitle{}}. The key of each element is the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3115 syntactic symbol, the associated value is either @code{nil}, a list,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3116 or a function.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3117
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3118 @table @asis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3119 @item The Key - the syntactic symbol
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3120 The syntactic symbols that are useful as keys in this list are
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3121 @code{brace-list-intro}, @code{statement-cont},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3122 @code{inexpr-class-open}, @code{inexpr-class-close}, and all the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3123 @code{*-open} and @code{*-close} symbols. @xref{Syntactic Symbols},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3124 for a more detailed description of these syntactic symbols, except for
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3125 @code{inexpr-class-open} and @code{inexpr-class-close}, which aren't
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3126 actual syntactic symbols. Elements with any other value as a key get
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3127 ignored.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3128
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3129 The braces of anonymous inner classes in Java are given the special
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3130 symbols @code{inexpr-class-open} and @code{inexpr-class-close}, so that
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3131 they can be distinguished from the braces of normal classes@footnote{The
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3132 braces of anonymous classes produce a combination of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3133 @code{inexpr-class}, and @code{class-open} or @code{class-close} in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3134 normal indentation analysis.}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3135
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3136 Note that the aggregate constructs in Pike mode, @samp{(@{}, @samp{@})},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3137 @samp{([}, @samp{])}, and @samp{(<}, @samp{>)}, do not count as brace
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3138 lists in this regard, even though they do for normal indentation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3139 purposes. It's currently not possible to set automatic newlines on
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3140 these constructs.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3141
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3142 @item The associated value - the ``ACTION'' list or function
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3143 The value associated with each syntactic symbol in this association
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3144 list is called an @var{action}, which can be either a list or a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3145 function which returns a list. @xref{Custom Braces}, for how to use
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3146 a function as a brace hanging @var{action}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3147
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3148 The list @var{action} (or the list returned by @var{action} when it's
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3149 a function) contains some combination of the symbols @code{before} and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3150 @code{after}, directing @ccmode{} where to put newlines in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3151 relationship to the brace being inserted. Thus, if the list contains
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3152 only the symbol @code{after}, then the brace hangs on the right side
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3153 of the line, as in:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3154
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3155 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3156 // here, open braces always `hang'
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3157 void spam( int i ) @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3158 if( i == 7 ) @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3159 dosomething(i);
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3160 @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3161 @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3162 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3163
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3164 When the list contains both @code{after} and @code{before}, the braces
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3165 will appear on a line by themselves, as shown by the close braces in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3166 the above example. The list can also be empty, in which case newlines
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3167 are added neither before nor after the brace.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3168 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3169
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3170 If a syntactic symbol is missing entirely from
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3171 @code{c-hanging-braces-alist}, it's treated in the same way as an
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3172 @var{action} with a list containing @code{before} and @code{after}, so
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3173 that braces by default end up on their own line.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3174
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3175 For example, the default value of @code{c-hanging-braces-alist} is:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3176
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3177 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3178 ((brace-list-open)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3179 (brace-entry-open)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3180 (statement-cont)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3181 (substatement-open after)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3182 (block-close . c-snug-do-while)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3183 (extern-lang-open after)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3184 (namespace-open after)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3185 (module-open after)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3186 (composition-open after)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3187 (inexpr-class-open after)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3188 (inexpr-class-close before))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3189 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3190
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3191 @noindent which says that @code{brace-list-open},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3192 @code{brace-entry-open} and @code{statement-cont}@footnote{Brace lists
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3193 inside statements, such as initializers for static array variables
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3194 inside functions in C, are recognized as @code{statement-cont}. All
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3195 normal substatement blocks are recognized with other symbols.} braces
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3196 should both hang on the right side and allow subsequent text to follow
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3197 on the same line as the brace. Also, @code{substatement-open},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3198 @code{extern-lang-open}, and @code{inexpr-class-open} braces should hang
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3199 on the right side, but subsequent text should follow on the next line.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3200 The opposite holds for @code{inexpr-class-close} braces; they won't
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3201 hang, but the following text continues on the same line. Here, in the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3202 @code{block-close} entry, you also see an example of using a function as
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3203 an @var{action}. In all other cases, braces are put on a line by
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3204 themselves.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3205 @end defopt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3206
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3207 @menu
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3208 * Custom Braces::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3209 @end menu
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3210
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3211 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3212 @node Custom Braces, , Hanging Braces, Hanging Braces
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3213 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3214 @subsection Custom Brace Hanging
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3215 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3216
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3217 @vindex c-hanging-braces-alist
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3218 @vindex hanging-braces-alist (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3219 @cindex action functions
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3220 Syntactic symbols aren't the only place where you can customize
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3221 @ccmode{} with the lisp equivalent of callback functions. Remember
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3222 that @var{action}s are usually a list containing some combination of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3223 the symbols @code{before} and @code{after} (@pxref{Hanging Braces}).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3224 For more flexibility, you can instead specify brace ``hanginess'' by
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3225 giving a syntactic symbol an @dfn{action function} in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3226 @code{c-hanging-braces-alist}; this function determines the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3227 ``hanginess'' of a brace, usually by looking at the code near it.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3228
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3229 @cindex customization, brace hanging
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3230 An action function is called with two arguments: the syntactic symbol
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3231 for the brace (e.g. @code{substatement-open}), and the buffer position
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3232 where the brace has been inserted. Point is undefined on entry to an
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3233 action function, but the function must preserve it (e.g. by using
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3234 @code{save-excursion}). The return value should be a list containing
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3235 some combination of @code{before} and @code{after}, including neither
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3236 of them (i.e. @code{nil}).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3237
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3238 @defvar c-syntactic-context
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3239 @vindex syntactic-context (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3240 During the call to the indentation or brace hanging @var{action}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3241 function, this variable is bound to the full syntactic analysis list.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3242 This might be, for example, @samp{((block-close 73))}. Don't ever
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3243 give @code{c-syntactic-context} a value yourself---this would disrupt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3244 the proper functioning of @ccmode{}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3245
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3246 This variable is also bound in three other circumstances:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3247 (i)@w{ }when calling a c-hanging-semi&comma-criteria function
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3248 (@pxref{Hanging Semicolons and Commas}); (ii)@w{ }when calling a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3249 line-up function (@pxref{Custom Line-Up}); (iii)@w{ }when calling a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3250 c-special-indent-hook function (@pxref{Other Indentation}).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3251 @end defvar
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3252
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3253 As an example, @ccmode{} itself uses this feature to dynamically
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3254 determine the hanginess of braces which close ``do-while''
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3255 constructs:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3256
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3257 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3258 void do_list( int count, char** atleast_one_string )
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3259 @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3260 int i=0;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3261 do @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3262 handle_string( atleast_one_string[i] );
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3263 i++;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3264 @} while( i < count );
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3265 @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3266 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3267
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3268 @ccmode{} assigns the @code{block-close} syntactic symbol to the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3269 brace that closes the @code{do} construct, and normally we'd like the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3270 line that follows a @code{block-close} brace to begin on a separate
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3271 line. However, with ``do-while'' constructs, we want the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3272 @code{while} clause to follow the closing brace. To do this, we
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3273 associate the @code{block-close} symbol with the @var{action} function
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3274 @code{c-snug-do-while}:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3275
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3276 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3277 (defun c-snug-do-while (syntax pos)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3278 "Dynamically calculate brace hanginess for do-while statements."
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3279 (save-excursion
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3280 (let (langelem)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3281 (if (and (eq syntax 'block-close)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3282 (setq langelem (assq 'block-close c-syntactic-context))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3283 (progn (goto-char (cdr langelem))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3284 (if (= (following-char) ?@{)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3285 (forward-sexp -1))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3286 (looking-at "\\<do\\>[^_]")))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3287 '(before)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3288 '(before after)))))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3289 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3290
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3291 @findex c-snug-do-while
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3292 @findex snug-do-while (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3293 This function simply looks to see if the brace closes a ``do-while''
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3294 clause and if so, returns the list @samp{(before)} indicating
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3295 that a newline should be inserted before the brace, but not after it.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3296 In all other cases, it returns the list @samp{(before after)} so
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3297 that the brace appears on a line by itself.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3298
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3299 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3300 @node Hanging Colons, Hanging Semicolons and Commas, Hanging Braces, Custom Auto-newlines
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3301 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3302 @section Hanging Colons
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3303 @cindex hanging colons
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3304 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3305
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3306 @cindex customization, colon hanging
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3307 @vindex c-hanging-colons-alist
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3308 @vindex hanging-colons-alist (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3309
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3310 Using a mechanism similar to brace hanging (@pxref{Hanging Braces}),
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3311 colons can also be made to hang using the style variable
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3312 @code{c-hanging-colons-alist} - When a colon is typed, @ccmode
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3313 determines its syntactic context, looks this up in the alist
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3314 @code{c-changing-colons-alist} and inserts up to two newlines
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3315 accordingly. Here, however, If @ccmode fails to find an entry for a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3316 syntactic symbol in the alist, no newlines are inserted around the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3317 newly typed colon.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3318
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3319 @defopt c-hanging-colons-alist
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3320 @vindex hanging-colons-alist (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3321
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3322 @table @asis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3323 @item The Key - the syntactic symbol
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3324 The syntactic symbols appropriate as keys in this association list
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3325 are: @code{case-label}, @code{label}, @code{access-label},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3326 @code{member-init-intro}, and @code{inher-intro}. @xref{Syntactic
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3327 Symbols}. Elements with any other value as a key get ignored.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3328
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3329 @item The associate value - the ``ACTION'' list
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3330 The @var{action} here is simply a list containing a combination of the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3331 symbols @code{before} and @code{after}. Unlike in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3332 @code{c-hanging-braces-alist}, functions as @var{actions} are not
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3333 supported - there doesn't seem to be any need for them.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3334 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3335 @end defopt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3336
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3337 In C++, double-colons are used as a scope operator but because these
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3338 colons always appear right next to each other, newlines before and after
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3339 them are controlled by a different mechanism, called @dfn{clean-ups} in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3340 @ccmode{}. @xref{Clean-ups}, for details.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3341
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3342 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3343 @node Hanging Semicolons and Commas, , Hanging Colons, Custom Auto-newlines
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3344 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3345 @section Hanging Semicolons and Commas
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3346 @cindex hanging semicolons
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3347 @cindex hanging commas
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3348 @cindex customization, semicolon newlines
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3349 @cindex customization, comma newlines
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3350 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3351
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3352 @defopt c-hanging-semi&comma-criteria
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3353 @vindex hanging-semi&comma-criteria (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3354 This style variable takes a list of functions; these get called when
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3355 you type a semicolon or comma. The functions are called in order
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3356 without arguments. When these functions are entered, point is just
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3357 after the newly inserted @samp{;} or @samp{,} and they must preserve
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3358 point (e.g., by using @code{save-excursion}). During the call, the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3359 variable @code{c-syntactic-context} is bound to the syntactic context
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3360 of the current line@footnote{This was first introduced in @ccmode{}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3361 5.31.} @pxref{Custom Braces}. These functions don't insert newlines
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3362 themselves, rather they direct @ccmode{} whether or not to do so.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3363 They should return one of the following values:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3364
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3365 @table @code
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3366 @item t
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3367 A newline is to be inserted after the @samp{;} or @samp{,}, and no
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3368 more functions from the list are to be called.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3369 @item stop
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3370 No more functions from the list are to be called, and no newline is to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3371 be inserted.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3372 @item nil
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3373 No determination has been made, and the next function in the list is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3374 to be called.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3375 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3376
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3377 Note that auto-newlines are never inserted @emph{before} a semicolon
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3378 or comma. If every function in the list is called without a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3379 determination being made, then no newline is added.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3380
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3381 In AWK mode, this variable is set by default to @code{nil}. In the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3382 other modes, the default value is a list containing a single function,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3383 @code{c-semi&comma-inside-parenlist}. This inserts newlines after all
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3384 semicolons, apart from those separating @code{for}-clause statements.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3385 @end defopt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3386
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3387 @defun c-semi&comma-no-newlines-before-nonblanks
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3388 @findex semi&comma-no-newlines-before-nonblanks (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3389 This is an example of a criteria function, provided by @ccmode{}. It
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3390 prevents newlines from being inserted after semicolons when there is a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3391 non-blank following line. Otherwise, it makes no determination. To
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3392 use, add this function to the front of the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3393 @code{c-hanging-semi&comma-criteria} list.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3394
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3395 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3396 (defun c-semi&comma-no-newlines-before-nonblanks ()
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3397 (save-excursion
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3398 (if (and (eq last-command-char ?\;)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3399 (zerop (forward-line 1))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3400 (not (looking-at "^[ \t]*$")))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3401 'stop
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3402 nil)))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3403 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3404 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3405
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3406 @defun c-semi&comma-inside-parenlist
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3407 @findex semi&comma-inside-parenlist (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3408 @defunx c-semi&comma-no-newlines-for-oneline-inliners
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3409 @findex semi&comma-no-newlines-for-oneline-inliners (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3410 The function @code{c-semi&comma-inside-parenlist} is what prevents
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3411 newlines from being inserted inside the parenthesis list of @code{for}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3412 statements. In addition to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3413 @code{c-semi&comma-no-newlines-before-nonblanks} described above,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3414 @ccmode{} also comes with the criteria function
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3415 @code{c-semi&comma-no-newlines-for-oneline-inliners}, which suppresses
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3416 newlines after semicolons inside one-line inline method definitions
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3417 (e.g. in C++ or Java).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3418 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3419
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3420
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3421 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3422 @node Clean-ups, Indentation Engine Basics, Custom Auto-newlines, Top
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3423 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3424 @chapter Clean-ups
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3425 @cindex clean-ups
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3426 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3427
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3428 @dfn{Clean-ups} are mechanisms which remove (or exceptionally, add)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3429 whitespace in specific circumstances and are complementary to colon
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3430 and brace hanging. You enable a clean-up by adding its symbol into
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3431 @code{c-cleanup-list}, e.g. like this:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3432
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3433 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3434 (add-to-list 'c-cleanup-list 'space-before-funcall)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3435 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3436
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3437 On the surface, it would seem that clean-ups overlap the functionality
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3438 provided by the @code{c-hanging-*-alist} variables. Clean-ups,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3439 however, are used to adjust code ``after-the-fact'', i.e. to adjust
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3440 the whitespace in constructs later than when they were typed.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3441
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3442 Most of the clean-ups remove automatically inserted newlines, and are
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3443 only active when auto-newline minor mode is turned on. Others will
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3444 work all the time. Note that clean-ups are only performed when there
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3445 is nothing but whitespace appearing between the individual components
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3446 of the construct, and (apart from @code{comment-close-slash}) when the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3447 construct does not occur within a literal (@pxref{Auto-newlines}).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3448
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3449 @defopt c-cleanup-list
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3450 @vindex cleanup-list (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3451 @cindex literal
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3452
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3453 You configure @ccmode{}'s clean-ups by setting the style variable
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3454 @code{c-cleanup-list}, which is a list of clean-up symbols. By
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3455 default, @ccmode{} cleans up only the @code{scope-operator} construct,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3456 which is necessary for proper C++ support.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3457 @end defopt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3458
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3459 These are the clean-ups that are only active when electric and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3460 auto-newline minor modes are enabled:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3461
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3462 @c TBD: Would like to use some sort of @deffoo here; @table indents a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3463 @c bit too much in dvi output.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3464 @table @code
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3465 @item brace-else-brace
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3466 Clean up @samp{@} else @{} constructs by placing the entire construct on
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3467 a single line. Clean up occurs when the open brace after the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3468 @samp{else} is typed. So for example, this:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3469
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3470 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3471 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3472 void spam(int i)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3473 @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3474 if( i==7 ) @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3475 dosomething();
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3476 @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3477 else
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3478 @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3479 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3480 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3481
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3482 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3483 appears like this after the last open brace is typed:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3484
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3485 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3486 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3487 void spam(int i)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3488 @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3489 if( i==7 ) @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3490 dosomething();
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3491 @} else @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3492 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3493 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3494
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3495 @item brace-elseif-brace
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3496 Similar to the @code{brace-else-brace} clean-up, but this cleans up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3497 @samp{@} else if (...) @{} constructs. For example:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3498
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3499 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3500 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3501 void spam(int i)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3502 @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3503 if( i==7 ) @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3504 dosomething();
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3505 @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3506 else if( i==3 )
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3507 @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3508 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3509 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3510
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3511 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3512 appears like this after the last open parenthesis is typed:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3513
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3514 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3515 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3516 void spam(int i)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3517 @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3518 if( i==7 ) @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3519 dosomething();
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3520 @} else if(
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3521 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3522 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3523
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3524 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3525 and like this after the last open brace is typed:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3526
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3527 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3528 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3529 void spam(int i)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3530 @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3531 if( i==7 ) @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3532 dosomething();
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3533 @} else if( i==3 ) @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3534 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3535 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3536
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3537 @item brace-catch-brace
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3538 Analogous to @code{brace-elseif-brace}, but cleans up @samp{@} catch
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3539 (...) @{} in C++ and Java mode.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3540
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3541 @item empty-defun-braces
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3542 Clean up braces following a top-level function or class definition that
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3543 contains no body. Clean up occurs when the closing brace is typed.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3544 Thus the following:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3545
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3546 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3547 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3548 class Spam
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3549 @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3550 @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3551 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3552 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3553
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3554 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3555 is transformed into this when the close brace is typed:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3556
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3557 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3558 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3559 class Spam
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3560 @{@}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3561 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3562 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3563
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3564 @item defun-close-semi
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3565 Clean up the terminating semicolon on top-level function or class
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3566 definitions when they follow a close brace. Clean up occurs when the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3567 semicolon is typed. So for example, the following:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3568
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3569 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3570 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3571 class Spam
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3572 @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3573 ...
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3574 @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3575 ;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3576 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3577 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3578
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3579 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3580 is transformed into this when the semicolon is typed:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3581
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3582 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3583 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3584 class Spam
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3585 @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3586 ...
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3587 @};
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3588 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3589 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3590
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3591 @item list-close-comma
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3592 Clean up commas following braces in array and aggregate initializers.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3593 Clean up occurs when the comma is typed. The space before the comma
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3594 is zapped just like the space before the semicolon in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3595 @code{defun-close-semi}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3596
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3597 @item scope-operator
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3598 Clean up double colons which might designate a C++ scope operator split
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3599 across multiple lines@footnote{Certain C++ constructs introduce
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3600 ambiguous situations, so @code{scope-operator} clean-ups might not
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3601 always be correct. This usually only occurs when scoped identifiers
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3602 appear in switch label tags.}. Clean up occurs when the second colon is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3603 typed. You will always want @code{scope-operator} in the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3604 @code{c-cleanup-list} when you are editing C++ code.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3605
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3606 @item one-liner-defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3607 Clean up a single line of code enclosed by defun braces by removing
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3608 the whitespace before and after the code. The clean-up happens when
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3609 the closing brace is typed. If the variable
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3610 @code{c-max-one-liner-length} is set, the cleanup is only done if the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3611 resulting line would be no longer than the value of that variable.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3612
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3613 For example, consider this AWK code:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3614
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3615 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3616 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3617 BEGIN @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3618 FS = "\t" # use <TAB> as a field separator
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3619 @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3620 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3621 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3622
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3623 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3624 It gets compacted to the following when the closing brace is typed:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3625
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3626 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3627 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3628 BEGIN @{FS = "\t"@} # use <TAB> as a field separator
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3629 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3630 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3631
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3632 @defopt c-max-one-liner-length
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3633 @vindex max-one-liner-length (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3634 The maximum length of the resulting line for which the clean-up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3635 @code{one-liner-defun} will be triggered. This length is that of the entire
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3636 line, including any leading whitespace and any trailing comment. Its
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3637 default value is 80. If the value is zero or @code{nil}, no limit
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3638 applies.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3639 @end defopt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3640 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3641
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3642 The following clean-ups are always active when they occur on
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3643 @code{c-cleanup-list}, regardless of whether Electric minor mode or
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3644 Auto-newline minor mode are enabled:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3645
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3646 @table @code
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3647 @item space-before-funcall
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3648 Insert a space between the function name and the opening parenthesis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3649 of a function call. This produces function calls in the style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3650 mandated by the GNU coding standards, e.g. @samp{signal@w{ }(SIGINT,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3651 SIG_IGN)} and @samp{abort@w{ }()}. Clean up occurs when the opening
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3652 parenthesis is typed. This clean-up should never be active in AWK
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3653 Mode, since such a space is syntactically invalid for user defined
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3654 functions.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3655
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3656 @item compact-empty-funcall
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3657 Clean up any space between the function name and the opening parenthesis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3658 of a function call that has no arguments. This is typically used
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3659 together with @code{space-before-funcall} if you prefer the GNU function
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3660 call style for functions with arguments but think it looks ugly when
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3661 it's only an empty parenthesis pair. I.e. you will get @samp{signal
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3662 (SIGINT, SIG_IGN)}, but @samp{abort()}. Clean up occurs when the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3663 closing parenthesis is typed.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3664
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3665 @item comment-close-slash
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3666 When inside a block comment, terminate the comment when you type a slash
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3667 at the beginning of a line (i.e. immediately after the comment prefix).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3668 This clean-up removes whitespace preceding the slash and if needed,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3669 inserts a star to complete the token @samp{*/}. Type @kbd{C-q /} in this
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3670 situation if you just want a literal @samp{/} inserted.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3671 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3672
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3673
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3674 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3675 @node Indentation Engine Basics, Customizing Indentation, Clean-ups, Top
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3676 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3677 @chapter Indentation Engine Basics
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3678 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3679
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3680 This chapter will briefly cover how @ccmode{} indents lines of code.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3681 It is helpful to understand the indentation model being used so that
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3682 you will know how to customize @ccmode{} for your personal coding
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3683 style. All the details are in @ref{Customizing Indentation}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3684
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3685 @ccmode{} has an indentation engine that provides a flexible and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3686 general mechanism for customizing indentation. When @ccmode{} indents
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3687 a line of code, it separates its calculations into two steps:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3688
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3689 @enumerate
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3690 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3691 @cindex syntactic symbol
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3692 @cindex anchor position
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3693 It analyzes the line to determine its @dfn{syntactic symbol(s)} (the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3694 kind of language construct it's looking at) and its @dfn{anchor
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3695 position} (the position earlier in the file that @ccmode{} will indent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3696 the line relative to). The anchor position might be the location of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3697 an opening brace in the previous line, for example. @xref{Syntactic
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3698 Analysis}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3699 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3700 @cindex offsets
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3701 @cindex indentation offset specifications
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3702 It looks up the syntactic symbol(s) in the configuration to get the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3703 corresponding @dfn{offset(s)}. The symbol @code{+}, which means
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3704 ``indent this line one more level'' is a typical offset. @ccmode{}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3705 then applies these offset(s) to the anchor position, giving the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3706 indentation for the line. The different sorts of offsets are
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3707 described in @ref{c-offsets-alist}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3708 @end enumerate
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3709
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3710 In exceptional circumstances, the syntax directed indentation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3711 described here may be a nuisance rather than a help. You can disable
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3712 it by setting @code{c-syntactic-indentation} to @code{nil}. (To set
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3713 the variable interactively, @ref{Minor Modes}).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3714
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3715 @defopt c-syntactic-indentation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3716 @vindex syntactic-indentation (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3717 When this is non-@code{nil} (which it is by default), the indentation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3718 of code is done according to its syntactic structure. When it's
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3719 @code{nil}, every line is just indented to the same level as the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3720 previous one, and @kbd{TAB} (@code{c-indent-command}) adjusts the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3721 indentation in steps of @code{c-basic-offset}. The current style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3722 (@pxref{Config Basics}) then has no effect on indentation, nor do any
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3723 of the variables associated with indentation, not even
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3724 @code{c-special-indent-hook}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3725 @end defopt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3726
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3727 @menu
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3728 * Syntactic Analysis::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3729 * Syntactic Symbols::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3730 * Indentation Calculation::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3731 @end menu
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3732
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3733
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3734 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3735 @node Syntactic Analysis, Syntactic Symbols, Indentation Engine Basics, Indentation Engine Basics
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3736 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3737 @section Syntactic Analysis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3738 @cindex syntactic analysis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3739 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3740
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3741 @cindex syntactic element
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3742 @cindex syntactic context
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3743 The first thing @ccmode{} does when indenting a line of code, is to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3744 analyze the line, determining the @dfn{syntactic context} of the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3745 (first) construct on that line. It's a list of @dfn{syntactic
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3746 elements}, where each syntactic element in turn is a list@footnote{In
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3747 @ccmode 5.28 and earlier, a syntactic element was a dotted pair; the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3748 cons was the syntactic symbol and the cdr was the anchor position.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3749 For compatibility's sake, the parameter passed to a line-up function
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3750 still has this dotted pair form (@pxref{Custom Line-Up}).} Here is a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3751 brief and typical example:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3752
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3753 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3754 ((defun-block-intro 1959))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3755 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3756
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3757 @cindex syntactic symbol
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3758 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3759 The first thing inside each syntactic element is always a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3760 @dfn{syntactic symbol}. It describes the kind of construct that was
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3761 recognized, e.g. @code{statement}, @code{substatement},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3762 @code{class-open}, @code{class-close}, etc. @xref{Syntactic Symbols},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3763 for a complete list of currently recognized syntactic symbols and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3764 their semantics. The remaining entries are various data associated
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3765 with the recognized construct - there might be zero or more.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3766
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3767 @cindex anchor position
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3768 Conceptually, a line of code is always indented relative to some
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3769 position higher up in the buffer (typically the indentation of the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3770 previous line). That position is the @dfn{anchor position} in the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3771 syntactic element. If there is an entry after the syntactic symbol in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3772 the syntactic element list then it's either nil or that anchor position.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3773
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3774 Here is an example. Suppose we had the following code as the only thing
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3775 in a C++ buffer @footnote{The line numbers in this and future examples
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3776 don't actually appear in the buffer, of course!}:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3777
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3778 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3779 1: void swap( int& a, int& b )
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3780 2: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3781 3: int tmp = a;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3782 4: a = b;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3783 5: b = tmp;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3784 6: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3785 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3786
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3787 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3788 We can use @kbd{C-c C-s} (@code{c-show-syntactic-information}) to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3789 report what the syntactic analysis is for the current line:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3790
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3791 @table @asis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3792 @item @kbd{C-c C-s} (@code{c-show-syntactic-information})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3793 @kindex C-c C-s
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3794 @findex c-show-syntactic-information
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3795 @findex show-syntactic-information (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3796 This command calculates the syntactic analysis of the current line and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3797 displays it in the minibuffer. The command also highlights the anchor
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3798 position(s).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3799 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3800
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3801 Running this command on line 4 of this example, we'd see in the echo
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3802 area@footnote{With a universal argument (i.e. @kbd{C-u C-c C-s}) the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3803 analysis is inserted into the buffer as a comment on the current
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3804 line.}:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3805
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3806 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3807 ((statement 35))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3808 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3809
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3810 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3811 and the @samp{i} of @code{int} on line 3 would be highlighted. This
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3812 tells us that the line is a statement and it is indented relative to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3813 buffer position 35, the highlighted position. If you were to move
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3814 point to line 3 and hit @kbd{C-c C-s}, you would see:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3815
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3816 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3817 ((defun-block-intro 29))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3818 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3819
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3820 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3821 This indicates that the @samp{int} line is the first statement in a top
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3822 level function block, and is indented relative to buffer position 29,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3823 which is the brace just after the function header.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3824
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3825 Here's another example:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3826
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3827 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3828 1: int add( int val, int incr, int doit )
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3829 2: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3830 3: if( doit )
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3831 4: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3832 5: return( val + incr );
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3833 6: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3834 7: return( val );
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3835 8: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3836 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3837
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3838 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3839 Hitting @kbd{C-c C-s} on line 4 gives us:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3840
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3841 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3842 ((substatement-open 46))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3843 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3844
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3845 @cindex substatement
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3846 @cindex substatement block
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3847 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3848 which tells us that this is a brace that @emph{opens} a substatement
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3849 block. @footnote{A @dfn{substatement} is the line after a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3850 conditional statement, such as @code{if}, @code{else}, @code{while},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3851 @code{do}, @code{switch}, etc. A @dfn{substatement
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3852 block} is a brace block following one of these conditional statements.}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3853
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3854 @cindex comment-only line
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3855 Syntactic contexts can contain more than one element, and syntactic
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3856 elements need not have anchor positions. The most common example of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3857 this is a @dfn{comment-only line}:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3858
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3859 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3860 1: void draw_list( List<Drawables>& drawables )
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3861 2: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3862 3: // call the virtual draw() method on each element in list
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3863 4: for( int i=0; i < drawables.count(), ++i )
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3864 5: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3865 6: drawables[i].draw();
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3866 7: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3867 8: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3868 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3869
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3870 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3871 Hitting @kbd{C-c C-s} on line 3 of this example gives:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3872
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3873 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3874 ((comment-intro) (defun-block-intro 46))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3875 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3876
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3877 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3878 and you can see that the syntactic context contains two syntactic
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3879 elements. Notice that the first element, @samp{(comment-intro)}, has no
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3880 anchor position.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3881
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3882
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3883 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3884 @node Syntactic Symbols, Indentation Calculation, Syntactic Analysis, Indentation Engine Basics
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3885 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3886 @section Syntactic Symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3887 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3888
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3889 @cindex syntactic symbols, brief list
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3890 @vindex c-offsets-alist
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3891 @vindex offsets-alist (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3892 This section is a complete list of the syntactic symbols which appear
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3893 in the @code{c-offsets-alist} style variable, along with brief
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3894 descriptions. The previous section (@pxref{Syntactic Analysis})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3895 states what syntactic symbols are and how the indentation engine uses
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3896 them.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3897
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3898 More detailed descriptions of these symbols, together with snippets of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3899 source code to which they apply, appear in the examples in the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3900 subsections below. Note that, in the interests of brevity, the anchor
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3901 position associated with most syntactic symbols is @emph{not}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3902 specified. In cases of doubt, type @kbd{C-c C-s} on a pertinent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3903 line---this highlights the anchor position.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3904
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3905 @ssindex -open symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3906 @ssindex -close symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3907 @ssindex -block-intro symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3908 The syntactic symbols which indicate brace constructs follow a general
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3909 naming convention. When a line begins with an open or close brace,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3910 its syntactic symbol will contain the suffix @code{-open} or
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3911 @code{-close} respectively. The first line within the brace block
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3912 construct will contain the suffix @code{-block-intro}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3913
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3914 @ssindex -intro symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3915 @ssindex -cont symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3916 In constructs which can span several lines, a distinction is usually
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3917 made between the first line that introduces the construct and the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3918 lines that continue it. The syntactic symbols that indicate these
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3919 lines will contain the suffixes @code{-intro} or @code{-cont}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3920 respectively.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3921
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3922 The best way to understand how all this works is by looking at some
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3923 examples. Remember that you can see the syntax of any source code
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3924 line by using @kbd{C-c C-s}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3925
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3926 @table @code
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3927 @item string
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3928 Inside a multiline string. @ref{Literal Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3929 @item c
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3930 Inside a multiline C style block comment. @ref{Literal Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3931 @item defun-open
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3932 Brace that opens a top-level function definition. @ref{Function
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3933 Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3934 @item defun-close
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3935 Brace that closes a top-level function definition. @ref{Function
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3936 Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3937 @item defun-block-intro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3938 The first line in a top-level defun. @ref{Function Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3939 @item class-open
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3940 Brace that opens a class definition. @ref{Class Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3941 @item class-close
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3942 Brace that closes a class definition. @ref{Class Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3943 @item inline-open
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3944 Brace that opens an in-class inline method. @ref{Class Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3945 @item inline-close
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3946 Brace that closes an in-class inline method. @ref{Class Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3947 @item func-decl-cont
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3948 The region between a function definition's argument list and the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3949 function opening brace (excluding K&R argument declarations). In C,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3950 you cannot put anything but whitespace and comments in this region,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3951 however in C++ and Java, @code{throws} declarations and other things
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3952 can appear here. @ref{Literal Symbols}. @c @emph{FIXME!!! Can it not
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3953 @c go somewhere better?}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3954 @item knr-argdecl-intro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3955 First line of a K&R C argument declaration. @ref{K&R Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3956 @item knr-argdecl
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3957 Subsequent lines in a K&R C argument declaration. @ref{K&R Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3958 @item topmost-intro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3959 The first line in a ``topmost'' definition. @ref{Function Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3960 @item topmost-intro-cont
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3961 Topmost definition continuation lines. This is only used in the parts
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3962 that aren't covered by other symbols such as @code{func-decl-cont} and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3963 @code{knr-argdecl}. @ref{Function Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3964 @item member-init-intro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3965 First line in a member initialization list. @ref{Class Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3966 @item member-init-cont
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3967 Subsequent member initialization list lines. @ref{Class Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3968 @item inher-intro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3969 First line of a multiple inheritance list. @ref{Class Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3970 @item inher-cont
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3971 Subsequent multiple inheritance lines. @ref{Class Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3972 @item block-open
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3973 Statement block open brace. @ref{Literal Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3974 @item block-close
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3975 Statement block close brace. @ref{Conditional Construct Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3976 @item brace-list-open
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3977 Open brace of an enum or static array list. @ref{Brace List Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3978 @item brace-list-close
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3979 Close brace of an enum or static array list. @ref{Brace List Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3980 @item brace-list-intro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3981 First line in an enum or static array list. @ref{Brace List Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3982 @item brace-list-entry
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3983 Subsequent lines in an enum or static array list. @ref{Brace List
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3984 Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3985 @item brace-entry-open
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3986 Subsequent lines in an enum or static array list where the line begins
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3987 with an open brace. @ref{Brace List Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3988 @item statement
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3989 A statement. @ref{Function Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3990 @item statement-cont
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3991 A continuation of a statement. @ref{Function Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3992 @item statement-block-intro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3993 The first line in a new statement block. @ref{Conditional Construct
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3994 Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3995 @item statement-case-intro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3996 The first line in a case block. @ref{Switch Statement Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3997 @item statement-case-open
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3998 The first line in a case block that starts with a brace. @ref{Switch
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3999 Statement Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4000 @item substatement
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4001 The first line after a conditional or loop construct.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4002 @ref{Conditional Construct Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4003 @item substatement-open
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4004 The brace that opens a substatement block. @ref{Conditional Construct
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4005 Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4006 @item substatement-label
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4007 The first line after a conditional or loop construct if it's a label.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4008 @ref{Conditional Construct Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4009 @item case-label
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4010 A label in a @code{switch} block. @ref{Switch Statement Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4011 @item access-label
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4012 C++ access control label. @ref{Class Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4013 @item label
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4014 Any other label. @ref{Literal Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4015 @item do-while-closure
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4016 The @code{while} line that ends a @code{do}-@code{while} construct.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4017 @ref{Conditional Construct Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4018 @item else-clause
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4019 The @code{else} line of an @code{if}-@code{else} construct.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4020 @ref{Conditional Construct Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4021 @item catch-clause
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4022 The @code{catch} or @code{finally} (in Java) line of a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4023 @code{try}-@code{catch} construct. @ref{Conditional Construct
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4024 Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4025 @item comment-intro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4026 A line containing only a comment introduction. @ref{Literal Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4027 @item arglist-intro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4028 The first line in an argument list. @ref{Paren List Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4029 @item arglist-cont
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4030 Subsequent argument list lines when no arguments follow on the same
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4031 line as the arglist opening paren. @ref{Paren List Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4032 @item arglist-cont-nonempty
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4033 Subsequent argument list lines when at least one argument follows on
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4034 the same line as the arglist opening paren. @ref{Paren List Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4035 @item arglist-close
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4036 The solo close paren of an argument list. @ref{Paren List Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4037 @item stream-op
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4038 Lines continuing a stream operator (C++ only). @ref{Literal
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4039 Symbols}. @c @emph{FIXME!!! Can this not be moved somewhere better?}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4040 @item inclass
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4041 The line is nested inside a class definition. @ref{Class Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4042 @item cpp-macro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4043 The start of a preprocessor macro definition. @ref{Literal Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4044 @item cpp-define-intro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4045 The first line inside a multiline preprocessor macro if
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4046 @code{c-syntactic-indentation-in-macros} is set. @ref{Multiline Macro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4047 Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4048 @item cpp-macro-cont
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4049 All lines inside multiline preprocessor macros if
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4050 @code{c-syntactic-indentation-in-macros} is @code{nil}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4051 @ref{Multiline Macro Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4052 @item friend
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4053 A C++ friend declaration. @ref{Class Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4054 @item objc-method-intro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4055 The first line of an Objective-C method definition. @ref{Objective-C
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4056 Method Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4057 @item objc-method-args-cont
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4058 Lines continuing an Objective-C method definition. @ref{Objective-C
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4059 Method Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4060 @item objc-method-call-cont
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4061 Lines continuing an Objective-C method call. @ref{Objective-C Method
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4062 Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4063 @item extern-lang-open
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4064 Brace that opens an @code{extern} block (e.g. @code{extern "C"
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4065 @{...@}}). @ref{External Scope Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4066 @item extern-lang-close
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4067 Brace that closes an @code{extern} block. @ref{External Scope
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4068 Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4069 @item inextern-lang
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4070 Analogous to @code{inclass} syntactic symbol, but used inside
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4071 @code{extern} blocks. @ref{External Scope Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4072 @item namespace-open
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4073 @itemx namespace-close
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4074 @itemx innamespace
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4075 These are analogous to the three @code{extern-lang} symbols above, but
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4076 are returned for C++ namespace blocks. @ref{External Scope Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4077 @item module-open
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4078 @itemx module-close
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4079 @itemx inmodule
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4080 Analogous to the above, but for CORBA IDL @code{module} blocks.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4081 @ref{External Scope Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4082 @item composition-open
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4083 @itemx composition-close
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4084 @itemx incomposition
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4085 Analogous to the above, but for CORBA CIDL @code{composition} blocks.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4086 @ref{External Scope Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4087 @item template-args-cont
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4088 C++ template argument list continuations. @ref{Class Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4089 @item inlambda
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4090 Analogous to @code{inclass} syntactic symbol, but used inside lambda
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4091 (i.e. anonymous) functions. Only used in Pike mode. @ref{Statement
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4092 Block Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4093 @item lambda-intro-cont
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4094 Lines continuing the header of a lambda function, i.e. between the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4095 @code{lambda} keyword and the function body. Only used in Pike mode.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4096 @ref{Statement Block Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4097 @item inexpr-statement
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4098 A statement block inside an expression. The gcc C and C++ extension
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4099 for this is recognized. It's also used for the special functions that
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4100 take a statement block as an argument in Pike. @ref{Statement Block
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4101 Symbols}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4102 @item inexpr-class
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4103 A class definition inside an expression. This is used for anonymous
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4104 classes in Java. It's also used for anonymous array initializers in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4105 Java. @ref{Anonymous Class Symbol}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4106 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4107
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4108 @menu
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4109 * Function Symbols::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4110 * Class Symbols::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4111 * Conditional Construct Symbols::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4112 * Switch Statement Symbols::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4113 * Brace List Symbols::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4114 * External Scope Symbols::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4115 * Paren List Symbols::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4116 * Literal Symbols::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4117 * Multiline Macro Symbols::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4118 * Objective-C Method Symbols::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4119 * Anonymous Class Symbol::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4120 * Statement Block Symbols::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4121 * K&R Symbols::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4122 @end menu
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4123
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4124 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4125 @node Function Symbols, Class Symbols, Syntactic Symbols, Syntactic Symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4126 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4127 @subsection Function Symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4128 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4129
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4130 This example shows a typical function declaration.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4131
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4132 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4133 1: void
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4134 2: swap( int& a, int& b )
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4135 3: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4136 4: int tmp = a;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4137 5: a = b;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4138 6: b = tmp;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4139 7: int ignored =
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4140 8: a + b;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4141 9: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4142 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4143
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4144 @ssindex topmost-intro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4145 @ssindex topmost-intro-cont
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4146 @ssindex defun-open
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4147 @ssindex defun-close
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4148 @ssindex defun-block-intro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4149 Line 1 shows a @code{topmost-intro} since it is the first line that
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4150 introduces a top-level construct. Line 2 is a continuation of the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4151 top-level construct introduction so it has the syntax
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4152 @code{topmost-intro-cont}. Line 3 shows a @code{defun-open} since it is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4153 the brace that opens a top-level function definition. Line 9 is the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4154 corresponding
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4155 @code{defun-close} since it contains the brace that closes the top-level
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4156 function definition. Line 4 is a @code{defun-block-intro}, i.e. it is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4157 the first line of a brace-block, enclosed in a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4158 top-level function definition.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4159
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4160 @ssindex statement
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4161 @ssindex statement-cont
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4162 Lines 5, 6, and 7 are all given @code{statement} syntax since there
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4163 isn't much special about them. Note however that line 8 is given
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4164 @code{statement-cont} syntax since it continues the statement begun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4165 on the previous line.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4166
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4167 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4168 @node Class Symbols, Conditional Construct Symbols, Function Symbols, Syntactic Symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4169 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4170 @subsection Class related Symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4171 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4172
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4173 Here's an example which illustrates some C++ class syntactic symbols:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4174
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4175 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4176 1: class Bass
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4177 2: : public Guitar,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4178 3: public Amplifiable
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4179 4: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4180 5: public:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4181 6: Bass()
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4182 7: : eString( new BassString( 0.105 )),
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4183 8: aString( new BassString( 0.085 )),
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4184 9: dString( new BassString( 0.065 )),
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4185 10: gString( new BassString( 0.045 ))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4186 11: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4187 12: eString.tune( 'E' );
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4188 13: aString.tune( 'A' );
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4189 14: dString.tune( 'D' );
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4190 15: gString.tune( 'G' );
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4191 16: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4192 17: friend class Luthier;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4193 18: @};
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4194 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4195
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4196 @ssindex class-open
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4197 @ssindex class-close
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4198 As in the previous example, line 1 has the @code{topmost-intro} syntax.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4199 Here however, the brace that opens a C++ class definition on line 4 is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4200 assigned the @code{class-open} syntax. Note that in C++, classes,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4201 structs, and unions are essentially equivalent syntactically (and are
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4202 very similar semantically), so replacing the @code{class} keyword in the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4203 example above with @code{struct} or @code{union} would still result in a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4204 syntax of @code{class-open} for line 4 @footnote{This is the case even
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4205 for C and Objective-C. For consistency, structs in all supported
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4206 languages are syntactically equivalent to classes. Note however that
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4207 the keyword @code{class} is meaningless in C and Objective-C.}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4208 Similarly, line 18 is assigned @code{class-close} syntax.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4209
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4210 @ssindex inher-intro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4211 @ssindex inher-cont
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4212 Line 2 introduces the inheritance list for the class so it is assigned
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4213 the @code{inher-intro} syntax, and line 3, which continues the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4214 inheritance list is given @code{inher-cont} syntax.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4215
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4216 @ssindex access-label
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4217 @ssindex inclass
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4218 Hitting @kbd{C-c C-s} on line 5 shows the following analysis:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4219
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4220 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4221 ((inclass 58) (access-label 58))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4222 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4223
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4224 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4225 The primary syntactic symbol for this line is @code{access-label} as
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4226 this a label keyword that specifies access protection in C++. However,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4227 because this line is also a top-level construct inside a class
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4228 definition, the analysis actually shows two syntactic symbols. The
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4229 other syntactic symbol assigned to this line is @code{inclass}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4230 Similarly, line 6 is given both @code{inclass} and @code{topmost-intro}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4231 syntax:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4232
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4233 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4234 ((inclass 58) (topmost-intro 60))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4235 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4236
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4237 @ssindex member-init-intro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4238 @ssindex member-init-cont
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4239 Line 7 introduces a C++ member initialization list and as such is given
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4240 @code{member-init-intro} syntax. Note that in this case it is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4241 @emph{not} assigned @code{inclass} since this is not considered a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4242 top-level construct. Lines 8 through 10 are all assigned
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4243 @code{member-init-cont} since they continue the member initialization
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4244 list started on line 7.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4245
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4246 @cindex in-class inline methods
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4247 @ssindex inline-open
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4248 @ssindex inline-close
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4249 Line 11's analysis is a bit more complicated:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4250
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4251 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4252 ((inclass 58) (inline-open))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4253 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4254
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4255 This line is assigned a syntax of both @code{inline-open} and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4256 @code{inclass} because it opens an @dfn{in-class} C++ inline method
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4257 definition. This is distinct from, but related to, the C++ notion of an
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4258 inline function in that its definition occurs inside an enclosing class
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4259 definition, which in C++ implies that the function should be inlined.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4260 However, if the definition of the @code{Bass} constructor appeared
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4261 outside the class definition, the construct would be given the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4262 @code{defun-open} syntax, even if the keyword @code{inline} appeared
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4263 before the method name, as in:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4264
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4265 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4266 1: class Bass
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4267 2: : public Guitar,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4268 3: public Amplifiable
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4269 4: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4270 5: public:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4271 6: Bass();
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4272 7: @};
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4273 8:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4274 9: inline
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4275 10: Bass::Bass()
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4276 11: : eString( new BassString( 0.105 )),
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4277 12: aString( new BassString( 0.085 )),
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4278 13: dString( new BassString( 0.065 )),
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4279 14: gString( new BassString( 0.045 ))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4280 15: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4281 16: eString.tune( 'E' );
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4282 17: aString.tune( 'A' );
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4283 18: dString.tune( 'D' );
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4284 19: gString.tune( 'G' );
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4285 20: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4286 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4287
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4288 @ssindex friend
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4289 Returning to the previous example, line 16 is given @code{inline-close}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4290 syntax, while line 12 is given @code{defun-block-open} syntax, and lines
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4291 13 through 15 are all given @code{statement} syntax. Line 17 is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4292 interesting in that its syntactic analysis list contains three
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4293 elements:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4294
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4295 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4296 ((inclass 58) (topmost-intro 380) (friend))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4297 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4298
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4299 The @code{friend} and @code{inline-open} syntactic symbols are
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4300 modifiers that do not have anchor positions.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4301
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4302 @ssindex template-args-cont
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4303 Template definitions introduce yet another syntactic symbol:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4304
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4305 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4306 1: ThingManager <int,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4307 2: Framework::Callback *,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4308 3: Mutex> framework_callbacks;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4309 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4310
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4311 Here, line 1 is analyzed as a @code{topmost-intro}, but lines 2 and 3
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4312 are both analyzed as @code{template-args-cont} lines.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4313
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4314 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4315 @node Conditional Construct Symbols, Switch Statement Symbols, Class Symbols, Syntactic Symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4316 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4317 @subsection Conditional Construct Symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4318 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4319
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4320 Here is a (totally contrived) example which illustrates how syntax is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4321 assigned to various conditional constructs:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4322
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4323 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4324 1: void spam( int index )
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4325 2: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4326 3: for( int i=0; i<index; i++ )
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4327 4: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4328 5: if( i == 10 )
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4329 6: do_something_special();
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4330 7: else
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4331 8: silly_label:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4332 9: do_something( i );
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4333 10: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4334 11: do @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4335 12: another_thing( i-- );
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4336 13: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4337 14: while( i > 0 );
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4338 15: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4339 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4340
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4341 Only the lines that illustrate new syntactic symbols will be discussed.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4342
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4343 @ssindex substatement-open
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4344 @ssindex statement-block-intro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4345 @ssindex block-close
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4346 Line 4 has a brace which opens a conditional's substatement block. It
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4347 is thus assigned @code{substatement-open} syntax, and since line 5 is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4348 the first line in the substatement block, it is assigned
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4349 @code{statement-block-intro} syntax. Line 10 contains the brace
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4350 that closes the inner substatement block, and is therefore given the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4351 syntax @code{block-close}@footnote{@code{block-open} is used only for
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4352 ``free-standing'' blocks, and is somewhat rare (@pxref{Literal
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4353 Symbols} for an example.)}. Line 13 is treated the same way.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4354
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4355 @ssindex substatement
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4356 Lines 6 and 9 are also substatements of conditionals, but since they
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4357 don't start blocks they are given @code{substatement} syntax
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4358 instead of @code{substatement-open}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4359
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4360 @ssindex substatement-label
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4361 Line 8 contains a label, which is normally given @code{label} syntax.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4362 This one is however a bit special since it's between a conditional and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4363 its substatement. It's analyzed as @code{substatement-label} to let you
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4364 handle this rather odd case differently from normal labels.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4365
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4366 @ssindex else-clause
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4367 @ssindex catch-clause
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4368 Line 7 start with an @code{else} that matches the @code{if} statement on
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4369 line 5. It is therefore given the @code{else-clause} syntax and is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4370 anchored on the matching @code{if}. The @code{try}-@code{catch}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4371 constructs in C++ and Java are treated this way too, except that
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4372 @code{catch} and (in Java) @code{finally}, are marked with
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4373 @code{catch-clause}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4374
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4375 @ssindex do-while-closure
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4376 The @code{while} construct on line 14 that closes a @code{do}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4377 conditional is given the special syntax @code{do-while-closure} if it
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4378 appears on a line by itself. Note that if the @code{while} appeared on
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4379 the same line as the preceding close brace, that line would still have
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4380 @code{block-close} syntax.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4381
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4382 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4383 @node Switch Statement Symbols, Brace List Symbols, Conditional Construct Symbols, Syntactic Symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4384 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4385 @subsection Switch Statement Symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4386 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4387
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4388 Switch statements have their own set of syntactic symbols. Here's an
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4389 example:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4390
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4391 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4392 1: void spam( enum Ingredient i )
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4393 2: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4394 3: switch( i ) @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4395 4: case Ham:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4396 5: be_a_pig();
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4397 6: break;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4398 7: case Salt:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4399 8: drink_some_water();
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4400 9: break;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4401 10: default:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4402 11: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4403 12: what_is_it();
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4404 13: break;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4405 14: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4406 15: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4407 14: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4408 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4409
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4410 @ssindex case-label
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4411 @ssindex statement-case-intro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4412 @ssindex statement-case-open
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4413 Here, lines 4, 7, and 10 are all assigned @code{case-label} syntax,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4414 while lines 5 and 8 are assigned @code{statement-case-intro}. Line 11
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4415 is treated slightly differently since it contains a brace that opens a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4416 block --- it is given @code{statement-case-open} syntax.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4417
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4418 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4419 @node Brace List Symbols, External Scope Symbols, Switch Statement Symbols, Syntactic Symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4420 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4421 @subsection Brace List Symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4422 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4423
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4424 @cindex brace lists
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4425 There are a set of syntactic symbols that are used to recognize
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4426 constructs inside of brace lists. A brace list is defined as an
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4427 @code{enum} or aggregate initializer list, such as might statically
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4428 initialize an array of structs. The three special aggregate constructs
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4429 in Pike, @code{(@{ @})}, @code{([ ])} and @code{(< >)}, are treated as
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4430 brace lists too. An example:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4431
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4432 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4433 1: static char* ingredients[] =
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4434 2: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4435 3: "Ham",
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4436 4: "Salt",
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4437 5: NULL
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4438 6: @};
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4439 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4440
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4441 @ssindex brace-list-open
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4442 @ssindex brace-list-intro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4443 @ssindex brace-list-close
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4444 @ssindex brace-list-entry
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4445 Following convention, line 2 in this example is assigned
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4446 @code{brace-list-open} syntax, and line 3 is assigned
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4447 @code{brace-list-intro} syntax. Likewise, line 6 is assigned
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4448 @code{brace-list-close} syntax. Lines 4 and 5 however, are assigned
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4449 @code{brace-list-entry} syntax, as would all subsequent lines in this
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4450 initializer list.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4451
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4452 @ssindex brace-entry-open
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4453 Your static initializer might be initializing nested structures, for
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4454 example:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4455
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4456 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4457 1: struct intpairs[] =
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4458 2: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4459 3: @{ 1, 2 @},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4460 4: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4461 5: 3,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4462 6: 4
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4463 7: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4464 8: @{ 1,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4465 9: 2 @},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4466 10: @{ 3, 4 @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4467 11: @};
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4468 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4469
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4470 Here, you've already seen the analysis of lines 1, 2, 3, and 11. On
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4471 line 4, things get interesting; this line is assigned
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4472 @code{brace-entry-open} syntactic symbol because it's a bracelist entry
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4473 line that starts with an open brace. Lines 5 and 6 (and line 9) are
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4474 pretty standard, and line 7 is a @code{brace-list-close} as you'd
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4475 expect. Once again, line 8 is assigned as @code{brace-entry-open} as is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4476 line 10.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4477
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4478 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4479 @node External Scope Symbols, Paren List Symbols, Brace List Symbols, Syntactic Symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4480 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4481 @subsection External Scope Symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4482 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4483
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4484 External language definition blocks also have their own syntactic
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4485 symbols. In this example:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4486
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4487 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4488 1: extern "C"
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4489 2: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4490 3: int thing_one( int );
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4491 4: int thing_two( double );
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4492 5: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4493 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4494
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4495 @ssindex extern-lang-open
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4496 @ssindex extern-lang-close
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4497 @ssindex inextern-lang
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4498 @ssindex inclass
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4499 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4500 line 2 is given the @code{extern-lang-open} syntax, while line 5 is given
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4501 the @code{extern-lang-close} syntax. The analysis for line 3 yields:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4502
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4503 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4504 ((inextern-lang) (topmost-intro 14))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4505 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4506
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4507 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4508 where @code{inextern-lang} is a modifier similar in purpose to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4509 @code{inclass}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4510
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4511 There are various other top level blocks like @code{extern}, and they
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4512 are all treated in the same way except that the symbols are named after
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4513 the keyword that introduces the block. E.g. C++ namespace blocks get
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4514 the three symbols @code{namespace-open}, @code{namespace-close} and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4515 @code{innamespace}. The currently recognized top level blocks are:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4516
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4517 @table @asis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4518 @item @code{extern-lang-open}, @code{extern-lang-close}, @code{inextern-lang}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4519 @code{extern} blocks in C and C++.@footnote{These should logically be
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4520 named @code{extern-open}, @code{extern-close} and @code{inextern}, but
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4521 that isn't the case for historical reasons.}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4522
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4523 @item @code{namespace-open}, @code{namespace-close}, @code{innamespace}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4524 @ssindex namespace-open
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4525 @ssindex namespace-close
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4526 @ssindex innamespace
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4527 @code{namespace} blocks in C++.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4528
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4529 @item @code{module-open}, @code{module-close}, @code{inmodule}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4530 @ssindex module-open
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4531 @ssindex module-close
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4532 @ssindex inmodule
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4533 @code{module} blocks in CORBA IDL.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4534
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4535 @item @code{composition-open}, @code{composition-close}, @code{incomposition}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4536 @ssindex composition-open
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4537 @ssindex composition-close
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4538 @ssindex incomposition
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4539 @code{composition} blocks in CORBA CIDL.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4540 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4541
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4542 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4543 @node Paren List Symbols, Literal Symbols, External Scope Symbols, Syntactic Symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4544 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4545 @subsection Parenthesis (Argument) List Symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4546 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4547
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4548 A number of syntactic symbols are associated with parenthesis lists,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4549 a.k.a argument lists, as found in function declarations and function
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4550 calls. This example illustrates these:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4551
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4552 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4553 1: void a_function( int line1,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4554 2: int line2 );
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4555 3:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4556 4: void a_longer_function(
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4557 5: int line1,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4558 6: int line2
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4559 7: );
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4560 8:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4561 9: void call_them( int line1, int line2 )
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4562 10: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4563 11: a_function(
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4564 12: line1,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4565 13: line2
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4566 14: );
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4567 15:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4568 16: a_longer_function( line1,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4569 17: line2 );
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4570 18: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4571 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4572
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4573 @ssindex arglist-intro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4574 @ssindex arglist-close
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4575 Lines 5 and 12 are assigned @code{arglist-intro} syntax since they are
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4576 the first line following the open parenthesis, and lines 7 and 14 are
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4577 assigned @code{arglist-close} syntax since they contain the parenthesis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4578 that closes the argument list.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4579
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4580 @ssindex arglist-cont-nonempty
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4581 @ssindex arglist-cont
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4582 Lines that continue argument lists can be assigned one of two syntactic
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4583 symbols. For example, Lines 2 and 17
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4584 are assigned @code{arglist-cont-nonempty} syntax. What this means
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4585 is that they continue an argument list, but that the line containing the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4586 parenthesis that opens the list is @emph{not empty} following the open
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4587 parenthesis. Contrast this against lines 6 and 13 which are assigned
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4588 @code{arglist-cont} syntax. This is because the parenthesis that opens
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4589 their argument lists is the last character on that line.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4590
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4591 Syntactic elements with @code{arglist-intro},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4592 @code{arglist-cont-nonempty}, and @code{arglist-close} contain two
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4593 buffer positions: the anchor position (the beginning of the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4594 declaration or statement) and the position of the open parenthesis.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4595 The latter position can be used in a line-up function (@pxref{Line-Up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4596 Functions}).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4597
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4598 Note that there is no @code{arglist-open} syntax. This is because any
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4599 parenthesis that opens an argument list, appearing on a separate line,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4600 is assigned the @code{statement-cont} syntax instead.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4601
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4602 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4603 @node Literal Symbols, Multiline Macro Symbols, Paren List Symbols, Syntactic Symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4604 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4605 @subsection Comment String Label and Macro Symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4606 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4607
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4608 A few miscellaneous syntactic symbols that haven't been previously
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4609 covered are illustrated by this C++ example:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4610
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4611 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4612 1: void Bass::play( int volume )
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4613 2: const
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4614 3: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4615 4: /* this line starts a multiline
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4616 5: * comment. This line should get `c' syntax */
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4617 6:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4618 7: char* a_multiline_string = "This line starts a multiline \
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4619 8: string. This line should get `string' syntax.";
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4620 9:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4621 10: note:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4622 11: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4623 12: #ifdef LOCK
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4624 13: Lock acquire();
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4625 14: #endif // LOCK
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4626 15: slap_pop();
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4627 16: cout << "I played "
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4628 17: << "a note\n";
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4629 18: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4630 19: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4631 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4632
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4633 The lines to note in this example include:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4634
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4635 @itemize @bullet
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4636 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4637 @ssindex func-decl-cont
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4638 Line 2 is assigned the @code{func-decl-cont} syntax.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4639
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4640 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4641 @ssindex comment-intro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4642 Line 4 is assigned both @code{defun-block-intro} @emph{and}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4643 @code{comment-intro} syntax. A syntactic element with
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4644 @code{comment-intro} has no anchor point --- It is always accompanied
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4645 by another syntactic element which does have one.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4646
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4647 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4648 @ssindex c
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4649 Line 5 is assigned @code{c} syntax.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4650
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4651 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4652 @cindex syntactic whitespace
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4653 Line 6 which, even though it contains nothing but whitespace, is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4654 assigned @code{defun-block-intro}. Note that the appearance of the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4655 comment on lines 4 and 5 do not cause line 6 to be assigned
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4656 @code{statement} syntax because comments are considered to be
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4657 @dfn{syntactic whitespace}, which are ignored when analyzing
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4658 code.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4659
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4660 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4661 @ssindex string
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4662 Line 8 is assigned @code{string} syntax.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4663
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4664 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4665 @ssindex label
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4666 Line 10 is assigned @code{label} syntax.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4667
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4668 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4669 @ssindex block-open
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4670 Line 11 is assigned @code{block-open} as well as @code{statement}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4671 syntax. A @code{block-open} syntactic element doesn't have an anchor
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4672 position, since it always appears with another syntactic element which
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4673 does have one.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4674
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4675 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4676 @ssindex cpp-macro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4677 Lines 12 and 14 are assigned @code{cpp-macro} syntax in addition to the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4678 normal syntactic symbols (@code{statement-block-intro} and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4679 @code{statement}, respectively). Normally @code{cpp-macro} is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4680 configured to cancel out the normal syntactic context to make all
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4681 preprocessor directives stick to the first column, but that's easily
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4682 changed if you want preprocessor directives to be indented like the rest
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4683 of the code. Like @code{comment-intro}, a syntactic element with
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4684 @code{cpp-macro} doesn't contain an anchor position.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4685
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4686 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4687 @ssindex stream-op
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4688 Line 17 is assigned @code{stream-op} syntax.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4689 @end itemize
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4690
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4691 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4692 @node Multiline Macro Symbols, Objective-C Method Symbols, Literal Symbols, Syntactic Symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4693 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4694 @subsection Multiline Macro Symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4695 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4696
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4697 @cindex multiline macros
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4698 @cindex syntactic whitespace
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4699 @ssindex cpp-define-intro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4700 @ssindex cpp-macro-cont
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4701 Multiline preprocessor macro definitions are normally handled just like
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4702 other code, i.e. the lines inside them are indented according to the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4703 syntactic analysis of the preceding lines inside the macro. The first
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4704 line inside a macro definition (i.e. the line after the starting line of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4705 the cpp directive itself) gets @code{cpp-define-intro}. In this example:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4706
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4707 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4708 1: #define LIST_LOOP(cons, listp) \
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4709 2: for (cons = listp; !NILP (cons); cons = XCDR (cons)) \
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4710 3: if (!CONSP (cons)) \
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4711 4: signal_error ("Invalid list format", listp); \
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4712 5: else
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4713 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4714
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4715 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4716 line 1 is given the syntactic symbol @code{cpp-macro}. The first line
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4717 of a cpp directive is always given that symbol. Line 2 is given
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4718 @code{cpp-define-intro}, so that you can give the macro body as a whole
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4719 some extra indentation. Lines 3 through 5 are then analyzed as normal
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4720 code, i.e. @code{substatement} on lines 3 and 4, and @code{else-clause}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4721 on line 5.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4722
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4723 The syntactic analysis inside macros can be turned off with
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4724 @code{c-syntactic-indentation-in-macros} (@pxref{Custom Macros}). In
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4725 that case, lines 2 through 5 would all be given @code{cpp-macro-cont}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4726 with an anchor position pointing to the @code{#} which starts the cpp
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4727 directive@footnote{This is how @ccmode{} 5.28 and earlier analyzed
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4728 macros.}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4729
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4730 @xref{Custom Macros}, for more info about the treatment of macros.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4731
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4732 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4733 @node Objective-C Method Symbols, Anonymous Class Symbol, Multiline Macro Symbols, Syntactic Symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4734 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4735 @subsection Objective-C Method Symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4736 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4737
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4738 In Objective-C buffers, there are three additional syntactic symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4739 assigned to various message calling constructs. Here's an example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4740 illustrating these:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4741
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4742 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4743 1: - (void)setDelegate:anObject
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4744 2: withStuff:stuff
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4745 3: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4746 4: [delegate masterWillRebind:self
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4747 5: toDelegate:anObject
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4748 6: withExtraStuff:stuff];
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4749 7: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4750 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4751
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4752 @ssindex objc-method-intro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4753 @ssindex objc-method-args-cont
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4754 @ssindex objc-method-call-cont
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4755 Here, line 1 is assigned @code{objc-method-intro} syntax, and line 2 is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4756 assigned @code{objc-method-args-cont} syntax. Lines 5 and 6 are both
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4757 assigned @code{objc-method-call-cont} syntax.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4758
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4759 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4760 @node Anonymous Class Symbol, Statement Block Symbols, Objective-C Method Symbols, Syntactic Symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4761 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4762 @subsection Anonymous Class Symbol (Java)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4763 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4764
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4765 Java has a concept of anonymous classes which can look something like
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4766 this:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4767
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4768 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4769 1: public void watch(Observable o) @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4770 2: o.addObserver(new Observer() @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4771 3: public void update(Observable o, Object arg) @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4772 4: history.addElement(arg);
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4773 5: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4774 6: @});
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4775 7: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4776 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4777
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4778 @ssindex inexpr-class
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4779 The brace following the @code{new} operator opens the anonymous class.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4780 Lines 3 and 6 are assigned the @code{inexpr-class} syntax, besides the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4781 @code{inclass} symbol used in normal classes. Thus, the class will be
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4782 indented just like a normal class, with the added indentation given to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4783 @code{inexpr-class}. An @code{inexpr-class} syntactic element doesn't
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4784 have an anchor position.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4785
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4786 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4787 @node Statement Block Symbols, K&R Symbols, Anonymous Class Symbol, Syntactic Symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4788 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4789 @subsection Statement Block Symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4790 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4791
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4792 There are a few occasions where a statement block might be used inside
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4793 an expression. One is in C or C++ code using the gcc extension for
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4794 this, e.g:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4795
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4796 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4797 1: int res = (@{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4798 2: int y = foo (); int z;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4799 3: if (y > 0) z = y; else z = - y;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4800 4: z;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4801 5: @});
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4802 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4803
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4804 @ssindex inexpr-statement
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4805 Lines 2 and 5 get the @code{inexpr-statement} syntax, besides the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4806 symbols they'd get in a normal block. Therefore, the indentation put on
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4807 @code{inexpr-statement} is added to the normal statement block
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4808 indentation. An @code{inexpr-statement} syntactic element doesn't
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4809 contain an anchor position.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4810
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4811 In Pike code, there are a few other situations where blocks occur inside
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4812 statements, as illustrated here:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4813
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4814 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4815 1: array itgob()
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4816 2: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4817 3: string s = map (backtrace()[-2][3..],
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4818 4: lambda
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4819 5: (mixed arg)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4820 6: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4821 7: return sprintf ("%t", arg);
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4822 8: @}) * ", " + "\n";
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4823 9: return catch @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4824 10: write (s + "\n");
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4825 11: @};
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4826 12: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4827 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4828
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4829 @ssindex inlambda
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4830 @ssindex lambda-intro-cont
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4831 Lines 4 through 8 contain a lambda function, which @ccmode{} recognizes
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4832 by the @code{lambda} keyword. If the function argument list is put
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4833 on a line of its own, as in line 5, it gets the @code{lambda-intro-cont}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4834 syntax. The function body is handled as an inline method body, with the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4835 addition of the @code{inlambda} syntactic symbol. This means that line
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4836 6 gets @code{inlambda} and @code{inline-open}, and line 8 gets
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4837 @code{inline-close}@footnote{You might wonder why it doesn't get
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4838 @code{inlambda} too. It's because the closing brace is relative to the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4839 opening brace, which stands on its own line in this example. If the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4840 opening brace was hanging on the previous line, then the closing brace
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4841 would get the @code{inlambda} syntax too to be indented correctly.}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4842
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4843 @ssindex inexpr-statement
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4844 On line 9, @code{catch} is a special function taking a statement block
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4845 as its argument. The block is handled as an in-expression statement
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4846 with the @code{inexpr-statement} syntax, just like the gcc extended C
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4847 example above. The other similar special function, @code{gauge}, is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4848 handled like this too.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4849
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4850 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4851 @node K&R Symbols, , Statement Block Symbols, Syntactic Symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4852 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4853 @subsection K&R Symbols
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4854 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4855
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4856 @ssindex knr-argdecl-intro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4857 @ssindex knr-argdecl
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4858 Two other syntactic symbols can appear in old style, non-prototyped C
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4859 code @footnote{a.k.a. K&R C, or Kernighan & Ritchie C}:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4860
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4861 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4862 1: int add_three_integers(a, b, c)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4863 2: int a;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4864 3: int b;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4865 4: int c;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4866 5: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4867 6: return a + b + c;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4868 7: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4869 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4870
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4871 Here, line 2 is the first line in an argument declaration list and so is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4872 given the @code{knr-argdecl-intro} syntactic symbol. Subsequent lines
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4873 (i.e. lines 3 and 4 in this example), are given @code{knr-argdecl}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4874 syntax.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4875
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4876
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4877 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4878 @node Indentation Calculation, , Syntactic Symbols, Indentation Engine Basics
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4879 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4880 @section Indentation Calculation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4881 @cindex indentation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4882 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4883
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4884 Indentation for a line is calculated from the syntactic context
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4885 (@pxref{Syntactic Analysis}).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4886
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4887 First, a buffer position is found whose column will be the base for the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4888 indentation calculation. It's the anchor position in the first
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4889 syntactic element that provides one that is used. If no syntactic
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4890 element has an anchor position then column zero is used.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4891
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4892 Second, the syntactic symbols in each syntactic element are looked up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4893 in the @code{c-offsets-alist} style variable
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4894 (@pxref{c-offsets-alist}), which is an association list of syntactic
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4895 symbols and the offsets to apply for those symbols. These offsets are
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4896 added together with the base column to produce the new indentation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4897 column.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4898
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4899 Let's use our two code examples above to see how this works. Here is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4900 our first example again:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4901
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4902 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4903 1: void swap( int& a, int& b )
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4904 2: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4905 3: int tmp = a;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4906 4: a = b;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4907 5: b = tmp;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4908 6: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4909 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4910
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4911 Let's say point is on line 3 and we hit the @key{TAB} key to reindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4912 the line. The syntactic context for that line is:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4913
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4914 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4915 ((defun-block-intro 29))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4916 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4917
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4918 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4919 Since buffer position 29 is the first and only anchor position in the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4920 list, @ccmode{} goes there and asks for the current column. This brace
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4921 is in column zero, so @ccmode{} uses @samp{0} as the base column.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4922
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4923 Next, @ccmode{} looks up @code{defun-block-intro} in the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4924 @code{c-offsets-alist} style variable. Let's say it finds the value
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4925 @samp{4}; it adds this to the base column @samp{0}, yielding a running
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4926 total indentation of 4 spaces.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4927
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4928 Since there is only one syntactic element on the list for this line,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4929 indentation calculation is complete, and the total indentation for the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4930 line is 4 spaces.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4931
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4932 Here's another example:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4933
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4934 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4935 1: int add( int val, int incr, int doit )
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4936 2: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4937 3: if( doit )
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4938 4: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4939 5: return( val + incr );
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4940 6: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4941 7: return( val );
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4942 8: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4943 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4944
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4945 If we were to hit @kbd{TAB} on line 4 in the above example, the same
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4946 basic process is performed, despite the differences in the syntactic
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4947 context. The context for this line is:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4948
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4949 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4950 ((substatement-open 46))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4951 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4952
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4953 Here, @ccmode{} goes to buffer position 46, which is the @samp{i} in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4954 @code{if} on line 3. This character is in the fourth column on that
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4955 line so the base column is @samp{4}. Then @ccmode{} looks up the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4956 @code{substatement-open} symbol in @code{c-offsets-alist}. Let's say it
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4957 finds the value @samp{4}. It's added with the base column and yields an
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4958 indentation for the line of 8 spaces.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4959
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4960 Simple, huh?
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4961
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4962 Actually, it's a bit more complicated than that since the entries on
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4963 @code{c-offsets-alist} can be much more than plain offsets.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4964 @xref{c-offsets-alist}, for the full story.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4965
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4966 Anyway, the mode usually just does The Right Thing without you having to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4967 think about it in this much detail. But when customizing indentation,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4968 it's helpful to understand the general indentation model being used.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4969
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4970 As you configure @ccmode{}, you might want to set the variable
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4971 @code{c-echo-syntactic-information-p} to non-@code{nil} so that the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4972 syntactic context and calculated offset always is echoed in the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4973 minibuffer when you hit @kbd{TAB}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4974
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4975
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4976 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4977 @node Customizing Indentation, Custom Macros, Indentation Engine Basics, Top
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4978 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4979 @chapter Customizing Indentation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4980 @cindex customization, indentation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4981 @cindex indentation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4982 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4983
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4984 The principal variable for customizing indentation is the style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4985 variable @code{c-offsets-alist}, which gives an @dfn{offset} (an
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4986 indentation rule) for each syntactic symbol. Its structure and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4987 semantics are completely described in @ref{c-offsets-alist}. The
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4988 various ways you can set the variable, including the use of the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4989 @ccmode{} style system, are described in @ref{Config Basics} and its
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4990 sections, in particular @ref{Style Variables}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4991
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4992 The simplest and most used kind of ``offset'' setting in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4993 @code{c-offsets-alist} is in terms of multiples of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4994 @code{c-basic-offset}:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4995
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4996 @defopt c-basic-offset
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4997 @vindex basic-offset (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4998 This style variable holds the basic offset between indentation levels.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4999 It's factory default is 4, but all the built-in styles set it
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5000 themselves, to some value between 2 (for @code{gnu} style) and 8 (for
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5001 @code{bsd}, @code{linux}, and @code{python} styles).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5002 @end defopt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5003
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5004 The most flexible ``offset'' setting you can make in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5005 @code{c-offsets-alist} is a line-up function (or even a list of them),
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5006 either one supplied by @ccmode{} (@pxref{Line-Up Functions}) or one
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5007 you write yourself (@pxref{Custom Line-Up}).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5008
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5009 Finally, in @ref{Other Indentation} you'll find the tool of last
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5010 resort: a hook which is called after a line has been indented. You
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5011 can install functions here to make ad-hoc adjustments to any line's
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5012 indentation.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5013
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5014 @menu
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5015 * c-offsets-alist::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5016 * Interactive Customization::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5017 * Line-Up Functions::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5018 * Custom Line-Up::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5019 * Other Indentation::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5020 @end menu
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5021
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5022
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5023 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5024 @node c-offsets-alist, Interactive Customization, Customizing Indentation, Customizing Indentation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5025 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5026 @section c-offsets-alist
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5027 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5028
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5029 This section explains the structure and semantics of the style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5030 variable @code{c-offset-alist}, the principal variable for configuring
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5031 indentation. Details of how to set it up, and its relationship to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5032 @ccmode{}'s style system are given in @ref{Style Variables}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5033
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5034 @defopt c-offsets-alist
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5035 @vindex offsets-alist (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5036 This is an alist which associates an offset with each syntactic
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5037 symbol. This @dfn{offset} is a rule specifying how to indent a line
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5038 whose syntactic context matches the symbol. @xref{Syntactic
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5039 Analysis}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5040
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5041 Note that the buffer-local binding of this alist in a @ccmode{} buffer
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5042 contains an entry for @emph{every} syntactic symbol. Its global
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5043 binding and its settings within style specifications usually contain
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5044 only a few entries. @xref{Style Variables}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5045
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5046 The offset specification associated with any particular syntactic
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5047 symbol can be an integer, a variable name, a vector, a function or
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5048 lambda expression, a list, or one of the following special symbols:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5049 @code{+}, @code{-}, @code{++}, @code{--}, @code{*}, or @code{/}. The
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5050 meanings of these values are described in detail below.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5051
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5052 Here is an example fragment of a @code{c-offsets-alist}, showing some
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5053 of these kinds of offsets:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5054
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5055 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5056 ((statement . 0)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5057 (substatement . +)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5058 (cpp-macro . [0])
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5059 (topmost-intro-cont . c-lineup-topmost-intro-cont)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5060 (statement-block-intro . (add c-lineup-whitesmith-in-block
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5061 c-indent-multi-line-block))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5062 @dots{}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5063 @*)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5064 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5065 @end defopt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5066
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5067 @deffn Command c-set-offset (@kbd{C-c C-o})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5068 @findex set-offset (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5069 @kindex C-c C-o
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5070 This command changes the entry for a syntactic symbol in the current
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5071 binding of @code{c-offsets-alist}, or it inserts a new entry if there
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5072 isn't already one for that syntactic symbol.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5073
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5074 You can use @code{c-set-offsets} interactively within a @ccmode{}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5075 buffer to make experimental changes to your indentation settings.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5076 @kbd{C-c C-o} prompts you for the syntactic symbol to change
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5077 (defaulting to that of the current line) and the new offset
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5078 (defaulting to the current offset).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5079
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5080 @code{c-set-offsets} takes two arguments when used programmatically:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5081 @var{symbol}, the syntactic element symbol to change and @var{offset},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5082 the new offset for that syntactic element. You can call the command
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5083 in your @file{.emacs} to change the global binding of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5084 @code{c-offsets-alist} (@pxref{Style Variables}); you can use it in a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5085 hook function to make changes from the current style. @ccmode{}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5086 itself uses this function when initializing styles.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5087 @end deffn
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5088
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5089 @cindex offset specification
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5090 The ``offset specifications'' in @code{c-offsets-alist} can be any of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5091 the following:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5092
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5093 @table @asis
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5094 @item An integer
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5095 The integer specifies a relative offset. All relative
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5096 offsets@footnote{The syntactic context @code{@w{((defun-block-intro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5097 2724) (comment-intro))}} would likely have two relative offsets.} will
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5098 be added together and used to calculate the indentation relative to an
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5099 anchor position earlier in the buffer. @xref{Indentation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5100 Calculation}, for details. Most of the time, it's probably better to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5101 use one of the special symbols like @code{+} than an integer (apart
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5102 from zero).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5103
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5104 @item One of the symbols @code{+}, @code{-}, @code{++}, @code{--}, @code{*}, or @code{/}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5105 These special symbols describe a relative offset in multiples of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5106 @code{c-basic-offset}:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5107
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5108 By defining a style's indentation in terms of @code{c-basic-offset},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5109 you can change the amount of whitespace given to an indentation level
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5110 while maintaining the same basic shape of your code. Here are the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5111 values that the special symbols correspond to:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5112
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5113 @table @code
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5114 @item +
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5115 @code{c-basic-offset} times 1
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5116 @item -
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5117 @code{c-basic-offset} times -1
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5118 @item ++
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5119 @code{c-basic-offset} times 2
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5120 @item --
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5121 @code{c-basic-offset} times -2
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5122 @item *
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5123 @code{c-basic-offset} times 0.5
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5124 @item /
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5125 @code{c-basic-offset} times -0.5
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5126 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5127
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5128 @item A vector
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5129 The first element of the vector, an integer, sets the absolute
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5130 indentation column. This will override any previously calculated
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5131 indentation, but won't override relative indentation calculated from
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5132 syntactic elements later on in the syntactic context of the line being
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5133 indented. @xref{Indentation Calculation}. Any elements in the vector
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5134 beyond the first will be ignored.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5135
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5136 @item A function or lambda expression
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5137 The function will be called and its return value will in turn be
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5138 evaluated as an offset specification. Functions are useful when more
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5139 context than just the syntactic symbol is needed to get the desired
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5140 indentation. @xref{Line-Up Functions}, and @ref{Custom Line-Up}, for
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5141 details about them.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5142
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5143 @item A symbol with a variable binding
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5144 If the symbol also has a function binding, the function takes
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5145 precedence over the variable. Otherwise the value of the variable is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5146 used. It must be an integer (which is used as relative offset) or a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5147 vector (an absolute offset).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5148
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5149 @item A list
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5150 The offset can also be a list containing several offset
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5151 specifications; these are evaluated recursively and combined. A list
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5152 is typically only useful when some of the offsets are line-up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5153 functions. A common strategy is calling a sequence of functions in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5154 turn until one of them recognizes that it is appropriate for the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5155 source line and returns a non-@code{nil} value.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5156
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5157 @code{nil} values are always ignored when the offsets are combined.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5158 The first element of the list specifies the method of combining the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5159 non-@code{nil} offsets from the remaining elements:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5160
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5161 @table @code
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5162 @item first
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5163 Use the first offset that doesn't evaluate to @code{nil}. Subsequent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5164 elements of the list don't get evaluated.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5165 @item min
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5166 Use the minimum of all the offsets. All must be either relative or
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5167 absolute - they can't be mixed.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5168 @item max
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5169 Use the maximum of all the offsets. All must be either relative or
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5170 absolute - they can't be mixed.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5171 @item add
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5172 Add all the evaluated offsets together. Exactly one of them may be
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5173 absolute, in which case the result is absolute. Any relative offsets
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5174 that preceded the absolute one in the list will be ignored in that case.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5175 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5176
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5177 As a compatibility measure, if the first element is none of the above
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5178 then it too will be taken as an offset specification and the whole list
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5179 will be combined according to the method @code{first}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5180 @end table
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5181
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5182 @vindex c-strict-syntax-p
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5183 @vindex strict-syntax-p (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5184 If an offset specification evaluates to @code{nil}, then a relative
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5185 offset of 0 (zero) is used@footnote{There is however a variable
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5186 @code{c-strict-syntax-p} that when set to non-@code{nil} will cause an
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5187 error to be signaled in that case. It's now considered obsolete since
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5188 it doesn't work well with some of the alignment functions that return
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5189 @code{nil} instead of zero. You should therefore leave
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5190 @code{c-strict-syntax-p} set to @code{nil}.}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5191
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5192 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5193 @node Interactive Customization, Line-Up Functions, c-offsets-alist, Customizing Indentation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5194 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5195 @section Interactive Customization
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5196 @cindex customization, interactive
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5197 @cindex interactive customization
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5198 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5199
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5200 As an example of how to customize indentation, let's change the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5201 style of this example@footnote{In this and subsequent examples, the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5202 original code is formatted using the @samp{gnu} style unless otherwise
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5203 indicated. @xref{Styles}.}:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5204
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5205 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5206 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5207 1: int add( int val, int incr, int doit )
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5208 2: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5209 3: if( doit )
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5210 4: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5211 5: return( val + incr );
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5212 6: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5213 7: return( val );
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5214 8: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5215 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5216 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5217
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5218 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5219 to:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5220
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5221 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5222 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5223 1: int add( int val, int incr, int doit )
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5224 2: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5225 3: if( doit )
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5226 4: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5227 5: return( val + incr );
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5228 6: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5229 7: return( val );
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5230 8: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5231 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5232 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5233
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5234 In other words, we want to change the indentation of braces that open a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5235 block following a condition so that the braces line up under the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5236 conditional, instead of being indented. Notice that the construct we
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5237 want to change starts on line 4. To change the indentation of a line,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5238 we need to see which syntactic symbols affect the offset calculations
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5239 for that line. Hitting @kbd{C-c C-s} on line 4 yields:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5240
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5241 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5242 ((substatement-open 44))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5243 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5244
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5245 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5246 so we know that to change the offset of the open brace, we need to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5247 change the indentation for the @code{substatement-open} syntactic
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5248 symbol.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5249
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5250 To do this interactively, just hit @kbd{C-c C-o}. This prompts
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5251 you for the syntactic symbol to change, providing a reasonable default.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5252 In this case, the default is @code{substatement-open}, which is just the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5253 syntactic symbol we want to change!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5254
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5255 After you hit return, @ccmode{} will then prompt you for the new
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5256 offset value, with the old value as the default. The default in this
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5257 case is @samp{+}, but we want no extra indentation so enter
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5258 @samp{0} and @kbd{RET}. This will associate the offset 0 with the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5259 syntactic symbol @code{substatement-open}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5260
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5261 To check your changes quickly, just hit @kbd{C-c C-q}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5262 (@code{c-indent-defun}) to reindent the entire function. The example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5263 should now look like:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5264
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5265 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5266 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5267 1: int add( int val, int incr, int doit )
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5268 2: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5269 3: if( doit )
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5270 4: @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5271 5: return( val + incr );
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5272 6: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5273 7: return( val );
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5274 8: @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5275 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5276 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5277
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5278 Notice how just changing the open brace offset on line 4 is all we
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5279 needed to do. Since the other affected lines are indented relative to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5280 line 4, they are automatically indented the way you'd expect. For more
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5281 complicated examples, this might not always work. The general approach
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5282 to take is to always start adjusting offsets for lines higher up in the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5283 file, then reindent and see if any following lines need further
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5284 adjustments.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5285
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5286 @c Move this bit to "Styles" (2005/10/7)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5287 @deffn Command c-set-offset symbol offset
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5288 @findex set-offset (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5289 @kindex C-c C-o
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5290 This is the command bound to @kbd{C-c C-o}. It provides a convenient
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5291 way to set offsets on @code{c-offsets-alist} both interactively (see
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5292 the example above) and from your mode hook.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5293
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5294 It takes two arguments when used programmatically: @var{symbol} is the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5295 syntactic element symbol to change and @var{offset} is the new offset
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5296 for that syntactic element.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5297 @end deffn
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5298 @c End of MOVE THIS BIT.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5299
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5300 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5301 @node Line-Up Functions, Custom Line-Up, Interactive Customization, Customizing Indentation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5302 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5303 @section Line-Up Functions
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5304 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5305
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5306 @cindex line-up function
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5307 @cindex indentation function
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5308 Often there are cases when a simple offset setting on a syntactic
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5309 symbol isn't enough to get the desired indentation---for example, you
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5310 might want to line up a closing parenthesis with the matching opening
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5311 one rather than indenting relative to its ``anchor point''. @ccmode{}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5312 provides this flexibility with @dfn{line-up functions}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5313
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5314 The way you associate a line-up function with a syntactic symbol is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5315 described in @ref{c-offsets-alist}. @ccmode{} comes with many
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5316 predefined line-up functions for common situations. If none of these
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5317 does what you want, you can write your own. @xref{Custom Line-Up}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5318 Sometimes, it is easier to tweak the standard indentation by adding a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5319 function to @code{c-special-indent-hook} (@pxref{Other Indentation}).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5320
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5321 The line-up functions haven't been adapted for AWK buffers or tested
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5322 with them. Some of them might work serendipitously. There shouldn't be
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5323 any problems writing custom line-up functions for AWK mode.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5324
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5325 The calling convention for line-up functions is described fully in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5326 @ref{Custom Line-Up}. Roughly speaking, the return value is either an
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5327 offset itself (such as @code{+} or @code{[0]}) or it's @code{nil},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5328 meaning ``this function is inappropriate in this case - try a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5329 different one''. @xref{c-offsets-alist}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5330
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5331 The subsections below describe all the standard line-up functions,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5332 categorized by the sort of token the lining-up centers around. For
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5333 each of these functions there is a ``works with'' list that indicates
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5334 which syntactic symbols the function is intended to be used with.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5335
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5336 @macro workswith
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5337 @emph{Works with:@ }
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5338 @end macro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5339 @ifinfo
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5340 @unmacro workswith
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5341 @macro workswith
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5342 Works with:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5343 @end macro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5344 @end ifinfo
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5345
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5346 @macro sssTBasicOffset
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5347 <--> @i{c-basic-offset}@c
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5348 @end macro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5349
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5350 @macro sssTsssTBasicOffset
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5351 <--><--> @i{c-basic-offset}@c
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5352 @end macro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5353
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5354 @macro hereFn{func}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5355 <- @i{\func\}@c
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5356 @end macro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5357
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5358 @c The TeX backend seems to insert extra spaces around the argument. :P
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5359 @iftex
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5360 @unmacro hereFn
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5361 @macro hereFn{func}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5362 <-@i{\func\}@c
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5363 @end macro
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5364 @end iftex
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5365
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5366 @menu
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5367 * Brace/Paren Line-Up::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5368 * List Line-Up::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5369 * Operator Line-Up::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5370 * Comment Line-Up::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5371 * Misc Line-Up::
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5372 @end menu
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5373
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5374 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5375 @node Brace/Paren Line-Up, List Line-Up, Line-Up Functions, Line-Up Functions
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5376 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5377 @subsection Brace and Parenthesis Line-Up Functions
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5378 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5379
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5380 The line-up functions here calculate the indentation for braces,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5381 parentheses and statements within brace blocks.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5382
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5383 @defun c-lineup-close-paren
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5384 @findex lineup-close-paren (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5385 Line up the closing paren under its corresponding open paren if the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5386 open paren is followed by code. If the open paren ends its line, no
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5387 indentation is added. E.g:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5388
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5389 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5390 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5391 main (int,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5392 char **
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5393 ) @hereFn{c-lineup-close-paren}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5394 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5395 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5396
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5397 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5398 and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5399
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5400 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5401 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5402 main (
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5403 int, char **
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5404 ) @hereFn{c-lineup-close-paren}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5405 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5406 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5407
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5408 As a special case, if a brace block is opened at the same line as the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5409 open parenthesis of the argument list, the indentation is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5410 @code{c-basic-offset} instead of the open paren column. See
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5411 @code{c-lineup-arglist} for further discussion of this ``DWIM'' measure.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5412
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5413 @workswith All @code{*-close} symbols.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5414 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5415
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5416 @comment ------------------------------------------------------------
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5417
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5418 @anchor{c-lineup-arglist-close-under-paren}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5419 @defun c-lineup-arglist-close-under-paren
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5420 @findex lineup-arglist-close-under-paren (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5421 Set your @code{arglist-close} syntactic symbol to this line-up function
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5422 so that parentheses that close argument lists will line up under the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5423 parenthesis that opened the argument list. It can also be used with
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5424 @code{arglist-cont} and @code{arglist-cont-nonempty} to line up all
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5425 lines inside a parenthesis under the open paren.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5426
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5427 As a special case, if a brace block is opened at the same line as the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5428 open parenthesis of the argument list, the indentation is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5429 @code{c-basic-offset} only. See @code{c-lineup-arglist} for further
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5430 discussion of this ``DWIM'' measure.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5431
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5432 @workswith Almost all symbols, but are typically most useful on
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5433 @code{arglist-close}, @code{brace-list-close}, @code{arglist-cont} and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5434 @code{arglist-cont-nonempty}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5435 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5436
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5437 @comment ------------------------------------------------------------
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5438
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5439 @defun c-indent-one-line-block
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5440 @findex indent-one-line-block (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5441 Indent a one line block @code{c-basic-offset} extra. E.g:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5442
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5443 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5444 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5445 if (n > 0)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5446 @{m+=n; n=0;@} @hereFn{c-indent-one-line-block}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5447 @sssTBasicOffset{}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5448 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5449 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5450
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5451 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5452 and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5453
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5454 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5455 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5456 if (n > 0)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5457 @{ @hereFn{c-indent-one-line-block}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5458 m+=n; n=0;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5459 @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5460 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5461 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5462
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5463 The block may be surrounded by any kind of parenthesis characters.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5464 @code{nil} is returned if the line doesn't start with a one line block,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5465 which makes the function usable in list expressions.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5466
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5467 @workswith Almost all syntactic symbols, but most useful on the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5468 @code{-open} symbols.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5469 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5470
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5471 @comment ------------------------------------------------------------
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5472
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5473 @defun c-indent-multi-line-block
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5474 @findex indent-multi-line-block (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5475 Indent a multiline block @code{c-basic-offset} extra. E.g:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5476
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5477 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5478 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5479 int *foo[] = @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5480 NULL,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5481 @{17@}, @hereFn{c-indent-multi-line-block}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5482 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5483 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5484
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5485 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5486 and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5487
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5488 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5489 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5490 int *foo[] = @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5491 NULL,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5492 @{ @hereFn{c-indent-multi-line-block}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5493 17
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5494 @},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5495 @sssTBasicOffset{}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5496 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5497 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5498
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5499 The block may be surrounded by any kind of parenthesis characters.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5500 @code{nil} is returned if the line doesn't start with a multiline
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5501 block, which makes the function usable in list expressions.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5502
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5503 @workswith Almost all syntactic symbols, but most useful on the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5504 @code{-open} symbols.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5505 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5506
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5507 @comment ------------------------------------------------------------
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5508
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5509 @defun c-lineup-runin-statements
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5510 @findex lineup-runin-statements (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5511 Line up statements for coding standards which place the first statement
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5512 in a block on the same line as the block opening brace@footnote{Run-in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5513 style doesn't really work too well. You might need to write your own
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5514 custom line-up functions to better support this style.}. E.g:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5515
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5516 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5517 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5518 int main()
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5519 @{ puts ("Hello!");
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5520 return 0; @hereFn{c-lineup-runin-statements}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5521 @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5522 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5523 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5524
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5525 If there is no statement after the opening brace to align with,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5526 @code{nil} is returned. This makes the function usable in list
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5527 expressions.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5528
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5529 @workswith The @code{statement} syntactic symbol.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5530 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5531
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5532 @comment ------------------------------------------------------------
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5533
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5534 @defun c-lineup-inexpr-block
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5535 @findex lineup-inexpr-block (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5536 This can be used with the in-expression block symbols to indent the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5537 whole block to the column where the construct is started. E.g. for Java
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5538 anonymous classes, this lines up the class under the @samp{new} keyword,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5539 and in Pike it lines up the lambda function body under the @samp{lambda}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5540 keyword. Returns @code{nil} if the block isn't part of such a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5541 construct.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5542
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5543 @workswith @code{inlambda}, @code{inexpr-statement},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5544 @code{inexpr-class}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5545 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5546
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5547 @comment ------------------------------------------------------------
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5548
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5549 @defun c-lineup-after-whitesmith-blocks
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5550 @findex lineup-after-whitesmith-blocks (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5551 Compensate for Whitesmith style indentation of blocks. Due to the way
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5552 @ccmode{} calculates anchor positions for normal lines inside blocks,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5553 this function is necessary for those lines to get correct Whitesmith
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5554 style indentation. Consider the following examples:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5555
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5556 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5557 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5558 int foo()
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5559 @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5560 a;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5561 x; @hereFn{c-lineup-after-whitesmith-blocks}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5562 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5563 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5564
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5565 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5566 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5567 int foo()
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5568 @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5569 @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5570 a;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5571 @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5572 x; @hereFn{c-lineup-after-whitesmith-blocks}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5573 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5574 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5575
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5576 The fact that the line with @code{x} is preceded by a Whitesmith style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5577 indented block in the latter case and not the first should not affect
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5578 its indentation. But since CC Mode in cases like this uses the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5579 indentation of the preceding statement as anchor position, the @code{x}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5580 would in the second case be indented too much if the offset for
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5581 @code{statement} was set simply to zero.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5582
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5583 This lineup function corrects for this situation by detecting if the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5584 anchor position is at an open paren character. In that case, it instead
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5585 indents relative to the surrounding block just like
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5586 @code{c-lineup-whitesmith-in-block}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5587
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5588 @workswith @code{brace-list-entry}, @code{brace-entry-open},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5589 @code{statement}, @code{arglist-cont}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5590 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5591
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5592 @comment ------------------------------------------------------------
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5593
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5594 @defun c-lineup-whitesmith-in-block
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5595 @findex lineup-whitesmith-in-block (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5596 Line up lines inside a block in Whitesmith style. It's done in a way
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5597 that works both when the opening brace hangs and when it doesn't. E.g:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5598
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5599 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5600 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5601 something
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5602 @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5603 foo; @hereFn{c-lineup-whitesmith-in-block}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5604 @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5605 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5606 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5607
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5608 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5609 and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5610
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5611 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5612 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5613 something @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5614 foo; @hereFn{c-lineup-whitesmith-in-block}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5615 @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5616 @sssTBasicOffset{}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5617 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5618 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5619
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5620 In the first case the indentation is kept unchanged, in the second
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5621 @code{c-basic-offset} is added.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5622
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5623 @workswith @code{defun-close}, @code{defun-block-intro},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5624 @code{inline-close}, @code{block-close}, @code{brace-list-close},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5625 @code{brace-list-intro}, @code{statement-block-intro},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5626 @code{arglist-intro}, @code{arglist-cont-nonempty},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5627 @code{arglist-close}, and all @code{in*} symbols, e.g. @code{inclass}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5628 and @code{inextern-lang}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5629 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5630
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5631 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5632 @node List Line-Up, Operator Line-Up, Brace/Paren Line-Up, Line-Up Functions
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5633 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5634 @subsection List Line-Up Functions
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5635 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5636
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5637 The line-up functions here calculate the indentation for lines which
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5638 form lists of items, usually separated by commas.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5639
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5640 The function @ref{c-lineup-arglist-close-under-paren}, which is mainly
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5641 for indenting a close parenthesis, is also useful for the lines
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5642 contained within parentheses.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5643
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5644 @defun c-lineup-arglist
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5645 @findex lineup-arglist (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5646 Line up the current argument line under the first argument.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5647
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5648 As a special case, if an argument on the same line as the open
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5649 parenthesis starts with a brace block opener, the indentation is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5650 @code{c-basic-offset} only. This is intended as a ``DWIM'' measure in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5651 cases like macros that contain statement blocks, e.g:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5652
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5653 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5654 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5655 A_VERY_LONG_MACRO_NAME (@{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5656 some (code, with + long, lines * in[it]);
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5657 @});
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5658 @sssTBasicOffset{}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5659 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5660 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5661
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5662 This is motivated partly because it's more in line with how code
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5663 blocks are handled, and partly since it approximates the behavior of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5664 earlier CC Mode versions, which due to inaccurate analysis tended to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5665 indent such cases this way.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5666
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5667 @workswith @code{arglist-cont-nonempty}, @code{arglist-close}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5668 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5669
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5670 @comment ------------------------------------------------------------
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5671
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5672 @defun c-lineup-arglist-intro-after-paren
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5673 @findex lineup-arglist-intro-after-paren (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5674 Line up a line to just after the open paren of the surrounding paren or
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5675 brace block.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5676
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5677 @workswith @code{defun-block-intro}, @code{brace-list-intro},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5678 @code{statement-block-intro}, @code{statement-case-intro},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5679 @code{arglist-intro}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5680 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5681
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5682 @comment ------------------------------------------------------------
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5683
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5684 @defun c-lineup-multi-inher
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5685 @findex lineup-multi-inher (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5686 Line up the classes in C++ multiple inheritance clauses and member
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5687 initializers under each other. E.g:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5688
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5689 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5690 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5691 Foo::Foo (int a, int b):
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5692 Cyphr (a),
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5693 Bar (b) @hereFn{c-lineup-multi-inher}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5694 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5695 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5696
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5697 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5698 and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5699
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5700 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5701 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5702 class Foo
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5703 : public Cyphr,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5704 public Bar @hereFn{c-lineup-multi-inher}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5705 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5706 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5707
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5708 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5709 and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5710
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5711 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5712 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5713 Foo::Foo (int a, int b)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5714 : Cyphr (a)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5715 , Bar (b) @hereFn{c-lineup-multi-inher}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5716 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5717 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5718
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5719 @workswith @code{inher-cont}, @code{member-init-cont}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5720 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5721
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5722 @comment ------------------------------------------------------------
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5723
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5724 @defun c-lineup-java-inher
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5725 @findex lineup-java-inher (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5726 Line up Java implements and extends declarations. If class names
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5727 follow on the same line as the @samp{implements}/@samp{extends}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5728 keyword, they are lined up under each other. Otherwise, they are
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5729 indented by adding @code{c-basic-offset} to the column of the keyword.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5730 E.g:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5731
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5732 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5733 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5734 class Foo
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5735 extends
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5736 Bar @hereFn{c-lineup-java-inher}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5737 @sssTBasicOffset{}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5738 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5739 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5740
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5741 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5742 and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5743
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5744 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5745 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5746 class Foo
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5747 extends Cyphr,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5748 Bar @hereFn{c-lineup-java-inher}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5749 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5750 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5751
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5752 @workswith @code{inher-cont}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5753 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5754
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5755 @comment ------------------------------------------------------------
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5756
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5757 @defun c-lineup-java-throws
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5758 @findex lineup-java-throws (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5759 Line up Java throws declarations. If exception names follow on the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5760 same line as the throws keyword, they are lined up under each other.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5761 Otherwise, they are indented by adding @code{c-basic-offset} to the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5762 column of the @samp{throws} keyword. The @samp{throws} keyword itself
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5763 is also indented by @code{c-basic-offset} from the function declaration
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5764 start if it doesn't hang. E.g:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5765
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5766 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5767 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5768 int foo()
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5769 throws @hereFn{c-lineup-java-throws}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5770 Bar @hereFn{c-lineup-java-throws}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5771 @sssTsssTBasicOffset{}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5772 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5773 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5774
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5775 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5776 and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5777
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5778 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5779 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5780 int foo() throws Cyphr,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5781 Bar, @hereFn{c-lineup-java-throws}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5782 Vlod @hereFn{c-lineup-java-throws}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5783 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5784 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5785
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5786 @workswith @code{func-decl-cont}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5787 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5788
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5789 @comment ------------------------------------------------------------
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5790
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5791 @defun c-lineup-template-args
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5792 @findex lineup-template-args (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5793 Line up the arguments of a template argument list under each other, but
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5794 only in the case where the first argument is on the same line as the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5795 opening @samp{<}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5796
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5797 To allow this function to be used in a list expression, @code{nil} is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5798 returned if there's no template argument on the first line.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5799
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5800 @workswith @code{template-args-cont}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5801 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5802
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5803 @comment ------------------------------------------------------------
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5804
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5805 @defun c-lineup-ObjC-method-call
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5806 @findex lineup-ObjC-method-call (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5807 For Objective-C code, line up selector args as Emacs Lisp mode does
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5808 with function args: go to the position right after the message receiver,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5809 and if you are at the end of the line, indent the current line
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5810 c-basic-offset columns from the opening bracket; otherwise you are
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5811 looking at the first character of the first method call argument, so
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5812 lineup the current line with it.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5813
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5814 @workswith @code{objc-method-call-cont}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5815 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5816
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5817 @comment ------------------------------------------------------------
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5818
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5819 @defun c-lineup-ObjC-method-args
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5820 @findex lineup-ObjC-method-args (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5821 For Objective-C code, line up the colons that separate args. The colon
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5822 on the current line is aligned with the one on the first line.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5823
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5824 @workswith @code{objc-method-args-cont}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5825 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5826
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5827 @comment ------------------------------------------------------------
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5828
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5829 @defun c-lineup-ObjC-method-args-2
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5830 @findex lineup-ObjC-method-args-2 (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5831 Similar to @code{c-lineup-ObjC-method-args} but lines up the colon on
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5832 the current line with the colon on the previous line.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5833
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5834 @workswith @code{objc-method-args-cont}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5835 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5836
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5837 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5838 @node Operator Line-Up, Comment Line-Up, List Line-Up, Line-Up Functions
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5839 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5840 @subsection Operator Line-Up Functions
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5841 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5842
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5843 The line-up functions here calculate the indentation for lines which
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5844 start with an operator, by lining it up with something on the previous
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5845 line.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5846
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5847 @defun c-lineup-argcont
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5848 @findex lineup-argcont (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5849 Line up a continued argument. E.g:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5850
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5851 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5852 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5853 foo (xyz, aaa + bbb + ccc
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5854 + ddd + eee + fff); @hereFn{c-lineup-argcont}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5855 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5856 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5857
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5858 Only continuation lines like this are touched, @code{nil} is returned on
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5859 lines which are the start of an argument.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5860
96449
80392a5671b7 American English spelling fixes.
Glenn Morris <rgm@gnu.org>
parents: 95936
diff changeset
5861 Within a gcc @code{asm} block, @code{:} is recognized as an argument
84286
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5862 separator, but of course only between operand specifications, not in the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5863 expressions for the operands.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5864
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5865 @workswith @code{arglist-cont}, @code{arglist-cont-nonempty}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5866 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5867
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5868 @comment ------------------------------------------------------------
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5869
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5870 @defun c-lineup-arglist-operators
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5871 @findex lineup-arglist-operators (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5872 Line up lines starting with an infix operator under the open paren.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5873 Return @code{nil} on lines that don't start with an operator, to leave
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5874 those cases to other line-up functions. Example:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5875
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5876 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5877 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5878 if ( x < 10
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5879 || at_limit (x, @hereFn{c-lineup-arglist-operators}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5880 list) @hereFn{c-lineup-arglist-operators@r{ returns nil}}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5881 )
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5882 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5883 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5884
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5885 Since this function doesn't do anything for lines without an infix
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5886 operator you typically want to use it together with some other lineup
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5887 settings, e.g. as follows (the @code{arglist-close} setting is just a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5888 suggestion to get a consistent style):
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5889
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5890 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5891 (c-set-offset 'arglist-cont
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5892 '(c-lineup-arglist-operators 0))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5893 (c-set-offset 'arglist-cont-nonempty
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5894 '(c-lineup-arglist-operators c-lineup-arglist))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5895 (c-set-offset 'arglist-close
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5896 '(c-lineup-arglist-close-under-paren))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5897 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5898
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5899 @workswith @code{arglist-cont}, @code{arglist-cont-nonempty}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5900 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5901
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5902 @comment ------------------------------------------------------------
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5903
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5904 @defun c-lineup-assignments
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5905 @findex lineup-assignments (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5906 Line up the current line after the assignment operator on the first line
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5907 in the statement. If there isn't any, return nil to allow stacking with
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5908 other line-up functions. If the current line contains an assignment
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5909 operator too, try to align it with the first one.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5910
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5911 @workswith @code{topmost-intro-cont}, @code{statement-cont},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5912 @code{arglist-cont}, @code{arglist-cont-nonempty}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5913
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5914 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5915
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5916 @comment ------------------------------------------------------------
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5917
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5918 @defun c-lineup-math
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5919 @findex lineup-math (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5920 Like @code{c-lineup-assignments} but indent with @code{c-basic-offset}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5921 if no assignment operator was found on the first line. I.e. this
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5922 function is the same as specifying a list @code{(c-lineup-assignments
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5923 +)}. It's provided for compatibility with old configurations.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5924
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5925 @workswith @code{topmost-intro-cont}, @code{statement-cont},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5926 @code{arglist-cont}, @code{arglist-cont-nonempty}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5927 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5928
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5929 @comment ------------------------------------------------------------
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5930
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5931 @defun c-lineup-cascaded-calls
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5932 @findex lineup-cascaded-calls (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5933 Line up ``cascaded calls'' under each other. If the line begins with
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5934 @code{->} or @code{.} and the preceding line ends with one or more
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5935 function calls preceded by the same token, then the arrow is lined up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5936 with the first of those tokens. E.g:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5937
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5938 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5939 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5940 r = proc->add(17)->add(18)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5941 ->add(19) + @hereFn{c-lineup-cascaded-calls}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5942 offset; @hereFn{c-lineup-cascaded-calls@r{ (inactive)}}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5943 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5944 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5945
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5946 In any other situation @code{nil} is returned to allow use in list
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5947 expressions.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5948
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5949 @workswith @code{topmost-intro-cont}, @code{statement-cont},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5950 @code{arglist-cont}, @code{arglist-cont-nonempty}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5951 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5952
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5953 @comment ------------------------------------------------------------
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5954
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5955 @defun c-lineup-streamop
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5956 @findex lineup-streamop (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5957 Line up C++ stream operators (i.e. @samp{<<} and @samp{>>}).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5958
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5959 @workswith @code{stream-op}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5960 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5961
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5962 @comment ------------------------------------------------------------
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5963
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5964 @defun c-lineup-string-cont
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5965 @findex lineup-string-cont (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5966 Line up a continued string under the one it continues. A continued
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5967 string in this sense is where a string literal follows directly after
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5968 another one. E.g:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5969
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5970 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5971 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5972 result = prefix + "A message "
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5973 "string."; @hereFn{c-lineup-string-cont}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5974 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5975 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5976
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5977 @code{nil} is returned in other situations, to allow stacking with other
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5978 lineup functions.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5979
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5980 @workswith @code{topmost-intro-cont}, @code{statement-cont},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5981 @code{arglist-cont}, @code{arglist-cont-nonempty}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5982 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5983
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5984
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5985 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5986 @node Comment Line-Up, Misc Line-Up, Operator Line-Up, Line-Up Functions
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5987 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5988 @subsection Comment Line-Up Functions
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5989 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5990
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5991 The lineup functions here calculate the indentation for several types
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5992 of comment structure.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5993
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5994 @defun c-lineup-C-comments
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5995 @findex lineup-C-comments (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5996 Line up C block comment continuation lines. Various heuristics are used
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5997 to handle most of the common comment styles. Some examples:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5998
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5999 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6000 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6001 /* /** /*
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6002 * text * text text
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6003 */ */ */
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6004 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6005 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6006
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6007 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6008 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6009 /* text /* /**
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6010 text ** text ** text
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6011 */ */ */
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6012 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6013 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6014
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6015 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6016 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6017 /**************************************************
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6018 * text
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6019 *************************************************/
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6020 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6021 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6022
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6023 @vindex comment-start-skip
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6024 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6025 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6026 /**************************************************
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6027 Free form text comments:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6028 In comments with a long delimiter line at the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6029 start, the indentation is kept unchanged for lines
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6030 that start with an empty comment line prefix. The
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6031 delimiter line is whatever matches the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6032 @code{comment-start-skip} regexp.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6033 **************************************************/
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6034 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6035 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6036
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6037 The style variable @code{c-comment-prefix-regexp} is used to recognize
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6038 the comment line prefix, e.g. the @samp{*} that usually starts every
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6039 line inside a comment.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6040
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6041 @workswith The @code{c} syntactic symbol.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6042 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6043
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6044 @comment ------------------------------------------------------------
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6045
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6046 @defun c-lineup-comment
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6047 @findex lineup-comment (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6048 Line up a comment-only line according to the style variable
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6049 @code{c-comment-only-line-offset}. If the comment is lined up with a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6050 comment starter on the previous line, that alignment is preserved.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6051
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6052 @defopt c-comment-only-line-offset
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6053 @vindex comment-only-line-offset (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6054 This style variable specifies the extra offset for the line. It can
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6055 contain an integer or a cons cell of the form
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6056
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6057 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6058 (@r{@var{non-anchored-offset}} . @r{@var{anchored-offset}})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6059 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6060
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6061 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6062 where @var{non-anchored-offset} is the amount of offset given to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6063 non-column-zero anchored lines, and @var{anchored-offset} is the amount
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6064 of offset to give column-zero anchored lines. Just an integer as value
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6065 is equivalent to @code{(@r{@var{value}} . -1000)}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6066 @end defopt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6067
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6068 @workswith @code{comment-intro}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6069 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6070
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6071 @comment ------------------------------------------------------------
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6072
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6073 @defun c-lineup-knr-region-comment
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6074 @findex lineup-knr-region-comment (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6075 Line up a comment in the ``K&R region'' with the declaration. That is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6076 the region between the function or class header and the beginning of the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6077 block. E.g:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6078
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6079 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6080 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6081 int main()
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6082 /* Called at startup. */ @hereFn{c-lineup-knr-region-comment}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6083 @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6084 return 0;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6085 @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6086 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6087 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6088
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6089 Return @code{nil} if called in any other situation, to be useful in list
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6090 expressions.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6091
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6092 @workswith @code{comment-intro}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6093 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6094
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6095 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6096 @node Misc Line-Up, , Comment Line-Up, Line-Up Functions
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6097 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6098 @subsection Miscellaneous Line-Up Functions
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6099 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6100
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6101 The line-up functions here are the odds and ends which didn't fit into
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6102 any earlier category.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6103
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6104 @defun c-lineup-dont-change
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6105 @findex lineup-dont-change (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6106 This lineup function makes the line stay at whatever indentation it
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6107 already has; think of it as an identity function for lineups.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6108
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6109 @workswith Any syntactic symbol.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6110 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6111
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6112 @comment ------------------------------------------------------------
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6113
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6114 @defun c-lineup-cpp-define
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6115 @findex lineup-cpp-define (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6116 Line up macro continuation lines according to the indentation of the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6117 construct preceding the macro. E.g:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6118
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6119 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6120 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6121 const char msg[] = @hereFn{@r{The beginning of the preceding construct.}}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6122 \"Some text.\";
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6123
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6124 #define X(A, B) \
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6125 do @{ \ @hereFn{c-lineup-cpp-define}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6126 printf (A, B); \
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6127 @} while (0)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6128 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6129 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6130
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6131 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6132 and:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6133
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6134 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6135 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6136 int dribble() @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6137 if (!running) @hereFn{@r{The beginning of the preceding construct.}}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6138 error(\"Not running!\");
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6139
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6140 #define X(A, B) \
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6141 do @{ \ @hereFn{c-lineup-cpp-define}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6142 printf (A, B); \
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6143 @} while (0)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6144 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6145 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6146
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6147 If @code{c-syntactic-indentation-in-macros} is non-@code{nil}, the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6148 function returns the relative indentation to the macro start line to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6149 allow accumulation with other offsets. E.g. in the following cases,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6150 @code{cpp-define-intro} is combined with the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6151 @code{statement-block-intro} that comes from the @samp{do @{} that hangs
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6152 on the @samp{#define} line:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6153
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6154 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6155 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6156 const char msg[] =
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6157 \"Some text.\";
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6158
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6159 #define X(A, B) do @{ \
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6160 printf (A, B); \ @hereFn{c-lineup-cpp-define}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6161 this->refs++; \
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6162 @} while (0) @hereFn{c-lineup-cpp-define}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6163 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6164 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6165
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6166 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6167 and:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6168
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6169 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6170 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6171 int dribble() @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6172 if (!running)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6173 error(\"Not running!\");
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6174
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6175 #define X(A, B) do @{ \
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6176 printf (A, B); \ @hereFn{c-lineup-cpp-define}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6177 this->refs++; \
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6178 @} while (0) @hereFn{c-lineup-cpp-define}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6179 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6180 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6181
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6182 The relative indentation returned by @code{c-lineup-cpp-define} is zero
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6183 and two, respectively, on the two lines in each of these examples. They
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6184 are then added to the two column indentation that
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6185 @code{statement-block-intro} gives in both cases here.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6186
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6187 If the relative indentation is zero, then @code{nil} is returned
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6188 instead. That is useful in a list expression to specify the default
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6189 indentation on the top level.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6190
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6191 If @code{c-syntactic-indentation-in-macros} is @code{nil} then this
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6192 function keeps the current indentation, except for empty lines (ignoring
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6193 the ending backslash) where it takes the indentation from the closest
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6194 preceding nonempty line in the macro. If there's no such line in the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6195 macro then the indentation is taken from the construct preceding it, as
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6196 described above.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6197
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6198 @workswith @code{cpp-define-intro}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6199 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6200
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6201 @comment ------------------------------------------------------------
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6202
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6203 @defun c-lineup-gcc-asm-reg
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6204 @findex lineup-gcc-asm-reg (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6205 Line up a gcc asm register under one on a previous line.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6206
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6207 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6208 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6209 asm ("foo %1, %0\n"
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6210 "bar %0, %1"
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6211 : "=r" (w),
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6212 "=r" (x)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6213 : "0" (y),
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6214 "1" (z));
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6215 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6216 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6217
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6218 The @samp{x} line is aligned to the text after the @samp{:} on the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6219 @samp{w} line, and similarly @samp{z} under @samp{y}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6220
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6221 This is done only in an @samp{asm} or @samp{__asm__} block, and only to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6222 those lines mentioned. Anywhere else @code{nil} is returned. The usual
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6223 arrangement is to have this routine as an extra feature at the start of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6224 arglist lineups, e.g.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6225
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6226 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6227 (c-lineup-gcc-asm-reg c-lineup-arglist)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6228 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6229
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6230 @workswith @code{arglist-cont}, @code{arglist-cont-nonempty}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6231 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6232
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6233 @comment ------------------------------------------------------------
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6234
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6235 @defun c-lineup-topmost-intro-cont
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6236 @findex lineup-topmost-intro-cont (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6237 Line up declaration continuation lines zero or one indentation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6238 step@footnote{This function is mainly provided to mimic the behavior of
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6239 CC Mode 5.28 and earlier where this case wasn't handled consistently so
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6240 that those lines could be analyzed as either topmost-intro-cont or
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6241 statement-cont. It's used for @code{topmost-intro-cont} by default, but
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6242 you might consider using @code{+} instead.}. For lines preceding a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6243 definition, zero is used. For other lines, @code{c-basic-offset} is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6244 added to the indentation. E.g:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6245
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6246 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6247 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6248 int
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6249 neg (int i) @hereFn{c-lineup-topmost-intro-cont}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6250 @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6251 return -i;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6252 @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6253 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6254 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6255
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6256 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6257 and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6258
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6259 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6260 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6261 struct
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6262 larch @hereFn{c-lineup-topmost-intro-cont}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6263 @{
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6264 double height;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6265 @}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6266 the_larch, @hereFn{c-lineup-topmost-intro-cont}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6267 another_larch; @hereFn{c-lineup-topmost-intro-cont}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6268 @sssTBasicOffset{}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6269 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6270 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6271
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6272 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6273 and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6274
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6275 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6276 @group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6277 struct larch
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6278 the_larch, @hereFn{c-lineup-topmost-intro-cont}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6279 another_larch; @hereFn{c-lineup-topmost-intro-cont}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6280 @end group
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6281 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6282
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6283 @workswith @code{topmost-intro-cont}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6284 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6285
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6286 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6287 @node Custom Line-Up, Other Indentation, Line-Up Functions, Customizing Indentation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6288 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6289 @section Custom Line-Up Functions
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6290 @cindex customization, indentation functions
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6291 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6292
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6293 The most flexible way to customize indentation is by writing custom
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6294 line-up functions, and associating them with specific syntactic
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6295 symbols (@pxref{c-offsets-alist}). Depending on the effect you want,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6296 it might be better to write a @code{c-special-indent-hook} function
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6297 rather than a line-up function (@pxref{Other Indentation}).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6298
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6299 @ccmode{} comes with an extensive set of predefined line-up functions,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6300 not all of which are used by the default styles. So there's a good
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6301 chance the function you want already exists. @xref{Line-Up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6302 Functions}, for a list of them. If you write your own line-up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6303 function, it's probably a good idea to start working from one of these
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6304 predefined functions, which can be found in the file
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6305 @file{cc-align.el}. If you have written a line-up function that you
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6306 think is generally useful, you're very welcome to contribute it;
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6307 please contact @email{bug-cc-mode@@gnu.org}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6308
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6309 Line-up functions are passed a single argument, the syntactic
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6310 element (see below). The return value is a @code{c-offsets-alist}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6311 offset specification: for example, an integer, a symbol such as
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6312 @code{+}, a vector, @code{nil}@footnote{Returning @code{nil} is useful
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6313 when the offset specification for a syntactic element is a list
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6314 containing the line-up function (@pxref{c-offsets-alist}).}, or even
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6315 another line-up function. Full details of these are in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6316 @ref{c-offsets-alist}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6317
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6318 Line-up functions must not move point or change the content of the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6319 buffer (except temporarily). They are however allowed to do
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6320 @dfn{hidden buffer changes}, i.e. setting text properties for caching
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6321 purposes etc. Buffer undo recording is disabled while they run.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6322
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6323 The syntactic element passed as the parameter to a line-up function is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6324 a cons cell of the form
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6325
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6326 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6327 (@r{@var{syntactic-symbol}} . @r{@var{anchor-position}})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6328 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6329
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6330 @noindent
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6331 @c FIXME!!! The following sentence might be better omitted, since the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6332 @c information is in the cross reference "Syntactic Analysis". 2005/10/2.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6333 where @var{syntactic-symbol} is the symbol that the function was
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6334 called for, and @var{anchor-position} is the anchor position (if any)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6335 for the construct that triggered the syntactic symbol
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6336 (@pxref{Syntactic Analysis}). This cons cell is how the syntactic
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6337 element of a line used to be represented in @ccmode{} 5.28 and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6338 earlier. Line-up functions are still passed this cons cell, so as to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6339 preserve compatibility with older configurations. In the future, we
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6340 may decide to convert to using the full list format---you can prepare
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6341 your setup for this by using the access functions
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6342 (@code{c-langelem-sym}, etc.) described below.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6343
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6344 @vindex c-syntactic-element
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6345 @vindex syntactic-element (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6346 @vindex c-syntactic-context
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6347 @vindex syntactic-context (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6348 Some syntactic symbols, e.g. @code{arglist-cont-nonempty}, have more
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6349 info in the syntactic element - typically other positions that can be
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6350 interesting besides the anchor position. That info can't be accessed
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6351 through the passed argument, which is a cons cell. Instead, you can
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6352 get this information from the variable @code{c-syntactic-element},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6353 which is dynamically bound to the complete syntactic element. The
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6354 variable @code{c-syntactic-context} might also be useful - it gets
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6355 dynamically bound to the complete syntactic context. @xref{Custom
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6356 Braces}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6357
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6358 @ccmode{} provides a few functions to access parts of syntactic
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6359 elements in a more abstract way. Besides making the code easier to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6360 read, they also hide the difference between the old cons cell form
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6361 used in the line-up function argument and the new list form used in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6362 @code{c-syntactic-element} and everywhere else. The functions are:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6363
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6364 @defun c-langelem-sym langelem
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6365 @findex langelem-sym (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6366 Return the syntactic symbol in @var{langelem}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6367 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6368
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6369 @defun c-langelem-pos langelem
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6370 @findex langelem-pos (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6371 Return the anchor position in @var{langelem}, or nil if there is none.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6372 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6373
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6374 @defun c-langelem-col langelem &optional preserve-point
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6375 @findex langelem-col (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6376 Return the column of the anchor position in @var{langelem}. Also move
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6377 the point to that position unless @var{preserve-point} is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6378 non-@code{nil}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6379 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6380
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6381 @defun c-langelem-2nd-pos langelem
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6382 @findex langelem-2nd-pos (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6383 Return the secondary position in @var{langelem}, or @code{nil} if there
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6384 is none.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6385
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6386 Note that the return value of this function is always @code{nil} if
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6387 @var{langelem} is in the old cons cell form. Thus this function is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6388 only meaningful when used on syntactic elements taken from
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6389 @code{c-syntactic-element} or @code{c-syntactic-context}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6390 @end defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6391
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6392 Custom line-up functions can be as simple or as complex as you like, and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6393 any syntactic symbol that appears in @code{c-offsets-alist} can have a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6394 custom line-up function associated with it.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6395
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6396 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6397 @node Other Indentation, , Custom Line-Up, Customizing Indentation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6398 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6399 @section Other Special Indentations
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6400 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6401
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6402 Here are the remaining odds and ends regarding indentation:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6403
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6404 @defopt c-label-minimum-indentation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6405 @vindex label-minimum-indentation (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6406 In @samp{gnu} style (@pxref{Built-in Styles}), a minimum indentation is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6407 imposed on lines inside code blocks. This minimum indentation is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6408 controlled by this style variable. The default value is 1.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6409
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6410 @findex c-gnu-impose-minimum
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6411 @findex gnu-impose-minimum (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6412 It's the function @code{c-gnu-impose-minimum} that enforces this minimum
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6413 indentation. It must be present on @code{c-special-indent-hook} to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6414 work.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6415 @end defopt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6416
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6417 @defopt c-special-indent-hook
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6418 @vindex special-indent-hook (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6419 This style variable is a standard hook variable that is called after
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6420 every line is indented by @ccmode{}. It is called only if
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6421 @code{c-syntactic-indentation} is non-@code{nil} (which it is by
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6422 default (@pxref{Indentation Engine Basics})). You can put a function
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6423 on this hook to do any special indentation or ad hoc line adjustments
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6424 your style dictates, such as adding extra indentation to constructors
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6425 or destructor declarations in a class definition, etc. Sometimes it
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6426 is better to write a custom Line-up Function instead (@pxref{Custom
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6427 Line-Up}).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6428
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6429 When the indentation engine calls this hook, the variable
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6430 @code{c-syntactic-context} is bound to the current syntactic context
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6431 (i.e. what you would get by typing @kbd{C-c C-s} on the source line.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6432 @xref{Custom Braces}.). Note that you should not change point or mark
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6433 inside a @code{c-special-indent-hook} function, i.e. you'll probably
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6434 want to wrap your function in a @code{save-excursion}@footnote{The
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6435 numerical value returned by @code{point} will change if you change the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6436 indentation of the line within a @code{save-excursion} form, but point
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6437 itself will still be over the same piece of text.}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6438
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6439 Setting @code{c-special-indent-hook} in style definitions is handled
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6440 slightly differently from other variables---A style can only add
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6441 functions to this hook, not remove them. @xref{Style Variables}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6442 @end defopt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6443
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6444
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6445 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6446 @node Custom Macros, Odds and Ends, Customizing Indentation, Top
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6447 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6448 @chapter Customizing Macros
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6449 @cindex macros
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6450 @cindex preprocessor directives
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6451 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6452
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6453 Normally, the lines in a multi-line macro are indented relative to
86093
d223d695f3f3 (Electric Keys, Electric Keys, Custom Macros): Fix typos.
Juanma Barranquero <lekktu@gmail.com>
parents: 85173
diff changeset
6454 each other as though they were code. You can suppress this behavior
84286
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6455 by setting the following user option:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6456
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6457 @defopt c-syntactic-indentation-in-macros
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6458 @vindex syntactic-indentation-in-macros (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6459 Enable syntactic analysis inside macros, which is the default. If this
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6460 is @code{nil}, all lines inside macro definitions are analyzed as
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6461 @code{cpp-macro-cont}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6462 @end defopt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6463
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6464 @ccmode{} provides some tools to help keep the line continuation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6465 backslashes in macros neat and tidy. Their precise action is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6466 customized with these variables:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6467
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6468 @defopt c-backslash-column
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6469 @vindex backslash-column (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6470 @defoptx c-backslash-max-column
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6471 @vindex backslash-max-column (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6472 These variables control the alignment columns for line continuation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6473 backslashes in multiline macros. They are used by the functions that
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6474 automatically insert or align such backslashes,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6475 e.g. @code{c-backslash-region} and @code{c-context-line-break}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6476
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6477 @code{c-backslash-column} specifies the minimum column for the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6478 backslashes. If any line in the macro goes past this column, then the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6479 next tab stop (i.e. next multiple of @code{tab-width}) in that line is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6480 used as the alignment column for all the backslashes, so that they
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6481 remain in a single column. However, if any lines go past
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6482 @code{c-backslash-max-column} then the backslashes in the rest of the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6483 macro will be kept at that column, so that the lines which are too
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6484 long ``stick out'' instead.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6485
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6486 Don't ever set these variables to @code{nil}. If you want to disable
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6487 the automatic alignment of backslashes, use
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6488 @code{c-auto-align-backslashes}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6489 @end defopt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6490
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6491 @defopt c-auto-align-backslashes
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6492 @vindex auto-align-backslashes (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6493 Align automatically inserted line continuation backslashes if
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6494 non-@code{nil}. When line continuation backslashes are inserted
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6495 automatically for line breaks in multiline macros, e.g. by
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6496 @code{c-context-line-break}, they are aligned with the other
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6497 backslashes in the same macro if this flag is set.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6498
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6499 If @code{c-auto-align-backslashes} is @code{nil}, automatically
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6500 inserted backslashes are preceded by a single space, and backslashes
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6501 get aligned only when you explicitly invoke the command
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6502 @code{c-backslash-region} (@kbd{C-c C-\}).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6503 @end defopt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6504
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6505 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6506 @node Odds and Ends, Sample .emacs File, Custom Macros, Top
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6507 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6508 @chapter Odds and Ends
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6509 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6510
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6511 The stuff that didn't fit in anywhere else is documented here.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6512
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6513 @defopt c-require-final-newline
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6514 @vindex require-final-newline (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6515 Controls whether a final newline is enforced when the file is saved.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6516 The value is an association list that for each language mode specifies
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6517 the value to give to @code{require-final-newline} (@pxref{Saving
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6518 Buffers,,, @lispref{}, @lispreftitle{}}) at mode initialization. If a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6519 language isn't present on the association list, CC Mode won't touch
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6520 @code{require-final-newline} in buffers for that language.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6521
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6522 The default is to set @code{require-final-newline} to @code{t} in the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6523 languages that mandate that source files should end with newlines.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6524 These are C, C++ and Objective-C.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6525 @end defopt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6526
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6527 @defopt c-echo-syntactic-information-p
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6528 @vindex echo-syntactic-information-p (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6529 If non-@code{nil}, the syntactic analysis for the current line is shown
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6530 in the echo area when it's indented (unless
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6531 @code{c-syntactic-indentation} is @code{nil}). That's useful when
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6532 finding out which syntactic symbols to modify to get the indentation you
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6533 want.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6534 @end defopt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6535
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6536 @defopt c-report-syntactic-errors
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6537 @vindex report-syntactic-errors (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6538 If non-@code{nil}, certain syntactic errors are reported with a ding and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6539 a message, for example when an @code{else} is indented for which there
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6540 is no corresponding @code{if}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6541
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6542 Note however that @ccmode{} doesn't make any special effort to check for
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6543 syntactic errors; that's the job of the compiler. The reason it can
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6544 report cases like the one above is that it can't find the correct
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6545 anchoring position to indent the line in that case.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6546 @end defopt
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6547
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6548
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6549 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6550 @node Sample .emacs File, Performance Issues, Odds and Ends, Top
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6551 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6552 @appendix Sample .emacs File
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6553 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6554
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6555 Here's a sample .emacs file fragment that might help you along the way.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6556 Just copy this region and paste it into your .emacs file. You might want
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6557 to change some of the actual values.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6558
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6559 @verbatim
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6560 ;; Make a non-standard key binding. We can put this in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6561 ;; c-mode-base-map because c-mode-map, c++-mode-map, and so on,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6562 ;; inherit from it.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6563 (defun my-c-initialization-hook ()
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6564 (define-key c-mode-base-map "\C-m" 'c-context-line-break))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6565 (add-hook 'c-initialization-hook 'my-c-initialization-hook)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6566
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6567 ;; offset customizations not in my-c-style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6568 ;; This will take precedence over any setting of the syntactic symbol
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6569 ;; made by a style.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6570 (setq c-offsets-alist '((member-init-intro . ++)))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6571
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6572 ;; Create my personal style.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6573 (defconst my-c-style
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6574 '((c-tab-always-indent . t)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6575 (c-comment-only-line-offset . 4)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6576 (c-hanging-braces-alist . ((substatement-open after)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6577 (brace-list-open)))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6578 (c-hanging-colons-alist . ((member-init-intro before)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6579 (inher-intro)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6580 (case-label after)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6581 (label after)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6582 (access-label after)))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6583 (c-cleanup-list . (scope-operator
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6584 empty-defun-braces
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6585 defun-close-semi))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6586 (c-offsets-alist . ((arglist-close . c-lineup-arglist)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6587 (substatement-open . 0)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6588 (case-label . 4)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6589 (block-open . 0)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6590 (knr-argdecl-intro . -)))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6591 (c-echo-syntactic-information-p . t))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6592 "My C Programming Style")
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6593 (c-add-style "PERSONAL" my-c-style)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6594
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6595 ;; Customizations for all modes in CC Mode.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6596 (defun my-c-mode-common-hook ()
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6597 ;; set my personal style for the current buffer
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6598 (c-set-style "PERSONAL")
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6599 ;; other customizations
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6600 (setq tab-width 8
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6601 ;; this will make sure spaces are used instead of tabs
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6602 indent-tabs-mode nil)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6603 ;; we like auto-newline, but not hungry-delete
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6604 (c-toggle-auto-newline 1))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6605 (add-hook 'c-mode-common-hook 'my-c-mode-common-hook)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6606 @end verbatim
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6607
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6608 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6609 @node Performance Issues, Limitations and Known Bugs, Sample .emacs File, Top
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6610 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6611 @chapter Performance Issues
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6612 @cindex performance
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6613 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6614
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6615 @comment FIXME: (ACM, 2003/5/24). Check whether AWK needs mentioning here.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6616
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6617 C and its derivative languages are highly complex creatures. Often,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6618 ambiguous code situations arise that require @ccmode{} to scan large
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6619 portions of the buffer to determine syntactic context. Such
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6620 pathological code can cause @ccmode{} to perform fairly badly. This
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6621 section gives some insight in how @ccmode{} operates, how that interacts
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6622 with some coding styles, and what you can use to improve performance.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6623
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6624 The overall goal is that @ccmode{} shouldn't be overly slow (i.e. take
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6625 more than a fraction of a second) in any interactive operation.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6626 I.e. it's tuned to limit the maximum response time in single operations,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6627 which is sometimes at the expense of batch-like operations like
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6628 reindenting whole blocks. If you find that @ccmode{} gradually gets
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6629 slower and slower in certain situations, perhaps as the file grows in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6630 size or as the macro or comment you're editing gets bigger, then chances
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6631 are that something isn't working right. You should consider reporting
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6632 it, unless it's something that's mentioned in this section.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6633
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6634 Because @ccmode{} has to scan the buffer backwards from the current
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6635 insertion point, and because C's syntax is fairly difficult to parse in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6636 the backwards direction, @ccmode{} often tries to find the nearest
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6637 position higher up in the buffer from which to begin a forward scan
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6638 (it's typically an opening or closing parenthesis of some kind). The
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6639 farther this position is from the current insertion point, the slower it
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6640 gets.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6641
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6642 @findex beginning-of-defun
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6643 In earlier versions of @ccmode{}, we used to recommend putting the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6644 opening brace of a top-level construct@footnote{E.g. a function in C,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6645 or outermost class definition in C++ or Java.} into the leftmost
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6646 column. Earlier still, this used to be a rigid Emacs constraint, as
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6647 embodied in the @code{beginning-of-defun} function. @ccmode now
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6648 caches syntactic information much better, so that the delay caused by
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6649 searching for such a brace when it's not in column 0 is minimal,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6650 except perhaps when you've just moved a long way inside the file.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6651
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6652 @findex defun-prompt-regexp
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6653 @vindex c-Java-defun-prompt-regexp
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6654 @vindex Java-defun-prompt-regexp (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6655 A special note about @code{defun-prompt-regexp} in Java mode: The common
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6656 style is to hang the opening braces of functions and classes on the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6657 right side of the line, and that doesn't work well with the Emacs
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6658 approach. @ccmode{} comes with a constant
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6659 @code{c-Java-defun-prompt-regexp} which tries to define a regular
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6660 expression usable for this style, but there are problems with it. In
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6661 some cases it can cause @code{beginning-of-defun} to hang@footnote{This
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6662 has been observed in Emacs 19.34 and XEmacs 19.15.}. For this reason,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6663 it is not used by default, but if you feel adventurous, you can set
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6664 @code{defun-prompt-regexp} to it in your mode hook. In any event,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6665 setting and relying on @code{defun-prompt-regexp} will definitely slow
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6666 things down because (X)Emacs will be doing regular expression searches a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6667 lot, so you'll probably be taking a hit either way!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6668
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6669 @ccmode{} maintains a cache of the opening parentheses of the blocks
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6670 surrounding the point, and it adapts that cache as the point is moved
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6671 around. That means that in bad cases it can take noticeable time to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6672 indent a line in a new surrounding, but after that it gets fast as long
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6673 as the point isn't moved far off. The farther the point is moved, the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6674 less useful is the cache. Since editing typically is done in ``chunks''
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6675 rather than on single lines far apart from each other, the cache
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6676 typically gives good performance even when the code doesn't fit the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6677 Emacs approach to finding the defun starts.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6678
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6679 @vindex c-enable-xemacs-performance-kludge-p
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6680 @vindex enable-xemacs-performance-kludge-p (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6681 XEmacs users can set the variable
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6682 @code{c-enable-xemacs-performance-kludge-p} to non-@code{nil}. This
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6683 tells @ccmode{} to use XEmacs-specific built-in functions which, in some
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6684 circumstances, can locate the top-most opening brace much more quickly than
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6685 @code{beginning-of-defun}. Preliminary testing has shown that for
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6686 styles where these braces are hung (e.g. most JDK-derived Java styles),
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6687 this hack can improve performance of the core syntax parsing routines
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6688 from 3 to 60 times. However, for styles which @emph{do} conform to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6689 Emacs' recommended style of putting top-level braces in column zero,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6690 this hack can degrade performance by about as much. Thus this variable
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6691 is set to @code{nil} by default, since the Emacs-friendly styles should
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6692 be more common (and encouraged!). Note that this variable has no effect
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6693 in Emacs since the necessary built-in functions don't exist (in Emacs
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6694 22.1 as of this writing in February 2007).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6695
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6696 Text properties are used to speed up skipping over syntactic whitespace,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6697 i.e. comments and preprocessor directives. Indenting a line after a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6698 huge macro definition can be slow the first time, but after that the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6699 text properties are in place and it should be fast (even after you've
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6700 edited other parts of the file and then moved back).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6701
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6702 Font locking can be a CPU hog, especially the font locking done on
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6703 decoration level 3 which tries to be very accurate. Note that that
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6704 level is designed to be used with a font lock support mode that only
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6705 fontifies the text that's actually shown, i.e. Lazy Lock or Just-in-time
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6706 Lock mode, so make sure you use one of them. Fontification of a whole
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6707 buffer with some thousand lines can often take over a minute. That is
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6708 a known weakness; the idea is that it never should happen.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6709
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6710 The most effective way to speed up font locking is to reduce the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6711 decoration level to 2 by setting @code{font-lock-maximum-decoration}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6712 appropriately. That level is designed to be as pretty as possible
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6713 without sacrificing performance. @xref{Font Locking Preliminaries}, for
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6714 more info.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6715
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6716
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6717 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6718 @node Limitations and Known Bugs, FAQ, Performance Issues, Top
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6719 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6720 @chapter Limitations and Known Bugs
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6721 @cindex limitations
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6722 @cindex bugs
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6723 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6724
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6725 @itemize @bullet
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6726 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6727 @ccmode{} doesn't support trigraphs. (These are character sequences
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6728 such as @samp{??(}, which represents @samp{[}. They date from a time
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6729 when some character sets didn't have all the characters that C needs,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6730 and are now utterly obsolete.)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6731
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6732 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6733 There is no way to apply auto newline settings (@pxref{Auto-newlines})
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6734 on already typed lines. That's only a feature to ease interactive
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6735 editing.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6736
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6737 To generalize this issue a bit: @ccmode{} is not intended to be used as
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6738 a reformatter for old code in some more or less batch-like way. With
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6739 the exception of some functions like @code{c-indent-region}, it's only
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6740 geared to be used interactively to edit new code. There's currently no
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6741 intention to change this goal.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6742
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6743 If you want to reformat old code, you're probably better off using some
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6744 other tool instead, e.g. @ref{Top, , GNU indent, indent, The `indent'
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6745 Manual}, which has more powerful reformatting capabilities than
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6746 @ccmode{}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6747
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6748 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6749 The support for C++ templates (in angle brackets) is not yet complete.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6750 When a non-nested template is used in a declaration, @ccmode{} indents
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6751 it and font-locks it OK. Templates used in expressions, and nested
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6752 templates do not fare so well. Sometimes a workaround is to refontify
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6753 the expression after typing the closing @samp{>}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6754
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6755 @item
92570
0c777c6d1ca8 (Limitations and Known Bugs): State that the number of parens/brackets in
Alan Mackenzie <acm@muc.de>
parents: 87903
diff changeset
6756 In a @dfn{k&r region} (the part of an old-fashioned C function
0c777c6d1ca8 (Limitations and Known Bugs): State that the number of parens/brackets in
Alan Mackenzie <acm@muc.de>
parents: 87903
diff changeset
6757 declaration which specifies the types of its parameters, coming
0c777c6d1ca8 (Limitations and Known Bugs): State that the number of parens/brackets in
Alan Mackenzie <acm@muc.de>
parents: 87903
diff changeset
6758 between the parameter list and the opening brace), there should be at
0c777c6d1ca8 (Limitations and Known Bugs): State that the number of parens/brackets in
Alan Mackenzie <acm@muc.de>
parents: 87903
diff changeset
6759 most 20 top-level parenthesis and bracket pairs. This limit has been
0c777c6d1ca8 (Limitations and Known Bugs): State that the number of parens/brackets in
Alan Mackenzie <acm@muc.de>
parents: 87903
diff changeset
6760 imposed for performance reasons. If it is violated, the source file
0c777c6d1ca8 (Limitations and Known Bugs): State that the number of parens/brackets in
Alan Mackenzie <acm@muc.de>
parents: 87903
diff changeset
6761 might be incorrectly indented or fontified.
0c777c6d1ca8 (Limitations and Known Bugs): State that the number of parens/brackets in
Alan Mackenzie <acm@muc.de>
parents: 87903
diff changeset
6762
0c777c6d1ca8 (Limitations and Known Bugs): State that the number of parens/brackets in
Alan Mackenzie <acm@muc.de>
parents: 87903
diff changeset
6763 @item
84286
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6764 On loading @ccmode{}, sometimes this error message appears:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6765
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6766 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6767 File mode specification error: (void-variable c-font-lock-keywords-3)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6768 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6769
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6770 This is due to a bug in the function @code{eval-after-load} in some
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6771 versions of (X)Emacs. It can manifest itself when there is a symbolic
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6772 link in the path of the directory which contains (X)Emacs. As a
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6773 workaround, put the following into your @file{.emacs} file, fairly
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6774 early on:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6775
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6776 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6777 (defun my-load-cc-fonts ()
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6778 (require "cc-fonts"))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6779 (add-hook 'c-initialization-hook 'my-load-cc-fonts)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6780 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6781 @end itemize
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6782
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6783 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6784 @node FAQ, Updating CC Mode, Limitations and Known Bugs, Top
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6785 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6786 @appendix Frequently Asked Questions
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6787 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6788
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6789 @itemize @bullet
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6790 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6791 @emph{How can I change the indent level from 4 spaces to 2 spaces?}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6792
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6793 Set the variable @code{c-basic-offset}. @xref{Getting Started}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6794
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6795 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6796 @kindex RET
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6797 @kindex C-j
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6798 @emph{Why doesn't the @kbd{RET} key indent the new line?}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6799
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6800 Emacs' convention is that @kbd{RET} just adds a newline, and that
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6801 @kbd{C-j} adds a newline and indents it. You can make @kbd{RET} do this
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6802 too by adding this to your @code{c-initialization-hook}:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6803
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6804 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6805 (define-key c-mode-base-map "\C-m" 'c-context-line-break)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6806 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6807
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6808 @xref{Getting Started}. This is a very common question. If you want
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6809 this to be the default behavior, don't lobby us, lobby RMS! @t{:-)}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6810
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6811 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6812 @emph{How do I stop my code jumping all over the place when I type?}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6813
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6814 Deactivate ``electric minor mode'' with @kbd{C-c C-l}. @xref{Getting
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6815 Started}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6816
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6817 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6818 @kindex C-x h
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6819 @kindex C-M-\
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6820 @emph{How do I reindent the whole file?}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6821
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6822 Visit the file and hit @kbd{C-x h} to mark the whole buffer. Then hit
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6823 @kbd{C-M-\}. @xref{Indentation Commands}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6824
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6825 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6826 @kindex C-M-q
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6827 @kindex C-M-u
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6828 @emph{How do I reindent the current block?}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6829
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6830 First move to the brace which opens the block with @kbd{C-M-u}, then
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6831 reindent that expression with @kbd{C-M-q}. @xref{Indentation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6832 Commands}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6833
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6834 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6835 @emph{I put @code{(c-set-offset 'substatement-open 0)} in my
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6836 @file{.emacs} file but I get an error saying that @code{c-set-offset}'s
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6837 function definition is void. What's wrong?}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6838
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6839 This means that @ccmode{} hasn't yet been loaded into your Emacs
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6840 session by the time the @code{c-set-offset} call is reached, most
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6841 likely because @ccmode{} is being autoloaded. Instead of putting the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6842 @code{c-set-offset} line in your top-level @file{.emacs} file, put it
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6843 in your @code{c-initialization-hook} (@pxref{CC Hooks}), or simply
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6844 modify @code{c-offsets-alist} directly:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6845
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6846 @example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6847 (setq c-offsets-alist '((substatement-open . 0)))
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6848 @end example
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6849
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6850 @item
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6851 @cindex open paren in column zero
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6852 @emph{I have an open paren character at column zero inside a comment or
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6853 multiline string literal, and it causes the fontification and/or
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6854 indentation to go haywire. What gives?}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6855
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6856 It's due to the ad-hoc rule in (X)Emacs that such open parens always
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6857 start defuns (which translates to functions, classes, namespaces or any
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6858 other top-level block constructs in the @ccmode{} languages).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6859 @ifset XEMACS
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6860 @xref{Defuns,,, xemacs, XEmacs User's Manual}, for details.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6861 @end ifset
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6862 @ifclear XEMACS
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6863 @xref{Left Margin Paren,,, emacs, GNU Emacs Manual}, for details
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6864 (@xref{Defuns,,, emacs, GNU Emacs Manual}, in the Emacs 20 manual).
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6865 @end ifclear
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6866
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6867 This heuristic is built into the core syntax analysis routines in
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6868 (X)Emacs, so it's not really a @ccmode{} issue. However, in Emacs
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6869 21.1 it became possible to turn it off@footnote{Using the variable
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6870 @code{open-paren-in-column-0-is-defun-start}.} and @ccmode{} does so
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6871 there since it's got its own system to keep track of blocks.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6872
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6873 @end itemize
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6874
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6875
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6876 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6877 @node Updating CC Mode, Mailing Lists and Bug Reports, FAQ, Top
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6878 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6879 @appendix Getting the Latest CC Mode Release
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6880 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6881
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6882 @ccmode{} has been standard with all versions of Emacs since 19.34 and
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6883 of XEmacs since 19.16.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6884
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6885 @cindex web site
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6886 Due to release schedule skew, it is likely that all of these Emacsen
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6887 have old versions of @ccmode{} and so should be upgraded. Access to the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6888 @ccmode{} source code, as well as more detailed information on Emacsen
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6889 compatibility, etc. are all available on the web site:
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6890
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6891 @quotation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6892 @uref{http://cc-mode.sourceforge.net/}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6893 @end quotation
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6894
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6895
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6896 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6897 @node Mailing Lists and Bug Reports, GNU Free Documentation License, Updating CC Mode, Top
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6898 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6899 @appendix Mailing Lists and Submitting Bug Reports
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6900 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6901
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6902 @kindex C-c C-b
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6903 @findex c-submit-bug-report
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6904 @findex submit-bug-report (c-)
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6905 To report bugs, use the @kbd{C-c C-b} (bound to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6906 @code{c-submit-bug-report}) command. This provides vital information
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6907 we need to reproduce your problem. Make sure you include a concise,
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6908 but complete code example. Please try to boil your example down to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6909 just the essential code needed to reproduce the problem, and include
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6910 an exact recipe of steps needed to expose the bug. Be especially sure
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6911 to include any code that appears @emph{before} your bug example, if
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6912 you think it might affect our ability to reproduce it.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6913
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6914 Please try to produce the problem in an Emacs instance without any
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6915 customizations loaded (i.e. start it with the @samp{-q --no-site-file}
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6916 arguments). If it works correctly there, the problem might be caused
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6917 by faulty customizations in either your own or your site
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6918 configuration. In that case, we'd appreciate it if you isolate the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6919 Emacs Lisp code that triggers the bug and include it in your report.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6920
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6921 @cindex bug report mailing list
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6922 Bug reports should be sent to @email{bug-cc-mode@@gnu.org}. You can
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6923 also send other questions and suggestions (kudos? @t{;-)} to that
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6924 address. It's a mailing list which you can join or browse an archive
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6925 of; see the web site at @uref{http://cc-mode.sourceforge.net/} for
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6926 further details.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6927
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6928 @cindex announcement mailing list
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6929 If you want to get announcements of new @ccmode{} releases, send the
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6930 word @emph{subscribe} in the body of a message to
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6931 @email{cc-mode-announce-request@@lists.sourceforge.net}. It's possible
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6932 to subscribe from the web site too. Announcements will also be posted
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6933 to the Usenet newsgroups @code{gnu.emacs.sources}, @code{comp.emacs},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6934 @code{comp.emacs.xemacs}, @code{comp.lang.c}, @code{comp.lang.c++},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6935 @code{comp.lang.objective-c}, @code{comp.lang.java.softwaretools},
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6936 @code{comp.lang.idl}, and @code{comp.lang.awk}.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6937 @c There is no newsgroup for Pike. :-(
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6938
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6939
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6940 @node GNU Free Documentation License, Command and Function Index, Mailing Lists and Bug Reports, Top
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6941 @appendix GNU Free Documentation License
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6942 @include doclicense.texi
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6943
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6944
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6945 @c Removed the tentative node "Mode Initialization" from here, 2005/8/27.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6946 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6947 @node Command and Function Index, Variable Index, GNU Free Documentation License, Top
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6948 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6949 @unnumbered Command and Function Index
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6950 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6951
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6952 Since most @ccmode{} commands are prepended with the string
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6953 @samp{c-}, each appears under its @code{c-@var{thing}} name and its
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6954 @code{@var{thing} (c-)} name.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6955 @iftex
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6956 @sp 2
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6957 @end iftex
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6958 @printindex fn
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6959
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6960
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6961 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6962 @node Variable Index, Concept and Key Index, Command and Function Index, Top
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6963 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6964 @unnumbered Variable Index
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6965 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6966
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6967 Since most @ccmode{} variables are prepended with the string
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6968 @samp{c-}, each appears under its @code{c-@var{thing}} name and its
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6969 @code{@var{thing} (c-)} name.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6970 @iftex
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6971 @sp 2
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6972 @end iftex
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6973 @printindex vr
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6974
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6975
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6976 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6977 @node Concept and Key Index, , Variable Index, Top
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6978 @comment node-name, next, previous, up
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6979 @unnumbered Concept and Key Index
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6980 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6981
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6982 @printindex cp
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6983
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6984
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6985 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6986 @comment Epilogue.
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6987 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6988
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6989 @iftex
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6990 @page
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6991 @summarycontents
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6992 @contents
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6993 @end iftex
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6994
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6995 @bye
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6996
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6997 @ignore
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6998 arch-tag: c4cab162-5e57-4366-bdce-4a9db2fc97f0
926f8ad9f714 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6999 @end ignore