[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] Changes to cc-mode.texi
|
From: |
Glenn Morris |
|
Subject: |
[Emacs-diffs] Changes to cc-mode.texi |
|
Date: |
Thu, 06 Sep 2007 04:58:55 +0000 |
CVSROOT: /sources/emacs
Module name: emacs
Changes by: Glenn Morris <gm> 07/09/06 04:58:54
Index: cc-mode.texi
===================================================================
RCS file: cc-mode.texi
diff -N cc-mode.texi
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ cc-mode.texi 6 Sep 2007 04:58:54 -0000 1.1
@@ -0,0 +1,6998 @@
+\input texinfo
address@hidden Notes to self regarding line handling:
address@hidden
address@hidden Empty lines are often significant before @end directives; avoid
them.
address@hidden
address@hidden Empty lines before and after @example directives are significant
in
address@hidden info output but not in TeX. Empty lines inside @example
directives
address@hidden are significant.
+
address@hidden Conventions for formatting examples:
address@hidden o If the example contains empty lines then put the surrounding
empty
address@hidden lines inside the @example directives. Put them outside
otherwise.
address@hidden o Use @group inside the example only if it shows indentation
where
address@hidden the relation between lines inside is relevant.
address@hidden o Format line number columns like this:
address@hidden 1: foo
address@hidden 2: bar
address@hidden ^ one space
address@hidden ^^ two columns, right alignment
address@hidden o Check line lengths in TeX output; they can typically be no
longer
address@hidden than 70 chars, 60 if the paragraph is indented.
+
address@hidden TBD: Document the finer details of statement anchoring?
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden %**start of header (This is for running Texinfo on a region)
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden How to make the various output formats:
address@hidden (Thanks to Robert Chassell for supplying this information.)
address@hidden Note that Texinfo 4.7 (or later) is needed.
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden
+In each of the following pairs of commands, the first generates a
+version with cross references pointing to the GNU Emacs manuals,
+the second with them pointing to the XEmacs manuals.
+ ## Info output
+ makeinfo cc-mode.texi
+ makeinfo -DXEMACS cc-mode.texi
+
+ ## DVI output
+ ## You may need to set up the environment variable TEXINPUTS so
+ ## that tex can find the file texinfo.tex - See the tex
+ ## manpage.
+ texi2dvi cc-mode.texi
+ texi2dvi -t "@set XEMACS " cc-mode.texi
+
+ ## HTML output. (The --no-split parameter is optional)
+ makeinfo --html --no-split cc-mode.texi
+ makeinfo --html --no-split -DXEMACS cc-mode.texi
+
+ ## Plain text output
+ makeinfo --fill-column=70 --no-split --paragraph-indent=0 \
+ --no-headers --output=cc-mode.txt cc-mode.texi
+ makeinfo --fill-column=70 --no-split --paragraph-indent=0 \
+ --no-headers --output=cc-mode.txt -DXEMACS cc-mode.texi
+
+ ## DocBook output
+ makeinfo --docbook --no-split --paragraph-indent=0 \
+ cc-mode.texi
+ makeinfo --docbook --no-split --paragraph-indent=0 \
+ -DXEMACS cc-mode.texi
+
+ ## XML output
+ makeinfo --xml --no-split --paragraph-indent=0 \
+ cc-mode.texi
+ makeinfo --xml --no-split --paragraph-indent=0 \
+ -DXEMACS cc-mode.texi
+
+ #### (You must be in the same directory as the viewed file.)
+
+ ## View DVI output
+ xdvi cc-mode.dvi &
+
+ ## View HTML output
+ mozilla cc-mode.html
address@hidden ignore
+
address@hidden No overfull hbox marks in the dvi file.
address@hidden
+
address@hidden ../info/ccmode
address@hidden CC Mode Manual
address@hidden end
+
address@hidden The following four macros generate the filenames and titles of
the
address@hidden main (X)Emacs manual and the Elisp/Lispref manual. Leave the
address@hidden Texinfo variable `XEMACS' unset to generate a GNU Emacs version,
set it
address@hidden to generate an XEmacs version, e.g. with
address@hidden "makeinfo -DXEMACS cc-mode.texi".
address@hidden XEMACS
address@hidden emacsman
+xemacs
address@hidden macro
address@hidden emacsmantitle
+XEmacs User's Manual
address@hidden macro
address@hidden lispref
+lispref
address@hidden macro
address@hidden lispreftitle
+XEmacs Lisp Reference Manual
address@hidden macro
address@hidden ifset
+
address@hidden XEMACS
address@hidden emacsman
+emacs
address@hidden macro
address@hidden emacsmantitle
+GNU Emacs Manual
address@hidden macro
address@hidden lispref
+elisp
address@hidden macro
address@hidden lispreftitle
+GNU Emacs Lisp Reference Manual
address@hidden macro
address@hidden ifclear
+
+
address@hidden ccmode
+CC Mode
address@hidden macro
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden @setchapternewpage odd !! we don't want blank pages !!
address@hidden %**end of header (This is for running Texinfo on a region)
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden
address@hidden Texinfo manual for CC Mode
address@hidden Generated from the original README file by Krishna Padmasola
address@hidden <address@hidden>
address@hidden
address@hidden Authors:
address@hidden Barry A. Warsaw
address@hidden Martin Stjernholm
address@hidden Alan Mackenzie
address@hidden
address@hidden Maintained by Martin Stjernholm and Alan Mackenzie
<address@hidden>
address@hidden
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden Define an index for syntactic symbols.
address@hidden @c In texi2dvi, the @defindex would create an empty cc-mode.ss
+ @c For Info, unlike tex, @syncodeindex needs a matching @defindex.
address@hidden ss
address@hidden ifnottex
+
address@hidden Combine key, syntactic symbol and concept indices into one.
address@hidden ss cp
address@hidden ky cp
+
address@hidden
+This manual is for CC Mode in Emacs.
+
+Copyright @copyright{} 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
+2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
+
address@hidden
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.2 or
+any later version published by the Free Software Foundation; with the
+Invariant Sections being ``The GNU Manifesto'', ``Distribution'' and
+``GNU GENERAL PUBLIC LICENSE'', with the Front-Cover texts being ``A GNU
+Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
+license is included in the section entitled ``GNU Free Documentation
+License'' in the Emacs manual.
+
+(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
+this GNU Manual, like GNU software. Copies published by the Free
+Software Foundation raise funds for GNU development.''
+
+This document is part of a collection distributed under the GNU Free
+Documentation License. If you want to distribute this document
+separately from the collection, you can do so by adding a copy of the
+license to the document, as described in section 6 of the license.
address@hidden quotation
address@hidden copying
+
address@hidden Info directory entry for use by install-info. The indentation
address@hidden here is by request from the FSF folks.
address@hidden Emacs
address@hidden
+* CC Mode: (ccmode). Emacs mode for editing C, C++, Objective-C,
+ Java, Pike, AWK, and CORBA IDL code.
address@hidden direntry
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden TeX title page
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden
address@hidden 10
+
address@hidden @titlefont{CC Mode 5.31}
address@hidden 2
address@hidden @subtitlefont{A GNU Emacs mode for editing C and C-like
languages}
address@hidden 2
address@hidden Barry A. Warsaw, Martin Stjernholm, Alan Mackenzie
+
address@hidden
address@hidden 0pt plus 1filll
address@hidden
+
+This manual was generated from $Revision: 1.1 $ of $RCSfile: cc-mode.texi,v $,
which can be
+downloaded from
address@hidden://cvs.savannah.gnu.org/viewcvs/emacs/emacs/man/cc-mode.texi}.
address@hidden titlepage
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden The Top node contains the master menu for the Info file.
address@hidden This appears only in the Info file, not the printed manual.
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden Top, Introduction, (dir), (dir)
address@hidden node-name, next, previous, up
+
address@hidden
address@hidden @ccmode{}
+
address@hidden is a GNU Emacs mode for editing files containing C, C++,
+Objective-C, Java, CORBA IDL (and the variants PSDL and CIDL), Pike
+and AWK code. It provides syntax-based indentation, font locking, and
+has several handy commands and some minor modes to make the editing
+easier. It does not provide tools to look up and navigate between
+functions, classes etc - there are other packages for that.
address@hidden ifinfo
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden
+* Introduction::
+* Overview::
+* Getting Started::
+* Commands::
+* Font Locking::
+* Config Basics::
+* Custom Filling and Breaking::
+* Custom Auto-newlines::
+* Clean-ups::
+* Indentation Engine Basics::
+* Customizing Indentation::
+* Custom Macros::
+* Odds and Ends::
+* Sample .emacs File::
+* Performance Issues::
+* Limitations and Known Bugs::
+* FAQ::
+* Updating CC Mode::
+* Mailing Lists and Bug Reports::
+* GNU Free Documentation License::
+* Command and Function Index::
+* Variable Index::
+* Concept and Key Index::
+
address@hidden
+ --- The Detailed Node Listing ---
+
+Commands
+
+* Indentation Commands::
+* Comment Commands::
+* Movement Commands::
+* Filling and Breaking::
+* Minor Modes::
+* Electric Keys::
+* Auto-newlines::
+* Hungry WS Deletion::
+* Subword Movement::
+* Other Commands::
+
+Font Locking
+
+* Font Locking Preliminaries::
+* Faces::
+* Doc Comments::
+* AWK Mode Font Locking::
+
+Configuration Basics
+
+* CC Hooks::
+* Style Variables::
+* Styles::
+
+Styles
+
+* Built-in Styles::
+* Choosing a Style::
+* Adding Styles::
+* File Styles::
+
+Customizing Auto-newlines
+
+* Hanging Braces::
+* Hanging Colons::
+* Hanging Semicolons and Commas::
+
+Hanging Braces
+
+* Custom Braces::
+
+Indentation Engine Basics
+
+* Syntactic Analysis::
+* Syntactic Symbols::
+* Indentation Calculation::
+
+Syntactic Symbols
+
+* Function Symbols::
+* Class Symbols::
+* Conditional Construct Symbols::
+* Switch Statement Symbols::
+* Brace List Symbols::
+* External Scope Symbols::
+* Paren List Symbols::
+* Literal Symbols::
+* Multiline Macro Symbols::
+* Objective-C Method Symbols::
+* Anonymous Class Symbol::
+* Statement Block Symbols::
+* K&R Symbols::
+
+Customizing Indentation
+
+* c-offsets-alist::
+* Interactive Customization::
+* Line-Up Functions::
+* Custom Line-Up::
+* Other Indentation::
+
+Line-Up Functions
+
+* Brace/Paren Line-Up::
+* List Line-Up::
+* Operator Line-Up::
+* Comment Line-Up::
+* Misc Line-Up::
+
address@hidden detailmenu
address@hidden menu
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Introduction, Overview, Top, Top
address@hidden node-name, next, previous, up
address@hidden Introduction
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden BOCM
address@hidden history
address@hidden awk-mode.el
address@hidden c-mode.el
address@hidden c++-mode.el
+
+Welcome to @ccmode{}, a GNU Emacs mode for editing files containing C,
+C++, Objective-C, Java, CORBA IDL (and the variants CORBA PSDL and
+CIDL), Pike and AWK code. This incarnation of the mode is descended
+from @file{c-mode.el} (also called ``Boring Old C Mode'' or BOCM
address@hidden:-)}, @file{c++-mode.el} version 2, which Barry Warsaw had been
+maintaining since 1992, and @file{awk-mode.el}, a long neglected mode
+in the (X)Emacs base.
+
+Late in 1997, Martin Stjernholm joined Barry on the @ccmode{}
+Maintainers Team, and implemented the Pike support. In 2000 Martin
+took over as the sole maintainer. In 2001 Alan Mackenzie joined the
+team, implementing AWK support in version 5.30. @ccmode{} did not
+originally contain the font lock support for its languages --- that
+was added in version 5.30.
+
+This manual describes @ccmode{}
address@hidden The following line must appear on its own, so that the
+version 5.31.
address@hidden Release.py script can update the version number automatically
+
address@hidden supports the editing of K&R and ANSI C, C++, Objective-C,
+Java, CORBA's Interface Definition Language, address@hidden C-like
+scripting language with its roots in the LPC language used in some MUD
+engines. See @uref{http://pike.ida.liu.se/}.} and AWK files. In this
+way, you can easily set up consistent font locking and coding styles for
+use in editing all of these languages, although AWK is not yet as
+uniformly integrated as the other languages.
+
address@hidden c-mode
address@hidden c++-mode
address@hidden objc-mode
address@hidden java-mode
address@hidden idl-mode
address@hidden pike-mode
address@hidden awk-mode
+Note that the name of this package is address@hidden'', but there is no top
+level @code{cc-mode} entry point. All of the variables, commands, and
+functions in @ccmode{} are prefixed with @address@hidden, and
address@hidden, @code{c++-mode}, @code{objc-mode}, @code{java-mode},
address@hidden, @code{pike-mode}, and @code{awk-mode} entry points are
+provided. This package is intended to be a replacement for
address@hidden, @file{c++-mode.el} and @file{awk-mode.el}.
+
+A special word of thanks goes to Krishna Padmasola for his work in
+converting the original @file{README} file to Texinfo format. I'd
+also like to thank all the @ccmode{} victims who help enormously
+during the early beta stages of @ccmode{}'s development.
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Overview, Getting Started, Introduction, Top
address@hidden node-name, next, previous, address@hidden organization of
the manual
address@hidden Overview of the Manual
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden
+The manual starts with several introductory chapters (including this
+one).
+
address@hidden
+The next chunk of the manual describes the day to day @emph{use} of
address@hidden (as contrasted with how to customize it).
+
address@hidden @bullet
address@hidden
+The chapter ``Commands'' describes in detail how to use (nearly) all
+of @ccmode{}'s features. There are extensive cross-references from
+here to the corresponding sections later in the manual which tell you
+how to customize these features.
+
address@hidden
+``Font Locking'' describes how ``syntax highlighting'' is applied to
+your buffers. It is mainly background information and can be skipped
+over at a first reading.
address@hidden itemize
+
address@hidden
+The next chunk of the manual describes how to @emph{customize}
address@hidden Typically, an overview of a topic is given at the chapter
+level, then the sections and subsections describe the material in
+increasing detail.
+
address@hidden @bullet
address@hidden
+The chapter ``Configuration Basics'' tells you @emph{how} to write
+customizations - whether in hooks, in styles, in both, or in neither,
+depending on your needs. It describes the @ccmode{} style system and
+lists the standard styles that @ccmode{} supplies.
+
address@hidden
+The next few chapters describe in detail how to customize the various
+features of @ccmode{}.
+
address@hidden
+Finally, there is a sample @file{.emacs} fragment, which might help you
+in creating your own customization.
address@hidden itemize
+
address@hidden
+The manual ends with ``this and that'', things that don't fit cleanly
+into any of the previous chunks.
+
address@hidden @bullet
address@hidden
+Two chapters discuss the performance of @ccmode{} and known
+bugs/limitations.
+
address@hidden
+The FAQ contains a list of common problems and questions.
+
address@hidden
+The next two chapters tell you how to get in touch with the @ccmode{}
+project - whether for updating @ccmode{} or submitting bug reports.
address@hidden itemize
+
address@hidden
+Finally, there are the customary indices.
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Getting Started, Commands, Overview, Top
address@hidden node-name, next, previous, up
address@hidden Getting Started
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+If you got this version of @ccmode{} with Emacs or XEmacs, it should
+work just fine right out of the box. Note however that you might not
+have the latest @ccmode{} release and might want to upgrade your copy
+(see below).
+
+You should probably start by skimming through the entire chapter
address@hidden to get an overview of @ccmode{}'s capabilities.
+
+After trying out some commands, you may dislike some aspects of
address@hidden's default configuration. Here is an outline of how to
+change some of the settings that newcomers to @ccmode{} most often
+want to change:
+
address@hidden @asis
address@hidden c-basic-offset
+This Lisp variable holds an integer, the number of columns @ccmode{}
+indents nested code. To set this value to 6, customize
address@hidden or put this into your @file{.emacs}:
+
address@hidden
+(setq c-basic-offset 6)
address@hidden example
+
address@hidden The (indentation) style
+The basic ``shape'' of indentation created by @ccmode{}---by default,
+this is @code{gnu} style (except for Java and AWK buffers). A list of
+the available styles and their descriptions can be found in
address@hidden Styles}. A complete specification of the @ccmode{}
+style system, including how to create your own style, can be found in
+the chapter @ref{Styles}. To set your style to @code{linux}, either
+customize @code{c-default-style} or put this into your @file{.emacs}:
+
address@hidden
+(setq c-default-style '((java-mode . "java")
+ (awk-mode . "awk")
+ (other . "linux")))
address@hidden example
+
address@hidden Electric Indentation
+Normally, when you type ``punctuation'' characters such as @samp{;} or
address@hidden@{}, @ccmode{} instantly reindents the current line. This can
+be disconcerting until you get used to it. To disable @dfn{electric
+indentation} in the current buffer, type @kbd{C-c C-l}. Type the same
+thing to enable it again. To have electric indentation disabled by
+default, put the following into your @file{.emacs} address@hidden
+is no ``easy customization'' facility for making this change.}:
+
address@hidden
+(setq-default c-electric-flag nil)
address@hidden example
+
address@hidden
+Details of this and other similar ``Minor Modes'' appear in the
+section @ref{Minor Modes}.
+
address@hidden Making the @key{RET} key indent the new line
+The standard Emacs binding for @key{RET} just adds a new line. If you
+want it to reindent the new line as well, rebind the key. Note that
+the action of rebinding would fail if the pertinent keymap didn't yet
+exist---we thus need to delay the action until after @ccmode{} has
+been loaded. Put the following code into your @file{.emacs}:
+
address@hidden
+(defun my-make-CR-do-indent ()
+ (define-key c-mode-base-map "\C-m" 'c-context-line-break))
+(add-hook 'c-initialization-hook 'my-make-CR-do-indent)
address@hidden example
+
address@hidden
+This example demonstrates the use of a very powerful @ccmode{} (and
+Emacs) facility, the hook. The use of @ccmode{}'s hooks is described
+in @ref{CC Hooks}.
address@hidden table
+
+All these settings should occur in your @file{.emacs} @emph{before}
+any @ccmode{} buffers get loaded---in particular, before any call of
address@hidden
+
+As you get to know the mode better, you may want to make more
+ambitious changes to your configuration. For this, you should start
+reading the chapter @ref{Config Basics}.
+
+If you are upgrading an existing @ccmode{} installation, please see
+the @file{README} file for installation details. In particular, if
+you are going to be editing AWK files, @file{README} describes how to
+configure your (X)Emacs so that @ccmode{} will supersede the obsolete
address@hidden which might have been supplied with your (X)Emacs.
address@hidden might not work with older versions of Emacs or XEmacs. See
+the @ccmode{} release notes at @uref{http://cc-mode.sourceforge.net}
+for the latest information on Emacs version and package compatibility
+(@pxref{Updating CC Mode}).
+
address@hidden Command c-version
address@hidden version (c-)
+You can find out what version of @ccmode{} you are using by visiting a C
+file and entering @kbd{M-x c-version RET}. You should see this message in
+the echo area:
+
address@hidden
+Using CC Mode version 5.XX
address@hidden example
+
address@hidden
+where @samp{XX} is the minor release number.
address@hidden deffn
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Commands, Font Locking, Getting Started, Top
address@hidden node-name, next, previous, up
address@hidden Commands
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+This chapter specifies all of CC Mode's commands, and thus contains
+nearly everything you need to know to @emph{use} @ccmode{} (as
+contrasted with configuring it). @dfn{Commands} here means both
+control key sequences and @dfn{electric keys}, these being characters
+such as @samp{;} which, as well as inserting themselves into the
+buffer, also do other things.
+
+You might well want to review
address@hidden XEMACS
address@hidden,,,@emacsman{}, @emacsmantitle{}},
address@hidden ifset
address@hidden XEMACS
address@hidden by Parens,,,@emacsman{}, @emacsmantitle{}},
address@hidden ifclear
+which describes commands for moving around brace and parenthesis
+structures.
+
+
address@hidden
+* Indentation Commands::
+* Comment Commands::
+* Movement Commands::
+* Filling and Breaking::
+* Minor Modes::
+* Electric Keys::
+* Auto-newlines::
+* Hungry WS Deletion::
+* Subword Movement::
+* Other Commands::
address@hidden menu
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Indentation Commands, Comment Commands, Commands, Commands
address@hidden node-name, next, previous,up
address@hidden Indentation Commands
address@hidden indentation
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+The following commands reindent C constructs. Note that when you
+change your coding style, either interactively or through some other
+means, your file does @emph{not} automatically get reindented. You
+will need to execute one of the following commands to see the effects
+of your changes.
+
address@hidden GNU indent program
+Also, variables like @code{c-hanging-*} and @code{c-cleanup-list}
+(@pxref{Custom Auto-newlines}) only affect how on-the-fly code is
+formatted. Changing the ``hanginess'' of a brace and then
+reindenting, will not move the brace to a different line. For this,
+you're better off getting an external program like GNU @code{indent},
+which will rearrange brace location, amongst other things.
+
+Preprocessor directives are handled as syntactic whitespace from other
+code, i.e. they can be interspersed anywhere without affecting the
+indentation of the surrounding code, just like comments.
+
+The code inside macro definitions is, by default, still analyzed
+syntactically so that you get relative indentation there just as you'd
+get if the same code was outside a macro. However, since there is no
+hint about the syntactic context, i.e. whether the macro expands to an
+expression, to some statements, or perhaps to whole functions, the
+syntactic recognition can be wrong. @ccmode{} manages to figure it
+out correctly most of the time, though.
+
+Reindenting large sections of code can take a long time. When
address@hidden reindents a region of code, it is essentially equivalent to
+hitting @key{TAB} on every line of the region.
+
+These commands indent code:
+
address@hidden @asis
address@hidden @address@hidden (@code{c-indent-command})
address@hidden TAB
address@hidden c-indent-command
address@hidden indent-command (c-)
+This command indents the current line. That is all you need to know
+about it for normal use.
+
address@hidden does different things, depending on the
+setting of @code{c-syntactic-indentation} (@pxref{Indentation Engine
+Basics}):
+
address@hidden @bullet
address@hidden
+When it's address@hidden (which it normally is), the command indents
+the line according to its syntactic context. With a prefix argument
+(@kbd{C-u @key{TAB}}), it will re-indent the entire
address@hidden is only useful for a line starting with a
+comment opener or an opening brace, parenthesis, or string quote.}
+that begins at the line's left margin.
+
address@hidden
+When it's @code{nil}, the command indents the line by an extra
address@hidden columns. A prefix argument acts as a
+multiplier. A bare prefix (@kbd{C-u @key{TAB}}) is equivalent to -1,
+removing @code{c-basic-offset} columns from the indentation.
address@hidden itemize
+
+The precise behavior is modified by several variables: With
address@hidden, you can make @key{TAB} insert whitespace
+in some address@hidden then defines
+precisely what sort of ``whitespace'' this will be. Set the standard
+Emacs variable @code{indent-tabs-mode} to @code{t} if you want real
address@hidden characters to be used in the indentation, to @code{nil} if
+you want only spaces. @xref{Just Spaces,,, @emacsman{},
address@hidden
+
address@hidden c-tab-always-indent
address@hidden tab-always-indent (c-)
address@hidden literal
+This variable modifies how @key{TAB} operates.
address@hidden @bullet
address@hidden
+When it is @code{t} (the default), @key{TAB} simply indents the
+current line.
address@hidden
+When it is @code{nil}, @key{TAB} (re)indents the line only if point is
+to the left of the first non-whitespace character on the line.
+Otherwise it inserts some whitespace (a tab or an equivalent number of
+spaces - see below) at point.
address@hidden
+With some other value, the line is reindented. Additionally, if point
+is within a string or comment, some whitespace is inserted.
address@hidden itemize
address@hidden defopt
+
address@hidden c-insert-tab-function
address@hidden insert-tab-function (c-)
address@hidden tab-to-tab-stop
+When ``some whitespace'' is inserted as described above, what actually
+happens is that the function stored in @code{c-insert-tab-function} is
+called. Normally, this is @code{insert-tab}, which inserts a real tab
+character or the equivalent number of spaces (depending on
address@hidden). Some people, however, set
address@hidden to @code{tab-to-tab-stop} so as to get
+hard tab stops when indenting.
address@hidden defopt
address@hidden table
+
address@hidden
+The kind of indentation the next five commands do depends on the
+setting of @code{c-syntactic-indentation} (@pxref{Indentation Engine
+Basics}):
address@hidden @bullet
address@hidden
+when it is address@hidden (the default), the commands indent lines
+according to their syntactic context;
address@hidden
+when it is @code{nil}, they just indent each line the same amount as
+the previous non-blank line. The commands that indent a region aren't
+very useful in this case.
address@hidden itemize
+
address@hidden @asis
address@hidden @kbd{C-j} (@code{newline-and-indent})
address@hidden C-j
address@hidden newline-and-indent
+Inserts a newline and indents the new blank line, ready to start
+typing. This is a standard (X)Emacs command.
+
address@hidden @kbd{C-M-q} (@code{c-indent-exp})
address@hidden C-M-q
address@hidden c-indent-exp
address@hidden indent-exp (c-)
+Indents an entire balanced brace or parenthesis expression. Note that
+point must be on the opening brace or parenthesis of the expression
+you want to indent.
+
address@hidden @kbd{C-c C-q} (@code{c-indent-defun})
address@hidden C-c C-q
address@hidden c-indent-defun
address@hidden indent-defun (c-)
+Indents the entire top-level function, class or macro definition
+encompassing point. It leaves point unchanged. This function can't be
+used to reindent a nested brace construct, such as a nested class or
+function, or a Java method. The top-level construct being reindented
+must be complete, i.e. it must have both a beginning brace and an ending
+brace.
+
address@hidden @kbd{C-M-\} (@code{indent-region})
address@hidden C-M-\
address@hidden indent-region
+Indents an arbitrary region of code. This is a standard Emacs command,
+tailored for C code in a @ccmode{} buffer. Note, of course, that point
+and mark must delineate the region you want to indent.
+
address@hidden @kbd{C-M-h} (@code{c-mark-function})
address@hidden C-M-h
address@hidden c-mark-function
address@hidden mark-function (c-)
+While not strictly an indentation command, this is useful for marking
+the current top-level function or class definition as the current
+region. As with @code{c-indent-defun}, this command operates on
+top-level constructs, and can't be used to mark say, a Java method.
address@hidden table
+
+These variables are also useful when indenting code:
+
address@hidden indent-tabs-mode
+This is a standard Emacs variable that controls how line indentation
+is composed. When it's address@hidden, tabs can be used in a line's
+indentation, otherwise only spaces are used.
address@hidden defopt
+
address@hidden c-progress-interval
address@hidden progress-interval (c-)
+When indenting large regions of code, this variable controls how often a
+progress message is displayed. Set this variable to @code{nil} to
+inhibit the progress messages, or set it to an integer which is how
+often (in seconds) progress messages are to be displayed.
address@hidden defopt
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Comment Commands, Movement Commands, Indentation Commands,
Commands
address@hidden node-name, next, previous, up
address@hidden Comment Commands
address@hidden comments (insertion of)
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden @asis
address@hidden @kbd{C-c C-c} (@code{comment-region})
address@hidden C-c C-c
address@hidden comment-region
+This command comments out the lines that start in the region. With a
+negative argument, it does the opposite - it deletes the comment
+delimiters from these lines. @xref{Multi-Line Comments,,, emacs, GNU
+Emacs Manual}, for fuller details. @code{comment-region} isn't
+actually part of @ccmode{} - it is given a @ccmode{} binding for
+convenience.
+
address@hidden @kbd{M-;} (@code{comment-dwim} or @code{indent-for-comment}
@footnote{The name of this command varies between (X)Emacs versions.})
address@hidden M-;
address@hidden comment-dwim
address@hidden indent-for-comment
+Insert a comment at the end of the current line, if none is there
+already. Then reindent the comment according to @code{comment-column}
address@hidden XEMACS
+(@pxref{Options for Comments,,, emacs, GNU Emacs Manual})
address@hidden ifclear
address@hidden XEMACS
+(@pxref{Comments,,, xemacs, XEmacs User's Manual})
address@hidden ifset
+and the variables below. Finally, position the point after the
+comment starter. @kbd{C-u M-;} kills any comment on the current line,
+together with any whitespace before it. This is a standard Emacs
+command, but @ccmode{} enhances it a bit with two variables:
+
address@hidden c-indent-comment-alist
address@hidden indent-comment-alist (c-)
address@hidden comment-column
+This style variable allows you to vary the column that @kbd{M-;} puts
+the comment at, depending on what sort of code is on the line, and
+possibly the indentation of any similar comment on the preceding line.
+It is an association list that maps different types of lines to
+actions describing how they should be handled. If a certain line type
+isn't present on the list then the line is indented to the column
+specified by @code{comment-column}.
+
+See the documentation string for a full description of this
+variable (use @kbd{C-h v c-indent-comment-alist}).
address@hidden defopt
+
address@hidden c-indent-comments-syntactically-p
address@hidden indent-comments-syntactically-p (c-)
+Normally, when this style variable is @code{nil}, @kbd{M-;} will
+indent comment-only lines according to @code{c-indent-comment-alist},
+just as it does with lines where other code precede the comments.
+However, if you want it to act just like @key{TAB} for comment-only
+lines you can get that by setting
address@hidden to address@hidden
+
+If @code{c-indent-comments-syntactically-p} is address@hidden then
address@hidden won't be consulted at all for comment-only
+lines.
address@hidden defopt
address@hidden table
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Movement Commands, Filling and Breaking, Comment Commands,
Commands
address@hidden node-name, next, previous, up
address@hidden Movement Commands
address@hidden movement
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden contains some useful commands for moving around in C code.
+
address@hidden @asis
address@hidden @kbd{C-M-a} (@code{c-beginning-of-defun})
address@hidden @kbd{C-M-e} (@code{c-end-of-defun})
address@hidden c-beginning-of-defun
address@hidden c-end-of-defun
+
+Move to the beginning or end of the current or next function. Other
+constructs (such as a structs or classes) which have a brace block
+also count as ``functions'' here. To move over several functions, you
+can give these commands a repeat count.
+
+The start of a function is at its header. The end of the function is
+after its closing brace, or after the semicolon of a construct (such
+as a @code{struct}) which doesn't end at the brace. These two
+commands try to leave point at the beginning of a line near the actual
+start or end of the function. This occasionally causes point not to
+move at all.
+
+These functions are analogous to the Emacs built-in commands
address@hidden and @code{end-of-defun}, except they
+eliminate the constraint that the top-level opening brace of the defun
+must be in column zero. See @ref{Defuns,,,@emacsman{},
address@hidden, for more information.
+
address@hidden @kbd{C-M-a} (AWK Mode) (@code{c-awk-beginning-of-defun})
address@hidden @kbd{C-M-e} (AWK Mode) (@code{c-awk-end-of-defun})
address@hidden C-M-a (AWK Mode)
address@hidden C-M-e (AWK Mode)
address@hidden c-awk-beginning-of-defun
address@hidden awk-beginning-of-defun (c-)
address@hidden c-awk-end-of-defun
address@hidden awk-end-of-defun (c-)
+Move to the beginning or end of the current or next AWK defun. These
+commands can take prefix-arguments, their functionality being entirely
+equivalent to @code{beginning-of-defun} and @code{end-of-defun}.
+
+AWK Mode @dfn{defuns} are either pattern/action pairs (either of which
+might be implicit) or user defined functions. Having the @address@hidden and
address@hidden@}} (if there are any) in column zero, as is suggested for some
+modes, is neither necessary nor helpful in AWK mode.
+
address@hidden @kbd{M-a} (@code{c-beginning-of-statement})
address@hidden @kbd{M-e} (@code{c-end-of-statement})
address@hidden M-a
address@hidden M-e
address@hidden c-beginning-of-statement
address@hidden c-end-of-statement
address@hidden beginning-of-statement (c-)
address@hidden end-of-statement (c-)
+Move to the beginning or end of the innermost C statement. If point
+is already there, move to the next beginning or end of a statement,
+even if that means moving into a block. (Use @kbd{C-M-b} or
address@hidden to move over a balanced block.) A prefix argument @var{n}
+means move over @var{n} statements.
+
+If point is within or next to a comment or a string which spans more
+than one line, these commands move by sentences instead of statements.
+
+When called from a program, these functions take three optional
+arguments: the repetition count, a buffer position limit which is the
+farthest back to search for the syntactic context, and a flag saying
+whether to do sentence motion in or near comments and multiline
+strings.
+
address@hidden @kbd{C-c C-u} (@code{c-up-conditional})
address@hidden C-c C-u
address@hidden c-up-conditional
address@hidden up-conditional (c-)
+Move back to the containing preprocessor conditional, leaving the mark
+behind. A prefix argument acts as a repeat count. With a negative
+argument, move forward to the end of the containing preprocessor
+conditional.
+
address@hidden is treated like @samp{#else} followed by @samp{#if}, so the
+function stops at them when going backward, but not when going
+forward.
+
+This key sequence is not bound in AWK Mode, which doesn't have
+preprocessor statements.
+
address@hidden @kbd{M-x c-up-conditional-with-else}
address@hidden c-up-conditional-with-else
address@hidden up-conditional-with-else (c-)
+A variety of @code{c-up-conditional} that also stops at @samp{#else}
+lines. Normally those lines are ignored.
+
address@hidden @kbd{M-x c-down-conditional}
address@hidden c-down-conditional
address@hidden down-conditional (c-)
+Move forward into the next nested preprocessor conditional, leaving
+the mark behind. A prefix argument acts as a repeat count. With a
+negative argument, move backward into the previous nested preprocessor
+conditional.
+
address@hidden is treated like @samp{#else} followed by @samp{#if}, so the
+function stops at them when going forward, but not when going backward.
+
address@hidden @kbd{M-x c-down-conditional-with-else}
address@hidden c-down-conditional-with-else
address@hidden down-conditional-with-else (c-)
+A variety of @code{c-down-conditional} that also stops at @samp{#else}
+lines. Normally those lines are ignored.
+
address@hidden @kbd{C-c C-p} (@code{c-backward-conditional})
address@hidden @kbd{C-c C-n} (@code{c-forward-conditional})
address@hidden C-c C-p
address@hidden C-c C-n
address@hidden c-backward-conditional
address@hidden c-forward-conditional
address@hidden backward-conditional (c-)
address@hidden forward-conditional (c-)
+Move backward or forward across a preprocessor conditional, leaving
+the mark behind. A prefix argument acts as a repeat count. With a
+negative argument, move in the opposite direction.
+
+These key sequences are not bound in AWK Mode, which doesn't have
+preprocessor statements.
+
address@hidden @kbd{M-x c-backward-into-nomenclature}
address@hidden @kbd{M-x c-forward-into-nomenclature}
address@hidden c-backward-into-nomenclature
address@hidden c-forward-into-nomenclature
address@hidden backward-into-nomenclature (c-)
address@hidden forward-into-nomenclature (c-)
+A popular programming style, especially for object-oriented languages
+such as C++ is to write symbols in a mixed case format, where the
+first letter of each word is capitalized, and not separated by
+underscores. E.g. @samp{SymbolsWithMixedCaseAndNoUnderlines}.
+
+These commands move backward or forward to the beginning of the next
+capitalized word. With prefix argument @var{n}, move @var{n} times.
+If @var{n} is negative, move in the opposite direction.
+
+Note that these two commands have been superseded by
address@hidden, which you should use instead. @xref{Subword
+Movement}. They might be removed from a future release of @ccmode{}.
address@hidden table
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Filling and Breaking, Minor Modes, Movement Commands, Commands
address@hidden node-name, next, previous, up
address@hidden Filling and Line Breaking Commands
address@hidden text filling
address@hidden line breaking
address@hidden comment handling
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+Since there's a lot of normal text in comments and string literals,
address@hidden provides features to edit these like in text mode. The goal
+is to do it seamlessly, i.e. you can use auto fill mode, sentence and
+paragraph movement, paragraph filling, adaptive filling etc. wherever
+there's a piece of normal text without having to think much about it.
address@hidden keeps the indentation, fixes suitable comment line prefixes,
+and so on.
+
+You can configure the exact way comments get filled and broken, and
+where Emacs does auto-filling (see @pxref{Custom Filling and
+Breaking}). Typically, the style system (@pxref{Styles}) will have
+set this up for you, so you probably won't have to bother.
+
address@hidden auto-fill-mode
address@hidden Auto Fill mode
address@hidden paragraph filling
+Line breaks are by default handled (almost) the same regardless of
+whether they are made by auto fill mode (@pxref{Auto Fill,,,
address@hidden, @emacsmantitle{}}), by paragraph filling (e.g. with
address@hidden), or explicitly with @kbd{M-j} or similar methods. In
+string literals, the new line gets the same indentation as the
+previous nonempty address@hidden can change this default by
+setting the @code{string} syntactic symbol (@pxref{Syntactic Symbols}
+and @pxref{Customizing Indentation})}.
+
address@hidden @asis
address@hidden @kbd{M-q} (@code{c-fill-paragraph})
address@hidden M-q
address@hidden c-fill-paragraph
address@hidden fill-paragraph (c-)
address@hidden Javadoc markup
address@hidden Pike autodoc markup
+This command fills multiline string literals and both block
+and line style comments. In Java buffers, the Javadoc markup words
+are recognized as paragraph starters. The line oriented Pike autodoc
+markup words are recognized in the same way in Pike mode.
+
+The formatting of the starters (@code{/*}) and enders (@code{*/}) of
+block comments are kept as they were before the filling. I.e., if
+either the starter or ender were on a line of its own, then it stays
+on its own line; conversely, if the delimiter has comment text on its
+line, it keeps at least one word of that text with it on the line.
+
+This command is the replacement for @code{fill-paragraph} in @ccmode{}
+buffers.
+
address@hidden @kbd{M-j} (@code{c-indent-new-comment-line})
address@hidden M-j
address@hidden c-indent-new-comment-line
address@hidden indent-new-comment-line (c-)
+This breaks the current line at point and indents the new line. If
+point was in a comment, the new line gets the proper comment line
+prefix. If point was inside a macro, a backslash is inserted before
+the line break. It is the replacement for
address@hidden
+
address@hidden @kbd{M-x c-context-line-break}
address@hidden c-context-line-break
address@hidden context-line-break (c-)
+Insert a line break suitable to the context: If the point is inside a
+comment, the new line gets the suitable indentation and comment line
+prefix like @code{c-indent-new-comment-line}. In normal code it's
+indented like @code{newline-and-indent} would do. In macros it acts
+like @code{newline-and-indent} but additionally inserts and optionally
+aligns the line ending backslash so that the macro remains unbroken.
address@hidden Macros}, for details about the backslash alignment. In a
+string, a backslash is inserted only if the string is within a
address@hidden GCC, unescaped line breaks within strings are
+valid.}.
+
+This function is not bound to a key by default, but it's intended to be
+used on the @kbd{RET} key. If you like the behavior of
address@hidden on @kbd{RET}, you should consider switching to
+this function. @xref{Sample .emacs File}.
+
address@hidden @kbd{M-x c-context-open-line}
address@hidden c-context-open-line
address@hidden context-open-line (c-)
+This is to @kbd{C-o} (@kbd{M-x open-line}) as
address@hidden is to @kbd{RET}. I.e. it works just like
address@hidden but leaves the point before the inserted
+line break.
address@hidden table
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Minor Modes, Electric Keys, Filling and Breaking, Commands
address@hidden node-name, next, previous, up
address@hidden Minor Modes
address@hidden Minor Modes
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden contains several minor-mode-like features that you might
+find useful while writing new code or editing old code:
+
address@hidden @asis
address@hidden electric mode
+When this is enabled, certain visible characters cause reformatting as
+they are typed. This is normally helpful, but can be a nuisance when
+editing chaotically formatted code. It can also be disconcerting,
+especially for users who are new to @ccmode{}.
address@hidden auto-newline mode
+This automatically inserts newlines where you'd probably want to type
+them yourself, e.g. after typing @address@hidden Its action is suppressed
+when electric mode is disabled.
address@hidden hungry-delete mode
+This lets you delete a contiguous block of whitespace with a single
+key - for example, the newline and indentation just inserted by
+auto-newline when you want to back up and write a comment after the
+last statement.
address@hidden subword mode
+This mode makes basic word movement commands like @kbd{M-f}
+(@code{forward-word}) and @kbd{M-b} (@code{backward-word}) treat the
+parts of sillycapsed symbols as different words.
+E.g. @samp{NSGraphicsContext} is treated as three words @samp{NS},
address@hidden, and @samp{Context}.
address@hidden syntactic-indentation mode
+When this is enabled (which it normally is), indentation commands such
+as @kbd{C-j} indent lines of code according to their syntactic
+structure. Otherwise, a line is simply indented to the same level as
+the previous one and @address@hidden adjusts the indentation in steps
+of `c-basic-offset'.
address@hidden table
+
+Full details on how these minor modes work are at @ref{Electric Keys},
address@hidden, @ref{Hungry WS Deletion}, @ref{Subword Movement},
+and @ref{Indentation Engine Basics}.
+
+You can toggle each of these minor modes on and off, and you can
+configure @ccmode{} so that it starts up with your favourite
+combination of them (@pxref{Sample .emacs File}). By default, when
+you initialize a buffer, electric mode and syntactic-indentation mode
+are enabled but the other two modes are disabled.
+
address@hidden displays the current state of the first four of these minor
+modes on the modeline by appending letters to the major mode's name,
+one letter for each enabled minor mode - @samp{l} for electric mode,
address@hidden for auto-newline mode, @samp{h} for hungry delete mode, and
address@hidden for subword mode. If all these modes were enabled, you'd see
address@hidden/address@hidden @samp{C} would be replaced with the name of
+the language in question for the other languages @ccmode{} supports.}.
+
+Here are the commands to toggle these modes:
+
address@hidden @asis
address@hidden @kbd{C-c C-l} (@code{c-toggle-electric-state})
address@hidden C-c C-l
address@hidden c-toggle-electric-state
address@hidden toggle-electric-state (c-)
+Toggle electric minor mode. When the command turns the mode off, it
+also suppresses auto-newline mode.
+
address@hidden @kbd{C-c C-a} (@code{c-toggle-auto-newline})
address@hidden C-c C-a
address@hidden c-toggle-auto-newline
address@hidden toggle-auto-newline (c-)
+Toggle auto-newline minor mode. When the command turns the mode on,
+it also enables electric minor mode.
+
address@hidden @kbd{M-x address@hidden to @ccmode{} 5.31, this command was
bound to @kbd{C-c C-d}.}
address@hidden c-toggle-hungry-state
address@hidden toggle-hungry-state (c-)
+Toggle hungry-delete minor mode.
+
address@hidden @kbd{M-x address@hidden to @ccmode{} 5.31, this command was
bound to @kbd{C-c C-t}.}
address@hidden c-toggle-auto-hungry-state
address@hidden toggle-auto-hungry-state (c-)
+Toggle both auto-newline and hungry delete minor modes.
+
address@hidden @kbd{C-c C-w} (@code{M-x c-subword-mode})
address@hidden C-c C-w
address@hidden c-subword-mode
address@hidden subword-mode (c-)
+Toggle subword mode.
+
address@hidden @kbd{M-x c-toggle-syntactic-indentation}
address@hidden c-toggle-syntactic-indentation
address@hidden toggle-syntactic-indentation (c-)
+Toggle syntactic-indentation mode.
address@hidden table
+
+Common to all the toggle functions above is that if they are called
+programmatically, they take an optional numerical argument. A
+positive value will turn on the minor mode (or both of them in the
+case of @code{c-toggle-auto-hungry-state}) and a negative value will
+turn it (or them) off.
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Electric Keys, Auto-newlines, Minor Modes, Commands
address@hidden node-name, next, previous, up
address@hidden Electric Keys and Keywords
address@hidden electric characters
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+Most punctuation keys provide @dfn{electric} behavior - as well as
+inserting themselves they perform some other action, such as
+reindenting the line. This reindentation saves you from having to
+reindent a line manually after typing, say, a @address@hidden A few
+keywords, such as @code{else}, also trigger electric action.
+
+You can inhibit the electric behaviour described here by disabling
+electric minor mode (@pxref{Minor Modes}).
+
+Common to all these keys is that they only behave electrically when
+used in normal code (as contrasted with getting typed in a string
+literal or comment). Those which cause re-indentation do so only when
address@hidden has a address@hidden value (which it
+does by default).
+
+These keys and keywords are:
address@hidden ACM, 2004/8/24: c-electric-pound doesn't check c-s-i: this is
more
address@hidden like a bug in the code than a bug in this document. It'll get
address@hidden fixed in the code sometime.
+
address@hidden @kbd
address@hidden #
address@hidden #
address@hidden c-electric-pound
address@hidden electric-pound (c-)
address@hidden c-electric-pound-behavior
address@hidden electric-pound-behavior (c-)
+Pound (bound to @code{c-electric-pound}) is electric when typed as the
+first non-whitespace character on a line and not within a macro
+definition. In this case, the variable @code{c-electric-pound-behavior}
+is consulted for the electric behavior. This variable takes a list
+value, although the only element currently defined is @code{alignleft},
+which tells this command to force the @samp{#} character into column
+zero. This is useful for entering preprocessor macro definitions.
+
+Pound is not electric in AWK buffers, where @samp{#} starts a comment,
+and is bound to @code{self-insert-command} like any typical printable
+character.
address@hidden ACM, 2004/8/24: Change this (and the code) to do AWK comment
address@hidden reindentation.
+
address@hidden *
address@hidden *
address@hidden /
address@hidden /
address@hidden c-electric-star
address@hidden electric-star (c-)
address@hidden c-electric-slash
address@hidden electric-slash (c-)
+A star (bound to @code{c-electric-star}) or a slash
+(@code{c-electric-slash}) causes reindentation when you type it as the
+second component of a C style block comment opener (@samp{/*}) or a
+C++ line comment opener (@samp{//}) respectively, but only if the
+comment opener is the first thing on the line (i.e. there's only
+whitespace before it).
+
+Additionally, you can configure @ccmode{} so that typing a slash at
+the start of a line within a block comment will terminate the
+comment. You don't need to have electric minor mode enabled to get
+this behaviour. @xref{Clean-ups}.
+
+In AWK mode, @samp{*} and @samp{/} do not delimit comments and are not
+electric.
+
address@hidden <
address@hidden <
address@hidden >
address@hidden >
address@hidden c-electric-lt-gt
address@hidden electric-lt-gt (c-)
+A less-than or greater-than sign (bound to @code{c-electric-lt-gt}) is
+electric in two circumstances: when it is an angle bracket in a C++
address@hidden declaration (and similar constructs in other
+languages) and when it is the second of two @kbd{<} or @kbd{>}
+characters in a C++ style stream operator. In either case, the line
+is reindented. Angle brackets in C @samp{#include} directives are not
+electric.
+
address@hidden (
address@hidden (
address@hidden )
address@hidden )
address@hidden c-electric-paren
address@hidden electric-paren (c-)
+The normal parenthesis characters @samp{(} and @samp{)} (bound to
address@hidden) reindent the current line. This is useful
+for getting the closing parenthesis of an argument list aligned
+automatically.
+
+You can also configure @ccmode{} to insert a space automatically
+between a function name and the @samp{(} you've just typed, and to
+remove it automatically after typing @samp{)}, should the argument
+list be empty. You don't need to have electric minor mode enabled to
+get these actions. @xref{Clean-ups}.
+
address@hidden @{
address@hidden @{
address@hidden @}
address@hidden @}
address@hidden c-electric-brace
address@hidden electric-brace (c-)
+Typing a brace (bound to @code{c-electric-brace}) reindents the
+current line. Also, one or more newlines might be inserted if
+auto-newline minor mode is enabled. @xref{Auto-newlines}.
+Additionally, you can configure @ccmode{} to compact excess whitespace
+inserted by auto-newline mode in certain circumstances.
address@hidden
+
address@hidden :
address@hidden :
address@hidden c-electric-colon
address@hidden electric-colon (c-)
+Typing a colon (bound to @code{c-electric-colon}) reindents the
+current line. Additionally, one or more newlines might be inserted if
+auto-newline minor mode is enabled. @xref{Auto-newlines}. If you
+type a second colon immediately after such an auto-newline, by default
+the whitespace between the two colons is removed, leaving a C++ scope
+operator. @xref{Clean-ups}.
+
+If you prefer, you can insert @samp{::} in a single operation,
+avoiding all these spurious reindentations, newlines, and clean-ups.
address@hidden Commands}.
+
address@hidden ;
address@hidden ;
address@hidden ,
address@hidden ,
address@hidden c-electric-semi&comma
address@hidden electric-semi&comma (c-)
+Typing a semicolon or comma (bound to @code{c-electric-semi&comma})
+reindents the current line. Also, a newline might be inserted if
+auto-newline minor mode is enabled. @xref{Auto-newlines}.
+Additionally, you can configure @ccmode{} so that when auto-newline
+has inserted whitespace after a @address@hidden, it will be removed again
+when you type a semicolon or comma just after it. @xref{Clean-ups}.
+
address@hidden table
+
address@hidden Command c-electric-continued-statement
address@hidden electric-continued-statement (c-)
+
+Certain keywords are electric, causing reindentation when they are
+preceded only by whitespace on the line. The keywords are those that
+continue an earlier statement instead of starting a new one:
address@hidden, @code{while}, @code{catch} (only in C++ and Java) and
address@hidden (only in Java).
+
+An example:
+
address@hidden
address@hidden
+for (i = 0; i < 17; i++)
+ if (a[i])
+ res += a[i]->offset;
+else
address@hidden group
address@hidden example
+
+Here, the @code{else} should be indented like the preceding @code{if},
+since it continues that statement. @ccmode{} will automatically
+reindent it after the @code{else} has been typed in full, since only
+then is it possible to decide whether it's a new statement or a
+continuation of the preceding @code{if}.
+
address@hidden abbrev-mode
address@hidden abbrev-mode
address@hidden Abbrev mode
address@hidden uses Abbrev mode (@pxref{Abbrevs,,, @emacsman{},
@emacsmantitle{}})
+to accomplish this. It's therefore turned on by default in all language
+modes except IDL mode, since CORBA IDL doesn't have any statements.
address@hidden deffn
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Auto-newlines, Hungry WS Deletion, Electric Keys, Commands
address@hidden node-name, next, previous, up
address@hidden Auto-newline Insertion
address@hidden auto-newline
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+When you have @dfn{Auto-newline minor mode} enabled (@pxref{Minor
+Modes}), @ccmode{} inserts newlines for you automatically (in certain
+syntactic contexts) when you type a left or right brace, a colon, a
+semicolon, or a comma. Sometimes a newline appears before the
+character you type, sometimes after it, sometimes both.
+
+Auto-newline only triggers when the following conditions hold:
+
address@hidden @bullet
address@hidden
+Auto-newline minor mode is enabled, as evidenced by the indicator
address@hidden after the mode name on the modeline (e.g. @samp{C/a} or
address@hidden/la}).
+
address@hidden
+The character was typed at the end of a line, or with only whitespace
+after it, and possibly a @samp{\} escaping the newline.
+
address@hidden
+The character is not on its own line already. (This applies only to
+insertion of a newline @emph{before} the character.)
+
address@hidden
address@hidden literal
address@hidden syntactic whitespace
+The character was not typed inside of a literal @footnote{A
address@hidden is defined as any comment, string, or preprocessor macro
+definition. These constructs are also known as @dfn{syntactic
+whitespace} since they are usually ignored when scanning C code.}.
+
address@hidden
+No numeric argument was supplied to the command (i.e. it was typed as
+normal, with no @kbd{C-u} prefix).
address@hidden itemize
+
+You can configure the precise circumstances in which newlines get
+inserted (see @pxref{Custom Auto-newlines}). Typically, the style
+system (@pxref{Styles}) will have set this up for you, so you probably
+won't have to bother.
+
+Sometimes @ccmode{} inserts an auto-newline where you don't want one,
+such as after a @address@hidden when you're about to type a @samp{;}.
+Hungry deletion can help here (@pxref{Hungry WS Deletion}), or you can
+activate an appropriate @dfn{clean-up}, which will remove the excess
+whitespace after you've typed the @samp{;}. See @ref{Clean-ups} for a
+full description. See also @ref{Electric Keys} for a summary of
+clean-ups listed by key.
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Hungry WS Deletion, Subword Movement, Auto-newlines, Commands
address@hidden node-name, next, previous, up
address@hidden Hungry Deletion of Whitespace
address@hidden hungry-deletion
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+If you want to delete an entire block of whitespace at point, you can
+use @dfn{hungry deletion}. This deletes all the contiguous whitespace
+either before point or after point in a single operation.
+``Whitespace'' here includes tabs and newlines, but not comments or
+preprocessor commands. Hungry deletion can markedly cut down on the
+number of times you have to hit deletion keys when, for example,
+you've made a mistake on the preceding line and have already pressed
address@hidden
+
+Hungry deletion is a simple feature that some people find extremely
+useful. In fact, you might find yourself wanting it in @strong{all}
+your editing modes!
+
+Loosely speaking, in what follows, @address@hidden means ``the
+backspace key'' and @address@hidden means ``the forward delete
+key''. This is discussed in more detail below.
+
+There are two different ways you can use hungry deletion:
+
address@hidden @asis
address@hidden Using @dfn{Hungry Delete Mode} with @address@hidden and @kbd{C-d}
+Here you toggle Hungry Delete minor mode with @kbd{M-x
address@hidden to @ccmode{} 5.31, this command
+was bound to @kbd{C-c C-d}. @kbd{C-c C-d} is now the default binding
+for @code{c-hungry-delete-forward}.} (@pxref{Minor Modes}.) This
+makes @address@hidden and @kbd{C-d} do backwards and forward hungry
+deletion.
+
address@hidden @asis
address@hidden @address@hidden (@code{c-electric-backspace})
address@hidden DEL
address@hidden c-electric-backspace
address@hidden electric-backspace (c-)
+This command is run by default when you hit the @kbd{DEL} key. When
+hungry delete mode is enabled, it deletes any amount of whitespace in
+the backwards direction. Otherwise, or when used with a prefix
+argument or in a literal (@pxref{Auto-newlines}), the command just
+deletes backwards in the usual way. (More precisely, it calls the
+function contained in the variable @code{c-backspace-function},
+passing it the prefix argument, if any.)
+
address@hidden @code{c-backspace-function}
address@hidden c-backspace-function
address@hidden backspace-function (c-)
address@hidden backward-delete-char-untabify
+Hook that gets called by @code{c-electric-backspace} when it doesn't
+do an ``electric'' deletion of the preceding whitespace. The default
+value is @code{backward-delete-char-untabify}
+(@pxref{Deletion,,,@lispref{}, @lispreftitle{}}, the function which
+deletes a single character.
+
address@hidden @kbd{C-d} (@code{c-electric-delete-forward})
address@hidden C-d
address@hidden c-electric-delete-forward
address@hidden electric-delete-forward (c-)
+This function, which is bound to @kbd{C-d} by default, works just like
address@hidden but in the forward direction. When it
+doesn't do an ``electric'' deletion of the following whitespace, it
+just does @code{delete-char}, more or less. (Strictly speaking, it
+calls the function in @code{c-delete-function} with the prefix
+argument.)
+
address@hidden @code{c-delete-function}
address@hidden c-delete-function
address@hidden delete-function (c-)
address@hidden delete-char
+Hook that gets called by @code{c-electric-delete-forward} when it
+doesn't do an ``electric'' deletion of the following whitespace. The
+default value is @code{delete-char}.
address@hidden table
+
address@hidden Using Distinct Bindings
+The other (newer and recommended) way to use hungry deletion is to
+perform @code{c-hungry-delete-backwards} and
address@hidden directly through their key sequences
+rather than using the minor mode toggling.
+
address@hidden @asis
address@hidden @kbd{C-c address@hidden, or @kbd{C-c @key{DEL}}
(@code{c-hungry-delete-backwards})@footnote{This command was formerly known as
@code{c-hungry-backspace}.}
address@hidden C-c C-<backspace>
address@hidden C-c <backspace>
address@hidden C-c C-DEL
address@hidden C-c DEL
address@hidden c-hungry-delete-backwards
address@hidden hungry-delete-backwards (c-)
+Delete any amount of whitespace in the backwards direction (regardless
+whether hungry-delete mode is enabled or not). This command is bound
+to both @kbd{C-c address@hidden and @kbd{C-c @key{DEL}}, since the more
+natural one, @kbd{C-c address@hidden, is sometimes difficult to type at
+a character terminal.
+
address@hidden @kbd{C-c C-d}, @kbd{C-c address@hidden, or @kbd{C-c
@key{DELETE}} (@code{c-hungry-delete-forward})
address@hidden C-c C-d
address@hidden C-c C-<DELETE>
address@hidden C-c <DELETE>
address@hidden c-hungry-delete-forward
address@hidden hungry-delete-forward (c-)
+Delete any amount of whitespace in the forward direction (regardless
+whether hungry-delete mode is enabled or not). This command is bound
+to both @kbd{C-c address@hidden and @kbd{C-c @key{DELETE}} for the
+same reason as for @key{DEL} above.
address@hidden table
address@hidden table
+
address@hidden <delete>
address@hidden <backspace>
+
+When we talk about @address@hidden, and @address@hidden above, we
+actually do so without connecting them to the physical keys commonly
+known as @key{Backspace} and @key{Delete}. The default bindings to
+those two keys depends on the flavor of (X)Emacs you are using.
+
address@hidden c-electric-delete
address@hidden electric-delete (c-)
address@hidden c-hungry-delete
address@hidden hungry-delete (c-)
address@hidden delete-key-deletes-forward
+In XEmacs 20.3 and beyond, the @key{Backspace} key is bound to
address@hidden and the @key{Delete} key is bound to
address@hidden You control the direction it deletes in by
+setting the variable @code{delete-key-deletes-forward}, a standard
+XEmacs variable.
address@hidden This variable is encapsulated by XEmacs's (defsubst
delete-forward-p ...).
+When this variable is address@hidden, @code{c-electric-delete} will do
+forward deletion with @code{c-electric-delete-forward}, otherwise it
+does backward deletion with @code{c-electric-backspace}. Similarly,
address@hidden @key{Delete}} and @kbd{C-c address@hidden are bound to
address@hidden which is controlled in the same way by
address@hidden
+
address@hidden normal-erase-is-backspace-mode
+
+Emacs 21 and later automatically binds @key{Backspace} and
address@hidden to @kbd{DEL} and @kbd{C-d} according to your environment,
+and @ccmode{} extends those bindings to @kbd{C-c address@hidden
+etc. If you need to change the bindings through
address@hidden then @ccmode{} will also adapt
+its extended bindings accordingly.
+
+In earlier (X)Emacs versions, @ccmode{} doesn't bind either
address@hidden or @key{Delete} directly. Only the key codes
address@hidden and @kbd{C-d} are bound, and it's up to the default bindings
+to map the physical keys to them. You might need to modify this
+yourself if the defaults are unsuitable.
+
+Getting your @key{Backspace} and @key{Delete} keys properly set up can
+sometimes be tricky. The information in @ref{DEL Does Not
+Delete,,,emacs, GNU Emacs Manual}, might be helpful if you're having
+trouble with this in GNU Emacs.
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Subword Movement, Other Commands, Hungry WS Deletion, Commands
address@hidden node-name, next, previous, up
address@hidden Subword Movement and Editing
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden nomenclature
address@hidden subword
+In spite of the GNU Coding Standards, it is popular to name a symbol
+by mixing uppercase and lowercase letters, e.g. @samp{GtkWidget},
address@hidden, or @samp{NSGraphicsContext}. Here we call
+these mixed case symbols @dfn{nomenclatures}. Also, each capitalized
+(or completely uppercase) part of a nomenclature is called a
address@hidden Here are some examples:
+
address@hidden address@hidden address@hidden, @samp{Graphics}, and
@samp{Context}}
address@hidden This could be converted to @headitem when we require Texinfo 4.7
address@hidden
address@hidden @b{Nomenclature}
+ @tab @b{Subwords}
address@hidden iftex
address@hidden
address@hidden Nomenclature
+ @tab Subwords
address@hidden ---------------------------------------------------------
address@hidden ifnottex
address@hidden @samp{GtkWindow}
+ @tab @samp{Gtk} and @samp{Window}
address@hidden @samp{EmacsFrameClass}
+ @tab @samp{Emacs}, @samp{Frame}, and @samp{Class}
address@hidden @samp{NSGraphicsContext}
+ @tab @samp{NS}, @samp{Graphics}, and @samp{Context}
address@hidden multitable
+
+The subword minor mode replaces the basic word oriented movement and
+editing commands with variants that recognize subwords in a
+nomenclature and treat them as separate words:
+
address@hidden c-forward-subword
address@hidden forward-subword (c-)
address@hidden c-backward-subword
address@hidden backward-subword (c-)
address@hidden c-mark-subword
address@hidden mark-subword (c-)
address@hidden c-kill-subword
address@hidden kill-subword (c-)
address@hidden c-backward-kill-subword
address@hidden backward-kill-subword (c-)
address@hidden c-transpose-subwords
address@hidden transpose-subwords (c-)
address@hidden c-capitalize-subword
address@hidden capitalize-subword (c-)
address@hidden c-upcase-subword
address@hidden upcase-subword (c-)
address@hidden c-downcase-subword
address@hidden downcase-subword (c-)
address@hidden @columnfractions .20 .40 .40
address@hidden This could be converted to @headitem when we require Texinfo 4.7
address@hidden
address@hidden @b{Key} @tab @b{Word oriented command} @tab @b{Subword
oriented command}
address@hidden iftex
address@hidden
address@hidden Key @tab Word oriented command @tab Subword
oriented command
address@hidden
----------------------------------------------------------------------------
address@hidden ifnottex
address@hidden @kbd{M-f} @tab @code{forward-word} @tab
@code{c-forward-subword}
address@hidden @kbd{M-b} @tab @code{backward-word} @tab
@code{c-backward-subword}
address@hidden @kbd{M-@@} @tab @code{mark-word} @tab
@code{c-mark-subword}
address@hidden @kbd{M-d} @tab @code{kill-word} @tab
@code{c-kill-subword}
address@hidden @kbd{M-DEL} @tab @code{backward-kill-word} @tab
@code{c-backward-kill-subword}
address@hidden @kbd{M-t} @tab @code{transpose-words} @tab
@code{c-transpose-subwords}
address@hidden @kbd{M-c} @tab @code{capitalize-word} @tab
@code{c-capitalize-subword}
address@hidden @kbd{M-u} @tab @code{upcase-word} @tab
@code{c-upcase-subword}
address@hidden @kbd{M-l} @tab @code{downcase-word} @tab
@code{c-downcase-subword}
address@hidden multitable
+
+Note that if you have changed the key bindings for the word oriented
+commands in your @file{.emacs} or a similar place, the keys you have
+configured are also used for the corresponding subword oriented
+commands.
+
+Type @kbd{C-c C-w} to toggle subword mode on and off. To make the
+mode turn on automatically, put the following code in your
address@hidden:
+
address@hidden
+(add-hook 'c-mode-common-hook
+ (lambda () (c-subword-mode 1)))
address@hidden example
+
+As a bonus, you can also use @code{c-subword-mode} in address@hidden
+buffers by typing @kbd{M-x c-subword-mode}.
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Other Commands, , Subword Movement, Commands
address@hidden node-name, next, previous, up
address@hidden Other Commands
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+Here are the various other commands that didn't fit anywhere else:
+
address@hidden @asis
address@hidden @kbd{C-c .} (@code{c-set-style})
address@hidden C-c .
address@hidden c-set-style
address@hidden set-style (c-)
+Switch to the specified style in the current buffer. Use like this:
+
address@hidden
address@hidden . @var{style-name} @key{RET}}
address@hidden example
+
+You can use the @key{TAB} in the normal way to do completion on the
+style name. Note that all style names are case insensitive, even the
+ones you define yourself.
+
+Setting a style in this way does @emph{not} automatically reindent your
+file. For commands that you can use to view the effect of your changes,
+see @ref{Indentation Commands} and @ref{Filling and Breaking}.
+
+For details of the @ccmode{} style system, see @ref{Styles}.
address@hidden @kbd{C-c :} (@code{c-scope-operator})
address@hidden C-c :
address@hidden c-scope-operator
address@hidden scope-operator (c-)
+In C++, it is also sometimes desirable to insert the double-colon scope
+operator without performing the electric behavior of colon insertion.
address@hidden :} does just this.
+
address@hidden @kbd{C-c C-\} (@code{c-backslash-region})
address@hidden C-c C-\
address@hidden c-backslash-region
address@hidden backslash-region (c-)
+This function inserts and aligns or deletes end-of-line backslashes in
+the current region. These are typically used in multi-line macros.
+
+With no prefix argument, it inserts any missing backslashes and aligns
+them according to the @code{c-backslash-column} and
address@hidden variables. With a prefix argument, it
+deletes any backslashes.
+
+The function does not modify blank lines at the start of the region. If
+the region ends at the start of a line, it always deletes the backslash
+(if any) at the end of the previous line.
+
+To customize the precise workings of this command, @ref{Custom Macros}.
address@hidden table
+
address@hidden
+The recommended line breaking function, @code{c-context-line-break}
+(@pxref{Filling and Breaking}), is especially nice if you edit
+multiline macros frequently. When used inside a macro, it
+automatically inserts and adjusts the mandatory backslash at the end
+of the line to keep the macro together, and it leaves the point at the
+right indentation column for the code. Thus you can write code inside
+macros almost exactly as you can elsewhere, without having to bother
+with the trailing backslashes.
+
address@hidden @asis
address@hidden @kbd{C-c C-e} (@code{c-macro-expand})
address@hidden C-c C-e
address@hidden c-macro-expand
address@hidden macro-expand (c-)
+This command expands C, C++, Objective C or Pike macros in the region,
+using an appropriate external preprocessor program. Normally it
+displays its output in a temporary buffer, but if you give it a prefix
+arg (with @kbd{C-u C-c C-e}) it will overwrite the original region
+with the expansion.
+
+The command does not work in any of the other modes, and the key
+sequence is not bound in these other modes.
+
address@hidden isn't actually part of @ccmode{}, even though it
+is bound to a @ccmode{} key sequence. If you need help setting it up
+or have other problems with it, you can either read its source code or
+ask for help in the standard (X)Emacs forums.
address@hidden table
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Font Locking, Config Basics, Commands, Top
address@hidden node-name, next, previous, up
address@hidden Font Locking
address@hidden font locking
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden Font Lock mode
+
address@hidden provides font locking for its supported languages by
+supplying patterns for use with Font Lock mode. This means that you
+get distinct faces on the various syntactic parts such as comments,
+strings, keywords and types, which is very helpful in telling them
+apart at a glance and discovering syntactic errors. @xref{Font
+Lock,,, emacs, GNU Emacs Manual}, for ways to enable font locking in
address@hidden buffers.
+
address@hidden note:} The font locking in AWK mode is currently not
+integrated with the rest of @ccmode{}. Only the last section of this
+chapter, @ref{AWK Mode Font Locking}, applies to AWK. The other
+sections apply to the other languages.
+
address@hidden
+* Font Locking Preliminaries::
+* Faces::
+* Doc Comments::
+* AWK Mode Font Locking::
address@hidden menu
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Font Locking Preliminaries, Faces, Font Locking, Font Locking
address@hidden node-name, next, previous, up
address@hidden Font Locking Preliminaries
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+The font locking for most of the @ccmode{} languages were provided
+directly by the Font Lock package prior to version 5.30 of @ccmode{}.
+In the transition to @ccmode{} the patterns have been reworked
+completely and are applied uniformly across all the languages except AWK
+mode, just like the indentation rules (although each language still has
+some peculiarities of its own, of course). Since the languages
+previously had completely separate font locking patterns, this means
+that it's a bit different in most languages now.
+
+The main goal for the font locking in @ccmode{} is accuracy, to provide
+a dependable aid in recognizing the various constructs. Some, like
+strings and comments, are easy to recognize while others, like
+declarations and types, can be very tricky. @ccmode{} can go to great
+lengths to recognize declarations and casts correctly, especially when
+the types aren't recognized by standard patterns. This is a fairly
+demanding analysis which can be slow on older hardware, and it can
+therefore be disabled by choosing a lower decoration level with the
+variable @code{font-lock-maximum-decoration} (@pxref{Font Lock,,,
+emacs, GNU Emacs Manual}).
+
address@hidden font-lock-maximum-decoration
+
+The decoration levels are used as follows:
+
address@hidden
address@hidden 1
address@hidden
+Minimal font locking: Fontify only comments, strings and preprocessor
+directives (in the languages that use cpp).
+
address@hidden 2
address@hidden
+Fast font locking: In addition to level 1, fontify keywords, simple
+types and declarations that are easy to recognize. The variables
address@hidden (where @samp{*} is the name of the
+language) are used to recognize types (see below). Documentation
+comments like Javadoc are fontified according to
address@hidden (@pxref{Doc Comments}).
+
+Use this if you think the font locking is too slow. It's the closest
+corresponding level to level 3 in the old font lock patterns.
+
address@hidden 3
address@hidden
+Accurate font locking: Like level 2 but uses a different approach that
+can recognize types and declarations much more accurately. The
address@hidden variables are still used, but user
+defined types are recognized correctly anyway in most cases. Therefore
+those variables should be fairly restrictive and not contain patterns
+that are uncertain.
+
address@hidden Lazy Lock mode
address@hidden Just-in-time Lock mode
+
+This level is designed for fairly modern hardware and a font lock
+support mode like Lazy Lock or Just-in-time Lock mode that only
+fontifies the parts that are actually shown. Fontifying the whole
+buffer at once can easily get bothersomely slow even on contemporary
+hardware. @xref{Font Lock,,,@emacsman{}, @emacsmantitle{}}.
address@hidden enumerate
+
address@hidden user defined types
address@hidden types, user defined
+
+Since user defined types are hard to recognize you can provide
+additional regexps to match those you use:
+
address@hidden c-font-lock-extra-types
address@hidden c++-font-lock-extra-types
address@hidden objc-font-lock-extra-types
address@hidden java-font-lock-extra-types
address@hidden idl-font-lock-extra-types
address@hidden pike-font-lock-extra-types
+For each language there's a variable @code{*-font-lock-extra-types},
+where @samp{*} stands for the language in question. It contains a list
+of regexps that matches identifiers that should be recognized as types,
+e.g. @samp{\\sw+_t} to recognize all identifiers ending with @samp{_t}
+as is customary in C code. Each regexp should not match more than a
+single identifier.
+
+The default values contain regexps for many types in standard runtime
+libraries that are otherwise difficult to recognize, and patterns for
+standard type naming conventions like the @samp{_t} suffix in C and C++.
+Java, Objective-C and Pike have as a convention to start class names
+with capitals, so there are patterns for that in those languages.
+
+Despite the names of these variables, they are not only used for
+fontification but in other places as well where @ccmode{} needs to
+recognize types.
address@hidden defopt
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Faces, Doc Comments, Font Locking Preliminaries, Font Locking
address@hidden node-name, next, previous, up
address@hidden Faces
address@hidden faces
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden attempts to use the standard faces for programming languages
+in accordance with their intended purposes as far as possible. No extra
+faces are currently provided, with the exception of a replacement face
address@hidden for emacsen that don't provide
address@hidden
+
address@hidden @bullet
address@hidden
address@hidden font-lock-comment-face
+Normal comments are fontified in @code{font-lock-comment-face}.
+
address@hidden
address@hidden font-lock-doc-face
address@hidden font-lock-doc-string-face
address@hidden font-lock-comment-face
+Comments that are recognized as documentation (@pxref{Doc Comments})
+get @code{font-lock-doc-face} (Emacs) or
address@hidden (XEmacs) if those faces exist. If
+they don't then @code{font-lock-comment-face} is used.
+
address@hidden
address@hidden font-lock-string-face
+String and character literals are fontified in
address@hidden
+
address@hidden
address@hidden font-lock-keyword-face
+Keywords are fontified with @code{font-lock-keyword-face}.
+
address@hidden
address@hidden font-lock-function-name-face
address@hidden is used for function names in
+declarations and definitions, and classes in those contexts. It's also
+used for preprocessor defines with arguments.
+
address@hidden
address@hidden font-lock-variable-name-face
+Variables in declarations and definitions, and other identifiers in such
+variable contexts, get @code{font-lock-variable-name-face}. It's also
+used for preprocessor defines without arguments.
+
address@hidden
address@hidden font-lock-constant-face
address@hidden font-lock-reference-face
+Builtin constants are fontified in @code{font-lock-constant-face} if it
+exists, @code{font-lock-reference-face} otherwise. As opposed to the
+preceding two faces, this is used on the names in expressions, and it's
+not used in declarations, even if there happen to be a @samp{const} in
+them somewhere.
+
address@hidden
address@hidden font-lock-type-face
address@hidden is put on types (both predefined and user
+defined) and classes in type contexts.
+
address@hidden
address@hidden font-lock-constant-face
address@hidden font-lock-reference-face
+Label identifiers get @code{font-lock-constant-face} if it exists,
address@hidden otherwise.
+
address@hidden
+Name qualifiers and identifiers for scope constructs are fontified like
+labels.
+
address@hidden
+Special markup inside documentation comments are also fontified like
+labels.
+
address@hidden
address@hidden font-lock-preprocessor-face
address@hidden font-lock-builtin-face
address@hidden font-lock-reference-face
+Preprocessor directives get @code{font-lock-preprocessor-face} if it
+exists (i.e. XEmacs). In Emacs they get @code{font-lock-builtin-face}
+or @code{font-lock-reference-face}, for lack of a closer equivalent.
+
address@hidden
address@hidden font-lock-warning-face
address@hidden c-invalid-face
address@hidden invalid-face (c-)
+Some kinds of syntactic errors are fontified with
address@hidden in Emacs. In older XEmacs versions
+there's no corresponding standard face, so there a special
address@hidden is used, which is defined to stand out sharply by
+default.
+
+Note that it's not used for @samp{#error} or @samp{#warning} directives,
+since those aren't syntactic errors in themselves.
address@hidden itemize
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Doc Comments, AWK Mode Font Locking, Faces, Font Locking
address@hidden node-name, next, previous, up
address@hidden Documentation Comments
address@hidden documentation comments
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+There are various tools to supply documentation in the source as
+specially structured comments, e.g. the standard Javadoc tool in Java.
address@hidden provides an extensible mechanism to fontify such comments and
+the special markup inside them.
+
address@hidden c-doc-comment-style
address@hidden doc-comment-style (c-)
+This is a style variable that specifies which documentation comment
+style to recognize, e.g. @code{javadoc} for Javadoc comments.
+
+The value may also be a list of styles, in which case all of them are
+recognized simultaneously (presumably with markup cues that don't
+conflict).
+
+The value may also be an association list to specify different comment
+styles for different languages. The symbol for the major mode is then
+looked up in the alist, and the value of that element is interpreted as
+above if found. If it isn't found then the symbol `other' is looked up
+and its value is used instead.
+
+The default value for @code{c-doc-comment-style} is
address@hidden@code{((java-mode . javadoc) (pike-mode . autodoc) (c-mode .
gtkdoc))}}.
+
+Note that @ccmode{} uses this variable to set other variables that
+handle fontification etc. That's done at mode initialization or when
+you switch to a style which sets this variable. Thus, if you change it
+in some other way, e.g. interactively in a CC Mode buffer, you will need
+to do @kbd{M-x java-mode} (or whatever mode you're currently using) to
+reinitialize.
+
address@hidden c-setup-doc-comment-style
address@hidden setup-doc-comment-style (c-)
+Note also that when @ccmode{} starts up, the other variables are
+modified before the mode hooks are run. If you change this variable in
+a mode hook, you'll have to call @code{c-setup-doc-comment-style}
+afterwards to redo that work.
address@hidden defopt
+
address@hidden currently provides handing of the following doc comment
+styles:
+
address@hidden @code
address@hidden javadoc
address@hidden Javadoc markup
+Javadoc comments, the standard tool in Java.
+
address@hidden autodoc
address@hidden Pike autodoc markup
+For Pike autodoc markup, the standard in Pike.
+
address@hidden gtkdoc
address@hidden GtkDoc markup
+For GtkDoc markup, widely used in the Gnome community.
address@hidden table
+
+The above is by no means complete. If you'd like to see support for
+other doc comment styles, please let us know (@pxref{Mailing Lists and
+Bug Reports}).
+
+You can also write your own doc comment fontification support to use
+with @code{c-doc-comment-style}: Supply a variable or function
address@hidden where @samp{*} is the name you want to use
+in @code{c-doc-comment-style}. If it's a variable, it's prepended to
address@hidden If it's a function, it's called at mode
+initialization and the result is prepended. For an example, see
address@hidden in @file{cc-fonts.el}.
+
+If you add support for another doc comment style, please consider
+contributing it - send a note to @email{bug-cc-mode@@gnu.org}.
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden AWK Mode Font Locking, , Doc Comments, Font Locking
address@hidden node-name, next, previous, up
address@hidden AWK Mode Font Locking
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+The general appearance of font-locking in AWK mode is much like in any
+other programming mode. @xref{Faces For Font Lock,,,elisp, GNU Emacs
+Lisp Reference Manual}.
+
+The following faces are, however, used in a non-standard fashion in
+AWK mode:
+
address@hidden @asis
address@hidden @code{font-lock-variable-name-face}
+This face was intended for variable declarations. Since variables are
+not declared in AWK, this face is used instead for AWK system
+variables (such as @code{NF}) and ``Special File Names'' (such as
address@hidden"/dev/stderr"}).
+
address@hidden @code{font-lock-builtin-face}
(Emacs)/@code{font-lock-preprocessor-face} (XEmacs)
+This face is normally used for preprocessor directives in @ccmode{}.
+There are no such things in AWK, so this face is used instead for
+standard functions (such as @code{match}).
+
address@hidden @code{font-lock-string-face}
+As well as being used for strings, including localizable strings,
+(delimited by @samp{"} and @samp{_"}), this face is also used for AWK
+regular expressions (delimited by @samp{/}).
+
address@hidden @code{font-lock-warning-face} (Emacs)/@code{c-invalid-face}
(XEmacs)
+This face highlights the following syntactically invalid AWK
+constructs:
+
address@hidden @bullet
address@hidden
+An unterminated string or regular expression. Here the opening
+delimiter (@samp{"} or @samp{/} or @samp{_"}) is displayed in
address@hidden This is most noticeable when typing in a
+new string/regular expression into a buffer, when the warning-face
+serves as a continual reminder to terminate the construct.
+
+AWK mode fontifies unterminated strings/regular expressions
+differently from other modes: Only the text up to the end of the line
+is fontified as a string (escaped newlines being handled correctly),
+rather than the text up to the next string quote.
+
address@hidden
+A space between the function name and opening parenthesis when calling
+a user function. The last character of the function name and the
+opening parenthesis are highlighted. This font-locking rule will
+spuriously highlight a valid concatenation expression where an
+identifier precedes a parenthesised expression. Unfortunately.
+
address@hidden
+Whitespace following the @samp{\} in what otherwise looks like an
+escaped newline. The @samp{\} is highlighted.
address@hidden itemize
address@hidden table
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Config Basics, Custom Filling and Breaking, Font Locking, Top
address@hidden node-name, next, previous, up
address@hidden Configuration Basics
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden Emacs Initialization File
address@hidden Configuration
+You configure @ccmode{} by setting Lisp variables and calling (and
+perhaps writing) Lisp address@hidden'T PANIC!!! This isn't
+difficult.}, which is usually done by adding code to an Emacs
+initialization file. This file might be @file{site-start.el} or
address@hidden or @file{init.el} or @file{default.el} or perhaps some
+other file. @xref{Init File,,,@emacsman{}, @emacsmantitle{}}. For
+the sake of conciseness, we just call this file ``your @file{.emacs}''
+throughout the rest of the manual.
+
+Several of these variables (currently 16), are known collectively as
address@hidden variables}. @ccmode{} provides a special mechanism, known
+as @dfn{styles} to make it easier to set these variables as a group,
+to ``inherit'' settings from one style into another, and so on. Style
+variables remain ordinary Lisp variables, whose values can be read and
+changed independently of the style system. @xref{Style Variables}.
+
+There are several ways you can write the code, depending on the
+precise effect you want---they are described further down on this page.
+If you are new to @ccmode{}, we suggest you begin with the simplest
+method, ``Top-level commands or the customization interface''.
+
+If you make conflicting settings in several of these ways, the way
+that takes precedence is the one that appears latest in this list:
address@hidden @asis
address@hidden
address@hidden @asis
address@hidden Style
address@hidden Top-level command or ``customization interface''
address@hidden Hook
address@hidden File Style
address@hidden table
address@hidden itemize
+
+Here is a summary of the different ways of writing your configuration
+settings:
+
address@hidden @asis
address@hidden Top-level commands or the ``customization interface''
+Most simply, you can write @code{setq} and similar commands at the top
+level of your @file{.emacs} file. When you load a @ccmode{} buffer,
+it initializes its configuration from these global values (at least,
+for those settings you have given values to), so it makes sense to
+have these @code{setq} commands run @emph{before} @ccmode{} is first
+initialized---in particular, before any call to @code{desktop-read}
+(@pxref{Saving Emacs Sessions,,, emacs, GNU Emacs Manual}). For
+example, you might set c-basic-offset thus:
+
address@hidden
+(setq c-basic-offset 4)
address@hidden example
+
+You can use the more user friendly Customization interface instead,
+but this manual does not cover in detail how that works. To do this,
+start by typing @kbd{M-x customize-group @key{RET} c @key{RET}}.
address@hidden Customization,,,@emacsman{}, @emacsmantitle{}}.
address@hidden The following note really belongs in the Emacs manual.
+Emacs normally writes the customizations at the end of your
address@hidden file. If you use @code{desktop-read}, you should edit
+your @file{.emacs} to place the call to @code{desktop-read} @emph{after}
+the customizations.
+
+The first initialization of @ccmode{} puts a snapshot of the
+configuration settings into the special style @code{user}.
address@hidden Styles}.
+
+For basic use of Emacs, either of these ways of configuring is
+adequate. However, the settings are then the same in all @ccmode{}
+buffers and it can be clumsy to communicate them between programmers.
+For more flexibility, you'll want to use one (or both) of @ccmode{}'s
+more sophisticated facilities, hooks and styles.
+
address@hidden Hooks
+An Emacs @dfn{hook} is a place to put Lisp functions that you want
+Emacs to execute later in specific circumstances.
address@hidden,,,@lispref{}, @lispreftitle{}}. @ccmode{} supplies a main
+hook and a language-specific hook for each language it supports - any
+functions you put onto these hooks get executed as the last part of a
+buffer's initialization. Typically you put most of your customization
+within the main hook, and use the language-specific hooks to vary the
+customization settings between language modes. For example, if you
+wanted different (non-standard) values of @code{c-basic-offset} in C
+Mode and Java Mode buffers, you could do it like this:
+
address@hidden
address@hidden
+(defun my-c-mode-hook ()
+ (setq c-basic-offset 3))
+(add-hook 'c-mode-hook 'my-c-mode-hook)
+
+(defun my-java-mode-hook ()
+ (setq c-basic-offset 6))
+(add-hook 'java-mode-hook 'my-java-mode-hook)
address@hidden group
address@hidden example
+
+See @ref{CC Hooks} for more details on the use of @ccmode{} hooks.
+
address@hidden Styles
+A @ccmode{} @dfn{style} is a coherent collection of customizations
+with a name. At any time, exactly one style is active in each
address@hidden buffer, either the one you have selected or a default.
address@hidden is delivered with several existing styles. Additionally,
+you can create your own styles, possibly based on these existing
+styles. If you worked in a programming team called the ``Free
+Group'', which had its own coding standards, you might well have this
+in your @file{.emacs} file:
+
address@hidden
+(setq c-default-style '((java-mode . "java")
+ (awk-mode . "awk")
+ (other . "free-group-style")))
address@hidden example
+
+See @ref{Styles} for fuller details on using @ccmode{} styles and how
+to create them.
+
address@hidden File Styles
+A @dfn{file style} is a rarely used variant of the ``style'' mechanism
+described above, which applies to an individual source file. To use
+it, you set certain Emacs local variables in a special block at the
+end of the source file. @xref{File Styles}.
+
address@hidden Hooks with Styles
+For ultimate flexibility, you can use hooks and styles together. For
+example, if your team were developing a product which required a
+Linux driver, you'd probably want to use the ``linux'' style for the
+driver, and your own team's style for the rest of the code. You
+could achieve this with code like this in your @file{.emacs}:
+
address@hidden
address@hidden
+(defun my-c-mode-hook ()
+ (c-set-style
+ (if (and (buffer-file-name)
+ (string-match "/usr/src/linux" (buffer-file-name)))
+ "linux"
+ "free-group-style")))
+(add-hook 'c-mode-hook 'my-c-mode-hook)
address@hidden group
address@hidden example
+
+In a programming team, a hook is a also a good place for each member
+to put his own personal preferences. For example, you might be the
+only person in your team who likes Auto-newline minor mode. You could
+have it enabled by default by placing the following in your
address@hidden:
+
address@hidden
address@hidden
+(defun my-turn-on-auto-newline ()
+ (c-toggle-auto-newline 1))
+(add-hook 'c-mode-common-hook 'my-turn-on-auto-newline)
address@hidden group
address@hidden example
address@hidden table
+
address@hidden
+* CC Hooks::
+* Style Variables::
+* Styles::
address@hidden menu
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden CC Hooks, Style Variables, Config Basics, Config Basics
address@hidden node-name, next, previous, up
address@hidden Hooks
address@hidden mode hooks
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden The node name is "CC Hooks" rather than "Hooks" because of a bug
in
address@hidden some older versions of Info, e.g. the info.el in GNU Emacs 21.3.
address@hidden If you go to "Config Basics" and hit <CR> on the xref to "CC
address@hidden Hooks" the function Info-follow-reference searches for "*Note: CC
address@hidden Hooks" from the beginning of the page. If this node were instead
address@hidden named "Hooks", that search would spuriously find "*Note:
address@hidden Hooks(elisp)" and go to the wrong node.
+
address@hidden provides several hooks that you can use to customize the
+mode for your coding style. The main hook is
address@hidden; typically, you'll put the bulk of your
+customizations here. In addition, each language mode has its own
+hook, allowing you to fine tune your settings individually for the
+different @ccmode{} languages, and there is a package initialization
+hook. Finally, there is @code{c-special-indent-hook}, which enables
+you to solve anomalous indentation problems. It is described in
address@hidden Indentation}, not here. All these hooks adhere to the
+standard Emacs conventions.
+
+When you open a buffer, @ccmode{} first initializes it with the
+currently active style (@pxref{Styles}). Then it calls
address@hidden, and finally it calls the language-specific
+hook. Thus, any style settings done in these hooks will override
+those set by @code{c-default-style}.
+
address@hidden c-initialization-hook
address@hidden initialization-hook (c-)
+Hook run only once per Emacs session, when @ccmode{} is initialized.
+This is a good place to change key bindings (or add new ones) in any
+of the @ccmode{} key maps. @xref{Sample .emacs File}.
address@hidden defvar
+
address@hidden c-mode-common-hook
address@hidden mode-common-hook (c-)
+Common hook across all languages. It's run immediately before the
+language specific hook.
address@hidden defvar
+
address@hidden c-mode-hook
address@hidden c++-mode-hook
address@hidden objc-mode-hook
address@hidden java-mode-hook
address@hidden idl-mode-hook
address@hidden pike-mode-hook
address@hidden awk-mode-hook
+The language specific mode hooks. The appropriate one is run as the
+last thing when you enter that language mode.
address@hidden defvar
+
+Although these hooks are variables defined in @ccmode{}, you can give
+them values before @ccmode{}'s code is loaded---indeed, this is the
+only way to use @code{c-initialization-hook}. Their values aren't
+overwritten when @ccmode{} gets loaded.
+
+Here's a simplified example of what you can add to your @file{.emacs}
+file to do things whenever any @ccmode{} language is edited. See the
+Emacs manuals for more information on customizing Emacs via hooks.
address@hidden .emacs File}, for a more complete sample @file{.emacs}
+file.
+
address@hidden
+(defun my-c-mode-common-hook ()
+ ;; my customizations for all of c-mode and related modes
+ (no-case-fold-search)
+ )
+(add-hook 'c-mode-common-hook 'my-c-mode-common-hook)
address@hidden example
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Style Variables, Styles, CC Hooks, Config Basics
address@hidden node-name, next, previous, up
address@hidden Style Variables
address@hidden styles
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden style variables
+The variables that @ccmode{}'s style system control are called
address@hidden variables}. Note that style variables are ordinary Lisp
+variables, which the style system initializes; you can change their
+values at any time (e.g. in a hook function). The style system can
+also set other variables, to some extent. @xref{Styles}.
+
address@hidden variables} are handled specially in several ways:
+
address@hidden @bullet
address@hidden
+Style variables are by default buffer-local variables. However, they
+can instead be made global by setting
address@hidden to @code{nil} before @ccmode{} is
+initialized.
+
address@hidden
address@hidden c-old-style-variable-behavior
address@hidden old-style-variable-behavior (c-)
+The default global binding of any style variable (with two exceptions
+- see below) is the special symbol @code{set-from-style}. When the
+style system initializes a buffer-local copy of a style variable for a
address@hidden buffer, if its global binding is still that symbol then it
+will be set from the current style. Otherwise it will retain its
+global address@hidden is a big change from versions of
address@hidden earlier than 5.26, where such settings would get overridden
+by the style system unless special precautions were taken. That was
+changed since it was counterintuitive and confusing, especially to
+novice users. If your configuration depends on the old overriding
+behavior, you can set the variable
address@hidden to address@hidden This
+``otherwise'' happens, for example, when you've set the variable with
address@hidden at the top level of your @file{.emacs} (@pxref{Config
+Basics}).
+
address@hidden
+The style variable @code{c-offsets-alist} (@pxref{c-offsets-alist}) is
+an association list with an element for each syntactic symbol. It's
+handled a little differently from the other style variables. It's
+default global binding is the empty list @code{nil}, rather than
address@hidden Before the style system is initialized, you
+can add individual elements to @code{c-offsets-alist} by calling
address@hidden(@pxref{c-offsets-alist}) just like you would set
+other style variables with @code{setq}. Those elements will then
+prevail when the style system later initializes a buffer-local copy of
address@hidden
+
address@hidden
+The style variable @code{c-special-indent-hook} is also handled in a
+special way. Styles can only add functions to this hook, not remove
+them, so any global settings you put on it are always
address@hidden did not change in version 5.26.}. The value
+you give this variable in a style definition can be either a function
+or a list of functions.
+
address@hidden
+The global bindings of the style variables get captured in the special
address@hidden style when the style system is first initialized.
address@hidden Styles}, for details.
address@hidden itemize
+
+The style variables are:@*
address@hidden,
address@hidden (@pxref{Indentation
+Commands});@*
address@hidden (@pxref{Doc Comments});@*
address@hidden, @code{c-comment-prefix-regexp}
+(@pxref{Custom Filling and Breaking});@*
address@hidden (@pxref{Hanging Braces});@*
address@hidden (@pxref{Hanging Colons});@*
address@hidden&comma-criteria} (@pxref{Hanging Semicolons and
+Commas});@*
address@hidden (@pxref{Clean-ups});@*
address@hidden (@pxref{Customizing Indentation});@*
address@hidden (@pxref{c-offsets-alist});@*
address@hidden (@pxref{Comment Line-Up});@*
address@hidden, @code{c-label-minimum-indentation}
+(@pxref{Other Indentation});@*
address@hidden, @code{c-backslash-max-column}
+(@pxref{Custom Macros}).
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Styles, , Style Variables, Config Basics
address@hidden node-name, next, previous, up
address@hidden Styles
address@hidden styles
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+By @dfn{style} we mean the layout of the code---things like how many
+columns to indent a block of code, whether an opening brace gets
+indented to the level of the code it encloses, or of the construct
+that introduces it, or ``hangs'' at the end of a line.
+
+Most people only need to edit code formatted in just a few well-defined
+and consistent styles. For example, their organization might impose a
+``blessed'' style that all its programmers must conform to. Similarly,
+people who work on GNU software will have to use the GNU coding style.
+Some shops are more lenient, allowing a variety of coding styles, and as
+programmers come and go, there could be a number of styles in use. For
+this reason, @ccmode{} makes it convenient for you to set up logical
+groupings of customizations called @dfn{styles}, associate a single name
+for any particular style, and pretty easily start editing new or
+existing code using these styles.
+
address@hidden
+* Built-in Styles::
+* Choosing a Style::
+* Adding Styles::
+* File Styles::
address@hidden menu
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Built-in Styles, Choosing a Style, Styles, Styles
address@hidden node-name, next, previous, up
address@hidden Built-in Styles
address@hidden styles, built-in
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+If you're lucky, one of @ccmode{}'s built-in styles might be just
+what you're looking for. These are:
+
address@hidden @code
address@hidden gnu
address@hidden GNU style
+Coding style blessed by the Free Software Foundation
+for C code in GNU programs.
+
address@hidden k&r
address@hidden K&R style
+The classic Kernighan and Ritchie style for C code.
+
address@hidden bsd
address@hidden BSD style
+Also known as ``Allman style'' after Eric Allman.
+
address@hidden whitesmith
address@hidden Whitesmith style
+Popularized by the examples that came with Whitesmiths C, an early
+commercial C compiler.
+
address@hidden stroustrup
address@hidden Stroustrup style
+The classic Stroustrup style for C++ code.
+
address@hidden ellemtel
address@hidden Ellemtel style
+Popular C++ coding standards as defined by ``Programming in C++, Rules
+and Recommendations,'' Erik Nyquist and Mats Henricson,
address@hidden document is available at
address@hidden://www.doc.ic.ac.uk/lab/cplus/c++.rules/} among other
+places.}.
address@hidden N.B. This URL was still valid at 2005/8/28 (ACM).
+
address@hidden linux
address@hidden Linux style
+C coding standard for Linux (the kernel).
+
address@hidden python
address@hidden Python style
+C coding standard for Python extension address@hidden is a
+high level scripting language with a C/C++ foreign function interface.
+For more information, see @uref{http://www.python.org/}.}.
+
address@hidden java
address@hidden Java style
+The style for editing Java code. Note that the default
+value for @code{c-default-style} installs this style when you enter
address@hidden
+
address@hidden awk
address@hidden AWK style
+The style for editing AWK code. Note that the default value for
address@hidden installs this style when you enter
address@hidden
+
address@hidden user
address@hidden User style
+This is a special style created by you. It consists of the factory
+defaults for all the style variables as modified by the customizations
+you do either with the Customization interface or by writing
address@hidden and @code{c-set-offset}s at the top level of your
address@hidden file (@pxref{Config Basics}). The style system creates
+this style as part of its initialization and doesn't modify it
+afterwards.
address@hidden table
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Choosing a Style, Adding Styles, Built-in Styles, Styles
address@hidden node-name, next, previous, up
address@hidden Choosing a Style
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+When you create a new buffer, its style will be set from
address@hidden The factory default is the style @code{gnu},
+except in Java and AWK modes where it's @code{java} and @code{awk}.
+
+Remember that if you set a style variable with the Customization
+interface or at the top level of your @file{.emacs} file before the
+style system is initialised (@pxref{Config Basics}), this setting will
+override the one that the style system would have given the variable.
+
+To set a buffer's style interactively, use the command @kbd{C-c .}
+(@pxref{Other Commands}). To set it from a file's local variable
+list, @ref{File Styles}.
+
address@hidden c-default-style
address@hidden default-style (c-)
+This variable specifies which style to install by default in new
+buffers. It takes either a style name string, or an association list
+of major mode symbols to style names:
+
address@hidden
address@hidden
+When @code{c-default-style} is a string, it must be an existing style
+name. This style is then used for all modes.
+
address@hidden
+When @code{c-default-style} is an association list, the mode language
+is looked up to find a style name string.
+
address@hidden
+If @code{c-default-style} is an association list where the mode
+language mode isn't found then the special symbol @samp{other} is
+looked up. If it's found then the associated style is used.
+
address@hidden
+If @samp{other} is not found then the @samp{gnu} style is used.
address@hidden enumerate
+
+In all cases, the style described in @code{c-default-style} is installed
address@hidden the language hooks are run, so you can always override
+this setting by including an explicit call to @code{c-set-style} in your
+language mode hook, or in @code{c-mode-common-hook}.
+
+The standard value of @code{c-default-style} is @address@hidden((java-mode
+. "java") (awk-mode . "awk") (other . "gnu"))}}.
address@hidden defopt
+
address@hidden c-indentation-style
address@hidden indentation-style (c-)
+This variable always contains the buffer's current style name, as a
+string.
address@hidden defvar
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Adding Styles, File Styles, Choosing a Style, Styles
address@hidden node-name, next, previous, up
address@hidden Adding and Amending Styles
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+If none of the built-in styles is appropriate, you'll probably want to
+create a new @dfn{style definition}, possibly based on an existing
+style. To do this, put the new style's settings into a list with the
+following format - the list can then be passed as an argument to the
+function @code{c-add-style}. You can see an example of a style
+definition in @ref{Sample .emacs File}.
+
address@hidden style definition
address@hidden @defvr {List} style definition
address@hidden @asis
address@hidden Structure of a Style Definition List
+(address@hidden [(@var{variable} . @var{value}) @dots{}])
+
+Optional @var{base-style}, if present, must be a string which is the
+name of the @dfn{base style} from which this style inherits. At most
+one @var{base-style} is allowed in a style definition. If
address@hidden is not specified, the style inherits from the table
+of factory default address@hidden table is stored internally in
+the variable c-fallback-style.} instead. All styles eventually
+inherit from this internal table. Style loops generate errors. The
+list of pre-existing styles can be seen in @ref{Built-in Styles}.
+
+The dotted pairs (@var{variable} . @var{value}) each consist of a
+variable and the value it is to be set to when the style is later
address@hidden that if the variable has been given a value
+by the Customization interface or a @code{setq} at the top level of
+your @file{.emacs}, this value will override the one the style system
+tries to give it. @xref{Config Basics}.} The variable can be either a
address@hidden style variable or an arbitrary Emacs variable. In the
+latter case, it is @emph{not} made buffer-local by the @ccmode{} style
+system.
address@hidden @end defvr
+
+Two variables are treated specially in the dotted pair list:
+
address@hidden @code
address@hidden c-offsets-alist
+The value is in turn a list of dotted pairs of the form
+
address@hidden
+(@address@hidden . @address@hidden)
address@hidden example
+
+as described in @ref{c-offsets-alist}. These are passed to
address@hidden so there is no need to set every syntactic symbol
+in your style, only those that are different from the inherited style.
+
address@hidden c-special-indent-hook
+The value is added to @code{c-special-indent-hook} using
address@hidden, so any functions already on it are kept. If the value
+is a list, each element of the list is added with @code{add-hook}.
address@hidden table
address@hidden table
+
+Styles are kept in the @code{c-style-alist} variable, but you
+should never modify this variable directly. Instead, @ccmode{}
+provides the function @code{c-add-style} for this purpose.
+
address@hidden c-add-style stylename description &optional set-p
address@hidden add-style (c-)
+Add or update a style called @var{stylename}, a string.
address@hidden is the new style definition in the form described
+above. If @var{stylename} already exists in @code{c-style-alist} then
+it is replaced by @var{description}. (Note, this replacement is
+total. The old style is @emph{not} merged into the new one.)
+Otherwise, a new style is added.
+
+If the optional @var{set-p} is address@hidden then the new style is
+applied to the current buffer as well. The use of this facility is
+deprecated and it might be removed from @ccmode{} in a future release.
+You should use @code{c-set-style} instead.
+
+The sample @file{.emacs} file provides a concrete example of how a new
+style can be added and automatically set. @xref{Sample .emacs File}.
address@hidden defun
+
address@hidden c-style-alist
address@hidden style-alist (c-)
+This is the variable that holds the definitions for the styles. It
+should not be changed directly; use @code{c-add-style} instead.
address@hidden defvar
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden File Styles, , Adding Styles, Styles
address@hidden node-name, next, previous, up
address@hidden File Styles
address@hidden styles, file local
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden file local variables
+
+The Emacs manual describes how you can customize certain variables on a
+per-file basis by including a @dfn{file local variable} block at the end
+of the file (@pxref{File Variables,, Local Variables in Files, @emacsman{},
address@hidden).
+
+So far, you've only seen a functional interface for setting styles in
address@hidden, and this can't be used here. @ccmode{} fills the gap by
+providing two variables for use in a file's local variable list.
+Don't use them anywhere else! These allow you to customize the style
+on a per-file basis:
+
address@hidden c-file-style
address@hidden file-style (c-)
+Set this variable to a style name string in the Local Variables list.
+From now on, when you visit the file, @ccmode{} will automatically set
+the file's style to this one using @code{c-set-style}.
address@hidden defvar
+
address@hidden c-file-offsets
address@hidden file-offsets (c-)
+Set this variable (in the Local Variables list) to an association list
+of the same format as @code{c-offsets-alist}. From now on, when you
+visit the file, @ccmode{} will automatically institute these offsets
+using @code{c-set-offset}.
address@hidden defvar
+
+Note that file style settings (i.e. @code{c-file-style}) are applied
+before file offset settings
+(i.e. @code{c-file-offsets})@footnote{Also, if either of these are set
+in a file's local variable section, all the style variable values are
+made local to that buffer, even if
address@hidden is @code{nil}. Since this
+variable is virtually always address@hidden anyhow, you're unlikely to
+notice this effect.}.
+
+If you set any variables, including style variables, by the file local
+variables mechanism, these settings take priority over all other
+settings, even those in your mode hooks (@pxref{CC Hooks}). If you
+use @code{c-file-style} or @code{c-file-offsets} and also explicitly
+set a style variable in a local variable block, the explicit setting
+will take priority.
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Custom Filling and Breaking, Custom Auto-newlines, Config
Basics, Top
address@hidden node-name, next, previous, up
address@hidden Customizing Filling and Line Breaking
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+Since there's a lot of normal text in comments and string literals,
address@hidden provides features to edit these like in text mode. It does
+this by hooking in on the different line breaking functions and tuning
+relevant variables as necessary.
+
address@hidden c-comment-prefix-regexp
address@hidden comment-prefix-regexp (c-)
address@hidden comment line prefix
address@hidden comment-start
address@hidden comment-end
address@hidden comment-start-skip
address@hidden paragraph-start
address@hidden paragraph-separate
address@hidden paragraph-ignore-fill-prefix
address@hidden adaptive-fill-mode
address@hidden adaptive-fill-regexp
address@hidden adaptive-fill-first-line-regexp
+To make Emacs recognize comments and treat text in them as normal
+paragraphs, @ccmode{} makes several standard
address@hidden@code{comment-start}, @code{comment-end},
address@hidden, @code{paragraph-start},
address@hidden, @code{paragraph-ignore-fill-prefix},
address@hidden, @code{adaptive-fill-regexp}, and
address@hidden buffer-local and modifies them
+according to the language syntax and the comment line prefix.
+
address@hidden c-comment-prefix-regexp
address@hidden comment-prefix-regexp (c-)
+This style variable contains the regexp used to recognize the
address@hidden line prefix}, which is the line decoration that starts
+every line in a comment. The variable is either the comment line
+prefix itself, or (more usually) an association list with different
+values for different languages. The symbol for the major mode is
+looked up in the alist to get the regexp for the language, and if it
+isn't found then the special symbol @samp{other} is looked up instead.
+
+When a comment line gets divided by @kbd{M-j} or the like, @ccmode{}
+inserts the comment line prefix from a neighbouring line at the start
+of the new line. The default value of c-comment-prefix-regexp is
address@hidden//+\\|\\**}, which matches C++ style line comments like
+
address@hidden
+// blah blah
address@hidden example
+
address@hidden
+with two or more slashes in front of them, and the second and
+subsequent lines of C style block comments like
+
address@hidden
address@hidden
+/*
+ * blah blah
+ */
address@hidden group
address@hidden example
+
address@hidden
+with zero or more stars at the beginning of every line. If you change
+this variable, please make sure it still matches the comment starter
+(i.e. @code{//}) of line comments @emph{and} the line prefix inside
+block comments.
+
address@hidden c-setup-paragraph-variables
address@hidden setup-paragraph-variables (c-)
+Also note that since @ccmode{} uses the value of
address@hidden to set up several other variables at
+mode initialization, there won't be any effect if you just change it
+inside a @ccmode{} buffer. You need to call the command
address@hidden too, to update those other
+variables. That's also the case if you modify
address@hidden in a mode hook, since @ccmode{} will
+already have set up these variables before calling the hook.
address@hidden defopt
+
+In comments, @ccmode{} uses @code{c-comment-prefix-regexp} to adapt
+the line prefix from the other lines in the comment.
+
address@hidden adaptive-fill-mode
address@hidden Adaptive Fill mode
address@hidden uses adaptive fill mode (@pxref{Adaptive Fill,,, emacs, GNU
+Emacs Manual}) to make Emacs correctly keep the line prefix when
+filling paragraphs. That also makes Emacs preserve the text
+indentation @emph{inside} the comment line prefix. E.g. in the
+following comment, both paragraphs will be filled with the left
+margins of the texts kept intact:
+
address@hidden
address@hidden
+/* Make a balanced b-tree of the nodes in the incoming
+ * stream. But, to quote the famous words of Donald E.
+ * Knuth,
+ *
+ * Beware of bugs in the above code; I have only
+ * proved it correct, not tried it.
+ */
address@hidden group
address@hidden example
+
address@hidden c-setup-filladapt
address@hidden setup-filladapt (c-)
address@hidden filladapt-mode
address@hidden filladapt-mode
address@hidden Filladapt mode
+It's also possible to use other adaptive filling packages, notably Kyle
+E. Jones' Filladapt address@hidden's available from
address@hidden://www.wonderworks.com/}. As of version 2.12, it does however
+lack a feature that makes it work suboptimally when
address@hidden matches the empty string (which it does
+by default). A patch for that is available from
address@hidden://cc-mode.sourceforge.net/,, the CC Mode web site}.},
address@hidden 2005/11/22: The above is still believed to be the case.
+which handles things like bulleted lists nicely. There's a convenience
+function @code{c-setup-filladapt} that tunes the relevant variables in
+Filladapt for use in @ccmode{}. Call it from a mode hook, e.g. with
+something like this in your @file{.emacs}:
+
address@hidden
+(defun my-c-mode-common-hook ()
+ (c-setup-filladapt)
+ (filladapt-mode 1))
+(add-hook 'c-mode-common-hook 'my-c-mode-common-hook)
address@hidden example
+
address@hidden c-block-comment-prefix
address@hidden block-comment-prefix (c-)
address@hidden c-comment-continuation-stars
address@hidden comment-continuation-stars (c-)
+Normally the comment line prefix inserted for a new line inside a
+comment is deduced from other lines in it. However there's one
+situation when there's no hint about what the prefix should look like,
+namely when a block comment is broken for the first time. This style
address@hidden versions before 5.26, this variable was called
address@hidden As a compatibility measure,
address@hidden still uses the value on that variable if it's set.} is used
+then as the comment prefix. It defaults to @samp{*
address@hidden, this default setting of
address@hidden typically gets overridden by the default
+style @code{gnu}, which sets it to blank. You can see the line
+splitting effect described here by setting a different style,
+e.g. @code{k&r} @xref{Choosing a Style}.}, which makes a comment
+
address@hidden
+/* Got O(n^2) here, which is a Bad Thing. */
address@hidden example
+
address@hidden
+break into
+
address@hidden
address@hidden
+/* Got O(n^2) here, which
+ * is a Bad Thing. */
address@hidden group
address@hidden example
+
+Note that it won't work to adjust the indentation by putting leading
+spaces in @code{c-block-comment-prefix}, since @ccmode{} still uses the
+normal indentation engine to indent the line. Thus, the right way to
+fix the indentation is by customizing the @code{c} syntactic symbol. It
+defaults to @code{c-lineup-C-comments}, which handles the indentation of
+most common comment styles, see @ref{Line-Up Functions}.
address@hidden defopt
+
address@hidden c-ignore-auto-fill
address@hidden ignore-auto-fill (c-)
+When auto fill mode is enabled, @ccmode{} can selectively ignore it
+depending on the context the line break would occur in, e.g. to never
+break a line automatically inside a string literal. This variable
+takes a list of symbols for the different contexts where auto-filling
+never should occur:
+
address@hidden @code
address@hidden string
+Inside a string or character literal.
address@hidden c
+Inside a C style block comment.
address@hidden c++
+Inside a C++ style line comment.
address@hidden cpp
+Inside a preprocessor directive.
address@hidden code
+Anywhere else, i.e. in normal code.
address@hidden table
+
+By default, @code{c-ignore-auto-fill} is set to @code{(string cpp
+code)}, which means that when auto-fill mode is activated,
+auto-filling only occurs in comments. In literals, it's often
+desirable to have explicit control over newlines. In preprocessor
+directives, the necessary @samp{\} escape character before the newline
+is not automatically inserted, so an automatic line break would
+produce invalid code. In normal code, line breaks are normally
+dictated by some logical structure in the code rather than the last
+whitespace character, so automatic line breaks there will produce poor
+results in the current implementation.
address@hidden defopt
+
address@hidden comment-multi-line
+If inside a comment and @code{comment-multi-line} (@pxref{Auto Fill,,,
address@hidden, @emacsmantitle{}} is address@hidden, the indentation and
+line prefix are preserved. If inside a comment and
address@hidden is @code{nil}, a new comment of the same
+type is started on the next line and indented as appropriate for
+comments.
+
+Note that @ccmode{} sets @code{comment-multi-line} to @code{t} at
+startup. The reason is that @kbd{M-j} could otherwise produce sequences
+of single line block comments for texts that should logically be treated
+as one comment, and the rest of the paragraph handling code
+(e.g. @kbd{M-q} and @kbd{M-a}) can't cope with that, which would lead to
+inconsistent behavior.
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Custom Auto-newlines, Clean-ups, Custom Filling and Breaking,
Top
address@hidden node-name, next, previous, up
address@hidden Customizing Auto-newlines
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden determines whether to insert auto-newlines in two basically
+different ways, depending on the character just typed:
+
address@hidden @asis
address@hidden Braces and Colons
address@hidden first determines the syntactic context of the brace or colon
+(@pxref{Syntactic Symbols}), then looks for a corresponding element in
+an alist. This element specifies where to put newlines - this is any
+combination of before and after the brace or colon. If no alist
+element is found, newlines are inserted both before and after a brace,
+but none are inserted around a colon. See @ref{Hanging Braces} and
address@hidden Colons}.
+
address@hidden Semicolons and Commas
+The variable @code{c-hanging-semi&comma-criteria} contains a list of
+functions which determine whether to insert a newline after a newly
+typed semicolon or comma. @xref{Hanging Semicolons and Commas}.
address@hidden table
+
+The names of these configuration variables contain @samp{hanging}
+because they let you @dfn{hang} the pertinent characters. A character
+which introduces a C construct is said to @dfn{hang on the right} when
+it appears at the end of a line after other code, being separated by a
+line break from the construct it introduces, like the opening brace in:
+
address@hidden
address@hidden
+while (i < MAX) @{
+ total += entry[i];
+ entry [i++] = 0;
address@hidden
address@hidden group
address@hidden example
+
address@hidden
+A character @dfn{hangs on the left} when it appears at the start of
+the line after the construct it closes off, like the above closing
+brace.
+
+The next chapter, ``Clean-ups'', describes how to configure @ccmode{}
+to remove these automatically added newlines in certain specific
+circumstances. @xref{Clean-ups}.
+
address@hidden
+* Hanging Braces::
+* Hanging Colons::
+* Hanging Semicolons and Commas::
address@hidden menu
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Hanging Braces, Hanging Colons, Custom Auto-newlines, Custom
Auto-newlines
address@hidden node-name, next, previous, up
address@hidden Hanging Braces
address@hidden hanging braces
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+To specify which kinds of braces you want auto-newlines put around,
+you set the style variable @code{c-hanging-braces-alist}. Its
+structure and semantics are described in this section. Details of how
+to set it up, and its relationship to CC Mode's style system are given
+in @ref{Style Variables}.
+
+Say you wanted an auto-newline after (but not before) the following
address@hidden@{}:
+
address@hidden
+if (foo < 17) @{
address@hidden example
+
address@hidden
+First you need to find the @dfn{syntactic context} of the brace---type
+a @key{RET} before the brace to get it on a line of its
address@hidden insert a @samp{\} at the end of the previous line if
+you're in AWK Mode.}, then type @kbd{C-c C-s}. That will tell you
+something like:
+
address@hidden
+((substatement-open 1061))
address@hidden example
+
address@hidden
+So here you need to put the entry @code{(substatement-open . (after))}
+into @code{c-hanging-braces-alist}.
+
+If you don't want any auto-newlines for a particular syntactic symbol,
+put this into @code{c-hanging-braces-alist}:
+
address@hidden
+(brace-entry-open)
address@hidden example
+
+If some brace syntactic symbol is not in @code{c-hanging-brace-alist},
+its entry is taken by default as @code{(before after)}---insert a
+newline both before and after the brace. In place of a
+``before/after'' list you can specify a function in this alist---this
+is useful when the auto newlines depend on the code around the brace.
+
address@hidden c-hanging-braces-alist
address@hidden hanging-braces-alist (c-)
+
+This variable is an association list which maps syntactic symbols to
+lists of places to insert a newline. @xref{Association
+Lists,,,@lispref{}, @lispreftitle{}}. The key of each element is the
+syntactic symbol, the associated value is either @code{nil}, a list,
+or a function.
+
address@hidden @asis
address@hidden The Key - the syntactic symbol
+The syntactic symbols that are useful as keys in this list are
address@hidden, @code{statement-cont},
address@hidden, @code{inexpr-class-close}, and all the
address@hidden and @code{*-close} symbols. @xref{Syntactic Symbols},
+for a more detailed description of these syntactic symbols, except for
address@hidden and @code{inexpr-class-close}, which aren't
+actual syntactic symbols. Elements with any other value as a key get
+ignored.
+
+The braces of anonymous inner classes in Java are given the special
+symbols @code{inexpr-class-open} and @code{inexpr-class-close}, so that
+they can be distinguished from the braces of normal address@hidden
+braces of anonymous classes produce a combination of
address@hidden, and @code{class-open} or @code{class-close} in
+normal indentation analysis.}.
+
+Note that the aggregate constructs in Pike mode, @samp{(@{}, @address@hidden)},
address@hidden([}, @samp{])}, and @samp{(<}, @samp{>)}, do not count as brace
+lists in this regard, even though they do for normal indentation
+purposes. It's currently not possible to set automatic newlines on
+these constructs.
+
address@hidden The associated value - the ``ACTION'' list or function
+The value associated with each syntactic symbol in this association
+list is called an @var{action}, which can be either a list or a
+function which returns a list. @xref{Custom Braces}, for how to use
+a function as a brace hanging @var{action}.
+
+The list @var{action} (or the list returned by @var{action} when it's
+a function) contains some combination of the symbols @code{before} and
address@hidden, directing @ccmode{} where to put newlines in
+relationship to the brace being inserted. Thus, if the list contains
+only the symbol @code{after}, then the brace hangs on the right side
+of the line, as in:
+
address@hidden
+// here, open braces always `hang'
+void spam( int i ) @{
+ if( i == 7 ) @{
+ dosomething(i);
+ @}
address@hidden
address@hidden example
+
+When the list contains both @code{after} and @code{before}, the braces
+will appear on a line by themselves, as shown by the close braces in
+the above example. The list can also be empty, in which case newlines
+are added neither before nor after the brace.
address@hidden table
+
+If a syntactic symbol is missing entirely from
address@hidden, it's treated in the same way as an
address@hidden with a list containing @code{before} and @code{after}, so
+that braces by default end up on their own line.
+
+For example, the default value of @code{c-hanging-braces-alist} is:
+
address@hidden
+((brace-list-open)
+ (brace-entry-open)
+ (statement-cont)
+ (substatement-open after)
+ (block-close . c-snug-do-while)
+ (extern-lang-open after)
+ (namespace-open after)
+ (module-open after)
+ (composition-open after)
+ (inexpr-class-open after)
+ (inexpr-class-close before))
address@hidden example
+
address@hidden which says that @code{brace-list-open},
address@hidden and @address@hidden lists
+inside statements, such as initializers for static array variables
+inside functions in C, are recognized as @code{statement-cont}. All
+normal substatement blocks are recognized with other symbols.} braces
+should both hang on the right side and allow subsequent text to follow
+on the same line as the brace. Also, @code{substatement-open},
address@hidden, and @code{inexpr-class-open} braces should hang
+on the right side, but subsequent text should follow on the next line.
+The opposite holds for @code{inexpr-class-close} braces; they won't
+hang, but the following text continues on the same line. Here, in the
address@hidden entry, you also see an example of using a function as
+an @var{action}. In all other cases, braces are put on a line by
+themselves.
address@hidden defopt
+
address@hidden
+* Custom Braces::
address@hidden menu
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Custom Braces, , Hanging Braces, Hanging Braces
address@hidden node-name, next, previous, up
address@hidden Custom Brace Hanging
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden c-hanging-braces-alist
address@hidden hanging-braces-alist (c-)
address@hidden action functions
+Syntactic symbols aren't the only place where you can customize
address@hidden with the lisp equivalent of callback functions. Remember
+that @var{action}s are usually a list containing some combination of
+the symbols @code{before} and @code{after} (@pxref{Hanging Braces}).
+For more flexibility, you can instead specify brace ``hanginess'' by
+giving a syntactic symbol an @dfn{action function} in
address@hidden; this function determines the
+``hanginess'' of a brace, usually by looking at the code near it.
+
address@hidden customization, brace hanging
+An action function is called with two arguments: the syntactic symbol
+for the brace (e.g. @code{substatement-open}), and the buffer position
+where the brace has been inserted. Point is undefined on entry to an
+action function, but the function must preserve it (e.g. by using
address@hidden). The return value should be a list containing
+some combination of @code{before} and @code{after}, including neither
+of them (i.e. @code{nil}).
+
address@hidden c-syntactic-context
address@hidden syntactic-context (c-)
+During the call to the indentation or brace hanging @var{action}
+function, this variable is bound to the full syntactic analysis list.
+This might be, for example, @samp{((block-close 73))}. Don't ever
+give @code{c-syntactic-context} a value yourself---this would disrupt
+the proper functioning of @ccmode{}.
+
+This variable is also bound in three other circumstances:
+(i)@w{ }when calling a c-hanging-semi&comma-criteria function
+(@pxref{Hanging Semicolons and Commas}); (ii)@w{ }when calling a
+line-up function (@pxref{Custom Line-Up}); (iii)@w{ }when calling a
+c-special-indent-hook function (@pxref{Other Indentation}).
address@hidden defvar
+
+As an example, @ccmode{} itself uses this feature to dynamically
+determine the hanginess of braces which close ``do-while''
+constructs:
+
address@hidden
+void do_list( int count, char** atleast_one_string )
address@hidden
+ int i=0;
+ do @{
+ handle_string( atleast_one_string[i] );
+ i++;
+ @} while( i < count );
address@hidden
address@hidden example
+
address@hidden assigns the @code{block-close} syntactic symbol to the
+brace that closes the @code{do} construct, and normally we'd like the
+line that follows a @code{block-close} brace to begin on a separate
+line. However, with ``do-while'' constructs, we want the
address@hidden clause to follow the closing brace. To do this, we
+associate the @code{block-close} symbol with the @var{action} function
address@hidden:
+
address@hidden
+(defun c-snug-do-while (syntax pos)
+ "Dynamically calculate brace hanginess for do-while statements."
+ (save-excursion
+ (let (langelem)
+ (if (and (eq syntax 'block-close)
+ (setq langelem (assq 'block-close c-syntactic-context))
+ (progn (goto-char (cdr langelem))
+ (if (= (following-char) address@hidden)
+ (forward-sexp -1))
+ (looking-at "\\<do\\>[^_]")))
+ '(before)
+ '(before after)))))
address@hidden example
+
address@hidden c-snug-do-while
address@hidden snug-do-while (c-)
+This function simply looks to see if the brace closes a ``do-while''
+clause and if so, returns the list @samp{(before)} indicating
+that a newline should be inserted before the brace, but not after it.
+In all other cases, it returns the list @samp{(before after)} so
+that the brace appears on a line by itself.
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Hanging Colons, Hanging Semicolons and Commas, Hanging
Braces, Custom Auto-newlines
address@hidden node-name, next, previous, up
address@hidden Hanging Colons
address@hidden hanging colons
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden customization, colon hanging
address@hidden c-hanging-colons-alist
address@hidden hanging-colons-alist (c-)
+
+Using a mechanism similar to brace hanging (@pxref{Hanging Braces}),
+colons can also be made to hang using the style variable
address@hidden - When a colon is typed, @ccmode
+determines its syntactic context, looks this up in the alist
address@hidden and inserts up to two newlines
+accordingly. Here, however, If @ccmode fails to find an entry for a
+syntactic symbol in the alist, no newlines are inserted around the
+newly typed colon.
+
address@hidden c-hanging-colons-alist
address@hidden hanging-colons-alist (c-)
+
address@hidden @asis
address@hidden The Key - the syntactic symbol
+The syntactic symbols appropriate as keys in this association list
+are: @code{case-label}, @code{label}, @code{access-label},
address@hidden, and @code{inher-intro}. @xref{Syntactic
+Symbols}. Elements with any other value as a key get ignored.
+
address@hidden The associate value - the ``ACTION'' list
+The @var{action} here is simply a list containing a combination of the
+symbols @code{before} and @code{after}. Unlike in
address@hidden, functions as @var{actions} are not
+supported - there doesn't seem to be any need for them.
address@hidden table
address@hidden defopt
+
+In C++, double-colons are used as a scope operator but because these
+colons always appear right next to each other, newlines before and after
+them are controlled by a different mechanism, called @dfn{clean-ups} in
address@hidden @xref{Clean-ups}, for details.
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Hanging Semicolons and Commas, , Hanging Colons, Custom
Auto-newlines
address@hidden node-name, next, previous, up
address@hidden Hanging Semicolons and Commas
address@hidden hanging semicolons
address@hidden hanging commas
address@hidden customization, semicolon newlines
address@hidden customization, comma newlines
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden c-hanging-semi&comma-criteria
address@hidden hanging-semi&comma-criteria (c-)
+This style variable takes a list of functions; these get called when
+you type a semicolon or comma. The functions are called in order
+without arguments. When these functions are entered, point is just
+after the newly inserted @samp{;} or @samp{,} and they must preserve
+point (e.g., by using @code{save-excursion}). During the call, the
+variable @code{c-syntactic-context} is bound to the syntactic context
+of the current address@hidden was first introduced in @ccmode{}
+5.31.} @pxref{Custom Braces}. These functions don't insert newlines
+themselves, rather they direct @ccmode{} whether or not to do so.
+They should return one of the following values:
+
address@hidden @code
address@hidden t
+A newline is to be inserted after the @samp{;} or @samp{,}, and no
+more functions from the list are to be called.
address@hidden stop
+No more functions from the list are to be called, and no newline is to
+be inserted.
address@hidden nil
+No determination has been made, and the next function in the list is
+to be called.
address@hidden table
+
+Note that auto-newlines are never inserted @emph{before} a semicolon
+or comma. If every function in the list is called without a
+determination being made, then no newline is added.
+
+In AWK mode, this variable is set by default to @code{nil}. In the
+other modes, the default value is a list containing a single function,
address@hidden&comma-inside-parenlist}. This inserts newlines after all
+semicolons, apart from those separating @code{for}-clause statements.
address@hidden defopt
+
address@hidden c-semi&comma-no-newlines-before-nonblanks
address@hidden semi&comma-no-newlines-before-nonblanks (c-)
+This is an example of a criteria function, provided by @ccmode{}. It
+prevents newlines from being inserted after semicolons when there is a
+non-blank following line. Otherwise, it makes no determination. To
+use, add this function to the front of the
address@hidden&comma-criteria} list.
+
address@hidden
+(defun c-semi&comma-no-newlines-before-nonblanks ()
+ (save-excursion
+ (if (and (eq last-command-char ?\;)
+ (zerop (forward-line 1))
+ (not (looking-at "^[ \t]*$")))
+ 'stop
+ nil)))
address@hidden example
address@hidden defun
+
address@hidden c-semi&comma-inside-parenlist
address@hidden semi&comma-inside-parenlist (c-)
address@hidden c-semi&comma-no-newlines-for-oneline-inliners
address@hidden semi&comma-no-newlines-for-oneline-inliners (c-)
+The function @code{c-semi&comma-inside-parenlist} is what prevents
+newlines from being inserted inside the parenthesis list of @code{for}
+statements. In addition to
address@hidden&comma-no-newlines-before-nonblanks} described above,
address@hidden also comes with the criteria function
address@hidden&comma-no-newlines-for-oneline-inliners}, which suppresses
+newlines after semicolons inside one-line inline method definitions
+(e.g. in C++ or Java).
address@hidden defun
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Clean-ups, Indentation Engine Basics, Custom Auto-newlines,
Top
address@hidden node-name, next, previous, up
address@hidden Clean-ups
address@hidden clean-ups
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden are mechanisms which remove (or exceptionally, add)
+whitespace in specific circumstances and are complementary to colon
+and brace hanging. You enable a clean-up by adding its symbol into
address@hidden, e.g. like this:
+
address@hidden
+(add-to-list 'c-cleanup-list 'space-before-funcall)
address@hidden example
+
+On the surface, it would seem that clean-ups overlap the functionality
+provided by the @code{c-hanging-*-alist} variables. Clean-ups,
+however, are used to adjust code ``after-the-fact'', i.e. to adjust
+the whitespace in constructs later than when they were typed.
+
+Most of the clean-ups remove automatically inserted newlines, and are
+only active when auto-newline minor mode is turned on. Others will
+work all the time. Note that clean-ups are only performed when there
+is nothing but whitespace appearing between the individual components
+of the construct, and (apart from @code{comment-close-slash}) when the
+construct does not occur within a literal (@pxref{Auto-newlines}).
+
address@hidden c-cleanup-list
address@hidden cleanup-list (c-)
address@hidden literal
+
+You configure @ccmode{}'s clean-ups by setting the style variable
address@hidden, which is a list of clean-up symbols. By
+default, @ccmode{} cleans up only the @code{scope-operator} construct,
+which is necessary for proper C++ support.
address@hidden defopt
+
+These are the clean-ups that are only active when electric and
+auto-newline minor modes are enabled:
+
address@hidden TBD: Would like to use some sort of @deffoo here; @table indents
a
address@hidden bit too much in dvi output.
address@hidden @code
address@hidden brace-else-brace
+Clean up @address@hidden else @{} constructs by placing the entire construct on
+a single line. Clean up occurs when the open brace after the
address@hidden is typed. So for example, this:
+
address@hidden
address@hidden
+void spam(int i)
address@hidden
+ if( i==7 ) @{
+ dosomething();
+ @}
+ else
+ @{
address@hidden group
address@hidden example
+
address@hidden
+appears like this after the last open brace is typed:
+
address@hidden
address@hidden
+void spam(int i)
address@hidden
+ if( i==7 ) @{
+ dosomething();
+ @} else @{
address@hidden group
address@hidden example
+
address@hidden brace-elseif-brace
+Similar to the @code{brace-else-brace} clean-up, but this cleans up
address@hidden@} else if (...) @{} constructs. For example:
+
address@hidden
address@hidden
+void spam(int i)
address@hidden
+ if( i==7 ) @{
+ dosomething();
+ @}
+ else if( i==3 )
+ @{
address@hidden group
address@hidden example
+
address@hidden
+appears like this after the last open parenthesis is typed:
+
address@hidden
address@hidden
+void spam(int i)
address@hidden
+ if( i==7 ) @{
+ dosomething();
+ @} else if(
address@hidden group
address@hidden example
+
address@hidden
+and like this after the last open brace is typed:
+
address@hidden
address@hidden
+void spam(int i)
address@hidden
+ if( i==7 ) @{
+ dosomething();
+ @} else if( i==3 ) @{
address@hidden group
address@hidden example
+
address@hidden brace-catch-brace
+Analogous to @code{brace-elseif-brace}, but cleans up @address@hidden catch
+(...) @{} in C++ and Java mode.
+
address@hidden empty-defun-braces
+Clean up braces following a top-level function or class definition that
+contains no body. Clean up occurs when the closing brace is typed.
+Thus the following:
+
address@hidden
address@hidden
+class Spam
address@hidden
address@hidden
address@hidden group
address@hidden example
+
address@hidden
+is transformed into this when the close brace is typed:
+
address@hidden
address@hidden
+class Spam
address@hidden@}
address@hidden group
address@hidden example
+
address@hidden defun-close-semi
+Clean up the terminating semicolon on top-level function or class
+definitions when they follow a close brace. Clean up occurs when the
+semicolon is typed. So for example, the following:
+
address@hidden
address@hidden
+class Spam
address@hidden
+...
address@hidden
+;
address@hidden group
address@hidden example
+
address@hidden
+is transformed into this when the semicolon is typed:
+
address@hidden
address@hidden
+class Spam
address@hidden
+...
address@hidden;
address@hidden group
address@hidden example
+
address@hidden list-close-comma
+Clean up commas following braces in array and aggregate initializers.
+Clean up occurs when the comma is typed. The space before the comma
+is zapped just like the space before the semicolon in
address@hidden
+
address@hidden scope-operator
+Clean up double colons which might designate a C++ scope operator split
+across multiple address@hidden C++ constructs introduce
+ambiguous situations, so @code{scope-operator} clean-ups might not
+always be correct. This usually only occurs when scoped identifiers
+appear in switch label tags.}. Clean up occurs when the second colon is
+typed. You will always want @code{scope-operator} in the
address@hidden when you are editing C++ code.
+
address@hidden one-liner-defun
+Clean up a single line of code enclosed by defun braces by removing
+the whitespace before and after the code. The clean-up happens when
+the closing brace is typed. If the variable
address@hidden is set, the cleanup is only done if the
+resulting line would be no longer than the value of that variable.
+
+For example, consider this AWK code:
+
address@hidden
address@hidden
+BEGIN @{
+ FS = "\t" # use <TAB> as a field separator
address@hidden
address@hidden group
address@hidden example
+
address@hidden
+It gets compacted to the following when the closing brace is typed:
+
address@hidden
address@hidden
+BEGIN @{FS = "\t"@} # use <TAB> as a field separator
address@hidden group
address@hidden example
+
address@hidden c-max-one-liner-length
address@hidden max-one-liner-length (c-)
+The maximum length of the resulting line for which the clean-up
address@hidden will be triggered. This length is that of the entire
+line, including any leading whitespace and any trailing comment. Its
+default value is 80. If the value is zero or @code{nil}, no limit
+applies.
address@hidden defopt
address@hidden table
+
+The following clean-ups are always active when they occur on
address@hidden, regardless of whether Electric minor mode or
+Auto-newline minor mode are enabled:
+
address@hidden @code
address@hidden space-before-funcall
+Insert a space between the function name and the opening parenthesis
+of a function call. This produces function calls in the style
+mandated by the GNU coding standards, e.g. @address@hidden }(SIGINT,
+SIG_IGN)} and @address@hidden }()}. Clean up occurs when the opening
+parenthesis is typed. This clean-up should never be active in AWK
+Mode, since such a space is syntactically invalid for user defined
+functions.
+
address@hidden compact-empty-funcall
+Clean up any space between the function name and the opening parenthesis
+of a function call that has no arguments. This is typically used
+together with @code{space-before-funcall} if you prefer the GNU function
+call style for functions with arguments but think it looks ugly when
+it's only an empty parenthesis pair. I.e. you will get @samp{signal
+(SIGINT, SIG_IGN)}, but @samp{abort()}. Clean up occurs when the
+closing parenthesis is typed.
+
address@hidden comment-close-slash
+When inside a block comment, terminate the comment when you type a slash
+at the beginning of a line (i.e. immediately after the comment prefix).
+This clean-up removes whitespace preceding the slash and if needed,
+inserts a star to complete the token @samp{*/}. Type @kbd{C-q /} in this
+situation if you just want a literal @samp{/} inserted.
address@hidden table
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Indentation Engine Basics, Customizing Indentation,
Clean-ups, Top
address@hidden node-name, next, previous, up
address@hidden Indentation Engine Basics
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+This chapter will briefly cover how @ccmode{} indents lines of code.
+It is helpful to understand the indentation model being used so that
+you will know how to customize @ccmode{} for your personal coding
+style. All the details are in @ref{Customizing Indentation}.
+
address@hidden has an indentation engine that provides a flexible and
+general mechanism for customizing indentation. When @ccmode{} indents
+a line of code, it separates its calculations into two steps:
+
address@hidden
address@hidden
address@hidden syntactic symbol
address@hidden anchor position
+It analyzes the line to determine its @dfn{syntactic symbol(s)} (the
+kind of language construct it's looking at) and its @dfn{anchor
+position} (the position earlier in the file that @ccmode{} will indent
+the line relative to). The anchor position might be the location of
+an opening brace in the previous line, for example. @xref{Syntactic
+Analysis}.
address@hidden
address@hidden offsets
address@hidden indentation offset specifications
+It looks up the syntactic symbol(s) in the configuration to get the
+corresponding @dfn{offset(s)}. The symbol @code{+}, which means
+``indent this line one more level'' is a typical offset. @ccmode{}
+then applies these offset(s) to the anchor position, giving the
+indentation for the line. The different sorts of offsets are
+described in @ref{c-offsets-alist}.
address@hidden enumerate
+
+In exceptional circumstances, the syntax directed indentation
+described here may be a nuisance rather than a help. You can disable
+it by setting @code{c-syntactic-indentation} to @code{nil}. (To set
+the variable interactively, @ref{Minor Modes}).
+
address@hidden c-syntactic-indentation
address@hidden syntactic-indentation (c-)
+When this is address@hidden (which it is by default), the indentation
+of code is done according to its syntactic structure. When it's
address@hidden, every line is just indented to the same level as the
+previous one, and @kbd{TAB} (@code{c-indent-command}) adjusts the
+indentation in steps of @code{c-basic-offset}. The current style
+(@pxref{Config Basics}) then has no effect on indentation, nor do any
+of the variables associated with indentation, not even
address@hidden
address@hidden defopt
+
address@hidden
+* Syntactic Analysis::
+* Syntactic Symbols::
+* Indentation Calculation::
address@hidden menu
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Syntactic Analysis, Syntactic Symbols, Indentation Engine
Basics, Indentation Engine Basics
address@hidden node-name, next, previous, up
address@hidden Syntactic Analysis
address@hidden syntactic analysis
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden syntactic element
address@hidden syntactic context
+The first thing @ccmode{} does when indenting a line of code, is to
+analyze the line, determining the @dfn{syntactic context} of the
+(first) construct on that line. It's a list of @dfn{syntactic
+elements}, where each syntactic element in turn is a address@hidden
address@hidden 5.28 and earlier, a syntactic element was a dotted pair; the
+cons was the syntactic symbol and the cdr was the anchor position.
+For compatibility's sake, the parameter passed to a line-up function
+still has this dotted pair form (@pxref{Custom Line-Up}).} Here is a
+brief and typical example:
+
address@hidden
+((defun-block-intro 1959))
address@hidden example
+
address@hidden syntactic symbol
address@hidden
+The first thing inside each syntactic element is always a
address@hidden symbol}. It describes the kind of construct that was
+recognized, e.g. @code{statement}, @code{substatement},
address@hidden, @code{class-close}, etc. @xref{Syntactic Symbols},
+for a complete list of currently recognized syntactic symbols and
+their semantics. The remaining entries are various data associated
+with the recognized construct - there might be zero or more.
+
address@hidden anchor position
+Conceptually, a line of code is always indented relative to some
+position higher up in the buffer (typically the indentation of the
+previous line). That position is the @dfn{anchor position} in the
+syntactic element. If there is an entry after the syntactic symbol in
+the syntactic element list then it's either nil or that anchor position.
+
+Here is an example. Suppose we had the following code as the only thing
+in a C++ buffer @footnote{The line numbers in this and future examples
+don't actually appear in the buffer, of course!}:
+
address@hidden
+ 1: void swap( int& a, int& b )
+ 2: @{
+ 3: int tmp = a;
+ 4: a = b;
+ 5: b = tmp;
+ 6: @}
address@hidden example
+
address@hidden
+We can use @kbd{C-c C-s} (@code{c-show-syntactic-information}) to
+report what the syntactic analysis is for the current line:
+
address@hidden @asis
address@hidden @kbd{C-c C-s} (@code{c-show-syntactic-information})
address@hidden C-c C-s
address@hidden c-show-syntactic-information
address@hidden show-syntactic-information (c-)
+This command calculates the syntactic analysis of the current line and
+displays it in the minibuffer. The command also highlights the anchor
+position(s).
address@hidden table
+
+ Running this command on line 4 of this example, we'd see in the echo
address@hidden a universal argument (i.e. @kbd{C-u C-c C-s}) the
+analysis is inserted into the buffer as a comment on the current
+line.}:
+
address@hidden
+((statement 35))
address@hidden example
+
address@hidden
+and the @samp{i} of @code{int} on line 3 would be highlighted. This
+tells us that the line is a statement and it is indented relative to
+buffer position 35, the highlighted position. If you were to move
+point to line 3 and hit @kbd{C-c C-s}, you would see:
+
address@hidden
+((defun-block-intro 29))
address@hidden example
+
address@hidden
+This indicates that the @samp{int} line is the first statement in a top
+level function block, and is indented relative to buffer position 29,
+which is the brace just after the function header.
+
+Here's another example:
+
address@hidden
+ 1: int add( int val, int incr, int doit )
+ 2: @{
+ 3: if( doit )
+ 4: @{
+ 5: return( val + incr );
+ 6: @}
+ 7: return( val );
+ 8: @}
address@hidden example
+
address@hidden
+Hitting @kbd{C-c C-s} on line 4 gives us:
+
address@hidden
+((substatement-open 46))
address@hidden example
+
address@hidden substatement
address@hidden substatement block
address@hidden
+which tells us that this is a brace that @emph{opens} a substatement
+block. @footnote{A @dfn{substatement} is the line after a
+conditional statement, such as @code{if}, @code{else}, @code{while},
address@hidden, @code{switch}, etc. A @dfn{substatement
+block} is a brace block following one of these conditional statements.}
+
address@hidden comment-only line
+Syntactic contexts can contain more than one element, and syntactic
+elements need not have anchor positions. The most common example of
+this is a @dfn{comment-only line}:
+
address@hidden
+ 1: void draw_list( List<Drawables>& drawables )
+ 2: @{
+ 3: // call the virtual draw() method on each element in list
+ 4: for( int i=0; i < drawables.count(), ++i )
+ 5: @{
+ 6: drawables[i].draw();
+ 7: @}
+ 8: @}
address@hidden example
+
address@hidden
+Hitting @kbd{C-c C-s} on line 3 of this example gives:
+
address@hidden
+((comment-intro) (defun-block-intro 46))
address@hidden example
+
address@hidden
+and you can see that the syntactic context contains two syntactic
+elements. Notice that the first element, @samp{(comment-intro)}, has no
+anchor position.
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Syntactic Symbols, Indentation Calculation, Syntactic
Analysis, Indentation Engine Basics
address@hidden node-name, next, previous, up
address@hidden Syntactic Symbols
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden syntactic symbols, brief list
address@hidden c-offsets-alist
address@hidden offsets-alist (c-)
+This section is a complete list of the syntactic symbols which appear
+in the @code{c-offsets-alist} style variable, along with brief
+descriptions. The previous section (@pxref{Syntactic Analysis})
+states what syntactic symbols are and how the indentation engine uses
+them.
+
+More detailed descriptions of these symbols, together with snippets of
+source code to which they apply, appear in the examples in the
+subsections below. Note that, in the interests of brevity, the anchor
+position associated with most syntactic symbols is @emph{not}
+specified. In cases of doubt, type @kbd{C-c C-s} on a pertinent
+line---this highlights the anchor position.
+
address@hidden -open symbols
address@hidden -close symbols
address@hidden -block-intro symbols
+The syntactic symbols which indicate brace constructs follow a general
+naming convention. When a line begins with an open or close brace,
+its syntactic symbol will contain the suffix @code{-open} or
address@hidden respectively. The first line within the brace block
+construct will contain the suffix @code{-block-intro}.
+
address@hidden -intro symbols
address@hidden -cont symbols
+In constructs which can span several lines, a distinction is usually
+made between the first line that introduces the construct and the
+lines that continue it. The syntactic symbols that indicate these
+lines will contain the suffixes @code{-intro} or @code{-cont}
+respectively.
+
+The best way to understand how all this works is by looking at some
+examples. Remember that you can see the syntax of any source code
+line by using @kbd{C-c C-s}.
+
address@hidden @code
address@hidden string
+Inside a multiline string. @ref{Literal Symbols}.
address@hidden c
+Inside a multiline C style block comment. @ref{Literal Symbols}.
address@hidden defun-open
+Brace that opens a top-level function definition. @ref{Function
+Symbols}.
address@hidden defun-close
+Brace that closes a top-level function definition. @ref{Function
+Symbols}.
address@hidden defun-block-intro
+The first line in a top-level defun. @ref{Function Symbols}.
address@hidden class-open
+Brace that opens a class definition. @ref{Class Symbols}.
address@hidden class-close
+Brace that closes a class definition. @ref{Class Symbols}.
address@hidden inline-open
+Brace that opens an in-class inline method. @ref{Class Symbols}.
address@hidden inline-close
+Brace that closes an in-class inline method. @ref{Class Symbols}.
address@hidden func-decl-cont
+The region between a function definition's argument list and the
+function opening brace (excluding K&R argument declarations). In C,
+you cannot put anything but whitespace and comments in this region,
+however in C++ and Java, @code{throws} declarations and other things
+can appear here. @ref{Literal Symbols}. @c @emph{FIXME!!! Can it not
address@hidden go somewhere better?}
address@hidden knr-argdecl-intro
+First line of a K&R C argument declaration. @ref{K&R Symbols}.
address@hidden knr-argdecl
+Subsequent lines in a K&R C argument declaration. @ref{K&R Symbols}.
address@hidden topmost-intro
+The first line in a ``topmost'' definition. @ref{Function Symbols}.
address@hidden topmost-intro-cont
+Topmost definition continuation lines. This is only used in the parts
+that aren't covered by other symbols such as @code{func-decl-cont} and
address@hidden @ref{Function Symbols}.
address@hidden member-init-intro
+First line in a member initialization list. @ref{Class Symbols}.
address@hidden member-init-cont
+Subsequent member initialization list lines. @ref{Class Symbols}.
address@hidden inher-intro
+First line of a multiple inheritance list. @ref{Class Symbols}.
address@hidden inher-cont
+Subsequent multiple inheritance lines. @ref{Class Symbols}.
address@hidden block-open
+Statement block open brace. @ref{Literal Symbols}.
address@hidden block-close
+Statement block close brace. @ref{Conditional Construct Symbols}.
address@hidden brace-list-open
+Open brace of an enum or static array list. @ref{Brace List Symbols}.
address@hidden brace-list-close
+Close brace of an enum or static array list. @ref{Brace List Symbols}.
address@hidden brace-list-intro
+First line in an enum or static array list. @ref{Brace List Symbols}.
address@hidden brace-list-entry
+Subsequent lines in an enum or static array list. @ref{Brace List
+Symbols}.
address@hidden brace-entry-open
+Subsequent lines in an enum or static array list where the line begins
+with an open brace. @ref{Brace List Symbols}.
address@hidden statement
+A statement. @ref{Function Symbols}.
address@hidden statement-cont
+A continuation of a statement. @ref{Function Symbols}.
address@hidden statement-block-intro
+The first line in a new statement block. @ref{Conditional Construct
+Symbols}.
address@hidden statement-case-intro
+The first line in a case block. @ref{Switch Statement Symbols}.
address@hidden statement-case-open
+The first line in a case block that starts with a brace. @ref{Switch
+Statement Symbols}.
address@hidden substatement
+The first line after a conditional or loop construct.
address@hidden Construct Symbols}.
address@hidden substatement-open
+The brace that opens a substatement block. @ref{Conditional Construct
+Symbols}.
address@hidden substatement-label
+The first line after a conditional or loop construct if it's a label.
address@hidden Construct Symbols}.
address@hidden case-label
+A label in a @code{switch} block. @ref{Switch Statement Symbols}.
address@hidden access-label
+C++ access control label. @ref{Class Symbols}.
address@hidden label
+Any other label. @ref{Literal Symbols}.
address@hidden do-while-closure
+The @code{while} line that ends a @address@hidden construct.
address@hidden Construct Symbols}.
address@hidden else-clause
+The @code{else} line of an @address@hidden construct.
address@hidden Construct Symbols}.
address@hidden catch-clause
+The @code{catch} or @code{finally} (in Java) line of a
address@hidden@code{catch} construct. @ref{Conditional Construct
+Symbols}.
address@hidden comment-intro
+A line containing only a comment introduction. @ref{Literal Symbols}.
address@hidden arglist-intro
+The first line in an argument list. @ref{Paren List Symbols}.
address@hidden arglist-cont
+Subsequent argument list lines when no arguments follow on the same
+line as the arglist opening paren. @ref{Paren List Symbols}.
address@hidden arglist-cont-nonempty
+Subsequent argument list lines when at least one argument follows on
+the same line as the arglist opening paren. @ref{Paren List Symbols}.
address@hidden arglist-close
+The solo close paren of an argument list. @ref{Paren List Symbols}.
address@hidden stream-op
+Lines continuing a stream operator (C++ only). @ref{Literal
+Symbols}. @c @emph{FIXME!!! Can this not be moved somewhere better?}
address@hidden inclass
+The line is nested inside a class definition. @ref{Class Symbols}.
address@hidden cpp-macro
+The start of a preprocessor macro definition. @ref{Literal Symbols}.
address@hidden cpp-define-intro
+The first line inside a multiline preprocessor macro if
address@hidden is set. @ref{Multiline Macro
+Symbols}.
address@hidden cpp-macro-cont
+All lines inside multiline preprocessor macros if
address@hidden is @code{nil}.
address@hidden Macro Symbols}.
address@hidden friend
+A C++ friend declaration. @ref{Class Symbols}.
address@hidden objc-method-intro
+The first line of an Objective-C method definition. @ref{Objective-C
+Method Symbols}.
address@hidden objc-method-args-cont
+Lines continuing an Objective-C method definition. @ref{Objective-C
+Method Symbols}.
address@hidden objc-method-call-cont
+Lines continuing an Objective-C method call. @ref{Objective-C Method
+Symbols}.
address@hidden extern-lang-open
+Brace that opens an @code{extern} block (e.g. @code{extern "C"
address@hidden@}}). @ref{External Scope Symbols}.
address@hidden extern-lang-close
+Brace that closes an @code{extern} block. @ref{External Scope
+Symbols}.
address@hidden inextern-lang
+Analogous to @code{inclass} syntactic symbol, but used inside
address@hidden blocks. @ref{External Scope Symbols}.
address@hidden namespace-open
address@hidden namespace-close
address@hidden innamespace
+These are analogous to the three @code{extern-lang} symbols above, but
+are returned for C++ namespace blocks. @ref{External Scope Symbols}.
address@hidden module-open
address@hidden module-close
address@hidden inmodule
+Analogous to the above, but for CORBA IDL @code{module} blocks.
address@hidden Scope Symbols}.
address@hidden composition-open
address@hidden composition-close
address@hidden incomposition
+Analogous to the above, but for CORBA CIDL @code{composition} blocks.
address@hidden Scope Symbols}.
address@hidden template-args-cont
+C++ template argument list continuations. @ref{Class Symbols}.
address@hidden inlambda
+Analogous to @code{inclass} syntactic symbol, but used inside lambda
+(i.e. anonymous) functions. Only used in Pike mode. @ref{Statement
+Block Symbols}.
address@hidden lambda-intro-cont
+Lines continuing the header of a lambda function, i.e. between the
address@hidden keyword and the function body. Only used in Pike mode.
address@hidden Block Symbols}.
address@hidden inexpr-statement
+A statement block inside an expression. The gcc C and C++ extension
+for this is recognized. It's also used for the special functions that
+take a statement block as an argument in Pike. @ref{Statement Block
+Symbols}.
address@hidden inexpr-class
+A class definition inside an expression. This is used for anonymous
+classes in Java. It's also used for anonymous array initializers in
+Java. @ref{Anonymous Class Symbol}.
address@hidden table
+
address@hidden
+* Function Symbols::
+* Class Symbols::
+* Conditional Construct Symbols::
+* Switch Statement Symbols::
+* Brace List Symbols::
+* External Scope Symbols::
+* Paren List Symbols::
+* Literal Symbols::
+* Multiline Macro Symbols::
+* Objective-C Method Symbols::
+* Anonymous Class Symbol::
+* Statement Block Symbols::
+* K&R Symbols::
address@hidden menu
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Function Symbols, Class Symbols, Syntactic Symbols, Syntactic
Symbols
address@hidden node-name, next, previous, up
address@hidden Function Symbols
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+This example shows a typical function declaration.
+
address@hidden
+ 1: void
+ 2: swap( int& a, int& b )
+ 3: @{
+ 4: int tmp = a;
+ 5: a = b;
+ 6: b = tmp;
+ 7: int ignored =
+ 8: a + b;
+ 9: @}
address@hidden example
+
address@hidden topmost-intro
address@hidden topmost-intro-cont
address@hidden defun-open
address@hidden defun-close
address@hidden defun-block-intro
+Line 1 shows a @code{topmost-intro} since it is the first line that
+introduces a top-level construct. Line 2 is a continuation of the
+top-level construct introduction so it has the syntax
address@hidden Line 3 shows a @code{defun-open} since it is
+the brace that opens a top-level function definition. Line 9 is the
+corresponding
address@hidden since it contains the brace that closes the top-level
+function definition. Line 4 is a @code{defun-block-intro}, i.e. it is
+the first line of a brace-block, enclosed in a
+top-level function definition.
+
address@hidden statement
address@hidden statement-cont
+Lines 5, 6, and 7 are all given @code{statement} syntax since there
+isn't much special about them. Note however that line 8 is given
address@hidden syntax since it continues the statement begun
+on the previous line.
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Class Symbols, Conditional Construct Symbols, Function
Symbols, Syntactic Symbols
address@hidden node-name, next, previous, up
address@hidden Class related Symbols
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+Here's an example which illustrates some C++ class syntactic symbols:
+
address@hidden
+ 1: class Bass
+ 2: : public Guitar,
+ 3: public Amplifiable
+ 4: @{
+ 5: public:
+ 6: Bass()
+ 7: : eString( new BassString( 0.105 )),
+ 8: aString( new BassString( 0.085 )),
+ 9: dString( new BassString( 0.065 )),
+10: gString( new BassString( 0.045 ))
+11: @{
+12: eString.tune( 'E' );
+13: aString.tune( 'A' );
+14: dString.tune( 'D' );
+15: gString.tune( 'G' );
+16: @}
+17: friend class Luthier;
+18: @};
address@hidden example
+
address@hidden class-open
address@hidden class-close
+As in the previous example, line 1 has the @code{topmost-intro} syntax.
+Here however, the brace that opens a C++ class definition on line 4 is
+assigned the @code{class-open} syntax. Note that in C++, classes,
+structs, and unions are essentially equivalent syntactically (and are
+very similar semantically), so replacing the @code{class} keyword in the
+example above with @code{struct} or @code{union} would still result in a
+syntax of @code{class-open} for line 4 @footnote{This is the case even
+for C and Objective-C. For consistency, structs in all supported
+languages are syntactically equivalent to classes. Note however that
+the keyword @code{class} is meaningless in C and Objective-C.}.
+Similarly, line 18 is assigned @code{class-close} syntax.
+
address@hidden inher-intro
address@hidden inher-cont
+Line 2 introduces the inheritance list for the class so it is assigned
+the @code{inher-intro} syntax, and line 3, which continues the
+inheritance list is given @code{inher-cont} syntax.
+
address@hidden access-label
address@hidden inclass
+Hitting @kbd{C-c C-s} on line 5 shows the following analysis:
+
address@hidden
+((inclass 58) (access-label 58))
address@hidden example
+
address@hidden
+The primary syntactic symbol for this line is @code{access-label} as
+this a label keyword that specifies access protection in C++. However,
+because this line is also a top-level construct inside a class
+definition, the analysis actually shows two syntactic symbols. The
+other syntactic symbol assigned to this line is @code{inclass}.
+Similarly, line 6 is given both @code{inclass} and @code{topmost-intro}
+syntax:
+
address@hidden
+((inclass 58) (topmost-intro 60))
address@hidden example
+
address@hidden member-init-intro
address@hidden member-init-cont
+Line 7 introduces a C++ member initialization list and as such is given
address@hidden syntax. Note that in this case it is
address@hidden assigned @code{inclass} since this is not considered a
+top-level construct. Lines 8 through 10 are all assigned
address@hidden since they continue the member initialization
+list started on line 7.
+
address@hidden in-class inline methods
address@hidden inline-open
address@hidden inline-close
+Line 11's analysis is a bit more complicated:
+
address@hidden
+((inclass 58) (inline-open))
address@hidden example
+
+This line is assigned a syntax of both @code{inline-open} and
address@hidden because it opens an @dfn{in-class} C++ inline method
+definition. This is distinct from, but related to, the C++ notion of an
+inline function in that its definition occurs inside an enclosing class
+definition, which in C++ implies that the function should be inlined.
+However, if the definition of the @code{Bass} constructor appeared
+outside the class definition, the construct would be given the
address@hidden syntax, even if the keyword @code{inline} appeared
+before the method name, as in:
+
address@hidden
+ 1: class Bass
+ 2: : public Guitar,
+ 3: public Amplifiable
+ 4: @{
+ 5: public:
+ 6: Bass();
+ 7: @};
+ 8:
+ 9: inline
+10: Bass::Bass()
+11: : eString( new BassString( 0.105 )),
+12: aString( new BassString( 0.085 )),
+13: dString( new BassString( 0.065 )),
+14: gString( new BassString( 0.045 ))
+15: @{
+16: eString.tune( 'E' );
+17: aString.tune( 'A' );
+18: dString.tune( 'D' );
+19: gString.tune( 'G' );
+20: @}
address@hidden example
+
address@hidden friend
+Returning to the previous example, line 16 is given @code{inline-close}
+syntax, while line 12 is given @code{defun-block-open} syntax, and lines
+13 through 15 are all given @code{statement} syntax. Line 17 is
+interesting in that its syntactic analysis list contains three
+elements:
+
address@hidden
+((inclass 58) (topmost-intro 380) (friend))
address@hidden example
+
+The @code{friend} and @code{inline-open} syntactic symbols are
+modifiers that do not have anchor positions.
+
address@hidden template-args-cont
+Template definitions introduce yet another syntactic symbol:
+
address@hidden
+ 1: ThingManager <int,
+ 2: Framework::Callback *,
+ 3: Mutex> framework_callbacks;
address@hidden example
+
+Here, line 1 is analyzed as a @code{topmost-intro}, but lines 2 and 3
+are both analyzed as @code{template-args-cont} lines.
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Conditional Construct Symbols, Switch Statement Symbols,
Class Symbols, Syntactic Symbols
address@hidden node-name, next, previous, up
address@hidden Conditional Construct Symbols
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+Here is a (totally contrived) example which illustrates how syntax is
+assigned to various conditional constructs:
+
address@hidden
+ 1: void spam( int index )
+ 2: @{
+ 3: for( int i=0; i<index; i++ )
+ 4: @{
+ 5: if( i == 10 )
+ 6: do_something_special();
+ 7: else
+ 8: silly_label:
+ 9: do_something( i );
+10: @}
+11: do @{
+12: another_thing( i-- );
+13: @}
+14: while( i > 0 );
+15: @}
address@hidden example
+
+Only the lines that illustrate new syntactic symbols will be discussed.
+
address@hidden substatement-open
address@hidden statement-block-intro
address@hidden block-close
+Line 4 has a brace which opens a conditional's substatement block. It
+is thus assigned @code{substatement-open} syntax, and since line 5 is
+the first line in the substatement block, it is assigned
address@hidden syntax. Line 10 contains the brace
+that closes the inner substatement block, and is therefore given the
+syntax @address@hidden@code{block-open} is used only for
+``free-standing'' blocks, and is somewhat rare (@pxref{Literal
+Symbols} for an example.)}. Line 13 is treated the same way.
+
address@hidden substatement
+Lines 6 and 9 are also substatements of conditionals, but since they
+don't start blocks they are given @code{substatement} syntax
+instead of @code{substatement-open}.
+
address@hidden substatement-label
+Line 8 contains a label, which is normally given @code{label} syntax.
+This one is however a bit special since it's between a conditional and
+its substatement. It's analyzed as @code{substatement-label} to let you
+handle this rather odd case differently from normal labels.
+
address@hidden else-clause
address@hidden catch-clause
+Line 7 start with an @code{else} that matches the @code{if} statement on
+line 5. It is therefore given the @code{else-clause} syntax and is
+anchored on the matching @code{if}. The @address@hidden
+constructs in C++ and Java are treated this way too, except that
address@hidden and (in Java) @code{finally}, are marked with
address@hidden
+
address@hidden do-while-closure
+The @code{while} construct on line 14 that closes a @code{do}
+conditional is given the special syntax @code{do-while-closure} if it
+appears on a line by itself. Note that if the @code{while} appeared on
+the same line as the preceding close brace, that line would still have
address@hidden syntax.
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Switch Statement Symbols, Brace List Symbols, Conditional
Construct Symbols, Syntactic Symbols
address@hidden node-name, next, previous, up
address@hidden Switch Statement Symbols
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+Switch statements have their own set of syntactic symbols. Here's an
+example:
+
address@hidden
+ 1: void spam( enum Ingredient i )
+ 2: @{
+ 3: switch( i ) @{
+ 4: case Ham:
+ 5: be_a_pig();
+ 6: break;
+ 7: case Salt:
+ 8: drink_some_water();
+ 9: break;
+10: default:
+11: @{
+12: what_is_it();
+13: break;
+14: @}
+15: @}
+14: @}
address@hidden example
+
address@hidden case-label
address@hidden statement-case-intro
address@hidden statement-case-open
+Here, lines 4, 7, and 10 are all assigned @code{case-label} syntax,
+while lines 5 and 8 are assigned @code{statement-case-intro}. Line 11
+is treated slightly differently since it contains a brace that opens a
+block --- it is given @code{statement-case-open} syntax.
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Brace List Symbols, External Scope Symbols, Switch Statement
Symbols, Syntactic Symbols
address@hidden node-name, next, previous, up
address@hidden Brace List Symbols
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden brace lists
+There are a set of syntactic symbols that are used to recognize
+constructs inside of brace lists. A brace list is defined as an
address@hidden or aggregate initializer list, such as might statically
+initialize an array of structs. The three special aggregate constructs
+in Pike, @code{(@{ @})}, @code{([ ])} and @code{(< >)}, are treated as
+brace lists too. An example:
+
address@hidden
+ 1: static char* ingredients[] =
+ 2: @{
+ 3: "Ham",
+ 4: "Salt",
+ 5: NULL
+ 6: @};
address@hidden example
+
address@hidden brace-list-open
address@hidden brace-list-intro
address@hidden brace-list-close
address@hidden brace-list-entry
+Following convention, line 2 in this example is assigned
address@hidden syntax, and line 3 is assigned
address@hidden syntax. Likewise, line 6 is assigned
address@hidden syntax. Lines 4 and 5 however, are assigned
address@hidden syntax, as would all subsequent lines in this
+initializer list.
+
address@hidden brace-entry-open
+Your static initializer might be initializing nested structures, for
+example:
+
address@hidden
+ 1: struct intpairs[] =
+ 2: @{
+ 3: @{ 1, 2 @},
+ 4: @{
+ 5: 3,
+ 6: 4
+ 7: @}
+ 8: @{ 1,
+ 9: 2 @},
+10: @{ 3, 4 @}
+11: @};
address@hidden example
+
+Here, you've already seen the analysis of lines 1, 2, 3, and 11. On
+line 4, things get interesting; this line is assigned
address@hidden syntactic symbol because it's a bracelist entry
+line that starts with an open brace. Lines 5 and 6 (and line 9) are
+pretty standard, and line 7 is a @code{brace-list-close} as you'd
+expect. Once again, line 8 is assigned as @code{brace-entry-open} as is
+line 10.
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden External Scope Symbols, Paren List Symbols, Brace List
Symbols, Syntactic Symbols
address@hidden node-name, next, previous, up
address@hidden External Scope Symbols
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+External language definition blocks also have their own syntactic
+symbols. In this example:
+
address@hidden
+ 1: extern "C"
+ 2: @{
+ 3: int thing_one( int );
+ 4: int thing_two( double );
+ 5: @}
address@hidden example
+
address@hidden extern-lang-open
address@hidden extern-lang-close
address@hidden inextern-lang
address@hidden inclass
address@hidden
+line 2 is given the @code{extern-lang-open} syntax, while line 5 is given
+the @code{extern-lang-close} syntax. The analysis for line 3 yields:
+
address@hidden
+((inextern-lang) (topmost-intro 14))
address@hidden example
+
address@hidden
+where @code{inextern-lang} is a modifier similar in purpose to
address@hidden
+
+There are various other top level blocks like @code{extern}, and they
+are all treated in the same way except that the symbols are named after
+the keyword that introduces the block. E.g. C++ namespace blocks get
+the three symbols @code{namespace-open}, @code{namespace-close} and
address@hidden The currently recognized top level blocks are:
+
address@hidden @asis
address@hidden @code{extern-lang-open}, @code{extern-lang-close},
@code{inextern-lang}
address@hidden blocks in C and address@hidden should logically be
+named @code{extern-open}, @code{extern-close} and @code{inextern}, but
+that isn't the case for historical reasons.}
+
address@hidden @code{namespace-open}, @code{namespace-close}, @code{innamespace}
address@hidden namespace-open
address@hidden namespace-close
address@hidden innamespace
address@hidden blocks in C++.
+
address@hidden @code{module-open}, @code{module-close}, @code{inmodule}
address@hidden module-open
address@hidden module-close
address@hidden inmodule
address@hidden blocks in CORBA IDL.
+
address@hidden @code{composition-open}, @code{composition-close},
@code{incomposition}
address@hidden composition-open
address@hidden composition-close
address@hidden incomposition
address@hidden blocks in CORBA CIDL.
address@hidden table
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Paren List Symbols, Literal Symbols, External Scope Symbols,
Syntactic Symbols
address@hidden node-name, next, previous, up
address@hidden Parenthesis (Argument) List Symbols
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+A number of syntactic symbols are associated with parenthesis lists,
+a.k.a argument lists, as found in function declarations and function
+calls. This example illustrates these:
+
address@hidden
+ 1: void a_function( int line1,
+ 2: int line2 );
+ 3:
+ 4: void a_longer_function(
+ 5: int line1,
+ 6: int line2
+ 7: );
+ 8:
+ 9: void call_them( int line1, int line2 )
+10: @{
+11: a_function(
+12: line1,
+13: line2
+14: );
+15:
+16: a_longer_function( line1,
+17: line2 );
+18: @}
address@hidden example
+
address@hidden arglist-intro
address@hidden arglist-close
+Lines 5 and 12 are assigned @code{arglist-intro} syntax since they are
+the first line following the open parenthesis, and lines 7 and 14 are
+assigned @code{arglist-close} syntax since they contain the parenthesis
+that closes the argument list.
+
address@hidden arglist-cont-nonempty
address@hidden arglist-cont
+Lines that continue argument lists can be assigned one of two syntactic
+symbols. For example, Lines 2 and 17
+are assigned @code{arglist-cont-nonempty} syntax. What this means
+is that they continue an argument list, but that the line containing the
+parenthesis that opens the list is @emph{not empty} following the open
+parenthesis. Contrast this against lines 6 and 13 which are assigned
address@hidden syntax. This is because the parenthesis that opens
+their argument lists is the last character on that line.
+
+Syntactic elements with @code{arglist-intro},
address@hidden, and @code{arglist-close} contain two
+buffer positions: the anchor position (the beginning of the
+declaration or statement) and the position of the open parenthesis.
+The latter position can be used in a line-up function (@pxref{Line-Up
+Functions}).
+
+Note that there is no @code{arglist-open} syntax. This is because any
+parenthesis that opens an argument list, appearing on a separate line,
+is assigned the @code{statement-cont} syntax instead.
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Literal Symbols, Multiline Macro Symbols, Paren List Symbols,
Syntactic Symbols
address@hidden node-name, next, previous, up
address@hidden Comment String Label and Macro Symbols
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+A few miscellaneous syntactic symbols that haven't been previously
+covered are illustrated by this C++ example:
+
address@hidden
+ 1: void Bass::play( int volume )
+ 2: const
+ 3: @{
+ 4: /* this line starts a multiline
+ 5: * comment. This line should get `c' syntax */
+ 6:
+ 7: char* a_multiline_string = "This line starts a multiline \
+ 8: string. This line should get `string' syntax.";
+ 9:
+10: note:
+11: @{
+12: #ifdef LOCK
+13: Lock acquire();
+14: #endif // LOCK
+15: slap_pop();
+16: cout << "I played "
+17: << "a note\n";
+18: @}
+19: @}
address@hidden example
+
+The lines to note in this example include:
+
address@hidden @bullet
address@hidden
address@hidden func-decl-cont
+Line 2 is assigned the @code{func-decl-cont} syntax.
+
address@hidden
address@hidden comment-intro
+Line 4 is assigned both @code{defun-block-intro} @emph{and}
address@hidden syntax. A syntactic element with
address@hidden has no anchor point --- It is always accompanied
+by another syntactic element which does have one.
+
address@hidden
address@hidden c
+Line 5 is assigned @code{c} syntax.
+
address@hidden
address@hidden syntactic whitespace
+Line 6 which, even though it contains nothing but whitespace, is
+assigned @code{defun-block-intro}. Note that the appearance of the
+comment on lines 4 and 5 do not cause line 6 to be assigned
address@hidden syntax because comments are considered to be
address@hidden whitespace}, which are ignored when analyzing
+code.
+
address@hidden
address@hidden string
+Line 8 is assigned @code{string} syntax.
+
address@hidden
address@hidden label
+Line 10 is assigned @code{label} syntax.
+
address@hidden
address@hidden block-open
+Line 11 is assigned @code{block-open} as well as @code{statement}
+syntax. A @code{block-open} syntactic element doesn't have an anchor
+position, since it always appears with another syntactic element which
+does have one.
+
address@hidden
address@hidden cpp-macro
+Lines 12 and 14 are assigned @code{cpp-macro} syntax in addition to the
+normal syntactic symbols (@code{statement-block-intro} and
address@hidden, respectively). Normally @code{cpp-macro} is
+configured to cancel out the normal syntactic context to make all
+preprocessor directives stick to the first column, but that's easily
+changed if you want preprocessor directives to be indented like the rest
+of the code. Like @code{comment-intro}, a syntactic element with
address@hidden doesn't contain an anchor position.
+
address@hidden
address@hidden stream-op
+Line 17 is assigned @code{stream-op} syntax.
address@hidden itemize
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Multiline Macro Symbols, Objective-C Method Symbols, Literal
Symbols, Syntactic Symbols
address@hidden node-name, next, previous, up
address@hidden Multiline Macro Symbols
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden multiline macros
address@hidden syntactic whitespace
address@hidden cpp-define-intro
address@hidden cpp-macro-cont
+Multiline preprocessor macro definitions are normally handled just like
+other code, i.e. the lines inside them are indented according to the
+syntactic analysis of the preceding lines inside the macro. The first
+line inside a macro definition (i.e. the line after the starting line of
+the cpp directive itself) gets @code{cpp-define-intro}. In this example:
+
address@hidden
+ 1: #define LIST_LOOP(cons, listp) \
+ 2: for (cons = listp; !NILP (cons); cons = XCDR (cons)) \
+ 3: if (!CONSP (cons)) \
+ 4: signal_error ("Invalid list format", listp); \
+ 5: else
address@hidden example
+
address@hidden
+line 1 is given the syntactic symbol @code{cpp-macro}. The first line
+of a cpp directive is always given that symbol. Line 2 is given
address@hidden, so that you can give the macro body as a whole
+some extra indentation. Lines 3 through 5 are then analyzed as normal
+code, i.e. @code{substatement} on lines 3 and 4, and @code{else-clause}
+on line 5.
+
+The syntactic analysis inside macros can be turned off with
address@hidden (@pxref{Custom Macros}). In
+that case, lines 2 through 5 would all be given @code{cpp-macro-cont}
+with an anchor position pointing to the @code{#} which starts the cpp
address@hidden is how @ccmode{} 5.28 and earlier analyzed
+macros.}.
+
address@hidden Macros}, for more info about the treatment of macros.
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Objective-C Method Symbols, Anonymous Class Symbol, Multiline
Macro Symbols, Syntactic Symbols
address@hidden node-name, next, previous, up
address@hidden Objective-C Method Symbols
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+In Objective-C buffers, there are three additional syntactic symbols
+assigned to various message calling constructs. Here's an example
+illustrating these:
+
address@hidden
+ 1: - (void)setDelegate:anObject
+ 2: withStuff:stuff
+ 3: @{
+ 4: [delegate masterWillRebind:self
+ 5: toDelegate:anObject
+ 6: withExtraStuff:stuff];
+ 7: @}
address@hidden example
+
address@hidden objc-method-intro
address@hidden objc-method-args-cont
address@hidden objc-method-call-cont
+Here, line 1 is assigned @code{objc-method-intro} syntax, and line 2 is
+assigned @code{objc-method-args-cont} syntax. Lines 5 and 6 are both
+assigned @code{objc-method-call-cont} syntax.
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Anonymous Class Symbol, Statement Block Symbols, Objective-C
Method Symbols, Syntactic Symbols
address@hidden node-name, next, previous, up
address@hidden Anonymous Class Symbol (Java)
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+Java has a concept of anonymous classes which can look something like
+this:
+
address@hidden
+ 1: public void watch(Observable o) @{
+ 2: o.addObserver(new Observer() @{
+ 3: public void update(Observable o, Object arg) @{
+ 4: history.addElement(arg);
+ 5: @}
+ 6: @});
+ 7: @}
address@hidden example
+
address@hidden inexpr-class
+The brace following the @code{new} operator opens the anonymous class.
+Lines 3 and 6 are assigned the @code{inexpr-class} syntax, besides the
address@hidden symbol used in normal classes. Thus, the class will be
+indented just like a normal class, with the added indentation given to
address@hidden An @code{inexpr-class} syntactic element doesn't
+have an anchor position.
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Statement Block Symbols, K&R Symbols, Anonymous Class Symbol,
Syntactic Symbols
address@hidden node-name, next, previous, up
address@hidden Statement Block Symbols
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+There are a few occasions where a statement block might be used inside
+an expression. One is in C or C++ code using the gcc extension for
+this, e.g:
+
address@hidden
+ 1: int res = (@{
+ 2: int y = foo (); int z;
+ 3: if (y > 0) z = y; else z = - y;
+ 4: z;
+ 5: @});
address@hidden example
+
address@hidden inexpr-statement
+Lines 2 and 5 get the @code{inexpr-statement} syntax, besides the
+symbols they'd get in a normal block. Therefore, the indentation put on
address@hidden is added to the normal statement block
+indentation. An @code{inexpr-statement} syntactic element doesn't
+contain an anchor position.
+
+In Pike code, there are a few other situations where blocks occur inside
+statements, as illustrated here:
+
address@hidden
+ 1: array itgob()
+ 2: @{
+ 3: string s = map (backtrace()[-2][3..],
+ 4: lambda
+ 5: (mixed arg)
+ 6: @{
+ 7: return sprintf ("%t", arg);
+ 8: @}) * ", " + "\n";
+ 9: return catch @{
+10: write (s + "\n");
+11: @};
+12: @}
address@hidden example
+
address@hidden inlambda
address@hidden lambda-intro-cont
+Lines 4 through 8 contain a lambda function, which @ccmode{} recognizes
+by the @code{lambda} keyword. If the function argument list is put
+on a line of its own, as in line 5, it gets the @code{lambda-intro-cont}
+syntax. The function body is handled as an inline method body, with the
+addition of the @code{inlambda} syntactic symbol. This means that line
+6 gets @code{inlambda} and @code{inline-open}, and line 8 gets
address@hidden@footnote{You might wonder why it doesn't get
address@hidden too. It's because the closing brace is relative to the
+opening brace, which stands on its own line in this example. If the
+opening brace was hanging on the previous line, then the closing brace
+would get the @code{inlambda} syntax too to be indented correctly.}.
+
address@hidden inexpr-statement
+On line 9, @code{catch} is a special function taking a statement block
+as its argument. The block is handled as an in-expression statement
+with the @code{inexpr-statement} syntax, just like the gcc extended C
+example above. The other similar special function, @code{gauge}, is
+handled like this too.
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden K&R Symbols, , Statement Block Symbols, Syntactic Symbols
address@hidden node-name, next, previous, up
address@hidden K&R Symbols
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden knr-argdecl-intro
address@hidden knr-argdecl
+Two other syntactic symbols can appear in old style, non-prototyped C
+code @footnote{a.k.a. K&R C, or Kernighan & Ritchie C}:
+
address@hidden
+ 1: int add_three_integers(a, b, c)
+ 2: int a;
+ 3: int b;
+ 4: int c;
+ 5: @{
+ 6: return a + b + c;
+ 7: @}
address@hidden example
+
+Here, line 2 is the first line in an argument declaration list and so is
+given the @code{knr-argdecl-intro} syntactic symbol. Subsequent lines
+(i.e. lines 3 and 4 in this example), are given @code{knr-argdecl}
+syntax.
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Indentation Calculation, , Syntactic Symbols, Indentation
Engine Basics
address@hidden node-name, next, previous, up
address@hidden Indentation Calculation
address@hidden indentation
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+Indentation for a line is calculated from the syntactic context
+(@pxref{Syntactic Analysis}).
+
+First, a buffer position is found whose column will be the base for the
+indentation calculation. It's the anchor position in the first
+syntactic element that provides one that is used. If no syntactic
+element has an anchor position then column zero is used.
+
+Second, the syntactic symbols in each syntactic element are looked up
+in the @code{c-offsets-alist} style variable
+(@pxref{c-offsets-alist}), which is an association list of syntactic
+symbols and the offsets to apply for those symbols. These offsets are
+added together with the base column to produce the new indentation
+column.
+
+Let's use our two code examples above to see how this works. Here is
+our first example again:
+
address@hidden
+ 1: void swap( int& a, int& b )
+ 2: @{
+ 3: int tmp = a;
+ 4: a = b;
+ 5: b = tmp;
+ 6: @}
address@hidden example
+
+Let's say point is on line 3 and we hit the @key{TAB} key to reindent
+the line. The syntactic context for that line is:
+
address@hidden
+((defun-block-intro 29))
address@hidden example
+
address@hidden
+Since buffer position 29 is the first and only anchor position in the
+list, @ccmode{} goes there and asks for the current column. This brace
+is in column zero, so @ccmode{} uses @samp{0} as the base column.
+
+Next, @ccmode{} looks up @code{defun-block-intro} in the
address@hidden style variable. Let's say it finds the value
address@hidden; it adds this to the base column @samp{0}, yielding a running
+total indentation of 4 spaces.
+
+Since there is only one syntactic element on the list for this line,
+indentation calculation is complete, and the total indentation for the
+line is 4 spaces.
+
+Here's another example:
+
address@hidden
+ 1: int add( int val, int incr, int doit )
+ 2: @{
+ 3: if( doit )
+ 4: @{
+ 5: return( val + incr );
+ 6: @}
+ 7: return( val );
+ 8: @}
address@hidden example
+
+If we were to hit @kbd{TAB} on line 4 in the above example, the same
+basic process is performed, despite the differences in the syntactic
+context. The context for this line is:
+
address@hidden
+((substatement-open 46))
address@hidden example
+
+Here, @ccmode{} goes to buffer position 46, which is the @samp{i} in
address@hidden on line 3. This character is in the fourth column on that
+line so the base column is @samp{4}. Then @ccmode{} looks up the
address@hidden symbol in @code{c-offsets-alist}. Let's say it
+finds the value @samp{4}. It's added with the base column and yields an
+indentation for the line of 8 spaces.
+
+Simple, huh?
+
+Actually, it's a bit more complicated than that since the entries on
address@hidden can be much more than plain offsets.
address@hidden, for the full story.
+
+Anyway, the mode usually just does The Right Thing without you having to
+think about it in this much detail. But when customizing indentation,
+it's helpful to understand the general indentation model being used.
+
+As you configure @ccmode{}, you might want to set the variable
address@hidden to address@hidden so that the
+syntactic context and calculated offset always is echoed in the
+minibuffer when you hit @kbd{TAB}.
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Customizing Indentation, Custom Macros, Indentation Engine
Basics, Top
address@hidden node-name, next, previous, up
address@hidden Customizing Indentation
address@hidden customization, indentation
address@hidden indentation
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+The principal variable for customizing indentation is the style
+variable @code{c-offsets-alist}, which gives an @dfn{offset} (an
+indentation rule) for each syntactic symbol. Its structure and
+semantics are completely described in @ref{c-offsets-alist}. The
+various ways you can set the variable, including the use of the
address@hidden style system, are described in @ref{Config Basics} and its
+sections, in particular @ref{Style Variables}.
+
+The simplest and most used kind of ``offset'' setting in
address@hidden is in terms of multiples of
address@hidden:
+
address@hidden c-basic-offset
address@hidden basic-offset (c-)
+This style variable holds the basic offset between indentation levels.
+It's factory default is 4, but all the built-in styles set it
+themselves, to some value between 2 (for @code{gnu} style) and 8 (for
address@hidden, @code{linux}, and @code{python} styles).
address@hidden defopt
+
+The most flexible ``offset'' setting you can make in
address@hidden is a line-up function (or even a list of them),
+either one supplied by @ccmode{} (@pxref{Line-Up Functions}) or one
+you write yourself (@pxref{Custom Line-Up}).
+
+Finally, in @ref{Other Indentation} you'll find the tool of last
+resort: a hook which is called after a line has been indented. You
+can install functions here to make ad-hoc adjustments to any line's
+indentation.
+
address@hidden
+* c-offsets-alist::
+* Interactive Customization::
+* Line-Up Functions::
+* Custom Line-Up::
+* Other Indentation::
address@hidden menu
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden c-offsets-alist, Interactive Customization, Customizing
Indentation, Customizing Indentation
address@hidden node-name, next, previous, up
address@hidden c-offsets-alist
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+This section explains the structure and semantics of the style
+variable @code{c-offset-alist}, the principal variable for configuring
+indentation. Details of how to set it up, and its relationship to
address@hidden's style system are given in @ref{Style Variables}.
+
address@hidden c-offsets-alist
address@hidden offsets-alist (c-)
+This is an alist which associates an offset with each syntactic
+symbol. This @dfn{offset} is a rule specifying how to indent a line
+whose syntactic context matches the symbol. @xref{Syntactic
+Analysis}.
+
+Note that the buffer-local binding of this alist in a @ccmode{} buffer
+contains an entry for @emph{every} syntactic symbol. Its global
+binding and its settings within style specifications usually contain
+only a few entries. @xref{Style Variables}.
+
+The offset specification associated with any particular syntactic
+symbol can be an integer, a variable name, a vector, a function or
+lambda expression, a list, or one of the following special symbols:
address@hidden, @code{-}, @code{++}, @code{--}, @code{*}, or @code{/}. The
+meanings of these values are described in detail below.
+
+Here is an example fragment of a @code{c-offsets-alist}, showing some
+of these kinds of offsets:
+
address@hidden
+((statement . 0)
+ (substatement . +)
+ (cpp-macro . [0])
+ (topmost-intro-cont . c-lineup-topmost-intro-cont)
+ (statement-block-intro . (add c-lineup-whitesmith-in-block
+ c-indent-multi-line-block))
+ @dots{}
address@hidden)
address@hidden example
address@hidden defopt
+
address@hidden Command c-set-offset (@kbd{C-c C-o})
address@hidden set-offset (c-)
address@hidden C-c C-o
+This command changes the entry for a syntactic symbol in the current
+binding of @code{c-offsets-alist}, or it inserts a new entry if there
+isn't already one for that syntactic symbol.
+
+You can use @code{c-set-offsets} interactively within a @ccmode{}
+buffer to make experimental changes to your indentation settings.
address@hidden C-o} prompts you for the syntactic symbol to change
+(defaulting to that of the current line) and the new offset
+(defaulting to the current offset).
+
address@hidden takes two arguments when used programmatically:
address@hidden, the syntactic element symbol to change and @var{offset},
+the new offset for that syntactic element. You can call the command
+in your @file{.emacs} to change the global binding of
address@hidden (@pxref{Style Variables}); you can use it in a
+hook function to make changes from the current style. @ccmode{}
+itself uses this function when initializing styles.
address@hidden deffn
+
address@hidden offset specification
+The ``offset specifications'' in @code{c-offsets-alist} can be any of
+the following:
+
address@hidden @asis
address@hidden An integer
+The integer specifies a relative offset. All relative
address@hidden syntactic context @address@hidden((defun-block-intro
+2724) (comment-intro))}} would likely have two relative offsets.} will
+be added together and used to calculate the indentation relative to an
+anchor position earlier in the buffer. @xref{Indentation
+Calculation}, for details. Most of the time, it's probably better to
+use one of the special symbols like @code{+} than an integer (apart
+from zero).
+
address@hidden One of the symbols @code{+}, @code{-}, @code{++}, @code{--},
@code{*}, or @code{/}
+These special symbols describe a relative offset in multiples of
address@hidden:
+
+By defining a style's indentation in terms of @code{c-basic-offset},
+you can change the amount of whitespace given to an indentation level
+while maintaining the same basic shape of your code. Here are the
+values that the special symbols correspond to:
+
address@hidden @code
address@hidden +
address@hidden times 1
address@hidden -
address@hidden times -1
address@hidden ++
address@hidden times 2
address@hidden --
address@hidden times -2
address@hidden *
address@hidden times 0.5
address@hidden /
address@hidden times -0.5
address@hidden table
+
address@hidden A vector
+The first element of the vector, an integer, sets the absolute
+indentation column. This will override any previously calculated
+indentation, but won't override relative indentation calculated from
+syntactic elements later on in the syntactic context of the line being
+indented. @xref{Indentation Calculation}. Any elements in the vector
+beyond the first will be ignored.
+
address@hidden A function or lambda expression
+The function will be called and its return value will in turn be
+evaluated as an offset specification. Functions are useful when more
+context than just the syntactic symbol is needed to get the desired
+indentation. @xref{Line-Up Functions}, and @ref{Custom Line-Up}, for
+details about them.
+
address@hidden A symbol with a variable binding
+If the symbol also has a function binding, the function takes
+precedence over the variable. Otherwise the value of the variable is
+used. It must be an integer (which is used as relative offset) or a
+vector (an absolute offset).
+
address@hidden A list
+The offset can also be a list containing several offset
+specifications; these are evaluated recursively and combined. A list
+is typically only useful when some of the offsets are line-up
+functions. A common strategy is calling a sequence of functions in
+turn until one of them recognizes that it is appropriate for the
+source line and returns a address@hidden value.
+
address@hidden values are always ignored when the offsets are combined.
+The first element of the list specifies the method of combining the
address@hidden offsets from the remaining elements:
+
address@hidden @code
address@hidden first
+Use the first offset that doesn't evaluate to @code{nil}. Subsequent
+elements of the list don't get evaluated.
address@hidden min
+Use the minimum of all the offsets. All must be either relative or
+absolute - they can't be mixed.
address@hidden max
+Use the maximum of all the offsets. All must be either relative or
+absolute - they can't be mixed.
address@hidden add
+Add all the evaluated offsets together. Exactly one of them may be
+absolute, in which case the result is absolute. Any relative offsets
+that preceded the absolute one in the list will be ignored in that case.
address@hidden table
+
+As a compatibility measure, if the first element is none of the above
+then it too will be taken as an offset specification and the whole list
+will be combined according to the method @code{first}.
address@hidden table
+
address@hidden c-strict-syntax-p
address@hidden strict-syntax-p (c-)
+If an offset specification evaluates to @code{nil}, then a relative
+offset of 0 (zero) is address@hidden is however a variable
address@hidden that when set to address@hidden will cause an
+error to be signaled in that case. It's now considered obsolete since
+it doesn't work well with some of the alignment functions that return
address@hidden instead of zero. You should therefore leave
address@hidden set to @code{nil}.}.
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Interactive Customization, Line-Up Functions,
c-offsets-alist, Customizing Indentation
address@hidden node-name, next, previous, up
address@hidden Interactive Customization
address@hidden customization, interactive
address@hidden interactive customization
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+As an example of how to customize indentation, let's change the
+style of this address@hidden this and subsequent examples, the
+original code is formatted using the @samp{gnu} style unless otherwise
+indicated. @xref{Styles}.}:
+
address@hidden
address@hidden
+ 1: int add( int val, int incr, int doit )
+ 2: @{
+ 3: if( doit )
+ 4: @{
+ 5: return( val + incr );
+ 6: @}
+ 7: return( val );
+ 8: @}
address@hidden group
address@hidden example
+
address@hidden
+to:
+
address@hidden
address@hidden
+ 1: int add( int val, int incr, int doit )
+ 2: @{
+ 3: if( doit )
+ 4: @{
+ 5: return( val + incr );
+ 6: @}
+ 7: return( val );
+ 8: @}
address@hidden group
address@hidden example
+
+In other words, we want to change the indentation of braces that open a
+block following a condition so that the braces line up under the
+conditional, instead of being indented. Notice that the construct we
+want to change starts on line 4. To change the indentation of a line,
+we need to see which syntactic symbols affect the offset calculations
+for that line. Hitting @kbd{C-c C-s} on line 4 yields:
+
address@hidden
+((substatement-open 44))
address@hidden example
+
address@hidden
+so we know that to change the offset of the open brace, we need to
+change the indentation for the @code{substatement-open} syntactic
+symbol.
+
+To do this interactively, just hit @kbd{C-c C-o}. This prompts
+you for the syntactic symbol to change, providing a reasonable default.
+In this case, the default is @code{substatement-open}, which is just the
+syntactic symbol we want to change!
+
+After you hit return, @ccmode{} will then prompt you for the new
+offset value, with the old value as the default. The default in this
+case is @samp{+}, but we want no extra indentation so enter
address@hidden and @kbd{RET}. This will associate the offset 0 with the
+syntactic symbol @code{substatement-open}.
+
+To check your changes quickly, just hit @kbd{C-c C-q}
+(@code{c-indent-defun}) to reindent the entire function. The example
+should now look like:
+
address@hidden
address@hidden
+ 1: int add( int val, int incr, int doit )
+ 2: @{
+ 3: if( doit )
+ 4: @{
+ 5: return( val + incr );
+ 6: @}
+ 7: return( val );
+ 8: @}
address@hidden group
address@hidden example
+
+Notice how just changing the open brace offset on line 4 is all we
+needed to do. Since the other affected lines are indented relative to
+line 4, they are automatically indented the way you'd expect. For more
+complicated examples, this might not always work. The general approach
+to take is to always start adjusting offsets for lines higher up in the
+file, then reindent and see if any following lines need further
+adjustments.
+
address@hidden Move this bit to "Styles" (2005/10/7)
address@hidden Command c-set-offset symbol offset
address@hidden set-offset (c-)
address@hidden C-c C-o
+This is the command bound to @kbd{C-c C-o}. It provides a convenient
+way to set offsets on @code{c-offsets-alist} both interactively (see
+the example above) and from your mode hook.
+
+It takes two arguments when used programmatically: @var{symbol} is the
+syntactic element symbol to change and @var{offset} is the new offset
+for that syntactic element.
address@hidden deffn
address@hidden End of MOVE THIS BIT.
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Line-Up Functions, Custom Line-Up, Interactive Customization,
Customizing Indentation
address@hidden node-name, next, previous, up
address@hidden Line-Up Functions
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden line-up function
address@hidden indentation function
+Often there are cases when a simple offset setting on a syntactic
+symbol isn't enough to get the desired indentation---for example, you
+might want to line up a closing parenthesis with the matching opening
+one rather than indenting relative to its ``anchor point''. @ccmode{}
+provides this flexibility with @dfn{line-up functions}.
+
+The way you associate a line-up function with a syntactic symbol is
+described in @ref{c-offsets-alist}. @ccmode{} comes with many
+predefined line-up functions for common situations. If none of these
+does what you want, you can write your own. @xref{Custom Line-Up}.
+Sometimes, it is easier to tweak the standard indentation by adding a
+function to @code{c-special-indent-hook} (@pxref{Other Indentation}).
+
+The line-up functions haven't been adapted for AWK buffers or tested
+with them. Some of them might work serendipitously. There shouldn't be
+any problems writing custom line-up functions for AWK mode.
+
+The calling convention for line-up functions is described fully in
address@hidden Line-Up}. Roughly speaking, the return value is either an
+offset itself (such as @code{+} or @code{[0]}) or it's @code{nil},
+meaning ``this function is inappropriate in this case - try a
+different one''. @xref{c-offsets-alist}.
+
+The subsections below describe all the standard line-up functions,
+categorized by the sort of token the lining-up centers around. For
+each of these functions there is a ``works with'' list that indicates
+which syntactic symbols the function is intended to be used with.
+
address@hidden workswith
address@hidden with:@ }
address@hidden macro
address@hidden
address@hidden workswith
address@hidden workswith
+Works with:
address@hidden macro
address@hidden ifinfo
+
address@hidden sssTBasicOffset
+<--> @address@hidden
address@hidden macro
+
address@hidden sssTsssTBasicOffset
+<--><--> @address@hidden
address@hidden macro
+
address@hidden hereFn{func}
+<- @address@hidden
address@hidden macro
+
address@hidden The TeX backend seems to insert extra spaces around the
argument. :P
address@hidden
address@hidden hereFn
address@hidden hereFn{func}
+<address@hidden@c
address@hidden macro
address@hidden iftex
+
address@hidden
+* Brace/Paren Line-Up::
+* List Line-Up::
+* Operator Line-Up::
+* Comment Line-Up::
+* Misc Line-Up::
address@hidden menu
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Brace/Paren Line-Up, List Line-Up, Line-Up Functions, Line-Up
Functions
address@hidden node-name, next, previous, up
address@hidden Brace and Parenthesis Line-Up Functions
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+The line-up functions here calculate the indentation for braces,
+parentheses and statements within brace blocks.
+
address@hidden c-lineup-close-paren
address@hidden lineup-close-paren (c-)
+Line up the closing paren under its corresponding open paren if the
+open paren is followed by code. If the open paren ends its line, no
+indentation is added. E.g:
+
address@hidden
address@hidden
+main (int,
+ char **
+ ) @hereFn{c-lineup-close-paren}
address@hidden group
address@hidden example
+
address@hidden
+and
+
address@hidden
address@hidden
+main (
+ int, char **
+) @hereFn{c-lineup-close-paren}
address@hidden group
address@hidden example
+
+As a special case, if a brace block is opened at the same line as the
+open parenthesis of the argument list, the indentation is
address@hidden instead of the open paren column. See
address@hidden for further discussion of this ``DWIM'' measure.
+
address@hidden All @code{*-close} symbols.
address@hidden defun
+
address@hidden ------------------------------------------------------------
+
address@hidden
address@hidden c-lineup-arglist-close-under-paren
address@hidden lineup-arglist-close-under-paren (c-)
+Set your @code{arglist-close} syntactic symbol to this line-up function
+so that parentheses that close argument lists will line up under the
+parenthesis that opened the argument list. It can also be used with
address@hidden and @code{arglist-cont-nonempty} to line up all
+lines inside a parenthesis under the open paren.
+
+As a special case, if a brace block is opened at the same line as the
+open parenthesis of the argument list, the indentation is
address@hidden only. See @code{c-lineup-arglist} for further
+discussion of this ``DWIM'' measure.
+
address@hidden Almost all symbols, but are typically most useful on
address@hidden, @code{brace-list-close}, @code{arglist-cont} and
address@hidden
address@hidden defun
+
address@hidden ------------------------------------------------------------
+
address@hidden c-indent-one-line-block
address@hidden indent-one-line-block (c-)
+Indent a one line block @code{c-basic-offset} extra. E.g:
+
address@hidden
address@hidden
+if (n > 0)
+ @{m+=n; n=0;@} @hereFn{c-indent-one-line-block}
address@hidden
address@hidden group
address@hidden example
+
address@hidden
+and
+
address@hidden
address@hidden
+if (n > 0)
address@hidden @hereFn{c-indent-one-line-block}
+ m+=n; n=0;
address@hidden
address@hidden group
address@hidden example
+
+The block may be surrounded by any kind of parenthesis characters.
address@hidden is returned if the line doesn't start with a one line block,
+which makes the function usable in list expressions.
+
address@hidden Almost all syntactic symbols, but most useful on the
address@hidden symbols.
address@hidden defun
+
address@hidden ------------------------------------------------------------
+
address@hidden c-indent-multi-line-block
address@hidden indent-multi-line-block (c-)
+Indent a multiline block @code{c-basic-offset} extra. E.g:
+
address@hidden
address@hidden
+int *foo[] = @{
+ NULL,
+ @address@hidden, @hereFn{c-indent-multi-line-block}
address@hidden group
address@hidden example
+
address@hidden
+and
+
address@hidden
address@hidden
+int *foo[] = @{
+ NULL,
+ @{ @hereFn{c-indent-multi-line-block}
+ 17
+ @},
+ @sssTBasicOffset{}
address@hidden group
address@hidden example
+
+The block may be surrounded by any kind of parenthesis characters.
address@hidden is returned if the line doesn't start with a multiline
+block, which makes the function usable in list expressions.
+
address@hidden Almost all syntactic symbols, but most useful on the
address@hidden symbols.
address@hidden defun
+
address@hidden ------------------------------------------------------------
+
address@hidden c-lineup-runin-statements
address@hidden lineup-runin-statements (c-)
+Line up statements for coding standards which place the first statement
+in a block on the same line as the block opening address@hidden
+style doesn't really work too well. You might need to write your own
+custom line-up functions to better support this style.}. E.g:
+
address@hidden
address@hidden
+int main()
address@hidden puts ("Hello!");
+ return 0; @hereFn{c-lineup-runin-statements}
address@hidden
address@hidden group
address@hidden example
+
+If there is no statement after the opening brace to align with,
address@hidden is returned. This makes the function usable in list
+expressions.
+
address@hidden The @code{statement} syntactic symbol.
address@hidden defun
+
address@hidden ------------------------------------------------------------
+
address@hidden c-lineup-inexpr-block
address@hidden lineup-inexpr-block (c-)
+This can be used with the in-expression block symbols to indent the
+whole block to the column where the construct is started. E.g. for Java
+anonymous classes, this lines up the class under the @samp{new} keyword,
+and in Pike it lines up the lambda function body under the @samp{lambda}
+keyword. Returns @code{nil} if the block isn't part of such a
+construct.
+
address@hidden @code{inlambda}, @code{inexpr-statement},
address@hidden
address@hidden defun
+
address@hidden ------------------------------------------------------------
+
address@hidden c-lineup-after-whitesmith-blocks
address@hidden lineup-after-whitesmith-blocks (c-)
+Compensate for Whitesmith style indentation of blocks. Due to the way
address@hidden calculates anchor positions for normal lines inside blocks,
+this function is necessary for those lines to get correct Whitesmith
+style indentation. Consider the following examples:
+
address@hidden
address@hidden
+int foo()
+ @{
+ a;
+ x; @hereFn{c-lineup-after-whitesmith-blocks}
address@hidden group
address@hidden example
+
address@hidden
address@hidden
+int foo()
+ @{
+ @{
+ a;
+ @}
+ x; @hereFn{c-lineup-after-whitesmith-blocks}
address@hidden group
address@hidden example
+
+The fact that the line with @code{x} is preceded by a Whitesmith style
+indented block in the latter case and not the first should not affect
+its indentation. But since CC Mode in cases like this uses the
+indentation of the preceding statement as anchor position, the @code{x}
+would in the second case be indented too much if the offset for
address@hidden was set simply to zero.
+
+This lineup function corrects for this situation by detecting if the
+anchor position is at an open paren character. In that case, it instead
+indents relative to the surrounding block just like
address@hidden
+
address@hidden @code{brace-list-entry}, @code{brace-entry-open},
address@hidden, @code{arglist-cont}.
address@hidden defun
+
address@hidden ------------------------------------------------------------
+
address@hidden c-lineup-whitesmith-in-block
address@hidden lineup-whitesmith-in-block (c-)
+Line up lines inside a block in Whitesmith style. It's done in a way
+that works both when the opening brace hangs and when it doesn't. E.g:
+
address@hidden
address@hidden
+something
+ @{
+ foo; @hereFn{c-lineup-whitesmith-in-block}
+ @}
address@hidden group
address@hidden example
+
address@hidden
+and
+
address@hidden
address@hidden
+something @{
+ foo; @hereFn{c-lineup-whitesmith-in-block}
+ @}
address@hidden
address@hidden group
address@hidden example
+
+In the first case the indentation is kept unchanged, in the second
address@hidden is added.
+
address@hidden @code{defun-close}, @code{defun-block-intro},
address@hidden, @code{block-close}, @code{brace-list-close},
address@hidden, @code{statement-block-intro},
address@hidden, @code{arglist-cont-nonempty},
address@hidden, and all @code{in*} symbols, e.g. @code{inclass}
+and @code{inextern-lang}.
address@hidden defun
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden List Line-Up, Operator Line-Up, Brace/Paren Line-Up, Line-Up
Functions
address@hidden node-name, next, previous, up
address@hidden List Line-Up Functions
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+The line-up functions here calculate the indentation for lines which
+form lists of items, usually separated by commas.
+
+The function @ref{c-lineup-arglist-close-under-paren}, which is mainly
+for indenting a close parenthesis, is also useful for the lines
+contained within parentheses.
+
address@hidden c-lineup-arglist
address@hidden lineup-arglist (c-)
+Line up the current argument line under the first argument.
+
+As a special case, if an argument on the same line as the open
+parenthesis starts with a brace block opener, the indentation is
address@hidden only. This is intended as a ``DWIM'' measure in
+cases like macros that contain statement blocks, e.g:
+
address@hidden
address@hidden
+A_VERY_LONG_MACRO_NAME (@{
+ some (code, with + long, lines * in[it]);
+ @});
address@hidden
address@hidden group
address@hidden example
+
+This is motivated partly because it's more in line with how code
+blocks are handled, and partly since it approximates the behavior of
+earlier CC Mode versions, which due to inaccurate analysis tended to
+indent such cases this way.
+
address@hidden @code{arglist-cont-nonempty}, @code{arglist-close}.
address@hidden defun
+
address@hidden ------------------------------------------------------------
+
address@hidden c-lineup-arglist-intro-after-paren
address@hidden lineup-arglist-intro-after-paren (c-)
+Line up a line to just after the open paren of the surrounding paren or
+brace block.
+
address@hidden @code{defun-block-intro}, @code{brace-list-intro},
address@hidden, @code{statement-case-intro},
address@hidden
address@hidden defun
+
address@hidden ------------------------------------------------------------
+
address@hidden c-lineup-multi-inher
address@hidden lineup-multi-inher (c-)
+Line up the classes in C++ multiple inheritance clauses and member
+initializers under each other. E.g:
+
address@hidden
address@hidden
+Foo::Foo (int a, int b):
+ Cyphr (a),
+ Bar (b) @hereFn{c-lineup-multi-inher}
address@hidden group
address@hidden example
+
address@hidden
+and
+
address@hidden
address@hidden
+class Foo
+ : public Cyphr,
+ public Bar @hereFn{c-lineup-multi-inher}
address@hidden group
address@hidden example
+
address@hidden
+and
+
address@hidden
address@hidden
+Foo::Foo (int a, int b)
+ : Cyphr (a)
+ , Bar (b) @hereFn{c-lineup-multi-inher}
address@hidden group
address@hidden example
+
address@hidden @code{inher-cont}, @code{member-init-cont}.
address@hidden defun
+
address@hidden ------------------------------------------------------------
+
address@hidden c-lineup-java-inher
address@hidden lineup-java-inher (c-)
+Line up Java implements and extends declarations. If class names
+follow on the same line as the @samp{implements}/@samp{extends}
+keyword, they are lined up under each other. Otherwise, they are
+indented by adding @code{c-basic-offset} to the column of the keyword.
+E.g:
+
address@hidden
address@hidden
+class Foo
+ extends
+ Bar @hereFn{c-lineup-java-inher}
+ @sssTBasicOffset{}
address@hidden group
address@hidden example
+
address@hidden
+and
+
address@hidden
address@hidden
+class Foo
+ extends Cyphr,
+ Bar @hereFn{c-lineup-java-inher}
address@hidden group
address@hidden example
+
address@hidden @code{inher-cont}.
address@hidden defun
+
address@hidden ------------------------------------------------------------
+
address@hidden c-lineup-java-throws
address@hidden lineup-java-throws (c-)
+Line up Java throws declarations. If exception names follow on the
+same line as the throws keyword, they are lined up under each other.
+Otherwise, they are indented by adding @code{c-basic-offset} to the
+column of the @samp{throws} keyword. The @samp{throws} keyword itself
+is also indented by @code{c-basic-offset} from the function declaration
+start if it doesn't hang. E.g:
+
address@hidden
address@hidden
+int foo()
+ throws @hereFn{c-lineup-java-throws}
+ Bar @hereFn{c-lineup-java-throws}
address@hidden
address@hidden group
address@hidden example
+
address@hidden
+and
+
address@hidden
address@hidden
+int foo() throws Cyphr,
+ Bar, @hereFn{c-lineup-java-throws}
+ Vlod @hereFn{c-lineup-java-throws}
address@hidden group
address@hidden example
+
address@hidden @code{func-decl-cont}.
address@hidden defun
+
address@hidden ------------------------------------------------------------
+
address@hidden c-lineup-template-args
address@hidden lineup-template-args (c-)
+Line up the arguments of a template argument list under each other, but
+only in the case where the first argument is on the same line as the
+opening @samp{<}.
+
+To allow this function to be used in a list expression, @code{nil} is
+returned if there's no template argument on the first line.
+
address@hidden @code{template-args-cont}.
address@hidden defun
+
address@hidden ------------------------------------------------------------
+
address@hidden c-lineup-ObjC-method-call
address@hidden lineup-ObjC-method-call (c-)
+For Objective-C code, line up selector args as Emacs Lisp mode does
+with function args: go to the position right after the message receiver,
+and if you are at the end of the line, indent the current line
+c-basic-offset columns from the opening bracket; otherwise you are
+looking at the first character of the first method call argument, so
+lineup the current line with it.
+
address@hidden @code{objc-method-call-cont}.
address@hidden defun
+
address@hidden ------------------------------------------------------------
+
address@hidden c-lineup-ObjC-method-args
address@hidden lineup-ObjC-method-args (c-)
+For Objective-C code, line up the colons that separate args. The colon
+on the current line is aligned with the one on the first line.
+
address@hidden @code{objc-method-args-cont}.
address@hidden defun
+
address@hidden ------------------------------------------------------------
+
address@hidden c-lineup-ObjC-method-args-2
address@hidden lineup-ObjC-method-args-2 (c-)
+Similar to @code{c-lineup-ObjC-method-args} but lines up the colon on
+the current line with the colon on the previous line.
+
address@hidden @code{objc-method-args-cont}.
address@hidden defun
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Operator Line-Up, Comment Line-Up, List Line-Up, Line-Up
Functions
address@hidden node-name, next, previous, up
address@hidden Operator Line-Up Functions
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+The line-up functions here calculate the indentation for lines which
+start with an operator, by lining it up with something on the previous
+line.
+
address@hidden c-lineup-argcont
address@hidden lineup-argcont (c-)
+Line up a continued argument. E.g:
+
address@hidden
address@hidden
+foo (xyz, aaa + bbb + ccc
+ + ddd + eee + fff); @hereFn{c-lineup-argcont}
address@hidden group
address@hidden example
+
+Only continuation lines like this are touched, @code{nil} is returned on
+lines which are the start of an argument.
+
+Within a gcc @code{asm} block, @code{:} is recognised as an argument
+separator, but of course only between operand specifications, not in the
+expressions for the operands.
+
address@hidden @code{arglist-cont}, @code{arglist-cont-nonempty}.
address@hidden defun
+
address@hidden ------------------------------------------------------------
+
address@hidden c-lineup-arglist-operators
address@hidden lineup-arglist-operators (c-)
+Line up lines starting with an infix operator under the open paren.
+Return @code{nil} on lines that don't start with an operator, to leave
+those cases to other line-up functions. Example:
+
address@hidden
address@hidden
+if ( x < 10
+ || at_limit (x, @hereFn{c-lineup-arglist-operators}
+ list) @address@hidden returns nil}}
+ )
address@hidden group
address@hidden example
+
+Since this function doesn't do anything for lines without an infix
+operator you typically want to use it together with some other lineup
+settings, e.g. as follows (the @code{arglist-close} setting is just a
+suggestion to get a consistent style):
+
address@hidden
+(c-set-offset 'arglist-cont
+ '(c-lineup-arglist-operators 0))
+(c-set-offset 'arglist-cont-nonempty
+ '(c-lineup-arglist-operators c-lineup-arglist))
+(c-set-offset 'arglist-close
+ '(c-lineup-arglist-close-under-paren))
address@hidden example
+
address@hidden @code{arglist-cont}, @code{arglist-cont-nonempty}.
address@hidden defun
+
address@hidden ------------------------------------------------------------
+
address@hidden c-lineup-assignments
address@hidden lineup-assignments (c-)
+Line up the current line after the assignment operator on the first line
+in the statement. If there isn't any, return nil to allow stacking with
+other line-up functions. If the current line contains an assignment
+operator too, try to align it with the first one.
+
address@hidden @code{topmost-intro-cont}, @code{statement-cont},
address@hidden, @code{arglist-cont-nonempty}.
+
address@hidden defun
+
address@hidden ------------------------------------------------------------
+
address@hidden c-lineup-math
address@hidden lineup-math (c-)
+Like @code{c-lineup-assignments} but indent with @code{c-basic-offset}
+if no assignment operator was found on the first line. I.e. this
+function is the same as specifying a list @code{(c-lineup-assignments
++)}. It's provided for compatibility with old configurations.
+
address@hidden @code{topmost-intro-cont}, @code{statement-cont},
address@hidden, @code{arglist-cont-nonempty}.
address@hidden defun
+
address@hidden ------------------------------------------------------------
+
address@hidden c-lineup-cascaded-calls
address@hidden lineup-cascaded-calls (c-)
+Line up ``cascaded calls'' under each other. If the line begins with
address@hidden>} or @code{.} and the preceding line ends with one or more
+function calls preceded by the same token, then the arrow is lined up
+with the first of those tokens. E.g:
+
address@hidden
address@hidden
+r = proc->add(17)->add(18)
+ ->add(19) + @hereFn{c-lineup-cascaded-calls}
+ offset; @address@hidden (inactive)}}
address@hidden group
address@hidden example
+
+In any other situation @code{nil} is returned to allow use in list
+expressions.
+
address@hidden @code{topmost-intro-cont}, @code{statement-cont},
address@hidden, @code{arglist-cont-nonempty}.
address@hidden defun
+
address@hidden ------------------------------------------------------------
+
address@hidden c-lineup-streamop
address@hidden lineup-streamop (c-)
+Line up C++ stream operators (i.e. @samp{<<} and @samp{>>}).
+
address@hidden @code{stream-op}.
address@hidden defun
+
address@hidden ------------------------------------------------------------
+
address@hidden c-lineup-string-cont
address@hidden lineup-string-cont (c-)
+Line up a continued string under the one it continues. A continued
+string in this sense is where a string literal follows directly after
+another one. E.g:
+
address@hidden
address@hidden
+result = prefix + "A message "
+ "string."; @hereFn{c-lineup-string-cont}
address@hidden group
address@hidden example
+
address@hidden is returned in other situations, to allow stacking with other
+lineup functions.
+
address@hidden @code{topmost-intro-cont}, @code{statement-cont},
address@hidden, @code{arglist-cont-nonempty}.
address@hidden defun
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Comment Line-Up, Misc Line-Up, Operator Line-Up, Line-Up
Functions
address@hidden node-name, next, previous, up
address@hidden Comment Line-Up Functions
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+The lineup functions here calculate the indentation for several types
+of comment structure.
+
address@hidden c-lineup-C-comments
address@hidden lineup-C-comments (c-)
+Line up C block comment continuation lines. Various heuristics are used
+to handle most of the common comment styles. Some examples:
+
address@hidden
address@hidden
+/* /** /*
+ * text * text text
+ */ */ */
address@hidden group
address@hidden example
+
address@hidden
address@hidden
+/* text /* /**
+ text ** text ** text
+*/ */ */
address@hidden group
address@hidden example
+
address@hidden
address@hidden
+/**************************************************
+ * text
+ *************************************************/
address@hidden group
address@hidden example
+
address@hidden comment-start-skip
address@hidden
address@hidden
+/**************************************************
+ Free form text comments:
+ In comments with a long delimiter line at the
+ start, the indentation is kept unchanged for lines
+ that start with an empty comment line prefix. The
+ delimiter line is whatever matches the
+ @code{comment-start-skip} regexp.
+**************************************************/
address@hidden group
address@hidden example
+
+The style variable @code{c-comment-prefix-regexp} is used to recognize
+the comment line prefix, e.g. the @samp{*} that usually starts every
+line inside a comment.
+
address@hidden The @code{c} syntactic symbol.
address@hidden defun
+
address@hidden ------------------------------------------------------------
+
address@hidden c-lineup-comment
address@hidden lineup-comment (c-)
+Line up a comment-only line according to the style variable
address@hidden If the comment is lined up with a
+comment starter on the previous line, that alignment is preserved.
+
address@hidden c-comment-only-line-offset
address@hidden comment-only-line-offset (c-)
+This style variable specifies the extra offset for the line. It can
+contain an integer or a cons cell of the form
+
address@hidden
+(@address@hidden . @address@hidden)
address@hidden example
+
address@hidden
+where @var{non-anchored-offset} is the amount of offset given to
+non-column-zero anchored lines, and @var{anchored-offset} is the amount
+of offset to give column-zero anchored lines. Just an integer as value
+is equivalent to @code{(@address@hidden . -1000)}.
address@hidden defopt
+
address@hidden @code{comment-intro}.
address@hidden defun
+
address@hidden ------------------------------------------------------------
+
address@hidden c-lineup-knr-region-comment
address@hidden lineup-knr-region-comment (c-)
+Line up a comment in the ``K&R region'' with the declaration. That is
+the region between the function or class header and the beginning of the
+block. E.g:
+
address@hidden
address@hidden
+int main()
+/* Called at startup. */ @hereFn{c-lineup-knr-region-comment}
address@hidden
+ return 0;
address@hidden
address@hidden group
address@hidden example
+
+Return @code{nil} if called in any other situation, to be useful in list
+expressions.
+
address@hidden @code{comment-intro}.
address@hidden defun
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Misc Line-Up, , Comment Line-Up, Line-Up Functions
address@hidden node-name, next, previous, up
address@hidden Miscellaneous Line-Up Functions
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+The line-up functions here are the odds and ends which didn't fit into
+any earlier category.
+
address@hidden c-lineup-dont-change
address@hidden lineup-dont-change (c-)
+This lineup function makes the line stay at whatever indentation it
+already has; think of it as an identity function for lineups.
+
address@hidden Any syntactic symbol.
address@hidden defun
+
address@hidden ------------------------------------------------------------
+
address@hidden c-lineup-cpp-define
address@hidden lineup-cpp-define (c-)
+Line up macro continuation lines according to the indentation of the
+construct preceding the macro. E.g:
+
address@hidden
address@hidden
+const char msg[] = @address@hidden beginning of the preceding construct.}}
+ \"Some text.\";
+
+#define X(A, B) \
+do @{ \ @hereFn{c-lineup-cpp-define}
+ printf (A, B); \
address@hidden while (0)
address@hidden group
address@hidden example
+
address@hidden
+and:
+
address@hidden
address@hidden
+int dribble() @{
+ if (!running) @address@hidden beginning of the preceding construct.}}
+ error(\"Not running!\");
+
+#define X(A, B) \
+ do @{ \ @hereFn{c-lineup-cpp-define}
+ printf (A, B); \
+ @} while (0)
address@hidden group
address@hidden example
+
+If @code{c-syntactic-indentation-in-macros} is address@hidden, the
+function returns the relative indentation to the macro start line to
+allow accumulation with other offsets. E.g. in the following cases,
address@hidden is combined with the
address@hidden that comes from the @samp{do @{} that hangs
+on the @samp{#define} line:
+
address@hidden
address@hidden
+const char msg[] =
+ \"Some text.\";
+
+#define X(A, B) do @{ \
+ printf (A, B); \ @hereFn{c-lineup-cpp-define}
+ this->refs++; \
address@hidden while (0) @hereFn{c-lineup-cpp-define}
address@hidden group
address@hidden example
+
address@hidden
+and:
+
address@hidden
address@hidden
+int dribble() @{
+ if (!running)
+ error(\"Not running!\");
+
+#define X(A, B) do @{ \
+ printf (A, B); \ @hereFn{c-lineup-cpp-define}
+ this->refs++; \
+ @} while (0) @hereFn{c-lineup-cpp-define}
address@hidden group
address@hidden example
+
+The relative indentation returned by @code{c-lineup-cpp-define} is zero
+and two, respectively, on the two lines in each of these examples. They
+are then added to the two column indentation that
address@hidden gives in both cases here.
+
+If the relative indentation is zero, then @code{nil} is returned
+instead. That is useful in a list expression to specify the default
+indentation on the top level.
+
+If @code{c-syntactic-indentation-in-macros} is @code{nil} then this
+function keeps the current indentation, except for empty lines (ignoring
+the ending backslash) where it takes the indentation from the closest
+preceding nonempty line in the macro. If there's no such line in the
+macro then the indentation is taken from the construct preceding it, as
+described above.
+
address@hidden @code{cpp-define-intro}.
address@hidden defun
+
address@hidden ------------------------------------------------------------
+
address@hidden c-lineup-gcc-asm-reg
address@hidden lineup-gcc-asm-reg (c-)
+Line up a gcc asm register under one on a previous line.
+
address@hidden
address@hidden
+ asm ("foo %1, %0\n"
+ "bar %0, %1"
+ : "=r" (w),
+ "=r" (x)
+ : "0" (y),
+ "1" (z));
address@hidden group
address@hidden example
+
+The @samp{x} line is aligned to the text after the @samp{:} on the
address@hidden line, and similarly @samp{z} under @samp{y}.
+
+This is done only in an @samp{asm} or @samp{__asm__} block, and only to
+those lines mentioned. Anywhere else @code{nil} is returned. The usual
+arrangement is to have this routine as an extra feature at the start of
+arglist lineups, e.g.
+
address@hidden
+(c-lineup-gcc-asm-reg c-lineup-arglist)
address@hidden example
+
address@hidden @code{arglist-cont}, @code{arglist-cont-nonempty}.
address@hidden defun
+
address@hidden ------------------------------------------------------------
+
address@hidden c-lineup-topmost-intro-cont
address@hidden lineup-topmost-intro-cont (c-)
+Line up declaration continuation lines zero or one indentation
address@hidden function is mainly provided to mimic the behavior of
+CC Mode 5.28 and earlier where this case wasn't handled consistently so
+that those lines could be analyzed as either topmost-intro-cont or
+statement-cont. It's used for @code{topmost-intro-cont} by default, but
+you might consider using @code{+} instead.}. For lines preceding a
+definition, zero is used. For other lines, @code{c-basic-offset} is
+added to the indentation. E.g:
+
address@hidden
address@hidden
+int
+neg (int i) @hereFn{c-lineup-topmost-intro-cont}
address@hidden
+ return -i;
address@hidden
address@hidden group
address@hidden example
+
address@hidden
+and
+
address@hidden
address@hidden
+struct
+larch @hereFn{c-lineup-topmost-intro-cont}
address@hidden
+ double height;
address@hidden
+ the_larch, @hereFn{c-lineup-topmost-intro-cont}
+ another_larch; @hereFn{c-lineup-topmost-intro-cont}
address@hidden
address@hidden group
address@hidden example
+
address@hidden
+and
+
address@hidden
address@hidden
+struct larch
+the_larch, @hereFn{c-lineup-topmost-intro-cont}
+ another_larch; @hereFn{c-lineup-topmost-intro-cont}
address@hidden group
address@hidden example
+
address@hidden @code{topmost-intro-cont}.
address@hidden defun
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Custom Line-Up, Other Indentation, Line-Up Functions,
Customizing Indentation
address@hidden node-name, next, previous, up
address@hidden Custom Line-Up Functions
address@hidden customization, indentation functions
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+The most flexible way to customize indentation is by writing custom
+line-up functions, and associating them with specific syntactic
+symbols (@pxref{c-offsets-alist}). Depending on the effect you want,
+it might be better to write a @code{c-special-indent-hook} function
+rather than a line-up function (@pxref{Other Indentation}).
+
address@hidden comes with an extensive set of predefined line-up functions,
+not all of which are used by the default styles. So there's a good
+chance the function you want already exists. @xref{Line-Up
+Functions}, for a list of them. If you write your own line-up
+function, it's probably a good idea to start working from one of these
+predefined functions, which can be found in the file
address@hidden If you have written a line-up function that you
+think is generally useful, you're very welcome to contribute it;
+please contact @email{bug-cc-mode@@gnu.org}.
+
+ Line-up functions are passed a single argument, the syntactic
+element (see below). The return value is a @code{c-offsets-alist}
+offset specification: for example, an integer, a symbol such as
address@hidden, a vector, @address@hidden @code{nil} is useful
+when the offset specification for a syntactic element is a list
+containing the line-up function (@pxref{c-offsets-alist}).}, or even
+another line-up function. Full details of these are in
address@hidden
+
+Line-up functions must not move point or change the content of the
+buffer (except temporarily). They are however allowed to do
address@hidden buffer changes}, i.e. setting text properties for caching
+purposes etc. Buffer undo recording is disabled while they run.
+
+The syntactic element passed as the parameter to a line-up function is
+a cons cell of the form
+
address@hidden
+(@address@hidden . @address@hidden)
address@hidden example
+
address@hidden
address@hidden FIXME!!! The following sentence might be better omitted, since
the
address@hidden information is in the cross reference "Syntactic Analysis".
2005/10/2.
+where @var{syntactic-symbol} is the symbol that the function was
+called for, and @var{anchor-position} is the anchor position (if any)
+for the construct that triggered the syntactic symbol
+(@pxref{Syntactic Analysis}). This cons cell is how the syntactic
+element of a line used to be represented in @ccmode{} 5.28 and
+earlier. Line-up functions are still passed this cons cell, so as to
+preserve compatibility with older configurations. In the future, we
+may decide to convert to using the full list format---you can prepare
+your setup for this by using the access functions
+(@code{c-langelem-sym}, etc.) described below.
+
address@hidden c-syntactic-element
address@hidden syntactic-element (c-)
address@hidden c-syntactic-context
address@hidden syntactic-context (c-)
+Some syntactic symbols, e.g. @code{arglist-cont-nonempty}, have more
+info in the syntactic element - typically other positions that can be
+interesting besides the anchor position. That info can't be accessed
+through the passed argument, which is a cons cell. Instead, you can
+get this information from the variable @code{c-syntactic-element},
+which is dynamically bound to the complete syntactic element. The
+variable @code{c-syntactic-context} might also be useful - it gets
+dynamically bound to the complete syntactic context. @xref{Custom
+Braces}.
+
address@hidden provides a few functions to access parts of syntactic
+elements in a more abstract way. Besides making the code easier to
+read, they also hide the difference between the old cons cell form
+used in the line-up function argument and the new list form used in
address@hidden and everywhere else. The functions are:
+
address@hidden c-langelem-sym langelem
address@hidden langelem-sym (c-)
+Return the syntactic symbol in @var{langelem}.
address@hidden defun
+
address@hidden c-langelem-pos langelem
address@hidden langelem-pos (c-)
+Return the anchor position in @var{langelem}, or nil if there is none.
address@hidden defun
+
address@hidden c-langelem-col langelem &optional preserve-point
address@hidden langelem-col (c-)
+Return the column of the anchor position in @var{langelem}. Also move
+the point to that position unless @var{preserve-point} is
address@hidden
address@hidden defun
+
address@hidden c-langelem-2nd-pos langelem
address@hidden langelem-2nd-pos (c-)
+Return the secondary position in @var{langelem}, or @code{nil} if there
+is none.
+
+Note that the return value of this function is always @code{nil} if
address@hidden is in the old cons cell form. Thus this function is
+only meaningful when used on syntactic elements taken from
address@hidden or @code{c-syntactic-context}.
address@hidden defun
+
+Custom line-up functions can be as simple or as complex as you like, and
+any syntactic symbol that appears in @code{c-offsets-alist} can have a
+custom line-up function associated with it.
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Other Indentation, , Custom Line-Up, Customizing Indentation
address@hidden node-name, next, previous, up
address@hidden Other Special Indentations
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+Here are the remaining odds and ends regarding indentation:
+
address@hidden c-label-minimum-indentation
address@hidden label-minimum-indentation (c-)
+In @samp{gnu} style (@pxref{Built-in Styles}), a minimum indentation is
+imposed on lines inside code blocks. This minimum indentation is
+controlled by this style variable. The default value is 1.
+
address@hidden c-gnu-impose-minimum
address@hidden gnu-impose-minimum (c-)
+It's the function @code{c-gnu-impose-minimum} that enforces this minimum
+indentation. It must be present on @code{c-special-indent-hook} to
+work.
address@hidden defopt
+
address@hidden c-special-indent-hook
address@hidden special-indent-hook (c-)
+This style variable is a standard hook variable that is called after
+every line is indented by @ccmode{}. It is called only if
address@hidden is address@hidden (which it is by
+default (@pxref{Indentation Engine Basics})). You can put a function
+on this hook to do any special indentation or ad hoc line adjustments
+your style dictates, such as adding extra indentation to constructors
+or destructor declarations in a class definition, etc. Sometimes it
+is better to write a custom Line-up Function instead (@pxref{Custom
+Line-Up}).
+
+When the indentation engine calls this hook, the variable
address@hidden is bound to the current syntactic context
+(i.e. what you would get by typing @kbd{C-c C-s} on the source line.
address@hidden Braces}.). Note that you should not change point or mark
+inside a @code{c-special-indent-hook} function, i.e. you'll probably
+want to wrap your function in a @address@hidden
+numerical value returned by @code{point} will change if you change the
+indentation of the line within a @code{save-excursion} form, but point
+itself will still be over the same piece of text.}.
+
+Setting @code{c-special-indent-hook} in style definitions is handled
+slightly differently from other variables---A style can only add
+functions to this hook, not remove them. @xref{Style Variables}.
address@hidden defopt
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Custom Macros, Odds and Ends, Customizing Indentation, Top
address@hidden node-name, next, previous, up
address@hidden Customizing Macros
address@hidden macros
address@hidden preprocessor directives
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+Normally, the lines in a multi-line macro are indented relative to
+each other as though they were code. You can suppress this behaviour
+by setting the following user option:
+
address@hidden c-syntactic-indentation-in-macros
address@hidden syntactic-indentation-in-macros (c-)
+Enable syntactic analysis inside macros, which is the default. If this
+is @code{nil}, all lines inside macro definitions are analyzed as
address@hidden
address@hidden defopt
+
address@hidden provides some tools to help keep the line continuation
+backslashes in macros neat and tidy. Their precise action is
+customized with these variables:
+
address@hidden c-backslash-column
address@hidden backslash-column (c-)
address@hidden c-backslash-max-column
address@hidden backslash-max-column (c-)
+These variables control the alignment columns for line continuation
+backslashes in multiline macros. They are used by the functions that
+automatically insert or align such backslashes,
+e.g. @code{c-backslash-region} and @code{c-context-line-break}.
+
address@hidden specifies the minimum column for the
+backslashes. If any line in the macro goes past this column, then the
+next tab stop (i.e. next multiple of @code{tab-width}) in that line is
+used as the alignment column for all the backslashes, so that they
+remain in a single column. However, if any lines go past
address@hidden then the backslashes in the rest of the
+macro will be kept at that column, so that the lines which are too
+long ``stick out'' instead.
+
+Don't ever set these variables to @code{nil}. If you want to disable
+the automatic alignment of backslashes, use
address@hidden
address@hidden defopt
+
address@hidden c-auto-align-backslashes
address@hidden auto-align-backslashes (c-)
+Align automatically inserted line continuation backslashes if
address@hidden When line continuation backslashes are inserted
+automatically for line breaks in multiline macros, e.g. by
address@hidden, they are aligned with the other
+backslashes in the same macro if this flag is set.
+
+If @code{c-auto-align-backslashes} is @code{nil}, automatically
+inserted backslashes are preceded by a single space, and backslashes
+get aligned only when you explicitly invoke the command
address@hidden (@kbd{C-c C-\}).
address@hidden defopt
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Odds and Ends, Sample .emacs File, Custom Macros, Top
address@hidden node-name, next, previous, up
address@hidden Odds and Ends
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+The stuff that didn't fit in anywhere else is documented here.
+
address@hidden c-require-final-newline
address@hidden require-final-newline (c-)
+Controls whether a final newline is enforced when the file is saved.
+The value is an association list that for each language mode specifies
+the value to give to @code{require-final-newline} (@pxref{Saving
+Buffers,,, @lispref{}, @lispreftitle{}}) at mode initialization. If a
+language isn't present on the association list, CC Mode won't touch
address@hidden in buffers for that language.
+
+The default is to set @code{require-final-newline} to @code{t} in the
+languages that mandate that source files should end with newlines.
+These are C, C++ and Objective-C.
address@hidden defopt
+
address@hidden c-echo-syntactic-information-p
address@hidden echo-syntactic-information-p (c-)
+If address@hidden, the syntactic analysis for the current line is shown
+in the echo area when it's indented (unless
address@hidden is @code{nil}). That's useful when
+finding out which syntactic symbols to modify to get the indentation you
+want.
address@hidden defopt
+
address@hidden c-report-syntactic-errors
address@hidden report-syntactic-errors (c-)
+If address@hidden, certain syntactic errors are reported with a ding and
+a message, for example when an @code{else} is indented for which there
+is no corresponding @code{if}.
+
+Note however that @ccmode{} doesn't make any special effort to check for
+syntactic errors; that's the job of the compiler. The reason it can
+report cases like the one above is that it can't find the correct
+anchoring position to indent the line in that case.
address@hidden defopt
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Sample .emacs File, Performance Issues, Odds and Ends, Top
address@hidden node-name, next, previous, up
address@hidden Sample .emacs File
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+Here's a sample .emacs file fragment that might help you along the way.
+Just copy this region and paste it into your .emacs file. You might want
+to change some of the actual values.
+
address@hidden
+;; Make a non-standard key binding. We can put this in
+;; c-mode-base-map because c-mode-map, c++-mode-map, and so on,
+;; inherit from it.
+(defun my-c-initialization-hook ()
+ (define-key c-mode-base-map "\C-m" 'c-context-line-break))
+(add-hook 'c-initialization-hook 'my-c-initialization-hook)
+
+;; offset customizations not in my-c-style
+;; This will take precedence over any setting of the syntactic symbol
+;; made by a style.
+(setq c-offsets-alist '((member-init-intro . ++)))
+
+;; Create my personal style.
+(defconst my-c-style
+ '((c-tab-always-indent . t)
+ (c-comment-only-line-offset . 4)
+ (c-hanging-braces-alist . ((substatement-open after)
+ (brace-list-open)))
+ (c-hanging-colons-alist . ((member-init-intro before)
+ (inher-intro)
+ (case-label after)
+ (label after)
+ (access-label after)))
+ (c-cleanup-list . (scope-operator
+ empty-defun-braces
+ defun-close-semi))
+ (c-offsets-alist . ((arglist-close . c-lineup-arglist)
+ (substatement-open . 0)
+ (case-label . 4)
+ (block-open . 0)
+ (knr-argdecl-intro . -)))
+ (c-echo-syntactic-information-p . t))
+ "My C Programming Style")
+(c-add-style "PERSONAL" my-c-style)
+
+;; Customizations for all modes in CC Mode.
+(defun my-c-mode-common-hook ()
+ ;; set my personal style for the current buffer
+ (c-set-style "PERSONAL")
+ ;; other customizations
+ (setq tab-width 8
+ ;; this will make sure spaces are used instead of tabs
+ indent-tabs-mode nil)
+ ;; we like auto-newline, but not hungry-delete
+ (c-toggle-auto-newline 1))
+(add-hook 'c-mode-common-hook 'my-c-mode-common-hook)
address@hidden verbatim
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Performance Issues, Limitations and Known Bugs, Sample .emacs
File, Top
address@hidden node-name, next, previous, up
address@hidden Performance Issues
address@hidden performance
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden FIXME: (ACM, 2003/5/24). Check whether AWK needs mentioning
here.
+
+C and its derivative languages are highly complex creatures. Often,
+ambiguous code situations arise that require @ccmode{} to scan large
+portions of the buffer to determine syntactic context. Such
+pathological code can cause @ccmode{} to perform fairly badly. This
+section gives some insight in how @ccmode{} operates, how that interacts
+with some coding styles, and what you can use to improve performance.
+
+The overall goal is that @ccmode{} shouldn't be overly slow (i.e. take
+more than a fraction of a second) in any interactive operation.
+I.e. it's tuned to limit the maximum response time in single operations,
+which is sometimes at the expense of batch-like operations like
+reindenting whole blocks. If you find that @ccmode{} gradually gets
+slower and slower in certain situations, perhaps as the file grows in
+size or as the macro or comment you're editing gets bigger, then chances
+are that something isn't working right. You should consider reporting
+it, unless it's something that's mentioned in this section.
+
+Because @ccmode{} has to scan the buffer backwards from the current
+insertion point, and because C's syntax is fairly difficult to parse in
+the backwards direction, @ccmode{} often tries to find the nearest
+position higher up in the buffer from which to begin a forward scan
+(it's typically an opening or closing parenthesis of some kind). The
+farther this position is from the current insertion point, the slower it
+gets.
+
address@hidden beginning-of-defun
+In earlier versions of @ccmode{}, we used to recommend putting the
+opening brace of a top-level address@hidden a function in C,
+or outermost class definition in C++ or Java.} into the leftmost
+column. Earlier still, this used to be a rigid Emacs constraint, as
+embodied in the @code{beginning-of-defun} function. @ccmode now
+caches syntactic information much better, so that the delay caused by
+searching for such a brace when it's not in column 0 is minimal,
+except perhaps when you've just moved a long way inside the file.
+
address@hidden defun-prompt-regexp
address@hidden c-Java-defun-prompt-regexp
address@hidden Java-defun-prompt-regexp (c-)
+A special note about @code{defun-prompt-regexp} in Java mode: The common
+style is to hang the opening braces of functions and classes on the
+right side of the line, and that doesn't work well with the Emacs
+approach. @ccmode{} comes with a constant
address@hidden which tries to define a regular
+expression usable for this style, but there are problems with it. In
+some cases it can cause @code{beginning-of-defun} to address@hidden
+has been observed in Emacs 19.34 and XEmacs 19.15.}. For this reason,
+it is not used by default, but if you feel adventurous, you can set
address@hidden to it in your mode hook. In any event,
+setting and relying on @code{defun-prompt-regexp} will definitely slow
+things down because (X)Emacs will be doing regular expression searches a
+lot, so you'll probably be taking a hit either way!
+
address@hidden maintains a cache of the opening parentheses of the blocks
+surrounding the point, and it adapts that cache as the point is moved
+around. That means that in bad cases it can take noticeable time to
+indent a line in a new surrounding, but after that it gets fast as long
+as the point isn't moved far off. The farther the point is moved, the
+less useful is the cache. Since editing typically is done in ``chunks''
+rather than on single lines far apart from each other, the cache
+typically gives good performance even when the code doesn't fit the
+Emacs approach to finding the defun starts.
+
address@hidden c-enable-xemacs-performance-kludge-p
address@hidden enable-xemacs-performance-kludge-p (c-)
+XEmacs users can set the variable
address@hidden to address@hidden This
+tells @ccmode{} to use XEmacs-specific built-in functions which, in some
+circumstances, can locate the top-most opening brace much more quickly than
address@hidden Preliminary testing has shown that for
+styles where these braces are hung (e.g. most JDK-derived Java styles),
+this hack can improve performance of the core syntax parsing routines
+from 3 to 60 times. However, for styles which @emph{do} conform to
+Emacs' recommended style of putting top-level braces in column zero,
+this hack can degrade performance by about as much. Thus this variable
+is set to @code{nil} by default, since the Emacs-friendly styles should
+be more common (and encouraged!). Note that this variable has no effect
+in Emacs since the necessary built-in functions don't exist (in Emacs
+22.1 as of this writing in February 2007).
+
+Text properties are used to speed up skipping over syntactic whitespace,
+i.e. comments and preprocessor directives. Indenting a line after a
+huge macro definition can be slow the first time, but after that the
+text properties are in place and it should be fast (even after you've
+edited other parts of the file and then moved back).
+
+Font locking can be a CPU hog, especially the font locking done on
+decoration level 3 which tries to be very accurate. Note that that
+level is designed to be used with a font lock support mode that only
+fontifies the text that's actually shown, i.e. Lazy Lock or Just-in-time
+Lock mode, so make sure you use one of them. Fontification of a whole
+buffer with some thousand lines can often take over a minute. That is
+a known weakness; the idea is that it never should happen.
+
+The most effective way to speed up font locking is to reduce the
+decoration level to 2 by setting @code{font-lock-maximum-decoration}
+appropriately. That level is designed to be as pretty as possible
+without sacrificing performance. @xref{Font Locking Preliminaries}, for
+more info.
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Limitations and Known Bugs, FAQ, Performance Issues, Top
address@hidden node-name, next, previous, up
address@hidden Limitations and Known Bugs
address@hidden limitations
address@hidden bugs
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden @bullet
address@hidden
address@hidden doesn't support trigraphs. (These are character sequences
+such as @samp{??(}, which represents @samp{[}. They date from a time
+when some character sets didn't have all the characters that C needs,
+and are now utterly obsolete.)
+
address@hidden
+There is no way to apply auto newline settings (@pxref{Auto-newlines})
+on already typed lines. That's only a feature to ease interactive
+editing.
+
+To generalize this issue a bit: @ccmode{} is not intended to be used as
+a reformatter for old code in some more or less batch-like way. With
+the exception of some functions like @code{c-indent-region}, it's only
+geared to be used interactively to edit new code. There's currently no
+intention to change this goal.
+
+If you want to reformat old code, you're probably better off using some
+other tool instead, e.g. @ref{Top, , GNU indent, indent, The `indent'
+Manual}, which has more powerful reformatting capabilities than
address@hidden
+
address@hidden
+The support for C++ templates (in angle brackets) is not yet complete.
+When a non-nested template is used in a declaration, @ccmode{} indents
+it and font-locks it OK. Templates used in expressions, and nested
+templates do not fare so well. Sometimes a workaround is to refontify
+the expression after typing the closing @samp{>}.
+
address@hidden
+On loading @ccmode{}, sometimes this error message appears:
+
address@hidden
+File mode specification error: (void-variable c-font-lock-keywords-3)
address@hidden example
+
+This is due to a bug in the function @code{eval-after-load} in some
+versions of (X)Emacs. It can manifest itself when there is a symbolic
+link in the path of the directory which contains (X)Emacs. As a
+workaround, put the following into your @file{.emacs} file, fairly
+early on:
+
address@hidden
+(defun my-load-cc-fonts ()
+ (require "cc-fonts"))
+(add-hook 'c-initialization-hook 'my-load-cc-fonts)
address@hidden example
address@hidden itemize
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden FAQ, Updating CC Mode, Limitations and Known Bugs, Top
address@hidden node-name, next, previous, up
address@hidden Frequently Asked Questions
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden @bullet
address@hidden
address@hidden can I change the indent level from 4 spaces to 2 spaces?}
+
+Set the variable @code{c-basic-offset}. @xref{Getting Started}.
+
address@hidden
address@hidden RET
address@hidden C-j
address@hidden doesn't the @kbd{RET} key indent the new line?}
+
+Emacs' convention is that @kbd{RET} just adds a newline, and that
address@hidden adds a newline and indents it. You can make @kbd{RET} do this
+too by adding this to your @code{c-initialization-hook}:
+
address@hidden
+(define-key c-mode-base-map "\C-m" 'c-context-line-break)
address@hidden example
+
address@hidden Started}. This is a very common question. If you want
+this to be the default behavior, don't lobby us, lobby RMS! @t{:-)}
+
address@hidden
address@hidden do I stop my code jumping all over the place when I type?}
+
+Deactivate ``electric minor mode'' with @kbd{C-c C-l}. @xref{Getting
+Started}.
+
address@hidden
address@hidden C-x h
address@hidden C-M-\
address@hidden do I reindent the whole file?}
+
+Visit the file and hit @kbd{C-x h} to mark the whole buffer. Then hit
address@hidden @xref{Indentation Commands}.
+
address@hidden
address@hidden C-M-q
address@hidden C-M-u
address@hidden do I reindent the current block?}
+
+First move to the brace which opens the block with @kbd{C-M-u}, then
+reindent that expression with @kbd{C-M-q}. @xref{Indentation
+Commands}.
+
address@hidden
address@hidden put @code{(c-set-offset 'substatement-open 0)} in my
address@hidden file but I get an error saying that @code{c-set-offset}'s
+function definition is void. What's wrong?}
+
+This means that @ccmode{} hasn't yet been loaded into your Emacs
+session by the time the @code{c-set-offset} call is reached, most
+likely because @ccmode{} is being autoloaded. Instead of putting the
address@hidden line in your top-level @file{.emacs} file, put it
+in your @code{c-initialization-hook} (@pxref{CC Hooks}), or simply
+modify @code{c-offsets-alist} directly:
+
address@hidden
+(setq c-offsets-alist '((substatement-open . 0)))
address@hidden example
+
address@hidden
address@hidden open paren in column zero
address@hidden have an open paren character at column zero inside a comment or
+multiline string literal, and it causes the fontification and/or
+indentation to go haywire. What gives?}
+
+It's due to the ad-hoc rule in (X)Emacs that such open parens always
+start defuns (which translates to functions, classes, namespaces or any
+other top-level block constructs in the @ccmode{} languages).
address@hidden XEMACS
address@hidden,,, xemacs, XEmacs User's Manual}, for details.
address@hidden ifset
address@hidden XEMACS
address@hidden Margin Paren,,, emacs, GNU Emacs Manual}, for details
+(@xref{Defuns,,, emacs, GNU Emacs Manual}, in the Emacs 20 manual).
address@hidden ifclear
+
+This heuristic is built into the core syntax analysis routines in
+(X)Emacs, so it's not really a @ccmode{} issue. However, in Emacs
+21.1 it became possible to turn it address@hidden the variable
address@hidden and @ccmode{} does so
+there since it's got its own system to keep track of blocks.
+
address@hidden itemize
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Updating CC Mode, Mailing Lists and Bug Reports, FAQ, Top
address@hidden node-name, next, previous, up
address@hidden Getting the Latest CC Mode Release
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden has been standard with all versions of Emacs since 19.34 and
+of XEmacs since 19.16.
+
address@hidden web site
+Due to release schedule skew, it is likely that all of these Emacsen
+have old versions of @ccmode{} and so should be upgraded. Access to the
address@hidden source code, as well as more detailed information on Emacsen
+compatibility, etc. are all available on the web site:
+
address@hidden
address@hidden://cc-mode.sourceforge.net/}
address@hidden quotation
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Mailing Lists and Bug Reports, GNU Free Documentation
License, Updating CC Mode, Top
address@hidden node-name, next, previous, up
address@hidden Mailing Lists and Submitting Bug Reports
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden C-c C-b
address@hidden c-submit-bug-report
address@hidden submit-bug-report (c-)
+To report bugs, use the @kbd{C-c C-b} (bound to
address@hidden) command. This provides vital information
+we need to reproduce your problem. Make sure you include a concise,
+but complete code example. Please try to boil your example down to
+just the essential code needed to reproduce the problem, and include
+an exact recipe of steps needed to expose the bug. Be especially sure
+to include any code that appears @emph{before} your bug example, if
+you think it might affect our ability to reproduce it.
+
+Please try to produce the problem in an Emacs instance without any
+customizations loaded (i.e. start it with the @samp{-q --no-site-file}
+arguments). If it works correctly there, the problem might be caused
+by faulty customizations in either your own or your site
+configuration. In that case, we'd appreciate it if you isolate the
+Emacs Lisp code that triggers the bug and include it in your report.
+
address@hidden bug report mailing list
+Bug reports should be sent to @email{bug-cc-mode@@gnu.org}. You can
+also send other questions and suggestions (kudos? @t{;-)} to that
+address. It's a mailing list which you can join or browse an archive
+of; see the web site at @uref{http://cc-mode.sourceforge.net/} for
+further details.
+
address@hidden announcement mailing list
+If you want to get announcements of new @ccmode{} releases, send the
+word @emph{subscribe} in the body of a message to
address@hidden@@lists.sourceforge.net}. It's possible
+to subscribe from the web site too. Announcements will also be posted
+to the Usenet newsgroups @code{gnu.emacs.sources}, @code{comp.emacs},
address@hidden, @code{comp.lang.c}, @code{comp.lang.c++},
address@hidden, @code{comp.lang.java.softwaretools},
address@hidden, and @code{comp.lang.awk}.
address@hidden There is no newsgroup for Pike. :-(
+
+
address@hidden GNU Free Documentation License, Command and Function Index,
Mailing Lists and Bug Reports, Top
address@hidden GNU Free Documentation License
address@hidden doclicense.texi
+
+
address@hidden Removed the tentative node "Mode Initialization" from here,
2005/8/27.
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Command and Function Index, Variable Index, GNU Free
Documentation License, Top
address@hidden node-name, next, previous, up
address@hidden Command and Function Index
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+Since most @ccmode{} commands are prepended with the string
address@hidden, each appears under its @address@hidden name and its
address@hidden@var{thing} (c-)} name.
address@hidden
address@hidden 2
address@hidden iftex
address@hidden fn
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Variable Index, Concept and Key Index, Command and Function
Index, Top
address@hidden node-name, next, previous, up
address@hidden Variable Index
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+Since most @ccmode{} variables are prepended with the string
address@hidden, each appears under its @address@hidden name and its
address@hidden@var{thing} (c-)} name.
address@hidden
address@hidden 2
address@hidden iftex
address@hidden vr
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Concept and Key Index, , Variable Index, Top
address@hidden node-name, next, previous, up
address@hidden Concept and Key Index
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden cp
+
+
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
address@hidden Epilogue.
address@hidden !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
address@hidden
address@hidden
address@hidden
address@hidden
address@hidden iftex
+
address@hidden
+
address@hidden
+ arch-tag: c4cab162-5e57-4366-bdce-4a9db2fc97f0
address@hidden ignore