procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Document c-guess-basic-syntax in the CC Mode manual.

Browse source 
* doc/misc/cc-mode.texi (Syntactic Analysis): Document the function, adding
pxrefs to Custom Line-Up and Other Indentation.
(Custom Line-Up): Add a note on using c-guess-basic-syntax with a pxref to
Syntactic Analysis.
This commit is contained in:
Alan Mackenzie 2016-03-01 15:01:46 +00:00
parent 733fb9fdf5
commit 60e0596402
1 changed files with 18 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
doc/misc/cc-mode.texi
View file

@ -3887,9 +3887,19 @@ of the variables associated with indentation, not even
@cindex syntactic element @cindex syntactic element
@cindex syntactic context @cindex syntactic context
The first thing @ccmode{} does when indenting a line of code, is to The first thing @ccmode{} does when indenting a line of code, is to
analyze the line, determining the @dfn{syntactic context} of the analyze the line by calling @code{c-guess-basic-syntax}, determining
(first) construct on that line. It's a list of @dfn{syntactic the syntactic context of the (first) construct on that line. Although
elements}, where each syntactic element in turn is a list@footnote{In this function is mainly used internally, it can sometimes be useful in
Line-up functions (@pxref{Custom Line-Up}) or in functions on
@code{c-special-indent-hook} (@pxref{Other Indentation}).
@defun c-guess-basic-syntax
@findex guess-basic-syntax (c-)
Determine the syntactic context of the current line.
@end defun
The @dfn{syntactic context} is a list of @dfn{syntactic elements},
where each syntactic element in turn is a list@footnote{In
@ccmode 5.28 and earlier, a syntactic element was a dotted pair; the @ccmode 5.28 and earlier, a syntactic element was a dotted pair; the
cons was the syntactic symbol and the cdr was the anchor position. cons was the syntactic symbol and the cdr was the anchor position.
For compatibility's sake, the parameter passed to a line-up function For compatibility's sake, the parameter passed to a line-up function
@ -6553,6 +6563,11 @@ only meaningful when used on syntactic elements taken from
@code{c-syntactic-element} or @code{c-syntactic-context}. @code{c-syntactic-element} or @code{c-syntactic-context}.
@end defun @end defun
Sometimes you may need to use the syntactic context of a line other
than the one being indented. You can determine this by (temporarily)
moving point onto this line and calling @code{c-guess-basic-syntax}
(@pxref{Syntactic Analysis}).
Custom line-up functions can be as simple or as complex as you like, and 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 any syntactic symbol that appears in @code{c-offsets-alist} can have a
custom line-up function associated with it. custom line-up function associated with it.