| blob | 317968aafd3fac6aeba656b5721eb099d90b7be5 |
1 ;;; cc-engine.el --- core syntax guessing engine for CC mode -*- coding: utf-8 -*-
3 ;; Copyright (C) 1985, 1987, 1992-2018 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 position of a comment which is open at the end of the
242 ;; macro represented by `c-macro-cache'.
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 start of the comment which is open at the end of the current
386 ;; CPP directive, or to the end of that directive. For this purpose, open
387 ;; strings are ignored.
388 ;;
389 ;; This function must only be called from the beginning of a CPP construct.
390 ;;
391 ;; Note that this function might do hidden buffer changes. See the comment
392 ;; at the start of cc-engine.el for more info.
395 s)
410 ;; Assuming point is at the "#" that introduces a preprocessor
411 ;; directive, it's moved forward to the end of the identifier which is
412 ;; "#define"d (or whatever c-opt-cpp-macro-define specifies). Non-nil
413 ;; is returned in this case, in all other cases nil is returned and
414 ;; point isn't moved.
415 ;;
416 ;; This function might do hidden buffer changes.
422 ;; Assuming point is at the "#" that introduces a preprocessor
423 ;; directive, it's moved forward to the start of the definition body
424 ;; if it's a "#define" (or whatever c-opt-cpp-macro-define
425 ;; specifies). Non-nil is returned in this case, in all other cases
426 ;; nil is returned and point isn't moved.
427 ;;
428 ;; This function might do hidden buffer changes.
434 \f
435 ;;; Basic utility functions.
438 ;; If ELT is a member of the (possibly dotted) list DLIST, remove all
439 ;; occurrences of it (except for any in the last cdr of DLIST).
440 ;;
441 ;; Call this as (setq DLIST (c-delq-from-dotted-list ELT DLIST)), as
442 ;; sometimes the original structure is changed, sometimes it's not.
443 ;;
444 ;; This function is needed in Emacs < 24.5, and possibly XEmacs, because
445 ;; `delq' throws an error in these versions when given a dotted list.
454 dlist))
457 ;; Return the given region as a string where all syntactic
458 ;; whitespace is removed or, where necessary, replaced with a single
459 ;; space. If PAREN-LEVEL is given then all parens in the region are
460 ;; collapsed to "()", "[]" etc.
461 ;;
462 ;; This function might do hidden buffer changes.
506 ;; Shift the indentation of the current line with the specified
507 ;; amount (positive inwards). The buffer is modified only if
508 ;; SHIFT-AMT isn't equal to zero.
511 tmp-char-inserted)
513 nil
514 ;; If we're on an empty line inside a macro, we take the point
515 ;; to be at the current indentation and shift it to the
516 ;; appropriate column. This way we don't treat the extra
517 ;; whitespace out to the line continuation as indentation.
533 ;; If initial point was within line's indentation and we're not on
534 ;; a line with a line continuation in a macro, position after the
535 ;; indentation. Else stay at same point in text.
543 ;; Return non-nil if the string KEYWORD is a known keyword. More
544 ;; precisely, the value is the symbol for the keyword in
545 ;; `c-keywords-obarray'.
549 ;; Return non-nil if the symbol KEYWORD-SYM, as returned by
550 ;; `c-keyword-sym', is a member of LANG-CONSTANT, which is the name
551 ;; of a language constant that ends with "-kwds". If KEYWORD-SYM is
552 ;; nil then the result is nil.
555 ;; String syntax chars, suitable for skip-syntax-(forward|backward).
560 ;; Regexp matching string limit syntax.
565 ;; Regexp matching WS followed by string limit syntax.
569 ;; Holds formatted error strings for the few cases where parse errors
570 ;; are reported.
577 c-parsing-error)
579 ;; Faces given to comments and string literals. This is used in some
580 ;; situations to speed up recognition; it isn't mandatory that font
581 ;; locking is in use. This variable is extended with the face in
582 ;; `c-doc-face-name' when fontification is activated in cc-fonts.el.
586 ;; New in Emacs 22.
590 ;; Put a c-type property with the given value at POS.
594 ;; Remove all occurrences of the c-type property that has the given
595 ;; value in the region between FROM and TO. VALUE is assumed to not
596 ;; be nil.
597 ;;
598 ;; Note: This assumes that c-type is put on single chars only; it's
599 ;; very inefficient if matching properties cover large regions.
608 \f
609 ;; Some debug tools to visualize various special positions. This
610 ;; debug code isn't as portable as the rest of CC Mode.
646 \f
647 ;; `c-beginning-of-statement-1' and accompanying stuff.
649 ;; KLUDGE ALERT: c-maybe-labelp is used to pass information between
650 ;; c-crosses-statement-barrier-p and c-beginning-of-statement-1. A
651 ;; better way should be implemented, but this will at least shut up
652 ;; the byte compiler.
655 ;; New awk-compatible version of c-beginning-of-statement-1, ACM 2002/6/22
657 ;; Macros used internally in c-beginning-of-statement-1 for the
658 ;; automaton actions.
661 stack)))
666 t
667 ,do-if-done
672 ;; Throw nil if stack is empty, else throw non-nil.
690 "No matching `%s' found for `%s' on line %d"
697 noerror comma-delim)
698 "Move to the start of the current statement or declaration, or to
699 the previous one if already at the beginning of one. Only
700 statements/declarations on the same level are considered, i.e. don't
701 move into or out of sexps (not even normal expression parentheses).
703 If point is already at the earliest statement within braces or parens,
704 this function doesn't move back into any whitespace preceding it; it
705 returns `same' in this case.
709 is within the continuation. If starting at such a token, move to the
710 corresponding statement start. If at the beginning of a statement,
711 move to the closest containing statement if there is any. This might
712 also stop at a continuation clause.
714 Labels are treated as part of the following statements if
715 IGNORE-LABELS is non-nil. (FIXME: Doesn't work if we stop at a known
716 statement start keyword.) Otherwise, each label is treated as a
717 separate statement.
719 Macros are ignored \(i.e. skipped over) unless point is within one, in
720 which case the content of the macro is treated as normal code. Aside
721 from any normal statement starts found in it, stop at the first token
724 macros before leaving them.
726 Return:
728 `same' if stopped at the beginning of the current statement;
729 `up' if stepped to a containing statement;
730 `previous' if stepped to a preceding statement;
731 `beginning' if stepped from a statement continuation clause to
732 its start clause; or
733 `macro' if stepped to a macro start.
734 Note that `same' and not `label' is returned if stopped at the same
735 label without crossing the colon character.
737 LIM may be given to limit the search. If the search hits the limit,
738 point will be left at the closest following token, or at the start
739 position if that is less (`same' is returned in this case).
741 NOERROR turns off error logging to `c-parsing-error'.
743 Normally only `;' and virtual semicolons are considered to delimit
744 statements, but if COMMA-DELIM is non-nil then `,' is treated
745 as a delimiter too.
747 Note that this function might do hidden buffer changes. See the
748 comment at the start of cc-engine.el for more info."
750 ;; The bulk of this function is a pushdown automaton that looks at statement
751 ;; boundaries and the tokens (such as "while") in c-opt-block-stmt-key. Its
752 ;; purpose is to keep track of nested statements, ensuring that such
753 ;; statements are skipped over in their entirety (somewhat akin to what C-M-p
754 ;; does with nested braces/brackets/parentheses).
755 ;;
756 ;; Note: The position of a boundary is the following token.
757 ;;
758 ;; Beginning with the current token (the one following point), move back one
759 ;; sexp at a time (where a sexp is, more or less, either a token or the
760 ;; entire contents of a brace/bracket/paren pair). Each time a statement
761 ;; boundary is crossed or a "while"-like token is found, update the state of
762 ;; the PDA. Stop at the beginning of a statement when the stack (holding
763 ;; nested statement info) is empty and the position has been moved.
764 ;;
765 ;; The following variables constitute the PDA:
766 ;;
767 ;; sym: This is either the "while"-like token (e.g. 'for) we've just
768 ;; scanned back over, 'boundary if we've just gone back over a
769 ;; statement boundary, or nil otherwise.
770 ;; state: takes one of the values (nil else else-boundary while
771 ;; while-boundary catch catch-boundary).
772 ;; nil means "no "while"-like token yet scanned".
773 ;; 'else, for example, means "just gone back over an else".
774 ;; 'else-boundary means "just gone back over a statement boundary
775 ;; immediately after having gone back over an else".
776 ;; saved-pos: A vector of either saved positions (tok ptok pptok, etc.) or
777 ;; of error reporting information.
778 ;; stack: The stack onto which the PDA pushes its state. Each entry
779 ;; consists of a saved value of state and saved-pos. An entry is
780 ;; pushed when we move back over a "continuation" token (e.g. else)
781 ;; and popped when we encounter the corresponding opening token
782 ;; (e.g. if).
783 ;;
784 ;;
785 ;; The following diagram briefly outlines the PDA.
786 ;;
787 ;; Common state:
788 ;; "else": Push state, goto state `else'.
789 ;; "while": Push state, goto state `while'.
790 ;; "catch" or "finally": Push state, goto state `catch'.
791 ;; boundary: Pop state.
792 ;; other: Do nothing special.
793 ;;
794 ;; State `else':
795 ;; boundary: Goto state `else-boundary'.
796 ;; other: Error, pop state, retry token.
797 ;;
798 ;; State `else-boundary':
799 ;; "if": Pop state.
800 ;; boundary: Error, pop state.
801 ;; other: See common state.
802 ;;
803 ;; State `while':
804 ;; boundary: Save position, goto state `while-boundary'.
805 ;; other: Pop state, retry token.
806 ;;
807 ;; State `while-boundary':
808 ;; "do": Pop state.
809 ;; boundary: Restore position if it's not at start, pop state. [*see below]
810 ;; other: See common state.
811 ;;
812 ;; State `catch':
813 ;; boundary: Goto state `catch-boundary'.
814 ;; other: Error, pop state, retry token.
815 ;;
816 ;; State `catch-boundary':
817 ;; "try": Pop state.
818 ;; "catch": Goto state `catch'.
819 ;; boundary: Error, pop state.
820 ;; other: See common state.
821 ;;
822 ;; [*] In the `while-boundary' state, we had pushed a 'while state, and were
823 ;; searching for a "do" which would have opened a do-while. If we didn't
824 ;; find it, we discard the analysis done since the "while", go back to this
825 ;; token in the buffer and restart the scanning there, this time WITHOUT
826 ;; pushing the 'while state onto the stack.
827 ;;
828 ;; In addition to the above there is some special handling of labels
829 ;; and macros.
833 macro-start
836 c-stmt-delim-chars-with-comma
837 c-stmt-delim-chars))
838 c-maybe-labelp after-case:-pos saved
839 ;; Current position.
840 pos
841 ;; Position of last stmt boundary character (e.g. ;).
842 boundary-pos
843 ;; The position of the last sexp or bound that follows the
844 ;; first found colon, i.e. the start of the nonlabel part of
845 ;; the statement. It's `start' if a colon is found just after
846 ;; the start.
847 after-labels-pos
848 ;; Like `after-labels-pos', but the first such position inside
849 ;; a label, i.e. the start of the last label before the start
850 ;; of the nonlabel part of the statement.
851 last-label-pos
852 ;; The last position where a label is possible provided the
853 ;; statement started there. It's nil as long as no invalid
854 ;; label content has been found (according to
855 ;; `c-nonlabel-token-key'). It's `start' if no valid label
856 ;; content was found in the label. Note that we might still
857 ;; regard it a label if it starts with `c-label-kwds'.
858 label-good-pos
859 ;; Putative positions of the components of a bitfield declaration,
860 ;; e.g. "int foo : NUM_FOO_BITS ;"
861 bitfield-type-pos bitfield-id-pos bitfield-size-pos
862 ;; Symbol just scanned back over (e.g. 'while or 'boundary).
863 ;; See above.
864 sym
865 ;; Current state in the automaton. See above.
866 state
867 ;; Current saved positions. See above.
868 saved-pos
869 ;; Stack of conses (state . saved-pos).
870 stack
871 ;; Regexp which matches "for", "if", etc.
874 ;; Return value.
876 ;; Positions of the last three sexps or bounds we've stopped at.
877 tok ptok pptok)
887 ;; Try to skip back over unary operator characters, to register
888 ;; that we've moved.
892 ;; Protect post-++/-- operators just before a virtual semicolon.
896 ;; Skip back over any semicolon here. If it was a bare semicolon, we're
897 ;; done. Later on we ignore the boundaries for statements that don't
898 ;; contain any sexp. The only thing that is affected is that the error
899 ;; checking is a little less strict, and we really don't bother.
909 pos saved)
911 ;; Begin at start and not pos to detect macros if we stand
912 ;; directly after the #.
915 ;; Record this as the first token if not starting inside it.
918 ;; The following while loop goes back one sexp (balanced parens,
919 ;; etc. with contents, or symbol or suchlike) each iteration. This
920 ;; movement is accomplished with a call to c-backward-sexp approx 170
921 ;; lines below.
922 ;;
923 ;; The loop is exited only by throwing nil to the (catch 'loop ...):
924 ;; 1. On reaching the start of a macro;
925 ;; 2. On having passed a stmt boundary with the PDA stack empty;
926 ;; 3. On reaching the start of an Objective C method def;
927 ;; 4. From macro `c-bos-pop-state'; when the stack is empty;
928 ;; 5. From macro `c-bos-pop-state-and-retry' when the stack is empty.
932 ;; Are we in a macro, just after the opening #?
947 ;; Stop at the first token in the content of the macro.
951 ret 'macro
952 ignore-labels t))
955 ;; Do a round through the automaton if we've just passed a
956 ;; statement boundary or passed a "while"-like token.
964 ;; The PDA state handling.
965 ;;
966 ;; Refer to the description of the PDA in the opening
967 ;; comments. In the following OR form, the first leaf
968 ;; attempts to handles one of the specific actions detailed
969 ;; (e.g., finding token "if" whilst in state `else-boundary').
970 ;; We drop through to the second leaf (which handles common
971 ;; state) if no specific handler is found in the first cond.
972 ;; If a parsing error is detected (e.g. an "else" with no
973 ;; preceding "if"), we throw to the enclosing catch.
974 ;;
975 ;; Note that the (eq state 'else) means
976 ;; "we've just passed an else", NOT "we're looking for an
977 ;; else".
994 ;; Since this can cause backtracking we do a
995 ;; little more careful analysis to avoid it:
996 ;; If there's a label in front of the while
997 ;; it can't be part of a do-while.
1026 ;; This is state common. We get here when the previous
1027 ;; cond statement found no particular state handler.
1029 ;; If we have a boundary at the start
1030 ;; position we push a frame to go to the
1031 ;; previous statement.
1040 ;; Is this a real while, or a do-while?
1041 ;; The next `when' triggers unless we are SURE that
1042 ;; the `while' is not the tail end of a `do-while'.
1045 ;; The following kludge is to prevent
1046 ;; infinite recursion when called from
1047 ;; c-awk-after-if-for-while-condition-p,
1048 ;; or the like.
1052 ;; Since this can cause backtracking we do a
1053 ;; little more careful analysis to avoid it: If
1054 ;; the while isn't followed by a (possibly
1055 ;; virtual) semicolon it can't be a do-while.
1064 ;; We're either past a statement boundary or at the
1065 ;; start of a statement, so throw away any label data
1066 ;; for the previous one.
1068 last-label-pos nil
1069 c-maybe-labelp nil))))
1071 ;; Step to the previous sexp, but not if we crossed a
1072 ;; boundary, since that doesn't consume an sexp.
1076 ;; HERE IS THE SINGLE PLACE INSIDE THE PDA LOOP WHERE WE MOVE
1077 ;; BACKWARDS THROUGH THE SOURCE.
1081 ;; The end position of the area to search for statement
1082 ;; barriers in this round.
1085 ;; Go back over exactly one logical sexp, taking proper
1086 ;; account of macros and escaped EOLs.
1090 ;; Give up if we hit an unbalanced block. Since the
1091 ;; stack won't be empty the code below will report a
1092 ;; suitable error.
1095 ;; Have we moved into a macro?
1098 ;; Have we crossed a statement boundary? If not,
1099 ;; keep going back until we find one or a "real" sexp.
1106 ;; Have we just gone back over an escaped NL? This
1107 ;; doesn't count as a sexp.
1110 ;; Have we crossed a statement boundary?
1113 ;; Are we at a macro beginning?
1115 c-opt-cpp-prefix
1121 ;; Just gone back over a brace block?
1130 ;; Just gone back over some paren block?
1134 before-sws-pos)))
1137 ;; Just gone back over an ordinary symbol of some sort?
1143 ptok tok
1144 tok boundary-pos
1146 ;; Like a C "continue". Analyze the next sexp.
1149 ;; ObjC method def?
1156 ;; Might we have a bitfield declaration, "<type> <id> : <size>"?
1159 ;; The : <size> and <id> fields?
1169 ;; The <type> field?
1177 bitfield-id-pos nil)))))
1179 ;; Handle labels.
1182 ;; `c-crosses-statement-barrier-p' has found a colon, so we
1183 ;; might be in a label now. Have we got a real label
1184 ;; (including a case label) or something like C++'s "public:"?
1185 ;; A case label might use an expression rather than a token.
1188 ;; Catch C++'s inheritance construct "class foo : bar".
1202 ; been found.
1204 ;; We're in a potential label and it's the first
1205 ;; time we've found something that isn't allowed in
1206 ;; one.
1209 ;; We've moved back by a sexp, so update the token positions.
1211 pptok ptok
1212 ptok tok
1218 ;; If the stack isn't empty there might be errors to report.
1227 ;; Need to investigate closer whether we've crossed
1228 ;; between a substatement and its containing statement.
1232 pptok)
1234 ptok)
1242 after-labels-pos
1249 last-label-pos
1250 pos))
1252 ;; We're in a label. Maybe we should step to the statement
1253 ;; after it.
1258 ;; Might have jumped over several labels. Go to the last one.
1261 ;; Have we got "case <expression>:"?
1271 ;; Skip over the unary operators that can start the statement.
1274 ;; protect AWK post-inc/decrement operators, etc.
1279 ret)))
1282 "Return non-nil if there is a non-comment non-macro punctuation character
1283 between FROM and TO. FROM must not be in a string or comment. The returned
1284 value is the position of the first such character."
1295 "Return non-nil if buffer positions FROM to TO cross one or more
1296 statement or declaration boundaries. The returned value is actually
1297 the position of the earliest boundary char. FROM must not be within
1298 a string or comment.
1300 The variable `c-maybe-labelp' is set to the position of the first `:' that
1301 might start a label (i.e. not part of `::' and not preceded by `?'). If a
1302 single `?' is found, then `c-maybe-labelp' is cleared.
1304 For AWK, a statement which is terminated by an EOL (not a ; or a }) is
1306 the line. If this virtual semicolon is _at_ from, the function recognizes it.
1308 Note that this function might do hidden buffer changes. See the
1309 comment at the start of cc-engine.el for more info."
1311 ;; If the current language has CPP macros, insert # into skip-chars.
1314 c-opt-cpp-symbol ; usually "#"
1316 c-stmt-delim-chars))
1319 lit-range lit-start vsemi-pos)
1326 skip-chars
1330 ;; Virtual semicolon?
1340 ;; In a string/comment?
1347 ;; Ignore scope operators.
1351 ;; A question mark. Can't be a label, so stop
1352 ;; looking for more : and ?.
1355 ;; At a CPP construct or a "#" or "##" operator?
1366 ;; In trailing space after an as yet undetected virtual semicolon?
1369 ; unterminated string/regexp.
1374 nil))))))
1377 "Return non-nil if the point is at the first token in a statement
1378 or somewhere in the syntactic whitespace before it.
1381 Any kind of declaration-like construct that occur outside function
1384 Note that this function might do hidden buffer changes. See the
1385 comment at the start of cc-engine.el for more info."
1389 c-maybe-labelp)
1400 "Return non-nil if the point is at the first token in an expression or
1401 statement, or somewhere in the syntactic whitespace before it.
1404 grammar sense: It's any sequence of expression tokens except commas,
1405 unless they are enclosed inside parentheses of some kind. Also, an
1406 expression never continues past an enclosing parenthesis, but it might
1407 contain parenthesis pairs of any sort except braces.
1409 Since expressions never cross statement boundaries, this function also
1410 recognizes statement beginnings, just like `c-at-statement-start-p'.
1412 Note that this function might do hidden buffer changes. See the
1413 comment at the start of cc-engine.el for more info."
1418 c-maybe-labelp)
1426 \f
1427 ;; A set of functions that covers various idiosyncrasies in
1428 ;; implementations of `forward-comment'.
1430 ;; Note: Some emacsen considers incorrectly that any line comment
1431 ;; ending with a backslash continues to the next line. I can't think
1432 ;; of any way to work around that in a reliable way without changing
1433 ;; the buffer, though. Suggestions welcome. ;) (No, temporarily
1434 ;; changing the syntax for backslash doesn't work since we must treat
1435 ;; escapes in string literals correctly.)
1438 "Move forward past whitespace and the closest following comment, if any.
1439 Return t if a comment was found, nil otherwise. In either case, the
1440 point is moved past the following whitespace. Line continuations,
1441 i.e. a backslashes followed by line breaks, are treated as whitespace.
1442 The line breaks that end line comments are considered to be the
1443 comment enders, so the point will be put on the beginning of the next
1444 line if it moved past a line comment.
1446 This function does not do any hidden buffer changes."
1454 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1455 ;; forwards at eob.
1456 nil
1458 ;; Emacs includes the ending newline in a b-style (c++)
1459 ;; comment, but XEmacs doesn't. We depend on the Emacs
1460 ;; behavior (which also is symmetric).
1464 t))))
1467 "Move forward past all following whitespace and comments.
1468 Line continuations, i.e. a backslashes followed by line breaks, are
1469 treated as whitespace.
1471 Note that this function might do hidden buffer changes. See the
1472 comment at the start of cc-engine.el for more info."
1475 ;; If forward-comment in at least XEmacs 21 is given a large
1476 ;; positive value, it'll loop all the way through if it hits
1477 ;; eob.
1479 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1480 ;; forwards at eob.
1485 t))))
1488 "Move backward past whitespace and the closest preceding comment, if any.
1489 Return t if a comment was found, nil otherwise. In either case, the
1490 point is moved past the preceding whitespace. Line continuations,
1491 i.e. a backslashes followed by line breaks, are treated as whitespace.
1492 The line breaks that end line comments are considered to be the
1493 comment enders, so the point cannot be at the end of the same line to
1494 move over a line comment.
1496 This function does not do any hidden buffer changes."
1499 ;; When we got newline terminated comments, forward-comment in all
1500 ;; supported emacsen so far will stop at eol of each line not
1501 ;; ending with a comment when moving backwards. This corrects for
1502 ;; that, and at the same time handles line continuations.
1510 ;; Some emacsen (e.g. Emacs 19.34) return t when moving
1511 ;; backwards at bob.
1512 nil
1514 ;; Leave point after the closest following newline if we've
1515 ;; backed up over any above, since forward-comment won't move
1516 ;; backward over a line comment if point is at the end of the
1517 ;; same line.
1522 ;; If forward-comment above succeeded and we're at eol
1523 ;; then the newline we moved over above didn't end a
1524 ;; line comment, so we give it another go.
1526 t))
1528 ;; Emacs <= 20 and XEmacs move back over the closer of a
1529 ;; block comment that lacks an opener.
1532 t)))))
1535 "Move backward past all preceding whitespace and comments.
1536 Line continuations, i.e. a backslashes followed by line breaks, are
1537 treated as whitespace. The line breaks that end line comments are
1538 considered to be the comment enders, so the point cannot be at the end
1539 of the same line to move over a line comment. Unlike
1540 c-backward-syntactic-ws, this function doesn't move back over
1541 preprocessor directives.
1543 Note that this function might do hidden buffer changes. See the
1544 comment at the start of cc-engine.el for more info."
1548 ;; `forward-comment' in some emacsen (e.g. XEmacs 21.4)
1549 ;; return t when moving backwards at bob.
1555 ;; Cope specifically with ^M^J here -
1556 ;; forward-comment sometimes gets stuck after ^Ms,
1557 ;; sometimes after ^M^J.
1561 t)
1565 t))))
1566 moved-comment)
1568 ;; Emacs <= 20 and XEmacs move back over the
1569 ;; closer of a block comment that lacks an opener.
1571 t)
1573 ;; XEmacs treats line continuations as whitespace but
1574 ;; only in the backward direction, which seems a bit
1575 ;; odd. Anyway, this is necessary for Emacs.
1580 t))))))
1582 \f
1583 ;; Tools for skipping over syntactic whitespace.
1585 ;; The following functions use text properties to cache searches over
1586 ;; large regions of syntactic whitespace. It works as follows:
1587 ;;
1588 ;; o If a syntactic whitespace region contains anything but simple
1589 ;; whitespace (i.e. space, tab and line breaks), the text property
1590 ;; `c-in-sws' is put over it. At places where we have stopped
1591 ;; within that region there's also a `c-is-sws' text property.
1592 ;; That since there typically are nested whitespace inside that
1593 ;; must be handled separately, e.g. whitespace inside a comment or
1594 ;; cpp directive. Thus, from one point with `c-is-sws' it's safe
1595 ;; to jump to another point with that property within the same
1596 ;; `c-in-sws' region. It can be likened to a ladder where
1597 ;; `c-in-sws' marks the bars and `c-is-sws' the rungs.
1598 ;;
1599 ;; o The `c-is-sws' property is put on the simple whitespace chars at
1600 ;; a "rung position" and also maybe on the first following char.
1601 ;; As many characters as can be conveniently found in this range
1602 ;; are marked, but no assumption can be made that the whole range
1603 ;; is marked (it could be clobbered by later changes, for
1604 ;; instance).
1605 ;;
1606 ;; Note that some part of the beginning of a sequence of simple
1607 ;; whitespace might be part of the end of a preceding line comment
1608 ;; or cpp directive and must not be considered part of the "rung".
1609 ;; Such whitespace is some amount of horizontal whitespace followed
1610 ;; by a newline. In the case of cpp directives it could also be
1611 ;; two newlines with horizontal whitespace between them.
1612 ;;
1613 ;; The reason to include the first following char is to cope with
1614 ;; "rung positions" that don't have any ordinary whitespace. If
1615 ;; `c-is-sws' is put on a token character it does not have
1616 ;; `c-in-sws' set simultaneously. That's the only case when that
1617 ;; can occur, and the reason for not extending the `c-in-sws'
1618 ;; region to cover it is that the `c-in-sws' region could then be
1619 ;; accidentally merged with a following one if the token is only
1620 ;; one character long.
1621 ;;
1622 ;; o On buffer changes the `c-in-sws' and `c-is-sws' properties are
1623 ;; removed in the changed region. If the change was inside
1624 ;; syntactic whitespace that means that the "ladder" is broken, but
1625 ;; a later call to `c-forward-sws' or `c-backward-sws' will use the
1626 ;; parts on either side and use an ordinary search only to "repair"
1627 ;; the gap.
1628 ;;
1629 ;; Special care needs to be taken if a region is removed: If there
1630 ;; are `c-in-sws' on both sides of it which do not connect inside
1631 ;; the region then they can't be joined. If e.g. a marked macro is
1632 ;; broken, syntactic whitespace inside the new text might be
1633 ;; marked. If those marks would become connected with the old
1634 ;; `c-in-sws' range around the macro then we could get a ladder
1635 ;; with one end outside the macro and the other at some whitespace
1636 ;; within it.
1637 ;;
1638 ;; The main motivation for this system is to increase the speed in
1639 ;; skipping over the large whitespace regions that can occur at the
1640 ;; top level in e.g. header files that contain a lot of comments and
1641 ;; cpp directives. For small comments inside code it's probably
1642 ;; slower than using `forward-comment' straightforwardly, but speed is
1643 ;; not a significant factor there anyway.
1645 ; (defface c-debug-is-sws-face
1646 ; '((t (:background "GreenYellow")))
1647 ; "Debug face to mark the `c-is-sws' property.")
1648 ; (defface c-debug-in-sws-face
1649 ; '((t (:underline t)))
1650 ; "Debug face to mark the `c-in-sws' property.")
1652 ; (defun c-debug-put-sws-faces ()
1653 ; ;; Put the sws debug faces on all the `c-is-sws' and `c-in-sws'
1654 ; ;; properties in the buffer.
1655 ; (interactive)
1656 ; (save-excursion
1657 ; (c-save-buffer-state (in-face)
1658 ; (goto-char (point-min))
1659 ; (setq in-face (if (get-text-property (point) 'c-is-sws)
1660 ; (point)))
1661 ; (while (progn
1662 ; (goto-char (next-single-property-change
1663 ; (point) 'c-is-sws nil (point-max)))
1664 ; (if in-face
1665 ; (progn
1666 ; (c-debug-add-face in-face (point) 'c-debug-is-sws-face)
1667 ; (setq in-face nil))
1668 ; (setq in-face (point)))
1669 ; (not (eobp))))
1670 ; (goto-char (point-min))
1671 ; (setq in-face (if (get-text-property (point) 'c-in-sws)
1672 ; (point)))
1673 ; (while (progn
1674 ; (goto-char (next-single-property-change
1675 ; (point) 'c-in-sws nil (point-max)))
1676 ; (if in-face
1677 ; (progn
1678 ; (c-debug-add-face in-face (point) 'c-debug-in-sws-face)
1679 ; (setq in-face nil))
1680 ; (setq in-face (point)))
1681 ; (not (eobp)))))))
1685 ;;`(message ,@args)
1686 )
1689 ;; This macro does a hidden buffer change.
1696 ;; This macro does a hidden buffer change.
1703 ;; This macro does a hidden buffer change.
1710 ;; This macro does a hidden buffer change.
1717 ;; This macro does a hidden buffer change.
1724 ;; The type of literal position `end' is in a `before-change-functions'
1725 ;; function - one of `c', `c++', `pound', or nil (but NOT `string').
1727 ;; A cons (START . STOP) of the bounds of the comment or CPP construct
1728 ;; enclosing END, if any, else nil.
1732 ;; Called from c-before-change. END is the end of the change region, the
1733 ;; standard parameter given to all before-change-functions.
1734 ;;
1735 ;; Note whether END is inside a comment or CPP construct, and if so note its
1736 ;; bounds in `c-sws-lit-limits' and type in `c-sws-lit-type'.
1744 c-sws-lit-limits limits))
1750 c-sws-lit-limits nil))))))
1753 ;; Text has been deleted, OLD-LEN characters of it starting from position
1754 ;; BEG. END is typically eq to BEG. Should there have been a comment or
1755 ;; CPP construct open at END before the deletion, check whether this
1756 ;; deletion deleted or "damaged" its opening delimiter. If so, return the
1757 ;; current position of where the construct ended, otherwise return nil.
1761 ; comment delimiters are 2
1762 ; chars long.
1772 ;; Text has been inserted, ending at buffer position END. Should there be a
1773 ;; literal or CPP construct open at END, check whether there are `c-in-sws'
1774 ;; or `c-is-sws' text properties inside this literal. If there are, return
1775 ;; the buffer position of the end of the literal, else return nil.
1794 ;; Called from `after-change-functions'. Remove any stale `c-in-sws' or
1795 ;; `c-is-sws' text properties from the vicinity of the change. BEG, END,
1796 ;; and OLD-LEN are the standard arguments given to after-change functions.
1797 ;;
1798 ;; Note that if `c-forward-sws' or `c-backward-sws' are used outside
1799 ;; `c-save-buffer-state' or similar then this will remove the cache
1800 ;; properties right after they're added.
1801 ;;
1802 ;; This function does hidden buffer changes.
1810 ;; Adjust the end to remove the properties in any following simple
1811 ;; ws up to and including the next line break, if there is any
1812 ;; after the changed region. This is necessary e.g. when a rung
1813 ;; marked empty line is converted to a line comment by inserting
1814 ;; "//" before the line break. In that case the line break would
1815 ;; keep the rung mark which could make a later `c-backward-sws'
1816 ;; move into the line comment instead of over it.
1826 ;; Ensure that an `c-in-sws' range gets broken. Note that it isn't
1827 ;; safe to keep a range that was continuous before the change. E.g:
1828 ;;
1829 ;; #define foo
1830 ;; \
1831 ;; bar
1832 ;;
1833 ;; There can be a "ladder" between "#" and "b". Now, if the newline
1834 ;; after "foo" is removed then "bar" will become part of the cpp
1835 ;; directive instead of a syntactically relevant token. In that
1836 ;; case there's no longer syntactic ws from "#" to "b".
1841 end))
1847 ;; Used by `c-forward-syntactic-ws' to implement the unbounded search.
1848 ;;
1849 ;; This function might do hidden buffer changes.
1852 ;; unmarked part of the simple ws region.
1854 rung-is-marked next-rung-is-marked simple-ws-end macro-start macro-end
1855 ;; `safe-start' is set when it's safe to cache the start position.
1856 ;; This is the case except when we have an unterminated block comment
1857 ;; within a macro.
1858 safe-start)
1860 ;; Skip simple ws and do a quick check on the following character to see
1861 ;; if it's anything that can't start syntactic ws, so we can bail out
1862 ;; early in the majority of cases when there just are a few ws chars.
1871 ;; Find the last rung position to avoid setting properties in all
1872 ;; the cases when the marked rung is complete.
1873 ;; (`next-single-property-change' is certain to move at least one
1874 ;; step forward.)
1877 ;; Got no marked rung here. Since the simple ws might have started
1878 ;; inside a line comment or cpp directive we must set `rung-pos' as
1879 ;; high as possible.
1885 ;; In the following while form, we move over a "ladder" and
1886 ;; following simple WS each time round the loop, appending the WS
1887 ;; onto the ladder, joining adjacent ladders, and terminating when
1888 ;; there is no more WS or we reach EOB.
1893 ;; The following search is the main reason that `c-in-sws'
1894 ;; and `c-is-sws' aren't combined to one property.
1898 ;; If the `c-in-sws' region extended past the last
1899 ;; `c-is-sws' char we have to go back a bit.
1906 "c-forward-sws cached move %s -> %s (max %s)"
1913 ;; We'll loop here if there is simple ws after the last rung.
1914 ;; That means that there's been some change in it and it's
1915 ;; possible that we've stepped into another ladder, so extend
1916 ;; the previous one to join with it if there is one, and try to
1917 ;; use the cache again.
1919 "c-forward-sws extending rung with [%s..%s] (max %s)"
1922 ;; Remove any `c-in-sws' property from the last char of
1923 ;; the rung before we mark it with `c-is-sws', so that we
1924 ;; won't connect with the remains of a broken "ladder".
1930 last-put-in-sws-pos rung-pos)))
1932 ;; Now move over any comments (x)or a CPP construct.
1935 ;; Take elaborate precautions to detect an open block comment at
1936 ;; the end of a macro. If we find one, we set `safe-start' to nil
1937 ;; and break off any further scanning of comments.
1959 safe-start)))
1964 ;; Skipped over comments. Don't cache at eob in case the buffer
1965 ;; is narrowed.
1977 ;; Skip a preprocessor directive.
1983 ;; Check for an open block comment at the end of the macro.
1989 ;; Don't cache at eob in case the buffer is narrowed.
1994 ;; Skip over a noise macro.
1998 ;; We've searched over a piece of non-white syntactic ws. See if this
1999 ;; can be cached.
2005 ;; Cache if we haven't skipped comments only, and if we started
2006 ;; either from a marked rung or from a completely uncached
2007 ;; position.
2012 ;; See if there's a marked rung in the encountered simple ws. If
2013 ;; so then we can cache, unless `safe-start' is nil. Even then
2014 ;; we need to do this to check if the cache can be used for the
2015 ;; next step.
2019 safe-start))
2023 "c-forward-sws caching [%s..%s] - [%s..%s] (max %s)"
2027 ;; Remove the properties for any nested ws that might be cached.
2028 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
2029 ;; anyway.
2037 last-put-in-sws-pos rung-pos))
2039 ;; Remove any `c-in-sws' property from the last char of
2040 ;; the rung before we mark it with `c-is-sws', so that we
2041 ;; won't connect with the remains of a broken "ladder".
2044 rung-end-pos))
2047 "c-forward-sws not caching [%s..%s] - [%s..%s] (max %s)"
2051 ;; Set `rung-pos' for the next rung. It's the same thing here as
2052 ;; initially, except that the rung position is set as early as
2053 ;; possible since we can't be in the ending ws of a line comment or
2054 ;; cpp directive now.
2060 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
2061 ;; another one after the point (which might occur when editing inside a
2062 ;; comment or macro).
2066 "c-forward-sws clearing at %s for cache separation"
2067 last-put-in-sws-pos)
2071 ;; If at eob we have to clear the last character before the end
2072 ;; instead since the buffer might be narrowed and there might
2073 ;; be a `c-in-sws' after (point-max). In this case it's
2074 ;; necessary to clear both properties.
2076 "c-forward-sws clearing thoroughly at %s for cache separation"
2079 last-put-in-sws-pos))))
2080 ))))
2083 ;; Used by `c-backward-syntactic-ws' to implement the unbounded search.
2084 ;;
2085 ;; This function might do hidden buffer changes.
2088 ;; part of the simple ws region.
2090 rung-is-marked simple-ws-beg cmt-skip-pos)
2092 ;; Skip simple horizontal ws and do a quick check on the preceding
2093 ;; character to see if it's anything that can't end syntactic ws, so we can
2094 ;; bail out early in the majority of cases when there just are a few ws
2095 ;; chars. Newlines are complicated in the backward direction, so we can't
2096 ;; skip over them.
2106 ;; Try to find a rung position in the simple ws preceding point, so that
2107 ;; we can get a cache hit even if the last bit of the simple ws has
2108 ;; changed recently.
2114 ;; `rung-pos' will be the earliest marked position, which means that
2115 ;; there might be later unmarked parts in the simple ws region.
2116 ;; It's not worth the effort to fix that; the last part of the
2117 ;; simple ws is also typically edited often, so it could be wasted.
2124 ;; Each time round the next while form, we move back over a ladder
2125 ;; and append any simple WS preceding it, if possible joining with
2126 ;; the previous ladder.
2132 ;; The following search is the main reason that `c-in-sws'
2133 ;; and `c-is-sws' aren't combined to one property.
2137 ;; If the `c-in-sws' region extended past the first
2138 ;; `c-is-sws' char we have to go forward a bit.
2143 "c-backward-sws cached move %s <- %s (min %s)"
2155 t
2157 nil))
2159 ;; We'll loop here if there is simple ws before the first rung.
2160 ;; That means that there's been some change in it and it's
2161 ;; possible that we've stepped into another ladder, so extend
2162 ;; the previous one to join with it if there is one, and try to
2163 ;; use the cache again.
2165 "c-backward-sws extending rung with [%s..%s] (min %s)"
2168 ;; Remove any `c-in-sws' property from the last char of
2169 ;; the rung before we mark it with `c-is-sws', so that we
2170 ;; won't connect with the remains of a broken "ladder".
2173 rung-pos)
2177 last-put-in-sws-pos rung-pos))
2186 ;; Inside a cpp directive. See if it should be skipped over.
2189 ;; Move back over all line continuations in the region skipped
2190 ;; over by `c-backward-comments'. If we go past it then we
2191 ;; started inside the cpp directive.
2200 ;; Don't move past the cpp directive if we began inside
2201 ;; it. Note that the position at the end of the last line
2202 ;; of the macro is also considered to be within it.
2204 nil)
2206 ;; It's worthwhile to spend a little bit of effort on finding
2207 ;; the end of the macro, to get a good `simple-ws-beg'
2208 ;; position for the cache. Note that `c-backward-comments'
2209 ;; could have stepped over some comments before going into
2210 ;; the macro, and then `simple-ws-beg' must be kept on the
2211 ;; same side of those comments.
2218 ;; Might happen if comments after the macro were skipped
2219 ;; over.
2223 t)))
2228 simple-ws-beg)
2229 ;; Skipped over comments. Must put point at the end of
2230 ;; the simple ws at point since we might be after a line
2231 ;; comment or cpp directive that's been partially
2232 ;; narrowed out, and we can't risk marking the simple ws
2233 ;; at the end of it.
2235 t)
2242 ;; Skipped over a noise macro
2244 t)))
2246 ;; We've searched over a piece of non-white syntactic ws. See if this
2247 ;; can be cached.
2252 ;; Cache if we started either from a marked rung or from a
2253 ;; completely uncached position.
2254 rung-is-marked
2257 ;; Cache if there's a marked rung in the encountered simple ws.
2265 "c-backward-sws caching [%s..%s] - [%s..%s] (min %s)"
2270 ;; Remove the properties for any nested ws that might be cached.
2271 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
2272 ;; anyway.
2277 ;; Remove any `c-in-sws' property from the last char of
2278 ;; the rung before we mark it with `c-is-sws', so that we
2279 ;; won't connect with the remains of a broken "ladder".
2282 rung-end-pos)
2285 last-put-in-sws-pos simple-ws-beg)
2286 rung-pos)
2291 "c-backward-sws not caching [%s..%s] - [%s..%s] (min %s)"
2297 ))
2299 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
2300 ;; another one before the point (which might occur when editing inside a
2301 ;; comment or macro).
2305 "c-backward-sws clearing at %s for cache separation"
2308 last-put-in-sws-pos))
2310 ;; If at bob and the buffer is narrowed, we have to clear the
2311 ;; character we're standing on instead since there might be a
2312 ;; `c-in-sws' before (point-min). In this case it's necessary
2313 ;; to clear both properties.
2315 "c-backward-sws clearing thoroughly at %s for cache separation"
2316 last-put-in-sws-pos)
2319 ))))
2321 \f
2322 ;; Other whitespace tools
2324 ;; Is the region (beg end) WS, and is there WS (or BOB/EOB) next to the
2325 ;; region? This is a "heuristic" function. .....
2326 ;;
2327 ;; The motivation for the second bit is to check whether removing this
2328 ;; region would coalesce two symbols.
2329 ;;
2330 ;; FIXME!!! This function doesn't check virtual semicolons in any way. Be
2331 ;; careful about using this function for, e.g. AWK. (2007/3/7)
2340 \f
2341 ;; A system for finding noteworthy parens before the point.
2344 ;; A maximum comfortable scanning distance, e.g. between
2345 ;; `c-state-cache-good-pos' and "HERE" (where we call c-parse-state). When
2346 ;; this distance is exceeded, we take "emergency measures", e.g. by clearing
2347 ;; the cache and starting again from point-min or a beginning of defun. This
2348 ;; value can be tuned for efficiency or set to a lower value for testing.
2352 ;; The state cache used by `c-parse-state' to cut down the amount of
2353 ;; searching. It's the result from some earlier `c-parse-state' call. See
2354 ;; `c-parse-state''s doc string for details of its structure.
2355 ;;
2356 ;; The use of the cached info is more effective if the next
2357 ;; `c-parse-state' call is on a line close by the one the cached state
2358 ;; was made at; the cache can actually slow down a little if the
2359 ;; cached state was made very far back in the buffer. The cache is
2360 ;; most effective if `c-parse-state' is used on each line while moving
2361 ;; forward.
2365 ;; This is a position where `c-state-cache' is known to be correct, or
2366 ;; nil (see below). It's a position inside one of the recorded unclosed
2367 ;; parens or the top level, but not further nested inside any literal or
2368 ;; subparen that is closed before the last recorded position.
2369 ;;
2370 ;; The exact position is chosen to try to be close to yet earlier than
2371 ;; the position where `c-state-cache' will be called next. Right now
2372 ;; the heuristic is to set it to the position after the last found
2373 ;; closing paren (of any type) before the line on which
2374 ;; `c-parse-state' was called. That is chosen primarily to work well
2375 ;; with refontification of the current line.
2376 ;;
2377 ;; 2009-07-28: When `c-state-point-min' and the last position where
2378 ;; `c-parse-state' or for which `c-invalidate-state-cache' was called, are
2379 ;; both in the same literal, there is no such "good position", and
2380 ;; c-state-cache-good-pos is then nil. This is the ONLY circumstance in which
2381 ;; it can be nil. In this case, `c-state-point-min-literal' will be non-nil.
2382 ;;
2383 ;; 2009-06-12: In a brace desert, c-state-cache-good-pos may also be in
2384 ;; the middle of the desert, as long as it is not within a brace pair
2385 ;; recorded in `c-state-cache' or a paren/bracket pair.
2387 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2388 ;; We maintain a simple cache of positions which aren't in a literal, so as to
2389 ;; speed up testing for non-literality.
2391 ;; The approximate interval between entries in `c-state-nonlit-pos-cache'.
2395 ;; A list of buffer positions which are known not to be in a literal or a cpp
2396 ;; construct. This is ordered with higher positions at the front of the list.
2397 ;; Only those which are less than `c-state-nonlit-pos-cache-limit' are valid.
2401 ;; An upper limit on valid entries in `c-state-nonlit-pos-cache'. This is
2402 ;; reduced by buffer changes, and increased by invocations of
2403 ;; `c-state-literal-at'.
2407 ;; A list of elements which are either buffer positions (when such positions
2408 ;; are not in literals) or lists of the form (POS TYPE START), where POS is
2409 ;; a buffer position inside a literal, TYPE is the type of the literal
2410 ;; ('string, 'c, or 'c++) and START is the start of the literal.
2414 ;; An upper limit on valid entries in `c-state-semi-nonlit-pos-cache'. This
2415 ;; is reduced by buffer changes, and increased by invocations of
2416 ;; `c-parse-ps-state-below'.
2419 ;; Truncate the upper bound of the cache `c-state-semi-nonlit-pos-cache' to
2420 ;; POS, if it is higher than that position.
2425 ;; Do a parse-partial-sexp from a position in the buffer before HERE which
2426 ;; isn't in a literal, and return information about HERE, either:
2427 ;; (STATE TYPE BEG) if HERE is in a literal; or
2428 ;; (STATE) otherwise,
2429 ;; where STATE is the parsing state at HERE, TYPE is the type of the literal
2430 ;; enclosing HERE, (one of 'string, 'c, 'c++) and BEG is the starting
2431 ;; position of that literal (including the delimiter).
2432 ;;
2433 ;; Unless NOT-IN-DELIMITER is non-nil, when TO is inside a two-character
2434 ;; comment opener, this is recognized as being in a comment literal.
2435 ;;
2436 ;; Only elements 3 (in a string), 4 (in a comment), 5 (following a quote), 7
2437 ;; (comment type), and 8 (start of comment/string), and possibly 10 (in
2438 ;; newer Emacsen only, the syntax of a position after a potential first char
2439 ;; of a two char construct) of STATE are valid.
2448 ty)
2471 ;; This function will supersede c-state-pp-to-literal.
2472 ;;
2473 ;; Do a parse-partial-sexp from a position in the buffer before HERE which
2474 ;; isn't in a literal, and return information about HERE, either:
2475 ;; (STATE TYPE (BEG . END)) if HERE is in a literal; or
2476 ;; (STATE) otherwise,
2477 ;; where STATE is the parsing state at HERE, TYPE is the type of the literal
2478 ;; enclosing HERE, (one of 'string, 'c, 'c++) and (BEG . END) is the
2479 ;; boundaries of that literal (including the delimiters).
2480 ;;
2481 ;; Unless NOT-IN-DELIMITER is non-nil, when TO is inside a two-character
2482 ;; comment opener, this is recognized as being in a comment literal.
2483 ;;
2484 ;; Only elements 3 (in a string), 4 (in a comment), 5 (following a quote), 7
2485 ;; (comment type), and 8 (start of comment/string), and possibly 10 (in
2486 ;; newer Emacsen only, the syntax of a position after a potential first char
2487 ;; of a two char construct) of STATE are valid.
2496 ty start)
2507 nil ; TARGETDEPTH
2508 nil ; STOPBEFORE
2509 s ; OLDSTATE
2527 ;; Do a parse-partial-sexp from FROM to TO, returning either
2528 ;; (STATE TYPE (BEG . END)) if TO is in a literal; or
2529 ;; (STATE) otherwise,
2530 ;; where STATE is the parsing state at TO, TYPE is the type of the literal
2531 ;; (one of 'c, 'c++, 'string) and (BEG . END) is the boundaries of the literal,
2532 ;; including the delimiters.
2533 ;;
2534 ;; Unless NOT-IN-DELIMITER is non-nil, when TO is inside a two-character
2535 ;; comment opener, this is recognized as being in a comment literal.
2536 ;;
2537 ;; Only elements 3 (in a string), 4 (in a comment), 5 (following a quote),
2538 ;; 7 (comment type) and 8 (start of comment/string) (and possibly 9) of
2539 ;; STATE are valid.
2543 ty co-st)
2553 nil ; TARGETDEPTH
2554 nil ; STOPBEFORE
2555 s ; OLDSTATE
2572 ;; Create a list suitable to use as the old-state parameter to
2573 ;; `parse-partial-sexp', out of ELT, a member of
2574 ;; `c-state-semi-nonlit-pos-cache'. ELT is either just a number, or a list
2575 ;; with 2, 3, or 4 members (See `c-parse-ps-state-to-cache'). That number
2576 ;; or the car of the list is the "position element" of ELT, the position
2577 ;; where ELT is valid.
2578 ;;
2579 ;; POINT is left at the position for which the returned state is valid. It
2580 ;; will be either the position element of ELT, or one character before
2581 ;; that. (The latter happens in Emacs <= 25 and XEmacs, when ELT indicates
2582 ;; its position element directly follows a potential first character of a
2583 ;; two char construct (such as a comment opener or an escaped character).)
2585 ;; Inside a string or comment
2600 elt)))
2605 in-string in-comment after-quote
2606 min-depth com-style com-str-start
2607 intermediate char-1))
2610 pos))
2612 in-string in-comment nil
2613 min-depth com-style com-str-start
2614 intermediate)))
2616 ;; Not in a string or comment.
2622 0 nil nil nil
2627 nil
2631 ;; Convert STATE, a `parse-partial-sexp' state valid at POINT, to an element
2632 ;; for the `c-state-semi-nonlit-pos-cache' cache. This is one of
2633 ;; o - POINT (when point is not in a literal);
2634 ;; o - (POINT CHAR-1) (when the last character before point is potentially
2635 ;; the first of a two-character construct
2636 ;; o - (POINT TYPE STARTING-POS) (when in a literal);
2637 ;; o - (POINT TYPE STARTING-POS CHAR-1) (Combination of the previous two),
2638 ;; where TYPE is the type of the literal (either 'c, or 'c++, or the
2639 ;; character which closes the string), STARTING-POS is the starting
2640 ;; position of the comment or string. CHAR-1 is either the character
2641 ;; potentially forming the first half of a two-char construct (in Emacs <=
2642 ;; 25 and XEmacs) or the syntax of the character (in Emacs >= 26).
2644 ;; Emacs >= 26.
2658 basic
2661 basic))
2663 ;; Emacs <= 25, XEmacs.
2676 ?*)
2685 ;; Get the buffer position from ELT, an element from the cache
2686 ;; `c-state-semi-nonlit-pos-cache'.
2688 elt
2692 ;; Given a buffer position HERE, Return a cons (CACHE-POS . STATE), where
2693 ;; CACHE-POS is a position not very far before HERE for which the
2694 ;; parse-partial-sexp STATE is valid. Note that the only valid elements of
2695 ;; STATE are those concerning comments and strings; STATE is the state of a
2696 ;; null `parse-partial-sexp' scan when CACHE-POS is not in a comment or
2697 ;; string.
2702 elt state npos high-elt)
2703 ;; Trim the cache to take account of buffer changes.
2705 c-state-semi-nonlit-pos-cache-limit))
2720 ;; We need to extend the cache. Add an element to
2721 ;; `c-state-semi-nonlit-pos-cache' each iteration of the following.
2735 ;; Return a buffer position before HERE which is "safe", i.e. outside any
2736 ;; string, comment, or macro.
2737 ;;
2738 ;; NOTE: This function manipulates `c-state-nonlit-pos-cache'. This cache
2739 ;; MAY NOT contain any positions within macros, since macros are frequently
2740 ;; turned into comments by use of the `c-cpp-delimiter' category properties.
2741 ;; We cannot rely on this mechanism whilst determining a cache pos since
2742 ;; this function is also called from outwith `c-parse-state'.
2747 pos npos high-pos lit macro-beg macro-end)
2748 ;; Trim the cache to take account of buffer changes.
2760 ;; Add an element to `c-state-nonlit-pos-cache' each iteration.
2766 ;; Test for being in a literal. If so, go to after it.
2773 ;; Test for being in a macro. If so, go to after it.
2788 ;; Add one extra element above HERE so as to avoid the previous
2789 ;; expensive calculation when the next call is close to the current
2790 ;; one. This is especially useful when inside a large macro.
2797 pos))))
2800 ;; If position HERE is inside a literal, return (START . END), the
2801 ;; boundaries of the literal (which may be outside the accessible bit of the
2802 ;; buffer). Otherwise, return nil.
2803 ;;
2804 ;; This function is almost the same as `c-literal-limits'. Previously, it
2805 ;; differed in that it was a lower level function, and that it rigorously
2806 ;; followed the syntax from BOB. `c-literal-limits' is now (2011-12)
2807 ;; virtually identical to this function.
2815 ;; Return the start of the literal containing POS, or POS itself.
2817 pos))
2820 ;; Return a position outside of a string/comment/macro at or before POS.
2821 ;; STATE is the parse-partial-sexp state at POS.
2826 pos)))
2831 res))))
2833 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2834 ;; Stuff to do with point-min, and coping with any literal there.
2837 ;; This is (point-min) when `c-state-cache' was last calculated. A change of
2838 ;; narrowing is likely to affect the parens that are visible before the point.
2844 ;; These two variables define the literal, if any, containing point-min.
2845 ;; Their values are, respectively, 'string, c, or c++, and the start of the
2846 ;; literal. If there's no literal there, they're both nil.
2850 ;; This is the earliest buffer-pos from which scanning can be done. It is
2851 ;; either the end of the literal containing point-min, or point-min itself.
2852 ;; It becomes nil if the buffer is changed earlier than this point.
2854 ;; Return the lowest valid scanning pos. This will be the end of the
2855 ;; literal enclosing point-min, or point-min itself.
2867 ;; Determine the properties of any literal containing POINT-MIN, setting the
2868 ;; variables `c-state-point-min-lit-type', `c-state-point-min-lit-start',
2869 ;; and `c-state-min-scan-pos' accordingly. The return value is meaningless.
2871 lit)
2886 c-state-point-min-lit-start nil
2887 c-state-min-scan-pos p-min)))))
2890 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2891 ;; A variable which signals a brace dessert - helpful for reducing the number
2892 ;; of fruitless backward scans.
2895 ;; Used only in `c-append-lower-brace-pair-to-state-cache'. It is set when
2896 ;; that defun has searched backwards for a brace pair and not found one. Its
2897 ;; value is either nil or a cons (PA . FROM), where PA is the position of the
2898 ;; enclosing opening paren/brace/bracket which bounds the backwards search (or
2899 ;; nil when at top level) and FROM is where the backward search started. It
2900 ;; is reset to nil in `c-invalidate-state-cache'.
2903 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2904 ;; Lowish level functions/macros which work directly on `c-state-cache', or a
2905 ;; list of like structure.
2907 ;; Return the address of the top left brace/bracket/paren recorded in CACHE
2908 ;; (default `c-state-cache') (or nil).
2915 ;; Return the address of the latest brace/bracket/paren (whether left or
2916 ;; right) recorded in CACHE (default `c-state-cache') or nil.
2923 ;; Return the position just after the latest brace/bracket/paren (whether
2924 ;; left or right) recorded in CACHE (default `c-state-cache') or nil.
2932 ;; From the state-cache, determine the buffer position from which we might
2933 ;; scan forward to HERE to update this cache. This position will be just
2934 ;; after a paren/brace/bracket recorded in the cache, if possible, otherwise
2935 ;; return the earliest position in the accessible region which isn't within
2936 ;; a literal. If the visible portion of the buffer is entirely within a
2937 ;; literal, return NIL.
2939 ;(while (>= (or (c-state-cache-top-lparen c) 1) here)
2955 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2956 ;; Variables which keep track of preprocessor constructs.
2965 ;; These are the limits of the macro containing point at the previous call of
2966 ;; `c-parse-state', or nil.
2968 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2969 ;; Defuns which analyze the buffer, yet don't change `c-state-cache'.
2971 ;; Return a start position for building `c-state-cache' from
2972 ;; scratch. This will be at the top level, 2 defuns back.
2974 ;; Go back 2 bods, but ignore any bogus positions returned by
2975 ;; beginning-of-defun (i.e. open paren in column zero).
2985 ;; Return the position of the opening paren/brace/bracket before HERE- which
2986 ;; matches the outermost close p/b/b between HERE+ and TOP. Except when
2987 ;; there's a macro, HERE- and HERE+ are the same. Like this:
2988 ;;
2989 ;; ............................................
2990 ;; | |
2991 ;; ( [ ( .........#macro.. ) ( ) ] )
2992 ;; ^ ^ ^ ^
2993 ;; | | | |
2994 ;; return HERE- HERE+ TOP
2995 ;;
2996 ;; If there aren't enough opening paren/brace/brackets, return the position
2997 ;; of the outermost one found, or HERE- if there are none. If there are no
2998 ;; closing p/b/bs between HERE+ and TOP, return HERE-. HERE-/+ and TOP
2999 ;; must not be inside literals. Only the accessible portion of the buffer
3000 ;; will be scanned.
3002 ;; PART 1: scan from `here+' up to `top', accumulating ")"s which enclose
3003 ;; `here'. Go round the next loop each time we pass over such a ")". These
3004 ;; probably match "("s before `here-'.
3016 ;; PART 2: Scan back before `here-' searching for the "("s
3017 ;; matching/mismatching the ")"s found above. We only need to direct the
3018 ;; caller to scan when we've encountered unmatched right parens.
3027 pos))
3030 ;; Determine the scanning strategy for adjusting `c-parse-state', attempting
3031 ;; to minimize the amount of scanning. HERE is the pertinent position in
3032 ;; the buffer, GOOD-POS is a position where `c-state-cache' (possibly with
3033 ;; its head trimmed) is known to be good, or nil if there is no such
3034 ;; position.
3035 ;;
3036 ;; The return value is a list, one of the following:
3037 ;;
3038 ;; o - ('forward START-POINT) - scan forward from START-POINT,
3039 ;; which is not less than the highest position in `c-state-cache' below HERE,
3040 ;; which is after GOOD-POS.
3041 ;; o - ('backward nil) - scan backwards (from HERE).
3042 ;; o - ('back-and-forward START-POINT) - like 'forward, but when HERE is earlier
3043 ;; than GOOD-POS.
3044 ;; o - ('BOD START-POINT) - scan forwards from START-POINT, which is at the
3045 ;; top level.
3046 ;; o - ('IN-LIT nil) - point is inside the literal containing point-min.
3056 in-macro-start))
3060 BOD-pos ; position of 2nd BOD before HERE.
3061 strategy ; 'forward, 'backward, 'BOD, or 'IN-LIT.
3062 start-point
3068 start-point nil
3069 cache-pos nil
3074 cache-pos
3082 start-point cache-pos
3085 ;; Might we be better off starting from the top level, two defuns back,
3086 ;; instead? This heuristic no longer works well in C++, where
3087 ;; declarations inside namespace brace blocks are frequently placed at
3088 ;; column zero. (2015-11-10): Remove the condition on C++ Mode.
3090 open-paren-in-column-0-is-defun-start)
3091 ;; (not (c-major-mode-is 'c++-mode))
3096 start-point BOD-pos)))
3101 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3102 ;; Routines which change `c-state-cache' and associated values.
3104 ;; The region (more precisely, point-min) has changed since we
3105 ;; calculated `c-state-cache'. Amend `c-state-cache' accordingly.
3107 ;; If point-min has MOVED BACKWARDS then we drop the state completely.
3108 ;; It would be possible to do a better job here and recalculate the top
3109 ;; only.
3113 c-state-cache-good-pos c-state-min-scan-pos
3114 c-state-brace-pair-desert nil))
3116 ;; point-min has MOVED FORWARD.
3118 ;; Is the new point-min inside a (different) literal?
3123 ;; Cut off a bit of the tail from `c-state-cache'.
3125 pa)
3134 ; inside a recorded
3135 ; brace pair.
3137 c-state-cache-good-pos c-state-min-scan-pos)
3140 )))
3145 ;; If there is a brace pair preceding FROM in the buffer, at the same level
3146 ;; of nesting (not necessarily immediately preceding), push a cons onto
3147 ;; `c-state-cache' to represent it. FROM must not be inside a literal. If
3148 ;; UPPER-LIM is non-nil, we append the highest brace pair whose "}" is below
3149 ;; UPPER-LIM.
3150 ;;
3151 ;; Return non-nil when this has been done.
3152 ;;
3153 ;; The situation it copes with is this transformation:
3154 ;;
3155 ;; OLD: { (.) {...........}
3156 ;; ^ ^
3157 ;; FROM HERE
3158 ;;
3159 ;; NEW: { {....} (.) {.........
3160 ;; ^ ^ ^
3161 ;; LOWER BRACE PAIR HERE or HERE
3162 ;;
3163 ;; This routine should be fast. Since it can get called a LOT, we maintain
3164 ;; `c-state-brace-pair-desert', a small cache of "failures", such that we
3165 ;; reduce the time wasted in repeated fruitless searches in brace deserts.
3175 ;; Don't start scanning in the middle of a CPP construct unless
3176 ;; it contains HERE - these constructs, in Emacs, are "commented
3177 ;; out" with category properties.
3180 macro-start-or-from
3181 from))
3185 ;; If we're essentially repeating a fruitless search, just give up.
3191 ;; DESERT-LIM. Avoid repeated searching through the cached desert.
3197 ;; CACHE-LIM. This limit will be necessary when an opening
3198 ;; paren at `cache-pos' has just had its matching close paren
3199 ;; inserted into the buffer. `cache-pos' continues to be a
3200 ;; search bound, even though the algorithm below would skip
3201 ;; over the new paren pair.
3210 ;; The top limit is EOB to ensure that `bra' is inside the
3211 ;; accessible part of the buffer at the next scan operation.
3214 ;; In the next pair of nested loops, the inner one moves back past a
3215 ;; pair of (mis-)matching parens or brackets; the outer one moves
3216 ;; back over a sequence of unmatched close brace/paren/bracket each
3217 ;; time round.
3233 ; brace, ignore it.
3236 ;; We've found the desired brace-pair.
3248 ;; We haven't found a brace pair. Record this in the cache.
3251 bra
3256 ;; If BRA+1 is nil, do nothing. Otherwise, BRA+1 is the buffer position
3257 ;; following a {, and that brace has a (mis-)matching } (or ]), and we
3258 ;; "push" "a" brace pair onto `c-state-cache'.
3259 ;;
3260 ;; Here "push" means overwrite the top element if it's itself a brace-pair,
3261 ;; otherwise push it normally.
3262 ;;
3263 ;; The brace pair we push is normally the one surrounding BRA+1, but if the
3264 ;; latter is inside a macro, not being a macro containing
3265 ;; MACRO-START-OR-HERE, we scan backwards through the buffer for a non-macro
3266 ;; base pair. This latter case is assumed to be rare.
3267 ;;
3268 ;; Note: POINT is not preserved in this routine.
3278 c-state-cache)))
3279 ;; N.B. This defsubst codes one method for the simple, normal case,
3280 ;; and a more sophisticated, slower way for the general case. Don't
3281 ;; eliminate this defsubst - it's a speed optimization.
3285 ;; Scan the buffer from FROM to HERE, adding elements into `c-state-cache'
3286 ;; for braces etc. Return a candidate for `c-state-cache-good-pos'.
3287 ;;
3288 ;; FROM must be after the latest brace/paren/bracket in `c-state-cache', if
3289 ;; any. Typically, it is immediately after it. It must not be inside a
3290 ;; literal.
3296 here)))
3299 ; Is actually the pos. to scan for a (/{/[ from,
3300 ; which sometimes is after a silly )/}/].
3303 ; good-pos.
3310 ;; Each time round the following loop, we enter a successively deeper
3311 ;; level of brace/paren nesting. (Except sometimes we "continue at
3312 ;; the existing level".) `pa+1' is a pos inside an opening
3313 ;; brace/paren/bracket, usually just after it.
3316 ;; Each time round the next loop moves forward over an opening then
3317 ;; a closing brace/bracket/paren. This loop is white hot, so it
3318 ;; plays ugly tricks to go fast. DON'T PUT ANYTHING INTO THIS
3319 ;; LOOP WHICH ISN'T ABSOLUTELY NECESSARY!!! It terminates when a
3320 ;; call of `scan-lists' signals an error, which happens when there
3321 ;; are no more b/b/p's to scan.
3332 ;; We've just entered a deeper nesting level.
3334 ;; Insert the brace pair (if present) and the single open
3335 ;; paren/brace/bracket into `c-state-cache' It cannot be
3336 ;; inside a macro, except one around point, because of what
3337 ;; `c-neutralize-syntax-in-CPP' has done.
3339 ;; Insert the opening brace/bracket/paren position.
3341 ;; Clear admin stuff for the next more nested part of the scan.
3345 ;; All open p/b/b's at this nesting level, if any, have probably
3346 ;; been closed by matching/mismatching ones. We're probably
3347 ;; finished - we just need to check for having found an
3348 ;; unmatched )/}/], which we ignore. Such a )/}/] can't be in a
3349 ;; macro, due the action of `c-neutralize-syntax-in-CPP'.
3352 ;; Record the final, innermost, brace-pair if there is one.
3355 ;; Determine a good pos
3363 here-bol))
3372 ;; Remove stale entries from the `c-cache-state', i.e. those which will
3373 ;; not be in it when it is amended for position HERE. This may involve
3374 ;; replacing a CONS element for a brace pair containing HERE with its car.
3375 ;; Additionally, the "outermost" open-brace entry before HERE will be
3376 ;; converted to a cons if the matching close-brace is below HERE.
3377 ;;
3378 ;; START-POINT is a "maximal" "safe position" - there must be no open
3379 ;; parens/braces/brackets between START-POINT and HERE.
3380 ;;
3381 ;; As a second thing, calculate the result of parse-partial-sexp at
3382 ;; PPS-POINT, w.r.t. START-POINT. The motivation here is that
3383 ;; `c-state-cache-good-pos' may become PPS-POINT, but the caller may need to
3384 ;; adjust it to get outside a string/comment. (Sorry about this! The code
3385 ;; needs to be FAST).
3386 ;;
3387 ;; Return a list (GOOD-POS SCAN-BACK-POS CONS-SEPARATED PPS-STATE), where
3388 ;; o - GOOD-POS is a position where the new value `c-state-cache' is known
3389 ;; to be good (we aim for this to be as high as possible);
3390 ;; o - SCAN-BACK-POS, if not nil, indicates there may be a brace pair
3391 ;; preceding POS which needs to be recorded in `c-state-cache'. It is a
3392 ;; position to scan backwards from. It is the position of the "{" of the
3393 ;; last element to be removed from `c-state-cache', when that elt is a
3394 ;; cons, otherwise nil.
3395 ;; o - CONS-SEPARATED is t when a cons element in `c-state-cache' has been
3396 ;; replaced by its car because HERE lies inside the brace pair represented
3397 ;; by the cons.
3398 ;; o - PPS-STATE is the parse-partial-sexp state at PPS-POINT.
3408 ; start-point or nil
3415 ; HERE), or nil.
3421 pps-state ; Will be 9 or 10 elements long.
3422 pos
3423 upper-lim ; ,beyond which `c-state-cache' entries are removed
3424 scan-back-pos
3425 cons-separated
3426 pair-beg target-depth)
3428 ;; Remove entries beyond HERE. Also remove any entries inside
3429 ;; a macro, unless HERE is in the same macro.
3434 here
3440 ;; If `upper-lim' is inside the last recorded brace pair, remove its
3441 ;; RBrace and indicate we'll need to search backwards for a previous
3442 ;; brace pair.
3448 cons-separated t))
3450 ;; The next loop jumps forward out of a nested level of parens each
3451 ;; time round; the corresponding elements in `c-state-cache' are
3452 ;; removed. `pos' is just after the brace-pair or the open paren at
3453 ;; (car c-state-cache). There can be no open parens/braces/brackets
3454 ;; between `start-point'/`start-point-actual-macro-start' and HERE,
3455 ;; due to the interface spec to this function.
3458 in-macro-start)))
3460 ; marked by a `category' text property.
3461 start-point))
3472 ;; Do nothing when we've merely reached pps-point.
3473 )
3475 ;; Scan!
3479 target-depth
3480 nil pps-state))
3487 ;; We've just moved out of the paren pair containing the brace-pair
3488 ;; at (car c-state-cache). `pair-beg' is where the open paren is,
3489 ;; and is potentially where the open brace of a cons in
3490 ;; c-state-cache will be.
3496 ; containing Lparen
3500 ; together with enclosed brace pair.
3501 ;; (t nil) ; Ignore an unmated Rparen.
3502 )))
3507 nil nil ; TARGETDEPTH, STOPBEFORE
3508 pps-state)))
3510 ;; If the last paren pair we moved out of was actually a brace pair,
3511 ;; insert it into `c-state-cache'.
3516 c-state-cache)))
3521 ;; Strip stale elements of `c-state-cache' by moving backwards through the
3522 ;; buffer, and inform the caller of the scenario detected.
3523 ;;
3524 ;; HERE is the position we're setting `c-state-cache' for.
3525 ;; CACHE-POS (a locally bound variable) is just after the latest recorded
3526 ;; position in `c-state-cache' before HERE, or a position at or near
3527 ;; point-min which isn't in a literal.
3528 ;;
3529 ;; This function must only be called only when (> `c-state-cache-good-pos'
3530 ;; HERE). Usually the gap between CACHE-POS and HERE is large. It is thus
3531 ;; optimized to eliminate (or minimize) scanning between these two
3532 ;; positions.
3533 ;;
3534 ;; Return a three element list (GOOD-POS SCAN-BACK-POS FWD-FLAG), where:
3535 ;; o - GOOD-POS is a "good position", where `c-state-cache' is valid, or
3536 ;; could become so after missing elements are inserted into
3537 ;; `c-state-cache'. This is JUST AFTER an opening or closing
3538 ;; brace/paren/bracket which is already in `c-state-cache' or just before
3539 ;; one otherwise. exceptionally (when there's no such b/p/b handy) the BOL
3540 ;; before `here''s line, or the start of the literal containing it.
3541 ;; o - SCAN-BACK-POS, if non-nil, indicates there may be a brace pair
3542 ;; preceding POS which isn't recorded in `c-state-cache'. It is a position
3543 ;; to scan backwards from.
3544 ;; o - FWD-FLAG, if non-nil, indicates there may be parens/braces between
3545 ;; POS and HERE which aren't recorded in `c-state-cache'.
3546 ;;
3547 ;; The comments in this defun use "paren" to mean parenthesis or square
3548 ;; bracket (as contrasted with a brace), and "(" and ")" likewise.
3549 ;;
3550 ;; . {..} (..) (..) ( .. { } ) (...) ( .... . ..)
3551 ;; | | | | | |
3552 ;; CP E here D C good
3555 pa ren ; positions of "(" and ")"
3556 dropped-cons ; whether the last element dropped from `c-state-cache'
3557 ; was a cons (representing a brace-pair)
3558 good-pos ; see above.
3559 lit ; (START . END) of a literal containing some point.
3560 here-lit-start here-lit-end ; bounds of literal containing `here'
3561 ; or `here' itself.
3566 ;; Remove completely irrelevant entries from `c-state-cache'.
3572 ;; At this stage, (>= pos here);
3573 ;; (< (c-state-cache-top-lparen) here) (or is nil).
3578 ;; CASE 1: The top of the cache is a brace pair which now encloses
3579 ;; `here'. As good-pos, return the address of the "{". Since we've no
3580 ;; knowledge of what's inside these braces, we have no alternative but
3581 ;; to direct the caller to scan the buffer from the opening brace.
3585 ; entry into a { entry, so the caller needs to
3586 ; search for a brace pair before the {.
3588 ;; `here' might be inside a literal. Check for this.
3593 ;; Has `here' just "newly entered" a macro?
3606 ;; `here' might be nested inside any depth of parens (or brackets but
3607 ;; not braces). Scan backwards to find the outermost such opening
3608 ;; paren, if there is one. This will be the scan position to return.
3615 ;; CASE 2: Address of outermost ( or [ which now encloses `here', but
3616 ;; didn't enclose the (previous) `c-state-cache-good-pos'. If there is
3617 ;; a brace pair preceding this, it will already be in `c-state-cache',
3618 ;; unless there was a brace pair after it, i.e. there'll only be one to
3619 ;; scan for if we've just deleted one.
3622 ;; `here' isn't enclosed in a (previously unrecorded) bracket/paren.
3623 ;; Further forward scanning isn't needed, but we still need to find a
3624 ;; GOOD-POS. Step out of all enclosing "("s on HERE's line.
3636 ;; CASE 3: After a }/)/] before `here''s BOL.
3641 ;; CASE 3.5: Just after an existing entry in `c-state-cache' on `here''s
3642 ;; line or the previous line.
3646 ;; CASE 4; Best of a bad job: BOL before `here-bol', or beginning of
3647 ;; literal containing it.
3651 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3652 ;; Externally visible routines.
3656 c-state-cache-good-pos 1
3657 c-state-nonlit-pos-cache nil
3658 c-state-nonlit-pos-cache-limit 1
3659 c-state-semi-nonlit-pos-cache nil
3660 c-state-semi-nonlit-pos-cache-limit 1
3661 c-state-brace-pair-desert nil
3662 c-state-point-min 1
3663 c-state-point-min-lit-type nil
3664 c-state-point-min-lit-start nil
3665 c-state-min-scan-pos 1
3666 c-state-old-cpp-beg nil
3667 c-state-old-cpp-end nil)
3670 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3671 ;; Debugging routines to dump `c-state-cache' in a "replayable" form.
3672 ;; (defmacro c-sc-de (elt) ; "c-state-cache-dump-element"
3673 ;; `(format ,(concat "(setq " (symbol-name elt) " %s) ") ,elt))
3674 ;; (defmacro c-sc-qde (elt) ; "c-state-cache-quote-dump-element"
3675 ;; `(format ,(concat "(setq " (symbol-name elt) " '%s) ") ,elt))
3676 ;; (defun c-state-dump ()
3677 ;; ;; For debugging.
3678 ;; ;(message
3679 ;; (concat
3680 ;; (c-sc-qde c-state-cache)
3681 ;; (c-sc-de c-state-cache-good-pos)
3682 ;; (c-sc-qde c-state-nonlit-pos-cache)
3683 ;; (c-sc-de c-state-nonlit-pos-cache-limit)
3684 ;; (c-sc-qde c-state-brace-pair-desert)
3685 ;; (c-sc-de c-state-point-min)
3686 ;; (c-sc-de c-state-point-min-lit-type)
3687 ;; (c-sc-de c-state-point-min-lit-start)
3688 ;; (c-sc-de c-state-min-scan-pos)
3689 ;; (c-sc-de c-state-old-cpp-beg)
3690 ;; (c-sc-de c-state-old-cpp-end)))
3691 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3694 ;; Invalidate all info on `c-state-cache' that applies to the buffer at HERE
3695 ;; or higher and set `c-state-cache-good-pos' accordingly. The cache is
3696 ;; left in a consistent state.
3697 ;;
3698 ;; This is much like `c-whack-state-after', but it never changes a paren
3699 ;; pair element into an open paren element. Doing that would mean that the
3700 ;; new open paren wouldn't have the required preceding paren pair element.
3701 ;;
3702 ;; This function is called from c-before-change.
3704 ;; The caches of non-literals:
3705 ;; Note that we use "<=" for the possibility of the second char of a two-char
3706 ;; comment opener being typed; this would invalidate any cache position at
3707 ;; HERE.
3712 ;; `c-state-cache':
3713 ;; Case 1: if `here' is in a literal containing point-min, everything
3714 ;; becomes (or is already) nil.
3718 c-state-cache-good-pos nil
3719 c-state-min-scan-pos nil)
3721 ;; Truncate `c-state-cache' and set `c-state-cache-good-pos' to a value
3722 ;; below `here'. To maintain its consistency, we may need to insert a new
3723 ;; brace pair.
3725 too-high-pa ; recorded {/(/[ next above or just below here, or nil.
3727 ;; The easy bit - knock over-the-top bits off `c-state-cache'.
3734 ;; Do we need to add in an earlier brace pair, having lopped one off?
3741 ;; The brace-pair desert marker:
3749 ;; Find and record all noteworthy parens between some good point earlier in
3750 ;; the file and point. That good point is at least the beginning of the
3751 ;; top-level construct we are in, or the beginning of the preceding
3752 ;; top-level construct if we aren't in one.
3753 ;;
3754 ;; The returned value is a list of the noteworthy parens with the last one
3755 ;; first. If an element in the list is an integer, it's the position of an
3756 ;; open paren (of any type) which has not been closed before the point. If
3757 ;; an element is a cons, it gives the position of a closed BRACE paren
3758 ;; pair[*]; the car is the start brace position and the cdr is the position
3759 ;; following the closing brace. Only the last closed brace paren pair
3760 ;; before each open paren and before the point is recorded, and thus the
3761 ;; state never contains two cons elements in succession. When a close brace
3762 ;; has no matching open brace (e.g., the matching brace is outside the
3763 ;; visible region), it is not represented in the returned value.
3764 ;;
3765 ;; [*] N.B. The close "brace" might be a mismatching close bracket or paren.
3766 ;; This defun explicitly treats mismatching parens/braces/brackets as
3767 ;; matching. It is the open brace which makes it a "brace" pair.
3768 ;;
3769 ;; If POINT is within a macro, open parens and brace pairs within
3770 ;; THIS macro MIGHT be recorded. This depends on whether their
3771 ;; syntactic properties have been suppressed by
3772 ;; `c-neutralize-syntax-in-CPP'. This might need fixing (2008-12-11).
3773 ;;
3774 ;; Currently no characters which are given paren syntax with the
3775 ;; syntax-table property are recorded, i.e. angle bracket arglist
3776 ;; parens are never present here. Note that this might change.
3777 ;;
3778 ;; BUG: This function doesn't cope entirely well with unbalanced
3779 ;; parens in macros. (2008-12-11: this has probably been resolved
3780 ;; by the function `c-neutralize-syntax-in-CPP'.) E.g. in the
3781 ;; following case the brace before the macro isn't balanced with the
3782 ;; one after it:
3783 ;;
3784 ;; {
3785 ;; #define X {
3786 ;; }
3787 ;;
3788 ;; Note to maintainers: this function DOES get called with point
3789 ;; within comments and strings, so don't assume it doesn't!
3790 ;;
3791 ;; This function might do hidden buffer changes.
3794 strategy ; 'forward, 'backward etc..
3795 ;; Candidate positions to start scanning from:
3796 cache-pos ; highest position below HERE already existing in
3797 ; cache (or 1).
3798 good-pos
3799 start-point ; (when scanning forward) a place below HERE where there
3800 ; are no open parens/braces between it and HERE.
3801 bopl-state
3802 res
3803 cons-separated
3805 ;; If POINT-MIN has changed, adjust the cache
3809 ;; Strategy?
3816 c-state-cache-good-pos start-point))
3818 ;; SCAN!
3826 ; start-point)
3836 good-pos)))
3848 good-pos)))
3852 c-state-cache-good-pos nil))))
3854 c-state-cache)
3857 ;; This is a wrapper over `c-invalidate-state-cache-1'.
3858 ;;
3859 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3860 ;; of all parens in preprocessor constructs, except for any such construct
3861 ;; containing point. We can then call `c-invalidate-state-cache-1' without
3862 ;; worrying further about macros and template delimiters.
3864 ;; Emacs
3867 ;; XEmacs
3871 ;; If PLACE is non-nil, return a marker marking it, otherwise nil.
3872 ;; We (re)use MARKER.
3878 ;; This is a wrapper over `c-parse-state-1'. See that function for a
3879 ;; description of the functionality and return value.
3880 ;;
3881 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3882 ;; of all parens in preprocessor constructs, except for any such construct
3883 ;; containing point. We can then call `c-parse-state-1' without worrying
3884 ;; further about macros and template delimiters.
3891 here-cpp-beg)
3893 ;; FIXME!!! Put in a `condition-case' here to protect the integrity of the
3894 ;; subsystem.
3897 ;; Emacs
3900 ;; XEmacs
3904 c-state-old-cpp-end
3907 ;; Debug tool to catch cache inconsistencies. This is called from
3908 ;; 000tests.el.
3931 c-state-cache-good-pos
3932 c-state-nonlit-pos-cache
3933 c-state-nonlit-pos-cache-limit
3934 c-state-semi-nonlit-pos-cache
3935 c-state-semi-nonlit-pos-cache-limit
3936 c-state-brace-pair-desert
3937 c-state-point-min
3938 c-state-point-min-lit-type
3939 c-state-point-min-lit-start
3940 c-state-min-scan-pos
3941 c-state-old-cpp-beg
3942 c-state-old-cpp-end
3943 c-parse-state-point))))
3965 conses-not-ok))
3982 ;; The cache can actually go further back due to the ad-hoc way
3983 ;; the first paren is found, so try to whack off a bit of its
3984 ;; start before complaining.
3985 ;; (save-excursion
3986 ;; (goto-char (or (c-least-enclosing-brace res2) (point)))
3987 ;; (c-beginning-of-defun-1)
3988 ;; (while (not (or (bobp) (eq (char-after) ?{)))
3989 ;; (c-beginning-of-defun-1))
3990 ;; (unless (equal (c-whack-state-before (point) res1) res2)
3991 ;; (message (concat "c-parse-state inconsistency at %s: "
3992 ;; "using cache: %s, from scratch: %s")
3993 ;; here res1 res2)))
3996 here res1 res2 min-point)
4002 here res1)
4007 res2 ; res1 correct a cascading series of errors ASAP
4008 ))
4014 'c-debug-parse-state
4022 \f
4024 ;; Whack off any state information from PAREN-STATE which lies
4025 ;; before BUFPOS. Not destructive on PAREN-STATE.
4028 car)
4039 ;; Whack off any state information from PAREN-STATE which lies at or
4040 ;; after BUFPOS. Not destructive on PAREN-STATE.
4045 ;; just check the car, because in a balanced brace
4046 ;; expression, it must be impossible for the corresponding
4047 ;; close brace to be before point, but the open brace to
4048 ;; be after.
4050 nil ; whack it off
4052 ;; its possible that the open brace is before
4053 ;; bufpos, but the close brace is after. In that
4054 ;; case, convert this to a non-cons element. The
4055 ;; rest of the state is before bufpos, so we're
4056 ;; done.
4058 ;; we know that both the open and close braces are
4059 ;; before bufpos, so we also know that everything else
4060 ;; on state is before bufpos.
4063 nil ; whack it off
4064 ;; it's before bufpos, so everything else should too.
4067 nil)))
4070 ;; Return the bufpos of the innermost enclosing open paren before
4071 ;; bufpos, or nil if none was found.
4081 enclosingp))
4084 ;; Return the bufpos of the outermost enclosing open paren, or nil
4085 ;; if none was found.
4092 pos))
4095 ;; Return the closest "safe" position recorded on PAREN-STATE that
4096 ;; is higher up than BUFPOS. Return nil if PAREN-STATE doesn't
4097 ;; contain any. Return nil if BUFPOS is nil, which is useful to
4098 ;; find the closest limit before a given limit that might be nil.
4099 ;;
4100 ;; A "safe" position is a position at or after a recorded open
4101 ;; paren, or after a recorded close paren. The returned position is
4102 ;; thus either the first position after a close brace, or the first
4103 ;; position after an enclosing paren, or at the enclosing paren in
4104 ;; case BUFPOS is immediately after it.
4114 ;; See below.
4117 ;; elem is the position at and not after the opening paren, so
4118 ;; we can go forward one more step unless it's equal to
4119 ;; bufpos. This is useful in some cases avoid an extra paren
4120 ;; level between the safe position and bufpos.
4125 ;; This is used for `font-lock-beginning-of-syntax-function'. It
4126 ;; goes to the closest previous point that is known to be outside
4127 ;; any string literal or comment. `c-state-cache' is used if it has
4128 ;; a position in the vicinity.
4130 elem
4133 ;; Note: Similar code in `c-safe-position'. The
4134 ;; difference is that we accept a safe position at
4135 ;; the point and don't bother to go forward past open
4136 ;; parens.
4151 ;; The position is far back. Try `c-beginning-of-defun-1'
4152 ;; (although we can't be entirely sure it will go to a position
4153 ;; outside a comment or string in current emacsen). FIXME:
4154 ;; Consult `syntax-ppss' here.
4159 \f
4160 ;; Tools for scanning identifiers and other tokens.
4163 "Return non-nil if the point is on or directly after an identifier.
4164 Keywords are recognized and not considered identifiers. If an
4165 identifier is detected, the returned value is its starting position.
4166 If an identifier ends at the point and another begins at it \(can only
4167 happen in Pike) then the point for the preceding one is returned.
4169 Note that this function might do hidden buffer changes. See the
4170 comment at the start of cc-engine.el for more info."
4172 ;; FIXME: Shouldn't this function handle "operator" in C++?
4179 ;; Check for a normal (non-keyword) identifier.
4185 ;; Handle the `<operator> syntax in Pike.
4189 t
4196 ;; Handle the "operator +" syntax in C++.
4213 )))
4216 ;; If the point is at the end of a symbol then skip backward to the
4217 ;; beginning of it. Don't move otherwise. Return non-nil if point
4218 ;; moved.
4219 ;;
4220 ;; This function might do hidden buffer changes.
4223 ;; Handle the `<operator> syntax in Pike.
4229 t
4231 nil)))))
4234 ;; Move to the beginning of the current token. Do not move if not
4235 ;; in the middle of one. BACK-LIMIT may be used to bound the
4236 ;; backward search; if given it's assumed to be at the boundary
4237 ;; between two tokens. Return non-nil if the point is moved, nil
4238 ;; otherwise.
4239 ;;
4240 ;; This function might do hidden buffer changes.
4247 ;; `c-nonsymbol-token-regexp' should always match
4248 ;; since we've skipped backward over punctuation
4249 ;; or paren syntax, but consume one char in case
4250 ;; it doesn't so that we don't leave point before
4251 ;; some earlier incorrect token.
4258 ;; Move to the end of the current token. Do not move if not in the
4259 ;; middle of one. BACK-LIMIT may be used to bound the backward
4260 ;; search; if given it's assumed to be at the boundary between two
4261 ;; tokens. Return non-nil if the point is moved, nil otherwise.
4262 ;;
4263 ;; This function might do hidden buffer changes.
4271 ;; `c-nonsymbol-token-regexp' should always match since
4272 ;; we've skipped backward over punctuation or paren
4273 ;; syntax, but move forward in case it doesn't so that
4274 ;; we don't leave point earlier than we started with.
4290 "Move forward over a token and any following whitespace
4291 Return t if we moved, nil otherwise (i.e. we were at EOB, or a
4292 non-token or BALANCED is non-nil and we can't move). If we
4293 are at syntactic whitespace, move over this in place of a token.
4295 If BALANCED is non-nil move over any balanced parens we are at, and never move
4296 out of an enclosing paren.
4298 This function differs from `c-forward-token-2' in that it will move forward
4299 over the final token in a buffer, up to EOB."
4301 c-jump-syntax-balanced
4302 c-jump-syntax-unbalanced))
4309 ;; If we're at whitespace, count this as the token.
4310 t)
4314 t)
4317 t)
4321 nil)
4324 t))
4326 nil))
4328 t)))
4331 "Move forward by tokens.
4332 A token is defined as all symbols and identifiers which aren't
4334 treated properly). Point is always either left at the beginning of a
4335 token or not moved at all. COUNT specifies the number of tokens to
4336 move; a negative COUNT moves in the opposite direction. A COUNT of 0
4337 moves to the next token beginning only if not already at one. If
4338 BALANCED is true, move over balanced parens, otherwise move into them.
4339 Also, if BALANCED is true, never move out of an enclosing paren.
4341 LIMIT sets the limit for the movement and defaults to the point limit.
4342 The case when LIMIT is set in the middle of a token, comment or macro
4343 is handled correctly, i.e. the point won't be left there.
4345 Return the number of tokens left to move \(positive or negative). If
4346 BALANCED is true, a move over a balanced paren counts as one. Note
4347 that if COUNT is 0 and no appropriate token beginning is found, 1 will
4348 be returned. Thus, a return value of 0 guarantees that point is at
4349 the requested position and a return value less \(without signs) than
4350 COUNT guarantees that point is at the beginning of some token.
4352 Note that this function might do hidden buffer changes. See the
4353 comment at the start of cc-engine.el for more info."
4362 ;; If count is zero we should jump if in the middle of a token.
4369 ;; Skip whitespace. Count this as a move if we did in
4370 ;; fact move.
4374 ;; Moved out of bounds. Make sure the returned count isn't zero.
4386 count)))
4389 "Move backward by tokens.
4390 See `c-forward-token-2' for details."
4398 c-jump-syntax-balanced
4399 c-jump-syntax-unbalanced))
4403 ;; The count is zero so try to skip to the beginning of the
4404 ;; current token.
4408 ;; The limit is inside the same token, so return 1.
4411 ;; We're not in the middle of a token. If there's
4412 ;; whitespace after the point then we must move backward,
4413 ;; so set count to 1 in that case.
4415 ;; If we're looking at a '#' that might start a cpp
4416 ;; directive then we have to do a more elaborate check.
4429 ;; Use `condition-case' to avoid having to check for buffer
4430 ;; limits in `backward-char', `scan-sexps' and `goto-char' below.
4439 ;; This can be very inefficient if there's a long
4440 ;; sequence of operator tokens without any separation.
4441 ;; That doesn't happen in practice, anyway.
4451 count)))
4454 "Like `c-forward-token-2' but doesn't treat multicharacter operator
4456 characters are jumped over character by character. This function is
4457 for compatibility only; it's only a wrapper over `c-forward-token-2'."
4462 "Like `c-backward-token-2' but doesn't treat multicharacter operator
4464 characters are jumped over character by character. This function is
4465 for compatibility only; it's only a wrapper over `c-backward-token-2'."
4469 \f
4470 ;; Tools for doing searches restricted to syntactically relevant text.
4473 paren-level not-inside-token
4474 lookbehind-submatch)
4475 "Like `re-search-forward', but only report matches that are found
4476 in syntactically significant text. I.e. matches in comments, macros
4477 or string literals are ignored. The start point is assumed to be
4478 outside any comment, macro or string literal, or else the content of
4479 that region is taken as syntactically significant text.
4481 NOERROR, in addition to the values nil, t, and <anything else>
4482 used in `re-search-forward' can also take the values
4483 'before-literal and 'after-literal. In these cases, when BOUND
4484 is also given and is inside a literal, and a search fails, point
4485 will be left, respectively before or after the literal. Be aware
4486 that with 'after-literal, if a string or comment is unclosed at
4487 the end of the buffer, point may be left there, even though it is
4488 inside a literal there.
4490 If PAREN-LEVEL is non-nil, an additional restriction is added to
4491 ignore matches in nested paren sexps. The search will also not go
4492 outside the current list sexp, which has the effect that if the point
4493 should be moved to BOUND when no match is found \(i.e. NOERROR is
4494 neither nil nor t), then it will be at the closing paren if the end of
4495 the current list sexp is encountered first.
4497 If NOT-INSIDE-TOKEN is non-nil, matches in the middle of tokens are
4498 ignored. Things like multicharacter operators and special symbols
4500 constants.
4502 If LOOKBEHIND-SUBMATCH is non-nil, it's taken as a number of a
4503 subexpression in REGEXP. The end of that submatch is used as the
4504 position to check for syntactic significance. If LOOKBEHIND-SUBMATCH
4505 isn't used or if that subexpression didn't match then the start
4507 subexpression is never tested before the starting position, so it
4511 subexpression can match the end of nonwhite syntactic whitespace,
4512 i.e. the end of comments or cpp directives. This since the function
4513 skips over such things before resuming the search. It's on the other
4515 matches syntactic whitespace.
4517 Bug: Unbalanced parens inside cpp directives are currently not handled
4518 correctly \(i.e. they don't get ignored as they should) when
4519 PAREN-LEVEL is set.
4521 Note that this function might do hidden buffer changes. See the
4522 comment at the start of cc-engine.el for more info."
4527 ;;(message "c-syntactic-re-search-forward %s %s %S" (point) bound regexp)
4530 tmp
4531 ;; Start position for the last search.
4532 search-pos
4533 ;; The `parse-partial-sexp' state between the start position
4534 ;; and the point.
4535 state
4536 ;; The current position after the last state update. The next
4537 ;; `parse-partial-sexp' continues from here.
4539 ;; The position at which to check the state and the state
4540 ;; there. This is separate from `state-pos' since we might
4541 ;; need to back up before doing the next search round.
4542 check-pos check-state
4543 ;; Last position known to end a token.
4545 ;; Set when a valid match is found.
4546 found)
4554 t
4555 ;; Without the following, when PAREN-LEVEL is non-nil, and
4556 ;; NOERROR is not nil or t, and the very first search above
4557 ;; has just failed, point would end up at BOUND rather than
4558 ;; just before the next close paren.
4560 paren-level
4565 nil))
4576 state-pos check-pos paren-level nil state))
4578 check-state state))
4580 ;; NOTE: If we got a look behind subexpression and get
4581 ;; an insignificant match in something that isn't
4582 ;; syntactic whitespace (i.e. strings or in nested
4583 ;; parentheses), then we can never skip more than a
4584 ;; single character from the match start position
4585 ;; (i.e. `state-pos' here) before continuing the
4586 ;; search. That since the look behind subexpression
4587 ;; might match the end of the insignificant region in
4588 ;; the next search.
4592 ;; Match inside a line comment. Skip to eol. Use
4593 ;; `re-search-forward' instead of `skip-chars-forward' to get
4594 ;; the right bound behavior.
4598 ;; Match inside a block comment. Skip to the '*/'.
4605 ;; Match in the middle of the opener of a block or line
4606 ;; comment.
4611 ;; The last `parse-partial-sexp' above might have
4612 ;; stopped short of the real check position if the end
4613 ;; of the current sexp was encountered in paren-level
4614 ;; mode. The checks above are always false in that
4615 ;; case, and since they can do better skipping in
4616 ;; lookbehind-submatch mode, we do them before
4617 ;; checking the paren level.
4621 ;; Check the paren level first since we're short of the
4622 ;; syntactic checking position if the end of the
4623 ;; current sexp was encountered by `parse-partial-sexp'.
4626 ;; Inside a nested paren sexp.
4628 ;; See the NOTE above.
4630 ;; Skip out of the paren quickly.
4634 ;; Have exited the current paren sexp.
4637 ;; The last `parse-partial-sexp' call above
4638 ;; has left us just after the closing paren
4639 ;; in this case, so we can modify the bound
4640 ;; to leave the point at the right position
4641 ;; upon return.
4643 nil)
4647 ;; Match inside a string.
4650 ;; See the NOTE above.
4652 ;; Skip to the end of the string before continuing.
4661 continue)))
4666 ;; Match inside a macro. Skip to the end of it.
4674 (< check-pos
4680 ;; Inside a token.
4682 ;; See the NOTE above.
4687 ;; A real match.
4689 nil)))
4691 ;; Should loop to search again, but take care to avoid
4692 ;; looping on the same spot.
4696 nil
4699 t))))
4705 ;;(message "c-syntactic-re-search-forward done %s" (or (match-end 0) (point)))
4712 ;; Search failed. Set point as appropriate.
4726 nil)))
4731 ;; Return the start of the literal point is in, or nil.
4732 ;; We read and write the variables `safe-pos', `safe-pos-list', `state'
4733 ;; bound in the caller.
4735 ;; Use `parse-partial-sexp' from a safe position down to the point to check
4736 ;; if it's outside comments and strings.
4739 ;; Pick a safe position as close to the point as possible.
4740 ;;
4741 ;; FIXME: Consult `syntax-ppss' here if our cache doesn't give a good
4742 ;; position.
4754 ;; Cache positions along the way to use if we have to back up more. We
4755 ;; cache every closing paren on the same level. If the paren cache is
4756 ;; relevant in this region then we're typically already on the same
4757 ;; level as the target position. Note that we might cache positions
4758 ;; after opening parens in case safe-pos is in a nested list. That's
4759 ;; both uncommon and harmless.
4767 ;; If the state contains the start of the containing sexp we cache that
4768 ;; position too, so that parse-partial-sexp in the next run has a bigger
4769 ;; chance of starting at the same level as the target position and thus
4770 ;; will get more good safe positions into the list.
4776 ;; Inside string or comment. Continue search at the
4777 ;; beginning of it.
4781 "Like `skip-chars-backward' but only look at syntactically relevant chars,
4782 i.e. don't stop at positions inside syntactic whitespace or string
4783 literals. Preprocessor directives are also ignored, with the exception
4784 of the one that the point starts within, if any. If LIMIT is given,
4785 it's assumed to be at a syntactically relevant position.
4787 If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4788 sexps, and the search will also not go outside the current paren sexp.
4789 However, if LIMIT or the buffer limit is reached inside a nested paren
4790 then the point will be left at the limit.
4792 Non-nil is returned if the point moved, nil otherwise.
4794 Note that this function might do hidden buffer changes. See the
4795 comment at the start of cc-engine.el for more info."
4799 ;; A list of syntactically relevant positions in descending
4800 ;; order. It's used to avoid scanning repeatedly over
4801 ;; potentially large regions with `parse-partial-sexp' to verify
4802 ;; each position. Used in `c-ssb-lit-begin'
4803 safe-pos-list
4804 ;; The result from `c-beginning-of-macro' at the start position or the
4805 ;; start position itself if it isn't within a macro. Evaluated on
4806 ;; demand.
4807 start-macro-beg
4808 ;; The earliest position after the current one with the same paren
4809 ;; level. Used only when `paren-level' is set.
4810 lit-beg
4815 ;; The next loop "tries" to find the end point each time round,
4816 ;; loops when it hasn't succeeded.
4822 ;; Don't stop inside a literal.
4825 t)))
4837 ;; Not at the right level.
4840 ;; We stop above if we go out of a paren.
4841 ;; Now check whether it precedes or is
4842 ;; nested in the starting sexp.
4846 pps-end-pos paren-level-pos
4847 nil nil state-2))
4850 ;; We've stopped short of the starting position
4851 ;; so the hit was inside a nested list. Go up
4852 ;; until we are at the right level.
4861 nil)
4862 t))
4865 nil))
4867 ;; The hit was outside the list at the start
4868 ;; position. Go to the start of the list and exit.
4870 nil))
4873 ;; Inside a macro.
4881 t
4883 ;; It's inside the same macro we started in so it's
4884 ;; a relevant match.
4886 nil))))))
4890 ;; Skip syntactic ws afterwards so that we don't stop at the
4891 ;; end of a comment if `skip-chars' is something like "^/".
4895 ;; We might want to extend this with more useful return values in
4896 ;; the future.
4899 ;; The following is an alternative implementation of
4900 ;; `c-syntactic-skip-backward' that uses backward movement to keep
4901 ;; track of the syntactic context. It turned out to be generally
4902 ;; slower than the one above which uses forward checks from earlier
4903 ;; safe positions.
4904 ;;
4905 ;;(defconst c-ssb-stop-re
4906 ;; ;; The regexp matching chars `c-syntactic-skip-backward' needs to
4907 ;; ;; stop at to avoid going into comments and literals.
4908 ;; (concat
4909 ;; ;; Match comment end syntax and string literal syntax. Also match
4910 ;; ;; '/' for block comment endings (not covered by comment end
4911 ;; ;; syntax).
4912 ;; "\\s>\\|/\\|\\s\""
4913 ;; (if (memq 'gen-string-delim c-emacs-features)
4914 ;; "\\|\\s|"
4915 ;; "")
4916 ;; (if (memq 'gen-comment-delim c-emacs-features)
4917 ;; "\\|\\s!"
4918 ;; "")))
4919 ;;
4920 ;;(defconst c-ssb-stop-paren-re
4921 ;; ;; Like `c-ssb-stop-re' but also stops at paren chars.
4922 ;; (concat c-ssb-stop-re "\\|\\s(\\|\\s)"))
4923 ;;
4924 ;;(defconst c-ssb-sexp-end-re
4925 ;; ;; Regexp matching the ending syntax of a complex sexp.
4926 ;; (concat c-string-limit-regexp "\\|\\s)"))
4927 ;;
4928 ;;(defun c-syntactic-skip-backward (skip-chars &optional limit paren-level)
4929 ;; "Like `skip-chars-backward' but only look at syntactically relevant chars,
4930 ;;i.e. don't stop at positions inside syntactic whitespace or string
4931 ;;literals. Preprocessor directives are also ignored. However, if the
4932 ;;point is within a comment, string literal or preprocessor directory to
4933 ;;begin with, its contents is treated as syntactically relevant chars.
4934 ;;If LIMIT is given, it limits the backward search and the point will be
4935 ;;left there if no earlier position is found.
4936 ;;
4937 ;;If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4938 ;;sexps, and the search will also not go outside the current paren sexp.
4939 ;;However, if LIMIT or the buffer limit is reached inside a nested paren
4940 ;;then the point will be left at the limit.
4941 ;;
4942 ;;Non-nil is returned if the point moved, nil otherwise.
4943 ;;
4944 ;;Note that this function might do hidden buffer changes. See the
4945 ;;comment at the start of cc-engine.el for more info."
4946 ;;
4947 ;; (save-restriction
4948 ;; (when limit
4949 ;; (narrow-to-region limit (point-max)))
4950 ;;
4951 ;; (let ((start (point)))
4952 ;; (catch 'done
4953 ;; (while (let ((last-pos (point))
4954 ;; (stop-pos (progn
4955 ;; (skip-chars-backward skip-chars)
4956 ;; (point))))
4957 ;;
4958 ;; ;; Skip back over the same region as
4959 ;; ;; `skip-chars-backward' above, but keep to
4960 ;; ;; syntactically relevant positions.
4961 ;; (goto-char last-pos)
4962 ;; (while (and
4963 ;; ;; `re-search-backward' with a single char regexp
4964 ;; ;; should be fast.
4965 ;; (re-search-backward
4966 ;; (if paren-level c-ssb-stop-paren-re c-ssb-stop-re)
4967 ;; stop-pos 'move)
4968 ;;
4969 ;; (progn
4970 ;; (cond
4971 ;; ((looking-at "\\s(")
4972 ;; ;; `paren-level' is set and we've found the
4973 ;; ;; start of the containing paren.
4974 ;; (forward-char)
4975 ;; (throw 'done t))
4976 ;;
4977 ;; ((looking-at c-ssb-sexp-end-re)
4978 ;; ;; We're at the end of a string literal or paren
4979 ;; ;; sexp (if `paren-level' is set).
4980 ;; (forward-char)
4981 ;; (condition-case nil
4982 ;; (c-backward-sexp)
4983 ;; (error
4984 ;; (goto-char limit)
4985 ;; (throw 'done t))))
4986 ;;
4987 ;; (t
4988 ;; (forward-char)
4989 ;; ;; At the end of some syntactic ws or possibly
4990 ;; ;; after a plain '/' operator.
4991 ;; (let ((pos (point)))
4992 ;; (c-backward-syntactic-ws)
4993 ;; (if (= pos (point))
4994 ;; ;; Was a plain '/' operator. Go past it.
4995 ;; (backward-char)))))
4996 ;;
4997 ;; (> (point) stop-pos))))
4998 ;;
4999 ;; ;; Now the point is either at `stop-pos' or at some
5000 ;; ;; position further back if `stop-pos' was at a
5001 ;; ;; syntactically irrelevant place.
5002 ;;
5003 ;; ;; Skip additional syntactic ws so that we don't stop
5004 ;; ;; at the end of a comment if `skip-chars' is
5005 ;; ;; something like "^/".
5006 ;; (c-backward-syntactic-ws)
5007 ;;
5008 ;; (< (point) stop-pos))))
5009 ;;
5010 ;; ;; We might want to extend this with more useful return values
5011 ;; ;; in the future.
5012 ;; (/= (point) start))))
5014 \f
5015 ;; Tools for handling comments and string literals.
5018 "Return the type of literal point is in, if any.
5019 The return value is `c' if in a C-style comment, `c++' if in a C++
5020 style comment, `string' if in a string literal, `pound' if DETECT-CPP
5021 is non-nil and in a preprocessor line, or nil if somewhere else.
5022 Optional LIM is used as the backward limit of the search. If omitted,
5023 or nil, `c-beginning-of-defun' is used.
5025 Note that this function might do hidden buffer changes. See the
5026 comment at the start of cc-engine.el for more info."
5036 "Return a cons of the beginning and end positions of the comment or
5037 string surrounding point (including both delimiters), or nil if point
5039 to start parsing from. If NEAR is non-nil, then the limits of any
5041 spaces and tabs between point and the literal. The search for such a
5042 literal is done first in forward direction. If NOT-IN-DELIMITER is
5043 non-nil, the case when point is inside a starting delimiter won't be
5044 recognized. This only has effect for comments which have starting
5045 delimiters with more than one character.
5047 Note that this function might do hidden buffer changes. See the
5048 comment at the start of cc-engine.el for more info."
5060 nil nil
5061 s
5071 ;; Search forward for a literal.
5082 ;; Search backward.
5093 ;; Block comment. Due to the nature of line
5094 ;; comments, they will always be covered by the
5095 ;; normal case above.
5098 ;; If LIM is bogus, beg will be bogus.
5102 ))))
5105 "Return the start of the string or comment surrounding point, or nil if
5106 point isn't in one. SAFE-POS, if non-nil, is a position before point which is
5115 ;; In case external callers use this; it did have a docstring.
5119 "If the argument is a cons of two buffer positions (such as returned by
5120 `c-literal-limits'), and that range contains a C++ style line comment,
5121 then an extended range is returned that contains all adjacent line
5122 comments (i.e. all comments that starts in the same column with no
5123 empty lines or non-whitespace characters between them). Otherwise the
5124 argument is returned.
5126 Note that this function might do hidden buffer changes. See the
5127 comment at the start of cc-engine.el for more info."
5138 ;; Got to take care in the backward direction to handle
5139 ;; comments which are preceded by code.
5153 range)
5157 "Convenience function that given the result of `c-literal-limits',
5158 returns nil or the type of literal that the range surrounds, one
5159 of the symbols `c', `c++' or `string'. It's much faster than using
5160 `c-in-literal' and is intended to be used when you need both the
5161 type of a literal and its limits.
5163 Note that this function might do hidden buffer changes. See the
5164 comment at the start of cc-engine.el for more info."
5175 range))
5178 ;; Get a "safe place" approximately TRY-SIZE characters before START.
5179 ;; This defsubst doesn't preserve point.
5184 cand
5189 ;; Return a buffer position HOW-FAR-BACK non-literal characters from
5190 ;; START (default point). The starting position, either point or
5191 ;; START may not be in a comment or string.
5192 ;;
5193 ;; The position found will not be before POINT-MIN and won't be in a
5194 ;; literal.
5195 ;;
5196 ;; We start searching for the sought position TRY-SIZE (default
5197 ;; twice HOW-FAR-BACK) bytes back from START.
5198 ;;
5199 ;; This function must be fast. :-)
5207 stack elt size
5210 ;; Move forward one literal each time round this loop.
5211 ;; Move forward to the start of a comment or string.
5213 pos
5214 start
5215 nil ; target-depth
5216 nil ; stop-before
5217 s ; state
5220 ;; Gather details of the non-literal-bit - starting pos and size.
5225 pos))
5229 ;; Move forward to the end of the comment/string.
5234 start
5235 nil ; target-depth
5236 nil ; stop-before
5237 s ; state
5241 ;; Now try and find enough non-literal characters recorded on the stack.
5242 ;; Go back one recorded literal each time round this loop.
5244 stack)
5249 ;; Have we found enough yet?
5261 ;; Return a buffer position about HOW-FAR non-literal characters forward
5262 ;; from START-POS (default point), which must not be inside a literal.
5269 ;; Scan over counted characters.
5271 pos
5273 nil ; target-depth
5274 nil ; stop-before
5275 s ; state
5279 ;; Scan over literal characters.
5282 pos
5284 nil ; target-depth
5285 nil ; stop-before
5286 s ; state
5291 \f
5292 ;; `c-find-decl-spots' and accompanying stuff.
5294 ;; Variables used in `c-find-decl-spots' to cache the search done for
5295 ;; the first declaration in the last call. When that function starts,
5296 ;; it needs to back up over syntactic whitespace to look at the last
5297 ;; token before the region being searched. That can sometimes cause
5298 ;; moves back and forth over a quite large region of comments and
5299 ;; macros, which would be repeated for each changed character when
5300 ;; we're called during fontification, since font-lock refontifies the
5301 ;; current line for each change. Thus it's worthwhile to cache the
5302 ;; first match.
5303 ;;
5304 ;; `c-find-decl-syntactic-pos' is a syntactically relevant position in
5305 ;; the syntactic whitespace less or equal to some start position.
5306 ;; There's no cached value if it's nil.
5307 ;;
5308 ;; `c-find-decl-match-pos' is the match position if
5309 ;; `c-find-decl-prefix-search' matched before the syntactic whitespace
5310 ;; at `c-find-decl-syntactic-pos', or nil if there's no such match.
5321 ; (defface c-debug-decl-spot-face
5322 ; '((t (:background "Turquoise")))
5323 ; "Debug face to mark the spots where `c-find-decl-spots' stopped.")
5324 ; (defface c-debug-decl-sws-face
5325 ; '((t (:background "Khaki")))
5326 ; "Debug face to mark the syntactic whitespace between the declaration
5327 ; spots and the preceding token end.")
5342 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
5343 ;; Machinery for determining when we're at top level (this including being
5344 ;; directly inside a class or namespace, etc.)
5345 ;;
5346 ;; We maintain a stack of brace depths in structures like classes and
5347 ;; namespaces. The car of this structure, when non-nil, indicates that the
5348 ;; associated position is within a template (etc.) structure, and the value is
5349 ;; the position where the (outermost) template ends. The other elements in
5350 ;; the structure are stacked elements, one each for each enclosing "top level"
5351 ;; structure.
5352 ;;
5353 ;; At the very outermost level, the value of the stack would be (nil 1), the
5354 ;; "1" indicating an enclosure in a notional all-enclosing block. After
5355 ;; passing a keyword such as "namespace", the value would become (nil 0 1).
5356 ;; At this point, passing a semicolon would cause the 0 to be dropped from the
5357 ;; stack (at any other time, a semicolon is ignored). Alternatively, on
5358 ;; passing an opening brace, the stack would become (nil 1 1). Each opening
5359 ;; brace passed causes the cadr to be incremented, and passing closing braces
5360 ;; causes it to be decremented until it reaches 1. On passing a closing brace
5361 ;; when the cadr of the stack is at 1, this causes it to be removed from the
5362 ;; stack, the corresponding namespace (etc.) structure having been closed.
5363 ;;
5364 ;; There is a special stack value -1 which means the C++ colon operator
5365 ;; introducing a list of inherited classes has just been parsed. The value
5366 ;; persists on the stack until the next open brace or semicolon.
5367 ;;
5368 ;; When the car of the stack is non-nil, i.e. when we're in a template (etc.)
5369 ;; structure, braces are not counted. The counting resumes only after passing
5370 ;; the template's closing position, which is recorded in the car of the stack.
5371 ;;
5372 ;; The test for being at top level consists of the cadr being 0 or 1.
5373 ;;
5374 ;; The values of this stack throughout a buffer are cached in a simple linear
5375 ;; cache, every 5000 characters.
5376 ;;
5377 ;; Note to maintainers: This cache mechanism is MUCH faster than recalculating
5378 ;; the stack at every entry to `c-find-decl-spots' using `c-at-toplevel-p' or
5379 ;; the like.
5380 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
5381 ;; The approximate interval at which we cache the value of the brace stack.
5383 ;; The list of cached values of the brace stack. Each value in the list is a
5384 ;; cons of the position it is valid for and the value of the stack as
5385 ;; described above.
5388 ;; The position of the buffer at and below which entries in `c-bs-cache' are
5389 ;; valid.
5392 ;; The previous buffer position for which the brace stack value was
5393 ;; determined.
5396 ;; The value of the brace stack at `c-bs-prev-pos'.
5401 ;; Initialize the cache in `c-bs-cache' and related variables.
5403 c-bs-cache-limit 1
5404 c-bs-prev-pos most-positive-fixnum
5405 c-bs-prev-stack nil))
5408 ;; Truncate the upper bound of the cache `c-bs-cache' to POS, if it is
5409 ;; higher than that position. This is called as either a before- or
5410 ;; after-change-function.
5415 ;; Given a brace-stack which has the value STACK at position FROM, update it
5416 ;; to its value at position TO, where TO is after (or equal to) FROM.
5417 ;; Return a cons of either TO (if it is outside a literal) and this new
5418 ;; value, or of the next position after TO outside a literal and the new
5419 ;; value.
5434 c-brace-stack-thing-key
5435 c-brace-stack-no-semi-key)
5448 1
5473 s
5483 ;; The failing `c-syntactic-re-search-forward' may have left us in the
5484 ;; middle of a token, which might be a significant token. Fix this!
5490 ;; Given a buffer position HERE, Return the value of the brace stack there.
5496 elt stack pos npos high-elt)
5497 ;; Trim the cache to take account of buffer changes.
5517 ;; Add an element to `c-state-semi-nonlit-pos-cache' each iteration.
5529 ;; Can we just use the previous value?
5534 stack c-bs-prev-stack)
5544 ;; Is position HERE at the top level, as indicated by the brace stack?
5550 ;; Macro used inside `c-find-decl-spots'. It ought to be a defun,
5551 ;; but it contains lots of free variables that refer to things
5552 ;; inside `c-find-decl-spots'. The point is left at `cfd-match-pos'
5553 ;; if there is a match, otherwise at `cfd-limit'.
5554 ;;
5555 ;; The macro moves point forward to the next putative start of a declaration
5556 ;; or cfd-limit. This decl start is the next token after a "declaration
5557 ;; prefix". The declaration prefix is the earlier of `cfd-prop-match' and
5558 ;; `cfd-re-match'. `cfd-match-pos' is set to the decl prefix.
5559 ;;
5560 ;; This macro might do hidden buffer changes.
5563 ;; Find the next property match position if we haven't got one already.
5574 ;; Find the next `c-decl-prefix-or-start-re' match if we haven't
5575 ;; got one already.
5581 ;; Each time round, the next `while' moves forward over a pseudo match
5582 ;; of `c-decl-prefix-or-start-re' which is either inside a literal, or
5583 ;; is a ":" not preceded by "public", etc.. `cfd-re-match' and
5584 ;; `cfd-re-match-end' get set.
5591 ;; No match. Finish up and exit the loop.
5593 nil)
5596 ;; Matched the end of a token preceding a decl spot.
5600 ;; Matched a token that start a decl spot.
5603 c-literal-faces)
5604 ;; Pseudo match inside a comment or string literal. Skip out
5605 ;; of comments and string literals.
5618 ;; Found, e.g., "::" in C++
5619 t)
5625 ;; Found a ":" which isn't part of "public:", etc.
5626 t)
5629 ;; If our match was at the decl start, we have to back up over the
5630 ;; preceding syntactic ws to set `cfd-match-pos' and to catch
5631 ;; any decl spots in the syntactic ws.
5636 ;; Choose whichever match is closer to the start.
5639 cfd-re-match nil)
5641 cfd-prop-match nil))
5647 ;; Skip forward past comments only so we don't skip macros.
5649 ;; Set the position to continue at. We can avoid going over
5650 ;; the comments skipped above a second time, but it's possible
5651 ;; that the comment skipping has taken us past `cfd-prop-match'
5652 ;; since the property might be used inside comments.
5658 ;; Call CFD-FUN for each possible spot for a declaration, cast or
5659 ;; label from the point to CFD-LIMIT.
5660 ;;
5661 ;; CFD-FUN is called with point at the start of the spot. It's passed three
5662 ;; arguments: The first is the end position of the token preceding the spot,
5663 ;; or 0 for the implicit match at bob. The second is a flag that is t when
5664 ;; the match is inside a macro. The third is a flag that is t when the
5665 ;; match is at "top level", i.e. outside any brace block, or directly inside
5666 ;; a class or namespace, etc. Point should be moved forward by at least one
5667 ;; token.
5668 ;;
5669 ;; If CFD-FUN adds `c-decl-end' properties somewhere below the current spot,
5670 ;; it should return non-nil to ensure that the next search will find them.
5671 ;;
5672 ;; Such a spot is:
5673 ;; o The first token after bob.
5674 ;; o The first token after the end of submatch 1 in
5675 ;; `c-decl-prefix-or-start-re' when that submatch matches. This
5676 ;; submatch is typically a (L or R) brace or paren, a ;, or a ,.
5677 ;; o The start of each `c-decl-prefix-or-start-re' match when
5678 ;; submatch 1 doesn't match. This is, for example, the keyword
5679 ;; "class" in Pike.
5680 ;; o The start of a previously recognized declaration; "recognized"
5681 ;; means that the last char of the previous token has a `c-type'
5682 ;; text property with the value `c-decl-end'; this only holds
5683 ;; when `c-type-decl-end-used' is set.
5684 ;;
5685 ;; Only a spot that match CFD-DECL-RE and whose face is in the
5686 ;; CFD-FACE-CHECKLIST list causes CFD-FUN to be called. The face
5687 ;; check is disabled if CFD-FACE-CHECKLIST is nil.
5688 ;;
5689 ;; If the match is inside a macro then the buffer is narrowed to the
5690 ;; end of it, so that CFD-FUN can investigate the following tokens
5691 ;; without matching something that begins inside a macro and ends
5692 ;; outside it. It's to avoid this work that the CFD-DECL-RE and
5693 ;; CFD-FACE-CHECKLIST checks exist.
5694 ;;
5695 ;; The spots are visited approximately in order from top to bottom.
5696 ;; It's however the positions where `c-decl-prefix-or-start-re'
5697 ;; matches and where `c-decl-end' properties are found that are in
5698 ;; order. Since the spots often are at the following token, they
5699 ;; might be visited out of order insofar as more spots are reported
5700 ;; later on within the syntactic whitespace between the match
5701 ;; positions and their spots.
5702 ;;
5703 ;; It's assumed that comments and strings are fontified in the
5704 ;; searched range.
5705 ;;
5706 ;; This is mainly used in fontification, and so has an elaborate
5707 ;; cache to handle repeated calls from the same start position; see
5708 ;; the variables above.
5709 ;;
5710 ;; All variables in this function begin with `cfd-' to avoid name
5711 ;; collision with the (dynamically bound) variables used in CFD-FUN.
5712 ;;
5713 ;; This function might do hidden buffer changes.
5717 ;; The end of the token preceding the decl spot last found
5718 ;; with `c-decl-prefix-or-start-re'. `cfd-limit' if there's
5719 ;; no match.
5720 cfd-re-match
5721 ;; The end position of the last `c-decl-prefix-or-start-re'
5722 ;; match. If this is greater than `cfd-continue-pos', the
5723 ;; next regexp search is started here instead.
5725 ;; The end of the last `c-decl-end' found by
5726 ;; `c-find-decl-prefix-search'. `cfd-limit' if there's no
5727 ;; match. If searching for the property isn't needed then we
5728 ;; disable it by setting it to `cfd-limit' directly.
5730 ;; The end of the token preceding the decl spot last found by
5731 ;; `c-find-decl-prefix-search'. 0 for the implicit match at
5732 ;; bob. `cfd-limit' if there's no match. In other words,
5733 ;; this is the minimum of `cfd-re-match' and `cfd-prop-match'.
5735 ;; The position to continue searching at.
5736 cfd-continue-pos
5737 ;; The position of the last "real" token we've stopped at.
5738 ;; This can be greater than `cfd-continue-pos' when we get
5739 ;; hits inside macros or at `c-decl-end' positions inside
5740 ;; comments.
5742 ;; The end position of the last entered macro.
5744 ;; Whether the last position returned from `c-find-decl-prefix-search'
5745 ;; is at the top-level (including directly in a class or namespace,
5746 ;; etc.).
5749 ;; Initialize by finding a syntactically relevant start position
5750 ;; before the point, and do the first `c-decl-prefix-or-start-re'
5751 ;; search unless we're at bob.
5754 ;; Must back up a bit since we look for the end of the previous
5755 ;; statement or declaration, which is earlier than the first
5756 ;; returned match.
5758 ;; This `cond' moves back over any literals or macros. It has special
5759 ;; handling for when the region being searched is entirely within a
5760 ;; macro. It sets `cfd-continue-pos' (unless we've reached
5761 ;; `cfd-limit').
5763 ;; First we need to move to a syntactically relevant position.
5764 ;; Begin by backing out of comment or string literals.
5765 ;;
5766 ;; This arm of the cond actually triggers if we're in a literal,
5767 ;; and cfd-limit is at most at BONL.
5769 ;; This arm of the `and' moves backwards out of a literal when
5770 ;; the face at point is a literal face. In this case, its value
5771 ;; is always non-nil.
5773 ;; Try to use the faces to back up to the start of the
5774 ;; literal. FIXME: What if the point is on a declaration
5775 ;; inside a comment?
5781 ;; XEmacs doesn't fontify the quotes surrounding string
5782 ;; literals.
5791 ;; Don't trust the literal to contain only literal faces
5792 ;; (the font lock package might not have fontified the
5793 ;; start of it at all, for instance) so check that we have
5794 ;; arrived at something that looks like a start or else
5795 ;; resort to `c-literal-limits'.
5799 )
5803 ;; The start is in a literal. If the limit is in the same
5804 ;; one we don't have to find a syntactic position etc. We
5805 ;; only check that if the limit is at or before bonl to save
5806 ;; time; it covers the by far most common case when font-lock
5807 ;; refontifies the current line only.
5818 ;; Completely inside a literal. Set up variables to trig the
5819 ;; (< cfd-continue-pos cfd-start-pos) case below and it'll
5820 ;; find a suitable start position.
5823 ;; Check if the region might be completely inside a macro, to
5824 ;; optimize that like the completely-inside-literal above.
5831 ;; (Maybe) completely inside a macro. Only need to trig the
5832 ;; (< cfd-continue-pos cfd-start-pos) case below to make it
5833 ;; set things up.
5835 start-in-macro t))
5837 ;; The default arm of the `cond' moves back over any macro we're in
5838 ;; and over any syntactic WS. It sets `c-find-decl-syntactic-pos'.
5840 ;; Back out of any macro so we don't miss any declaration
5841 ;; that could follow after it.
5845 ;; Now we're at a proper syntactically relevant position so we
5846 ;; can use the cache. But first clear it if it applied
5847 ;; further down.
5852 ;; Don't have to do this if the cache is relevant here,
5853 ;; typically if the same line is refontified again. If
5854 ;; we're just some syntactic whitespace further down we can
5855 ;; still use the cache to limit the skipping.
5858 ;; If we hit `c-find-decl-syntactic-pos' and
5859 ;; `c-find-decl-match-pos' is set then we install the cached
5860 ;; values. If we hit `c-find-decl-syntactic-pos' and
5861 ;; `c-find-decl-match-pos' is nil then we know there's no decl
5862 ;; prefix in the whitespace before `c-find-decl-syntactic-pos'
5863 ;; and so we can continue the search from this point. If we
5864 ;; didn't hit `c-find-decl-syntactic-pos' then we're now in
5865 ;; the right spot to begin searching anyway.
5867 c-find-decl-match-pos)
5869 cfd-continue-pos syntactic-pos)
5874 ;; Always consider bob a match to get the first
5875 ;; declaration in the file. Do this separately instead of
5876 ;; letting `c-decl-prefix-or-start-re' match bob, so that
5877 ;; regexp always can consume at least one character to
5878 ;; ensure that we won't get stuck in an infinite loop.
5883 ;; Do an initial search now. In the bob case above it's
5884 ;; only done to search for a `c-decl-end' spot.
5890 ;; Advance `cfd-continue-pos' if it's before the start position.
5891 ;; The closest continue position that might have effect at or
5892 ;; after the start depends on what we started in. This also
5893 ;; finds a suitable start position in the special cases when the
5894 ;; region is completely within a literal or macro.
5899 ;; If we're in a macro then it's the closest preceding token
5900 ;; in the macro. Check this before `start-in-literal',
5901 ;; since if we're inside a literal in a macro, the preceding
5902 ;; token is earlier than any `c-decl-end' spot inside the
5903 ;; literal (comment).
5905 ;; The only syntactic ws in macros are comments.
5911 ;; If we're in a comment it can only be the closest
5912 ;; preceding `c-decl-end' position within that comment, if
5913 ;; any. Go back to the beginning of such a property so that
5914 ;; `c-find-decl-prefix-search' will find the end of it.
5915 ;; (Can't stop at the end and install it directly on
5916 ;; `cfd-prop-match' since that variable might be cleared
5917 ;; after `cfd-fun' below.)
5918 ;;
5919 ;; Note that if the literal is a string then the property
5920 ;; search will simply skip to the beginning of it right
5921 ;; away.
5933 ;; Didn't find any property inside the comment, so we can
5934 ;; skip it entirely. (This won't skip past a string, but
5935 ;; that'll be handled quickly by the next
5936 ;; `c-find-decl-prefix-search' anyway.)
5942 ;; If we started in normal code, the only match that might
5943 ;; apply before the start is what we already got in
5944 ;; `cfd-match-pos' so we can continue at the start position.
5945 ;; (Note that we don't get here if the first match is below
5946 ;; it.)
5949 ;; Delete found matches if they are before our new continue
5950 ;; position, so that `c-find-decl-prefix-search' won't back up
5951 ;; to them later on.
5959 ;; This is the normal case and we got a proper syntactic
5960 ;; position. If there's a match then it's always outside
5961 ;; macros and comments, so advance to the next token and set
5962 ;; `cfd-token-pos'. The loop below will later go back using
5963 ;; `cfd-continue-pos' to fix declarations inside the
5964 ;; syntactic ws.
5972 ;; Have one of the special cases when the region is completely
5973 ;; within a literal or macro. `cfd-continue-pos' is set to a
5974 ;; good start position for the search, so do it.
5977 ;; Now loop, one decl spot per iteration. We already have the first
5978 ;; match in `cfd-match-pos'.
5980 ;; Go forward over "false matches", one per iteration.
5985 ;; Kludge to filter out matches on the "<" that
5986 ;; aren't open parens, for the sake of languages
5987 ;; that got `c-recognize-<>-arglists' set.
5992 ;; If `cfd-continue-pos' is less or equal to
5993 ;; `cfd-token-pos', we've got a hit inside a macro
5994 ;; that's in the syntactic whitespace before the last
5995 ;; "real" declaration we've checked. If they're equal
5996 ;; we've arrived at the declaration a second time, so
5997 ;; there's nothing to do.
6001 ;; If `cfd-continue-pos' is less than `cfd-token-pos'
6002 ;; we're still searching for declarations embedded in
6003 ;; the syntactic whitespace. In that case we need
6004 ;; only to skip comments and not macros, since they
6005 ;; can't be nested, and that's already been done in
6006 ;; `c-find-decl-prefix-search'.
6011 ;; Continue if the following token fails the
6012 ;; CFD-DECL-RE and CFD-FACE-CHECKLIST checks.
6019 t)))
6030 ;; Narrow to the end of the macro if we got a hit inside
6031 ;; one, to avoid recognizing things that start inside the
6032 ;; macro and end outside it.
6034 ;; Not in the same macro as in the previous round.
6045 t
6048 t)
6049 ;; The matched token was the last thing in the macro,
6050 ;; so the whole match is bogus.
6061 ;; Restore limits if we did macro narrowing above.
6068 ; cfd-match-pos, etc.
6070 \f
6071 ;; A cache for found types.
6073 ;; Buffer local variable that contains an obarray with the types we've
6074 ;; found. If a declaration is recognized somewhere we record the
6075 ;; fully qualified identifier in it to recognize it as a type
6076 ;; elsewhere in the file too. This is not accurate since we do not
6077 ;; bother with the scoping rules of the languages, but in practice the
6078 ;; same name is seldom used as both a type and something else in a
6079 ;; file, and we only use this as a last resort in ambiguous cases (see
6080 ;; `c-forward-decl-or-cast-1').
6081 ;;
6082 ;; Not every type need be in this cache. However, things which have
6083 ;; ceased to be types must be removed from it.
6084 ;;
6085 ;; Template types in C++ are added here too but with the template
6086 ;; arglist replaced with "<>" in references or "<" for the one in the
6087 ;; primary type. E.g. the type "Foo<A,B>::Bar<C>" is stored as
6088 ;; "Foo<>::Bar<". This avoids storing very long strings (since C++
6089 ;; template specs can be fairly sized programs in themselves) and
6090 ;; improves the hit ratio (it's a type regardless of the template
6091 ;; args; it's just not the same type, but we're only interested in
6092 ;; recognizing types, not telling distinct types apart). Note that
6093 ;; template types in references are added here too; from the example
6094 ;; above there will also be an entry "Foo<".
6099 ;; Clears `c-found-types'.
6104 ;; Add the given region as a type in `c-found-types'. If the region
6105 ;; doesn't match an existing type but there is a type which is equal
6106 ;; to the given one except that the last character is missing, then
6107 ;; the shorter type is removed. That's done to avoid adding all
6108 ;; prefixes of a type as it's being entered and font locked. This
6109 ;; doesn't cover cases like when characters are removed from a type
6110 ;; or added in the middle. We'd need the position of point when the
6111 ;; font locking is invoked to solve this well.
6112 ;;
6113 ;; This function might do hidden buffer changes.
6120 ;; Remove the "NAME" from c-found-types, if present.
6124 ;; Return non-nil if the given region contains a type in
6125 ;; `c-found-types'.
6126 ;;
6127 ;; This function might do hidden buffer changes.
6131 ;; Return all the types in `c-found-types' as a sorted list of
6132 ;; strings.
6136 c-found-types)
6139 ;; Shut up the byte compiler.
6143 ;; An after change function which, in conjunction with the info in
6144 ;; c-maybe-stale-found-type (set in c-before-change), removes a type
6145 ;; from `c-found-types', should this type have become stale. For
6146 ;; example, this happens to "foo" when "foo \n bar();" becomes
6147 ;; "foo(); \n bar();". Such stale types, if not removed, foul up
6148 ;; the fontification.
6149 ;;
6150 ;; Have we, perhaps, added non-ws characters to the front/back of a found
6151 ;; type?
6171 ;; Changing the amount of (already existing) whitespace - don't do anything.
6176 ;; The syntactic relationship which defined a "found type" has been
6177 ;; destroyed.
6180 ;; ((eq (car c-maybe-stale-found-type) 'c-decl-type-start) FIXME!!!
6181 )))
6183 \f
6184 ;; Setting and removing syntax properties on < and > in languages (C++
6185 ;; and Java) where they can be template/generic delimiters as well as
6186 ;; their normal meaning of "less/greater than".
6188 ;; Normally, < and > have syntax 'punctuation'. When they are found to
6189 ;; be delimiters, they are marked as such with the category properties
6190 ;; c-<-as-paren-syntax, c->-as-paren-syntax respectively.
6192 ;; STRATEGY:
6193 ;;
6194 ;; It is impossible to determine with certainty whether a <..> pair in
6195 ;; C++ is two comparison operators or is template delimiters, unless
6196 ;; one duplicates a lot of a C++ compiler. For example, the following
6197 ;; code fragment:
6198 ;;
6199 ;; foo (a < b, c > d) ;
6200 ;;
6201 ;; could be a function call with two integer parameters (each a
6202 ;; relational expression), or it could be a constructor for class foo
6203 ;; taking one parameter d of templated type "a < b, c >". They are
6204 ;; somewhat easier to distinguish in Java.
6205 ;;
6206 ;; The strategy now (2010-01) adopted is to mark and unmark < and
6207 ;; > IN MATCHING PAIRS ONLY. [Previously, they were marked
6208 ;; individually when their context so indicated. This gave rise to
6209 ;; intractable problems when one of a matching pair was deleted, or
6210 ;; pulled into a literal.]
6211 ;;
6212 ;; At each buffer change, the syntax-table properties are removed in a
6213 ;; before-change function and reapplied, when needed, in an
6214 ;; after-change function. It is far more important that the
6215 ;; properties get removed when they they are spurious than that they
6216 ;; be present when wanted.
6217 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
6219 ;; POS (default point) is at a < character. If it is marked with
6220 ;; open paren syntax-table text property, remove the property,
6221 ;; together with the close paren property on the matching > (if
6222 ;; any).
6237 ;; POS (default point) is at a > character. If it is marked with
6238 ;; close paren syntax-table property, remove the property, together
6239 ;; with the open paren property on the matching < (if any).
6254 ;; POS (default point) is at a < or > character. If it has an
6255 ;; open/close paren syntax-table property, remove this property both
6256 ;; from the current character and its partner (which will also be
6257 ;; thusly marked).
6267 ;; POS (default point) is at a < character. If it is both marked
6268 ;; with open/close paren syntax-table property, and has a matching >
6269 ;; (also marked) which is after LIM, remove the property both from
6270 ;; the current > and its partner. Return t when this happens, nil
6271 ;; when it doesn't.
6285 t)))
6288 ;; POS (default point) is at a > character. If it is both marked
6289 ;; with open/close paren syntax-table property, and has a matching <
6290 ;; (also marked) which is before LIM, remove the property both from
6291 ;; the current < and its partner. Return t when this happens, nil
6292 ;; when it doesn't.
6306 t)))
6308 ;; Set by c-common-init in cc-mode.el.
6311 ;; Set by c-after-change in cc-mode.el.
6316 ;; Unmark certain pairs of "< .... >" which are currently marked as
6317 ;; template/generic delimiters. (This marking is via syntax-table text
6318 ;; properties), and expand the (c-new-BEG c-new-END) region to include all
6319 ;; unmarked < and > operators within the certain bounds (see below).
6320 ;;
6321 ;; These pairs are those which are in the current "statement" (i.e.,
6322 ;; the region between the {, }, or ; before BEG and the one after
6323 ;; END), and which enclose any part of the interval (BEG END).
6324 ;;
6325 ;; Note that in C++ (?and Java), template/generic parens cannot
6326 ;; enclose a brace or semicolon, so we use these as bounds on the
6327 ;; region we must work on.
6328 ;;
6329 ;; This function is called from before-change-functions (via
6330 ;; c-get-state-before-change-functions). Thus the buffer is widened,
6331 ;; and point is undefined, both at entry and exit.
6332 ;;
6333 ;; FIXME!!! This routine ignores the possibility of macros entirely.
6334 ;; 2010-01-29.
6339 new-beg new-end beg-limit end-limit)
6340 ;; Locate the earliest < after the barrier before the changed region,
6341 ;; which isn't already marked as a paren.
6345 ;; Remove the syntax-table/category properties from each pertinent <...>
6346 ;; pair. Firstly, the ones with the < before beg and > after beg....
6355 ;; ...Then the ones with < before end and > after end.
6366 ;; Extend the fontification region, if needed.
6375 ;; This is called from `after-change-functions' when
6376 ;; c-recognize-<>-arglists' is set. It ensures that no "<" or ">"
6377 ;; chars with paren syntax become part of another operator like "<<"
6378 ;; or ">=".
6379 ;;
6380 ;; This function might do hidden buffer changes.
6416 ;; This function is called as an after-change function. It restores the
6417 ;; category/syntax-table properties on template/generic <..> pairs between
6418 ;; c-new-BEG and c-new-END. It may do hidden buffer changes.
6439 \f
6440 ;; Functions to handle C++ raw strings.
6441 ;;
6442 ;; A valid C++ raw string looks like
6443 ;; R"<id>(<contents>)<id>"
6444 ;; , where <id> is an identifier from 0 to 16 characters long, not containing
6445 ;; spaces, control characters, double quote or left/right paren. <contents>
6446 ;; can include anything which isn't the terminating )<id>", including new
6447 ;; lines, "s, parentheses, etc.
6448 ;;
6449 ;; CC Mode handles C++ raw strings by the use of `syntax-table' text
6450 ;; properties as follows:
6451 ;;
6452 ;; (i) On a validly terminated raw string, no `syntax-table' text properties
6453 ;; are applied to the opening and closing delimiters, but any " in the
6454 ;; contents is given the property value "punctuation" (`(1)') to prevent it
6455 ;; interacting with the "s in the delimiters.
6456 ;;
6457 ;; The font locking routine `c-font-lock-c++-raw-strings' (in cc-fonts.el)
6458 ;; recognizes valid raw strings, and fontifies the delimiters (apart from
6459 ;; the parentheses) with the default face and the parentheses and the
6460 ;; <contents> with font-lock-string-face.
6461 ;;
6462 ;; (ii) A valid, but unterminated, raw string opening delimiter gets the
6463 ;; "punctuation" value (`(1)') of the `syntax-table' text property, and the
6464 ;; open parenthesis gets the "string fence" value (`(15)').
6465 ;;
6466 ;; `c-font-lock-c++-raw-strings' puts c-font-lock-warning-face on the entire
6467 ;; unmatched opening delimiter (from the R up to the open paren), and allows
6468 ;; the rest of the buffer to get font-lock-string-face, caused by the
6469 ;; unmatched "string fence" `syntax-table' text property value.
6470 ;;
6471 ;; (iii) Inside a macro, a valid raw string is handled as in (i). An
6472 ;; unmatched opening delimiter is handled slightly differently. In addition
6473 ;; to the "punctuation" and "string fence" properties on the delimiter,
6474 ;; another "string fence" `syntax-table' property is applied to the last
6475 ;; possible character of the macro before the terminating linefeed (if there
6476 ;; is such a character after the "("). This "last possible" character is
6477 ;; never a backslash escaping the end of line. If the character preceding
6478 ;; this "last possible" character is itself a backslash, this preceding
6479 ;; character gets a "punctuation" `syntax-table' value. If the "(" is
6480 ;; already at the end of the macro, it gets the "punctuation" value, and no
6481 ;; "string fence"s are used.
6482 ;;
6483 ;; The effect on the fontification of either of these tactics is that rest of
6484 ;; the macro (if any) after the "(" gets font-lock-string-face, but the rest
6485 ;; of the file is fontified normally.
6489 ;; Get POINT's relationship to any containing raw string.
6490 ;; If point isn't in a raw string, return nil.
6491 ;; Otherwise, return the following list:
6492 ;;
6493 ;; (POS B\" B\( E\) E\")
6494 ;;
6495 ;; , where POS is the symbol `open-delim' if point is in the opening
6496 ;; delimiter, the symbol `close-delim' if it's in the closing delimiter, and
6497 ;; nil if it's in the string body. B\", B\(, E\), E\" are the positions of
6498 ;; the opening and closing quotes and parentheses of a correctly terminated
6499 ;; raw string. (N.B.: E\) and E\" are NOT on the "outside" of these
6500 ;; characters.) If the raw string is not terminated, E\) and E\" are set to
6501 ;; nil.
6502 ;;
6503 ;; Note: this routine is dependant upon the correct syntax-table text
6504 ;; properties being set.
6506 open-quote-pos open-paren-pos close-paren-pos close-quote-pos id)
6538 open-quote-pos open-paren-pos close-paren-pos close-quote-pos))))
6541 ;; Point is immediately after a raw string opening delimiter. Remove any
6542 ;; `syntax-table' text properties associated with the delimiter (if it's
6543 ;; unmatched) or the raw string.
6544 ;;
6545 ;; ID, a string, is the delimiter's identifier. OPEN-QUOTE and OPEN-PAREN
6546 ;; are the buffer positions of the delimiter's components. BOUND is the
6547 ;; bound for searching for a matching closing delimiter; it is usually nil,
6548 ;; but if we're inside a macro, it's the end of the macro.
6549 ;;
6550 ;; Point is moved to after the (terminated) raw string, or left after the
6551 ;; unmatched opening delimiter, as the case may be. The return value is of
6552 ;; no significance.
6556 ;; A terminated raw string
6563 closing-paren)
6565 )
6570 ))))
6573 ;; An unterminated raw string either not in a macro, or in a macro with
6574 ;; the open parenthesis right up against the end of macro
6579 ;; An unterminated string in a macro, with at least one char after the
6580 ;; open paren
6590 ))))
6593 ;; Remove any `syntax-table' text properties associated with C++ raw strings
6594 ;; contained in the region (START FINISH). Point is undefined at entry and
6595 ;; exit, and the return value has no significance.
6600 c-anchored-cpp-prefix ; 2
6604 finish t))
6608 ;; We've found a raw string
6614 ;; We've found a CPP construct. Search for raw strings within it.
6629 ;; This function clears `syntax-table' text properties from C++ raw strings
6630 ;; in the region (c-new-BEG c-new-END). BEG and END are the standard
6631 ;; arguments supplied to any before-change function.
6632 ;;
6633 ;; Point is undefined on both entry and exit, and the return value has no
6634 ;; significance.
6635 ;;
6636 ;; This function is called as a before-change function solely due to its
6637 ;; membership of the C++ value of `c-get-state-before-change-functions'.
6641 beg
6645 ; Optimize this so that we don't call
6646 ; `c-raw-string-pos' twice when once
6647 ; will do. (2016-06-02).
6649 end
6651 )
6663 ;; Point is immediately after a raw string opening delimiter. Apply any
6664 ;; pertinent `syntax-table' text properties to the delimiter and also the
6665 ;; raw string, should there be a valid matching closing delimiter.
6666 ;;
6667 ;; ID, a string, is the delimiter's identifier. OPEN-QUOTE and OPEN-PAREN
6668 ;; are the buffer positions of the delimiter's components. BOUND is the
6669 ;; bound for searching for a matching closing delimiter; it is usually nil,
6670 ;; but if we're inside a macro, it's the end of the macro.
6671 ;;
6672 ;; Point is moved to after the (terminated) raw string, or left after the
6673 ;; unmatched opening delimiter, as the case may be. The return value is of
6674 ;; no significance.
6689 ;; In a CPP construct, we try to apply a generic-string `syntax-table'
6690 ;; text property to the last possible character in the string, so that
6691 ;; only characters within the macro get "stringed out".
6697 ;; This regular expression matches either an escape pair (which
6698 ;; isn't an escaped NL) (submatch 5) or a non-escaped character
6699 ;; (which isn't itself a backslash) (submatch 10). The long
6700 ;; preambles to these (respectively submatches 2-4 and 6-9)
6701 ;; ensure that we have the correct parity for sequences of
6702 ;; backslashes, etc..
6723 ;; This function applies `syntax-table' text properties to C++ raw strings
6724 ;; beginning in the region (c-new-BEG c-new-END). BEG, END, and OLD-LEN are
6725 ;; the standard arguments supplied to any after-change function.
6726 ;;
6727 ;; Point is undefined on both entry and exit, and the return value has no
6728 ;; significance.
6729 ;;
6730 ;; This function is called as an after-change function solely due to its
6731 ;; membership of the C++ value of `c-before-font-lock-functions'.
6733 ;; If the region (c-new-BEG c-new-END) has expanded, remove
6734 ;; `syntax-table' text-properties from the new piece(s).
6738 c-new-BEG
6741 c-old-BEG))))
6747 c-old-END)
6748 c-new-END)))
6754 c-anchored-cpp-prefix ; 2
6758 c-new-END t))
6762 ;; We've found a raw string.
6768 ;; We've found a CPP construct. Search for raw strings within it.
6782 \f
6783 ;; Handling of small scale constructs like types and names.
6785 ;; Dynamically bound variable that instructs `c-forward-type' to also
6786 ;; treat possible types (i.e. those that it normally returns 'maybe or
6787 ;; 'found for) as actual types (and always return 'found for them).
6788 ;; This means that it records them in `c-record-type-identifiers' if
6789 ;; that is set, and that it adds them to `c-found-types'.
6792 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
6793 ;; mark up successfully parsed arglists with paren syntax properties on
6794 ;; the surrounding angle brackets and with `c-<>-arg-sep' in the
6795 ;; `c-type' property of each argument separating comma.
6796 ;;
6797 ;; Setting this variable also makes `c-forward-<>-arglist' recurse into
6798 ;; all arglists for side effects (i.e. recording types), otherwise it
6799 ;; exploits any existing paren syntax properties to quickly jump to the
6800 ;; end of already parsed arglists.
6801 ;;
6802 ;; Marking up the arglists is not the default since doing that correctly
6803 ;; depends on a proper value for `c-restricted-<>-arglists'.
6806 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
6807 ;; not accept arglists that contain binary operators.
6808 ;;
6809 ;; This is primarily used to handle C++ template arglists. C++
6810 ;; disambiguates them by checking whether the preceding name is a
6811 ;; template or not. We can't do that, so we assume it is a template
6812 ;; if it can be parsed as one. That usually works well since
6813 ;; comparison expressions on the forms "a < b > c" or "a < b, c > d"
6814 ;; in almost all cases would be pointless.
6815 ;;
6816 ;; However, in function arglists, e.g. in "foo (a < b, c > d)", we
6817 ;; should let the comma separate the function arguments instead. And
6818 ;; in a context where the value of the expression is taken, e.g. in
6819 ;; "if (a < b || c > d)", it's probably not a template.
6822 ;; Dynamically bound variables that instructs
6823 ;; `c-forward-keyword-clause', `c-forward-<>-arglist',
6824 ;; `c-forward-name', `c-forward-type', `c-forward-decl-or-cast-1', and
6825 ;; `c-forward-label' to record the ranges of all the type and
6826 ;; reference identifiers they encounter. They will build lists on
6827 ;; these variables where each element is a cons of the buffer
6828 ;; positions surrounding each identifier. This recording is only
6829 ;; activated when `c-record-type-identifiers' is non-nil.
6830 ;;
6831 ;; All known types that can't be identifiers are recorded, and also
6832 ;; other possible types if `c-promote-possible-types' is set.
6833 ;; Recording is however disabled inside angle bracket arglists that
6834 ;; are encountered inside names and other angle bracket arglists.
6835 ;; Such occurrences are taken care of by `c-font-lock-<>-arglists'
6836 ;; instead.
6837 ;;
6838 ;; Only the names in C++ template style references (e.g. "tmpl" in
6839 ;; "tmpl<a,b>::foo") are recorded as references, other references
6840 ;; aren't handled here.
6841 ;;
6842 ;; `c-forward-label' records the label identifier(s) on
6843 ;; `c-record-ref-identifiers'.
6847 ;; This variable will receive a cons cell of the range of the last
6848 ;; single identifier symbol stepped over by `c-forward-name' if it's
6849 ;; successful. This is the range that should be put on one of the
6850 ;; record lists above by the caller. It's assigned nil if there's no
6851 ;; such symbol in the name.
6856 ;; Always true.
6866 ;; Always true.
6874 ;; Dynamically bound variable that instructs `c-forward-type' to
6875 ;; record the ranges of types that only are found. Behaves otherwise
6876 ;; like `c-record-type-identifiers'.
6880 ;; Used internally in `c-forward-keyword-clause' to move forward
6881 ;; over a type (if TYPE is 'type) or a name (otherwise) which
6882 ;; possibly is prefixed by keywords and their associated clauses.
6883 ;; Try with a type/name first to not trip up on those that begin
6884 ;; with a keyword. Return t if a known or found type is moved
6885 ;; over. The point is clobbered if nil is returned. If range
6886 ;; recording is enabled, the identifier is recorded on as a type
6887 ;; if TYPE is 'type or as a reference if TYPE is 'ref.
6888 ;;
6889 ;; This macro might do hidden buffer changes.
6895 nil
6906 t)))
6909 ;; Used internally in `c-forward-keyword-clause' to move forward
6910 ;; over a comma separated list of types or names using
6911 ;; `c-forward-keyword-prefixed-id'.
6912 ;;
6913 ;; This macro might do hidden buffer changes.
6924 ;; Point is at a c-noise-macro-with-parens-names macro identifier. Go
6925 ;; forward over this name, any parenthesis expression which follows it, and
6926 ;; any syntactic WS, ending up at the next token. If there is an unbalanced
6927 ;; paren expression, leave point at it. Always Return t.
6932 t)
6935 ;; Submatch MATCH in the current match data is assumed to surround a
6936 ;; token. If it's a keyword, move over it and any immediately
6937 ;; following clauses associated with it, stopping at the start of
6938 ;; the next token. t is returned in that case, otherwise the point
6939 ;; stays and nil is returned. The kind of clauses that are
6940 ;; recognized are those specified by `c-type-list-kwds',
6941 ;; `c-ref-list-kwds', `c-colon-type-list-kwds',
6942 ;; `c-paren-nontype-kwds', `c-paren-type-kwds', `c-<>-type-kwds',
6943 ;; `c-<>-arglist-kwds', and `c-protection-kwds'.
6944 ;;
6945 ;; This function records identifier ranges on
6946 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6947 ;; `c-record-type-identifiers' is non-nil.
6948 ;;
6949 ;; Note that for `c-colon-type-list-kwds', which doesn't necessary
6950 ;; apply directly after the keyword, the type list is moved over
6951 ;; only when there is no unaccounted token before it (i.e. a token
6952 ;; that isn't moved over due to some other keyword list). The
6953 ;; identifier ranges in the list are still recorded if that should
6954 ;; be done, though.
6955 ;;
6956 ;; This function might do hidden buffer changes.
6959 ;; The call to `c-forward-<>-arglist' below is made after
6960 ;; `c-<>-sexp-kwds' keywords, so we're certain they actually
6961 ;; are angle bracket arglists and `c-restricted-<>-arglists'
6962 ;; should therefore be nil.
6974 ;; There's a type directly after a keyword in `c-type-list-kwds'.
6979 ;; There's a name directly after a keyword in `c-ref-list-kwds'.
6984 ;; There's an open paren after a keyword in `c-paren-any-kwds'.
6991 ;; Use `c-forward-type' on every identifier we can find
6992 ;; inside the paren, to record the types.
7028 ;; If we are at the colon already, we move over the type
7029 ;; list after it.
7035 ;; Not at the colon, so stop here. But the identifier
7036 ;; ranges in the type list later on should still be
7037 ;; recorded.
7040 ;; If a keyword matched both one of the types above and
7041 ;; this one, we match `c-colon-type-list-re' after the
7042 ;; clause matched above.
7049 ;; There's a type after the `c-colon-type-list-re' match
7050 ;; after a keyword in `c-colon-type-list-kwds'.
7054 t)))
7056 ;; cc-mode requires cc-fonts.
7060 ;; The point is assumed to be at a "<". Try to treat it as the open
7061 ;; paren of an angle bracket arglist and move forward to the
7062 ;; corresponding ">". If successful, the point is left after the
7063 ;; ">" and t is returned, otherwise the point isn't moved and nil is
7064 ;; returned. If ALL-TYPES is t then all encountered arguments in
7065 ;; the arglist that might be types are treated as found types.
7066 ;;
7067 ;; The variable `c-parse-and-markup-<>-arglists' controls how this
7068 ;; function handles text properties on the angle brackets and argument
7069 ;; separating commas.
7070 ;;
7071 ;; `c-restricted-<>-arglists' controls how lenient the template
7072 ;; arglist recognition should be.
7073 ;;
7074 ;; This function records identifier ranges on
7075 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
7076 ;; `c-record-type-identifiers' is non-nil.
7077 ;;
7078 ;; This function might do hidden buffer changes.
7082 ;; If `c-record-type-identifiers' is set then activate
7083 ;; recording of any found types that constitute an argument in
7084 ;; the arglist.
7092 ;; `nconc' doesn't mind that the tail of
7093 ;; `c-record-found-types' is t.
7095 t)
7099 nil)))
7102 ;; Recursive part of `c-forward-<>-arglist'.
7103 ;;
7104 ;; This function might do hidden buffer changes.
7106 ;; Cover this so that any recorded found type ranges are
7107 ;; automatically lost if it turns out to not be an angle
7108 ;; bracket arglist. It's propagated through the return value
7109 ;; on successful completion.
7111 ;; List that collects the positions after the argument
7112 ;; separating ',' in the arglist.
7113 arg-start-pos)
7114 ;; If the '<' has paren open syntax then we've marked it as an angle
7115 ;; bracket arglist before, so skip to the end.
7123 t
7124 ;; Got unmatched paren angle brackets. We don't clear the paren
7125 ;; syntax properties and retry, on the basis that it's very
7126 ;; unlikely that paren angle brackets become operators by code
7127 ;; manipulation. It's far more likely that it doesn't match due
7128 ;; to narrowing or some temporary change.
7130 nil))
7135 ;; go forward one non-alphanumeric character (group) per iteration of
7136 ;; this loop.
7150 ;; All encountered identifiers are types, so set the
7151 ;; promote flag and parse the type.
7169 ;; Note: These regexps exploit the match order in \| so
7170 ;; that "<>" is matched by "<" rather than "[^>:-]>".
7172 ;; Stop on ',', '|', '&', '+' and '-' to catch
7173 ;; common binary operators that could be between
7174 ;; two comparison expressions "a<b" and "c>d".
7175 ;; 2016-02-11: C++11 templates can now contain arithmetic
7176 ;; expressions, so template detection in C++ is now less
7177 ;; robust than it was.
7178 c-<>-notable-chars-re
7179 nil t t))
7183 ;; Either an operator starting with '>' or the end of
7184 ;; the angle bracket arglist.
7193 ;; The angle bracket arglist is finished.
7205 ;; Either an operator starting with '<' or a nested arglist.
7209 ;; The '<' begins a multi-char operator.
7212 ;; We're at a nested <.....>
7217 ;; There's always an identifier before an angle
7218 ;; bracket arglist, or a keyword in `c-<>-type-kwds'
7219 ;; or `c-<>-arglist-kwds'.
7236 subres)
7237 ;; It was an angle bracket arglist.
7240 ;; Record the identifier before the template as a type
7241 ;; or reference depending on whether the arglist is last
7242 ;; in a qualified identifier.
7252 ;; At a "less than" operator.
7254 ;; (forward-char) ; NO! We've already gone over the <.
7255 )))
7267 ;; Just another argument. Record the position. The
7268 ;; type check stuff that made us stop at it is at
7269 ;; the top of the loop.
7273 ;; Got a character that can't be in an angle bracket
7274 ;; arglist argument. Abort using `throw', since
7275 ;; it's useless to try to find a surrounding arglist
7276 ;; if we're nested.
7282 ;; The point is assumed to be directly after a ">". Try to treat it
7283 ;; as the close paren of an angle bracket arglist and move back to
7284 ;; the corresponding "<". If successful, the point is left at
7285 ;; the "<" and t is returned, otherwise the point isn't moved and
7286 ;; nil is returned. ALL-TYPES is passed on to
7287 ;; `c-forward-<>-arglist'.
7288 ;;
7289 ;; If the optional LIMIT is given, it bounds the backward search.
7290 ;; It's then assumed to be at a syntactically relevant position.
7291 ;;
7292 ;; This is a wrapper around `c-forward-<>-arglist'. See that
7293 ;; function for more details.
7302 t
7303 ;; See corresponding note in `c-forward-<>-arglist'.
7305 nil)
7312 t
7313 ;; Stopped at bob or a char that isn't allowed in an
7314 ;; arglist, so we've failed.
7316 nil)
7321 ;; If we moved then the "<" was part of some
7322 ;; multicharacter token.
7323 t
7329 ;; Matched the arglist. Break the while.
7331 nil)
7333 ;; We started from a non-paren ">" inside an
7334 ;; arglist.
7336 nil)
7338 ;; Matched a shorter arglist. Can be a nested
7339 ;; one so continue looking.
7341 t))
7342 t))))))
7347 ;; Move forward over a complete name if at the beginning of one,
7348 ;; stopping at the next following token. A keyword, as such,
7349 ;; doesn't count as a name. If the point is not at something that
7350 ;; is recognized as a name then it stays put.
7351 ;;
7352 ;; A name could be something as simple as "foo" in C or something as
7353 ;; complex as "X<Y<class A<int>::B, BIT_MAX >> b>, ::operator<> ::
7354 ;; Z<(a>b)> :: operator const X<&foo>::T Q::G<unsigned short
7355 ;; int>::*volatile const" in C++ (this function is actually little
7356 ;; more than a `looking-at' call in all modes except those that,
7357 ;; like C++, have `c-recognize-<>-arglists' set).
7358 ;;
7359 ;; Return
7360 ;; o - nil if no name is found;
7361 ;; o - 'template if it's an identifier ending with an angle bracket
7362 ;; arglist;
7363 ;; o - 'operator of it's an operator identifier;
7364 ;; o - t if it's some other kind of name.
7365 ;;
7366 ;; This function records identifier ranges on
7367 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
7368 ;; `c-record-type-identifiers' is non-nil.
7369 ;;
7370 ;; This function might do hidden buffer changes.
7373 ;; Turn off `c-promote-possible-types' here since we might
7374 ;; call `c-forward-<>-arglist' and we don't want it to promote
7375 ;; every suspect thing in the arglist to a type. We're
7376 ;; typically called from `c-forward-type' in this case, and
7377 ;; the caller only wants the top level type that it finds to
7378 ;; be promoted.
7379 c-promote-possible-types)
7385 ;; Check for keyword. We go to the last symbol in
7386 ;; `c-identifier-key' first.
7399 ;; "template" is only valid inside an
7400 ;; identifier if preceded by "::".
7405 t))
7407 ;; Handle a C++ operator or template identifier.
7411 ;; Got "... ::template".
7415 res subres))))
7419 c-ambiguous-overloadable-or-identifier-prefix-re))
7423 ;; Got a cast operator.
7427 ;; Now we should match a sequence of either
7428 ;; '*', '&' or a name followed by ":: *",
7429 ;; where each can be followed by a sequence
7430 ;; of `c-opt-type-modifier-key'.
7433 t)
7443 t))))
7451 ;; Got some other operator.
7459 nil)
7461 ;; `id-start' is equal to `id-end' if we've jumped over
7462 ;; an identifier that doesn't end with a symbol token.
7463 ;; That can occur e.g. for Java import directives on the
7464 ;; form "foo.bar.*".
7471 res t)))
7481 ;; Got a concatenated identifier. This handles the
7482 ;; cases with tricky syntactic whitespace that aren't
7483 ;; covered in `c-identifier-key'.
7486 t)
7490 ;; Maybe an angle bracket arglist.
7503 ;; Continue if there's an identifier concatenation
7504 ;; operator after the template argument.
7510 t)
7516 nil)))
7517 )))))
7520 res))
7523 ;; Move forward over a type spec if at the beginning of one,
7524 ;; stopping at the next following token. The keyword "typedef"
7525 ;; isn't part of a type spec here.
7526 ;;
7527 ;; BRACE-BLOCK-TOO, when non-nil, means move over the brace block in
7528 ;; constructs like "struct foo {...} bar ;" or "struct {...} bar;".
7529 ;; The current (2009-03-10) intention is to convert all uses of
7530 ;; `c-forward-type' to call with this parameter set, then to
7531 ;; eliminate it.
7532 ;;
7533 ;; Return
7534 ;; o - t if it's a known type that can't be a name or other
7535 ;; expression;
7536 ;; o - 'known if it's an otherwise known type (according to
7537 ;; `*-font-lock-extra-types');
7538 ;; o - 'prefix if it's a known prefix of a type;
7539 ;; o - 'found if it's a type that matches one in `c-found-types';
7540 ;; o - 'maybe if it's an identifier that might be a type;
7541 ;; o - 'decltype if it's a decltype(variable) declaration; - or
7542 ;; o - nil if it can't be a type (the point isn't moved then).
7543 ;;
7544 ;; The point is assumed to be at the beginning of a token.
7545 ;;
7546 ;; Note that this function doesn't skip past the brace definition
7547 ;; that might be considered part of the type, e.g.
7548 ;; "enum {a, b, c} foo".
7549 ;;
7550 ;; This function records identifier ranges on
7551 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
7552 ;; `c-record-type-identifiers' is non-nil.
7553 ;;
7554 ;; This function might do hidden buffer changes.
7562 ;; Skip leading type modifiers. If any are found we know it's a
7563 ;; prefix of a type.
7582 ; "typedef".
7601 ;; In many languages the name can be used without the
7602 ;; prefix, so we add it to `c-found-types'.
7605 c-last-identifier-range)
7627 id-range c-last-identifier-range))))
7639 id-end)
7641 ;; Looking at a primitive or known type identifier. We've
7642 ;; checked for a name first so that we don't go here if the
7643 ;; known type match only is a prefix of another name.
7654 ;; There might be more keywords for the type.
7682 ;; A normal identifier.
7692 ;; It's an identifier that has been used as
7693 ;; a type somewhere else.
7694 'found
7695 ;; It's an identifier that might be a type.
7698 ;; A template is sometimes a type.
7704 ;; It's an identifier that has been used as
7705 ;; a type somewhere else.
7706 'found
7707 ;; It's an identifier that might be a type.
7709 t)))
7711 ;; Otherwise it's an operator identifier, which is not a type.
7716 ;; Skip trailing type modifiers. If any are found we know it's
7717 ;; a type.
7724 ;; Step over any type suffix operator. Do not let the existence
7725 ;; of these alter the classification of the found type, since
7726 ;; these operators typically are allowed in normal expressions
7727 ;; too.
7733 ;; Skip any "WS" identifiers (e.g. "final" or "override" in C++)
7740 ;; Look for a trailing operator that concatenates the type
7741 ;; with a following one, and if so step past that one through
7742 ;; a recursive call. Note that we don't record concatenated
7743 ;; types in `c-found-types' - it's the component types that
7744 ;; are recorded when appropriate.
7747 c-promote-possible-types))
7748 ;; If we can't promote then set `c-record-found-types' so that
7749 ;; we can merge in the types from the second part afterwards if
7750 ;; it turns out to be a known type there.
7753 subres)
7762 ;; If either operand certainly is a type then both are, but we
7763 ;; don't let the existence of the operator itself promote two
7764 ;; uncertain types to a certain one.
7783 ;; Merge in the ranges of any types found by the second
7784 ;; `c-forward-type'.
7786 ;; `nconc' doesn't mind that the tail of
7787 ;; `c-record-found-types' is t.
7789 c-record-type-identifiers))))
7797 ;;(message "c-forward-type %s -> %s: %s" start (point) res)
7799 res))
7802 ;; Used for Java code only at the moment. Assumes point is on the @, moves
7803 ;; forward an annotation and returns t. Leaves point unmoved and returns
7804 ;; nil if there is no annotation at point.
7813 t)
7816 t))
7820 ;; Pull the next open brace from PS (which has the form of paren-state),
7821 ;; skipping over any brace pairs. Returns NIL when PS is exhausted.
7829 ;; Point is putatively just after a "compound identifier", i.e. something
7830 ;; looking (in C++) like this "FQN::of::base::Class". Move to the start of
7831 ;; this construct and return t. If the parsing fails, return nil, leaving
7832 ;; point unchanged.
7835 nil
7843 c-opt-identifier-concat-key
7850 t)))
7853 ;; Point is just after a closing brace/parenthesis. Try to parse this as a
7854 ;; C++ member initializer list, going back to just after the introducing ":"
7855 ;; and returning t. Otherwise return nil, leaving point unchanged.
7880 res))
7883 ;; Go back over a list of elements, each looking like:
7884 ;; <symbol> (<expression>) ,
7885 ;; or <symbol> {<expression>} , (with possibly a <....> expressions
7886 ;; following the <symbol>).
7887 ;; when we are putatively immediately after a comma. Stop when we don't see
7888 ;; a comma. If either of <symbol> or bracketed <expression> is missing,
7889 ;; throw nil to 'level. If the terminating } or ) is unmatched, throw nil
7890 ;; to 'done. This is not a general purpose macro!
7908 ;; Test whether we are in a C++ member initializer list, and if so, go back
7909 ;; to the introducing ":", returning the position of the opening paren of
7910 ;; the function's arglist. Otherwise return nil, leaving point unchanged.
7913 pos level-plausible at-top-level res)
7914 ;; Assume tentatively that we're at the top level. Try to go back to the
7915 ;; colon we seek.
7953 res))
7955 \f
7956 ;; Handling of large scale constructs like statements and declarations.
7958 ;; Macro used inside `c-forward-decl-or-cast-1'. It ought to be a
7959 ;; defsubst or perhaps even a defun, but it contains lots of free
7960 ;; variables that refer to things inside `c-forward-decl-or-cast-1'.
7962 ;; `c-forward-decl-or-cast-1' can consume an arbitrary length list
7963 ;; of types when parsing a declaration, which means that it
7964 ;; sometimes consumes the identifier in the declaration as a type.
7965 ;; This is used to "backtrack" and make the last type be treated as
7966 ;; an identifier instead.
7969 ;; These identifiers are bound only in the inner let.
7971 identifier-start type-start
7972 got-parens nil
7973 got-identifier t
7974 got-suffix t
7975 got-suffix-after-parens id-start
7979 t
7980 backup-at-type))
7982 id-start backup-id-start)
7984 id-start start-pos))
7986 ;; When these flags already are set we've found specifiers that
7987 ;; unconditionally signal these attributes - backtracking doesn't
7988 ;; change that. So keep them set in that case.
7995 ;; This identifier is bound only in the inner let.
7999 ;; Assuming point is at the start of a declarator, move forward over it,
8000 ;; leaving point at the next token after it (e.g. a ) or a ; or a ,).
8001 ;;
8002 ;; Return a list (ID-START ID-END BRACKETS-AFTER-ID GOT-INIT DECORATED),
8003 ;; where ID-START and ID-END are the bounds of the declarator's identifier,
8004 ;; and BRACKETS-AFTER-ID is non-nil if a [...] pair is present after the id.
8005 ;; GOT-INIT is non-nil when the declarator is followed by "=" or "(",
8006 ;; DECORATED is non-nil when the identifier is embellished by an operator,
8007 ;; like "*x", or "(*x)".
8008 ;;
8009 ;; If ACCEPT-ANON is non-nil, move forward over any "anonymous declarator",
8010 ;; i.e. something like the (*) in int (*), such as might be found in a
8011 ;; declaration. In such a case ID-START and ID-END in the return value are
8012 ;; both set to nil. A "null" "anonymous declarator" gives a non-nil result.
8013 ;;
8014 ;; If no declarator is found, leave point unmoved and return nil. LIMIT is
8015 ;; an optional limit for forward searching.
8016 ;;
8017 ;; Note that the global variable `c-last-identifier-range' is written to, so
8018 ;; the caller should bind it if necessary.
8020 ;; Inside the following "condition form", we move forward over the
8021 ;; declarator's identifier up as far as any opening bracket (for array
8022 ;; size) or paren (for parameters of function-type) or brace (for
8023 ;; array/struct initialization) or "=" or terminating delimiter
8024 ;; (e.g. "," or ";" or "}").
8026 id-start id-end brackets-after-id paren-depth decorated)
8031 ;; The following form moves forward over the declarator's
8032 ;; identifier (and what precedes it), returning t. If there
8033 ;; wasn't one, it returns nil.
8036 ;; Skip over type decl prefix operators, one for each iteration
8037 ;; of the while. These are, e.g. "*" in "int *foo" or "(" and
8038 ;; "*" in "int (*foo) (void)" (Note similar code in
8039 ;; `c-forward-decl-or-cast-1'.)
8050 ;; If the third submatch matches in C++ then
8051 ;; we're looking at an identifier that's a
8052 ;; prefix only if it specifies a member pointer.
8057 ;; We only check for a trailing "::" and
8058 ;; let the "*" that should follow be
8059 ;; matched in the next round.
8060 t
8061 ;; It turned out to be the real identifier,
8062 ;; so flag that and stop.
8064 nil))
8065 t))
8074 t)))
8076 ;; If we haven't passed the identifier already, do it now.
8087 t)
8090 ;; Skip out of the parens surrounding the identifier. If closing
8091 ;; parens are missing, this form returns nil.
8097 ;; Skip over any trailing bit, such as "__attribute__".
8107 ;; Search syntactically to the end of the declarator (";",
8108 ;; ",", a closing paren, eob etc) or to the beginning of an
8109 ;; initializer or function prototype ("=" or "\\s\(").
8110 ;; Note that square brackets are now not also treated as
8111 ;; initializers, since this broke when there were also
8112 ;; initializing brace lists.
8117 ;; In the next loop, we keep searching forward whilst
8118 ;; we find ":"s which aren't single colons inside C++
8119 ;; "for" statements.
8126 limit t t))
8139 found)
8148 nil)))
8151 ;; Move forward over a declaration or a cast if at the start of one.
8152 ;; The point is assumed to be at the start of some token. Nil is
8153 ;; returned if no declaration or cast is recognized, and the point
8154 ;; is clobbered in that case.
8155 ;;
8156 ;; If a declaration is parsed:
8157 ;;
8158 ;; The point is left at the first token after the first complete
8159 ;; declarator, if there is one. The return value is a list of 5 elements,
8160 ;; where the first is the position of the first token in the declarator.
8161 ;; (See below for the other four.)
8162 ;; Some examples:
8163 ;;
8164 ;; void foo (int a, char *b) stuff ...
8165 ;; car ^ ^ point
8166 ;; float (*a)[], b;
8167 ;; car ^ ^ point
8168 ;; unsigned int a = c_style_initializer, b;
8169 ;; car ^ ^ point
8170 ;; unsigned int a (cplusplus_style_initializer), b;
8171 ;; car ^ ^ point (might change)
8172 ;; class Foo : public Bar {}
8173 ;; car ^ ^ point
8174 ;; class PikeClass (int a, string b) stuff ...
8175 ;; car ^ ^ point
8176 ;; enum bool;
8177 ;; car ^ ^ point
8178 ;; enum bool flag;
8179 ;; car ^ ^ point
8180 ;; void cplusplus_function (int x) throw (Bad);
8181 ;; car ^ ^ point
8182 ;; Foo::Foo (int b) : Base (b) {}
8183 ;; car ^ ^ point
8184 ;;
8185 ;; auto foo = 5;
8186 ;; car ^ ^ point
8187 ;; auto cplusplus_11 (int a, char *b) -> decltype (bar):
8188 ;; car ^ ^ point
8189 ;;
8190 ;;
8191 ;;
8192 ;; The second element of the return value is non-nil when a
8193 ;; `c-typedef-decl-kwds' specifier is found in the declaration.
8194 ;; Specifically it is a dotted pair (A . B) where B is t when a
8195 ;; `c-typedef-kwds' ("typedef") is present, and A is t when some
8196 ;; other `c-typedef-decl-kwds' (e.g. class, struct, enum)
8197 ;; specifier is present. I.e., (some of) the declared
8198 ;; identifier(s) are types.
8199 ;;
8200 ;; The third element of the return value is non-nil when the declaration
8201 ;; parsed might be an expression. The fourth element is the position of
8202 ;; the start of the type identifier. The fifth element is t if either
8203 ;; CONTEXT was 'top, or the declaration is detected to be treated as top
8204 ;; level (e.g. with the keyword "extern").
8205 ;;
8206 ;; If a cast is parsed:
8207 ;;
8208 ;; The point is left at the first token after the closing paren of
8209 ;; the cast. The return value is `cast'. Note that the start
8210 ;; position must be at the first token inside the cast parenthesis
8211 ;; to recognize it.
8212 ;;
8213 ;; PRECEDING-TOKEN-END is the first position after the preceding
8214 ;; token, i.e. on the other side of the syntactic ws from the point.
8215 ;; Use a value less than or equal to (point-min) if the point is at
8216 ;; the first token in (the visible part of) the buffer.
8217 ;;
8218 ;; CONTEXT is a symbol that describes the context at the point:
8219 ;; 'decl In a comma-separated declaration context (typically
8220 ;; inside a function declaration arglist).
8221 ;; '<> In an angle bracket arglist.
8222 ;; 'arglist Some other type of arglist.
8223 ;; 'top Some other context and point is at the top-level (either
8224 ;; outside any braces or directly inside a class or namespace,
8225 ;; etc.)
8226 ;; nil Some other context or unknown context. Includes
8227 ;; within the parens of an if, for, ... construct.
8228 ;; 'not-decl This value is never supplied to this function. It
8229 ;; would mean we're definitely not in a declaration.
8230 ;;
8231 ;; LAST-CAST-END is the first token after the closing paren of a
8232 ;; preceding cast, or nil if none is known. If
8233 ;; `c-forward-decl-or-cast-1' is used in succession, it should be
8234 ;; the position after the closest preceding call where a cast was
8235 ;; matched. In that case it's used to discover chains of casts like
8236 ;; "(a) (b) c".
8237 ;;
8238 ;; This function records identifier ranges on
8239 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
8240 ;; `c-record-type-identifiers' is non-nil.
8241 ;;
8242 ;; This function might do hidden buffer changes.
8245 ;; first type, i.e. after any leading specifiers. It might
8246 ;; also point at the beginning of the preceding syntactic
8247 ;; whitespace.
8249 ;; Set to the result of `c-forward-type'.
8250 at-type
8251 ;; The position of the first token in what we currently
8252 ;; believe is the type in the declaration or cast, after any
8253 ;; specifiers and their associated clauses.
8254 type-start
8255 ;; The position of the first token in what we currently
8256 ;; believe is the declarator for the first identifier. Set
8257 ;; when the type is found, and moved forward over any
8258 ;; `c-decl-hangon-kwds' and their associated clauses that
8259 ;; occurs after the type.
8260 id-start
8261 ;; These store `at-type', `type-start' and `id-start' of the
8262 ;; identifier before the one in those variables. The previous
8263 ;; identifier might turn out to be the real type in a
8264 ;; declaration if the last one has to be the declarator in it.
8265 ;; If `backup-at-type' is nil then the other variables have
8266 ;; undefined values.
8267 backup-at-type backup-type-start backup-id-start
8268 ;; Set if we've found a specifier (apart from "typedef") that makes
8269 ;; the defined identifier(s) types.
8270 at-type-decl
8271 ;; Set if we've a "typedef" keyword.
8272 at-typedef
8273 ;; Set if we've found a specifier that can start a declaration
8274 ;; where there's no type.
8275 maybe-typeless
8276 ;; Save the value of kwd-sym between loops of the "Check for a
8277 ;; type" loop. Needed to distinguish a C++11 "auto" from a pre
8278 ;; C++11 one.
8279 prev-kwd-sym
8280 ;; If a specifier is found that also can be a type prefix,
8281 ;; these flags are set instead of those above. If we need to
8282 ;; back up an identifier, they are copied to the real flag
8283 ;; variables. Thus they only take effect if we fail to
8284 ;; interpret it as a type.
8285 backup-at-type-decl backup-maybe-typeless
8286 ;; Whether we've found a declaration or a cast. We might know
8287 ;; this before we've found the type in it. It's 'ids if we've
8288 ;; found two consecutive identifiers (usually a sure sign, but
8289 ;; we should allow that in labels too), and t if we've found a
8290 ;; specifier keyword (a 100% sure sign).
8291 at-decl-or-cast
8292 ;; Set when we need to back up to parse this as a declaration
8293 ;; but not as a cast.
8294 backup-if-not-cast
8295 ;; For casts, the return position.
8296 cast-end
8297 ;; Have we got a new-style C++11 "auto"?
8298 new-style-auto
8299 ;; Set when the symbol before `preceding-token-end' is known to
8300 ;; terminate the previous construct, or when we're at point-min.
8301 at-decl-start
8302 ;; Set when we have encountered a keyword (e.g. "extern") which
8303 ;; causes the following declaration to be treated as though top-level.
8304 make-top
8305 ;; Save `c-record-type-identifiers' and
8306 ;; `c-record-ref-identifiers' since ranges are recorded
8307 ;; speculatively and should be thrown away if it turns out
8308 ;; that it isn't a declaration or cast.
8311 ;; Set when we parse a declaration which might also be an expression,
8312 ;; such as "a *b". See CASE 16 and CASE 17.
8313 maybe-expression)
8322 c-pre-start-tokens)))))
8327 ;; Check for a type. Unknown symbols are treated as possible
8328 ;; types, but they could also be specifiers disguised through
8329 ;; macros like __INLINE__, so we recognize both types and known
8330 ;; specifiers after them too.
8335 ;; Look for a specifier keyword clause.
8355 ;; Found a known or possible type or a prefix of a known type.
8364 ;; Got two identifiers with nothing but whitespace
8365 ;; between them. That can only happen in declarations.
8369 ;; If the previous identifier is a found type we
8370 ;; record it as a real one; it might be some sort of
8371 ;; alias for a prefix like "unsigned".
8378 backup-type-start type-start
8379 backup-id-start id-start
8380 at-type found-type
8381 type-start start
8383 ;; The previous ambiguous specifier/type turned out
8384 ;; to be a type since we've parsed another one after
8385 ;; it, so clear these backup flags.
8386 backup-at-type-decl nil
8387 backup-maybe-typeless nil))
8391 ;; Handle known specifier keywords and
8392 ;; `c-decl-hangon-kwds' which can occur after known
8393 ;; types.
8396 noise-start)
8397 ;; It's a hang-on keyword or noise clause that can occur
8398 ;; anywhere.
8401 ;; Move the identifier start position if
8402 ;; we've passed a type.
8404 ;; Otherwise treat this as a specifier and
8405 ;; move the fallback position.
8409 ;; It's an ordinary specifier so we know that
8410 ;; anything before this can't be the type.
8412 start-pos kwd-clause-end)
8415 ;; It's ambiguous whether this keyword is a
8416 ;; specifier or a type prefix, so set the backup
8417 ;; flags. (It's assumed that `c-forward-type'
8418 ;; moved further than `c-forward-keyword-clause'.)
8426 ;; This test only happens after we've scanned a type.
8427 ;; So, with valid syntax, kwd-sym can't be 'typedef.
8432 ;; Haven't matched a type so it's an unambiguous
8433 ;; specifier keyword and we know we're in a
8434 ;; declaration.
8440 ;; If the type isn't known we continue so that we'll jump
8441 ;; over all specifiers and type identifiers. The reason
8442 ;; to do this for a known type prefix is to make things
8443 ;; like "unsigned INT16" work.
8448 ;; If a known type was found, we still need to skip over any
8449 ;; hangon keyword clauses after it. Otherwise it has already
8450 ;; been done in the loop above.
8460 ;; A prefix type is itself a primitive type when it's not
8461 ;; followed by another type.
8465 ;; Got no type but set things up to continue anyway to handle
8466 ;; the various cases when a declaration doesn't start with a
8467 ;; type.
8472 ;; If it's C++ then check if the last "type" ends on the form
8473 ;; "foo::foo" or "foo::~foo", i.e. if it's the name of a
8474 ;; (con|de)structor.
8485 ;; Cheating in the handling of syntactic ws below.
8492 name)
8497 ;; It is a (con|de)structor name. In that case the
8498 ;; declaration is typeless so zap out any preceding
8499 ;; identifier(s) that we might have taken as types.
8502 backup-at-type nil
8503 id-start type-start))))))
8505 ;; Check for and step over a type decl expression after the thing
8506 ;; that is or might be a type. This can't be skipped since we
8507 ;; need the correct end position of the declarator for
8508 ;; `max-type-decl-end-*'.
8510 ;; True if there's a non-open-paren match of
8511 ;; `c-type-decl-prefix-key'.
8512 got-prefix
8513 ;; True if the declarator is surrounded by a parenthesis pair.
8514 got-parens
8515 ;; True if there is an identifier in the declarator.
8516 got-identifier
8517 ;; True if there's a non-close-paren match of
8518 ;; `c-type-decl-suffix-key'.
8519 got-suffix
8520 ;; True if there's a prefix match outside the outermost
8521 ;; paren pair that surrounds the declarator.
8522 got-prefix-before-parens
8523 ;; True if there's a suffix match outside the outermost
8524 ;; paren pair that surrounds the declarator. The value is
8525 ;; the position of the first suffix match.
8526 got-suffix-after-parens
8527 ;; True if we've parsed the type decl to a token that is
8528 ;; known to end declarations in this context.
8529 at-decl-end
8530 ;; The earlier values of `at-type' and `type-start' if we've
8531 ;; shifted the type backwards.
8532 identifier-type identifier-start
8533 ;; If `c-parse-and-markup-<>-arglists' is set we need to
8534 ;; turn it off during the name skipping below to avoid
8535 ;; getting `c-type' properties that might be bogus. That
8536 ;; can happen since we don't know if
8537 ;; `c-restricted-<>-arglists' will be correct inside the
8538 ;; arglist paren that gets entered.
8539 c-parse-and-markup-<>-arglists
8540 ;; Start of the identifier for which `got-identifier' was set.
8541 name-start
8542 ;; Position after (innermost) open parenthesis encountered in the
8543 ;; prefix operators.
8544 after-paren-pos)
8548 ;; Skip over type decl prefix operators. (Note similar code in
8549 ;; `c-forward-declarator'.)
8560 ;; If the third submatch matches in C++ then
8561 ;; we're looking at an identifier that's a
8562 ;; prefix only if it specifies a member pointer.
8567 ;; We only check for a trailing "::" and
8568 ;; let the "*" that should follow be
8569 ;; matched in the next round.
8571 ;; It turned out to be the real identifier,
8572 ;; so stop.
8573 nil))
8574 t))
8589 ;; Try to skip over an identifier.
8596 ;; Skip over type decl suffix operators and trailing noise macros.
8604 ;; We avoid recognizing foo(bar) or foo() at top level as a
8605 ;; construct here in C, since we want to recognize this as a
8606 ;; typeless function declaration.
8614 t)
8618 t)
8625 ;; No suffix matched. We might have matched the
8626 ;; identifier as a type and the open paren of a
8627 ;; function arglist as a type decl prefix. In that
8628 ;; case we should "backtrack": Reinterpret the last
8629 ;; type as the identifier, move out of the arglist and
8630 ;; continue searching for suffix operators.
8631 ;;
8632 ;; Do this even if there's no preceding type, to cope
8633 ;; with old style function declarations in K&R C,
8634 ;; (con|de)structors in C++ and `c-typeless-decl-kwds'
8635 ;; style declarations. That isn't applicable in an
8636 ;; arglist context, though.
8641 maybe-typeless
8642 backup-maybe-typeless
8645 ;; Deal with C++11's "copy-initialization"
8646 ;; where we have <type>(<constant>), by
8647 ;; contrasting with a typeless
8648 ;; <name>(<type><parameter>, ...).
8653 ;; Recognize a top-level typeless
8654 ;; function declaration in C.
8662 t)))
8671 at-type))
8672 ;; Have found no identifier but `c-typeless-decl-kwds' has
8673 ;; matched so we know we're inside a declaration. The
8674 ;; preceding type must be the identifier instead.
8677 ;; Prepare the "-> type;" for fontification later on.
8686 ;; Move forward over any "WS" ids (like "final" or "override" in C++)
8692 at-decl-or-cast
8695 ;; CASE 1
8697 ;; Encountered something inside parens that isn't matched by
8698 ;; the `c-type-decl-*' regexps, so it's not a type decl
8699 ;; expression. Try to skip out to the same paren depth to
8700 ;; not confuse the cast check below. If we don't manage this and
8701 ;; `at-decl-or-cast' is 'ids we might have an expression like
8702 ;; "foo bar ({ ..." which is a valid C++11 initialization.
8706 ;; If we've found a specifier keyword then it's a
8707 ;; declaration regardless.
8715 ;; Now we've collected info about various characteristics of
8716 ;; the construct we're looking at. Below follows a decision
8717 ;; tree based on that. It's ordered to check more certain
8718 ;; signs before less certain ones.
8723 ;; CASE 2
8726 ;; Got another identifier directly after the type, so it's a
8727 ;; declaration.
8732 ;; (not got-suffix-after-parens)
8734 maybe-typeless
8735 backup-maybe-typeless
8737 ;; Check whether we have "bar (gnu);" where we
8738 ;; are directly inside a class (etc.) called "bar".
8748 type-start
8754 ;; Got a declaration of the form "foo bar (gnu);" or "bar
8755 ;; (gnu);" where we've recognized "bar" as the type and "gnu"
8756 ;; as the declarator, and in the latter case, checked that
8757 ;; "bar (gnu)" appears directly inside the class "bar". In
8758 ;; this case it's however more likely that "bar" is the
8759 ;; declarator and "gnu" a function argument or initializer
8760 ;; (if `c-recognize-paren-inits' is set), since the parens
8761 ;; around "gnu" would be superfluous if it's a declarator.
8762 ;; Shift the type one step backward.
8765 ;; Found no identifier.
8770 ;; CASE 3
8772 ;; Got a plain list of identifiers. If a colon follows it's
8773 ;; a valid label, or maybe a bitfield. Otherwise the last
8774 ;; one probably is the declared identifier and we should
8775 ;; back up to the previous type, providing it isn't a cast.
8779 ;; If we've found a specifier keyword then it's a
8780 ;; declaration regardless.
8791 ;; CASE 4
8795 ;; Got a plain list of identifiers followed by some suffix.
8796 ;; If this isn't a cast then the last identifier probably is
8797 ;; the declared one and we should back up to the previous
8798 ;; type.
8802 ;; CASE 5
8804 ;; If the type is known we know that there can't be any
8805 ;; identifier somewhere else, and it's only in declarations in
8806 ;; e.g. function prototypes and in casts that the identifier may
8807 ;; be left out.
8811 ;; Only got a single identifier (parsed as a type so far).
8812 ;; CASE 6
8814 ;; Check that the identifier isn't at the start of an
8815 ;; expression.
8816 at-decl-end
8819 ;; Inside an arglist that contains declarations. If K&R
8820 ;; style declarations and parenthesis style initializers
8821 ;; aren't allowed then the single identifier must be a
8822 ;; type, else we require that it's known or found
8823 ;; (primitive types are handled above).
8828 ;; Inside a template arglist. Accept known and found
8829 ;; types; other identifiers could just as well be
8830 ;; constants in C++.
8833 ;; CASE 7
8834 ;; Can't be a valid declaration or cast, but if we've found a
8835 ;; specifier it can't be anything else either, so treat it as
8836 ;; an invalid/unfinished declaration or cast.
8844 maybe-typeless
8845 backup-maybe-typeless
8849 c-after-suffixed-type-maybe-decl-key))))))
8850 ;; Got an empty paren pair and a preceding type that probably
8851 ;; really is the identifier. Shift the type backwards to make
8852 ;; the last one the identifier. This is analogous to the
8853 ;; "backtracking" done inside the `c-type-decl-suffix-key' loop
8854 ;; above.
8855 ;;
8856 ;; Exception: In addition to the conditions in that
8857 ;; "backtracking" code, do not shift backward if we're not
8858 ;; looking at either `c-after-suffixed-type-decl-key' or "[;,]".
8859 ;; Since there's no preceding type, the shift would mean that
8860 ;; the declaration is typeless. But if the regexp doesn't match
8861 ;; then we will simply fall through in the tests below and not
8862 ;; recognize it at all, so it's better to try it as an abstract
8863 ;; declarator instead.
8866 ;; Still no identifier.
8867 ;; CASE 8
8869 ;; Require `got-prefix' together with either `got-parens' or
8870 ;; `got-suffix' to recognize it as an abstract declarator:
8871 ;; `got-parens' only is probably an empty function call.
8872 ;; `got-suffix' only can build an ordinary expression together
8873 ;; with the preceding identifier which we've taken as a type.
8874 ;; We could actually accept on `got-prefix' only, but that can
8875 ;; easily occur temporarily while writing an expression so we
8876 ;; avoid that case anyway. We could do a better job if we knew
8877 ;; the point when the fontification was invoked.
8880 ;; CASE 9
8884 got-suffix-after-parens
8886 ;; Got a type, no declarator but a paren suffix. I.e. it's a
8887 ;; normal function call after all (or perhaps a C++ style object
8888 ;; instantiation expression).
8891 ;; CASE 9.5
8895 after-paren-pos)
8896 ;; We've got something like "foo bar (...)" in C++ which isn't at
8897 ;; the top level. This is probably a uniform initialization of bar
8898 ;; to the contents of the parens. In this case the declarator ends
8899 ;; at the open paren.
8903 ;; CASE 10
8905 ;; By now we've located the type in the declaration that we know
8906 ;; we're in.
8909 ;; CASE 11
8913 make-top
8920 ;; Shift the type backward in the case that there's a
8921 ;; single identifier inside parens. That can only
8922 ;; occur in K&R style function declarations so it's
8923 ;; more likely that it really is a function call.
8924 ;; Therefore we only do this after
8925 ;; `c-after-suffixed-type-decl-key' has matched.
8927 got-suffix-after-parens))
8928 ;; A declaration according to `c-after-suffixed-type-decl-key'.
8931 ;; CASE 12
8934 ;; It's a declaration if a known type precedes it and it can't be a
8935 ;; function call.
8938 ;; If we get here we can't tell if this is a type decl or a normal
8939 ;; expression by looking at it alone. (That's under the assumption
8940 ;; that normal expressions always can look like type decl expressions,
8941 ;; which isn't really true but the cases where it doesn't hold are so
8942 ;; uncommon (e.g. some placements of "const" in C++) it's not worth
8943 ;; the effort to look for them.)
8945 ;;; 2008-04-16: commented out the next form, to allow the function to recognize
8946 ;;; "foo (int bar)" in CC (an implicit type (in class foo) without a semicolon)
8947 ;;; as a(n almost complete) declaration, enabling it to be fontified.
8948 ;; CASE 13
8949 ;; (unless (or at-decl-end (looking-at "=[^=]"))
8950 ;; If this is a declaration it should end here or its initializer(*)
8951 ;; should start here, so check for allowed separation tokens. Note
8952 ;; that this rule doesn't work e.g. with a K&R arglist after a
8953 ;; function header.
8954 ;;
8955 ;; *) Don't check for C++ style initializers using parens
8956 ;; since those already have been matched as suffixes.
8957 ;;
8958 ;; If `at-decl-or-cast' is then we've found some other sign that
8959 ;; it's a declaration or cast, so then it's probably an
8960 ;; invalid/unfinished one.
8961 ;; (throw 'at-decl-or-cast at-decl-or-cast))
8963 ;; Below are tests that only should be applied when we're certain to
8964 ;; not have parsed halfway through an expression.
8966 ;; CASE 14
8968 ;; The expression starts with a known type so treat it as a
8969 ;; declaration.
8972 ;; CASE 15
8974 ;; In C++ we check if the identifier is a known type, since
8975 ;; (con|de)structors use the class name as identifier.
8976 ;; We've always shifted over the identifier as a type and
8977 ;; then backed up again in this case.
8978 identifier-type
8981 ;; `at-type' probably won't be 'found for
8982 ;; destructors since the "~" is then part of the
8983 ;; type name being checked against the list of
8984 ;; known types, so do a check without that
8985 ;; operator.
8990 c-identifier-syntax-table
8994 ;; We have already parsed the type earlier,
8995 ;; so it'd be possible to cache the end
8996 ;; position instead of redoing it here, but
8997 ;; then we'd need to keep track of another
8998 ;; position everywhere.
9006 ;; CASE 16
9008 at-type
9012 at-decl-start))
9013 ;; Got something like "foo * bar;". Since we're not inside
9014 ;; an arglist it would be a meaningless expression because
9015 ;; the result isn't used. We therefore choose to recognize
9016 ;; it as a declaration. We only allow a suffix (which makes
9017 ;; the construct look like a function call) when
9018 ;; `at-decl-start' provides additional evidence that we do
9019 ;; have a declaration.
9023 ;; CASE 17
9028 ;; Got something like "a (*b) (c);" or "a (b) = c;". It could
9029 ;; be an odd expression or it could be a declaration. Treat
9030 ;; it as a declaration if "a" has been used as a type
9031 ;; somewhere else (if it's a known type we won't get here).
9035 ;; CASE 17.5
9037 got-prefix-before-parens
9038 at-type
9040 at-decl-start))
9057 ;; CASE 18
9063 ;; Got a type followed by an abstract declarator. If `got-prefix'
9064 ;; is set it's something like "a *" without anything after it. If
9065 ;; `got-parens' or `got-suffix' is set it's "a()", "a[]", "a()[]",
9066 ;; or similar, which we accept only if the context rules out
9067 ;; expressions.
9070 ;; If we had a complete symbol table here (which rules out
9071 ;; `c-found-types') we should return t due to the disambiguation rule
9072 ;; (in at least C++) that anything that can be parsed as a declaration
9073 ;; is a declaration. Now we're being more defensive and prefer to
9074 ;; highlight things like "foo (bar);" as a declaration only if we're
9075 ;; inside an arglist that contains declarations. Update (2017-09): We
9076 ;; now recognize a top-level "foo(bar);" as a declaration in C.
9077 ;; CASE 19
9082 ;; The point is now after the type decl expression.
9085 ;; Check for a cast.
9088 c-cast-parens
9090 ;; Should be the first type/identifier in a cast paren.
9094 ;; The closing paren should follow.
9099 ;; There should be a primary expression after it.
9108 ;; Check if the expression begins with a prefix keyword.
9111 ;; Expression begins with an ambiguous operator. Treat
9112 ;; it as a cast if it's a type decl or if we've
9113 ;; recognized the type somewhere else.
9116 ;; Unless it's a keyword, it's the beginning of a primary
9117 ;; expression.
9119 ;; If `c-primary-expr-regexp' matched a nonsymbol token, check
9120 ;; that it matched a whole one so that we don't e.g. confuse
9121 ;; the operator '-' with '->'. It's ok if it matches further,
9122 ;; though, since it e.g. can match the float '.5' while the
9123 ;; operator regexp only matches '.'.
9127 ;; There should either be a cast before it or something that isn't an
9128 ;; identifier or close paren.
9136 ;; It's a symbol. Accept it only if it's one of the
9137 ;; keywords that can precede an expression (without
9138 ;; surrounding parens).
9141 ;; Check that it isn't a close paren (block close is ok,
9142 ;; though).
9144 ;; Check that it isn't a nonsymbol identifier.
9147 ;; Handle the cast.
9157 ;; We're at a declaration. Highlight the type and the following
9158 ;; declarators.
9164 ;; Make sure to propagate the `c-decl-arg-start' property to
9165 ;; the next argument if it's set in this one, to cope with
9166 ;; interactive refontification.
9169 ;; Record the type's coordinates in `c-record-type-identifiers' for
9170 ;; later fontification.
9172 ;; There seems no reason to exclude a token from
9173 ;; fontification just because it's "a known type that can't
9174 ;; be a name or other expression". 2013-09-18.
9175 )
9184 maybe-expression
9185 type-start
9189 ;; False alarm. Restore the recorded ranges.
9191 c-record-ref-identifiers save-rec-ref-ids)
9192 nil))))
9195 ;; Assuming that point is at the beginning of a token, check if it starts a
9196 ;; label and if so move over it and return non-nil (t in default situations,
9197 ;; specific symbols (see below) for interesting situations), otherwise don't
9198 ;; move and return nil. "Label" here means "most things with a colon".
9199 ;;
9200 ;; More precisely, a "label" is regarded as one of:
9201 ;; (i) a goto target like "foo:" - returns the symbol `goto-target';
9202 ;; (ii) A case label - either the entire construct "case FOO:", or just the
9203 ;; bare "case", should the colon be missing. We return t;
9204 ;; (iii) a keyword which needs a colon, like "default:" or "private:"; We
9205 ;; return t;
9206 ;; (iv) One of QT's "extended" C++ variants of
9207 ;; "private:"/"protected:"/"public:"/"more:" looking like "public slots:".
9208 ;; Returns the symbol `qt-2kwds-colon'.
9209 ;; (v) QT's construct "signals:". Returns the symbol `qt-1kwd-colon'.
9210 ;; (vi) One of the keywords matched by `c-opt-extra-label-key' (without any
9211 ;; colon). Currently (2006-03), this applies only to Objective C's
9212 ;; keywords "@private", "@protected", and "@public". Returns t.
9213 ;;
9214 ;; One of the things which will NOT be recognized as a label is a bit-field
9215 ;; element of a struct, something like "int foo:5".
9216 ;;
9217 ;; The end of the label is taken to be just after the colon, or the end of
9218 ;; the first submatch in `c-opt-extra-label-key'. The point is directly
9219 ;; after the end on return. The terminating char gets marked with
9220 ;; `c-decl-end' to improve recognition of the following declaration or
9221 ;; statement.
9222 ;;
9223 ;; If ASSUME-MARKUP is non-nil, it's assumed that the preceding
9224 ;; label, if any, has already been marked up like that.
9225 ;;
9226 ;; If PRECEDING-TOKEN-END is given, it should be the first position
9227 ;; after the preceding token, i.e. on the other side of the
9228 ;; syntactic ws from the point. Use a value less than or equal to
9229 ;; (point-min) if the point is at the first token in (the visible
9230 ;; part of) the buffer.
9231 ;;
9232 ;; The optional LIMIT limits the forward scan for the colon.
9233 ;;
9234 ;; This function records the ranges of the label symbols on
9235 ;; `c-record-ref-identifiers' if `c-record-type-identifiers' (!) is
9236 ;; non-nil.
9237 ;;
9238 ;; This function might do hidden buffer changes.
9241 label-end
9242 qt-symbol-idx
9243 macro-start ; if we're in one.
9244 label-type
9245 kwd)
9247 ;; "case" or "default" (Doesn't apply to AWK).
9250 ;; Record only the keyword itself for fontification, since in
9251 ;; case labels the following is a constant expression and not
9252 ;; a label.
9256 ;; Find the label end.
9260 ;; Stop on chars that aren't allowed in expressions,
9261 ;; and on operator chars that would be meaningless
9262 ;; there. FIXME: This doesn't cope with ?: operators.
9270 t)
9272 ;; It's an unfinished label. We consider the keyword enough
9273 ;; to recognize it as a label, so that it gets fontified.
9274 ;; Leave the point at the end of it, but don't put any
9275 ;; `c-decl-end' marker.
9277 t))))
9279 ;; @private, @protected, @public, in Objective C, or similar.
9282 ;; For a `c-opt-extra-label-key' match, we record the whole
9283 ;; thing for fontification. That's to get the leading '@' in
9284 ;; Objective-C protection labels fontified.
9291 ;; All other cases of labels.
9294 ;; A colon label must have something before the colon.
9297 ;; Check that we're not after a token that can't precede a label.
9299 ;; Trivially succeeds when there's no preceding token.
9300 ;; Succeeds when we're at a virtual semicolon.
9309 ;; Check if we're after a label, if we're after a closing
9310 ;; paren that belong to statement, and with
9311 ;; `c-label-prefix-re'. It's done in different order
9312 ;; depending on `assume-markup' since the checks have
9313 ;; different expensiveness.
9340 ;; Might be after another label, so check it recursively.
9344 ;; Essentially the same as the
9345 ;; `c-syntactic-re-search-forward' regexp below.
9351 ;; Note: the following should work instead of the
9352 ;; narrow-to-region above. Investigate why not,
9353 ;; sometime. ACM, 2006-03-31.
9354 ;; (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+"
9355 ;; macro-start t)
9357 ;; If the caller turned on recording for us,
9358 ;; it shouldn't apply when we check the
9359 ;; preceding label.
9360 c-record-type-identifiers)
9361 ;; A label can't start at a cpp directive. Check for
9362 ;; this, since c-forward-syntactic-ws would foul up on it.
9367 ;; Point is still at the beginning of the possible label construct.
9368 ;;
9369 ;; Check that the next nonsymbol token is ":", or that we're in one
9370 ;; of QT's "slots" declarations. Allow '(' for the sake of macro
9371 ;; arguments. FIXME: Should build this regexp from the language
9372 ;; constants.
9374 ;; public: protected: private:
9384 ;; QT double keyword like "protected slots:" or goto target.
9403 'qt-1kwd-colon
9415 ;; Check that `c-nonlabel-token-key' doesn't match anywhere.
9425 t)
9428 ;; Record the identifiers in the label for fontification, unless
9429 ;; it begins with `c-label-kwds' in which case the following
9430 ;; identifiers are part of a (constant) expression that
9431 ;; shouldn't be fontified.
9443 ;; Not a label.
9445 label-type))
9448 ;; Assuming the point is at the beginning of a token, try to move
9449 ;; forward to the end of the Objective-C directive that starts
9450 ;; there. Return t if a directive was fully recognized, otherwise
9451 ;; the point is moved as far as one could be successfully parsed and
9452 ;; nil is returned.
9453 ;;
9454 ;; This function records identifier ranges on
9455 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
9456 ;; `c-record-type-identifiers' is non-nil.
9457 ;;
9458 ;; This function might do hidden buffer changes.
9461 start-char
9463 lim
9464 ;; Turn off recognition of angle bracket arglists while parsing
9465 ;; types here since the protocol reference list might then be
9466 ;; considered part of the preceding name or superclass-name.
9477 t)
9486 ;; Handle the name of the class itself.
9488 ;; (c-forward-token-2) ; 2006/1/13 This doesn't move if the token's
9489 ;; at EOB.
9496 ;; Look for ": superclass-name" or "( category-name )".
9507 ;; Look for a protocol reference list.
9513 t))))
9519 t)
9522 nil)))
9525 ;; Go to the first non-whitespace after the colon that starts a
9526 ;; multiple inheritance introduction. Optional LIM is the farthest
9527 ;; back we should search.
9528 ;;
9529 ;; This function might do hidden buffer changes.
9537 ;; Return nil if we aren't in a method definition, otherwise the
9538 ;; position of the initial [+-].
9539 ;;
9540 ;; This function might do hidden buffer changes.
9546 ))
9548 ;; Contributed by Kevin Ryde <user42@zip.com.au>.
9550 ;; Return non-nil if point is within a gcc \"asm\" block.
9551 ;;
9552 ;; This should be called with point inside an argument list.
9553 ;;
9554 ;; Only one level of enclosing parentheses is considered, so for
9555 ;; instance nil is returned when in a function call within an asm
9556 ;; operand.
9557 ;;
9558 ;; This function might do hidden buffer changes.
9570 a function.
9572 More precisely, being at the top-level means that point is either
9573 outside any enclosing block (such as a function definition), or
9574 directly inside a class, namespace or other block that contains
9575 another declaration level.
9577 If point is not at the top-level (e.g. it is inside a method
9578 definition), then nil is returned. Otherwise, if point is at a
9579 top-level not enclosed within a class definition, t is returned.
9580 Otherwise, a 2-vector is returned where the zeroth element is the
9581 buffer position of the start of the class declaration, and the first
9582 element is the buffer position of the enclosing class's opening
9583 brace.
9585 Note that this function might do hidden buffer changes. See the
9586 comment at the start of cc-engine.el for more info."
9587 ;; Note to maintainers: this function consumes a great mass of CPU cycles.
9588 ;; Its use should thus be minimized as far as possible.
9589 ;; Consider instead using `c-bs-at-toplevel-p'.
9595 ;; Return non-nil if the point is in the region after the argument
9596 ;; list of a function and its opening brace (or semicolon in case it
9597 ;; got no body). If there are K&R style argument declarations in
9598 ;; that region, the point has to be inside the first one for this
9599 ;; function to recognize it.
9600 ;;
9601 ;; If successful, the point is moved to the first token after the
9602 ;; function header (see `c-forward-decl-or-cast-1' for details) and
9603 ;; the position of the opening paren of the function arglist is
9604 ;; returned.
9605 ;;
9606 ;; The point is clobbered if not successful.
9607 ;;
9608 ;; LIM is used as bound for backward buffer searches.
9609 ;;
9610 ;; This function might do hidden buffer changes.
9619 ;; Don't confuse #if .... defined(foo) for a function arglist.
9630 ;; There should not be a '=' or ',' between beg and the
9631 ;; start of the declaration since that means we were in the
9632 ;; "expression part" of the declaration.
9637 ;; Check that there's an arglist paren in the
9638 ;; declaration.
9641 ;; The declarator is a paren expression, so skip past it
9642 ;; so that we don't get stuck on that instead of the
9643 ;; function arglist.
9647 ;; Don't trip up on "operator ()".
9654 ;; Return the position of the first argument declaration if point is
9655 ;; inside a K&R style argument declaration list, nil otherwise.
9656 ;; `c-recognize-knr-p' is not checked. If LIM is non-nil, it's a
9657 ;; position that bounds the backward search for the argument list. This
9658 ;; function doesn't move point.
9659 ;;
9660 ;; Point must be within a possible K&R region, e.g. just before a top-level
9661 ;; "{". It must be outside of parens and brackets. The test can return
9662 ;; false positives otherwise.
9663 ;;
9664 ;; This function might do hidden buffer changes.
9667 ;; If we're in a macro, our search range is restricted to it. Narrow to
9668 ;; the searchable range.
9672 before-lparen after-rparen
9675 ; we give up.
9676 ids ; List of identifiers in the parenthesized list.
9677 id-start after-prec-token decl-or-cast decl-res
9678 c-last-identifier-range identifier-ok)
9681 ;; Search backwards for the defun's argument list. We give up if we
9682 ;; encounter a "}" (end of a previous defun) an "=" (which can't be in
9683 ;; a knr region) or BOB.
9684 ;;
9685 ;; The criterion for a paren structure being the arg list is:
9686 ;; o - there is non-WS stuff after it but before any "{"; AND
9687 ;; o - the token after it isn't a ";" AND
9688 ;; o - it is preceded by either an identifier (the function name) or
9689 ;; a macro expansion like "DEFUN (...)"; AND
9690 ;; o - its content is a non-empty comma-separated list of identifiers
9691 ;; (an empty arg list won't have a knr region).
9692 ;;
9693 ;; The following snippet illustrates these rules:
9694 ;; int foo (bar, baz, yuk)
9695 ;; int bar [] ;
9696 ;; int (*baz) (my_type) ;
9697 ;; int (*(* yuk) (void)) (void) ;
9698 ;; {
9699 ;;
9700 ;; Additionally, for a knr list to be recognized:
9701 ;; o - The identifier of each declarator up to and including the
9702 ;; one "near" point must be contained in the arg list.
9713 ; parens/brackets.
9717 ;; We're inside a paren. Could it be our argument list....?
9723 ;; FIXME!!! What about macros between the parens? 2007/01/20
9726 ;; It can't be the arg list if next token is ; or {
9731 ;; Is the thing preceding the list an identifier (the
9732 ;; function name), or a macro expansion?
9742 ;; Have we got a non-empty list of comma-separated
9743 ;; identifiers?
9756 ids)
9764 ;; Are all the identifiers in the k&r list up to the
9765 ;; current one also in the argument list?
9773 after-prec-token
9774 nil ; Or 'arglist ???
9775 nil)))
9780 nil))
9788 ids))
9794 identifier-ok))
9795 ;; ...Yes. We've identified the function's argument list.
9800 ;; ...No. The current parens aren't the function's arg list.
9807 ;; skip forward over conditional at point, including any predicate
9808 ;; statements in parentheses. No error checking is performed.
9809 ;;
9810 ;; This function might do hidden buffer changes.
9812 ;; else if()
9817 ;; do, else, try, finally
9822 ;; for, if, while, switch, catch, synchronized, foreach
9826 ;; If looking at the token after a conditional then return the
9827 ;; position of its start, otherwise return nil.
9828 ;;
9829 ;; This function might do hidden buffer changes.
9840 ;; If the point is after an operator identifier that isn't handled
9841 ;; like an ordinary symbol (i.e. like "operator =" in C++) then the
9842 ;; position of the start of that identifier is returned. nil is
9843 ;; returned otherwise. The point may be anywhere in the syntactic
9844 ;; whitespace after the last token of the operator identifier.
9845 ;;
9846 ;; This function might do hidden buffer changes.
9858 ;; Assuming point is at a brace that opens a statement block of some
9859 ;; kind, move to the proper anchor point for that block. It might
9860 ;; need to be adjusted further by c-add-stmt-syntax, but the
9861 ;; position at return is suitable as start position for that
9862 ;; function.
9863 ;;
9864 ;; This function might do hidden buffer changes.
9871 ;; Assuming point is at a brace that opens the block of a top level
9872 ;; declaration of some kind, move to the proper anchor point for
9873 ;; that block.
9874 ;;
9875 ;; This function might do hidden buffer changes.
9880 ;; Search forward for the end of the "header" of the current
9881 ;; declaration. That's the position where the definition body
9882 ;; starts, or the first variable initializer, or the ending
9883 ;; semicolon. I.e. search forward for the closest following
9884 ;; (syntactically relevant) '{', '=' or ';' token. Point is left
9885 ;; _after_ the first found token, or at point-max if none is found.
9886 ;;
9887 ;; This function might do hidden buffer changes.
9892 ;; In C++ we need to take special care to handle operator
9893 ;; tokens and those pesky template brackets.
9898 ;; Handle operator identifiers, i.e. ignore any
9899 ;; operator token preceded by "operator".
9906 t
9908 nil)))))
9917 ;; Go to the beginning of the current declaration, or the beginning
9918 ;; of the previous one if already at the start of it. Point won't
9919 ;; be moved out of any surrounding paren. Return a cons cell of the
9920 ;; form (MOVE . KNR-POS). MOVE is like the return value from
9921 ;; `c-beginning-of-statement-1'. If point skipped over some K&R
9922 ;; style argument declarations (and they are to be recognized) then
9923 ;; KNR-POS is set to the start of the first such argument
9924 ;; declaration, otherwise KNR-POS is nil. If LIM is non-nil, it's a
9925 ;; position that bounds the backward search.
9926 ;;
9927 ;; NB: Cases where the declaration continues after the block, as in
9928 ;; "struct foo { ... } bar;", are currently recognized as two
9929 ;; declarations, e.g. "struct foo { ... }" and "bar;" in this case.
9930 ;;
9931 ;; This function might do hidden buffer changes.
9937 ;; `c-beginning-of-statement-1' stops at a block start, but we
9938 ;; want to continue if the block doesn't begin a top level
9939 ;; construct, i.e. if it isn't preceded by ';', '}', ':', bob,
9940 ;; or an open paren.
9942 ;; Go back one "statement" each time round the loop until we're just
9943 ;; after a ;, }, or :, or at BOB or the start of a macro or start of
9944 ;; an ObjC method. This will move over a multiple declaration whose
9945 ;; components are comma separated.
9947 ;; Must check with c-opt-method-key in ObjC mode.
9958 ;; Check that we don't move from the first thing in a
9959 ;; macro to its header.
9965 move tentative-move))
9970 ;; Handle K&R argdecls. Back up after the "statement" jumped
9971 ;; over by `c-beginning-of-statement-1', unless it was the
9972 ;; function body, in which case we're sitting on the opening
9973 ;; brace now. Then test if we're in a K&R argdecl region and
9974 ;; that we started at the other side of the first argdecl in
9975 ;; it.
9985 'previous
9987 knr-argdecl-start))
9990 ;; `c-beginning-of-statement-1' counts each brace block as a separate
9991 ;; statement, so the result will be 'previous if we've moved over any.
9992 ;; So change our result back to 'same if necessary.
9993 ;;
9994 ;; If they were brace list initializers we might not have moved over a
9995 ;; declaration boundary though, so change it to 'same if we've moved
9996 ;; past a '=' before '{', but not ';'. (This ought to be integrated
9997 ;; into `c-beginning-of-statement-1', so we avoid this extra pass which
9998 ;; potentially can search over a large amount of text.). Take special
9999 ;; pains not to get mislead by C++'s "operator=", and the like.
10002 c++-template-syntax-table
10008 ; no more, or get to one which isn't an "operator ="
10011 c-overloadable-operators-regexp
10012 c-opt-op-identifier-prefix
10027 ;; Assuming point is at the start of a declaration (as detected by
10028 ;; e.g. `c-beginning-of-decl-1'), go to the end of it. Unlike
10029 ;; `c-beginning-of-decl-1', this function handles the case when a
10030 ;; block is followed by identifiers in e.g. struct declarations in C
10031 ;; or C++. If a proper end was found then t is returned, otherwise
10032 ;; point is moved as far as possible within the current sexp and nil
10033 ;; is returned. This function doesn't handle macros; use
10034 ;; `c-end-of-macro' instead in those cases.
10035 ;;
10036 ;; This function might do hidden buffer changes.
10039 c++-template-syntax-table
10047 ;; Stopped at the ';' in a K&R argdecl section which is
10048 ;; detected using the same criteria as in
10049 ;; `c-beginning-of-decl-1'. Move to the following block
10050 ;; start.
10054 ;; Encountered a block in the declaration. Jump over it.
10065 ;; Check for `c-opt-block-decls-with-vars-key'
10066 ;; before the first paren.
10069 c-opt-block-decls-with-vars-key
10071 lim t t t)
10074 ;; Check that the first following paren is
10075 ;; the block.
10077 lim t t t)
10079 ;; The declaration doesn't have any of the
10080 ;; `c-opt-block-decls-with-vars' keywords in the
10081 ;; beginning, so it ends here at the end of the block.
10089 nil)))
10092 ;; Assuming the point is at an open brace, check if it starts a
10093 ;; block that contains another declaration level, i.e. that isn't a
10094 ;; statement block or a brace list, and if so return non-nil.
10095 ;;
10096 ;; If the check is successful, the return value is the start of the
10097 ;; keyword that tells what kind of construct it is, i.e. typically
10098 ;; what `c-decl-block-key' matched. Also, if GOTO-START is set then
10099 ;; the point will be at the start of the construct, before any
10100 ;; leading specifiers, otherwise it's at the returned position.
10101 ;;
10102 ;; The point is clobbered if the check is unsuccessful.
10103 ;;
10104 ;; CONTAINING-SEXP is the position of the open of the surrounding
10105 ;; paren, or nil if none.
10106 ;;
10107 ;; The optional LIMIT limits the backward search for the start of
10108 ;; the construct. It's assumed to be at a syntactically relevant
10109 ;; position.
10110 ;;
10111 ;; If any template arglists are found in the searched region before
10112 ;; the open brace, they get marked with paren syntax.
10113 ;;
10114 ;; This function might do hidden buffer changes.
10121 ;; Could be at the end of a template arglist.
10129 ;; Skip back over noise clauses.
10131 c-opt-cpp-prefix
10141 t)
10143 nil))))
10145 ;; Note: Can't get bogus hits inside template arglists below since they
10146 ;; have gotten paren syntax above.
10148 ;; If `goto-start' is set we begin by searching for the
10149 ;; first possible position of a leading specifier list.
10150 ;; The `c-decl-block-key' search continues from there since
10151 ;; we know it can't match earlier.
10154 open-brace t t)
10156 t)
10157 t)
10163 ;; Exclude cases where we matched what would ordinarily
10164 ;; be a block declaration keyword, except where it's not
10165 ;; legal because it's part of a "compound keyword" like
10166 ;; "enum class". Of course, if c-after-brace-list-key
10167 ;; is nil, we can skip the test.
10177 ;; Found a keyword that can't be a type?
10180 ;; Can be a type too, in which case it's the return type of a
10181 ;; function (under the assumption that no declaration level
10182 ;; block construct starts with a type).
10185 ;; Jumped over a type, but it could be a declaration keyword
10186 ;; followed by the declared identifier that we've jumped over
10187 ;; instead (e.g. in "class Foo {"). If it indeed is a type
10188 ;; then we should be at the declarator now, so check for a
10189 ;; valid declarator start.
10190 ;;
10191 ;; Note: This doesn't cope with the case when a declared
10192 ;; identifier is followed by e.g. '(' in a language where '('
10193 ;; also might be part of a declarator expression. Currently
10194 ;; there's no such language.
10198 ;; In Pike a list of modifiers may be followed by a brace
10199 ;; to make them apply to many identifiers. Note that the
10200 ;; match data will be empty on return in this case.
10206 ;; Use this variant to avoid yet another special regexp.
10210 t)))
10212 ;; Got a match.
10215 ;; Back up over any preceding specifiers and their clauses
10216 ;; by going forward from `first-specifier-pos', which is the
10217 ;; earliest possible position where the specifier list can
10218 ;; start.
10224 ;; Accept any plain symbol token on the ground that
10225 ;; it's a specifier masked through a macro (just
10226 ;; like `c-forward-decl-or-cast-1' skip forward over
10227 ;; such tokens).
10228 ;;
10229 ;; Could be more restrictive wrt invalid keywords,
10230 ;; but that'd only occur in invalid code so there's
10231 ;; no use spending effort on it.
10236 ;; Moving over a protection kwd and the following
10237 ;; ":" (in C++ Mode) to the next token could take
10238 ;; us all the way up to `kwd-start', leaving us
10239 ;; no chance to update `first-specifier-pos'.
10245 ;; Can't parse a declaration preamble and is still
10246 ;; before `kwd-start'. That means `first-specifier-pos'
10247 ;; was in some earlier construct. Search again.
10251 ;; Got no preamble before the block declaration keyword.
10257 kwd-start)))
10260 ;; Check whether point is directly inside a brace block which is the brace
10261 ;; block of a class, struct, or union which is called NAME, a string.
10264 )
10268 ; *c-looking-at-decl-block
10269 ; containing-sexp goto-start &optional
10270 ; limit)
10273 nil)
10280 ;; Check if the closest containing paren sexp is a declaration
10281 ;; block, returning a 2 element vector in that case. Aref 0
10282 ;; contains the bufpos at boi of the class key line, and aref 1
10283 ;; contains the bufpos of the open brace. This function is an
10284 ;; obsolete wrapper for `c-looking-at-decl-block'.
10285 ;;
10286 ;; This function might do hidden buffer changes.
10294 nil))
10299 ;; Return the buffer position of the most enclosing decl-block brace (in the
10300 ;; sense of c-looking-at-decl-block) in the PAREN-STATE structure, or nil if
10301 ;; none was found.
10310 open-brace))
10313 ;; Return the position of the L-brace if point is inside a brace list
10314 ;; initialization of an array, etc. This is an approximate function,
10315 ;; designed for speed over accuracy. It will not find every bracelist, but
10316 ;; a non-nil result is reliable. We simply search for "= {" (naturally with
10317 ;; syntactic whitespace allowed). PAREN-STATE is the normal thing that it
10318 ;; is everywhere else.
10327 b-pos)))
10330 ;; We're at a "{" which might be the opening brace of an enum which is
10331 ;; strongly typed (by a ":" followed by a type). If this is the case, leave
10332 ;; point before the colon and return t. Otherwise leave point unchanged and return nil.
10333 ;; Match data will be clobbered.
10343 t)
10358 nil)
10360 t)
10362 t)
10366 t)))
10369 ;; We're at a "{". Move back to the enum-like keyword that starts this
10370 ;; declaration and return t, otherwise don't move and return nil.
10372 before-identifier)
10388 t)
10400 t)
10406 ;; Point is at an open brace. If this starts a brace list, return a list
10407 ;; whose car is the buffer position of the start of the construct which
10408 ;; introduces the list, and whose cdr is the symbol `in-paren' if the brace
10409 ;; is directly enclosed in a parenthesis form (i.e. an arglist), t if we
10410 ;; have parsed a keyword matching `c-opt-inexpr-brace-list-key' (e.g. Java's
10411 ;; "new"), nil otherwise. Otherwise, if point might be inside an enclosing
10412 ;; brace list, return t. If point is definitely neither at nor in a brace
10413 ;; list, return nil.
10414 ;;
10415 ;; CONTAINING-SEXP is the position of the brace/paren/bracket enclosing
10416 ;; POINT, or nil if there is no such position, or we do not know it. LIM is
10417 ;; a backward search limit.
10418 ;;
10419 ;; The determination of whether the brace starts a brace list is solely by
10420 ;; the context of the brace, not by its contents.
10421 ;;
10422 ;; Here, "brace list" does not include the body of an enum.
10426 ;; Pike can have class definitions anywhere, so we must
10427 ;; check for the class key here.
10429 c-decl-block-key))
10431 inexpr-brace-list bufpos macro-start res pos after-type-id-pos
10432 in-paren parens-before-brace)
10435 ;; Checks to do only on the first sexp before the brace.
10436 ;; Have we a C++ initialization, without an "="?
10452 nil)
10464 nil))))
10469 ;; In Java, an initialization brace list may follow
10470 ;; directly after "new Foo[]", so check for a "new"
10471 ;; earlier.
10477 t)
10479 ;; Carry on looking if this is an
10480 ;; identifier (may contain "." in Java)
10481 ;; or another "[]" sexp.
10498 ;; Single identifier between '(' and '{'. We have a bracelist.
10501 ;; Are we at the parens of a C++ lambda expression?
10511 ;; Checks to do on all sexps before the brace, up to the
10512 ;; beginning of the statement.
10520 ;; We've seen a =, but must check earlier tokens so
10521 ;; that it isn't something that should be ignored.
10527 ;; Check for operator =
10530 nil)
10531 ;; Check for `<opchar>= in Pike.
10534 ;; Special case for Pikes
10535 ;; `[]=, since '[' is not in
10536 ;; the punctuation class.
10539 nil)
10541 ;; make sure we're not in a C++ template
10542 ;; argument assignment
10554 ))))
10555 nil)
10563 ;; We've hit the beginning of the aggregate list.
10587 nil nil))
10592 ;; Brace lists can't contain a semicolon, so we're done.
10593 ;; (setq containing-sexp nil)
10594 nil)
10598 ;; We've a macro whose expansion starts with the '{'.
10599 ;; Heuristically, if we have a ';' in it we've not got a
10600 ;; brace list, otherwise we have.
10606 nil
10608 ; languages where
10609 ; `c-opt-inexpr-brace-list-key' is
10610 ; non-nil and we have macros.
10612 )))
10615 ;; return the buffer position of the beginning of the brace list
10616 ;; statement if we're inside a brace list, otherwise return nil.
10617 ;; CONTAINING-SEXP is the buffer pos of the innermost containing
10618 ;; paren. PAREN-STATE is the remainder of the state of enclosing
10619 ;; braces. ACCEPT-IN-PAREN is non-nil iff we will accept as a brace
10620 ;; list a brace directly enclosed in a parenthesis.
10621 ;;
10622 ;; The "brace list" here is recognized solely by its context, not by
10623 ;; its contents.
10624 ;;
10625 ;; N.B.: This algorithm can potentially get confused by cpp macros
10626 ;; placed in inconvenient locations. It's a trade-off we make for
10627 ;; speed.
10628 ;;
10629 ;; This function might do hidden buffer changes.
10631 ;; This will pick up brace list declarations.
10635 ;; this will pick up array/aggregate init lists, even if they are nested.
10638 next-containing)
10640 containing-sexp)
10646 ;; We're in an in-expression block of some kind. Do not
10647 ;; check nesting. We deliberately set the limit to the
10648 ;; containing sexp, so that c-looking-at-inexpr-block
10649 ;; doesn't check for an identifier before it.
10654 next-containing next-containing))
10655 t)
10657 next-containing nil)))))
10663 ;; If we're looking at the start of a pike-style list, i.e., `({Â })',
10664 ;; `([Â ])', `(<Â >)', etc., a cons of a cons of its starting and ending
10665 ;; positions and its entry in c-special-brace-lists is returned, nil
10666 ;; otherwise. The ending position is nil if the list is still open.
10667 ;; LIM is the limit for forward search. The point may either be at
10668 ;; the `(' or at the following paren character. Tries to check the
10669 ;; matching closer, but assumes it's correct if no balanced paren is
10670 ;; found (i.e. the case `({ ... } ... )' is detected as _not_ being
10671 ;; a special brace list).
10672 ;;
10673 ;; This function might do hidden buffer changes.
10678 inner-beg end type)
10693 nil)))))
10703 ;; Check balancing of the inner paren
10704 ;; below.
10707 t)
10708 ;; If the inner char isn't a paren then
10709 ;; we can't check balancing, so just
10710 ;; check the char before the outer
10711 ;; closing paren.
10726 ;; Return non-nil if between two statements or declarations, assuming
10727 ;; point is not inside a literal or comment.
10728 ;;
10729 ;; Obsolete - `c-at-statement-start-p' or `c-at-expression-start-p'
10730 ;; are recommended instead.
10731 ;;
10732 ;; This function might do hidden buffer changes.
10737 ;; Point is at an opening brace. If this is a statement block (i.e. the
10738 ;; elements in the block are terminated by semicolons, or the block is
10739 ;; empty, or the block contains a keyword) return t. Otherwise, return nil.
10772 ;; Return non-nil if we're looking at the beginning of a block
10773 ;; inside an expression. The value returned is actually a cons of
10774 ;; either 'inlambda, 'inexpr-statement or 'inexpr-class and the
10775 ;; position of the beginning of the construct.
10776 ;;
10777 ;; LIM limits the backward search. CONTAINING-SEXP is the start
10778 ;; position of the closest containing list. If it's nil, the
10779 ;; containing paren isn't used to decide whether we're inside an
10780 ;; expression or not. If both LIM and CONTAINING-SEXP are used, LIM
10781 ;; needs to be farther back.
10782 ;;
10783 ;; If CHECK-AT-END is non-nil then extra checks at the end of the
10784 ;; brace block might be done. It should only be used when the
10785 ;; construct can be assumed to be complete, i.e. when the original
10786 ;; starting position was further down than that.
10787 ;;
10788 ;; This function might do hidden buffer changes.
10792 haskell-op-pos
10794 ;; Look at the character after point only as a last resort
10795 ;; when we can't disambiguate.
10798 ;; Search for a C++11 "->" which suggests a lambda declaration.
10829 ;; If the class definition is at the start of
10830 ;; a statement, we don't consider it an
10831 ;; in-expression class.
10839 ;; Also, in Pike we treat it as an
10840 ;; in-expression class if it's used in an
10841 ;; object clone expression.
10862 nil)
10872 ;; Accept several square bracket sexps for
10873 ;; Java array initializations.
10880 ;; C++11 lambda function declaration
10896 block-follows
10909 block-follows
10910 containing-sexp
10928 nil
10931 res))))
10934 ;; Returns non-nil if we're looking at the end of an in-expression
10935 ;; block, otherwise the same as `c-looking-at-inexpr-block'.
10936 ;; PAREN-STATE is the paren state relevant at the current position.
10937 ;;
10938 ;; This function might do hidden buffer changes.
10940 ;; We currently only recognize a block.
10943 containing-sexp)
10952 paren-state)
10953 containing-sexp)))))
10956 ;; Return non-nil if we're at the opening "[" of the capture list of a C++
10957 ;; lambda function, nil otherwise.
10968 ;; Is there a "virtual semicolon" at POS or point?
10969 ;; (See cc-defs.el for full details of "virtual semicolons".)
10970 ;;
10971 ;; This is true when point is at the last non syntactic WS position on the
10972 ;; line, there is a macro call last on the line, and this particular macro's
10973 ;; name is defined by the regexp `c-vs-macro-regexp' as not needing a
10974 ;; semicolon.
10982 c-macro-with-semi-re
10985 ;; Check we've got nothing after this except comments and empty lines
10986 ;; joined by escaped EOLs.
10999 nil)
11007 ;; Check for one of the listed macros being before point.
11011 t))
11019 \f
11020 ;; `c-guess-basic-syntax' and the functions that precedes it below
11021 ;; implements the main decision tree for determining the syntactic
11022 ;; analysis of the current line of code.
11024 ;; Dynamically bound to t when `c-guess-basic-syntax' is called during
11025 ;; auto newline analysis.
11029 ;; BRACEPOS is the position of a brace in a construct like "namespace
11030 ;; Bar {". Return the anchor point in this construct; this is the
11031 ;; earliest symbol on the brace's line which isn't earlier than
11032 ;; "namespace".
11033 ;;
11034 ;; Currently (2007-08-17), "like namespace" means "matches
11035 ;; c-other-block-decl-kwds". It doesn't work with "class" or "struct"
11036 ;; or anything like that.
11046 ;; A simple function to prepend a new syntax element to
11047 ;; `c-syntactic-context'. Using `setq' on it is unsafe since it
11048 ;; should always be dynamically bound but since we read it first
11049 ;; we'll fail properly anyway if this function is misused.
11051 c-syntactic-context)))
11054 ;; Like `c-add-syntax' but appends to the end of the syntax list.
11055 ;; (Normally not necessary.)
11060 syntax-extra-args
11061 stop-at-boi-only
11062 containing-sexp
11063 paren-state
11065 ;; Add the indicated SYNTAX-SYMBOL to `c-syntactic-context', extending it as
11066 ;; needed with further syntax elements of the types `substatement',
11067 ;; `inexpr-statement', `arglist-cont-nonempty', `statement-block-intro',
11068 ;; `defun-block-intro', and `brace-list-intro'.
11069 ;;
11070 ;; Do the generic processing to anchor the given syntax symbol on the
11071 ;; preceding statement: First skip over any labels and containing statements
11072 ;; on the same line. If FIXED-ANCHOR is non-nil, use this as the
11073 ;; anchor-point for the given syntactic symbol, and don't make syntactic
11074 ;; entries for constructs beginning on lines before that containing
11075 ;; ANCHOR-POINT. Otherwise search backward until we find a statement or
11076 ;; block start that begins at boi without a label or comment.
11077 ;;
11078 ;; Point is assumed to be at the prospective anchor point for the
11079 ;; given SYNTAX-SYMBOL. More syntax entries are added if we need to
11080 ;; skip past open parens and containing statements. Most of the added
11081 ;; syntax elements will get the same anchor point - the exception is
11082 ;; for an anchor in a construct like "namespace"[*] - this is as early
11083 ;; as possible in the construct but on the same line as the {.
11084 ;;
11085 ;; [*] i.e. with a keyword matching c-other-block-decl-kwds.
11086 ;;
11087 ;; SYNTAX-EXTRA-ARGS are a list of the extra arguments for the
11088 ;; syntax symbol. They are appended after the anchor point.
11089 ;;
11090 ;; If STOP-AT-BOI-ONLY is nil, we can stop in the middle of the line
11091 ;; if the current statement starts there.
11092 ;;
11093 ;; Note: It's not a problem if PAREN-STATE "overshoots"
11094 ;; CONTAINING-SEXP, i.e. contains info about parens further down.
11095 ;;
11096 ;; This function might do hidden buffer changes.
11099 ;; This is by far the most common case, so let's give it special
11100 ;; treatment.
11106 ;; Set when we're on a label, so that we don't stop there.
11107 ;; FIXME: To be complete we should check if we're on a label
11108 ;; now at the start.
11109 on-label)
11111 ;; Use point as the anchor point for "namespace", "extern", etc.
11115 syntax-extra-args)
11117 ;; Loop while we have to back out of containing blocks.
11122 ;; Loop while we have to back up statements.
11124 on-label
11127 ;; Skip past any comments that stands between the
11128 ;; statement start and boi.
11136 ;; Skip to the beginning of this statement or backward
11137 ;; another one.
11145 ;; If we didn't move we're at the start of a block and
11146 ;; have to continue outside it.
11155 ;; Special case to avoid deeper and deeper indentation
11156 ;; of "else if" clauses.
11157 )
11162 ;; If stop-at-boi-only is nil, we shouldn't back up
11163 ;; over previous or containing statements to try to
11164 ;; reach boi, so go back to the last position and
11165 ;; exit.
11172 ;; If we've moved into another statement then we
11173 ;; should no longer try to stop in the middle of a
11174 ;; line.
11177 ;; Record this as a substatement if we skipped up one
11178 ;; level.
11181 )))
11183 containing-sexp
11187 ;; Now we have to go out of this block.
11190 ;; Don't stop in the middle of a special brace list opener
11191 ;; like "({".
11203 ;; Analyze the construct in front of the block we've stepped out
11204 ;; from and add the right syntactic element for it.
11207 step-type)
11210 ;; Stepped out of a parenthesis block, so we're in an
11211 ;; expression now.
11223 ;; Stepped out of an in-expression statement. This
11224 ;; syntactic element won't get an anchor pos.
11227 ;; A parenthesis normally belongs to an arglist.
11235 on-label nil))
11237 ;; Stepped out of a brace block.
11249 containing-sexp)))
11251 'defun-block-intro
11253 nil))
11257 c-other-decl-block-key-in-symbols-alist))
11272 ;; Always done if the open brace was at boi. The
11273 ;; c-beginning-of-statement-1 call above is necessary
11274 ;; anyway, to decide the type of block-intro to add.
11277 ))
11279 ;; Fill in the current point as the anchor for all the symbols
11280 ;; added above.
11289 fixed-anchor)))
11292 )))
11295 containing-decl-open
11296 containing-decl-start
11297 containing-decl-kwd
11298 _paren-state)
11299 ;; The inclass and class-close syntactic symbols are added in
11300 ;; several places and some work is needed to fix everything.
11301 ;; Therefore it's collected here.
11302 ;;
11303 ;; This function might do hidden buffer changes.
11308 containing-decl-open)
11310 ;; Ought to use `c-add-stmt-syntax' instead of backing up to boi
11311 ;; here, but we have to do like this for compatibility.
11321 char-after-ip
11322 beg-of-same-or-containing-stmt
11323 containing-sexp
11324 paren-state)
11325 ;; This function contains the decision tree reached through both
11326 ;; cases 18 and 10. It's a continued statement or top level
11327 ;; construct of some kind.
11328 ;;
11329 ;; This function might do hidden buffer changes.
11336 ;; (CASE A removed.)
11337 ;; CASE B: open braces for class or brace-lists
11344 ;; CASE B.1: class-open
11351 ;; CASE B.2: brace-list-open
11355 containing-sexp beg-of-same-or-containing-stmt))
11356 )
11357 ;; The most semantically accurate symbol here is
11358 ;; brace-list-open, but we normally report it simply as a
11359 ;; statement-cont. The reason is that one normally adjusts
11360 ;; brace-list-open for brace lists as top-level constructs,
11361 ;; and brace lists inside statements is a completely different
11362 ;; context. C.f. case 5A.3.
11365 ;; Turn off the dwim above when we're
11366 ;; analyzing the nature of the brace
11367 ;; for the auto newline feature.
11368 'brace-list-open
11370 nil nil
11371 containing-sexp paren-state))
11373 ;; CASE B.3: The body of a function declared inside a normal
11374 ;; block. Can occur e.g. in Pike and when using gcc
11375 ;; extensions, but watch out for macros followed by blocks.
11376 ;; C.f. cases E, 16F and 17G.
11382 ;; Turn off recognition of constructs that lacks a
11383 ;; type in this case, since that's more likely to be
11384 ;; a macro followed by a block.
11387 containing-sexp paren-state))
11389 ;; CASE B.5: We have a C++11 "return \n { ..... }" Note that we're
11390 ;; not at the "{", currently.
11395 containing-sexp paren-state))
11397 ;; CASE B.4: Continued statement with block open. The most
11398 ;; accurate analysis is perhaps `statement-cont' together with
11399 ;; `block-open' but we play DWIM and use `substatement-open'
11400 ;; instead. The rationale is that this typically is a macro
11401 ;; followed by a block which makes it very similar to a
11402 ;; statement with a substatement block.
11405 containing-sexp paren-state))
11406 ))
11408 ;; CASE C: iostream insertion or extraction operator
11412 ;; If there is no preceding streamop in the statement
11413 ;; then indent this line as a normal statement-cont.
11417 t))))
11419 ;; CASE E: In the "K&R region" of a function declared inside a
11420 ;; normal block. C.f. case B.3.
11422 ;; Check that the next token is a '{'. This works as
11423 ;; long as no language that allows nested function
11424 ;; definitions allows stuff like member init lists, K&R
11425 ;; declarations or throws clauses there.
11426 ;;
11427 ;; Note that we do a forward search for something ahead
11428 ;; of the indentation line here. That's not good since
11429 ;; the user might not have typed it yet. Unfortunately
11430 ;; it's exceedingly tricky to recognize a function
11431 ;; prototype in a code block without resorting to this.
11439 ;; Turn off recognition of constructs that lacks a
11440 ;; type in this case, since that's more likely to be
11441 ;; a macro followed by a block.
11444 containing-sexp paren-state))
11446 ;;CASE F: continued statement and the only preceding items are
11447 ;;annotations.
11455 t)
11462 ;; CASE G: a template list continuation?
11463 ;; Mostly a duplication of case 5D.3 to fix templates-19:
11481 ;; In a nested template arglist.
11487 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
11488 ;; template aware.
11491 ;; CASE D: continued statement.
11495 containing-sexp paren-state))
11496 )))
11498 ;; The next autoload was added by RMS on 2005/8/9 - don't know why (ACM,
11499 ;; 2005/11/29).
11500 ;;;###autoload
11502 "Return the syntactic context of the current line."
11508 ;; A whole ugly bunch of various temporary variables. Have
11509 ;; to declare them here since it's not possible to declare
11510 ;; a variable with only the scope of a cond test and the
11511 ;; following result clauses, and most of this function is a
11512 ;; single gigantic cond. :P
11513 literal char-before-ip before-ws-ip char-after-ip macro-start
11514 in-macro-expr c-syntactic-context placeholder
11515 step-type tmpsymbol keyword injava-inher special-brace-list tmp-pos
11516 containing-<
11517 ;; The following record some positions for the containing
11518 ;; declaration block if we're directly within one:
11519 ;; `containing-decl-open' is the position of the open
11520 ;; brace. `containing-decl-start' is the start of the
11521 ;; declaration. `containing-decl-kwd' is the keyword
11522 ;; symbol of the keyword that tells what kind of block it
11523 ;; is.
11524 containing-decl-open
11525 containing-decl-start
11526 containing-decl-kwd
11527 ;; The open paren of the closest surrounding sexp or nil if
11528 ;; there is none.
11529 containing-sexp
11530 ;; The position after the closest preceding brace sexp
11531 ;; (nested sexps are ignored), or the position after
11532 ;; `containing-sexp' if there is none, or (point-min) if
11533 ;; `containing-sexp' is nil.
11534 lim
11535 ;; The paren state outside `containing-sexp', or at
11536 ;; `indent-point' if `containing-sexp' is nil.
11539 ;; There's always at most one syntactic element which got
11540 ;; an anchor pos. It's stored in syntactic-relpos.
11541 syntactic-relpos
11544 ;; Check if we're directly inside an enclosing declaration
11545 ;; level block.
11554 containing-sexp)
11555 t)))
11558 containing-sexp nil)
11563 ;; Init some position variables.
11576 ;; Ignore balanced paren. The next entry
11577 ;; can't be another one.
11580 ;; If there is no surrounding open paren then
11581 ;; put the last balanced pair back on paren-state.
11583 containing-sexp nil)))
11587 ;; If we're in a parenthesis list then ',' delimits the
11588 ;; "statements" rather than being an operator (with the
11589 ;; exception of the "for" clause). This difference is
11590 ;; typically only noticeable when statements are used in macro
11591 ;; arglists.
11595 ;; cache char before and after indent point, and move point to
11596 ;; the most likely position to perform the majority of tests
11605 ;; are we in a literal?
11608 ;; now figure out syntactic qualities of the current line
11611 ;; CASE 1: in a string.
11615 ;; CASE 2: in a C or C++ style comment.
11617 ;; This is a kludge for XEmacs where we use
11618 ;; `buffer-syntactic-context', which doesn't correctly
11619 ;; recognize "\*/" to end a block comment.
11620 ;; `parse-partial-sexp' which is used by
11621 ;; `c-literal-limits' will however do that in most
11622 ;; versions, which results in that we get nil from
11623 ;; `c-literal-limits' even when `c-in-literal' claims
11624 ;; we're inside a comment.
11628 ;; CASE 3: in a cpp preprocessor macro continuation.
11638 ;; If at the beginning of the body of a #define
11639 ;; directive then analyze as cpp-define-intro
11640 ;; only. Go on with the syntactic analysis
11641 ;; otherwise. in-macro-expr is set if we're in a
11642 ;; cpp expression, i.e. before the #define body
11643 ;; or anywhere in a non-#define directive.
11650 nil)))))
11654 ;; CASE 11: an else clause?
11658 containing-sexp paren-state))
11660 ;; CASE 12: while closure of a do/while construct?
11668 containing-sexp paren-state))
11670 ;; CASE 13: A catch or finally clause? This case is simpler
11671 ;; than if-else and do-while, because a block is required
11672 ;; after every try, catch and finally.
11680 t)
11684 t)
11687 t))
11692 containing-sexp paren-state))
11694 ;; CASE 18: A substatement we can recognize by keyword.
11704 ;; Ought to cache the result from the
11705 ;; c-beginning-of-statement-1 calls here.
11715 ;; Step up to the containing statement if we
11716 ;; stayed in the same one.
11724 ;; There was no containing statement after all.
11726 placeholder))
11728 ;; Require a parenthesis after these keywords.
11729 ;; Necessary to catch e.g. synchronized in Java,
11730 ;; which can be used both as statement and
11731 ;; modifier.
11737 ;; CASE 18A: Simple substatement.
11743 containing-sexp paren-state))
11749 containing-sexp paren-state))
11752 containing-sexp paren-state))))
11754 ;; CASE 18B: Some other substatement. This is shared
11755 ;; with case 10.
11757 char-after-ip
11758 placeholder
11759 lim
11760 paren-state)))
11762 ;; CASE 14: A case or default label
11767 containing-sexp
11780 containing-sexp))
11783 ;; Got a bogus label at the top level. In lack of better
11784 ;; alternatives, anchor it on (point-min).
11787 ;; CASE 15: any other label
11795 containing-decl-open
11796 containing-decl-start
11797 containing-decl-kwd
11798 paren-state))
11799 ;; Append access-label with the same anchor point as
11800 ;; inclass gets.
11806 containing-sexp))
11811 ;; If the surrounding statement is a switch then
11812 ;; let's analyze all labels as switch labels, so
11813 ;; that they get lined up consistently.
11814 'case-label
11820 ;; A label on the top level. Treat it as a class
11821 ;; context. (point-min) is the closest we get to the
11822 ;; class open brace.
11825 ;; CASE 4: In-expression statement. C.f. cases 7B, 16A and
11826 ;; 17E.
11829 containing-sexp
11830 ;; Have to turn on the heuristics after
11831 ;; the point even though it doesn't work
11832 ;; very well. C.f. test case class-16.pike.
11833 t))
11838 ;; It's a statement block or an anonymous class.
11840 ;; It's a Pike lambda. Check whether we are between the
11841 ;; lambda keyword and the argument list or at the defun
11842 ;; opener.
11844 'inline-open
11850 paren-state)
11854 ;; CASE 5: Line is inside a declaration level block or at top level.
11858 ;; CASE 5A: we are looking at a defun, brace list, class,
11859 ;; or inline-inclass method opening brace
11866 ;; CASE 5A.1: Non-class declaration block open.
11881 ;; Special case for extern-lang-open.
11882 'extern-lang-open
11884 nil t containing-sexp paren-state))
11886 ;; CASE 5A.2: we are looking at a class opening brace
11895 ;; CASE 5A.3: brace list open
11904 containing-sexp lim)))
11908 ;(c-major-mode-is 'java-mode) ; Not needed anymore (2016-08-30).
11910 ;; We're in Java and have found that the open brace
11911 ;; belongs to a "new Foo[]" initialization list,
11912 ;; which means the brace list is part of an
11913 ;; expression and not a top level definition. We
11914 ;; therefore treat it as any topmost continuation
11915 ;; even though the semantically correct symbol still
11916 ;; is brace-list-open, on the same grounds as in
11917 ;; case B.2.
11923 ;; CASE 5A.4: inline defun open
11929 containing-decl-open
11930 containing-decl-start
11931 containing-decl-kwd
11932 paren-state))
11934 ;; CASE 5A.5: ordinary defun open
11945 ;; Bogus to use bol here, but it's the legacy. (Resolved,
11946 ;; 2007-11-09)
11947 ))))
11949 ;; CASE 5R: Member init list. (Used to be part of CASE 5B.1)
11950 ;; Note there is no limit on the backward search here, since member
11951 ;; init lists can, in practice, be very large.
11958 ;; There is no preceding member init clause.
11959 ;; Indent relative to the beginning of indentation
11960 ;; for the topmost-intro line that contains the
11961 ;; prototype's open paren.
11964 ;; Indent relative to the first member init clause.
11969 ;; CASE 5B: After a function header but before the body (or
11970 ;; the ending semicolon if there's no body).
11977 ;; CASE 5B.1: Member init list.
11979 ;; There is no preceding member init clause.
11980 ;; Indent relative to the beginning of indentation
11981 ;; for the topmost-intro line that contains the
11982 ;; prototype's open paren.
11986 ;; CASE 5B.2: K&R arg decl intro
11993 containing-decl-open
11994 containing-decl-start
11995 containing-decl-kwd
11996 paren-state)))
11998 ;; CASE 5B.4: Nether region after a C++ or Java func
11999 ;; decl, which could include a `throws' declaration.
12003 )))
12005 ;; CASE 5C: inheritance line. could be first inheritance
12006 ;; line, or continuation of a multiple inheritance
12014 ;; watch out for scope operator
12019 )))
12028 ;; for Java
12033 cont done)
12038 done t))
12042 )
12044 injava-inher)
12047 ))
12050 ;; CASE 5C.1: non-hanging colon on an inher intro
12054 ;; don't add inclass symbol since relative point already
12055 ;; contains any class offset
12056 )
12058 ;; CASE 5C.2: hanging colon on an inher intro
12064 containing-decl-open
12065 containing-decl-start
12066 containing-decl-kwd
12067 paren-state)))
12069 ;; CASE 5C.3: in a Java implements/extends
12083 )))
12085 ;; CASE 5C.4: a continued inheritance line
12089 ;; don't add inclass symbol since relative point already
12090 ;; contains any class offset
12091 )))
12093 ;; CASE 5P: AWK pattern or function or continuation
12094 ;; thereof.
12100 'topmost-intro-cont
12102 nil nil
12103 containing-sexp paren-state))
12105 ;; CASE 5D: this could be a top-level initialization, a
12106 ;; member init list continuation, or a template argument
12107 ;; list continuation.
12109 ;; Note: We use the fact that lim is always after any
12110 ;; preceding brace sexp.
12120 t))
12125 t)
12131 nil)
12132 t))
12134 ;; NB: No c-after-special-operator-id stuff in this
12135 ;; clause - we assume only C++ needs it.
12140 ;; CASE 5D.3: perhaps a template list continuation?
12155 ;; In a nested template arglist.
12161 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
12162 ;; template aware.
12165 ;; CASE 5D.4: perhaps a multiple inheritance line?
12177 t)
12182 ;; CASE 5D.5: Continuation of the "expression part" of a
12183 ;; top level construct. Or, perhaps, an unrecognized construct.
12195 ;; A preceding comma at the top level means that a
12196 ;; new variable declaration starts here. Use
12197 ;; topmost-intro-cont for it, for consistency with
12198 ;; the first variable declaration. C.f. case 5N.
12201 nil nil containing-sexp paren-state))
12202 ))
12204 ;; CASE 5F: Close of a non-class declaration level block.
12208 ;; This is inconsistent: Should use `containing-decl-open'
12209 ;; here if it's at boi, like in case 5J.
12213 ;; Special case for compatibility with the
12214 ;; extern-lang syntactic symbols.
12215 'extern-lang-close
12218 nil t
12220 paren-state))
12222 ;; CASE 5G: we are looking at the brace which closes the
12223 ;; enclosing nested class decl
12228 containing-decl-open
12229 containing-decl-start
12230 containing-decl-kwd
12231 paren-state))
12233 ;; CASE 5H: we could be looking at subsequent knr-argdecls
12240 ;; Do an extra check to avoid tripping up on
12241 ;; statements that occur in invalid contexts
12242 ;; (e.g. in macro bodies where we don't really
12243 ;; know the context of what we're looking at).
12250 ;; CASE 5I: ObjC method definition.
12255 ;; Handle the case when it's the first (non-comment)
12256 ;; thing in the buffer. Can't look for a 'same return
12257 ;; value from cbos1 since ObjC directives currently
12258 ;; aren't recognized fully, so that we get 'same
12259 ;; instead of 'previous if it moved over a preceding
12260 ;; directive.
12264 ;; CASE 5N: At a variable declaration that follows a class
12265 ;; definition or some other block declaration that doesn't
12266 ;; end at the closing '}'. C.f. case 5D.5.
12275 ;; Speed up the backward search a bit.
12280 ;; The '}' is unbalanced.
12281 nil
12286 containing-sexp paren-state))
12288 ;; NOTE: The point is at the end of the previous token here.
12290 ;; CASE 5J: we are at the topmost level, make
12291 ;; sure we skip back past any access specifiers
12293 ;; A macro continuation line is never at top level.
12315 nil)))))
12316 ;; For historic reasons we anchor at bol of the last
12317 ;; line of the previous declaration. That's clearly
12318 ;; highly bogus and useless, and it makes our lives hard
12319 ;; to remain compatible. :P
12330 ;; Special case for compatibility with the
12331 ;; extern-lang syntactic symbols.
12332 'inextern-lang
12335 nil t
12337 paren-state))
12339 containing-decl-open
12340 containing-decl-start
12341 containing-decl-kwd
12342 paren-state)))
12344 macro-start
12349 ;; CASE 5K: we are at an ObjC method definition
12350 ;; continuation line.
12359 ;; CASE 5L: we are at the first argument of a template
12360 ;; arglist that begins on the previous line.
12368 ;; CASE 5Q: we are at a statement within a macro.
12373 ;;CASE 5N: We are at a topmost continuation line and the only
12374 ;;preceding items are annotations.
12381 t)
12387 ;; CASE 5M: we are at a topmost continuation line
12398 ))
12400 ;; (CASE 6 has been removed.)
12402 ;; CASE 7: line is an expression, not a statement. Most
12403 ;; likely we are either in a function prototype or a function
12404 ;; call argument list
12412 ;; CASE 7A: we are looking at the arglist closing paren.
12413 ;; C.f. case 7F.
12425 paren-state))
12427 ;; CASE 7B: Looking at the opening brace of an
12428 ;; in-expression block or brace list. C.f. cases 4, 16A
12429 ;; and 17E.
12433 paren-state
12434 nil))
12438 placeholder
12441 paren-state)
12442 containing-sexp)))
12443 ;; placeholder is nil if it's a block directly in
12444 ;; a function arglist. That makes us skip out of
12445 ;; this case.
12446 )))
12451 paren-state)
12455 ;; CASE 7C: we are looking at the first argument in an empty
12456 ;; argument list. Use arglist-close if we're actually
12457 ;; looking at a close paren or bracket.
12469 paren-state))
12471 ;; CASE 7D: we are inside a conditional test clause. treat
12472 ;; these things as statements
12482 ))
12484 ;; CASE 7E: maybe a continued ObjC method call. This is the
12485 ;; case when we are inside a [] bracketed exp, and what
12486 ;; precede the opening bracket is not an identifier.
12494 )))
12496 ;; CASE 7F: we are looking at an arglist continuation line,
12497 ;; but the preceding argument is on the same line as the
12498 ;; opening paren. This case includes multi-line
12499 ;; mathematical paren groupings, but we could be on a
12500 ;; for-list continuation line. C.f. case 7A.
12517 paren-state))
12519 ;; CASE 7G: we are looking at just a normal arglist
12520 ;; continuation line
12523 ))
12525 ;; CASE 8: func-local multi-inheritance line
12535 ;; CASE 8A: non-hanging colon on an inher intro
12540 ;; CASE 8B: hanging colon on an inher intro
12544 ;; CASE 8C: a continued inheritance line
12548 )))
12550 ;; CASE 9: we are inside a brace-list
12560 ;; CASE 9A: In the middle of a special brace list opener.
12583 ;; CASE 9B: brace-list-close brace
12585 ;; Check special brace list closer.
12592 ;; We were between the special close char and the `)'.
12595 ;; We were before the special close char.
12599 ;; Normal brace list check.
12610 ;; Prepare for the rest of the cases below by going to the
12611 ;; token following the opening brace
12624 ;; CASE 9C: we're looking at the first line in a brace-list
12635 ;; CASE 9D: this is just a later brace-list-entry or
12636 ;; brace-entry-open
12646 ))
12647 ))))
12649 ;; CASE 10: A continued statement or top level construct.
12659 ;; This is shared with case 18.
12661 char-after-ip
12662 placeholder
12663 containing-sexp
12664 paren-state))
12666 ;; CASE 16: block close brace, possibly closing the defun or
12667 ;; the class
12669 ;; From here on we have the next containing sexp in lim.
12674 ;; CASE 16E: Closing a statement block? This catches
12675 ;; cases where it's preceded by a statement keyword,
12676 ;; which works even when used in an "invalid" context,
12677 ;; e.g. a macro argument.
12682 ;; CASE 16A: closing a lambda defun or an in-expression
12683 ;; block? C.f. cases 4, 7B and 17E.
12686 nil))
12688 'inline-close
12698 paren-state)
12702 ;; CASE 16B: does this close an inline or a function in
12703 ;; a non-class declaration level block?
12710 nil))
12720 ;; CASE 16F: Can be a defun-close of a function declared
12721 ;; in a statement block, e.g. in Pike or when using gcc
12722 ;; extensions, but watch out for macros followed by
12723 ;; blocks. Let it through to be handled below.
12724 ;; C.f. cases B.3 and 17G.
12730 ;; Turn off recognition of constructs that
12731 ;; lacks a type in this case, since that's more
12732 ;; likely to be a macro followed by a block.
12739 ;; CASE 16C: If there is an enclosing brace then this is
12740 ;; a block close since defun closes inside declaration
12741 ;; level blocks have been handled above.
12743 ;; If the block is preceded by a case/switch label on
12744 ;; the same line, we anchor at the first preceding label
12745 ;; at boi. The default handling in c-add-stmt-syntax
12746 ;; really fixes it better, but we do like this to keep
12747 ;; the indentation compatible with version 5.28 and
12748 ;; earlier. C.f. case 17H.
12755 ;; c-backward-to-block-anchor not necessary here; those
12756 ;; situations are handled in case 16E above.
12759 ;; CASE 16D: Only top level defun close left.
12765 paren-state))
12766 ))
12768 ;; CASE 19: line is an expression, not a statement, and is directly
12769 ;; contained by a template delimiter. Most likely, we are in a
12770 ;; template arglist within a statement. This case is based on CASE
12771 ;; 7. At some point in the future, we may wish to create more
12772 ;; syntactic symbols such as `template-intro',
12773 ;; `template-cont-nonempty', etc., and distinguish between them as we
12774 ;; do for `arglist-intro' etc. (2009-12-07).
12780 ; '<') before indent-point.
12788 paren-state))
12790 ;; CASE 17: Statement or defun catchall.
12793 ;; Back up statements until we find one that starts at boi.
12796 containing-sexp)))
12800 nil)
12805 ;; CASE 17B: continued statement
12809 containing-sexp paren-state))
12811 ;; CASE 17A: After a case/default label?
12819 'statement-case-open
12821 nil t containing-sexp paren-state))
12823 ;; CASE 17D: any old statement
12830 containing-sexp paren-state)
12834 ;; CASE 17I: Inside a substatement block.
12836 ;; The following tests are all based on containing-sexp.
12838 ;; From here on we have the next containing sexp in lim.
12843 lim paren-state)
12847 ;; CASE 17E: first statement in an in-expression block.
12848 ;; C.f. cases 4, 7B and 16A.
12851 nil))
12853 'defun-block-intro
12862 paren-state)
12868 ;; CASE 17F: first statement in an inline, or first
12869 ;; statement in a top-level defun. we can tell this is it
12870 ;; if there are no enclosing braces that haven't been
12871 ;; narrowed out by a class (i.e. don't use bod here).
12874 paren-state)))
12880 nil))))
12885 ;; CASE 17G: First statement in a function declared inside
12886 ;; a normal block. This can occur in Pike and with
12887 ;; e.g. the gcc extensions, but watch out for macros
12888 ;; followed by blocks. C.f. cases B.3 and 16F.
12894 ;; Turn off recognition of constructs that lacks
12895 ;; a type in this case, since that's more likely
12896 ;; to be a macro followed by a block.
12902 lim paren-state))
12904 ;; CASE 17H: First statement in a block.
12906 ;; If the block is preceded by a case/switch label on the
12907 ;; same line, we anchor at the first preceding label at
12908 ;; boi. The default handling in c-add-stmt-syntax is
12909 ;; really fixes it better, but we do like this to keep the
12910 ;; indentation compatible with version 5.28 and earlier.
12911 ;; C.f. case 16C.
12918 ;; c-backward-to-block-anchor not necessary here; those
12919 ;; situations are handled in case 17I above.
12921 lim paren-state))
12924 ))
12925 )
12927 ;; now we need to look at any modifiers
12931 ;; are we looking at a comment only line?
12936 ;; we might want to give additional offset to friends (in C++).
12941 ;; Set syntactic-relpos.
12947 nil)
12948 t))
12951 ;; Start of or a continuation of a preprocessor directive?
12966 ;; If inside a cpp expression, i.e. anywhere in a
12967 ;; cpp directive except a #define body, we only let
12968 ;; through the syntactic analysis that is internal
12969 ;; in the expression. That means the arglist
12970 ;; elements, if they are anchored inside the cpp
12971 ;; expression.
12980 ;; Inside a #define body and the syntactic analysis is
12981 ;; anchored on the start of the #define. In this case
12982 ;; we add cpp-define-intro to get the extra
12983 ;; indentation of the #define body.
12986 ;; return the syntax
12987 c-syntactic-context)))
12989 \f
12990 ;; Indentation calculation.
12993 ;; offset can be a number, a function, a variable, a list, or one of
12994 ;; the symbols + or -
12995 ;;
12996 ;; This function might do hidden buffer changes.
13015 langelem symbol))
13021 offset symbol)
13022 nil)
13036 Error evaluating offset %S for %s: \
13037 Cannot combine absolute offset %S with relative %S in `%s' method"
13043 Error evaluating offset %S for %s: \
13044 Cannot combine relative offset %S with absolute %S in `%s' method"
13049 res))
13067 Error evaluating offset %S for %s: \
13068 Cannot combine absolute offsets %S and %S in `add' method"
13072 res))
13081 res))))
13088 nil))))
13092 res
13094 offset symbol res)
13095 nil)))
13098 ;; Get offset from LANGELEM which is a list beginning with the
13099 ;; syntactic symbol and followed by any analysis data it provides.
13100 ;; That data may be zero or more elements, but if at least one is
13101 ;; given then the first is the anchor position (or nil). The symbol
13102 ;; is matched against `c-offsets-alist' and the offset calculated
13103 ;; from that is returned.
13104 ;;
13105 ;; This function might do hidden buffer changes.
13115 offset
13119 ))
13122 ;; This is a compatibility wrapper for `c-calc-offset' in case
13123 ;; someone is calling it directly. It takes an old style syntactic
13124 ;; element on the form (SYMBOL . ANCHOR-POS) and converts it to the
13125 ;; new list form.
13126 ;;
13127 ;; This function might do hidden buffer changes.
13134 ;; Calculate the syntactic indentation from a syntactic description
13135 ;; as returned by `c-guess-syntax'.
13136 ;;
13137 ;; Note that topmost-intro always has an anchor position at bol, for
13138 ;; historical reasons. It's often used together with other symbols
13139 ;; that have more sane positions. Since we always use the first
13140 ;; found anchor position, we rely on that these other symbols always
13141 ;; precede topmost-intro in the LANGELEMS list.
13142 ;;
13143 ;; This function might do hidden buffer changes.
13151 ;; Got an absolute column that overrides any indentation
13152 ;; we've collected so far, but not the relative
13153 ;; indentation we might get for the nested structures
13154 ;; further down the langelems list.
13158 ;; Got a relative change of the current calculated
13159 ;; indentation.
13162 ;; Use the anchor position from the first syntactic
13163 ;; element with one.
13173 indent)))
13175 \f
13178 ;; Local Variables:
13179 ;; indent-tabs-mode: t
13180 ;; tab-width: 8
13181 ;; End:
13182 ;;; cc-engine.el ends here