Mercurial > emacs
annotate man/cc-mode.texi @ 65980:4520ae2624f2
* mh-init.el (mh-image-load-path): New function that adds the path to
the MH-E images to the image-load-path or load-path depending on the
version of Emacs.
* mh-customize.el: Call mh-image-load-path just before
mh-tool-bar-define so that the toolbar images can be found.
* mh-customize.el (mh-invisible-header-fields-internal)
(mh-invisible-header-fields-internal): Add Received-SPF header and
X-Gmail- prefixes seen from Gmail. Jeffrey C Honig
<jch@honig.net>
* mh-customize.el (mh-customize): Use customization group mh-e.
* mh-e.el (desktop-buffer-mode-handlers): Only add to this list if
the variable exists. Not present pre-version 22.
(Version, mh-version): Added +cvs to version.
* mh-unit.el (mh-unit): Changed lm-verify test to Emacs 22.
* Makefile: Incorporated ideas from Clemens Fruhwirth to
generalize mh-loaddefs.el to make it work for both GNU Emacs and
XEmacs.
(EMACS_OPTIONS, XEMACS_OPTIONS): Use double-dash for all long
options.
(EMACS_LOADDEFS_COOKIE): New variable for generate-autoload-cookie
setting. Obsoletes XEMACS_LOADDEFS_COOKIE.
(EMACS_EXPORT_MH_LOADDEFS): New variable for GNU Emacs commands to
rebuild mh-loaddefs.el.
(XEMACS_EXPORT_MH_LOADDEFS): New variable for XEmacs commands to
rebuild mh-loaddefs.el. Obsoletes XEMACS_LOADDEFS_FILE and
XEMACS_LOADDEFS_PKG_NAME.
(MH-E-LOADDEFS-SRC): New variable which is set to $(MH-E-SRC) on
GNU Emacs, and adds $(MH-E-XEMACS-SRC) on XEmacs.
(all): Modify EMACS_EXPORT_MH_LOADDEFS and MH-E-LOADDEFS-SRC on
XEMacs.
(mh-loaddefs.el): Now depends on $(MH-E-LOADDEFS-SRC) and has
generic compile command that works on both GNU Emacs XEmacs.
(xemacs): Depend on autoloads instead of deleted loaddefs-xemacs.
(loaddefs-xemacs): Deleted.
* mh-comp.el (mh-font-lock-field-data): Fix a bug where the
function would return t but match-data was being set to nil
(closes SF #1241017). Satyaki Das <satyaki@theforce.stanford.edu>.
* mh-comp.el (mh-insert-auto-fields): Inset identity regardless of
whether one was already set, since if one used a default identity
it would never be overridden. Peter S Galbraith
<psg@debian.org>
* mh-init.el (mh-path): Use customization group mh-e. Thanks to
Peter Whaite for these patches (closes SF #1213716).
* mh-mime.el (mh-compose-forward): Only use mh-sent-from-msg as a
default message if it's a number (as is done elsewhere).
Otherwise, an error is thrown if this function is called from a
draft created by mh-forward since this variable is a list. Also
added a space after the "Messages [%s]:" prompt.
* mh-mime.el (mh-compose-forward): Allow insertion of multiple
forwarded messages by range (including sequences). For the sent
folder the default message presented is the sent message. For
other folders, the default message is "cur", if it exists.
Jeffrey C Honig <jch@honig.net>
author | Bill Wohler <wohler@newt.com> |
---|---|
date | Mon, 10 Oct 2005 16:37:54 +0000 |
parents | 69b3598a61c5 |
children | f3fd456d606b fa0da9b57058 |
rev | line source |
---|---|
25829 | 1 \input texinfo |
2 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3 @c Notes to self regarding line handling: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4 @c |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5 @c Empty lines are often significant before @end directives; avoid them. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
6 @c |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
7 @c Empty lines before and after @example directives are significant in |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
8 @c info output but not in TeX. Empty lines inside @example directives |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
9 @c are significant. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
10 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
11 @c Conventions for formatting examples: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
12 @c o If the example contains empty lines then put the surrounding empty |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
13 @c lines inside the @example directives. Put them outside otherwise. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
14 @c o Use @group inside the example only if it shows indentation where |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
15 @c the relation between lines inside is relevant. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
16 @c o Format line number columns like this: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
17 @c 1: foo |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
18 @c 2: bar |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
19 @c ^ one space |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
20 @c ^^ two columns, right alignment |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
21 @c o Check line lengths in TeX output; they can typically be no longer |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
22 @c than 70 chars, 60 if the paragraph is indented. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
23 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
24 @comment TBD: Document the finer details of statement anchoring? |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
25 |
25829 | 26 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
27 @comment %**start of header (This is for running Texinfo on a region) | |
28 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
29 | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
30 @comment No overfull hbox marks in the dvi file. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
31 @finalout |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
32 |
36924
28d23bbdd2cf
Version merged with the one from CC mode 5.28.
Gerd Moellmann <gerd@gnu.org>
parents:
36923
diff
changeset
|
33 @setfilename ../info/ccmode |
36923 | 34 @settitle CC Mode Manual |
25829 | 35 @footnotestyle end |
36 | |
37 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
38 @comment @setchapternewpage odd !! we don't want blank pages !! | |
39 @comment %**end of header (This is for running Texinfo on a region) | |
40 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
41 | |
42 | |
43 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
59996
aac0a33f5772
Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents:
59032
diff
changeset
|
44 @comment |
25829 | 45 @comment Texinfo manual for CC Mode |
46 @comment Generated from the original README file by Krishna Padmasola | |
47 @comment <krishna@earth-gw.njit.edu> | |
36923 | 48 @comment |
49 @comment Authors: | |
50 @comment Barry A. Warsaw | |
51 @comment Martin Stjernholm | |
52 @comment | |
30396
460a86ced57c
@setfilename to ../info/ccmode.
Gerd Moellmann <gerd@gnu.org>
parents:
30044
diff
changeset
|
53 @comment Maintained by Martin Stjernholm <bug-cc-mode@gnu.org> |
59996
aac0a33f5772
Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents:
59032
diff
changeset
|
54 @comment |
25829 | 55 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
56 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
57 @comment Define an index for syntactic symbols. |
61528
22798b2ebf72
Prevent creating an unnecessary empty cc-mode.ss file.
Lute Kamstra <lute@gnu.org>
parents:
59996
diff
changeset
|
58 @ifnottex |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
59 @defindex ss |
61528
22798b2ebf72
Prevent creating an unnecessary empty cc-mode.ss file.
Lute Kamstra <lute@gnu.org>
parents:
59996
diff
changeset
|
60 @end ifnottex |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
61 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
62 @comment Combine key, syntactic symbol and concept indices into one. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
63 @syncodeindex ss cp |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
64 @syncodeindex ky cp |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
65 |
47737
0a70200bde27
use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents:
46918
diff
changeset
|
66 @copying |
0a70200bde27
use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents:
46918
diff
changeset
|
67 This manual is for CC Mode in Emacs. |
0a70200bde27
use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents:
46918
diff
changeset
|
68 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
69 Copyright @copyright{} 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, |
64890
3723093a21fd
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
63612
diff
changeset
|
70 2003, 2004, 2005 Free Software Foundation, Inc. |
47737
0a70200bde27
use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents:
46918
diff
changeset
|
71 |
0a70200bde27
use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents:
46918
diff
changeset
|
72 @quotation |
36924
28d23bbdd2cf
Version merged with the one from CC mode 5.28.
Gerd Moellmann <gerd@gnu.org>
parents:
36923
diff
changeset
|
73 Permission is granted to copy, distribute and/or modify this document |
65555
69b3598a61c5
Update all manuals to specify GFDL version 1.2.
Romain Francoise <romain@orebokech.com>
parents:
64890
diff
changeset
|
74 under the terms of the GNU Free Documentation License, Version 1.2 or |
36924
28d23bbdd2cf
Version merged with the one from CC mode 5.28.
Gerd Moellmann <gerd@gnu.org>
parents:
36923
diff
changeset
|
75 any later version published by the Free Software Foundation; with the |
28d23bbdd2cf
Version merged with the one from CC mode 5.28.
Gerd Moellmann <gerd@gnu.org>
parents:
36923
diff
changeset
|
76 Invariant Sections being ``The GNU Manifesto'', ``Distribution'' and |
28d23bbdd2cf
Version merged with the one from CC mode 5.28.
Gerd Moellmann <gerd@gnu.org>
parents:
36923
diff
changeset
|
77 ``GNU GENERAL PUBLIC LICENSE'', with the Front-Cover texts being ``A GNU |
28d23bbdd2cf
Version merged with the one from CC mode 5.28.
Gerd Moellmann <gerd@gnu.org>
parents:
36923
diff
changeset
|
78 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the |
28d23bbdd2cf
Version merged with the one from CC mode 5.28.
Gerd Moellmann <gerd@gnu.org>
parents:
36923
diff
changeset
|
79 license is included in the section entitled ``GNU Free Documentation |
28d23bbdd2cf
Version merged with the one from CC mode 5.28.
Gerd Moellmann <gerd@gnu.org>
parents:
36923
diff
changeset
|
80 License'' in the Emacs manual. |
28d23bbdd2cf
Version merged with the one from CC mode 5.28.
Gerd Moellmann <gerd@gnu.org>
parents:
36923
diff
changeset
|
81 |
28d23bbdd2cf
Version merged with the one from CC mode 5.28.
Gerd Moellmann <gerd@gnu.org>
parents:
36923
diff
changeset
|
82 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify |
28d23bbdd2cf
Version merged with the one from CC mode 5.28.
Gerd Moellmann <gerd@gnu.org>
parents:
36923
diff
changeset
|
83 this GNU Manual, like GNU software. Copies published by the Free |
28d23bbdd2cf
Version merged with the one from CC mode 5.28.
Gerd Moellmann <gerd@gnu.org>
parents:
36923
diff
changeset
|
84 Software Foundation raise funds for GNU development.'' |
28d23bbdd2cf
Version merged with the one from CC mode 5.28.
Gerd Moellmann <gerd@gnu.org>
parents:
36923
diff
changeset
|
85 |
28d23bbdd2cf
Version merged with the one from CC mode 5.28.
Gerd Moellmann <gerd@gnu.org>
parents:
36923
diff
changeset
|
86 This document is part of a collection distributed under the GNU Free |
28d23bbdd2cf
Version merged with the one from CC mode 5.28.
Gerd Moellmann <gerd@gnu.org>
parents:
36923
diff
changeset
|
87 Documentation License. If you want to distribute this document |
28d23bbdd2cf
Version merged with the one from CC mode 5.28.
Gerd Moellmann <gerd@gnu.org>
parents:
36923
diff
changeset
|
88 separately from the collection, you can do so by adding a copy of the |
28d23bbdd2cf
Version merged with the one from CC mode 5.28.
Gerd Moellmann <gerd@gnu.org>
parents:
36923
diff
changeset
|
89 license to the document, as described in section 6 of the license. |
47737
0a70200bde27
use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents:
46918
diff
changeset
|
90 @end quotation |
0a70200bde27
use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents:
46918
diff
changeset
|
91 @end copying |
0a70200bde27
use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents:
46918
diff
changeset
|
92 |
0a70200bde27
use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents:
46918
diff
changeset
|
93 @comment Info directory entry for use by install-info. The indentation |
0a70200bde27
use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents:
46918
diff
changeset
|
94 @comment here is by request from the FSF folks. |
0a70200bde27
use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents:
46918
diff
changeset
|
95 @dircategory Emacs |
0a70200bde27
use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents:
46918
diff
changeset
|
96 @direntry |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
97 * CC Mode: (ccmode). Emacs mode for editing C, C++, Objective-C, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
98 Java, Pike, AWK, and CORBA IDL code. |
47737
0a70200bde27
use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents:
46918
diff
changeset
|
99 @end direntry |
25829 | 100 |
101 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
36923 | 102 @comment TeX title page |
25829 | 103 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
104 | |
105 @titlepage | |
106 @sp 10 | |
107 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
108 @center @titlefont{CC Mode 5.30} |
25829 | 109 @sp 2 |
110 @center @subtitlefont{A GNU Emacs mode for editing C and C-like languages} | |
111 @sp 2 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
112 @center Barry A. Warsaw, Martin Stjernholm, Alan Mackenzie (AWK support) |
25829 | 113 |
114 @page | |
115 @vskip 0pt plus 1filll | |
47737
0a70200bde27
use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents:
46918
diff
changeset
|
116 @insertcopying |
25829 | 117 @end titlepage |
118 | |
119 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
120 @comment The Top node contains the master menu for the Info file. | |
121 @comment This appears only in the Info file, not the printed manual. | |
122 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
123 | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
124 @node Top, Introduction, (dir), (dir) |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
125 @comment node-name, next, previous, up |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
126 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
127 @macro ccmode |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
128 CC Mode |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
129 @end macro |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
130 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
131 @ifinfo |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
132 @top @ccmode{} |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
133 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
134 @ccmode{} is a GNU Emacs mode for editing files containing C, C++, |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
135 Objective-C, Java, CORBA IDL (and the variants PSDL and CIDL), Pike |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
136 code and to a certain extent, AWK code @xref{AWK Mode}. It provides |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
137 syntax-based indentation, font locking, and has several handy commands |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
138 and some minor modes to make the editing easier. It does not provide |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
139 tools to look up and navigate between functions, classes etc - there are |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
140 other packages for that. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
141 @end ifinfo |
25829 | 142 |
143 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
144 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
145 | |
146 @menu | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
147 * Introduction:: |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
148 * Getting Connected:: |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
149 * Indentation Engine:: |
25829 | 150 * Minor Modes:: |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
151 * Text Filling and Line Breaking:: |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
152 * Macro Handling:: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
153 * Font Locking:: |
25829 | 154 * Commands:: |
155 * Customizing Indentation:: | |
156 * Syntactic Symbols:: | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
157 * Indentation Functions:: |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
158 * AWK Mode:: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
159 * Odds and Ends:: |
25829 | 160 * Performance Issues:: |
36923 | 161 * Limitations and Known Bugs:: |
25829 | 162 * Frequently Asked Questions:: |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
163 * Getting the Latest CC Mode Release:: |
36923 | 164 * Mailing Lists and Submitting Bug Reports:: |
25829 | 165 * Sample .emacs File:: |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
166 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
167 --- Indices --- |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
168 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
169 * Command and Function Index:: |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
170 * Variable Index:: |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
171 * Concept Index:: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
172 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
173 @detailmenu |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
174 --- The Detailed Node Listing --- |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
175 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
176 Indentation Engine |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
177 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
178 * Syntactic Analysis:: |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
179 * Indentation Calculation:: |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
180 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
181 Minor Modes |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
182 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
183 * Auto-newline Insertion:: |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
184 * Hungry-deletion of Whitespace:: |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
185 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
186 Font Locking |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
187 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
188 * Font Locking Preliminaries:: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
189 * Faces:: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
190 * Documentation Comments:: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
191 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
192 Auto-newline Insertion |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
193 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
194 * Hanging Braces:: |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
195 * Hanging Colons:: |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
196 * Hanging Semicolons and Commas:: |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
197 * Other Electric Commands:: |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
198 * Clean-ups:: |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
199 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
200 Commands |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
201 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
202 * Indentation Commands:: |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
203 * Movement Commands:: |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
204 * Other Commands:: |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
205 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
206 Customizing Indentation |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
207 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
208 * Interactive Customization:: |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
209 * Permanent Customization:: |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
210 * Hooks:: |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
211 * Styles:: |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
212 * Advanced Customizations:: |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
213 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
214 Styles |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
215 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
216 * Built-in Styles:: |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
217 * Choosing a Style:: |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
218 * Adding Styles:: |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
219 * File Styles:: |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
220 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
221 Advanced Customizations |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
222 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
223 * Custom Indentation Functions:: |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
224 * Custom Brace and Colon Hanging:: |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
225 * Customizing Semicolons and Commas:: |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
226 * Other Special Indentations:: |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
227 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
228 AWK Mode |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
229 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
230 * Initialising AWK Mode:: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
231 * AWK Mode Font Locking:: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
232 * AWK Mode Defuns:: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
233 @end detailmenu |
25829 | 234 @end menu |
235 | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
236 |
25829 | 237 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
238 @node Introduction, Getting Connected, Top, Top |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
239 @comment node-name, next, previous, up |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
240 @chapter Introduction |
25829 | 241 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
242 | |
243 @cindex BOCM | |
244 | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
245 Welcome to @ccmode{}, a GNU Emacs mode for editing files containing C, |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
246 C++, Objective-C, Java, CORBA IDL (and the variants CORBA PSDL and |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
247 CIDL), Pike and to a certain extent, AWK code (@pxref{AWK Mode}). This |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
248 incarnation of the mode is descended from @file{c-mode.el} (also called |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
249 ``Boring Old C Mode'' or BOCM @t{:-)}, and @file{c++-mode.el} version 2, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
250 which Barry has been maintaining since 1992. Late in 1997, Martin |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
251 joined the @ccmode{} Maintainers Team, and implemented the Pike support. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
252 As of 2000 Martin has taken over as the sole maintainer. @ccmode{} did |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
253 not originally contain the font lock support for its languages --- that |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
254 was added in version 5.30. AWK support was also added in 5.30 by Alan |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
255 Mackenzie. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
256 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
257 This manual describes @ccmode{} |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
258 @comment The following line must appear on its own, so that the automated |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
259 version 5.30. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
260 @comment Release.py script can update the version number automatically |
25829 | 261 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
262 @ccmode{} supports the editing of K&R and ANSI C, C++, Objective-C, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
263 Java, CORBA's Interface Definition Language, Pike@footnote{A C-like |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
264 scripting language with its roots in the LPC language used in some MUD |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
265 engines. See @uref{http://pike.ida.liu.se/}.} and AWK files. In this |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
266 way, you can easily set up consistent font locking and coding styles for |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
267 use in editing all of these languages, although AWK is not yet as |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
268 uniformly integrated as the other languages. |
25829 | 269 |
270 @findex c-mode | |
271 @findex c++-mode | |
272 @findex objc-mode | |
273 @findex java-mode | |
274 @findex idl-mode | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
275 @findex pike-mode |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
276 @findex awk-mode |
36924
28d23bbdd2cf
Version merged with the one from CC mode 5.28.
Gerd Moellmann <gerd@gnu.org>
parents:
36923
diff
changeset
|
277 Note that the name of this package is ``@ccmode{},'' but there is no top |
25829 | 278 level @code{cc-mode} entry point. All of the variables, commands, and |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
279 functions in @ccmode{} are prefixed with @code{c-@var{thing}}, and |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
280 @code{c-mode}, @code{c++-mode}, @code{objc-mode}, @code{java-mode}, |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
281 @code{idl-mode}, @code{pike-mode}, and @code{awk-mode} entry points are |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
282 provided. This package is intended to be a replacement for |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
283 @file{c-mode.el}, @file{c++-mode.el} and @file{awk-mode.el}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
284 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
285 @c @cindex @file{cc-compat.el} file |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
286 @c This distribution also contains a file |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
287 @c called @file{cc-compat.el} which should ease your transition from BOCM |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
288 @c to @ccmode{}. If you have a BOCM configuration you are really happy |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
289 @c with, and want to postpone learning how to configure @ccmode{}, take a |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
290 @c look at that file. It maps BOCM configuration variables to @ccmode{}'s |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
291 @c indentation model. It is not actively supported so for the long run, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
292 @c you should learn how to customize @ccmode{} to support your coding |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
293 @c style. |
25829 | 294 |
295 A special word of thanks goes to Krishna Padmasola for his work in | |
296 converting the original @file{README} file to Texinfo format. I'd also | |
297 like to thank all the @ccmode{} victims who help enormously during the | |
298 early beta stages of @ccmode{}'s development. | |
299 | |
300 | |
301 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
302 @node Getting Connected, Indentation Engine, Introduction, Top |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
303 @comment node-name, next, previous, up |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
304 @chapter Getting Connected |
25829 | 305 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
306 | |
307 If you got this version of @ccmode{} with Emacs or XEmacs, it should | |
308 work just fine right out of the box. Note however that you may not have | |
309 the latest @ccmode{} release and may want to upgrade your copy. | |
310 | |
311 If you are upgrading an existing @ccmode{} installation, please see the | |
312 @file{README} file for installation details. @ccmode{} may not work | |
313 with older versions of Emacs or XEmacs. See the @ccmode{} release notes | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
314 at @uref{http://cc-mode.sourceforge.net} for the latest information on |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
315 Emacs version and package compatibility (@pxref{Getting the Latest CC |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
316 Mode Release}). |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
317 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
318 @deffn Command c-version |
25829 | 319 @findex version (c-) |
320 You can find out what version of @ccmode{} you are using by visiting a C | |
321 file and entering @kbd{M-x c-version RET}. You should see this message in | |
322 the echo area: | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
323 |
25829 | 324 @example |
325 Using CC Mode version 5.XX | |
326 @end example | |
327 | |
328 @noindent | |
329 where @samp{XX} is the minor release number. | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
330 @end deffn |
25829 | 331 |
332 | |
333 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
334 @node Indentation Engine, Minor Modes, Getting Connected, Top |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
335 @comment node-name, next, previous, up |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
336 @chapter Indentation Engine |
25829 | 337 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
338 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
339 @ccmode{} has an indentation engine that provides a flexible and general |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
340 mechanism for customizing indentation. It separates indentation |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
341 calculation into two steps: first, @ccmode{} analyzes the line of code |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
342 being indented to determine the kind of language construct it's looking |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
343 at, then it applies user defined offsets to the current line based on |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
344 this analysis. |
25829 | 345 |
346 This section will briefly cover how indentation is calculated in | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
347 @ccmode{}. It is important to understand the indentation model being |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
348 used so that you will know how to customize @ccmode{} for your personal |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
349 coding style. All the details are in @ref{Customizing Indentation}, and |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
350 later chapters. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
351 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
352 @defopt c-syntactic-indentation |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
353 @vindex syntactic-indentation (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
354 Syntactic analysis for indentation is done when this is non-@code{nil} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
355 (which is the default). When it's @code{nil} every line is just |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
356 indented to the same level as the previous one, and @kbd{TAB} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
357 (@code{c-indent-command}) adjusts the indentation in steps of |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
358 @code{c-basic-offset}. The indentation style has no effect, nor any of |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
359 the indentation associated variables, e.g., @code{c-special-indent-hook}. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
360 @end defopt |
25829 | 361 |
362 @menu | |
363 * Syntactic Analysis:: | |
364 * Indentation Calculation:: | |
365 @end menu | |
366 | |
367 | |
368 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
369 @node Syntactic Analysis, Indentation Calculation, , Indentation Engine |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
370 @comment node-name, next, previous, up |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
371 @section Syntactic Analysis |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
372 @cindex syntactic analysis |
25829 | 373 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
374 | |
375 @cindex relative buffer position | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
376 @cindex syntactic symbols |
25829 | 377 @cindex syntactic component |
378 @cindex syntactic component list | |
379 The first thing @ccmode{} does when indenting a line of code, is to | |
380 analyze the line, determining the @dfn{syntactic component list} of the | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
381 construct on that line. A syntactic component consists of a pair of |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
382 elements (in lisp parlance, a @emph{cons cell}), the first being |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
383 a @dfn{syntactic symbol}, the second being a @dfn{relative |
25829 | 384 buffer position}. Syntactic symbols describe elements of C code |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
385 @footnote{Unless otherwise noted, the term ``C code'' refers to all |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
386 the C-like languages.}, e.g., @code{statement}, @code{substatement}, |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
387 @code{class-open}, @code{class-close}, etc. @xref{Syntactic Symbols}, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
388 for a complete list of currently recognized syntactic symbols and their |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
389 semantics. The style variable @code{c-offsets-alist} also contains the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
390 list of currently supported syntactic symbols. |
25829 | 391 |
392 Conceptually, a line of C code is always indented relative to the | |
393 indentation of some line higher up in the buffer. This is represented | |
394 by the relative buffer position in the syntactic component. | |
395 | |
396 Here is an example. Suppose we had the following code as the only thing | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
397 in a C++ buffer @footnote{The line numbers in this and future examples |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
398 don't actually appear in the buffer, of course!}: |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
399 |
25829 | 400 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
401 1: void swap( int& a, int& b ) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
402 2: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
403 3: int tmp = a; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
404 4: a = b; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
405 5: b = tmp; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
406 6: @} |
25829 | 407 @end example |
408 | |
409 @kindex C-c C-s | |
410 @findex c-show-syntactic-information | |
411 @findex show-syntactic-information (c-) | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
412 We can use the command @kbd{C-c C-s} (bound to |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
413 @code{c-show-syntactic-information}) to simply report what the |
25829 | 414 syntactic analysis is for the current line. Running this command on |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
415 line 4 of this example, we'd see in the echo area@footnote{With a |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
416 universal argument (i.e., @kbd{C-u C-c C-s}) the analysis is inserted |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
417 into the buffer as a comment on the current line.}: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
418 |
25829 | 419 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
420 ((statement 35)) |
25829 | 421 @end example |
422 | |
423 This tells us that the line is a statement and it is indented relative | |
424 to buffer position 35, which happens to be the @samp{i} in @code{int} on | |
425 line 3. If you were to move point to line 3 and hit @kbd{C-c C-s}, you | |
426 would see: | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
427 |
25829 | 428 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
429 ((defun-block-intro 29)) |
25829 | 430 @end example |
431 | |
432 This indicates that the @samp{int} line is the first statement in a top | |
433 level function block, and is indented relative to buffer position 29, | |
434 which is the brace just after the function header. | |
435 | |
436 Here's another example: | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
437 |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
47737
diff
changeset
|
438 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
439 1: int add( int val, int incr, int doit ) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
440 2: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
441 3: if( doit ) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
442 4: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
443 5: return( val + incr ); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
444 6: @} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
445 7: return( val ); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
446 8: @} |
25829 | 447 @end example |
448 | |
449 @noindent | |
450 Hitting @kbd{C-c C-s} on line 4 gives us: | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
451 |
25829 | 452 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
453 ((substatement-open 46)) |
25829 | 454 @end example |
455 | |
456 @cindex substatement | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
457 @cindex substatement block |
25829 | 458 @noindent |
459 which tells us that this is a brace that @emph{opens} a substatement | |
460 block. @footnote{A @dfn{substatement} is the line after a | |
461 conditional statement, such as @code{if}, @code{else}, @code{while}, | |
462 @code{do}, @code{switch}, etc. A @dfn{substatement | |
463 block} is a brace block following one of these conditional statements.} | |
464 | |
465 @cindex comment-only line | |
466 Syntactic component lists can contain more than one component, and | |
467 individual syntactic components need not have relative buffer positions. | |
468 The most common example of this is a line that contains a @dfn{comment | |
469 only line}. | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
470 |
25829 | 471 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
472 1: void draw_list( List<Drawables>& drawables ) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
473 2: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
474 3: // call the virtual draw() method on each element in list |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
475 4: for( int i=0; i < drawables.count(), ++i ) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
476 5: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
477 6: drawables[i].draw(); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
478 7: @} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
479 8: @} |
25829 | 480 @end example |
481 | |
482 @noindent | |
483 Hitting @kbd{C-c C-s} on line 3 of this example gives: | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
484 |
25829 | 485 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
486 ((comment-intro) (defun-block-intro 46)) |
25829 | 487 @end example |
488 | |
489 @noindent | |
490 and you can see that the syntactic component list contains two syntactic | |
491 components. Also notice that the first component, | |
492 @samp{(comment-intro)} has no relative buffer position. | |
493 | |
494 | |
495 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
496 @node Indentation Calculation, , Syntactic Analysis, Indentation Engine |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
497 @comment node-name, next, previous, up |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
498 @section Indentation Calculation |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
499 @cindex indentation |
25829 | 500 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
501 | |
502 Indentation for a line is calculated using the syntactic | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
503 component list derived in step 1 above (@pxref{Syntactic Analysis}). |
25829 | 504 Each component contributes to the final total indentation of the line in |
505 two ways. | |
506 | |
507 First, the syntactic symbols are looked up in the @code{c-offsets-alist} | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
508 style variable, which is an association list of syntactic symbols and |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
509 the offsets to apply for those symbols. These offsets are added to a |
25829 | 510 running total. |
511 | |
512 Second, if the component has a relative buffer position, @ccmode{} | |
513 adds the column number of that position to the running total. By adding | |
514 up the offsets and columns for every syntactic component on the list, | |
515 the final total indentation for the current line is computed. | |
516 | |
517 Let's use our two code examples above to see how this works. Here is | |
518 our first example again: | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
519 |
25829 | 520 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
521 1: void swap( int& a, int& b ) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
522 2: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
523 3: int tmp = a; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
524 4: a = b; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
525 5: b = tmp; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
526 6: @} |
25829 | 527 @end example |
528 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
529 Let's say point is on line 3 and we hit the @kbd{TAB} key to reindent |
25829 | 530 the line. Remember that the syntactic component list for that |
531 line is: | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
532 |
25829 | 533 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
534 ((defun-block-intro 29)) |
25829 | 535 @end example |
536 | |
537 @noindent | |
538 @ccmode{} looks up @code{defun-block-intro} in the | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
539 @code{c-offsets-alist} style variable. Let's say it finds the value |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
540 @samp{4}; it adds this to the running total (initialized to zero), |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
541 yielding a running total indentation of 4 spaces. |
25829 | 542 |
543 Next @ccmode{} goes to buffer position 29 and asks for the current | |
544 column. This brace is in column zero, so @ccmode{} | |
545 adds @samp{0} to the running total. Since there is only one syntactic | |
546 component on the list for this line, indentation calculation is | |
547 complete, and the total indentation for the line | |
548 is 4 spaces. | |
549 | |
550 Here's another example: | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
551 |
25829 | 552 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
553 1: int add( int val, int incr, int doit ) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
554 2: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
555 3: if( doit ) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
556 4: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
557 5: return( val + incr ); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
558 6: @} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
559 7: return( val ); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
560 8: @} |
25829 | 561 @end example |
562 | |
563 If we were to hit @kbd{TAB} on line 4 in the above example, the same | |
564 basic process is performed, despite the differences in the syntactic | |
565 component list. Remember that the list for this line is: | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
566 |
25829 | 567 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
568 ((substatement-open 46)) |
25829 | 569 @end example |
570 | |
571 Here, @ccmode{} first looks up the @code{substatement-open} symbol | |
572 in @code{c-offsets-alist}. Let's say it finds the value @samp{4}. This | |
573 yields a running total of 4. @ccmode{} then goes to | |
574 buffer position 46, which is the @samp{i} in @code{if} on line 3. This | |
575 character is in the fourth column on that line so adding this to the | |
576 running total yields an indentation for the line of 8 spaces. | |
577 | |
578 Simple, huh? | |
579 | |
580 Actually, the mode usually just does The Right Thing without you having | |
581 to think about it in this much detail. But when customizing | |
582 indentation, it's helpful to understand the general indentation model | |
583 being used. | |
584 | |
585 As you configure @ccmode{}, you might want to set the variable | |
586 @code{c-echo-syntactic-information-p} to non-@code{nil} so that the | |
587 syntactic component list and calculated offset will always be echoed in | |
588 the minibuffer when you hit @kbd{TAB}. | |
589 | |
590 | |
591 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
592 @node Minor Modes, Text Filling and Line Breaking, Indentation Engine, Top |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
593 @comment node-name, next, previous, up |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
594 @chapter Minor Modes |
25829 | 595 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
596 | |
597 @ccmode{} contains two minor-mode-like features that you should | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
598 find useful while entering new C code. The first is called |
25829 | 599 @dfn{auto-newline} mode, and the second is called @dfn{hungry-delete} |
600 mode. These minor modes can be toggled on and off independently, and | |
601 @ccmode{} can be configured so that it starts up with any | |
602 combination of these minor modes. By default, both of these minor modes | |
603 are turned off. | |
604 | |
605 The state of the minor modes is always reflected in the minor mode list | |
606 on the modeline of the @ccmode{} buffer. When auto-newline mode is | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
607 enabled, you will see @samp{C/a} on the mode line@footnote{The @samp{C} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
608 would be replaced with the name of the language in question for the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
609 other languages @ccmode{} supports.}. When hungry delete mode is |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
610 enabled you will see @samp{C/h} and if both modes were enabled, you'd |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
611 see @samp{C/ah}. |
25829 | 612 |
613 @kindex C-c C-a | |
614 @kindex C-c C-d | |
615 @kindex C-c C-t | |
616 @findex c-toggle-hungry-state | |
617 @findex c-toggle-auto-state | |
618 @findex c-toggle-auto-hungry-state | |
619 @findex toggle-hungry-state (c-) | |
620 @findex toggle-auto-state (c-) | |
621 @findex toggle-auto-hungry-state (c-) | |
39267 | 622 @ccmode{} provides key bindings which allow you to toggle the minor |
25829 | 623 modes on the fly while editing code. To toggle just the auto-newline |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
624 state, hit @kbd{C-c C-a} (bound to @code{c-toggle-auto-state}). When |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
625 you do this, you should see the @samp{a} indicator either appear or |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
626 disappear on the modeline. Similarly, to toggle just the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
627 hungry-delete state, use @kbd{C-c C-d} (@code{c-toggle-hungry-state}), |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
628 and to toggle both states, use @kbd{C-c C-t} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
629 (@code{c-toggle-auto-hungry-state}). |
25829 | 630 |
631 To set up the auto-newline and hungry-delete states to your preferred | |
632 values, you would need to add some lisp to your @file{.emacs} file that | |
633 called one of the @code{c-toggle-*-state} functions directly. When | |
634 called programmatically, each function takes a numeric value, where | |
635 a positive number enables the minor mode, a negative number disables the | |
636 mode, and zero toggles the current state of the mode. | |
637 | |
638 So for example, if you wanted to enable both auto-newline and | |
639 hungry-delete for all your C file editing, you could add the following | |
640 to your @file{.emacs} file: | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
641 |
25829 | 642 @example |
643 (add-hook 'c-mode-common-hook | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
644 (lambda () (c-toggle-auto-hungry-state 1))) |
25829 | 645 @end example |
646 | |
647 @menu | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
648 * Auto-newline Insertion:: |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
649 * Hungry-deletion of Whitespace:: |
25829 | 650 @end menu |
651 | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
652 |
25829 | 653 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
654 @node Auto-newline Insertion, Hungry-deletion of Whitespace, , Minor Modes |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
655 @comment node-name, next, previous, up |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
656 @section Auto-newline Insertion |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
657 @cindex auto-newline |
25829 | 658 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
659 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
660 @cindex electric characters |
25829 | 661 Auto-newline minor mode works by enabling certain @dfn{electric |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
662 characters}. Special characters such as the left and right braces, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
663 colons, semicolons, etc., have been made electric to perform some |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
664 magic formatting in addition to inserting the typed character. As a |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
665 general rule, electric characters are only electric when the following |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
666 conditions apply: |
25829 | 667 |
668 @itemize @bullet | |
669 @item | |
670 Auto-newline minor mode is enabled, as evidenced by a @samp{C/a} or | |
671 @samp{C/ah} indicator on the modeline. | |
672 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
673 @item |
25829 | 674 @cindex literal |
675 @cindex syntactic whitespace | |
676 The character was not typed inside of a literal @footnote{A | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
677 @dfn{literal} is defined as any comment, string, or preprocessor macro |
25829 | 678 definition. These constructs are also known as @dfn{syntactic |
679 whitespace} since they are usually ignored when scanning C code.}. | |
680 | |
681 @item | |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
682 No numeric argument was supplied to the command (i.e., it was typed as |
25829 | 683 normal, with no @kbd{C-u} prefix). |
684 @end itemize | |
685 | |
686 @menu | |
687 * Hanging Braces:: | |
688 * Hanging Colons:: | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
689 * Hanging Semicolons and Commas:: |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
690 * Other Electric Commands:: |
25829 | 691 * Clean-ups:: |
692 @end menu | |
693 | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
694 |
25829 | 695 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
696 @node Hanging Braces, Hanging Colons, , Auto-newline Insertion |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
697 @comment node-name, next, previous, up |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
698 @subsection Hanging Braces |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
699 @cindex hanging braces |
25829 | 700 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
701 | |
702 @findex c-electric-brace | |
703 @findex electric-brace (c-) | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
704 @kindex @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
705 @kindex @} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
706 |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
707 When you type either an open or close brace (i.e., @kbd{@{} or @kbd{@}}), |
25829 | 708 the electric command @code{c-electric-brace} gets run. This command has |
709 two electric formatting behaviors. First, it will perform some | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
710 reindentation of the line the brace was typed on, and second, it will |
25829 | 711 add various newlines before and/or after the typed brace. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
712 Reindentation occurs automatically whenever the electric behavior is |
25829 | 713 enabled. If the brace ends up on a line other than the one it was typed |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
714 on, then that line is also reindented. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
715 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
716 The default in auto-newline mode is to insert newlines both before and |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
717 after a brace, but that can be controlled by the |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
718 @code{c-hanging-braces-alist} style variable. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
719 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
720 @defopt c-hanging-braces-alist |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
721 @vindex hanging-braces-alist (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
722 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
723 This variable contains a mapping between syntactic symbols related to |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
724 braces, and a list of places to insert a newline. The syntactic symbols |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
725 that are useful for this list are @code{brace-list-intro}, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
726 @code{statement-cont}, @code{inexpr-class-open}, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
727 @code{inexpr-class-close}, and all the @code{*-open} and @code{*-close} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
728 symbols. @xref{Syntactic Symbols}, for a more detailed description of |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
729 these syntactic symbols, except for @code{inexpr-class-open} and |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
730 @code{inexpr-class-close}, which aren't actual syntactic symbols. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
731 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
732 The braces of anonymous inner classes in Java are given the special |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
733 symbols @code{inexpr-class-open} and @code{inexpr-class-close}, so that |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
734 they can be distinguished from the braces of normal classes@footnote{The |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
735 braces of anonymous classes produce a combination of |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
736 @code{inexpr-class}, and @code{class-open} or @code{class-close} in |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
737 normal indentation analysis.}. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
738 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
739 Note that the aggregate constructs in Pike mode, @samp{(@{}, @samp{@})}, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
740 @samp{([}, @samp{])}, and @samp{(<}, @samp{>)}, do not count as brace |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
741 lists in this regard, even though they do for normal indentation |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
742 purposes. It's currently not possible to set automatic newlines on |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
743 these constructs. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
744 |
25829 | 745 The value associated with each syntactic symbol in this association list |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
746 is called an @var{action}, which can be either a function or a list. |
26490
2b08d829af86
Fix complaints from makeinfo 4.0.
Eli Zaretskii <eliz@gnu.org>
parents:
25829
diff
changeset
|
747 @xref{Custom Brace and Colon Hanging}, for a more detailed discussion of |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
748 using a function as a brace hanging @var{action}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
749 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
750 When the @var{action} is a list, it can contain any combination of the |
25829 | 751 symbols @code{before} and @code{after}, directing @ccmode{} where to |
752 put newlines in relationship to the brace being inserted. Thus, if the | |
753 list contains only the symbol @code{after}, then the brace is said to | |
754 @dfn{hang} on the right side of the line, as in: | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
755 |
25829 | 756 @example |
757 // here, open braces always `hang' | |
758 void spam( int i ) @{ | |
759 if( i == 7 ) @{ | |
760 dosomething(i); | |
761 @} | |
762 @} | |
763 @end example | |
764 | |
765 When the list contains both @code{after} and @code{before}, the braces | |
766 will appear on a line by themselves, as shown by the close braces in the | |
767 above example. The list can also be empty, in which case no newlines | |
768 are added either before or after the brace. | |
769 | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
770 If a syntactic symbol is missing entirely from |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
771 @code{c-hanging-braces-alist}, it's treated in the same way as an |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
772 @var{action} with a list containing @code{before} and @code{after}, so |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
773 that braces by default end up on their own line. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
774 |
25829 | 775 For example, the default value of @code{c-hanging-braces-alist} is: |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
776 |
25829 | 777 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
778 ((brace-list-open) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
779 (brace-entry-open) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
780 (statement-cont) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
781 (substatement-open after) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
782 (block-close . c-snug-do-while) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
783 (extern-lang-open after) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
784 (inexpr-class-open after) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
785 (inexpr-class-close before)) |
25829 | 786 @end example |
787 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
788 @noindent which says that @code{brace-list-open}, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
789 @code{brace-entry-open} and @code{statement-cont}@footnote{Brace lists |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
790 inside statements, such as initializers for static array variables |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
791 inside functions in C, are recognized as @code{statement-cont}. All |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
792 normal substatement blocks are recognized with other symbols.} braces |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
793 should both hang on the right side and allow subsequent text to follow |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
794 on the same line as the brace. Also, @code{substatement-open}, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
795 @code{extern-lang-open}, and @code{inexpr-class-open} braces should hang |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
796 on the right side, but subsequent text should follow on the next line. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
797 The opposite holds for @code{inexpr-class-close} braces; they won't |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
798 hang, but the following text continues on the same line. Here, in the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
799 @code{block-close} entry, you also see an example of using a function as |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
800 an @var{action}. In all other cases, braces are put on a line by |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
801 themselves. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
802 @end defopt |
25829 | 803 |
804 | |
805 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
806 @node Hanging Colons, Hanging Semicolons and Commas, Hanging Braces, Auto-newline Insertion |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
807 @comment node-name, next, previous, up |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
808 @subsection Hanging Colons |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
809 @cindex hanging colons |
25829 | 810 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
811 | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
812 Using a mechanism similar to brace hanging (@pxref{Hanging Braces}), |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
813 colons can also be made to hang using the style variable |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
814 @code{c-hanging-colons-alist}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
815 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
816 @defopt c-hanging-colons-alist |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
817 @vindex hanging-colons-alist (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
818 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
819 The syntactic symbols appropriate for this association list are: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
820 @code{case-label}, @code{label}, @code{access-label}, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
821 @code{member-init-intro}, and @code{inher-intro}. Note however that for |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
822 @code{c-hanging-colons-alist}, @var{action}s as functions are not |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
823 supported. See also @ref{Custom Brace and Colon Hanging} for details. |
25829 | 824 |
825 In C++, double-colons are used as a scope operator but because these | |
826 colons always appear right next to each other, newlines before and after | |
827 them are controlled by a different mechanism, called @dfn{clean-ups} in | |
26490
2b08d829af86
Fix complaints from makeinfo 4.0.
Eli Zaretskii <eliz@gnu.org>
parents:
25829
diff
changeset
|
828 @ccmode{}. @xref{Clean-ups}, for details. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
829 @end defopt |
25829 | 830 |
831 | |
832 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
833 @node Hanging Semicolons and Commas, Other Electric Commands, Hanging Colons, Auto-newline Insertion |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
834 @comment node-name, next, previous, up |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
835 @subsection Hanging Semicolons and Commas |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
836 @cindex hanging semicolons |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
837 @cindex hanging commas |
25829 | 838 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
839 | |
840 Semicolons and commas are also electric in @ccmode{}, but since | |
841 these characters do not correspond directly to syntactic symbols, a | |
842 different mechanism is used to determine whether newlines should be | |
843 automatically inserted after these characters. @xref{Customizing | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
844 Semicolons and Commas}, for details. |
25829 | 845 |
846 | |
847 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
848 @node Other Electric Commands, Clean-ups, Hanging Semicolons and Commas, Auto-newline Insertion |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
849 @comment node-name, next, previous, up |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
850 @subsection Other Electric Commands |
25829 | 851 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
852 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
853 A few other keys also provide electric behavior, often only to reindent |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
854 the line. Common to all of them is that they only reindent if used in |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
855 normal code (as opposed to in a string literal or comment), and |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
856 @code{c-syntactic-indentation} isn't @code{nil}. They are: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
857 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
858 @table @kbd |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
859 @item # |
25829 | 860 @kindex # |
861 @findex c-electric-pound | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
862 @findex electric-pound (c-) |
25829 | 863 @vindex c-electric-pound-behavior |
864 @vindex electric-pound-behavior (c-) | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
865 Pound (bound to @code{c-electric-pound}) is electric when typed as the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
866 first non-whitespace character on a line and not within a macro |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
867 definition. In this case, the variable @code{c-electric-pound-behavior} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
868 is consulted for the electric behavior. This variable takes a list |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
869 value, although the only element currently defined is @code{alignleft}, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
870 which tells this command to force the @samp{#} character into column |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
871 zero. This is useful for entering preprocessor macro definitions. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
872 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
873 Pound is not electric in AWK buffers, where @samp{#} starts a comment, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
874 and is bound to @code{self-insert-command} like any typical printable |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
875 character. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
876 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
877 @item * |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
878 @kindex * |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
879 @itemx / |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
880 @kindex / |
25829 | 881 @findex c-electric-star |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
882 @findex electric-star (c-) |
25829 | 883 @findex c-electric-slash |
884 @findex electric-slash (c-) | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
885 Stars and slashes (bound to @code{c-electric-star} and |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
886 @code{c-electric-slash} respectively) are also electric under certain |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
887 circumstances. If a @samp{*} is inserted as the second character of a C |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
888 style block comment on a comment-only line, then the comment delimiter |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
889 is indented as defined by @code{c-offsets-alist}. A comment-only line |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
890 is defined as a line which contains only a comment, as in: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
891 |
25829 | 892 @example |
893 @group | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
47737
diff
changeset
|
894 void spam( int i ) |
25829 | 895 @{ |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
896 // this is a comment-only line... |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
897 if( i == 7 ) // but this is not |
25829 | 898 @{ |
899 dosomething(i); | |
900 @} | |
901 @} | |
902 @end group | |
903 @end example | |
904 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
905 Likewise, if a @samp{/} is inserted as the second slash in a C++ style |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
906 line comment (also only on a comment-only line), then the line is |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
907 indented as defined by @code{c-offsets-alist}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
908 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
909 In AWK mode, @samp{*} and @samp{/} do not delimit comments and are |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
910 bound to @code{self-insert-command}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
911 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
912 @item < |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
913 @kindex < |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
914 @itemx > |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
915 @kindex > |
25829 | 916 @findex c-electric-lt-gt |
917 @findex electric-lt-gt (c-) | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
918 Less-than and greater-than signs (bound to @code{c-electric-lt-gt}) are |
25829 | 919 electric, but only in C++ mode. Hitting the second of two @kbd{<} or |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
920 @kbd{>} keys reindents the line if it is a C++ style stream operator. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
921 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
922 @item ( |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
923 @kindex ( |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
924 @itemx ) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
925 @kindex ) |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
926 @findex c-electric-paren |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
927 @findex electric-paren (c-) |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
928 The normal parenthesis characters @samp{(} and @samp{)} reindent the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
929 current line. This is useful for getting the closing parenthesis of an |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
930 argument list aligned automatically. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
931 @end table |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
932 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
933 @deffn Command c-electric-continued-statement |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
934 @findex electric-continued-statement (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
935 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
936 Certain keywords, depending on language, are electric to cause |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
937 reindentation when they are preceded only by whitespace on the line. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
938 The keywords are those that continue an earlier statement instead of |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
939 starting a new one: @code{else}, @code{while}, @code{catch} (only in C++ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
940 and Java) and @code{finally} (only in Java). |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
941 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
942 An example: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
943 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
944 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
945 @group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
946 for (i = 0; i < 17; i++) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
947 if (a[i]) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
948 res += a[i]->offset; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
949 else |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
950 @end group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
951 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
952 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
953 Here, the @code{else} should be indented like the preceding @code{if}, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
954 since it continues that statement. @ccmode{} will automatically reindent |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
955 it after the @code{else} has been typed in full, since it's not until |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
956 then it's possible to decide whether it's a new statement or a |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
957 continuation of the preceding @code{if}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
958 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
959 @vindex abbrev-mode |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
960 @findex abbrev-mode |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
961 @cindex Abbrev mode |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
962 @ccmode{} uses Abbrev mode (@pxref{Abbrevs,,, emacs, The Emacs Editor}) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
963 to accomplish this. It's therefore turned on by default in all language |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
964 modes except IDL mode, since CORBA IDL doesn't have any statements. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
965 @end deffn |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
966 |
25829 | 967 |
968 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
969 @node Clean-ups, , Other Electric Commands, Auto-newline Insertion |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
970 @comment node-name, next, previous, up |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
971 @subsection Clean-ups |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
972 @cindex clean-ups |
25829 | 973 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
974 | |
36923 | 975 @dfn{Clean-ups} are mechanisms complementary to colon and brace hanging. |
976 On the surface, it would seem that clean-ups overlap the functionality | |
977 provided by the @code{c-hanging-*-alist} variables. Clean-ups are | |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
978 however used to adjust code ``after-the-fact,'' i.e., to adjust the |
36923 | 979 whitespace in constructs after they are typed. |
980 | |
981 Most of the clean-ups are only applicable to counteract automatically | |
982 inserted newlines, and will therefore only have any effect if the | |
983 auto-newline minor mode is turned on. Others will work all the time. | |
25829 | 984 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
985 @defopt c-cleanup-list |
25829 | 986 @vindex cleanup-list (c-) |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
987 @cindex literal |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
988 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
989 You can configure @ccmode{}'s clean-ups by setting the style variable |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
990 @code{c-cleanup-list}, which is a list of clean-up symbols. By default, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
991 @ccmode{} cleans up only the @code{scope-operator} construct, which is |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
992 necessary for proper C++ support. Note that clean-ups are only |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
993 performed when the construct does not occur within a literal |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
994 (@pxref{Auto-newline Insertion}), and when there is nothing but |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
995 whitespace appearing between the individual components of the construct. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
996 @end defopt |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
997 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
998 These are the clean-ups that are only active in the auto-newline minor |
36923 | 999 mode: |
25829 | 1000 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1001 @c TBD: Would like to use some sort of @deffoo here; @table indents a |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1002 @c bit too much in dvi output. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1003 @table @code |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1004 @item brace-else-brace |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1005 Clean up @samp{@} else @{} constructs by placing the entire construct on |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1006 a single line. Clean-up occurs when the open brace after the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1007 @samp{else} is typed. So for example, this: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1008 |
25829 | 1009 @example |
1010 @group | |
1011 void spam(int i) | |
1012 @{ | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1013 if( i==7 ) @{ |
25829 | 1014 dosomething(); |
1015 @} | |
1016 else | |
1017 @{ | |
1018 @end group | |
1019 @end example | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1020 |
25829 | 1021 @noindent |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1022 appears like this after the last open brace is typed: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1023 |
25829 | 1024 @example |
1025 @group | |
1026 void spam(int i) | |
1027 @{ | |
1028 if( i==7 ) @{ | |
1029 dosomething(); | |
1030 @} else @{ | |
1031 @end group | |
1032 @end example | |
1033 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1034 @item brace-elseif-brace |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1035 Similar to the @code{brace-else-brace} clean-up, but this cleans up |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1036 @samp{@} else if (...) @{} constructs. For example: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1037 |
25829 | 1038 @example |
1039 @group | |
1040 void spam(int i) | |
1041 @{ | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1042 if( i==7 ) @{ |
25829 | 1043 dosomething(); |
1044 @} | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1045 else if( i==3 ) |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1046 @{ |
25829 | 1047 @end group |
1048 @end example | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1049 |
25829 | 1050 @noindent |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1051 appears like this after the last open parenthesis is typed: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1052 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1053 @example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1054 @group |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1055 void spam(int i) |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1056 @{ |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1057 if( i==7 ) @{ |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1058 dosomething(); |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1059 @} else if( i==3 ) |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1060 @{ |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1061 @end group |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1062 @end example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1063 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1064 @noindent |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1065 and like this after the last open brace is typed: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1066 |
25829 | 1067 @example |
1068 @group | |
1069 void spam(int i) | |
1070 @{ | |
1071 if( i==7 ) @{ | |
1072 dosomething(); | |
1073 @} else if( i==3 ) @{ | |
1074 @end group | |
1075 @end example | |
1076 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1077 @item brace-catch-brace |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1078 Analogous to @code{brace-elseif-brace}, but cleans up @samp{@} catch |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1079 (...) @{} in C++ and Java mode. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1080 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1081 @item empty-defun-braces |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1082 Clean up braces following a top-level function or class definition that |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1083 contains no body. Clean up occurs when the closing brace is typed. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1084 Thus the following: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1085 |
25829 | 1086 @example |
1087 @group | |
1088 class Spam | |
1089 @{ | |
1090 @} | |
1091 @end group | |
1092 @end example | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1093 |
25829 | 1094 @noindent |
1095 is transformed into this when the close brace is typed: | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1096 |
25829 | 1097 @example |
1098 @group | |
1099 class Spam | |
1100 @{@} | |
1101 @end group | |
1102 @end example | |
1103 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1104 @item defun-close-semi |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1105 Clean up the terminating semicolon on top-level function or class |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1106 definitions when they follow a close brace. Clean up occurs when the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1107 semicolon is typed. So for example, the following: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1108 |
25829 | 1109 @example |
1110 @group | |
1111 class Spam | |
1112 @{ | |
1113 @} | |
1114 ; | |
1115 @end group | |
1116 @end example | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1117 |
25829 | 1118 @noindent |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1119 is transformed into this when the semicolon is typed: |
25829 | 1120 |
1121 @example | |
1122 @group | |
1123 class Spam | |
1124 @{ | |
1125 @}; | |
1126 @end group | |
1127 @end example | |
1128 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1129 @item list-close-comma |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1130 Clean up commas following braces in array and aggregate initializers. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1131 Clean up occurs when the comma is typed. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1132 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1133 @item scope-operator |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1134 Clean up double colons which may designate a C++ scope operator split |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1135 across multiple lines@footnote{Certain C++ constructs introduce |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1136 ambiguous situations, so @code{scope-operator} clean-ups may not always |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1137 be correct. This usually only occurs when scoped identifiers appear in |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1138 switch label tags.}. Clean up occurs when the second colon is typed. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1139 You will always want @code{scope-operator} in the @code{c-cleanup-list} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1140 when you are editing C++ code. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1141 @end table |
25829 | 1142 |
36923 | 1143 The following clean-ups are always active when they occur on |
1144 @code{c-cleanup-list}, and are thus not affected by the auto-newline | |
1145 minor mode: | |
1146 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1147 @table @code |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1148 @item space-before-funcall |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1149 Insert a space between the function name and the opening parenthesis of |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1150 a function call. This produces function calls in the style mandated by |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
1151 the GNU coding standards, e.g., @samp{signal (SIGINT, SIG_IGN)} and |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1152 @samp{abort ()}. Clean up occurs when the opening parenthesis is typed. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1153 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1154 @item compact-empty-funcall |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1155 Clean up any space between the function name and the opening parenthesis |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1156 of a function call that has no arguments. This is typically used |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1157 together with @code{space-before-funcall} if you prefer the GNU function |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1158 call style for functions with arguments but think it looks ugly when |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
1159 it's only an empty parenthesis pair. I.e., you will get @samp{signal |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1160 (SIGINT, SIG_IGN)}, but @samp{abort()}. Clean up occurs when the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1161 closing parenthesis is typed. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1162 @end table |
36923 | 1163 |
25829 | 1164 |
1165 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1166 @node Hungry-deletion of Whitespace, , Auto-newline Insertion, Minor Modes |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1167 @comment node-name, next, previous, up |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1168 @section Hungry-deletion of Whitespace |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1169 @cindex hungry-deletion |
25829 | 1170 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
1171 | |
1172 Hungry deletion of whitespace, or as it more commonly called, | |
1173 @dfn{hungry-delete mode}, is a simple feature that some people find | |
1174 extremely useful. In fact, you might find yourself wanting | |
1175 hungry-delete in @strong{all} your editing modes! | |
1176 | |
1177 @kindex DEL | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1178 @kindex C-d |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1179 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1180 In a nutshell, when hungry-delete mode is enabled, hitting the @kbd{DEL} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1181 or @kbd{C-d} keys will consume all preceding or following whitespace, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1182 including newlines and tabs. This can really cut down on the number of |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1183 times you have to hit these keys if, for example, you made a mistake on |
25829 | 1184 the preceding line. |
1185 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1186 @deffn Command c-electric-backspace |
25829 | 1187 @findex electric-backspace (c-) |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1188 This command is run by default when you hit the @kbd{DEL} key. It |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1189 deletes any amount of whitespace in the backwards direction if |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1190 hungry-delete mode is enabled. When it's disabled, or when used with |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1191 a prefix argument or in a literal (@pxref{Auto-newline Insertion}), |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1192 the function contained in the @code{c-backspace-function} variable is |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1193 called with the prefix argument. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1194 @end deffn |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1195 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1196 @defvar c-backspace-function |
25829 | 1197 @vindex backspace-function (c-) |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1198 @findex backward-delete-char-untabify |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1199 Hook that gets called by @code{c-electric-backspace} when it doesn't |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1200 do an ``electric'' deletion of the preceding whitespace. The default |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1201 value is @code{backward-delete-char-untabify}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1202 @end defvar |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1203 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1204 @deffn Command c-electric-delete-forward |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1205 @findex electric-delete-forward (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1206 This function, which is bound to @kbd{C-d} by default, works just like |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1207 @code{c-electric-backspace} but in the forward direction. When it |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1208 doesn't do an ``electric'' deletion of the following whitespace, it |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1209 calls the function in @code{c-delete-function} with its prefix |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1210 argument. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1211 @end deffn |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1212 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1213 @defvar c-delete-function |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1214 @vindex delete-function (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1215 @findex delete-char |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1216 Hook that gets called by @code{c-electric-delete-forward} when it |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1217 doesn't do an ``electric'' deletion of the following whitespace. The |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1218 default value is @code{delete-char}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1219 @end defvar |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1220 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1221 Above we have only talked about the @kbd{DEL} and @kbd{C-d} key events, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1222 without connecting them to the physical keys commonly known as |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1223 @key{Backspace} and @key{Delete}. The default behavior of those two |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1224 depends on the flavor of (X)Emacs you are using. |
25829 | 1225 |
1226 @findex c-electric-delete | |
1227 @findex electric-delete (c-) | |
1228 @vindex delete-key-deletes-forward | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1229 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1230 In XEmacs 20.3 and beyond, the @key{Backspace} key is bound to |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1231 @code{c-electric-backspace} and the @key{Delete} key is bound to |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1232 @code{c-electric-delete}. You control the direction it deletes in by |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1233 setting the variable @code{delete-key-deletes-forward}, a standard |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1234 XEmacs variable. When this variable is non-@code{nil}, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1235 @code{c-electric-delete} will do forward deletion with |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1236 @code{c-electric-delete-forward}, otherwise it does backward deletion |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1237 with @code{c-electric-backspace}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1238 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1239 In other Emacs versions, @ccmode{} doesn't bind either @key{Backspace} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1240 or @key{Delete}. In XEmacs 19 and Emacs prior to 21 that means that |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1241 it's up to you to fix them. Emacs 21 automatically binds them as |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1242 appropriate to @kbd{DEL} and @kbd{C-d}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1243 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1244 Another way to use hungry deletion is to bind |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1245 @code{c-hungry-backspace} and @code{c-hungry-delete-forward} directly |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1246 to keys, and not use the mode toggling. For example @kbd{C-c C-d} and |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1247 @kbd{C-c DEL} to match plain @kbd{C-d} and @kbd{DEL}, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1248 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1249 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1250 (add-hook |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1251 'c-mode-common-hook |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1252 (lambda () |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1253 (define-key c-mode-base-map |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1254 [?\C-c ?\d] 'c-hungry-backspace) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1255 (define-key c-mode-base-map |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1256 [?\C-c ?\C-d] 'c-hungry-delete-forward))) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1257 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1258 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1259 @deffn Command c-hungry-backspace |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1260 @findex hungry-backspace (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1261 Delete any amount of whitespace in the backwards direction (regardless |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1262 whether hungry-delete mode is enabled or not). |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1263 @end deffn |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1264 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1265 @deffn Command c-hungry-delete-forward |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1266 @findex hungry-delete-forward (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1267 Delete any amount of whitespace in the forward direction (regardless |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1268 whether hungry-delete mode is enabled or not). |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1269 @end deffn |
25829 | 1270 |
1271 | |
1272 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1273 @node Text Filling and Line Breaking, Macro Handling, Minor Modes, Top |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1274 @comment node-name, next, previous, up |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1275 @chapter Text Filling and Line Breaking |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1276 @cindex text filling |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1277 @cindex line breaking |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1278 @cindex comment handling |
25829 | 1279 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
1280 | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1281 Since there's a lot of normal text in comments and string literals, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1282 @ccmode{} provides features to edit these like in text mode. The goal |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
1283 is to do it as seamlessly as possible, i.e., you can use auto fill mode, |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1284 sentence and paragraph movement, paragraph filling, adaptive filling etc |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1285 wherever there's a piece of normal text without having to think much |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1286 about it. @ccmode{} should keep the indentation, fix the comment line |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1287 decorations, and so on, for you. It does that by hooking in on the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1288 different line breaking functions and tuning relevant variables as |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1289 necessary. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1290 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1291 @vindex c-comment-prefix-regexp |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1292 @vindex comment-prefix-regexp (c-) |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1293 @cindex comment line prefix |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1294 @vindex comment-start |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1295 @vindex comment-end |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1296 @vindex comment-start-skip |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1297 @vindex paragraph-start |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1298 @vindex paragraph-separate |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1299 @vindex paragraph-ignore-fill-prefix |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1300 @vindex adaptive-fill-mode |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1301 @vindex adaptive-fill-regexp |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1302 @vindex adaptive-fill-first-line-regexp |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1303 To make Emacs recognize comments and treat text in them as normal |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1304 paragraphs, @ccmode{} makes several standard |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1305 variables@footnote{@code{comment-start}, @code{comment-end}, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1306 @code{comment-start-skip}, @code{paragraph-start}, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1307 @code{paragraph-separate}, @code{paragraph-ignore-fill-prefix}, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1308 @code{adaptive-fill-mode}, @code{adaptive-fill-regexp}, and |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1309 @code{adaptive-fill-first-line-regexp}.} buffer local and modifies them |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1310 according to the language syntax and the comment line prefix. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1311 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1312 @defopt c-comment-prefix-regexp |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1313 @vindex comment-prefix-regexp (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1314 This style variable contains the regexp used to recognize the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1315 @dfn{comment line prefix}, which is the line decoration that starts |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1316 every line in a comment. The default is @samp{//+\\|\\**}, which |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1317 matches C++ style line comments like |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1318 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1319 @example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1320 // blah blah |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1321 @end example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1322 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1323 @noindent |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1324 with two or more slashes in front of them, and C style block comments |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1325 like |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1326 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1327 @example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1328 @group |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1329 /* |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1330 * blah blah |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1331 */ |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1332 @end group |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1333 @end example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1334 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1335 @noindent |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1336 with zero or more stars at the beginning of every line. If you change |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1337 this variable, please make sure it still matches the comment starter |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
1338 (i.e., @code{//}) of line comments @emph{and} the line prefix inside |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1339 block comments. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1340 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1341 @findex c-setup-paragraph-variables |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1342 @findex setup-paragraph-variables (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1343 Also note that since @ccmode{} uses the value of |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1344 @code{c-comment-prefix-regexp} to set up several other variables at mode |
56646
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
1345 initialization, there won't be any effect if you just change it inside a |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1346 @ccmode{} buffer. You need to call the command |
56646
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
1347 @code{c-setup-paragraph-variables} too, to update those other variables with |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1348 the new value. That's also the case if you modify this variable in a |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1349 mode hook, since @ccmode{} sets up all variables before calling them. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1350 @end defopt |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1351 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1352 @findex auto-fill-mode |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1353 @cindex Auto Fill mode |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1354 @cindex paragraph filling |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1355 Line breaks are by default handled (almost) the same regardless whether |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1356 they are made by auto fill mode (@pxref{Auto Fill,,, emacs, The Emacs |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
1357 Editor}), paragraph filling (e.g., with @kbd{M-q}), or explicitly with |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1358 @kbd{M-j} or similar methods. In string literals, the new line gets the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1359 same indentation as the previous nonempty line (may be changed with the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1360 @code{string} syntactic symbol). In comments, @ccmode{} uses |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1361 @code{c-comment-prefix-regexp} to adapt the line prefix from the other |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1362 lines in the comment. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1363 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1364 @vindex adaptive-fill-mode |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1365 @cindex Adaptive Fill mode |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1366 @ccmode{} uses adaptive fill mode (@pxref{Adaptive Fill,,, emacs, The |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1367 Emacs Editor}) to make Emacs correctly keep the line prefix when filling |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1368 paragraphs. That also makes Emacs preserve the text indentation |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
1369 @emph{inside} the comment line prefix. e.g., in the following comment, |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1370 both paragraphs will be filled with the left margins of the texts kept |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1371 intact: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1372 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1373 @example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1374 @group |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1375 /* Make a balanced b-tree of the nodes in the incoming |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1376 * stream. But, to quote the famous words of Donald E. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1377 * Knuth, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1378 * |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1379 * Beware of bugs in the above code; I have only |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1380 * proved it correct, not tried it. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1381 */ |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1382 @end group |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1383 @end example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1384 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1385 @findex c-setup-filladapt |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1386 @findex setup-filladapt (c-) |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1387 @findex filladapt-mode |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1388 @vindex filladapt-mode |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1389 @cindex Filladapt mode |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1390 It's also possible to use other adaptive filling packages, notably Kyle |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1391 E. Jones' Filladapt package@footnote{It's available from |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1392 @uref{http://www.wonderworks.com/}. As of version 2.12, it does however |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1393 lack a feature that makes it work suboptimally when |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1394 @code{c-comment-prefix-regexp} matches the empty string (which it does |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1395 by default). A patch for that is available from |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1396 @uref{http://cc-mode.sourceforge.net/,, the CC Mode web site}.}, |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1397 which handles things like bulleted lists nicely. There's a convenience |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1398 function @code{c-setup-filladapt} that tunes the relevant variables in |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
1399 Filladapt for use in @ccmode{}. Call it from a mode hook, e.g., with |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1400 something like this in your @file{.emacs}: |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1401 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1402 @example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1403 (defun my-c-mode-common-hook () |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1404 (c-setup-filladapt) |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1405 (filladapt-mode 1)) |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1406 (add-hook 'c-mode-common-hook 'my-c-mode-common-hook) |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1407 @end example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1408 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1409 @defopt c-block-comment-prefix |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1410 @vindex block-comment-prefix (c-) |
25829 | 1411 @vindex c-comment-continuation-stars |
1412 @vindex comment-continuation-stars (c-) | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1413 Normally the comment line prefix inserted for a new line inside a |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1414 comment is deduced from other lines in it. However there's one |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1415 situation when there's no hint about what the prefix should look like, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1416 namely when a block comment is broken for the first time. This style |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1417 variable@footnote{In versions before 5.26, this variable was called |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1418 @code{c-comment-continuation-stars}. As a compatibility measure, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1419 @ccmode{} still uses the value on that variable if it's set.} is used |
56646
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
1420 then as the comment prefix. It defaults to @samp{* |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
1421 }@footnote{Actually, this default setting of |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
1422 @code{c-block-comment-prefix} typically gets overriden by the default |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
1423 style @code{gnu}, which sets it to blank. You can see the line |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
1424 splitting effect described here by setting a different style, |
59032
b362e981bb86
(Text Filling and Line Breaking): Put period after @xref.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56646
diff
changeset
|
1425 e.g. @code{k&r} @xref{Choosing a Style}.}, which makes a comment |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1426 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1427 @example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1428 /* Got O(n^2) here, which is a Bad Thing. */ |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1429 @end example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1430 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1431 @noindent |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1432 break into |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1433 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1434 @example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1435 @group |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1436 /* Got O(n^2) here, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1437 * which is a Bad Thing. */ |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1438 @end group |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1439 @end example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1440 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1441 Note that it won't work to adjust the indentation by putting leading |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1442 spaces in @code{c-block-comment-prefix}, since @ccmode{} still uses the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1443 normal indentation engine to indent the line. Thus, the right way to |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1444 fix the indentation is by customizing the @code{c} syntactic symbol. It |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1445 defaults to @code{c-lineup-C-comments}, which handles the indentation of |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1446 most common comment styles, see @ref{Indentation Functions}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1447 @end defopt |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1448 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1449 @defopt c-ignore-auto-fill |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1450 @vindex ignore-auto-fill (c-) |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1451 When auto fill mode is enabled, @ccmode{} can selectively ignore it |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
1452 depending on the context the line break would occur in, e.g., to never |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1453 break a line automatically inside a string literal. This variable |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1454 takes a list of symbols for the different contexts where auto-filling |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1455 never should occur: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1456 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1457 @table @code |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1458 @item string |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1459 Inside a string or character literal. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1460 @item c |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1461 Inside a C style block comment. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1462 @item c++ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1463 Inside a C++ style line comment. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1464 @item cpp |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1465 Inside a preprocessor directive. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1466 @item code |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
1467 Anywhere else, i.e., in normal code. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1468 @end table |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1469 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1470 By default, @code{c-ignore-auto-fill} is set to @code{'(string cpp |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1471 code)}, which means that auto-filling only occurs in comments when |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1472 auto-fill mode is activated. In literals, it's often desirable to have |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1473 explicit control over newlines. In preprocessor directives, the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1474 necessary @samp{\} escape character before the newline is not |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1475 automatically inserted, so an automatic line break would produce invalid |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1476 code. In normal code, line breaks are normally dictated by some logical |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1477 structure in the code rather than the last whitespace character, so |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1478 automatic line breaks there will produce poor results in the current |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1479 implementation. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1480 @end defopt |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1481 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1482 The commands that do the actual work follow. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1483 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1484 @table @asis |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1485 @item @kbd{M-q} (@code{c-fill-paragraph}) |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1486 @kindex M-q |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1487 @findex c-fill-paragraph |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1488 @findex fill-paragraph (c-) |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1489 @cindex Javadoc markup |
36923 | 1490 @cindex Pike autodoc markup |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1491 This is the replacement for @code{fill-paragraph} in @ccmode{} |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1492 buffers. It's used to fill multiline string literals and both block and |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1493 line style comments. In Java buffers, the Javadoc markup words are |
36923 | 1494 recognized as paragraph starters. The line oriented Pike autodoc markup |
1495 words are recognized in the same way in Pike mode. | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1496 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1497 The function keeps the comment starters and enders of block comments as |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1498 they were before the filling. This means that a comment ender on the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1499 same line as the paragraph being filled will be filled with the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1500 paragraph, and one on a line by itself will stay as it is. The comment |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1501 starter is handled similarly@footnote{This means that the variables |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1502 @code{c-hanging-comment-starter-p} and @code{c-hanging-comment-ender-p}, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1503 which controlled this behavior in earlier versions of @ccmode{}, are now |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1504 obsolete.}. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1505 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1506 @item @kbd{M-j} (@code{c-indent-new-comment-line}) |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1507 @kindex M-j |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1508 @findex c-indent-new-comment-line |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1509 @findex indent-new-comment-line (c-) |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1510 This is the replacement for @code{indent-new-comment-line}. It breaks |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1511 the line at point and indents the new line like the current one. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1512 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1513 @vindex comment-multi-line |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1514 If inside a comment and @code{comment-multi-line} is non-@code{nil}, the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1515 indentation and line prefix are preserved. If inside a comment and |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1516 @code{comment-multi-line} is @code{nil}, a new comment of the same type |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1517 is started on the next line and indented as appropriate for comments. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1518 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1519 Note that @ccmode{} sets @code{comment-multi-line} to @code{t} at |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1520 startup. The reason is that @kbd{M-j} could otherwise produce sequences |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1521 of single line block comments for texts that should logically be treated |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1522 as one comment, and the rest of the paragraph handling code |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
1523 (e.g., @kbd{M-q} and @kbd{M-a}) can't cope with that, which would lead to |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1524 inconsistent behavior. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1525 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1526 @item @kbd{M-x c-context-line-break} |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1527 @findex c-context-line-break |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1528 @findex context-line-break (c-) |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1529 This is a function that works like @code{indent-new-comment-line} in |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1530 comments and @code{newline-and-indent} elsewhere, thus combining those |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1531 two in a way that uses each one in the context it's best suited for. |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
1532 I.e., in comments the comment line prefix and indentation is kept for |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1533 the new line, and in normal code it's indented according to context by |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1534 the indentation engine. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1535 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1536 In macros it acts like @code{newline-and-indent} but additionally |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1537 inserts and optionally aligns the line ending backslash so that the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1538 macro remains unbroken. @xref{Macro Handling}, for details about the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1539 backslash alignment. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1540 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1541 It's not bound to a key by default, but it's intended to be used on the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1542 @kbd{RET} key. If you like the behavior of @code{newline-and-indent} on |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1543 @kbd{RET}, you should consider switching to this function. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1544 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1545 @item @kbd{M-x c-context-open-line} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1546 @findex c-context-open-line |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1547 @findex context-open-line (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1548 This is to @kbd{C-o} (@kbd{M-x open-line}) as |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
1549 @code{c-context-line-break} is to @kbd{RET}. I.e., it works just like |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1550 @code{c-context-line-break} but leaves the point before the inserted |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1551 line break. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1552 @end table |
25829 | 1553 |
1554 | |
1555 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1556 @node Macro Handling, Font Locking, Text Filling and Line Breaking, Top |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1557 @comment node-name, next, previous, up |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1558 @chapter Macro Handling |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1559 @cindex macros |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1560 @cindex preprocessor directives |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1561 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1562 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1563 Preprocessor directives are handled as syntactic whitespace from other |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
1564 code, i.e., they can be interspersed anywhere without affecting the |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1565 syntactic analysis, just like comments. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1566 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1567 The code inside macro definitions is still analyzed syntactically so |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1568 that you get relative indentation there just as you'd get if the same |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1569 code was outside a macro. However, since there is no hint about the |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
1570 syntactic context, i.e., whether the macro expands to an expression, to some |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1571 statements, or perhaps to whole functions, the syntactic recognition can be |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1572 wrong. @ccmode{} manages to figure it out correctly most of the time, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1573 though. @xref{Syntactic Symbols}, for details about the indentation. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1574 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1575 @defopt c-syntactic-indentation-in-macros |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1576 @vindex syntactic-indentation-in-macros (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1577 Enable syntactic analysis inside macros, which is the default. If this |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1578 is @code{nil}, all lines inside macro definitions are analyzed as |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1579 @code{cpp-macro-cont}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1580 @end defopt |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1581 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1582 @ccmode{} provides some tools to help keep the line continuation |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1583 backslashes in macros neat and tidy: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1584 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1585 @table @asis |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1586 @item @kbd{C-c C-\} (@code{c-backslash-region}) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1587 @kindex C-c C-\ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1588 @findex c-backslash-region |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1589 @findex backslash-region (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1590 This function inserts and aligns or deletes the end-of-line backslashes |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1591 in the current region. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1592 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1593 With no prefix argument, it inserts any missing backslashes and aligns |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1594 them according to the @code{c-backslash-column} and |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1595 @code{c-backslash-max-column} variables. With a prefix argument, it |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1596 deletes any backslashes. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1597 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1598 The function does not modify blank lines at the start of the region. If |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1599 the region ends at the start of a line, it always deletes the backslash |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1600 (if any) at the end of the previous line. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1601 @end table |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1602 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1603 @defopt c-backslash-column |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1604 @vindex backslash-column (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1605 @defoptx c-backslash-max-column |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1606 @vindex backslash-max-column (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1607 These variables control the alignment columns for line continuation |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1608 backslashes in multiline macros. They are used by the functions that |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1609 automatically insert or align such backslashes, |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
1610 e.g., @code{c-backslash-region} and @code{c-context-line-break}. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1611 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1612 @code{c-backslash-column} specifies the minimum column for the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1613 backslashes. If any line in the macro exceeds it then the next tab |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1614 stop from that line is used as the alignment column for all the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1615 backslashes, so that they remain in a single column. However, if some |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1616 lines exceed @code{c-backslash-max-column} then the backslashes in the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1617 rest of the macro will be kept at that column, so that the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1618 lines which are too long ``stick out'' instead. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1619 @end defopt |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1620 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1621 @defopt c-auto-align-backslashes |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1622 @vindex auto-align-backslashes (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1623 Align automatically inserted line continuation backslashes if |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1624 non-@code{nil}. When line continuation backslashes are inserted |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
1625 automatically for line breaks in multiline macros, e.g., by |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1626 @code{c-context-line-break}, they are aligned with the other backslashes |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1627 in the same macro if this flag is set. Otherwise the inserted |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1628 backslashes are preceded by a single space. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1629 @end defopt |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1630 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1631 The recommended line breaking function, @code{c-context-line-break} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1632 (@pxref{Text Filling and Line Breaking}), is especially nice if you edit |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1633 multiline macros frequently. When used inside a macro, it automatically |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1634 inserts and adjusts the mandatory backslash at the end of the line to |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1635 keep the macro together, and it leaves the point at the right |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1636 indentation column for the code. Thus you can write code inside macros |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1637 almost exactly as you can elsewhere, without having to bother with the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1638 trailing backslashes. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1639 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1640 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1641 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1642 @node Font Locking, Commands, Macro Handling, Top |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1643 @comment node-name, next, previous, up |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1644 @chapter Font Locking |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1645 @cindex font locking |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1646 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1647 |
59032
b362e981bb86
(Text Filling and Line Breaking): Put period after @xref.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56646
diff
changeset
|
1648 @strong{Please note:} The font locking in AWK mode is currently not integrated |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1649 with the rest of @ccmode{}, so this section does not apply there. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1650 @xref{AWK Mode Font Locking}, instead. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1651 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1652 @cindex Font Lock mode |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1653 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1654 @ccmode{} provides font locking for its supported languages by supplying |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1655 patterns for use with Font Lock mode. This means that you get distinct |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1656 faces on the various syntactic parts such as comments, strings, keywords |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1657 and types, which is very helpful in telling them apart at a glance and |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1658 discovering syntactic errors. @xref{Font Lock,,, emacs, The Emacs |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1659 Editor}, for ways to enable font locking in @ccmode{} buffers. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1660 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1661 @menu |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1662 * Font Locking Preliminaries:: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1663 * Faces:: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1664 * Documentation Comments:: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1665 @end menu |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1666 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1667 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1668 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1669 @node Font Locking Preliminaries, Faces, , Font Locking |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1670 @comment node-name, next, previous, up |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1671 @section Font Locking Preliminaries |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1672 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1673 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1674 The font locking for most of the @ccmode{} languages were provided |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1675 directly by the Font Lock package prior to version 5.30 of @ccmode{}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1676 In the transition to @ccmode{} the patterns have been reworked |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1677 completely and are applied uniformly across all the languages except AWK |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1678 mode, just like the indentation rules (although each language still has |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1679 some pecularities of its own, of course). Since the languages |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1680 previously had completely separate font locking patterns, this means |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1681 that it's a bit different in most languages now. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1682 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1683 The main goal for the font locking in @ccmode{} is accuracy, to provide |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1684 a dependable aid in recognizing the various constructs. Some, like |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1685 strings and comments, are easy to recognize while others like |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1686 declarations and types can be very tricky. @ccmode{} can go to great |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1687 lengths to recognize declarations and casts correctly, especially when |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1688 the types aren't recognized by standard patterns. This is a fairly |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1689 demanding analysis which can be slow on older hardware, and it can |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1690 therefore be disabled by choosing a lower decoration level with the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1691 variable @code{font-lock-maximum-decoration}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1692 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1693 @vindex font-lock-maximum-decoration |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1694 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1695 The decoration levels are used as follows: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1696 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1697 @enumerate |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1698 @comment 1 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1699 @item |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1700 Minimal font locking: Fontify only comments, strings and preprocessor |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1701 directives (in the languages that use cpp). |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1702 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1703 @comment 2 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1704 @item |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1705 Fast normal font locking: In addition to level 1, fontify keywords, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1706 simple types and declarations that are easy to recognize. The variables |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1707 @code{*-font-lock-extra-types} (where @samp{*} is the name of the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1708 language) are used to recognize types (see below). Documentation |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1709 comments like Javadoc are fontified according to |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1710 @code{c-doc-comment-style} (@pxref{Documentation Comments}). |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1711 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1712 Use this if you think the font locking is too slow. It's the closest |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1713 corresponding level to level 3 in the old font lock patterns. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1714 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1715 @comment 3 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1716 @item |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1717 Accurate normal font locking: Like level 2 but uses a different approach |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1718 that can recognize types and declarations much more accurately. The |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1719 @code{*-font-lock-extra-types} variables are still used, but user |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1720 defined types are recognized correctly anyway in most cases. Therefore |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1721 those variables should be fairly restrictive and not contain patterns |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1722 that are uncertain. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1723 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1724 @cindex Lazy Lock mode |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1725 @cindex Just-in-time Lock mode |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1726 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1727 This level is designed for fairly modern hardware and a font lock |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1728 support mode like Lazy Lock or Just-in-time Lock mode that only |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1729 fontifies the parts that are actually shown. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1730 @end enumerate |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1731 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1732 @cindex user defined types |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1733 @cindex types, user defined |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1734 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1735 Since user defined types are hard to recognize you can provide |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1736 additional regexps to match those you use: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1737 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1738 @defopt c-font-lock-extra-types |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1739 @defoptx c++-font-lock-extra-types |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1740 @defoptx objc-font-lock-extra-types |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1741 @defoptx java-font-lock-extra-types |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1742 @defoptx idl-font-lock-extra-types |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1743 @defoptx pike-font-lock-extra-types |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1744 For each language there's a variable @code{*-font-lock-extra-types}, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1745 where @samp{*} stands for the language in question. It contains a list |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1746 of regexps that matches identifiers that should be recognized as types, |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
1747 e.g., @samp{\\sw+_t} to recognize all identifiers ending with @samp{_t} |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1748 as is customary in C code. Each regexp should not match more than a |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1749 single identifier. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1750 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1751 The default values contain regexps for many types in standard runtime |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1752 libraries that are otherwise difficult to recognize, and patterns for |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1753 standard type naming conventions like the @samp{_t} suffix in C and C++. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1754 Java, Objective-C and Pike have as a convention to start class names |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1755 with capitals, so there are patterns for that in those languages. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1756 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1757 Despite the names of these variables, they are not only used for |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1758 fontification but in other places as well where @ccmode{} needs to |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1759 recognize types. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1760 @end defopt |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1761 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1762 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1763 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1764 @node Faces, Documentation Comments, Font Locking Preliminaries, Font Locking |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1765 @comment node-name, next, previous, up |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1766 @section Faces |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1767 @cindex faces |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1768 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1769 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1770 @ccmode{} attempts to use the standard faces for programming languages |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1771 in accordance with their intended purposes as far as possible. No extra |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1772 faces are currently provided, with the exception of a replacement face |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1773 @code{c-invalid-face} for emacsen that don't provide |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1774 @code{font-lock-warning-face}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1775 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1776 @itemize @bullet |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1777 @item |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1778 @vindex font-lock-comment-face |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1779 Normal comments are fontified in @code{font-lock-comment-face}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1780 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1781 @item |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1782 @vindex font-lock-doc-face |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1783 @vindex font-lock-doc-string-face |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1784 @vindex font-lock-comment-face |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1785 Comments that are recognized as documentation (@pxref{Documentation |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1786 Comments}) get @code{font-lock-doc-face} (Emacs) or |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1787 @code{font-lock-doc-string-face} (XEmacs) if those faces exist. If they |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1788 don't then @code{font-lock-comment-face} is used. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1789 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1790 @item |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1791 @vindex font-lock-string-face |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1792 String and character literals are fontified in |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1793 @code{font-lock-string-face}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1794 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1795 @item |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1796 @vindex font-lock-keyword-face |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1797 Keywords are fontified with @code{font-lock-keyword-face}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1798 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1799 @item |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1800 @vindex font-lock-function-name-face |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1801 @code{font-lock-function-name-face} is used for function names in |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1802 declarations and definitions, and classes in those contexts. It's also |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1803 used for preprocessor defines with arguments. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1804 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1805 @item |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1806 @vindex font-lock-variable-name-face |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1807 Variables in declarations and definitions, and other identifiers in such |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1808 variable contexts, get @code{font-lock-variable-name-face}. It's also |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1809 used for preprocessor defines without arguments. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1810 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1811 @item |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1812 @vindex font-lock-constant-face |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1813 @vindex font-lock-reference-face |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1814 Builtin constants are fontified in @code{font-lock-constant-face} if it |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1815 exists, @code{font-lock-reference-face} otherwise. As opposed to the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1816 preceding two faces, this is used on the names in expressions, and it's |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1817 not used in declarations, even if there happen to be a @samp{const} in |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1818 them somewhere. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1819 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1820 @item |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1821 @vindex font-lock-type-face |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1822 @code{font-lock-type-face} is put on types (both predefined and user |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1823 defined) and classes in type contexts. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1824 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1825 @item |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1826 @vindex font-lock-constant-face |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1827 @vindex font-lock-reference-face |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1828 Label identifiers get @code{font-lock-constant-face} if it exists, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1829 @code{font-lock-reference-face} otherwise. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1830 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1831 @item |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1832 Name qualifiers and identifiers for scope constructs are fontified like |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1833 labels. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1834 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1835 @item |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1836 Special markup inside documentation comments are also fontified like |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1837 labels. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1838 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1839 @item |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1840 @vindex font-lock-preprocessor-face |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1841 @vindex font-lock-builtin-face |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1842 @vindex font-lock-reference-face |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1843 Preprocessor directives get @code{font-lock-preprocessor-face} if it |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
1844 exists (i.e., XEmacs). In Emacs they get @code{font-lock-builtin-face} |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1845 or @code{font-lock-reference-face}, for lack of a closer equivalent. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1846 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1847 @item |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1848 @vindex font-lock-warning-face |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1849 @vindex c-invalid-face |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1850 @vindex invalid-face (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1851 Some kinds of syntactic errors are fontified with |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1852 @code{font-lock-warning-face} in Emacs. In older XEmacs versions |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1853 there's no corresponding standard face, so there a special |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1854 @code{c-invalid-face} is used, which is defined to stand out sharply by |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1855 default. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1856 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1857 Note that it's not used for @samp{#error} or @samp{#warning} directives, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1858 since those aren't syntactic errors in themselves. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1859 @end itemize |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1860 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1861 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1862 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1863 @node Documentation Comments, , Faces, Font Locking |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1864 @comment node-name, next, previous, up |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1865 @section Documentation Comments |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1866 @cindex documentation comments |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1867 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1868 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1869 There are various tools to supply documentation in the source as |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
1870 specially structured comments, e.g., the standard Javadoc tool in Java. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1871 @ccmode{} provides an extensible mechanism to fontify such comments and |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1872 the special markup inside them. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1873 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1874 @defopt c-doc-comment-style |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1875 @vindex doc-comment-style (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1876 This is a style variable that specifies which documentation comment |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
1877 style to recognize, e.g., @code{javadoc} for Javadoc comments. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1878 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1879 The value may also be a list of styles, in which case all of them are |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1880 recognized simultaneously (presumably with markup cues that don't |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1881 conflict). |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1882 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1883 The value may also be an association list to specify different comment |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1884 styles for different languages. The symbol for the major mode is then |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1885 looked up in the alist, and the value of that element is interpreted as |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1886 above if found. If it isn't found then the symbol `other' is looked up |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1887 and its value is used instead. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1888 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1889 Note that @ccmode{} uses this variable to set other variables that |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1890 handle fontification etc. That's done at mode initialization or when |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1891 you switch to a style which sets this variable. Thus, if you change it |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
1892 in some other way, e.g., interactively in a CC Mode buffer, you will need |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1893 to do @kbd{M-x java-mode} (or whatever mode you're currently using) to |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1894 reinitialize. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1895 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1896 @findex c-setup-doc-comment-style |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1897 @findex setup-doc-comment-style (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1898 Note also that when @ccmode{} starts up, the other variables are |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1899 modified before the mode hooks are run. If you change this variable in |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1900 a mode hook, you have to call @code{c-setup-doc-comment-style} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1901 afterwards to redo that work. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1902 @end defopt |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1903 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1904 @ccmode{} currently provides handing of the following doc comment |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1905 styles: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1906 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1907 @table @code |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1908 @item javadoc |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1909 @cindex Javadoc markup |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1910 Javadoc comments, the standard tool in Java. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1911 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1912 @item autodoc |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1913 @cindex Pike autodoc markup |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1914 For Pike autodoc markup, the standard in Pike. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1915 @end table |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1916 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1917 The above is by no means complete. If you'd like to see support for |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1918 other doc comment styles, please let us know (@pxref{Mailing Lists and |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1919 Submitting Bug Reports}). |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1920 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1921 You can also write your own doc comment fontification support to use |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1922 with @code{c-doc-comment-style}: Supply a variable or function |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1923 @code{*-font-lock-keywords} where @samp{*} is the name you want to use |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1924 in @code{c-doc-comment-style}. If it's a variable, it's prepended to |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1925 @code{font-lock-keywords}. If it's a function, it's called at mode |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1926 initialization and the result is prepended. For an example, see |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1927 @code{javadoc-font-lock-keywords} in @file{cc-fonts.el}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1928 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1929 If you add support for another doc comment style, please consider |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1930 contributing it --- send a note to @email{bug-cc-mode@@gnu.org}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1931 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1932 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1933 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1934 @node Commands, Customizing Indentation, Font Locking, Top |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1935 @comment node-name, next, previous, up |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1936 @chapter Commands |
25829 | 1937 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
1938 | |
1939 @menu | |
1940 * Indentation Commands:: | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1941 * Movement Commands:: |
25829 | 1942 * Other Commands:: |
1943 @end menu | |
1944 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1945 See also @ref{Text Filling and Line Breaking} and @ref{Macro Handling}, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1946 for commands concerning those bits. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1947 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1948 |
25829 | 1949 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1950 @node Indentation Commands, Movement Commands, , Commands |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1951 @comment node-name, next, previous,up |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1952 @section Indentation Commands |
25829 | 1953 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
1954 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1955 The following list of commands reindent C constructs. Note that when |
59996
aac0a33f5772
Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents:
59032
diff
changeset
|
1956 you change your coding style, either interactively or through some other |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1957 means, your file does @emph{not} automatically get reindented. You |
59996
aac0a33f5772
Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents:
59032
diff
changeset
|
1958 will need to execute one of the following commands to see the effects of |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1959 your changes. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1960 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1961 @cindex GNU indent program |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1962 Also, variables like @code{c-hanging-*} and @code{c-cleanup-list} |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1963 only affect how on-the-fly code is formatted. Changing the |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1964 ``hanginess'' of a brace and then reindenting, will not move the brace |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1965 to a different line. For this, you're better off getting an external |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1966 program like GNU @code{indent}, which will rearrange brace location, |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1967 among other things. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1968 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1969 Reindenting large sections of code can take a long time. When |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1970 @ccmode{} reindents a region of code, it is essentially equivalent to |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1971 hitting @kbd{TAB} on every line of the region. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1972 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1973 These commands are useful when indenting code: |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1974 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1975 @table @asis |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1976 @item @kbd{TAB} (@code{c-indent-command}) |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1977 @kindex TAB |
25829 | 1978 @findex c-indent-command |
1979 @findex indent-command (c-) | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1980 Indents the current line. The actual behavior is controlled by several |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1981 variables, described below. See @code{c-tab-always-indent}, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1982 @code{c-insert-tab-function}, and @code{indent-tabs-mode}. With a |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1983 numeric argument, this command rigidly indents the region, preserving |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1984 the relative indentation among the lines. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1985 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1986 @item @kbd{C-M-q} (@code{c-indent-exp}) |
40705 | 1987 @kindex C-M-q |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1988 @findex c-indent-exp |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1989 @findex indent-exp (c-) |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1990 Indent an entire balanced brace or parenthesis expression. Note that |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1991 point must be on the opening brace or parenthesis of the expression you |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1992 want to indent. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1993 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1994 @item @kbd{C-c C-q} (@code{c-indent-defun}) |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1995 @kindex C-c C-q |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1996 @findex c-indent-defun |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
1997 @findex indent-defun (c-) |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1998 Indents the entire top-level function, class or macro definition |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
1999 encompassing point. It leaves point unchanged. This function can't be |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2000 used to reindent a nested brace construct, such as a nested class or |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2001 function, or a Java method. The top-level construct being reindented |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
2002 must be complete, i.e., it must have both a beginning brace and an ending |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2003 brace. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2004 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2005 @item @kbd{C-M-\} (@code{indent-region}) |
40705 | 2006 @kindex C-M-\ |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2007 @findex indent-region |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2008 Indents an arbitrary region of code. This is a standard Emacs command, |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2009 tailored for C code in a @ccmode{} buffer. Note, of course, that point |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2010 and mark must delineate the region you want to indent. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2011 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2012 @item @kbd{M-;} (@code{indent-for-comment}) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2013 @kindex M-; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2014 @findex indent-for-comment |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2015 Insert a comment at the end of the current line, if none is there already. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2016 Then reindent the comment according to the variables |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2017 @code{c-indent-comment-alist}, @code{c-indent-comments-syntactically-p} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2018 and @code{comment-column}. Then position the point after the comment |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2019 starter. This is a standard Emacs command, but @ccmode{} enhances it a |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2020 bit with two variables: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2021 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2022 @defopt c-indent-comment-alist |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2023 @vindex indent-comment-alist (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2024 @vindex comment-column |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2025 This style variable allows you to control which column @kbd{M-;} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2026 indents the comment to, depending on the preceding code and the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2027 indentation of a similar comment on the preceding line, if there is |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2028 any. It is an association list that maps different types of lines to |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2029 actions describing how they should be handled. If a certain line type |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2030 isn't present on the list then the line is indented to the column |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2031 specified by @code{comment-column}. See the documentation string for |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2032 @code{c-indent-comment-alist} for a full description of the available |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2033 line types and actions (use @kbd{C-h v c-indent-comment-alist}). |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2034 @end defopt |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2035 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2036 @defopt c-indent-comments-syntactically-p |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2037 @vindex indent-comments-syntactically-p (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2038 Normally, when this variable is @code{nil}, @kbd{M-;} will indent |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2039 comment-only lines according to @code{c-indent-comment-alist}, just as |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2040 it does with lines where other code precede the comments. However, if |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2041 you want it to act just like @kbd{TAB} for comment-only lines you can |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2042 get that by setting @code{c-indent-comments-syntactically-p} to |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2043 non-@code{nil}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2044 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2045 If @code{c-indent-comments-syntactically-p} is non-@code{nil} then |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2046 @code{c-indent-comment-alist} won't be consulted at all for comment-only |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2047 lines. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2048 @end defopt |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2049 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2050 @item @kbd{C-M-h} (@code{c-mark-function}) |
40705 | 2051 @kindex C-M-h |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2052 @findex c-mark-function |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2053 @findex mark-function (c-) |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2054 While not strictly an indentation command, this is useful for marking |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2055 the current top-level function or class definition as the current |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2056 region. As with @code{c-indent-defun}, this command operates on |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2057 top-level constructs, and can't be used to mark say, a Java method. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2058 @end table |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2059 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2060 These variables are also useful when indenting code: |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2061 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2062 @defopt c-tab-always-indent |
25829 | 2063 @vindex tab-always-indent (c-) |
2064 @kindex TAB | |
2065 @cindex literal | |
56646
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2066 This variable controls how @kbd{TAB} (@code{c-indent-command}) |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2067 operates. When it is @code{t}, @kbd{TAB} always indents the current |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2068 line. When it is @code{nil}, the line is indented only if point is at |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2069 the left margin, or on or before the first non-whitespace character on |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2070 the line, otherwise some whitespace is inserted. If this variable is |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2071 some other value (not @code{nil} or @code{t}), then some whitespace is |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2072 inserted only within strings and comments (literals), but the line is |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2073 always reindented. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2074 @end defopt |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2075 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2076 @defopt c-insert-tab-function |
25829 | 2077 @vindex insert-tab-function (c-) |
2078 @findex tab-to-tab-stop | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2079 When ``some whitespace'' is inserted as described above, what actually |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2080 happens is that the function stored in @code{c-insert-tab-function} is |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2081 called. Normally, this just inserts a real tab character, or the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2082 equivalent number of spaces, depending on @code{indent-tabs-mode}. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2083 Some people, however, set @code{c-insert-tab-function} to |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2084 @code{tab-to-tab-stop} so as to get hard tab stops when indenting. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2085 @end defopt |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2086 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2087 @defopt indent-tabs-mode |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2088 This is a standard Emacs variable that controls how line indentation |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2089 is composed. When it's non-@code{nil}, tabs can be used in a line's |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2090 indentation, otherwise only spaces can be used. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2091 @end defopt |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2092 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2093 @defopt c-progress-interval |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2094 @vindex progress-interval (c-) |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
47737
diff
changeset
|
2095 When indenting large regions of code, this variable controls how often a |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2096 progress message is displayed. Set this variable to @code{nil} to |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2097 inhibit the progress messages, or set it to an integer which is how |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2098 often (in seconds) progress messages are to be displayed. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2099 @end defopt |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2100 |
25829 | 2101 |
2102 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2103 @node Movement Commands, Other Commands, Indentation Commands, Commands |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2104 @comment node-name, next, previous, up |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2105 @section Movement Commands |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2106 @cindex movement |
25829 | 2107 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
2108 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2109 @ccmode{} contains some useful commands for moving around in C |
25829 | 2110 code. |
2111 | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2112 @table @asis |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2113 @item @kbd{M-x c-beginning-of-defun} |
25829 | 2114 @findex c-beginning-of-defun |
2115 @findex beginning-of-defun (c-) | |
2116 @findex beginning-of-defun | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2117 Move point back to the least-enclosing brace. This function is |
25829 | 2118 analogous to the Emacs built-in command @code{beginning-of-defun}, |
2119 except it eliminates the constraint that the top-level opening brace | |
2120 must be in column zero. See @code{beginning-of-defun} for more | |
2121 information. | |
2122 | |
2123 Depending on the coding style being used, you might prefer | |
2124 @code{c-beginning-of-defun} to @code{beginning-of-defun}. If so, | |
2125 consider binding @kbd{C-M-a} to the former instead. For backwards | |
2126 compatibility reasons, the default binding remains in effect. | |
2127 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2128 In AWK mode, a defun doesn't necessarily have braces at all. AWK Mode |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2129 therefore has its own version of this function which is bound by |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2130 default to @kbd{C-M-a}. You can thus chose freely which function to |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2131 bind to @kbd{C-M-a} for the other modes without worrying about AWK |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2132 buffers. @xref{AWK Mode Defuns}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2133 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2134 @item @kbd{M-x c-end-of-defun} |
25829 | 2135 @findex c-end-of-defun |
2136 @findex end-of-defun (c-) | |
2137 @findex end-of-defun | |
2138 Moves point to the end of the current top-level definition. This | |
2139 function is analogous to the Emacs built-in command @code{end-of-defun}, | |
2140 except it eliminates the constraint that the top-level opening brace of | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2141 the defun must be in column zero. See @code{end-of-defun} for more |
25829 | 2142 information. |
2143 | |
2144 Depending on the coding style being used, you might prefer | |
2145 @code{c-end-of-defun} to @code{end-of-defun}. If so, | |
2146 consider binding @kbd{C-M-e} to the former instead. For backwards | |
2147 compatibility reasons, the default binding remains in effect. | |
2148 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2149 In AWK Mode, a defun doesn't necessarily have braces at all. AWK Mode |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2150 therefore has its own version of this function which is bound by |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2151 default to @kbd{C-M-e}. You can thus chose freely which function to |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2152 bind to @kbd{C-M-e} for the other modes without worrying about AWK |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2153 buffers. @ref{AWK Mode Defuns}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2154 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2155 @item @kbd{C-c C-u} (@code{c-up-conditional}) |
25829 | 2156 @kindex C-c C-u |
2157 @findex c-up-conditional | |
2158 @findex up-conditional (c-) | |
2159 Move point back to the containing preprocessor conditional, leaving the | |
2160 mark behind. A prefix argument acts as a repeat count. With a negative | |
2161 argument, move point forward to the end of the containing | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2162 preprocessor conditional. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2163 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2164 @samp{#elif} is treated like @samp{#else} followed by @samp{#if}, so the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2165 function stops at them when going backward, but not when going forward. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2166 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2167 @item @kbd{M-x c-up-conditional-with-else} |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2168 @findex c-up-conditional-with-else |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2169 @findex up-conditional-with-else (c-) |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2170 A variety of @code{c-up-conditional} that also stops at @samp{#else} |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2171 lines. Normally those lines are ignored. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2172 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2173 @item @kbd{M-x c-down-conditional} |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2174 @findex c-down-conditional |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2175 @findex down-conditional (c-) |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2176 Move point forward into the next nested preprocessor conditional, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2177 leaving the mark behind. A prefix argument acts as a repeat count. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2178 With a negative argument, move point backward into the previous |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2179 nested preprocessor conditional. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2180 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2181 @samp{#elif} is treated like @samp{#else} followed by @samp{#if}, so the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2182 function stops at them when going forward, but not when going backward. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2183 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2184 @item @kbd{M-x c-down-conditional-with-else} |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2185 @findex c-down-conditional-with-else |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2186 @findex down-conditional-with-else (c-) |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2187 A variety of @code{c-down-conditional} that also stops at @samp{#else} |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2188 lines. Normally those lines are ignored. |
25829 | 2189 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2190 @item @kbd{C-c C-p} (@code{c-backward-conditional}) |
25829 | 2191 @kindex C-c C-p |
2192 @findex c-backward-conditional | |
2193 @findex backward-conditional (c-) | |
2194 Move point back over a preprocessor conditional, leaving the mark | |
2195 behind. A prefix argument acts as a repeat count. With a negative | |
2196 argument, move forward. | |
2197 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2198 @item @kbd{C-c C-n} (@code{c-forward-conditional}) |
25829 | 2199 @kindex C-c C-n |
2200 @findex c-forward-conditional | |
2201 @findex forward-conditional (c-) | |
2202 Move point forward across a preprocessor conditional, leaving the mark | |
2203 behind. A prefix argument acts as a repeat count. With a negative | |
2204 argument, move backward. | |
2205 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2206 @item @kbd{M-a} (@code{c-beginning-of-statement}) |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2207 @kindex M-a |
25829 | 2208 @findex c-beginning-of-statement |
2209 @findex beginning-of-statement (c-) | |
2210 Move point to the beginning of the innermost C statement. If point is | |
36923 | 2211 already at the beginning of a statement, move to the beginning of the |
2212 closest preceding statement, even if that means moving into a block (you | |
40705 | 2213 can use @kbd{C-M-b} to move over a balanced block). With prefix |
25829 | 2214 argument @var{n}, move back @var{n} @minus{} 1 statements. |
2215 | |
36923 | 2216 If point is within or next to a comment or a string which spans more |
2217 than one line, this command moves by sentences instead of statements. | |
25829 | 2218 |
2219 When called from a program, this function takes three optional | |
36923 | 2220 arguments: the repetition count, a buffer position limit which is the |
2221 farthest back to search for the syntactic context, and a flag saying | |
2222 whether to do sentence motion in or near comments and multiline strings. | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2223 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2224 @item @kbd{M-e} (@code{c-end-of-statement}) |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2225 @kindex M-e |
25829 | 2226 @findex c-end-of-statement |
2227 @findex end-of-statement (c-) | |
2228 Move point to the end of the innermost C statement. If point is at the | |
2229 end of a statement, move to the end of the next statement, even if it's | |
40705 | 2230 inside a nested block (use @kbd{C-M-f} to move to the other side of the |
25829 | 2231 block). With prefix argument @var{n}, move forward @var{n} @minus{} 1 |
2232 statements. | |
2233 | |
36923 | 2234 If point is within or next to a comment or a string which spans more |
2235 than one line, this command moves by sentences instead of statements. | |
25829 | 2236 |
2237 When called from a program, this function takes three optional | |
36923 | 2238 arguments: the repetition count, a buffer position limit which is the |
2239 farthest back to search for the syntactic context, and a flag saying | |
2240 whether to do sentence motion in or near comments and multiline strings. | |
25829 | 2241 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2242 @item @kbd{M-x c-forward-into-nomenclature} |
25829 | 2243 @findex c-forward-into-nomenclature |
2244 @findex forward-into-nomenclature (c-) | |
2245 A popular programming style, especially for object-oriented languages | |
2246 such as C++ is to write symbols in a mixed case format, where the first | |
2247 letter of each word is capitalized, and not separated by underscores. | |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
2248 e.g., @samp{SymbolsWithMixedCaseAndNoUnderlines}. |
25829 | 2249 |
2250 This command moves point forward to next capitalized word. With prefix | |
2251 argument @var{n}, move @var{n} times. | |
2252 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2253 @item @kbd{M-x c-backward-into-nomenclature} |
25829 | 2254 @findex c-backward-into-nomenclature |
2255 @findex backward-into-nomenclature (c-) | |
2256 Move point backward to beginning of the next capitalized | |
2257 word. With prefix argument @var{n}, move @var{n} times. If | |
2258 @var{n} is negative, move forward. | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2259 @end table |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2260 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2261 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2262 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2263 @node Other Commands, , Movement Commands, Commands |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2264 @comment node-name, next, previous, up |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2265 @section Other Commands |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2266 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2267 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2268 Here are the various other commands that didn't fit anywhere else: |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2269 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2270 @table @asis |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2271 @item @kbd{C-c :} (@code{c-scope-operator}) |
25829 | 2272 @kindex C-c : |
2273 @findex c-scope-operator | |
2274 @findex scope-operator (c-) | |
2275 In C++, it is also sometimes desirable to insert the double-colon scope | |
2276 operator without performing the electric behavior of colon insertion. | |
2277 @kbd{C-c :} does just this. | |
2278 @end table | |
2279 | |
2280 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2281 @node Customizing Indentation, Syntactic Symbols, Commands, Top |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2282 @comment node-name, next, previous, up |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2283 @chapter Customizing Indentation |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2284 @cindex customization, indentation |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2285 @cindex indentation |
25829 | 2286 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
2287 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2288 The context sensitive indentation is mainly controlled by the variable |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2289 @code{c-offsets-alist}: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2290 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2291 @defopt c-offsets-alist |
25829 | 2292 @vindex offsets-alist (c-) |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2293 This special style variable contains the mappings between syntactic |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2294 symbols and the offsets to apply for those symbols. It's set at mode |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2295 initialization from a @emph{style} you may specify. Styles are |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2296 groupings of syntactic symbol offsets and other style variable values. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2297 Most likely, you'll find that one of the predefined styles will suit |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2298 your needs. @xref{Styles}, for an explanation of how to set up named |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2299 styles. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2300 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2301 Only syntactic symbols not already bound on @code{c-offsets-alist} will |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2302 be set from styles. This means that any association you set on it, be |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2303 it before or after mode initialization, will not be changed. The |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
2304 @code{c-offsets-alist} variable may therefore be used from e.g., the |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2305 Customization interface@footnote{Available in Emacs 20 and later, and |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2306 XEmacs 19.15 and later.} to easily change indentation offsets without |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2307 having to bother about styles. Initially @code{c-offsets-alist} is |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2308 empty, so that all syntactic symbols are set by the style system. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2309 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2310 The offset associated with any particular syntactic symbol can be an |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2311 integer, a function or lambda expression, a variable name, a vector, a |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2312 list, or one of the following special symbols: @code{+}, @code{-}, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2313 @code{++}, @code{--}, @code{*}, or @code{/}. The meaning of these |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2314 values are described in detail below. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2315 @end defopt |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2316 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2317 The special symbols describe an offset in multiples of the value of |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2318 @code{c-basic-offset}: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2319 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2320 @defopt c-basic-offset |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2321 @vindex basic-offset (c-) |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2322 Style variable that holds the basic offset between indentation levels. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2323 @end defopt |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2324 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2325 By defining a style's indentation in terms of @code{c-basic-offset}, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2326 you can change the amount of whitespace given to an indentation level |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2327 while maintaining the same basic shape of your code. Here are the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2328 values that the special symbols correspond to: |
25829 | 2329 |
2330 @table @code | |
2331 @item + | |
2332 @code{c-basic-offset} times 1 | |
2333 @item - | |
2334 @code{c-basic-offset} times -1 | |
2335 @item ++ | |
2336 @code{c-basic-offset} times 2 | |
2337 @item -- | |
2338 @code{c-basic-offset} times -2 | |
2339 @item * | |
2340 @code{c-basic-offset} times 0.5 | |
2341 @item / | |
2342 @code{c-basic-offset} times -0.5 | |
2343 @end table | |
2344 | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2345 @cindex indentation functions |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2346 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2347 When a function is used as offset, it's called an @dfn{indentation |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2348 function}. Such functions are useful when more context than just the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2349 syntactic symbol is needed to get the desired indentation. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2350 @xref{Indentation Functions}, and @ref{Custom Indentation Functions}, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2351 for details about them. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2352 |
36923 | 2353 If the offset is a vector, its first element sets the absolute |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2354 indentation column, which will override any previous relative |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2355 indentation. It won't override additional relative indentation for |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2356 nested constructs, though. |
36923 | 2357 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2358 @vindex c-strict-syntax-p |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2359 @vindex strict-syntax-p (c-) |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2360 The offset can also be a list, in which case it is evaluated recursively |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2361 using the semantics described above. The first element of the list that |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2362 returns a non-@code{nil} value succeeds and the evaluation stops. If |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2363 none of the list elements return a non-@code{nil} value, then an offset |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2364 of 0 (zero) is used@footnote{There is however a variable |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2365 @code{c-strict-syntax-p} that, when set to non-@code{nil}, will cause an |
63612 | 2366 error to be signaled in that case. It's now considered obsolete since |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2367 it doesn't work well with some of the alignment functions that now |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2368 returns @code{nil} instead of zero to be more usable in lists. You |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2369 should therefore leave @code{c-strict-syntax-p} set to @code{nil}.}. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2370 |
25829 | 2371 So, for example, because most of the default offsets are defined in |
2372 terms of @code{+}, @code{-}, and @code{0}, if you like the general | |
2373 indentation style, but you use 4 spaces instead of 2 spaces per level, | |
2374 you can probably achieve your style just by changing | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2375 @code{c-basic-offset} like so@footnote{You can try this interactively in |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2376 a C buffer by typing the text that appears in italics.}: |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2377 |
25829 | 2378 @example |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2379 @emph{M-x set-variable RET} |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2380 Set variable: @emph{c-basic-offset RET} |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2381 Set c-basic-offset to value: @emph{4 RET} |
25829 | 2382 @end example |
2383 | |
2384 @noindent | |
2385 This would change | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2386 |
25829 | 2387 @example |
2388 @group | |
2389 int add( int val, int incr, int doit ) | |
2390 @{ | |
2391 if( doit ) | |
2392 @{ | |
2393 return( val + incr ); | |
2394 @} | |
2395 return( val ); | |
2396 @} | |
2397 @end group | |
2398 @end example | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2399 |
25829 | 2400 @noindent |
2401 to | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2402 |
25829 | 2403 @example |
2404 @group | |
2405 int add( int val, int incr, int doit ) | |
2406 @{ | |
2407 if( doit ) | |
2408 @{ | |
2409 return( val + incr ); | |
2410 @} | |
2411 return( val ); | |
2412 @} | |
2413 @end group | |
2414 @end example | |
2415 | |
2416 To change indentation styles more radically, you will want to change the | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2417 offsets associated with other syntactic symbols. First, I'll show you |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2418 how to do that interactively, then I'll describe how to make changes to |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2419 your @file{.emacs} file so that your changes are more permanent. |
25829 | 2420 |
2421 @menu | |
2422 * Interactive Customization:: | |
2423 * Permanent Customization:: | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2424 * Hooks:: |
25829 | 2425 * Styles:: |
2426 * Advanced Customizations:: | |
2427 @end menu | |
2428 | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2429 |
25829 | 2430 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2431 @node Interactive Customization, Permanent Customization, , Customizing Indentation |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2432 @comment node-name, next, previous, up |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2433 @section Interactive Customization |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2434 @cindex customization, interactive |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2435 @cindex interactive customization |
25829 | 2436 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
2437 | |
2438 As an example of how to customize indentation, let's change the | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2439 style of this example@footnote{In this and subsequent examples, the |
25829 | 2440 original code is formatted using the @samp{gnu} style unless otherwise |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2441 indicated. @xref{Styles}.}: |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2442 |
25829 | 2443 @example |
2444 @group | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2445 1: int add( int val, int incr, int doit ) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2446 2: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2447 3: if( doit ) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2448 4: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2449 5: return( val + incr ); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2450 6: @} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2451 7: return( val ); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2452 8: @} |
25829 | 2453 @end group |
2454 @end example | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2455 |
25829 | 2456 @noindent |
2457 to: | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2458 |
25829 | 2459 @example |
2460 @group | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2461 1: int add( int val, int incr, int doit ) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2462 2: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2463 3: if( doit ) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2464 4: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2465 5: return( val + incr ); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2466 6: @} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2467 7: return( val ); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2468 8: @} |
25829 | 2469 @end group |
2470 @end example | |
2471 | |
2472 In other words, we want to change the indentation of braces that open a | |
2473 block following a condition so that the braces line up under the | |
2474 conditional, instead of being indented. Notice that the construct we | |
2475 want to change starts on line 4. To change the indentation of a line, | |
2476 we need to see which syntactic components affect the offset calculations | |
2477 for that line. Hitting @kbd{C-c C-s} on line 4 yields: | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2478 |
25829 | 2479 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2480 ((substatement-open 44)) |
25829 | 2481 @end example |
2482 | |
2483 @noindent | |
2484 so we know that to change the offset of the open brace, we need to | |
2485 change the indentation for the @code{substatement-open} syntactic | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2486 symbol. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2487 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2488 To do this interactively, just hit @kbd{C-c C-o}. This prompts |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2489 you for the syntactic symbol to change, providing a reasonable default. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2490 In this case, the default is @code{substatement-open}, which is just the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2491 syntactic symbol we want to change! |
25829 | 2492 |
2493 After you hit return, @ccmode{} will then prompt you for the new | |
2494 offset value, with the old value as the default. The default in this | |
2495 case is @samp{+}, but we want no extra indentation so enter | |
2496 @samp{0} and @kbd{RET}. This will associate the offset 0 with the | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2497 syntactic symbol @code{substatement-open}. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2498 |
25829 | 2499 To check your changes quickly, just hit @kbd{C-c C-q} |
2500 (@code{c-indent-defun}) to reindent the entire function. The example | |
2501 should now look like: | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2502 |
25829 | 2503 @example |
2504 @group | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2505 1: int add( int val, int incr, int doit ) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2506 2: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2507 3: if( doit ) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2508 4: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2509 5: return( val + incr ); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2510 6: @} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2511 7: return( val ); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2512 8: @} |
25829 | 2513 @end group |
2514 @end example | |
2515 | |
2516 Notice how just changing the open brace offset on line 4 is all we | |
2517 needed to do. Since the other affected lines are indented relative to | |
2518 line 4, they are automatically indented the way you'd expect. For more | |
2519 complicated examples, this may not always work. The general approach to | |
2520 take is to always start adjusting offsets for lines higher up in the | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2521 file, then reindent and see if any following lines need further |
25829 | 2522 adjustments. |
2523 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2524 @deffn Command c-set-offset symbol offset |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2525 @findex set-offset (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2526 @kindex C-c C-o |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2527 This is the command bound to @kbd{C-c C-o}. It provides a convenient |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2528 way to set offsets on @code{c-offsets-alist} both interactively (see |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2529 the example above) and from your mode hook. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2530 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2531 It takes two arguments when used programmatically: @var{symbol} is the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2532 syntactic element symbol to change and @var{offset} is the new offset |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2533 for that syntactic element. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2534 @end deffn |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2535 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2536 |
25829 | 2537 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2538 @node Permanent Customization, Hooks, Interactive Customization, Customizing Indentation |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2539 @comment node-name, next, previous, up |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2540 @section Permanent Customization |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2541 @cindex customization, permanent |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2542 @cindex permanent customization |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2543 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2544 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2545 To make your changes permanent, you need to add some lisp code to your |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2546 @file{.emacs} file. @ccmode{} supports many different ways to be |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2547 configured, from the straightforward way by setting variables globally |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2548 in @file{.emacs} or in the Customization interface, to the complex and |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2549 precisely controlled way by using styles and hook functions. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2550 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2551 The simplest way of customizing @ccmode{} permanently is to set the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2552 variables in your @file{.emacs} with @code{setq} and similar commands. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2553 So to make a permanent setting of @code{substatement-open} to 0, add |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2554 this to the @file{.emacs} file: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2555 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2556 @example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2557 @group |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2558 (setq c-offsets-alist |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2559 '((substatement-open . 0))) |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2560 @end group |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2561 @end example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2562 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2563 When @ccmode{} initializes a buffer, it will fill out |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2564 @code{c-offsets-alist} with the remaining syntactic symbols according to |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2565 the style system. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2566 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2567 You can also use the more user friendly Customization interface, but |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2568 this manual does not cover how that works. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2569 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2570 Variables set like this at the top level in @file{.emacs} take effect in |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2571 all @ccmode{} buffers, regardless of language. The indentation style |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
2572 related variables, e.g., @code{c-offsets-alist}, that you don't set this |
30396
460a86ced57c
@setfilename to ../info/ccmode.
Gerd Moellmann <gerd@gnu.org>
parents:
30044
diff
changeset
|
2573 way get their value from the style system (@pxref{Styles}), and they |
460a86ced57c
@setfilename to ../info/ccmode.
Gerd Moellmann <gerd@gnu.org>
parents:
30044
diff
changeset
|
2574 therefore depend on the setting of @code{c-default-style}. Note that if |
460a86ced57c
@setfilename to ../info/ccmode.
Gerd Moellmann <gerd@gnu.org>
parents:
30044
diff
changeset
|
2575 you use Customize, this means that the greyed-out default values |
460a86ced57c
@setfilename to ../info/ccmode.
Gerd Moellmann <gerd@gnu.org>
parents:
30044
diff
changeset
|
2576 presented there might not be the ones you actually get, since the actual |
460a86ced57c
@setfilename to ../info/ccmode.
Gerd Moellmann <gerd@gnu.org>
parents:
30044
diff
changeset
|
2577 values depend on the style, which may very well be different for |
460a86ced57c
@setfilename to ../info/ccmode.
Gerd Moellmann <gerd@gnu.org>
parents:
30044
diff
changeset
|
2578 different languages. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2579 |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
2580 If you want to make more advanced configurations, e.g., language-specific |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2581 customization, setting global variables isn't enough. For that you can |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2582 use the language hooks, see @ref{Hooks}, and/or the style system, see |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2583 @ref{Styles}. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2584 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2585 @defopt c-style-variables-are-local-p |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2586 @vindex style-variables-are-local-p (c-) |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2587 By default, all style variables are buffer local, so that different |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2588 buffers can have different style settings. If you only use one style |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2589 in all the files you edit you might want to share them between buffers |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2590 so that a change take effect in all buffers. That's done by setting |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2591 this variable to @code{nil}. The value takes effect when @ccmode{} is |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2592 activated in a buffer for the first time in the Emacs session, so you |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2593 typically set it in your @file{.emacs} file and then restart Emacs. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2594 @end defopt |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2595 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2596 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2597 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2598 @node Hooks, Styles, Permanent Customization, Customizing Indentation |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2599 @comment node-name, next, previous, up |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2600 @section Hooks |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2601 @cindex mode hooks |
25829 | 2602 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
2603 | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2604 @ccmode{} provides several hooks that you can use to customize the mode |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2605 according to your coding style. Each language mode has its own hook, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2606 adhering to standard Emacs major mode conventions. There is also one |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2607 general hook and one package initialization hook: |
25829 | 2608 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2609 @defvar c-initialization-hook |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2610 @vindex initialization-hook (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2611 Hook run only once per Emacs session, when @ccmode{} is initialized. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2612 @end defvar |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2613 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2614 @defvar c-mode-common-hook |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2615 @vindex mode-common-hook (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2616 Common hook across all languages. It's run immediately before the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2617 language specific hook. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2618 @end defvar |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2619 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2620 @defvar c-mode-hook |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2621 @defvarx c++-mode-hook |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2622 @defvarx objc-mode-hook |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2623 @defvarx java-mode-hook |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2624 @defvarx idl-mode-hook |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2625 @defvarx pike-mode-hook |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2626 @defvarx awk-mode-hook |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2627 The language specific mode hooks. The appropriate one is run as the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2628 last thing when you enter that language mode. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2629 @end defvar |
36923 | 2630 |
2631 Note that all the language-specific mode setup that CC Mode does is done | |
2632 prior to both @code{c-mode-common-hook} and the language specific hook. | |
2633 That includes installing the indentation style, which can be mode | |
2634 specific (and also is by default for Java mode). Thus, any style | |
2635 settings done in @code{c-mode-common-hook} will override whatever | |
2636 language-specific style is chosen by @code{c-default-style}. | |
25829 | 2637 |
2638 Here's a simplified example of what you can add to your @file{.emacs} | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2639 file to do things whenever any @ccmode{} language is edited. See the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2640 Emacs manuals for more information on customizing Emacs via hooks. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2641 @xref{Sample .emacs File}, for a more complete sample @file{.emacs} |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2642 file. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2643 |
25829 | 2644 @example |
2645 (defun my-c-mode-common-hook () | |
2646 ;; my customizations for all of c-mode and related modes | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2647 (no-case-fold-search) |
25829 | 2648 ) |
2649 (add-hook 'c-mode-common-hook 'my-c-mode-common-hook) | |
2650 @end example | |
2651 | |
2652 | |
2653 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2654 @node Styles, Advanced Customizations, Hooks, Customizing Indentation |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2655 @comment node-name, next, previous, up |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2656 @section Styles |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2657 @cindex styles |
25829 | 2658 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
2659 | |
2660 Most people only need to edit code formatted in just a few well-defined | |
2661 and consistent styles. For example, their organization might impose a | |
2662 ``blessed'' style that all its programmers must conform to. Similarly, | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2663 people who work on GNU software will have to use the GNU coding style. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2664 Some shops are more lenient, allowing a variety of coding styles, and as |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2665 programmers come and go, there could be a number of styles in use. For |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2666 this reason, @ccmode{} makes it convenient for you to set up logical |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2667 groupings of customizations called @dfn{styles}, associate a single name |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2668 for any particular style, and pretty easily start editing new or |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2669 existing code using these styles. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2670 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2671 @cindex style variables |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2672 The variables that the style system affect are called @dfn{style |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2673 variables}. They are handled specially in several ways: |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2674 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2675 @itemize @bullet |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2676 @item |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2677 Style variables are by default buffer local variables. However, they |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2678 can instead be made global by setting |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2679 @code{c-style-variables-are-local-p} to @code{nil} before @ccmode{} is |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2680 initialized. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2681 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2682 @item |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2683 @vindex c-old-style-variable-behavior |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2684 @vindex old-style-variable-behavior (c-) |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2685 The default value of any style variable (with two exceptions --- see |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2686 below) is the special symbol @code{set-from-style}. Variables that are |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2687 still set to that symbol when a @ccmode{} buffer is initialized will be |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2688 set according to the current style, otherwise they will keep their |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2689 current value@footnote{This is a big change from versions of @ccmode{} |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2690 earlier than 5.26, where such settings would get overridden by the style |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2691 system unless special precautions were taken. That was changed since it |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2692 was counterintuitive and confusing, especially to novice users. If your |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2693 configuration depends on the old overriding behavior, you can set the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2694 variable @code{c-old-style-variable-behavior} to non-@code{nil}.}. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2695 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2696 Note that when we talk about the ``default value'' for a style variable, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2697 we don't mean the @code{set-from-style} symbol that all style variables |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2698 are set to initially, but instead the value it will get at mode |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2699 initialization when neither a style nor a global setting has set its |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2700 value. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2701 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2702 The style variable @code{c-offsets-alist} is handled a little |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2703 differently from the other style variables. It's an association list, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2704 and is thus by default set to the empty list, @code{nil}. When the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2705 style system is initialized, any syntactic symbols already on it are |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2706 kept --- only the missing ones are filled in from the chosen style. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2707 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2708 The style variable @code{c-special-indent-hook} is also handled in a |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2709 special way. Styles may only add more functions on this hook, so the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2710 global settings on it are always preserved@footnote{This did not change |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2711 in version 5.26.}. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2712 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2713 @item |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2714 The global settings of style variables get captured in the special |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2715 @code{user} style, which is used as the base for all the other styles. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2716 @xref{Built-in Styles}, for details. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2717 @end itemize |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2718 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2719 The style variables are: |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2720 @code{c-basic-offset}, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2721 @code{c-comment-only-line-offset}, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2722 @code{c-block-comment-prefix}, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2723 @code{c-comment-prefix-regexp}, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2724 @code{c-cleanup-list}, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2725 @code{c-hanging-braces-alist}, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2726 @code{c-hanging-colons-alist}, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2727 @code{c-hanging-semi&comma-criteria}, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2728 @code{c-backslash-column}, |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2729 @code{c-backslash-max-column}, |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2730 @code{c-special-indent-hook}, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2731 @code{c-label-minimum-indentation}, and |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2732 @code{c-offsets-alist}. |
25829 | 2733 |
2734 @menu | |
2735 * Built-in Styles:: | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2736 * Choosing a Style:: |
25829 | 2737 * Adding Styles:: |
2738 * File Styles:: | |
2739 @end menu | |
2740 | |
2741 | |
2742 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2743 @node Built-in Styles, Choosing a Style, , Styles |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2744 @comment node-name, next, previous, up |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2745 @subsection Built-in Styles |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2746 @cindex styles, built-in |
25829 | 2747 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
2748 | |
2749 If you're lucky, one of @ccmode{}'s built-in styles might be just | |
2750 what you're looking for. These include: | |
2751 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2752 @table @code |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2753 @item gnu |
25829 | 2754 @cindex GNU style |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2755 Coding style blessed by the Free Software Foundation |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2756 for C code in GNU programs. |
25829 | 2757 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2758 @item k&r |
25829 | 2759 @cindex K&R style |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2760 The classic Kernighan and Ritchie style for C code. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2761 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2762 @item bsd |
25829 | 2763 @cindex BSD style |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2764 Also known as ``Allman style'' after Eric Allman. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2765 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2766 @item whitesmith |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2767 @cindex Whitesmith style |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2768 Popularized by the examples that came with Whitesmiths C, an early |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2769 commercial C compiler. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2770 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2771 @item stroustrup |
25829 | 2772 @cindex Stroustrup style |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2773 The classic Stroustrup style for C++ code. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2774 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2775 @item ellemtel |
25829 | 2776 @cindex Ellemtel style |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2777 Popular C++ coding standards as defined by ``Programming in C++, Rules |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2778 and Recommendations,'' Erik Nyquist and Mats Henricson, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2779 Ellemtel@footnote{This document is available at |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2780 @uref{http://www.doc.ic.ac.uk/lab/cplus/c++.rules/} among other |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2781 places.}. |
25829 | 2782 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2783 @item linux |
25829 | 2784 @cindex Linux style |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2785 C coding standard for Linux (the kernel). |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2786 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2787 @item python |
25829 | 2788 @cindex Python style |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2789 C coding standard for Python extension modules@footnote{Python is a |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2790 high level scripting language with a C/C++ foreign function interface. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2791 For more information, see @uref{http://www.python.org/}.}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2792 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2793 @item java |
25829 | 2794 @cindex Java style |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2795 The style for editing Java code. Note that the default |
36923 | 2796 value for @code{c-default-style} installs this style when you enter |
2797 @code{java-mode}. | |
25829 | 2798 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2799 @item user |
25829 | 2800 @cindex User style |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2801 This is a special style for several reasons. First, the |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2802 @ccmode{} customizations you do by using either the Customization |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2803 interface, or by writing @code{setq}'s at the top level of your |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2804 @file{.emacs} file, will be captured in the @code{user} style. Also, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2805 all other styles implicitly inherit their settings from @code{user} |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2806 style. This means that for any styles you add via @code{c-add-style} |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2807 (@pxref{Adding Styles}) you need only define the differences between |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2808 your new style and @code{user} style. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2809 @end table |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2810 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2811 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2812 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2813 @node Choosing a Style, Adding Styles, Built-in Styles, Styles |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2814 @comment node-name, next, previous, up |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2815 @subsection Choosing a Style |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2816 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2817 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2818 Use @kbd{C-c .} to choose a style interactively: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2819 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2820 @deffn Command c-set-style style-name |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2821 @findex set-style (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2822 @kindex C-c . |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2823 Switch to the specified style in the current buffer. Use |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2824 interactively like this: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2825 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2826 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2827 @kbd{C-c . @var{style-name} RET} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2828 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2829 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2830 Note that all style names are case insensitive, even the ones you |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2831 define. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2832 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2833 Setting a style in this way does @emph{not} automatically reindent your |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2834 file. For commands that you can use to view the effect of your changes, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2835 see @ref{Commands}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2836 @end deffn |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2837 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2838 The default style in all newly created buffers is @code{gnu}, except |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2839 in Java mode where it's @code{java}. Although the @code{user} style |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2840 is not the default style, any style variable settings you do with the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2841 Customization interface or on the top level in your @file{.emacs} file |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2842 will by default override the style system, so you don't need to set |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2843 @code{c-default-style} to @code{user} to see the effect of such |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2844 settings. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2845 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2846 @defopt c-default-style |
25829 | 2847 @vindex default-style (c-) |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2848 This variable specifies which style to install by default in new |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2849 buffers. It takes either a style name string, or an association list |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2850 of major mode symbols to style names: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2851 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2852 @enumerate |
25829 | 2853 @item |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2854 When @code{c-default-style} is a string, it must be an existing style |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2855 name. This style is then used for all modes. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2856 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2857 @item |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2858 When @code{c-default-style} is an association list, the mode language |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2859 is looked up to find a style name string. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2860 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2861 @item |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2862 If @code{c-default-style} is an association list where the mode |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2863 language mode isn't found then the special symbol @samp{other} is |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2864 looked up. If it's found then the associated style is used. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2865 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2866 @item |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2867 If @samp{other} is not found then the @samp{gnu} style is used. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2868 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2869 @item |
59996
aac0a33f5772
Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents:
59032
diff
changeset
|
2870 In all cases, the style described in @code{c-default-style} is installed |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2871 @emph{before} the language hooks are run, so you can always override |
59996
aac0a33f5772
Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents:
59032
diff
changeset
|
2872 this setting by including an explicit call to @code{c-set-style} in your |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2873 language mode hook, or in @code{c-mode-common-hook}. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2874 @end enumerate |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2875 @end defopt |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2876 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2877 @defvar c-indentation-style |
25829 | 2878 @vindex indentation-style (c-) |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2879 This variable always contains the buffer's current style name, as a |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2880 string. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2881 @end defvar |
25829 | 2882 |
2883 | |
2884 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2885 @node Adding Styles, File Styles, Choosing a Style, Styles |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2886 @comment node-name, next, previous, up |
56646
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2887 @subsection Adding and Amending Styles |
25829 | 2888 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
2889 | |
2890 If none of the built-in styles is appropriate, you'll probably want to | |
56646
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2891 create a new @dfn{style definition}, possibly based on an existing |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2892 style. To do this, put the new style's settings into a list with the |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2893 following format - the list can then be passed as an argument to the |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2894 function @code{c-add-style}: |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2895 |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2896 @cindex style definition |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2897 @defvr {List} style definition |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2898 ([@var{base-style}] [(@var{variable} . @var{value}) @dots{}]) |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2899 |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2900 Optional @var{base-style}, if present, must be a string which is the |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2901 name of the @dfn{base style} from which this style inherits. At most |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2902 one @var{base-style} is allowed in a style definition. If |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2903 @var{base-style} is not specified, the style inherits from a table of |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2904 default values@footnote{This table is stored internally in the |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2905 variable c-fallback-style. It is computed during the initialisation |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2906 of @ccmode{} from the factory defaults of the style variables and any |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2907 global values they may have been given since starting Emacs.} instead. |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2908 All styles eventually inherit from this internal table. Style loops |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2909 generate errors. The list of pre-existing styles can be seen in |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2910 @ref{Built-in Styles}. |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2911 |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2912 The dotted pairs (@var{variable} . @var{value}) each consist of a |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2913 variable and the value it is to be set to when the style is later |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2914 activated.@footnote{In certain circumstances, this value can get |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2915 overridden by another value.} The variable can be either a @ccmode{} |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2916 style variable or an arbitrary Emacs variable. In the latter case, it |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2917 is @emph{not} made buffer local by the @ccmode{} style system. |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2918 @end defvr |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2919 |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2920 Two variables are treated specially in the dotted pair list: |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2921 |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2922 @table @code |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2923 @item c-offsets-alist |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2924 The value is in turn a dotted list on the form |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2925 |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2926 (@var{syntactic-symbol} . @var{offset}) |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2927 |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2928 as described in @ref{Customizing Indentation}. These are passed to |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2929 @code{c-set-offset} so there is no need to set every syntactic symbol in |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2930 your style, only those that are different from the inherited style. |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2931 |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2932 @item c-special-indent-hook |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2933 The value is added to @code{c-special-indent-hook} using |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2934 @code{add-hook}, so any functions already on it are kept. If the value |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2935 is a list, each element of the list is added with @code{add-hook}. |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2936 @end table |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2937 |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2938 Styles are kept in the @code{c-style-alist} variable, but you |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2939 should never modify this variable directly. Instead, @ccmode{} |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2940 provides the function @code{c-add-style} for this purpose. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2941 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2942 @defun c-add-style stylename description &optional set-p |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2943 @findex add-style (c-) |
56646
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2944 Add or update a style called @var{stylename}, a string. |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2945 @var{description} is the new style definition in the form described |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2946 above. If @var{stylename} already exists in @code{c-style-alist} then |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2947 it is replaced by @var{description}. (Note, this replacement is |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2948 total. The old style is @emph{not} merged into the new one.) |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2949 Otherwise, a new style is added. If the optional @var{set-p} is |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2950 non-@code{nil} then the new style is applied to the current buffer as |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
2951 well. |
25829 | 2952 |
2953 The sample @file{.emacs} file provides a concrete example of how a new | |
2954 style can be added and automatically set. @xref{Sample .emacs File}. | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2955 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2956 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2957 @defvar c-style-alist |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2958 @vindex style-alist (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2959 This is the variable that holds the definitions for the styles. It |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2960 should not be changed directly; use @code{c-add-style} instead. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2961 @end defvar |
25829 | 2962 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2963 |
25829 | 2964 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2965 @node File Styles, , Adding Styles, Styles |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2966 @comment node-name, next, previous, up |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
2967 @subsection File Styles |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2968 @cindex styles, file local |
25829 | 2969 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
2970 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2971 @cindex file local variables |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2972 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2973 The Emacs manual describes how you can customize certain variables on |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2974 a per-file basis by including a @dfn{file local variable} block at the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2975 end of the file. So far, you've only seen a functional interface to |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2976 @ccmode{} customization, which can't be used there. @ccmode{} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2977 provides two variables allow customization of the indentation style on |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2978 a per-file basis: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2979 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2980 @defvar c-file-style |
25829 | 2981 @vindex file-style (c-) |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2982 This variable can be set to a style name string. When the file is |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2983 visited, @ccmode{} will automatically set the file's style to this |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2984 one using @code{c-set-style}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2985 @end defvar |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2986 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2987 @defvar c-file-offsets |
25829 | 2988 @vindex file-offsets (c-) |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2989 This variable takes an association list similar to what is allowed in |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2990 @code{c-offsets-alist}. When the file is visited, @ccmode{} will |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2991 automatically institute these offsets using @code{c-set-offset}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
2992 @end defvar |
25829 | 2993 |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
2994 Note that file style settings (i.e., @code{c-file-style}) are applied |
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
2995 before file offset settings (i.e., @code{c-file-offsets}). Also, if |
25829 | 2996 either of these are set in a file's local variable section, all the |
2997 style variable values are made local to that buffer. | |
2998 | |
2999 | |
3000 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3001 @node Advanced Customizations, , Styles, Customizing Indentation |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3002 @comment node-name, next, previous, up |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3003 @section Advanced Customizations |
25829 | 3004 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
3005 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3006 For most users, @ccmode{} will support their coding styles with very |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3007 little need for more advanced customizations. Usually, one of the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3008 standard styles (@pxref{Built-in Styles}) will do the trick. At most, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3009 perhaps one of the syntactic symbol offsets will need to be tweaked |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3010 slightly, or maybe @code{c-basic-offset} will need to be changed. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3011 However, some styles require a more flexible framework for |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3012 customization, and one of the real strengths of @ccmode{} is that the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3013 syntactic analysis model provides just such a framework. This allows |
25829 | 3014 you to implement custom indentation calculations for situations not |
3015 handled by the mode directly. | |
3016 | |
3017 @menu | |
3018 * Custom Indentation Functions:: | |
3019 * Custom Brace and Colon Hanging:: | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3020 * Customizing Semicolons and Commas:: |
25829 | 3021 * Other Special Indentations:: |
3022 @end menu | |
3023 | |
3024 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3025 @node Custom Indentation Functions, Custom Brace and Colon Hanging, , Advanced Customizations |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3026 @comment node-name, next, previous, up |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3027 @subsection Custom Indentation Functions |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3028 @cindex customization, indentation functions |
25829 | 3029 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
3030 | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3031 The most flexible way to customize @ccmode{} is by writing custom |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3032 indentation functions, and associating them with specific syntactic |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3033 symbols (@pxref{Syntactic Symbols}). @ccmode{} itself uses indentation |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3034 functions to provide more sophisticated indentation, for example when |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3035 lining up C++ stream operator blocks: |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3036 |
25829 | 3037 @example |
3038 @group | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3039 1: void main(int argc, char**) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3040 2: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3041 3: cout << "There were " |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3042 4: << argc |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3043 5: << "arguments passed to the program" |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3044 6: << endl; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3045 7: @} |
25829 | 3046 @end group |
3047 @end example | |
3048 | |
3049 In this example, lines 4 through 6 are assigned the @code{stream-op} | |
3050 syntactic symbol. Here, @code{stream-op} has an offset of @code{+}, and | |
3051 with a @code{c-basic-offset} of 2, you can see that lines 4 through 6 | |
3052 are simply indented two spaces to the right of line 3. But perhaps we'd | |
3053 like @ccmode{} to be a little more intelligent so that it aligns | |
3054 all the @samp{<<} symbols in lines 3 through 6. To do this, we have | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3055 to write a custom indentation function which finds the column of the first |
59996
aac0a33f5772
Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents:
59032
diff
changeset
|
3056 stream operator on the first line of the statement. Here is sample |
25829 | 3057 lisp code implementing this: |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3058 |
25829 | 3059 @example |
3060 (defun c-lineup-streamop (langelem) | |
3061 (save-excursion | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3062 (goto-char (cdr langelem)) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3063 (re-search-forward "<<\\|>>" (c-point 'eol) 'move) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3064 (goto-char (match-beginning 0)) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3065 (vector (current-column)))) |
25829 | 3066 @end example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3067 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3068 Indentation functions take a single argument, which is a syntactic |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3069 component cons cell (@pxref{Syntactic Analysis}). The function can |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3070 return an integer which is added to the running total indentation for |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3071 the line, or a vector containing an integer which is an absolute |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3072 column to align to. Usually an absolute column is wanted when |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3073 aligning to existing text, as in this example. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3074 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3075 The function should return @code{nil} if it's used in a situation where |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3076 it doesn't want to make any decision. If the function is used in a list |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3077 expression (@pxref{Customizing Indentation}), that will cause @ccmode{} |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3078 to go on and check the next entry in the list. |
25829 | 3079 |
3080 Now, to associate the function @code{c-lineup-streamop} with the | |
3081 @code{stream-op} syntactic symbol, we can add something like the | |
3082 following to our @code{c++-mode-hook}@footnote{It probably makes more | |
3083 sense to add this to @code{c++-mode-hook} than @code{c-mode-common-hook} | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3084 since stream operators are only relevant for C++.}: |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3085 |
25829 | 3086 @example |
3087 (c-set-offset 'stream-op 'c-lineup-streamop) | |
3088 @end example | |
3089 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3090 Now the function looks like this after reindenting (using @kbd{C-c |
25829 | 3091 C-q}): |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3092 |
25829 | 3093 @example |
3094 @group | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3095 1: void main(int argc, char**) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3096 2: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3097 3: cout << "There were " |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3098 4: << argc |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3099 5: << " arguments passed to the program" |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3100 6: << endl; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3101 7: @} |
25829 | 3102 @end group |
3103 @end example | |
3104 | |
3105 Custom indentation functions can be as simple or as complex as you like, | |
3106 and any syntactic symbol that appears in @code{c-offsets-alist} can have | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3107 a custom indentation function associated with it. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3108 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3109 @ccmode{} comes with an extensive set of predefined indentation |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3110 functions, not all of which are used by the default styles. So there's |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3111 a good chance the function you want already exists. @xref{Indentation |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3112 Functions}, for a list of them. If you have written an indentation |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3113 function that you think is generally useful, you're very welcome to |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3114 contribute it; please contact @email{bug-cc-mode@@gnu.org}. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3115 |
25829 | 3116 |
3117 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3118 @node Custom Brace and Colon Hanging, Customizing Semicolons and Commas, Custom Indentation Functions, Advanced Customizations |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3119 @comment node-name, next, previous, up |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3120 @subsection Custom Brace and Colon Hanging |
25829 | 3121 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
3122 | |
3123 @vindex c-hanging-braces-alist | |
3124 @vindex hanging-braces-alist (c-) | |
3125 Syntactic symbols aren't the only place where you can customize | |
3126 @ccmode{} with the lisp equivalent of callback functions. Brace | |
3127 ``hanginess'' can also be determined by custom functions associated with | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3128 syntactic symbols on the @code{c-hanging-braces-alist} style variable. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3129 Remember that @var{action}'s are typically a list containing some |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3130 combination of the symbols @code{before} and @code{after} |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3131 (@pxref{Hanging Braces}). However, an @var{action} can also be a |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3132 function which gets called when a brace matching that syntactic symbol |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3133 is entered. |
25829 | 3134 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3135 @cindex customization, brace hanging |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3136 These @var{action} functions are called with two arguments: the |
25829 | 3137 syntactic symbol for the brace, and the buffer position at which the |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3138 brace was inserted. The @var{action} function is expected to return a |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3139 list containing some combination of @code{before} and @code{after}, |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
3140 including neither of them (i.e., @code{nil}). This return value has the |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3141 normal brace hanging semantics. |
25829 | 3142 |
3143 As an example, @ccmode{} itself uses this feature to dynamically | |
3144 determine the hanginess of braces which close ``do-while'' | |
3145 constructs: | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3146 |
25829 | 3147 @example |
3148 void do_list( int count, char** atleast_one_string ) | |
3149 @{ | |
3150 int i=0; | |
3151 do @{ | |
3152 handle_string( atleast_one_string[i] ); | |
3153 i++; | |
3154 @} while( i < count ); | |
3155 @} | |
3156 @end example | |
3157 | |
3158 @ccmode{} assigns the @code{block-close} syntactic symbol to the | |
3159 brace that closes the @code{do} construct, and normally we'd like the | |
3160 line that follows a @code{block-close} brace to begin on a separate | |
3161 line. However, with ``do-while'' constructs, we want the | |
3162 @code{while} clause to follow the closing brace. To do this, we | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3163 associate the @code{block-close} symbol with the @var{action} function |
25829 | 3164 @code{c-snug-do-while}: |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3165 |
25829 | 3166 @example |
3167 (defun c-snug-do-while (syntax pos) | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3168 "Dynamically calculate brace hanginess for do-while statements." |
25829 | 3169 (save-excursion |
3170 (let (langelem) | |
3171 (if (and (eq syntax 'block-close) | |
3172 (setq langelem (assq 'block-close c-syntactic-context)) | |
3173 (progn (goto-char (cdr langelem)) | |
3174 (if (= (following-char) ?@{) | |
3175 (forward-sexp -1)) | |
3176 (looking-at "\\<do\\>[^_]"))) | |
3177 '(before) | |
3178 '(before after))))) | |
3179 @end example | |
3180 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3181 @findex c-snug-do-while |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3182 @findex snug-do-while (c-) |
25829 | 3183 This function simply looks to see if the brace closes a ``do-while'' |
3184 clause and if so, returns the list @samp{(before)} indicating | |
3185 that a newline should be inserted before the brace, but not after it. | |
3186 In all other cases, it returns the list @samp{(before after)} so | |
3187 that the brace appears on a line by itself. | |
3188 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3189 @defvar c-syntactic-context |
25829 | 3190 @vindex syntactic-context (c-) |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3191 During the call to the indentation or brace hanging @var{action} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3192 function, this variable is bound to the full syntactic analysis list. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3193 @end defvar |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3194 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3195 @cindex customization, colon hanging |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3196 @vindex c-hanging-colons-alist |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3197 @vindex hanging-colons-alist (c-) |
25829 | 3198 Note that for symmetry, colon hanginess should be customizable by |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3199 allowing function symbols as @var{action}s on the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3200 @code{c-hanging-colons-alist} style variable. Since no use has actually |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3201 been found for this feature, it isn't currently implemented! |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3202 |
25829 | 3203 |
3204 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3205 @node Customizing Semicolons and Commas, Other Special Indentations, Custom Brace and Colon Hanging, Advanced Customizations |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3206 @comment node-name, next, previous, up |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3207 @subsection Customizing Semicolons and Commas |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3208 @cindex customization, semicolon newlines |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3209 @cindex customization, comma newlines |
25829 | 3210 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
3211 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3212 You can also customize the insertion of newlines after semicolons and |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3213 commas when the auto-newline minor mode is enabled (@pxref{Minor |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3214 Modes}). |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3215 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3216 @defopt c-hanging-semi&comma-criteria |
25829 | 3217 @vindex hanging-semi&comma-criteria (c-) |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3218 This style variable takes a list of hooks that get called when a |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3219 semicolon or comma is inserted. The hooks are called in order without |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3220 arguments, and are expected to return one of the following values: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3221 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3222 @table @code |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3223 @item t |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3224 A newline is inserted, and no more functions from the list are called. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3225 @item stop |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3226 No more functions from the list are called, but no newline is |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3227 inserted. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3228 @item nil |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3229 No determination is made, and the next function in the list is called. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3230 @end table |
25829 | 3231 |
3232 If every function in the list is called without a determination being | |
3233 made, then no newline is added. The default value for this variable is a | |
3234 list containing a single function which inserts newlines only after | |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
3235 semicolons which do not appear inside parenthesis lists (i.e., those |
25829 | 3236 that separate @code{for}-clause statements). |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3237 @end defopt |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3238 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3239 @defun c-semi&comma-no-newlines-before-nonblanks |
25829 | 3240 @findex semi&comma-no-newlines-before-nonblanks (c-) |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3241 This is an example of a criteria function, provided by @ccmode{}. It |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3242 prevents newlines from being inserted after semicolons when there is a |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3243 non-blank following line. Otherwise, it makes no determination. To |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3244 use, add this function to the front of the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3245 @code{c-hanging-semi&comma-criteria} list. |
25829 | 3246 |
3247 @example | |
3248 (defun c-semi&comma-no-newlines-before-nonblanks () | |
3249 (save-excursion | |
3250 (if (and (eq last-command-char ?\;) | |
3251 (zerop (forward-line 1)) | |
3252 (not (looking-at "^[ \t]*$"))) | |
3253 'stop | |
3254 nil))) | |
3255 @end example | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3256 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3257 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3258 @defun c-semi&comma-inside-parenlist |
25829 | 3259 @findex semi&comma-inside-parenlist (c-) |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3260 @defunx c-semi&comma-no-newlines-for-oneline-inliners |
25829 | 3261 @findex semi&comma-no-newlines-for-oneline-inliners (c-) |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3262 The function @code{c-semi&comma-inside-parenlist} is what prevents |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3263 newlines from being inserted inside the parenthesis list of @code{for} |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3264 statements. In addition to |
25829 | 3265 @code{c-semi&comma-no-newlines-before-nonblanks} described above, |
3266 @ccmode{} also comes with the criteria function | |
3267 @code{c-semi&comma-no-newlines-for-oneline-inliners}, which suppresses | |
3268 newlines after semicolons inside one-line inline method definitions | |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
3269 (e.g., in C++ or Java). |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3270 @end defun |
25829 | 3271 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3272 |
25829 | 3273 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3274 @node Other Special Indentations, , Customizing Semicolons and Commas, Advanced Customizations |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3275 @comment node-name, next, previous, up |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3276 @subsection Other Special Indentations |
25829 | 3277 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
3278 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3279 Here are the remaining odds and ends regarding indentation: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3280 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3281 @defopt c-label-minimum-indentation |
25829 | 3282 @vindex label-minimum-indentation (c-) |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3283 In @samp{gnu} style (@pxref{Built-in Styles}), a minimum indentation |
25829 | 3284 is imposed on lines inside top-level constructs. This minimum |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3285 indentation is controlled by this style variable. The default value |
25829 | 3286 is 1. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3287 @end defopt |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3288 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3289 @defopt c-special-indent-hook |
25829 | 3290 @vindex special-indent-hook (c-) |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3291 This style variable is a standard hook variable that is called after |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3292 every line is indented by @ccmode{}. You can use it to do any special |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3293 indentation or line adjustments your style dictates, such as adding |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3294 extra indentation to constructors or destructor declarations in a |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3295 class definition, etc. Note that you should not change point or mark |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
3296 inside your @code{c-special-indent-hook} functions, i.e., you'll |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3297 probably want to wrap your function in a @code{save-excursion}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3298 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3299 Setting @code{c-special-indent-hook} in your style definition is |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3300 handled slightly differently than other variables. In your style |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3301 definition, you should set the value for @code{c-special-indent-hook} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3302 to a function or list of functions, which will be appended to |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3303 @code{c-special-indent-hook} using @code{add-hook}. That way, the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3304 current setting for the buffer local value of |
25829 | 3305 @code{c-special-indent-hook} won't be overridden. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3306 @end defopt |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3307 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3308 |
25829 | 3309 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3310 @node Syntactic Symbols, Indentation Functions, Customizing Indentation, Top |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3311 @comment node-name, next, previous, up |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3312 @chapter Syntactic Symbols |
25829 | 3313 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
3314 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3315 @cindex syntactic symbols, brief list |
25829 | 3316 @vindex c-offsets-alist |
3317 @vindex offsets-alist (c-) | |
3318 Here is a complete list of the recognized syntactic symbols as described | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3319 in the @code{c-offsets-alist} style variable, along with a brief |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3320 description. More detailed descriptions follow. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3321 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3322 @table @code |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3323 @item string |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3324 Inside a multiline string. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3325 @item c |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3326 Inside a multiline C style block comment. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3327 @item defun-open |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3328 Brace that opens a top-level function definition. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3329 @item defun-close |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3330 Brace that closes a top-level function definition. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3331 @item defun-block-intro |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3332 The first line in a top-level defun. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3333 @item class-open |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3334 Brace that opens a class definition. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3335 @item class-close |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3336 Brace that closes a class definition. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3337 @item inline-open |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3338 Brace that opens an in-class inline method. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3339 @item inline-close |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3340 Brace that closes an in-class inline method. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3341 @item func-decl-cont |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3342 The region between a function definition's argument list and the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3343 function opening brace (excluding K&R argument declarations). In C, you |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3344 cannot put anything but whitespace and comments in this region, however |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3345 in C++ and Java, @code{throws} declarations and other things can appear |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3346 here. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3347 @item knr-argdecl-intro |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3348 First line of a K&R C argument declaration. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3349 @item knr-argdecl |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3350 Subsequent lines in a K&R C argument declaration. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3351 @item topmost-intro |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3352 The first line in a ``topmost'' definition. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3353 @item topmost-intro-cont |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3354 Topmost definition continuation lines. This is only used in the parts |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3355 that aren't covered by other symbols such as @code{func-decl-cont} and |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3356 @code{knr-argdecl}. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3357 @item member-init-intro |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3358 First line in a member initialization list. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3359 @item member-init-cont |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3360 Subsequent member initialization list lines. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3361 @item inher-intro |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3362 First line of a multiple inheritance list. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3363 @item inher-cont |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3364 Subsequent multiple inheritance lines. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3365 @item block-open |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3366 Statement block open brace. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3367 @item block-close |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3368 Statement block close brace. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3369 @item brace-list-open |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3370 Open brace of an enum or static array list. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3371 @item brace-list-close |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3372 Close brace of an enum or static array list. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3373 @item brace-list-intro |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3374 First line in an enum or static array list. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3375 @item brace-list-entry |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3376 Subsequent lines in an enum or static array list. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3377 @item brace-entry-open |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3378 Subsequent lines in an enum or static array list where the line begins |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3379 with an open brace. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3380 @item statement |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3381 A statement. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3382 @item statement-cont |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3383 A continuation of a statement. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3384 @item statement-block-intro |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3385 The first line in a new statement block. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3386 @item statement-case-intro |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3387 The first line in a case block. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3388 @item statement-case-open |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3389 The first line in a case block that starts with a brace. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3390 @item substatement |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3391 The first line after a conditional or loop construct. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3392 @item substatement-open |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3393 The brace that opens a substatement block. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3394 @item substatement-label |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3395 The first line after a conditional or loop construct if it's a label. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3396 @item case-label |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3397 A label in a @code{switch} block. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3398 @item access-label |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3399 C++ access control label. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3400 @item label |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3401 Any other label. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3402 @item do-while-closure |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3403 The @code{while} line that ends a @code{do}-@code{while} construct. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3404 @item else-clause |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3405 The @code{else} line of an @code{if}-@code{else} construct. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3406 @item catch-clause |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3407 The @code{catch} or @code{finally} (in Java) line of a |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3408 @code{try}-@code{catch} construct. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3409 @item comment-intro |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3410 A line containing only a comment introduction. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3411 @item arglist-intro |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3412 The first line in an argument list. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3413 @item arglist-cont |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3414 Subsequent argument list lines when no arguments follow on the same line |
36341
0ab4e667274d
(Syntactic Symbols): Remove doubled `the'.
Gerd Moellmann <gerd@gnu.org>
parents:
36160
diff
changeset
|
3415 as the arglist opening paren. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3416 @item arglist-cont-nonempty |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3417 Subsequent argument list lines when at least one argument follows on the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3418 same line as the arglist opening paren. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3419 @item arglist-close |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3420 The solo close paren of an argument list. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3421 @item stream-op |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3422 Lines continuing a stream operator (C++ only). |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3423 @item inclass |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3424 The line is nested inside a class definition. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3425 @item cpp-macro |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3426 The start of a preprocessor macro definition. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3427 @item cpp-define-intro |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3428 The first line inside a multiline preproprocessor macro if |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3429 @code{c-syntactic-indentation-in-macros} is set. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3430 @item cpp-macro-cont |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3431 All lines inside multiline preprocessor macros if |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3432 @code{c-syntactic-indentation-in-macros} is @code{nil}. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3433 @item friend |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3434 A C++ friend declaration. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3435 @item objc-method-intro |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3436 The first line of an Objective-C method definition. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3437 @item objc-method-args-cont |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3438 Lines continuing an Objective-C method definition. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3439 @item objc-method-call-cont |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3440 Lines continuing an Objective-C method call. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3441 @item extern-lang-open |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
3442 Brace that opens an @code{extern} block (e.g., @code{extern "C" @{...@}}). |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3443 @item extern-lang-close |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3444 Brace that closes an @code{extern} block. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3445 @item inextern-lang |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3446 Analogous to @code{inclass} syntactic symbol, but used inside |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3447 @code{extern} blocks. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3448 @item namespace-open |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3449 @itemx namespace-close |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3450 @itemx innamespace |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3451 These are analogous to the three @code{extern-lang} symbols above, but |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3452 are returned for C++ namespace blocks. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3453 @item module-open |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3454 @itemx module-close |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3455 @itemx inmodule |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3456 Analogous to the above, but for CORBA IDL @code{module} blocks. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3457 @item composition-open |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3458 @itemx composition-close |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3459 @itemx incomposition |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3460 Analogous to the above, but for CORBA CIDL @code{composition} blocks. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3461 @item template-args-cont |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3462 C++ template argument list continuations. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3463 @item inlambda |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3464 Analogous to @code{inclass} syntactic symbol, but used inside lambda |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
3465 (i.e., anonymous) functions. Only used in Pike mode. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3466 @item lambda-intro-cont |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
3467 Lines continuing the header of a lambda function, i.e., between the |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3468 @code{lambda} keyword and the function body. Only used in Pike mode. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3469 @item inexpr-statement |
56646
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
3470 A statement block inside an expression. The gcc C and C++ extension for |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
3471 this is recognized. It's also used for the special functions that take |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
3472 a statement block as an argument in Pike. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3473 @item inexpr-class |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3474 A class definition inside an expression. This is used for anonymous |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3475 classes in Java. It's also used for anonymous array initializers in |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3476 Java. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3477 @end table |
25829 | 3478 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3479 @ssindex -open symbols |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3480 @ssindex -close symbols |
25829 | 3481 Most syntactic symbol names follow a general naming convention. When a |
3482 line begins with an open or close brace, the syntactic symbol will | |
3483 contain the suffix @code{-open} or @code{-close} respectively. | |
3484 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3485 @ssindex -intro symbols |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3486 @ssindex -cont symbols |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3487 @ssindex -block-intro symbols |
25829 | 3488 Usually, a distinction is made between the first line that introduces a |
3489 construct and lines that continue a construct, and the syntactic symbols | |
3490 that represent these lines will contain the suffix @code{-intro} or | |
3491 @code{-cont} respectively. As a sub-classification of this scheme, a | |
3492 line which is the first of a particular brace block construct will | |
3493 contain the suffix @code{-block-intro}. | |
3494 | |
3495 Let's look at some examples to understand how this works. Remember that | |
3496 you can check the syntax of any line by using @kbd{C-c C-s}. | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3497 |
25829 | 3498 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3499 1: void |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3500 2: swap( int& a, int& b ) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3501 3: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3502 4: int tmp = a; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3503 5: a = b; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3504 6: b = tmp; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3505 7: int ignored = |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3506 8: a + b; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3507 9: @} |
25829 | 3508 @end example |
3509 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3510 @ssindex topmost-intro |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3511 @ssindex topmost-intro-cont |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3512 @ssindex defun-open |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3513 @ssindex defun-close |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3514 @ssindex defun-block-intro |
25829 | 3515 Line 1 shows a @code{topmost-intro} since it is the first line that |
3516 introduces a top-level construct. Line 2 is a continuation of the | |
3517 top-level construct introduction so it has the syntax | |
3518 @code{topmost-intro-cont}. Line 3 shows a @code{defun-open} since it is | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3519 the brace that opens a top-level function definition. Line 9 is the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3520 corresponding |
25829 | 3521 @code{defun-close} since it contains the brace that closes the top-level |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
3522 function definition. Line 4 is a @code{defun-block-intro}, i.e., it is |
25829 | 3523 the first line of a brace-block, enclosed in a |
3524 top-level function definition. | |
3525 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3526 @ssindex statement |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3527 @ssindex statement-cont |
25829 | 3528 Lines 5, 6, and 7 are all given @code{statement} syntax since there |
3529 isn't much special about them. Note however that line 8 is given | |
3530 @code{statement-cont} syntax since it continues the statement begun | |
3531 on the previous line. | |
3532 | |
3533 Here's another example, which illustrates some C++ class syntactic | |
3534 symbols: | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3535 |
25829 | 3536 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3537 1: class Bass |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3538 2: : public Guitar, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3539 3: public Amplifiable |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3540 4: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3541 5: public: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3542 6: Bass() |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3543 7: : eString( new BassString( 0.105 )), |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3544 8: aString( new BassString( 0.085 )), |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3545 9: dString( new BassString( 0.065 )), |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3546 10: gString( new BassString( 0.045 )) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3547 11: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3548 12: eString.tune( 'E' ); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3549 13: aString.tune( 'A' ); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3550 14: dString.tune( 'D' ); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3551 15: gString.tune( 'G' ); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3552 16: @} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3553 17: friend class Luthier; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3554 18: @}; |
25829 | 3555 @end example |
3556 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3557 @ssindex class-open |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3558 @ssindex class-close |
25829 | 3559 As in the previous example, line 1 has the @code{topmost-intro} syntax. |
3560 Here however, the brace that opens a C++ class definition on line 4 is | |
3561 assigned the @code{class-open} syntax. Note that in C++, classes, | |
3562 structs, and unions are essentially equivalent syntactically (and are | |
3563 very similar semantically), so replacing the @code{class} keyword in the | |
3564 example above with @code{struct} or @code{union} would still result in a | |
3565 syntax of @code{class-open} for line 4 @footnote{This is the case even | |
3566 for C and Objective-C. For consistency, structs in all supported | |
3567 languages are syntactically equivalent to classes. Note however that | |
3568 the keyword @code{class} is meaningless in C and Objective-C.}. | |
3569 Similarly, line 18 is assigned @code{class-close} syntax. | |
3570 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3571 @ssindex inher-intro |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3572 @ssindex inher-cont |
25829 | 3573 Line 2 introduces the inheritance list for the class so it is assigned |
3574 the @code{inher-intro} syntax, and line 3, which continues the | |
3575 inheritance list is given @code{inher-cont} syntax. | |
3576 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3577 @ssindex access-label |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3578 @ssindex inclass |
25829 | 3579 Hitting @kbd{C-c C-s} on line 5 shows the following analysis: |
3580 | |
3581 @example | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3582 ((inclass 58) (access-label 58)) |
25829 | 3583 @end example |
3584 | |
3585 @noindent | |
3586 The primary syntactic symbol for this line is @code{access-label} as | |
3587 this a label keyword that specifies access protection in C++. However, | |
3588 because this line is also a top-level construct inside a class | |
3589 definition, the analysis actually shows two syntactic symbols. The | |
3590 other syntactic symbol assigned to this line is @code{inclass}. | |
3591 Similarly, line 6 is given both @code{inclass} and @code{topmost-intro} | |
3592 syntax: | |
3593 | |
3594 @example | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3595 ((inclass 58) (topmost-intro 60)) |
25829 | 3596 @end example |
3597 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3598 @ssindex member-init-intro |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3599 @ssindex member-init-cont |
25829 | 3600 Line 7 introduces a C++ member initialization list and as such is given |
3601 @code{member-init-intro} syntax. Note that in this case it is | |
3602 @emph{not} assigned @code{inclass} since this is not considered a | |
3603 top-level construct. Lines 8 through 10 are all assigned | |
3604 @code{member-init-cont} since they continue the member initialization | |
3605 list started on line 7. | |
3606 | |
3607 @cindex in-class inline methods | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3608 @ssindex inline-open |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3609 @ssindex inline-close |
25829 | 3610 Line 11's analysis is a bit more complicated: |
3611 | |
3612 @example | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3613 ((inclass 58) (inline-open)) |
25829 | 3614 @end example |
3615 | |
3616 This line is assigned a syntax of both @code{inline-open} and | |
3617 @code{inclass} because it opens an @dfn{in-class} C++ inline method | |
3618 definition. This is distinct from, but related to, the C++ notion of an | |
3619 inline function in that its definition occurs inside an enclosing class | |
3620 definition, which in C++ implies that the function should be inlined. | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3621 However, if the definition of the @code{Bass} constructor appeared |
25829 | 3622 outside the class definition, the construct would be given the |
3623 @code{defun-open} syntax, even if the keyword @code{inline} appeared | |
3624 before the method name, as in: | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3625 |
25829 | 3626 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3627 1: class Bass |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3628 2: : public Guitar, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3629 3: public Amplifiable |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3630 4: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3631 5: public: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3632 6: Bass(); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3633 7: @}; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3634 8: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3635 9: inline |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3636 10: Bass::Bass() |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3637 11: : eString( new BassString( 0.105 )), |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3638 12: aString( new BassString( 0.085 )), |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3639 13: dString( new BassString( 0.065 )), |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3640 14: gString( new BassString( 0.045 )) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3641 15: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3642 16: eString.tune( 'E' ); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3643 17: aString.tune( 'A' ); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3644 18: dString.tune( 'D' ); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3645 19: gString.tune( 'G' ); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3646 20: @} |
25829 | 3647 @end example |
3648 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3649 @ssindex friend |
25829 | 3650 Returning to the previous example, line 16 is given @code{inline-close} |
3651 syntax, while line 12 is given @code{defun-block-open} syntax, and lines | |
3652 13 through 15 are all given @code{statement} syntax. Line 17 is | |
3653 interesting in that its syntactic analysis list contains three | |
3654 elements: | |
3655 | |
3656 @example | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3657 ((inclass 58) (topmost-intro 380) (friend)) |
25829 | 3658 @end example |
3659 | |
3660 The @code{friend} syntactic symbol is a modifier that typically does not | |
3661 have a relative buffer position. | |
3662 | |
3663 Template definitions introduce yet another syntactic symbol: | |
3664 | |
3665 @example | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3666 1: ThingManager <int, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3667 2: Framework::Callback *, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3668 3: Mutex> framework_callbacks; |
25829 | 3669 @end example |
3670 | |
3671 Here, line 1 is analyzed as a @code{topmost-intro}, but lines 2 and 3 | |
3672 are both analyzed as @code{template-args-cont} lines. | |
3673 | |
3674 Here is another (totally contrived) example which illustrates how syntax | |
3675 is assigned to various conditional constructs: | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3676 |
25829 | 3677 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3678 1: void spam( int index ) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3679 2: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3680 3: for( int i=0; i<index; i++ ) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3681 4: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3682 5: if( i == 10 ) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3683 6: do_something_special(); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3684 7: else |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3685 8: silly_label: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3686 9: do_something( i ); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3687 10: @} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3688 11: do @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3689 12: another_thing( i-- ); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3690 13: @} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3691 14: while( i > 0 ); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3692 15: @} |
25829 | 3693 @end example |
3694 | |
3695 Only the lines that illustrate new syntactic symbols will be discussed. | |
3696 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3697 @ssindex substatement-open |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3698 @ssindex substatement-block-intro |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3699 @ssindex block-close |
25829 | 3700 Line 4 has a brace which opens a conditional's substatement block. It |
3701 is thus assigned @code{substatement-open} syntax, and since line 5 is | |
3702 the first line in the substatement block, it is assigned | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3703 @code{substatement-block-intro} syntax. Line 10 contains the brace that |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3704 closes the inner substatement block, and is therefore given the syntax |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3705 @code{block-close}. Line 13 is treated the same way. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3706 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3707 @ssindex substatement |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3708 Lines 6 and 9 are also substatements of conditionals, but since they |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3709 don't start blocks they are given @code{substatement} syntax |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3710 instead of @code{substatement-open}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3711 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3712 @ssindex substatement-label |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3713 Line 8 contains a label, which is normally given @code{label} syntax. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3714 This one is however a bit special since it's between a conditional and |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3715 its substatement. It's analyzed as @code{substatement-label} to let you |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3716 handle this rather odd case differently from normal labels. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3717 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3718 @ssindex else-clause |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3719 @ssindex catch-clause |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3720 Line 7 start with an @code{else} that matches the @code{if} statement on |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3721 line 5. It is therefore given the @code{else-clause} syntax and is |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3722 anchored on the matching @code{if}. The @code{try}-@code{catch} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3723 constructs in C++ and Java are treated this way too, except that |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3724 @code{catch} and (in Java) @code{finally}, are marked with |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3725 @code{catch-clause}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3726 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3727 @ssindex do-while-closure |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3728 The @code{while} construct on line 14 that closes a @code{do} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3729 conditional is given the special syntax @code{do-while-closure} if it |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3730 appears on a line by itself. Note that if the @code{while} appeared on |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3731 the same line as the preceding close brace, that line would still have |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3732 @code{block-close} syntax. |
25829 | 3733 |
3734 Switch statements have their own set of syntactic symbols. Here's an | |
3735 example: | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3736 |
25829 | 3737 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3738 1: void spam( enum Ingredient i ) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3739 2: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3740 3: switch( i ) @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3741 4: case Ham: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3742 5: be_a_pig(); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3743 6: break; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3744 7: case Salt: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3745 8: drink_some_water(); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3746 9: break; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3747 10: default: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3748 11: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3749 12: what_is_it(); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3750 13: break; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3751 14: @} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3752 15: @} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3753 14: @} |
25829 | 3754 @end example |
3755 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3756 @ssindex case-label |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3757 @ssindex statement-case-intro |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3758 @ssindex statement-case-open |
25829 | 3759 Here, lines 4, 7, and 10 are all assigned @code{case-label} syntax, |
3760 while lines 5 and 8 are assigned @code{statement-case-intro}. Line 11 | |
3761 is treated slightly differently since it contains a brace that opens a | |
3762 block --- it is given @code{statement-case-open} syntax. | |
3763 | |
3764 @cindex brace lists | |
3765 There are a set of syntactic symbols that are used to recognize | |
3766 constructs inside of brace lists. A brace list is defined as an | |
3767 @code{enum} or aggregate initializer list, such as might statically | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3768 initialize an array of structs. The three special aggregate constructs |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3769 in Pike, @code{(@{ @})}, @code{([ ])} and @code{(< >)}, are treated as |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3770 brace lists too. An example: |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3771 |
25829 | 3772 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3773 1: static char* ingredients[] = |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3774 2: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3775 3: "Ham", |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3776 4: "Salt", |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3777 5: NULL |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3778 6: @}; |
25829 | 3779 @end example |
3780 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3781 @ssindex brace-list-open |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3782 @ssindex brace-list-intro |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3783 @ssindex brace-list-close |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3784 @ssindex brace-list-entry |
25829 | 3785 Following convention, line 2 in this example is assigned |
3786 @code{brace-list-open} syntax, and line 3 is assigned | |
3787 @code{brace-list-intro} syntax. Likewise, line 6 is assigned | |
3788 @code{brace-list-close} syntax. Lines 4 and 5 however, are assigned | |
3789 @code{brace-list-entry} syntax, as would all subsequent lines in this | |
3790 initializer list. | |
3791 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3792 @ssindex brace-entry-open |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3793 Your static initializer might be initializing nested structures, for |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3794 example: |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3795 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3796 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3797 1: struct intpairs[] = |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3798 2: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3799 3: @{ 1, 2 @}, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3800 4: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3801 5: 3, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3802 6: 4 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3803 7: @} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3804 8: @{ 1, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3805 9: 2 @}, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3806 10: @{ 3, 4 @} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3807 11: @}; |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3808 @end example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3809 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3810 Here, you've already seen the analysis of lines 1, 2, 3, and 11. On |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3811 line 4, things get interesting; this line is assigned |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3812 @code{brace-entry-open} syntactic symbol because it's a bracelist entry |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3813 line that starts with an open brace. Lines 5 and 6 (and line 9) are |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3814 pretty standard, and line 7 is a @code{brace-list-close} as you'd |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3815 expect. Once again, line 8 is assigned as @code{brace-entry-open} as is |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3816 line 10. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
3817 |
25829 | 3818 External language definition blocks also have their own syntactic |
3819 symbols. In this example: | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3820 |
25829 | 3821 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3822 1: extern "C" |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3823 2: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3824 3: int thing_one( int ); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3825 4: int thing_two( double ); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3826 5: @} |
25829 | 3827 @end example |
3828 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3829 @ssindex extern-lang-open |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3830 @ssindex extern-lang-close |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3831 @ssindex inextern-lang |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3832 @ssindex inclass |
25829 | 3833 @noindent |
3834 line 2 is given the @code{extern-lang-open} syntax, while line 5 is given | |
3835 the @code{extern-lang-close} syntax. The analysis for line 3 yields: | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3836 |
25829 | 3837 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3838 ((inextern-lang) (topmost-intro 14)) |
25829 | 3839 @end example |
3840 | |
3841 @noindent | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3842 where @code{inextern-lang} is a modifier similar in purpose to |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3843 @code{inclass}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3844 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3845 There are various other top level blocks like @code{extern}, and they |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3846 are all treated in the same way except that the symbols are named after |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
3847 the keyword that introduces the block. e.g., C++ namespace blocks get |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3848 the three symbols @code{namespace-open}, @code{namespace-close} and |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3849 @code{innamespace}. The currently recognized top level blocks are: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3850 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3851 @table @asis |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3852 @item @code{extern-lang-open}, @code{extern-lang-close}, @code{inextern-lang} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3853 @code{extern} blocks in C and C++.@footnote{These should logically be |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3854 named @code{extern-open}, @code{extern-close} and @code{inextern}, but |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3855 that isn't the case for historical reasons.} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3856 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3857 @item @code{namespace-open}, @code{namespace-close}, @code{innamespace} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3858 @ssindex namespace-open |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3859 @ssindex namespace-close |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3860 @ssindex innamespace |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3861 @code{namespace} blocks in C++. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3862 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3863 @item @code{module-open}, @code{module-close}, @code{inmodule} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3864 @ssindex module-open |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3865 @ssindex module-close |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3866 @ssindex inmodule |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3867 @code{module} blocks in CORBA IDL. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3868 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3869 @item @code{composition-open}, @code{composition-close}, @code{incomposition} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3870 @ssindex composition-open |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3871 @ssindex composition-close |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3872 @ssindex incomposition |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3873 @code{composition} blocks in CORBA CIDL. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3874 @end table |
25829 | 3875 |
3876 A number of syntactic symbols are associated with parenthesis lists, | |
3877 a.k.a argument lists, as found in function declarations and function | |
3878 calls. This example illustrates these: | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3879 |
25829 | 3880 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3881 1: void a_function( int line1, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3882 2: int line2 ); |
59996
aac0a33f5772
Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents:
59032
diff
changeset
|
3883 3: |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3884 4: void a_longer_function( |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3885 5: int line1, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3886 6: int line2 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3887 7: ); |
59996
aac0a33f5772
Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents:
59032
diff
changeset
|
3888 8: |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3889 9: void call_them( int line1, int line2 ) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3890 10: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3891 11: a_function( |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3892 12: line1, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3893 13: line2 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3894 14: ); |
59996
aac0a33f5772
Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents:
59032
diff
changeset
|
3895 15: |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3896 16: a_longer_function( line1, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3897 17: line2 ); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3898 18: @} |
25829 | 3899 @end example |
3900 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3901 @ssindex arglist-intro |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3902 @ssindex arglist-close |
25829 | 3903 Lines 5 and 12 are assigned @code{arglist-intro} syntax since they are |
3904 the first line following the open parenthesis, and lines 7 and 14 are | |
3905 assigned @code{arglist-close} syntax since they contain the parenthesis | |
3906 that closes the argument list. | |
3907 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3908 @ssindex arglist-cont-nonempty |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3909 @ssindex arglist-cont |
25829 | 3910 Lines that continue argument lists can be assigned one of two syntactic |
3911 symbols. For example, Lines 2 and 17 | |
3912 are assigned @code{arglist-cont-nonempty} syntax. What this means | |
3913 is that they continue an argument list, but that the line containing the | |
3914 parenthesis that opens the list is @emph{not empty} following the open | |
3915 parenthesis. Contrast this against lines 6 and 13 which are assigned | |
3916 @code{arglist-cont} syntax. This is because the parenthesis that opens | |
3917 their argument lists is the last character on that line. | |
3918 | |
3919 Note that there is no @code{arglist-open} syntax. This is because any | |
3920 parenthesis that opens an argument list, appearing on a separate line, | |
3921 is assigned the @code{statement-cont} syntax instead. | |
3922 | |
3923 A few miscellaneous syntactic symbols that haven't been previously | |
3924 covered are illustrated by this C++ example: | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3925 |
25829 | 3926 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3927 1: void Bass::play( int volume ) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3928 2: const |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3929 3: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3930 4: /* this line starts a multiline |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3931 5: * comment. This line should get `c' syntax */ |
59996
aac0a33f5772
Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents:
59032
diff
changeset
|
3932 6: |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3933 7: char* a_multiline_string = "This line starts a multiline \ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3934 8: string. This line should get `string' syntax."; |
59996
aac0a33f5772
Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents:
59032
diff
changeset
|
3935 9: |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3936 10: note: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3937 11: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3938 12: #ifdef LOCK |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3939 13: Lock acquire(); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3940 14: #endif // LOCK |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3941 15: slap_pop(); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3942 16: cout << "I played " |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3943 17: << "a note\n"; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3944 18: @} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3945 19: @} |
25829 | 3946 @end example |
3947 | |
3948 The lines to note in this example include: | |
3949 | |
3950 @itemize @bullet | |
3951 @item | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3952 @ssindex func-decl-cont |
30396
460a86ced57c
@setfilename to ../info/ccmode.
Gerd Moellmann <gerd@gnu.org>
parents:
30044
diff
changeset
|
3953 Line 2 is assigned the @code{func-decl-cont} syntax. |
25829 | 3954 |
3955 @item | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3956 @ssindex comment-intro |
30396
460a86ced57c
@setfilename to ../info/ccmode.
Gerd Moellmann <gerd@gnu.org>
parents:
30044
diff
changeset
|
3957 Line 4 is assigned both @code{defun-block-intro} @emph{and} |
460a86ced57c
@setfilename to ../info/ccmode.
Gerd Moellmann <gerd@gnu.org>
parents:
30044
diff
changeset
|
3958 @code{comment-intro} syntax. |
25829 | 3959 |
3960 @item | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3961 @ssindex c |
30396
460a86ced57c
@setfilename to ../info/ccmode.
Gerd Moellmann <gerd@gnu.org>
parents:
30044
diff
changeset
|
3962 Line 5 is assigned @code{c} syntax. |
25829 | 3963 |
3964 @item | |
3965 @cindex syntactic whitespace | |
30396
460a86ced57c
@setfilename to ../info/ccmode.
Gerd Moellmann <gerd@gnu.org>
parents:
30044
diff
changeset
|
3966 Line 6 which, even though it contains nothing but whitespace, is |
25829 | 3967 assigned @code{defun-block-intro}. Note that the appearance of the |
3968 comment on lines 4 and 5 do not cause line 6 to be assigned | |
3969 @code{statement} syntax because comments are considered to be | |
3970 @dfn{syntactic whitespace}, which are ignored when analyzing | |
30396
460a86ced57c
@setfilename to ../info/ccmode.
Gerd Moellmann <gerd@gnu.org>
parents:
30044
diff
changeset
|
3971 code. |
25829 | 3972 |
3973 @item | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3974 @ssindex string |
30396
460a86ced57c
@setfilename to ../info/ccmode.
Gerd Moellmann <gerd@gnu.org>
parents:
30044
diff
changeset
|
3975 Line 8 is assigned @code{string} syntax. |
25829 | 3976 |
3977 @item | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3978 @ssindex label |
30396
460a86ced57c
@setfilename to ../info/ccmode.
Gerd Moellmann <gerd@gnu.org>
parents:
30044
diff
changeset
|
3979 Line 10 is assigned @code{label} syntax. |
25829 | 3980 |
3981 @item | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3982 @ssindex block-open |
30396
460a86ced57c
@setfilename to ../info/ccmode.
Gerd Moellmann <gerd@gnu.org>
parents:
30044
diff
changeset
|
3983 Line 11 is assigned @code{block-open} syntax. |
25829 | 3984 |
3985 @item | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3986 @ssindex cpp-macro |
30396
460a86ced57c
@setfilename to ../info/ccmode.
Gerd Moellmann <gerd@gnu.org>
parents:
30044
diff
changeset
|
3987 Lines 12 and 14 are assigned @code{cpp-macro} syntax in addition to the |
460a86ced57c
@setfilename to ../info/ccmode.
Gerd Moellmann <gerd@gnu.org>
parents:
30044
diff
changeset
|
3988 normal syntactic symbols (@code{statement-block-intro} and |
460a86ced57c
@setfilename to ../info/ccmode.
Gerd Moellmann <gerd@gnu.org>
parents:
30044
diff
changeset
|
3989 @code{statement}, respectively). Normally @code{cpp-macro} is |
460a86ced57c
@setfilename to ../info/ccmode.
Gerd Moellmann <gerd@gnu.org>
parents:
30044
diff
changeset
|
3990 configured to cancel out the normal syntactic context to make all |
460a86ced57c
@setfilename to ../info/ccmode.
Gerd Moellmann <gerd@gnu.org>
parents:
30044
diff
changeset
|
3991 preprocessor directives stick to the first column, but that's easily |
460a86ced57c
@setfilename to ../info/ccmode.
Gerd Moellmann <gerd@gnu.org>
parents:
30044
diff
changeset
|
3992 changed if you want preprocessor directives to be indented like the rest |
460a86ced57c
@setfilename to ../info/ccmode.
Gerd Moellmann <gerd@gnu.org>
parents:
30044
diff
changeset
|
3993 of the code. |
25829 | 3994 |
3995 @item | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
3996 @ssindex stream-op |
30396
460a86ced57c
@setfilename to ../info/ccmode.
Gerd Moellmann <gerd@gnu.org>
parents:
30044
diff
changeset
|
3997 Line 17 is assigned @code{stream-op} syntax. |
25829 | 3998 @end itemize |
3999 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4000 @cindex multiline macros |
25829 | 4001 @cindex syntactic whitespace |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4002 @ssindex cpp-define-intro |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4003 Multiline preprocessor macro definitions are normally handled just like |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
4004 other code, i.e., the lines inside them are indented according to the |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4005 syntactic analysis of the preceding lines inside the macro. The first |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
4006 line inside a macro definition (i.e., the line after the starting line of |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4007 the cpp directive itself) gets @code{cpp-define-intro}. In this example: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4008 |
25829 | 4009 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4010 1: #define LIST_LOOP(cons, listp) \ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4011 2: for (cons = listp; !NILP (cons); cons = XCDR (cons)) \ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4012 3: if (!CONSP (cons)) \ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4013 4: signal_error ("Invalid list format", listp); \ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4014 5: else |
25829 | 4015 @end example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4016 |
25829 | 4017 @noindent |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4018 line 1 is given the syntactic symbol @code{cpp-macro}. The first line |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4019 of a cpp directive is always given that symbol. Line 2 is given |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4020 @code{cpp-define-intro}, so that you can give the macro body as a whole |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4021 some extra indentation. Lines 3 through 5 are then analyzed as normal |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
4022 code, i.e., @code{substatement} on lines 3 and 4, and @code{else-clause} |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4023 on line 5. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4024 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4025 The syntactic analysis inside macros can be turned off with |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4026 @code{c-syntactic-indentation-in-macros}. In that case, lines 2 through |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4027 5 would all be given @code{cpp-macro-cont} with a relative buffer |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4028 position pointing to the @code{#} which starts the cpp |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4029 directive@footnote{This is how @ccmode{} 5.28 and earlier analyzed |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4030 macros.}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4031 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4032 @xref{Macro Handling}, for more info about the treatment of macros. |
25829 | 4033 |
4034 In Objective-C buffers, there are three additional syntactic symbols | |
4035 assigned to various message calling constructs. Here's an example | |
4036 illustrating these: | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4037 |
25829 | 4038 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4039 1: - (void)setDelegate:anObject |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4040 2: withStuff:stuff |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4041 3: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4042 4: [delegate masterWillRebind:self |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4043 5: toDelegate:anObject |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4044 6: withExtraStuff:stuff]; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4045 7: @} |
25829 | 4046 @end example |
4047 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4048 @ssindex objc-method-intro |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4049 @ssindex objc-method-args-cont |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4050 @ssindex objc-method-call-cont |
25829 | 4051 Here, line 1 is assigned @code{objc-method-intro} syntax, and line 2 is |
4052 assigned @code{objc-method-args-cont} syntax. Lines 5 and 6 are both | |
4053 assigned @code{objc-method-call-cont} syntax. | |
4054 | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4055 Java has a concept of anonymous classes, which may look something like |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4056 this: |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4057 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4058 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4059 1: public void watch(Observable o) @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4060 2: o.addObserver(new Observer() @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4061 3: public void update(Observable o, Object arg) @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4062 4: history.addElement(arg); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4063 5: @} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4064 6: @}); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4065 7: @} |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4066 @end example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4067 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4068 @ssindex inexpr-class |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4069 The brace following the @code{new} operator opens the anonymous class. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4070 Lines 3 and 6 are assigned the @code{inexpr-class} syntax, besides the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4071 @code{inclass} symbol used in normal classes. Thus, the class will be |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4072 indented just like a normal class, with the added indentation given to |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4073 @code{inexpr-class}. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4074 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4075 There are a few occasions where a statement block may be used inside an |
56646
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
4076 expression. One is in C or C++ code using the gcc extension for this, |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
4077 e.g: |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4078 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4079 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4080 1: int res = (@{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4081 2: int y = foo (); int z; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4082 3: if (y > 0) z = y; else z = - y; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4083 4: z; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4084 5: @}); |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4085 @end example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4086 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4087 @ssindex inexpr-statement |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4088 Lines 2 and 5 get the @code{inexpr-statement} syntax, besides the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4089 symbols they'd get in a normal block. Therefore, the indentation put on |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4090 @code{inexpr-statement} is added to the normal statement block |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4091 indentation. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4092 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4093 In Pike code, there are a few other situations where blocks occur inside |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4094 statements, as illustrated here: |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4095 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4096 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4097 1: array itgob() |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4098 2: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4099 3: string s = map (backtrace()[-2][3..], |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4100 4: lambda |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4101 5: (mixed arg) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4102 6: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4103 7: return sprintf ("%t", arg); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4104 8: @}) * ", " + "\n"; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4105 9: return catch @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4106 10: write (s + "\n"); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4107 11: @}; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4108 12: @} |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4109 @end example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4110 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4111 @ssindex inlambda |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4112 @ssindex lambda-intro-cont |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4113 Lines 4 through 8 contain a lambda function, which @ccmode{} recognizes |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4114 by the @code{lambda} keyword. If the function argument list is put |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4115 on a line of its own, as in line 5, it gets the @code{lambda-intro-cont} |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4116 syntax. The function body is handled as an inline method body, with the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4117 addition of the @code{inlambda} syntactic symbol. This means that line |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4118 6 gets @code{inlambda} and @code{inline-open}, and line 8 gets |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4119 @code{inline-close}@footnote{You might wonder why it doesn't get |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4120 @code{inlambda} too. It's because the closing brace is relative to the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4121 opening brace, which stands on its own line in this example. If the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4122 opening brace was hanging on the previous line, then the closing brace |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4123 would get the @code{inlambda} syntax too to be indented correctly.}. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4124 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4125 @ssindex inexpr-statement |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4126 On line 9, @code{catch} is a special function taking a statement block |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4127 as its argument. The block is handled as an in-expression statement |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4128 with the @code{inexpr-statement} syntax, just like the gcc extended C |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4129 example above. The other similar special function, @code{gauge}, is |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4130 handled like this too. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4131 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4132 @ssindex knr-argdecl-intro |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4133 @ssindex knr-argdecl |
25829 | 4134 Two other syntactic symbols can appear in old style, non-prototyped C |
4135 code @footnote{a.k.a. K&R C, or Kernighan & Ritchie C}: | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4136 |
25829 | 4137 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4138 1: int add_three_integers(a, b, c) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4139 2: int a; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4140 3: int b; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4141 4: int c; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4142 5: @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4143 6: return a + b + c; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4144 7: @} |
25829 | 4145 @end example |
4146 | |
4147 Here, line 2 is the first line in an argument declaration list and so is | |
4148 given the @code{knr-argdecl-intro} syntactic symbol. Subsequent lines | |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
4149 (i.e., lines 3 and 4 in this example), are given @code{knr-argdecl} |
25829 | 4150 syntax. |
4151 | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4152 |
25829 | 4153 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4154 @node Indentation Functions, AWK Mode, Syntactic Symbols, Top |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4155 @comment node-name, next, previous, up |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4156 @chapter Indentation Functions |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4157 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4158 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4159 @cindex indentation function |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4160 @cindex line-up function |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4161 Often there are cases when a simple offset setting on a syntactic |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4162 symbol isn't enough to get the desired indentation. Therefore, it's |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4163 also possible to use an @dfn{indentation function} (a.k.a. @dfn{line-up |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4164 function}) for a syntactic symbol. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4165 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4166 @ccmode{} comes with many predefined indentation functions for common |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4167 situations. If none of these does what you want, you can write your |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4168 own, see @ref{Custom Indentation Functions}. If you do, it's probably a |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4169 good idea to start working from one of these predefined functions, they |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4170 can be found in the file @file{cc-align.el}. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4171 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4172 For every function below there is a ``works with'' list that indicates |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4173 which syntactic symbols the function is intended to be used with. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4174 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4175 @macro workswith |
36923 | 4176 @emph{Works with:@ } |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4177 @end macro |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4178 @ifinfo |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4179 @unmacro workswith |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4180 @macro workswith |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4181 Works with: |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4182 @end macro |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4183 @end ifinfo |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4184 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4185 @macro sssTBasicOffset |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4186 <--> @i{c-basic-offset}@c |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4187 @end macro |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4188 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4189 @macro sssTsssTBasicOffset |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4190 <--><--> @i{c-basic-offset}@c |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4191 @end macro |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4192 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4193 @macro hereFn{func} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4194 <- @i{\func\}@c |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4195 @end macro |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4196 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4197 @c The TeX backend seems to insert extra spaces around the argument. :P |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4198 @iftex |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4199 @unmacro hereFn |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4200 @macro hereFn{func} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4201 <-@i{\func\}@c |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4202 @end macro |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4203 @end iftex |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4204 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4205 @comment ------------------------------------------------------------ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4206 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4207 @defun c-indent-one-line-block |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4208 @findex indent-one-line-block (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4209 Indent a one line block @code{c-basic-offset} extra. E.g: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4210 |
30396
460a86ced57c
@setfilename to ../info/ccmode.
Gerd Moellmann <gerd@gnu.org>
parents:
30044
diff
changeset
|
4211 @example |
460a86ced57c
@setfilename to ../info/ccmode.
Gerd Moellmann <gerd@gnu.org>
parents:
30044
diff
changeset
|
4212 @group |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4213 if (n > 0) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4214 @{m+=n; n=0;@} @hereFn{c-indent-one-line-block} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4215 @sssTBasicOffset{} |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4216 @end group |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4217 @end example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4218 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4219 @noindent |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4220 and |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4221 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4222 @example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4223 @group |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4224 if (n > 0) |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4225 @{ @hereFn{c-indent-one-line-block} |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4226 m+=n; n=0; |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4227 @} |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4228 @end group |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4229 @end example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4230 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4231 The block may be surrounded by any kind of parenthesis characters. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4232 @code{nil} is returned if the line doesn't start with a one line block, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4233 which makes the function usable in list expressions. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4234 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4235 @workswith Almost all syntactic symbols, but most useful on the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4236 @code{-open} symbols. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4237 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4238 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4239 @comment ------------------------------------------------------------ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4240 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4241 @defun c-indent-multi-line-block |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4242 @findex indent-multi-line-block (c-) |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4243 Indent a multiline block @code{c-basic-offset} extra. E.g: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4244 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4245 @example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4246 @group |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4247 int *foo[] = @{ |
59996
aac0a33f5772
Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents:
59032
diff
changeset
|
4248 NULL, |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4249 @{17@}, @hereFn{c-indent-multi-line-block} |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4250 @end group |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4251 @end example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4252 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4253 @noindent |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4254 and |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4255 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4256 @example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4257 @group |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4258 int *foo[] = @{ |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4259 NULL, |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4260 @{ @hereFn{c-indent-multi-line-block} |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4261 17 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4262 @}, |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4263 @sssTBasicOffset{} |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4264 @end group |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4265 @end example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4266 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4267 The block may be surrounded by any kind of parenthesis characters. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4268 @code{nil} is returned if the line doesn't start with a multiline |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4269 block, which makes the function usable in list expressions. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4270 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4271 @workswith Almost all syntactic symbols, but most useful on the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4272 @code{-open} symbols. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4273 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4274 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4275 @comment ------------------------------------------------------------ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4276 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4277 @defun c-lineup-argcont |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4278 @findex lineup-argcont (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4279 Line up a continued argument. E.g: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4280 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4281 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4282 @group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4283 foo (xyz, aaa + bbb + ccc |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4284 + ddd + eee + fff); @hereFn{c-lineup-argcont} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4285 @end group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4286 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4287 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4288 Only continuation lines like this are touched, @code{nil} is returned on |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4289 lines which are the start of an argument. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4290 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4291 Within a gcc @code{asm} block, @code{:} is recognised as an argument |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4292 separator, but of course only between operand specifications, not in the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4293 expressions for the operands. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4294 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4295 @workswith @code{arglist-cont}, @code{arglist-cont-nonempty}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4296 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4297 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4298 @comment ------------------------------------------------------------ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4299 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4300 @defun c-lineup-arglist |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4301 @findex lineup-arglist (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4302 Line up the current argument line under the first argument. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4303 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4304 As a special case, if an argument on the same line as the open |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4305 parenthesis starts with a brace block opener, the indentation is |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4306 @code{c-basic-offset} only. This is intended as a ``DWIM'' measure in |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4307 cases like macros that contains statement blocks, e.g: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4308 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4309 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4310 @group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4311 A_VERY_LONG_MACRO_NAME (@{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4312 some (code, with + long, lines * in[it]); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4313 @}); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4314 @sssTBasicOffset{} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4315 @end group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4316 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4317 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4318 This is motivated partly because it's more in line with how code |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4319 blocks are handled, and partly since it approximates the behavior of |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4320 earlier CC Mode versions, which due to inaccurate analysis tended to |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4321 indent such cases this way. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4322 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4323 @workswith @code{arglist-cont-nonempty}, @code{arglist-close}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4324 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4325 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4326 @comment ------------------------------------------------------------ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4327 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4328 @defun c-lineup-arglist-intro-after-paren |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4329 @findex lineup-arglist-intro-after-paren (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4330 Line up a line to just after the open paren of the surrounding paren or |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4331 brace block. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4332 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4333 @workswith @code{defun-block-intro}, @code{brace-list-intro}, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4334 @code{statement-block-intro}, @code{statement-case-intro}, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4335 @code{arglist-intro}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4336 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4337 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4338 @comment ------------------------------------------------------------ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4339 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4340 @defun c-lineup-arglist-close-under-paren |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4341 @findex lineup-arglist-close-under-paren (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4342 Set your @code{arglist-close} syntactic symbol to this line-up function |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4343 so that parentheses that close argument lists will line up under the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4344 parenthesis that opened the argument list. It can also be used with |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4345 @code{arglist-cont} and @code{arglist-cont-nonempty} to line up all |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4346 lines inside a parenthesis under the open paren. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4347 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4348 As a special case, if a brace block is opened at the same line as the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4349 open parenthesis of the argument list, the indentation is |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4350 @code{c-basic-offset} only. See @code{c-lineup-arglist} for further |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4351 discussion of this ``DWIM'' measure. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4352 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4353 @workswith Almost all symbols, but are typically most useful on |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4354 @code{arglist-close}, @code{brace-list-close}, @code{arglist-cont} and |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4355 @code{arglist-cont-nonempty}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4356 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4357 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4358 @comment ------------------------------------------------------------ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4359 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4360 @defun c-lineup-arglist-operators |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4361 @findex lineup-arglist-operators (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4362 Line up lines starting with an infix operator under the open paren. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4363 Return @code{nil} on lines that don't start with an operator, to leave |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4364 those cases to other lineup functions. Example: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4365 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4366 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4367 @group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4368 if ( x < 10 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4369 || at_limit (x, @hereFn{c-lineup-arglist-operators} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4370 list) @hereFn{c-lineup-arglist-operators@r{ returns nil}} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4371 ) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4372 @end group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4373 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4374 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4375 Since this function doesn't do anything for lines without an infix |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4376 operator you typically want to use it together with some other lineup |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
4377 settings, e.g., as follows (the @code{arglist-close} setting is just a |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4378 suggestion to get a consistent style): |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4379 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4380 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4381 (c-set-offset 'arglist-cont |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4382 '(c-lineup-arglist-operators 0)) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4383 (c-set-offset 'arglist-cont-nonempty |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4384 '(c-lineup-arglist-operators c-lineup-arglist)) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4385 (c-set-offset 'arglist-close |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4386 '(c-lineup-arglist-close-under-paren)) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4387 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4388 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4389 @workswith @code{arglist-cont}, @code{arglist-cont-nonempty}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4390 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4391 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4392 @comment ------------------------------------------------------------ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4393 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4394 @defun c-lineup-C-comments |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4395 @findex lineup-C-comments (c-) |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4396 Line up C block comment continuation lines. Various heuristics are used |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4397 to handle most of the common comment styles. Some examples: |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4398 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4399 @example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4400 @group |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4401 /* /** /* |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4402 * text * text text |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4403 */ */ */ |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4404 @end group |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4405 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4406 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4407 @example |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4408 @group |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4409 /* text /* /** |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4410 text ** text ** text |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4411 */ */ */ |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4412 @end group |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4413 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4414 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4415 @example |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4416 @group |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4417 /************************************************** |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4418 * text |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4419 *************************************************/ |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4420 @end group |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4421 @end example |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4422 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4423 @vindex comment-start-skip |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4424 @example |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4425 @group |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4426 /************************************************** |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4427 Free form text comments: |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4428 In comments with a long delimiter line at the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4429 start, the indentation is kept unchanged for lines |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4430 that start with an empty comment line prefix. The |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4431 delimiter line is whatever matches the |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4432 @code{comment-start-skip} regexp. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4433 **************************************************/ |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4434 @end group |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4435 @end example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4436 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4437 The style variable @code{c-comment-prefix-regexp} is used to recognize |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
4438 the comment line prefix, e.g., the @samp{*} that usually starts every |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4439 line inside a comment. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4440 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4441 @workswith The @code{c} syntactic symbol. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4442 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4443 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4444 @comment ------------------------------------------------------------ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4445 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4446 @defun c-lineup-cascaded-calls |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4447 @findex lineup-cascaded-calls (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4448 Line up ``cascaded calls'' under each other. If the line begins with |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4449 @code{->} or @code{.} and the preceding line ends with one or more |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4450 function calls preceded by the same token, then the arrow is lined up |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4451 with the first of those tokens. E.g: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4452 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4453 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4454 @group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4455 r = proc->add(17)->add(18) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4456 ->add(19) + @hereFn{c-lineup-cascaded-calls} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4457 offset; @hereFn{c-lineup-cascaded-calls@r{ (inactive)}} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4458 @end group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4459 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4460 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4461 In any other situation @code{nil} is returned to allow use in list |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4462 expressions. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4463 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4464 @workswith @code{topmost-intro-cont}, @code{statement-cont}, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4465 @code{arglist-cont}, @code{arglist-cont-nonempty}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4466 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4467 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4468 @comment ------------------------------------------------------------ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4469 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4470 @defun c-lineup-close-paren |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4471 @findex lineup-close-paren (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4472 Line up the closing paren under its corresponding open paren if the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4473 open paren is followed by code. If the open paren ends its line, no |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4474 indentation is added. E.g: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4475 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4476 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4477 @group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4478 main (int, |
59996
aac0a33f5772
Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents:
59032
diff
changeset
|
4479 char ** |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4480 ) @hereFn{c-lineup-close-paren} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4481 @end group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4482 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4483 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4484 @noindent |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4485 and |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4486 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4487 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4488 @group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4489 main ( |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4490 int, char ** |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4491 ) @hereFn{c-lineup-close-paren} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4492 @end group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4493 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4494 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4495 As a special case, if a brace block is opened at the same line as the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4496 open parenthesis of the argument list, the indentation is |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4497 @code{c-basic-offset} instead of the open paren column. See |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4498 @code{c-lineup-arglist} for further discussion of this ``DWIM'' measure. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4499 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4500 @workswith All @code{*-close} symbols. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4501 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4502 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4503 @comment ------------------------------------------------------------ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4504 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4505 @defun c-lineup-comment |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4506 @findex lineup-comment (c-) |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4507 Line up a comment-only line according to the style variable |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4508 @code{c-comment-only-line-offset}. If the comment is lined up with a |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4509 comment starter on the previous line, that alignment is preserved. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4510 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4511 @defopt c-comment-only-line-offset |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4512 @vindex comment-only-line-offset (c-) |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4513 This style variable specifies the extra offset for the line. It can |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4514 contain an integer or a cons cell of the form |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4515 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4516 @example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4517 (@r{@var{non-anchored-offset}} . @r{@var{anchored-offset}}) |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4518 @end example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4519 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4520 @noindent |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4521 where @var{non-anchored-offset} is the amount of offset given to |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4522 non-column-zero anchored lines, and @var{anchored-offset} is the amount |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4523 of offset to give column-zero anchored lines. Just an integer as value |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4524 is equivalent to @code{(@r{@var{value}} . -1000)}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4525 @end defopt |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4526 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4527 @workswith @code{comment-intro}. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4528 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4529 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4530 @comment ------------------------------------------------------------ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4531 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4532 @defun c-lineup-cpp-define |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4533 @findex lineup-cpp-define (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4534 Line up macro continuation lines according to the indentation of the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4535 construct preceding the macro. E.g: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4536 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4537 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4538 @group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4539 const char msg[] = @hereFn{@r{The beginning of the preceding construct.}} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4540 \"Some text.\"; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4541 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4542 #define X(A, B) \ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4543 do @{ \ @hereFn{c-lineup-cpp-define} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4544 printf (A, B); \ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4545 @} while (0) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4546 @end group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4547 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4548 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4549 @noindent |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4550 and: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4551 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4552 @example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4553 @group |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4554 int dribble() @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4555 if (!running) @hereFn{@r{The beginning of the preceding construct.}} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4556 error(\"Not running!\"); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4557 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4558 #define X(A, B) \ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4559 do @{ \ @hereFn{c-lineup-cpp-define} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4560 printf (A, B); \ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4561 @} while (0) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4562 @end group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4563 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4564 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4565 If @code{c-syntactic-indentation-in-macros} is non-@code{nil}, the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4566 function returns the relative indentation to the macro start line to |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
4567 allow accumulation with other offsets. e.g., in the following cases, |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4568 @code{cpp-define-intro} is combined with the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4569 @code{statement-block-intro} that comes from the @samp{do @{} that hangs |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4570 on the @samp{#define} line: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4571 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4572 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4573 @group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4574 const char msg[] = |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4575 \"Some text.\"; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4576 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4577 #define X(A, B) do @{ \ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4578 printf (A, B); \ @hereFn{c-lineup-cpp-define} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4579 this->refs++; \ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4580 @} while (0) @hereFn{c-lineup-cpp-define} |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4581 @end group |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4582 @end example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4583 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4584 @noindent |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4585 and: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4586 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4587 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4588 @group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4589 int dribble() @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4590 if (!running) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4591 error(\"Not running!\"); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4592 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4593 #define X(A, B) do @{ \ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4594 printf (A, B); \ @hereFn{c-lineup-cpp-define} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4595 this->refs++; \ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4596 @} while (0) @hereFn{c-lineup-cpp-define} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4597 @end group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4598 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4599 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4600 The relative indentation returned by @code{c-lineup-cpp-define} is zero |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4601 and two, respectively, on the two lines in each of these examples. They |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4602 are then added to the two column indentation that |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4603 @code{statement-block-intro} gives in both cases here. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4604 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4605 If the relative indentation is zero, then @code{nil} is returned |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4606 instead. That is useful in a list expression to specify the default |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4607 indentation on the top level. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4608 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4609 If @code{c-syntactic-indentation-in-macros} is @code{nil} then this |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4610 function keeps the current indentation, except for empty lines (ignoring |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4611 the ending backslash) where it takes the indentation from the closest |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4612 preceding nonempty line in the macro. If there's no such line in the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4613 macro then the indentation is taken from the construct preceding it, as |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4614 described above. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4615 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4616 @workswith @code{cpp-define-intro}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4617 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4618 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4619 @comment ------------------------------------------------------------ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4620 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4621 @defun c-lineup-dont-change |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4622 @findex lineup-dont-change (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4623 This lineup function makes the line stay at whatever indentation it |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4624 already has; think of it as an identity function for lineups. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4625 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4626 @workswith Any syntactic symbol. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4627 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4628 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4629 @comment ------------------------------------------------------------ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4630 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4631 @defun c-lineup-gcc-asm-reg |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4632 @findex lineup-gcc-asm-reg (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4633 Line up a gcc asm register under one on a previous line. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4634 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4635 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4636 @group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4637 asm ("foo %1, %0\n" |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4638 "bar %0, %1" |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4639 : "=r" (w), |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4640 "=r" (x) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4641 : "0" (y), |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4642 "1" (z)); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4643 @end group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4644 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4645 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4646 The @samp{x} line is aligned to the text after the @samp{:} on the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4647 @samp{w} line, and similarly @samp{z} under @samp{y}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4648 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4649 This is done only in an @samp{asm} or @samp{__asm__} block, and only to |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4650 those lines mentioned. Anywhere else @code{nil} is returned. The usual |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4651 arrangement is to have this routine as an extra feature at the start of |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4652 arglist lineups, e.g. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4653 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4654 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4655 (c-lineup-gcc-asm-reg c-lineup-arglist) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4656 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4657 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4658 @workswith @code{arglist-cont}, @code{arglist-cont-nonempty}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4659 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4660 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4661 @comment ------------------------------------------------------------ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4662 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4663 @defun c-lineup-inexpr-block |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4664 @findex lineup-inexpr-block (c-) |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4665 This can be used with the in-expression block symbols to indent the |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
4666 whole block to the column where the construct is started. e.g., for Java |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4667 anonymous classes, this lines up the class under the @samp{new} keyword, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4668 and in Pike it lines up the lambda function body under the @samp{lambda} |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4669 keyword. Returns @code{nil} if the block isn't part of such a |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4670 construct. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4671 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4672 @workswith @code{inlambda}, @code{inexpr-statement}, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4673 @code{inexpr-class}. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4674 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4675 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4676 @comment ------------------------------------------------------------ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4677 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4678 @defun c-lineup-java-inher |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4679 @findex lineup-java-inher (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4680 Line up Java implements and extends declarations. If class names |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4681 follow on the same line as the @samp{implements}/@samp{extends} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4682 keyword, they are lined up under each other. Otherwise, they are |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4683 indented by adding @code{c-basic-offset} to the column of the keyword. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4684 E.g: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4685 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4686 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4687 @group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4688 class Foo |
59996
aac0a33f5772
Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents:
59032
diff
changeset
|
4689 extends |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4690 Bar @hereFn{c-lineup-java-inher} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4691 @sssTBasicOffset{} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4692 @end group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4693 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4694 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4695 @noindent |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4696 and |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4697 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4698 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4699 @group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4700 class Foo |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4701 extends Cyphr, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4702 Bar @hereFn{c-lineup-java-inher} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4703 @end group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4704 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4705 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4706 @workswith @code{inher-cont}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4707 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4708 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4709 @comment ------------------------------------------------------------ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4710 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4711 @defun c-lineup-java-throws |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4712 @findex lineup-java-throws (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4713 Line up Java throws declarations. If exception names follow on the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4714 same line as the throws keyword, they are lined up under each other. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4715 Otherwise, they are indented by adding @code{c-basic-offset} to the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4716 column of the @samp{throws} keyword. The @samp{throws} keyword itself |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4717 is also indented by @code{c-basic-offset} from the function declaration |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4718 start if it doesn't hang. E.g: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4719 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4720 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4721 @group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4722 int foo() |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4723 throws @hereFn{c-lineup-java-throws} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4724 Bar @hereFn{c-lineup-java-throws} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4725 @sssTsssTBasicOffset{} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4726 @end group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4727 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4728 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4729 @noindent |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4730 and |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4731 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4732 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4733 @group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4734 int foo() throws Cyphr, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4735 Bar, @hereFn{c-lineup-java-throws} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4736 Vlod @hereFn{c-lineup-java-throws} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4737 @end group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4738 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4739 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4740 @workswith @code{func-decl-cont}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4741 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4742 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4743 @comment ------------------------------------------------------------ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4744 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4745 @defun c-lineup-knr-region-comment |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4746 @findex lineup-knr-region-comment (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4747 Line up a comment in the ``K&R region'' with the declaration. That is |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4748 the region between the function or class header and the beginning of the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4749 block. E.g: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4750 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4751 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4752 @group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4753 int main() |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4754 /* Called at startup. */ @hereFn{c-lineup-knr-region-comment} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4755 @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4756 return 0; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4757 @} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4758 @end group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4759 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4760 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4761 Return @code{nil} if called in any other situation, to be useful in list |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4762 expressions. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4763 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4764 @workswith @code{comment-intro}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4765 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4766 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4767 @comment ------------------------------------------------------------ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4768 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4769 @defun c-lineup-math |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4770 @findex lineup-math (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4771 Line up the current line to after the equal sign on the first line in the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4772 statement. If there isn't any, indent with @code{c-basic-offset}. If |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4773 the current line contains an equal sign too, try to align it with the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4774 first one. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4775 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4776 @workswith @code{topmost-intro-cont}, @code{statement-cont}, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4777 @code{arglist-cont}, @code{arglist-cont-nonempty}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4778 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4779 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4780 @comment ------------------------------------------------------------ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4781 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4782 @defun c-lineup-multi-inher |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4783 @findex lineup-multi-inher (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4784 Line up the classes in C++ multiple inheritance clauses and member |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4785 initializers under each other. E.g: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4786 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4787 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4788 @group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4789 Foo::Foo (int a, int b): |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4790 Cyphr (a), |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4791 Bar (b) @hereFn{c-lineup-multi-inher} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4792 @end group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4793 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4794 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4795 @noindent |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4796 and |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4797 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4798 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4799 @group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4800 class Foo |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4801 : public Cyphr, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4802 public Bar @hereFn{c-lineup-multi-inher} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4803 @end group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4804 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4805 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4806 @noindent |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4807 and |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4808 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4809 @example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4810 @group |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4811 Foo::Foo (int a, int b) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4812 : Cyphr (a) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4813 , Bar (b) @hereFn{c-lineup-multi-inher} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4814 @end group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4815 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4816 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4817 @workswith @code{inher-cont}, @code{member-init-cont}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4818 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4819 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4820 @comment ------------------------------------------------------------ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4821 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4822 @defun c-lineup-ObjC-method-call |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4823 @findex lineup-ObjC-method-call (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4824 For Objective-C code, line up selector args as Emacs Lisp mode does |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4825 with function args: go to the position right after the message receiver, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4826 and if you are at the end of the line, indent the current line |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4827 c-basic-offset columns from the opening bracket; otherwise you are |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4828 looking at the first character of the first method call argument, so |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4829 lineup the current line with it. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4830 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4831 @workswith @code{objc-method-call-cont}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4832 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4833 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4834 @comment ------------------------------------------------------------ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4835 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4836 @defun c-lineup-ObjC-method-args |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4837 @findex lineup-ObjC-method-args (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4838 For Objective-C code, line up the colons that separate args. The colon |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4839 on the current line is aligned with the one on the first line. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4840 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4841 @workswith @code{objc-method-args-cont}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4842 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4843 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4844 @comment ------------------------------------------------------------ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4845 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4846 @defun c-lineup-ObjC-method-args-2 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4847 @findex lineup-ObjC-method-args-2 (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4848 Similar to @code{c-lineup-ObjC-method-args} but lines up the colon on |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4849 the current line with the colon on the previous line. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4850 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4851 @workswith @code{objc-method-args-cont}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4852 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4853 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4854 @comment ------------------------------------------------------------ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4855 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4856 @defun c-lineup-runin-statements |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4857 @findex lineup-runin-statements (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4858 Line up statements for coding standards which place the first statement |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4859 in a block on the same line as the block opening brace@footnote{Run-in |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4860 style doesn't really work too well. You might need to write your own |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4861 custom indentation functions to better support this style.}. E.g: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4862 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4863 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4864 @group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4865 int main() |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4866 @{ puts ("Hello!"); |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4867 return 0; @hereFn{c-lineup-runin-statements} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4868 @} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4869 @end group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4870 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4871 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4872 If there is no statement after the opening brace to align with, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4873 @code{nil} is returned. This makes the function usable in list |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4874 expressions. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4875 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4876 @workswith The @code{statement} syntactic symbol. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4877 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4878 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4879 @comment ------------------------------------------------------------ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4880 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4881 @defun c-lineup-streamop |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4882 @findex lineup-streamop (c-) |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
4883 Line up C++ stream operators (i.e., @samp{<<} and @samp{>>}). |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4884 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4885 @workswith @code{stream-op}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4886 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4887 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4888 @comment ------------------------------------------------------------ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4889 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4890 @defun c-lineup-string-cont |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4891 @findex lineup-string-cont (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4892 Line up a continued string under the one it continues. A continued |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4893 string in this sense is where a string literal follows directly after |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4894 another one. E.g: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4895 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4896 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4897 @group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4898 result = prefix + "A message " |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4899 "string."; @hereFn{c-lineup-string-cont} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4900 @end group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4901 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4902 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4903 @code{nil} is returned in other situations, to allow stacking with other |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4904 lineup functions. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4905 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4906 @workswith @code{topmost-intro-cont}, @code{statement-cont}, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4907 @code{arglist-cont}, @code{arglist-cont-nonempty}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4908 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4909 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4910 @comment ------------------------------------------------------------ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4911 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4912 @defun c-lineup-template-args |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4913 @findex lineup-template-args (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4914 Line up the arguments of a template argument list under each other, but |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4915 only in the case where the first argument is on the same line as the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4916 opening @samp{<}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4917 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4918 To allow this function to be used in a list expression, @code{nil} is |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4919 returned if there's no template argument on the first line. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4920 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4921 @workswith @code{template-args-cont}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4922 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4923 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4924 @comment ------------------------------------------------------------ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4925 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4926 @defun c-lineup-topmost-intro-cont |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4927 @findex lineup-topmost-intro-cont (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4928 Line up declaration continuation lines zero or one indentation |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4929 step@footnote{This function is mainly provided to mimic the behavior of |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4930 CC Mode 5.28 and earlier where this case wasn't handled consistently so |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4931 that those lines could be analyzed as either topmost-intro-cont or |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4932 statement-cont. It's used for @code{topmost-intro-cont} by default, but |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4933 you might consider using @code{+} instead.}. For lines preceding a |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4934 definition, zero is used. For other lines, @code{c-basic-offset} is |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4935 added to the indentation. E.g: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4936 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4937 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4938 @group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4939 int |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4940 neg (int i) @hereFn{c-lineup-topmost-intro-cont} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4941 @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4942 return -i; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4943 @} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4944 @end group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4945 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4946 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4947 @noindent |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4948 and |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4949 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4950 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4951 @group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4952 struct |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4953 larch @hereFn{c-lineup-topmost-intro-cont} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4954 @{ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4955 double height; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4956 @} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4957 the_larch, @hereFn{c-lineup-topmost-intro-cont} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4958 another_larch; @hereFn{c-lineup-topmost-intro-cont} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4959 @sssTBasicOffset{} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4960 @end group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4961 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4962 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4963 @noindent |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4964 and |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4965 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4966 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4967 @group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4968 struct larch |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4969 the_larch, @hereFn{c-lineup-topmost-intro-cont} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4970 another_larch; @hereFn{c-lineup-topmost-intro-cont} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4971 @end group |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4972 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4973 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4974 @workswith @code{topmost-intro-cont}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4975 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4976 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4977 @comment ------------------------------------------------------------ |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4978 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4979 @defun c-lineup-whitesmith-in-block |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4980 @findex lineup-whitesmith-in-block (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4981 Line up lines inside a block in Whitesmith style. It's done in a way |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4982 that works both when the opening brace hangs and when it doesn't. E.g: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4983 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4984 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4985 @group |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4986 something |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4987 @{ |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4988 foo; @hereFn{c-lineup-whitesmith-in-block} |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4989 @} |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4990 @end group |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4991 @end example |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4992 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4993 @noindent |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4994 and |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4995 |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4996 @example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4997 @group |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
4998 something @{ |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
4999 foo; @hereFn{c-lineup-whitesmith-in-block} |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5000 @} |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5001 @sssTBasicOffset{} |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5002 @end group |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5003 @end example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5004 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5005 In the first case the indentation is kept unchanged, in the second |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5006 @code{c-basic-offset} is added. |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5007 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5008 @workswith @code{defun-close}, @code{defun-block-intro}, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5009 @code{block-close}, @code{brace-list-close}, @code{brace-list-intro}, |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5010 @code{statement-block-intro} and all @code{in*} symbols, |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
5011 e.g., @code{inclass} and @code{inextern-lang}. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5012 @end defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5013 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5014 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5015 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5016 @node AWK Mode, Odds and Ends, Indentation Functions, Top |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5017 @comment node-name, next, previous, up |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5018 @chapter Status of AWK Mode |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5019 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5020 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5021 @dfn{AWK mode} existed until recently in the file @file{awk-mode.el} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5022 as a mode derived from c-mode. It had not been actively maintained to |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5023 keep pace with the newer @ccmode{}, and its indentation mechanism no |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5024 longer worked satisfactorally. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5025 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5026 The current AWK mode is based around the GNU implementation, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5027 @emph{GAWK version 3.1.0}, though it should work pretty well with any |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5028 AWK. It has now been updated and integrated into @ccmode{} to a |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5029 substantial extent, though as yet not all the features of @ccmode{} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5030 have been adapted to support it. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5031 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5032 If your (X)Emacs is set up to use the old file @file{awk-mode.elc} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5033 (which will usually be the case if you have obtained this @ccmode{} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5034 independently of (X)Emacs itself), or if you are not sure, insert the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5035 following form into your @file{.emacs} or @file{init.el} so that the new |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5036 AWK mode will be used instead: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5037 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5038 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5039 (autoload 'awk-mode "cc-mode" nil t) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5040 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5041 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5042 You can check which AWK mode you are running by displaying the mode |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5043 documentation string with @kbd{C-h m} from an AWK buffer. The newer |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5044 mode's doc string contains @code{To submit a problem report, enter |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5045 `C-c C-b'} near the top of the doc string where the older mode has |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5046 @code{This is much like C mode except ....}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5047 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5048 Since this newer AWK mode makes essential use of a relatively new |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5049 Emacs Lisp feature@footnote{Specifically, the @code{syntax-table} text |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5050 property.}, you need either GNU Emacs 20.1 (or later) or XEmacs 21.4 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5051 (or later) to use it. If your Emacs version is earlier than one of |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5052 these, the older @file{awk-mode.el} will get loaded and run in place |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5053 of the AWK mode described here, even when you have put the above |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5054 @code{autoload} form into your @file{.emacs} or @file{init.el}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5055 Upgrading your (X)Emacs is strongly recommended if this is the case. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5056 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5057 Here is an overview of which @ccmode{} features currently work with |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5058 AWK mode and which don't: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5059 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5060 @table @asis |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5061 @item Indentation Engine |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5062 The @ccmode{} indentation engine fully supports AWK mode. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5063 @xref{Indentation Engine}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5064 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5065 AWK mode handles code formatted in the conventional AWK fashion: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5066 @samp{@{}s which start actions, user-defined functions, or compound |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5067 statements are placed on the same line as the associated construct; the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5068 matching @samp{@}}s are normally placed under the start of the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5069 respective pattern, function definition, or structured statement. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5070 @c Add in a bit about the @samp{@}} being on the same line when the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5071 @c contents are short. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5072 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5073 The predefined indentation functions (@pxref{Indentation Functions}) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5074 haven't yet been adapted for AWK mode, though some of them may work |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5075 serendipitously. There shouldn't be any problems writing custom |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5076 indentation functions for AWK mode. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5077 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5078 The command @kbd{C-c C-q} (@code{c-indent-defun}) hasn't yet been |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5079 adapted for AWK, though in practice it works properly nearly all the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5080 time. Should it fail, explicitly set the region around the function |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5081 (using @kbd{C-u C-SPC}: @kbd{C-M-h} probably won't work either) then do |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5082 @kbd{C-M-\} (@code{indent-region}). |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5083 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5084 @item Font Locking |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5085 There is a single level of font locking in AWK mode, rather than the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5086 three distinct levels the other modes have. There are several |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5087 idiosyncrasies in AWK mode's font-locking due to the peculiarities of |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5088 the AWK language itself. @xref{AWK Mode Font Locking}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5089 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5090 @item Comment Commands |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5091 @kbd{M-;} (@code{indent-for-comment}) works fine. None of the other |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5092 @ccmode{} comment formatting commands have yet been adapted for AWK |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5093 mode. @xref{Text Filling and Line Breaking}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5094 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5095 @item Movement Commands |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5096 Most of the movement commands work in AWK mode. The most important |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5097 exceptions are @kbd{M-a} (@code{c-beginning-of-statement}) and |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5098 @kbd{M-e} (@code{c-end-of-statement}) which haven't yet been adapted. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5099 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5100 The notion of @dfn{defun} has been augmented to include pattern-action |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5101 pairs. See @ref{AWK Mode Defuns} for a description of commands which |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5102 work on AWK ``defuns''. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5103 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5104 Since there is no preprocessor in AWK, the commands which move to |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
5105 preprocessor directives (e.g., @code{c-up-conditional}) are meaningless |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5106 in AWK mode and are not bound in the AWK mode keymap. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5107 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5108 @item Auto-newline Insertion and Clean-ups |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5109 Auto-newline insertion hasn't yet been adapted for AWK. Some of the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5110 clean-ups can actually convert good AWK code into syntactically |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5111 invalid code. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5112 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5113 If auto-newline or its associated clean-ups are enabled generally for |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5114 the modes in @ccmode{}, you are strongly recommended to disable them |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5115 in the AWK Mode hook. @xref{Initialising AWK Mode}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5116 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5117 The clean-up @code{space-before-funcall}, which is independent of |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5118 auto-newline, should never be active in AWK mode (since inserting a |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5119 space between a user function's name and its opening @samp{(} makes |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5120 the call syntactically invalid). If necessary, this should be |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5121 disabled in the AWK Mode hook. @xref{Initialising AWK Mode}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5122 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5123 @end table |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5124 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5125 @menu |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5126 * Initialising AWK Mode:: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5127 * AWK Mode Font Locking:: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5128 * AWK Mode Defuns:: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5129 @end menu |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5130 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5131 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5132 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5133 @node Initialising AWK Mode, AWK Mode Font Locking, , AWK Mode |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5134 @comment node-name, next, previous, up |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5135 @section AWK mode - What to put in your @file{.emacs} or @file{init.el} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5136 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5137 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5138 Much of the AWK mode initialization can, of course, be done by the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5139 @ccmode{} general initialization procedure. You may want to use certain |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5140 @ccmode{} features such as @code{auto-newline} and @code{clean-ups} in |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5141 the other modes, and you might thus have enabled them in a |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5142 @code{c-mode-common-hook} function, as described in @ref{Sample .emacs File}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5143 These features have not yet been amended for AWK mode, and far from |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5144 being useful, can be irritating in AWK mode or actually make AWK code |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5145 syntactically invalid. Adding the following code to your |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5146 @file{.emacs} or @file{init.el} file will disable them for AWK mode. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5147 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5148 @example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5149 (defun my-awk-mode-hook () |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5150 "Disable certain @ccmode{} features which could impair AWK mode." |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5151 (c-toggle-auto-state -1) ; disable automatic insertions of newlines |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5152 (if (memq 'space-before-funcall c-cleanup-list) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5153 (setq c-cleanup-list ; don't automatically insert a space into "foo(" |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5154 (remove 'space-before-funcall c-cleanup-list)))) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5155 (add-hook 'awk-mode-hook 'my-awk-mode-hook) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5156 @end example |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5157 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5158 Naturally you can add your own AWK-specific customizations to this |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5159 function. @xref{Hooks}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5160 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5161 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5162 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5163 @node AWK Mode Font Locking, AWK Mode Defuns, Initialising AWK Mode, AWK Mode |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5164 @comment node-name, next, previous, up |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5165 @section AWK Mode Font Locking |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5166 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5167 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5168 The general appearance of font-locking in AWK mode is much like in any |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5169 other programming mode. @xref{Faces For Font Lock,,,elisp}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5170 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5171 The following faces are, however, used in a non-standard fashion in |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5172 AWK mode: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5173 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5174 @table @asis |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5175 @item @code{font-lock-variable-name-face} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5176 This face was intended for variable declarations. Since variables are |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5177 not declared in AWK, this face is used instead for AWK system |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5178 variables (such as @code{NF}) and ``Special File Names'' (such as |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5179 @code{"/dev/stderr"}). |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5180 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5181 @item @code{font-lock-builtin-face} (Emacs)/@code{font-lock-preprocessor-face} (XEmacs) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5182 This face is normally used for preprocessor directives in @ccmode{}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5183 There are no such things in AWK, so this face is used instead for |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5184 standard functions (such as @code{match}). |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5185 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5186 @item @code{font-lock-string-face} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5187 As well as being used for strings, including localizable strings, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5188 (delimited by @samp{"} and @samp{_"}), this face is also used for AWK |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5189 regular expressions (delimited by @samp{/}). |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5190 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5191 @item @code{font-lock-warning-face} (Emacs)/@code{c-invalid-face} (XEmacs) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5192 This face highlights the following syntactically invalid AWK |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5193 constructs: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5194 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5195 @itemize @bullet |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5196 @item |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5197 An unterminated string or regular expression. Here the opening |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5198 delimiter (@samp{"} or @samp{/} or @samp{_"}) is displayed in |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5199 @code{font-lock-warning-face}. This is most noticeable when typing in a |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5200 new string/regular expression into a buffer, when the warning-face |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5201 serves as a continual reminder to terminate the construct. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5202 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5203 AWK mode fontifies unterminated strings/regular expressions |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5204 differently from other modes: Only the text up to the end of the line |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5205 is fontified as a string (escaped newlines being handled correctly), |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5206 rather than the text up to the next string quote. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5207 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5208 @item |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5209 A space between the function name and opening parenthesis when calling |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5210 a user function. The last character of the function name and the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5211 opening parenthesis are highlighted. This font-locking rule will |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5212 spuriously highlight a valid concatenation expression where an |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5213 identifier precedes a parenthesised expression. Unfortunately. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5214 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5215 @item |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5216 Whitespace following the @samp{\} in what otherwise looks like an |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5217 escaped newline. The @samp{\} is highlighted. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5218 @end itemize |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5219 @end table |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5220 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5221 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5222 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5223 @node AWK Mode Defuns, , AWK Mode Font Locking, AWK Mode |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5224 @comment node-name, next, previous, up |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5225 @section AWK Mode Defuns |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5226 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5227 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5228 In AWK mode, @dfn{defun} means either a user-defined function or a |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5229 pattern-action pair. Either the pattern or the action may be |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5230 implicit. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5231 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5232 The beginning of a defun is recognised heuristically as, more or less, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5233 code which begins in column zero. Having the @samp{@{} in column zero, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5234 as is suggested for some modes, is neither necessary nor helpful in AWK |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5235 mode. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5236 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5237 More precisely, the beginning of a defun is code which begins in |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5238 column zero, and which isn't a closing brace, a comment, or a |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5239 continuation of the previous line. Code is the @dfn{continuation of |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5240 the previous line} when that line is syntactically incomplete, for |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5241 example when it ends with @samp{@{} or an escaped newline. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5242 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5243 The end of a defun is the @samp{@}} which matches the @samp{@{} (if |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5244 any) at the beginning of the action or function body, or the EOL or |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5245 @samp{;} which marks an implicit action. Although this @samp{@}} is |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5246 usually placed in column zero, AWK mode doesn't need it to be placed |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5247 there. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5248 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5249 @table @asis |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5250 @item @kbd{C-M-a} @code{c-awk-beginning-of-defun} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5251 @itemx @kbd{C-M-e} @code{c-awk-end-of-defun} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5252 @findex c-awk-beginning-of-defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5253 @findex awk-beginning-of-defun (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5254 @findex c-awk-end-of-defun |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5255 @findex awk-end-of-defun (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5256 Move point back to the beginning or forward to the end of the current |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5257 AWK defun. These functions can take prefix-arguments, their |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5258 functionality being entirely equivalent to @code{beginning-of-defun} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5259 and @code{end-of-defun}. @xref{Moving by Defuns,,,emacs}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5260 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5261 @item @kbd{C-M-h} @code{c-mark-function} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5262 This works fine with AWK defuns. @xref{Indentation Commands}. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5263 @end table |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5264 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5265 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5266 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5267 @node Odds and Ends, Performance Issues, AWK Mode, Top |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5268 @comment node-name, next, previous, up |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5269 @chapter Odds and Ends |
25829 | 5270 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
5271 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5272 The stuff that didn't fit in anywhere else is documented here. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5273 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5274 @defopt c-require-final-newline |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5275 @vindex require-final-newline (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5276 Controls whether a final newline is ensured when the file is saved. The |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5277 value is an association list that for each language mode specifies the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5278 value to give to @code{require-final-newline} at mode initialization; |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5279 see that variable for details about the value. If a language isn't |
56646
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
5280 present on the association list, CC Mode won't touch |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5281 @code{require-final-newline} in buffers for that language. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5282 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5283 The default is to set @code{require-final-newline} to @code{t} in the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5284 languages that mandates that source files should end with newlines, |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
5285 i.e., C, C++ and Objective-C. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5286 @end defopt |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5287 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5288 @defopt c-echo-syntactic-information-p |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5289 @vindex echo-syntactic-information-p (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5290 If non-@code{nil}, the syntactic analysis for the current line is shown |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5291 in the echo area when it's indented (unless |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5292 @code{c-syntactic-indentation} is @code{nil}). That's useful when |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5293 finding out which syntactic symbols to modify to get the indentation you |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5294 want. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5295 @end defopt |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5296 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5297 @defopt c-report-syntactic-errors |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5298 @vindex report-syntactic-errors (c-) |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5299 If non-@code{nil}, certain syntactic errors are reported with a ding and |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5300 a message, for example when an @code{else} is indented for which there |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5301 is no corresponding @code{if}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5302 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5303 Note however that @ccmode{} doesn't make any special effort to check for |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5304 syntactic errors; that's the job of the compiler. The reason it can |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5305 report cases like the one above is that it can't find the correct |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5306 anchoring position to indent the line in that case. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5307 @end defopt |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5308 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5309 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5310 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5311 @node Performance Issues, Limitations and Known Bugs, Odds and Ends, Top |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5312 @comment node-name, next, previous, up |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5313 @chapter Performance Issues |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5314 @cindex performance |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5315 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5316 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5317 @comment FIXME: (ACM, 2003/5/24). Check whether AWK needs mentioning here. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5318 |
25829 | 5319 C and its derivative languages are highly complex creatures. Often, |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5320 ambiguous code situations arise that require @ccmode{} to scan large |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5321 portions of the buffer to determine syntactic context. Such |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5322 pathological code can cause @ccmode{} to perform fairly badly. This |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5323 section gives some insight in how @ccmode{} operates, how that interacts |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5324 with some coding styles, and what you can use to improve performance. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5325 |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
5326 The overall goal is that @ccmode{} shouldn't be overly slow (i.e., take |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5327 more than a fraction of a second) in any interactive operation. |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
5328 i.e., it's tuned to limit the maximum response time in single operations, |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5329 which sometimes is at the expense of batch-like operations like |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5330 reindenting whole blocks. If you find that @ccmode{} gradually gets |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5331 slower and slower in certain situations, perhaps as the file grows in |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5332 size or as the macro or comment you're editing gets bigger, then chances |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5333 are that something isn't working right. You should consider reporting |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5334 it, unless it's something that's mentioned in this section. |
25829 | 5335 |
5336 Because @ccmode{} has to scan the buffer backwards from the current | |
5337 insertion point, and because C's syntax is fairly difficult to parse in | |
5338 the backwards direction, @ccmode{} often tries to find the nearest | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5339 position higher up in the buffer from which to begin a forward scan |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5340 (it's typically an opening or closing parethesis of some kind). The |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5341 farther this position is from the current insertion point, the slower it |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5342 gets. |
25829 | 5343 |
5344 @findex beginning-of-defun | |
5345 @findex defun-prompt-regexp | |
5346 One of the simplest things you can do to reduce scan time, is make sure | |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
5347 any brace that opens a top-level construct@footnote{e.g., a function in |
25829 | 5348 C, or outermost class definition in C++ or Java.} always appears in the |
5349 leftmost column. This is actually an Emacs constraint, as embodied in | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5350 the @code{beginning-of-defun} function which @ccmode{} uses heavily. If |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5351 you hang top-level open braces on the right side of the line, then you |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5352 might want to set the variable @code{defun-prompt-regexp} to something |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5353 reasonable, however that ``something reasonable'' is difficult to |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5354 define, so @ccmode{} doesn't do it for you. |
25829 | 5355 |
5356 @vindex c-Java-defun-prompt-regexp | |
5357 @vindex Java-defun-prompt-regexp (c-) | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5358 A special note about @code{defun-prompt-regexp} in Java mode: The common |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5359 style is to hang the opening braces of functions and classes on the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5360 right side of the line, and that doesn't work well with the Emacs |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5361 approach. @ccmode{} comes with a variable |
25829 | 5362 @code{c-Java-defun-prompt-regexp} which tries to define a regular |
5363 expression usable for this style, but there are problems with it. In | |
5364 some cases it can cause @code{beginning-of-defun} to hang@footnote{This | |
5365 has been observed in Emacs 19.34 and XEmacs 19.15.}. For this reason, | |
5366 it is not used by default, but if you feel adventurous, you can set | |
5367 @code{defun-prompt-regexp} to it in your mode hook. In any event, | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5368 setting and relying on @code{defun-prompt-regexp} will definitely slow |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5369 things down because (X)Emacs will be doing regular expression searches a |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5370 lot, so you'll probably be taking a hit either way! |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5371 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5372 @ccmode{} maintains a cache of the opening parentheses of the blocks |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5373 surrounding the point, and it adapts that cache as the point is moved |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5374 around. That means that in bad cases it can take noticeable time to |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5375 indent a line in a new surrounding, but after that it gets fast as long |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5376 as the point isn't moved far off. The farther the point is moved, the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5377 less useful is the cache. Since editing typically is done in ``chunks'' |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5378 rather than on single lines far apart from each other, the cache |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5379 typically gives good performance even when the code doesn't fit the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5380 Emacs approach to finding the defun starts. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5381 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5382 @vindex c-enable-xemacs-performance-kludge-p |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5383 @vindex enable-xemacs-performance-kludge-p (c-) |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5384 XEmacs users can set the variable |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5385 @code{c-enable-xemacs-performance-kludge-p} to non-@code{nil}. This |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5386 tells @ccmode{} to use XEmacs-specific built-in functions which, in some |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5387 circumstances, can locate the top-most opening brace much more quickly than |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5388 @code{beginning-of-defun}. Preliminary testing has shown that for |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
5389 styles where these braces are hung (e.g., most JDK-derived Java styles), |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5390 this hack can improve performance of the core syntax parsing routines |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5391 from 3 to 60 times. However, for styles which @emph{do} conform to |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5392 Emacs' recommended style of putting top-level braces in column zero, |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5393 this hack can degrade performance by about as much. Thus this variable |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5394 is set to @code{nil} by default, since the Emacs-friendly styles should |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5395 be more common (and encouraged!). Note that this variable has no effect |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5396 in Emacs since the necessary built-in functions don't exist (in Emacs |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5397 21.3 as of this writing in May 2003). |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5398 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5399 Text properties are used to speed up skipping over syntactic whitespace, |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
5400 i.e., comments and preprocessor directives. Indenting a line after a |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5401 huge macro definition can be slow the first time, but after that the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5402 text properties are in place and it should be fast (even after you've |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5403 edited other parts of the file and then moved back). |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5404 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5405 Font locking can be a CPU hog, especially the font locking done on |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5406 decoration level 3 which tries to be very accurate. Note that that |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5407 level is designed to be used with a font lock support mode that only |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
5408 fontifies the text that's actually shown, i.e., Lazy Lock or Just-in-time |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5409 Lock mode, so make sure you use one of them. Fontification of a whole |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5410 buffer with some thousand lines can often take over a minute. That is |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5411 a known weakness; the idea is that it never should happen. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5412 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5413 The most effective way to speed up font locking is to reduce the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5414 decoration level to 2 by setting @code{font-lock-maximum-decoration} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5415 appropriately. That level is designed to be as pretty as possible |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5416 without sacrificing performance. @xref{Font Locking Preliminaries}, for |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5417 more info. |
25829 | 5418 |
5419 | |
36923 | 5420 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
5421 @node Limitations and Known Bugs, Frequently Asked Questions, Performance Issues, Top | |
5422 @comment node-name, next, previous, up | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5423 @chapter Limitations and Known Bugs |
36923 | 5424 @cindex limitations |
5425 @cindex bugs | |
5426 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
5427 | |
5428 @itemize @bullet | |
5429 @item | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5430 There is no way to apply auto newline settings (@pxref{Auto-newline |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5431 Insertion}) on already typed lines. That's only a feature to ease |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5432 interactive editing. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5433 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5434 To generalize this issue a bit: @ccmode{} is not intended to be used as |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5435 a reformatter for old code in some more or less batch-like way. With |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5436 the exception of some functions like @code{c-indent-region}, it's only |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5437 geared to be used interactively to edit new code. There's currently no |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5438 intention to change this goal. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5439 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5440 If you want to reformat old code, you're probably better off using some |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
5441 other tool instead, e.g., @ref{Top, , GNU indent, indent, The `indent' |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5442 Manual}, which has more powerful reformatting capabilities than |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5443 @ccmode{}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5444 |
36923 | 5445 @item |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5446 @vindex signal-error-on-buffer-boundary |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5447 XEmacs has a variable called @code{signal-error-on-buffer-boundary}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5448 It's used as a solution to user interface problems associated with |
36923 | 5449 buffer movement and the @code{zmacs-region} deactivation on errors. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5450 However, setting this variable to a non-default value in XEmacs 19 and |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5451 20 had the deleterious side effect of breaking many built-in primitive |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5452 functions. @strong{Do not set this variable to @code{nil} in XEmacs |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5453 19 and 20}; you will cause serious problems in @ccmode{} and probably |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5454 other XEmacs packages! In XEmacs 21 the effects of the variable is |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5455 limited to some functions that are only used interactively, so it's |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5456 not a problem there. |
36923 | 5457 @end itemize |
5458 | |
5459 | |
25829 | 5460 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
36923 | 5461 @node Frequently Asked Questions, Getting the Latest CC Mode Release, Limitations and Known Bugs, Top |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5462 @comment node-name, next, previous, up |
36923 | 5463 @appendix Frequently Asked Questions |
25829 | 5464 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
5465 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5466 @itemize @bullet |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5467 @item |
25829 | 5468 @kindex C-x h |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5469 @kindex C-M-\ |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5470 @emph{How do I reindent the whole file?} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5471 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5472 Visit the file and hit @kbd{C-x h} to mark the whole buffer. Then hit |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5473 @kbd{C-M-\}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5474 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5475 @item |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5476 @kindex C-M-q |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5477 @kindex C-M-u |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5478 @emph{How do I reindent the current block?} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5479 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5480 First move to the brace which opens the block with @kbd{C-M-u}, then |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5481 reindent that expression with @kbd{C-M-q}. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5482 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5483 @item |
25829 | 5484 @kindex RET |
5485 @kindex C-j | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5486 @emph{Why doesn't the @kbd{RET} key indent the new line?} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5487 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5488 Emacs' convention is that @kbd{RET} just adds a newline, and that |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5489 @kbd{C-j} adds a newline and indents it. You can make @kbd{RET} do this |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5490 too by adding this to your @code{c-mode-common-hook}: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5491 |
25829 | 5492 @example |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5493 (define-key c-mode-base-map "\C-m" 'c-context-line-break) |
25829 | 5494 @end example |
5495 | |
5496 This is a very common question. If you want this to be the default | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5497 behavior, don't lobby me, lobby RMS! @t{:-)} |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5498 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5499 @item |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5500 @emph{I put @code{(c-set-offset 'substatement-open 0)} in my |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5501 @file{.emacs} file but I get an error saying that @code{c-set-offset}'s |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5502 function definition is void. What's wrong?} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5503 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5504 This means that @ccmode{} wasn't loaded into your Emacs session by the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5505 time the @code{c-set-offset} call was reached, most likely because |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5506 @ccmode{} is being autoloaded. Instead of putting the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5507 @code{c-set-offset} line in your top-level @file{.emacs} file, put it in |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5508 your @code{c-mode-common-hook}, or simply modify @code{c-offsets-alist} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5509 directly: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5510 |
25829 | 5511 @example |
30396
460a86ced57c
@setfilename to ../info/ccmode.
Gerd Moellmann <gerd@gnu.org>
parents:
30044
diff
changeset
|
5512 (setq c-offsets-alist '((substatement-open . 0))) |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5513 @end example |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5514 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5515 @item |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5516 @kindex M-a |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5517 @kindex M-e |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5518 @emph{@kbd{M-a} and @kbd{M-e} used to move over entire balanced brace |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5519 lists, but now they move into blocks. How do I get the old behavior |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5520 back?} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5521 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5522 Use @kbd{C-M-f} and @kbd{C-M-b} to move over balanced brace blocks. Use |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5523 @kbd{M-a} and @kbd{M-e} to move by statements, which will also move into |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5524 blocks. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5525 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5526 @item |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5527 @emph{Whenever I try to indent a line or type an ``electric'' key such |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5528 as @kbd{;}, @kbd{@{}, or @kbd{@}}, I get an error that look like this: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5529 @code{Invalid function: (macro . #[...}. What gives?} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5530 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5531 This is a common error when @ccmode{} hasn't been compiled correctly, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5532 especially under Emacs 19.34@footnote{Technically, it's because some |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5533 macro wasn't defined during the compilation, so the byte compiler put |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5534 in function calls instead of the macro expansions. Later, when the |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5535 interpreter tries to call the macro as a function, it shows this |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5536 (somewhat cryptic) error message.}. If you are using the standalone |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5537 @ccmode{} distribution, try recompiling it according to the instructions |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5538 in the @file{README} file. |
56646
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
5539 |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
5540 @item |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
5541 @cindex open paren in column zero |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
5542 @emph{I have an open paren character at column zero inside a comment or |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
5543 multiline string literal, and it causes the fontification and/or |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
5544 indentation to go haywire. What gives?} |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
5545 |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
5546 It's due to the ad-hoc rule in (X)Emacs that such open parens always |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
5547 start defuns (which translates to functions, classes, namespaces or any |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
5548 other top-level block constructs in the @ccmode{} languages). |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
5549 @xref{Left Margin Paren,,, emacs, The Emacs Editor}, for details |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
5550 (@xref{Defuns,,, emacs, The Emacs Editor}, in the Emacs 20 manual). |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
5551 |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
5552 This heuristic is built into the core syntax analysis routines in |
59996
aac0a33f5772
Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents:
59032
diff
changeset
|
5553 (X)Emacs, so it's not really a @ccmode{} issue. However, in Emacs 22.1 |
56646
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
5554 it has become possible to turn it off@footnote{Using the variable |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
5555 @code{open-paren-in-column-0-is-defun-start}.} and @ccmode{} does so |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
5556 there since it got its own system to keep track of blocks. |
b7446b6f097d
Updated CC Mode to 5.30.9.
Martin Stjernholm <mast@lysator.liu.se>
parents:
55832
diff
changeset
|
5557 |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5558 @end itemize |
25829 | 5559 |
5560 | |
5561 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
36923 | 5562 @node Getting the Latest CC Mode Release, Mailing Lists and Submitting Bug Reports, Frequently Asked Questions, Top |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5563 @comment node-name, next, previous, up |
36923 | 5564 @appendix Getting the Latest CC Mode Release |
25829 | 5565 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
5566 | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5567 @ccmode{} has been standard with all versions of Emacs since 19.34 and |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5568 of XEmacs since 19.16. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5569 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5570 @cindex web site |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5571 Due to release schedule skew, it is likely that all of these Emacsen |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
47737
diff
changeset
|
5572 have old versions of @ccmode{} and so should be upgraded. Access to the |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5573 @ccmode{} source code, as well as more detailed information on Emacsen |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5574 compatibility, etc. are all available on the web site: |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5575 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5576 @quotation |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5577 @uref{http://cc-mode.sourceforge.net/} |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5578 @end quotation |
25829 | 5579 |
5580 | |
36923 | 5581 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
5582 @node Mailing Lists and Submitting Bug Reports, Sample .emacs File, Getting the Latest CC Mode Release, Top | |
5583 @comment node-name, next, previous, up | |
5584 @appendix Mailing Lists and Submitting Bug Reports | |
5585 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | |
5586 | |
5587 @kindex C-c C-b | |
5588 @findex c-submit-bug-report | |
5589 @findex submit-bug-report (c-) | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5590 To report bugs, use the @kbd{C-c C-b} (bound to |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5591 @code{c-submit-bug-report}) command. This provides vital information |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5592 we need to reproduce your problem. Make sure you include a concise, |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5593 but complete code example. Please try to boil your example down to |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5594 just the essential code needed to reproduce the problem, and include |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5595 an exact recipe of steps needed to expose the bug. Be especially sure |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5596 to include any code that appears @emph{before} your bug example, if |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5597 you think it might affect our ability to reproduce it. |
36923 | 5598 |
5599 Please try to produce the problem in an Emacs instance without any | |
55832
cd954d951766
Put commas after i.e. and e.g. Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents:
53118
diff
changeset
|
5600 customizations loaded (i.e., start it with the @samp{-q --no-site-file} |
36923 | 5601 arguments). If it works correctly there, the problem might be caused by |
5602 faulty customizations in either your own or your site configuration. In | |
5603 that case, we'd appreciate if you isolate the Emacs Lisp code that trigs | |
5604 the bug and include it in your report. | |
5605 | |
5606 @cindex bug report mailing list | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5607 Bug reports are sent to @email{bug-cc-mode@@gnu.org}. You can also send |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5608 other questions and suggestions (kudos? @t{;-)} to that address. It's a |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5609 mailing list which you can join or browse an archive of; see the web |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5610 site at @uref{http://cc-mode.sourceforge.net/} for further details. |
36923 | 5611 |
5612 @cindex announcement mailing list | |
5613 If you want to get announcements of new @ccmode{} releases, send the | |
5614 word @emph{subscribe} in the body of a message to | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5615 @email{cc-mode-announce-request@@lists.sourceforge.net}. It's possible |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5616 to subscribe from the web site too. Announcements will also be posted |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5617 to the Usenet newsgroups @code{gnu.emacs.sources}, @code{comp.emacs} and |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5618 @code{comp.emacs.xemacs}. |
36923 | 5619 |
5620 | |
25829 | 5621 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5622 @node Sample .emacs File, Command and Function Index, Mailing Lists and Submitting Bug Reports, Top |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5623 @comment node-name, next, previous, up |
36923 | 5624 @appendix Sample .emacs file |
25829 | 5625 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
5626 | |
5627 @example | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5628 ;; Here's a sample .emacs file that might help you along the way. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5629 ;; Just copy this region and paste it into your .emacs file. You may |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5630 ;; want to change some of the actual values. |
25829 | 5631 |
5632 (defconst my-c-style | |
5633 '((c-tab-always-indent . t) | |
5634 (c-comment-only-line-offset . 4) | |
5635 (c-hanging-braces-alist . ((substatement-open after) | |
5636 (brace-list-open))) | |
5637 (c-hanging-colons-alist . ((member-init-intro before) | |
5638 (inher-intro) | |
5639 (case-label after) | |
5640 (label after) | |
5641 (access-label after))) | |
5642 (c-cleanup-list . (scope-operator | |
5643 empty-defun-braces | |
5644 defun-close-semi)) | |
5645 (c-offsets-alist . ((arglist-close . c-lineup-arglist) | |
5646 (substatement-open . 0) | |
5647 (case-label . 4) | |
5648 (block-open . 0) | |
5649 (knr-argdecl-intro . -))) | |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5650 (c-echo-syntactic-information-p . t)) |
25829 | 5651 "My C Programming Style") |
5652 | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5653 ;; offset customizations not in my-c-style |
30396
460a86ced57c
@setfilename to ../info/ccmode.
Gerd Moellmann <gerd@gnu.org>
parents:
30044
diff
changeset
|
5654 (setq c-offsets-alist '((member-init-intro . ++))) |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5655 |
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5656 ;; Customizations for all modes in CC Mode. |
25829 | 5657 (defun my-c-mode-common-hook () |
5658 ;; add my personal style and set it for the current buffer | |
5659 (c-add-style "PERSONAL" my-c-style t) | |
5660 ;; other customizations | |
5661 (setq tab-width 8 | |
5662 ;; this will make sure spaces are used instead of tabs | |
5663 indent-tabs-mode nil) | |
5664 ;; we like auto-newline and hungry-delete | |
5665 (c-toggle-auto-hungry-state 1) | |
39267 | 5666 ;; key bindings for all supported languages. We can put these in |
25829 | 5667 ;; c-mode-base-map because c-mode-map, c++-mode-map, objc-mode-map, |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5668 ;; java-mode-map, idl-mode-map, and pike-mode-map inherit from it. |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5669 (define-key c-mode-base-map "\C-m" 'c-context-line-break)) |
25829 | 5670 |
5671 (add-hook 'c-mode-common-hook 'my-c-mode-common-hook) | |
5672 @end example | |
5673 | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5674 |
25829 | 5675 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5676 @node Command and Function Index, Variable Index, Sample .emacs File, Top |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5677 @comment node-name, next, previous, up |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5678 @unnumbered Command and Function Index |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5679 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5680 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5681 Since most @ccmode{} commands are prepended with the string |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5682 @samp{c-}, each appears under its @code{c-@var{thing}} name and its |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5683 @code{@var{thing} (c-)} name. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5684 @iftex |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5685 @sp 2 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5686 @end iftex |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5687 @printindex fn |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5688 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5689 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5690 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5691 @node Variable Index, Concept Index, Command and Function Index, Top |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5692 @comment node-name, next, previous, up |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5693 @unnumbered Variable Index |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5694 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5695 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5696 Since most @ccmode{} variables are prepended with the string |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5697 @samp{c-}, each appears under its @code{c-@var{thing}} name and its |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5698 @code{@var{thing} (c-)} name. |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5699 @iftex |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5700 @sp 2 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5701 @end iftex |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5702 @printindex vr |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5703 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5704 |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5705 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5706 @node Concept Index, , Variable Index, Top |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5707 @comment node-name, next, previous, up |
25829 | 5708 @unnumbered Concept Index |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5709 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
25829 | 5710 |
5711 @printindex cp | |
5712 | |
5713 | |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5714 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
53118
04d26b9d5b56
* cc-mode.texi: Updated for CC Mode 5.30.
Martin Stjernholm <mast@lysator.liu.se>
parents:
52401
diff
changeset
|
5715 @comment Epilogue. |
26819
a19be798eaea
Installed cc-mode version 5.26.
Gerd Moellmann <gerd@gnu.org>
parents:
26490
diff
changeset
|
5716 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
36923 | 5717 |
5718 @iftex | |
25829 | 5719 @page |
5720 @summarycontents | |
5721 @contents | |
36923 | 5722 @end iftex |
5723 | |
25829 | 5724 @bye |
52401 | 5725 |
5726 @ignore | |
5727 arch-tag: c4cab162-5e57-4366-bdce-4a9db2fc97f0 | |
5728 @end ignore |