Mercurial > emacs
annotate doc/misc/cc-mode.texi @ 98383:fb8c41cd17c4
*** empty log message ***
author | Martin Rudalics <rudalics@gmx.at> |
---|---|
date | Sun, 28 Sep 2008 08:43:50 +0000 |
parents | 80392a5671b7 |
children | 6de181810d0f |
rev | line source |
---|---|
84286 | 1 \input texinfo |
2 @c Notes to self regarding line handling: | |
3 @c | |
4 @c Empty lines are often significant before @end directives; avoid them. | |
5 @c | |
6 @c Empty lines before and after @example directives are significant in | |
7 @c info output but not in TeX. Empty lines inside @example directives | |
8 @c are significant. | |
9 | |
10 @c Conventions for formatting examples: | |
11 @c o If the example contains empty lines then put the surrounding empty | |
12 @c lines inside the @example directives. Put them outside otherwise. | |
13 @c o Use @group inside the example only if it shows indentation where | |
14 @c the relation between lines inside is relevant. | |
15 @c o Format line number columns like this: | |
16 @c 1: foo | |
17 @c 2: bar | |
18 @c ^ one space | |
19 @c ^^ two columns, right alignment | |
20 @c o Check line lengths in TeX output; they can typically be no longer | |
21 @c than 70 chars, 60 if the paragraph is indented. | |
22 | |
23 @comment TBD: Document the finer details of statement anchoring? | |
24 | |
25 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
26 @comment %**start of header (This is for running Texinfo on a region) | |
27 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
28 | |
29 | |
30 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
31 @comment How to make the various output formats: | |
32 @comment (Thanks to Robert Chassell for supplying this information.) | |
33 @comment Note that Texinfo 4.7 (or later) is needed. | |
34 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
35 @ignore | |
36 In each of the following pairs of commands, the first generates a | |
37 version with cross references pointing to the GNU Emacs manuals, | |
38 the second with them pointing to the XEmacs manuals. | |
39 ## Info output | |
40 makeinfo cc-mode.texi | |
41 makeinfo -DXEMACS cc-mode.texi | |
42 | |
43 ## DVI output | |
44 ## You may need to set up the environment variable TEXINPUTS so | |
45 ## that tex can find the file texinfo.tex - See the tex | |
46 ## manpage. | |
47 texi2dvi cc-mode.texi | |
48 texi2dvi -t "@set XEMACS " cc-mode.texi | |
49 | |
50 ## HTML output. (The --no-split parameter is optional) | |
51 makeinfo --html --no-split cc-mode.texi | |
52 makeinfo --html --no-split -DXEMACS cc-mode.texi | |
53 | |
54 ## Plain text output | |
55 makeinfo --fill-column=70 --no-split --paragraph-indent=0 \ | |
56 --no-headers --output=cc-mode.txt cc-mode.texi | |
57 makeinfo --fill-column=70 --no-split --paragraph-indent=0 \ | |
58 --no-headers --output=cc-mode.txt -DXEMACS cc-mode.texi | |
59 | |
60 ## DocBook output | |
61 makeinfo --docbook --no-split --paragraph-indent=0 \ | |
62 cc-mode.texi | |
63 makeinfo --docbook --no-split --paragraph-indent=0 \ | |
64 -DXEMACS cc-mode.texi | |
65 | |
66 ## XML output | |
67 makeinfo --xml --no-split --paragraph-indent=0 \ | |
68 cc-mode.texi | |
69 makeinfo --xml --no-split --paragraph-indent=0 \ | |
70 -DXEMACS cc-mode.texi | |
71 | |
72 #### (You must be in the same directory as the viewed file.) | |
73 | |
74 ## View DVI output | |
75 xdvi cc-mode.dvi & | |
76 | |
77 ## View HTML output | |
78 mozilla cc-mode.html | |
79 @end ignore | |
80 | |
81 @comment No overfull hbox marks in the dvi file. | |
82 @finalout | |
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 | 85 @settitle CC Mode Manual |
86 @footnotestyle end | |
87 | |
88 @c The following four macros generate the filenames and titles of the | |
89 @c main (X)Emacs manual and the Elisp/Lispref manual. Leave the | |
90 @c Texinfo variable `XEMACS' unset to generate a GNU Emacs version, set it | |
91 @c to generate an XEmacs version, e.g. with | |
92 @c "makeinfo -DXEMACS cc-mode.texi". | |
93 @ifset XEMACS | |
94 @macro emacsman | |
95 xemacs | |
96 @end macro | |
97 @macro emacsmantitle | |
98 XEmacs User's Manual | |
99 @end macro | |
100 @macro lispref | |
101 lispref | |
102 @end macro | |
103 @macro lispreftitle | |
104 XEmacs Lisp Reference Manual | |
105 @end macro | |
106 @end ifset | |
107 | |
108 @ifclear XEMACS | |
109 @macro emacsman | |
110 emacs | |
111 @end macro | |
112 @macro emacsmantitle | |
113 GNU Emacs Manual | |
114 @end macro | |
115 @macro lispref | |
116 elisp | |
117 @end macro | |
118 @macro lispreftitle | |
119 GNU Emacs Lisp Reference Manual | |
120 @end macro | |
121 @end ifclear | |
122 | |
123 | |
124 @macro ccmode | |
125 CC Mode | |
126 @end macro | |
127 | |
128 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
129 @comment @setchapternewpage odd !! we don't want blank pages !! | |
130 @comment %**end of header (This is for running Texinfo on a region) | |
131 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
132 | |
133 | |
134 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
135 @comment | |
136 @comment Texinfo manual for CC Mode | |
137 @comment Generated from the original README file by Krishna Padmasola | |
138 @comment <krishna@earth-gw.njit.edu> | |
139 @comment | |
140 @comment Authors: | |
141 @comment Barry A. Warsaw | |
142 @comment Martin Stjernholm | |
143 @comment Alan Mackenzie | |
144 @comment | |
145 @comment Maintained by Martin Stjernholm and Alan Mackenzie <bug-cc-mode@gnu.org> | |
146 @comment | |
147 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
148 | |
149 @comment Define an index for syntactic symbols. | |
150 @ifnottex @c In texi2dvi, the @defindex would create an empty cc-mode.ss | |
151 @c For Info, unlike tex, @syncodeindex needs a matching @defindex. | |
152 @defindex ss | |
153 @end ifnottex | |
154 | |
155 @comment Combine key, syntactic symbol and concept indices into one. | |
156 @syncodeindex ss cp | |
157 @syncodeindex ky cp | |
158 | |
159 @copying | |
160 This manual is for CC Mode in Emacs. | |
161 | |
162 Copyright @copyright{} 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, | |
87903 | 163 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc. |
84286 | 164 |
165 @quotation | |
166 Permission is granted to copy, distribute and/or modify this document | |
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 | 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 | 176 @end quotation |
177 @end copying | |
178 | |
179 @comment Info directory entry for use by install-info. The indentation | |
180 @comment here is by request from the FSF folks. | |
181 @dircategory Emacs | |
182 @direntry | |
183 * CC Mode: (ccmode). Emacs mode for editing C, C++, Objective-C, | |
184 Java, Pike, AWK, and CORBA IDL code. | |
185 @end direntry | |
186 | |
187 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
188 @comment TeX title page | |
189 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
190 | |
191 @titlepage | |
192 @sp 10 | |
193 | |
194 @center @titlefont{CC Mode 5.31} | |
195 @sp 2 | |
196 @center @subtitlefont{A GNU Emacs mode for editing C and C-like languages} | |
197 @sp 2 | |
198 @center Barry A. Warsaw, Martin Stjernholm, Alan Mackenzie | |
199 | |
200 @page | |
201 @vskip 0pt plus 1filll | |
202 @insertcopying | |
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 | 207 @end titlepage |
208 | |
209 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
210 @comment The Top node contains the master menu for the Info file. | |
211 @comment This appears only in the Info file, not the printed manual. | |
212 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
213 | |
214 @node Top, Introduction, (dir), (dir) | |
215 @comment node-name, next, previous, up | |
216 | |
217 @ifinfo | |
218 @top @ccmode{} | |
219 | |
220 @ccmode{} is a GNU Emacs mode for editing files containing C, C++, | |
221 Objective-C, Java, CORBA IDL (and the variants PSDL and CIDL), Pike | |
222 and AWK code. It provides syntax-based indentation, font locking, and | |
223 has several handy commands and some minor modes to make the editing | |
224 easier. It does not provide tools to look up and navigate between | |
225 functions, classes etc - there are other packages for that. | |
226 @end ifinfo | |
227 | |
228 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
229 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
230 | |
231 @menu | |
232 * Introduction:: | |
233 * Overview:: | |
234 * Getting Started:: | |
235 * Commands:: | |
236 * Font Locking:: | |
237 * Config Basics:: | |
238 * Custom Filling and Breaking:: | |
239 * Custom Auto-newlines:: | |
240 * Clean-ups:: | |
241 * Indentation Engine Basics:: | |
242 * Customizing Indentation:: | |
243 * Custom Macros:: | |
244 * Odds and Ends:: | |
245 * Sample .emacs File:: | |
246 * Performance Issues:: | |
247 * Limitations and Known Bugs:: | |
248 * FAQ:: | |
249 * Updating CC Mode:: | |
250 * Mailing Lists and Bug Reports:: | |
251 * GNU Free Documentation License:: | |
252 * Command and Function Index:: | |
253 * Variable Index:: | |
254 * Concept and Key Index:: | |
255 | |
256 @detailmenu | |
257 --- The Detailed Node Listing --- | |
258 | |
259 Commands | |
260 | |
261 * Indentation Commands:: | |
262 * Comment Commands:: | |
263 * Movement Commands:: | |
264 * Filling and Breaking:: | |
265 * Minor Modes:: | |
266 * Electric Keys:: | |
267 * Auto-newlines:: | |
268 * Hungry WS Deletion:: | |
269 * Subword Movement:: | |
270 * Other Commands:: | |
271 | |
272 Font Locking | |
273 | |
274 * Font Locking Preliminaries:: | |
275 * Faces:: | |
276 * Doc Comments:: | |
277 * AWK Mode Font Locking:: | |
278 | |
279 Configuration Basics | |
280 | |
281 * CC Hooks:: | |
282 * Style Variables:: | |
283 * Styles:: | |
284 | |
285 Styles | |
286 | |
287 * Built-in Styles:: | |
288 * Choosing a Style:: | |
289 * Adding Styles:: | |
290 * File Styles:: | |
291 | |
292 Customizing Auto-newlines | |
293 | |
294 * Hanging Braces:: | |
295 * Hanging Colons:: | |
296 * Hanging Semicolons and Commas:: | |
297 | |
298 Hanging Braces | |
299 | |
300 * Custom Braces:: | |
301 | |
302 Indentation Engine Basics | |
303 | |
304 * Syntactic Analysis:: | |
305 * Syntactic Symbols:: | |
306 * Indentation Calculation:: | |
307 | |
308 Syntactic Symbols | |
309 | |
310 * Function Symbols:: | |
311 * Class Symbols:: | |
312 * Conditional Construct Symbols:: | |
313 * Switch Statement Symbols:: | |
314 * Brace List Symbols:: | |
315 * External Scope Symbols:: | |
316 * Paren List Symbols:: | |
317 * Literal Symbols:: | |
318 * Multiline Macro Symbols:: | |
319 * Objective-C Method Symbols:: | |
320 * Anonymous Class Symbol:: | |
321 * Statement Block Symbols:: | |
322 * K&R Symbols:: | |
323 | |
324 Customizing Indentation | |
325 | |
326 * c-offsets-alist:: | |
327 * Interactive Customization:: | |
328 * Line-Up Functions:: | |
329 * Custom Line-Up:: | |
330 * Other Indentation:: | |
331 | |
332 Line-Up Functions | |
333 | |
334 * Brace/Paren Line-Up:: | |
335 * List Line-Up:: | |
336 * Operator Line-Up:: | |
337 * Comment Line-Up:: | |
338 * Misc Line-Up:: | |
339 | |
340 @end detailmenu | |
341 @end menu | |
342 | |
343 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
344 @node Introduction, Overview, Top, Top | |
345 @comment node-name, next, previous, up | |
346 @chapter Introduction | |
347 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
348 | |
349 @cindex BOCM | |
350 @cindex history | |
351 @cindex awk-mode.el | |
352 @cindex c-mode.el | |
353 @cindex c++-mode.el | |
354 | |
355 Welcome to @ccmode{}, a GNU Emacs mode for editing files containing C, | |
356 C++, Objective-C, Java, CORBA IDL (and the variants CORBA PSDL and | |
357 CIDL), Pike and AWK code. This incarnation of the mode is descended | |
358 from @file{c-mode.el} (also called ``Boring Old C Mode'' or BOCM | |
359 @t{:-)}, @file{c++-mode.el} version 2, which Barry Warsaw had been | |
360 maintaining since 1992, and @file{awk-mode.el}, a long neglected mode | |
361 in the (X)Emacs base. | |
362 | |
363 Late in 1997, Martin Stjernholm joined Barry on the @ccmode{} | |
364 Maintainers Team, and implemented the Pike support. In 2000 Martin | |
365 took over as the sole maintainer. In 2001 Alan Mackenzie joined the | |
366 team, implementing AWK support in version 5.30. @ccmode{} did not | |
367 originally contain the font lock support for its languages --- that | |
368 was added in version 5.30. | |
369 | |
370 This manual describes @ccmode{} | |
371 @comment The following line must appear on its own, so that the | |
372 version 5.31. | |
373 @comment Release.py script can update the version number automatically | |
374 | |
375 @ccmode{} supports the editing of K&R and ANSI C, C++, Objective-C, | |
376 Java, CORBA's Interface Definition Language, Pike@footnote{A C-like | |
377 scripting language with its roots in the LPC language used in some MUD | |
378 engines. See @uref{http://pike.ida.liu.se/}.} and AWK files. In this | |
379 way, you can easily set up consistent font locking and coding styles for | |
380 use in editing all of these languages, although AWK is not yet as | |
381 uniformly integrated as the other languages. | |
382 | |
383 @findex c-mode | |
384 @findex c++-mode | |
385 @findex objc-mode | |
386 @findex java-mode | |
387 @findex idl-mode | |
388 @findex pike-mode | |
389 @findex awk-mode | |
390 Note that the name of this package is ``@ccmode{}'', but there is no top | |
391 level @code{cc-mode} entry point. All of the variables, commands, and | |
392 functions in @ccmode{} are prefixed with @code{c-@var{thing}}, and | |
393 @code{c-mode}, @code{c++-mode}, @code{objc-mode}, @code{java-mode}, | |
394 @code{idl-mode}, @code{pike-mode}, and @code{awk-mode} entry points are | |
395 provided. This package is intended to be a replacement for | |
396 @file{c-mode.el}, @file{c++-mode.el} and @file{awk-mode.el}. | |
397 | |
398 A special word of thanks goes to Krishna Padmasola for his work in | |
399 converting the original @file{README} file to Texinfo format. I'd | |
400 also like to thank all the @ccmode{} victims who help enormously | |
401 during the early beta stages of @ccmode{}'s development. | |
402 | |
403 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
404 @node Overview, Getting Started, Introduction, Top | |
405 @comment node-name, next, previous, up@cindex organization of the manual | |
406 @chapter Overview of the Manual | |
407 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
408 | |
409 @noindent | |
410 The manual starts with several introductory chapters (including this | |
411 one). | |
412 | |
413 @noindent | |
414 The next chunk of the manual describes the day to day @emph{use} of | |
415 @ccmode{} (as contrasted with how to customize it). | |
416 | |
417 @itemize @bullet | |
418 @item | |
419 The chapter ``Commands'' describes in detail how to use (nearly) all | |
420 of @ccmode{}'s features. There are extensive cross-references from | |
421 here to the corresponding sections later in the manual which tell you | |
422 how to customize these features. | |
423 | |
424 @item | |
425 ``Font Locking'' describes how ``syntax highlighting'' is applied to | |
426 your buffers. It is mainly background information and can be skipped | |
427 over at a first reading. | |
428 @end itemize | |
429 | |
430 @noindent | |
431 The next chunk of the manual describes how to @emph{customize} | |
432 @ccmode{}. Typically, an overview of a topic is given at the chapter | |
433 level, then the sections and subsections describe the material in | |
434 increasing detail. | |
435 | |
436 @itemize @bullet | |
437 @item | |
438 The chapter ``Configuration Basics'' tells you @emph{how} to write | |
439 customizations - whether in hooks, in styles, in both, or in neither, | |
440 depending on your needs. It describes the @ccmode{} style system and | |
441 lists the standard styles that @ccmode{} supplies. | |
442 | |
443 @item | |
444 The next few chapters describe in detail how to customize the various | |
445 features of @ccmode{}. | |
446 | |
447 @item | |
448 Finally, there is a sample @file{.emacs} fragment, which might help you | |
449 in creating your own customization. | |
450 @end itemize | |
451 | |
452 @noindent | |
453 The manual ends with ``this and that'', things that don't fit cleanly | |
454 into any of the previous chunks. | |
455 | |
456 @itemize @bullet | |
457 @item | |
458 Two chapters discuss the performance of @ccmode{} and known | |
459 bugs/limitations. | |
460 | |
461 @item | |
462 The FAQ contains a list of common problems and questions. | |
463 | |
464 @item | |
465 The next two chapters tell you how to get in touch with the @ccmode{} | |
466 project - whether for updating @ccmode{} or submitting bug reports. | |
467 @end itemize | |
468 | |
469 @noindent | |
470 Finally, there are the customary indices. | |
471 | |
472 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
473 @node Getting Started, Commands, Overview, Top | |
474 @comment node-name, next, previous, up | |
475 @chapter Getting Started | |
476 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
477 | |
478 If you got this version of @ccmode{} with Emacs or XEmacs, it should | |
479 work just fine right out of the box. Note however that you might not | |
480 have the latest @ccmode{} release and might want to upgrade your copy | |
481 (see below). | |
482 | |
87453 | 483 You should probably start by skimming through the entire Commands chapter |
484 (@pxref{Commands}) to get an overview of @ccmode{}'s capabilities. | |
84286 | 485 |
486 After trying out some commands, you may dislike some aspects of | |
487 @ccmode{}'s default configuration. Here is an outline of how to | |
488 change some of the settings that newcomers to @ccmode{} most often | |
489 want to change: | |
490 | |
491 @table @asis | |
492 @item c-basic-offset | |
493 This Lisp variable holds an integer, the number of columns @ccmode{} | |
494 indents nested code. To set this value to 6, customize | |
495 @code{c-basic-offset} or put this into your @file{.emacs}: | |
496 | |
497 @example | |
498 (setq c-basic-offset 6) | |
499 @end example | |
500 | |
501 @item The (indentation) style | |
502 The basic ``shape'' of indentation created by @ccmode{}---by default, | |
503 this is @code{gnu} style (except for Java and AWK buffers). A list of | |
504 the available styles and their descriptions can be found in | |
505 @ref{Built-in Styles}. A complete specification of the @ccmode{} | |
506 style system, including how to create your own style, can be found in | |
507 the chapter @ref{Styles}. To set your style to @code{linux}, either | |
508 customize @code{c-default-style} or put this into your @file{.emacs}: | |
509 | |
510 @example | |
511 (setq c-default-style '((java-mode . "java") | |
512 (awk-mode . "awk") | |
513 (other . "linux"))) | |
514 @end example | |
515 | |
516 @item Electric Indentation | |
517 Normally, when you type ``punctuation'' characters such as @samp{;} or | |
518 @samp{@{}, @ccmode{} instantly reindents the current line. This can | |
519 be disconcerting until you get used to it. To disable @dfn{electric | |
520 indentation} in the current buffer, type @kbd{C-c C-l}. Type the same | |
521 thing to enable it again. To have electric indentation disabled by | |
522 default, put the following into your @file{.emacs} file@footnote{There | |
523 is no ``easy customization'' facility for making this change.}: | |
524 | |
525 @example | |
526 (setq-default c-electric-flag nil) | |
527 @end example | |
528 | |
529 @noindent | |
530 Details of this and other similar ``Minor Modes'' appear in the | |
531 section @ref{Minor Modes}. | |
532 | |
533 @item Making the @key{RET} key indent the new line | |
534 The standard Emacs binding for @key{RET} just adds a new line. If you | |
535 want it to reindent the new line as well, rebind the key. Note that | |
536 the action of rebinding would fail if the pertinent keymap didn't yet | |
537 exist---we thus need to delay the action until after @ccmode{} has | |
538 been loaded. Put the following code into your @file{.emacs}: | |
539 | |
540 @example | |
541 (defun my-make-CR-do-indent () | |
542 (define-key c-mode-base-map "\C-m" 'c-context-line-break)) | |
543 (add-hook 'c-initialization-hook 'my-make-CR-do-indent) | |
544 @end example | |
545 | |
546 @noindent | |
547 This example demonstrates the use of a very powerful @ccmode{} (and | |
548 Emacs) facility, the hook. The use of @ccmode{}'s hooks is described | |
549 in @ref{CC Hooks}. | |
550 @end table | |
551 | |
552 All these settings should occur in your @file{.emacs} @emph{before} | |
553 any @ccmode{} buffers get loaded---in particular, before any call of | |
554 @code{desktop-read}. | |
555 | |
556 As you get to know the mode better, you may want to make more | |
557 ambitious changes to your configuration. For this, you should start | |
558 reading the chapter @ref{Config Basics}. | |
559 | |
560 If you are upgrading an existing @ccmode{} installation, please see | |
561 the @file{README} file for installation details. In particular, if | |
562 you are going to be editing AWK files, @file{README} describes how to | |
563 configure your (X)Emacs so that @ccmode{} will supersede the obsolete | |
564 @code{awk-mode.el} which might have been supplied with your (X)Emacs. | |
565 @ccmode{} might not work with older versions of Emacs or XEmacs. See | |
566 the @ccmode{} release notes at @uref{http://cc-mode.sourceforge.net} | |
567 for the latest information on Emacs version and package compatibility | |
568 (@pxref{Updating CC Mode}). | |
569 | |
570 @deffn Command c-version | |
571 @findex version (c-) | |
572 You can find out what version of @ccmode{} you are using by visiting a C | |
573 file and entering @kbd{M-x c-version RET}. You should see this message in | |
574 the echo area: | |
575 | |
576 @example | |
577 Using CC Mode version 5.XX | |
578 @end example | |
579 | |
580 @noindent | |
581 where @samp{XX} is the minor release number. | |
582 @end deffn | |
583 | |
584 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
585 @node Commands, Font Locking, Getting Started, Top | |
586 @comment node-name, next, previous, up | |
587 @chapter Commands | |
588 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
589 | |
590 This chapter specifies all of CC Mode's commands, and thus contains | |
591 nearly everything you need to know to @emph{use} @ccmode{} (as | |
592 contrasted with configuring it). @dfn{Commands} here means both | |
593 control key sequences and @dfn{electric keys}, these being characters | |
594 such as @samp{;} which, as well as inserting themselves into the | |
595 buffer, also do other things. | |
596 | |
597 You might well want to review | |
598 @ifset XEMACS | |
599 @ref{Lists,,,@emacsman{}, @emacsmantitle{}}, | |
600 @end ifset | |
601 @ifclear XEMACS | |
602 @ref{Moving by Parens,,,@emacsman{}, @emacsmantitle{}}, | |
603 @end ifclear | |
604 which describes commands for moving around brace and parenthesis | |
605 structures. | |
606 | |
607 | |
608 @menu | |
609 * Indentation Commands:: | |
610 * Comment Commands:: | |
611 * Movement Commands:: | |
612 * Filling and Breaking:: | |
613 * Minor Modes:: | |
614 * Electric Keys:: | |
615 * Auto-newlines:: | |
616 * Hungry WS Deletion:: | |
617 * Subword Movement:: | |
618 * Other Commands:: | |
619 @end menu | |
620 | |
621 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
622 @node Indentation Commands, Comment Commands, Commands, Commands | |
623 @comment node-name, next, previous,up | |
624 @section Indentation Commands | |
625 @cindex indentation | |
626 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
627 | |
628 The following commands reindent C constructs. Note that when you | |
629 change your coding style, either interactively or through some other | |
630 means, your file does @emph{not} automatically get reindented. You | |
631 will need to execute one of the following commands to see the effects | |
632 of your changes. | |
633 | |
634 @cindex GNU indent program | |
635 Also, variables like @code{c-hanging-*} and @code{c-cleanup-list} | |
636 (@pxref{Custom Auto-newlines}) only affect how on-the-fly code is | |
637 formatted. Changing the ``hanginess'' of a brace and then | |
638 reindenting, will not move the brace to a different line. For this, | |
639 you're better off getting an external program like GNU @code{indent}, | |
640 which will rearrange brace location, amongst other things. | |
641 | |
642 Preprocessor directives are handled as syntactic whitespace from other | |
643 code, i.e. they can be interspersed anywhere without affecting the | |
644 indentation of the surrounding code, just like comments. | |
645 | |
646 The code inside macro definitions is, by default, still analyzed | |
647 syntactically so that you get relative indentation there just as you'd | |
648 get if the same code was outside a macro. However, since there is no | |
649 hint about the syntactic context, i.e. whether the macro expands to an | |
650 expression, to some statements, or perhaps to whole functions, the | |
651 syntactic recognition can be wrong. @ccmode{} manages to figure it | |
652 out correctly most of the time, though. | |
653 | |
654 Reindenting large sections of code can take a long time. When | |
655 @ccmode{} reindents a region of code, it is essentially equivalent to | |
656 hitting @key{TAB} on every line of the region. | |
657 | |
658 These commands indent code: | |
659 | |
660 @table @asis | |
661 @item @kbd{@key{TAB}} (@code{c-indent-command}) | |
662 @kindex TAB | |
663 @findex c-indent-command | |
664 @findex indent-command (c-) | |
665 This command indents the current line. That is all you need to know | |
666 about it for normal use. | |
667 | |
668 @code{c-indent-command} does different things, depending on the | |
669 setting of @code{c-syntactic-indentation} (@pxref{Indentation Engine | |
670 Basics}): | |
671 | |
672 @itemize @bullet | |
673 @item | |
674 When it's non-@code{nil} (which it normally is), the command indents | |
675 the line according to its syntactic context. With a prefix argument | |
676 (@kbd{C-u @key{TAB}}), it will re-indent the entire | |
677 expression@footnote{this is only useful for a line starting with a | |
678 comment opener or an opening brace, parenthesis, or string quote.} | |
679 that begins at the line's left margin. | |
680 | |
681 @item | |
682 When it's @code{nil}, the command indents the line by an extra | |
683 @code{c-basic-offset} columns. A prefix argument acts as a | |
684 multiplier. A bare prefix (@kbd{C-u @key{TAB}}) is equivalent to -1, | |
685 removing @code{c-basic-offset} columns from the indentation. | |
686 @end itemize | |
687 | |
688 The precise behavior is modified by several variables: With | |
689 @code{c-tab-always-indent}, you can make @key{TAB} insert whitespace | |
690 in some circumstances---@code{c-insert-tab-function} then defines | |
691 precisely what sort of ``whitespace'' this will be. Set the standard | |
692 Emacs variable @code{indent-tabs-mode} to @code{t} if you want real | |
693 @samp{tab} characters to be used in the indentation, to @code{nil} if | |
694 you want only spaces. @xref{Just Spaces,,, @emacsman{}, | |
695 @emacsmantitle{}}. | |
696 | |
697 @defopt c-tab-always-indent | |
698 @vindex tab-always-indent (c-) | |
699 @cindex literal | |
700 This variable modifies how @key{TAB} operates. | |
701 @itemize @bullet | |
702 @item | |
703 When it is @code{t} (the default), @key{TAB} simply indents the | |
704 current line. | |
705 @item | |
706 When it is @code{nil}, @key{TAB} (re)indents the line only if point is | |
707 to the left of the first non-whitespace character on the line. | |
708 Otherwise it inserts some whitespace (a tab or an equivalent number of | |
709 spaces - see below) at point. | |
710 @item | |
711 With some other value, the line is reindented. Additionally, if point | |
712 is within a string or comment, some whitespace is inserted. | |
713 @end itemize | |
714 @end defopt | |
715 | |
716 @defopt c-insert-tab-function | |
717 @vindex insert-tab-function (c-) | |
718 @findex tab-to-tab-stop | |
719 When ``some whitespace'' is inserted as described above, what actually | |
720 happens is that the function stored in @code{c-insert-tab-function} is | |
721 called. Normally, this is @code{insert-tab}, which inserts a real tab | |
722 character or the equivalent number of spaces (depending on | |
723 @code{indent-tabs-mode}). Some people, however, set | |
724 @code{c-insert-tab-function} to @code{tab-to-tab-stop} so as to get | |
725 hard tab stops when indenting. | |
726 @end defopt | |
727 @end table | |
728 | |
729 @noindent | |
730 The kind of indentation the next five commands do depends on the | |
731 setting of @code{c-syntactic-indentation} (@pxref{Indentation Engine | |
732 Basics}): | |
733 @itemize @bullet | |
734 @item | |
735 when it is non-@code{nil} (the default), the commands indent lines | |
736 according to their syntactic context; | |
737 @item | |
738 when it is @code{nil}, they just indent each line the same amount as | |
739 the previous non-blank line. The commands that indent a region aren't | |
740 very useful in this case. | |
741 @end itemize | |
742 | |
743 @table @asis | |
744 @item @kbd{C-j} (@code{newline-and-indent}) | |
745 @kindex C-j | |
746 @findex newline-and-indent | |
747 Inserts a newline and indents the new blank line, ready to start | |
748 typing. This is a standard (X)Emacs command. | |
749 | |
750 @item @kbd{C-M-q} (@code{c-indent-exp}) | |
751 @kindex C-M-q | |
752 @findex c-indent-exp | |
753 @findex indent-exp (c-) | |
754 Indents an entire balanced brace or parenthesis expression. Note that | |
755 point must be on the opening brace or parenthesis of the expression | |
756 you want to indent. | |
757 | |
758 @item @kbd{C-c C-q} (@code{c-indent-defun}) | |
759 @kindex C-c C-q | |
760 @findex c-indent-defun | |
761 @findex indent-defun (c-) | |
762 Indents the entire top-level function, class or macro definition | |
763 encompassing point. It leaves point unchanged. This function can't be | |
764 used to reindent a nested brace construct, such as a nested class or | |
765 function, or a Java method. The top-level construct being reindented | |
766 must be complete, i.e. it must have both a beginning brace and an ending | |
767 brace. | |
768 | |
769 @item @kbd{C-M-\} (@code{indent-region}) | |
770 @kindex C-M-\ | |
771 @findex indent-region | |
772 Indents an arbitrary region of code. This is a standard Emacs command, | |
773 tailored for C code in a @ccmode{} buffer. Note, of course, that point | |
774 and mark must delineate the region you want to indent. | |
775 | |
776 @item @kbd{C-M-h} (@code{c-mark-function}) | |
777 @kindex C-M-h | |
778 @findex c-mark-function | |
779 @findex mark-function (c-) | |
780 While not strictly an indentation command, this is useful for marking | |
781 the current top-level function or class definition as the current | |
782 region. As with @code{c-indent-defun}, this command operates on | |
783 top-level constructs, and can't be used to mark say, a Java method. | |
784 @end table | |
785 | |
786 These variables are also useful when indenting code: | |
787 | |
788 @defopt indent-tabs-mode | |
789 This is a standard Emacs variable that controls how line indentation | |
790 is composed. When it's non-@code{nil}, tabs can be used in a line's | |
791 indentation, otherwise only spaces are used. | |
792 @end defopt | |
793 | |
794 @defopt c-progress-interval | |
795 @vindex progress-interval (c-) | |
796 When indenting large regions of code, this variable controls how often a | |
797 progress message is displayed. Set this variable to @code{nil} to | |
798 inhibit the progress messages, or set it to an integer which is how | |
799 often (in seconds) progress messages are to be displayed. | |
800 @end defopt | |
801 | |
802 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
803 @node Comment Commands, Movement Commands, Indentation Commands, Commands | |
804 @comment node-name, next, previous, up | |
805 @section Comment Commands | |
806 @cindex comments (insertion of) | |
807 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
808 | |
809 @table @asis | |
810 @item @kbd{C-c C-c} (@code{comment-region}) | |
811 @kindex C-c C-c | |
812 @findex comment-region | |
813 This command comments out the lines that start in the region. With a | |
814 negative argument, it does the opposite - it deletes the comment | |
815 delimiters from these lines. @xref{Multi-Line Comments,,, emacs, GNU | |
816 Emacs Manual}, for fuller details. @code{comment-region} isn't | |
817 actually part of @ccmode{} - it is given a @ccmode{} binding for | |
818 convenience. | |
819 | |
820 @item @kbd{M-;} (@code{comment-dwim} or @code{indent-for-comment} @footnote{The name of this command varies between (X)Emacs versions.}) | |
821 @kindex M-; | |
822 @findex comment-dwim | |
823 @findex indent-for-comment | |
824 Insert a comment at the end of the current line, if none is there | |
825 already. Then reindent the comment according to @code{comment-column} | |
826 @ifclear XEMACS | |
827 (@pxref{Options for Comments,,, emacs, GNU Emacs Manual}) | |
828 @end ifclear | |
829 @ifset XEMACS | |
830 (@pxref{Comments,,, xemacs, XEmacs User's Manual}) | |
831 @end ifset | |
832 and the variables below. Finally, position the point after the | |
833 comment starter. @kbd{C-u M-;} kills any comment on the current line, | |
834 together with any whitespace before it. This is a standard Emacs | |
835 command, but @ccmode{} enhances it a bit with two variables: | |
836 | |
837 @defopt c-indent-comment-alist | |
838 @vindex indent-comment-alist (c-) | |
839 @vindex comment-column | |
840 This style variable allows you to vary the column that @kbd{M-;} puts | |
841 the comment at, depending on what sort of code is on the line, and | |
842 possibly the indentation of any similar comment on the preceding line. | |
843 It is an association list that maps different types of lines to | |
844 actions describing how they should be handled. If a certain line type | |
845 isn't present on the list then the line is indented to the column | |
846 specified by @code{comment-column}. | |
847 | |
848 See the documentation string for a full description of this | |
849 variable (use @kbd{C-h v c-indent-comment-alist}). | |
850 @end defopt | |
851 | |
852 @defopt c-indent-comments-syntactically-p | |
853 @vindex indent-comments-syntactically-p (c-) | |
854 Normally, when this style variable is @code{nil}, @kbd{M-;} will | |
855 indent comment-only lines according to @code{c-indent-comment-alist}, | |
856 just as it does with lines where other code precede the comments. | |
857 However, if you want it to act just like @key{TAB} for comment-only | |
858 lines you can get that by setting | |
859 @code{c-indent-comments-syntactically-p} to non-@code{nil}. | |
860 | |
861 If @code{c-indent-comments-syntactically-p} is non-@code{nil} then | |
862 @code{c-indent-comment-alist} won't be consulted at all for comment-only | |
863 lines. | |
864 @end defopt | |
865 @end table | |
866 | |
867 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
868 @node Movement Commands, Filling and Breaking, Comment Commands, Commands | |
869 @comment node-name, next, previous, up | |
870 @section Movement Commands | |
871 @cindex movement | |
872 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
873 | |
874 @ccmode{} contains some useful commands for moving around in C code. | |
875 | |
876 @table @asis | |
877 @item @kbd{C-M-a} (@code{c-beginning-of-defun}) | |
878 @itemx @kbd{C-M-e} (@code{c-end-of-defun}) | |
879 @findex c-beginning-of-defun | |
880 @findex c-end-of-defun | |
881 | |
882 Move to the beginning or end of the current or next function. Other | |
883 constructs (such as a structs or classes) which have a brace block | |
884 also count as ``functions'' here. To move over several functions, you | |
885 can give these commands a repeat count. | |
886 | |
887 The start of a function is at its header. The end of the function is | |
888 after its closing brace, or after the semicolon of a construct (such | |
889 as a @code{struct}) which doesn't end at the brace. These two | |
890 commands try to leave point at the beginning of a line near the actual | |
891 start or end of the function. This occasionally causes point not to | |
892 move at all. | |
893 | |
894 These functions are analogous to the Emacs built-in commands | |
895 @code{beginning-of-defun} and @code{end-of-defun}, except they | |
896 eliminate the constraint that the top-level opening brace of the defun | |
897 must be in column zero. See @ref{Defuns,,,@emacsman{}, | |
898 @emacsmantitle{}}, for more information. | |
899 | |
900 @item @kbd{C-M-a} (AWK Mode) (@code{c-awk-beginning-of-defun}) | |
901 @itemx @kbd{C-M-e} (AWK Mode) (@code{c-awk-end-of-defun}) | |
902 @kindex C-M-a (AWK Mode) | |
903 @kindex C-M-e (AWK Mode) | |
904 @findex c-awk-beginning-of-defun | |
905 @findex awk-beginning-of-defun (c-) | |
906 @findex c-awk-end-of-defun | |
907 @findex awk-end-of-defun (c-) | |
908 Move to the beginning or end of the current or next AWK defun. These | |
909 commands can take prefix-arguments, their functionality being entirely | |
910 equivalent to @code{beginning-of-defun} and @code{end-of-defun}. | |
911 | |
912 AWK Mode @dfn{defuns} are either pattern/action pairs (either of which | |
913 might be implicit) or user defined functions. Having the @samp{@{} and | |
914 @samp{@}} (if there are any) in column zero, as is suggested for some | |
915 modes, is neither necessary nor helpful in AWK mode. | |
916 | |
917 @item @kbd{M-a} (@code{c-beginning-of-statement}) | |
918 @itemx @kbd{M-e} (@code{c-end-of-statement}) | |
919 @kindex M-a | |
920 @kindex M-e | |
921 @findex c-beginning-of-statement | |
922 @findex c-end-of-statement | |
923 @findex beginning-of-statement (c-) | |
924 @findex end-of-statement (c-) | |
925 Move to the beginning or end of the innermost C statement. If point | |
926 is already there, move to the next beginning or end of a statement, | |
927 even if that means moving into a block. (Use @kbd{C-M-b} or | |
928 @kbd{C-M-f} to move over a balanced block.) A prefix argument @var{n} | |
929 means move over @var{n} statements. | |
930 | |
931 If point is within or next to a comment or a string which spans more | |
932 than one line, these commands move by sentences instead of statements. | |
933 | |
934 When called from a program, these functions take three optional | |
935 arguments: the repetition count, a buffer position limit which is the | |
936 farthest back to search for the syntactic context, and a flag saying | |
937 whether to do sentence motion in or near comments and multiline | |
938 strings. | |
939 | |
940 @item @kbd{C-c C-u} (@code{c-up-conditional}) | |
941 @kindex C-c C-u | |
942 @findex c-up-conditional | |
943 @findex up-conditional (c-) | |
944 Move back to the containing preprocessor conditional, leaving the mark | |
945 behind. A prefix argument acts as a repeat count. With a negative | |
946 argument, move forward to the end of the containing preprocessor | |
947 conditional. | |
948 | |
949 @samp{#elif} is treated like @samp{#else} followed by @samp{#if}, so the | |
950 function stops at them when going backward, but not when going | |
951 forward. | |
952 | |
953 This key sequence is not bound in AWK Mode, which doesn't have | |
954 preprocessor statements. | |
955 | |
956 @item @kbd{M-x c-up-conditional-with-else} | |
957 @findex c-up-conditional-with-else | |
958 @findex up-conditional-with-else (c-) | |
959 A variety of @code{c-up-conditional} that also stops at @samp{#else} | |
960 lines. Normally those lines are ignored. | |
961 | |
962 @item @kbd{M-x c-down-conditional} | |
963 @findex c-down-conditional | |
964 @findex down-conditional (c-) | |
965 Move forward into the next nested preprocessor conditional, leaving | |
966 the mark behind. A prefix argument acts as a repeat count. With a | |
967 negative argument, move backward into the previous nested preprocessor | |
968 conditional. | |
969 | |
970 @samp{#elif} is treated like @samp{#else} followed by @samp{#if}, so the | |
971 function stops at them when going forward, but not when going backward. | |
972 | |
973 @item @kbd{M-x c-down-conditional-with-else} | |
974 @findex c-down-conditional-with-else | |
975 @findex down-conditional-with-else (c-) | |
976 A variety of @code{c-down-conditional} that also stops at @samp{#else} | |
977 lines. Normally those lines are ignored. | |
978 | |
979 @item @kbd{C-c C-p} (@code{c-backward-conditional}) | |
980 @itemx @kbd{C-c C-n} (@code{c-forward-conditional}) | |
981 @kindex C-c C-p | |
982 @kindex C-c C-n | |
983 @findex c-backward-conditional | |
984 @findex c-forward-conditional | |
985 @findex backward-conditional (c-) | |
986 @findex forward-conditional (c-) | |
987 Move backward or forward across a preprocessor conditional, leaving | |
988 the mark behind. A prefix argument acts as a repeat count. With a | |
989 negative argument, move in the opposite direction. | |
990 | |
991 These key sequences are not bound in AWK Mode, which doesn't have | |
992 preprocessor statements. | |
993 | |
994 @item @kbd{M-x c-backward-into-nomenclature} | |
995 @itemx @kbd{M-x c-forward-into-nomenclature} | |
996 @findex c-backward-into-nomenclature | |
997 @findex c-forward-into-nomenclature | |
998 @findex backward-into-nomenclature (c-) | |
999 @findex forward-into-nomenclature (c-) | |
1000 A popular programming style, especially for object-oriented languages | |
1001 such as C++ is to write symbols in a mixed case format, where the | |
1002 first letter of each word is capitalized, and not separated by | |
1003 underscores. E.g. @samp{SymbolsWithMixedCaseAndNoUnderlines}. | |
1004 | |
1005 These commands move backward or forward to the beginning of the next | |
1006 capitalized word. With prefix argument @var{n}, move @var{n} times. | |
1007 If @var{n} is negative, move in the opposite direction. | |
1008 | |
1009 Note that these two commands have been superseded by | |
1010 @code{c-subword-mode}, which you should use instead. @xref{Subword | |
1011 Movement}. They might be removed from a future release of @ccmode{}. | |
1012 @end table | |
1013 | |
1014 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
1015 @node Filling and Breaking, Minor Modes, Movement Commands, Commands | |
1016 @comment node-name, next, previous, up | |
1017 @section Filling and Line Breaking Commands | |
1018 @cindex text filling | |
1019 @cindex line breaking | |
1020 @cindex comment handling | |
1021 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
1022 | |
1023 Since there's a lot of normal text in comments and string literals, | |
1024 @ccmode{} provides features to edit these like in text mode. The goal | |
1025 is to do it seamlessly, i.e. you can use auto fill mode, sentence and | |
1026 paragraph movement, paragraph filling, adaptive filling etc. wherever | |
1027 there's a piece of normal text without having to think much about it. | |
1028 @ccmode{} keeps the indentation, fixes suitable comment line prefixes, | |
1029 and so on. | |
1030 | |
1031 You can configure the exact way comments get filled and broken, and | |
1032 where Emacs does auto-filling (see @pxref{Custom Filling and | |
1033 Breaking}). Typically, the style system (@pxref{Styles}) will have | |
1034 set this up for you, so you probably won't have to bother. | |
1035 | |
1036 @findex auto-fill-mode | |
1037 @cindex Auto Fill mode | |
1038 @cindex paragraph filling | |
1039 Line breaks are by default handled (almost) the same regardless of | |
1040 whether they are made by auto fill mode (@pxref{Auto Fill,,, | |
1041 @emacsman{}, @emacsmantitle{}}), by paragraph filling (e.g. with | |
1042 @kbd{M-q}), or explicitly with @kbd{M-j} or similar methods. In | |
1043 string literals, the new line gets the same indentation as the | |
1044 previous nonempty line.@footnote{You can change this default by | |
1045 setting the @code{string} syntactic symbol (@pxref{Syntactic Symbols} | |
1046 and @pxref{Customizing Indentation})}. | |
1047 | |
1048 @table @asis | |
1049 @item @kbd{M-q} (@code{c-fill-paragraph}) | |
1050 @kindex M-q | |
1051 @findex c-fill-paragraph | |
1052 @findex fill-paragraph (c-) | |
1053 @cindex Javadoc markup | |
1054 @cindex Pike autodoc markup | |
1055 This command fills multiline string literals and both block | |
1056 and line style comments. In Java buffers, the Javadoc markup words | |
1057 are recognized as paragraph starters. The line oriented Pike autodoc | |
1058 markup words are recognized in the same way in Pike mode. | |
1059 | |
1060 The formatting of the starters (@code{/*}) and enders (@code{*/}) of | |
1061 block comments are kept as they were before the filling. I.e., if | |
1062 either the starter or ender were on a line of its own, then it stays | |
1063 on its own line; conversely, if the delimiter has comment text on its | |
1064 line, it keeps at least one word of that text with it on the line. | |
1065 | |
1066 This command is the replacement for @code{fill-paragraph} in @ccmode{} | |
1067 buffers. | |
1068 | |
1069 @item @kbd{M-j} (@code{c-indent-new-comment-line}) | |
1070 @kindex M-j | |
1071 @findex c-indent-new-comment-line | |
1072 @findex indent-new-comment-line (c-) | |
1073 This breaks the current line at point and indents the new line. If | |
1074 point was in a comment, the new line gets the proper comment line | |
1075 prefix. If point was inside a macro, a backslash is inserted before | |
1076 the line break. It is the replacement for | |
1077 @code{indent-new-comment-line}. | |
1078 | |
1079 @item @kbd{M-x c-context-line-break} | |
1080 @findex c-context-line-break | |
1081 @findex context-line-break (c-) | |
1082 Insert a line break suitable to the context: If the point is inside a | |
1083 comment, the new line gets the suitable indentation and comment line | |
1084 prefix like @code{c-indent-new-comment-line}. In normal code it's | |
1085 indented like @code{newline-and-indent} would do. In macros it acts | |
1086 like @code{newline-and-indent} but additionally inserts and optionally | |
1087 aligns the line ending backslash so that the macro remains unbroken. | |
1088 @xref{Custom Macros}, for details about the backslash alignment. In a | |
1089 string, a backslash is inserted only if the string is within a | |
1090 macro@footnote{In GCC, unescaped line breaks within strings are | |
1091 valid.}. | |
1092 | |
1093 This function is not bound to a key by default, but it's intended to be | |
1094 used on the @kbd{RET} key. If you like the behavior of | |
1095 @code{newline-and-indent} on @kbd{RET}, you should consider switching to | |
1096 this function. @xref{Sample .emacs File}. | |
1097 | |
1098 @item @kbd{M-x c-context-open-line} | |
1099 @findex c-context-open-line | |
1100 @findex context-open-line (c-) | |
1101 This is to @kbd{C-o} (@kbd{M-x open-line}) as | |
1102 @code{c-context-line-break} is to @kbd{RET}. I.e. it works just like | |
1103 @code{c-context-line-break} but leaves the point before the inserted | |
1104 line break. | |
1105 @end table | |
1106 | |
1107 | |
1108 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
1109 @node Minor Modes, Electric Keys, Filling and Breaking, Commands | |
1110 @comment node-name, next, previous, up | |
1111 @section Minor Modes | |
1112 @cindex Minor Modes | |
1113 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
1114 | |
1115 @ccmode{} contains several minor-mode-like features that you might | |
1116 find useful while writing new code or editing old code: | |
1117 | |
1118 @table @asis | |
1119 @item electric mode | |
1120 When this is enabled, certain visible characters cause reformatting as | |
1121 they are typed. This is normally helpful, but can be a nuisance when | |
1122 editing chaotically formatted code. It can also be disconcerting, | |
1123 especially for users who are new to @ccmode{}. | |
1124 @item auto-newline mode | |
1125 This automatically inserts newlines where you'd probably want to type | |
1126 them yourself, e.g. after typing @samp{@}}s. Its action is suppressed | |
1127 when electric mode is disabled. | |
1128 @item hungry-delete mode | |
1129 This lets you delete a contiguous block of whitespace with a single | |
1130 key - for example, the newline and indentation just inserted by | |
1131 auto-newline when you want to back up and write a comment after the | |
1132 last statement. | |
1133 @item subword mode | |
1134 This mode makes basic word movement commands like @kbd{M-f} | |
1135 (@code{forward-word}) and @kbd{M-b} (@code{backward-word}) treat the | |
1136 parts of sillycapsed symbols as different words. | |
1137 E.g. @samp{NSGraphicsContext} is treated as three words @samp{NS}, | |
1138 @samp{Graphics}, and @samp{Context}. | |
1139 @item syntactic-indentation mode | |
1140 When this is enabled (which it normally is), indentation commands such | |
1141 as @kbd{C-j} indent lines of code according to their syntactic | |
1142 structure. Otherwise, a line is simply indented to the same level as | |
1143 the previous one and @kbd{@key{TAB}} adjusts the indentation in steps | |
1144 of `c-basic-offset'. | |
1145 @end table | |
1146 | |
1147 Full details on how these minor modes work are at @ref{Electric Keys}, | |
1148 @ref{Auto-newlines}, @ref{Hungry WS Deletion}, @ref{Subword Movement}, | |
1149 and @ref{Indentation Engine Basics}. | |
1150 | |
1151 You can toggle each of these minor modes on and off, and you can | |
1152 configure @ccmode{} so that it starts up with your favourite | |
1153 combination of them (@pxref{Sample .emacs File}). By default, when | |
1154 you initialize a buffer, electric mode and syntactic-indentation mode | |
1155 are enabled but the other two modes are disabled. | |
1156 | |
1157 @ccmode{} displays the current state of the first four of these minor | |
1158 modes on the modeline by appending letters to the major mode's name, | |
1159 one letter for each enabled minor mode - @samp{l} for electric mode, | |
1160 @samp{a} for auto-newline mode, @samp{h} for hungry delete mode, and | |
1161 @samp{w} for subword mode. If all these modes were enabled, you'd see | |
1162 @samp{C/lahw}@footnote{The @samp{C} would be replaced with the name of | |
1163 the language in question for the other languages @ccmode{} supports.}. | |
1164 | |
1165 Here are the commands to toggle these modes: | |
1166 | |
1167 @table @asis | |
1168 @item @kbd{C-c C-l} (@code{c-toggle-electric-state}) | |
1169 @kindex C-c C-l | |
1170 @findex c-toggle-electric-state | |
1171 @findex toggle-electric-state (c-) | |
1172 Toggle electric minor mode. When the command turns the mode off, it | |
1173 also suppresses auto-newline mode. | |
1174 | |
1175 @item @kbd{C-c C-a} (@code{c-toggle-auto-newline}) | |
1176 @kindex C-c C-a | |
1177 @findex c-toggle-auto-newline | |
1178 @findex toggle-auto-newline (c-) | |
1179 Toggle auto-newline minor mode. When the command turns the mode on, | |
1180 it also enables electric minor mode. | |
1181 | |
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}.} | |
1183 @findex c-toggle-hungry-state | |
1184 @findex toggle-hungry-state (c-) | |
1185 Toggle hungry-delete minor mode. | |
1186 | |
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}.} | |
1188 @findex c-toggle-auto-hungry-state | |
1189 @findex toggle-auto-hungry-state (c-) | |
1190 Toggle both auto-newline and hungry delete minor modes. | |
1191 | |
1192 @item @kbd{C-c C-w} (@code{M-x c-subword-mode}) | |
1193 @kindex C-c C-w | |
1194 @findex c-subword-mode | |
1195 @findex subword-mode (c-) | |
1196 Toggle subword mode. | |
1197 | |
1198 @item @kbd{M-x c-toggle-syntactic-indentation} | |
1199 @findex c-toggle-syntactic-indentation | |
1200 @findex toggle-syntactic-indentation (c-) | |
1201 Toggle syntactic-indentation mode. | |
1202 @end table | |
1203 | |
1204 Common to all the toggle functions above is that if they are called | |
1205 programmatically, they take an optional numerical argument. A | |
1206 positive value will turn on the minor mode (or both of them in the | |
1207 case of @code{c-toggle-auto-hungry-state}) and a negative value will | |
1208 turn it (or them) off. | |
1209 | |
1210 | |
1211 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
1212 @node Electric Keys, Auto-newlines, Minor Modes, Commands | |
1213 @comment node-name, next, previous, up | |
1214 @section Electric Keys and Keywords | |
1215 @cindex electric characters | |
1216 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
1217 | |
1218 Most punctuation keys provide @dfn{electric} behavior - as well as | |
1219 inserting themselves they perform some other action, such as | |
1220 reindenting the line. This reindentation saves you from having to | |
1221 reindent a line manually after typing, say, a @samp{@}}. A few | |
1222 keywords, such as @code{else}, also trigger electric action. | |
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 | 1225 electric minor mode (@pxref{Minor Modes}). |
1226 | |
1227 Common to all these keys is that they only behave electrically when | |
1228 used in normal code (as contrasted with getting typed in a string | |
1229 literal or comment). Those which cause re-indentation do so only when | |
1230 @code{c-syntactic-indentation} has a non-@code{nil} value (which it | |
1231 does by default). | |
1232 | |
1233 These keys and keywords are: | |
1234 @c ACM, 2004/8/24: c-electric-pound doesn't check c-s-i: this is more | |
1235 @c like a bug in the code than a bug in this document. It'll get | |
1236 @c fixed in the code sometime. | |
1237 | |
1238 @table @kbd | |
1239 @item # | |
1240 @kindex # | |
1241 @findex c-electric-pound | |
1242 @findex electric-pound (c-) | |
1243 @vindex c-electric-pound-behavior | |
1244 @vindex electric-pound-behavior (c-) | |
1245 Pound (bound to @code{c-electric-pound}) is electric when typed as the | |
1246 first non-whitespace character on a line and not within a macro | |
1247 definition. In this case, the variable @code{c-electric-pound-behavior} | |
1248 is consulted for the electric behavior. This variable takes a list | |
1249 value, although the only element currently defined is @code{alignleft}, | |
1250 which tells this command to force the @samp{#} character into column | |
1251 zero. This is useful for entering preprocessor macro definitions. | |
1252 | |
1253 Pound is not electric in AWK buffers, where @samp{#} starts a comment, | |
1254 and is bound to @code{self-insert-command} like any typical printable | |
1255 character. | |
1256 @c ACM, 2004/8/24: Change this (and the code) to do AWK comment | |
1257 @c reindentation. | |
1258 | |
1259 @item * | |
1260 @kindex * | |
1261 @itemx / | |
1262 @kindex / | |
1263 @findex c-electric-star | |
1264 @findex electric-star (c-) | |
1265 @findex c-electric-slash | |
1266 @findex electric-slash (c-) | |
1267 A star (bound to @code{c-electric-star}) or a slash | |
1268 (@code{c-electric-slash}) causes reindentation when you type it as the | |
1269 second component of a C style block comment opener (@samp{/*}) or a | |
1270 C++ line comment opener (@samp{//}) respectively, but only if the | |
1271 comment opener is the first thing on the line (i.e. there's only | |
1272 whitespace before it). | |
1273 | |
1274 Additionally, you can configure @ccmode{} so that typing a slash at | |
1275 the start of a line within a block comment will terminate the | |
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 | 1278 |
1279 In AWK mode, @samp{*} and @samp{/} do not delimit comments and are not | |
1280 electric. | |
1281 | |
1282 @item < | |
1283 @kindex < | |
1284 @itemx > | |
1285 @kindex > | |
1286 @findex c-electric-lt-gt | |
1287 @findex electric-lt-gt (c-) | |
1288 A less-than or greater-than sign (bound to @code{c-electric-lt-gt}) is | |
1289 electric in two circumstances: when it is an angle bracket in a C++ | |
1290 @samp{template} declaration (and similar constructs in other | |
1291 languages) and when it is the second of two @kbd{<} or @kbd{>} | |
1292 characters in a C++ style stream operator. In either case, the line | |
1293 is reindented. Angle brackets in C @samp{#include} directives are not | |
1294 electric. | |
1295 | |
1296 @item ( | |
1297 @kindex ( | |
1298 @itemx ) | |
1299 @kindex ) | |
1300 @findex c-electric-paren | |
1301 @findex electric-paren (c-) | |
1302 The normal parenthesis characters @samp{(} and @samp{)} (bound to | |
1303 @code{c-electric-paren}) reindent the current line. This is useful | |
1304 for getting the closing parenthesis of an argument list aligned | |
1305 automatically. | |
1306 | |
1307 You can also configure @ccmode{} to insert a space automatically | |
1308 between a function name and the @samp{(} you've just typed, and to | |
1309 remove it automatically after typing @samp{)}, should the argument | |
1310 list be empty. You don't need to have electric minor mode enabled to | |
1311 get these actions. @xref{Clean-ups}. | |
1312 | |
1313 @item @{ | |
1314 @kindex @{ | |
1315 @itemx @} | |
1316 @kindex @} | |
1317 @findex c-electric-brace | |
1318 @findex electric-brace (c-) | |
1319 Typing a brace (bound to @code{c-electric-brace}) reindents the | |
1320 current line. Also, one or more newlines might be inserted if | |
1321 auto-newline minor mode is enabled. @xref{Auto-newlines}. | |
1322 Additionally, you can configure @ccmode{} to compact excess whitespace | |
1323 inserted by auto-newline mode in certain circumstances. | |
1324 @xref{Clean-ups}. | |
1325 | |
1326 @item : | |
1327 @kindex : | |
1328 @findex c-electric-colon | |
1329 @findex electric-colon (c-) | |
1330 Typing a colon (bound to @code{c-electric-colon}) reindents the | |
1331 current line. Additionally, one or more newlines might be inserted if | |
1332 auto-newline minor mode is enabled. @xref{Auto-newlines}. If you | |
1333 type a second colon immediately after such an auto-newline, by default | |
1334 the whitespace between the two colons is removed, leaving a C++ scope | |
1335 operator. @xref{Clean-ups}. | |
1336 | |
1337 If you prefer, you can insert @samp{::} in a single operation, | |
1338 avoiding all these spurious reindentations, newlines, and clean-ups. | |
1339 @xref{Other Commands}. | |
1340 | |
1341 @item ; | |
1342 @kindex ; | |
1343 @itemx , | |
1344 @kindex , | |
1345 @findex c-electric-semi&comma | |
1346 @findex electric-semi&comma (c-) | |
1347 Typing a semicolon or comma (bound to @code{c-electric-semi&comma}) | |
1348 reindents the current line. Also, a newline might be inserted if | |
1349 auto-newline minor mode is enabled. @xref{Auto-newlines}. | |
1350 Additionally, you can configure @ccmode{} so that when auto-newline | |
1351 has inserted whitespace after a @samp{@}}, it will be removed again | |
1352 when you type a semicolon or comma just after it. @xref{Clean-ups}. | |
1353 | |
1354 @end table | |
1355 | |
1356 @deffn Command c-electric-continued-statement | |
1357 @findex electric-continued-statement (c-) | |
1358 | |
1359 Certain keywords are electric, causing reindentation when they are | |
1360 preceded only by whitespace on the line. The keywords are those that | |
1361 continue an earlier statement instead of starting a new one: | |
1362 @code{else}, @code{while}, @code{catch} (only in C++ and Java) and | |
1363 @code{finally} (only in Java). | |
1364 | |
1365 An example: | |
1366 | |
1367 @example | |
1368 @group | |
1369 for (i = 0; i < 17; i++) | |
1370 if (a[i]) | |
1371 res += a[i]->offset; | |
1372 else | |
1373 @end group | |
1374 @end example | |
1375 | |
1376 Here, the @code{else} should be indented like the preceding @code{if}, | |
1377 since it continues that statement. @ccmode{} will automatically | |
1378 reindent it after the @code{else} has been typed in full, since only | |
1379 then is it possible to decide whether it's a new statement or a | |
1380 continuation of the preceding @code{if}. | |
1381 | |
1382 @vindex abbrev-mode | |
1383 @findex abbrev-mode | |
1384 @cindex Abbrev mode | |
1385 @ccmode{} uses Abbrev mode (@pxref{Abbrevs,,, @emacsman{}, @emacsmantitle{}}) | |
1386 to accomplish this. It's therefore turned on by default in all language | |
1387 modes except IDL mode, since CORBA IDL doesn't have any statements. | |
1388 @end deffn | |
1389 | |
1390 | |
1391 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
1392 @node Auto-newlines, Hungry WS Deletion, Electric Keys, Commands | |
1393 @comment node-name, next, previous, up | |
1394 @section Auto-newline Insertion | |
1395 @cindex auto-newline | |
1396 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
1397 | |
1398 When you have @dfn{Auto-newline minor mode} enabled (@pxref{Minor | |
1399 Modes}), @ccmode{} inserts newlines for you automatically (in certain | |
1400 syntactic contexts) when you type a left or right brace, a colon, a | |
1401 semicolon, or a comma. Sometimes a newline appears before the | |
1402 character you type, sometimes after it, sometimes both. | |
1403 | |
1404 Auto-newline only triggers when the following conditions hold: | |
1405 | |
1406 @itemize @bullet | |
1407 @item | |
1408 Auto-newline minor mode is enabled, as evidenced by the indicator | |
1409 @samp{a} after the mode name on the modeline (e.g. @samp{C/a} or | |
1410 @samp{C/la}). | |
1411 | |
1412 @item | |
1413 The character was typed at the end of a line, or with only whitespace | |
1414 after it, and possibly a @samp{\} escaping the newline. | |
1415 | |
1416 @item | |
1417 The character is not on its own line already. (This applies only to | |
1418 insertion of a newline @emph{before} the character.) | |
1419 | |
1420 @item | |
1421 @cindex literal | |
1422 @cindex syntactic whitespace | |
1423 The character was not typed inside of a literal @footnote{A | |
1424 @dfn{literal} is defined as any comment, string, or preprocessor macro | |
1425 definition. These constructs are also known as @dfn{syntactic | |
1426 whitespace} since they are usually ignored when scanning C code.}. | |
1427 | |
1428 @item | |
1429 No numeric argument was supplied to the command (i.e. it was typed as | |
1430 normal, with no @kbd{C-u} prefix). | |
1431 @end itemize | |
1432 | |
1433 You can configure the precise circumstances in which newlines get | |
1434 inserted (see @pxref{Custom Auto-newlines}). Typically, the style | |
1435 system (@pxref{Styles}) will have set this up for you, so you probably | |
1436 won't have to bother. | |
1437 | |
1438 Sometimes @ccmode{} inserts an auto-newline where you don't want one, | |
1439 such as after a @samp{@}} when you're about to type a @samp{;}. | |
1440 Hungry deletion can help here (@pxref{Hungry WS Deletion}), or you can | |
1441 activate an appropriate @dfn{clean-up}, which will remove the excess | |
1442 whitespace after you've typed the @samp{;}. See @ref{Clean-ups} for a | |
1443 full description. See also @ref{Electric Keys} for a summary of | |
1444 clean-ups listed by key. | |
1445 | |
1446 | |
1447 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
1448 @node Hungry WS Deletion, Subword Movement, Auto-newlines, Commands | |
1449 @comment node-name, next, previous, up | |
1450 @section Hungry Deletion of Whitespace | |
1451 @cindex hungry-deletion | |
1452 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
1453 | |
1454 If you want to delete an entire block of whitespace at point, you can | |
1455 use @dfn{hungry deletion}. This deletes all the contiguous whitespace | |
1456 either before point or after point in a single operation. | |
1457 ``Whitespace'' here includes tabs and newlines, but not comments or | |
1458 preprocessor commands. Hungry deletion can markedly cut down on the | |
1459 number of times you have to hit deletion keys when, for example, | |
1460 you've made a mistake on the preceding line and have already pressed | |
1461 @kbd{C-j}. | |
1462 | |
1463 Hungry deletion is a simple feature that some people find extremely | |
1464 useful. In fact, you might find yourself wanting it in @strong{all} | |
1465 your editing modes! | |
1466 | |
1467 Loosely speaking, in what follows, @dfn{@key{DEL}} means ``the | |
1468 backspace key'' and @dfn{@key{DELETE}} means ``the forward delete | |
1469 key''. This is discussed in more detail below. | |
1470 | |
1471 There are two different ways you can use hungry deletion: | |
1472 | |
1473 @table @asis | |
1474 @item Using @dfn{Hungry Delete Mode} with @kbd{@key{DEL}} and @kbd{C-d} | |
1475 Here you toggle Hungry Delete minor mode with @kbd{M-x | |
1476 c-toggle-hungry-state}@footnote{Prior to @ccmode{} 5.31, this command | |
1477 was bound to @kbd{C-c C-d}. @kbd{C-c C-d} is now the default binding | |
1478 for @code{c-hungry-delete-forward}.} (@pxref{Minor Modes}.) This | |
1479 makes @kbd{@key{DEL}} and @kbd{C-d} do backwards and forward hungry | |
1480 deletion. | |
1481 | |
1482 @table @asis | |
1483 @item @kbd{@key{DEL}} (@code{c-electric-backspace}) | |
1484 @kindex DEL | |
1485 @findex c-electric-backspace | |
1486 @findex electric-backspace (c-) | |
1487 This command is run by default when you hit the @kbd{DEL} key. When | |
1488 hungry delete mode is enabled, it deletes any amount of whitespace in | |
1489 the backwards direction. Otherwise, or when used with a prefix | |
1490 argument or in a literal (@pxref{Auto-newlines}), the command just | |
1491 deletes backwards in the usual way. (More precisely, it calls the | |
1492 function contained in the variable @code{c-backspace-function}, | |
1493 passing it the prefix argument, if any.) | |
1494 | |
1495 @item @code{c-backspace-function} | |
1496 @vindex c-backspace-function | |
1497 @vindex backspace-function (c-) | |
1498 @findex backward-delete-char-untabify | |
1499 Hook that gets called by @code{c-electric-backspace} when it doesn't | |
1500 do an ``electric'' deletion of the preceding whitespace. The default | |
1501 value is @code{backward-delete-char-untabify} | |
1502 (@pxref{Deletion,,,@lispref{}, @lispreftitle{}}, the function which | |
1503 deletes a single character. | |
1504 | |
1505 @item @kbd{C-d} (@code{c-electric-delete-forward}) | |
1506 @kindex C-d | |
1507 @findex c-electric-delete-forward | |
1508 @findex electric-delete-forward (c-) | |
1509 This function, which is bound to @kbd{C-d} by default, works just like | |
1510 @code{c-electric-backspace} but in the forward direction. When it | |
1511 doesn't do an ``electric'' deletion of the following whitespace, it | |
1512 just does @code{delete-char}, more or less. (Strictly speaking, it | |
1513 calls the function in @code{c-delete-function} with the prefix | |
1514 argument.) | |
1515 | |
1516 @item @code{c-delete-function} | |
1517 @vindex c-delete-function | |
1518 @vindex delete-function (c-) | |
1519 @findex delete-char | |
1520 Hook that gets called by @code{c-electric-delete-forward} when it | |
1521 doesn't do an ``electric'' deletion of the following whitespace. The | |
1522 default value is @code{delete-char}. | |
1523 @end table | |
1524 | |
1525 @item Using Distinct Bindings | |
1526 The other (newer and recommended) way to use hungry deletion is to | |
1527 perform @code{c-hungry-delete-backwards} and | |
1528 @code{c-hungry-delete-forward} directly through their key sequences | |
1529 rather than using the minor mode toggling. | |
1530 | |
1531 @table @asis | |
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}.} | |
1533 @kindex C-c C-<backspace> | |
1534 @kindex C-c <backspace> | |
1535 @kindex C-c C-DEL | |
1536 @kindex C-c DEL | |
1537 @findex c-hungry-delete-backwards | |
1538 @findex hungry-delete-backwards (c-) | |
1539 Delete any amount of whitespace in the backwards direction (regardless | |
1540 whether hungry-delete mode is enabled or not). This command is bound | |
1541 to both @kbd{C-c C-@key{DEL}} and @kbd{C-c @key{DEL}}, since the more | |
1542 natural one, @kbd{C-c C-@key{DEL}}, is sometimes difficult to type at | |
1543 a character terminal. | |
1544 | |
1545 @item @kbd{C-c C-d}, @kbd{C-c C-@key{DELETE}}, or @kbd{C-c @key{DELETE}} (@code{c-hungry-delete-forward}) | |
1546 @kindex C-c C-d | |
1547 @kindex C-c C-<DELETE> | |
1548 @kindex C-c <DELETE> | |
1549 @findex c-hungry-delete-forward | |
1550 @findex hungry-delete-forward (c-) | |
1551 Delete any amount of whitespace in the forward direction (regardless | |
1552 whether hungry-delete mode is enabled or not). This command is bound | |
1553 to both @kbd{C-c C-@key{DELETE}} and @kbd{C-c @key{DELETE}} for the | |
1554 same reason as for @key{DEL} above. | |
1555 @end table | |
1556 @end table | |
1557 | |
1558 @kindex <delete> | |
1559 @kindex <backspace> | |
1560 | |
1561 When we talk about @kbd{@key{DEL}}, and @kbd{@key{DELETE}} above, we | |
1562 actually do so without connecting them to the physical keys commonly | |
1563 known as @key{Backspace} and @key{Delete}. The default bindings to | |
1564 those two keys depends on the flavor of (X)Emacs you are using. | |
1565 | |
1566 @findex c-electric-delete | |
1567 @findex electric-delete (c-) | |
1568 @findex c-hungry-delete | |
1569 @findex hungry-delete (c-) | |
1570 @vindex delete-key-deletes-forward | |
1571 In XEmacs 20.3 and beyond, the @key{Backspace} key is bound to | |
1572 @code{c-electric-backspace} and the @key{Delete} key is bound to | |
1573 @code{c-electric-delete}. You control the direction it deletes in by | |
1574 setting the variable @code{delete-key-deletes-forward}, a standard | |
1575 XEmacs variable. | |
1576 @c This variable is encapsulated by XEmacs's (defsubst delete-forward-p ...). | |
1577 When this variable is non-@code{nil}, @code{c-electric-delete} will do | |
1578 forward deletion with @code{c-electric-delete-forward}, otherwise it | |
1579 does backward deletion with @code{c-electric-backspace}. Similarly, | |
1580 @kbd{C-c @key{Delete}} and @kbd{C-c C-@key{Delete}} are bound to | |
1581 @code{c-hungry-delete} which is controlled in the same way by | |
1582 @code{delete-key-deletes-forward}. | |
1583 | |
1584 @findex normal-erase-is-backspace-mode | |
1585 | |
1586 Emacs 21 and later automatically binds @key{Backspace} and | |
1587 @key{Delete} to @kbd{DEL} and @kbd{C-d} according to your environment, | |
1588 and @ccmode{} extends those bindings to @kbd{C-c C-@key{Backspace}} | |
1589 etc. If you need to change the bindings through | |
1590 @code{normal-erase-is-backspace-mode} then @ccmode{} will also adapt | |
1591 its extended bindings accordingly. | |
1592 | |
1593 In earlier (X)Emacs versions, @ccmode{} doesn't bind either | |
1594 @key{Backspace} or @key{Delete} directly. Only the key codes | |
1595 @kbd{DEL} and @kbd{C-d} are bound, and it's up to the default bindings | |
1596 to map the physical keys to them. You might need to modify this | |
1597 yourself if the defaults are unsuitable. | |
1598 | |
1599 Getting your @key{Backspace} and @key{Delete} keys properly set up can | |
1600 sometimes be tricky. The information in @ref{DEL Does Not | |
1601 Delete,,,emacs, GNU Emacs Manual}, might be helpful if you're having | |
1602 trouble with this in GNU Emacs. | |
1603 | |
1604 | |
1605 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
1606 @node Subword Movement, Other Commands, Hungry WS Deletion, Commands | |
1607 @comment node-name, next, previous, up | |
1608 @section Subword Movement and Editing | |
1609 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
1610 | |
1611 @cindex nomenclature | |
1612 @cindex subword | |
1613 In spite of the GNU Coding Standards, it is popular to name a symbol | |
1614 by mixing uppercase and lowercase letters, e.g. @samp{GtkWidget}, | |
1615 @samp{EmacsFrameClass}, or @samp{NSGraphicsContext}. Here we call | |
1616 these mixed case symbols @dfn{nomenclatures}. Also, each capitalized | |
1617 (or completely uppercase) part of a nomenclature is called a | |
1618 @dfn{subword}. Here are some examples: | |
1619 | |
1620 @multitable {@samp{NSGraphicsContext}} {@samp{NS}, @samp{Graphics}, and @samp{Context}} | |
1621 @c This could be converted to @headitem when we require Texinfo 4.7 | |
1622 @iftex | |
1623 @item @b{Nomenclature} | |
1624 @tab @b{Subwords} | |
1625 @end iftex | |
1626 @ifnottex | |
1627 @item Nomenclature | |
1628 @tab Subwords | |
1629 @item --------------------------------------------------------- | |
1630 @end ifnottex | |
1631 @item @samp{GtkWindow} | |
1632 @tab @samp{Gtk} and @samp{Window} | |
1633 @item @samp{EmacsFrameClass} | |
1634 @tab @samp{Emacs}, @samp{Frame}, and @samp{Class} | |
1635 @item @samp{NSGraphicsContext} | |
1636 @tab @samp{NS}, @samp{Graphics}, and @samp{Context} | |
1637 @end multitable | |
1638 | |
1639 The subword minor mode replaces the basic word oriented movement and | |
1640 editing commands with variants that recognize subwords in a | |
1641 nomenclature and treat them as separate words: | |
1642 | |
1643 @findex c-forward-subword | |
1644 @findex forward-subword (c-) | |
1645 @findex c-backward-subword | |
1646 @findex backward-subword (c-) | |
1647 @findex c-mark-subword | |
1648 @findex mark-subword (c-) | |
1649 @findex c-kill-subword | |
1650 @findex kill-subword (c-) | |
1651 @findex c-backward-kill-subword | |
1652 @findex backward-kill-subword (c-) | |
1653 @findex c-transpose-subwords | |
1654 @findex transpose-subwords (c-) | |
1655 @findex c-capitalize-subword | |
1656 @findex capitalize-subword (c-) | |
1657 @findex c-upcase-subword | |
1658 @findex upcase-subword (c-) | |
1659 @findex c-downcase-subword | |
1660 @findex downcase-subword (c-) | |
1661 @multitable @columnfractions .20 .40 .40 | |
1662 @c This could be converted to @headitem when we require Texinfo 4.7 | |
1663 @iftex | |
1664 @item @b{Key} @tab @b{Word oriented command} @tab @b{Subword oriented command} | |
1665 @end iftex | |
1666 @ifnottex | |
1667 @item Key @tab Word oriented command @tab Subword oriented command | |
1668 @item ---------------------------------------------------------------------------- | |
1669 @end ifnottex | |
1670 @item @kbd{M-f} @tab @code{forward-word} @tab @code{c-forward-subword} | |
1671 @item @kbd{M-b} @tab @code{backward-word} @tab @code{c-backward-subword} | |
1672 @item @kbd{M-@@} @tab @code{mark-word} @tab @code{c-mark-subword} | |
1673 @item @kbd{M-d} @tab @code{kill-word} @tab @code{c-kill-subword} | |
1674 @item @kbd{M-DEL} @tab @code{backward-kill-word} @tab @code{c-backward-kill-subword} | |
1675 @item @kbd{M-t} @tab @code{transpose-words} @tab @code{c-transpose-subwords} | |
1676 @item @kbd{M-c} @tab @code{capitalize-word} @tab @code{c-capitalize-subword} | |
1677 @item @kbd{M-u} @tab @code{upcase-word} @tab @code{c-upcase-subword} | |
1678 @item @kbd{M-l} @tab @code{downcase-word} @tab @code{c-downcase-subword} | |
1679 @end multitable | |
1680 | |
1681 Note that if you have changed the key bindings for the word oriented | |
1682 commands in your @file{.emacs} or a similar place, the keys you have | |
1683 configured are also used for the corresponding subword oriented | |
1684 commands. | |
1685 | |
1686 Type @kbd{C-c C-w} to toggle subword mode on and off. To make the | |
1687 mode turn on automatically, put the following code in your | |
1688 @file{.emacs}: | |
1689 | |
1690 @example | |
1691 (add-hook 'c-mode-common-hook | |
1692 (lambda () (c-subword-mode 1))) | |
1693 @end example | |
1694 | |
1695 As a bonus, you can also use @code{c-subword-mode} in non-@ccmode{} | |
1696 buffers by typing @kbd{M-x c-subword-mode}. | |
1697 | |
1698 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
1699 @node Other Commands, , Subword Movement, Commands | |
1700 @comment node-name, next, previous, up | |
1701 @section Other Commands | |
1702 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
1703 | |
1704 Here are the various other commands that didn't fit anywhere else: | |
1705 | |
1706 @table @asis | |
1707 @item @kbd{C-c .} (@code{c-set-style}) | |
1708 @kindex C-c . | |
1709 @findex c-set-style | |
1710 @findex set-style (c-) | |
1711 Switch to the specified style in the current buffer. Use like this: | |
1712 | |
1713 @example | |
1714 @kbd{C-c . @var{style-name} @key{RET}} | |
1715 @end example | |
1716 | |
1717 You can use the @key{TAB} in the normal way to do completion on the | |
1718 style name. Note that all style names are case insensitive, even the | |
1719 ones you define yourself. | |
1720 | |
1721 Setting a style in this way does @emph{not} automatically reindent your | |
1722 file. For commands that you can use to view the effect of your changes, | |
1723 see @ref{Indentation Commands} and @ref{Filling and Breaking}. | |
1724 | |
1725 For details of the @ccmode{} style system, see @ref{Styles}. | |
1726 @item @kbd{C-c :} (@code{c-scope-operator}) | |
1727 @kindex C-c : | |
1728 @findex c-scope-operator | |
1729 @findex scope-operator (c-) | |
1730 In C++, it is also sometimes desirable to insert the double-colon scope | |
1731 operator without performing the electric behavior of colon insertion. | |
1732 @kbd{C-c :} does just this. | |
1733 | |
1734 @item @kbd{C-c C-\} (@code{c-backslash-region}) | |
1735 @kindex C-c C-\ | |
1736 @findex c-backslash-region | |
1737 @findex backslash-region (c-) | |
1738 This function inserts and aligns or deletes end-of-line backslashes in | |
1739 the current region. These are typically used in multi-line macros. | |
1740 | |
1741 With no prefix argument, it inserts any missing backslashes and aligns | |
1742 them according to the @code{c-backslash-column} and | |
1743 @code{c-backslash-max-column} variables. With a prefix argument, it | |
1744 deletes any backslashes. | |
1745 | |
1746 The function does not modify blank lines at the start of the region. If | |
1747 the region ends at the start of a line, it always deletes the backslash | |
1748 (if any) at the end of the previous line. | |
1749 | |
1750 To customize the precise workings of this command, @ref{Custom Macros}. | |
1751 @end table | |
1752 | |
1753 @noindent | |
1754 The recommended line breaking function, @code{c-context-line-break} | |
1755 (@pxref{Filling and Breaking}), is especially nice if you edit | |
1756 multiline macros frequently. When used inside a macro, it | |
1757 automatically inserts and adjusts the mandatory backslash at the end | |
1758 of the line to keep the macro together, and it leaves the point at the | |
1759 right indentation column for the code. Thus you can write code inside | |
1760 macros almost exactly as you can elsewhere, without having to bother | |
1761 with the trailing backslashes. | |
1762 | |
1763 @table @asis | |
1764 @item @kbd{C-c C-e} (@code{c-macro-expand}) | |
1765 @kindex C-c C-e | |
1766 @findex c-macro-expand | |
1767 @findex macro-expand (c-) | |
1768 This command expands C, C++, Objective C or Pike macros in the region, | |
1769 using an appropriate external preprocessor program. Normally it | |
1770 displays its output in a temporary buffer, but if you give it a prefix | |
1771 arg (with @kbd{C-u C-c C-e}) it will overwrite the original region | |
1772 with the expansion. | |
1773 | |
1774 The command does not work in any of the other modes, and the key | |
1775 sequence is not bound in these other modes. | |
1776 | |
1777 @code{c-macro-expand} isn't actually part of @ccmode{}, even though it | |
1778 is bound to a @ccmode{} key sequence. If you need help setting it up | |
1779 or have other problems with it, you can either read its source code or | |
1780 ask for help in the standard (X)Emacs forums. | |
1781 @end table | |
1782 | |
1783 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
1784 @node Font Locking, Config Basics, Commands, Top | |
1785 @comment node-name, next, previous, up | |
1786 @chapter Font Locking | |
1787 @cindex font locking | |
1788 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
1789 | |
1790 @cindex Font Lock mode | |
1791 | |
1792 @ccmode{} provides font locking for its supported languages by | |
1793 supplying patterns for use with Font Lock mode. This means that you | |
1794 get distinct faces on the various syntactic parts such as comments, | |
1795 strings, keywords and types, which is very helpful in telling them | |
1796 apart at a glance and discovering syntactic errors. @xref{Font | |
1797 Lock,,, emacs, GNU Emacs Manual}, for ways to enable font locking in | |
1798 @ccmode{} buffers. | |
1799 | |
1800 @strong{Please note:} The font locking in AWK mode is currently not | |
1801 integrated with the rest of @ccmode{}. Only the last section of this | |
1802 chapter, @ref{AWK Mode Font Locking}, applies to AWK. The other | |
1803 sections apply to the other languages. | |
1804 | |
1805 @menu | |
1806 * Font Locking Preliminaries:: | |
1807 * Faces:: | |
1808 * Doc Comments:: | |
1809 * AWK Mode Font Locking:: | |
1810 @end menu | |
1811 | |
1812 | |
1813 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
1814 @node Font Locking Preliminaries, Faces, Font Locking, Font Locking | |
1815 @comment node-name, next, previous, up | |
1816 @section Font Locking Preliminaries | |
1817 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
1818 | |
1819 The font locking for most of the @ccmode{} languages were provided | |
1820 directly by the Font Lock package prior to version 5.30 of @ccmode{}. | |
1821 In the transition to @ccmode{} the patterns have been reworked | |
1822 completely and are applied uniformly across all the languages except AWK | |
1823 mode, just like the indentation rules (although each language still has | |
1824 some peculiarities of its own, of course). Since the languages | |
1825 previously had completely separate font locking patterns, this means | |
1826 that it's a bit different in most languages now. | |
1827 | |
1828 The main goal for the font locking in @ccmode{} is accuracy, to provide | |
1829 a dependable aid in recognizing the various constructs. Some, like | |
1830 strings and comments, are easy to recognize while others, like | |
1831 declarations and types, can be very tricky. @ccmode{} can go to great | |
1832 lengths to recognize declarations and casts correctly, especially when | |
1833 the types aren't recognized by standard patterns. This is a fairly | |
1834 demanding analysis which can be slow on older hardware, and it can | |
1835 therefore be disabled by choosing a lower decoration level with the | |
1836 variable @code{font-lock-maximum-decoration} (@pxref{Font Lock,,, | |
1837 emacs, GNU Emacs Manual}). | |
1838 | |
1839 @vindex font-lock-maximum-decoration | |
1840 | |
1841 The decoration levels are used as follows: | |
1842 | |
1843 @enumerate | |
1844 @comment 1 | |
1845 @item | |
1846 Minimal font locking: Fontify only comments, strings and preprocessor | |
1847 directives (in the languages that use cpp). | |
1848 | |
1849 @comment 2 | |
1850 @item | |
1851 Fast font locking: In addition to level 1, fontify keywords, simple | |
1852 types and declarations that are easy to recognize. The variables | |
1853 @code{*-font-lock-extra-types} (where @samp{*} is the name of the | |
1854 language) are used to recognize types (see below). Documentation | |
1855 comments like Javadoc are fontified according to | |
1856 @code{c-doc-comment-style} (@pxref{Doc Comments}). | |
1857 | |
1858 Use this if you think the font locking is too slow. It's the closest | |
1859 corresponding level to level 3 in the old font lock patterns. | |
1860 | |
1861 @comment 3 | |
1862 @item | |
1863 Accurate font locking: Like level 2 but uses a different approach that | |
1864 can recognize types and declarations much more accurately. The | |
1865 @code{*-font-lock-extra-types} variables are still used, but user | |
1866 defined types are recognized correctly anyway in most cases. Therefore | |
1867 those variables should be fairly restrictive and not contain patterns | |
1868 that are uncertain. | |
1869 | |
1870 @cindex Lazy Lock mode | |
1871 @cindex Just-in-time Lock mode | |
1872 | |
1873 This level is designed for fairly modern hardware and a font lock | |
1874 support mode like Lazy Lock or Just-in-time Lock mode that only | |
1875 fontifies the parts that are actually shown. Fontifying the whole | |
1876 buffer at once can easily get bothersomely slow even on contemporary | |
1877 hardware. @xref{Font Lock,,,@emacsman{}, @emacsmantitle{}}. | |
1878 @end enumerate | |
1879 | |
1880 @cindex user defined types | |
1881 @cindex types, user defined | |
1882 | |
1883 Since user defined types are hard to recognize you can provide | |
1884 additional regexps to match those you use: | |
1885 | |
1886 @defopt c-font-lock-extra-types | |
1887 @defoptx c++-font-lock-extra-types | |
1888 @defoptx objc-font-lock-extra-types | |
1889 @defoptx java-font-lock-extra-types | |
1890 @defoptx idl-font-lock-extra-types | |
1891 @defoptx pike-font-lock-extra-types | |
1892 For each language there's a variable @code{*-font-lock-extra-types}, | |
1893 where @samp{*} stands for the language in question. It contains a list | |
1894 of regexps that matches identifiers that should be recognized as types, | |
1895 e.g. @samp{\\sw+_t} to recognize all identifiers ending with @samp{_t} | |
1896 as is customary in C code. Each regexp should not match more than a | |
1897 single identifier. | |
1898 | |
1899 The default values contain regexps for many types in standard runtime | |
1900 libraries that are otherwise difficult to recognize, and patterns for | |
1901 standard type naming conventions like the @samp{_t} suffix in C and C++. | |
1902 Java, Objective-C and Pike have as a convention to start class names | |
1903 with capitals, so there are patterns for that in those languages. | |
1904 | |
1905 Despite the names of these variables, they are not only used for | |
1906 fontification but in other places as well where @ccmode{} needs to | |
1907 recognize types. | |
1908 @end defopt | |
1909 | |
1910 | |
1911 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
1912 @node Faces, Doc Comments, Font Locking Preliminaries, Font Locking | |
1913 @comment node-name, next, previous, up | |
1914 @section Faces | |
1915 @cindex faces | |
1916 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
1917 | |
1918 @ccmode{} attempts to use the standard faces for programming languages | |
1919 in accordance with their intended purposes as far as possible. No extra | |
1920 faces are currently provided, with the exception of a replacement face | |
1921 @code{c-invalid-face} for emacsen that don't provide | |
1922 @code{font-lock-warning-face}. | |
1923 | |
1924 @itemize @bullet | |
1925 @item | |
1926 @vindex font-lock-comment-face | |
1927 Normal comments are fontified in @code{font-lock-comment-face}. | |
1928 | |
1929 @item | |
1930 @vindex font-lock-doc-face | |
1931 @vindex font-lock-doc-string-face | |
1932 @vindex font-lock-comment-face | |
1933 Comments that are recognized as documentation (@pxref{Doc Comments}) | |
1934 get @code{font-lock-doc-face} (Emacs) or | |
1935 @code{font-lock-doc-string-face} (XEmacs) if those faces exist. If | |
1936 they don't then @code{font-lock-comment-face} is used. | |
1937 | |
1938 @item | |
1939 @vindex font-lock-string-face | |
1940 String and character literals are fontified in | |
1941 @code{font-lock-string-face}. | |
1942 | |
1943 @item | |
1944 @vindex font-lock-keyword-face | |
1945 Keywords are fontified with @code{font-lock-keyword-face}. | |
1946 | |
1947 @item | |
1948 @vindex font-lock-function-name-face | |
1949 @code{font-lock-function-name-face} is used for function names in | |
1950 declarations and definitions, and classes in those contexts. It's also | |
1951 used for preprocessor defines with arguments. | |
1952 | |
1953 @item | |
1954 @vindex font-lock-variable-name-face | |
1955 Variables in declarations and definitions, and other identifiers in such | |
1956 variable contexts, get @code{font-lock-variable-name-face}. It's also | |
1957 used for preprocessor defines without arguments. | |
1958 | |
1959 @item | |
1960 @vindex font-lock-constant-face | |
1961 @vindex font-lock-reference-face | |
1962 Builtin constants are fontified in @code{font-lock-constant-face} if it | |
1963 exists, @code{font-lock-reference-face} otherwise. As opposed to the | |
1964 preceding two faces, this is used on the names in expressions, and it's | |
1965 not used in declarations, even if there happen to be a @samp{const} in | |
1966 them somewhere. | |
1967 | |
1968 @item | |
1969 @vindex font-lock-type-face | |
1970 @code{font-lock-type-face} is put on types (both predefined and user | |
1971 defined) and classes in type contexts. | |
1972 | |
1973 @item | |
1974 @vindex font-lock-constant-face | |
1975 @vindex font-lock-reference-face | |
1976 Label identifiers get @code{font-lock-constant-face} if it exists, | |
1977 @code{font-lock-reference-face} otherwise. | |
1978 | |
1979 @item | |
1980 Name qualifiers and identifiers for scope constructs are fontified like | |
1981 labels. | |
1982 | |
1983 @item | |
1984 Special markup inside documentation comments are also fontified like | |
1985 labels. | |
1986 | |
1987 @item | |
1988 @vindex font-lock-preprocessor-face | |
1989 @vindex font-lock-builtin-face | |
1990 @vindex font-lock-reference-face | |
1991 Preprocessor directives get @code{font-lock-preprocessor-face} if it | |
1992 exists (i.e. XEmacs). In Emacs they get @code{font-lock-builtin-face} | |
1993 or @code{font-lock-reference-face}, for lack of a closer equivalent. | |
1994 | |
1995 @item | |
1996 @vindex font-lock-warning-face | |
1997 @vindex c-invalid-face | |
1998 @vindex invalid-face (c-) | |
1999 Some kinds of syntactic errors are fontified with | |
2000 @code{font-lock-warning-face} in Emacs. In older XEmacs versions | |
2001 there's no corresponding standard face, so there a special | |
2002 @code{c-invalid-face} is used, which is defined to stand out sharply by | |
2003 default. | |
2004 | |
2005 Note that it's not used for @samp{#error} or @samp{#warning} directives, | |
2006 since those aren't syntactic errors in themselves. | |
2007 @end itemize | |
2008 | |
2009 | |
2010 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
2011 @node Doc Comments, AWK Mode Font Locking, Faces, Font Locking | |
2012 @comment node-name, next, previous, up | |
2013 @section Documentation Comments | |
2014 @cindex documentation comments | |
2015 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
2016 | |
2017 There are various tools to supply documentation in the source as | |
2018 specially structured comments, e.g. the standard Javadoc tool in Java. | |
2019 @ccmode{} provides an extensible mechanism to fontify such comments and | |
2020 the special markup inside them. | |
2021 | |
2022 @defopt c-doc-comment-style | |
2023 @vindex doc-comment-style (c-) | |
2024 This is a style variable that specifies which documentation comment | |
2025 style to recognize, e.g. @code{javadoc} for Javadoc comments. | |
2026 | |
2027 The value may also be a list of styles, in which case all of them are | |
2028 recognized simultaneously (presumably with markup cues that don't | |
2029 conflict). | |
2030 | |
2031 The value may also be an association list to specify different comment | |
2032 styles for different languages. The symbol for the major mode is then | |
2033 looked up in the alist, and the value of that element is interpreted as | |
2034 above if found. If it isn't found then the symbol `other' is looked up | |
2035 and its value is used instead. | |
2036 | |
2037 The default value for @code{c-doc-comment-style} is | |
2038 @w{@code{((java-mode . javadoc) (pike-mode . autodoc) (c-mode . gtkdoc))}}. | |
2039 | |
2040 Note that @ccmode{} uses this variable to set other variables that | |
2041 handle fontification etc. That's done at mode initialization or when | |
2042 you switch to a style which sets this variable. Thus, if you change it | |
2043 in some other way, e.g. interactively in a CC Mode buffer, you will need | |
2044 to do @kbd{M-x java-mode} (or whatever mode you're currently using) to | |
2045 reinitialize. | |
2046 | |
2047 @findex c-setup-doc-comment-style | |
2048 @findex setup-doc-comment-style (c-) | |
2049 Note also that when @ccmode{} starts up, the other variables are | |
2050 modified before the mode hooks are run. If you change this variable in | |
2051 a mode hook, you'll have to call @code{c-setup-doc-comment-style} | |
2052 afterwards to redo that work. | |
2053 @end defopt | |
2054 | |
2055 @ccmode{} currently provides handing of the following doc comment | |
2056 styles: | |
2057 | |
2058 @table @code | |
2059 @item javadoc | |
2060 @cindex Javadoc markup | |
2061 Javadoc comments, the standard tool in Java. | |
2062 | |
2063 @item autodoc | |
2064 @cindex Pike autodoc markup | |
2065 For Pike autodoc markup, the standard in Pike. | |
2066 | |
2067 @item gtkdoc | |
2068 @cindex GtkDoc markup | |
2069 For GtkDoc markup, widely used in the Gnome community. | |
2070 @end table | |
2071 | |
2072 The above is by no means complete. If you'd like to see support for | |
2073 other doc comment styles, please let us know (@pxref{Mailing Lists and | |
2074 Bug Reports}). | |
2075 | |
2076 You can also write your own doc comment fontification support to use | |
2077 with @code{c-doc-comment-style}: Supply a variable or function | |
2078 @code{*-font-lock-keywords} where @samp{*} is the name you want to use | |
2079 in @code{c-doc-comment-style}. If it's a variable, it's prepended to | |
2080 @code{font-lock-keywords}. If it's a function, it's called at mode | |
2081 initialization and the result is prepended. For an example, see | |
2082 @code{javadoc-font-lock-keywords} in @file{cc-fonts.el}. | |
2083 | |
2084 If you add support for another doc comment style, please consider | |
2085 contributing it - send a note to @email{bug-cc-mode@@gnu.org}. | |
2086 | |
2087 | |
2088 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
2089 @node AWK Mode Font Locking, , Doc Comments, Font Locking | |
2090 @comment node-name, next, previous, up | |
2091 @section AWK Mode Font Locking | |
2092 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
2093 | |
2094 The general appearance of font-locking in AWK mode is much like in any | |
2095 other programming mode. @xref{Faces For Font Lock,,,elisp, GNU Emacs | |
2096 Lisp Reference Manual}. | |
2097 | |
2098 The following faces are, however, used in a non-standard fashion in | |
2099 AWK mode: | |
2100 | |
2101 @table @asis | |
2102 @item @code{font-lock-variable-name-face} | |
2103 This face was intended for variable declarations. Since variables are | |
2104 not declared in AWK, this face is used instead for AWK system | |
2105 variables (such as @code{NF}) and ``Special File Names'' (such as | |
2106 @code{"/dev/stderr"}). | |
2107 | |
2108 @item @code{font-lock-builtin-face} (Emacs)/@code{font-lock-preprocessor-face} (XEmacs) | |
2109 This face is normally used for preprocessor directives in @ccmode{}. | |
2110 There are no such things in AWK, so this face is used instead for | |
2111 standard functions (such as @code{match}). | |
2112 | |
2113 @item @code{font-lock-string-face} | |
2114 As well as being used for strings, including localizable strings, | |
2115 (delimited by @samp{"} and @samp{_"}), this face is also used for AWK | |
2116 regular expressions (delimited by @samp{/}). | |
2117 | |
2118 @item @code{font-lock-warning-face} (Emacs)/@code{c-invalid-face} (XEmacs) | |
2119 This face highlights the following syntactically invalid AWK | |
2120 constructs: | |
2121 | |
2122 @itemize @bullet | |
2123 @item | |
2124 An unterminated string or regular expression. Here the opening | |
2125 delimiter (@samp{"} or @samp{/} or @samp{_"}) is displayed in | |
2126 @code{font-lock-warning-face}. This is most noticeable when typing in a | |
2127 new string/regular expression into a buffer, when the warning-face | |
2128 serves as a continual reminder to terminate the construct. | |
2129 | |
2130 AWK mode fontifies unterminated strings/regular expressions | |
2131 differently from other modes: Only the text up to the end of the line | |
2132 is fontified as a string (escaped newlines being handled correctly), | |
2133 rather than the text up to the next string quote. | |
2134 | |
2135 @item | |
2136 A space between the function name and opening parenthesis when calling | |
2137 a user function. The last character of the function name and the | |
2138 opening parenthesis are highlighted. This font-locking rule will | |
2139 spuriously highlight a valid concatenation expression where an | |
2140 identifier precedes a parenthesised expression. Unfortunately. | |
2141 | |
2142 @item | |
2143 Whitespace following the @samp{\} in what otherwise looks like an | |
2144 escaped newline. The @samp{\} is highlighted. | |
2145 @end itemize | |
2146 @end table | |
2147 | |
2148 | |
2149 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
2150 @node Config Basics, Custom Filling and Breaking, Font Locking, Top | |
2151 @comment node-name, next, previous, up | |
2152 @chapter Configuration Basics | |
2153 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
2154 | |
2155 @cindex Emacs Initialization File | |
2156 @cindex Configuration | |
2157 You configure @ccmode{} by setting Lisp variables and calling (and | |
2158 perhaps writing) Lisp functions@footnote{DON'T PANIC!!! This isn't | |
2159 difficult.}, which is usually done by adding code to an Emacs | |
2160 initialization file. This file might be @file{site-start.el} or | |
2161 @file{.emacs} or @file{init.el} or @file{default.el} or perhaps some | |
2162 other file. @xref{Init File,,,@emacsman{}, @emacsmantitle{}}. For | |
2163 the sake of conciseness, we just call this file ``your @file{.emacs}'' | |
2164 throughout the rest of the manual. | |
2165 | |
2166 Several of these variables (currently 16), are known collectively as | |
2167 @dfn{style variables}. @ccmode{} provides a special mechanism, known | |
2168 as @dfn{styles} to make it easier to set these variables as a group, | |
2169 to ``inherit'' settings from one style into another, and so on. Style | |
2170 variables remain ordinary Lisp variables, whose values can be read and | |
2171 changed independently of the style system. @xref{Style Variables}. | |
2172 | |
2173 There are several ways you can write the code, depending on the | |
2174 precise effect you want---they are described further down on this page. | |
2175 If you are new to @ccmode{}, we suggest you begin with the simplest | |
2176 method, ``Top-level commands or the customization interface''. | |
2177 | |
2178 If you make conflicting settings in several of these ways, the way | |
2179 that takes precedence is the one that appears latest in this list: | |
2180 @itemize @asis | |
2181 @item | |
2182 @table @asis | |
2183 @item Style | |
2184 @itemx Top-level command or ``customization interface'' | |
2185 @itemx Hook | |
2186 @itemx File Style | |
2187 @end table | |
2188 @end itemize | |
2189 | |
2190 Here is a summary of the different ways of writing your configuration | |
2191 settings: | |
2192 | |
2193 @table @asis | |
2194 @item Top-level commands or the ``customization interface'' | |
2195 Most simply, you can write @code{setq} and similar commands at the top | |
2196 level of your @file{.emacs} file. When you load a @ccmode{} buffer, | |
2197 it initializes its configuration from these global values (at least, | |
2198 for those settings you have given values to), so it makes sense to | |
2199 have these @code{setq} commands run @emph{before} @ccmode{} is first | |
2200 initialized---in particular, before any call to @code{desktop-read} | |
2201 (@pxref{Saving Emacs Sessions,,, emacs, GNU Emacs Manual}). For | |
2202 example, you might set c-basic-offset thus: | |
2203 | |
2204 @example | |
2205 (setq c-basic-offset 4) | |
2206 @end example | |
2207 | |
2208 You can use the more user friendly Customization interface instead, | |
2209 but this manual does not cover in detail how that works. To do this, | |
2210 start by typing @kbd{M-x customize-group @key{RET} c @key{RET}}. | |
2211 @xref{Easy Customization,,,@emacsman{}, @emacsmantitle{}}. | |
2212 @c The following note really belongs in the Emacs manual. | |
2213 Emacs normally writes the customizations at the end of your | |
2214 @file{.emacs} file. If you use @code{desktop-read}, you should edit | |
2215 your @file{.emacs} to place the call to @code{desktop-read} @emph{after} | |
2216 the customizations. | |
2217 | |
2218 The first initialization of @ccmode{} puts a snapshot of the | |
2219 configuration settings into the special style @code{user}. | |
2220 @xref{Built-in Styles}. | |
2221 | |
2222 For basic use of Emacs, either of these ways of configuring is | |
2223 adequate. However, the settings are then the same in all @ccmode{} | |
2224 buffers and it can be clumsy to communicate them between programmers. | |
2225 For more flexibility, you'll want to use one (or both) of @ccmode{}'s | |
2226 more sophisticated facilities, hooks and styles. | |
2227 | |
2228 @item Hooks | |
2229 An Emacs @dfn{hook} is a place to put Lisp functions that you want | |
2230 Emacs to execute later in specific circumstances. | |
2231 @xref{Hooks,,,@lispref{}, @lispreftitle{}}. @ccmode{} supplies a main | |
2232 hook and a language-specific hook for each language it supports - any | |
2233 functions you put onto these hooks get executed as the last part of a | |
2234 buffer's initialization. Typically you put most of your customization | |
2235 within the main hook, and use the language-specific hooks to vary the | |
2236 customization settings between language modes. For example, if you | |
2237 wanted different (non-standard) values of @code{c-basic-offset} in C | |
2238 Mode and Java Mode buffers, you could do it like this: | |
2239 | |
2240 @example | |
2241 @group | |
2242 (defun my-c-mode-hook () | |
2243 (setq c-basic-offset 3)) | |
2244 (add-hook 'c-mode-hook 'my-c-mode-hook) | |
2245 | |
2246 (defun my-java-mode-hook () | |
2247 (setq c-basic-offset 6)) | |
2248 (add-hook 'java-mode-hook 'my-java-mode-hook) | |
2249 @end group | |
2250 @end example | |
2251 | |
2252 See @ref{CC Hooks} for more details on the use of @ccmode{} hooks. | |
2253 | |
2254 @item Styles | |
2255 A @ccmode{} @dfn{style} is a coherent collection of customizations | |
2256 with a name. At any time, exactly one style is active in each | |
2257 @ccmode{} buffer, either the one you have selected or a default. | |
2258 @ccmode{} is delivered with several existing styles. Additionally, | |
2259 you can create your own styles, possibly based on these existing | |
2260 styles. If you worked in a programming team called the ``Free | |
2261 Group'', which had its own coding standards, you might well have this | |
2262 in your @file{.emacs} file: | |
2263 | |
2264 @example | |
2265 (setq c-default-style '((java-mode . "java") | |
2266 (awk-mode . "awk") | |
2267 (other . "free-group-style"))) | |
2268 @end example | |
2269 | |
2270 See @ref{Styles} for fuller details on using @ccmode{} styles and how | |
2271 to create them. | |
2272 | |
2273 @item File Styles | |
2274 A @dfn{file style} is a rarely used variant of the ``style'' mechanism | |
2275 described above, which applies to an individual source file. To use | |
2276 it, you set certain Emacs local variables in a special block at the | |
2277 end of the source file. @xref{File Styles}. | |
2278 | |
2279 @item Hooks with Styles | |
2280 For ultimate flexibility, you can use hooks and styles together. For | |
2281 example, if your team were developing a product which required a | |
2282 Linux driver, you'd probably want to use the ``linux'' style for the | |
2283 driver, and your own team's style for the rest of the code. You | |
2284 could achieve this with code like this in your @file{.emacs}: | |
2285 | |
2286 @example | |
2287 @group | |
2288 (defun my-c-mode-hook () | |
2289 (c-set-style | |
2290 (if (and (buffer-file-name) | |
2291 (string-match "/usr/src/linux" (buffer-file-name))) | |
2292 "linux" | |
2293 "free-group-style"))) | |
2294 (add-hook 'c-mode-hook 'my-c-mode-hook) | |
2295 @end group | |
2296 @end example | |
2297 | |
2298 In a programming team, a hook is a also a good place for each member | |
2299 to put his own personal preferences. For example, you might be the | |
2300 only person in your team who likes Auto-newline minor mode. You could | |
2301 have it enabled by default by placing the following in your | |
2302 @file{.emacs}: | |
2303 | |
2304 @example | |
2305 @group | |
2306 (defun my-turn-on-auto-newline () | |
2307 (c-toggle-auto-newline 1)) | |
2308 (add-hook 'c-mode-common-hook 'my-turn-on-auto-newline) | |
2309 @end group | |
2310 @end example | |
2311 @end table | |
2312 | |
2313 @menu | |
2314 * CC Hooks:: | |
2315 * Style Variables:: | |
2316 * Styles:: | |
2317 @end menu | |
2318 | |
2319 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
2320 @node CC Hooks, Style Variables, Config Basics, Config Basics | |
2321 @comment node-name, next, previous, up | |
2322 @section Hooks | |
2323 @cindex mode hooks | |
2324 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
2325 @c The node name is "CC Hooks" rather than "Hooks" because of a bug in | |
2326 @c some older versions of Info, e.g. the info.el in GNU Emacs 21.3. | |
2327 @c If you go to "Config Basics" and hit <CR> on the xref to "CC | |
2328 @c Hooks" the function Info-follow-reference searches for "*Note: CC | |
2329 @c Hooks" from the beginning of the page. If this node were instead | |
2330 @c named "Hooks", that search would spuriously find "*Note: | |
2331 @c Hooks(elisp)" and go to the wrong node. | |
2332 | |
2333 @ccmode{} provides several hooks that you can use to customize the | |
2334 mode for your coding style. The main hook is | |
2335 @code{c-mode-common-hook}; typically, you'll put the bulk of your | |
2336 customizations here. In addition, each language mode has its own | |
2337 hook, allowing you to fine tune your settings individually for the | |
2338 different @ccmode{} languages, and there is a package initialization | |
2339 hook. Finally, there is @code{c-special-indent-hook}, which enables | |
2340 you to solve anomalous indentation problems. It is described in | |
2341 @ref{Other Indentation}, not here. All these hooks adhere to the | |
2342 standard Emacs conventions. | |
2343 | |
2344 When you open a buffer, @ccmode{} first initializes it with the | |
2345 currently active style (@pxref{Styles}). Then it calls | |
2346 @code{c-mode-common-hook}, and finally it calls the language-specific | |
2347 hook. Thus, any style settings done in these hooks will override | |
2348 those set by @code{c-default-style}. | |
2349 | |
2350 @defvar c-initialization-hook | |
2351 @vindex initialization-hook (c-) | |
2352 Hook run only once per Emacs session, when @ccmode{} is initialized. | |
2353 This is a good place to change key bindings (or add new ones) in any | |
2354 of the @ccmode{} key maps. @xref{Sample .emacs File}. | |
2355 @end defvar | |
2356 | |
2357 @defvar c-mode-common-hook | |
2358 @vindex mode-common-hook (c-) | |
2359 Common hook across all languages. It's run immediately before the | |
2360 language specific hook. | |
2361 @end defvar | |
2362 | |
2363 @defvar c-mode-hook | |
2364 @defvarx c++-mode-hook | |
2365 @defvarx objc-mode-hook | |
2366 @defvarx java-mode-hook | |
2367 @defvarx idl-mode-hook | |
2368 @defvarx pike-mode-hook | |
2369 @defvarx awk-mode-hook | |
2370 The language specific mode hooks. The appropriate one is run as the | |
2371 last thing when you enter that language mode. | |
2372 @end defvar | |
2373 | |
2374 Although these hooks are variables defined in @ccmode{}, you can give | |
2375 them values before @ccmode{}'s code is loaded---indeed, this is the | |
2376 only way to use @code{c-initialization-hook}. Their values aren't | |
2377 overwritten when @ccmode{} gets loaded. | |
2378 | |
2379 Here's a simplified example of what you can add to your @file{.emacs} | |
2380 file to do things whenever any @ccmode{} language is edited. See the | |
2381 Emacs manuals for more information on customizing Emacs via hooks. | |
2382 @xref{Sample .emacs File}, for a more complete sample @file{.emacs} | |
2383 file. | |
2384 | |
2385 @example | |
2386 (defun my-c-mode-common-hook () | |
2387 ;; my customizations for all of c-mode and related modes | |
2388 (no-case-fold-search) | |
2389 ) | |
2390 (add-hook 'c-mode-common-hook 'my-c-mode-common-hook) | |
2391 @end example | |
2392 | |
2393 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
2394 @node Style Variables, Styles, CC Hooks, Config Basics | |
2395 @comment node-name, next, previous, up | |
2396 @section Style Variables | |
2397 @cindex styles | |
2398 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
2399 | |
2400 @cindex style variables | |
2401 The variables that @ccmode{}'s style system control are called | |
2402 @dfn{style variables}. Note that style variables are ordinary Lisp | |
2403 variables, which the style system initializes; you can change their | |
2404 values at any time (e.g. in a hook function). The style system can | |
2405 also set other variables, to some extent. @xref{Styles}. | |
2406 | |
2407 @dfn{Style variables} are handled specially in several ways: | |
2408 | |
2409 @itemize @bullet | |
2410 @item | |
2411 Style variables are by default buffer-local variables. However, they | |
2412 can instead be made global by setting | |
2413 @code{c-style-variables-are-local-p} to @code{nil} before @ccmode{} is | |
2414 initialized. | |
2415 | |
2416 @item | |
2417 @vindex c-old-style-variable-behavior | |
2418 @vindex old-style-variable-behavior (c-) | |
2419 The default global binding of any style variable (with two exceptions | |
2420 - see below) is the special symbol @code{set-from-style}. When the | |
2421 style system initializes a buffer-local copy of a style variable for a | |
2422 @ccmode{} buffer, if its global binding is still that symbol then it | |
2423 will be set from the current style. Otherwise it will retain its | |
2424 global default@footnote{This is a big change from versions of | |
2425 @ccmode{} earlier than 5.26, where such settings would get overridden | |
2426 by the style system unless special precautions were taken. That was | |
2427 changed since it was counterintuitive and confusing, especially to | |
2428 novice users. If your configuration depends on the old overriding | |
2429 behavior, you can set the variable | |
2430 @code{c-old-style-variable-behavior} to non-@code{nil}.}. This | |
2431 ``otherwise'' happens, for example, when you've set the variable with | |
2432 @code{setq} at the top level of your @file{.emacs} (@pxref{Config | |
2433 Basics}). | |
2434 | |
2435 @item | |
2436 The style variable @code{c-offsets-alist} (@pxref{c-offsets-alist}) is | |
2437 an association list with an element for each syntactic symbol. It's | |
2438 handled a little differently from the other style variables. It's | |
2439 default global binding is the empty list @code{nil}, rather than | |
2440 @code{set-from-style}. Before the style system is initialized, you | |
2441 can add individual elements to @code{c-offsets-alist} by calling | |
2442 @code{c-set-offset}(@pxref{c-offsets-alist}) just like you would set | |
2443 other style variables with @code{setq}. Those elements will then | |
2444 prevail when the style system later initializes a buffer-local copy of | |
2445 @code{c-offsets-alist}. | |
2446 | |
2447 @item | |
2448 The style variable @code{c-special-indent-hook} is also handled in a | |
2449 special way. Styles can only add functions to this hook, not remove | |
2450 them, so any global settings you put on it are always | |
2451 preserved@footnote{This did not change in version 5.26.}. The value | |
2452 you give this variable in a style definition can be either a function | |
2453 or a list of functions. | |
2454 | |
2455 @item | |
2456 The global bindings of the style variables get captured in the special | |
2457 @code{user} style when the style system is first initialized. | |
2458 @xref{Built-in Styles}, for details. | |
2459 @end itemize | |
2460 | |
2461 The style variables are:@* | |
2462 @code{c-indent-comment-alist}, | |
2463 @code{c-indent-comments-syntactically-p} (@pxref{Indentation | |
2464 Commands});@* | |
2465 @code{c-doc-comment-style} (@pxref{Doc Comments});@* | |
2466 @code{c-block-comment-prefix}, @code{c-comment-prefix-regexp} | |
2467 (@pxref{Custom Filling and Breaking});@* | |
2468 @code{c-hanging-braces-alist} (@pxref{Hanging Braces});@* | |
2469 @code{c-hanging-colons-alist} (@pxref{Hanging Colons});@* | |
2470 @code{c-hanging-semi&comma-criteria} (@pxref{Hanging Semicolons and | |
2471 Commas});@* | |
2472 @code{c-cleanup-list} (@pxref{Clean-ups});@* | |
2473 @code{c-basic-offset} (@pxref{Customizing Indentation});@* | |
2474 @code{c-offsets-alist} (@pxref{c-offsets-alist});@* | |
2475 @code{c-comment-only-line-offset} (@pxref{Comment Line-Up});@* | |
2476 @code{c-special-indent-hook}, @code{c-label-minimum-indentation} | |
2477 (@pxref{Other Indentation});@* | |
2478 @code{c-backslash-column}, @code{c-backslash-max-column} | |
2479 (@pxref{Custom Macros}). | |
2480 | |
2481 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
2482 @node Styles, , Style Variables, Config Basics | |
2483 @comment node-name, next, previous, up | |
2484 @section Styles | |
2485 @cindex styles | |
2486 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
2487 | |
2488 By @dfn{style} we mean the layout of the code---things like how many | |
2489 columns to indent a block of code, whether an opening brace gets | |
2490 indented to the level of the code it encloses, or of the construct | |
2491 that introduces it, or ``hangs'' at the end of a line. | |
2492 | |
2493 Most people only need to edit code formatted in just a few well-defined | |
2494 and consistent styles. For example, their organization might impose a | |
2495 ``blessed'' style that all its programmers must conform to. Similarly, | |
2496 people who work on GNU software will have to use the GNU coding style. | |
2497 Some shops are more lenient, allowing a variety of coding styles, and as | |
2498 programmers come and go, there could be a number of styles in use. For | |
2499 this reason, @ccmode{} makes it convenient for you to set up logical | |
2500 groupings of customizations called @dfn{styles}, associate a single name | |
2501 for any particular style, and pretty easily start editing new or | |
2502 existing code using these styles. | |
2503 | |
2504 @menu | |
2505 * Built-in Styles:: | |
2506 * Choosing a Style:: | |
2507 * Adding Styles:: | |
2508 * File Styles:: | |
2509 @end menu | |
2510 | |
2511 | |
2512 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
2513 @node Built-in Styles, Choosing a Style, Styles, Styles | |
2514 @comment node-name, next, previous, up | |
2515 @subsection Built-in Styles | |
2516 @cindex styles, built-in | |
2517 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
2518 | |
2519 If you're lucky, one of @ccmode{}'s built-in styles might be just | |
2520 what you're looking for. These are: | |
2521 | |
2522 @table @code | |
2523 @item gnu | |
2524 @cindex GNU style | |
2525 Coding style blessed by the Free Software Foundation | |
2526 for C code in GNU programs. | |
2527 | |
2528 @item k&r | |
2529 @cindex K&R style | |
2530 The classic Kernighan and Ritchie style for C code. | |
2531 | |
2532 @item bsd | |
2533 @cindex BSD style | |
2534 Also known as ``Allman style'' after Eric Allman. | |
2535 | |
2536 @item whitesmith | |
2537 @cindex Whitesmith style | |
2538 Popularized by the examples that came with Whitesmiths C, an early | |
2539 commercial C compiler. | |
2540 | |
2541 @item stroustrup | |
2542 @cindex Stroustrup style | |
2543 The classic Stroustrup style for C++ code. | |
2544 | |
2545 @item ellemtel | |
2546 @cindex Ellemtel style | |
2547 Popular C++ coding standards as defined by ``Programming in C++, Rules | |
2548 and Recommendations,'' Erik Nyquist and Mats Henricson, | |
2549 Ellemtel@footnote{This document is available at | |
2550 @uref{http://www.doc.ic.ac.uk/lab/cplus/c++.rules/} among other | |
2551 places.}. | |
2552 @c N.B. This URL was still valid at 2005/8/28 (ACM). | |
2553 | |
2554 @item linux | |
2555 @cindex Linux style | |
2556 C coding standard for Linux (the kernel). | |
2557 | |
2558 @item python | |
2559 @cindex Python style | |
2560 C coding standard for Python extension modules@footnote{Python is a | |
2561 high level scripting language with a C/C++ foreign function interface. | |
2562 For more information, see @uref{http://www.python.org/}.}. | |
2563 | |
2564 @item java | |
2565 @cindex Java style | |
2566 The style for editing Java code. Note that the default | |
2567 value for @code{c-default-style} installs this style when you enter | |
2568 @code{java-mode}. | |
2569 | |
2570 @item awk | |
2571 @cindex AWK style | |
2572 The style for editing AWK code. Note that the default value for | |
2573 @code{c-default-style} installs this style when you enter | |
2574 @code{awk-mode}. | |
2575 | |
2576 @item user | |
2577 @cindex User style | |
2578 This is a special style created by you. It consists of the factory | |
2579 defaults for all the style variables as modified by the customizations | |
2580 you do either with the Customization interface or by writing | |
2581 @code{setq}s and @code{c-set-offset}s at the top level of your | |
2582 @file{.emacs} file (@pxref{Config Basics}). The style system creates | |
2583 this style as part of its initialization and doesn't modify it | |
2584 afterwards. | |
2585 @end table | |
2586 | |
2587 | |
2588 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
2589 @node Choosing a Style, Adding Styles, Built-in Styles, Styles | |
2590 @comment node-name, next, previous, up | |
2591 @subsection Choosing a Style | |
2592 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
2593 | |
2594 When you create a new buffer, its style will be set from | |
2595 @code{c-default-style}. The factory default is the style @code{gnu}, | |
2596 except in Java and AWK modes where it's @code{java} and @code{awk}. | |
2597 | |
2598 Remember that if you set a style variable with the Customization | |
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 | 2601 override the one that the style system would have given the variable. |
2602 | |
2603 To set a buffer's style interactively, use the command @kbd{C-c .} | |
2604 (@pxref{Other Commands}). To set it from a file's local variable | |
2605 list, @ref{File Styles}. | |
2606 | |
2607 @defopt c-default-style | |
2608 @vindex default-style (c-) | |
2609 This variable specifies which style to install by default in new | |
2610 buffers. It takes either a style name string, or an association list | |
2611 of major mode symbols to style names: | |
2612 | |
2613 @enumerate | |
2614 @item | |
2615 When @code{c-default-style} is a string, it must be an existing style | |
2616 name. This style is then used for all modes. | |
2617 | |
2618 @item | |
2619 When @code{c-default-style} is an association list, the mode language | |
2620 is looked up to find a style name string. | |
2621 | |
2622 @item | |
2623 If @code{c-default-style} is an association list where the mode | |
2624 language mode isn't found then the special symbol @samp{other} is | |
2625 looked up. If it's found then the associated style is used. | |
2626 | |
2627 @item | |
2628 If @samp{other} is not found then the @samp{gnu} style is used. | |
2629 @end enumerate | |
2630 | |
2631 In all cases, the style described in @code{c-default-style} is installed | |
2632 @emph{before} the language hooks are run, so you can always override | |
2633 this setting by including an explicit call to @code{c-set-style} in your | |
2634 language mode hook, or in @code{c-mode-common-hook}. | |
2635 | |
2636 The standard value of @code{c-default-style} is @w{@code{((java-mode | |
2637 . "java") (awk-mode . "awk") (other . "gnu"))}}. | |
2638 @end defopt | |
2639 | |
2640 @defvar c-indentation-style | |
2641 @vindex indentation-style (c-) | |
2642 This variable always contains the buffer's current style name, as a | |
2643 string. | |
2644 @end defvar | |
2645 | |
2646 | |
2647 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
2648 @node Adding Styles, File Styles, Choosing a Style, Styles | |
2649 @comment node-name, next, previous, up | |
2650 @subsection Adding and Amending Styles | |
2651 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
2652 | |
2653 If none of the built-in styles is appropriate, you'll probably want to | |
2654 create a new @dfn{style definition}, possibly based on an existing | |
2655 style. To do this, put the new style's settings into a list with the | |
2656 following format - the list can then be passed as an argument to the | |
2657 function @code{c-add-style}. You can see an example of a style | |
2658 definition in @ref{Sample .emacs File}. | |
2659 | |
2660 @cindex style definition | |
2661 @c @defvr {List} style definition | |
2662 @table @asis | |
2663 @item Structure of a Style Definition List | |
2664 ([@var{base-style}] [(@var{variable} . @var{value}) @dots{}]) | |
2665 | |
2666 Optional @var{base-style}, if present, must be a string which is the | |
2667 name of the @dfn{base style} from which this style inherits. At most | |
2668 one @var{base-style} is allowed in a style definition. If | |
2669 @var{base-style} is not specified, the style inherits from the table | |
2670 of factory default values@footnote{This table is stored internally in | |
2671 the variable c-fallback-style.} instead. All styles eventually | |
2672 inherit from this internal table. Style loops generate errors. The | |
2673 list of pre-existing styles can be seen in @ref{Built-in Styles}. | |
2674 | |
2675 The dotted pairs (@var{variable} . @var{value}) each consist of a | |
2676 variable and the value it is to be set to when the style is later | |
2677 activated.@footnote{Note that if the variable has been given a value | |
2678 by the Customization interface or a @code{setq} at the top level of | |
2679 your @file{.emacs}, this value will override the one the style system | |
2680 tries to give it. @xref{Config Basics}.} The variable can be either a | |
2681 @ccmode{} style variable or an arbitrary Emacs variable. In the | |
2682 latter case, it is @emph{not} made buffer-local by the @ccmode{} style | |
2683 system. | |
2684 @c @end defvr | |
2685 | |
2686 Two variables are treated specially in the dotted pair list: | |
2687 | |
2688 @table @code | |
2689 @item c-offsets-alist | |
2690 The value is in turn a list of dotted pairs of the form | |
2691 | |
2692 @example | |
2693 (@r{@var{syntactic-symbol}} . @r{@var{offset}}) | |
2694 @end example | |
2695 | |
2696 as described in @ref{c-offsets-alist}. These are passed to | |
2697 @code{c-set-offset} so there is no need to set every syntactic symbol | |
2698 in your style, only those that are different from the inherited style. | |
2699 | |
2700 @item c-special-indent-hook | |
2701 The value is added to @code{c-special-indent-hook} using | |
2702 @code{add-hook}, so any functions already on it are kept. If the value | |
2703 is a list, each element of the list is added with @code{add-hook}. | |
2704 @end table | |
2705 @end table | |
2706 | |
2707 Styles are kept in the @code{c-style-alist} variable, but you | |
2708 should never modify this variable directly. Instead, @ccmode{} | |
2709 provides the function @code{c-add-style} for this purpose. | |
2710 | |
2711 @defun c-add-style stylename description &optional set-p | |
2712 @findex add-style (c-) | |
2713 Add or update a style called @var{stylename}, a string. | |
2714 @var{description} is the new style definition in the form described | |
2715 above. If @var{stylename} already exists in @code{c-style-alist} then | |
2716 it is replaced by @var{description}. (Note, this replacement is | |
2717 total. The old style is @emph{not} merged into the new one.) | |
2718 Otherwise, a new style is added. | |
2719 | |
2720 If the optional @var{set-p} is non-@code{nil} then the new style is | |
2721 applied to the current buffer as well. The use of this facility is | |
2722 deprecated and it might be removed from @ccmode{} in a future release. | |
2723 You should use @code{c-set-style} instead. | |
2724 | |
2725 The sample @file{.emacs} file provides a concrete example of how a new | |
2726 style can be added and automatically set. @xref{Sample .emacs File}. | |
2727 @end defun | |
2728 | |
2729 @defvar c-style-alist | |
2730 @vindex style-alist (c-) | |
2731 This is the variable that holds the definitions for the styles. It | |
2732 should not be changed directly; use @code{c-add-style} instead. | |
2733 @end defvar | |
2734 | |
2735 | |
2736 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
2737 @node File Styles, , Adding Styles, Styles | |
2738 @comment node-name, next, previous, up | |
2739 @subsection File Styles | |
2740 @cindex styles, file local | |
2741 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
2742 | |
2743 @cindex file local variables | |
2744 | |
2745 The Emacs manual describes how you can customize certain variables on a | |
2746 per-file basis by including a @dfn{file local variable} block at the end | |
2747 of the file (@pxref{File Variables,, Local Variables in Files, @emacsman{}, | |
2748 @emacsmantitle{}}). | |
2749 | |
2750 So far, you've only seen a functional interface for setting styles in | |
2751 @ccmode{}, and this can't be used here. @ccmode{} fills the gap by | |
2752 providing two variables for use in a file's local variable list. | |
2753 Don't use them anywhere else! These allow you to customize the style | |
2754 on a per-file basis: | |
2755 | |
2756 @defvar c-file-style | |
2757 @vindex file-style (c-) | |
2758 Set this variable to a style name string in the Local Variables list. | |
2759 From now on, when you visit the file, @ccmode{} will automatically set | |
2760 the file's style to this one using @code{c-set-style}. | |
2761 @end defvar | |
2762 | |
2763 @defvar c-file-offsets | |
2764 @vindex file-offsets (c-) | |
2765 Set this variable (in the Local Variables list) to an association list | |
2766 of the same format as @code{c-offsets-alist}. From now on, when you | |
2767 visit the file, @ccmode{} will automatically institute these offsets | |
2768 using @code{c-set-offset}. | |
2769 @end defvar | |
2770 | |
2771 Note that file style settings (i.e. @code{c-file-style}) are applied | |
2772 before file offset settings | |
2773 (i.e. @code{c-file-offsets})@footnote{Also, if either of these are set | |
2774 in a file's local variable section, all the style variable values are | |
2775 made local to that buffer, even if | |
2776 @code{c-style-variables-are-local-p} is @code{nil}. Since this | |
2777 variable is virtually always non-@code{nil} anyhow, you're unlikely to | |
2778 notice this effect.}. | |
2779 | |
2780 If you set any variables, including style variables, by the file local | |
2781 variables mechanism, these settings take priority over all other | |
2782 settings, even those in your mode hooks (@pxref{CC Hooks}). If you | |
2783 use @code{c-file-style} or @code{c-file-offsets} and also explicitly | |
2784 set a style variable in a local variable block, the explicit setting | |
2785 will take priority. | |
2786 | |
2787 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
2788 @node Custom Filling and Breaking, Custom Auto-newlines, Config Basics, Top | |
2789 @comment node-name, next, previous, up | |
2790 @chapter Customizing Filling and Line Breaking | |
2791 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
2792 | |
2793 Since there's a lot of normal text in comments and string literals, | |
2794 @ccmode{} provides features to edit these like in text mode. It does | |
2795 this by hooking in on the different line breaking functions and tuning | |
2796 relevant variables as necessary. | |
2797 | |
2798 @vindex c-comment-prefix-regexp | |
2799 @vindex comment-prefix-regexp (c-) | |
2800 @cindex comment line prefix | |
2801 @vindex comment-start | |
2802 @vindex comment-end | |
2803 @vindex comment-start-skip | |
2804 @vindex paragraph-start | |
2805 @vindex paragraph-separate | |
2806 @vindex paragraph-ignore-fill-prefix | |
2807 @vindex adaptive-fill-mode | |
2808 @vindex adaptive-fill-regexp | |
2809 @vindex adaptive-fill-first-line-regexp | |
2810 To make Emacs recognize comments and treat text in them as normal | |
2811 paragraphs, @ccmode{} makes several standard | |
2812 variables@footnote{@code{comment-start}, @code{comment-end}, | |
2813 @code{comment-start-skip}, @code{paragraph-start}, | |
2814 @code{paragraph-separate}, @code{paragraph-ignore-fill-prefix}, | |
2815 @code{adaptive-fill-mode}, @code{adaptive-fill-regexp}, and | |
2816 @code{adaptive-fill-first-line-regexp}.} buffer-local and modifies them | |
2817 according to the language syntax and the comment line prefix. | |
2818 | |
2819 @defopt c-comment-prefix-regexp | |
2820 @vindex comment-prefix-regexp (c-) | |
2821 This style variable contains the regexp used to recognize the | |
2822 @dfn{comment line prefix}, which is the line decoration that starts | |
2823 every line in a comment. The variable is either the comment line | |
2824 prefix itself, or (more usually) an association list with different | |
2825 values for different languages. The symbol for the major mode is | |
2826 looked up in the alist to get the regexp for the language, and if it | |
2827 isn't found then the special symbol @samp{other} is looked up instead. | |
2828 | |
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 | 2831 of the new line. The default value of c-comment-prefix-regexp is |
2832 @samp{//+\\|\\**}, which matches C++ style line comments like | |
2833 | |
2834 @example | |
2835 // blah blah | |
2836 @end example | |
2837 | |
2838 @noindent | |
2839 with two or more slashes in front of them, and the second and | |
2840 subsequent lines of C style block comments like | |
2841 | |
2842 @example | |
2843 @group | |
2844 /* | |
2845 * blah blah | |
2846 */ | |
2847 @end group | |
2848 @end example | |
2849 | |
2850 @noindent | |
2851 with zero or more stars at the beginning of every line. If you change | |
2852 this variable, please make sure it still matches the comment starter | |
2853 (i.e. @code{//}) of line comments @emph{and} the line prefix inside | |
2854 block comments. | |
2855 | |
2856 @findex c-setup-paragraph-variables | |
2857 @findex setup-paragraph-variables (c-) | |
2858 Also note that since @ccmode{} uses the value of | |
2859 @code{c-comment-prefix-regexp} to set up several other variables at | |
2860 mode initialization, there won't be any effect if you just change it | |
2861 inside a @ccmode{} buffer. You need to call the command | |
2862 @code{c-setup-paragraph-variables} too, to update those other | |
2863 variables. That's also the case if you modify | |
2864 @code{c-comment-prefix-regexp} in a mode hook, since @ccmode{} will | |
2865 already have set up these variables before calling the hook. | |
2866 @end defopt | |
2867 | |
2868 In comments, @ccmode{} uses @code{c-comment-prefix-regexp} to adapt | |
2869 the line prefix from the other lines in the comment. | |
2870 | |
2871 @vindex adaptive-fill-mode | |
2872 @cindex Adaptive Fill mode | |
2873 @ccmode{} uses adaptive fill mode (@pxref{Adaptive Fill,,, emacs, GNU | |
2874 Emacs Manual}) to make Emacs correctly keep the line prefix when | |
2875 filling paragraphs. That also makes Emacs preserve the text | |
2876 indentation @emph{inside} the comment line prefix. E.g. in the | |
2877 following comment, both paragraphs will be filled with the left | |
2878 margins of the texts kept intact: | |
2879 | |
2880 @example | |
2881 @group | |
2882 /* Make a balanced b-tree of the nodes in the incoming | |
2883 * stream. But, to quote the famous words of Donald E. | |
2884 * Knuth, | |
2885 * | |
2886 * Beware of bugs in the above code; I have only | |
2887 * proved it correct, not tried it. | |
2888 */ | |
2889 @end group | |
2890 @end example | |
2891 | |
2892 @findex c-setup-filladapt | |
2893 @findex setup-filladapt (c-) | |
2894 @findex filladapt-mode | |
2895 @vindex filladapt-mode | |
2896 @cindex Filladapt mode | |
2897 It's also possible to use other adaptive filling packages, notably Kyle | |
2898 E. Jones' Filladapt package@footnote{It's available from | |
2899 @uref{http://www.wonderworks.com/}. As of version 2.12, it does however | |
2900 lack a feature that makes it work suboptimally when | |
2901 @code{c-comment-prefix-regexp} matches the empty string (which it does | |
2902 by default). A patch for that is available from | |
2903 @uref{http://cc-mode.sourceforge.net/,, the CC Mode web site}.}, | |
2904 @c 2005/11/22: The above is still believed to be the case. | |
2905 which handles things like bulleted lists nicely. There's a convenience | |
2906 function @code{c-setup-filladapt} that tunes the relevant variables in | |
2907 Filladapt for use in @ccmode{}. Call it from a mode hook, e.g. with | |
2908 something like this in your @file{.emacs}: | |
2909 | |
2910 @example | |
2911 (defun my-c-mode-common-hook () | |
2912 (c-setup-filladapt) | |
2913 (filladapt-mode 1)) | |
2914 (add-hook 'c-mode-common-hook 'my-c-mode-common-hook) | |
2915 @end example | |
2916 | |
2917 @defopt c-block-comment-prefix | |
2918 @vindex block-comment-prefix (c-) | |
2919 @vindex c-comment-continuation-stars | |
2920 @vindex comment-continuation-stars (c-) | |
2921 Normally the comment line prefix inserted for a new line inside a | |
2922 comment is deduced from other lines in it. However there's one | |
2923 situation when there's no hint about what the prefix should look like, | |
2924 namely when a block comment is broken for the first time. This style | |
2925 variable@footnote{In versions before 5.26, this variable was called | |
2926 @code{c-comment-continuation-stars}. As a compatibility measure, | |
2927 @ccmode{} still uses the value on that variable if it's set.} is used | |
2928 then as the comment prefix. It defaults to @samp{* | |
2929 }@footnote{Actually, this default setting of | |
2930 @code{c-block-comment-prefix} typically gets overridden by the default | |
2931 style @code{gnu}, which sets it to blank. You can see the line | |
2932 splitting effect described here by setting a different style, | |
2933 e.g. @code{k&r} @xref{Choosing a Style}.}, which makes a comment | |
2934 | |
2935 @example | |
2936 /* Got O(n^2) here, which is a Bad Thing. */ | |
2937 @end example | |
2938 | |
2939 @noindent | |
2940 break into | |
2941 | |
2942 @example | |
2943 @group | |
2944 /* Got O(n^2) here, which | |
2945 * is a Bad Thing. */ | |
2946 @end group | |
2947 @end example | |
2948 | |
2949 Note that it won't work to adjust the indentation by putting leading | |
2950 spaces in @code{c-block-comment-prefix}, since @ccmode{} still uses the | |
2951 normal indentation engine to indent the line. Thus, the right way to | |
2952 fix the indentation is by customizing the @code{c} syntactic symbol. It | |
2953 defaults to @code{c-lineup-C-comments}, which handles the indentation of | |
2954 most common comment styles, see @ref{Line-Up Functions}. | |
2955 @end defopt | |
2956 | |
2957 @defopt c-ignore-auto-fill | |
2958 @vindex ignore-auto-fill (c-) | |
2959 When auto fill mode is enabled, @ccmode{} can selectively ignore it | |
2960 depending on the context the line break would occur in, e.g. to never | |
2961 break a line automatically inside a string literal. This variable | |
2962 takes a list of symbols for the different contexts where auto-filling | |
2963 never should occur: | |
2964 | |
2965 @table @code | |
2966 @item string | |
2967 Inside a string or character literal. | |
2968 @item c | |
2969 Inside a C style block comment. | |
2970 @item c++ | |
2971 Inside a C++ style line comment. | |
2972 @item cpp | |
2973 Inside a preprocessor directive. | |
2974 @item code | |
2975 Anywhere else, i.e. in normal code. | |
2976 @end table | |
2977 | |
2978 By default, @code{c-ignore-auto-fill} is set to @code{(string cpp | |
2979 code)}, which means that when auto-fill mode is activated, | |
2980 auto-filling only occurs in comments. In literals, it's often | |
2981 desirable to have explicit control over newlines. In preprocessor | |
2982 directives, the necessary @samp{\} escape character before the newline | |
2983 is not automatically inserted, so an automatic line break would | |
2984 produce invalid code. In normal code, line breaks are normally | |
2985 dictated by some logical structure in the code rather than the last | |
2986 whitespace character, so automatic line breaks there will produce poor | |
2987 results in the current implementation. | |
2988 @end defopt | |
2989 | |
2990 @vindex comment-multi-line | |
2991 If inside a comment and @code{comment-multi-line} (@pxref{Auto Fill,,, | |
2992 @emacsman{}, @emacsmantitle{}} is non-@code{nil}, the indentation and | |
2993 line prefix are preserved. If inside a comment and | |
2994 @code{comment-multi-line} is @code{nil}, a new comment of the same | |
2995 type is started on the next line and indented as appropriate for | |
2996 comments. | |
2997 | |
2998 Note that @ccmode{} sets @code{comment-multi-line} to @code{t} at | |
2999 startup. The reason is that @kbd{M-j} could otherwise produce sequences | |
3000 of single line block comments for texts that should logically be treated | |
3001 as one comment, and the rest of the paragraph handling code | |
3002 (e.g. @kbd{M-q} and @kbd{M-a}) can't cope with that, which would lead to | |
3003 inconsistent behavior. | |
3004 | |
3005 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
3006 @node Custom Auto-newlines, Clean-ups, Custom Filling and Breaking, Top | |
3007 @comment node-name, next, previous, up | |
3008 @chapter Customizing Auto-newlines | |
3009 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
3010 | |
3011 @ccmode{} determines whether to insert auto-newlines in two basically | |
3012 different ways, depending on the character just typed: | |
3013 | |
3014 @table @asis | |
3015 @item Braces and Colons | |
3016 @ccmode{} first determines the syntactic context of the brace or colon | |
3017 (@pxref{Syntactic Symbols}), then looks for a corresponding element in | |
3018 an alist. This element specifies where to put newlines - this is any | |
3019 combination of before and after the brace or colon. If no alist | |
3020 element is found, newlines are inserted both before and after a brace, | |
3021 but none are inserted around a colon. See @ref{Hanging Braces} and | |
3022 @ref{Hanging Colons}. | |
3023 | |
3024 @item Semicolons and Commas | |
3025 The variable @code{c-hanging-semi&comma-criteria} contains a list of | |
3026 functions which determine whether to insert a newline after a newly | |
3027 typed semicolon or comma. @xref{Hanging Semicolons and Commas}. | |
3028 @end table | |
3029 | |
3030 The names of these configuration variables contain @samp{hanging} | |
3031 because they let you @dfn{hang} the pertinent characters. A character | |
3032 which introduces a C construct is said to @dfn{hang on the right} when | |
3033 it appears at the end of a line after other code, being separated by a | |
3034 line break from the construct it introduces, like the opening brace in: | |
3035 | |
3036 @example | |
3037 @group | |
3038 while (i < MAX) @{ | |
3039 total += entry[i]; | |
3040 entry [i++] = 0; | |
3041 @} | |
3042 @end group | |
3043 @end example | |
3044 | |
3045 @noindent | |
3046 A character @dfn{hangs on the left} when it appears at the start of | |
3047 the line after the construct it closes off, like the above closing | |
3048 brace. | |
3049 | |
3050 The next chapter, ``Clean-ups'', describes how to configure @ccmode{} | |
3051 to remove these automatically added newlines in certain specific | |
3052 circumstances. @xref{Clean-ups}. | |
3053 | |
3054 @menu | |
3055 * Hanging Braces:: | |
3056 * Hanging Colons:: | |
3057 * Hanging Semicolons and Commas:: | |
3058 @end menu | |
3059 | |
3060 | |
3061 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
3062 @node Hanging Braces, Hanging Colons, Custom Auto-newlines, Custom Auto-newlines | |
3063 @comment node-name, next, previous, up | |
3064 @section Hanging Braces | |
3065 @cindex hanging braces | |
3066 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
3067 | |
3068 To specify which kinds of braces you want auto-newlines put around, | |
3069 you set the style variable @code{c-hanging-braces-alist}. Its | |
3070 structure and semantics are described in this section. Details of how | |
3071 to set it up, and its relationship to CC Mode's style system are given | |
3072 in @ref{Style Variables}. | |
3073 | |
3074 Say you wanted an auto-newline after (but not before) the following | |
3075 @samp{@{}: | |
3076 | |
3077 @example | |
3078 if (foo < 17) @{ | |
3079 @end example | |
3080 | |
3081 @noindent | |
3082 First you need to find the @dfn{syntactic context} of the brace---type | |
3083 a @key{RET} before the brace to get it on a line of its | |
3084 own@footnote{Also insert a @samp{\} at the end of the previous line if | |
3085 you're in AWK Mode.}, then type @kbd{C-c C-s}. That will tell you | |
3086 something like: | |
3087 | |
3088 @example | |
3089 ((substatement-open 1061)) | |
3090 @end example | |
3091 | |
3092 @noindent | |
3093 So here you need to put the entry @code{(substatement-open . (after))} | |
3094 into @code{c-hanging-braces-alist}. | |
3095 | |
3096 If you don't want any auto-newlines for a particular syntactic symbol, | |
3097 put this into @code{c-hanging-braces-alist}: | |
3098 | |
3099 @example | |
3100 (brace-entry-open) | |
3101 @end example | |
3102 | |
3103 If some brace syntactic symbol is not in @code{c-hanging-brace-alist}, | |
3104 its entry is taken by default as @code{(before after)}---insert a | |
3105 newline both before and after the brace. In place of a | |
3106 ``before/after'' list you can specify a function in this alist---this | |
3107 is useful when the auto newlines depend on the code around the brace. | |
3108 | |
3109 @defopt c-hanging-braces-alist | |
3110 @vindex hanging-braces-alist (c-) | |
3111 | |
3112 This variable is an association list which maps syntactic symbols to | |
3113 lists of places to insert a newline. @xref{Association | |
3114 Lists,,,@lispref{}, @lispreftitle{}}. The key of each element is the | |
3115 syntactic symbol, the associated value is either @code{nil}, a list, | |
3116 or a function. | |
3117 | |
3118 @table @asis | |
3119 @item The Key - the syntactic symbol | |
3120 The syntactic symbols that are useful as keys in this list are | |
3121 @code{brace-list-intro}, @code{statement-cont}, | |
3122 @code{inexpr-class-open}, @code{inexpr-class-close}, and all the | |
3123 @code{*-open} and @code{*-close} symbols. @xref{Syntactic Symbols}, | |
3124 for a more detailed description of these syntactic symbols, except for | |
3125 @code{inexpr-class-open} and @code{inexpr-class-close}, which aren't | |
3126 actual syntactic symbols. Elements with any other value as a key get | |
3127 ignored. | |
3128 | |
3129 The braces of anonymous inner classes in Java are given the special | |
3130 symbols @code{inexpr-class-open} and @code{inexpr-class-close}, so that | |
3131 they can be distinguished from the braces of normal classes@footnote{The | |
3132 braces of anonymous classes produce a combination of | |
3133 @code{inexpr-class}, and @code{class-open} or @code{class-close} in | |
3134 normal indentation analysis.}. | |
3135 | |
3136 Note that the aggregate constructs in Pike mode, @samp{(@{}, @samp{@})}, | |
3137 @samp{([}, @samp{])}, and @samp{(<}, @samp{>)}, do not count as brace | |
3138 lists in this regard, even though they do for normal indentation | |
3139 purposes. It's currently not possible to set automatic newlines on | |
3140 these constructs. | |
3141 | |
3142 @item The associated value - the ``ACTION'' list or function | |
3143 The value associated with each syntactic symbol in this association | |
3144 list is called an @var{action}, which can be either a list or a | |
3145 function which returns a list. @xref{Custom Braces}, for how to use | |
3146 a function as a brace hanging @var{action}. | |
3147 | |
3148 The list @var{action} (or the list returned by @var{action} when it's | |
3149 a function) contains some combination of the symbols @code{before} and | |
3150 @code{after}, directing @ccmode{} where to put newlines in | |
3151 relationship to the brace being inserted. Thus, if the list contains | |
3152 only the symbol @code{after}, then the brace hangs on the right side | |
3153 of the line, as in: | |
3154 | |
3155 @example | |
3156 // here, open braces always `hang' | |
3157 void spam( int i ) @{ | |
3158 if( i == 7 ) @{ | |
3159 dosomething(i); | |
3160 @} | |
3161 @} | |
3162 @end example | |
3163 | |
3164 When the list contains both @code{after} and @code{before}, the braces | |
3165 will appear on a line by themselves, as shown by the close braces in | |
3166 the above example. The list can also be empty, in which case newlines | |
3167 are added neither before nor after the brace. | |
3168 @end table | |
3169 | |
3170 If a syntactic symbol is missing entirely from | |
3171 @code{c-hanging-braces-alist}, it's treated in the same way as an | |
3172 @var{action} with a list containing @code{before} and @code{after}, so | |
3173 that braces by default end up on their own line. | |
3174 | |
3175 For example, the default value of @code{c-hanging-braces-alist} is: | |
3176 | |
3177 @example | |
3178 ((brace-list-open) | |
3179 (brace-entry-open) | |
3180 (statement-cont) | |
3181 (substatement-open after) | |
3182 (block-close . c-snug-do-while) | |
3183 (extern-lang-open after) | |
3184 (namespace-open after) | |
3185 (module-open after) | |
3186 (composition-open after) | |
3187 (inexpr-class-open after) | |
3188 (inexpr-class-close before)) | |
3189 @end example | |
3190 | |
3191 @noindent which says that @code{brace-list-open}, | |
3192 @code{brace-entry-open} and @code{statement-cont}@footnote{Brace lists | |
3193 inside statements, such as initializers for static array variables | |
3194 inside functions in C, are recognized as @code{statement-cont}. All | |
3195 normal substatement blocks are recognized with other symbols.} braces | |
3196 should both hang on the right side and allow subsequent text to follow | |
3197 on the same line as the brace. Also, @code{substatement-open}, | |
3198 @code{extern-lang-open}, and @code{inexpr-class-open} braces should hang | |
3199 on the right side, but subsequent text should follow on the next line. | |
3200 The opposite holds for @code{inexpr-class-close} braces; they won't | |
3201 hang, but the following text continues on the same line. Here, in the | |
3202 @code{block-close} entry, you also see an example of using a function as | |
3203 an @var{action}. In all other cases, braces are put on a line by | |
3204 themselves. | |
3205 @end defopt | |
3206 | |
3207 @menu | |
3208 * Custom Braces:: | |
3209 @end menu | |
3210 | |
3211 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
3212 @node Custom Braces, , Hanging Braces, Hanging Braces | |
3213 @comment node-name, next, previous, up | |
3214 @subsection Custom Brace Hanging | |
3215 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
3216 | |
3217 @vindex c-hanging-braces-alist | |
3218 @vindex hanging-braces-alist (c-) | |
3219 @cindex action functions | |
3220 Syntactic symbols aren't the only place where you can customize | |
3221 @ccmode{} with the lisp equivalent of callback functions. Remember | |
3222 that @var{action}s are usually a list containing some combination of | |
3223 the symbols @code{before} and @code{after} (@pxref{Hanging Braces}). | |
3224 For more flexibility, you can instead specify brace ``hanginess'' by | |
3225 giving a syntactic symbol an @dfn{action function} in | |
3226 @code{c-hanging-braces-alist}; this function determines the | |
3227 ``hanginess'' of a brace, usually by looking at the code near it. | |
3228 | |
3229 @cindex customization, brace hanging | |
3230 An action function is called with two arguments: the syntactic symbol | |
3231 for the brace (e.g. @code{substatement-open}), and the buffer position | |
3232 where the brace has been inserted. Point is undefined on entry to an | |
3233 action function, but the function must preserve it (e.g. by using | |
3234 @code{save-excursion}). The return value should be a list containing | |
3235 some combination of @code{before} and @code{after}, including neither | |
3236 of them (i.e. @code{nil}). | |
3237 | |
3238 @defvar c-syntactic-context | |
3239 @vindex syntactic-context (c-) | |
3240 During the call to the indentation or brace hanging @var{action} | |
3241 function, this variable is bound to the full syntactic analysis list. | |
3242 This might be, for example, @samp{((block-close 73))}. Don't ever | |
3243 give @code{c-syntactic-context} a value yourself---this would disrupt | |
3244 the proper functioning of @ccmode{}. | |
3245 | |
3246 This variable is also bound in three other circumstances: | |
3247 (i)@w{ }when calling a c-hanging-semi&comma-criteria function | |
3248 (@pxref{Hanging Semicolons and Commas}); (ii)@w{ }when calling a | |
3249 line-up function (@pxref{Custom Line-Up}); (iii)@w{ }when calling a | |
3250 c-special-indent-hook function (@pxref{Other Indentation}). | |
3251 @end defvar | |
3252 | |
3253 As an example, @ccmode{} itself uses this feature to dynamically | |
3254 determine the hanginess of braces which close ``do-while'' | |
3255 constructs: | |
3256 | |
3257 @example | |
3258 void do_list( int count, char** atleast_one_string ) | |
3259 @{ | |
3260 int i=0; | |
3261 do @{ | |
3262 handle_string( atleast_one_string[i] ); | |
3263 i++; | |
3264 @} while( i < count ); | |
3265 @} | |
3266 @end example | |
3267 | |
3268 @ccmode{} assigns the @code{block-close} syntactic symbol to the | |
3269 brace that closes the @code{do} construct, and normally we'd like the | |
3270 line that follows a @code{block-close} brace to begin on a separate | |
3271 line. However, with ``do-while'' constructs, we want the | |
3272 @code{while} clause to follow the closing brace. To do this, we | |
3273 associate the @code{block-close} symbol with the @var{action} function | |
3274 @code{c-snug-do-while}: | |
3275 | |
3276 @example | |
3277 (defun c-snug-do-while (syntax pos) | |
3278 "Dynamically calculate brace hanginess for do-while statements." | |
3279 (save-excursion | |
3280 (let (langelem) | |
3281 (if (and (eq syntax 'block-close) | |
3282 (setq langelem (assq 'block-close c-syntactic-context)) | |
3283 (progn (goto-char (cdr langelem)) | |
3284 (if (= (following-char) ?@{) | |
3285 (forward-sexp -1)) | |
3286 (looking-at "\\<do\\>[^_]"))) | |
3287 '(before) | |
3288 '(before after))))) | |
3289 @end example | |
3290 | |
3291 @findex c-snug-do-while | |
3292 @findex snug-do-while (c-) | |
3293 This function simply looks to see if the brace closes a ``do-while'' | |
3294 clause and if so, returns the list @samp{(before)} indicating | |
3295 that a newline should be inserted before the brace, but not after it. | |
3296 In all other cases, it returns the list @samp{(before after)} so | |
3297 that the brace appears on a line by itself. | |
3298 | |
3299 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
3300 @node Hanging Colons, Hanging Semicolons and Commas, Hanging Braces, Custom Auto-newlines | |
3301 @comment node-name, next, previous, up | |
3302 @section Hanging Colons | |
3303 @cindex hanging colons | |
3304 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
3305 | |
3306 @cindex customization, colon hanging | |
3307 @vindex c-hanging-colons-alist | |
3308 @vindex hanging-colons-alist (c-) | |
3309 | |
3310 Using a mechanism similar to brace hanging (@pxref{Hanging Braces}), | |
3311 colons can also be made to hang using the style variable | |
3312 @code{c-hanging-colons-alist} - When a colon is typed, @ccmode | |
3313 determines its syntactic context, looks this up in the alist | |
3314 @code{c-changing-colons-alist} and inserts up to two newlines | |
3315 accordingly. Here, however, If @ccmode fails to find an entry for a | |
3316 syntactic symbol in the alist, no newlines are inserted around the | |
3317 newly typed colon. | |
3318 | |
3319 @defopt c-hanging-colons-alist | |
3320 @vindex hanging-colons-alist (c-) | |
3321 | |
3322 @table @asis | |
3323 @item The Key - the syntactic symbol | |
3324 The syntactic symbols appropriate as keys in this association list | |
3325 are: @code{case-label}, @code{label}, @code{access-label}, | |
3326 @code{member-init-intro}, and @code{inher-intro}. @xref{Syntactic | |
3327 Symbols}. Elements with any other value as a key get ignored. | |
3328 | |
3329 @item The associate value - the ``ACTION'' list | |
3330 The @var{action} here is simply a list containing a combination of the | |
3331 symbols @code{before} and @code{after}. Unlike in | |
3332 @code{c-hanging-braces-alist}, functions as @var{actions} are not | |
3333 supported - there doesn't seem to be any need for them. | |
3334 @end table | |
3335 @end defopt | |
3336 | |
3337 In C++, double-colons are used as a scope operator but because these | |
3338 colons always appear right next to each other, newlines before and after | |
3339 them are controlled by a different mechanism, called @dfn{clean-ups} in | |
3340 @ccmode{}. @xref{Clean-ups}, for details. | |
3341 | |
3342 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
3343 @node Hanging Semicolons and Commas, , Hanging Colons, Custom Auto-newlines | |
3344 @comment node-name, next, previous, up | |
3345 @section Hanging Semicolons and Commas | |
3346 @cindex hanging semicolons | |
3347 @cindex hanging commas | |
3348 @cindex customization, semicolon newlines | |
3349 @cindex customization, comma newlines | |
3350 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
3351 | |
3352 @defopt c-hanging-semi&comma-criteria | |
3353 @vindex hanging-semi&comma-criteria (c-) | |
3354 This style variable takes a list of functions; these get called when | |
3355 you type a semicolon or comma. The functions are called in order | |
3356 without arguments. When these functions are entered, point is just | |
3357 after the newly inserted @samp{;} or @samp{,} and they must preserve | |
3358 point (e.g., by using @code{save-excursion}). During the call, the | |
3359 variable @code{c-syntactic-context} is bound to the syntactic context | |
3360 of the current line@footnote{This was first introduced in @ccmode{} | |
3361 5.31.} @pxref{Custom Braces}. These functions don't insert newlines | |
3362 themselves, rather they direct @ccmode{} whether or not to do so. | |
3363 They should return one of the following values: | |
3364 | |
3365 @table @code | |
3366 @item t | |
3367 A newline is to be inserted after the @samp{;} or @samp{,}, and no | |
3368 more functions from the list are to be called. | |
3369 @item stop | |
3370 No more functions from the list are to be called, and no newline is to | |
3371 be inserted. | |
3372 @item nil | |
3373 No determination has been made, and the next function in the list is | |
3374 to be called. | |
3375 @end table | |
3376 | |
3377 Note that auto-newlines are never inserted @emph{before} a semicolon | |
3378 or comma. If every function in the list is called without a | |
3379 determination being made, then no newline is added. | |
3380 | |
3381 In AWK mode, this variable is set by default to @code{nil}. In the | |
3382 other modes, the default value is a list containing a single function, | |
3383 @code{c-semi&comma-inside-parenlist}. This inserts newlines after all | |
3384 semicolons, apart from those separating @code{for}-clause statements. | |
3385 @end defopt | |
3386 | |
3387 @defun c-semi&comma-no-newlines-before-nonblanks | |
3388 @findex semi&comma-no-newlines-before-nonblanks (c-) | |
3389 This is an example of a criteria function, provided by @ccmode{}. It | |
3390 prevents newlines from being inserted after semicolons when there is a | |
3391 non-blank following line. Otherwise, it makes no determination. To | |
3392 use, add this function to the front of the | |
3393 @code{c-hanging-semi&comma-criteria} list. | |
3394 | |
3395 @example | |
3396 (defun c-semi&comma-no-newlines-before-nonblanks () | |
3397 (save-excursion | |
3398 (if (and (eq last-command-char ?\;) | |
3399 (zerop (forward-line 1)) | |
3400 (not (looking-at "^[ \t]*$"))) | |
3401 'stop | |
3402 nil))) | |
3403 @end example | |
3404 @end defun | |
3405 | |
3406 @defun c-semi&comma-inside-parenlist | |
3407 @findex semi&comma-inside-parenlist (c-) | |
3408 @defunx c-semi&comma-no-newlines-for-oneline-inliners | |
3409 @findex semi&comma-no-newlines-for-oneline-inliners (c-) | |
3410 The function @code{c-semi&comma-inside-parenlist} is what prevents | |
3411 newlines from being inserted inside the parenthesis list of @code{for} | |
3412 statements. In addition to | |
3413 @code{c-semi&comma-no-newlines-before-nonblanks} described above, | |
3414 @ccmode{} also comes with the criteria function | |
3415 @code{c-semi&comma-no-newlines-for-oneline-inliners}, which suppresses | |
3416 newlines after semicolons inside one-line inline method definitions | |
3417 (e.g. in C++ or Java). | |
3418 @end defun | |
3419 | |
3420 | |
3421 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
3422 @node Clean-ups, Indentation Engine Basics, Custom Auto-newlines, Top | |
3423 @comment node-name, next, previous, up | |
3424 @chapter Clean-ups | |
3425 @cindex clean-ups | |
3426 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
3427 | |
3428 @dfn{Clean-ups} are mechanisms which remove (or exceptionally, add) | |
3429 whitespace in specific circumstances and are complementary to colon | |
3430 and brace hanging. You enable a clean-up by adding its symbol into | |
3431 @code{c-cleanup-list}, e.g. like this: | |
3432 | |
3433 @example | |
3434 (add-to-list 'c-cleanup-list 'space-before-funcall) | |
3435 @end example | |
3436 | |
3437 On the surface, it would seem that clean-ups overlap the functionality | |
3438 provided by the @code{c-hanging-*-alist} variables. Clean-ups, | |
3439 however, are used to adjust code ``after-the-fact'', i.e. to adjust | |
3440 the whitespace in constructs later than when they were typed. | |
3441 | |
3442 Most of the clean-ups remove automatically inserted newlines, and are | |
3443 only active when auto-newline minor mode is turned on. Others will | |
3444 work all the time. Note that clean-ups are only performed when there | |
3445 is nothing but whitespace appearing between the individual components | |
3446 of the construct, and (apart from @code{comment-close-slash}) when the | |
3447 construct does not occur within a literal (@pxref{Auto-newlines}). | |
3448 | |
3449 @defopt c-cleanup-list | |
3450 @vindex cleanup-list (c-) | |
3451 @cindex literal | |
3452 | |
3453 You configure @ccmode{}'s clean-ups by setting the style variable | |
3454 @code{c-cleanup-list}, which is a list of clean-up symbols. By | |
3455 default, @ccmode{} cleans up only the @code{scope-operator} construct, | |
3456 which is necessary for proper C++ support. | |
3457 @end defopt | |
3458 | |
3459 These are the clean-ups that are only active when electric and | |
3460 auto-newline minor modes are enabled: | |
3461 | |
3462 @c TBD: Would like to use some sort of @deffoo here; @table indents a | |
3463 @c bit too much in dvi output. | |
3464 @table @code | |
3465 @item brace-else-brace | |
3466 Clean up @samp{@} else @{} constructs by placing the entire construct on | |
3467 a single line. Clean up occurs when the open brace after the | |
3468 @samp{else} is typed. So for example, this: | |
3469 | |
3470 @example | |
3471 @group | |
3472 void spam(int i) | |
3473 @{ | |
3474 if( i==7 ) @{ | |
3475 dosomething(); | |
3476 @} | |
3477 else | |
3478 @{ | |
3479 @end group | |
3480 @end example | |
3481 | |
3482 @noindent | |
3483 appears like this after the last open brace is typed: | |
3484 | |
3485 @example | |
3486 @group | |
3487 void spam(int i) | |
3488 @{ | |
3489 if( i==7 ) @{ | |
3490 dosomething(); | |
3491 @} else @{ | |
3492 @end group | |
3493 @end example | |
3494 | |
3495 @item brace-elseif-brace | |
3496 Similar to the @code{brace-else-brace} clean-up, but this cleans up | |
3497 @samp{@} else if (...) @{} constructs. For example: | |
3498 | |
3499 @example | |
3500 @group | |
3501 void spam(int i) | |
3502 @{ | |
3503 if( i==7 ) @{ | |
3504 dosomething(); | |
3505 @} | |
3506 else if( i==3 ) | |
3507 @{ | |
3508 @end group | |
3509 @end example | |
3510 | |
3511 @noindent | |
3512 appears like this after the last open parenthesis is typed: | |
3513 | |
3514 @example | |
3515 @group | |
3516 void spam(int i) | |
3517 @{ | |
3518 if( i==7 ) @{ | |
3519 dosomething(); | |
3520 @} else if( | |
3521 @end group | |
3522 @end example | |
3523 | |
3524 @noindent | |
3525 and like this after the last open brace is typed: | |
3526 | |
3527 @example | |
3528 @group | |
3529 void spam(int i) | |
3530 @{ | |
3531 if( i==7 ) @{ | |
3532 dosomething(); | |
3533 @} else if( i==3 ) @{ | |
3534 @end group | |
3535 @end example | |
3536 | |
3537 @item brace-catch-brace | |
3538 Analogous to @code{brace-elseif-brace}, but cleans up @samp{@} catch | |
3539 (...) @{} in C++ and Java mode. | |
3540 | |
3541 @item empty-defun-braces | |
3542 Clean up braces following a top-level function or class definition that | |
3543 contains no body. Clean up occurs when the closing brace is typed. | |
3544 Thus the following: | |
3545 | |
3546 @example | |
3547 @group | |
3548 class Spam | |
3549 @{ | |
3550 @} | |
3551 @end group | |
3552 @end example | |
3553 | |
3554 @noindent | |
3555 is transformed into this when the close brace is typed: | |
3556 | |
3557 @example | |
3558 @group | |
3559 class Spam | |
3560 @{@} | |
3561 @end group | |
3562 @end example | |
3563 | |
3564 @item defun-close-semi | |
3565 Clean up the terminating semicolon on top-level function or class | |
3566 definitions when they follow a close brace. Clean up occurs when the | |
3567 semicolon is typed. So for example, the following: | |
3568 | |
3569 @example | |
3570 @group | |
3571 class Spam | |
3572 @{ | |
3573 ... | |
3574 @} | |
3575 ; | |
3576 @end group | |
3577 @end example | |
3578 | |
3579 @noindent | |
3580 is transformed into this when the semicolon is typed: | |
3581 | |
3582 @example | |
3583 @group | |
3584 class Spam | |
3585 @{ | |
3586 ... | |
3587 @}; | |
3588 @end group | |
3589 @end example | |
3590 | |
3591 @item list-close-comma | |
3592 Clean up commas following braces in array and aggregate initializers. | |
3593 Clean up occurs when the comma is typed. The space before the comma | |
3594 is zapped just like the space before the semicolon in | |
3595 @code{defun-close-semi}. | |
3596 | |
3597 @item scope-operator | |
3598 Clean up double colons which might designate a C++ scope operator split | |
3599 across multiple lines@footnote{Certain C++ constructs introduce | |
3600 ambiguous situations, so @code{scope-operator} clean-ups might not | |
3601 always be correct. This usually only occurs when scoped identifiers | |
3602 appear in switch label tags.}. Clean up occurs when the second colon is | |
3603 typed. You will always want @code{scope-operator} in the | |
3604 @code{c-cleanup-list} when you are editing C++ code. | |
3605 | |
3606 @item one-liner-defun | |
3607 Clean up a single line of code enclosed by defun braces by removing | |
3608 the whitespace before and after the code. The clean-up happens when | |
3609 the closing brace is typed. If the variable | |
3610 @code{c-max-one-liner-length} is set, the cleanup is only done if the | |
3611 resulting line would be no longer than the value of that variable. | |
3612 | |
3613 For example, consider this AWK code: | |
3614 | |
3615 @example | |
3616 @group | |
3617 BEGIN @{ | |
3618 FS = "\t" # use <TAB> as a field separator | |
3619 @} | |
3620 @end group | |
3621 @end example | |
3622 | |
3623 @noindent | |
3624 It gets compacted to the following when the closing brace is typed: | |
3625 | |
3626 @example | |
3627 @group | |
3628 BEGIN @{FS = "\t"@} # use <TAB> as a field separator | |
3629 @end group | |
3630 @end example | |
3631 | |
3632 @defopt c-max-one-liner-length | |
3633 @vindex max-one-liner-length (c-) | |
3634 The maximum length of the resulting line for which the clean-up | |
3635 @code{one-liner-defun} will be triggered. This length is that of the entire | |
3636 line, including any leading whitespace and any trailing comment. Its | |
3637 default value is 80. If the value is zero or @code{nil}, no limit | |
3638 applies. | |
3639 @end defopt | |
3640 @end table | |
3641 | |
3642 The following clean-ups are always active when they occur on | |
3643 @code{c-cleanup-list}, regardless of whether Electric minor mode or | |
3644 Auto-newline minor mode are enabled: | |
3645 | |
3646 @table @code | |
3647 @item space-before-funcall | |
3648 Insert a space between the function name and the opening parenthesis | |
3649 of a function call. This produces function calls in the style | |
3650 mandated by the GNU coding standards, e.g. @samp{signal@w{ }(SIGINT, | |
3651 SIG_IGN)} and @samp{abort@w{ }()}. Clean up occurs when the opening | |
3652 parenthesis is typed. This clean-up should never be active in AWK | |
3653 Mode, since such a space is syntactically invalid for user defined | |
3654 functions. | |
3655 | |
3656 @item compact-empty-funcall | |
3657 Clean up any space between the function name and the opening parenthesis | |
3658 of a function call that has no arguments. This is typically used | |
3659 together with @code{space-before-funcall} if you prefer the GNU function | |
3660 call style for functions with arguments but think it looks ugly when | |
3661 it's only an empty parenthesis pair. I.e. you will get @samp{signal | |
3662 (SIGINT, SIG_IGN)}, but @samp{abort()}. Clean up occurs when the | |
3663 closing parenthesis is typed. | |
3664 | |
3665 @item comment-close-slash | |
3666 When inside a block comment, terminate the comment when you type a slash | |
3667 at the beginning of a line (i.e. immediately after the comment prefix). | |
3668 This clean-up removes whitespace preceding the slash and if needed, | |
3669 inserts a star to complete the token @samp{*/}. Type @kbd{C-q /} in this | |
3670 situation if you just want a literal @samp{/} inserted. | |
3671 @end table | |
3672 | |
3673 | |
3674 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
3675 @node Indentation Engine Basics, Customizing Indentation, Clean-ups, Top | |
3676 @comment node-name, next, previous, up | |
3677 @chapter Indentation Engine Basics | |
3678 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
3679 | |
3680 This chapter will briefly cover how @ccmode{} indents lines of code. | |
3681 It is helpful to understand the indentation model being used so that | |
3682 you will know how to customize @ccmode{} for your personal coding | |
3683 style. All the details are in @ref{Customizing Indentation}. | |
3684 | |
3685 @ccmode{} has an indentation engine that provides a flexible and | |
3686 general mechanism for customizing indentation. When @ccmode{} indents | |
3687 a line of code, it separates its calculations into two steps: | |
3688 | |
3689 @enumerate | |
3690 @item | |
3691 @cindex syntactic symbol | |
3692 @cindex anchor position | |
3693 It analyzes the line to determine its @dfn{syntactic symbol(s)} (the | |
3694 kind of language construct it's looking at) and its @dfn{anchor | |
3695 position} (the position earlier in the file that @ccmode{} will indent | |
3696 the line relative to). The anchor position might be the location of | |
3697 an opening brace in the previous line, for example. @xref{Syntactic | |
3698 Analysis}. | |
3699 @item | |
3700 @cindex offsets | |
3701 @cindex indentation offset specifications | |
3702 It looks up the syntactic symbol(s) in the configuration to get the | |
3703 corresponding @dfn{offset(s)}. The symbol @code{+}, which means | |
3704 ``indent this line one more level'' is a typical offset. @ccmode{} | |
3705 then applies these offset(s) to the anchor position, giving the | |
3706 indentation for the line. The different sorts of offsets are | |
3707 described in @ref{c-offsets-alist}. | |
3708 @end enumerate | |
3709 | |
3710 In exceptional circumstances, the syntax directed indentation | |
3711 described here may be a nuisance rather than a help. You can disable | |
3712 it by setting @code{c-syntactic-indentation} to @code{nil}. (To set | |
3713 the variable interactively, @ref{Minor Modes}). | |
3714 | |
3715 @defopt c-syntactic-indentation | |
3716 @vindex syntactic-indentation (c-) | |
3717 When this is non-@code{nil} (which it is by default), the indentation | |
3718 of code is done according to its syntactic structure. When it's | |
3719 @code{nil}, every line is just indented to the same level as the | |
3720 previous one, and @kbd{TAB} (@code{c-indent-command}) adjusts the | |
3721 indentation in steps of @code{c-basic-offset}. The current style | |
3722 (@pxref{Config Basics}) then has no effect on indentation, nor do any | |
3723 of the variables associated with indentation, not even | |
3724 @code{c-special-indent-hook}. | |
3725 @end defopt | |
3726 | |
3727 @menu | |
3728 * Syntactic Analysis:: | |
3729 * Syntactic Symbols:: | |
3730 * Indentation Calculation:: | |
3731 @end menu | |
3732 | |
3733 | |
3734 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
3735 @node Syntactic Analysis, Syntactic Symbols, Indentation Engine Basics, Indentation Engine Basics | |
3736 @comment node-name, next, previous, up | |
3737 @section Syntactic Analysis | |
3738 @cindex syntactic analysis | |
3739 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
3740 | |
3741 @cindex syntactic element | |
3742 @cindex syntactic context | |
3743 The first thing @ccmode{} does when indenting a line of code, is to | |
3744 analyze the line, determining the @dfn{syntactic context} of the | |
3745 (first) construct on that line. It's a list of @dfn{syntactic | |
3746 elements}, where each syntactic element in turn is a list@footnote{In | |
3747 @ccmode 5.28 and earlier, a syntactic element was a dotted pair; the | |
3748 cons was the syntactic symbol and the cdr was the anchor position. | |
3749 For compatibility's sake, the parameter passed to a line-up function | |
3750 still has this dotted pair form (@pxref{Custom Line-Up}).} Here is a | |
3751 brief and typical example: | |
3752 | |
3753 @example | |
3754 ((defun-block-intro 1959)) | |
3755 @end example | |
3756 | |
3757 @cindex syntactic symbol | |
3758 @noindent | |
3759 The first thing inside each syntactic element is always a | |
3760 @dfn{syntactic symbol}. It describes the kind of construct that was | |
3761 recognized, e.g. @code{statement}, @code{substatement}, | |
3762 @code{class-open}, @code{class-close}, etc. @xref{Syntactic Symbols}, | |
3763 for a complete list of currently recognized syntactic symbols and | |
3764 their semantics. The remaining entries are various data associated | |
3765 with the recognized construct - there might be zero or more. | |
3766 | |
3767 @cindex anchor position | |
3768 Conceptually, a line of code is always indented relative to some | |
3769 position higher up in the buffer (typically the indentation of the | |
3770 previous line). That position is the @dfn{anchor position} in the | |
3771 syntactic element. If there is an entry after the syntactic symbol in | |
3772 the syntactic element list then it's either nil or that anchor position. | |
3773 | |
3774 Here is an example. Suppose we had the following code as the only thing | |
3775 in a C++ buffer @footnote{The line numbers in this and future examples | |
3776 don't actually appear in the buffer, of course!}: | |
3777 | |
3778 @example | |
3779 1: void swap( int& a, int& b ) | |
3780 2: @{ | |
3781 3: int tmp = a; | |
3782 4: a = b; | |
3783 5: b = tmp; | |
3784 6: @} | |
3785 @end example | |
3786 | |
3787 @noindent | |
3788 We can use @kbd{C-c C-s} (@code{c-show-syntactic-information}) to | |
3789 report what the syntactic analysis is for the current line: | |
3790 | |
3791 @table @asis | |
3792 @item @kbd{C-c C-s} (@code{c-show-syntactic-information}) | |
3793 @kindex C-c C-s | |
3794 @findex c-show-syntactic-information | |
3795 @findex show-syntactic-information (c-) | |
3796 This command calculates the syntactic analysis of the current line and | |
3797 displays it in the minibuffer. The command also highlights the anchor | |
3798 position(s). | |
3799 @end table | |
3800 | |
3801 Running this command on line 4 of this example, we'd see in the echo | |
3802 area@footnote{With a universal argument (i.e. @kbd{C-u C-c C-s}) the | |
3803 analysis is inserted into the buffer as a comment on the current | |
3804 line.}: | |
3805 | |
3806 @example | |
3807 ((statement 35)) | |
3808 @end example | |
3809 | |
3810 @noindent | |
3811 and the @samp{i} of @code{int} on line 3 would be highlighted. This | |
3812 tells us that the line is a statement and it is indented relative to | |
3813 buffer position 35, the highlighted position. If you were to move | |
3814 point to line 3 and hit @kbd{C-c C-s}, you would see: | |
3815 | |
3816 @example | |
3817 ((defun-block-intro 29)) | |
3818 @end example | |
3819 | |
3820 @noindent | |
3821 This indicates that the @samp{int} line is the first statement in a top | |
3822 level function block, and is indented relative to buffer position 29, | |
3823 which is the brace just after the function header. | |
3824 | |
3825 Here's another example: | |
3826 | |
3827 @example | |
3828 1: int add( int val, int incr, int doit ) | |
3829 2: @{ | |
3830 3: if( doit ) | |
3831 4: @{ | |
3832 5: return( val + incr ); | |
3833 6: @} | |
3834 7: return( val ); | |
3835 8: @} | |
3836 @end example | |
3837 | |
3838 @noindent | |
3839 Hitting @kbd{C-c C-s} on line 4 gives us: | |
3840 | |
3841 @example | |
3842 ((substatement-open 46)) | |
3843 @end example | |
3844 | |
3845 @cindex substatement | |
3846 @cindex substatement block | |
3847 @noindent | |
3848 which tells us that this is a brace that @emph{opens} a substatement | |
3849 block. @footnote{A @dfn{substatement} is the line after a | |
3850 conditional statement, such as @code{if}, @code{else}, @code{while}, | |
3851 @code{do}, @code{switch}, etc. A @dfn{substatement | |
3852 block} is a brace block following one of these conditional statements.} | |
3853 | |
3854 @cindex comment-only line | |
3855 Syntactic contexts can contain more than one element, and syntactic | |
3856 elements need not have anchor positions. The most common example of | |
3857 this is a @dfn{comment-only line}: | |
3858 | |
3859 @example | |
3860 1: void draw_list( List<Drawables>& drawables ) | |
3861 2: @{ | |
3862 3: // call the virtual draw() method on each element in list | |
3863 4: for( int i=0; i < drawables.count(), ++i ) | |
3864 5: @{ | |
3865 6: drawables[i].draw(); | |
3866 7: @} | |
3867 8: @} | |
3868 @end example | |
3869 | |
3870 @noindent | |
3871 Hitting @kbd{C-c C-s} on line 3 of this example gives: | |
3872 | |
3873 @example | |
3874 ((comment-intro) (defun-block-intro 46)) | |
3875 @end example | |
3876 | |
3877 @noindent | |
3878 and you can see that the syntactic context contains two syntactic | |
3879 elements. Notice that the first element, @samp{(comment-intro)}, has no | |
3880 anchor position. | |
3881 | |
3882 | |
3883 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
3884 @node Syntactic Symbols, Indentation Calculation, Syntactic Analysis, Indentation Engine Basics | |
3885 @comment node-name, next, previous, up | |
3886 @section Syntactic Symbols | |
3887 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
3888 | |
3889 @cindex syntactic symbols, brief list | |
3890 @vindex c-offsets-alist | |
3891 @vindex offsets-alist (c-) | |
3892 This section is a complete list of the syntactic symbols which appear | |
3893 in the @code{c-offsets-alist} style variable, along with brief | |
3894 descriptions. The previous section (@pxref{Syntactic Analysis}) | |
3895 states what syntactic symbols are and how the indentation engine uses | |
3896 them. | |
3897 | |
3898 More detailed descriptions of these symbols, together with snippets of | |
3899 source code to which they apply, appear in the examples in the | |
3900 subsections below. Note that, in the interests of brevity, the anchor | |
3901 position associated with most syntactic symbols is @emph{not} | |
3902 specified. In cases of doubt, type @kbd{C-c C-s} on a pertinent | |
3903 line---this highlights the anchor position. | |
3904 | |
3905 @ssindex -open symbols | |
3906 @ssindex -close symbols | |
3907 @ssindex -block-intro symbols | |
3908 The syntactic symbols which indicate brace constructs follow a general | |
3909 naming convention. When a line begins with an open or close brace, | |
3910 its syntactic symbol will contain the suffix @code{-open} or | |
3911 @code{-close} respectively. The first line within the brace block | |
3912 construct will contain the suffix @code{-block-intro}. | |
3913 | |
3914 @ssindex -intro symbols | |
3915 @ssindex -cont symbols | |
3916 In constructs which can span several lines, a distinction is usually | |
3917 made between the first line that introduces the construct and the | |
3918 lines that continue it. The syntactic symbols that indicate these | |
3919 lines will contain the suffixes @code{-intro} or @code{-cont} | |
3920 respectively. | |
3921 | |
3922 The best way to understand how all this works is by looking at some | |
3923 examples. Remember that you can see the syntax of any source code | |
3924 line by using @kbd{C-c C-s}. | |
3925 | |
3926 @table @code | |
3927 @item string | |
3928 Inside a multiline string. @ref{Literal Symbols}. | |
3929 @item c | |
3930 Inside a multiline C style block comment. @ref{Literal Symbols}. | |
3931 @item defun-open | |
3932 Brace that opens a top-level function definition. @ref{Function | |
3933 Symbols}. | |
3934 @item defun-close | |
3935 Brace that closes a top-level function definition. @ref{Function | |
3936 Symbols}. | |
3937 @item defun-block-intro | |
3938 The first line in a top-level defun. @ref{Function Symbols}. | |
3939 @item class-open | |
3940 Brace that opens a class definition. @ref{Class Symbols}. | |
3941 @item class-close | |
3942 Brace that closes a class definition. @ref{Class Symbols}. | |
3943 @item inline-open | |
3944 Brace that opens an in-class inline method. @ref{Class Symbols}. | |
3945 @item inline-close | |
3946 Brace that closes an in-class inline method. @ref{Class Symbols}. | |
3947 @item func-decl-cont | |
3948 The region between a function definition's argument list and the | |
3949 function opening brace (excluding K&R argument declarations). In C, | |
3950 you cannot put anything but whitespace and comments in this region, | |
3951 however in C++ and Java, @code{throws} declarations and other things | |
3952 can appear here. @ref{Literal Symbols}. @c @emph{FIXME!!! Can it not | |
3953 @c go somewhere better?} | |
3954 @item knr-argdecl-intro | |
3955 First line of a K&R C argument declaration. @ref{K&R Symbols}. | |
3956 @item knr-argdecl | |
3957 Subsequent lines in a K&R C argument declaration. @ref{K&R Symbols}. | |
3958 @item topmost-intro | |
3959 The first line in a ``topmost'' definition. @ref{Function Symbols}. | |
3960 @item topmost-intro-cont | |
3961 Topmost definition continuation lines. This is only used in the parts | |
3962 that aren't covered by other symbols such as @code{func-decl-cont} and | |
3963 @code{knr-argdecl}. @ref{Function Symbols}. | |
3964 @item member-init-intro | |
3965 First line in a member initialization list. @ref{Class Symbols}. | |
3966 @item member-init-cont | |
3967 Subsequent member initialization list lines. @ref{Class Symbols}. | |
3968 @item inher-intro | |
3969 First line of a multiple inheritance list. @ref{Class Symbols}. | |
3970 @item inher-cont | |
3971 Subsequent multiple inheritance lines. @ref{Class Symbols}. | |
3972 @item block-open | |
3973 Statement block open brace. @ref{Literal Symbols}. | |
3974 @item block-close | |
3975 Statement block close brace. @ref{Conditional Construct Symbols}. | |
3976 @item brace-list-open | |
3977 Open brace of an enum or static array list. @ref{Brace List Symbols}. | |
3978 @item brace-list-close | |
3979 Close brace of an enum or static array list. @ref{Brace List Symbols}. | |
3980 @item brace-list-intro | |
3981 First line in an enum or static array list. @ref{Brace List Symbols}. | |
3982 @item brace-list-entry | |
3983 Subsequent lines in an enum or static array list. @ref{Brace List | |
3984 Symbols}. | |
3985 @item brace-entry-open | |
3986 Subsequent lines in an enum or static array list where the line begins | |
3987 with an open brace. @ref{Brace List Symbols}. | |
3988 @item statement | |
3989 A statement. @ref{Function Symbols}. | |
3990 @item statement-cont | |
3991 A continuation of a statement. @ref{Function Symbols}. | |
3992 @item statement-block-intro | |
3993 The first line in a new statement block. @ref{Conditional Construct | |
3994 Symbols}. | |
3995 @item statement-case-intro | |
3996 The first line in a case block. @ref{Switch Statement Symbols}. | |
3997 @item statement-case-open | |
3998 The first line in a case block that starts with a brace. @ref{Switch | |
3999 Statement Symbols}. | |
4000 @item substatement | |
4001 The first line after a conditional or loop construct. | |
4002 @ref{Conditional Construct Symbols}. | |
4003 @item substatement-open | |
4004 The brace that opens a substatement block. @ref{Conditional Construct | |
4005 Symbols}. | |
4006 @item substatement-label | |
4007 The first line after a conditional or loop construct if it's a label. | |
4008 @ref{Conditional Construct Symbols}. | |
4009 @item case-label | |
4010 A label in a @code{switch} block. @ref{Switch Statement Symbols}. | |
4011 @item access-label | |
4012 C++ access control label. @ref{Class Symbols}. | |
4013 @item label | |
4014 Any other label. @ref{Literal Symbols}. | |
4015 @item do-while-closure | |
4016 The @code{while} line that ends a @code{do}-@code{while} construct. | |
4017 @ref{Conditional Construct Symbols}. | |
4018 @item else-clause | |
4019 The @code{else} line of an @code{if}-@code{else} construct. | |
4020 @ref{Conditional Construct Symbols}. | |
4021 @item catch-clause | |
4022 The @code{catch} or @code{finally} (in Java) line of a | |
4023 @code{try}-@code{catch} construct. @ref{Conditional Construct | |
4024 Symbols}. | |
4025 @item comment-intro | |
4026 A line containing only a comment introduction. @ref{Literal Symbols}. | |
4027 @item arglist-intro | |
4028 The first line in an argument list. @ref{Paren List Symbols}. | |
4029 @item arglist-cont | |
4030 Subsequent argument list lines when no arguments follow on the same | |
4031 line as the arglist opening paren. @ref{Paren List Symbols}. | |
4032 @item arglist-cont-nonempty | |
4033 Subsequent argument list lines when at least one argument follows on | |
4034 the same line as the arglist opening paren. @ref{Paren List Symbols}. | |
4035 @item arglist-close | |
4036 The solo close paren of an argument list. @ref{Paren List Symbols}. | |
4037 @item stream-op | |
4038 Lines continuing a stream operator (C++ only). @ref{Literal | |
4039 Symbols}. @c @emph{FIXME!!! Can this not be moved somewhere better?} | |
4040 @item inclass | |
4041 The line is nested inside a class definition. @ref{Class Symbols}. | |
4042 @item cpp-macro | |
4043 The start of a preprocessor macro definition. @ref{Literal Symbols}. | |
4044 @item cpp-define-intro | |
4045 The first line inside a multiline preprocessor macro if | |
4046 @code{c-syntactic-indentation-in-macros} is set. @ref{Multiline Macro | |
4047 Symbols}. | |
4048 @item cpp-macro-cont | |
4049 All lines inside multiline preprocessor macros if | |
4050 @code{c-syntactic-indentation-in-macros} is @code{nil}. | |
4051 @ref{Multiline Macro Symbols}. | |
4052 @item friend | |
4053 A C++ friend declaration. @ref{Class Symbols}. | |
4054 @item objc-method-intro | |
4055 The first line of an Objective-C method definition. @ref{Objective-C | |
4056 Method Symbols}. | |
4057 @item objc-method-args-cont | |
4058 Lines continuing an Objective-C method definition. @ref{Objective-C | |
4059 Method Symbols}. | |
4060 @item objc-method-call-cont | |
4061 Lines continuing an Objective-C method call. @ref{Objective-C Method | |
4062 Symbols}. | |
4063 @item extern-lang-open | |
4064 Brace that opens an @code{extern} block (e.g. @code{extern "C" | |
4065 @{...@}}). @ref{External Scope Symbols}. | |
4066 @item extern-lang-close | |
4067 Brace that closes an @code{extern} block. @ref{External Scope | |
4068 Symbols}. | |
4069 @item inextern-lang | |
4070 Analogous to @code{inclass} syntactic symbol, but used inside | |
4071 @code{extern} blocks. @ref{External Scope Symbols}. | |
4072 @item namespace-open | |
4073 @itemx namespace-close | |
4074 @itemx innamespace | |
4075 These are analogous to the three @code{extern-lang} symbols above, but | |
4076 are returned for C++ namespace blocks. @ref{External Scope Symbols}. | |
4077 @item module-open | |
4078 @itemx module-close | |
4079 @itemx inmodule | |
4080 Analogous to the above, but for CORBA IDL @code{module} blocks. | |
4081 @ref{External Scope Symbols}. | |
4082 @item composition-open | |
4083 @itemx composition-close | |
4084 @itemx incomposition | |
4085 Analogous to the above, but for CORBA CIDL @code{composition} blocks. | |
4086 @ref{External Scope Symbols}. | |
4087 @item template-args-cont | |
4088 C++ template argument list continuations. @ref{Class Symbols}. | |
4089 @item inlambda | |
4090 Analogous to @code{inclass} syntactic symbol, but used inside lambda | |
4091 (i.e. anonymous) functions. Only used in Pike mode. @ref{Statement | |
4092 Block Symbols}. | |
4093 @item lambda-intro-cont | |
4094 Lines continuing the header of a lambda function, i.e. between the | |
4095 @code{lambda} keyword and the function body. Only used in Pike mode. | |
4096 @ref{Statement Block Symbols}. | |
4097 @item inexpr-statement | |
4098 A statement block inside an expression. The gcc C and C++ extension | |
4099 for this is recognized. It's also used for the special functions that | |
4100 take a statement block as an argument in Pike. @ref{Statement Block | |
4101 Symbols}. | |
4102 @item inexpr-class | |
4103 A class definition inside an expression. This is used for anonymous | |
4104 classes in Java. It's also used for anonymous array initializers in | |
4105 Java. @ref{Anonymous Class Symbol}. | |
4106 @end table | |
4107 | |
4108 @menu | |
4109 * Function Symbols:: | |
4110 * Class Symbols:: | |
4111 * Conditional Construct Symbols:: | |
4112 * Switch Statement Symbols:: | |
4113 * Brace List Symbols:: | |
4114 * External Scope Symbols:: | |
4115 * Paren List Symbols:: | |
4116 * Literal Symbols:: | |
4117 * Multiline Macro Symbols:: | |
4118 * Objective-C Method Symbols:: | |
4119 * Anonymous Class Symbol:: | |
4120 * Statement Block Symbols:: | |
4121 * K&R Symbols:: | |
4122 @end menu | |
4123 | |
4124 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4125 @node Function Symbols, Class Symbols, Syntactic Symbols, Syntactic Symbols | |
4126 @comment node-name, next, previous, up | |
4127 @subsection Function Symbols | |
4128 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4129 | |
4130 This example shows a typical function declaration. | |
4131 | |
4132 @example | |
4133 1: void | |
4134 2: swap( int& a, int& b ) | |
4135 3: @{ | |
4136 4: int tmp = a; | |
4137 5: a = b; | |
4138 6: b = tmp; | |
4139 7: int ignored = | |
4140 8: a + b; | |
4141 9: @} | |
4142 @end example | |
4143 | |
4144 @ssindex topmost-intro | |
4145 @ssindex topmost-intro-cont | |
4146 @ssindex defun-open | |
4147 @ssindex defun-close | |
4148 @ssindex defun-block-intro | |
4149 Line 1 shows a @code{topmost-intro} since it is the first line that | |
4150 introduces a top-level construct. Line 2 is a continuation of the | |
4151 top-level construct introduction so it has the syntax | |
4152 @code{topmost-intro-cont}. Line 3 shows a @code{defun-open} since it is | |
4153 the brace that opens a top-level function definition. Line 9 is the | |
4154 corresponding | |
4155 @code{defun-close} since it contains the brace that closes the top-level | |
4156 function definition. Line 4 is a @code{defun-block-intro}, i.e. it is | |
4157 the first line of a brace-block, enclosed in a | |
4158 top-level function definition. | |
4159 | |
4160 @ssindex statement | |
4161 @ssindex statement-cont | |
4162 Lines 5, 6, and 7 are all given @code{statement} syntax since there | |
4163 isn't much special about them. Note however that line 8 is given | |
4164 @code{statement-cont} syntax since it continues the statement begun | |
4165 on the previous line. | |
4166 | |
4167 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4168 @node Class Symbols, Conditional Construct Symbols, Function Symbols, Syntactic Symbols | |
4169 @comment node-name, next, previous, up | |
4170 @subsection Class related Symbols | |
4171 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4172 | |
4173 Here's an example which illustrates some C++ class syntactic symbols: | |
4174 | |
4175 @example | |
4176 1: class Bass | |
4177 2: : public Guitar, | |
4178 3: public Amplifiable | |
4179 4: @{ | |
4180 5: public: | |
4181 6: Bass() | |
4182 7: : eString( new BassString( 0.105 )), | |
4183 8: aString( new BassString( 0.085 )), | |
4184 9: dString( new BassString( 0.065 )), | |
4185 10: gString( new BassString( 0.045 )) | |
4186 11: @{ | |
4187 12: eString.tune( 'E' ); | |
4188 13: aString.tune( 'A' ); | |
4189 14: dString.tune( 'D' ); | |
4190 15: gString.tune( 'G' ); | |
4191 16: @} | |
4192 17: friend class Luthier; | |
4193 18: @}; | |
4194 @end example | |
4195 | |
4196 @ssindex class-open | |
4197 @ssindex class-close | |
4198 As in the previous example, line 1 has the @code{topmost-intro} syntax. | |
4199 Here however, the brace that opens a C++ class definition on line 4 is | |
4200 assigned the @code{class-open} syntax. Note that in C++, classes, | |
4201 structs, and unions are essentially equivalent syntactically (and are | |
4202 very similar semantically), so replacing the @code{class} keyword in the | |
4203 example above with @code{struct} or @code{union} would still result in a | |
4204 syntax of @code{class-open} for line 4 @footnote{This is the case even | |
4205 for C and Objective-C. For consistency, structs in all supported | |
4206 languages are syntactically equivalent to classes. Note however that | |
4207 the keyword @code{class} is meaningless in C and Objective-C.}. | |
4208 Similarly, line 18 is assigned @code{class-close} syntax. | |
4209 | |
4210 @ssindex inher-intro | |
4211 @ssindex inher-cont | |
4212 Line 2 introduces the inheritance list for the class so it is assigned | |
4213 the @code{inher-intro} syntax, and line 3, which continues the | |
4214 inheritance list is given @code{inher-cont} syntax. | |
4215 | |
4216 @ssindex access-label | |
4217 @ssindex inclass | |
4218 Hitting @kbd{C-c C-s} on line 5 shows the following analysis: | |
4219 | |
4220 @example | |
4221 ((inclass 58) (access-label 58)) | |
4222 @end example | |
4223 | |
4224 @noindent | |
4225 The primary syntactic symbol for this line is @code{access-label} as | |
4226 this a label keyword that specifies access protection in C++. However, | |
4227 because this line is also a top-level construct inside a class | |
4228 definition, the analysis actually shows two syntactic symbols. The | |
4229 other syntactic symbol assigned to this line is @code{inclass}. | |
4230 Similarly, line 6 is given both @code{inclass} and @code{topmost-intro} | |
4231 syntax: | |
4232 | |
4233 @example | |
4234 ((inclass 58) (topmost-intro 60)) | |
4235 @end example | |
4236 | |
4237 @ssindex member-init-intro | |
4238 @ssindex member-init-cont | |
4239 Line 7 introduces a C++ member initialization list and as such is given | |
4240 @code{member-init-intro} syntax. Note that in this case it is | |
4241 @emph{not} assigned @code{inclass} since this is not considered a | |
4242 top-level construct. Lines 8 through 10 are all assigned | |
4243 @code{member-init-cont} since they continue the member initialization | |
4244 list started on line 7. | |
4245 | |
4246 @cindex in-class inline methods | |
4247 @ssindex inline-open | |
4248 @ssindex inline-close | |
4249 Line 11's analysis is a bit more complicated: | |
4250 | |
4251 @example | |
4252 ((inclass 58) (inline-open)) | |
4253 @end example | |
4254 | |
4255 This line is assigned a syntax of both @code{inline-open} and | |
4256 @code{inclass} because it opens an @dfn{in-class} C++ inline method | |
4257 definition. This is distinct from, but related to, the C++ notion of an | |
4258 inline function in that its definition occurs inside an enclosing class | |
4259 definition, which in C++ implies that the function should be inlined. | |
4260 However, if the definition of the @code{Bass} constructor appeared | |
4261 outside the class definition, the construct would be given the | |
4262 @code{defun-open} syntax, even if the keyword @code{inline} appeared | |
4263 before the method name, as in: | |
4264 | |
4265 @example | |
4266 1: class Bass | |
4267 2: : public Guitar, | |
4268 3: public Amplifiable | |
4269 4: @{ | |
4270 5: public: | |
4271 6: Bass(); | |
4272 7: @}; | |
4273 8: | |
4274 9: inline | |
4275 10: Bass::Bass() | |
4276 11: : eString( new BassString( 0.105 )), | |
4277 12: aString( new BassString( 0.085 )), | |
4278 13: dString( new BassString( 0.065 )), | |
4279 14: gString( new BassString( 0.045 )) | |
4280 15: @{ | |
4281 16: eString.tune( 'E' ); | |
4282 17: aString.tune( 'A' ); | |
4283 18: dString.tune( 'D' ); | |
4284 19: gString.tune( 'G' ); | |
4285 20: @} | |
4286 @end example | |
4287 | |
4288 @ssindex friend | |
4289 Returning to the previous example, line 16 is given @code{inline-close} | |
4290 syntax, while line 12 is given @code{defun-block-open} syntax, and lines | |
4291 13 through 15 are all given @code{statement} syntax. Line 17 is | |
4292 interesting in that its syntactic analysis list contains three | |
4293 elements: | |
4294 | |
4295 @example | |
4296 ((inclass 58) (topmost-intro 380) (friend)) | |
4297 @end example | |
4298 | |
4299 The @code{friend} and @code{inline-open} syntactic symbols are | |
4300 modifiers that do not have anchor positions. | |
4301 | |
4302 @ssindex template-args-cont | |
4303 Template definitions introduce yet another syntactic symbol: | |
4304 | |
4305 @example | |
4306 1: ThingManager <int, | |
4307 2: Framework::Callback *, | |
4308 3: Mutex> framework_callbacks; | |
4309 @end example | |
4310 | |
4311 Here, line 1 is analyzed as a @code{topmost-intro}, but lines 2 and 3 | |
4312 are both analyzed as @code{template-args-cont} lines. | |
4313 | |
4314 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4315 @node Conditional Construct Symbols, Switch Statement Symbols, Class Symbols, Syntactic Symbols | |
4316 @comment node-name, next, previous, up | |
4317 @subsection Conditional Construct Symbols | |
4318 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4319 | |
4320 Here is a (totally contrived) example which illustrates how syntax is | |
4321 assigned to various conditional constructs: | |
4322 | |
4323 @example | |
4324 1: void spam( int index ) | |
4325 2: @{ | |
4326 3: for( int i=0; i<index; i++ ) | |
4327 4: @{ | |
4328 5: if( i == 10 ) | |
4329 6: do_something_special(); | |
4330 7: else | |
4331 8: silly_label: | |
4332 9: do_something( i ); | |
4333 10: @} | |
4334 11: do @{ | |
4335 12: another_thing( i-- ); | |
4336 13: @} | |
4337 14: while( i > 0 ); | |
4338 15: @} | |
4339 @end example | |
4340 | |
4341 Only the lines that illustrate new syntactic symbols will be discussed. | |
4342 | |
4343 @ssindex substatement-open | |
4344 @ssindex statement-block-intro | |
4345 @ssindex block-close | |
4346 Line 4 has a brace which opens a conditional's substatement block. It | |
4347 is thus assigned @code{substatement-open} syntax, and since line 5 is | |
4348 the first line in the substatement block, it is assigned | |
4349 @code{statement-block-intro} syntax. Line 10 contains the brace | |
4350 that closes the inner substatement block, and is therefore given the | |
4351 syntax @code{block-close}@footnote{@code{block-open} is used only for | |
4352 ``free-standing'' blocks, and is somewhat rare (@pxref{Literal | |
4353 Symbols} for an example.)}. Line 13 is treated the same way. | |
4354 | |
4355 @ssindex substatement | |
4356 Lines 6 and 9 are also substatements of conditionals, but since they | |
4357 don't start blocks they are given @code{substatement} syntax | |
4358 instead of @code{substatement-open}. | |
4359 | |
4360 @ssindex substatement-label | |
4361 Line 8 contains a label, which is normally given @code{label} syntax. | |
4362 This one is however a bit special since it's between a conditional and | |
4363 its substatement. It's analyzed as @code{substatement-label} to let you | |
4364 handle this rather odd case differently from normal labels. | |
4365 | |
4366 @ssindex else-clause | |
4367 @ssindex catch-clause | |
4368 Line 7 start with an @code{else} that matches the @code{if} statement on | |
4369 line 5. It is therefore given the @code{else-clause} syntax and is | |
4370 anchored on the matching @code{if}. The @code{try}-@code{catch} | |
4371 constructs in C++ and Java are treated this way too, except that | |
4372 @code{catch} and (in Java) @code{finally}, are marked with | |
4373 @code{catch-clause}. | |
4374 | |
4375 @ssindex do-while-closure | |
4376 The @code{while} construct on line 14 that closes a @code{do} | |
4377 conditional is given the special syntax @code{do-while-closure} if it | |
4378 appears on a line by itself. Note that if the @code{while} appeared on | |
4379 the same line as the preceding close brace, that line would still have | |
4380 @code{block-close} syntax. | |
4381 | |
4382 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4383 @node Switch Statement Symbols, Brace List Symbols, Conditional Construct Symbols, Syntactic Symbols | |
4384 @comment node-name, next, previous, up | |
4385 @subsection Switch Statement Symbols | |
4386 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4387 | |
4388 Switch statements have their own set of syntactic symbols. Here's an | |
4389 example: | |
4390 | |
4391 @example | |
4392 1: void spam( enum Ingredient i ) | |
4393 2: @{ | |
4394 3: switch( i ) @{ | |
4395 4: case Ham: | |
4396 5: be_a_pig(); | |
4397 6: break; | |
4398 7: case Salt: | |
4399 8: drink_some_water(); | |
4400 9: break; | |
4401 10: default: | |
4402 11: @{ | |
4403 12: what_is_it(); | |
4404 13: break; | |
4405 14: @} | |
4406 15: @} | |
4407 14: @} | |
4408 @end example | |
4409 | |
4410 @ssindex case-label | |
4411 @ssindex statement-case-intro | |
4412 @ssindex statement-case-open | |
4413 Here, lines 4, 7, and 10 are all assigned @code{case-label} syntax, | |
4414 while lines 5 and 8 are assigned @code{statement-case-intro}. Line 11 | |
4415 is treated slightly differently since it contains a brace that opens a | |
4416 block --- it is given @code{statement-case-open} syntax. | |
4417 | |
4418 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4419 @node Brace List Symbols, External Scope Symbols, Switch Statement Symbols, Syntactic Symbols | |
4420 @comment node-name, next, previous, up | |
4421 @subsection Brace List Symbols | |
4422 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4423 | |
4424 @cindex brace lists | |
4425 There are a set of syntactic symbols that are used to recognize | |
4426 constructs inside of brace lists. A brace list is defined as an | |
4427 @code{enum} or aggregate initializer list, such as might statically | |
4428 initialize an array of structs. The three special aggregate constructs | |
4429 in Pike, @code{(@{ @})}, @code{([ ])} and @code{(< >)}, are treated as | |
4430 brace lists too. An example: | |
4431 | |
4432 @example | |
4433 1: static char* ingredients[] = | |
4434 2: @{ | |
4435 3: "Ham", | |
4436 4: "Salt", | |
4437 5: NULL | |
4438 6: @}; | |
4439 @end example | |
4440 | |
4441 @ssindex brace-list-open | |
4442 @ssindex brace-list-intro | |
4443 @ssindex brace-list-close | |
4444 @ssindex brace-list-entry | |
4445 Following convention, line 2 in this example is assigned | |
4446 @code{brace-list-open} syntax, and line 3 is assigned | |
4447 @code{brace-list-intro} syntax. Likewise, line 6 is assigned | |
4448 @code{brace-list-close} syntax. Lines 4 and 5 however, are assigned | |
4449 @code{brace-list-entry} syntax, as would all subsequent lines in this | |
4450 initializer list. | |
4451 | |
4452 @ssindex brace-entry-open | |
4453 Your static initializer might be initializing nested structures, for | |
4454 example: | |
4455 | |
4456 @example | |
4457 1: struct intpairs[] = | |
4458 2: @{ | |
4459 3: @{ 1, 2 @}, | |
4460 4: @{ | |
4461 5: 3, | |
4462 6: 4 | |
4463 7: @} | |
4464 8: @{ 1, | |
4465 9: 2 @}, | |
4466 10: @{ 3, 4 @} | |
4467 11: @}; | |
4468 @end example | |
4469 | |
4470 Here, you've already seen the analysis of lines 1, 2, 3, and 11. On | |
4471 line 4, things get interesting; this line is assigned | |
4472 @code{brace-entry-open} syntactic symbol because it's a bracelist entry | |
4473 line that starts with an open brace. Lines 5 and 6 (and line 9) are | |
4474 pretty standard, and line 7 is a @code{brace-list-close} as you'd | |
4475 expect. Once again, line 8 is assigned as @code{brace-entry-open} as is | |
4476 line 10. | |
4477 | |
4478 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4479 @node External Scope Symbols, Paren List Symbols, Brace List Symbols, Syntactic Symbols | |
4480 @comment node-name, next, previous, up | |
4481 @subsection External Scope Symbols | |
4482 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4483 | |
4484 External language definition blocks also have their own syntactic | |
4485 symbols. In this example: | |
4486 | |
4487 @example | |
4488 1: extern "C" | |
4489 2: @{ | |
4490 3: int thing_one( int ); | |
4491 4: int thing_two( double ); | |
4492 5: @} | |
4493 @end example | |
4494 | |
4495 @ssindex extern-lang-open | |
4496 @ssindex extern-lang-close | |
4497 @ssindex inextern-lang | |
4498 @ssindex inclass | |
4499 @noindent | |
4500 line 2 is given the @code{extern-lang-open} syntax, while line 5 is given | |
4501 the @code{extern-lang-close} syntax. The analysis for line 3 yields: | |
4502 | |
4503 @example | |
4504 ((inextern-lang) (topmost-intro 14)) | |
4505 @end example | |
4506 | |
4507 @noindent | |
4508 where @code{inextern-lang} is a modifier similar in purpose to | |
4509 @code{inclass}. | |
4510 | |
4511 There are various other top level blocks like @code{extern}, and they | |
4512 are all treated in the same way except that the symbols are named after | |
4513 the keyword that introduces the block. E.g. C++ namespace blocks get | |
4514 the three symbols @code{namespace-open}, @code{namespace-close} and | |
4515 @code{innamespace}. The currently recognized top level blocks are: | |
4516 | |
4517 @table @asis | |
4518 @item @code{extern-lang-open}, @code{extern-lang-close}, @code{inextern-lang} | |
4519 @code{extern} blocks in C and C++.@footnote{These should logically be | |
4520 named @code{extern-open}, @code{extern-close} and @code{inextern}, but | |
4521 that isn't the case for historical reasons.} | |
4522 | |
4523 @item @code{namespace-open}, @code{namespace-close}, @code{innamespace} | |
4524 @ssindex namespace-open | |
4525 @ssindex namespace-close | |
4526 @ssindex innamespace | |
4527 @code{namespace} blocks in C++. | |
4528 | |
4529 @item @code{module-open}, @code{module-close}, @code{inmodule} | |
4530 @ssindex module-open | |
4531 @ssindex module-close | |
4532 @ssindex inmodule | |
4533 @code{module} blocks in CORBA IDL. | |
4534 | |
4535 @item @code{composition-open}, @code{composition-close}, @code{incomposition} | |
4536 @ssindex composition-open | |
4537 @ssindex composition-close | |
4538 @ssindex incomposition | |
4539 @code{composition} blocks in CORBA CIDL. | |
4540 @end table | |
4541 | |
4542 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4543 @node Paren List Symbols, Literal Symbols, External Scope Symbols, Syntactic Symbols | |
4544 @comment node-name, next, previous, up | |
4545 @subsection Parenthesis (Argument) List Symbols | |
4546 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4547 | |
4548 A number of syntactic symbols are associated with parenthesis lists, | |
4549 a.k.a argument lists, as found in function declarations and function | |
4550 calls. This example illustrates these: | |
4551 | |
4552 @example | |
4553 1: void a_function( int line1, | |
4554 2: int line2 ); | |
4555 3: | |
4556 4: void a_longer_function( | |
4557 5: int line1, | |
4558 6: int line2 | |
4559 7: ); | |
4560 8: | |
4561 9: void call_them( int line1, int line2 ) | |
4562 10: @{ | |
4563 11: a_function( | |
4564 12: line1, | |
4565 13: line2 | |
4566 14: ); | |
4567 15: | |
4568 16: a_longer_function( line1, | |
4569 17: line2 ); | |
4570 18: @} | |
4571 @end example | |
4572 | |
4573 @ssindex arglist-intro | |
4574 @ssindex arglist-close | |
4575 Lines 5 and 12 are assigned @code{arglist-intro} syntax since they are | |
4576 the first line following the open parenthesis, and lines 7 and 14 are | |
4577 assigned @code{arglist-close} syntax since they contain the parenthesis | |
4578 that closes the argument list. | |
4579 | |
4580 @ssindex arglist-cont-nonempty | |
4581 @ssindex arglist-cont | |
4582 Lines that continue argument lists can be assigned one of two syntactic | |
4583 symbols. For example, Lines 2 and 17 | |
4584 are assigned @code{arglist-cont-nonempty} syntax. What this means | |
4585 is that they continue an argument list, but that the line containing the | |
4586 parenthesis that opens the list is @emph{not empty} following the open | |
4587 parenthesis. Contrast this against lines 6 and 13 which are assigned | |
4588 @code{arglist-cont} syntax. This is because the parenthesis that opens | |
4589 their argument lists is the last character on that line. | |
4590 | |
4591 Syntactic elements with @code{arglist-intro}, | |
4592 @code{arglist-cont-nonempty}, and @code{arglist-close} contain two | |
4593 buffer positions: the anchor position (the beginning of the | |
4594 declaration or statement) and the position of the open parenthesis. | |
4595 The latter position can be used in a line-up function (@pxref{Line-Up | |
4596 Functions}). | |
4597 | |
4598 Note that there is no @code{arglist-open} syntax. This is because any | |
4599 parenthesis that opens an argument list, appearing on a separate line, | |
4600 is assigned the @code{statement-cont} syntax instead. | |
4601 | |
4602 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4603 @node Literal Symbols, Multiline Macro Symbols, Paren List Symbols, Syntactic Symbols | |
4604 @comment node-name, next, previous, up | |
4605 @subsection Comment String Label and Macro Symbols | |
4606 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4607 | |
4608 A few miscellaneous syntactic symbols that haven't been previously | |
4609 covered are illustrated by this C++ example: | |
4610 | |
4611 @example | |
4612 1: void Bass::play( int volume ) | |
4613 2: const | |
4614 3: @{ | |
4615 4: /* this line starts a multiline | |
4616 5: * comment. This line should get `c' syntax */ | |
4617 6: | |
4618 7: char* a_multiline_string = "This line starts a multiline \ | |
4619 8: string. This line should get `string' syntax."; | |
4620 9: | |
4621 10: note: | |
4622 11: @{ | |
4623 12: #ifdef LOCK | |
4624 13: Lock acquire(); | |
4625 14: #endif // LOCK | |
4626 15: slap_pop(); | |
4627 16: cout << "I played " | |
4628 17: << "a note\n"; | |
4629 18: @} | |
4630 19: @} | |
4631 @end example | |
4632 | |
4633 The lines to note in this example include: | |
4634 | |
4635 @itemize @bullet | |
4636 @item | |
4637 @ssindex func-decl-cont | |
4638 Line 2 is assigned the @code{func-decl-cont} syntax. | |
4639 | |
4640 @item | |
4641 @ssindex comment-intro | |
4642 Line 4 is assigned both @code{defun-block-intro} @emph{and} | |
4643 @code{comment-intro} syntax. A syntactic element with | |
4644 @code{comment-intro} has no anchor point --- It is always accompanied | |
4645 by another syntactic element which does have one. | |
4646 | |
4647 @item | |
4648 @ssindex c | |
4649 Line 5 is assigned @code{c} syntax. | |
4650 | |
4651 @item | |
4652 @cindex syntactic whitespace | |
4653 Line 6 which, even though it contains nothing but whitespace, is | |
4654 assigned @code{defun-block-intro}. Note that the appearance of the | |
4655 comment on lines 4 and 5 do not cause line 6 to be assigned | |
4656 @code{statement} syntax because comments are considered to be | |
4657 @dfn{syntactic whitespace}, which are ignored when analyzing | |
4658 code. | |
4659 | |
4660 @item | |
4661 @ssindex string | |
4662 Line 8 is assigned @code{string} syntax. | |
4663 | |
4664 @item | |
4665 @ssindex label | |
4666 Line 10 is assigned @code{label} syntax. | |
4667 | |
4668 @item | |
4669 @ssindex block-open | |
4670 Line 11 is assigned @code{block-open} as well as @code{statement} | |
4671 syntax. A @code{block-open} syntactic element doesn't have an anchor | |
4672 position, since it always appears with another syntactic element which | |
4673 does have one. | |
4674 | |
4675 @item | |
4676 @ssindex cpp-macro | |
4677 Lines 12 and 14 are assigned @code{cpp-macro} syntax in addition to the | |
4678 normal syntactic symbols (@code{statement-block-intro} and | |
4679 @code{statement}, respectively). Normally @code{cpp-macro} is | |
4680 configured to cancel out the normal syntactic context to make all | |
4681 preprocessor directives stick to the first column, but that's easily | |
4682 changed if you want preprocessor directives to be indented like the rest | |
4683 of the code. Like @code{comment-intro}, a syntactic element with | |
4684 @code{cpp-macro} doesn't contain an anchor position. | |
4685 | |
4686 @item | |
4687 @ssindex stream-op | |
4688 Line 17 is assigned @code{stream-op} syntax. | |
4689 @end itemize | |
4690 | |
4691 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4692 @node Multiline Macro Symbols, Objective-C Method Symbols, Literal Symbols, Syntactic Symbols | |
4693 @comment node-name, next, previous, up | |
4694 @subsection Multiline Macro Symbols | |
4695 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4696 | |
4697 @cindex multiline macros | |
4698 @cindex syntactic whitespace | |
4699 @ssindex cpp-define-intro | |
4700 @ssindex cpp-macro-cont | |
4701 Multiline preprocessor macro definitions are normally handled just like | |
4702 other code, i.e. the lines inside them are indented according to the | |
4703 syntactic analysis of the preceding lines inside the macro. The first | |
4704 line inside a macro definition (i.e. the line after the starting line of | |
4705 the cpp directive itself) gets @code{cpp-define-intro}. In this example: | |
4706 | |
4707 @example | |
4708 1: #define LIST_LOOP(cons, listp) \ | |
4709 2: for (cons = listp; !NILP (cons); cons = XCDR (cons)) \ | |
4710 3: if (!CONSP (cons)) \ | |
4711 4: signal_error ("Invalid list format", listp); \ | |
4712 5: else | |
4713 @end example | |
4714 | |
4715 @noindent | |
4716 line 1 is given the syntactic symbol @code{cpp-macro}. The first line | |
4717 of a cpp directive is always given that symbol. Line 2 is given | |
4718 @code{cpp-define-intro}, so that you can give the macro body as a whole | |
4719 some extra indentation. Lines 3 through 5 are then analyzed as normal | |
4720 code, i.e. @code{substatement} on lines 3 and 4, and @code{else-clause} | |
4721 on line 5. | |
4722 | |
4723 The syntactic analysis inside macros can be turned off with | |
4724 @code{c-syntactic-indentation-in-macros} (@pxref{Custom Macros}). In | |
4725 that case, lines 2 through 5 would all be given @code{cpp-macro-cont} | |
4726 with an anchor position pointing to the @code{#} which starts the cpp | |
4727 directive@footnote{This is how @ccmode{} 5.28 and earlier analyzed | |
4728 macros.}. | |
4729 | |
4730 @xref{Custom Macros}, for more info about the treatment of macros. | |
4731 | |
4732 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4733 @node Objective-C Method Symbols, Anonymous Class Symbol, Multiline Macro Symbols, Syntactic Symbols | |
4734 @comment node-name, next, previous, up | |
4735 @subsection Objective-C Method Symbols | |
4736 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4737 | |
4738 In Objective-C buffers, there are three additional syntactic symbols | |
4739 assigned to various message calling constructs. Here's an example | |
4740 illustrating these: | |
4741 | |
4742 @example | |
4743 1: - (void)setDelegate:anObject | |
4744 2: withStuff:stuff | |
4745 3: @{ | |
4746 4: [delegate masterWillRebind:self | |
4747 5: toDelegate:anObject | |
4748 6: withExtraStuff:stuff]; | |
4749 7: @} | |
4750 @end example | |
4751 | |
4752 @ssindex objc-method-intro | |
4753 @ssindex objc-method-args-cont | |
4754 @ssindex objc-method-call-cont | |
4755 Here, line 1 is assigned @code{objc-method-intro} syntax, and line 2 is | |
4756 assigned @code{objc-method-args-cont} syntax. Lines 5 and 6 are both | |
4757 assigned @code{objc-method-call-cont} syntax. | |
4758 | |
4759 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4760 @node Anonymous Class Symbol, Statement Block Symbols, Objective-C Method Symbols, Syntactic Symbols | |
4761 @comment node-name, next, previous, up | |
4762 @subsection Anonymous Class Symbol (Java) | |
4763 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4764 | |
4765 Java has a concept of anonymous classes which can look something like | |
4766 this: | |
4767 | |
4768 @example | |
4769 1: public void watch(Observable o) @{ | |
4770 2: o.addObserver(new Observer() @{ | |
4771 3: public void update(Observable o, Object arg) @{ | |
4772 4: history.addElement(arg); | |
4773 5: @} | |
4774 6: @}); | |
4775 7: @} | |
4776 @end example | |
4777 | |
4778 @ssindex inexpr-class | |
4779 The brace following the @code{new} operator opens the anonymous class. | |
4780 Lines 3 and 6 are assigned the @code{inexpr-class} syntax, besides the | |
4781 @code{inclass} symbol used in normal classes. Thus, the class will be | |
4782 indented just like a normal class, with the added indentation given to | |
4783 @code{inexpr-class}. An @code{inexpr-class} syntactic element doesn't | |
4784 have an anchor position. | |
4785 | |
4786 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4787 @node Statement Block Symbols, K&R Symbols, Anonymous Class Symbol, Syntactic Symbols | |
4788 @comment node-name, next, previous, up | |
4789 @subsection Statement Block Symbols | |
4790 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4791 | |
4792 There are a few occasions where a statement block might be used inside | |
4793 an expression. One is in C or C++ code using the gcc extension for | |
4794 this, e.g: | |
4795 | |
4796 @example | |
4797 1: int res = (@{ | |
4798 2: int y = foo (); int z; | |
4799 3: if (y > 0) z = y; else z = - y; | |
4800 4: z; | |
4801 5: @}); | |
4802 @end example | |
4803 | |
4804 @ssindex inexpr-statement | |
4805 Lines 2 and 5 get the @code{inexpr-statement} syntax, besides the | |
4806 symbols they'd get in a normal block. Therefore, the indentation put on | |
4807 @code{inexpr-statement} is added to the normal statement block | |
4808 indentation. An @code{inexpr-statement} syntactic element doesn't | |
4809 contain an anchor position. | |
4810 | |
4811 In Pike code, there are a few other situations where blocks occur inside | |
4812 statements, as illustrated here: | |
4813 | |
4814 @example | |
4815 1: array itgob() | |
4816 2: @{ | |
4817 3: string s = map (backtrace()[-2][3..], | |
4818 4: lambda | |
4819 5: (mixed arg) | |
4820 6: @{ | |
4821 7: return sprintf ("%t", arg); | |
4822 8: @}) * ", " + "\n"; | |
4823 9: return catch @{ | |
4824 10: write (s + "\n"); | |
4825 11: @}; | |
4826 12: @} | |
4827 @end example | |
4828 | |
4829 @ssindex inlambda | |
4830 @ssindex lambda-intro-cont | |
4831 Lines 4 through 8 contain a lambda function, which @ccmode{} recognizes | |
4832 by the @code{lambda} keyword. If the function argument list is put | |
4833 on a line of its own, as in line 5, it gets the @code{lambda-intro-cont} | |
4834 syntax. The function body is handled as an inline method body, with the | |
4835 addition of the @code{inlambda} syntactic symbol. This means that line | |
4836 6 gets @code{inlambda} and @code{inline-open}, and line 8 gets | |
4837 @code{inline-close}@footnote{You might wonder why it doesn't get | |
4838 @code{inlambda} too. It's because the closing brace is relative to the | |
4839 opening brace, which stands on its own line in this example. If the | |
4840 opening brace was hanging on the previous line, then the closing brace | |
4841 would get the @code{inlambda} syntax too to be indented correctly.}. | |
4842 | |
4843 @ssindex inexpr-statement | |
4844 On line 9, @code{catch} is a special function taking a statement block | |
4845 as its argument. The block is handled as an in-expression statement | |
4846 with the @code{inexpr-statement} syntax, just like the gcc extended C | |
4847 example above. The other similar special function, @code{gauge}, is | |
4848 handled like this too. | |
4849 | |
4850 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4851 @node K&R Symbols, , Statement Block Symbols, Syntactic Symbols | |
4852 @comment node-name, next, previous, up | |
4853 @subsection K&R Symbols | |
4854 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4855 | |
4856 @ssindex knr-argdecl-intro | |
4857 @ssindex knr-argdecl | |
4858 Two other syntactic symbols can appear in old style, non-prototyped C | |
4859 code @footnote{a.k.a. K&R C, or Kernighan & Ritchie C}: | |
4860 | |
4861 @example | |
4862 1: int add_three_integers(a, b, c) | |
4863 2: int a; | |
4864 3: int b; | |
4865 4: int c; | |
4866 5: @{ | |
4867 6: return a + b + c; | |
4868 7: @} | |
4869 @end example | |
4870 | |
4871 Here, line 2 is the first line in an argument declaration list and so is | |
4872 given the @code{knr-argdecl-intro} syntactic symbol. Subsequent lines | |
4873 (i.e. lines 3 and 4 in this example), are given @code{knr-argdecl} | |
4874 syntax. | |
4875 | |
4876 | |
4877 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4878 @node Indentation Calculation, , Syntactic Symbols, Indentation Engine Basics | |
4879 @comment node-name, next, previous, up | |
4880 @section Indentation Calculation | |
4881 @cindex indentation | |
4882 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4883 | |
4884 Indentation for a line is calculated from the syntactic context | |
4885 (@pxref{Syntactic Analysis}). | |
4886 | |
4887 First, a buffer position is found whose column will be the base for the | |
4888 indentation calculation. It's the anchor position in the first | |
4889 syntactic element that provides one that is used. If no syntactic | |
4890 element has an anchor position then column zero is used. | |
4891 | |
4892 Second, the syntactic symbols in each syntactic element are looked up | |
4893 in the @code{c-offsets-alist} style variable | |
4894 (@pxref{c-offsets-alist}), which is an association list of syntactic | |
4895 symbols and the offsets to apply for those symbols. These offsets are | |
4896 added together with the base column to produce the new indentation | |
4897 column. | |
4898 | |
4899 Let's use our two code examples above to see how this works. Here is | |
4900 our first example again: | |
4901 | |
4902 @example | |
4903 1: void swap( int& a, int& b ) | |
4904 2: @{ | |
4905 3: int tmp = a; | |
4906 4: a = b; | |
4907 5: b = tmp; | |
4908 6: @} | |
4909 @end example | |
4910 | |
4911 Let's say point is on line 3 and we hit the @key{TAB} key to reindent | |
4912 the line. The syntactic context for that line is: | |
4913 | |
4914 @example | |
4915 ((defun-block-intro 29)) | |
4916 @end example | |
4917 | |
4918 @noindent | |
4919 Since buffer position 29 is the first and only anchor position in the | |
4920 list, @ccmode{} goes there and asks for the current column. This brace | |
4921 is in column zero, so @ccmode{} uses @samp{0} as the base column. | |
4922 | |
4923 Next, @ccmode{} looks up @code{defun-block-intro} in the | |
4924 @code{c-offsets-alist} style variable. Let's say it finds the value | |
4925 @samp{4}; it adds this to the base column @samp{0}, yielding a running | |
4926 total indentation of 4 spaces. | |
4927 | |
4928 Since there is only one syntactic element on the list for this line, | |
4929 indentation calculation is complete, and the total indentation for the | |
4930 line is 4 spaces. | |
4931 | |
4932 Here's another example: | |
4933 | |
4934 @example | |
4935 1: int add( int val, int incr, int doit ) | |
4936 2: @{ | |
4937 3: if( doit ) | |
4938 4: @{ | |
4939 5: return( val + incr ); | |
4940 6: @} | |
4941 7: return( val ); | |
4942 8: @} | |
4943 @end example | |
4944 | |
4945 If we were to hit @kbd{TAB} on line 4 in the above example, the same | |
4946 basic process is performed, despite the differences in the syntactic | |
4947 context. The context for this line is: | |
4948 | |
4949 @example | |
4950 ((substatement-open 46)) | |
4951 @end example | |
4952 | |
4953 Here, @ccmode{} goes to buffer position 46, which is the @samp{i} in | |
4954 @code{if} on line 3. This character is in the fourth column on that | |
4955 line so the base column is @samp{4}. Then @ccmode{} looks up the | |
4956 @code{substatement-open} symbol in @code{c-offsets-alist}. Let's say it | |
4957 finds the value @samp{4}. It's added with the base column and yields an | |
4958 indentation for the line of 8 spaces. | |
4959 | |
4960 Simple, huh? | |
4961 | |
4962 Actually, it's a bit more complicated than that since the entries on | |
4963 @code{c-offsets-alist} can be much more than plain offsets. | |
4964 @xref{c-offsets-alist}, for the full story. | |
4965 | |
4966 Anyway, the mode usually just does The Right Thing without you having to | |
4967 think about it in this much detail. But when customizing indentation, | |
4968 it's helpful to understand the general indentation model being used. | |
4969 | |
4970 As you configure @ccmode{}, you might want to set the variable | |
4971 @code{c-echo-syntactic-information-p} to non-@code{nil} so that the | |
4972 syntactic context and calculated offset always is echoed in the | |
4973 minibuffer when you hit @kbd{TAB}. | |
4974 | |
4975 | |
4976 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4977 @node Customizing Indentation, Custom Macros, Indentation Engine Basics, Top | |
4978 @comment node-name, next, previous, up | |
4979 @chapter Customizing Indentation | |
4980 @cindex customization, indentation | |
4981 @cindex indentation | |
4982 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
4983 | |
4984 The principal variable for customizing indentation is the style | |
4985 variable @code{c-offsets-alist}, which gives an @dfn{offset} (an | |
4986 indentation rule) for each syntactic symbol. Its structure and | |
4987 semantics are completely described in @ref{c-offsets-alist}. The | |
4988 various ways you can set the variable, including the use of the | |
4989 @ccmode{} style system, are described in @ref{Config Basics} and its | |
4990 sections, in particular @ref{Style Variables}. | |
4991 | |
4992 The simplest and most used kind of ``offset'' setting in | |
4993 @code{c-offsets-alist} is in terms of multiples of | |
4994 @code{c-basic-offset}: | |
4995 | |
4996 @defopt c-basic-offset | |
4997 @vindex basic-offset (c-) | |
4998 This style variable holds the basic offset between indentation levels. | |
4999 It's factory default is 4, but all the built-in styles set it | |
5000 themselves, to some value between 2 (for @code{gnu} style) and 8 (for | |
5001 @code{bsd}, @code{linux}, and @code{python} styles). | |
5002 @end defopt | |
5003 | |
5004 The most flexible ``offset'' setting you can make in | |
5005 @code{c-offsets-alist} is a line-up function (or even a list of them), | |
5006 either one supplied by @ccmode{} (@pxref{Line-Up Functions}) or one | |
5007 you write yourself (@pxref{Custom Line-Up}). | |
5008 | |
5009 Finally, in @ref{Other Indentation} you'll find the tool of last | |
5010 resort: a hook which is called after a line has been indented. You | |
5011 can install functions here to make ad-hoc adjustments to any line's | |
5012 indentation. | |
5013 | |
5014 @menu | |
5015 * c-offsets-alist:: | |
5016 * Interactive Customization:: | |
5017 * Line-Up Functions:: | |
5018 * Custom Line-Up:: | |
5019 * Other Indentation:: | |
5020 @end menu | |
5021 | |
5022 | |
5023 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
5024 @node c-offsets-alist, Interactive Customization, Customizing Indentation, Customizing Indentation | |
5025 @comment node-name, next, previous, up | |
5026 @section c-offsets-alist | |
5027 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
5028 | |
5029 This section explains the structure and semantics of the style | |
5030 variable @code{c-offset-alist}, the principal variable for configuring | |
5031 indentation. Details of how to set it up, and its relationship to | |
5032 @ccmode{}'s style system are given in @ref{Style Variables}. | |
5033 | |
5034 @defopt c-offsets-alist | |
5035 @vindex offsets-alist (c-) | |
5036 This is an alist which associates an offset with each syntactic | |
5037 symbol. This @dfn{offset} is a rule specifying how to indent a line | |
5038 whose syntactic context matches the symbol. @xref{Syntactic | |
5039 Analysis}. | |
5040 | |
5041 Note that the buffer-local binding of this alist in a @ccmode{} buffer | |
5042 contains an entry for @emph{every} syntactic symbol. Its global | |
5043 binding and its settings within style specifications usually contain | |
5044 only a few entries. @xref{Style Variables}. | |
5045 | |
5046 The offset specification associated with any particular syntactic | |
5047 symbol can be an integer, a variable name, a vector, a function or | |
5048 lambda expression, a list, or one of the following special symbols: | |
5049 @code{+}, @code{-}, @code{++}, @code{--}, @code{*}, or @code{/}. The | |
5050 meanings of these values are described in detail below. | |
5051 | |
5052 Here is an example fragment of a @code{c-offsets-alist}, showing some | |
5053 of these kinds of offsets: | |
5054 | |
5055 @example | |
5056 ((statement . 0) | |
5057 (substatement . +) | |
5058 (cpp-macro . [0]) | |
5059 (topmost-intro-cont . c-lineup-topmost-intro-cont) | |
5060 (statement-block-intro . (add c-lineup-whitesmith-in-block | |
5061 c-indent-multi-line-block)) | |
5062 @dots{} | |
5063 @*) | |
5064 @end example | |
5065 @end defopt | |
5066 | |
5067 @deffn Command c-set-offset (@kbd{C-c C-o}) | |
5068 @findex set-offset (c-) | |
5069 @kindex C-c C-o | |
5070 This command changes the entry for a syntactic symbol in the current | |
5071 binding of @code{c-offsets-alist}, or it inserts a new entry if there | |
5072 isn't already one for that syntactic symbol. | |
5073 | |
5074 You can use @code{c-set-offsets} interactively within a @ccmode{} | |
5075 buffer to make experimental changes to your indentation settings. | |
5076 @kbd{C-c C-o} prompts you for the syntactic symbol to change | |
5077 (defaulting to that of the current line) and the new offset | |
5078 (defaulting to the current offset). | |
5079 | |
5080 @code{c-set-offsets} takes two arguments when used programmatically: | |
5081 @var{symbol}, the syntactic element symbol to change and @var{offset}, | |
5082 the new offset for that syntactic element. You can call the command | |
5083 in your @file{.emacs} to change the global binding of | |
5084 @code{c-offsets-alist} (@pxref{Style Variables}); you can use it in a | |
5085 hook function to make changes from the current style. @ccmode{} | |
5086 itself uses this function when initializing styles. | |
5087 @end deffn | |
5088 | |
5089 @cindex offset specification | |
5090 The ``offset specifications'' in @code{c-offsets-alist} can be any of | |
5091 the following: | |
5092 | |
5093 @table @asis | |
5094 @item An integer | |
5095 The integer specifies a relative offset. All relative | |
5096 offsets@footnote{The syntactic context @code{@w{((defun-block-intro | |
5097 2724) (comment-intro))}} would likely have two relative offsets.} will | |
5098 be added together and used to calculate the indentation relative to an | |
5099 anchor position earlier in the buffer. @xref{Indentation | |
5100 Calculation}, for details. Most of the time, it's probably better to | |
5101 use one of the special symbols like @code{+} than an integer (apart | |
5102 from zero). | |
5103 | |
5104 @item One of the symbols @code{+}, @code{-}, @code{++}, @code{--}, @code{*}, or @code{/} | |
5105 These special symbols describe a relative offset in multiples of | |
5106 @code{c-basic-offset}: | |
5107 | |
5108 By defining a style's indentation in terms of @code{c-basic-offset}, | |
5109 you can change the amount of whitespace given to an indentation level | |
5110 while maintaining the same basic shape of your code. Here are the | |
5111 values that the special symbols correspond to: | |
5112 | |
5113 @table @code | |
5114 @item + | |
5115 @code{c-basic-offset} times 1 | |
5116 @item - | |
5117 @code{c-basic-offset} times -1 | |
5118 @item ++ | |
5119 @code{c-basic-offset} times 2 | |
5120 @item -- | |
5121 @code{c-basic-offset} times -2 | |
5122 @item * | |
5123 @code{c-basic-offset} times 0.5 | |
5124 @item / | |
5125 @code{c-basic-offset} times -0.5 | |
5126 @end table | |
5127 | |
5128 @item A vector | |
5129 The first element of the vector, an integer, sets the absolute | |
5130 indentation column. This will override any previously calculated | |
5131 indentation, but won't override relative indentation calculated from | |
5132 syntactic elements later on in the syntactic context of the line being | |
5133 indented. @xref{Indentation Calculation}. Any elements in the vector | |
5134 beyond the first will be ignored. | |
5135 | |
5136 @item A function or lambda expression | |
5137 The function will be called and its return value will in turn be | |
5138 evaluated as an offset specification. Functions are useful when more | |
5139 context than just the syntactic symbol is needed to get the desired | |
5140 indentation. @xref{Line-Up Functions}, and @ref{Custom Line-Up}, for | |
5141 details about them. | |
5142 | |
5143 @item A symbol with a variable binding | |
5144 If the symbol also has a function binding, the function takes | |
5145 precedence over the variable. Otherwise the value of the variable is | |
5146 used. It must be an integer (which is used as relative offset) or a | |
5147 vector (an absolute offset). | |
5148 | |
5149 @item A list | |
5150 The offset can also be a list containing several offset | |
5151 specifications; these are evaluated recursively and combined. A list | |
5152 is typically only useful when some of the offsets are line-up | |
5153 functions. A common strategy is calling a sequence of functions in | |
5154 turn until one of them recognizes that it is appropriate for the | |
5155 source line and returns a non-@code{nil} value. | |
5156 | |
5157 @code{nil} values are always ignored when the offsets are combined. | |
5158 The first element of the list specifies the method of combining the | |
5159 non-@code{nil} offsets from the remaining elements: | |
5160 | |
5161 @table @code | |
5162 @item first | |
5163 Use the first offset that doesn't evaluate to @code{nil}. Subsequent | |
5164 elements of the list don't get evaluated. | |
5165 @item min | |
5166 Use the minimum of all the offsets. All must be either relative or | |
5167 absolute - they can't be mixed. | |
5168 @item max | |
5169 Use the maximum of all the offsets. All must be either relative or | |
5170 absolute - they can't be mixed. | |
5171 @item add | |
5172 Add all the evaluated offsets together. Exactly one of them may be | |
5173 absolute, in which case the result is absolute. Any relative offsets | |
5174 that preceded the absolute one in the list will be ignored in that case. | |
5175 @end table | |
5176 | |
5177 As a compatibility measure, if the first element is none of the above | |
5178 then it too will be taken as an offset specification and the whole list | |
5179 will be combined according to the method @code{first}. | |
5180 @end table | |
5181 | |
5182 @vindex c-strict-syntax-p | |
5183 @vindex strict-syntax-p (c-) | |
5184 If an offset specification evaluates to @code{nil}, then a relative | |
5185 offset of 0 (zero) is used@footnote{There is however a variable | |
5186 @code{c-strict-syntax-p} that when set to non-@code{nil} will cause an | |
5187 error to be signaled in that case. It's now considered obsolete since | |
5188 it doesn't work well with some of the alignment functions that return | |
5189 @code{nil} instead of zero. You should therefore leave | |
5190 @code{c-strict-syntax-p} set to @code{nil}.}. | |
5191 | |
5192 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
5193 @node Interactive Customization, Line-Up Functions, c-offsets-alist, Customizing Indentation | |
5194 @comment node-name, next, previous, up | |
5195 @section Interactive Customization | |
5196 @cindex customization, interactive | |
5197 @cindex interactive customization | |
5198 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
5199 | |
5200 As an example of how to customize indentation, let's change the | |
5201 style of this example@footnote{In this and subsequent examples, the | |
5202 original code is formatted using the @samp{gnu} style unless otherwise | |
5203 indicated. @xref{Styles}.}: | |
5204 | |
5205 @example | |
5206 @group | |
5207 1: int add( int val, int incr, int doit ) | |
5208 2: @{ | |
5209 3: if( doit ) | |
5210 4: @{ | |
5211 5: return( val + incr ); | |
5212 6: @} | |
5213 7: return( val ); | |
5214 8: @} | |
5215 @end group | |
5216 @end example | |
5217 | |
5218 @noindent | |
5219 to: | |
5220 | |
5221 @example | |
5222 @group | |
5223 1: int add( int val, int incr, int doit ) | |
5224 2: @{ | |
5225 3: if( doit ) | |
5226 4: @{ | |
5227 5: return( val + incr ); | |
5228 6: @} | |
5229 7: return( val ); | |
5230 8: @} | |
5231 @end group | |
5232 @end example | |
5233 | |
5234 In other words, we want to change the indentation of braces that open a | |
5235 block following a condition so that the braces line up under the | |
5236 conditional, instead of being indented. Notice that the construct we | |
5237 want to change starts on line 4. To change the indentation of a line, | |
5238 we need to see which syntactic symbols affect the offset calculations | |
5239 for that line. Hitting @kbd{C-c C-s} on line 4 yields: | |
5240 | |
5241 @example | |
5242 ((substatement-open 44)) | |
5243 @end example | |
5244 | |
5245 @noindent | |
5246 so we know that to change the offset of the open brace, we need to | |
5247 change the indentation for the @code{substatement-open} syntactic | |
5248 symbol. | |
5249 | |
5250 To do this interactively, just hit @kbd{C-c C-o}. This prompts | |
5251 you for the syntactic symbol to change, providing a reasonable default. | |
5252 In this case, the default is @code{substatement-open}, which is just the | |
5253 syntactic symbol we want to change! | |
5254 | |
5255 After you hit return, @ccmode{} will then prompt you for the new | |
5256 offset value, with the old value as the default. The default in this | |
5257 case is @samp{+}, but we want no extra indentation so enter | |
5258 @samp{0} and @kbd{RET}. This will associate the offset 0 with the | |
5259 syntactic symbol @code{substatement-open}. | |
5260 | |
5261 To check your changes quickly, just hit @kbd{C-c C-q} | |
5262 (@code{c-indent-defun}) to reindent the entire function. The example | |
5263 should now look like: | |
5264 | |
5265 @example | |
5266 @group | |
5267 1: int add( int val, int incr, int doit ) | |
5268 2: @{ | |
5269 3: if( doit ) | |
5270 4: @{ | |
5271 5: return( val + incr ); | |
5272 6: @} | |
5273 7: return( val ); | |
5274 8: @} | |
5275 @end group | |
5276 @end example | |
5277 | |
5278 Notice how just changing the open brace offset on line 4 is all we | |
5279 needed to do. Since the other affected lines are indented relative to | |
5280 line 4, they are automatically indented the way you'd expect. For more | |
5281 complicated examples, this might not always work. The general approach | |
5282 to take is to always start adjusting offsets for lines higher up in the | |
5283 file, then reindent and see if any following lines need further | |
5284 adjustments. | |
5285 | |
5286 @c Move this bit to "Styles" (2005/10/7) | |
5287 @deffn Command c-set-offset symbol offset | |
5288 @findex set-offset (c-) | |
5289 @kindex C-c C-o | |
5290 This is the command bound to @kbd{C-c C-o}. It provides a convenient | |
5291 way to set offsets on @code{c-offsets-alist} both interactively (see | |
5292 the example above) and from your mode hook. | |
5293 | |
5294 It takes two arguments when used programmatically: @var{symbol} is the | |
5295 syntactic element symbol to change and @var{offset} is the new offset | |
5296 for that syntactic element. | |
5297 @end deffn | |
5298 @c End of MOVE THIS BIT. | |
5299 | |
5300 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
5301 @node Line-Up Functions, Custom Line-Up, Interactive Customization, Customizing Indentation | |
5302 @comment node-name, next, previous, up | |
5303 @section Line-Up Functions | |
5304 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
5305 | |
5306 @cindex line-up function | |
5307 @cindex indentation function | |
5308 Often there are cases when a simple offset setting on a syntactic | |
5309 symbol isn't enough to get the desired indentation---for example, you | |
5310 might want to line up a closing parenthesis with the matching opening | |
5311 one rather than indenting relative to its ``anchor point''. @ccmode{} | |
5312 provides this flexibility with @dfn{line-up functions}. | |
5313 | |
5314 The way you associate a line-up function with a syntactic symbol is | |
5315 described in @ref{c-offsets-alist}. @ccmode{} comes with many | |
5316 predefined line-up functions for common situations. If none of these | |
5317 does what you want, you can write your own. @xref{Custom Line-Up}. | |
5318 Sometimes, it is easier to tweak the standard indentation by adding a | |
5319 function to @code{c-special-indent-hook} (@pxref{Other Indentation}). | |
5320 | |
5321 The line-up functions haven't been adapted for AWK buffers or tested | |
5322 with them. Some of them might work serendipitously. There shouldn't be | |
5323 any problems writing custom line-up functions for AWK mode. | |
5324 | |
5325 The calling convention for line-up functions is described fully in | |
5326 @ref{Custom Line-Up}. Roughly speaking, the return value is either an | |
5327 offset itself (such as @code{+} or @code{[0]}) or it's @code{nil}, | |
5328 meaning ``this function is inappropriate in this case - try a | |
5329 different one''. @xref{c-offsets-alist}. | |
5330 | |
5331 The subsections below describe all the standard line-up functions, | |
5332 categorized by the sort of token the lining-up centers around. For | |
5333 each of these functions there is a ``works with'' list that indicates | |
5334 which syntactic symbols the function is intended to be used with. | |
5335 | |
5336 @macro workswith | |
5337 @emph{Works with:@ } | |
5338 @end macro | |
5339 @ifinfo | |
5340 @unmacro workswith | |
5341 @macro workswith | |
5342 Works with: | |
5343 @end macro | |
5344 @end ifinfo | |
5345 | |
5346 @macro sssTBasicOffset | |
5347 <--> @i{c-basic-offset}@c | |
5348 @end macro | |
5349 | |
5350 @macro sssTsssTBasicOffset | |
5351 <--><--> @i{c-basic-offset}@c | |
5352 @end macro | |
5353 | |
5354 @macro hereFn{func} | |
5355 <- @i{\func\}@c | |
5356 @end macro | |
5357 | |
5358 @c The TeX backend seems to insert extra spaces around the argument. :P | |
5359 @iftex | |
5360 @unmacro hereFn | |
5361 @macro hereFn{func} | |
5362 <-@i{\func\}@c | |
5363 @end macro | |
5364 @end iftex | |
5365 | |
5366 @menu | |
5367 * Brace/Paren Line-Up:: | |
5368 * List Line-Up:: | |
5369 * Operator Line-Up:: | |
5370 * Comment Line-Up:: | |
5371 * Misc Line-Up:: | |
5372 @end menu | |
5373 | |
5374 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
5375 @node Brace/Paren Line-Up, List Line-Up, Line-Up Functions, Line-Up Functions | |
5376 @comment node-name, next, previous, up | |
5377 @subsection Brace and Parenthesis Line-Up Functions | |
5378 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
5379 | |
5380 The line-up functions here calculate the indentation for braces, | |
5381 parentheses and statements within brace blocks. | |
5382 | |
5383 @defun c-lineup-close-paren | |
5384 @findex lineup-close-paren (c-) | |
5385 Line up the closing paren under its corresponding open paren if the | |
5386 open paren is followed by code. If the open paren ends its line, no | |
5387 indentation is added. E.g: | |
5388 | |
5389 @example | |
5390 @group | |
5391 main (int, | |
5392 char ** | |
5393 ) @hereFn{c-lineup-close-paren} | |
5394 @end group | |
5395 @end example | |
5396 | |
5397 @noindent | |
5398 and | |
5399 | |
5400 @example | |
5401 @group | |
5402 main ( | |
5403 int, char ** | |
5404 ) @hereFn{c-lineup-close-paren} | |
5405 @end group | |
5406 @end example | |
5407 | |
5408 As a special case, if a brace block is opened at the same line as the | |
5409 open parenthesis of the argument list, the indentation is | |
5410 @code{c-basic-offset} instead of the open paren column. See | |
5411 @code{c-lineup-arglist} for further discussion of this ``DWIM'' measure. | |
5412 | |
5413 @workswith All @code{*-close} symbols. | |
5414 @end defun | |
5415 | |
5416 @comment ------------------------------------------------------------ | |
5417 | |
5418 @anchor{c-lineup-arglist-close-under-paren} | |
5419 @defun c-lineup-arglist-close-under-paren | |
5420 @findex lineup-arglist-close-under-paren (c-) | |
5421 Set your @code{arglist-close} syntactic symbol to this line-up function | |
5422 so that parentheses that close argument lists will line up under the | |
5423 parenthesis that opened the argument list. It can also be used with | |
5424 @code{arglist-cont} and @code{arglist-cont-nonempty} to line up all | |
5425 lines inside a parenthesis under the open paren. | |
5426 | |
5427 As a special case, if a brace block is opened at the same line as the | |
5428 open parenthesis of the argument list, the indentation is | |
5429 @code{c-basic-offset} only. See @code{c-lineup-arglist} for further | |
5430 discussion of this ``DWIM'' measure. | |
5431 | |
5432 @workswith Almost all symbols, but are typically most useful on | |
5433 @code{arglist-close}, @code{brace-list-close}, @code{arglist-cont} and | |
5434 @code{arglist-cont-nonempty}. | |
5435 @end defun | |
5436 | |
5437 @comment ------------------------------------------------------------ | |
5438 | |
5439 @defun c-indent-one-line-block | |
5440 @findex indent-one-line-block (c-) | |
5441 Indent a one line block @code{c-basic-offset} extra. E.g: | |
5442 | |
5443 @example | |
5444 @group | |
5445 if (n > 0) | |
5446 @{m+=n; n=0;@} @hereFn{c-indent-one-line-block} | |
5447 @sssTBasicOffset{} | |
5448 @end group | |
5449 @end example | |
5450 | |
5451 @noindent | |
5452 and | |
5453 | |
5454 @example | |
5455 @group | |
5456 if (n > 0) | |
5457 @{ @hereFn{c-indent-one-line-block} | |
5458 m+=n; n=0; | |
5459 @} | |
5460 @end group | |
5461 @end example | |
5462 | |
5463 The block may be surrounded by any kind of parenthesis characters. | |
5464 @code{nil} is returned if the line doesn't start with a one line block, | |
5465 which makes the function usable in list expressions. | |
5466 | |
5467 @workswith Almost all syntactic symbols, but most useful on the | |
5468 @code{-open} symbols. | |
5469 @end defun | |
5470 | |
5471 @comment ------------------------------------------------------------ | |
5472 | |
5473 @defun c-indent-multi-line-block | |
5474 @findex indent-multi-line-block (c-) | |
5475 Indent a multiline block @code{c-basic-offset} extra. E.g: | |
5476 | |
5477 @example | |
5478 @group | |
5479 int *foo[] = @{ | |
5480 NULL, | |
5481 @{17@}, @hereFn{c-indent-multi-line-block} | |
5482 @end group | |
5483 @end example | |
5484 | |
5485 @noindent | |
5486 and | |
5487 | |
5488 @example | |
5489 @group | |
5490 int *foo[] = @{ | |
5491 NULL, | |
5492 @{ @hereFn{c-indent-multi-line-block} | |
5493 17 | |
5494 @}, | |
5495 @sssTBasicOffset{} | |
5496 @end group | |
5497 @end example | |
5498 | |
5499 The block may be surrounded by any kind of parenthesis characters. | |
5500 @code{nil} is returned if the line doesn't start with a multiline | |
5501 block, which makes the function usable in list expressions. | |
5502 | |
5503 @workswith Almost all syntactic symbols, but most useful on the | |
5504 @code{-open} symbols. | |
5505 @end defun | |
5506 | |
5507 @comment ------------------------------------------------------------ | |
5508 | |
5509 @defun c-lineup-runin-statements | |
5510 @findex lineup-runin-statements (c-) | |
5511 Line up statements for coding standards which place the first statement | |
5512 in a block on the same line as the block opening brace@footnote{Run-in | |
5513 style doesn't really work too well. You might need to write your own | |
5514 custom line-up functions to better support this style.}. E.g: | |
5515 | |
5516 @example | |
5517 @group | |
5518 int main() | |
5519 @{ puts ("Hello!"); | |
5520 return 0; @hereFn{c-lineup-runin-statements} | |
5521 @} | |
5522 @end group | |
5523 @end example | |
5524 | |
5525 If there is no statement after the opening brace to align with, | |
5526 @code{nil} is returned. This makes the function usable in list | |
5527 expressions. | |
5528 | |
5529 @workswith The @code{statement} syntactic symbol. | |
5530 @end defun | |
5531 | |
5532 @comment ------------------------------------------------------------ | |
5533 | |
5534 @defun c-lineup-inexpr-block | |
5535 @findex lineup-inexpr-block (c-) | |
5536 This can be used with the in-expression block symbols to indent the | |
5537 whole block to the column where the construct is started. E.g. for Java | |
5538 anonymous classes, this lines up the class under the @samp{new} keyword, | |
5539 and in Pike it lines up the lambda function body under the @samp{lambda} | |
5540 keyword. Returns @code{nil} if the block isn't part of such a | |
5541 construct. | |
5542 | |
5543 @workswith @code{inlambda}, @code{inexpr-statement}, | |
5544 @code{inexpr-class}. | |
5545 @end defun | |
5546 | |
5547 @comment ------------------------------------------------------------ | |
5548 | |
5549 @defun c-lineup-after-whitesmith-blocks | |
5550 @findex lineup-after-whitesmith-blocks (c-) | |
5551 Compensate for Whitesmith style indentation of blocks. Due to the way | |
5552 @ccmode{} calculates anchor positions for normal lines inside blocks, | |
5553 this function is necessary for those lines to get correct Whitesmith | |
5554 style indentation. Consider the following examples: | |
5555 | |
5556 @example | |
5557 @group | |
5558 int foo() | |
5559 @{ | |
5560 a; | |
5561 x; @hereFn{c-lineup-after-whitesmith-blocks} | |
5562 @end group | |
5563 @end example | |
5564 | |
5565 @example | |
5566 @group | |
5567 int foo() | |
5568 @{ | |
5569 @{ | |
5570 a; | |
5571 @} | |
5572 x; @hereFn{c-lineup-after-whitesmith-blocks} | |
5573 @end group | |
5574 @end example | |
5575 | |
5576 The fact that the line with @code{x} is preceded by a Whitesmith style | |
5577 indented block in the latter case and not the first should not affect | |
5578 its indentation. But since CC Mode in cases like this uses the | |
5579 indentation of the preceding statement as anchor position, the @code{x} | |
5580 would in the second case be indented too much if the offset for | |
5581 @code{statement} was set simply to zero. | |
5582 | |
5583 This lineup function corrects for this situation by detecting if the | |
5584 anchor position is at an open paren character. In that case, it instead | |
5585 indents relative to the surrounding block just like | |
5586 @code{c-lineup-whitesmith-in-block}. | |
5587 | |
5588 @workswith @code{brace-list-entry}, @code{brace-entry-open}, | |
5589 @code{statement}, @code{arglist-cont}. | |
5590 @end defun | |
5591 | |
5592 @comment ------------------------------------------------------------ | |
5593 | |
5594 @defun c-lineup-whitesmith-in-block | |
5595 @findex lineup-whitesmith-in-block (c-) | |
5596 Line up lines inside a block in Whitesmith style. It's done in a way | |
5597 that works both when the opening brace hangs and when it doesn't. E.g: | |
5598 | |
5599 @example | |
5600 @group | |
5601 something | |
5602 @{ | |
5603 foo; @hereFn{c-lineup-whitesmith-in-block} | |
5604 @} | |
5605 @end group | |
5606 @end example | |
5607 | |
5608 @noindent | |
5609 and | |
5610 | |
5611 @example | |
5612 @group | |
5613 something @{ | |
5614 foo; @hereFn{c-lineup-whitesmith-in-block} | |
5615 @} | |
5616 @sssTBasicOffset{} | |
5617 @end group | |
5618 @end example | |
5619 | |
5620 In the first case the indentation is kept unchanged, in the second | |
5621 @code{c-basic-offset} is added. | |
5622 | |
5623 @workswith @code{defun-close}, @code{defun-block-intro}, | |
5624 @code{inline-close}, @code{block-close}, @code{brace-list-close}, | |
5625 @code{brace-list-intro}, @code{statement-block-intro}, | |
5626 @code{arglist-intro}, @code{arglist-cont-nonempty}, | |
5627 @code{arglist-close}, and all @code{in*} symbols, e.g. @code{inclass} | |
5628 and @code{inextern-lang}. | |
5629 @end defun | |
5630 | |
5631 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
5632 @node List Line-Up, Operator Line-Up, Brace/Paren Line-Up, Line-Up Functions | |
5633 @comment node-name, next, previous, up | |
5634 @subsection List Line-Up Functions | |
5635 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
5636 | |
5637 The line-up functions here calculate the indentation for lines which | |
5638 form lists of items, usually separated by commas. | |
5639 | |
5640 The function @ref{c-lineup-arglist-close-under-paren}, which is mainly | |
5641 for indenting a close parenthesis, is also useful for the lines | |
5642 contained within parentheses. | |
5643 | |
5644 @defun c-lineup-arglist | |
5645 @findex lineup-arglist (c-) | |
5646 Line up the current argument line under the first argument. | |
5647 | |
5648 As a special case, if an argument on the same line as the open | |
5649 parenthesis starts with a brace block opener, the indentation is | |
5650 @code{c-basic-offset} only. This is intended as a ``DWIM'' measure in | |
5651 cases like macros that contain statement blocks, e.g: | |
5652 | |
5653 @example | |
5654 @group | |
5655 A_VERY_LONG_MACRO_NAME (@{ | |
5656 some (code, with + long, lines * in[it]); | |
5657 @}); | |
5658 @sssTBasicOffset{} | |
5659 @end group | |
5660 @end example | |
5661 | |
5662 This is motivated partly because it's more in line with how code | |
5663 blocks are handled, and partly since it approximates the behavior of | |
5664 earlier CC Mode versions, which due to inaccurate analysis tended to | |
5665 indent such cases this way. | |
5666 | |
5667 @workswith @code{arglist-cont-nonempty}, @code{arglist-close}. | |
5668 @end defun | |
5669 | |
5670 @comment ------------------------------------------------------------ | |
5671 | |
5672 @defun c-lineup-arglist-intro-after-paren | |
5673 @findex lineup-arglist-intro-after-paren (c-) | |
5674 Line up a line to just after the open paren of the surrounding paren or | |
5675 brace block. | |
5676 | |
5677 @workswith @code{defun-block-intro}, @code{brace-list-intro}, | |
5678 @code{statement-block-intro}, @code{statement-case-intro}, | |
5679 @code{arglist-intro}. | |
5680 @end defun | |
5681 | |
5682 @comment ------------------------------------------------------------ | |
5683 | |
5684 @defun c-lineup-multi-inher | |
5685 @findex lineup-multi-inher (c-) | |
5686 Line up the classes in C++ multiple inheritance clauses and member | |
5687 initializers under each other. E.g: | |
5688 | |
5689 @example | |
5690 @group | |
5691 Foo::Foo (int a, int b): | |
5692 Cyphr (a), | |
5693 Bar (b) @hereFn{c-lineup-multi-inher} | |
5694 @end group | |
5695 @end example | |
5696 | |
5697 @noindent | |
5698 and | |
5699 | |
5700 @example | |
5701 @group | |
5702 class Foo | |
5703 : public Cyphr, | |
5704 public Bar @hereFn{c-lineup-multi-inher} | |
5705 @end group | |
5706 @end example | |
5707 | |
5708 @noindent | |
5709 and | |
5710 | |
5711 @example | |
5712 @group | |
5713 Foo::Foo (int a, int b) | |
5714 : Cyphr (a) | |
5715 , Bar (b) @hereFn{c-lineup-multi-inher} | |
5716 @end group | |
5717 @end example | |
5718 | |
5719 @workswith @code{inher-cont}, @code{member-init-cont}. | |
5720 @end defun | |
5721 | |
5722 @comment ------------------------------------------------------------ | |
5723 | |
5724 @defun c-lineup-java-inher | |
5725 @findex lineup-java-inher (c-) | |
5726 Line up Java implements and extends declarations. If class names | |
5727 follow on the same line as the @samp{implements}/@samp{extends} | |
5728 keyword, they are lined up under each other. Otherwise, they are | |
5729 indented by adding @code{c-basic-offset} to the column of the keyword. | |
5730 E.g: | |
5731 | |
5732 @example | |
5733 @group | |
5734 class Foo | |
5735 extends | |
5736 Bar @hereFn{c-lineup-java-inher} | |
5737 @sssTBasicOffset{} | |
5738 @end group | |
5739 @end example | |
5740 | |
5741 @noindent | |
5742 and | |
5743 | |
5744 @example | |
5745 @group | |
5746 class Foo | |
5747 extends Cyphr, | |
5748 Bar @hereFn{c-lineup-java-inher} | |
5749 @end group | |
5750 @end example | |
5751 | |
5752 @workswith @code{inher-cont}. | |
5753 @end defun | |
5754 | |
5755 @comment ------------------------------------------------------------ | |
5756 | |
5757 @defun c-lineup-java-throws | |
5758 @findex lineup-java-throws (c-) | |
5759 Line up Java throws declarations. If exception names follow on the | |
5760 same line as the throws keyword, they are lined up under each other. | |
5761 Otherwise, they are indented by adding @code{c-basic-offset} to the | |
5762 column of the @samp{throws} keyword. The @samp{throws} keyword itself | |
5763 is also indented by @code{c-basic-offset} from the function declaration | |
5764 start if it doesn't hang. E.g: | |
5765 | |
5766 @example | |
5767 @group | |
5768 int foo() | |
5769 throws @hereFn{c-lineup-java-throws} | |
5770 Bar @hereFn{c-lineup-java-throws} | |
5771 @sssTsssTBasicOffset{} | |
5772 @end group | |
5773 @end example | |
5774 | |
5775 @noindent | |
5776 and | |
5777 | |
5778 @example | |
5779 @group | |
5780 int foo() throws Cyphr, | |
5781 Bar, @hereFn{c-lineup-java-throws} | |
5782 Vlod @hereFn{c-lineup-java-throws} | |
5783 @end group | |
5784 @end example | |
5785 | |
5786 @workswith @code{func-decl-cont}. | |
5787 @end defun | |
5788 | |
5789 @comment ------------------------------------------------------------ | |
5790 | |
5791 @defun c-lineup-template-args | |
5792 @findex lineup-template-args (c-) | |
5793 Line up the arguments of a template argument list under each other, but | |
5794 only in the case where the first argument is on the same line as the | |
5795 opening @samp{<}. | |
5796 | |
5797 To allow this function to be used in a list expression, @code{nil} is | |
5798 returned if there's no template argument on the first line. | |
5799 | |
5800 @workswith @code{template-args-cont}. | |
5801 @end defun | |
5802 | |
5803 @comment ------------------------------------------------------------ | |
5804 | |
5805 @defun c-lineup-ObjC-method-call | |
5806 @findex lineup-ObjC-method-call (c-) | |
5807 For Objective-C code, line up selector args as Emacs Lisp mode does | |
5808 with function args: go to the position right after the message receiver, | |
5809 and if you are at the end of the line, indent the current line | |
5810 c-basic-offset columns from the opening bracket; otherwise you are | |
5811 looking at the first character of the first method call argument, so | |
5812 lineup the current line with it. | |
5813 | |
5814 @workswith @code{objc-method-call-cont}. | |
5815 @end defun | |
5816 | |
5817 @comment ------------------------------------------------------------ | |
5818 | |
5819 @defun c-lineup-ObjC-method-args | |
5820 @findex lineup-ObjC-method-args (c-) | |
5821 For Objective-C code, line up the colons that separate args. The colon | |
5822 on the current line is aligned with the one on the first line. | |
5823 | |
5824 @workswith @code{objc-method-args-cont}. | |
5825 @end defun | |
5826 | |
5827 @comment ------------------------------------------------------------ | |
5828 | |
5829 @defun c-lineup-ObjC-method-args-2 | |
5830 @findex lineup-ObjC-method-args-2 (c-) | |
5831 Similar to @code{c-lineup-ObjC-method-args} but lines up the colon on | |
5832 the current line with the colon on the previous line. | |
5833 | |
5834 @workswith @code{objc-method-args-cont}. | |
5835 @end defun | |
5836 | |
5837 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
5838 @node Operator Line-Up, Comment Line-Up, List Line-Up, Line-Up Functions | |
5839 @comment node-name, next, previous, up | |
5840 @subsection Operator Line-Up Functions | |
5841 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
5842 | |
5843 The line-up functions here calculate the indentation for lines which | |
5844 start with an operator, by lining it up with something on the previous | |
5845 line. | |
5846 | |
5847 @defun c-lineup-argcont | |
5848 @findex lineup-argcont (c-) | |
5849 Line up a continued argument. E.g: | |
5850 | |
5851 @example | |
5852 @group | |
5853 foo (xyz, aaa + bbb + ccc | |
5854 + ddd + eee + fff); @hereFn{c-lineup-argcont} | |
5855 @end group | |
5856 @end example | |
5857 | |
5858 Only continuation lines like this are touched, @code{nil} is returned on | |
5859 lines which are the start of an argument. | |
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 | 5862 separator, but of course only between operand specifications, not in the |
5863 expressions for the operands. | |
5864 | |
5865 @workswith @code{arglist-cont}, @code{arglist-cont-nonempty}. | |
5866 @end defun | |
5867 | |
5868 @comment ------------------------------------------------------------ | |
5869 | |
5870 @defun c-lineup-arglist-operators | |
5871 @findex lineup-arglist-operators (c-) | |
5872 Line up lines starting with an infix operator under the open paren. | |
5873 Return @code{nil} on lines that don't start with an operator, to leave | |
5874 those cases to other line-up functions. Example: | |
5875 | |
5876 @example | |
5877 @group | |
5878 if ( x < 10 | |
5879 || at_limit (x, @hereFn{c-lineup-arglist-operators} | |
5880 list) @hereFn{c-lineup-arglist-operators@r{ returns nil}} | |
5881 ) | |
5882 @end group | |
5883 @end example | |
5884 | |
5885 Since this function doesn't do anything for lines without an infix | |
5886 operator you typically want to use it together with some other lineup | |
5887 settings, e.g. as follows (the @code{arglist-close} setting is just a | |
5888 suggestion to get a consistent style): | |
5889 | |
5890 @example | |
5891 (c-set-offset 'arglist-cont | |
5892 '(c-lineup-arglist-operators 0)) | |
5893 (c-set-offset 'arglist-cont-nonempty | |
5894 '(c-lineup-arglist-operators c-lineup-arglist)) | |
5895 (c-set-offset 'arglist-close | |
5896 '(c-lineup-arglist-close-under-paren)) | |
5897 @end example | |
5898 | |
5899 @workswith @code{arglist-cont}, @code{arglist-cont-nonempty}. | |
5900 @end defun | |
5901 | |
5902 @comment ------------------------------------------------------------ | |
5903 | |
5904 @defun c-lineup-assignments | |
5905 @findex lineup-assignments (c-) | |
5906 Line up the current line after the assignment operator on the first line | |
5907 in the statement. If there isn't any, return nil to allow stacking with | |
5908 other line-up functions. If the current line contains an assignment | |
5909 operator too, try to align it with the first one. | |
5910 | |
5911 @workswith @code{topmost-intro-cont}, @code{statement-cont}, | |
5912 @code{arglist-cont}, @code{arglist-cont-nonempty}. | |
5913 | |
5914 @end defun | |
5915 | |
5916 @comment ------------------------------------------------------------ | |
5917 | |
5918 @defun c-lineup-math | |
5919 @findex lineup-math (c-) | |
5920 Like @code{c-lineup-assignments} but indent with @code{c-basic-offset} | |
5921 if no assignment operator was found on the first line. I.e. this | |
5922 function is the same as specifying a list @code{(c-lineup-assignments | |
5923 +)}. It's provided for compatibility with old configurations. | |
5924 | |
5925 @workswith @code{topmost-intro-cont}, @code{statement-cont}, | |
5926 @code{arglist-cont}, @code{arglist-cont-nonempty}. | |
5927 @end defun | |
5928 | |
5929 @comment ------------------------------------------------------------ | |
5930 | |
5931 @defun c-lineup-cascaded-calls | |
5932 @findex lineup-cascaded-calls (c-) | |
5933 Line up ``cascaded calls'' under each other. If the line begins with | |
5934 @code{->} or @code{.} and the preceding line ends with one or more | |
5935 function calls preceded by the same token, then the arrow is lined up | |
5936 with the first of those tokens. E.g: | |
5937 | |
5938 @example | |
5939 @group | |
5940 r = proc->add(17)->add(18) | |
5941 ->add(19) + @hereFn{c-lineup-cascaded-calls} | |
5942 offset; @hereFn{c-lineup-cascaded-calls@r{ (inactive)}} | |
5943 @end group | |
5944 @end example | |
5945 | |
5946 In any other situation @code{nil} is returned to allow use in list | |
5947 expressions. | |
5948 | |
5949 @workswith @code{topmost-intro-cont}, @code{statement-cont}, | |
5950 @code{arglist-cont}, @code{arglist-cont-nonempty}. | |
5951 @end defun | |
5952 | |
5953 @comment ------------------------------------------------------------ | |
5954 | |
5955 @defun c-lineup-streamop | |
5956 @findex lineup-streamop (c-) | |
5957 Line up C++ stream operators (i.e. @samp{<<} and @samp{>>}). | |
5958 | |
5959 @workswith @code{stream-op}. | |
5960 @end defun | |
5961 | |
5962 @comment ------------------------------------------------------------ | |
5963 | |
5964 @defun c-lineup-string-cont | |
5965 @findex lineup-string-cont (c-) | |
5966 Line up a continued string under the one it continues. A continued | |
5967 string in this sense is where a string literal follows directly after | |
5968 another one. E.g: | |
5969 | |
5970 @example | |
5971 @group | |
5972 result = prefix + "A message " | |
5973 "string."; @hereFn{c-lineup-string-cont} | |
5974 @end group | |
5975 @end example | |
5976 | |
5977 @code{nil} is returned in other situations, to allow stacking with other | |
5978 lineup functions. | |
5979 | |
5980 @workswith @code{topmost-intro-cont}, @code{statement-cont}, | |
5981 @code{arglist-cont}, @code{arglist-cont-nonempty}. | |
5982 @end defun | |
5983 | |
5984 | |
5985 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
5986 @node Comment Line-Up, Misc Line-Up, Operator Line-Up, Line-Up Functions | |
5987 @comment node-name, next, previous, up | |
5988 @subsection Comment Line-Up Functions | |
5989 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
5990 | |
5991 The lineup functions here calculate the indentation for several types | |
5992 of comment structure. | |
5993 | |
5994 @defun c-lineup-C-comments | |
5995 @findex lineup-C-comments (c-) | |
5996 Line up C block comment continuation lines. Various heuristics are used | |
5997 to handle most of the common comment styles. Some examples: | |
5998 | |
5999 @example | |
6000 @group | |
6001 /* /** /* | |
6002 * text * text text | |
6003 */ */ */ | |
6004 @end group | |
6005 @end example | |
6006 | |
6007 @example | |
6008 @group | |
6009 /* text /* /** | |
6010 text ** text ** text | |
6011 */ */ */ | |
6012 @end group | |
6013 @end example | |
6014 | |
6015 @example | |
6016 @group | |
6017 /************************************************** | |
6018 * text | |
6019 *************************************************/ | |
6020 @end group | |
6021 @end example | |
6022 | |
6023 @vindex comment-start-skip | |
6024 @example | |
6025 @group | |
6026 /************************************************** | |
6027 Free form text comments: | |
6028 In comments with a long delimiter line at the | |
6029 start, the indentation is kept unchanged for lines | |
6030 that start with an empty comment line prefix. The | |
6031 delimiter line is whatever matches the | |
6032 @code{comment-start-skip} regexp. | |
6033 **************************************************/ | |
6034 @end group | |
6035 @end example | |
6036 | |
6037 The style variable @code{c-comment-prefix-regexp} is used to recognize | |
6038 the comment line prefix, e.g. the @samp{*} that usually starts every | |
6039 line inside a comment. | |
6040 | |
6041 @workswith The @code{c} syntactic symbol. | |
6042 @end defun | |
6043 | |
6044 @comment ------------------------------------------------------------ | |
6045 | |
6046 @defun c-lineup-comment | |
6047 @findex lineup-comment (c-) | |
6048 Line up a comment-only line according to the style variable | |
6049 @code{c-comment-only-line-offset}. If the comment is lined up with a | |
6050 comment starter on the previous line, that alignment is preserved. | |
6051 | |
6052 @defopt c-comment-only-line-offset | |
6053 @vindex comment-only-line-offset (c-) | |
6054 This style variable specifies the extra offset for the line. It can | |
6055 contain an integer or a cons cell of the form | |
6056 | |
6057 @example | |
6058 (@r{@var{non-anchored-offset}} . @r{@var{anchored-offset}}) | |
6059 @end example | |
6060 | |
6061 @noindent | |
6062 where @var{non-anchored-offset} is the amount of offset given to | |
6063 non-column-zero anchored lines, and @var{anchored-offset} is the amount | |
6064 of offset to give column-zero anchored lines. Just an integer as value | |
6065 is equivalent to @code{(@r{@var{value}} . -1000)}. | |
6066 @end defopt | |
6067 | |
6068 @workswith @code{comment-intro}. | |
6069 @end defun | |
6070 | |
6071 @comment ------------------------------------------------------------ | |
6072 | |
6073 @defun c-lineup-knr-region-comment | |
6074 @findex lineup-knr-region-comment (c-) | |
6075 Line up a comment in the ``K&R region'' with the declaration. That is | |
6076 the region between the function or class header and the beginning of the | |
6077 block. E.g: | |
6078 | |
6079 @example | |
6080 @group | |
6081 int main() | |
6082 /* Called at startup. */ @hereFn{c-lineup-knr-region-comment} | |
6083 @{ | |
6084 return 0; | |
6085 @} | |
6086 @end group | |
6087 @end example | |
6088 | |
6089 Return @code{nil} if called in any other situation, to be useful in list | |
6090 expressions. | |
6091 | |
6092 @workswith @code{comment-intro}. | |
6093 @end defun | |
6094 | |
6095 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6096 @node Misc Line-Up, , Comment Line-Up, Line-Up Functions | |
6097 @comment node-name, next, previous, up | |
6098 @subsection Miscellaneous Line-Up Functions | |
6099 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6100 | |
6101 The line-up functions here are the odds and ends which didn't fit into | |
6102 any earlier category. | |
6103 | |
6104 @defun c-lineup-dont-change | |
6105 @findex lineup-dont-change (c-) | |
6106 This lineup function makes the line stay at whatever indentation it | |
6107 already has; think of it as an identity function for lineups. | |
6108 | |
6109 @workswith Any syntactic symbol. | |
6110 @end defun | |
6111 | |
6112 @comment ------------------------------------------------------------ | |
6113 | |
6114 @defun c-lineup-cpp-define | |
6115 @findex lineup-cpp-define (c-) | |
6116 Line up macro continuation lines according to the indentation of the | |
6117 construct preceding the macro. E.g: | |
6118 | |
6119 @example | |
6120 @group | |
6121 const char msg[] = @hereFn{@r{The beginning of the preceding construct.}} | |
6122 \"Some text.\"; | |
6123 | |
6124 #define X(A, B) \ | |
6125 do @{ \ @hereFn{c-lineup-cpp-define} | |
6126 printf (A, B); \ | |
6127 @} while (0) | |
6128 @end group | |
6129 @end example | |
6130 | |
6131 @noindent | |
6132 and: | |
6133 | |
6134 @example | |
6135 @group | |
6136 int dribble() @{ | |
6137 if (!running) @hereFn{@r{The beginning of the preceding construct.}} | |
6138 error(\"Not running!\"); | |
6139 | |
6140 #define X(A, B) \ | |
6141 do @{ \ @hereFn{c-lineup-cpp-define} | |
6142 printf (A, B); \ | |
6143 @} while (0) | |
6144 @end group | |
6145 @end example | |
6146 | |
6147 If @code{c-syntactic-indentation-in-macros} is non-@code{nil}, the | |
6148 function returns the relative indentation to the macro start line to | |
6149 allow accumulation with other offsets. E.g. in the following cases, | |
6150 @code{cpp-define-intro} is combined with the | |
6151 @code{statement-block-intro} that comes from the @samp{do @{} that hangs | |
6152 on the @samp{#define} line: | |
6153 | |
6154 @example | |
6155 @group | |
6156 const char msg[] = | |
6157 \"Some text.\"; | |
6158 | |
6159 #define X(A, B) do @{ \ | |
6160 printf (A, B); \ @hereFn{c-lineup-cpp-define} | |
6161 this->refs++; \ | |
6162 @} while (0) @hereFn{c-lineup-cpp-define} | |
6163 @end group | |
6164 @end example | |
6165 | |
6166 @noindent | |
6167 and: | |
6168 | |
6169 @example | |
6170 @group | |
6171 int dribble() @{ | |
6172 if (!running) | |
6173 error(\"Not running!\"); | |
6174 | |
6175 #define X(A, B) do @{ \ | |
6176 printf (A, B); \ @hereFn{c-lineup-cpp-define} | |
6177 this->refs++; \ | |
6178 @} while (0) @hereFn{c-lineup-cpp-define} | |
6179 @end group | |
6180 @end example | |
6181 | |
6182 The relative indentation returned by @code{c-lineup-cpp-define} is zero | |
6183 and two, respectively, on the two lines in each of these examples. They | |
6184 are then added to the two column indentation that | |
6185 @code{statement-block-intro} gives in both cases here. | |
6186 | |
6187 If the relative indentation is zero, then @code{nil} is returned | |
6188 instead. That is useful in a list expression to specify the default | |
6189 indentation on the top level. | |
6190 | |
6191 If @code{c-syntactic-indentation-in-macros} is @code{nil} then this | |
6192 function keeps the current indentation, except for empty lines (ignoring | |
6193 the ending backslash) where it takes the indentation from the closest | |
6194 preceding nonempty line in the macro. If there's no such line in the | |
6195 macro then the indentation is taken from the construct preceding it, as | |
6196 described above. | |
6197 | |
6198 @workswith @code{cpp-define-intro}. | |
6199 @end defun | |
6200 | |
6201 @comment ------------------------------------------------------------ | |
6202 | |
6203 @defun c-lineup-gcc-asm-reg | |
6204 @findex lineup-gcc-asm-reg (c-) | |
6205 Line up a gcc asm register under one on a previous line. | |
6206 | |
6207 @example | |
6208 @group | |
6209 asm ("foo %1, %0\n" | |
6210 "bar %0, %1" | |
6211 : "=r" (w), | |
6212 "=r" (x) | |
6213 : "0" (y), | |
6214 "1" (z)); | |
6215 @end group | |
6216 @end example | |
6217 | |
6218 The @samp{x} line is aligned to the text after the @samp{:} on the | |
6219 @samp{w} line, and similarly @samp{z} under @samp{y}. | |
6220 | |
6221 This is done only in an @samp{asm} or @samp{__asm__} block, and only to | |
6222 those lines mentioned. Anywhere else @code{nil} is returned. The usual | |
6223 arrangement is to have this routine as an extra feature at the start of | |
6224 arglist lineups, e.g. | |
6225 | |
6226 @example | |
6227 (c-lineup-gcc-asm-reg c-lineup-arglist) | |
6228 @end example | |
6229 | |
6230 @workswith @code{arglist-cont}, @code{arglist-cont-nonempty}. | |
6231 @end defun | |
6232 | |
6233 @comment ------------------------------------------------------------ | |
6234 | |
6235 @defun c-lineup-topmost-intro-cont | |
6236 @findex lineup-topmost-intro-cont (c-) | |
6237 Line up declaration continuation lines zero or one indentation | |
6238 step@footnote{This function is mainly provided to mimic the behavior of | |
6239 CC Mode 5.28 and earlier where this case wasn't handled consistently so | |
6240 that those lines could be analyzed as either topmost-intro-cont or | |
6241 statement-cont. It's used for @code{topmost-intro-cont} by default, but | |
6242 you might consider using @code{+} instead.}. For lines preceding a | |
6243 definition, zero is used. For other lines, @code{c-basic-offset} is | |
6244 added to the indentation. E.g: | |
6245 | |
6246 @example | |
6247 @group | |
6248 int | |
6249 neg (int i) @hereFn{c-lineup-topmost-intro-cont} | |
6250 @{ | |
6251 return -i; | |
6252 @} | |
6253 @end group | |
6254 @end example | |
6255 | |
6256 @noindent | |
6257 and | |
6258 | |
6259 @example | |
6260 @group | |
6261 struct | |
6262 larch @hereFn{c-lineup-topmost-intro-cont} | |
6263 @{ | |
6264 double height; | |
6265 @} | |
6266 the_larch, @hereFn{c-lineup-topmost-intro-cont} | |
6267 another_larch; @hereFn{c-lineup-topmost-intro-cont} | |
6268 @sssTBasicOffset{} | |
6269 @end group | |
6270 @end example | |
6271 | |
6272 @noindent | |
6273 and | |
6274 | |
6275 @example | |
6276 @group | |
6277 struct larch | |
6278 the_larch, @hereFn{c-lineup-topmost-intro-cont} | |
6279 another_larch; @hereFn{c-lineup-topmost-intro-cont} | |
6280 @end group | |
6281 @end example | |
6282 | |
6283 @workswith @code{topmost-intro-cont}. | |
6284 @end defun | |
6285 | |
6286 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6287 @node Custom Line-Up, Other Indentation, Line-Up Functions, Customizing Indentation | |
6288 @comment node-name, next, previous, up | |
6289 @section Custom Line-Up Functions | |
6290 @cindex customization, indentation functions | |
6291 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6292 | |
6293 The most flexible way to customize indentation is by writing custom | |
6294 line-up functions, and associating them with specific syntactic | |
6295 symbols (@pxref{c-offsets-alist}). Depending on the effect you want, | |
6296 it might be better to write a @code{c-special-indent-hook} function | |
6297 rather than a line-up function (@pxref{Other Indentation}). | |
6298 | |
6299 @ccmode{} comes with an extensive set of predefined line-up functions, | |
6300 not all of which are used by the default styles. So there's a good | |
6301 chance the function you want already exists. @xref{Line-Up | |
6302 Functions}, for a list of them. If you write your own line-up | |
6303 function, it's probably a good idea to start working from one of these | |
6304 predefined functions, which can be found in the file | |
6305 @file{cc-align.el}. If you have written a line-up function that you | |
6306 think is generally useful, you're very welcome to contribute it; | |
6307 please contact @email{bug-cc-mode@@gnu.org}. | |
6308 | |
6309 Line-up functions are passed a single argument, the syntactic | |
6310 element (see below). The return value is a @code{c-offsets-alist} | |
6311 offset specification: for example, an integer, a symbol such as | |
6312 @code{+}, a vector, @code{nil}@footnote{Returning @code{nil} is useful | |
6313 when the offset specification for a syntactic element is a list | |
6314 containing the line-up function (@pxref{c-offsets-alist}).}, or even | |
6315 another line-up function. Full details of these are in | |
6316 @ref{c-offsets-alist}. | |
6317 | |
6318 Line-up functions must not move point or change the content of the | |
6319 buffer (except temporarily). They are however allowed to do | |
6320 @dfn{hidden buffer changes}, i.e. setting text properties for caching | |
6321 purposes etc. Buffer undo recording is disabled while they run. | |
6322 | |
6323 The syntactic element passed as the parameter to a line-up function is | |
6324 a cons cell of the form | |
6325 | |
6326 @example | |
6327 (@r{@var{syntactic-symbol}} . @r{@var{anchor-position}}) | |
6328 @end example | |
6329 | |
6330 @noindent | |
6331 @c FIXME!!! The following sentence might be better omitted, since the | |
6332 @c information is in the cross reference "Syntactic Analysis". 2005/10/2. | |
6333 where @var{syntactic-symbol} is the symbol that the function was | |
6334 called for, and @var{anchor-position} is the anchor position (if any) | |
6335 for the construct that triggered the syntactic symbol | |
6336 (@pxref{Syntactic Analysis}). This cons cell is how the syntactic | |
6337 element of a line used to be represented in @ccmode{} 5.28 and | |
6338 earlier. Line-up functions are still passed this cons cell, so as to | |
6339 preserve compatibility with older configurations. In the future, we | |
6340 may decide to convert to using the full list format---you can prepare | |
6341 your setup for this by using the access functions | |
6342 (@code{c-langelem-sym}, etc.) described below. | |
6343 | |
6344 @vindex c-syntactic-element | |
6345 @vindex syntactic-element (c-) | |
6346 @vindex c-syntactic-context | |
6347 @vindex syntactic-context (c-) | |
6348 Some syntactic symbols, e.g. @code{arglist-cont-nonempty}, have more | |
6349 info in the syntactic element - typically other positions that can be | |
6350 interesting besides the anchor position. That info can't be accessed | |
6351 through the passed argument, which is a cons cell. Instead, you can | |
6352 get this information from the variable @code{c-syntactic-element}, | |
6353 which is dynamically bound to the complete syntactic element. The | |
6354 variable @code{c-syntactic-context} might also be useful - it gets | |
6355 dynamically bound to the complete syntactic context. @xref{Custom | |
6356 Braces}. | |
6357 | |
6358 @ccmode{} provides a few functions to access parts of syntactic | |
6359 elements in a more abstract way. Besides making the code easier to | |
6360 read, they also hide the difference between the old cons cell form | |
6361 used in the line-up function argument and the new list form used in | |
6362 @code{c-syntactic-element} and everywhere else. The functions are: | |
6363 | |
6364 @defun c-langelem-sym langelem | |
6365 @findex langelem-sym (c-) | |
6366 Return the syntactic symbol in @var{langelem}. | |
6367 @end defun | |
6368 | |
6369 @defun c-langelem-pos langelem | |
6370 @findex langelem-pos (c-) | |
6371 Return the anchor position in @var{langelem}, or nil if there is none. | |
6372 @end defun | |
6373 | |
6374 @defun c-langelem-col langelem &optional preserve-point | |
6375 @findex langelem-col (c-) | |
6376 Return the column of the anchor position in @var{langelem}. Also move | |
6377 the point to that position unless @var{preserve-point} is | |
6378 non-@code{nil}. | |
6379 @end defun | |
6380 | |
6381 @defun c-langelem-2nd-pos langelem | |
6382 @findex langelem-2nd-pos (c-) | |
6383 Return the secondary position in @var{langelem}, or @code{nil} if there | |
6384 is none. | |
6385 | |
6386 Note that the return value of this function is always @code{nil} if | |
6387 @var{langelem} is in the old cons cell form. Thus this function is | |
6388 only meaningful when used on syntactic elements taken from | |
6389 @code{c-syntactic-element} or @code{c-syntactic-context}. | |
6390 @end defun | |
6391 | |
6392 Custom line-up functions can be as simple or as complex as you like, and | |
6393 any syntactic symbol that appears in @code{c-offsets-alist} can have a | |
6394 custom line-up function associated with it. | |
6395 | |
6396 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6397 @node Other Indentation, , Custom Line-Up, Customizing Indentation | |
6398 @comment node-name, next, previous, up | |
6399 @section Other Special Indentations | |
6400 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6401 | |
6402 Here are the remaining odds and ends regarding indentation: | |
6403 | |
6404 @defopt c-label-minimum-indentation | |
6405 @vindex label-minimum-indentation (c-) | |
6406 In @samp{gnu} style (@pxref{Built-in Styles}), a minimum indentation is | |
6407 imposed on lines inside code blocks. This minimum indentation is | |
6408 controlled by this style variable. The default value is 1. | |
6409 | |
6410 @findex c-gnu-impose-minimum | |
6411 @findex gnu-impose-minimum (c-) | |
6412 It's the function @code{c-gnu-impose-minimum} that enforces this minimum | |
6413 indentation. It must be present on @code{c-special-indent-hook} to | |
6414 work. | |
6415 @end defopt | |
6416 | |
6417 @defopt c-special-indent-hook | |
6418 @vindex special-indent-hook (c-) | |
6419 This style variable is a standard hook variable that is called after | |
6420 every line is indented by @ccmode{}. It is called only if | |
6421 @code{c-syntactic-indentation} is non-@code{nil} (which it is by | |
6422 default (@pxref{Indentation Engine Basics})). You can put a function | |
6423 on this hook to do any special indentation or ad hoc line adjustments | |
6424 your style dictates, such as adding extra indentation to constructors | |
6425 or destructor declarations in a class definition, etc. Sometimes it | |
6426 is better to write a custom Line-up Function instead (@pxref{Custom | |
6427 Line-Up}). | |
6428 | |
6429 When the indentation engine calls this hook, the variable | |
6430 @code{c-syntactic-context} is bound to the current syntactic context | |
6431 (i.e. what you would get by typing @kbd{C-c C-s} on the source line. | |
6432 @xref{Custom Braces}.). Note that you should not change point or mark | |
6433 inside a @code{c-special-indent-hook} function, i.e. you'll probably | |
6434 want to wrap your function in a @code{save-excursion}@footnote{The | |
6435 numerical value returned by @code{point} will change if you change the | |
6436 indentation of the line within a @code{save-excursion} form, but point | |
6437 itself will still be over the same piece of text.}. | |
6438 | |
6439 Setting @code{c-special-indent-hook} in style definitions is handled | |
6440 slightly differently from other variables---A style can only add | |
6441 functions to this hook, not remove them. @xref{Style Variables}. | |
6442 @end defopt | |
6443 | |
6444 | |
6445 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6446 @node Custom Macros, Odds and Ends, Customizing Indentation, Top | |
6447 @comment node-name, next, previous, up | |
6448 @chapter Customizing Macros | |
6449 @cindex macros | |
6450 @cindex preprocessor directives | |
6451 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6452 | |
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 | 6455 by setting the following user option: |
6456 | |
6457 @defopt c-syntactic-indentation-in-macros | |
6458 @vindex syntactic-indentation-in-macros (c-) | |
6459 Enable syntactic analysis inside macros, which is the default. If this | |
6460 is @code{nil}, all lines inside macro definitions are analyzed as | |
6461 @code{cpp-macro-cont}. | |
6462 @end defopt | |
6463 | |
6464 @ccmode{} provides some tools to help keep the line continuation | |
6465 backslashes in macros neat and tidy. Their precise action is | |
6466 customized with these variables: | |
6467 | |
6468 @defopt c-backslash-column | |
6469 @vindex backslash-column (c-) | |
6470 @defoptx c-backslash-max-column | |
6471 @vindex backslash-max-column (c-) | |
6472 These variables control the alignment columns for line continuation | |
6473 backslashes in multiline macros. They are used by the functions that | |
6474 automatically insert or align such backslashes, | |
6475 e.g. @code{c-backslash-region} and @code{c-context-line-break}. | |
6476 | |
6477 @code{c-backslash-column} specifies the minimum column for the | |
6478 backslashes. If any line in the macro goes past this column, then the | |
6479 next tab stop (i.e. next multiple of @code{tab-width}) in that line is | |
6480 used as the alignment column for all the backslashes, so that they | |
6481 remain in a single column. However, if any lines go past | |
6482 @code{c-backslash-max-column} then the backslashes in the rest of the | |
6483 macro will be kept at that column, so that the lines which are too | |
6484 long ``stick out'' instead. | |
6485 | |
6486 Don't ever set these variables to @code{nil}. If you want to disable | |
6487 the automatic alignment of backslashes, use | |
6488 @code{c-auto-align-backslashes}. | |
6489 @end defopt | |
6490 | |
6491 @defopt c-auto-align-backslashes | |
6492 @vindex auto-align-backslashes (c-) | |
6493 Align automatically inserted line continuation backslashes if | |
6494 non-@code{nil}. When line continuation backslashes are inserted | |
6495 automatically for line breaks in multiline macros, e.g. by | |
6496 @code{c-context-line-break}, they are aligned with the other | |
6497 backslashes in the same macro if this flag is set. | |
6498 | |
6499 If @code{c-auto-align-backslashes} is @code{nil}, automatically | |
6500 inserted backslashes are preceded by a single space, and backslashes | |
6501 get aligned only when you explicitly invoke the command | |
6502 @code{c-backslash-region} (@kbd{C-c C-\}). | |
6503 @end defopt | |
6504 | |
6505 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6506 @node Odds and Ends, Sample .emacs File, Custom Macros, Top | |
6507 @comment node-name, next, previous, up | |
6508 @chapter Odds and Ends | |
6509 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6510 | |
6511 The stuff that didn't fit in anywhere else is documented here. | |
6512 | |
6513 @defopt c-require-final-newline | |
6514 @vindex require-final-newline (c-) | |
6515 Controls whether a final newline is enforced when the file is saved. | |
6516 The value is an association list that for each language mode specifies | |
6517 the value to give to @code{require-final-newline} (@pxref{Saving | |
6518 Buffers,,, @lispref{}, @lispreftitle{}}) at mode initialization. If a | |
6519 language isn't present on the association list, CC Mode won't touch | |
6520 @code{require-final-newline} in buffers for that language. | |
6521 | |
6522 The default is to set @code{require-final-newline} to @code{t} in the | |
6523 languages that mandate that source files should end with newlines. | |
6524 These are C, C++ and Objective-C. | |
6525 @end defopt | |
6526 | |
6527 @defopt c-echo-syntactic-information-p | |
6528 @vindex echo-syntactic-information-p (c-) | |
6529 If non-@code{nil}, the syntactic analysis for the current line is shown | |
6530 in the echo area when it's indented (unless | |
6531 @code{c-syntactic-indentation} is @code{nil}). That's useful when | |
6532 finding out which syntactic symbols to modify to get the indentation you | |
6533 want. | |
6534 @end defopt | |
6535 | |
6536 @defopt c-report-syntactic-errors | |
6537 @vindex report-syntactic-errors (c-) | |
6538 If non-@code{nil}, certain syntactic errors are reported with a ding and | |
6539 a message, for example when an @code{else} is indented for which there | |
6540 is no corresponding @code{if}. | |
6541 | |
6542 Note however that @ccmode{} doesn't make any special effort to check for | |
6543 syntactic errors; that's the job of the compiler. The reason it can | |
6544 report cases like the one above is that it can't find the correct | |
6545 anchoring position to indent the line in that case. | |
6546 @end defopt | |
6547 | |
6548 | |
6549 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6550 @node Sample .emacs File, Performance Issues, Odds and Ends, Top | |
6551 @comment node-name, next, previous, up | |
6552 @appendix Sample .emacs File | |
6553 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6554 | |
6555 Here's a sample .emacs file fragment that might help you along the way. | |
6556 Just copy this region and paste it into your .emacs file. You might want | |
6557 to change some of the actual values. | |
6558 | |
6559 @verbatim | |
6560 ;; Make a non-standard key binding. We can put this in | |
6561 ;; c-mode-base-map because c-mode-map, c++-mode-map, and so on, | |
6562 ;; inherit from it. | |
6563 (defun my-c-initialization-hook () | |
6564 (define-key c-mode-base-map "\C-m" 'c-context-line-break)) | |
6565 (add-hook 'c-initialization-hook 'my-c-initialization-hook) | |
6566 | |
6567 ;; offset customizations not in my-c-style | |
6568 ;; This will take precedence over any setting of the syntactic symbol | |
6569 ;; made by a style. | |
6570 (setq c-offsets-alist '((member-init-intro . ++))) | |
6571 | |
6572 ;; Create my personal style. | |
6573 (defconst my-c-style | |
6574 '((c-tab-always-indent . t) | |
6575 (c-comment-only-line-offset . 4) | |
6576 (c-hanging-braces-alist . ((substatement-open after) | |
6577 (brace-list-open))) | |
6578 (c-hanging-colons-alist . ((member-init-intro before) | |
6579 (inher-intro) | |
6580 (case-label after) | |
6581 (label after) | |
6582 (access-label after))) | |
6583 (c-cleanup-list . (scope-operator | |
6584 empty-defun-braces | |
6585 defun-close-semi)) | |
6586 (c-offsets-alist . ((arglist-close . c-lineup-arglist) | |
6587 (substatement-open . 0) | |
6588 (case-label . 4) | |
6589 (block-open . 0) | |
6590 (knr-argdecl-intro . -))) | |
6591 (c-echo-syntactic-information-p . t)) | |
6592 "My C Programming Style") | |
6593 (c-add-style "PERSONAL" my-c-style) | |
6594 | |
6595 ;; Customizations for all modes in CC Mode. | |
6596 (defun my-c-mode-common-hook () | |
6597 ;; set my personal style for the current buffer | |
6598 (c-set-style "PERSONAL") | |
6599 ;; other customizations | |
6600 (setq tab-width 8 | |
6601 ;; this will make sure spaces are used instead of tabs | |
6602 indent-tabs-mode nil) | |
6603 ;; we like auto-newline, but not hungry-delete | |
6604 (c-toggle-auto-newline 1)) | |
6605 (add-hook 'c-mode-common-hook 'my-c-mode-common-hook) | |
6606 @end verbatim | |
6607 | |
6608 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6609 @node Performance Issues, Limitations and Known Bugs, Sample .emacs File, Top | |
6610 @comment node-name, next, previous, up | |
6611 @chapter Performance Issues | |
6612 @cindex performance | |
6613 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6614 | |
6615 @comment FIXME: (ACM, 2003/5/24). Check whether AWK needs mentioning here. | |
6616 | |
6617 C and its derivative languages are highly complex creatures. Often, | |
6618 ambiguous code situations arise that require @ccmode{} to scan large | |
6619 portions of the buffer to determine syntactic context. Such | |
6620 pathological code can cause @ccmode{} to perform fairly badly. This | |
6621 section gives some insight in how @ccmode{} operates, how that interacts | |
6622 with some coding styles, and what you can use to improve performance. | |
6623 | |
6624 The overall goal is that @ccmode{} shouldn't be overly slow (i.e. take | |
6625 more than a fraction of a second) in any interactive operation. | |
6626 I.e. it's tuned to limit the maximum response time in single operations, | |
6627 which is sometimes at the expense of batch-like operations like | |
6628 reindenting whole blocks. If you find that @ccmode{} gradually gets | |
6629 slower and slower in certain situations, perhaps as the file grows in | |
6630 size or as the macro or comment you're editing gets bigger, then chances | |
6631 are that something isn't working right. You should consider reporting | |
6632 it, unless it's something that's mentioned in this section. | |
6633 | |
6634 Because @ccmode{} has to scan the buffer backwards from the current | |
6635 insertion point, and because C's syntax is fairly difficult to parse in | |
6636 the backwards direction, @ccmode{} often tries to find the nearest | |
6637 position higher up in the buffer from which to begin a forward scan | |
6638 (it's typically an opening or closing parenthesis of some kind). The | |
6639 farther this position is from the current insertion point, the slower it | |
6640 gets. | |
6641 | |
6642 @findex beginning-of-defun | |
6643 In earlier versions of @ccmode{}, we used to recommend putting the | |
6644 opening brace of a top-level construct@footnote{E.g. a function in C, | |
6645 or outermost class definition in C++ or Java.} into the leftmost | |
6646 column. Earlier still, this used to be a rigid Emacs constraint, as | |
6647 embodied in the @code{beginning-of-defun} function. @ccmode now | |
6648 caches syntactic information much better, so that the delay caused by | |
6649 searching for such a brace when it's not in column 0 is minimal, | |
6650 except perhaps when you've just moved a long way inside the file. | |
6651 | |
6652 @findex defun-prompt-regexp | |
6653 @vindex c-Java-defun-prompt-regexp | |
6654 @vindex Java-defun-prompt-regexp (c-) | |
6655 A special note about @code{defun-prompt-regexp} in Java mode: The common | |
6656 style is to hang the opening braces of functions and classes on the | |
6657 right side of the line, and that doesn't work well with the Emacs | |
6658 approach. @ccmode{} comes with a constant | |
6659 @code{c-Java-defun-prompt-regexp} which tries to define a regular | |
6660 expression usable for this style, but there are problems with it. In | |
6661 some cases it can cause @code{beginning-of-defun} to hang@footnote{This | |
6662 has been observed in Emacs 19.34 and XEmacs 19.15.}. For this reason, | |
6663 it is not used by default, but if you feel adventurous, you can set | |
6664 @code{defun-prompt-regexp} to it in your mode hook. In any event, | |
6665 setting and relying on @code{defun-prompt-regexp} will definitely slow | |
6666 things down because (X)Emacs will be doing regular expression searches a | |
6667 lot, so you'll probably be taking a hit either way! | |
6668 | |
6669 @ccmode{} maintains a cache of the opening parentheses of the blocks | |
6670 surrounding the point, and it adapts that cache as the point is moved | |
6671 around. That means that in bad cases it can take noticeable time to | |
6672 indent a line in a new surrounding, but after that it gets fast as long | |
6673 as the point isn't moved far off. The farther the point is moved, the | |
6674 less useful is the cache. Since editing typically is done in ``chunks'' | |
6675 rather than on single lines far apart from each other, the cache | |
6676 typically gives good performance even when the code doesn't fit the | |
6677 Emacs approach to finding the defun starts. | |
6678 | |
6679 @vindex c-enable-xemacs-performance-kludge-p | |
6680 @vindex enable-xemacs-performance-kludge-p (c-) | |
6681 XEmacs users can set the variable | |
6682 @code{c-enable-xemacs-performance-kludge-p} to non-@code{nil}. This | |
6683 tells @ccmode{} to use XEmacs-specific built-in functions which, in some | |
6684 circumstances, can locate the top-most opening brace much more quickly than | |
6685 @code{beginning-of-defun}. Preliminary testing has shown that for | |
6686 styles where these braces are hung (e.g. most JDK-derived Java styles), | |
6687 this hack can improve performance of the core syntax parsing routines | |
6688 from 3 to 60 times. However, for styles which @emph{do} conform to | |
6689 Emacs' recommended style of putting top-level braces in column zero, | |
6690 this hack can degrade performance by about as much. Thus this variable | |
6691 is set to @code{nil} by default, since the Emacs-friendly styles should | |
6692 be more common (and encouraged!). Note that this variable has no effect | |
6693 in Emacs since the necessary built-in functions don't exist (in Emacs | |
6694 22.1 as of this writing in February 2007). | |
6695 | |
6696 Text properties are used to speed up skipping over syntactic whitespace, | |
6697 i.e. comments and preprocessor directives. Indenting a line after a | |
6698 huge macro definition can be slow the first time, but after that the | |
6699 text properties are in place and it should be fast (even after you've | |
6700 edited other parts of the file and then moved back). | |
6701 | |
6702 Font locking can be a CPU hog, especially the font locking done on | |
6703 decoration level 3 which tries to be very accurate. Note that that | |
6704 level is designed to be used with a font lock support mode that only | |
6705 fontifies the text that's actually shown, i.e. Lazy Lock or Just-in-time | |
6706 Lock mode, so make sure you use one of them. Fontification of a whole | |
6707 buffer with some thousand lines can often take over a minute. That is | |
6708 a known weakness; the idea is that it never should happen. | |
6709 | |
6710 The most effective way to speed up font locking is to reduce the | |
6711 decoration level to 2 by setting @code{font-lock-maximum-decoration} | |
6712 appropriately. That level is designed to be as pretty as possible | |
6713 without sacrificing performance. @xref{Font Locking Preliminaries}, for | |
6714 more info. | |
6715 | |
6716 | |
6717 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6718 @node Limitations and Known Bugs, FAQ, Performance Issues, Top | |
6719 @comment node-name, next, previous, up | |
6720 @chapter Limitations and Known Bugs | |
6721 @cindex limitations | |
6722 @cindex bugs | |
6723 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6724 | |
6725 @itemize @bullet | |
6726 @item | |
6727 @ccmode{} doesn't support trigraphs. (These are character sequences | |
6728 such as @samp{??(}, which represents @samp{[}. They date from a time | |
6729 when some character sets didn't have all the characters that C needs, | |
6730 and are now utterly obsolete.) | |
6731 | |
6732 @item | |
6733 There is no way to apply auto newline settings (@pxref{Auto-newlines}) | |
6734 on already typed lines. That's only a feature to ease interactive | |
6735 editing. | |
6736 | |
6737 To generalize this issue a bit: @ccmode{} is not intended to be used as | |
6738 a reformatter for old code in some more or less batch-like way. With | |
6739 the exception of some functions like @code{c-indent-region}, it's only | |
6740 geared to be used interactively to edit new code. There's currently no | |
6741 intention to change this goal. | |
6742 | |
6743 If you want to reformat old code, you're probably better off using some | |
6744 other tool instead, e.g. @ref{Top, , GNU indent, indent, The `indent' | |
6745 Manual}, which has more powerful reformatting capabilities than | |
6746 @ccmode{}. | |
6747 | |
6748 @item | |
6749 The support for C++ templates (in angle brackets) is not yet complete. | |
6750 When a non-nested template is used in a declaration, @ccmode{} indents | |
6751 it and font-locks it OK. Templates used in expressions, and nested | |
6752 templates do not fare so well. Sometimes a workaround is to refontify | |
6753 the expression after typing the closing @samp{>}. | |
6754 | |
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 | 6764 On loading @ccmode{}, sometimes this error message appears: |
6765 | |
6766 @example | |
6767 File mode specification error: (void-variable c-font-lock-keywords-3) | |
6768 @end example | |
6769 | |
6770 This is due to a bug in the function @code{eval-after-load} in some | |
6771 versions of (X)Emacs. It can manifest itself when there is a symbolic | |
6772 link in the path of the directory which contains (X)Emacs. As a | |
6773 workaround, put the following into your @file{.emacs} file, fairly | |
6774 early on: | |
6775 | |
6776 @example | |
6777 (defun my-load-cc-fonts () | |
6778 (require "cc-fonts")) | |
6779 (add-hook 'c-initialization-hook 'my-load-cc-fonts) | |
6780 @end example | |
6781 @end itemize | |
6782 | |
6783 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6784 @node FAQ, Updating CC Mode, Limitations and Known Bugs, Top | |
6785 @comment node-name, next, previous, up | |
6786 @appendix Frequently Asked Questions | |
6787 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6788 | |
6789 @itemize @bullet | |
6790 @item | |
6791 @emph{How can I change the indent level from 4 spaces to 2 spaces?} | |
6792 | |
6793 Set the variable @code{c-basic-offset}. @xref{Getting Started}. | |
6794 | |
6795 @item | |
6796 @kindex RET | |
6797 @kindex C-j | |
6798 @emph{Why doesn't the @kbd{RET} key indent the new line?} | |
6799 | |
6800 Emacs' convention is that @kbd{RET} just adds a newline, and that | |
6801 @kbd{C-j} adds a newline and indents it. You can make @kbd{RET} do this | |
6802 too by adding this to your @code{c-initialization-hook}: | |
6803 | |
6804 @example | |
6805 (define-key c-mode-base-map "\C-m" 'c-context-line-break) | |
6806 @end example | |
6807 | |
6808 @xref{Getting Started}. This is a very common question. If you want | |
6809 this to be the default behavior, don't lobby us, lobby RMS! @t{:-)} | |
6810 | |
6811 @item | |
6812 @emph{How do I stop my code jumping all over the place when I type?} | |
6813 | |
6814 Deactivate ``electric minor mode'' with @kbd{C-c C-l}. @xref{Getting | |
6815 Started}. | |
6816 | |
6817 @item | |
6818 @kindex C-x h | |
6819 @kindex C-M-\ | |
6820 @emph{How do I reindent the whole file?} | |
6821 | |
6822 Visit the file and hit @kbd{C-x h} to mark the whole buffer. Then hit | |
6823 @kbd{C-M-\}. @xref{Indentation Commands}. | |
6824 | |
6825 @item | |
6826 @kindex C-M-q | |
6827 @kindex C-M-u | |
6828 @emph{How do I reindent the current block?} | |
6829 | |
6830 First move to the brace which opens the block with @kbd{C-M-u}, then | |
6831 reindent that expression with @kbd{C-M-q}. @xref{Indentation | |
6832 Commands}. | |
6833 | |
6834 @item | |
6835 @emph{I put @code{(c-set-offset 'substatement-open 0)} in my | |
6836 @file{.emacs} file but I get an error saying that @code{c-set-offset}'s | |
6837 function definition is void. What's wrong?} | |
6838 | |
6839 This means that @ccmode{} hasn't yet been loaded into your Emacs | |
6840 session by the time the @code{c-set-offset} call is reached, most | |
6841 likely because @ccmode{} is being autoloaded. Instead of putting the | |
6842 @code{c-set-offset} line in your top-level @file{.emacs} file, put it | |
6843 in your @code{c-initialization-hook} (@pxref{CC Hooks}), or simply | |
6844 modify @code{c-offsets-alist} directly: | |
6845 | |
6846 @example | |
6847 (setq c-offsets-alist '((substatement-open . 0))) | |
6848 @end example | |
6849 | |
6850 @item | |
6851 @cindex open paren in column zero | |
6852 @emph{I have an open paren character at column zero inside a comment or | |
6853 multiline string literal, and it causes the fontification and/or | |
6854 indentation to go haywire. What gives?} | |
6855 | |
6856 It's due to the ad-hoc rule in (X)Emacs that such open parens always | |
6857 start defuns (which translates to functions, classes, namespaces or any | |
6858 other top-level block constructs in the @ccmode{} languages). | |
6859 @ifset XEMACS | |
6860 @xref{Defuns,,, xemacs, XEmacs User's Manual}, for details. | |
6861 @end ifset | |
6862 @ifclear XEMACS | |
6863 @xref{Left Margin Paren,,, emacs, GNU Emacs Manual}, for details | |
6864 (@xref{Defuns,,, emacs, GNU Emacs Manual}, in the Emacs 20 manual). | |
6865 @end ifclear | |
6866 | |
6867 This heuristic is built into the core syntax analysis routines in | |
6868 (X)Emacs, so it's not really a @ccmode{} issue. However, in Emacs | |
6869 21.1 it became possible to turn it off@footnote{Using the variable | |
6870 @code{open-paren-in-column-0-is-defun-start}.} and @ccmode{} does so | |
6871 there since it's got its own system to keep track of blocks. | |
6872 | |
6873 @end itemize | |
6874 | |
6875 | |
6876 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6877 @node Updating CC Mode, Mailing Lists and Bug Reports, FAQ, Top | |
6878 @comment node-name, next, previous, up | |
6879 @appendix Getting the Latest CC Mode Release | |
6880 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6881 | |
6882 @ccmode{} has been standard with all versions of Emacs since 19.34 and | |
6883 of XEmacs since 19.16. | |
6884 | |
6885 @cindex web site | |
6886 Due to release schedule skew, it is likely that all of these Emacsen | |
6887 have old versions of @ccmode{} and so should be upgraded. Access to the | |
6888 @ccmode{} source code, as well as more detailed information on Emacsen | |
6889 compatibility, etc. are all available on the web site: | |
6890 | |
6891 @quotation | |
6892 @uref{http://cc-mode.sourceforge.net/} | |
6893 @end quotation | |
6894 | |
6895 | |
6896 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6897 @node Mailing Lists and Bug Reports, GNU Free Documentation License, Updating CC Mode, Top | |
6898 @comment node-name, next, previous, up | |
6899 @appendix Mailing Lists and Submitting Bug Reports | |
6900 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6901 | |
6902 @kindex C-c C-b | |
6903 @findex c-submit-bug-report | |
6904 @findex submit-bug-report (c-) | |
6905 To report bugs, use the @kbd{C-c C-b} (bound to | |
6906 @code{c-submit-bug-report}) command. This provides vital information | |
6907 we need to reproduce your problem. Make sure you include a concise, | |
6908 but complete code example. Please try to boil your example down to | |
6909 just the essential code needed to reproduce the problem, and include | |
6910 an exact recipe of steps needed to expose the bug. Be especially sure | |
6911 to include any code that appears @emph{before} your bug example, if | |
6912 you think it might affect our ability to reproduce it. | |
6913 | |
6914 Please try to produce the problem in an Emacs instance without any | |
6915 customizations loaded (i.e. start it with the @samp{-q --no-site-file} | |
6916 arguments). If it works correctly there, the problem might be caused | |
6917 by faulty customizations in either your own or your site | |
6918 configuration. In that case, we'd appreciate it if you isolate the | |
6919 Emacs Lisp code that triggers the bug and include it in your report. | |
6920 | |
6921 @cindex bug report mailing list | |
6922 Bug reports should be sent to @email{bug-cc-mode@@gnu.org}. You can | |
6923 also send other questions and suggestions (kudos? @t{;-)} to that | |
6924 address. It's a mailing list which you can join or browse an archive | |
6925 of; see the web site at @uref{http://cc-mode.sourceforge.net/} for | |
6926 further details. | |
6927 | |
6928 @cindex announcement mailing list | |
6929 If you want to get announcements of new @ccmode{} releases, send the | |
6930 word @emph{subscribe} in the body of a message to | |
6931 @email{cc-mode-announce-request@@lists.sourceforge.net}. It's possible | |
6932 to subscribe from the web site too. Announcements will also be posted | |
6933 to the Usenet newsgroups @code{gnu.emacs.sources}, @code{comp.emacs}, | |
6934 @code{comp.emacs.xemacs}, @code{comp.lang.c}, @code{comp.lang.c++}, | |
6935 @code{comp.lang.objective-c}, @code{comp.lang.java.softwaretools}, | |
6936 @code{comp.lang.idl}, and @code{comp.lang.awk}. | |
6937 @c There is no newsgroup for Pike. :-( | |
6938 | |
6939 | |
6940 @node GNU Free Documentation License, Command and Function Index, Mailing Lists and Bug Reports, Top | |
6941 @appendix GNU Free Documentation License | |
6942 @include doclicense.texi | |
6943 | |
6944 | |
6945 @c Removed the tentative node "Mode Initialization" from here, 2005/8/27. | |
6946 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6947 @node Command and Function Index, Variable Index, GNU Free Documentation License, Top | |
6948 @comment node-name, next, previous, up | |
6949 @unnumbered Command and Function Index | |
6950 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6951 | |
6952 Since most @ccmode{} commands are prepended with the string | |
6953 @samp{c-}, each appears under its @code{c-@var{thing}} name and its | |
6954 @code{@var{thing} (c-)} name. | |
6955 @iftex | |
6956 @sp 2 | |
6957 @end iftex | |
6958 @printindex fn | |
6959 | |
6960 | |
6961 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6962 @node Variable Index, Concept and Key Index, Command and Function Index, Top | |
6963 @comment node-name, next, previous, up | |
6964 @unnumbered Variable Index | |
6965 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6966 | |
6967 Since most @ccmode{} variables are prepended with the string | |
6968 @samp{c-}, each appears under its @code{c-@var{thing}} name and its | |
6969 @code{@var{thing} (c-)} name. | |
6970 @iftex | |
6971 @sp 2 | |
6972 @end iftex | |
6973 @printindex vr | |
6974 | |
6975 | |
6976 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6977 @node Concept and Key Index, , Variable Index, Top | |
6978 @comment node-name, next, previous, up | |
6979 @unnumbered Concept and Key Index | |
6980 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6981 | |
6982 @printindex cp | |
6983 | |
6984 | |
6985 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6986 @comment Epilogue. | |
6987 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
6988 | |
6989 @iftex | |
6990 @page | |
6991 @summarycontents | |
6992 @contents | |
6993 @end iftex | |
6994 | |
6995 @bye | |
6996 | |
6997 @ignore | |
6998 arch-tag: c4cab162-5e57-4366-bdce-4a9db2fc97f0 | |
6999 @end ignore |