annotate src/indent.h @ 106395:f2b36fb84bf7

Enhance `c-parse-state' to run efficiently in "brace desserts". * progmodes/cc-mode.el (c-basic-common-init): Call c-state-cache-init. (c-neutralize-syntax-in-and-mark-CPP): Renamed from c-extend-and-neutralize-syntax-in-CPP. Mark each CPP construct by placing `category' properties value 'c-cpp-delimiter at its boundaries. * progmodes/cc-langs.el (c-before-font-lock-function): c-extend-and-neutralize-syntax-in-CPP has been renamed c-neutralize-syntax-in-and-mark-CPP. * progmodes/cc-fonts.el (c-cpp-matchers): Mark template brackets with `category' properties now, not `syntax-table' ones. * progmodes/cc-engine.el (c-syntactic-end-of-macro): A new enhanced (but slower) version of c-end-of-macro that won't land inside a literal or on another awkward character. (c-state-cache-too-far, c-state-cache-start) (c-state-nonlit-pos-interval, c-state-nonlit-pos-cache) (c-state-nonlit-pos-cache-limit, c-state-point-min) (c-state-point-min-lit-type, c-state-point-min-lit-start) (c-state-min-scan-pos, c-state-brace-pair-desert) (c-state-old-cpp-beg, c-state-old-cpp-end): New constants and buffer local variables. (c-state-literal-at, c-state-lit-beg) (c-state-cache-non-literal-place, c-state-get-min-scan-pos) (c-state-mark-point-min-literal, c-state-cache-top-lparen) (c-state-cache-top-paren, c-state-cache-after-top-paren) (c-get-cache-scan-pos, c-get-fallback-scan-pos) (c-state-balance-parens-backwards, c-parse-state-get-strategy) (c-renarrow-state-cache) (c-append-lower-brace-pair-to-state-cache) (c-state-push-any-brace-pair, c-append-to-state-cache) (c-remove-stale-state-cache) (c-remove-stale-state-cache-backwards, c-state-cache-init) (c-invalidate-state-cache-1, c-parse-state-1) (c-invalidate-state-cache): New defuns/defmacros/defsubsts. (c-parse-state): Enhanced and refactored. (c-debug-parse-state): Amended to deal with all the new variables. * progmodes/cc-defs.el (c-<-as-paren-syntax, c-mark-<-as-paren) (c->-as-paren-syntax, c-mark->-as-paren, c-unmark-<->-as-paren): modify to use category text properties rather than syntax-table ones. (c-suppress-<->-as-parens, c-restore-<->-as-parens): new defsubsts to switch off/on the syntactic paren property of C++ template delimiters using the category property. (c-with-<->-as-parens-suppressed): Macro to invoke code with template delims suppressed. (c-cpp-delimiter, c-set-cpp-delimiters, c-clear-cpp-delimiters): New constant/macros which apply category properties to the start and end of preprocessor constructs. (c-comment-out-cpps, c-uncomment-out-cpps): defsubsts which "comment out" the syntactic value of characters in preprocessor constructs. (c-with-cpps-commented-out) (c-with-all-but-one-cpps-commented-out): Macros to invoke code with characters in all or all but one preprocessor constructs "commented out".
author Alan Mackenzie <acm@muc.de>
date Thu, 03 Dec 2009 16:02:10 +0000
parents e038c1a8307c
children 1d1d5d9bd884
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
1 /* Definitions for interface to indent.c
75227
e90d04cd455a Update copyright for years from Emacs 21 to present (mainly adding
Glenn Morris <rgm@gnu.org>
parents: 68651
diff changeset
2 Copyright (C) 1985, 1986, 2001, 2002, 2003, 2004,
100951
e038c1a8307c Add 2009 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 94994
diff changeset
3 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
4
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
5 This file is part of GNU Emacs.
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
6
94994
29adfc9354e7 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
7 GNU Emacs is free software: you can redistribute it and/or modify
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
8 it under the terms of the GNU General Public License as published by
94994
29adfc9354e7 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
9 the Free Software Foundation, either version 3 of the License, or
29adfc9354e7 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
10 (at your option) any later version.
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
11
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
12 GNU Emacs is distributed in the hope that it will be useful,
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
15 GNU General Public License for more details.
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
16
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
94994
29adfc9354e7 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
19
17018
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
20 /* We introduce new member `tab_offset'. We need it because of the
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
21 existence of wide-column characters. There is a case that the
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
22 line-break occurs at a wide-column character and the number of
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
23 colums of the line gets less than width.
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
24
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
25 Example (where W_ stands for a wide-column character):
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
26 ----------
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
27 abcdefgh\\
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 25026
diff changeset
28 W_
17018
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
29 ----------
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
30
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 25026
diff changeset
31 To handle this case, we should not calculate the tab offset by
17018
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
32 tab_offset += width;
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
33
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 25026
diff changeset
34 Instead, we must remember tab_offset of the line.
17018
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
35
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
36 */
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
37
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
38 struct position
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
39 {
84951
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
40 EMACS_INT bufpos;
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
41 EMACS_INT bytepos;
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
42 EMACS_INT hpos;
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
43 EMACS_INT vpos;
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
44 EMACS_INT prevhpos;
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
45 EMACS_INT contin;
16403
a388d0109b9e (struct position): New field ovstring_chars_done.
Richard M. Stallman <rms@gnu.org>
parents: 14186
diff changeset
46 /* Number of characters we have already handled
a388d0109b9e (struct position): New field ovstring_chars_done.
Richard M. Stallman <rms@gnu.org>
parents: 14186
diff changeset
47 from the before and after strings at this position. */
84951
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
48 EMACS_INT ovstring_chars_done;
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
49 EMACS_INT tab_offset;
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
50 };
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
51
84951
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
52 struct position *compute_motion P_ ((EMACS_INT from, EMACS_INT fromvpos,
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
53 EMACS_INT fromhpos, int did_motion,
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
54 EMACS_INT to, EMACS_INT tovpos,
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
55 EMACS_INT tohpos,
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
56 EMACS_INT width, EMACS_INT hscroll,
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
57 EMACS_INT tab_offset, struct window *));
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
58 struct position *vmotion P_ ((EMACS_INT from, EMACS_INT vtarget,
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
59 struct window *));
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
60 EMACS_INT skip_invisible P_ ((EMACS_INT pos, EMACS_INT *next_boundary_p,
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
61 EMACS_INT to, Lisp_Object window));
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
62
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
63 /* Value of point when current_column was called */
84951
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
64 extern EMACS_INT last_known_column_point;
9408
99429d6c8b4e * indent.h (disptab_matches_widthtab, recompute_width_table): New
Jim Blandy <jimb@redhat.com>
parents: 484
diff changeset
65
99429d6c8b4e * indent.h (disptab_matches_widthtab, recompute_width_table): New
Jim Blandy <jimb@redhat.com>
parents: 484
diff changeset
66 /* Functions for dealing with the column cache. */
99429d6c8b4e * indent.h (disptab_matches_widthtab, recompute_width_table): New
Jim Blandy <jimb@redhat.com>
parents: 484
diff changeset
67
78501
1677cf1c2509 Replace `iff' in comments.
Glenn Morris <rgm@gnu.org>
parents: 78260
diff changeset
68 /* Return true if the display table DISPTAB specifies the same widths
9408
99429d6c8b4e * indent.h (disptab_matches_widthtab, recompute_width_table): New
Jim Blandy <jimb@redhat.com>
parents: 484
diff changeset
69 for characters as WIDTHTAB. We use this to decide when to
99429d6c8b4e * indent.h (disptab_matches_widthtab, recompute_width_table): New
Jim Blandy <jimb@redhat.com>
parents: 484
diff changeset
70 invalidate the buffer's column_cache. */
25026
488e6b8dc9ae (toplevel): Add function prototypes.
Gerd Moellmann <gerd@gnu.org>
parents: 20540
diff changeset
71 int disptab_matches_widthtab P_ ((struct Lisp_Char_Table *disptab,
488e6b8dc9ae (toplevel): Add function prototypes.
Gerd Moellmann <gerd@gnu.org>
parents: 20540
diff changeset
72 struct Lisp_Vector *widthtab));
9408
99429d6c8b4e * indent.h (disptab_matches_widthtab, recompute_width_table): New
Jim Blandy <jimb@redhat.com>
parents: 484
diff changeset
73
99429d6c8b4e * indent.h (disptab_matches_widthtab, recompute_width_table): New
Jim Blandy <jimb@redhat.com>
parents: 484
diff changeset
74 /* Recompute BUF's width table, using the display table DISPTAB. */
25026
488e6b8dc9ae (toplevel): Add function prototypes.
Gerd Moellmann <gerd@gnu.org>
parents: 20540
diff changeset
75 void recompute_width_table P_ ((struct buffer *buf,
488e6b8dc9ae (toplevel): Add function prototypes.
Gerd Moellmann <gerd@gnu.org>
parents: 20540
diff changeset
76 struct Lisp_Char_Table *disptab));
488e6b8dc9ae (toplevel): Add function prototypes.
Gerd Moellmann <gerd@gnu.org>
parents: 20540
diff changeset
77
488e6b8dc9ae (toplevel): Add function prototypes.
Gerd Moellmann <gerd@gnu.org>
parents: 20540
diff changeset
78
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 49600
diff changeset
79 /* arch-tag: f9feb373-5bff-4f4f-9198-94805d00cfd7
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 49600
diff changeset
80 (do not change this comment) */