| blob | 12ec8f74fea4e82d7a16bf4773237474bbe1e9e0 |
1 ;;; cc-engine.el --- core syntax guessing engine for CC mode -*- coding: utf-8 -*-
3 ;; Copyright (C) 1985, 1987, 1992-2017 Free Software Foundation, Inc.
5 ;; Authors: 2001- Alan Mackenzie
6 ;; 1998- Martin Stjernholm
7 ;; 1992-1999 Barry A. Warsaw
8 ;; 1987 Dave Detlefs
9 ;; 1987 Stewart Clamen
10 ;; 1985 Richard M. Stallman
11 ;; Maintainer: bug-cc-mode@gnu.org
12 ;; Created: 22-Apr-1997 (split from cc-mode.el)
13 ;; Keywords: c languages
14 ;; Package: cc-mode
16 ;; This file is part of GNU Emacs.
18 ;; GNU Emacs is free software: you can redistribute it and/or modify
19 ;; it under the terms of the GNU General Public License as published by
20 ;; the Free Software Foundation, either version 3 of the License, or
21 ;; (at your option) any later version.
23 ;; GNU Emacs is distributed in the hope that it will be useful,
24 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
25 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 ;; GNU General Public License for more details.
28 ;; You should have received a copy of the GNU General Public License
29 ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
31 ;;; Commentary:
33 ;; The functions which have docstring documentation can be considered
34 ;; part of an API which other packages can use in CC Mode buffers.
35 ;; Otoh, undocumented functions and functions with the documentation
36 ;; in comments are considered purely internal and can change semantics
37 ;; or even disappear in the future.
38 ;;
39 ;; (This policy applies to CC Mode as a whole, not just this file. It
40 ;; probably also applies to many other Emacs packages, but here it's
41 ;; clearly spelled out.)
43 ;; Hidden buffer changes
44 ;;
45 ;; Various functions in CC Mode use text properties for caching and
46 ;; syntactic markup purposes, and those of them that might modify such
47 ;; properties but still don't modify the buffer in a visible way are
48 ;; said to do "hidden buffer changes". They should be used within
49 ;; `c-save-buffer-state' or a similar function that saves and restores
50 ;; buffer modifiedness, disables buffer change hooks, etc.
51 ;;
52 ;; Interactive functions are assumed to not do hidden buffer changes,
53 ;; except in the specific parts of them that do real changes.
54 ;;
55 ;; Lineup functions are assumed to do hidden buffer changes. They
56 ;; must not do real changes, though.
57 ;;
58 ;; All other functions that do hidden buffer changes have that noted
59 ;; in their doc string or comment.
60 ;;
61 ;; The intention with this system is to avoid wrapping every leaf
62 ;; function that do hidden buffer changes inside
63 ;; `c-save-buffer-state'. It should be used as near the top of the
64 ;; interactive functions as possible.
65 ;;
66 ;; Functions called during font locking are allowed to do hidden
67 ;; buffer changes since the font-lock package run them in a context
68 ;; similar to `c-save-buffer-state' (in fact, that function is heavily
69 ;; inspired by `save-buffer-state' in the font-lock package).
71 ;; Use of text properties
72 ;;
73 ;; CC Mode uses several text properties internally to mark up various
74 ;; positions, e.g. to improve speed and to eliminate glitches in
75 ;; interactive refontification.
76 ;;
77 ;; Note: This doc is for internal use only. Other packages should not
78 ;; assume that these text properties are used as described here.
79 ;;
80 ;; 'category
81 ;; Used for "indirection". With its help, some other property can
82 ;; be cheaply and easily switched on or off everywhere it occurs.
83 ;;
84 ;; 'syntax-table
85 ;; Used to modify the syntax of some characters. It is used to
86 ;; mark the "<" and ">" of angle bracket parens with paren syntax, to
87 ;; "hide" obtrusive characters in preprocessor lines, and to mark C++
88 ;; raw strings to enable their fontification.
89 ;;
90 ;; This property is used on single characters and is therefore
91 ;; always treated as front and rear nonsticky (or start and end open
92 ;; in XEmacs vocabulary). It's therefore installed on
93 ;; `text-property-default-nonsticky' if that variable exists (Emacs
94 ;; >= 21).
95 ;;
96 ;; 'c-is-sws and 'c-in-sws
97 ;; Used by `c-forward-syntactic-ws' and `c-backward-syntactic-ws' to
98 ;; speed them up. See the comment blurb before `c-put-is-sws'
99 ;; below for further details.
100 ;;
101 ;; 'c-type
102 ;; This property is used on single characters to mark positions with
103 ;; special syntactic relevance of various sorts. Its primary use is
104 ;; to avoid glitches when multiline constructs are refontified
105 ;; interactively (on font lock decoration level 3). It's cleared in
106 ;; a region before it's fontified and is then put on relevant chars
107 ;; in that region as they are encountered during the fontification.
108 ;; The value specifies the kind of position:
109 ;;
110 ;; 'c-decl-arg-start
111 ;; Put on the last char of the token preceding each declaration
112 ;; inside a declaration style arglist (typically in a function
113 ;; prototype).
114 ;;
115 ;; 'c-decl-end
116 ;; Put on the last char of the token preceding a declaration.
117 ;; This is used in cases where declaration boundaries can't be
118 ;; recognized simply by looking for a token like ";" or "}".
119 ;; `c-type-decl-end-used' must be set if this is used (see also
120 ;; `c-find-decl-spots').
121 ;;
122 ;; 'c-<>-arg-sep
123 ;; Put on the commas that separate arguments in angle bracket
124 ;; arglists like C++ template arglists.
125 ;;
126 ;; 'c-decl-id-start and 'c-decl-type-start
127 ;; Put on the last char of the token preceding each declarator
128 ;; in the declarator list of a declaration. They are also used
129 ;; between the identifiers cases like enum declarations.
130 ;; 'c-decl-type-start is used when the declarators are types,
131 ;; 'c-decl-id-start otherwise.
132 ;;
133 ;; 'c-not-decl
134 ;; Put on the brace which introduces a brace list and on the commas
135 ;; which separate the elements within it.
136 ;;
137 ;; 'c-awk-NL-prop
138 ;; Used in AWK mode to mark the various kinds of newlines. See
139 ;; cc-awk.el.
141 ;;; Code:
148 load-path)))
157 \f
158 ;; Make declarations for all the `c-lang-defvar' variables in cc-langs.
170 \f
171 ;;; Internal state variables.
173 ;; Internal state of hungry delete key feature
177 ;; The electric flag (toggled by `c-toggle-electric-state').
178 ;; If t, electric actions (like automatic reindentation, and (if
179 ;; c-auto-newline is also set) auto newlining) will happen when an electric
180 ;; key like `{' is pressed (or an electric keyword like `else').
184 ;; Internal state of auto newline feature.
188 ;; Included in the mode line to indicate the active submodes.
189 ;; (defvar c-submode-indicators nil)
190 ;; (make-variable-buffer-local 'c-submode-indicators)
193 ;; Calculate the new state of PREVSTATE, t or nil, based on arg. If
194 ;; arg is nil or zero, toggle the state. If arg is negative, turn
195 ;; the state off, and if arg is positive, turn the state on
201 \f
202 ;; Basic handling of preprocessor directives.
204 ;; This is a dynamically bound cache used together with
205 ;; `c-query-macro-start' and `c-query-and-set-macro-start'. It only
206 ;; works as long as point doesn't cross a macro boundary.
215 c-macro-start))
223 c-macro-start))
225 ;; One element macro cache to cope with continual movement within very large
226 ;; CPP macros.
229 ;; Nil or cons of the bounds of the most recent CPP form probed by
230 ;; `c-beginning-of-macro', `c-end-of-macro' or `c-syntactic-end-of-macro'.
231 ;; The cdr will be nil if we know only the start of the CPP form.
234 ;; The starting position from where we determined `c-macro-cache'.
237 ;; Either nil, or the syntactic end of the macro currently represented by
238 ;; `c-macro-cache'.
241 ;; Either nil, or the last character of the macro currently represented by
242 ;; `c-macro-cache' which isn't in a comment. */
245 ;; Called from a before-change function. If the change region is before or
246 ;; in the macro characterized by `c-macro-cache' etc., nullify it
247 ;; appropriately. BEG and END are the standard before-change-functions
248 ;; parameters. END isn't used.
253 c-macro-cache-start-pos nil
254 c-macro-cache-syntactic nil
255 c-macro-cache-no-comment nil))
260 c-macro-cache-syntactic nil
261 c-macro-cache-no-comment nil))))
264 ;; Check that the ostensible CPP construct at point is a real one. In
265 ;; particular, if point is on the first line of a narrowed buffer, make sure
266 ;; that the "#" isn't, say, the second character of a "##" operator. Return
267 ;; t when the macro is real, nil otherwise.
278 t)
282 "Go to the beginning of a preprocessor directive.
283 Leave point at the beginning of the directive and return t if in one,
284 otherwise return nil and leave point unchanged.
286 Note that this function might do hidden buffer changes. See the
287 comment at the start of cc-engine.el for more info."
299 t))
301 c-macro-cache-start-pos nil
302 c-macro-cache-syntactic nil
303 c-macro-cache-no-comment nil)
316 c-macro-cache-start-pos here
317 c-macro-cache-syntactic nil)
318 t)
320 nil))))))
323 "Go to the end of a preprocessor directive.
324 More accurately, move the point to the end of the closest following
325 line that doesn't end with a line continuation backslash - no check is
326 done that the point is inside a cpp directive to begin with.
328 If LIM is provided, it is a limit position at which point is left
329 if the end of the macro doesn't occur earlier.
331 Note that this function might do hidden buffer changes. See the
332 comment at the start of cc-engine.el for more info."
343 c-macro-cache-start-pos nil
344 c-macro-cache-syntactic nil
345 c-macro-cache-no-comment nil))
351 t)))
359 ;; Go to the end of a CPP directive, or a "safe" pos just before.
360 ;;
361 ;; This is normally the end of the next non-escaped line. A "safe"
362 ;; position is one not within a string or comment. (The EOL on a line
363 ;; comment is NOT "safe").
364 ;;
365 ;; This function must only be called from the beginning of a CPP construct.
366 ;;
367 ;; Note that this function might do hidden buffer changes. See the comment
368 ;; at the start of cc-engine.el for more info.
371 s)
385 ;; Go to the end of a CPP directive, or a pos just before which isn't in a
386 ;; comment. For this purpose, open strings are ignored.
387 ;;
388 ;; This function must only be called from the beginning of a CPP construct.
389 ;;
390 ;; Note that this function might do hidden buffer changes. See the comment
391 ;; at the start of cc-engine.el for more info.
394 s)
409 ;; Assuming point is at the "#" that introduces a preprocessor
410 ;; directive, it's moved forward to the end of the identifier which is
411 ;; "#define"d (or whatever c-opt-cpp-macro-define specifies). Non-nil
412 ;; is returned in this case, in all other cases nil is returned and
413 ;; point isn't moved.
414 ;;
415 ;; This function might do hidden buffer changes.
421 ;; Assuming point is at the "#" that introduces a preprocessor
422 ;; directive, it's moved forward to the start of the definition body
423 ;; if it's a "#define" (or whatever c-opt-cpp-macro-define
424 ;; specifies). Non-nil is returned in this case, in all other cases
425 ;; nil is returned and point isn't moved.
426 ;;
427 ;; This function might do hidden buffer changes.
433 \f
434 ;;; Basic utility functions.
437 ;; If ELT is a member of the (possibly dotted) list DLIST, remove all
438 ;; occurrences of it (except for any in the last cdr of DLIST).
439 ;;
440 ;; Call this as (setq DLIST (c-delq-from-dotted-list ELT DLIST)), as
441 ;; sometimes the original structure is changed, sometimes it's not.
442 ;;
443 ;; This function is needed in Emacs < 24.5, and possibly XEmacs, because
444 ;; `delq' throws an error in these versions when given a dotted list.
453 dlist))
456 ;; Return the given region as a string where all syntactic
457 ;; whitespace is removed or, where necessary, replaced with a single
458 ;; space. If PAREN-LEVEL is given then all parens in the region are
459 ;; collapsed to "()", "[]" etc.
460 ;;
461 ;; This function might do hidden buffer changes.
505 ;; Shift the indentation of the current line with the specified
506 ;; amount (positive inwards). The buffer is modified only if
507 ;; SHIFT-AMT isn't equal to zero.
510 tmp-char-inserted)
512 nil
513 ;; If we're on an empty line inside a macro, we take the point
514 ;; to be at the current indentation and shift it to the
515 ;; appropriate column. This way we don't treat the extra
516 ;; whitespace out to the line continuation as indentation.
532 ;; If initial point was within line's indentation and we're not on
533 ;; a line with a line continuation in a macro, position after the
534 ;; indentation. Else stay at same point in text.
542 ;; Return non-nil if the string KEYWORD is a known keyword. More
543 ;; precisely, the value is the symbol for the keyword in
544 ;; `c-keywords-obarray'.
548 ;; Return non-nil if the symbol KEYWORD-SYM, as returned by
549 ;; `c-keyword-sym', is a member of LANG-CONSTANT, which is the name
550 ;; of a language constant that ends with "-kwds". If KEYWORD-SYM is
551 ;; nil then the result is nil.
554 ;; String syntax chars, suitable for skip-syntax-(forward|backward).
559 ;; Regexp matching string limit syntax.
564 ;; Regexp matching WS followed by string limit syntax.
568 ;; Holds formatted error strings for the few cases where parse errors
569 ;; are reported.
576 c-parsing-error)
578 ;; Faces given to comments and string literals. This is used in some
579 ;; situations to speed up recognition; it isn't mandatory that font
580 ;; locking is in use. This variable is extended with the face in
581 ;; `c-doc-face-name' when fontification is activated in cc-fonts.el.
585 ;; New in Emacs 22.
589 ;; Put a c-type property with the given value at POS.
593 ;; Remove all occurrences of the c-type property that has the given
594 ;; value in the region between FROM and TO. VALUE is assumed to not
595 ;; be nil.
596 ;;
597 ;; Note: This assumes that c-type is put on single chars only; it's
598 ;; very inefficient if matching properties cover large regions.
607 \f
608 ;; Some debug tools to visualize various special positions. This
609 ;; debug code isn't as portable as the rest of CC Mode.
645 \f
646 ;; `c-beginning-of-statement-1' and accompanying stuff.
648 ;; KLUDGE ALERT: c-maybe-labelp is used to pass information between
649 ;; c-crosses-statement-barrier-p and c-beginning-of-statement-1. A
650 ;; better way should be implemented, but this will at least shut up
651 ;; the byte compiler.
654 ;; New awk-compatible version of c-beginning-of-statement-1, ACM 2002/6/22
656 ;; Macros used internally in c-beginning-of-statement-1 for the
657 ;; automaton actions.
660 stack)))
665 t
666 ,do-if-done
671 ;; Throw nil if stack is empty, else throw non-nil.
689 "No matching `%s' found for `%s' on line %d"
696 noerror comma-delim)
697 "Move to the start of the current statement or declaration, or to
698 the previous one if already at the beginning of one. Only
699 statements/declarations on the same level are considered, i.e. don't
700 move into or out of sexps (not even normal expression parentheses).
702 If point is already at the earliest statement within braces or parens,
703 this function doesn't move back into any whitespace preceding it; it
704 returns `same' in this case.
708 is within the continuation. If starting at such a token, move to the
709 corresponding statement start. If at the beginning of a statement,
710 move to the closest containing statement if there is any. This might
711 also stop at a continuation clause.
713 Labels are treated as part of the following statements if
714 IGNORE-LABELS is non-nil. (FIXME: Doesn't work if we stop at a known
715 statement start keyword.) Otherwise, each label is treated as a
716 separate statement.
718 Macros are ignored \(i.e. skipped over) unless point is within one, in
719 which case the content of the macro is treated as normal code. Aside
720 from any normal statement starts found in it, stop at the first token
723 macros before leaving them.
725 Return:
727 `same' if stopped at the beginning of the current statement;
728 `up' if stepped to a containing statement;
729 `previous' if stepped to a preceding statement;
730 `beginning' if stepped from a statement continuation clause to
731 its start clause; or
732 `macro' if stepped to a macro start.
733 Note that `same' and not `label' is returned if stopped at the same
734 label without crossing the colon character.
736 LIM may be given to limit the search. If the search hits the limit,
737 point will be left at the closest following token, or at the start
738 position if that is less (`same' is returned in this case).
740 NOERROR turns off error logging to `c-parsing-error'.
742 Normally only `;' and virtual semicolons are considered to delimit
743 statements, but if COMMA-DELIM is non-nil then `,' is treated
744 as a delimiter too.
746 Note that this function might do hidden buffer changes. See the
747 comment at the start of cc-engine.el for more info."
749 ;; The bulk of this function is a pushdown automaton that looks at statement
750 ;; boundaries and the tokens (such as "while") in c-opt-block-stmt-key. Its
751 ;; purpose is to keep track of nested statements, ensuring that such
752 ;; statements are skipped over in their entirety (somewhat akin to what C-M-p
753 ;; does with nested braces/brackets/parentheses).
754 ;;
755 ;; Note: The position of a boundary is the following token.
756 ;;
757 ;; Beginning with the current token (the one following point), move back one
758 ;; sexp at a time (where a sexp is, more or less, either a token or the
759 ;; entire contents of a brace/bracket/paren pair). Each time a statement
760 ;; boundary is crossed or a "while"-like token is found, update the state of
761 ;; the PDA. Stop at the beginning of a statement when the stack (holding
762 ;; nested statement info) is empty and the position has been moved.
763 ;;
764 ;; The following variables constitute the PDA:
765 ;;
766 ;; sym: This is either the "while"-like token (e.g. 'for) we've just
767 ;; scanned back over, 'boundary if we've just gone back over a
768 ;; statement boundary, or nil otherwise.
769 ;; state: takes one of the values (nil else else-boundary while
770 ;; while-boundary catch catch-boundary).
771 ;; nil means "no "while"-like token yet scanned".
772 ;; 'else, for example, means "just gone back over an else".
773 ;; 'else-boundary means "just gone back over a statement boundary
774 ;; immediately after having gone back over an else".
775 ;; saved-pos: A vector of either saved positions (tok ptok pptok, etc.) or
776 ;; of error reporting information.
777 ;; stack: The stack onto which the PDA pushes its state. Each entry
778 ;; consists of a saved value of state and saved-pos. An entry is
779 ;; pushed when we move back over a "continuation" token (e.g. else)
780 ;; and popped when we encounter the corresponding opening token
781 ;; (e.g. if).
782 ;;
783 ;;
784 ;; The following diagram briefly outlines the PDA.
785 ;;
786 ;; Common state:
787 ;; "else": Push state, goto state `else'.
788 ;; "while": Push state, goto state `while'.
789 ;; "catch" or "finally": Push state, goto state `catch'.
790 ;; boundary: Pop state.
791 ;; other: Do nothing special.
792 ;;
793 ;; State `else':
794 ;; boundary: Goto state `else-boundary'.
795 ;; other: Error, pop state, retry token.
796 ;;
797 ;; State `else-boundary':
798 ;; "if": Pop state.
799 ;; boundary: Error, pop state.
800 ;; other: See common state.
801 ;;
802 ;; State `while':
803 ;; boundary: Save position, goto state `while-boundary'.
804 ;; other: Pop state, retry token.
805 ;;
806 ;; State `while-boundary':
807 ;; "do": Pop state.
808 ;; boundary: Restore position if it's not at start, pop state. [*see below]
809 ;; other: See common state.
810 ;;
811 ;; State `catch':
812 ;; boundary: Goto state `catch-boundary'.
813 ;; other: Error, pop state, retry token.
814 ;;
815 ;; State `catch-boundary':
816 ;; "try": Pop state.
817 ;; "catch": Goto state `catch'.
818 ;; boundary: Error, pop state.
819 ;; other: See common state.
820 ;;
821 ;; [*] In the `while-boundary' state, we had pushed a 'while state, and were
822 ;; searching for a "do" which would have opened a do-while. If we didn't
823 ;; find it, we discard the analysis done since the "while", go back to this
824 ;; token in the buffer and restart the scanning there, this time WITHOUT
825 ;; pushing the 'while state onto the stack.
826 ;;
827 ;; In addition to the above there is some special handling of labels
828 ;; and macros.
832 macro-start
835 c-stmt-delim-chars-with-comma
836 c-stmt-delim-chars))
837 c-maybe-labelp after-case:-pos saved
838 ;; Current position.
839 pos
840 ;; Position of last stmt boundary character (e.g. ;).
841 boundary-pos
842 ;; The position of the last sexp or bound that follows the
843 ;; first found colon, i.e. the start of the nonlabel part of
844 ;; the statement. It's `start' if a colon is found just after
845 ;; the start.
846 after-labels-pos
847 ;; Like `after-labels-pos', but the first such position inside
848 ;; a label, i.e. the start of the last label before the start
849 ;; of the nonlabel part of the statement.
850 last-label-pos
851 ;; The last position where a label is possible provided the
852 ;; statement started there. It's nil as long as no invalid
853 ;; label content has been found (according to
854 ;; `c-nonlabel-token-key'). It's `start' if no valid label
855 ;; content was found in the label. Note that we might still
856 ;; regard it a label if it starts with `c-label-kwds'.
857 label-good-pos
858 ;; Putative positions of the components of a bitfield declaration,
859 ;; e.g. "int foo : NUM_FOO_BITS ;"
860 bitfield-type-pos bitfield-id-pos bitfield-size-pos
861 ;; Symbol just scanned back over (e.g. 'while or 'boundary).
862 ;; See above.
863 sym
864 ;; Current state in the automaton. See above.
865 state
866 ;; Current saved positions. See above.
867 saved-pos
868 ;; Stack of conses (state . saved-pos).
869 stack
870 ;; Regexp which matches "for", "if", etc.
873 ;; Return value.
875 ;; Positions of the last three sexps or bounds we've stopped at.
876 tok ptok pptok)
886 ;; Try to skip back over unary operator characters, to register
887 ;; that we've moved.
891 ;; Protect post-++/-- operators just before a virtual semicolon.
895 ;; Skip back over any semicolon here. If it was a bare semicolon, we're
896 ;; done. Later on we ignore the boundaries for statements that don't
897 ;; contain any sexp. The only thing that is affected is that the error
898 ;; checking is a little less strict, and we really don't bother.
908 pos saved)
910 ;; Begin at start and not pos to detect macros if we stand
911 ;; directly after the #.
914 ;; Record this as the first token if not starting inside it.
917 ;; The following while loop goes back one sexp (balanced parens,
918 ;; etc. with contents, or symbol or suchlike) each iteration. This
919 ;; movement is accomplished with a call to c-backward-sexp approx 170
920 ;; lines below.
921 ;;
922 ;; The loop is exited only by throwing nil to the (catch 'loop ...):
923 ;; 1. On reaching the start of a macro;
924 ;; 2. On having passed a stmt boundary with the PDA stack empty;
925 ;; 3. On reaching the start of an Objective C method def;
926 ;; 4. From macro `c-bos-pop-state'; when the stack is empty;
927 ;; 5. From macro `c-bos-pop-state-and-retry' when the stack is empty.
931 ;; Are we in a macro, just after the opening #?
946 ;; Stop at the first token in the content of the macro.
950 ret 'macro
951 ignore-labels t))
954 ;; Do a round through the automaton if we've just passed a
955 ;; statement boundary or passed a "while"-like token.
963 ;; The PDA state handling.
964 ;;
965 ;; Refer to the description of the PDA in the opening
966 ;; comments. In the following OR form, the first leaf
967 ;; attempts to handles one of the specific actions detailed
968 ;; (e.g., finding token "if" whilst in state `else-boundary').
969 ;; We drop through to the second leaf (which handles common
970 ;; state) if no specific handler is found in the first cond.
971 ;; If a parsing error is detected (e.g. an "else" with no
972 ;; preceding "if"), we throw to the enclosing catch.
973 ;;
974 ;; Note that the (eq state 'else) means
975 ;; "we've just passed an else", NOT "we're looking for an
976 ;; else".
993 ;; Since this can cause backtracking we do a
994 ;; little more careful analysis to avoid it:
995 ;; If there's a label in front of the while
996 ;; it can't be part of a do-while.
1025 ;; This is state common. We get here when the previous
1026 ;; cond statement found no particular state handler.
1028 ;; If we have a boundary at the start
1029 ;; position we push a frame to go to the
1030 ;; previous statement.
1039 ;; Is this a real while, or a do-while?
1040 ;; The next `when' triggers unless we are SURE that
1041 ;; the `while' is not the tail end of a `do-while'.
1044 ;; The following kludge is to prevent
1045 ;; infinite recursion when called from
1046 ;; c-awk-after-if-for-while-condition-p,
1047 ;; or the like.
1051 ;; Since this can cause backtracking we do a
1052 ;; little more careful analysis to avoid it: If
1053 ;; the while isn't followed by a (possibly
1054 ;; virtual) semicolon it can't be a do-while.
1063 ;; We're either past a statement boundary or at the
1064 ;; start of a statement, so throw away any label data
1065 ;; for the previous one.
1067 last-label-pos nil
1068 c-maybe-labelp nil))))
1070 ;; Step to the previous sexp, but not if we crossed a
1071 ;; boundary, since that doesn't consume an sexp.
1075 ;; HERE IS THE SINGLE PLACE INSIDE THE PDA LOOP WHERE WE MOVE
1076 ;; BACKWARDS THROUGH THE SOURCE.
1080 ;; The end position of the area to search for statement
1081 ;; barriers in this round.
1084 ;; Go back over exactly one logical sexp, taking proper
1085 ;; account of macros and escaped EOLs.
1089 ;; Give up if we hit an unbalanced block. Since the
1090 ;; stack won't be empty the code below will report a
1091 ;; suitable error.
1094 ;; Have we moved into a macro?
1097 ;; Have we crossed a statement boundary? If not,
1098 ;; keep going back until we find one or a "real" sexp.
1105 ;; Have we just gone back over an escaped NL? This
1106 ;; doesn't count as a sexp.
1109 ;; Have we crossed a statement boundary?
1112 ;; Are we at a macro beginning?
1114 c-opt-cpp-prefix
1120 ;; Just gone back over a brace block?
1129 ;; Just gone back over some paren block?
1133 before-sws-pos)))
1136 ;; Just gone back over an ordinary symbol of some sort?
1142 ptok tok
1143 tok boundary-pos
1145 ;; Like a C "continue". Analyze the next sexp.
1148 ;; ObjC method def?
1155 ;; Might we have a bitfield declaration, "<type> <id> : <size>"?
1158 ;; The : <size> and <id> fields?
1168 ;; The <type> field?
1176 bitfield-id-pos nil)))))
1178 ;; Handle labels.
1181 ;; `c-crosses-statement-barrier-p' has found a colon, so we
1182 ;; might be in a label now. Have we got a real label
1183 ;; (including a case label) or something like C++'s "public:"?
1184 ;; A case label might use an expression rather than a token.
1187 ;; Catch C++'s inheritance construct "class foo : bar".
1201 ; been found.
1203 ;; We're in a potential label and it's the first
1204 ;; time we've found something that isn't allowed in
1205 ;; one.
1208 ;; We've moved back by a sexp, so update the token positions.
1210 pptok ptok
1211 ptok tok
1217 ;; If the stack isn't empty there might be errors to report.
1226 ;; Need to investigate closer whether we've crossed
1227 ;; between a substatement and its containing statement.
1231 pptok)
1233 ptok)
1241 after-labels-pos
1248 last-label-pos
1249 pos))
1251 ;; We're in a label. Maybe we should step to the statement
1252 ;; after it.
1257 ;; Might have jumped over several labels. Go to the last one.
1260 ;; Have we got "case <expression>:"?
1270 ;; Skip over the unary operators that can start the statement.
1273 ;; protect AWK post-inc/decrement operators, etc.
1278 ret)))
1281 "Return non-nil if there is a non-comment non-macro punctuation character
1282 between FROM and TO. FROM must not be in a string or comment. The returned
1283 value is the position of the first such character."
1294 "Return non-nil if buffer positions FROM to TO cross one or more
1295 statement or declaration boundaries. The returned value is actually
1296 the position of the earliest boundary char. FROM must not be within
1297 a string or comment.
1299 The variable `c-maybe-labelp' is set to the position of the first `:' that
1300 might start a label (i.e. not part of `::' and not preceded by `?'). If a
1301 single `?' is found, then `c-maybe-labelp' is cleared.
1303 For AWK, a statement which is terminated by an EOL (not a ; or a }) is
1305 the line. If this virtual semicolon is _at_ from, the function recognizes it.
1307 Note that this function might do hidden buffer changes. See the
1308 comment at the start of cc-engine.el for more info."
1310 ;; If the current language has CPP macros, insert # into skip-chars.
1313 c-opt-cpp-symbol ; usually "#"
1315 c-stmt-delim-chars))
1318 lit-range lit-start vsemi-pos)
1325 skip-chars
1329 ;; Virtual semicolon?
1339 ;; In a string/comment?
1346 ;; Ignore scope operators.
1350 ;; A question mark. Can't be a label, so stop
1351 ;; looking for more : and ?.
1354 ;; At a CPP construct or a "#" or "##" operator?
1365 ;; In trailing space after an as yet undetected virtual semicolon?
1368 ; unterminated string/regexp.
1373 nil))))))
1376 "Return non-nil if the point is at the first token in a statement
1377 or somewhere in the syntactic whitespace before it.
1380 Any kind of declaration-like construct that occur outside function
1383 Note that this function might do hidden buffer changes. See the
1384 comment at the start of cc-engine.el for more info."
1388 c-maybe-labelp)
1399 "Return non-nil if the point is at the first token in an expression or
1400 statement, or somewhere in the syntactic whitespace before it.
1403 grammar sense: It's any sequence of expression tokens except commas,
1404 unless they are enclosed inside parentheses of some kind. Also, an
1405 expression never continues past an enclosing parenthesis, but it might
1406 contain parenthesis pairs of any sort except braces.
1408 Since expressions never cross statement boundaries, this function also
1409 recognizes statement beginnings, just like `c-at-statement-start-p'.
1411 Note that this function might do hidden buffer changes. See the
1412 comment at the start of cc-engine.el for more info."
1417 c-maybe-labelp)
1425 \f
1426 ;; A set of functions that covers various idiosyncrasies in
1427 ;; implementations of `forward-comment'.
1429 ;; Note: Some emacsen considers incorrectly that any line comment
1430 ;; ending with a backslash continues to the next line. I can't think
1431 ;; of any way to work around that in a reliable way without changing
1432 ;; the buffer, though. Suggestions welcome. ;) (No, temporarily
1433 ;; changing the syntax for backslash doesn't work since we must treat
1434 ;; escapes in string literals correctly.)
1437 "Move forward past whitespace and the closest following comment, if any.
1438 Return t if a comment was found, nil otherwise. In either case, the
1439 point is moved past the following whitespace. Line continuations,
1440 i.e. a backslashes followed by line breaks, are treated as whitespace.
1441 The line breaks that end line comments are considered to be the
1442 comment enders, so the point will be put on the beginning of the next
1443 line if it moved past a line comment.
1445 This function does not do any hidden buffer changes."
1453 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1454 ;; forwards at eob.
1455 nil
1457 ;; Emacs includes the ending newline in a b-style (c++)
1458 ;; comment, but XEmacs doesn't. We depend on the Emacs
1459 ;; behavior (which also is symmetric).
1463 t))))
1466 "Move forward past all following whitespace and comments.
1467 Line continuations, i.e. a backslashes followed by line breaks, are
1468 treated as whitespace.
1470 Note that this function might do hidden buffer changes. See the
1471 comment at the start of cc-engine.el for more info."
1474 ;; If forward-comment in at least XEmacs 21 is given a large
1475 ;; positive value, it'll loop all the way through if it hits
1476 ;; eob.
1478 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1479 ;; forwards at eob.
1484 t))))
1487 "Move backward past whitespace and the closest preceding comment, if any.
1488 Return t if a comment was found, nil otherwise. In either case, the
1489 point is moved past the preceding whitespace. Line continuations,
1490 i.e. a backslashes followed by line breaks, are treated as whitespace.
1491 The line breaks that end line comments are considered to be the
1492 comment enders, so the point cannot be at the end of the same line to
1493 move over a line comment.
1495 This function does not do any hidden buffer changes."
1498 ;; When we got newline terminated comments, forward-comment in all
1499 ;; supported emacsen so far will stop at eol of each line not
1500 ;; ending with a comment when moving backwards. This corrects for
1501 ;; that, and at the same time handles line continuations.
1509 ;; Some emacsen (e.g. Emacs 19.34) return t when moving
1510 ;; backwards at bob.
1511 nil
1513 ;; Leave point after the closest following newline if we've
1514 ;; backed up over any above, since forward-comment won't move
1515 ;; backward over a line comment if point is at the end of the
1516 ;; same line.
1521 ;; If forward-comment above succeeded and we're at eol
1522 ;; then the newline we moved over above didn't end a
1523 ;; line comment, so we give it another go.
1525 t))
1527 ;; Emacs <= 20 and XEmacs move back over the closer of a
1528 ;; block comment that lacks an opener.
1531 t)))))
1534 "Move backward past all preceding whitespace and comments.
1535 Line continuations, i.e. a backslashes followed by line breaks, are
1536 treated as whitespace. The line breaks that end line comments are
1537 considered to be the comment enders, so the point cannot be at the end
1538 of the same line to move over a line comment. Unlike
1539 c-backward-syntactic-ws, this function doesn't move back over
1540 preprocessor directives.
1542 Note that this function might do hidden buffer changes. See the
1543 comment at the start of cc-engine.el for more info."
1547 ;; `forward-comment' in some emacsen (e.g. XEmacs 21.4)
1548 ;; return t when moving backwards at bob.
1554 ;; Cope specifically with ^M^J here -
1555 ;; forward-comment sometimes gets stuck after ^Ms,
1556 ;; sometimes after ^M^J.
1560 t)
1564 t))))
1565 moved-comment)
1567 ;; Emacs <= 20 and XEmacs move back over the
1568 ;; closer of a block comment that lacks an opener.
1570 t)
1572 ;; XEmacs treats line continuations as whitespace but
1573 ;; only in the backward direction, which seems a bit
1574 ;; odd. Anyway, this is necessary for Emacs.
1579 t))))))
1581 \f
1582 ;; Tools for skipping over syntactic whitespace.
1584 ;; The following functions use text properties to cache searches over
1585 ;; large regions of syntactic whitespace. It works as follows:
1586 ;;
1587 ;; o If a syntactic whitespace region contains anything but simple
1588 ;; whitespace (i.e. space, tab and line breaks), the text property
1589 ;; `c-in-sws' is put over it. At places where we have stopped
1590 ;; within that region there's also a `c-is-sws' text property.
1591 ;; That since there typically are nested whitespace inside that
1592 ;; must be handled separately, e.g. whitespace inside a comment or
1593 ;; cpp directive. Thus, from one point with `c-is-sws' it's safe
1594 ;; to jump to another point with that property within the same
1595 ;; `c-in-sws' region. It can be likened to a ladder where
1596 ;; `c-in-sws' marks the bars and `c-is-sws' the rungs.
1597 ;;
1598 ;; o The `c-is-sws' property is put on the simple whitespace chars at
1599 ;; a "rung position" and also maybe on the first following char.
1600 ;; As many characters as can be conveniently found in this range
1601 ;; are marked, but no assumption can be made that the whole range
1602 ;; is marked (it could be clobbered by later changes, for
1603 ;; instance).
1604 ;;
1605 ;; Note that some part of the beginning of a sequence of simple
1606 ;; whitespace might be part of the end of a preceding line comment
1607 ;; or cpp directive and must not be considered part of the "rung".
1608 ;; Such whitespace is some amount of horizontal whitespace followed
1609 ;; by a newline. In the case of cpp directives it could also be
1610 ;; two newlines with horizontal whitespace between them.
1611 ;;
1612 ;; The reason to include the first following char is to cope with
1613 ;; "rung positions" that don't have any ordinary whitespace. If
1614 ;; `c-is-sws' is put on a token character it does not have
1615 ;; `c-in-sws' set simultaneously. That's the only case when that
1616 ;; can occur, and the reason for not extending the `c-in-sws'
1617 ;; region to cover it is that the `c-in-sws' region could then be
1618 ;; accidentally merged with a following one if the token is only
1619 ;; one character long.
1620 ;;
1621 ;; o On buffer changes the `c-in-sws' and `c-is-sws' properties are
1622 ;; removed in the changed region. If the change was inside
1623 ;; syntactic whitespace that means that the "ladder" is broken, but
1624 ;; a later call to `c-forward-sws' or `c-backward-sws' will use the
1625 ;; parts on either side and use an ordinary search only to "repair"
1626 ;; the gap.
1627 ;;
1628 ;; Special care needs to be taken if a region is removed: If there
1629 ;; are `c-in-sws' on both sides of it which do not connect inside
1630 ;; the region then they can't be joined. If e.g. a marked macro is
1631 ;; broken, syntactic whitespace inside the new text might be
1632 ;; marked. If those marks would become connected with the old
1633 ;; `c-in-sws' range around the macro then we could get a ladder
1634 ;; with one end outside the macro and the other at some whitespace
1635 ;; within it.
1636 ;;
1637 ;; The main motivation for this system is to increase the speed in
1638 ;; skipping over the large whitespace regions that can occur at the
1639 ;; top level in e.g. header files that contain a lot of comments and
1640 ;; cpp directives. For small comments inside code it's probably
1641 ;; slower than using `forward-comment' straightforwardly, but speed is
1642 ;; not a significant factor there anyway.
1644 ; (defface c-debug-is-sws-face
1645 ; '((t (:background "GreenYellow")))
1646 ; "Debug face to mark the `c-is-sws' property.")
1647 ; (defface c-debug-in-sws-face
1648 ; '((t (:underline t)))
1649 ; "Debug face to mark the `c-in-sws' property.")
1651 ; (defun c-debug-put-sws-faces ()
1652 ; ;; Put the sws debug faces on all the `c-is-sws' and `c-in-sws'
1653 ; ;; properties in the buffer.
1654 ; (interactive)
1655 ; (save-excursion
1656 ; (c-save-buffer-state (in-face)
1657 ; (goto-char (point-min))
1658 ; (setq in-face (if (get-text-property (point) 'c-is-sws)
1659 ; (point)))
1660 ; (while (progn
1661 ; (goto-char (next-single-property-change
1662 ; (point) 'c-is-sws nil (point-max)))
1663 ; (if in-face
1664 ; (progn
1665 ; (c-debug-add-face in-face (point) 'c-debug-is-sws-face)
1666 ; (setq in-face nil))
1667 ; (setq in-face (point)))
1668 ; (not (eobp))))
1669 ; (goto-char (point-min))
1670 ; (setq in-face (if (get-text-property (point) 'c-in-sws)
1671 ; (point)))
1672 ; (while (progn
1673 ; (goto-char (next-single-property-change
1674 ; (point) 'c-in-sws nil (point-max)))
1675 ; (if in-face
1676 ; (progn
1677 ; (c-debug-add-face in-face (point) 'c-debug-in-sws-face)
1678 ; (setq in-face nil))
1679 ; (setq in-face (point)))
1680 ; (not (eobp)))))))
1684 ;;`(message ,@args)
1685 )
1688 ;; This macro does a hidden buffer change.
1695 ;; This macro does a hidden buffer change.
1702 ;; This macro does a hidden buffer change.
1709 ;; This macro does a hidden buffer change.
1716 ;; This macro does a hidden buffer change.
1723 ;; The type of literal position `end' is in a `before-change-functions'
1724 ;; function - one of `c', `c++', `pound', or nil (but NOT `string').
1726 ;; A cons (START . STOP) of the bounds of the comment or CPP construct
1727 ;; enclosing END, if any, else nil.
1731 ;; Called from c-before-change. END is the end of the change region, the
1732 ;; standard parameter given to all before-change-functions.
1733 ;;
1734 ;; Note whether END is inside a comment or CPP construct, and if so note its
1735 ;; bounds in `c-sws-lit-limits' and type in `c-sws-lit-type'.
1743 c-sws-lit-limits limits))
1749 c-sws-lit-limits nil))))))
1752 ;; Text has been deleted, OLD-LEN characters of it starting from position
1753 ;; BEG. END is typically eq to BEG. Should there have been a comment or
1754 ;; CPP construct open at END before the deletion, check whether this
1755 ;; deletion deleted or "damaged" its opening delimiter. If so, return the
1756 ;; current position of where the construct ended, otherwise return nil.
1760 ; comment delimiters are 2
1761 ; chars long.
1771 ;; Text has been inserted, ending at buffer position END. Should there be a
1772 ;; literal or CPP construct open at END, check whether there are `c-in-sws'
1773 ;; or `c-is-sws' text properties inside this literal. If there are, return
1774 ;; the buffer position of the end of the literal, else return nil.
1793 ;; Called from `after-change-functions'. Remove any stale `c-in-sws' or
1794 ;; `c-is-sws' text properties from the vicinity of the change. BEG, END,
1795 ;; and OLD-LEN are the standard arguments given to after-change functions.
1796 ;;
1797 ;; Note that if `c-forward-sws' or `c-backward-sws' are used outside
1798 ;; `c-save-buffer-state' or similar then this will remove the cache
1799 ;; properties right after they're added.
1800 ;;
1801 ;; This function does hidden buffer changes.
1809 ;; Adjust the end to remove the properties in any following simple
1810 ;; ws up to and including the next line break, if there is any
1811 ;; after the changed region. This is necessary e.g. when a rung
1812 ;; marked empty line is converted to a line comment by inserting
1813 ;; "//" before the line break. In that case the line break would
1814 ;; keep the rung mark which could make a later `c-backward-sws'
1815 ;; move into the line comment instead of over it.
1825 ;; Ensure that an `c-in-sws' range gets broken. Note that it isn't
1826 ;; safe to keep a range that was continuous before the change. E.g:
1827 ;;
1828 ;; #define foo
1829 ;; \
1830 ;; bar
1831 ;;
1832 ;; There can be a "ladder" between "#" and "b". Now, if the newline
1833 ;; after "foo" is removed then "bar" will become part of the cpp
1834 ;; directive instead of a syntactically relevant token. In that
1835 ;; case there's no longer syntactic ws from "#" to "b".
1840 end))
1846 ;; Used by `c-forward-syntactic-ws' to implement the unbounded search.
1847 ;;
1848 ;; This function might do hidden buffer changes.
1851 ;; unmarked part of the simple ws region.
1853 rung-is-marked next-rung-is-marked simple-ws-end macro-start macro-end
1854 ;; `safe-start' is set when it's safe to cache the start position.
1855 ;; This is the case except when we have an unterminated block comment
1856 ;; within a macro.
1857 safe-start)
1859 ;; Skip simple ws and do a quick check on the following character to see
1860 ;; if it's anything that can't start syntactic ws, so we can bail out
1861 ;; early in the majority of cases when there just are a few ws chars.
1870 ;; Find the last rung position to avoid setting properties in all
1871 ;; the cases when the marked rung is complete.
1872 ;; (`next-single-property-change' is certain to move at least one
1873 ;; step forward.)
1876 ;; Got no marked rung here. Since the simple ws might have started
1877 ;; inside a line comment or cpp directive we must set `rung-pos' as
1878 ;; high as possible.
1884 ;; In the following while form, we move over a "ladder" and
1885 ;; following simple WS each time round the loop, appending the WS
1886 ;; onto the ladder, joining adjacent ladders, and terminating when
1887 ;; there is no more WS or we reach EOB.
1892 ;; The following search is the main reason that `c-in-sws'
1893 ;; and `c-is-sws' aren't combined to one property.
1897 ;; If the `c-in-sws' region extended past the last
1898 ;; `c-is-sws' char we have to go back a bit.
1905 "c-forward-sws cached move %s -> %s (max %s)"
1912 ;; We'll loop here if there is simple ws after the last rung.
1913 ;; That means that there's been some change in it and it's
1914 ;; possible that we've stepped into another ladder, so extend
1915 ;; the previous one to join with it if there is one, and try to
1916 ;; use the cache again.
1918 "c-forward-sws extending rung with [%s..%s] (max %s)"
1921 ;; Remove any `c-in-sws' property from the last char of
1922 ;; the rung before we mark it with `c-is-sws', so that we
1923 ;; won't connect with the remains of a broken "ladder".
1929 last-put-in-sws-pos rung-pos)))
1931 ;; Now move over any comments (x)or a CPP construct.
1934 ;; Take elaborate precautions to detect an open block comment at
1935 ;; the end of a macro. If we find one, we set `safe-start' to nil
1936 ;; and break off any further scanning of comments.
1958 safe-start)))
1963 ;; Skipped over comments. Don't cache at eob in case the buffer
1964 ;; is narrowed.
1976 ;; Skip a preprocessor directive.
1982 ;; Check for an open block comment at the end of the macro.
1988 ;; Don't cache at eob in case the buffer is narrowed.
1993 ;; Skip over a noise macro.
1997 ;; We've searched over a piece of non-white syntactic ws. See if this
1998 ;; can be cached.
2004 ;; Cache if we haven't skipped comments only, and if we started
2005 ;; either from a marked rung or from a completely uncached
2006 ;; position.
2011 ;; See if there's a marked rung in the encountered simple ws. If
2012 ;; so then we can cache, unless `safe-start' is nil. Even then
2013 ;; we need to do this to check if the cache can be used for the
2014 ;; next step.
2018 safe-start))
2022 "c-forward-sws caching [%s..%s] - [%s..%s] (max %s)"
2026 ;; Remove the properties for any nested ws that might be cached.
2027 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
2028 ;; anyway.
2036 last-put-in-sws-pos rung-pos))
2038 ;; Remove any `c-in-sws' property from the last char of
2039 ;; the rung before we mark it with `c-is-sws', so that we
2040 ;; won't connect with the remains of a broken "ladder".
2043 rung-end-pos))
2046 "c-forward-sws not caching [%s..%s] - [%s..%s] (max %s)"
2050 ;; Set `rung-pos' for the next rung. It's the same thing here as
2051 ;; initially, except that the rung position is set as early as
2052 ;; possible since we can't be in the ending ws of a line comment or
2053 ;; cpp directive now.
2059 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
2060 ;; another one after the point (which might occur when editing inside a
2061 ;; comment or macro).
2065 "c-forward-sws clearing at %s for cache separation"
2066 last-put-in-sws-pos)
2070 ;; If at eob we have to clear the last character before the end
2071 ;; instead since the buffer might be narrowed and there might
2072 ;; be a `c-in-sws' after (point-max). In this case it's
2073 ;; necessary to clear both properties.
2075 "c-forward-sws clearing thoroughly at %s for cache separation"
2078 last-put-in-sws-pos))))
2079 ))))
2082 ;; Used by `c-backward-syntactic-ws' to implement the unbounded search.
2083 ;;
2084 ;; This function might do hidden buffer changes.
2087 ;; part of the simple ws region.
2089 rung-is-marked simple-ws-beg cmt-skip-pos)
2091 ;; Skip simple horizontal ws and do a quick check on the preceding
2092 ;; character to see if it's anything that can't end syntactic ws, so we can
2093 ;; bail out early in the majority of cases when there just are a few ws
2094 ;; chars. Newlines are complicated in the backward direction, so we can't
2095 ;; skip over them.
2105 ;; Try to find a rung position in the simple ws preceding point, so that
2106 ;; we can get a cache hit even if the last bit of the simple ws has
2107 ;; changed recently.
2113 ;; `rung-pos' will be the earliest marked position, which means that
2114 ;; there might be later unmarked parts in the simple ws region.
2115 ;; It's not worth the effort to fix that; the last part of the
2116 ;; simple ws is also typically edited often, so it could be wasted.
2123 ;; Each time round the next while form, we move back over a ladder
2124 ;; and append any simple WS preceding it, if possible joining with
2125 ;; the previous ladder.
2131 ;; The following search is the main reason that `c-in-sws'
2132 ;; and `c-is-sws' aren't combined to one property.
2136 ;; If the `c-in-sws' region extended past the first
2137 ;; `c-is-sws' char we have to go forward a bit.
2142 "c-backward-sws cached move %s <- %s (min %s)"
2154 t
2156 nil))
2158 ;; We'll loop here if there is simple ws before the first rung.
2159 ;; That means that there's been some change in it and it's
2160 ;; possible that we've stepped into another ladder, so extend
2161 ;; the previous one to join with it if there is one, and try to
2162 ;; use the cache again.
2164 "c-backward-sws extending rung with [%s..%s] (min %s)"
2167 ;; Remove any `c-in-sws' property from the last char of
2168 ;; the rung before we mark it with `c-is-sws', so that we
2169 ;; won't connect with the remains of a broken "ladder".
2172 rung-pos)
2176 last-put-in-sws-pos rung-pos))
2185 ;; Inside a cpp directive. See if it should be skipped over.
2188 ;; Move back over all line continuations in the region skipped
2189 ;; over by `c-backward-comments'. If we go past it then we
2190 ;; started inside the cpp directive.
2199 ;; Don't move past the cpp directive if we began inside
2200 ;; it. Note that the position at the end of the last line
2201 ;; of the macro is also considered to be within it.
2203 nil)
2205 ;; It's worthwhile to spend a little bit of effort on finding
2206 ;; the end of the macro, to get a good `simple-ws-beg'
2207 ;; position for the cache. Note that `c-backward-comments'
2208 ;; could have stepped over some comments before going into
2209 ;; the macro, and then `simple-ws-beg' must be kept on the
2210 ;; same side of those comments.
2217 ;; Might happen if comments after the macro were skipped
2218 ;; over.
2222 t)))
2227 simple-ws-beg)
2228 ;; Skipped over comments. Must put point at the end of
2229 ;; the simple ws at point since we might be after a line
2230 ;; comment or cpp directive that's been partially
2231 ;; narrowed out, and we can't risk marking the simple ws
2232 ;; at the end of it.
2234 t)
2241 ;; Skipped over a noise macro
2243 t)))
2245 ;; We've searched over a piece of non-white syntactic ws. See if this
2246 ;; can be cached.
2251 ;; Cache if we started either from a marked rung or from a
2252 ;; completely uncached position.
2253 rung-is-marked
2256 ;; Cache if there's a marked rung in the encountered simple ws.
2264 "c-backward-sws caching [%s..%s] - [%s..%s] (min %s)"
2269 ;; Remove the properties for any nested ws that might be cached.
2270 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
2271 ;; anyway.
2276 ;; Remove any `c-in-sws' property from the last char of
2277 ;; the rung before we mark it with `c-is-sws', so that we
2278 ;; won't connect with the remains of a broken "ladder".
2281 rung-end-pos)
2284 last-put-in-sws-pos simple-ws-beg)
2285 rung-pos)
2290 "c-backward-sws not caching [%s..%s] - [%s..%s] (min %s)"
2296 ))
2298 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
2299 ;; another one before the point (which might occur when editing inside a
2300 ;; comment or macro).
2304 "c-backward-sws clearing at %s for cache separation"
2307 last-put-in-sws-pos))
2309 ;; If at bob and the buffer is narrowed, we have to clear the
2310 ;; character we're standing on instead since there might be a
2311 ;; `c-in-sws' before (point-min). In this case it's necessary
2312 ;; to clear both properties.
2314 "c-backward-sws clearing thoroughly at %s for cache separation"
2315 last-put-in-sws-pos)
2318 ))))
2320 \f
2321 ;; Other whitespace tools
2323 ;; Is the region (beg end) WS, and is there WS (or BOB/EOB) next to the
2324 ;; region? This is a "heuristic" function. .....
2325 ;;
2326 ;; The motivation for the second bit is to check whether removing this
2327 ;; region would coalesce two symbols.
2328 ;;
2329 ;; FIXME!!! This function doesn't check virtual semicolons in any way. Be
2330 ;; careful about using this function for, e.g. AWK. (2007/3/7)
2339 \f
2340 ;; A system for finding noteworthy parens before the point.
2343 ;; A maximum comfortable scanning distance, e.g. between
2344 ;; `c-state-cache-good-pos' and "HERE" (where we call c-parse-state). When
2345 ;; this distance is exceeded, we take "emergency measures", e.g. by clearing
2346 ;; the cache and starting again from point-min or a beginning of defun. This
2347 ;; value can be tuned for efficiency or set to a lower value for testing.
2351 ;; The state cache used by `c-parse-state' to cut down the amount of
2352 ;; searching. It's the result from some earlier `c-parse-state' call. See
2353 ;; `c-parse-state''s doc string for details of its structure.
2354 ;;
2355 ;; The use of the cached info is more effective if the next
2356 ;; `c-parse-state' call is on a line close by the one the cached state
2357 ;; was made at; the cache can actually slow down a little if the
2358 ;; cached state was made very far back in the buffer. The cache is
2359 ;; most effective if `c-parse-state' is used on each line while moving
2360 ;; forward.
2364 ;; This is a position where `c-state-cache' is known to be correct, or
2365 ;; nil (see below). It's a position inside one of the recorded unclosed
2366 ;; parens or the top level, but not further nested inside any literal or
2367 ;; subparen that is closed before the last recorded position.
2368 ;;
2369 ;; The exact position is chosen to try to be close to yet earlier than
2370 ;; the position where `c-state-cache' will be called next. Right now
2371 ;; the heuristic is to set it to the position after the last found
2372 ;; closing paren (of any type) before the line on which
2373 ;; `c-parse-state' was called. That is chosen primarily to work well
2374 ;; with refontification of the current line.
2375 ;;
2376 ;; 2009-07-28: When `c-state-point-min' and the last position where
2377 ;; `c-parse-state' or for which `c-invalidate-state-cache' was called, are
2378 ;; both in the same literal, there is no such "good position", and
2379 ;; c-state-cache-good-pos is then nil. This is the ONLY circumstance in which
2380 ;; it can be nil. In this case, `c-state-point-min-literal' will be non-nil.
2381 ;;
2382 ;; 2009-06-12: In a brace desert, c-state-cache-good-pos may also be in
2383 ;; the middle of the desert, as long as it is not within a brace pair
2384 ;; recorded in `c-state-cache' or a paren/bracket pair.
2386 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2387 ;; We maintain a simple cache of positions which aren't in a literal, so as to
2388 ;; speed up testing for non-literality.
2390 ;; The approximate interval between entries in `c-state-nonlit-pos-cache'.
2394 ;; A list of buffer positions which are known not to be in a literal or a cpp
2395 ;; construct. This is ordered with higher positions at the front of the list.
2396 ;; Only those which are less than `c-state-nonlit-pos-cache-limit' are valid.
2400 ;; An upper limit on valid entries in `c-state-nonlit-pos-cache'. This is
2401 ;; reduced by buffer changes, and increased by invocations of
2402 ;; `c-state-literal-at'.
2406 ;; A list of elements which are either buffer positions (when such positions
2407 ;; are not in literals) or lists of the form (POS TYPE START), where POS is
2408 ;; a buffer position inside a literal, TYPE is the type of the literal
2409 ;; ('string, 'c, or 'c++) and START is the start of the literal.
2413 ;; An upper limit on valid entries in `c-state-semi-nonlit-pos-cache'. This
2414 ;; is reduced by buffer changes, and increased by invocations of
2415 ;; `c-parse-ps-state-below'.
2418 ;; Truncate the upper bound of the cache `c-state-semi-nonlit-pos-cache' to
2419 ;; POS, if it is higher than that position.
2424 ;; Do a parse-partial-sexp from a position in the buffer before HERE which
2425 ;; isn't in a literal, and return information about HERE, either:
2426 ;; (STATE TYPE BEG) if HERE is in a literal; or
2427 ;; (STATE) otherwise,
2428 ;; where STATE is the parsing state at HERE, TYPE is the type of the literal
2429 ;; enclosing HERE, (one of 'string, 'c, 'c++) and BEG is the starting
2430 ;; position of that literal (including the delimiter).
2431 ;;
2432 ;; Unless NOT-IN-DELIMITER is non-nil, when TO is inside a two-character
2433 ;; comment opener, this is recognized as being in a comment literal.
2434 ;;
2435 ;; Only elements 3 (in a string), 4 (in a comment), 5 (following a quote), 7
2436 ;; (comment type), and 8 (start of comment/string), and possibly 10 (in
2437 ;; newer Emacsen only, the syntax of a position after a potential first char
2438 ;; of a two char construct) of STATE are valid.
2447 ty)
2470 ;; This function will supersede c-state-pp-to-literal.
2471 ;;
2472 ;; Do a parse-partial-sexp from a position in the buffer before HERE which
2473 ;; isn't in a literal, and return information about HERE, either:
2474 ;; (STATE TYPE (BEG . END)) if HERE is in a literal; or
2475 ;; (STATE) otherwise,
2476 ;; where STATE is the parsing state at HERE, TYPE is the type of the literal
2477 ;; enclosing HERE, (one of 'string, 'c, 'c++) and (BEG . END) is the
2478 ;; boundaries of that literal (including the delimiters).
2479 ;;
2480 ;; Unless NOT-IN-DELIMITER is non-nil, when TO is inside a two-character
2481 ;; comment opener, this is recognized as being in a comment literal.
2482 ;;
2483 ;; Only elements 3 (in a string), 4 (in a comment), 5 (following a quote), 7
2484 ;; (comment type), and 8 (start of comment/string), and possibly 10 (in
2485 ;; newer Emacsen only, the syntax of a position after a potential first char
2486 ;; of a two char construct) of STATE are valid.
2495 ty start)
2506 nil ; TARGETDEPTH
2507 nil ; STOPBEFORE
2508 s ; OLDSTATE
2526 ;; Do a parse-partial-sexp from FROM to TO, returning either
2527 ;; (STATE TYPE (BEG . END)) if TO is in a literal; or
2528 ;; (STATE) otherwise,
2529 ;; where STATE is the parsing state at TO, TYPE is the type of the literal
2530 ;; (one of 'c, 'c++, 'string) and (BEG . END) is the boundaries of the literal,
2531 ;; including the delimiters.
2532 ;;
2533 ;; Unless NOT-IN-DELIMITER is non-nil, when TO is inside a two-character
2534 ;; comment opener, this is recognized as being in a comment literal.
2535 ;;
2536 ;; Only elements 3 (in a string), 4 (in a comment), 5 (following a quote),
2537 ;; 7 (comment type) and 8 (start of comment/string) (and possibly 9) of
2538 ;; STATE are valid.
2542 ty co-st)
2552 nil ; TARGETDEPTH
2553 nil ; STOPBEFORE
2554 s ; OLDSTATE
2571 ;; Create a list suitable to use as the old-state parameter to
2572 ;; `parse-partial-sexp', out of ELT, a member of
2573 ;; `c-state-semi-nonlit-pos-cache'. ELT is either just a number, or a list
2574 ;; with 2, 3, or 4 members (See `c-parse-ps-state-to-cache'). That number
2575 ;; or the car of the list is the "position element" of ELT, the position
2576 ;; where ELT is valid.
2577 ;;
2578 ;; POINT is left at the postition for which the returned state is valid. It
2579 ;; will be either the position element of ELT, or one character before
2580 ;; that. (The latter happens in Emacs <= 25 and XEmacs, when ELT indicates
2581 ;; its position element directly follows a potential first character of a
2582 ;; two char construct (such as a comment opener or an escaped character).)
2584 ;; Inside a string or comment
2599 elt)))
2604 in-string in-comment after-quote
2605 min-depth com-style com-str-start
2606 intermediate char-1))
2609 pos))
2611 in-string in-comment nil
2612 min-depth com-style com-str-start
2613 intermediate)))
2615 ;; Not in a string or comment.
2621 0 nil nil nil
2626 nil
2630 ;; Convert STATE, a `parse-partial-sexp' state valid at POINT, to an element
2631 ;; for the `c-state-semi-nonlit-pos-cache' cache. This is one of
2632 ;; o - POINT (when point is not in a literal);
2633 ;; o - (POINT CHAR-1) (when the last character before point is potentially
2634 ;; the first of a two-character construct
2635 ;; o - (POINT TYPE STARTING-POS) (when in a literal);
2636 ;; o - (POINT TYPE STARTING-POS CHAR-1) (Combination of the previous two),
2637 ;; where TYPE is the type of the literal (either 'c, or 'c++, or the
2638 ;; character which closes the string), STARTING-POS is the starting
2639 ;; position of the comment or string. CHAR-1 is either the character
2640 ;; potentially forming the first half of a two-char construct (in Emacs <=
2641 ;; 25 and XEmacs) or the syntax of the character (in Emacs >= 26).
2643 ;; Emacs >= 26.
2657 basic
2660 basic))
2662 ;; Emacs <= 25, XEmacs.
2675 ?*)
2684 ;; Get the buffer position from ELT, an element from the cache
2685 ;; `c-state-semi-nonlit-pos-cache'.
2687 elt
2691 ;; Given a buffer position HERE, Return a cons (CACHE-POS . STATE), where
2692 ;; CACHE-POS is a position not very far before HERE for which the
2693 ;; parse-partial-sexp STATE is valid. Note that the only valid elements of
2694 ;; STATE are those concerning comments and strings; STATE is the state of a
2695 ;; null `parse-partial-sexp' scan when CACHE-POS is not in a comment or
2696 ;; string.
2701 elt state npos high-elt)
2702 ;; Trim the cache to take account of buffer changes.
2704 c-state-semi-nonlit-pos-cache-limit))
2719 ;; We need to extend the cache. Add an element to
2720 ;; `c-state-semi-nonlit-pos-cache' each iteration of the following.
2734 ;; Return a buffer position before HERE which is "safe", i.e. outside any
2735 ;; string, comment, or macro.
2736 ;;
2737 ;; NOTE: This function manipulates `c-state-nonlit-pos-cache'. This cache
2738 ;; MAY NOT contain any positions within macros, since macros are frequently
2739 ;; turned into comments by use of the `c-cpp-delimiter' category properties.
2740 ;; We cannot rely on this mechanism whilst determining a cache pos since
2741 ;; this function is also called from outwith `c-parse-state'.
2746 pos npos high-pos lit macro-beg macro-end)
2747 ;; Trim the cache to take account of buffer changes.
2759 ;; Add an element to `c-state-nonlit-pos-cache' each iteration.
2765 ;; Test for being in a literal. If so, go to after it.
2772 ;; Test for being in a macro. If so, go to after it.
2787 ;; Add one extra element above HERE so as to avoid the previous
2788 ;; expensive calculation when the next call is close to the current
2789 ;; one. This is especially useful when inside a large macro.
2796 pos))))
2799 ;; If position HERE is inside a literal, return (START . END), the
2800 ;; boundaries of the literal (which may be outside the accessible bit of the
2801 ;; buffer). Otherwise, return nil.
2802 ;;
2803 ;; This function is almost the same as `c-literal-limits'. Previously, it
2804 ;; differed in that it was a lower level function, and that it rigorously
2805 ;; followed the syntax from BOB. `c-literal-limits' is now (2011-12)
2806 ;; virtually identical to this function.
2814 ;; Return the start of the literal containing POS, or POS itself.
2816 pos))
2819 ;; Return a position outside of a string/comment/macro at or before POS.
2820 ;; STATE is the parse-partial-sexp state at POS.
2825 pos)))
2830 res))))
2832 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2833 ;; Stuff to do with point-min, and coping with any literal there.
2836 ;; This is (point-min) when `c-state-cache' was last calculated. A change of
2837 ;; narrowing is likely to affect the parens that are visible before the point.
2843 ;; These two variables define the literal, if any, containing point-min.
2844 ;; Their values are, respectively, 'string, c, or c++, and the start of the
2845 ;; literal. If there's no literal there, they're both nil.
2849 ;; This is the earliest buffer-pos from which scanning can be done. It is
2850 ;; either the end of the literal containing point-min, or point-min itself.
2851 ;; It becomes nil if the buffer is changed earlier than this point.
2853 ;; Return the lowest valid scanning pos. This will be the end of the
2854 ;; literal enclosing point-min, or point-min itself.
2866 ;; Determine the properties of any literal containing POINT-MIN, setting the
2867 ;; variables `c-state-point-min-lit-type', `c-state-point-min-lit-start',
2868 ;; and `c-state-min-scan-pos' accordingly. The return value is meaningless.
2870 lit)
2885 c-state-point-min-lit-start nil
2886 c-state-min-scan-pos p-min)))))
2889 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2890 ;; A variable which signals a brace dessert - helpful for reducing the number
2891 ;; of fruitless backward scans.
2894 ;; Used only in `c-append-lower-brace-pair-to-state-cache'. It is set when
2895 ;; that defun has searched backwards for a brace pair and not found one. Its
2896 ;; value is either nil or a cons (PA . FROM), where PA is the position of the
2897 ;; enclosing opening paren/brace/bracket which bounds the backwards search (or
2898 ;; nil when at top level) and FROM is where the backward search started. It
2899 ;; is reset to nil in `c-invalidate-state-cache'.
2902 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2903 ;; Lowish level functions/macros which work directly on `c-state-cache', or a
2904 ;; list of like structure.
2906 ;; Return the address of the top left brace/bracket/paren recorded in CACHE
2907 ;; (default `c-state-cache') (or nil).
2914 ;; Return the address of the latest brace/bracket/paren (whether left or
2915 ;; right) recorded in CACHE (default `c-state-cache') or nil.
2922 ;; Return the position just after the latest brace/bracket/paren (whether
2923 ;; left or right) recorded in CACHE (default `c-state-cache') or nil.
2931 ;; From the state-cache, determine the buffer position from which we might
2932 ;; scan forward to HERE to update this cache. This position will be just
2933 ;; after a paren/brace/bracket recorded in the cache, if possible, otherwise
2934 ;; return the earliest position in the accessible region which isn't within
2935 ;; a literal. If the visible portion of the buffer is entirely within a
2936 ;; literal, return NIL.
2938 ;(while (>= (or (c-state-cache-top-lparen c) 1) here)
2954 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2955 ;; Variables which keep track of preprocessor constructs.
2964 ;; These are the limits of the macro containing point at the previous call of
2965 ;; `c-parse-state', or nil.
2967 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2968 ;; Defuns which analyze the buffer, yet don't change `c-state-cache'.
2970 ;; Return a start position for building `c-state-cache' from
2971 ;; scratch. This will be at the top level, 2 defuns back.
2973 ;; Go back 2 bods, but ignore any bogus positions returned by
2974 ;; beginning-of-defun (i.e. open paren in column zero).
2984 ;; Return the position of the opening paren/brace/bracket before HERE- which
2985 ;; matches the outermost close p/b/b between HERE+ and TOP. Except when
2986 ;; there's a macro, HERE- and HERE+ are the same. Like this:
2987 ;;
2988 ;; ............................................
2989 ;; | |
2990 ;; ( [ ( .........#macro.. ) ( ) ] )
2991 ;; ^ ^ ^ ^
2992 ;; | | | |
2993 ;; return HERE- HERE+ TOP
2994 ;;
2995 ;; If there aren't enough opening paren/brace/brackets, return the position
2996 ;; of the outermost one found, or HERE- if there are none. If there are no
2997 ;; closing p/b/bs between HERE+ and TOP, return HERE-. HERE-/+ and TOP
2998 ;; must not be inside literals. Only the accessible portion of the buffer
2999 ;; will be scanned.
3001 ;; PART 1: scan from `here+' up to `top', accumulating ")"s which enclose
3002 ;; `here'. Go round the next loop each time we pass over such a ")". These
3003 ;; probably match "("s before `here-'.
3015 ;; PART 2: Scan back before `here-' searching for the "("s
3016 ;; matching/mismatching the ")"s found above. We only need to direct the
3017 ;; caller to scan when we've encountered unmatched right parens.
3026 pos))
3029 ;; Determine the scanning strategy for adjusting `c-parse-state', attempting
3030 ;; to minimize the amount of scanning. HERE is the pertinent position in
3031 ;; the buffer, GOOD-POS is a position where `c-state-cache' (possibly with
3032 ;; its head trimmed) is known to be good, or nil if there is no such
3033 ;; position.
3034 ;;
3035 ;; The return value is a list, one of the following:
3036 ;;
3037 ;; o - ('forward START-POINT) - scan forward from START-POINT,
3038 ;; which is not less than the highest position in `c-state-cache' below HERE,
3039 ;; which is after GOOD-POS.
3040 ;; o - ('backward nil) - scan backwards (from HERE).
3041 ;; o - ('back-and-forward START-POINT) - like 'forward, but when HERE is earlier
3042 ;; than GOOD-POS.
3043 ;; o - ('BOD START-POINT) - scan forwards from START-POINT, which is at the
3044 ;; top level.
3045 ;; o - ('IN-LIT nil) - point is inside the literal containing point-min.
3055 in-macro-start))
3059 BOD-pos ; position of 2nd BOD before HERE.
3060 strategy ; 'forward, 'backward, 'BOD, or 'IN-LIT.
3061 start-point
3067 start-point nil
3068 cache-pos nil
3073 cache-pos
3081 start-point cache-pos
3084 ;; Might we be better off starting from the top level, two defuns back,
3085 ;; instead? This heuristic no longer works well in C++, where
3086 ;; declarations inside namespace brace blocks are frequently placed at
3087 ;; column zero. (2015-11-10): Remove the condition on C++ Mode.
3089 open-paren-in-column-0-is-defun-start)
3090 ;; (not (c-major-mode-is 'c++-mode))
3095 start-point BOD-pos)))
3100 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3101 ;; Routines which change `c-state-cache' and associated values.
3103 ;; The region (more precisely, point-min) has changed since we
3104 ;; calculated `c-state-cache'. Amend `c-state-cache' accordingly.
3106 ;; If point-min has MOVED BACKWARDS then we drop the state completely.
3107 ;; It would be possible to do a better job here and recalculate the top
3108 ;; only.
3112 c-state-cache-good-pos c-state-min-scan-pos
3113 c-state-brace-pair-desert nil))
3115 ;; point-min has MOVED FORWARD.
3117 ;; Is the new point-min inside a (different) literal?
3122 ;; Cut off a bit of the tail from `c-state-cache'.
3124 pa)
3133 ; inside a recorded
3134 ; brace pair.
3136 c-state-cache-good-pos c-state-min-scan-pos)
3139 )))
3144 ;; If there is a brace pair preceding FROM in the buffer, at the same level
3145 ;; of nesting (not necessarily immediately preceding), push a cons onto
3146 ;; `c-state-cache' to represent it. FROM must not be inside a literal. If
3147 ;; UPPER-LIM is non-nil, we append the highest brace pair whose "}" is below
3148 ;; UPPER-LIM.
3149 ;;
3150 ;; Return non-nil when this has been done.
3151 ;;
3152 ;; The situation it copes with is this transformation:
3153 ;;
3154 ;; OLD: { (.) {...........}
3155 ;; ^ ^
3156 ;; FROM HERE
3157 ;;
3158 ;; NEW: { {....} (.) {.........
3159 ;; ^ ^ ^
3160 ;; LOWER BRACE PAIR HERE or HERE
3161 ;;
3162 ;; This routine should be fast. Since it can get called a LOT, we maintain
3163 ;; `c-state-brace-pair-desert', a small cache of "failures", such that we
3164 ;; reduce the time wasted in repeated fruitless searches in brace deserts.
3174 ;; Don't start scanning in the middle of a CPP construct unless
3175 ;; it contains HERE - these constructs, in Emacs, are "commented
3176 ;; out" with category properties.
3179 macro-start-or-from
3180 from))
3184 ;; If we're essentially repeating a fruitless search, just give up.
3190 ;; DESERT-LIM. Avoid repeated searching through the cached desert.
3196 ;; CACHE-LIM. This limit will be necessary when an opening
3197 ;; paren at `cache-pos' has just had its matching close paren
3198 ;; inserted into the buffer. `cache-pos' continues to be a
3199 ;; search bound, even though the algorithm below would skip
3200 ;; over the new paren pair.
3209 ;; The top limit is EOB to ensure that `bra' is inside the
3210 ;; accessible part of the buffer at the next scan operation.
3213 ;; In the next pair of nested loops, the inner one moves back past a
3214 ;; pair of (mis-)matching parens or brackets; the outer one moves
3215 ;; back over a sequence of unmatched close brace/paren/bracket each
3216 ;; time round.
3232 ; brace, ignore it.
3235 ;; We've found the desired brace-pair.
3247 ;; We haven't found a brace pair. Record this in the cache.
3250 bra
3255 ;; If BRA+1 is nil, do nothing. Otherwise, BRA+1 is the buffer position
3256 ;; following a {, and that brace has a (mis-)matching } (or ]), and we
3257 ;; "push" "a" brace pair onto `c-state-cache'.
3258 ;;
3259 ;; Here "push" means overwrite the top element if it's itself a brace-pair,
3260 ;; otherwise push it normally.
3261 ;;
3262 ;; The brace pair we push is normally the one surrounding BRA+1, but if the
3263 ;; latter is inside a macro, not being a macro containing
3264 ;; MACRO-START-OR-HERE, we scan backwards through the buffer for a non-macro
3265 ;; base pair. This latter case is assumed to be rare.
3266 ;;
3267 ;; Note: POINT is not preserved in this routine.
3277 c-state-cache)))
3278 ;; N.B. This defsubst codes one method for the simple, normal case,
3279 ;; and a more sophisticated, slower way for the general case. Don't
3280 ;; eliminate this defsubst - it's a speed optimization.
3284 ;; Scan the buffer from FROM to HERE, adding elements into `c-state-cache'
3285 ;; for braces etc. Return a candidate for `c-state-cache-good-pos'.
3286 ;;
3287 ;; FROM must be after the latest brace/paren/bracket in `c-state-cache', if
3288 ;; any. Typically, it is immediately after it. It must not be inside a
3289 ;; literal.
3295 here)))
3298 ; Is actually the pos. to scan for a (/{/[ from,
3299 ; which sometimes is after a silly )/}/].
3302 ; good-pos.
3309 ;; Each time round the following loop, we enter a successively deeper
3310 ;; level of brace/paren nesting. (Except sometimes we "continue at
3311 ;; the existing level".) `pa+1' is a pos inside an opening
3312 ;; brace/paren/bracket, usually just after it.
3315 ;; Each time round the next loop moves forward over an opening then
3316 ;; a closing brace/bracket/paren. This loop is white hot, so it
3317 ;; plays ugly tricks to go fast. DON'T PUT ANYTHING INTO THIS
3318 ;; LOOP WHICH ISN'T ABSOLUTELY NECESSARY!!! It terminates when a
3319 ;; call of `scan-lists' signals an error, which happens when there
3320 ;; are no more b/b/p's to scan.
3331 ;; We've just entered a deeper nesting level.
3333 ;; Insert the brace pair (if present) and the single open
3334 ;; paren/brace/bracket into `c-state-cache' It cannot be
3335 ;; inside a macro, except one around point, because of what
3336 ;; `c-neutralize-syntax-in-CPP' has done.
3338 ;; Insert the opening brace/bracket/paren position.
3340 ;; Clear admin stuff for the next more nested part of the scan.
3344 ;; All open p/b/b's at this nesting level, if any, have probably
3345 ;; been closed by matching/mismatching ones. We're probably
3346 ;; finished - we just need to check for having found an
3347 ;; unmatched )/}/], which we ignore. Such a )/}/] can't be in a
3348 ;; macro, due the action of `c-neutralize-syntax-in-CPP'.
3351 ;; Record the final, innermost, brace-pair if there is one.
3354 ;; Determine a good pos
3362 here-bol))
3371 ;; Remove stale entries from the `c-cache-state', i.e. those which will
3372 ;; not be in it when it is amended for position HERE. This may involve
3373 ;; replacing a CONS element for a brace pair containing HERE with its car.
3374 ;; Additionally, the "outermost" open-brace entry before HERE will be
3375 ;; converted to a cons if the matching close-brace is below HERE.
3376 ;;
3377 ;; START-POINT is a "maximal" "safe position" - there must be no open
3378 ;; parens/braces/brackets between START-POINT and HERE.
3379 ;;
3380 ;; As a second thing, calculate the result of parse-partial-sexp at
3381 ;; PPS-POINT, w.r.t. START-POINT. The motivation here is that
3382 ;; `c-state-cache-good-pos' may become PPS-POINT, but the caller may need to
3383 ;; adjust it to get outside a string/comment. (Sorry about this! The code
3384 ;; needs to be FAST).
3385 ;;
3386 ;; Return a list (GOOD-POS SCAN-BACK-POS CONS-SEPARATED PPS-STATE), where
3387 ;; o - GOOD-POS is a position where the new value `c-state-cache' is known
3388 ;; to be good (we aim for this to be as high as possible);
3389 ;; o - SCAN-BACK-POS, if not nil, indicates there may be a brace pair
3390 ;; preceding POS which needs to be recorded in `c-state-cache'. It is a
3391 ;; position to scan backwards from. It is the position of the "{" of the
3392 ;; last element to be removed from `c-state-cache', when that elt is a
3393 ;; cons, otherwise nil.
3394 ;; o - CONS-SEPARATED is t when a cons element in `c-state-cache' has been
3395 ;; replaced by its car because HERE lies inside the brace pair represented
3396 ;; by the cons.
3397 ;; o - PPS-STATE is the parse-partial-sexp state at PPS-POINT.
3407 ; start-point or nil
3414 ; HERE), or nil.
3420 pps-state ; Will be 9 or 10 elements long.
3421 pos
3422 upper-lim ; ,beyond which `c-state-cache' entries are removed
3423 scan-back-pos
3424 cons-separated
3425 pair-beg target-depth)
3427 ;; Remove entries beyond HERE. Also remove any entries inside
3428 ;; a macro, unless HERE is in the same macro.
3433 here
3439 ;; If `upper-lim' is inside the last recorded brace pair, remove its
3440 ;; RBrace and indicate we'll need to search backwards for a previous
3441 ;; brace pair.
3447 cons-separated t))
3449 ;; The next loop jumps forward out of a nested level of parens each
3450 ;; time round; the corresponding elements in `c-state-cache' are
3451 ;; removed. `pos' is just after the brace-pair or the open paren at
3452 ;; (car c-state-cache). There can be no open parens/braces/brackets
3453 ;; between `start-point'/`start-point-actual-macro-start' and HERE,
3454 ;; due to the interface spec to this function.
3457 in-macro-start)))
3459 ; marked by a `category' text property.
3460 start-point))
3471 ;; Do nothing when we've merely reached pps-point.
3472 )
3474 ;; Scan!
3478 target-depth
3479 nil pps-state))
3486 ;; We've just moved out of the paren pair containing the brace-pair
3487 ;; at (car c-state-cache). `pair-beg' is where the open paren is,
3488 ;; and is potentially where the open brace of a cons in
3489 ;; c-state-cache will be.
3495 ; containing Lparen
3499 ; together with enclosed brace pair.
3500 ;; (t nil) ; Ignore an unmated Rparen.
3501 )))
3506 nil nil ; TARGETDEPTH, STOPBEFORE
3507 pps-state)))
3509 ;; If the last paren pair we moved out of was actually a brace pair,
3510 ;; insert it into `c-state-cache'.
3515 c-state-cache)))
3520 ;; Strip stale elements of `c-state-cache' by moving backwards through the
3521 ;; buffer, and inform the caller of the scenario detected.
3522 ;;
3523 ;; HERE is the position we're setting `c-state-cache' for.
3524 ;; CACHE-POS (a locally bound variable) is just after the latest recorded
3525 ;; position in `c-state-cache' before HERE, or a position at or near
3526 ;; point-min which isn't in a literal.
3527 ;;
3528 ;; This function must only be called only when (> `c-state-cache-good-pos'
3529 ;; HERE). Usually the gap between CACHE-POS and HERE is large. It is thus
3530 ;; optimized to eliminate (or minimize) scanning between these two
3531 ;; positions.
3532 ;;
3533 ;; Return a three element list (GOOD-POS SCAN-BACK-POS FWD-FLAG), where:
3534 ;; o - GOOD-POS is a "good position", where `c-state-cache' is valid, or
3535 ;; could become so after missing elements are inserted into
3536 ;; `c-state-cache'. This is JUST AFTER an opening or closing
3537 ;; brace/paren/bracket which is already in `c-state-cache' or just before
3538 ;; one otherwise. exceptionally (when there's no such b/p/b handy) the BOL
3539 ;; before `here''s line, or the start of the literal containing it.
3540 ;; o - SCAN-BACK-POS, if non-nil, indicates there may be a brace pair
3541 ;; preceding POS which isn't recorded in `c-state-cache'. It is a position
3542 ;; to scan backwards from.
3543 ;; o - FWD-FLAG, if non-nil, indicates there may be parens/braces between
3544 ;; POS and HERE which aren't recorded in `c-state-cache'.
3545 ;;
3546 ;; The comments in this defun use "paren" to mean parenthesis or square
3547 ;; bracket (as contrasted with a brace), and "(" and ")" likewise.
3548 ;;
3549 ;; . {..} (..) (..) ( .. { } ) (...) ( .... . ..)
3550 ;; | | | | | |
3551 ;; CP E here D C good
3554 pa ren ; positions of "(" and ")"
3555 dropped-cons ; whether the last element dropped from `c-state-cache'
3556 ; was a cons (representing a brace-pair)
3557 good-pos ; see above.
3558 lit ; (START . END) of a literal containing some point.
3559 here-lit-start here-lit-end ; bounds of literal containing `here'
3560 ; or `here' itself.
3565 ;; Remove completely irrelevant entries from `c-state-cache'.
3571 ;; At this stage, (>= pos here);
3572 ;; (< (c-state-cache-top-lparen) here) (or is nil).
3577 ;; CASE 1: The top of the cache is a brace pair which now encloses
3578 ;; `here'. As good-pos, return the address of the "{". Since we've no
3579 ;; knowledge of what's inside these braces, we have no alternative but
3580 ;; to direct the caller to scan the buffer from the opening brace.
3584 ; entry into a { entry, so the caller needs to
3585 ; search for a brace pair before the {.
3587 ;; `here' might be inside a literal. Check for this.
3592 ;; Has `here' just "newly entered" a macro?
3605 ;; `here' might be nested inside any depth of parens (or brackets but
3606 ;; not braces). Scan backwards to find the outermost such opening
3607 ;; paren, if there is one. This will be the scan position to return.
3614 ;; CASE 2: Address of outermost ( or [ which now encloses `here', but
3615 ;; didn't enclose the (previous) `c-state-cache-good-pos'. If there is
3616 ;; a brace pair preceding this, it will already be in `c-state-cache',
3617 ;; unless there was a brace pair after it, i.e. there'll only be one to
3618 ;; scan for if we've just deleted one.
3621 ;; `here' isn't enclosed in a (previously unrecorded) bracket/paren.
3622 ;; Further forward scanning isn't needed, but we still need to find a
3623 ;; GOOD-POS. Step out of all enclosing "("s on HERE's line.
3635 ;; CASE 3: After a }/)/] before `here''s BOL.
3640 ;; CASE 3.5: Just after an existing entry in `c-state-cache' on `here''s
3641 ;; line or the previous line.
3645 ;; CASE 4; Best of a bad job: BOL before `here-bol', or beginning of
3646 ;; literal containing it.
3650 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3651 ;; Externally visible routines.
3655 c-state-cache-good-pos 1
3656 c-state-nonlit-pos-cache nil
3657 c-state-nonlit-pos-cache-limit 1
3658 c-state-semi-nonlit-pos-cache nil
3659 c-state-semi-nonlit-pos-cache-limit 1
3660 c-state-brace-pair-desert nil
3661 c-state-point-min 1
3662 c-state-point-min-lit-type nil
3663 c-state-point-min-lit-start nil
3664 c-state-min-scan-pos 1
3665 c-state-old-cpp-beg nil
3666 c-state-old-cpp-end nil)
3669 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3670 ;; Debugging routines to dump `c-state-cache' in a "replayable" form.
3671 ;; (defmacro c-sc-de (elt) ; "c-state-cache-dump-element"
3672 ;; `(format ,(concat "(setq " (symbol-name elt) " %s) ") ,elt))
3673 ;; (defmacro c-sc-qde (elt) ; "c-state-cache-quote-dump-element"
3674 ;; `(format ,(concat "(setq " (symbol-name elt) " '%s) ") ,elt))
3675 ;; (defun c-state-dump ()
3676 ;; ;; For debugging.
3677 ;; ;(message
3678 ;; (concat
3679 ;; (c-sc-qde c-state-cache)
3680 ;; (c-sc-de c-state-cache-good-pos)
3681 ;; (c-sc-qde c-state-nonlit-pos-cache)
3682 ;; (c-sc-de c-state-nonlit-pos-cache-limit)
3683 ;; (c-sc-qde c-state-brace-pair-desert)
3684 ;; (c-sc-de c-state-point-min)
3685 ;; (c-sc-de c-state-point-min-lit-type)
3686 ;; (c-sc-de c-state-point-min-lit-start)
3687 ;; (c-sc-de c-state-min-scan-pos)
3688 ;; (c-sc-de c-state-old-cpp-beg)
3689 ;; (c-sc-de c-state-old-cpp-end)))
3690 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3693 ;; Invalidate all info on `c-state-cache' that applies to the buffer at HERE
3694 ;; or higher and set `c-state-cache-good-pos' accordingly. The cache is
3695 ;; left in a consistent state.
3696 ;;
3697 ;; This is much like `c-whack-state-after', but it never changes a paren
3698 ;; pair element into an open paren element. Doing that would mean that the
3699 ;; new open paren wouldn't have the required preceding paren pair element.
3700 ;;
3701 ;; This function is called from c-before-change.
3703 ;; The caches of non-literals:
3704 ;; Note that we use "<=" for the possibility of the second char of a two-char
3705 ;; comment opener being typed; this would invalidate any cache position at
3706 ;; HERE.
3711 ;; `c-state-cache':
3712 ;; Case 1: if `here' is in a literal containing point-min, everything
3713 ;; becomes (or is already) nil.
3717 c-state-cache-good-pos nil
3718 c-state-min-scan-pos nil)
3720 ;; Truncate `c-state-cache' and set `c-state-cache-good-pos' to a value
3721 ;; below `here'. To maintain its consistency, we may need to insert a new
3722 ;; brace pair.
3724 too-high-pa ; recorded {/(/[ next above or just below here, or nil.
3726 ;; The easy bit - knock over-the-top bits off `c-state-cache'.
3733 ;; Do we need to add in an earlier brace pair, having lopped one off?
3740 ;; The brace-pair desert marker:
3748 ;; Find and record all noteworthy parens between some good point earlier in
3749 ;; the file and point. That good point is at least the beginning of the
3750 ;; top-level construct we are in, or the beginning of the preceding
3751 ;; top-level construct if we aren't in one.
3752 ;;
3753 ;; The returned value is a list of the noteworthy parens with the last one
3754 ;; first. If an element in the list is an integer, it's the position of an
3755 ;; open paren (of any type) which has not been closed before the point. If
3756 ;; an element is a cons, it gives the position of a closed BRACE paren
3757 ;; pair[*]; the car is the start brace position and the cdr is the position
3758 ;; following the closing brace. Only the last closed brace paren pair
3759 ;; before each open paren and before the point is recorded, and thus the
3760 ;; state never contains two cons elements in succession. When a close brace
3761 ;; has no matching open brace (e.g., the matching brace is outside the
3762 ;; visible region), it is not represented in the returned value.
3763 ;;
3764 ;; [*] N.B. The close "brace" might be a mismatching close bracket or paren.
3765 ;; This defun explicitly treats mismatching parens/braces/brackets as
3766 ;; matching. It is the open brace which makes it a "brace" pair.
3767 ;;
3768 ;; If POINT is within a macro, open parens and brace pairs within
3769 ;; THIS macro MIGHT be recorded. This depends on whether their
3770 ;; syntactic properties have been suppressed by
3771 ;; `c-neutralize-syntax-in-CPP'. This might need fixing (2008-12-11).
3772 ;;
3773 ;; Currently no characters which are given paren syntax with the
3774 ;; syntax-table property are recorded, i.e. angle bracket arglist
3775 ;; parens are never present here. Note that this might change.
3776 ;;
3777 ;; BUG: This function doesn't cope entirely well with unbalanced
3778 ;; parens in macros. (2008-12-11: this has probably been resolved
3779 ;; by the function `c-neutralize-syntax-in-CPP'.) E.g. in the
3780 ;; following case the brace before the macro isn't balanced with the
3781 ;; one after it:
3782 ;;
3783 ;; {
3784 ;; #define X {
3785 ;; }
3786 ;;
3787 ;; Note to maintainers: this function DOES get called with point
3788 ;; within comments and strings, so don't assume it doesn't!
3789 ;;
3790 ;; This function might do hidden buffer changes.
3793 strategy ; 'forward, 'backward etc..
3794 ;; Candidate positions to start scanning from:
3795 cache-pos ; highest position below HERE already existing in
3796 ; cache (or 1).
3797 good-pos
3798 start-point ; (when scanning forward) a place below HERE where there
3799 ; are no open parens/braces between it and HERE.
3800 bopl-state
3801 res
3802 cons-separated
3804 ;; If POINT-MIN has changed, adjust the cache
3808 ;; Strategy?
3815 c-state-cache-good-pos start-point))
3817 ;; SCAN!
3825 ; start-point)
3835 good-pos)))
3847 good-pos)))
3851 c-state-cache-good-pos nil))))
3853 c-state-cache)
3856 ;; This is a wrapper over `c-invalidate-state-cache-1'.
3857 ;;
3858 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3859 ;; of all parens in preprocessor constructs, except for any such construct
3860 ;; containing point. We can then call `c-invalidate-state-cache-1' without
3861 ;; worrying further about macros and template delimiters.
3863 ;; Emacs
3868 c-state-old-cpp-beg
3869 c-state-old-cpp-end
3873 ;; XEmacs
3877 ;; If PLACE is non-nil, return a marker marking it, otherwise nil.
3878 ;; We (re)use MARKER.
3884 ;; This is a wrapper over `c-parse-state-1'. See that function for a
3885 ;; description of the functionality and return value.
3886 ;;
3887 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3888 ;; of all parens in preprocessor constructs, except for any such construct
3889 ;; containing point. We can then call `c-parse-state-1' without worrying
3890 ;; further about macros and template delimiters.
3897 here-cpp-beg)
3899 ;; FIXME!!! Put in a `condition-case' here to protect the integrity of the
3900 ;; subsystem.
3903 ;; Emacs
3907 here-cpp-beg here-cpp-end
3911 ;; XEmacs
3915 c-state-old-cpp-end
3918 ;; Debug tool to catch cache inconsistencies. This is called from
3919 ;; 000tests.el.
3942 c-state-cache-good-pos
3943 c-state-nonlit-pos-cache
3944 c-state-nonlit-pos-cache-limit
3945 c-state-semi-nonlit-pos-cache
3946 c-state-semi-nonlit-pos-cache-limit
3947 c-state-brace-pair-desert
3948 c-state-point-min
3949 c-state-point-min-lit-type
3950 c-state-point-min-lit-start
3951 c-state-min-scan-pos
3952 c-state-old-cpp-beg
3953 c-state-old-cpp-end
3954 c-parse-state-point))))
3976 conses-not-ok))
3993 ;; The cache can actually go further back due to the ad-hoc way
3994 ;; the first paren is found, so try to whack off a bit of its
3995 ;; start before complaining.
3996 ;; (save-excursion
3997 ;; (goto-char (or (c-least-enclosing-brace res2) (point)))
3998 ;; (c-beginning-of-defun-1)
3999 ;; (while (not (or (bobp) (eq (char-after) ?{)))
4000 ;; (c-beginning-of-defun-1))
4001 ;; (unless (equal (c-whack-state-before (point) res1) res2)
4002 ;; (message (concat "c-parse-state inconsistency at %s: "
4003 ;; "using cache: %s, from scratch: %s")
4004 ;; here res1 res2)))
4007 here res1 res2 min-point)
4013 here res1)
4018 res2 ; res1 correct a cascading series of errors ASAP
4019 ))
4025 'c-debug-parse-state
4033 \f
4035 ;; Whack off any state information from PAREN-STATE which lies
4036 ;; before BUFPOS. Not destructive on PAREN-STATE.
4039 car)
4050 ;; Whack off any state information from PAREN-STATE which lies at or
4051 ;; after BUFPOS. Not destructive on PAREN-STATE.
4056 ;; just check the car, because in a balanced brace
4057 ;; expression, it must be impossible for the corresponding
4058 ;; close brace to be before point, but the open brace to
4059 ;; be after.
4061 nil ; whack it off
4063 ;; its possible that the open brace is before
4064 ;; bufpos, but the close brace is after. In that
4065 ;; case, convert this to a non-cons element. The
4066 ;; rest of the state is before bufpos, so we're
4067 ;; done.
4069 ;; we know that both the open and close braces are
4070 ;; before bufpos, so we also know that everything else
4071 ;; on state is before bufpos.
4074 nil ; whack it off
4075 ;; it's before bufpos, so everything else should too.
4078 nil)))
4081 ;; Return the bufpos of the innermost enclosing open paren before
4082 ;; bufpos, or nil if none was found.
4092 enclosingp))
4095 ;; Return the bufpos of the outermost enclosing open paren, or nil
4096 ;; if none was found.
4103 pos))
4106 ;; Return the closest "safe" position recorded on PAREN-STATE that
4107 ;; is higher up than BUFPOS. Return nil if PAREN-STATE doesn't
4108 ;; contain any. Return nil if BUFPOS is nil, which is useful to
4109 ;; find the closest limit before a given limit that might be nil.
4110 ;;
4111 ;; A "safe" position is a position at or after a recorded open
4112 ;; paren, or after a recorded close paren. The returned position is
4113 ;; thus either the first position after a close brace, or the first
4114 ;; position after an enclosing paren, or at the enclosing paren in
4115 ;; case BUFPOS is immediately after it.
4125 ;; See below.
4128 ;; elem is the position at and not after the opening paren, so
4129 ;; we can go forward one more step unless it's equal to
4130 ;; bufpos. This is useful in some cases avoid an extra paren
4131 ;; level between the safe position and bufpos.
4136 ;; This is used for `font-lock-beginning-of-syntax-function'. It
4137 ;; goes to the closest previous point that is known to be outside
4138 ;; any string literal or comment. `c-state-cache' is used if it has
4139 ;; a position in the vicinity.
4141 elem
4144 ;; Note: Similar code in `c-safe-position'. The
4145 ;; difference is that we accept a safe position at
4146 ;; the point and don't bother to go forward past open
4147 ;; parens.
4162 ;; The position is far back. Try `c-beginning-of-defun-1'
4163 ;; (although we can't be entirely sure it will go to a position
4164 ;; outside a comment or string in current emacsen). FIXME:
4165 ;; Consult `syntax-ppss' here.
4170 \f
4171 ;; Tools for scanning identifiers and other tokens.
4174 "Return non-nil if the point is on or directly after an identifier.
4175 Keywords are recognized and not considered identifiers. If an
4176 identifier is detected, the returned value is its starting position.
4177 If an identifier ends at the point and another begins at it \(can only
4178 happen in Pike) then the point for the preceding one is returned.
4180 Note that this function might do hidden buffer changes. See the
4181 comment at the start of cc-engine.el for more info."
4183 ;; FIXME: Shouldn't this function handle "operator" in C++?
4190 ;; Check for a normal (non-keyword) identifier.
4196 ;; Handle the `<operator> syntax in Pike.
4200 t
4207 ;; Handle the "operator +" syntax in C++.
4224 )))
4227 ;; If the point is at the end of a symbol then skip backward to the
4228 ;; beginning of it. Don't move otherwise. Return non-nil if point
4229 ;; moved.
4230 ;;
4231 ;; This function might do hidden buffer changes.
4234 ;; Handle the `<operator> syntax in Pike.
4240 t
4242 nil)))))
4245 ;; Move to the beginning of the current token. Do not move if not
4246 ;; in the middle of one. BACK-LIMIT may be used to bound the
4247 ;; backward search; if given it's assumed to be at the boundary
4248 ;; between two tokens. Return non-nil if the point is moved, nil
4249 ;; otherwise.
4250 ;;
4251 ;; This function might do hidden buffer changes.
4258 ;; `c-nonsymbol-token-regexp' should always match
4259 ;; since we've skipped backward over punctuation
4260 ;; or paren syntax, but consume one char in case
4261 ;; it doesn't so that we don't leave point before
4262 ;; some earlier incorrect token.
4269 ;; Move to the end of the current token. Do not move if not in the
4270 ;; middle of one. BACK-LIMIT may be used to bound the backward
4271 ;; search; if given it's assumed to be at the boundary between two
4272 ;; tokens. Return non-nil if the point is moved, nil otherwise.
4273 ;;
4274 ;; This function might do hidden buffer changes.
4282 ;; `c-nonsymbol-token-regexp' should always match since
4283 ;; we've skipped backward over punctuation or paren
4284 ;; syntax, but move forward in case it doesn't so that
4285 ;; we don't leave point earlier than we started with.
4301 "Move forward over a token and any following whitespace
4302 Return t if we moved, nil otherwise (i.e. we were at EOB, or a
4303 non-token or BALANCED is non-nil and we can't move). If we
4304 are at syntactic whitespace, move over this in place of a token.
4306 If BALANCED is non-nil move over any balanced parens we are at, and never move
4307 out of an enclosing paren.
4309 This function differs from `c-forward-token-2' in that it will move forward
4310 over the final token in a buffer, up to EOB."
4312 c-jump-syntax-balanced
4313 c-jump-syntax-unbalanced))
4320 ;; If we're at whitespace, count this as the token.
4321 t)
4325 t)
4328 t)
4332 nil)
4335 t))
4337 nil))
4339 t)))
4342 "Move forward by tokens.
4343 A token is defined as all symbols and identifiers which aren't
4345 treated properly). Point is always either left at the beginning of a
4346 token or not moved at all. COUNT specifies the number of tokens to
4347 move; a negative COUNT moves in the opposite direction. A COUNT of 0
4348 moves to the next token beginning only if not already at one. If
4349 BALANCED is true, move over balanced parens, otherwise move into them.
4350 Also, if BALANCED is true, never move out of an enclosing paren.
4352 LIMIT sets the limit for the movement and defaults to the point limit.
4353 The case when LIMIT is set in the middle of a token, comment or macro
4354 is handled correctly, i.e. the point won't be left there.
4356 Return the number of tokens left to move \(positive or negative). If
4357 BALANCED is true, a move over a balanced paren counts as one. Note
4358 that if COUNT is 0 and no appropriate token beginning is found, 1 will
4359 be returned. Thus, a return value of 0 guarantees that point is at
4360 the requested position and a return value less \(without signs) than
4361 COUNT guarantees that point is at the beginning of some token.
4363 Note that this function might do hidden buffer changes. See the
4364 comment at the start of cc-engine.el for more info."
4373 ;; If count is zero we should jump if in the middle of a token.
4380 ;; Skip whitespace. Count this as a move if we did in
4381 ;; fact move.
4385 ;; Moved out of bounds. Make sure the returned count isn't zero.
4397 count)))
4400 "Move backward by tokens.
4401 See `c-forward-token-2' for details."
4409 c-jump-syntax-balanced
4410 c-jump-syntax-unbalanced))
4414 ;; The count is zero so try to skip to the beginning of the
4415 ;; current token.
4419 ;; The limit is inside the same token, so return 1.
4422 ;; We're not in the middle of a token. If there's
4423 ;; whitespace after the point then we must move backward,
4424 ;; so set count to 1 in that case.
4426 ;; If we're looking at a '#' that might start a cpp
4427 ;; directive then we have to do a more elaborate check.
4440 ;; Use `condition-case' to avoid having to check for buffer
4441 ;; limits in `backward-char', `scan-sexps' and `goto-char' below.
4450 ;; This can be very inefficient if there's a long
4451 ;; sequence of operator tokens without any separation.
4452 ;; That doesn't happen in practice, anyway.
4462 count)))
4465 "Like `c-forward-token-2' but doesn't treat multicharacter operator
4467 characters are jumped over character by character. This function is
4468 for compatibility only; it's only a wrapper over `c-forward-token-2'."
4473 "Like `c-backward-token-2' but doesn't treat multicharacter operator
4475 characters are jumped over character by character. This function is
4476 for compatibility only; it's only a wrapper over `c-backward-token-2'."
4480 \f
4481 ;; Tools for doing searches restricted to syntactically relevant text.
4484 paren-level not-inside-token
4485 lookbehind-submatch)
4486 "Like `re-search-forward', but only report matches that are found
4487 in syntactically significant text. I.e. matches in comments, macros
4488 or string literals are ignored. The start point is assumed to be
4489 outside any comment, macro or string literal, or else the content of
4490 that region is taken as syntactically significant text.
4492 NOERROR, in addition to the values nil, t, and <anything else>
4493 used in `re-search-forward' can also take the values
4494 'before-literal and 'after-literal. In these cases, when BOUND
4495 is also given and is inside a literal, and a search fails, point
4496 will be left, respectively before or after the literal. Be aware
4497 that with 'after-literal, if a string or comment is unclosed at
4498 the end of the buffer, point may be left there, even though it is
4499 inside a literal there.
4501 If PAREN-LEVEL is non-nil, an additional restriction is added to
4502 ignore matches in nested paren sexps. The search will also not go
4503 outside the current list sexp, which has the effect that if the point
4504 should be moved to BOUND when no match is found \(i.e. NOERROR is
4505 neither nil nor t), then it will be at the closing paren if the end of
4506 the current list sexp is encountered first.
4508 If NOT-INSIDE-TOKEN is non-nil, matches in the middle of tokens are
4509 ignored. Things like multicharacter operators and special symbols
4511 constants.
4513 If LOOKBEHIND-SUBMATCH is non-nil, it's taken as a number of a
4514 subexpression in REGEXP. The end of that submatch is used as the
4515 position to check for syntactic significance. If LOOKBEHIND-SUBMATCH
4516 isn't used or if that subexpression didn't match then the start
4518 subexpression is never tested before the starting position, so it
4522 subexpression can match the end of nonwhite syntactic whitespace,
4523 i.e. the end of comments or cpp directives. This since the function
4524 skips over such things before resuming the search. It's on the other
4526 matches syntactic whitespace.
4528 Bug: Unbalanced parens inside cpp directives are currently not handled
4529 correctly \(i.e. they don't get ignored as they should) when
4530 PAREN-LEVEL is set.
4532 Note that this function might do hidden buffer changes. See the
4533 comment at the start of cc-engine.el for more info."
4538 ;;(message "c-syntactic-re-search-forward %s %s %S" (point) bound regexp)
4541 tmp
4542 ;; Start position for the last search.
4543 search-pos
4544 ;; The `parse-partial-sexp' state between the start position
4545 ;; and the point.
4546 state
4547 ;; The current position after the last state update. The next
4548 ;; `parse-partial-sexp' continues from here.
4550 ;; The position at which to check the state and the state
4551 ;; there. This is separate from `state-pos' since we might
4552 ;; need to back up before doing the next search round.
4553 check-pos check-state
4554 ;; Last position known to end a token.
4556 ;; Set when a valid match is found.
4557 found)
4565 t
4566 ;; Without the following, when PAREN-LEVEL is non-nil, and
4567 ;; NOERROR is not nil or t, and the very first search above
4568 ;; has just failed, point would end up at BOUND rather than
4569 ;; just before the next close paren.
4571 paren-level
4576 nil))
4587 state-pos check-pos paren-level nil state))
4589 check-state state))
4591 ;; NOTE: If we got a look behind subexpression and get
4592 ;; an insignificant match in something that isn't
4593 ;; syntactic whitespace (i.e. strings or in nested
4594 ;; parentheses), then we can never skip more than a
4595 ;; single character from the match start position
4596 ;; (i.e. `state-pos' here) before continuing the
4597 ;; search. That since the look behind subexpression
4598 ;; might match the end of the insignificant region in
4599 ;; the next search.
4603 ;; Match inside a line comment. Skip to eol. Use
4604 ;; `re-search-forward' instead of `skip-chars-forward' to get
4605 ;; the right bound behavior.
4609 ;; Match inside a block comment. Skip to the '*/'.
4616 ;; Match in the middle of the opener of a block or line
4617 ;; comment.
4622 ;; The last `parse-partial-sexp' above might have
4623 ;; stopped short of the real check position if the end
4624 ;; of the current sexp was encountered in paren-level
4625 ;; mode. The checks above are always false in that
4626 ;; case, and since they can do better skipping in
4627 ;; lookbehind-submatch mode, we do them before
4628 ;; checking the paren level.
4632 ;; Check the paren level first since we're short of the
4633 ;; syntactic checking position if the end of the
4634 ;; current sexp was encountered by `parse-partial-sexp'.
4637 ;; Inside a nested paren sexp.
4639 ;; See the NOTE above.
4641 ;; Skip out of the paren quickly.
4645 ;; Have exited the current paren sexp.
4648 ;; The last `parse-partial-sexp' call above
4649 ;; has left us just after the closing paren
4650 ;; in this case, so we can modify the bound
4651 ;; to leave the point at the right position
4652 ;; upon return.
4654 nil)
4658 ;; Match inside a string.
4661 ;; See the NOTE above.
4663 ;; Skip to the end of the string before continuing.
4672 continue)))
4677 ;; Match inside a macro. Skip to the end of it.
4685 (< check-pos
4691 ;; Inside a token.
4693 ;; See the NOTE above.
4698 ;; A real match.
4700 nil)))
4702 ;; Should loop to search again, but take care to avoid
4703 ;; looping on the same spot.
4707 nil
4710 t))))
4716 ;;(message "c-syntactic-re-search-forward done %s" (or (match-end 0) (point)))
4723 ;; Search failed. Set point as appropriate.
4737 nil)))
4742 ;; Return the start of the literal point is in, or nil.
4743 ;; We read and write the variables `safe-pos', `safe-pos-list', `state'
4744 ;; bound in the caller.
4746 ;; Use `parse-partial-sexp' from a safe position down to the point to check
4747 ;; if it's outside comments and strings.
4750 ;; Pick a safe position as close to the point as possible.
4751 ;;
4752 ;; FIXME: Consult `syntax-ppss' here if our cache doesn't give a good
4753 ;; position.
4765 ;; Cache positions along the way to use if we have to back up more. We
4766 ;; cache every closing paren on the same level. If the paren cache is
4767 ;; relevant in this region then we're typically already on the same
4768 ;; level as the target position. Note that we might cache positions
4769 ;; after opening parens in case safe-pos is in a nested list. That's
4770 ;; both uncommon and harmless.
4778 ;; If the state contains the start of the containing sexp we cache that
4779 ;; position too, so that parse-partial-sexp in the next run has a bigger
4780 ;; chance of starting at the same level as the target position and thus
4781 ;; will get more good safe positions into the list.
4787 ;; Inside string or comment. Continue search at the
4788 ;; beginning of it.
4792 "Like `skip-chars-backward' but only look at syntactically relevant chars,
4793 i.e. don't stop at positions inside syntactic whitespace or string
4794 literals. Preprocessor directives are also ignored, with the exception
4795 of the one that the point starts within, if any. If LIMIT is given,
4796 it's assumed to be at a syntactically relevant position.
4798 If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4799 sexps, and the search will also not go outside the current paren sexp.
4800 However, if LIMIT or the buffer limit is reached inside a nested paren
4801 then the point will be left at the limit.
4803 Non-nil is returned if the point moved, nil otherwise.
4805 Note that this function might do hidden buffer changes. See the
4806 comment at the start of cc-engine.el for more info."
4810 ;; A list of syntactically relevant positions in descending
4811 ;; order. It's used to avoid scanning repeatedly over
4812 ;; potentially large regions with `parse-partial-sexp' to verify
4813 ;; each position. Used in `c-ssb-lit-begin'
4814 safe-pos-list
4815 ;; The result from `c-beginning-of-macro' at the start position or the
4816 ;; start position itself if it isn't within a macro. Evaluated on
4817 ;; demand.
4818 start-macro-beg
4819 ;; The earliest position after the current one with the same paren
4820 ;; level. Used only when `paren-level' is set.
4821 lit-beg
4826 ;; The next loop "tries" to find the end point each time round,
4827 ;; loops when it hasn't succeeded.
4833 ;; Don't stop inside a literal.
4836 t)))
4848 ;; Not at the right level.
4851 ;; We stop above if we go out of a paren.
4852 ;; Now check whether it precedes or is
4853 ;; nested in the starting sexp.
4857 pps-end-pos paren-level-pos
4858 nil nil state-2))
4861 ;; We've stopped short of the starting position
4862 ;; so the hit was inside a nested list. Go up
4863 ;; until we are at the right level.
4872 nil)
4873 t))
4876 nil))
4878 ;; The hit was outside the list at the start
4879 ;; position. Go to the start of the list and exit.
4881 nil))
4884 ;; Inside a macro.
4892 t
4894 ;; It's inside the same macro we started in so it's
4895 ;; a relevant match.
4897 nil))))))
4901 ;; Skip syntactic ws afterwards so that we don't stop at the
4902 ;; end of a comment if `skip-chars' is something like "^/".
4906 ;; We might want to extend this with more useful return values in
4907 ;; the future.
4910 ;; The following is an alternative implementation of
4911 ;; `c-syntactic-skip-backward' that uses backward movement to keep
4912 ;; track of the syntactic context. It turned out to be generally
4913 ;; slower than the one above which uses forward checks from earlier
4914 ;; safe positions.
4915 ;;
4916 ;;(defconst c-ssb-stop-re
4917 ;; ;; The regexp matching chars `c-syntactic-skip-backward' needs to
4918 ;; ;; stop at to avoid going into comments and literals.
4919 ;; (concat
4920 ;; ;; Match comment end syntax and string literal syntax. Also match
4921 ;; ;; '/' for block comment endings (not covered by comment end
4922 ;; ;; syntax).
4923 ;; "\\s>\\|/\\|\\s\""
4924 ;; (if (memq 'gen-string-delim c-emacs-features)
4925 ;; "\\|\\s|"
4926 ;; "")
4927 ;; (if (memq 'gen-comment-delim c-emacs-features)
4928 ;; "\\|\\s!"
4929 ;; "")))
4930 ;;
4931 ;;(defconst c-ssb-stop-paren-re
4932 ;; ;; Like `c-ssb-stop-re' but also stops at paren chars.
4933 ;; (concat c-ssb-stop-re "\\|\\s(\\|\\s)"))
4934 ;;
4935 ;;(defconst c-ssb-sexp-end-re
4936 ;; ;; Regexp matching the ending syntax of a complex sexp.
4937 ;; (concat c-string-limit-regexp "\\|\\s)"))
4938 ;;
4939 ;;(defun c-syntactic-skip-backward (skip-chars &optional limit paren-level)
4940 ;; "Like `skip-chars-backward' but only look at syntactically relevant chars,
4941 ;;i.e. don't stop at positions inside syntactic whitespace or string
4942 ;;literals. Preprocessor directives are also ignored. However, if the
4943 ;;point is within a comment, string literal or preprocessor directory to
4944 ;;begin with, its contents is treated as syntactically relevant chars.
4945 ;;If LIMIT is given, it limits the backward search and the point will be
4946 ;;left there if no earlier position is found.
4947 ;;
4948 ;;If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4949 ;;sexps, and the search will also not go outside the current paren sexp.
4950 ;;However, if LIMIT or the buffer limit is reached inside a nested paren
4951 ;;then the point will be left at the limit.
4952 ;;
4953 ;;Non-nil is returned if the point moved, nil otherwise.
4954 ;;
4955 ;;Note that this function might do hidden buffer changes. See the
4956 ;;comment at the start of cc-engine.el for more info."
4957 ;;
4958 ;; (save-restriction
4959 ;; (when limit
4960 ;; (narrow-to-region limit (point-max)))
4961 ;;
4962 ;; (let ((start (point)))
4963 ;; (catch 'done
4964 ;; (while (let ((last-pos (point))
4965 ;; (stop-pos (progn
4966 ;; (skip-chars-backward skip-chars)
4967 ;; (point))))
4968 ;;
4969 ;; ;; Skip back over the same region as
4970 ;; ;; `skip-chars-backward' above, but keep to
4971 ;; ;; syntactically relevant positions.
4972 ;; (goto-char last-pos)
4973 ;; (while (and
4974 ;; ;; `re-search-backward' with a single char regexp
4975 ;; ;; should be fast.
4976 ;; (re-search-backward
4977 ;; (if paren-level c-ssb-stop-paren-re c-ssb-stop-re)
4978 ;; stop-pos 'move)
4979 ;;
4980 ;; (progn
4981 ;; (cond
4982 ;; ((looking-at "\\s(")
4983 ;; ;; `paren-level' is set and we've found the
4984 ;; ;; start of the containing paren.
4985 ;; (forward-char)
4986 ;; (throw 'done t))
4987 ;;
4988 ;; ((looking-at c-ssb-sexp-end-re)
4989 ;; ;; We're at the end of a string literal or paren
4990 ;; ;; sexp (if `paren-level' is set).
4991 ;; (forward-char)
4992 ;; (condition-case nil
4993 ;; (c-backward-sexp)
4994 ;; (error
4995 ;; (goto-char limit)
4996 ;; (throw 'done t))))
4997 ;;
4998 ;; (t
4999 ;; (forward-char)
5000 ;; ;; At the end of some syntactic ws or possibly
5001 ;; ;; after a plain '/' operator.
5002 ;; (let ((pos (point)))
5003 ;; (c-backward-syntactic-ws)
5004 ;; (if (= pos (point))
5005 ;; ;; Was a plain '/' operator. Go past it.
5006 ;; (backward-char)))))
5007 ;;
5008 ;; (> (point) stop-pos))))
5009 ;;
5010 ;; ;; Now the point is either at `stop-pos' or at some
5011 ;; ;; position further back if `stop-pos' was at a
5012 ;; ;; syntactically irrelevant place.
5013 ;;
5014 ;; ;; Skip additional syntactic ws so that we don't stop
5015 ;; ;; at the end of a comment if `skip-chars' is
5016 ;; ;; something like "^/".
5017 ;; (c-backward-syntactic-ws)
5018 ;;
5019 ;; (< (point) stop-pos))))
5020 ;;
5021 ;; ;; We might want to extend this with more useful return values
5022 ;; ;; in the future.
5023 ;; (/= (point) start))))
5025 \f
5026 ;; Tools for handling comments and string literals.
5029 "Return the type of literal point is in, if any.
5030 The return value is `c' if in a C-style comment, `c++' if in a C++
5031 style comment, `string' if in a string literal, `pound' if DETECT-CPP
5032 is non-nil and in a preprocessor line, or nil if somewhere else.
5033 Optional LIM is used as the backward limit of the search. If omitted,
5034 or nil, `c-beginning-of-defun' is used.
5036 Note that this function might do hidden buffer changes. See the
5037 comment at the start of cc-engine.el for more info."
5047 "Return a cons of the beginning and end positions of the comment or
5048 string surrounding point (including both delimiters), or nil if point
5050 to start parsing from. If NEAR is non-nil, then the limits of any
5052 spaces and tabs between point and the literal. The search for such a
5053 literal is done first in forward direction. If NOT-IN-DELIMITER is
5054 non-nil, the case when point is inside a starting delimiter won't be
5055 recognized. This only has effect for comments which have starting
5056 delimiters with more than one character.
5058 Note that this function might do hidden buffer changes. See the
5059 comment at the start of cc-engine.el for more info."
5071 nil nil
5072 s
5082 ;; Search forward for a literal.
5093 ;; Search backward.
5104 ;; Block comment. Due to the nature of line
5105 ;; comments, they will always be covered by the
5106 ;; normal case above.
5109 ;; If LIM is bogus, beg will be bogus.
5113 ))))
5116 "Return the start of the string or comment surrounding point, or nil if
5117 point isn't in one. SAFE-POS, if non-nil, is a position before point which is
5126 ;; In case external callers use this; it did have a docstring.
5130 "If the argument is a cons of two buffer positions (such as returned by
5131 `c-literal-limits'), and that range contains a C++ style line comment,
5132 then an extended range is returned that contains all adjacent line
5133 comments (i.e. all comments that starts in the same column with no
5134 empty lines or non-whitespace characters between them). Otherwise the
5135 argument is returned.
5137 Note that this function might do hidden buffer changes. See the
5138 comment at the start of cc-engine.el for more info."
5149 ;; Got to take care in the backward direction to handle
5150 ;; comments which are preceded by code.
5164 range)
5168 "Convenience function that given the result of `c-literal-limits',
5169 returns nil or the type of literal that the range surrounds, one
5170 of the symbols `c', `c++' or `string'. It's much faster than using
5171 `c-in-literal' and is intended to be used when you need both the
5172 type of a literal and its limits.
5174 Note that this function might do hidden buffer changes. See the
5175 comment at the start of cc-engine.el for more info."
5186 range))
5189 ;; Get a "safe place" approximately TRY-SIZE characters before START.
5190 ;; This defsubst doesn't preserve point.
5195 cand
5200 ;; Return a buffer position HOW-FAR-BACK non-literal characters from
5201 ;; START (default point). The starting position, either point or
5202 ;; START may not be in a comment or string.
5203 ;;
5204 ;; The position found will not be before POINT-MIN and won't be in a
5205 ;; literal.
5206 ;;
5207 ;; We start searching for the sought position TRY-SIZE (default
5208 ;; twice HOW-FAR-BACK) bytes back from START.
5209 ;;
5210 ;; This function must be fast. :-)
5218 stack elt size
5221 ;; Move forward one literal each time round this loop.
5222 ;; Move forward to the start of a comment or string.
5224 pos
5225 start
5226 nil ; target-depth
5227 nil ; stop-before
5228 s ; state
5231 ;; Gather details of the non-literal-bit - starting pos and size.
5236 pos))
5240 ;; Move forward to the end of the comment/string.
5245 start
5246 nil ; target-depth
5247 nil ; stop-before
5248 s ; state
5252 ;; Now try and find enough non-literal characters recorded on the stack.
5253 ;; Go back one recorded literal each time round this loop.
5255 stack)
5260 ;; Have we found enough yet?
5272 ;; Return a buffer position about HOW-FAR non-literal characters forward
5273 ;; from START-POS (default point), which must not be inside a literal.
5280 ;; Scan over counted characters.
5282 pos
5284 nil ; target-depth
5285 nil ; stop-before
5286 s ; state
5290 ;; Scan over literal characters.
5293 pos
5295 nil ; target-depth
5296 nil ; stop-before
5297 s ; state
5302 \f
5303 ;; `c-find-decl-spots' and accompanying stuff.
5305 ;; Variables used in `c-find-decl-spots' to cache the search done for
5306 ;; the first declaration in the last call. When that function starts,
5307 ;; it needs to back up over syntactic whitespace to look at the last
5308 ;; token before the region being searched. That can sometimes cause
5309 ;; moves back and forth over a quite large region of comments and
5310 ;; macros, which would be repeated for each changed character when
5311 ;; we're called during fontification, since font-lock refontifies the
5312 ;; current line for each change. Thus it's worthwhile to cache the
5313 ;; first match.
5314 ;;
5315 ;; `c-find-decl-syntactic-pos' is a syntactically relevant position in
5316 ;; the syntactic whitespace less or equal to some start position.
5317 ;; There's no cached value if it's nil.
5318 ;;
5319 ;; `c-find-decl-match-pos' is the match position if
5320 ;; `c-find-decl-prefix-search' matched before the syntactic whitespace
5321 ;; at `c-find-decl-syntactic-pos', or nil if there's no such match.
5332 ; (defface c-debug-decl-spot-face
5333 ; '((t (:background "Turquoise")))
5334 ; "Debug face to mark the spots where `c-find-decl-spots' stopped.")
5335 ; (defface c-debug-decl-sws-face
5336 ; '((t (:background "Khaki")))
5337 ; "Debug face to mark the syntactic whitespace between the declaration
5338 ; spots and the preceding token end.")
5353 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
5354 ;; Machinery for determining when we're at top level (this including being
5355 ;; directly inside a class or namespace, etc.)
5356 ;;
5357 ;; We maintain a stack of brace depths in structures like classes and
5358 ;; namespaces. The car of this structure, when non-nil, indicates that the
5359 ;; associated position is within a template (etc.) structure, and the value is
5360 ;; the position where the (outermost) template ends. The other elements in
5361 ;; the structure are stacked elements, one each for each enclosing "top level"
5362 ;; structure.
5363 ;;
5364 ;; At the very outermost level, the value of the stack would be (nil 1), the
5365 ;; "1" indicating an enclosure in a notional all-enclosing block. After
5366 ;; passing a keyword such as "namespace", the value would become (nil 0 1).
5367 ;; At this point, passing a semicolon would cause the 0 to be dropped from the
5368 ;; stack (at any other time, a semicolon is ignored). Alternatively, on
5369 ;; passing an opening brace, the stack would become (nil 1 1). Each opening
5370 ;; brace passed causes the cadr to be incremented, and passing closing braces
5371 ;; causes it to be decremented until it reaches 1. On passing a closing brace
5372 ;; when the cadr of the stack is at 1, this causes it to be removed from the
5373 ;; stack, the corresponding namespace (etc.) structure having been closed.
5374 ;;
5375 ;; There is a special stack value -1 which means the C++ colon operator
5376 ;; introducing a list of inherited classes has just been parsed. The value
5377 ;; persists on the stack until the next open brace or semicolon.
5378 ;;
5379 ;; When the car of the stack is non-nil, i.e. when we're in a template (etc.)
5380 ;; structure, braces are not counted. The counting resumes only after passing
5381 ;; the template's closing position, which is recorded in the car of the stack.
5382 ;;
5383 ;; The test for being at top level consists of the cadr being 0 or 1.
5384 ;;
5385 ;; The values of this stack throughout a buffer are cached in a simple linear
5386 ;; cache, every 5000 characters.
5387 ;;
5388 ;; Note to maintainers: This cache mechanism is MUCH faster than recalculating
5389 ;; the stack at every entry to `c-find-decl-spots' using `c-at-toplevel-p' or
5390 ;; the like.
5391 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
5392 ;; The approximate interval at which we cache the value of the brace stack.
5394 ;; The list of cached values of the brace stack. Each value in the list is a
5395 ;; cons of the position it is valid for and the value of the stack as
5396 ;; described above.
5399 ;; The position of the buffer at and below which entries in `c-bs-cache' are
5400 ;; valid.
5403 ;; The previous buffer position for which the brace stack value was
5404 ;; determined.
5407 ;; The value of the brace stack at `c-bs-prev-pos'.
5412 ;; Initialize the cache in `c-bs-cache' and related variables.
5414 c-bs-cache-limit 1
5415 c-bs-prev-pos most-positive-fixnum
5416 c-bs-prev-stack nil))
5419 ;; Truncate the upper bound of the cache `c-bs-cache' to POS, if it is
5420 ;; higher than that position. This is called as either a before- or
5421 ;; after-change-function.
5426 ;; Given a brace-stack which has the value STACK at position FROM, update it
5427 ;; to its value at position TO, where TO is after (or equal to) FROM.
5428 ;; Return a cons of either TO (if it is outside a literal) and this new
5429 ;; value, or of the next position after TO outside a literal and the new
5430 ;; value.
5445 c-brace-stack-thing-key
5446 c-brace-stack-no-semi-key)
5459 1
5484 s
5494 ;; The failing `c-syntactic-re-search-forward' may have left us in the
5495 ;; middle of a token, which might be a significant token. Fix this!
5501 ;; Given a buffer position HERE, Return the value of the brace stack there.
5507 elt stack pos npos high-elt)
5508 ;; Trim the cache to take account of buffer changes.
5528 ;; Add an element to `c-state-semi-nonlit-pos-cache' each iteration.
5540 ;; Can we just use the previous value?
5545 stack c-bs-prev-stack)
5555 ;; Is position HERE at the top level, as indicated by the brace stack?
5561 ;; Macro used inside `c-find-decl-spots'. It ought to be a defun,
5562 ;; but it contains lots of free variables that refer to things
5563 ;; inside `c-find-decl-spots'. The point is left at `cfd-match-pos'
5564 ;; if there is a match, otherwise at `cfd-limit'.
5565 ;;
5566 ;; The macro moves point forward to the next putative start of a declaration
5567 ;; or cfd-limit. This decl start is the next token after a "declaration
5568 ;; prefix". The declaration prefix is the earlier of `cfd-prop-match' and
5569 ;; `cfd-re-match'. `cfd-match-pos' is set to the decl prefix.
5570 ;;
5571 ;; This macro might do hidden buffer changes.
5574 ;; Find the next property match position if we haven't got one already.
5585 ;; Find the next `c-decl-prefix-or-start-re' match if we haven't
5586 ;; got one already.
5592 ;; Each time round, the next `while' moves forward over a pseudo match
5593 ;; of `c-decl-prefix-or-start-re' which is either inside a literal, or
5594 ;; is a ":" not preceded by "public", etc.. `cfd-re-match' and
5595 ;; `cfd-re-match-end' get set.
5602 ;; No match. Finish up and exit the loop.
5604 nil)
5607 ;; Matched the end of a token preceding a decl spot.
5611 ;; Matched a token that start a decl spot.
5614 c-literal-faces)
5615 ;; Pseudo match inside a comment or string literal. Skip out
5616 ;; of comments and string literals.
5629 ;; Found, e.g., "::" in C++
5630 t)
5636 ;; Found a ":" which isn't part of "public:", etc.
5637 t)
5640 ;; If our match was at the decl start, we have to back up over the
5641 ;; preceding syntactic ws to set `cfd-match-pos' and to catch
5642 ;; any decl spots in the syntactic ws.
5647 ;; Choose whichever match is closer to the start.
5650 cfd-re-match nil)
5652 cfd-prop-match nil))
5658 ;; Skip forward past comments only so we don't skip macros.
5660 ;; Set the position to continue at. We can avoid going over
5661 ;; the comments skipped above a second time, but it's possible
5662 ;; that the comment skipping has taken us past `cfd-prop-match'
5663 ;; since the property might be used inside comments.
5669 ;; Call CFD-FUN for each possible spot for a declaration, cast or
5670 ;; label from the point to CFD-LIMIT.
5671 ;;
5672 ;; CFD-FUN is called with point at the start of the spot. It's passed three
5673 ;; arguments: The first is the end position of the token preceding the spot,
5674 ;; or 0 for the implicit match at bob. The second is a flag that is t when
5675 ;; the match is inside a macro. The third is a flag that is t when the
5676 ;; match is at "top level", i.e. outside any brace block, or directly inside
5677 ;; a class or namespace, etc. Point should be moved forward by at least one
5678 ;; token.
5679 ;;
5680 ;; If CFD-FUN adds `c-decl-end' properties somewhere below the current spot,
5681 ;; it should return non-nil to ensure that the next search will find them.
5682 ;;
5683 ;; Such a spot is:
5684 ;; o The first token after bob.
5685 ;; o The first token after the end of submatch 1 in
5686 ;; `c-decl-prefix-or-start-re' when that submatch matches. This
5687 ;; submatch is typically a (L or R) brace or paren, a ;, or a ,.
5688 ;; o The start of each `c-decl-prefix-or-start-re' match when
5689 ;; submatch 1 doesn't match. This is, for example, the keyword
5690 ;; "class" in Pike.
5691 ;; o The start of a previously recognized declaration; "recognized"
5692 ;; means that the last char of the previous token has a `c-type'
5693 ;; text property with the value `c-decl-end'; this only holds
5694 ;; when `c-type-decl-end-used' is set.
5695 ;;
5696 ;; Only a spot that match CFD-DECL-RE and whose face is in the
5697 ;; CFD-FACE-CHECKLIST list causes CFD-FUN to be called. The face
5698 ;; check is disabled if CFD-FACE-CHECKLIST is nil.
5699 ;;
5700 ;; If the match is inside a macro then the buffer is narrowed to the
5701 ;; end of it, so that CFD-FUN can investigate the following tokens
5702 ;; without matching something that begins inside a macro and ends
5703 ;; outside it. It's to avoid this work that the CFD-DECL-RE and
5704 ;; CFD-FACE-CHECKLIST checks exist.
5705 ;;
5706 ;; The spots are visited approximately in order from top to bottom.
5707 ;; It's however the positions where `c-decl-prefix-or-start-re'
5708 ;; matches and where `c-decl-end' properties are found that are in
5709 ;; order. Since the spots often are at the following token, they
5710 ;; might be visited out of order insofar as more spots are reported
5711 ;; later on within the syntactic whitespace between the match
5712 ;; positions and their spots.
5713 ;;
5714 ;; It's assumed that comments and strings are fontified in the
5715 ;; searched range.
5716 ;;
5717 ;; This is mainly used in fontification, and so has an elaborate
5718 ;; cache to handle repeated calls from the same start position; see
5719 ;; the variables above.
5720 ;;
5721 ;; All variables in this function begin with `cfd-' to avoid name
5722 ;; collision with the (dynamically bound) variables used in CFD-FUN.
5723 ;;
5724 ;; This function might do hidden buffer changes.
5728 ;; The end of the token preceding the decl spot last found
5729 ;; with `c-decl-prefix-or-start-re'. `cfd-limit' if there's
5730 ;; no match.
5731 cfd-re-match
5732 ;; The end position of the last `c-decl-prefix-or-start-re'
5733 ;; match. If this is greater than `cfd-continue-pos', the
5734 ;; next regexp search is started here instead.
5736 ;; The end of the last `c-decl-end' found by
5737 ;; `c-find-decl-prefix-search'. `cfd-limit' if there's no
5738 ;; match. If searching for the property isn't needed then we
5739 ;; disable it by setting it to `cfd-limit' directly.
5741 ;; The end of the token preceding the decl spot last found by
5742 ;; `c-find-decl-prefix-search'. 0 for the implicit match at
5743 ;; bob. `cfd-limit' if there's no match. In other words,
5744 ;; this is the minimum of `cfd-re-match' and `cfd-prop-match'.
5746 ;; The position to continue searching at.
5747 cfd-continue-pos
5748 ;; The position of the last "real" token we've stopped at.
5749 ;; This can be greater than `cfd-continue-pos' when we get
5750 ;; hits inside macros or at `c-decl-end' positions inside
5751 ;; comments.
5753 ;; The end position of the last entered macro.
5755 ;; Whether the last position returned from `c-find-decl-prefix-search'
5756 ;; is at the top-level (including directly in a class or namespace,
5757 ;; etc.).
5760 ;; Initialize by finding a syntactically relevant start position
5761 ;; before the point, and do the first `c-decl-prefix-or-start-re'
5762 ;; search unless we're at bob.
5765 ;; Must back up a bit since we look for the end of the previous
5766 ;; statement or declaration, which is earlier than the first
5767 ;; returned match.
5769 ;; This `cond' moves back over any literals or macros. It has special
5770 ;; handling for when the region being searched is entirely within a
5771 ;; macro. It sets `cfd-continue-pos' (unless we've reached
5772 ;; `cfd-limit').
5774 ;; First we need to move to a syntactically relevant position.
5775 ;; Begin by backing out of comment or string literals.
5776 ;;
5777 ;; This arm of the cond actually triggers if we're in a literal,
5778 ;; and cfd-limit is at most at BONL.
5780 ;; This arm of the `and' moves backwards out of a literal when
5781 ;; the face at point is a literal face. In this case, its value
5782 ;; is always non-nil.
5784 ;; Try to use the faces to back up to the start of the
5785 ;; literal. FIXME: What if the point is on a declaration
5786 ;; inside a comment?
5792 ;; XEmacs doesn't fontify the quotes surrounding string
5793 ;; literals.
5802 ;; Don't trust the literal to contain only literal faces
5803 ;; (the font lock package might not have fontified the
5804 ;; start of it at all, for instance) so check that we have
5805 ;; arrived at something that looks like a start or else
5806 ;; resort to `c-literal-limits'.
5810 )
5814 ;; The start is in a literal. If the limit is in the same
5815 ;; one we don't have to find a syntactic position etc. We
5816 ;; only check that if the limit is at or before bonl to save
5817 ;; time; it covers the by far most common case when font-lock
5818 ;; refontifies the current line only.
5829 ;; Completely inside a literal. Set up variables to trig the
5830 ;; (< cfd-continue-pos cfd-start-pos) case below and it'll
5831 ;; find a suitable start position.
5834 ;; Check if the region might be completely inside a macro, to
5835 ;; optimize that like the completely-inside-literal above.
5842 ;; (Maybe) completely inside a macro. Only need to trig the
5843 ;; (< cfd-continue-pos cfd-start-pos) case below to make it
5844 ;; set things up.
5846 start-in-macro t))
5848 ;; The default arm of the `cond' moves back over any macro we're in
5849 ;; and over any syntactic WS. It sets `c-find-decl-syntactic-pos'.
5851 ;; Back out of any macro so we don't miss any declaration
5852 ;; that could follow after it.
5856 ;; Now we're at a proper syntactically relevant position so we
5857 ;; can use the cache. But first clear it if it applied
5858 ;; further down.
5863 ;; Don't have to do this if the cache is relevant here,
5864 ;; typically if the same line is refontified again. If
5865 ;; we're just some syntactic whitespace further down we can
5866 ;; still use the cache to limit the skipping.
5869 ;; If we hit `c-find-decl-syntactic-pos' and
5870 ;; `c-find-decl-match-pos' is set then we install the cached
5871 ;; values. If we hit `c-find-decl-syntactic-pos' and
5872 ;; `c-find-decl-match-pos' is nil then we know there's no decl
5873 ;; prefix in the whitespace before `c-find-decl-syntactic-pos'
5874 ;; and so we can continue the search from this point. If we
5875 ;; didn't hit `c-find-decl-syntactic-pos' then we're now in
5876 ;; the right spot to begin searching anyway.
5878 c-find-decl-match-pos)
5880 cfd-continue-pos syntactic-pos)
5885 ;; Always consider bob a match to get the first
5886 ;; declaration in the file. Do this separately instead of
5887 ;; letting `c-decl-prefix-or-start-re' match bob, so that
5888 ;; regexp always can consume at least one character to
5889 ;; ensure that we won't get stuck in an infinite loop.
5894 ;; Do an initial search now. In the bob case above it's
5895 ;; only done to search for a `c-decl-end' spot.
5901 ;; Advance `cfd-continue-pos' if it's before the start position.
5902 ;; The closest continue position that might have effect at or
5903 ;; after the start depends on what we started in. This also
5904 ;; finds a suitable start position in the special cases when the
5905 ;; region is completely within a literal or macro.
5910 ;; If we're in a macro then it's the closest preceding token
5911 ;; in the macro. Check this before `start-in-literal',
5912 ;; since if we're inside a literal in a macro, the preceding
5913 ;; token is earlier than any `c-decl-end' spot inside the
5914 ;; literal (comment).
5916 ;; The only syntactic ws in macros are comments.
5922 ;; If we're in a comment it can only be the closest
5923 ;; preceding `c-decl-end' position within that comment, if
5924 ;; any. Go back to the beginning of such a property so that
5925 ;; `c-find-decl-prefix-search' will find the end of it.
5926 ;; (Can't stop at the end and install it directly on
5927 ;; `cfd-prop-match' since that variable might be cleared
5928 ;; after `cfd-fun' below.)
5929 ;;
5930 ;; Note that if the literal is a string then the property
5931 ;; search will simply skip to the beginning of it right
5932 ;; away.
5944 ;; Didn't find any property inside the comment, so we can
5945 ;; skip it entirely. (This won't skip past a string, but
5946 ;; that'll be handled quickly by the next
5947 ;; `c-find-decl-prefix-search' anyway.)
5953 ;; If we started in normal code, the only match that might
5954 ;; apply before the start is what we already got in
5955 ;; `cfd-match-pos' so we can continue at the start position.
5956 ;; (Note that we don't get here if the first match is below
5957 ;; it.)
5960 ;; Delete found matches if they are before our new continue
5961 ;; position, so that `c-find-decl-prefix-search' won't back up
5962 ;; to them later on.
5970 ;; This is the normal case and we got a proper syntactic
5971 ;; position. If there's a match then it's always outside
5972 ;; macros and comments, so advance to the next token and set
5973 ;; `cfd-token-pos'. The loop below will later go back using
5974 ;; `cfd-continue-pos' to fix declarations inside the
5975 ;; syntactic ws.
5983 ;; Have one of the special cases when the region is completely
5984 ;; within a literal or macro. `cfd-continue-pos' is set to a
5985 ;; good start position for the search, so do it.
5988 ;; Now loop, one decl spot per iteration. We already have the first
5989 ;; match in `cfd-match-pos'.
5991 ;; Go forward over "false matches", one per iteration.
5996 ;; Kludge to filter out matches on the "<" that
5997 ;; aren't open parens, for the sake of languages
5998 ;; that got `c-recognize-<>-arglists' set.
6003 ;; If `cfd-continue-pos' is less or equal to
6004 ;; `cfd-token-pos', we've got a hit inside a macro
6005 ;; that's in the syntactic whitespace before the last
6006 ;; "real" declaration we've checked. If they're equal
6007 ;; we've arrived at the declaration a second time, so
6008 ;; there's nothing to do.
6012 ;; If `cfd-continue-pos' is less than `cfd-token-pos'
6013 ;; we're still searching for declarations embedded in
6014 ;; the syntactic whitespace. In that case we need
6015 ;; only to skip comments and not macros, since they
6016 ;; can't be nested, and that's already been done in
6017 ;; `c-find-decl-prefix-search'.
6022 ;; Continue if the following token fails the
6023 ;; CFD-DECL-RE and CFD-FACE-CHECKLIST checks.
6030 t)))
6041 ;; Narrow to the end of the macro if we got a hit inside
6042 ;; one, to avoid recognizing things that start inside the
6043 ;; macro and end outside it.
6045 ;; Not in the same macro as in the previous round.
6056 t
6059 t)
6060 ;; The matched token was the last thing in the macro,
6061 ;; so the whole match is bogus.
6072 ;; Restore limits if we did macro narrowing above.
6079 ; cfd-match-pos, etc.
6081 \f
6082 ;; A cache for found types.
6084 ;; Buffer local variable that contains an obarray with the types we've
6085 ;; found. If a declaration is recognized somewhere we record the
6086 ;; fully qualified identifier in it to recognize it as a type
6087 ;; elsewhere in the file too. This is not accurate since we do not
6088 ;; bother with the scoping rules of the languages, but in practice the
6089 ;; same name is seldom used as both a type and something else in a
6090 ;; file, and we only use this as a last resort in ambiguous cases (see
6091 ;; `c-forward-decl-or-cast-1').
6092 ;;
6093 ;; Not every type need be in this cache. However, things which have
6094 ;; ceased to be types must be removed from it.
6095 ;;
6096 ;; Template types in C++ are added here too but with the template
6097 ;; arglist replaced with "<>" in references or "<" for the one in the
6098 ;; primary type. E.g. the type "Foo<A,B>::Bar<C>" is stored as
6099 ;; "Foo<>::Bar<". This avoids storing very long strings (since C++
6100 ;; template specs can be fairly sized programs in themselves) and
6101 ;; improves the hit ratio (it's a type regardless of the template
6102 ;; args; it's just not the same type, but we're only interested in
6103 ;; recognizing types, not telling distinct types apart). Note that
6104 ;; template types in references are added here too; from the example
6105 ;; above there will also be an entry "Foo<".
6110 ;; Clears `c-found-types'.
6115 ;; Add the given region as a type in `c-found-types'. If the region
6116 ;; doesn't match an existing type but there is a type which is equal
6117 ;; to the given one except that the last character is missing, then
6118 ;; the shorter type is removed. That's done to avoid adding all
6119 ;; prefixes of a type as it's being entered and font locked. This
6120 ;; doesn't cover cases like when characters are removed from a type
6121 ;; or added in the middle. We'd need the position of point when the
6122 ;; font locking is invoked to solve this well.
6123 ;;
6124 ;; This function might do hidden buffer changes.
6131 ;; Remove the "NAME" from c-found-types, if present.
6135 ;; Return non-nil if the given region contains a type in
6136 ;; `c-found-types'.
6137 ;;
6138 ;; This function might do hidden buffer changes.
6142 ;; Return all the types in `c-found-types' as a sorted list of
6143 ;; strings.
6147 c-found-types)
6150 ;; Shut up the byte compiler.
6154 ;; An after change function which, in conjunction with the info in
6155 ;; c-maybe-stale-found-type (set in c-before-change), removes a type
6156 ;; from `c-found-types', should this type have become stale. For
6157 ;; example, this happens to "foo" when "foo \n bar();" becomes
6158 ;; "foo(); \n bar();". Such stale types, if not removed, foul up
6159 ;; the fontification.
6160 ;;
6161 ;; Have we, perhaps, added non-ws characters to the front/back of a found
6162 ;; type?
6182 ;; Changing the amount of (already existing) whitespace - don't do anything.
6187 ;; The syntactic relationship which defined a "found type" has been
6188 ;; destroyed.
6191 ;; ((eq (car c-maybe-stale-found-type) 'c-decl-type-start) FIXME!!!
6192 )))
6194 \f
6195 ;; Setting and removing syntax properties on < and > in languages (C++
6196 ;; and Java) where they can be template/generic delimiters as well as
6197 ;; their normal meaning of "less/greater than".
6199 ;; Normally, < and > have syntax 'punctuation'. When they are found to
6200 ;; be delimiters, they are marked as such with the category properties
6201 ;; c-<-as-paren-syntax, c->-as-paren-syntax respectively.
6203 ;; STRATEGY:
6204 ;;
6205 ;; It is impossible to determine with certainty whether a <..> pair in
6206 ;; C++ is two comparison operators or is template delimiters, unless
6207 ;; one duplicates a lot of a C++ compiler. For example, the following
6208 ;; code fragment:
6209 ;;
6210 ;; foo (a < b, c > d) ;
6211 ;;
6212 ;; could be a function call with two integer parameters (each a
6213 ;; relational expression), or it could be a constructor for class foo
6214 ;; taking one parameter d of templated type "a < b, c >". They are
6215 ;; somewhat easier to distinguish in Java.
6216 ;;
6217 ;; The strategy now (2010-01) adopted is to mark and unmark < and
6218 ;; > IN MATCHING PAIRS ONLY. [Previously, they were marked
6219 ;; individually when their context so indicated. This gave rise to
6220 ;; intractable problems when one of a matching pair was deleted, or
6221 ;; pulled into a literal.]
6222 ;;
6223 ;; At each buffer change, the syntax-table properties are removed in a
6224 ;; before-change function and reapplied, when needed, in an
6225 ;; after-change function. It is far more important that the
6226 ;; properties get removed when they they are spurious than that they
6227 ;; be present when wanted.
6228 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
6230 ;; POS (default point) is at a < character. If it is marked with
6231 ;; open paren syntax-table text property, remove the property,
6232 ;; together with the close paren property on the matching > (if
6233 ;; any).
6248 ;; POS (default point) is at a > character. If it is marked with
6249 ;; close paren syntax-table property, remove the property, together
6250 ;; with the open paren property on the matching < (if any).
6265 ;; POS (default point) is at a < or > character. If it has an
6266 ;; open/close paren syntax-table property, remove this property both
6267 ;; from the current character and its partner (which will also be
6268 ;; thusly marked).
6278 ;; POS (default point) is at a < character. If it is both marked
6279 ;; with open/close paren syntax-table property, and has a matching >
6280 ;; (also marked) which is after LIM, remove the property both from
6281 ;; the current > and its partner. Return t when this happens, nil
6282 ;; when it doesn't.
6296 t)))
6299 ;; POS (default point) is at a > character. If it is both marked
6300 ;; with open/close paren syntax-table property, and has a matching <
6301 ;; (also marked) which is before LIM, remove the property both from
6302 ;; the current < and its partner. Return t when this happens, nil
6303 ;; when it doesn't.
6317 t)))
6319 ;; Set by c-common-init in cc-mode.el.
6322 ;; Set by c-after-change in cc-mode.el.
6327 ;; Unmark certain pairs of "< .... >" which are currently marked as
6328 ;; template/generic delimiters. (This marking is via syntax-table text
6329 ;; properties), and expand the (c-new-BEG c-new-END) region to include all
6330 ;; unmarked < and > operators within the certain bounds (see below).
6331 ;;
6332 ;; These pairs are those which are in the current "statement" (i.e.,
6333 ;; the region between the {, }, or ; before BEG and the one after
6334 ;; END), and which enclose any part of the interval (BEG END).
6335 ;;
6336 ;; Note that in C++ (?and Java), template/generic parens cannot
6337 ;; enclose a brace or semicolon, so we use these as bounds on the
6338 ;; region we must work on.
6339 ;;
6340 ;; This function is called from before-change-functions (via
6341 ;; c-get-state-before-change-functions). Thus the buffer is widened,
6342 ;; and point is undefined, both at entry and exit.
6343 ;;
6344 ;; FIXME!!! This routine ignores the possibility of macros entirely.
6345 ;; 2010-01-29.
6350 new-beg new-end beg-limit end-limit)
6351 ;; Locate the earliest < after the barrier before the changed region,
6352 ;; which isn't already marked as a paren.
6356 ;; Remove the syntax-table/category properties from each pertinent <...>
6357 ;; pair. Firstly, the ones with the < before beg and > after beg....
6366 ;; ...Then the ones with < before end and > after end.
6377 ;; Extend the fontification region, if needed.
6386 ;; This is called from `after-change-functions' when
6387 ;; c-recognize-<>-arglists' is set. It ensures that no "<" or ">"
6388 ;; chars with paren syntax become part of another operator like "<<"
6389 ;; or ">=".
6390 ;;
6391 ;; This function might do hidden buffer changes.
6427 ;; This function is called as an after-change function. It restores the
6428 ;; category/syntax-table properties on template/generic <..> pairs between
6429 ;; c-new-BEG and c-new-END. It may do hidden buffer changes.
6450 \f
6451 ;; Functions to handle C++ raw strings.
6452 ;;
6453 ;; A valid C++ raw string looks like
6454 ;; R"<id>(<contents>)<id>"
6455 ;; , where <id> is an identifier from 0 to 16 characters long, not containing
6456 ;; spaces, control characters, double quote or left/right paren. <contents>
6457 ;; can include anything which isn't the terminating )<id>", including new
6458 ;; lines, "s, parentheses, etc.
6459 ;;
6460 ;; CC Mode handles C++ raw strings by the use of `syntax-table' text
6461 ;; properties as follows:
6462 ;;
6463 ;; (i) On a validly terminated raw string, no `syntax-table' text properties
6464 ;; are applied to the opening and closing delimiters, but any " in the
6465 ;; contents is given the property value "punctuation" (`(1)') to prevent it
6466 ;; interacting with the "s in the delimiters.
6467 ;;
6468 ;; The font locking routine `c-font-lock-c++-raw-strings' (in cc-fonts.el)
6469 ;; recognizes valid raw strings, and fontifies the delimiters (apart from
6470 ;; the parentheses) with the default face and the parentheses and the
6471 ;; <contents> with font-lock-string-face.
6472 ;;
6473 ;; (ii) A valid, but unterminated, raw string opening delimiter gets the
6474 ;; "punctuation" value (`(1)') of the `syntax-table' text property, and the
6475 ;; open parenthesis gets the "string fence" value (`(15)').
6476 ;;
6477 ;; `c-font-lock-c++-raw-strings' puts c-font-lock-warning-face on the entire
6478 ;; unmatched opening delimiter (from the R up to the open paren), and allows
6479 ;; the rest of the buffer to get font-lock-string-face, caused by the
6480 ;; unmatched "string fence" `syntax-table' text property value.
6481 ;;
6482 ;; (iii) Inside a macro, a valid raw string is handled as in (i). An
6483 ;; unmatched opening delimiter is handled slightly differently. In addition
6484 ;; to the "punctuation" and "string fence" properties on the delimiter,
6485 ;; another "string fence" `syntax-table' property is applied to the last
6486 ;; possible character of the macro before the terminating linefeed (if there
6487 ;; is such a character after the "("). This "last possible" character is
6488 ;; never a backslash escaping the end of line. If the character preceding
6489 ;; this "last possible" character is itself a backslash, this preceding
6490 ;; character gets a "punctuation" `syntax-table' value. If the "(" is
6491 ;; already at the end of the macro, it gets the "punctuation" value, and no
6492 ;; "string fence"s are used.
6493 ;;
6494 ;; The effect on the fontification of either of these tactics is that rest of
6495 ;; the macro (if any) after the "(" gets font-lock-string-face, but the rest
6496 ;; of the file is fontified normally.
6500 ;; Get POINT's relationship to any containing raw string.
6501 ;; If point isn't in a raw string, return nil.
6502 ;; Otherwise, return the following list:
6503 ;;
6504 ;; (POS B\" B\( E\) E\")
6505 ;;
6506 ;; , where POS is the symbol `open-delim' if point is in the opening
6507 ;; delimiter, the symbol `close-delim' if it's in the closing delimiter, and
6508 ;; nil if it's in the string body. B\", B\(, E\), E\" are the positions of
6509 ;; the opening and closing quotes and parentheses of a correctly terminated
6510 ;; raw string. (N.B.: E\) and E\" are NOT on the "outside" of these
6511 ;; characters.) If the raw string is not terminated, E\) and E\" are set to
6512 ;; nil.
6513 ;;
6514 ;; Note: this routine is dependant upon the correct syntax-table text
6515 ;; properties being set.
6517 open-quote-pos open-paren-pos close-paren-pos close-quote-pos id)
6549 open-quote-pos open-paren-pos close-paren-pos close-quote-pos))))
6552 ;; Point is immediately after a raw string opening delimiter. Remove any
6553 ;; `syntax-table' text properties associated with the delimiter (if it's
6554 ;; unmatched) or the raw string.
6555 ;;
6556 ;; ID, a string, is the delimiter's identifier. OPEN-QUOTE and OPEN-PAREN
6557 ;; are the buffer positions of the delimiter's components. BOUND is the
6558 ;; bound for searching for a matching closing delimiter; it is usually nil,
6559 ;; but if we're inside a macro, it's the end of the macro.
6560 ;;
6561 ;; Point is moved to after the (terminated) raw string, or left after the
6562 ;; unmatched opening delimiter, as the case may be. The return value is of
6563 ;; no significance.
6567 ;; A terminated raw string
6574 closing-paren)
6576 )
6581 ))))
6584 ;; An unterminated raw string either not in a macro, or in a macro with
6585 ;; the open parenthesis right up against the end of macro
6590 ;; An unterminated string in a macro, with at least one char after the
6591 ;; open paren
6601 ))))
6604 ;; Remove any `syntax-table' text properties associated with C++ raw strings
6605 ;; contained in the region (START FINISH). Point is undefined at entry and
6606 ;; exit, and the return value has no significance.
6611 c-anchored-cpp-prefix ; 2
6615 finish t))
6619 ;; We've found a raw string
6625 ;; We've found a CPP construct. Search for raw strings within it.
6640 ;; This function clears `syntax-table' text properties from C++ raw strings
6641 ;; in the region (c-new-BEG c-new-END). BEG and END are the standard
6642 ;; arguments supplied to any before-change function.
6643 ;;
6644 ;; Point is undefined on both entry and exit, and the return value has no
6645 ;; significance.
6646 ;;
6647 ;; This function is called as a before-change function solely due to its
6648 ;; membership of the C++ value of `c-get-state-before-change-functions'.
6652 beg
6656 ; Optimize this so that we don't call
6657 ; `c-raw-string-pos' twice when once
6658 ; will do. (2016-06-02).
6660 end
6662 )
6674 ;; Point is immediately after a raw string opening delimiter. Apply any
6675 ;; pertinent `syntax-table' text properties to the delimiter and also the
6676 ;; raw string, should there be a valid matching closing delimiter.
6677 ;;
6678 ;; ID, a string, is the delimiter's identifier. OPEN-QUOTE and OPEN-PAREN
6679 ;; are the buffer positions of the delimiter's components. BOUND is the
6680 ;; bound for searching for a matching closing delimiter; it is usually nil,
6681 ;; but if we're inside a macro, it's the end of the macro.
6682 ;;
6683 ;; Point is moved to after the (terminated) raw string, or left after the
6684 ;; unmatched opening delimiter, as the case may be. The return value is of
6685 ;; no significance.
6700 ;; In a CPP construct, we try to apply a generic-string `syntax-table'
6701 ;; text property to the last possible character in the string, so that
6702 ;; only characters within the macro get "stringed out".
6708 ;; This regular expression matches either an escape pair (which
6709 ;; isn't an escaped NL) (submatch 5) or a non-escaped character
6710 ;; (which isn't itself a backslash) (submatch 10). The long
6711 ;; preambles to these (respectively submatches 2-4 and 6-9)
6712 ;; ensure that we have the correct parity for sequences of
6713 ;; backslashes, etc..
6734 ;; This function applies `syntax-table' text properties to C++ raw strings
6735 ;; beginning in the region (c-new-BEG c-new-END). BEG, END, and OLD-LEN are
6736 ;; the standard arguments supplied to any after-change function.
6737 ;;
6738 ;; Point is undefined on both entry and exit, and the return value has no
6739 ;; significance.
6740 ;;
6741 ;; This function is called as an after-change function solely due to its
6742 ;; membership of the C++ value of `c-before-font-lock-functions'.
6744 ;; If the region (c-new-BEG c-new-END) has expanded, remove
6745 ;; `syntax-table' text-properties from the new piece(s).
6749 c-new-BEG
6752 c-old-BEG))))
6758 c-old-END)
6759 c-new-END)))
6765 c-anchored-cpp-prefix ; 2
6769 c-new-END t))
6773 ;; We've found a raw string.
6779 ;; We've found a CPP construct. Search for raw strings within it.
6793 \f
6794 ;; Handling of small scale constructs like types and names.
6796 ;; Dynamically bound variable that instructs `c-forward-type' to also
6797 ;; treat possible types (i.e. those that it normally returns 'maybe or
6798 ;; 'found for) as actual types (and always return 'found for them).
6799 ;; This means that it records them in `c-record-type-identifiers' if
6800 ;; that is set, and that it adds them to `c-found-types'.
6803 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
6804 ;; mark up successfully parsed arglists with paren syntax properties on
6805 ;; the surrounding angle brackets and with `c-<>-arg-sep' in the
6806 ;; `c-type' property of each argument separating comma.
6807 ;;
6808 ;; Setting this variable also makes `c-forward-<>-arglist' recurse into
6809 ;; all arglists for side effects (i.e. recording types), otherwise it
6810 ;; exploits any existing paren syntax properties to quickly jump to the
6811 ;; end of already parsed arglists.
6812 ;;
6813 ;; Marking up the arglists is not the default since doing that correctly
6814 ;; depends on a proper value for `c-restricted-<>-arglists'.
6817 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
6818 ;; not accept arglists that contain binary operators.
6819 ;;
6820 ;; This is primarily used to handle C++ template arglists. C++
6821 ;; disambiguates them by checking whether the preceding name is a
6822 ;; template or not. We can't do that, so we assume it is a template
6823 ;; if it can be parsed as one. That usually works well since
6824 ;; comparison expressions on the forms "a < b > c" or "a < b, c > d"
6825 ;; in almost all cases would be pointless.
6826 ;;
6827 ;; However, in function arglists, e.g. in "foo (a < b, c > d)", we
6828 ;; should let the comma separate the function arguments instead. And
6829 ;; in a context where the value of the expression is taken, e.g. in
6830 ;; "if (a < b || c > d)", it's probably not a template.
6833 ;; Dynamically bound variables that instructs
6834 ;; `c-forward-keyword-clause', `c-forward-<>-arglist',
6835 ;; `c-forward-name', `c-forward-type', `c-forward-decl-or-cast-1', and
6836 ;; `c-forward-label' to record the ranges of all the type and
6837 ;; reference identifiers they encounter. They will build lists on
6838 ;; these variables where each element is a cons of the buffer
6839 ;; positions surrounding each identifier. This recording is only
6840 ;; activated when `c-record-type-identifiers' is non-nil.
6841 ;;
6842 ;; All known types that can't be identifiers are recorded, and also
6843 ;; other possible types if `c-promote-possible-types' is set.
6844 ;; Recording is however disabled inside angle bracket arglists that
6845 ;; are encountered inside names and other angle bracket arglists.
6846 ;; Such occurrences are taken care of by `c-font-lock-<>-arglists'
6847 ;; instead.
6848 ;;
6849 ;; Only the names in C++ template style references (e.g. "tmpl" in
6850 ;; "tmpl<a,b>::foo") are recorded as references, other references
6851 ;; aren't handled here.
6852 ;;
6853 ;; `c-forward-label' records the label identifier(s) on
6854 ;; `c-record-ref-identifiers'.
6858 ;; This variable will receive a cons cell of the range of the last
6859 ;; single identifier symbol stepped over by `c-forward-name' if it's
6860 ;; successful. This is the range that should be put on one of the
6861 ;; record lists above by the caller. It's assigned nil if there's no
6862 ;; such symbol in the name.
6867 ;; Always true.
6877 ;; Always true.
6885 ;; Dynamically bound variable that instructs `c-forward-type' to
6886 ;; record the ranges of types that only are found. Behaves otherwise
6887 ;; like `c-record-type-identifiers'.
6891 ;; Used internally in `c-forward-keyword-clause' to move forward
6892 ;; over a type (if TYPE is 'type) or a name (otherwise) which
6893 ;; possibly is prefixed by keywords and their associated clauses.
6894 ;; Try with a type/name first to not trip up on those that begin
6895 ;; with a keyword. Return t if a known or found type is moved
6896 ;; over. The point is clobbered if nil is returned. If range
6897 ;; recording is enabled, the identifier is recorded on as a type
6898 ;; if TYPE is 'type or as a reference if TYPE is 'ref.
6899 ;;
6900 ;; This macro might do hidden buffer changes.
6906 nil
6917 t)))
6920 ;; Used internally in `c-forward-keyword-clause' to move forward
6921 ;; over a comma separated list of types or names using
6922 ;; `c-forward-keyword-prefixed-id'.
6923 ;;
6924 ;; This macro might do hidden buffer changes.
6935 ;; Point is at a c-noise-macro-with-parens-names macro identifier. Go
6936 ;; forward over this name, any parenthesis expression which follows it, and
6937 ;; any syntactic WS, ending up at the next token. If there is an unbalanced
6938 ;; paren expression, leave point at it. Always Return t.
6943 t)
6946 ;; Submatch MATCH in the current match data is assumed to surround a
6947 ;; token. If it's a keyword, move over it and any immediately
6948 ;; following clauses associated with it, stopping at the start of
6949 ;; the next token. t is returned in that case, otherwise the point
6950 ;; stays and nil is returned. The kind of clauses that are
6951 ;; recognized are those specified by `c-type-list-kwds',
6952 ;; `c-ref-list-kwds', `c-colon-type-list-kwds',
6953 ;; `c-paren-nontype-kwds', `c-paren-type-kwds', `c-<>-type-kwds',
6954 ;; `c-<>-arglist-kwds', and `c-protection-kwds'.
6955 ;;
6956 ;; This function records identifier ranges on
6957 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6958 ;; `c-record-type-identifiers' is non-nil.
6959 ;;
6960 ;; Note that for `c-colon-type-list-kwds', which doesn't necessary
6961 ;; apply directly after the keyword, the type list is moved over
6962 ;; only when there is no unaccounted token before it (i.e. a token
6963 ;; that isn't moved over due to some other keyword list). The
6964 ;; identifier ranges in the list are still recorded if that should
6965 ;; be done, though.
6966 ;;
6967 ;; This function might do hidden buffer changes.
6970 ;; The call to `c-forward-<>-arglist' below is made after
6971 ;; `c-<>-sexp-kwds' keywords, so we're certain they actually
6972 ;; are angle bracket arglists and `c-restricted-<>-arglists'
6973 ;; should therefore be nil.
6985 ;; There's a type directly after a keyword in `c-type-list-kwds'.
6990 ;; There's a name directly after a keyword in `c-ref-list-kwds'.
6995 ;; There's an open paren after a keyword in `c-paren-any-kwds'.
7002 ;; Use `c-forward-type' on every identifier we can find
7003 ;; inside the paren, to record the types.
7039 ;; If we are at the colon already, we move over the type
7040 ;; list after it.
7046 ;; Not at the colon, so stop here. But the identifier
7047 ;; ranges in the type list later on should still be
7048 ;; recorded.
7051 ;; If a keyword matched both one of the types above and
7052 ;; this one, we match `c-colon-type-list-re' after the
7053 ;; clause matched above.
7060 ;; There's a type after the `c-colon-type-list-re' match
7061 ;; after a keyword in `c-colon-type-list-kwds'.
7065 t)))
7067 ;; cc-mode requires cc-fonts.
7071 ;; The point is assumed to be at a "<". Try to treat it as the open
7072 ;; paren of an angle bracket arglist and move forward to the
7073 ;; corresponding ">". If successful, the point is left after the
7074 ;; ">" and t is returned, otherwise the point isn't moved and nil is
7075 ;; returned. If ALL-TYPES is t then all encountered arguments in
7076 ;; the arglist that might be types are treated as found types.
7077 ;;
7078 ;; The variable `c-parse-and-markup-<>-arglists' controls how this
7079 ;; function handles text properties on the angle brackets and argument
7080 ;; separating commas.
7081 ;;
7082 ;; `c-restricted-<>-arglists' controls how lenient the template
7083 ;; arglist recognition should be.
7084 ;;
7085 ;; This function records identifier ranges on
7086 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
7087 ;; `c-record-type-identifiers' is non-nil.
7088 ;;
7089 ;; This function might do hidden buffer changes.
7093 ;; If `c-record-type-identifiers' is set then activate
7094 ;; recording of any found types that constitute an argument in
7095 ;; the arglist.
7103 ;; `nconc' doesn't mind that the tail of
7104 ;; `c-record-found-types' is t.
7106 t)
7110 nil)))
7113 ;; Recursive part of `c-forward-<>-arglist'.
7114 ;;
7115 ;; This function might do hidden buffer changes.
7117 ;; Cover this so that any recorded found type ranges are
7118 ;; automatically lost if it turns out to not be an angle
7119 ;; bracket arglist. It's propagated through the return value
7120 ;; on successful completion.
7122 ;; List that collects the positions after the argument
7123 ;; separating ',' in the arglist.
7124 arg-start-pos)
7125 ;; If the '<' has paren open syntax then we've marked it as an angle
7126 ;; bracket arglist before, so skip to the end.
7134 t
7135 ;; Got unmatched paren angle brackets. We don't clear the paren
7136 ;; syntax properties and retry, on the basis that it's very
7137 ;; unlikely that paren angle brackets become operators by code
7138 ;; manipulation. It's far more likely that it doesn't match due
7139 ;; to narrowing or some temporary change.
7141 nil))
7146 ;; go forward one non-alphanumeric character (group) per iteration of
7147 ;; this loop.
7161 ;; All encountered identifiers are types, so set the
7162 ;; promote flag and parse the type.
7180 ;; Note: These regexps exploit the match order in \| so
7181 ;; that "<>" is matched by "<" rather than "[^>:-]>".
7183 ;; Stop on ',', '|', '&', '+' and '-' to catch
7184 ;; common binary operators that could be between
7185 ;; two comparison expressions "a<b" and "c>d".
7186 ;; 2016-02-11: C++11 templates can now contain arithmetic
7187 ;; expressions, so template detection in C++ is now less
7188 ;; robust than it was.
7189 c-<>-notable-chars-re
7190 nil t t))
7194 ;; Either an operator starting with '>' or the end of
7195 ;; the angle bracket arglist.
7204 ;; The angle bracket arglist is finished.
7216 ;; Either an operator starting with '<' or a nested arglist.
7220 ;; The '<' begins a multi-char operator.
7223 ;; We're at a nested <.....>
7228 ;; There's always an identifier before an angle
7229 ;; bracket arglist, or a keyword in `c-<>-type-kwds'
7230 ;; or `c-<>-arglist-kwds'.
7247 subres)
7248 ;; It was an angle bracket arglist.
7251 ;; Record the identifier before the template as a type
7252 ;; or reference depending on whether the arglist is last
7253 ;; in a qualified identifier.
7263 ;; At a "less than" operator.
7265 ;; (forward-char) ; NO! We've already gone over the <.
7266 )))
7278 ;; Just another argument. Record the position. The
7279 ;; type check stuff that made us stop at it is at
7280 ;; the top of the loop.
7284 ;; Got a character that can't be in an angle bracket
7285 ;; arglist argument. Abort using `throw', since
7286 ;; it's useless to try to find a surrounding arglist
7287 ;; if we're nested.
7293 ;; The point is assumed to be directly after a ">". Try to treat it
7294 ;; as the close paren of an angle bracket arglist and move back to
7295 ;; the corresponding "<". If successful, the point is left at
7296 ;; the "<" and t is returned, otherwise the point isn't moved and
7297 ;; nil is returned. ALL-TYPES is passed on to
7298 ;; `c-forward-<>-arglist'.
7299 ;;
7300 ;; If the optional LIMIT is given, it bounds the backward search.
7301 ;; It's then assumed to be at a syntactically relevant position.
7302 ;;
7303 ;; This is a wrapper around `c-forward-<>-arglist'. See that
7304 ;; function for more details.
7313 t
7314 ;; See corresponding note in `c-forward-<>-arglist'.
7316 nil)
7323 t
7324 ;; Stopped at bob or a char that isn't allowed in an
7325 ;; arglist, so we've failed.
7327 nil)
7332 ;; If we moved then the "<" was part of some
7333 ;; multicharacter token.
7334 t
7340 ;; Matched the arglist. Break the while.
7342 nil)
7344 ;; We started from a non-paren ">" inside an
7345 ;; arglist.
7347 nil)
7349 ;; Matched a shorter arglist. Can be a nested
7350 ;; one so continue looking.
7352 t))
7353 t))))))
7358 ;; Move forward over a complete name if at the beginning of one,
7359 ;; stopping at the next following token. A keyword, as such,
7360 ;; doesn't count as a name. If the point is not at something that
7361 ;; is recognized as a name then it stays put.
7362 ;;
7363 ;; A name could be something as simple as "foo" in C or something as
7364 ;; complex as "X<Y<class A<int>::B, BIT_MAX >> b>, ::operator<> ::
7365 ;; Z<(a>b)> :: operator const X<&foo>::T Q::G<unsigned short
7366 ;; int>::*volatile const" in C++ (this function is actually little
7367 ;; more than a `looking-at' call in all modes except those that,
7368 ;; like C++, have `c-recognize-<>-arglists' set).
7369 ;;
7370 ;; Return
7371 ;; o - nil if no name is found;
7372 ;; o - 'template if it's an identifier ending with an angle bracket
7373 ;; arglist;
7374 ;; o - 'operator of it's an operator identifier;
7375 ;; o - t if it's some other kind of name.
7376 ;;
7377 ;; This function records identifier ranges on
7378 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
7379 ;; `c-record-type-identifiers' is non-nil.
7380 ;;
7381 ;; This function might do hidden buffer changes.
7384 ;; Turn off `c-promote-possible-types' here since we might
7385 ;; call `c-forward-<>-arglist' and we don't want it to promote
7386 ;; every suspect thing in the arglist to a type. We're
7387 ;; typically called from `c-forward-type' in this case, and
7388 ;; the caller only wants the top level type that it finds to
7389 ;; be promoted.
7390 c-promote-possible-types)
7396 ;; Check for keyword. We go to the last symbol in
7397 ;; `c-identifier-key' first.
7410 ;; "template" is only valid inside an
7411 ;; identifier if preceded by "::".
7416 t))
7418 ;; Handle a C++ operator or template identifier.
7422 ;; Got "... ::template".
7426 res subres))))
7430 c-ambiguous-overloadable-or-identifier-prefix-re))
7434 ;; Got a cast operator.
7438 ;; Now we should match a sequence of either
7439 ;; '*', '&' or a name followed by ":: *",
7440 ;; where each can be followed by a sequence
7441 ;; of `c-opt-type-modifier-key'.
7444 t)
7454 t))))
7462 ;; Got some other operator.
7470 nil)
7472 ;; `id-start' is equal to `id-end' if we've jumped over
7473 ;; an identifier that doesn't end with a symbol token.
7474 ;; That can occur e.g. for Java import directives on the
7475 ;; form "foo.bar.*".
7482 res t)))
7492 ;; Got a concatenated identifier. This handles the
7493 ;; cases with tricky syntactic whitespace that aren't
7494 ;; covered in `c-identifier-key'.
7497 t)
7501 ;; Maybe an angle bracket arglist.
7514 ;; Continue if there's an identifier concatenation
7515 ;; operator after the template argument.
7521 t)
7527 nil)))
7528 )))))
7531 res))
7534 ;; Move forward over a type spec if at the beginning of one,
7535 ;; stopping at the next following token. The keyword "typedef"
7536 ;; isn't part of a type spec here.
7537 ;;
7538 ;; BRACE-BLOCK-TOO, when non-nil, means move over the brace block in
7539 ;; constructs like "struct foo {...} bar ;" or "struct {...} bar;".
7540 ;; The current (2009-03-10) intention is to convert all uses of
7541 ;; `c-forward-type' to call with this parameter set, then to
7542 ;; eliminate it.
7543 ;;
7544 ;; Return
7545 ;; o - t if it's a known type that can't be a name or other
7546 ;; expression;
7547 ;; o - 'known if it's an otherwise known type (according to
7548 ;; `*-font-lock-extra-types');
7549 ;; o - 'prefix if it's a known prefix of a type;
7550 ;; o - 'found if it's a type that matches one in `c-found-types';
7551 ;; o - 'maybe if it's an identifier that might be a type;
7552 ;; o - 'decltype if it's a decltype(variable) declaration; - or
7553 ;; o - nil if it can't be a type (the point isn't moved then).
7554 ;;
7555 ;; The point is assumed to be at the beginning of a token.
7556 ;;
7557 ;; Note that this function doesn't skip past the brace definition
7558 ;; that might be considered part of the type, e.g.
7559 ;; "enum {a, b, c} foo".
7560 ;;
7561 ;; This function records identifier ranges on
7562 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
7563 ;; `c-record-type-identifiers' is non-nil.
7564 ;;
7565 ;; This function might do hidden buffer changes.
7573 ;; Skip leading type modifiers. If any are found we know it's a
7574 ;; prefix of a type.
7593 ; "typedef".
7612 ;; In many languages the name can be used without the
7613 ;; prefix, so we add it to `c-found-types'.
7616 c-last-identifier-range)
7638 id-range c-last-identifier-range))))
7650 id-end)
7652 ;; Looking at a primitive or known type identifier. We've
7653 ;; checked for a name first so that we don't go here if the
7654 ;; known type match only is a prefix of another name.
7665 ;; There might be more keywords for the type.
7693 ;; A normal identifier.
7703 ;; It's an identifier that has been used as
7704 ;; a type somewhere else.
7705 'found
7706 ;; It's an identifier that might be a type.
7709 ;; A template is sometimes a type.
7715 ;; It's an identifier that has been used as
7716 ;; a type somewhere else.
7717 'found
7718 ;; It's an identifier that might be a type.
7720 t)))
7722 ;; Otherwise it's an operator identifier, which is not a type.
7727 ;; Skip trailing type modifiers. If any are found we know it's
7728 ;; a type.
7735 ;; Step over any type suffix operator. Do not let the existence
7736 ;; of these alter the classification of the found type, since
7737 ;; these operators typically are allowed in normal expressions
7738 ;; too.
7744 ;; Skip any "WS" identifiers (e.g. "final" or "override" in C++)
7751 ;; Look for a trailing operator that concatenates the type
7752 ;; with a following one, and if so step past that one through
7753 ;; a recursive call. Note that we don't record concatenated
7754 ;; types in `c-found-types' - it's the component types that
7755 ;; are recorded when appropriate.
7758 c-promote-possible-types))
7759 ;; If we can't promote then set `c-record-found-types' so that
7760 ;; we can merge in the types from the second part afterwards if
7761 ;; it turns out to be a known type there.
7764 subres)
7773 ;; If either operand certainly is a type then both are, but we
7774 ;; don't let the existence of the operator itself promote two
7775 ;; uncertain types to a certain one.
7794 ;; Merge in the ranges of any types found by the second
7795 ;; `c-forward-type'.
7797 ;; `nconc' doesn't mind that the tail of
7798 ;; `c-record-found-types' is t.
7800 c-record-type-identifiers))))
7808 ;;(message "c-forward-type %s -> %s: %s" start (point) res)
7810 res))
7813 ;; Used for Java code only at the moment. Assumes point is on the @, moves
7814 ;; forward an annotation and returns t. Leaves point unmoved and returns
7815 ;; nil if there is no annotation at point.
7824 t)
7827 t))
7831 ;; Pull the next open brace from PS (which has the form of paren-state),
7832 ;; skipping over any brace pairs. Returns NIL when PS is exhausted.
7840 ;; Point is putatively just after a "compound identifier", i.e. something
7841 ;; looking (in C++) like this "FQN::of::base::Class". Move to the start of
7842 ;; this construct and return t. If the parsing fails, return nil, leaving
7843 ;; point unchanged.
7846 nil
7854 c-opt-identifier-concat-key
7861 t)))
7864 ;; Point is just after a closing brace/parenthesis. Try to parse this as a
7865 ;; C++ member initializer list, going back to just after the introducing ":"
7866 ;; and returning t. Otherwise return nil, leaving point unchanged.
7891 res))
7894 ;; Go back over a list of elements, each looking like:
7895 ;; <symbol> (<expression>) ,
7896 ;; or <symbol> {<expression>} , (with possibly a <....> expressions
7897 ;; following the <symbol>).
7898 ;; when we are putatively immediately after a comma. Stop when we don't see
7899 ;; a comma. If either of <symbol> or bracketed <expression> is missing,
7900 ;; throw nil to 'level. If the terminating } or ) is unmatched, throw nil
7901 ;; to 'done. This is not a general purpose macro!
7919 ;; Test whether we are in a C++ member initializer list, and if so, go back
7920 ;; to the introducing ":", returning the position of the opening paren of
7921 ;; the function's arglist. Otherwise return nil, leaving point unchanged.
7924 pos level-plausible at-top-level res)
7925 ;; Assume tentatively that we're at the top level. Try to go back to the
7926 ;; colon we seek.
7964 res))
7966 \f
7967 ;; Handling of large scale constructs like statements and declarations.
7969 ;; Macro used inside `c-forward-decl-or-cast-1'. It ought to be a
7970 ;; defsubst or perhaps even a defun, but it contains lots of free
7971 ;; variables that refer to things inside `c-forward-decl-or-cast-1'.
7973 ;; `c-forward-decl-or-cast-1' can consume an arbitrary length list
7974 ;; of types when parsing a declaration, which means that it
7975 ;; sometimes consumes the identifier in the declaration as a type.
7976 ;; This is used to "backtrack" and make the last type be treated as
7977 ;; an identifier instead.
7980 ;; These identifiers are bound only in the inner let.
7982 identifier-start type-start
7983 got-parens nil
7984 got-identifier t
7985 got-suffix t
7986 got-suffix-after-parens id-start
7990 t
7991 backup-at-type))
7993 id-start backup-id-start)
7995 id-start start-pos))
7997 ;; When these flags already are set we've found specifiers that
7998 ;; unconditionally signal these attributes - backtracking doesn't
7999 ;; change that. So keep them set in that case.
8006 ;; This identifier is bound only in the inner let.
8010 ;; Assuming point is at the start of a declarator, move forward over it,
8011 ;; leaving point at the next token after it (e.g. a ) or a ; or a ,).
8012 ;;
8013 ;; Return a list (ID-START ID-END BRACKETS-AFTER-ID GOT-INIT DECORATED),
8014 ;; where ID-START and ID-END are the bounds of the declarator's identifier,
8015 ;; and BRACKETS-AFTER-ID is non-nil if a [...] pair is present after the id.
8016 ;; GOT-INIT is non-nil when the declarator is followed by "=" or "(",
8017 ;; DECORATED is non-nil when the identifier is embellished by an operator,
8018 ;; like "*x", or "(*x)".
8019 ;;
8020 ;; If ACCEPT-ANON is non-nil, move forward over any "anonymous declarator",
8021 ;; i.e. something like the (*) in int (*), such as might be found in a
8022 ;; declaration. In such a case ID-START and ID-END in the return value are
8023 ;; both set to nil. A "null" "anonymous declarator" gives a non-nil result.
8024 ;;
8025 ;; If no declarator is found, leave point unmoved and return nil. LIMIT is
8026 ;; an optional limit for forward searching.
8027 ;;
8028 ;; Note that the global variable `c-last-identifier-range' is written to, so
8029 ;; the caller should bind it if necessary.
8031 ;; Inside the following "condition form", we move forward over the
8032 ;; declarator's identifier up as far as any opening bracket (for array
8033 ;; size) or paren (for parameters of function-type) or brace (for
8034 ;; array/struct initialization) or "=" or terminating delimiter
8035 ;; (e.g. "," or ";" or "}").
8037 id-start id-end brackets-after-id paren-depth decorated)
8042 ;; The following form moves forward over the declarator's
8043 ;; identifier (and what precedes it), returning t. If there
8044 ;; wasn't one, it returns nil.
8047 ;; Skip over type decl prefix operators, one for each iteration
8048 ;; of the while. These are, e.g. "*" in "int *foo" or "(" and
8049 ;; "*" in "int (*foo) (void)" (Note similar code in
8050 ;; `c-forward-decl-or-cast-1'.)
8061 ;; If the third submatch matches in C++ then
8062 ;; we're looking at an identifier that's a
8063 ;; prefix only if it specifies a member pointer.
8068 ;; We only check for a trailing "::" and
8069 ;; let the "*" that should follow be
8070 ;; matched in the next round.
8071 t
8072 ;; It turned out to be the real identifier,
8073 ;; so flag that and stop.
8075 nil))
8076 t))
8085 t)))
8087 ;; If we haven't passed the identifier already, do it now.
8098 t)
8101 ;; Skip out of the parens surrounding the identifier. If closing
8102 ;; parens are missing, this form returns nil.
8108 ;; Skip over any trailing bit, such as "__attribute__".
8118 ;; Search syntactically to the end of the declarator (";",
8119 ;; ",", a closing paren, eob etc) or to the beginning of an
8120 ;; initializer or function prototype ("=" or "\\s\(").
8121 ;; Note that square brackets are now not also treated as
8122 ;; initializers, since this broke when there were also
8123 ;; initializing brace lists.
8128 ;; In the next loop, we keep searching forward whilst
8129 ;; we find ":"s which aren't single colons inside C++
8130 ;; "for" statements.
8137 limit t t))
8150 found)
8159 nil)))
8162 ;; Move forward over a declaration or a cast if at the start of one.
8163 ;; The point is assumed to be at the start of some token. Nil is
8164 ;; returned if no declaration or cast is recognized, and the point
8165 ;; is clobbered in that case.
8166 ;;
8167 ;; If a declaration is parsed:
8168 ;;
8169 ;; The point is left at the first token after the first complete
8170 ;; declarator, if there is one. The return value is a list of 5 elements,
8171 ;; where the first is the position of the first token in the declarator.
8172 ;; (See below for the other four.)
8173 ;; Some examples:
8174 ;;
8175 ;; void foo (int a, char *b) stuff ...
8176 ;; car ^ ^ point
8177 ;; float (*a)[], b;
8178 ;; car ^ ^ point
8179 ;; unsigned int a = c_style_initializer, b;
8180 ;; car ^ ^ point
8181 ;; unsigned int a (cplusplus_style_initializer), b;
8182 ;; car ^ ^ point (might change)
8183 ;; class Foo : public Bar {}
8184 ;; car ^ ^ point
8185 ;; class PikeClass (int a, string b) stuff ...
8186 ;; car ^ ^ point
8187 ;; enum bool;
8188 ;; car ^ ^ point
8189 ;; enum bool flag;
8190 ;; car ^ ^ point
8191 ;; void cplusplus_function (int x) throw (Bad);
8192 ;; car ^ ^ point
8193 ;; Foo::Foo (int b) : Base (b) {}
8194 ;; car ^ ^ point
8195 ;;
8196 ;; auto foo = 5;
8197 ;; car ^ ^ point
8198 ;; auto cplusplus_11 (int a, char *b) -> decltype (bar):
8199 ;; car ^ ^ point
8200 ;;
8201 ;;
8202 ;;
8203 ;; The second element of the return value is non-nil when a
8204 ;; `c-typedef-decl-kwds' specifier is found in the declaration.
8205 ;; Specifically it is a dotted pair (A . B) where B is t when a
8206 ;; `c-typedef-kwds' ("typedef") is present, and A is t when some
8207 ;; other `c-typedef-decl-kwds' (e.g. class, struct, enum)
8208 ;; specifier is present. I.e., (some of) the declared
8209 ;; identifier(s) are types.
8210 ;;
8211 ;; The third element of the return value is non-nil when the declaration
8212 ;; parsed might be an expression. The fourth element is the position of
8213 ;; the start of the type identifier. The fifth element is t if either
8214 ;; CONTEXT was 'top, or the declaration is detected to be treated as top
8215 ;; level (e.g. with the keyword "extern").
8216 ;;
8217 ;; If a cast is parsed:
8218 ;;
8219 ;; The point is left at the first token after the closing paren of
8220 ;; the cast. The return value is `cast'. Note that the start
8221 ;; position must be at the first token inside the cast parenthesis
8222 ;; to recognize it.
8223 ;;
8224 ;; PRECEDING-TOKEN-END is the first position after the preceding
8225 ;; token, i.e. on the other side of the syntactic ws from the point.
8226 ;; Use a value less than or equal to (point-min) if the point is at
8227 ;; the first token in (the visible part of) the buffer.
8228 ;;
8229 ;; CONTEXT is a symbol that describes the context at the point:
8230 ;; 'decl In a comma-separated declaration context (typically
8231 ;; inside a function declaration arglist).
8232 ;; '<> In an angle bracket arglist.
8233 ;; 'arglist Some other type of arglist.
8234 ;; 'top Some other context and point is at the top-level (either
8235 ;; outside any braces or directly inside a class or namespace,
8236 ;; etc.)
8237 ;; nil Some other context or unknown context. Includes
8238 ;; within the parens of an if, for, ... construct.
8239 ;; 'not-decl This value is never supplied to this function. It
8240 ;; would mean we're definitely not in a declaration.
8241 ;;
8242 ;; LAST-CAST-END is the first token after the closing paren of a
8243 ;; preceding cast, or nil if none is known. If
8244 ;; `c-forward-decl-or-cast-1' is used in succession, it should be
8245 ;; the position after the closest preceding call where a cast was
8246 ;; matched. In that case it's used to discover chains of casts like
8247 ;; "(a) (b) c".
8248 ;;
8249 ;; This function records identifier ranges on
8250 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
8251 ;; `c-record-type-identifiers' is non-nil.
8252 ;;
8253 ;; This function might do hidden buffer changes.
8256 ;; first type, i.e. after any leading specifiers. It might
8257 ;; also point at the beginning of the preceding syntactic
8258 ;; whitespace.
8260 ;; Set to the result of `c-forward-type'.
8261 at-type
8262 ;; The position of the first token in what we currently
8263 ;; believe is the type in the declaration or cast, after any
8264 ;; specifiers and their associated clauses.
8265 type-start
8266 ;; The position of the first token in what we currently
8267 ;; believe is the declarator for the first identifier. Set
8268 ;; when the type is found, and moved forward over any
8269 ;; `c-decl-hangon-kwds' and their associated clauses that
8270 ;; occurs after the type.
8271 id-start
8272 ;; These store `at-type', `type-start' and `id-start' of the
8273 ;; identifier before the one in those variables. The previous
8274 ;; identifier might turn out to be the real type in a
8275 ;; declaration if the last one has to be the declarator in it.
8276 ;; If `backup-at-type' is nil then the other variables have
8277 ;; undefined values.
8278 backup-at-type backup-type-start backup-id-start
8279 ;; Set if we've found a specifier (apart from "typedef") that makes
8280 ;; the defined identifier(s) types.
8281 at-type-decl
8282 ;; Set if we've a "typedef" keyword.
8283 at-typedef
8284 ;; Set if we've found a specifier that can start a declaration
8285 ;; where there's no type.
8286 maybe-typeless
8287 ;; Save the value of kwd-sym between loops of the "Check for a
8288 ;; type" loop. Needed to distinguish a C++11 "auto" from a pre
8289 ;; C++11 one.
8290 prev-kwd-sym
8291 ;; If a specifier is found that also can be a type prefix,
8292 ;; these flags are set instead of those above. If we need to
8293 ;; back up an identifier, they are copied to the real flag
8294 ;; variables. Thus they only take effect if we fail to
8295 ;; interpret it as a type.
8296 backup-at-type-decl backup-maybe-typeless
8297 ;; Whether we've found a declaration or a cast. We might know
8298 ;; this before we've found the type in it. It's 'ids if we've
8299 ;; found two consecutive identifiers (usually a sure sign, but
8300 ;; we should allow that in labels too), and t if we've found a
8301 ;; specifier keyword (a 100% sure sign).
8302 at-decl-or-cast
8303 ;; Set when we need to back up to parse this as a declaration
8304 ;; but not as a cast.
8305 backup-if-not-cast
8306 ;; For casts, the return position.
8307 cast-end
8308 ;; Have we got a new-style C++11 "auto"?
8309 new-style-auto
8310 ;; Set when the symbol before `preceding-token-end' is known to
8311 ;; terminate the previous construct, or when we're at point-min.
8312 at-decl-start
8313 ;; Set when we have encountered a keyword (e.g. "extern") which
8314 ;; causes the following declaration to be treated as though top-level.
8315 make-top
8316 ;; Save `c-record-type-identifiers' and
8317 ;; `c-record-ref-identifiers' since ranges are recorded
8318 ;; speculatively and should be thrown away if it turns out
8319 ;; that it isn't a declaration or cast.
8322 ;; Set when we parse a declaration which might also be an expression,
8323 ;; such as "a *b". See CASE 16 and CASE 17.
8324 maybe-expression)
8333 c-pre-start-tokens)))))
8338 ;; Check for a type. Unknown symbols are treated as possible
8339 ;; types, but they could also be specifiers disguised through
8340 ;; macros like __INLINE__, so we recognize both types and known
8341 ;; specifiers after them too.
8346 ;; Look for a specifier keyword clause.
8366 ;; Found a known or possible type or a prefix of a known type.
8375 ;; Got two identifiers with nothing but whitespace
8376 ;; between them. That can only happen in declarations.
8380 ;; If the previous identifier is a found type we
8381 ;; record it as a real one; it might be some sort of
8382 ;; alias for a prefix like "unsigned".
8389 backup-type-start type-start
8390 backup-id-start id-start
8391 at-type found-type
8392 type-start start
8394 ;; The previous ambiguous specifier/type turned out
8395 ;; to be a type since we've parsed another one after
8396 ;; it, so clear these backup flags.
8397 backup-at-type-decl nil
8398 backup-maybe-typeless nil))
8402 ;; Handle known specifier keywords and
8403 ;; `c-decl-hangon-kwds' which can occur after known
8404 ;; types.
8407 noise-start)
8408 ;; It's a hang-on keyword or noise clause that can occur
8409 ;; anywhere.
8412 ;; Move the identifier start position if
8413 ;; we've passed a type.
8415 ;; Otherwise treat this as a specifier and
8416 ;; move the fallback position.
8420 ;; It's an ordinary specifier so we know that
8421 ;; anything before this can't be the type.
8423 start-pos kwd-clause-end)
8426 ;; It's ambiguous whether this keyword is a
8427 ;; specifier or a type prefix, so set the backup
8428 ;; flags. (It's assumed that `c-forward-type'
8429 ;; moved further than `c-forward-keyword-clause'.)
8437 ;; This test only happens after we've scanned a type.
8438 ;; So, with valid syntax, kwd-sym can't be 'typedef.
8443 ;; Haven't matched a type so it's an unambiguous
8444 ;; specifier keyword and we know we're in a
8445 ;; declaration.
8451 ;; If the type isn't known we continue so that we'll jump
8452 ;; over all specifiers and type identifiers. The reason
8453 ;; to do this for a known type prefix is to make things
8454 ;; like "unsigned INT16" work.
8459 ;; If a known type was found, we still need to skip over any
8460 ;; hangon keyword clauses after it. Otherwise it has already
8461 ;; been done in the loop above.
8471 ;; A prefix type is itself a primitive type when it's not
8472 ;; followed by another type.
8476 ;; Got no type but set things up to continue anyway to handle
8477 ;; the various cases when a declaration doesn't start with a
8478 ;; type.
8483 ;; If it's C++ then check if the last "type" ends on the form
8484 ;; "foo::foo" or "foo::~foo", i.e. if it's the name of a
8485 ;; (con|de)structor.
8496 ;; Cheating in the handling of syntactic ws below.
8503 name)
8508 ;; It is a (con|de)structor name. In that case the
8509 ;; declaration is typeless so zap out any preceding
8510 ;; identifier(s) that we might have taken as types.
8513 backup-at-type nil
8514 id-start type-start))))))
8516 ;; Check for and step over a type decl expression after the thing
8517 ;; that is or might be a type. This can't be skipped since we
8518 ;; need the correct end position of the declarator for
8519 ;; `max-type-decl-end-*'.
8521 ;; True if there's a non-open-paren match of
8522 ;; `c-type-decl-prefix-key'.
8523 got-prefix
8524 ;; True if the declarator is surrounded by a parenthesis pair.
8525 got-parens
8526 ;; True if there is an identifier in the declarator.
8527 got-identifier
8528 ;; True if there's a non-close-paren match of
8529 ;; `c-type-decl-suffix-key'.
8530 got-suffix
8531 ;; True if there's a prefix match outside the outermost
8532 ;; paren pair that surrounds the declarator.
8533 got-prefix-before-parens
8534 ;; True if there's a suffix match outside the outermost
8535 ;; paren pair that surrounds the declarator. The value is
8536 ;; the position of the first suffix match.
8537 got-suffix-after-parens
8538 ;; True if we've parsed the type decl to a token that is
8539 ;; known to end declarations in this context.
8540 at-decl-end
8541 ;; The earlier values of `at-type' and `type-start' if we've
8542 ;; shifted the type backwards.
8543 identifier-type identifier-start
8544 ;; If `c-parse-and-markup-<>-arglists' is set we need to
8545 ;; turn it off during the name skipping below to avoid
8546 ;; getting `c-type' properties that might be bogus. That
8547 ;; can happen since we don't know if
8548 ;; `c-restricted-<>-arglists' will be correct inside the
8549 ;; arglist paren that gets entered.
8550 c-parse-and-markup-<>-arglists
8551 ;; Start of the identifier for which `got-identifier' was set.
8552 name-start
8553 ;; Position after (innermost) open parenthesis encountered in the
8554 ;; prefix operators.
8555 after-paren-pos)
8559 ;; Skip over type decl prefix operators. (Note similar code in
8560 ;; `c-forward-declarator'.)
8571 ;; If the third submatch matches in C++ then
8572 ;; we're looking at an identifier that's a
8573 ;; prefix only if it specifies a member pointer.
8578 ;; We only check for a trailing "::" and
8579 ;; let the "*" that should follow be
8580 ;; matched in the next round.
8582 ;; It turned out to be the real identifier,
8583 ;; so stop.
8584 nil))
8585 t))
8600 ;; Try to skip over an identifier.
8607 ;; Skip over type decl suffix operators and trailing noise macros.
8615 ;; We avoid recognizing foo(bar) or foo() at top level as a
8616 ;; construct here in C, since we want to recognize this as a
8617 ;; typeless function declaration.
8625 t)
8629 t)
8636 ;; No suffix matched. We might have matched the
8637 ;; identifier as a type and the open paren of a
8638 ;; function arglist as a type decl prefix. In that
8639 ;; case we should "backtrack": Reinterpret the last
8640 ;; type as the identifier, move out of the arglist and
8641 ;; continue searching for suffix operators.
8642 ;;
8643 ;; Do this even if there's no preceding type, to cope
8644 ;; with old style function declarations in K&R C,
8645 ;; (con|de)structors in C++ and `c-typeless-decl-kwds'
8646 ;; style declarations. That isn't applicable in an
8647 ;; arglist context, though.
8652 maybe-typeless
8653 backup-maybe-typeless
8656 ;; Deal with C++11's "copy-initialization"
8657 ;; where we have <type>(<constant>), by
8658 ;; contrasting with a typeless
8659 ;; <name>(<type><parameter>, ...).
8664 ;; Recognize a top-level typeless
8665 ;; function declaration in C.
8673 t)))
8682 at-type))
8683 ;; Have found no identifier but `c-typeless-decl-kwds' has
8684 ;; matched so we know we're inside a declaration. The
8685 ;; preceding type must be the identifier instead.
8688 ;; Prepare the "-> type;" for fontification later on.
8697 ;; Move forward over any "WS" ids (like "final" or "override" in C++)
8703 at-decl-or-cast
8706 ;; CASE 1
8708 ;; Encountered something inside parens that isn't matched by
8709 ;; the `c-type-decl-*' regexps, so it's not a type decl
8710 ;; expression. Try to skip out to the same paren depth to
8711 ;; not confuse the cast check below. If we don't manage this and
8712 ;; `at-decl-or-cast' is 'ids we might have an expression like
8713 ;; "foo bar ({ ..." which is a valid C++11 initialization.
8717 ;; If we've found a specifier keyword then it's a
8718 ;; declaration regardless.
8726 ;; Now we've collected info about various characteristics of
8727 ;; the construct we're looking at. Below follows a decision
8728 ;; tree based on that. It's ordered to check more certain
8729 ;; signs before less certain ones.
8734 ;; CASE 2
8737 ;; Got another identifier directly after the type, so it's a
8738 ;; declaration.
8743 ;; (not got-suffix-after-parens)
8745 maybe-typeless
8746 backup-maybe-typeless
8748 ;; Check whether we have "bar (gnu);" where we
8749 ;; are directly inside a class (etc.) called "bar".
8759 type-start
8765 ;; Got a declaration of the form "foo bar (gnu);" or "bar
8766 ;; (gnu);" where we've recognized "bar" as the type and "gnu"
8767 ;; as the declarator, and in the latter case, checked that
8768 ;; "bar (gnu)" appears directly inside the class "bar". In
8769 ;; this case it's however more likely that "bar" is the
8770 ;; declarator and "gnu" a function argument or initializer
8771 ;; (if `c-recognize-paren-inits' is set), since the parens
8772 ;; around "gnu" would be superfluous if it's a declarator.
8773 ;; Shift the type one step backward.
8776 ;; Found no identifier.
8781 ;; CASE 3
8783 ;; Got a plain list of identifiers. If a colon follows it's
8784 ;; a valid label, or maybe a bitfield. Otherwise the last
8785 ;; one probably is the declared identifier and we should
8786 ;; back up to the previous type, providing it isn't a cast.
8790 ;; If we've found a specifier keyword then it's a
8791 ;; declaration regardless.
8802 ;; CASE 4
8806 ;; Got a plain list of identifiers followed by some suffix.
8807 ;; If this isn't a cast then the last identifier probably is
8808 ;; the declared one and we should back up to the previous
8809 ;; type.
8813 ;; CASE 5
8815 ;; If the type is known we know that there can't be any
8816 ;; identifier somewhere else, and it's only in declarations in
8817 ;; e.g. function prototypes and in casts that the identifier may
8818 ;; be left out.
8822 ;; Only got a single identifier (parsed as a type so far).
8823 ;; CASE 6
8825 ;; Check that the identifier isn't at the start of an
8826 ;; expression.
8827 at-decl-end
8830 ;; Inside an arglist that contains declarations. If K&R
8831 ;; style declarations and parenthesis style initializers
8832 ;; aren't allowed then the single identifier must be a
8833 ;; type, else we require that it's known or found
8834 ;; (primitive types are handled above).
8839 ;; Inside a template arglist. Accept known and found
8840 ;; types; other identifiers could just as well be
8841 ;; constants in C++.
8844 ;; CASE 7
8845 ;; Can't be a valid declaration or cast, but if we've found a
8846 ;; specifier it can't be anything else either, so treat it as
8847 ;; an invalid/unfinished declaration or cast.
8855 maybe-typeless
8856 backup-maybe-typeless
8860 c-after-suffixed-type-maybe-decl-key))))))
8861 ;; Got an empty paren pair and a preceding type that probably
8862 ;; really is the identifier. Shift the type backwards to make
8863 ;; the last one the identifier. This is analogous to the
8864 ;; "backtracking" done inside the `c-type-decl-suffix-key' loop
8865 ;; above.
8866 ;;
8867 ;; Exception: In addition to the conditions in that
8868 ;; "backtracking" code, do not shift backward if we're not
8869 ;; looking at either `c-after-suffixed-type-decl-key' or "[;,]".
8870 ;; Since there's no preceding type, the shift would mean that
8871 ;; the declaration is typeless. But if the regexp doesn't match
8872 ;; then we will simply fall through in the tests below and not
8873 ;; recognize it at all, so it's better to try it as an abstract
8874 ;; declarator instead.
8877 ;; Still no identifier.
8878 ;; CASE 8
8880 ;; Require `got-prefix' together with either `got-parens' or
8881 ;; `got-suffix' to recognize it as an abstract declarator:
8882 ;; `got-parens' only is probably an empty function call.
8883 ;; `got-suffix' only can build an ordinary expression together
8884 ;; with the preceding identifier which we've taken as a type.
8885 ;; We could actually accept on `got-prefix' only, but that can
8886 ;; easily occur temporarily while writing an expression so we
8887 ;; avoid that case anyway. We could do a better job if we knew
8888 ;; the point when the fontification was invoked.
8891 ;; CASE 9
8895 got-suffix-after-parens
8897 ;; Got a type, no declarator but a paren suffix. I.e. it's a
8898 ;; normal function call after all (or perhaps a C++ style object
8899 ;; instantiation expression).
8902 ;; CASE 9.5
8906 after-paren-pos)
8907 ;; We've got something like "foo bar (...)" in C++ which isn't at
8908 ;; the top level. This is probably a uniform initialization of bar
8909 ;; to the contents of the parens. In this case the declarator ends
8910 ;; at the open paren.
8914 ;; CASE 10
8916 ;; By now we've located the type in the declaration that we know
8917 ;; we're in.
8920 ;; CASE 11
8924 make-top
8931 ;; Shift the type backward in the case that there's a
8932 ;; single identifier inside parens. That can only
8933 ;; occur in K&R style function declarations so it's
8934 ;; more likely that it really is a function call.
8935 ;; Therefore we only do this after
8936 ;; `c-after-suffixed-type-decl-key' has matched.
8938 got-suffix-after-parens))
8939 ;; A declaration according to `c-after-suffixed-type-decl-key'.
8942 ;; CASE 12
8945 ;; It's a declaration if a known type precedes it and it can't be a
8946 ;; function call.
8949 ;; If we get here we can't tell if this is a type decl or a normal
8950 ;; expression by looking at it alone. (That's under the assumption
8951 ;; that normal expressions always can look like type decl expressions,
8952 ;; which isn't really true but the cases where it doesn't hold are so
8953 ;; uncommon (e.g. some placements of "const" in C++) it's not worth
8954 ;; the effort to look for them.)
8956 ;;; 2008-04-16: commented out the next form, to allow the function to recognize
8957 ;;; "foo (int bar)" in CC (an implicit type (in class foo) without a semicolon)
8958 ;;; as a(n almost complete) declaration, enabling it to be fontified.
8959 ;; CASE 13
8960 ;; (unless (or at-decl-end (looking-at "=[^=]"))
8961 ;; If this is a declaration it should end here or its initializer(*)
8962 ;; should start here, so check for allowed separation tokens. Note
8963 ;; that this rule doesn't work e.g. with a K&R arglist after a
8964 ;; function header.
8965 ;;
8966 ;; *) Don't check for C++ style initializers using parens
8967 ;; since those already have been matched as suffixes.
8968 ;;
8969 ;; If `at-decl-or-cast' is then we've found some other sign that
8970 ;; it's a declaration or cast, so then it's probably an
8971 ;; invalid/unfinished one.
8972 ;; (throw 'at-decl-or-cast at-decl-or-cast))
8974 ;; Below are tests that only should be applied when we're certain to
8975 ;; not have parsed halfway through an expression.
8977 ;; CASE 14
8979 ;; The expression starts with a known type so treat it as a
8980 ;; declaration.
8983 ;; CASE 15
8985 ;; In C++ we check if the identifier is a known type, since
8986 ;; (con|de)structors use the class name as identifier.
8987 ;; We've always shifted over the identifier as a type and
8988 ;; then backed up again in this case.
8989 identifier-type
8992 ;; `at-type' probably won't be 'found for
8993 ;; destructors since the "~" is then part of the
8994 ;; type name being checked against the list of
8995 ;; known types, so do a check without that
8996 ;; operator.
9001 c-identifier-syntax-table
9005 ;; We have already parsed the type earlier,
9006 ;; so it'd be possible to cache the end
9007 ;; position instead of redoing it here, but
9008 ;; then we'd need to keep track of another
9009 ;; position everywhere.
9017 ;; CASE 16
9019 at-type
9023 at-decl-start))
9024 ;; Got something like "foo * bar;". Since we're not inside
9025 ;; an arglist it would be a meaningless expression because
9026 ;; the result isn't used. We therefore choose to recognize
9027 ;; it as a declaration. We only allow a suffix (which makes
9028 ;; the construct look like a function call) when
9029 ;; `at-decl-start' provides additional evidence that we do
9030 ;; have a declaration.
9034 ;; CASE 17
9039 ;; Got something like "a (*b) (c);" or "a (b) = c;". It could
9040 ;; be an odd expression or it could be a declaration. Treat
9041 ;; it as a declaration if "a" has been used as a type
9042 ;; somewhere else (if it's a known type we won't get here).
9046 ;; CASE 17.5
9048 got-prefix-before-parens
9049 at-type
9051 at-decl-start))
9068 ;; CASE 18
9074 ;; Got a type followed by an abstract declarator. If `got-prefix'
9075 ;; is set it's something like "a *" without anything after it. If
9076 ;; `got-parens' or `got-suffix' is set it's "a()", "a[]", "a()[]",
9077 ;; or similar, which we accept only if the context rules out
9078 ;; expressions.
9081 ;; If we had a complete symbol table here (which rules out
9082 ;; `c-found-types') we should return t due to the disambiguation rule
9083 ;; (in at least C++) that anything that can be parsed as a declaration
9084 ;; is a declaration. Now we're being more defensive and prefer to
9085 ;; highlight things like "foo (bar);" as a declaration only if we're
9086 ;; inside an arglist that contains declarations. Update (2017-09): We
9087 ;; now recognize a top-level "foo(bar);" as a declaration in C.
9088 ;; CASE 19
9093 ;; The point is now after the type decl expression.
9096 ;; Check for a cast.
9099 c-cast-parens
9101 ;; Should be the first type/identifier in a cast paren.
9105 ;; The closing paren should follow.
9110 ;; There should be a primary expression after it.
9119 ;; Check if the expression begins with a prefix keyword.
9122 ;; Expression begins with an ambiguous operator. Treat
9123 ;; it as a cast if it's a type decl or if we've
9124 ;; recognized the type somewhere else.
9127 ;; Unless it's a keyword, it's the beginning of a primary
9128 ;; expression.
9130 ;; If `c-primary-expr-regexp' matched a nonsymbol token, check
9131 ;; that it matched a whole one so that we don't e.g. confuse
9132 ;; the operator '-' with '->'. It's ok if it matches further,
9133 ;; though, since it e.g. can match the float '.5' while the
9134 ;; operator regexp only matches '.'.
9138 ;; There should either be a cast before it or something that isn't an
9139 ;; identifier or close paren.
9147 ;; It's a symbol. Accept it only if it's one of the
9148 ;; keywords that can precede an expression (without
9149 ;; surrounding parens).
9152 ;; Check that it isn't a close paren (block close is ok,
9153 ;; though).
9155 ;; Check that it isn't a nonsymbol identifier.
9158 ;; Handle the cast.
9168 ;; We're at a declaration. Highlight the type and the following
9169 ;; declarators.
9175 ;; Make sure to propagate the `c-decl-arg-start' property to
9176 ;; the next argument if it's set in this one, to cope with
9177 ;; interactive refontification.
9180 ;; Record the type's coordinates in `c-record-type-identifiers' for
9181 ;; later fontification.
9183 ;; There seems no reason to exclude a token from
9184 ;; fontification just because it's "a known type that can't
9185 ;; be a name or other expression". 2013-09-18.
9186 )
9195 maybe-expression
9196 type-start
9200 ;; False alarm. Restore the recorded ranges.
9202 c-record-ref-identifiers save-rec-ref-ids)
9203 nil))))
9206 ;; Assuming that point is at the beginning of a token, check if it starts a
9207 ;; label and if so move over it and return non-nil (t in default situations,
9208 ;; specific symbols (see below) for interesting situations), otherwise don't
9209 ;; move and return nil. "Label" here means "most things with a colon".
9210 ;;
9211 ;; More precisely, a "label" is regarded as one of:
9212 ;; (i) a goto target like "foo:" - returns the symbol `goto-target';
9213 ;; (ii) A case label - either the entire construct "case FOO:", or just the
9214 ;; bare "case", should the colon be missing. We return t;
9215 ;; (iii) a keyword which needs a colon, like "default:" or "private:"; We
9216 ;; return t;
9217 ;; (iv) One of QT's "extended" C++ variants of
9218 ;; "private:"/"protected:"/"public:"/"more:" looking like "public slots:".
9219 ;; Returns the symbol `qt-2kwds-colon'.
9220 ;; (v) QT's construct "signals:". Returns the symbol `qt-1kwd-colon'.
9221 ;; (vi) One of the keywords matched by `c-opt-extra-label-key' (without any
9222 ;; colon). Currently (2006-03), this applies only to Objective C's
9223 ;; keywords "@private", "@protected", and "@public". Returns t.
9224 ;;
9225 ;; One of the things which will NOT be recognized as a label is a bit-field
9226 ;; element of a struct, something like "int foo:5".
9227 ;;
9228 ;; The end of the label is taken to be just after the colon, or the end of
9229 ;; the first submatch in `c-opt-extra-label-key'. The point is directly
9230 ;; after the end on return. The terminating char gets marked with
9231 ;; `c-decl-end' to improve recognition of the following declaration or
9232 ;; statement.
9233 ;;
9234 ;; If ASSUME-MARKUP is non-nil, it's assumed that the preceding
9235 ;; label, if any, has already been marked up like that.
9236 ;;
9237 ;; If PRECEDING-TOKEN-END is given, it should be the first position
9238 ;; after the preceding token, i.e. on the other side of the
9239 ;; syntactic ws from the point. Use a value less than or equal to
9240 ;; (point-min) if the point is at the first token in (the visible
9241 ;; part of) the buffer.
9242 ;;
9243 ;; The optional LIMIT limits the forward scan for the colon.
9244 ;;
9245 ;; This function records the ranges of the label symbols on
9246 ;; `c-record-ref-identifiers' if `c-record-type-identifiers' (!) is
9247 ;; non-nil.
9248 ;;
9249 ;; This function might do hidden buffer changes.
9252 label-end
9253 qt-symbol-idx
9254 macro-start ; if we're in one.
9255 label-type
9256 kwd)
9258 ;; "case" or "default" (Doesn't apply to AWK).
9261 ;; Record only the keyword itself for fontification, since in
9262 ;; case labels the following is a constant expression and not
9263 ;; a label.
9267 ;; Find the label end.
9271 ;; Stop on chars that aren't allowed in expressions,
9272 ;; and on operator chars that would be meaningless
9273 ;; there. FIXME: This doesn't cope with ?: operators.
9281 t)
9283 ;; It's an unfinished label. We consider the keyword enough
9284 ;; to recognize it as a label, so that it gets fontified.
9285 ;; Leave the point at the end of it, but don't put any
9286 ;; `c-decl-end' marker.
9288 t))))
9290 ;; @private, @protected, @public, in Objective C, or similar.
9293 ;; For a `c-opt-extra-label-key' match, we record the whole
9294 ;; thing for fontification. That's to get the leading '@' in
9295 ;; Objective-C protection labels fontified.
9302 ;; All other cases of labels.
9305 ;; A colon label must have something before the colon.
9308 ;; Check that we're not after a token that can't precede a label.
9310 ;; Trivially succeeds when there's no preceding token.
9311 ;; Succeeds when we're at a virtual semicolon.
9320 ;; Check if we're after a label, if we're after a closing
9321 ;; paren that belong to statement, and with
9322 ;; `c-label-prefix-re'. It's done in different order
9323 ;; depending on `assume-markup' since the checks have
9324 ;; different expensiveness.
9351 ;; Might be after another label, so check it recursively.
9355 ;; Essentially the same as the
9356 ;; `c-syntactic-re-search-forward' regexp below.
9362 ;; Note: the following should work instead of the
9363 ;; narrow-to-region above. Investigate why not,
9364 ;; sometime. ACM, 2006-03-31.
9365 ;; (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+"
9366 ;; macro-start t)
9368 ;; If the caller turned on recording for us,
9369 ;; it shouldn't apply when we check the
9370 ;; preceding label.
9371 c-record-type-identifiers)
9372 ;; A label can't start at a cpp directive. Check for
9373 ;; this, since c-forward-syntactic-ws would foul up on it.
9378 ;; Point is still at the beginning of the possible label construct.
9379 ;;
9380 ;; Check that the next nonsymbol token is ":", or that we're in one
9381 ;; of QT's "slots" declarations. Allow '(' for the sake of macro
9382 ;; arguments. FIXME: Should build this regexp from the language
9383 ;; constants.
9385 ;; public: protected: private:
9395 ;; QT double keyword like "protected slots:" or goto target.
9414 'qt-1kwd-colon
9426 ;; Check that `c-nonlabel-token-key' doesn't match anywhere.
9436 t)
9439 ;; Record the identifiers in the label for fontification, unless
9440 ;; it begins with `c-label-kwds' in which case the following
9441 ;; identifiers are part of a (constant) expression that
9442 ;; shouldn't be fontified.
9454 ;; Not a label.
9456 label-type))
9459 ;; Assuming the point is at the beginning of a token, try to move
9460 ;; forward to the end of the Objective-C directive that starts
9461 ;; there. Return t if a directive was fully recognized, otherwise
9462 ;; the point is moved as far as one could be successfully parsed and
9463 ;; nil is returned.
9464 ;;
9465 ;; This function records identifier ranges on
9466 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
9467 ;; `c-record-type-identifiers' is non-nil.
9468 ;;
9469 ;; This function might do hidden buffer changes.
9472 start-char
9474 lim
9475 ;; Turn off recognition of angle bracket arglists while parsing
9476 ;; types here since the protocol reference list might then be
9477 ;; considered part of the preceding name or superclass-name.
9488 t)
9497 ;; Handle the name of the class itself.
9499 ;; (c-forward-token-2) ; 2006/1/13 This doesn't move if the token's
9500 ;; at EOB.
9507 ;; Look for ": superclass-name" or "( category-name )".
9518 ;; Look for a protocol reference list.
9524 t))))
9530 t)
9533 nil)))
9536 ;; Go to the first non-whitespace after the colon that starts a
9537 ;; multiple inheritance introduction. Optional LIM is the farthest
9538 ;; back we should search.
9539 ;;
9540 ;; This function might do hidden buffer changes.
9548 ;; Return nil if we aren't in a method definition, otherwise the
9549 ;; position of the initial [+-].
9550 ;;
9551 ;; This function might do hidden buffer changes.
9557 ))
9559 ;; Contributed by Kevin Ryde <user42@zip.com.au>.
9561 ;; Return non-nil if point is within a gcc \"asm\" block.
9562 ;;
9563 ;; This should be called with point inside an argument list.
9564 ;;
9565 ;; Only one level of enclosing parentheses is considered, so for
9566 ;; instance nil is returned when in a function call within an asm
9567 ;; operand.
9568 ;;
9569 ;; This function might do hidden buffer changes.
9581 a function.
9583 More precisely, being at the top-level means that point is either
9584 outside any enclosing block (such as a function definition), or
9585 directly inside a class, namespace or other block that contains
9586 another declaration level.
9588 If point is not at the top-level (e.g. it is inside a method
9589 definition), then nil is returned. Otherwise, if point is at a
9590 top-level not enclosed within a class definition, t is returned.
9591 Otherwise, a 2-vector is returned where the zeroth element is the
9592 buffer position of the start of the class declaration, and the first
9593 element is the buffer position of the enclosing class's opening
9594 brace.
9596 Note that this function might do hidden buffer changes. See the
9597 comment at the start of cc-engine.el for more info."
9598 ;; Note to maintainers: this function consumes a great mass of CPU cycles.
9599 ;; Its use should thus be minimized as far as possible.
9600 ;; Consider instead using `c-bs-at-toplevel-p'.
9606 ;; Return non-nil if the point is in the region after the argument
9607 ;; list of a function and its opening brace (or semicolon in case it
9608 ;; got no body). If there are K&R style argument declarations in
9609 ;; that region, the point has to be inside the first one for this
9610 ;; function to recognize it.
9611 ;;
9612 ;; If successful, the point is moved to the first token after the
9613 ;; function header (see `c-forward-decl-or-cast-1' for details) and
9614 ;; the position of the opening paren of the function arglist is
9615 ;; returned.
9616 ;;
9617 ;; The point is clobbered if not successful.
9618 ;;
9619 ;; LIM is used as bound for backward buffer searches.
9620 ;;
9621 ;; This function might do hidden buffer changes.
9630 ;; Don't confuse #if .... defined(foo) for a function arglist.
9641 ;; There should not be a '=' or ',' between beg and the
9642 ;; start of the declaration since that means we were in the
9643 ;; "expression part" of the declaration.
9648 ;; Check that there's an arglist paren in the
9649 ;; declaration.
9652 ;; The declarator is a paren expression, so skip past it
9653 ;; so that we don't get stuck on that instead of the
9654 ;; function arglist.
9658 ;; Don't trip up on "operator ()".
9665 ;; Return the position of the first argument declaration if point is
9666 ;; inside a K&R style argument declaration list, nil otherwise.
9667 ;; `c-recognize-knr-p' is not checked. If LIM is non-nil, it's a
9668 ;; position that bounds the backward search for the argument list. This
9669 ;; function doesn't move point.
9670 ;;
9671 ;; Point must be within a possible K&R region, e.g. just before a top-level
9672 ;; "{". It must be outside of parens and brackets. The test can return
9673 ;; false positives otherwise.
9674 ;;
9675 ;; This function might do hidden buffer changes.
9678 ;; If we're in a macro, our search range is restricted to it. Narrow to
9679 ;; the searchable range.
9683 before-lparen after-rparen
9686 ; we give up.
9687 ids ; List of identifiers in the parenthesized list.
9688 id-start after-prec-token decl-or-cast decl-res
9689 c-last-identifier-range identifier-ok)
9692 ;; Search backwards for the defun's argument list. We give up if we
9693 ;; encounter a "}" (end of a previous defun) an "=" (which can't be in
9694 ;; a knr region) or BOB.
9695 ;;
9696 ;; The criterion for a paren structure being the arg list is:
9697 ;; o - there is non-WS stuff after it but before any "{"; AND
9698 ;; o - the token after it isn't a ";" AND
9699 ;; o - it is preceded by either an identifier (the function name) or
9700 ;; a macro expansion like "DEFUN (...)"; AND
9701 ;; o - its content is a non-empty comma-separated list of identifiers
9702 ;; (an empty arg list won't have a knr region).
9703 ;;
9704 ;; The following snippet illustrates these rules:
9705 ;; int foo (bar, baz, yuk)
9706 ;; int bar [] ;
9707 ;; int (*baz) (my_type) ;
9708 ;; int (*(* yuk) (void)) (void) ;
9709 ;; {
9710 ;;
9711 ;; Additionally, for a knr list to be recognized:
9712 ;; o - The identifier of each declarator up to and including the
9713 ;; one "near" point must be contained in the arg list.
9724 ; parens/brackets.
9728 ;; We're inside a paren. Could it be our argument list....?
9734 ;; FIXME!!! What about macros between the parens? 2007/01/20
9737 ;; It can't be the arg list if next token is ; or {
9742 ;; Is the thing preceding the list an identifier (the
9743 ;; function name), or a macro expansion?
9753 ;; Have we got a non-empty list of comma-separated
9754 ;; identifiers?
9767 ids)
9775 ;; Are all the identifiers in the k&r list up to the
9776 ;; current one also in the argument list?
9784 after-prec-token
9785 nil ; Or 'arglist ???
9786 nil)))
9791 nil))
9799 ids))
9805 identifier-ok))
9806 ;; ...Yes. We've identified the function's argument list.
9811 ;; ...No. The current parens aren't the function's arg list.
9818 ;; skip forward over conditional at point, including any predicate
9819 ;; statements in parentheses. No error checking is performed.
9820 ;;
9821 ;; This function might do hidden buffer changes.
9823 ;; else if()
9828 ;; do, else, try, finally
9833 ;; for, if, while, switch, catch, synchronized, foreach
9837 ;; If looking at the token after a conditional then return the
9838 ;; position of its start, otherwise return nil.
9839 ;;
9840 ;; This function might do hidden buffer changes.
9851 ;; If the point is after an operator identifier that isn't handled
9852 ;; like an ordinary symbol (i.e. like "operator =" in C++) then the
9853 ;; position of the start of that identifier is returned. nil is
9854 ;; returned otherwise. The point may be anywhere in the syntactic
9855 ;; whitespace after the last token of the operator identifier.
9856 ;;
9857 ;; This function might do hidden buffer changes.
9869 ;; Assuming point is at a brace that opens a statement block of some
9870 ;; kind, move to the proper anchor point for that block. It might
9871 ;; need to be adjusted further by c-add-stmt-syntax, but the
9872 ;; position at return is suitable as start position for that
9873 ;; function.
9874 ;;
9875 ;; This function might do hidden buffer changes.
9882 ;; Assuming point is at a brace that opens the block of a top level
9883 ;; declaration of some kind, move to the proper anchor point for
9884 ;; that block.
9885 ;;
9886 ;; This function might do hidden buffer changes.
9891 ;; Search forward for the end of the "header" of the current
9892 ;; declaration. That's the position where the definition body
9893 ;; starts, or the first variable initializer, or the ending
9894 ;; semicolon. I.e. search forward for the closest following
9895 ;; (syntactically relevant) '{', '=' or ';' token. Point is left
9896 ;; _after_ the first found token, or at point-max if none is found.
9897 ;;
9898 ;; This function might do hidden buffer changes.
9903 ;; In C++ we need to take special care to handle operator
9904 ;; tokens and those pesky template brackets.
9909 ;; Handle operator identifiers, i.e. ignore any
9910 ;; operator token preceded by "operator".
9917 t
9919 nil)))))
9928 ;; Go to the beginning of the current declaration, or the beginning
9929 ;; of the previous one if already at the start of it. Point won't
9930 ;; be moved out of any surrounding paren. Return a cons cell of the
9931 ;; form (MOVE . KNR-POS). MOVE is like the return value from
9932 ;; `c-beginning-of-statement-1'. If point skipped over some K&R
9933 ;; style argument declarations (and they are to be recognized) then
9934 ;; KNR-POS is set to the start of the first such argument
9935 ;; declaration, otherwise KNR-POS is nil. If LIM is non-nil, it's a
9936 ;; position that bounds the backward search.
9937 ;;
9938 ;; NB: Cases where the declaration continues after the block, as in
9939 ;; "struct foo { ... } bar;", are currently recognized as two
9940 ;; declarations, e.g. "struct foo { ... }" and "bar;" in this case.
9941 ;;
9942 ;; This function might do hidden buffer changes.
9948 ;; `c-beginning-of-statement-1' stops at a block start, but we
9949 ;; want to continue if the block doesn't begin a top level
9950 ;; construct, i.e. if it isn't preceded by ';', '}', ':', bob,
9951 ;; or an open paren.
9953 ;; Go back one "statement" each time round the loop until we're just
9954 ;; after a ;, }, or :, or at BOB or the start of a macro or start of
9955 ;; an ObjC method. This will move over a multiple declaration whose
9956 ;; components are comma separated.
9958 ;; Must check with c-opt-method-key in ObjC mode.
9969 ;; Check that we don't move from the first thing in a
9970 ;; macro to its header.
9976 move tentative-move))
9981 ;; Handle K&R argdecls. Back up after the "statement" jumped
9982 ;; over by `c-beginning-of-statement-1', unless it was the
9983 ;; function body, in which case we're sitting on the opening
9984 ;; brace now. Then test if we're in a K&R argdecl region and
9985 ;; that we started at the other side of the first argdecl in
9986 ;; it.
9996 'previous
9998 knr-argdecl-start))
10001 ;; `c-beginning-of-statement-1' counts each brace block as a separate
10002 ;; statement, so the result will be 'previous if we've moved over any.
10003 ;; So change our result back to 'same if necessary.
10004 ;;
10005 ;; If they were brace list initializers we might not have moved over a
10006 ;; declaration boundary though, so change it to 'same if we've moved
10007 ;; past a '=' before '{', but not ';'. (This ought to be integrated
10008 ;; into `c-beginning-of-statement-1', so we avoid this extra pass which
10009 ;; potentially can search over a large amount of text.). Take special
10010 ;; pains not to get mislead by C++'s "operator=", and the like.
10013 c++-template-syntax-table
10019 ; no more, or get to one which isn't an "operator ="
10022 c-overloadable-operators-regexp
10023 c-opt-op-identifier-prefix
10038 ;; Assuming point is at the start of a declaration (as detected by
10039 ;; e.g. `c-beginning-of-decl-1'), go to the end of it. Unlike
10040 ;; `c-beginning-of-decl-1', this function handles the case when a
10041 ;; block is followed by identifiers in e.g. struct declarations in C
10042 ;; or C++. If a proper end was found then t is returned, otherwise
10043 ;; point is moved as far as possible within the current sexp and nil
10044 ;; is returned. This function doesn't handle macros; use
10045 ;; `c-end-of-macro' instead in those cases.
10046 ;;
10047 ;; This function might do hidden buffer changes.
10050 c++-template-syntax-table
10058 ;; Stopped at the ';' in a K&R argdecl section which is
10059 ;; detected using the same criteria as in
10060 ;; `c-beginning-of-decl-1'. Move to the following block
10061 ;; start.
10065 ;; Encountered a block in the declaration. Jump over it.
10076 ;; Check for `c-opt-block-decls-with-vars-key'
10077 ;; before the first paren.
10080 c-opt-block-decls-with-vars-key
10082 lim t t t)
10085 ;; Check that the first following paren is
10086 ;; the block.
10088 lim t t t)
10090 ;; The declaration doesn't have any of the
10091 ;; `c-opt-block-decls-with-vars' keywords in the
10092 ;; beginning, so it ends here at the end of the block.
10100 nil)))
10103 ;; Assuming the point is at an open brace, check if it starts a
10104 ;; block that contains another declaration level, i.e. that isn't a
10105 ;; statement block or a brace list, and if so return non-nil.
10106 ;;
10107 ;; If the check is successful, the return value is the start of the
10108 ;; keyword that tells what kind of construct it is, i.e. typically
10109 ;; what `c-decl-block-key' matched. Also, if GOTO-START is set then
10110 ;; the point will be at the start of the construct, before any
10111 ;; leading specifiers, otherwise it's at the returned position.
10112 ;;
10113 ;; The point is clobbered if the check is unsuccessful.
10114 ;;
10115 ;; CONTAINING-SEXP is the position of the open of the surrounding
10116 ;; paren, or nil if none.
10117 ;;
10118 ;; The optional LIMIT limits the backward search for the start of
10119 ;; the construct. It's assumed to be at a syntactically relevant
10120 ;; position.
10121 ;;
10122 ;; If any template arglists are found in the searched region before
10123 ;; the open brace, they get marked with paren syntax.
10124 ;;
10125 ;; This function might do hidden buffer changes.
10132 ;; Could be at the end of a template arglist.
10140 ;; Skip back over noise clauses.
10142 c-opt-cpp-prefix
10152 t)
10154 nil))))
10156 ;; Note: Can't get bogus hits inside template arglists below since they
10157 ;; have gotten paren syntax above.
10159 ;; If `goto-start' is set we begin by searching for the
10160 ;; first possible position of a leading specifier list.
10161 ;; The `c-decl-block-key' search continues from there since
10162 ;; we know it can't match earlier.
10165 open-brace t t)
10167 t)
10168 t)
10174 ;; Exclude cases where we matched what would ordinarily
10175 ;; be a block declaration keyword, except where it's not
10176 ;; legal because it's part of a "compound keyword" like
10177 ;; "enum class". Of course, if c-after-brace-list-key
10178 ;; is nil, we can skip the test.
10188 ;; Found a keyword that can't be a type?
10191 ;; Can be a type too, in which case it's the return type of a
10192 ;; function (under the assumption that no declaration level
10193 ;; block construct starts with a type).
10196 ;; Jumped over a type, but it could be a declaration keyword
10197 ;; followed by the declared identifier that we've jumped over
10198 ;; instead (e.g. in "class Foo {"). If it indeed is a type
10199 ;; then we should be at the declarator now, so check for a
10200 ;; valid declarator start.
10201 ;;
10202 ;; Note: This doesn't cope with the case when a declared
10203 ;; identifier is followed by e.g. '(' in a language where '('
10204 ;; also might be part of a declarator expression. Currently
10205 ;; there's no such language.
10209 ;; In Pike a list of modifiers may be followed by a brace
10210 ;; to make them apply to many identifiers. Note that the
10211 ;; match data will be empty on return in this case.
10217 ;; Use this variant to avoid yet another special regexp.
10221 t)))
10223 ;; Got a match.
10226 ;; Back up over any preceding specifiers and their clauses
10227 ;; by going forward from `first-specifier-pos', which is the
10228 ;; earliest possible position where the specifier list can
10229 ;; start.
10235 ;; Accept any plain symbol token on the ground that
10236 ;; it's a specifier masked through a macro (just
10237 ;; like `c-forward-decl-or-cast-1' skip forward over
10238 ;; such tokens).
10239 ;;
10240 ;; Could be more restrictive wrt invalid keywords,
10241 ;; but that'd only occur in invalid code so there's
10242 ;; no use spending effort on it.
10247 ;; Moving over a protection kwd and the following
10248 ;; ":" (in C++ Mode) to the next token could take
10249 ;; us all the way up to `kwd-start', leaving us
10250 ;; no chance to update `first-specifier-pos'.
10256 ;; Can't parse a declaration preamble and is still
10257 ;; before `kwd-start'. That means `first-specifier-pos'
10258 ;; was in some earlier construct. Search again.
10262 ;; Got no preamble before the block declaration keyword.
10268 kwd-start)))
10271 ;; Check whether point is directly inside a brace block which is the brace
10272 ;; block of a class, struct, or union which is called NAME, a string.
10275 )
10279 ; *c-looking-at-decl-block
10280 ; containing-sexp goto-start &optional
10281 ; limit)
10284 nil)
10291 ;; Check if the closest containing paren sexp is a declaration
10292 ;; block, returning a 2 element vector in that case. Aref 0
10293 ;; contains the bufpos at boi of the class key line, and aref 1
10294 ;; contains the bufpos of the open brace. This function is an
10295 ;; obsolete wrapper for `c-looking-at-decl-block'.
10296 ;;
10297 ;; This function might do hidden buffer changes.
10305 nil))
10310 ;; Return the buffer position of the most enclosing decl-block brace (in the
10311 ;; sense of c-looking-at-decl-block) in the PAREN-STATE structure, or nil if
10312 ;; none was found.
10321 open-brace))
10324 ;; Return the position of the L-brace if point is inside a brace list
10325 ;; initialization of an array, etc. This is an approximate function,
10326 ;; designed for speed over accuracy. It will not find every bracelist, but
10327 ;; a non-nil result is reliable. We simply search for "= {" (naturally with
10328 ;; syntactic whitespace allowed). PAREN-STATE is the normal thing that it
10329 ;; is everywhere else.
10338 b-pos)))
10341 ;; We're at a "{" which might be the opening brace of a enum which is
10342 ;; strongly typed (by a ":" followed by a type). If this is the case, leave
10343 ;; point before the colon and return t. Otherwise leave point unchanged and return nil.
10344 ;; Match data will be clobbered.
10354 t)
10369 nil)
10371 t)
10373 t)
10377 t)))
10380 ;; We're at a "{". Move back to the enum-like keyword that starts this
10381 ;; declaration and return t, otherwise don't move and return nil.
10383 before-identifier)
10399 t)
10411 t)
10417 ;; Point is at an open brace. If this starts a brace list, return a list
10418 ;; whose car is the buffer position of the start of the construct which
10419 ;; introduces the list, and whose cdr is the symbol `in-paren' if the brace
10420 ;; is directly enclosed in a parenthesis form (i.e. an arglist), t if we
10421 ;; have parsed a keyword matching `c-opt-inexpr-brace-list-key' (e.g. Java's
10422 ;; "new"), nil otherwise. Otherwise, if point might be inside an enclosing
10423 ;; brace list, return t. If point is definitely neither at nor in a brace
10424 ;; list, return nil.
10425 ;;
10426 ;; CONTAINING-SEXP is the position of the brace/paren/bracket enclosing
10427 ;; POINT, or nil if there is no such position, or we do not know it. LIM is
10428 ;; a backward search limit.
10429 ;;
10430 ;; The determination of whether the brace starts a brace list is solely by
10431 ;; the context of the brace, not by its contents.
10432 ;;
10433 ;; Here, "brace list" does not include the body of an enum.
10437 ;; Pike can have class definitions anywhere, so we must
10438 ;; check for the class key here.
10440 c-decl-block-key))
10442 inexpr-brace-list bufpos macro-start res pos after-type-id-pos
10443 in-paren parens-before-brace)
10446 ;; Checks to do only on the first sexp before the brace.
10447 ;; Have we a C++ initialization, without an "="?
10463 nil)
10475 nil))))
10480 ;; In Java, an initialization brace list may follow
10481 ;; directly after "new Foo[]", so check for a "new"
10482 ;; earlier.
10488 t)
10490 ;; Carry on looking if this is an
10491 ;; identifier (may contain "." in Java)
10492 ;; or another "[]" sexp.
10509 ;; Single identifier between '(' and '{'. We have a bracelist.
10512 ;; Are we at the parens of a C++ lambda expression?
10522 ;; Checks to do on all sexps before the brace, up to the
10523 ;; beginning of the statement.
10531 ;; We've seen a =, but must check earlier tokens so
10532 ;; that it isn't something that should be ignored.
10538 ;; Check for operator =
10541 nil)
10542 ;; Check for `<opchar>= in Pike.
10545 ;; Special case for Pikes
10546 ;; `[]=, since '[' is not in
10547 ;; the punctuation class.
10550 nil)
10552 ;; make sure we're not in a C++ template
10553 ;; argument assignment
10565 ))))
10566 nil)
10574 ;; We've hit the beginning of the aggregate list.
10598 nil nil))
10603 ;; Brace lists can't contain a semicolon, so we're done.
10604 ;; (setq containing-sexp nil)
10605 nil)
10609 ;; We've a macro whose expansion starts with the '{'.
10610 ;; Heuristically, if we have a ';' in it we've not got a
10611 ;; brace list, otherwise we have.
10617 nil
10619 ; languages where
10620 ; `c-opt-inexpr-brace-list-key' is
10621 ; non-nil and we have macros.
10623 )))
10626 ;; return the buffer position of the beginning of the brace list
10627 ;; statement if we're inside a brace list, otherwise return nil.
10628 ;; CONTAINING-SEXP is the buffer pos of the innermost containing
10629 ;; paren. PAREN-STATE is the remainder of the state of enclosing
10630 ;; braces. ACCEPT-IN-PAREN is non-nil iff we will accept as a brace
10631 ;; list a brace directly enclosed in a parenthesis.
10632 ;;
10633 ;; The "brace list" here is recognized solely by its context, not by
10634 ;; its contents.
10635 ;;
10636 ;; N.B.: This algorithm can potentially get confused by cpp macros
10637 ;; placed in inconvenient locations. It's a trade-off we make for
10638 ;; speed.
10639 ;;
10640 ;; This function might do hidden buffer changes.
10642 ;; This will pick up brace list declarations.
10646 ;; this will pick up array/aggregate init lists, even if they are nested.
10649 next-containing)
10651 containing-sexp)
10657 ;; We're in an in-expression block of some kind. Do not
10658 ;; check nesting. We deliberately set the limit to the
10659 ;; containing sexp, so that c-looking-at-inexpr-block
10660 ;; doesn't check for an identifier before it.
10665 next-containing next-containing))
10666 t)
10668 next-containing nil)))))
10674 ;; If we're looking at the start of a pike-style list, i.e., `({Â })',
10675 ;; `([Â ])', `(<Â >)', etc., a cons of a cons of its starting and ending
10676 ;; positions and its entry in c-special-brace-lists is returned, nil
10677 ;; otherwise. The ending position is nil if the list is still open.
10678 ;; LIM is the limit for forward search. The point may either be at
10679 ;; the `(' or at the following paren character. Tries to check the
10680 ;; matching closer, but assumes it's correct if no balanced paren is
10681 ;; found (i.e. the case `({ ... } ... )' is detected as _not_ being
10682 ;; a special brace list).
10683 ;;
10684 ;; This function might do hidden buffer changes.
10689 inner-beg end type)
10704 nil)))))
10714 ;; Check balancing of the inner paren
10715 ;; below.
10718 t)
10719 ;; If the inner char isn't a paren then
10720 ;; we can't check balancing, so just
10721 ;; check the char before the outer
10722 ;; closing paren.
10737 ;; Return non-nil if between two statements or declarations, assuming
10738 ;; point is not inside a literal or comment.
10739 ;;
10740 ;; Obsolete - `c-at-statement-start-p' or `c-at-expression-start-p'
10741 ;; are recommended instead.
10742 ;;
10743 ;; This function might do hidden buffer changes.
10748 ;; Point is at an opening brace. If this is a statement block (i.e. the
10749 ;; elements in the block are terminated by semicolons, or the block is
10750 ;; empty, or the block contains a keyword) return t. Otherwise, return nil.
10783 ;; Return non-nil if we're looking at the beginning of a block
10784 ;; inside an expression. The value returned is actually a cons of
10785 ;; either 'inlambda, 'inexpr-statement or 'inexpr-class and the
10786 ;; position of the beginning of the construct.
10787 ;;
10788 ;; LIM limits the backward search. CONTAINING-SEXP is the start
10789 ;; position of the closest containing list. If it's nil, the
10790 ;; containing paren isn't used to decide whether we're inside an
10791 ;; expression or not. If both LIM and CONTAINING-SEXP are used, LIM
10792 ;; needs to be farther back.
10793 ;;
10794 ;; If CHECK-AT-END is non-nil then extra checks at the end of the
10795 ;; brace block might be done. It should only be used when the
10796 ;; construct can be assumed to be complete, i.e. when the original
10797 ;; starting position was further down than that.
10798 ;;
10799 ;; This function might do hidden buffer changes.
10803 haskell-op-pos
10805 ;; Look at the character after point only as a last resort
10806 ;; when we can't disambiguate.
10809 ;; Search for a C++11 "->" which suggests a lambda declaration.
10840 ;; If the class definition is at the start of
10841 ;; a statement, we don't consider it an
10842 ;; in-expression class.
10850 ;; Also, in Pike we treat it as an
10851 ;; in-expression class if it's used in an
10852 ;; object clone expression.
10873 nil)
10883 ;; Accept several square bracket sexps for
10884 ;; Java array initializations.
10891 ;; C++11 lambda function declaration
10907 block-follows
10920 block-follows
10921 containing-sexp
10939 nil
10942 res))))
10945 ;; Returns non-nil if we're looking at the end of an in-expression
10946 ;; block, otherwise the same as `c-looking-at-inexpr-block'.
10947 ;; PAREN-STATE is the paren state relevant at the current position.
10948 ;;
10949 ;; This function might do hidden buffer changes.
10951 ;; We currently only recognize a block.
10954 containing-sexp)
10963 paren-state)
10964 containing-sexp)))))
10967 ;; Return non-nil if we're at the opening "[" of the capture list of a C++
10968 ;; lambda function, nil otherwise.
10979 ;; Is there a "virtual semicolon" at POS or point?
10980 ;; (See cc-defs.el for full details of "virtual semicolons".)
10981 ;;
10982 ;; This is true when point is at the last non syntactic WS position on the
10983 ;; line, there is a macro call last on the line, and this particular macro's
10984 ;; name is defined by the regexp `c-vs-macro-regexp' as not needing a
10985 ;; semicolon.
10993 c-macro-with-semi-re
10996 ;; Check we've got nothing after this except comments and empty lines
10997 ;; joined by escaped EOLs.
11010 nil)
11018 ;; Check for one of the listed macros being before point.
11022 t))
11030 \f
11031 ;; `c-guess-basic-syntax' and the functions that precedes it below
11032 ;; implements the main decision tree for determining the syntactic
11033 ;; analysis of the current line of code.
11035 ;; Dynamically bound to t when `c-guess-basic-syntax' is called during
11036 ;; auto newline analysis.
11040 ;; BRACEPOS is the position of a brace in a construct like "namespace
11041 ;; Bar {". Return the anchor point in this construct; this is the
11042 ;; earliest symbol on the brace's line which isn't earlier than
11043 ;; "namespace".
11044 ;;
11045 ;; Currently (2007-08-17), "like namespace" means "matches
11046 ;; c-other-block-decl-kwds". It doesn't work with "class" or "struct"
11047 ;; or anything like that.
11057 ;; A simple function to prepend a new syntax element to
11058 ;; `c-syntactic-context'. Using `setq' on it is unsafe since it
11059 ;; should always be dynamically bound but since we read it first
11060 ;; we'll fail properly anyway if this function is misused.
11062 c-syntactic-context)))
11065 ;; Like `c-add-syntax' but appends to the end of the syntax list.
11066 ;; (Normally not necessary.)
11071 syntax-extra-args
11072 stop-at-boi-only
11073 containing-sexp
11074 paren-state
11076 ;; Add the indicated SYNTAX-SYMBOL to `c-syntactic-context', extending it as
11077 ;; needed with further syntax elements of the types `substatement',
11078 ;; `inexpr-statement', `arglist-cont-nonempty', `statement-block-intro',
11079 ;; `defun-block-intro', and `brace-list-intro'.
11080 ;;
11081 ;; Do the generic processing to anchor the given syntax symbol on the
11082 ;; preceding statement: First skip over any labels and containing statements
11083 ;; on the same line. If FIXED-ANCHOR is non-nil, use this as the
11084 ;; anchor-point for the given syntactic symbol, and don't make syntactic
11085 ;; entries for constructs beginning on lines before that containing
11086 ;; ANCHOR-POINT. Otherwise search backward until we find a statement or
11087 ;; block start that begins at boi without a label or comment.
11088 ;;
11089 ;; Point is assumed to be at the prospective anchor point for the
11090 ;; given SYNTAX-SYMBOL. More syntax entries are added if we need to
11091 ;; skip past open parens and containing statements. Most of the added
11092 ;; syntax elements will get the same anchor point - the exception is
11093 ;; for an anchor in a construct like "namespace"[*] - this is as early
11094 ;; as possible in the construct but on the same line as the {.
11095 ;;
11096 ;; [*] i.e. with a keyword matching c-other-block-decl-kwds.
11097 ;;
11098 ;; SYNTAX-EXTRA-ARGS are a list of the extra arguments for the
11099 ;; syntax symbol. They are appended after the anchor point.
11100 ;;
11101 ;; If STOP-AT-BOI-ONLY is nil, we can stop in the middle of the line
11102 ;; if the current statement starts there.
11103 ;;
11104 ;; Note: It's not a problem if PAREN-STATE "overshoots"
11105 ;; CONTAINING-SEXP, i.e. contains info about parens further down.
11106 ;;
11107 ;; This function might do hidden buffer changes.
11110 ;; This is by far the most common case, so let's give it special
11111 ;; treatment.
11117 ;; Set when we're on a label, so that we don't stop there.
11118 ;; FIXME: To be complete we should check if we're on a label
11119 ;; now at the start.
11120 on-label)
11122 ;; Use point as the anchor point for "namespace", "extern", etc.
11126 syntax-extra-args)
11128 ;; Loop while we have to back out of containing blocks.
11133 ;; Loop while we have to back up statements.
11135 on-label
11138 ;; Skip past any comments that stands between the
11139 ;; statement start and boi.
11147 ;; Skip to the beginning of this statement or backward
11148 ;; another one.
11156 ;; If we didn't move we're at the start of a block and
11157 ;; have to continue outside it.
11166 ;; Special case to avoid deeper and deeper indentation
11167 ;; of "else if" clauses.
11168 )
11173 ;; If stop-at-boi-only is nil, we shouldn't back up
11174 ;; over previous or containing statements to try to
11175 ;; reach boi, so go back to the last position and
11176 ;; exit.
11183 ;; If we've moved into another statement then we
11184 ;; should no longer try to stop in the middle of a
11185 ;; line.
11188 ;; Record this as a substatement if we skipped up one
11189 ;; level.
11192 )))
11194 containing-sexp
11198 ;; Now we have to go out of this block.
11201 ;; Don't stop in the middle of a special brace list opener
11202 ;; like "({".
11214 ;; Analyze the construct in front of the block we've stepped out
11215 ;; from and add the right syntactic element for it.
11218 step-type)
11221 ;; Stepped out of a parenthesis block, so we're in an
11222 ;; expression now.
11234 ;; Stepped out of an in-expression statement. This
11235 ;; syntactic element won't get an anchor pos.
11238 ;; A parenthesis normally belongs to an arglist.
11246 on-label nil))
11248 ;; Stepped out of a brace block.
11260 containing-sexp)))
11262 'defun-block-intro
11264 nil))
11268 c-other-decl-block-key-in-symbols-alist))
11283 ;; Always done if the open brace was at boi. The
11284 ;; c-beginning-of-statement-1 call above is necessary
11285 ;; anyway, to decide the type of block-intro to add.
11288 ))
11290 ;; Fill in the current point as the anchor for all the symbols
11291 ;; added above.
11300 fixed-anchor)))
11303 )))
11306 containing-decl-open
11307 containing-decl-start
11308 containing-decl-kwd
11309 _paren-state)
11310 ;; The inclass and class-close syntactic symbols are added in
11311 ;; several places and some work is needed to fix everything.
11312 ;; Therefore it's collected here.
11313 ;;
11314 ;; This function might do hidden buffer changes.
11319 containing-decl-open)
11321 ;; Ought to use `c-add-stmt-syntax' instead of backing up to boi
11322 ;; here, but we have to do like this for compatibility.
11332 char-after-ip
11333 beg-of-same-or-containing-stmt
11334 containing-sexp
11335 paren-state)
11336 ;; This function contains the decision tree reached through both
11337 ;; cases 18 and 10. It's a continued statement or top level
11338 ;; construct of some kind.
11339 ;;
11340 ;; This function might do hidden buffer changes.
11347 ;; (CASE A removed.)
11348 ;; CASE B: open braces for class or brace-lists
11355 ;; CASE B.1: class-open
11362 ;; CASE B.2: brace-list-open
11366 containing-sexp beg-of-same-or-containing-stmt))
11367 )
11368 ;; The most semantically accurate symbol here is
11369 ;; brace-list-open, but we normally report it simply as a
11370 ;; statement-cont. The reason is that one normally adjusts
11371 ;; brace-list-open for brace lists as top-level constructs,
11372 ;; and brace lists inside statements is a completely different
11373 ;; context. C.f. case 5A.3.
11376 ;; Turn off the dwim above when we're
11377 ;; analyzing the nature of the brace
11378 ;; for the auto newline feature.
11379 'brace-list-open
11381 nil nil
11382 containing-sexp paren-state))
11384 ;; CASE B.3: The body of a function declared inside a normal
11385 ;; block. Can occur e.g. in Pike and when using gcc
11386 ;; extensions, but watch out for macros followed by blocks.
11387 ;; C.f. cases E, 16F and 17G.
11393 ;; Turn off recognition of constructs that lacks a
11394 ;; type in this case, since that's more likely to be
11395 ;; a macro followed by a block.
11398 containing-sexp paren-state))
11400 ;; CASE B.5: We have a C++11 "return \n { ..... }" Note that we're
11401 ;; not at the "{", currently.
11406 containing-sexp paren-state))
11408 ;; CASE B.4: Continued statement with block open. The most
11409 ;; accurate analysis is perhaps `statement-cont' together with
11410 ;; `block-open' but we play DWIM and use `substatement-open'
11411 ;; instead. The rationale is that this typically is a macro
11412 ;; followed by a block which makes it very similar to a
11413 ;; statement with a substatement block.
11416 containing-sexp paren-state))
11417 ))
11419 ;; CASE C: iostream insertion or extraction operator
11423 ;; If there is no preceding streamop in the statement
11424 ;; then indent this line as a normal statement-cont.
11428 t))))
11430 ;; CASE E: In the "K&R region" of a function declared inside a
11431 ;; normal block. C.f. case B.3.
11433 ;; Check that the next token is a '{'. This works as
11434 ;; long as no language that allows nested function
11435 ;; definitions allows stuff like member init lists, K&R
11436 ;; declarations or throws clauses there.
11437 ;;
11438 ;; Note that we do a forward search for something ahead
11439 ;; of the indentation line here. That's not good since
11440 ;; the user might not have typed it yet. Unfortunately
11441 ;; it's exceedingly tricky to recognize a function
11442 ;; prototype in a code block without resorting to this.
11450 ;; Turn off recognition of constructs that lacks a
11451 ;; type in this case, since that's more likely to be
11452 ;; a macro followed by a block.
11455 containing-sexp paren-state))
11457 ;;CASE F: continued statement and the only preceding items are
11458 ;;annotations.
11466 t)
11473 ;; CASE G: a template list continuation?
11474 ;; Mostly a duplication of case 5D.3 to fix templates-19:
11492 ;; In a nested template arglist.
11498 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
11499 ;; template aware.
11502 ;; CASE D: continued statement.
11506 containing-sexp paren-state))
11507 )))
11509 ;; The next autoload was added by RMS on 2005/8/9 - don't know why (ACM,
11510 ;; 2005/11/29).
11511 ;;;###autoload
11513 "Return the syntactic context of the current line."
11519 ;; A whole ugly bunch of various temporary variables. Have
11520 ;; to declare them here since it's not possible to declare
11521 ;; a variable with only the scope of a cond test and the
11522 ;; following result clauses, and most of this function is a
11523 ;; single gigantic cond. :P
11524 literal char-before-ip before-ws-ip char-after-ip macro-start
11525 in-macro-expr c-syntactic-context placeholder
11526 step-type tmpsymbol keyword injava-inher special-brace-list tmp-pos
11527 containing-<
11528 ;; The following record some positions for the containing
11529 ;; declaration block if we're directly within one:
11530 ;; `containing-decl-open' is the position of the open
11531 ;; brace. `containing-decl-start' is the start of the
11532 ;; declaration. `containing-decl-kwd' is the keyword
11533 ;; symbol of the keyword that tells what kind of block it
11534 ;; is.
11535 containing-decl-open
11536 containing-decl-start
11537 containing-decl-kwd
11538 ;; The open paren of the closest surrounding sexp or nil if
11539 ;; there is none.
11540 containing-sexp
11541 ;; The position after the closest preceding brace sexp
11542 ;; (nested sexps are ignored), or the position after
11543 ;; `containing-sexp' if there is none, or (point-min) if
11544 ;; `containing-sexp' is nil.
11545 lim
11546 ;; The paren state outside `containing-sexp', or at
11547 ;; `indent-point' if `containing-sexp' is nil.
11550 ;; There's always at most one syntactic element which got
11551 ;; an anchor pos. It's stored in syntactic-relpos.
11552 syntactic-relpos
11555 ;; Check if we're directly inside an enclosing declaration
11556 ;; level block.
11565 containing-sexp)
11566 t)))
11569 containing-sexp nil)
11574 ;; Init some position variables.
11587 ;; Ignore balanced paren. The next entry
11588 ;; can't be another one.
11591 ;; If there is no surrounding open paren then
11592 ;; put the last balanced pair back on paren-state.
11594 containing-sexp nil)))
11598 ;; If we're in a parenthesis list then ',' delimits the
11599 ;; "statements" rather than being an operator (with the
11600 ;; exception of the "for" clause). This difference is
11601 ;; typically only noticeable when statements are used in macro
11602 ;; arglists.
11606 ;; cache char before and after indent point, and move point to
11607 ;; the most likely position to perform the majority of tests
11616 ;; are we in a literal?
11619 ;; now figure out syntactic qualities of the current line
11622 ;; CASE 1: in a string.
11626 ;; CASE 2: in a C or C++ style comment.
11628 ;; This is a kludge for XEmacs where we use
11629 ;; `buffer-syntactic-context', which doesn't correctly
11630 ;; recognize "\*/" to end a block comment.
11631 ;; `parse-partial-sexp' which is used by
11632 ;; `c-literal-limits' will however do that in most
11633 ;; versions, which results in that we get nil from
11634 ;; `c-literal-limits' even when `c-in-literal' claims
11635 ;; we're inside a comment.
11639 ;; CASE 3: in a cpp preprocessor macro continuation.
11649 ;; If at the beginning of the body of a #define
11650 ;; directive then analyze as cpp-define-intro
11651 ;; only. Go on with the syntactic analysis
11652 ;; otherwise. in-macro-expr is set if we're in a
11653 ;; cpp expression, i.e. before the #define body
11654 ;; or anywhere in a non-#define directive.
11661 nil)))))
11665 ;; CASE 11: an else clause?
11669 containing-sexp paren-state))
11671 ;; CASE 12: while closure of a do/while construct?
11679 containing-sexp paren-state))
11681 ;; CASE 13: A catch or finally clause? This case is simpler
11682 ;; than if-else and do-while, because a block is required
11683 ;; after every try, catch and finally.
11691 t)
11695 t)
11698 t))
11703 containing-sexp paren-state))
11705 ;; CASE 18: A substatement we can recognize by keyword.
11715 ;; Ought to cache the result from the
11716 ;; c-beginning-of-statement-1 calls here.
11726 ;; Step up to the containing statement if we
11727 ;; stayed in the same one.
11735 ;; There was no containing statement after all.
11737 placeholder))
11739 ;; Require a parenthesis after these keywords.
11740 ;; Necessary to catch e.g. synchronized in Java,
11741 ;; which can be used both as statement and
11742 ;; modifier.
11748 ;; CASE 18A: Simple substatement.
11754 containing-sexp paren-state))
11760 containing-sexp paren-state))
11763 containing-sexp paren-state))))
11765 ;; CASE 18B: Some other substatement. This is shared
11766 ;; with case 10.
11768 char-after-ip
11769 placeholder
11770 lim
11771 paren-state)))
11773 ;; CASE 14: A case or default label
11778 containing-sexp
11791 containing-sexp))
11794 ;; Got a bogus label at the top level. In lack of better
11795 ;; alternatives, anchor it on (point-min).
11798 ;; CASE 15: any other label
11806 containing-decl-open
11807 containing-decl-start
11808 containing-decl-kwd
11809 paren-state))
11810 ;; Append access-label with the same anchor point as
11811 ;; inclass gets.
11817 containing-sexp))
11822 ;; If the surrounding statement is a switch then
11823 ;; let's analyze all labels as switch labels, so
11824 ;; that they get lined up consistently.
11825 'case-label
11831 ;; A label on the top level. Treat it as a class
11832 ;; context. (point-min) is the closest we get to the
11833 ;; class open brace.
11836 ;; CASE 4: In-expression statement. C.f. cases 7B, 16A and
11837 ;; 17E.
11840 containing-sexp
11841 ;; Have to turn on the heuristics after
11842 ;; the point even though it doesn't work
11843 ;; very well. C.f. test case class-16.pike.
11844 t))
11849 ;; It's a statement block or an anonymous class.
11851 ;; It's a Pike lambda. Check whether we are between the
11852 ;; lambda keyword and the argument list or at the defun
11853 ;; opener.
11855 'inline-open
11861 paren-state)
11865 ;; CASE 5: Line is inside a declaration level block or at top level.
11869 ;; CASE 5A: we are looking at a defun, brace list, class,
11870 ;; or inline-inclass method opening brace
11877 ;; CASE 5A.1: Non-class declaration block open.
11892 ;; Special case for extern-lang-open.
11893 'extern-lang-open
11895 nil t containing-sexp paren-state))
11897 ;; CASE 5A.2: we are looking at a class opening brace
11906 ;; CASE 5A.3: brace list open
11915 containing-sexp lim)))
11919 ;(c-major-mode-is 'java-mode) ; Not needed anymore (2016-08-30).
11921 ;; We're in Java and have found that the open brace
11922 ;; belongs to a "new Foo[]" initialization list,
11923 ;; which means the brace list is part of an
11924 ;; expression and not a top level definition. We
11925 ;; therefore treat it as any topmost continuation
11926 ;; even though the semantically correct symbol still
11927 ;; is brace-list-open, on the same grounds as in
11928 ;; case B.2.
11934 ;; CASE 5A.4: inline defun open
11940 containing-decl-open
11941 containing-decl-start
11942 containing-decl-kwd
11943 paren-state))
11945 ;; CASE 5A.5: ordinary defun open
11956 ;; Bogus to use bol here, but it's the legacy. (Resolved,
11957 ;; 2007-11-09)
11958 ))))
11960 ;; CASE 5R: Member init list. (Used to be part of CASE 5B.1)
11961 ;; Note there is no limit on the backward search here, since member
11962 ;; init lists can, in practice, be very large.
11969 ;; There is no preceding member init clause.
11970 ;; Indent relative to the beginning of indentation
11971 ;; for the topmost-intro line that contains the
11972 ;; prototype's open paren.
11975 ;; Indent relative to the first member init clause.
11980 ;; CASE 5B: After a function header but before the body (or
11981 ;; the ending semicolon if there's no body).
11988 ;; CASE 5B.1: Member init list.
11990 ;; There is no preceding member init clause.
11991 ;; Indent relative to the beginning of indentation
11992 ;; for the topmost-intro line that contains the
11993 ;; prototype's open paren.
11997 ;; CASE 5B.2: K&R arg decl intro
12004 containing-decl-open
12005 containing-decl-start
12006 containing-decl-kwd
12007 paren-state)))
12009 ;; CASE 5B.4: Nether region after a C++ or Java func
12010 ;; decl, which could include a `throws' declaration.
12014 )))
12016 ;; CASE 5C: inheritance line. could be first inheritance
12017 ;; line, or continuation of a multiple inheritance
12025 ;; watch out for scope operator
12030 )))
12039 ;; for Java
12044 cont done)
12049 done t))
12053 )
12055 injava-inher)
12058 ))
12061 ;; CASE 5C.1: non-hanging colon on an inher intro
12065 ;; don't add inclass symbol since relative point already
12066 ;; contains any class offset
12067 )
12069 ;; CASE 5C.2: hanging colon on an inher intro
12075 containing-decl-open
12076 containing-decl-start
12077 containing-decl-kwd
12078 paren-state)))
12080 ;; CASE 5C.3: in a Java implements/extends
12094 )))
12096 ;; CASE 5C.4: a continued inheritance line
12100 ;; don't add inclass symbol since relative point already
12101 ;; contains any class offset
12102 )))
12104 ;; CASE 5P: AWK pattern or function or continuation
12105 ;; thereof.
12111 'topmost-intro-cont
12113 nil nil
12114 containing-sexp paren-state))
12116 ;; CASE 5D: this could be a top-level initialization, a
12117 ;; member init list continuation, or a template argument
12118 ;; list continuation.
12120 ;; Note: We use the fact that lim is always after any
12121 ;; preceding brace sexp.
12131 t))
12136 t)
12142 nil)
12143 t))
12145 ;; NB: No c-after-special-operator-id stuff in this
12146 ;; clause - we assume only C++ needs it.
12151 ;; CASE 5D.3: perhaps a template list continuation?
12166 ;; In a nested template arglist.
12172 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
12173 ;; template aware.
12176 ;; CASE 5D.4: perhaps a multiple inheritance line?
12188 t)
12193 ;; CASE 5D.5: Continuation of the "expression part" of a
12194 ;; top level construct. Or, perhaps, an unrecognized construct.
12206 ;; A preceding comma at the top level means that a
12207 ;; new variable declaration starts here. Use
12208 ;; topmost-intro-cont for it, for consistency with
12209 ;; the first variable declaration. C.f. case 5N.
12212 nil nil containing-sexp paren-state))
12213 ))
12215 ;; CASE 5F: Close of a non-class declaration level block.
12219 ;; This is inconsistent: Should use `containing-decl-open'
12220 ;; here if it's at boi, like in case 5J.
12224 ;; Special case for compatibility with the
12225 ;; extern-lang syntactic symbols.
12226 'extern-lang-close
12229 nil t
12231 paren-state))
12233 ;; CASE 5G: we are looking at the brace which closes the
12234 ;; enclosing nested class decl
12239 containing-decl-open
12240 containing-decl-start
12241 containing-decl-kwd
12242 paren-state))
12244 ;; CASE 5H: we could be looking at subsequent knr-argdecls
12251 ;; Do an extra check to avoid tripping up on
12252 ;; statements that occur in invalid contexts
12253 ;; (e.g. in macro bodies where we don't really
12254 ;; know the context of what we're looking at).
12261 ;; CASE 5I: ObjC method definition.
12266 ;; Handle the case when it's the first (non-comment)
12267 ;; thing in the buffer. Can't look for a 'same return
12268 ;; value from cbos1 since ObjC directives currently
12269 ;; aren't recognized fully, so that we get 'same
12270 ;; instead of 'previous if it moved over a preceding
12271 ;; directive.
12275 ;; CASE 5N: At a variable declaration that follows a class
12276 ;; definition or some other block declaration that doesn't
12277 ;; end at the closing '}'. C.f. case 5D.5.
12286 ;; Speed up the backward search a bit.
12291 ;; The '}' is unbalanced.
12292 nil
12297 containing-sexp paren-state))
12299 ;; NOTE: The point is at the end of the previous token here.
12301 ;; CASE 5J: we are at the topmost level, make
12302 ;; sure we skip back past any access specifiers
12304 ;; A macro continuation line is never at top level.
12326 nil)))))
12327 ;; For historic reasons we anchor at bol of the last
12328 ;; line of the previous declaration. That's clearly
12329 ;; highly bogus and useless, and it makes our lives hard
12330 ;; to remain compatible. :P
12341 ;; Special case for compatibility with the
12342 ;; extern-lang syntactic symbols.
12343 'inextern-lang
12346 nil t
12348 paren-state))
12350 containing-decl-open
12351 containing-decl-start
12352 containing-decl-kwd
12353 paren-state)))
12355 macro-start
12360 ;; CASE 5K: we are at an ObjC method definition
12361 ;; continuation line.
12370 ;; CASE 5L: we are at the first argument of a template
12371 ;; arglist that begins on the previous line.
12379 ;; CASE 5Q: we are at a statement within a macro.
12384 ;;CASE 5N: We are at a topmost continuation line and the only
12385 ;;preceding items are annotations.
12392 t)
12398 ;; CASE 5M: we are at a topmost continuation line
12409 ))
12411 ;; (CASE 6 has been removed.)
12413 ;; CASE 7: line is an expression, not a statement. Most
12414 ;; likely we are either in a function prototype or a function
12415 ;; call argument list
12423 ;; CASE 7A: we are looking at the arglist closing paren.
12424 ;; C.f. case 7F.
12436 paren-state))
12438 ;; CASE 7B: Looking at the opening brace of an
12439 ;; in-expression block or brace list. C.f. cases 4, 16A
12440 ;; and 17E.
12444 paren-state
12445 nil))
12449 placeholder
12452 paren-state)
12453 containing-sexp)))
12454 ;; placeholder is nil if it's a block directly in
12455 ;; a function arglist. That makes us skip out of
12456 ;; this case.
12457 )))
12462 paren-state)
12466 ;; CASE 7C: we are looking at the first argument in an empty
12467 ;; argument list. Use arglist-close if we're actually
12468 ;; looking at a close paren or bracket.
12480 paren-state))
12482 ;; CASE 7D: we are inside a conditional test clause. treat
12483 ;; these things as statements
12493 ))
12495 ;; CASE 7E: maybe a continued ObjC method call. This is the
12496 ;; case when we are inside a [] bracketed exp, and what
12497 ;; precede the opening bracket is not an identifier.
12505 )))
12507 ;; CASE 7F: we are looking at an arglist continuation line,
12508 ;; but the preceding argument is on the same line as the
12509 ;; opening paren. This case includes multi-line
12510 ;; mathematical paren groupings, but we could be on a
12511 ;; for-list continuation line. C.f. case 7A.
12528 paren-state))
12530 ;; CASE 7G: we are looking at just a normal arglist
12531 ;; continuation line
12534 ))
12536 ;; CASE 8: func-local multi-inheritance line
12546 ;; CASE 8A: non-hanging colon on an inher intro
12551 ;; CASE 8B: hanging colon on an inher intro
12555 ;; CASE 8C: a continued inheritance line
12559 )))
12561 ;; CASE 9: we are inside a brace-list
12575 ;; CASE 9A: In the middle of a special brace list opener.
12598 ;; CASE 9B: brace-list-close brace
12600 ;; Check special brace list closer.
12607 ;; We were between the special close char and the `)'.
12610 ;; We were before the special close char.
12614 ;; Normal brace list check.
12625 ;; Prepare for the rest of the cases below by going to the
12626 ;; token following the opening brace
12639 ;; CASE 9C: we're looking at the first line in a brace-list
12650 ;; CASE 9D: this is just a later brace-list-entry or
12651 ;; brace-entry-open
12661 ))
12662 ))))
12664 ;; CASE 10: A continued statement or top level construct.
12674 ;; This is shared with case 18.
12676 char-after-ip
12677 placeholder
12678 containing-sexp
12679 paren-state))
12681 ;; CASE 16: block close brace, possibly closing the defun or
12682 ;; the class
12684 ;; From here on we have the next containing sexp in lim.
12689 ;; CASE 16E: Closing a statement block? This catches
12690 ;; cases where it's preceded by a statement keyword,
12691 ;; which works even when used in an "invalid" context,
12692 ;; e.g. a macro argument.
12697 ;; CASE 16A: closing a lambda defun or an in-expression
12698 ;; block? C.f. cases 4, 7B and 17E.
12701 nil))
12703 'inline-close
12713 paren-state)
12717 ;; CASE 16B: does this close an inline or a function in
12718 ;; a non-class declaration level block?
12725 nil))
12735 ;; CASE 16F: Can be a defun-close of a function declared
12736 ;; in a statement block, e.g. in Pike or when using gcc
12737 ;; extensions, but watch out for macros followed by
12738 ;; blocks. Let it through to be handled below.
12739 ;; C.f. cases B.3 and 17G.
12745 ;; Turn off recognition of constructs that
12746 ;; lacks a type in this case, since that's more
12747 ;; likely to be a macro followed by a block.
12754 ;; CASE 16C: If there is an enclosing brace then this is
12755 ;; a block close since defun closes inside declaration
12756 ;; level blocks have been handled above.
12758 ;; If the block is preceded by a case/switch label on
12759 ;; the same line, we anchor at the first preceding label
12760 ;; at boi. The default handling in c-add-stmt-syntax
12761 ;; really fixes it better, but we do like this to keep
12762 ;; the indentation compatible with version 5.28 and
12763 ;; earlier. C.f. case 17H.
12770 ;; c-backward-to-block-anchor not necessary here; those
12771 ;; situations are handled in case 16E above.
12774 ;; CASE 16D: Only top level defun close left.
12780 paren-state))
12781 ))
12783 ;; CASE 19: line is an expression, not a statement, and is directly
12784 ;; contained by a template delimiter. Most likely, we are in a
12785 ;; template arglist within a statement. This case is based on CASE
12786 ;; 7. At some point in the future, we may wish to create more
12787 ;; syntactic symbols such as `template-intro',
12788 ;; `template-cont-nonempty', etc., and distinguish between them as we
12789 ;; do for `arglist-intro' etc. (2009-12-07).
12795 ; '<') before indent-point.
12803 paren-state))
12805 ;; CASE 17: Statement or defun catchall.
12808 ;; Back up statements until we find one that starts at boi.
12811 containing-sexp)))
12815 nil)
12820 ;; CASE 17B: continued statement
12824 containing-sexp paren-state))
12826 ;; CASE 17A: After a case/default label?
12834 'statement-case-open
12836 nil t containing-sexp paren-state))
12838 ;; CASE 17D: any old statement
12845 containing-sexp paren-state)
12849 ;; CASE 17I: Inside a substatement block.
12851 ;; The following tests are all based on containing-sexp.
12853 ;; From here on we have the next containing sexp in lim.
12858 lim paren-state)
12862 ;; CASE 17E: first statement in an in-expression block.
12863 ;; C.f. cases 4, 7B and 16A.
12866 nil))
12868 'defun-block-intro
12877 paren-state)
12883 ;; CASE 17F: first statement in an inline, or first
12884 ;; statement in a top-level defun. we can tell this is it
12885 ;; if there are no enclosing braces that haven't been
12886 ;; narrowed out by a class (i.e. don't use bod here).
12889 paren-state)))
12895 nil))))
12900 ;; CASE 17G: First statement in a function declared inside
12901 ;; a normal block. This can occur in Pike and with
12902 ;; e.g. the gcc extensions, but watch out for macros
12903 ;; followed by blocks. C.f. cases B.3 and 16F.
12909 ;; Turn off recognition of constructs that lacks
12910 ;; a type in this case, since that's more likely
12911 ;; to be a macro followed by a block.
12917 lim paren-state))
12919 ;; CASE 17H: First statement in a block.
12921 ;; If the block is preceded by a case/switch label on the
12922 ;; same line, we anchor at the first preceding label at
12923 ;; boi. The default handling in c-add-stmt-syntax is
12924 ;; really fixes it better, but we do like this to keep the
12925 ;; indentation compatible with version 5.28 and earlier.
12926 ;; C.f. case 16C.
12933 ;; c-backward-to-block-anchor not necessary here; those
12934 ;; situations are handled in case 17I above.
12936 lim paren-state))
12939 ))
12940 )
12942 ;; now we need to look at any modifiers
12946 ;; are we looking at a comment only line?
12951 ;; we might want to give additional offset to friends (in C++).
12956 ;; Set syntactic-relpos.
12962 nil)
12963 t))
12966 ;; Start of or a continuation of a preprocessor directive?
12981 ;; If inside a cpp expression, i.e. anywhere in a
12982 ;; cpp directive except a #define body, we only let
12983 ;; through the syntactic analysis that is internal
12984 ;; in the expression. That means the arglist
12985 ;; elements, if they are anchored inside the cpp
12986 ;; expression.
12995 ;; Inside a #define body and the syntactic analysis is
12996 ;; anchored on the start of the #define. In this case
12997 ;; we add cpp-define-intro to get the extra
12998 ;; indentation of the #define body.
13001 ;; return the syntax
13002 c-syntactic-context)))
13004 \f
13005 ;; Indentation calculation.
13008 ;; offset can be a number, a function, a variable, a list, or one of
13009 ;; the symbols + or -
13010 ;;
13011 ;; This function might do hidden buffer changes.
13030 langelem symbol))
13036 offset symbol)
13037 nil)
13051 Error evaluating offset %S for %s: \
13052 Cannot combine absolute offset %S with relative %S in `%s' method"
13058 Error evaluating offset %S for %s: \
13059 Cannot combine relative offset %S with absolute %S in `%s' method"
13064 res))
13082 Error evaluating offset %S for %s: \
13083 Cannot combine absolute offsets %S and %S in `add' method"
13087 res))
13096 res))))
13103 nil))))
13107 res
13109 offset symbol res)
13110 nil)))
13113 ;; Get offset from LANGELEM which is a list beginning with the
13114 ;; syntactic symbol and followed by any analysis data it provides.
13115 ;; That data may be zero or more elements, but if at least one is
13116 ;; given then the first is the anchor position (or nil). The symbol
13117 ;; is matched against `c-offsets-alist' and the offset calculated
13118 ;; from that is returned.
13119 ;;
13120 ;; This function might do hidden buffer changes.
13130 offset
13134 ))
13137 ;; This is a compatibility wrapper for `c-calc-offset' in case
13138 ;; someone is calling it directly. It takes an old style syntactic
13139 ;; element on the form (SYMBOL . ANCHOR-POS) and converts it to the
13140 ;; new list form.
13141 ;;
13142 ;; This function might do hidden buffer changes.
13149 ;; Calculate the syntactic indentation from a syntactic description
13150 ;; as returned by `c-guess-syntax'.
13151 ;;
13152 ;; Note that topmost-intro always has an anchor position at bol, for
13153 ;; historical reasons. It's often used together with other symbols
13154 ;; that have more sane positions. Since we always use the first
13155 ;; found anchor position, we rely on that these other symbols always
13156 ;; precede topmost-intro in the LANGELEMS list.
13157 ;;
13158 ;; This function might do hidden buffer changes.
13166 ;; Got an absolute column that overrides any indentation
13167 ;; we've collected so far, but not the relative
13168 ;; indentation we might get for the nested structures
13169 ;; further down the langelems list.
13173 ;; Got a relative change of the current calculated
13174 ;; indentation.
13177 ;; Use the anchor position from the first syntactic
13178 ;; element with one.
13188 indent)))
13190 \f
13193 ;; Local Variables:
13194 ;; indent-tabs-mode: t
13195 ;; tab-width: 8
13196 ;; End:
13197 ;;; cc-engine.el ends here