| blob | b8051b274d2a68c079f8eda4de5f964d6398edc3 |
1 ;;; cc-engine.el --- core syntax guessing engine for CC mode -*- coding: utf-8 -*-
3 ;; Copyright (C) 1985, 1987, 1992-2015 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 <http://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, and
87 ;; to "hide" obtrusive characters in preprocessor lines.
88 ;;
89 ;; This property is used on single characters and is therefore
90 ;; always treated as front and rear nonsticky (or start and end open
91 ;; in XEmacs vocabulary). It's therefore installed on
92 ;; `text-property-default-nonsticky' if that variable exists (Emacs
93 ;; >= 21).
94 ;;
95 ;; 'c-is-sws and 'c-in-sws
96 ;; Used by `c-forward-syntactic-ws' and `c-backward-syntactic-ws' to
97 ;; speed them up. See the comment blurb before `c-put-is-sws'
98 ;; below for further details.
99 ;;
100 ;; 'c-type
101 ;; This property is used on single characters to mark positions with
102 ;; special syntactic relevance of various sorts. Its primary use is
103 ;; to avoid glitches when multiline constructs are refontified
104 ;; interactively (on font lock decoration level 3). It's cleared in
105 ;; a region before it's fontified and is then put on relevant chars
106 ;; in that region as they are encountered during the fontification.
107 ;; The value specifies the kind of position:
108 ;;
109 ;; 'c-decl-arg-start
110 ;; Put on the last char of the token preceding each declaration
111 ;; inside a declaration style arglist (typically in a function
112 ;; prototype).
113 ;;
114 ;; 'c-decl-end
115 ;; Put on the last char of the token preceding a declaration.
116 ;; This is used in cases where declaration boundaries can't be
117 ;; recognized simply by looking for a token like ";" or "}".
118 ;; `c-type-decl-end-used' must be set if this is used (see also
119 ;; `c-find-decl-spots').
120 ;;
121 ;; 'c-<>-arg-sep
122 ;; Put on the commas that separate arguments in angle bracket
123 ;; arglists like C++ template arglists.
124 ;;
125 ;; 'c-decl-id-start and 'c-decl-type-start
126 ;; Put on the last char of the token preceding each declarator
127 ;; in the declarator list of a declaration. They are also used
128 ;; between the identifiers cases like enum declarations.
129 ;; 'c-decl-type-start is used when the declarators are types,
130 ;; 'c-decl-id-start otherwise.
131 ;;
132 ;; 'c-awk-NL-prop
133 ;; Used in AWK mode to mark the various kinds of newlines. See
134 ;; cc-awk.el.
136 ;;; Code:
143 load-path)))
150 \f
151 ;; Make declarations for all the `c-lang-defvar' variables in cc-langs.
164 \f
165 ;;; Internal state variables.
167 ;; Internal state of hungry delete key feature
171 ;; The electric flag (toggled by `c-toggle-electric-state').
172 ;; If t, electric actions (like automatic reindentation, and (if
173 ;; c-auto-newline is also set) auto newlining) will happen when an electric
174 ;; key like `{' is pressed (or an electric keyword like `else').
178 ;; Internal state of auto newline feature.
182 ;; Included in the mode line to indicate the active submodes.
183 ;; (defvar c-submode-indicators nil)
184 ;; (make-variable-buffer-local 'c-submode-indicators)
187 ;; Calculate the new state of PREVSTATE, t or nil, based on arg. If
188 ;; arg is nil or zero, toggle the state. If arg is negative, turn
189 ;; the state off, and if arg is positive, turn the state on
195 \f
196 ;; Basic handling of preprocessor directives.
198 ;; This is a dynamically bound cache used together with
199 ;; `c-query-macro-start' and `c-query-and-set-macro-start'. It only
200 ;; works as long as point doesn't cross a macro boundary.
209 c-macro-start))
217 c-macro-start))
219 ;; One element macro cache to cope with continual movement within very large
220 ;; CPP macros.
223 ;; Nil or cons of the bounds of the most recent CPP form probed by
224 ;; `c-beginning-of-macro', `c-end-of-macro' or `c-syntactic-end-of-macro'.
225 ;; The cdr will be nil if we know only the start of the CPP form.
228 ;; The starting position from where we determined `c-macro-cache'.
231 ;; non-nil iff `c-macro-cache' has both elements set AND the cdr is at a
232 ;; syntactic end of macro, not merely an apparent one.
235 ;; Called from a before-change function. If the change region is before or
236 ;; in the macro characterized by `c-macro-cache' etc., nullify it
237 ;; appropriately. BEG and END are the standard before-change-functions
238 ;; parameters. END isn't used.
243 c-macro-cache-start-pos nil
244 c-macro-cache-syntactic nil))
249 c-macro-cache-syntactic nil))))
252 ;; Check that the ostensible CPP construct at point is a real one. In
253 ;; particular, if point is on the first line of a narrowed buffer, make sure
254 ;; that the "#" isn't, say, the second character of a "##" operator. Return
255 ;; t when the macro is real, nil otherwise.
266 t)
270 "Go to the beginning of a preprocessor directive.
271 Leave point at the beginning of the directive and return t if in one,
272 otherwise return nil and leave point unchanged.
274 Note that this function might do hidden buffer changes. See the
275 comment at the start of cc-engine.el for more info."
287 t))
289 c-macro-cache-start-pos nil
290 c-macro-cache-syntactic nil)
303 c-macro-cache-start-pos here)
304 t)
306 nil))))))
309 "Go to the end of a preprocessor directive.
310 More accurately, move the point to the end of the closest following
311 line that doesn't end with a line continuation backslash - no check is
312 done that the point is inside a cpp directive to begin with.
314 Note that this function might do hidden buffer changes. See the
315 comment at the start of cc-engine.el for more info."
324 c-macro-cache-start-pos nil
325 c-macro-cache-syntactic nil))
331 t)))
336 ;; Go to the end of a CPP directive, or a "safe" pos just before.
337 ;;
338 ;; This is normally the end of the next non-escaped line. A "safe"
339 ;; position is one not within a string or comment. (The EOL on a line
340 ;; comment is NOT "safe").
341 ;;
342 ;; This function must only be called from the beginning of a CPP construct.
343 ;;
344 ;; Note that this function might do hidden buffer changes. See the comment
345 ;; at the start of cc-engine.el for more info.
348 s)
360 ;; Assuming point is at the "#" that introduces a preprocessor
361 ;; directive, it's moved forward to the end of the identifier which is
362 ;; "#define"d (or whatever c-opt-cpp-macro-define specifies). Non-nil
363 ;; is returned in this case, in all other cases nil is returned and
364 ;; point isn't moved.
365 ;;
366 ;; This function might do hidden buffer changes.
372 ;; Assuming point is at the "#" that introduces a preprocessor
373 ;; directive, it's moved forward to the start of the definition body
374 ;; if it's a "#define" (or whatever c-opt-cpp-macro-define
375 ;; specifies). Non-nil is returned in this case, in all other cases
376 ;; nil is returned and point isn't moved.
377 ;;
378 ;; This function might do hidden buffer changes.
384 \f
385 ;;; Basic utility functions.
388 ;; Return the given region as a string where all syntactic
389 ;; whitespace is removed or, where necessary, replaced with a single
390 ;; space. If PAREN-LEVEL is given then all parens in the region are
391 ;; collapsed to "()", "[]" etc.
392 ;;
393 ;; This function might do hidden buffer changes.
437 ;; Shift the indentation of the current line with the specified
438 ;; amount (positive inwards). The buffer is modified only if
439 ;; SHIFT-AMT isn't equal to zero.
442 tmp-char-inserted)
444 nil
445 ;; If we're on an empty line inside a macro, we take the point
446 ;; to be at the current indentation and shift it to the
447 ;; appropriate column. This way we don't treat the extra
448 ;; whitespace out to the line continuation as indentation.
464 ;; If initial point was within line's indentation and we're not on
465 ;; a line with a line continuation in a macro, position after the
466 ;; indentation. Else stay at same point in text.
474 ;; Return non-nil if the string KEYWORD is a known keyword. More
475 ;; precisely, the value is the symbol for the keyword in
476 ;; `c-keywords-obarray'.
480 ;; Return non-nil if the symbol KEYWORD-SYM, as returned by
481 ;; `c-keyword-sym', is a member of LANG-CONSTANT, which is the name
482 ;; of a language constant that ends with "-kwds". If KEYWORD-SYM is
483 ;; nil then the result is nil.
486 ;; String syntax chars, suitable for skip-syntax-(forward|backward).
491 ;; Regexp matching string limit syntax.
496 ;; Regexp matching WS followed by string limit syntax.
500 ;; Holds formatted error strings for the few cases where parse errors
501 ;; are reported.
508 c-parsing-error)
510 ;; Faces given to comments and string literals. This is used in some
511 ;; situations to speed up recognition; it isn't mandatory that font
512 ;; locking is in use. This variable is extended with the face in
513 ;; `c-doc-face-name' when fontification is activated in cc-fonts.el.
517 ;; New in Emacs 22.
521 ;; Put a c-type property with the given value at POS.
525 ;; Remove all occurrences of the c-type property that has the given
526 ;; value in the region between FROM and TO. VALUE is assumed to not
527 ;; be nil.
528 ;;
529 ;; Note: This assumes that c-type is put on single chars only; it's
530 ;; very inefficient if matching properties cover large regions.
539 \f
540 ;; Some debug tools to visualize various special positions. This
541 ;; debug code isn't as portable as the rest of CC Mode.
577 \f
578 ;; `c-beginning-of-statement-1' and accompanying stuff.
580 ;; KLUDGE ALERT: c-maybe-labelp is used to pass information between
581 ;; c-crosses-statement-barrier-p and c-beginning-of-statement-1. A
582 ;; better way should be implemented, but this will at least shut up
583 ;; the byte compiler.
586 ;; New awk-compatible version of c-beginning-of-statement-1, ACM 2002/6/22
588 ;; Macros used internally in c-beginning-of-statement-1 for the
589 ;; automaton actions.
592 stack)))
597 t
598 ,do-if-done
603 ;; Throw nil if stack is empty, else throw non-nil.
627 noerror comma-delim)
628 "Move to the start of the current statement or declaration, or to
629 the previous one if already at the beginning of one. Only
630 statements/declarations on the same level are considered, i.e. don't
631 move into or out of sexps (not even normal expression parentheses).
633 If point is already at the earliest statement within braces or parens,
634 this function doesn't move back into any whitespace preceding it; it
635 returns 'same in this case.
639 is within the continuation. If starting at such a token, move to the
640 corresponding statement start. If at the beginning of a statement,
641 move to the closest containing statement if there is any. This might
642 also stop at a continuation clause.
644 Labels are treated as part of the following statements if
645 IGNORE-LABELS is non-nil. (FIXME: Doesn't work if we stop at a known
646 statement start keyword.) Otherwise, each label is treated as a
647 separate statement.
649 Macros are ignored \(i.e. skipped over) unless point is within one, in
650 which case the content of the macro is treated as normal code. Aside
651 from any normal statement starts found in it, stop at the first token
654 macros before leaving them.
656 Return:
658 'same if stopped at the beginning of the current statement;
659 'up if stepped to a containing statement;
660 'previous if stepped to a preceding statement;
661 'beginning if stepped from a statement continuation clause to
662 its start clause; or
663 'macro if stepped to a macro start.
664 Note that 'same and not 'label is returned if stopped at the same
665 label without crossing the colon character.
667 LIM may be given to limit the search. If the search hits the limit,
668 point will be left at the closest following token, or at the start
669 position if that is less ('same is returned in this case).
671 NOERROR turns off error logging to `c-parsing-error'.
673 Normally only ';' and virtual semicolons are considered to delimit
674 statements, but if COMMA-DELIM is non-nil then ',' is treated
675 as a delimiter too.
677 Note that this function might do hidden buffer changes. See the
678 comment at the start of cc-engine.el for more info."
680 ;; The bulk of this function is a pushdown automaton that looks at statement
681 ;; boundaries and the tokens (such as "while") in c-opt-block-stmt-key. Its
682 ;; purpose is to keep track of nested statements, ensuring that such
683 ;; statements are skipped over in their entirety (somewhat akin to what C-M-p
684 ;; does with nested braces/brackets/parentheses).
685 ;;
686 ;; Note: The position of a boundary is the following token.
687 ;;
688 ;; Beginning with the current token (the one following point), move back one
689 ;; sexp at a time (where a sexp is, more or less, either a token or the
690 ;; entire contents of a brace/bracket/paren pair). Each time a statement
691 ;; boundary is crossed or a "while"-like token is found, update the state of
692 ;; the PDA. Stop at the beginning of a statement when the stack (holding
693 ;; nested statement info) is empty and the position has been moved.
694 ;;
695 ;; The following variables constitute the PDA:
696 ;;
697 ;; sym: This is either the "while"-like token (e.g. 'for) we've just
698 ;; scanned back over, 'boundary if we've just gone back over a
699 ;; statement boundary, or nil otherwise.
700 ;; state: takes one of the values (nil else else-boundary while
701 ;; while-boundary catch catch-boundary).
702 ;; nil means "no "while"-like token yet scanned".
703 ;; 'else, for example, means "just gone back over an else".
704 ;; 'else-boundary means "just gone back over a statement boundary
705 ;; immediately after having gone back over an else".
706 ;; saved-pos: A vector of either saved positions (tok ptok pptok, etc.) or
707 ;; of error reporting information.
708 ;; stack: The stack onto which the PDA pushes its state. Each entry
709 ;; consists of a saved value of state and saved-pos. An entry is
710 ;; pushed when we move back over a "continuation" token (e.g. else)
711 ;; and popped when we encounter the corresponding opening token
712 ;; (e.g. if).
713 ;;
714 ;;
715 ;; The following diagram briefly outlines the PDA.
716 ;;
717 ;; Common state:
718 ;; "else": Push state, goto state `else'.
719 ;; "while": Push state, goto state `while'.
720 ;; "catch" or "finally": Push state, goto state `catch'.
721 ;; boundary: Pop state.
722 ;; other: Do nothing special.
723 ;;
724 ;; State `else':
725 ;; boundary: Goto state `else-boundary'.
726 ;; other: Error, pop state, retry token.
727 ;;
728 ;; State `else-boundary':
729 ;; "if": Pop state.
730 ;; boundary: Error, pop state.
731 ;; other: See common state.
732 ;;
733 ;; State `while':
734 ;; boundary: Save position, goto state `while-boundary'.
735 ;; other: Pop state, retry token.
736 ;;
737 ;; State `while-boundary':
738 ;; "do": Pop state.
739 ;; boundary: Restore position if it's not at start, pop state. [*see below]
740 ;; other: See common state.
741 ;;
742 ;; State `catch':
743 ;; boundary: Goto state `catch-boundary'.
744 ;; other: Error, pop state, retry token.
745 ;;
746 ;; State `catch-boundary':
747 ;; "try": Pop state.
748 ;; "catch": Goto state `catch'.
749 ;; boundary: Error, pop state.
750 ;; other: See common state.
751 ;;
752 ;; [*] In the `while-boundary' state, we had pushed a 'while state, and were
753 ;; searching for a "do" which would have opened a do-while. If we didn't
754 ;; find it, we discard the analysis done since the "while", go back to this
755 ;; token in the buffer and restart the scanning there, this time WITHOUT
756 ;; pushing the 'while state onto the stack.
757 ;;
758 ;; In addition to the above there is some special handling of labels
759 ;; and macros.
763 macro-start
766 c-stmt-delim-chars-with-comma
767 c-stmt-delim-chars))
768 c-in-literal-cache c-maybe-labelp after-case:-pos saved
769 ;; Current position.
770 pos
771 ;; Position of last stmt boundary character (e.g. ;).
772 boundary-pos
773 ;; The position of the last sexp or bound that follows the
774 ;; first found colon, i.e. the start of the nonlabel part of
775 ;; the statement. It's `start' if a colon is found just after
776 ;; the start.
777 after-labels-pos
778 ;; Like `after-labels-pos', but the first such position inside
779 ;; a label, i.e. the start of the last label before the start
780 ;; of the nonlabel part of the statement.
781 last-label-pos
782 ;; The last position where a label is possible provided the
783 ;; statement started there. It's nil as long as no invalid
784 ;; label content has been found (according to
785 ;; `c-nonlabel-token-key'). It's `start' if no valid label
786 ;; content was found in the label. Note that we might still
787 ;; regard it a label if it starts with `c-label-kwds'.
788 label-good-pos
789 ;; Putative positions of the components of a bitfield declaration,
790 ;; e.g. "int foo : NUM_FOO_BITS ;"
791 bitfield-type-pos bitfield-id-pos bitfield-size-pos
792 ;; Symbol just scanned back over (e.g. 'while or 'boundary).
793 ;; See above.
794 sym
795 ;; Current state in the automaton. See above.
796 state
797 ;; Current saved positions. See above.
798 saved-pos
799 ;; Stack of conses (state . saved-pos).
800 stack
801 ;; Regexp which matches "for", "if", etc.
804 ;; Return value.
806 ;; Positions of the last three sexps or bounds we've stopped at.
807 tok ptok pptok)
817 ;; Try to skip back over unary operator characters, to register
818 ;; that we've moved.
822 ;; Protect post-++/-- operators just before a virtual semicolon.
826 ;; Skip back over any semicolon here. If it was a bare semicolon, we're
827 ;; done. Later on we ignore the boundaries for statements that don't
828 ;; contain any sexp. The only thing that is affected is that the error
829 ;; checking is a little less strict, and we really don't bother.
839 pos saved)
841 ;; Begin at start and not pos to detect macros if we stand
842 ;; directly after the #.
845 ;; Record this as the first token if not starting inside it.
849 ;; The following while loop goes back one sexp (balanced parens,
850 ;; etc. with contents, or symbol or suchlike) each iteration. This
851 ;; movement is accomplished with a call to c-backward-sexp approx 170
852 ;; lines below.
853 ;;
854 ;; The loop is exited only by throwing nil to the (catch 'loop ...):
855 ;; 1. On reaching the start of a macro;
856 ;; 2. On having passed a stmt boundary with the PDA stack empty;
857 ;; 3. On reaching the start of an Objective C method def;
858 ;; 4. From macro `c-bos-pop-state'; when the stack is empty;
859 ;; 5. From macro `c-bos-pop-state-and-retry' when the stack is empty.
863 ;; Are we in a macro, just after the opening #?
878 ;; Stop at the first token in the content of the macro.
882 ret 'macro
883 ignore-labels t))
886 ;; Do a round through the automaton if we've just passed a
887 ;; statement boundary or passed a "while"-like token.
895 ;; The PDA state handling.
896 ;;
897 ;; Refer to the description of the PDA in the opening
898 ;; comments. In the following OR form, the first leaf
899 ;; attempts to handles one of the specific actions detailed
900 ;; (e.g., finding token "if" whilst in state `else-boundary').
901 ;; We drop through to the second leaf (which handles common
902 ;; state) if no specific handler is found in the first cond.
903 ;; If a parsing error is detected (e.g. an "else" with no
904 ;; preceding "if"), we throw to the enclosing catch.
905 ;;
906 ;; Note that the (eq state 'else) means
907 ;; "we've just passed an else", NOT "we're looking for an
908 ;; else".
925 ;; Since this can cause backtracking we do a
926 ;; little more careful analysis to avoid it:
927 ;; If there's a label in front of the while
928 ;; it can't be part of a do-while.
957 ;; This is state common. We get here when the previous
958 ;; cond statement found no particular state handler.
960 ;; If we have a boundary at the start
961 ;; position we push a frame to go to the
962 ;; previous statement.
971 ;; Is this a real while, or a do-while?
972 ;; The next `when' triggers unless we are SURE that
973 ;; the `while' is not the tail end of a `do-while'.
976 ;; The following kludge is to prevent
977 ;; infinite recursion when called from
978 ;; c-awk-after-if-for-while-condition-p,
979 ;; or the like.
983 ;; Since this can cause backtracking we do a
984 ;; little more careful analysis to avoid it: If
985 ;; the while isn't followed by a (possibly
986 ;; virtual) semicolon it can't be a do-while.
995 ;; We're either past a statement boundary or at the
996 ;; start of a statement, so throw away any label data
997 ;; for the previous one.
999 last-label-pos nil
1000 c-maybe-labelp nil))))
1002 ;; Step to the previous sexp, but not if we crossed a
1003 ;; boundary, since that doesn't consume an sexp.
1007 ;; HERE IS THE SINGLE PLACE INSIDE THE PDA LOOP WHERE WE MOVE
1008 ;; BACKWARDS THROUGH THE SOURCE.
1012 ;; The end position of the area to search for statement
1013 ;; barriers in this round.
1016 ;; Go back over exactly one logical sexp, taking proper
1017 ;; account of macros and escaped EOLs.
1021 ;; Give up if we hit an unbalanced block. Since the
1022 ;; stack won't be empty the code below will report a
1023 ;; suitable error.
1026 ;; Have we moved into a macro?
1029 ;; Have we crossed a statement boundary? If not,
1030 ;; keep going back until we find one or a "real" sexp.
1037 ;; Have we just gone back over an escaped NL? This
1038 ;; doesn't count as a sexp.
1041 ;; Have we crossed a statement boundary?
1044 ;; Are we at a macro beginning?
1046 c-opt-cpp-prefix
1052 ;; Just gone back over a brace block?
1058 ;; Just gone back over some paren block?
1062 before-sws-pos)))
1065 ;; Just gone back over an ordinary symbol of some sort?
1071 ptok tok
1072 tok boundary-pos
1074 ;; Like a C "continue". Analyze the next sexp.
1077 ;; ObjC method def?
1084 ;; Might we have a bitfield declaration, "<type> <id> : <size>"?
1087 ;; The : <size> and <id> fields?
1097 ;; The <type> field?
1105 bitfield-id-pos nil)))))
1107 ;; Handle labels.
1110 ;; `c-crosses-statement-barrier-p' has found a colon, so we
1111 ;; might be in a label now. Have we got a real label
1112 ;; (including a case label) or something like C++'s "public:"?
1113 ;; A case label might use an expression rather than a token.
1116 ;; Catch C++'s inheritance construct "class foo : bar".
1130 ; been found.
1132 ;; We're in a potential label and it's the first
1133 ;; time we've found something that isn't allowed in
1134 ;; one.
1137 ;; We've moved back by a sexp, so update the token positions.
1139 pptok ptok
1140 ptok tok
1146 ;; If the stack isn't empty there might be errors to report.
1155 ;; Need to investigate closer whether we've crossed
1156 ;; between a substatement and its containing statement.
1160 pptok)
1162 ptok)
1170 after-labels-pos
1177 last-label-pos
1178 pos))
1180 ;; We're in a label. Maybe we should step to the statement
1181 ;; after it.
1186 ;; Might have jumped over several labels. Go to the last one.
1189 ;; Have we got "case <expression>:"?
1199 ;; Skip over the unary operators that can start the statement.
1202 ;; protect AWK post-inc/decrement operators, etc.
1207 ret)))
1210 "Return non-nil if there is a non-comment non-macro punctuation character
1211 between FROM and TO. FROM must not be in a string or comment. The returned
1212 value is the position of the first such character."
1223 "Return non-nil if buffer positions FROM to TO cross one or more
1224 statement or declaration boundaries. The returned value is actually
1225 the position of the earliest boundary char. FROM must not be within
1226 a string or comment.
1228 The variable `c-maybe-labelp' is set to the position of the first `:' that
1229 might start a label (i.e. not part of `::' and not preceded by `?'). If a
1230 single `?' is found, then `c-maybe-labelp' is cleared.
1232 For AWK, a statement which is terminated by an EOL (not a \; or a }) is
1234 the line. If this virtual semicolon is _at_ from, the function recognizes it.
1236 Note that this function might do hidden buffer changes. See the
1237 comment at the start of cc-engine.el for more info."
1239 ;; If the current language has CPP macros, insert # into skip-chars.
1242 c-opt-cpp-symbol ; usually "#"
1244 c-stmt-delim-chars))
1247 lit-range vsemi-pos)
1254 skip-chars
1258 ;; Virtual semicolon?
1268 ;; In a string/comment?
1275 ;; Ignore scope operators.
1279 ;; A question mark. Can't be a label, so stop
1280 ;; looking for more : and ?.
1283 ;; At a CPP construct or a "#" or "##" operator?
1294 ;; In trailing space after an as yet undetected virtual semicolon?
1297 ; unterminated string/regexp.
1302 nil))))))
1305 "Return non-nil if the point is at the first token in a statement
1306 or somewhere in the syntactic whitespace before it.
1309 Any kind of declaration-like construct that occur outside function
1312 Note that this function might do hidden buffer changes. See the
1313 comment at the start of cc-engine.el for more info."
1317 c-maybe-labelp)
1328 "Return non-nil if the point is at the first token in an expression or
1329 statement, or somewhere in the syntactic whitespace before it.
1332 grammar sense: It's any sequence of expression tokens except commas,
1333 unless they are enclosed inside parentheses of some kind. Also, an
1334 expression never continues past an enclosing parenthesis, but it might
1335 contain parenthesis pairs of any sort except braces.
1337 Since expressions never cross statement boundaries, this function also
1338 recognizes statement beginnings, just like `c-at-statement-start-p'.
1340 Note that this function might do hidden buffer changes. See the
1341 comment at the start of cc-engine.el for more info."
1346 c-maybe-labelp)
1354 \f
1355 ;; A set of functions that covers various idiosyncrasies in
1356 ;; implementations of `forward-comment'.
1358 ;; Note: Some emacsen considers incorrectly that any line comment
1359 ;; ending with a backslash continues to the next line. I can't think
1360 ;; of any way to work around that in a reliable way without changing
1361 ;; the buffer, though. Suggestions welcome. ;) (No, temporarily
1362 ;; changing the syntax for backslash doesn't work since we must treat
1363 ;; escapes in string literals correctly.)
1366 "Move forward past whitespace and the closest following comment, if any.
1367 Return t if a comment was found, nil otherwise. In either case, the
1368 point is moved past the following whitespace. Line continuations,
1369 i.e. a backslashes followed by line breaks, are treated as whitespace.
1370 The line breaks that end line comments are considered to be the
1371 comment enders, so the point will be put on the beginning of the next
1372 line if it moved past a line comment.
1374 This function does not do any hidden buffer changes."
1382 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1383 ;; forwards at eob.
1384 nil
1386 ;; Emacs includes the ending newline in a b-style (c++)
1387 ;; comment, but XEmacs doesn't. We depend on the Emacs
1388 ;; behavior (which also is symmetric).
1392 t))))
1395 "Move forward past all following whitespace and comments.
1396 Line continuations, i.e. a backslashes followed by line breaks, are
1397 treated as whitespace.
1399 Note that this function might do hidden buffer changes. See the
1400 comment at the start of cc-engine.el for more info."
1403 ;; If forward-comment in at least XEmacs 21 is given a large
1404 ;; positive value, it'll loop all the way through if it hits
1405 ;; eob.
1407 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1408 ;; forwards at eob.
1413 t))))
1416 "Move backward past whitespace and the closest preceding comment, if any.
1417 Return t if a comment was found, nil otherwise. In either case, the
1418 point is moved past the preceding whitespace. Line continuations,
1419 i.e. a backslashes followed by line breaks, are treated as whitespace.
1420 The line breaks that end line comments are considered to be the
1421 comment enders, so the point cannot be at the end of the same line to
1422 move over a line comment.
1424 This function does not do any hidden buffer changes."
1427 ;; When we got newline terminated comments, forward-comment in all
1428 ;; supported emacsen so far will stop at eol of each line not
1429 ;; ending with a comment when moving backwards. This corrects for
1430 ;; that, and at the same time handles line continuations.
1438 ;; Some emacsen (e.g. Emacs 19.34) return t when moving
1439 ;; backwards at bob.
1440 nil
1442 ;; Leave point after the closest following newline if we've
1443 ;; backed up over any above, since forward-comment won't move
1444 ;; backward over a line comment if point is at the end of the
1445 ;; same line.
1450 ;; If forward-comment above succeeded and we're at eol
1451 ;; then the newline we moved over above didn't end a
1452 ;; line comment, so we give it another go.
1455 t))
1457 ;; Emacs <= 20 and XEmacs move back over the closer of a
1458 ;; block comment that lacks an opener.
1461 t)))))
1464 "Move backward past all preceding whitespace and comments.
1465 Line continuations, i.e. a backslashes followed by line breaks, are
1466 treated as whitespace. The line breaks that end line comments are
1467 considered to be the comment enders, so the point cannot be at the end
1468 of the same line to move over a line comment. Unlike
1469 c-backward-syntactic-ws, this function doesn't move back over
1470 preprocessor directives.
1472 Note that this function might do hidden buffer changes. See the
1473 comment at the start of cc-engine.el for more info."
1477 ;; `forward-comment' in some emacsen (e.g. XEmacs 21.4)
1478 ;; return t when moving backwards at bob.
1484 ;; Cope specifically with ^M^J here -
1485 ;; forward-comment sometimes gets stuck after ^Ms,
1486 ;; sometimes after ^M^J.
1490 t)
1494 t))))
1495 moved-comment)
1497 ;; Emacs <= 20 and XEmacs move back over the
1498 ;; closer of a block comment that lacks an opener.
1500 t)
1502 ;; XEmacs treats line continuations as whitespace but
1503 ;; only in the backward direction, which seems a bit
1504 ;; odd. Anyway, this is necessary for Emacs.
1509 t))))))
1511 \f
1512 ;; Tools for skipping over syntactic whitespace.
1514 ;; The following functions use text properties to cache searches over
1515 ;; large regions of syntactic whitespace. It works as follows:
1516 ;;
1517 ;; o If a syntactic whitespace region contains anything but simple
1518 ;; whitespace (i.e. space, tab and line breaks), the text property
1519 ;; `c-in-sws' is put over it. At places where we have stopped
1520 ;; within that region there's also a `c-is-sws' text property.
1521 ;; That since there typically are nested whitespace inside that
1522 ;; must be handled separately, e.g. whitespace inside a comment or
1523 ;; cpp directive. Thus, from one point with `c-is-sws' it's safe
1524 ;; to jump to another point with that property within the same
1525 ;; `c-in-sws' region. It can be likened to a ladder where
1526 ;; `c-in-sws' marks the bars and `c-is-sws' the rungs.
1527 ;;
1528 ;; o The `c-is-sws' property is put on the simple whitespace chars at
1529 ;; a "rung position" and also maybe on the first following char.
1530 ;; As many characters as can be conveniently found in this range
1531 ;; are marked, but no assumption can be made that the whole range
1532 ;; is marked (it could be clobbered by later changes, for
1533 ;; instance).
1534 ;;
1535 ;; Note that some part of the beginning of a sequence of simple
1536 ;; whitespace might be part of the end of a preceding line comment
1537 ;; or cpp directive and must not be considered part of the "rung".
1538 ;; Such whitespace is some amount of horizontal whitespace followed
1539 ;; by a newline. In the case of cpp directives it could also be
1540 ;; two newlines with horizontal whitespace between them.
1541 ;;
1542 ;; The reason to include the first following char is to cope with
1543 ;; "rung positions" that doesn't have any ordinary whitespace. If
1544 ;; `c-is-sws' is put on a token character it does not have
1545 ;; `c-in-sws' set simultaneously. That's the only case when that
1546 ;; can occur, and the reason for not extending the `c-in-sws'
1547 ;; region to cover it is that the `c-in-sws' region could then be
1548 ;; accidentally merged with a following one if the token is only
1549 ;; one character long.
1550 ;;
1551 ;; o On buffer changes the `c-in-sws' and `c-is-sws' properties are
1552 ;; removed in the changed region. If the change was inside
1553 ;; syntactic whitespace that means that the "ladder" is broken, but
1554 ;; a later call to `c-forward-sws' or `c-backward-sws' will use the
1555 ;; parts on either side and use an ordinary search only to "repair"
1556 ;; the gap.
1557 ;;
1558 ;; Special care needs to be taken if a region is removed: If there
1559 ;; are `c-in-sws' on both sides of it which do not connect inside
1560 ;; the region then they can't be joined. If e.g. a marked macro is
1561 ;; broken, syntactic whitespace inside the new text might be
1562 ;; marked. If those marks would become connected with the old
1563 ;; `c-in-sws' range around the macro then we could get a ladder
1564 ;; with one end outside the macro and the other at some whitespace
1565 ;; within it.
1566 ;;
1567 ;; The main motivation for this system is to increase the speed in
1568 ;; skipping over the large whitespace regions that can occur at the
1569 ;; top level in e.g. header files that contain a lot of comments and
1570 ;; cpp directives. For small comments inside code it's probably
1571 ;; slower than using `forward-comment' straightforwardly, but speed is
1572 ;; not a significant factor there anyway.
1574 ; (defface c-debug-is-sws-face
1575 ; '((t (:background "GreenYellow")))
1576 ; "Debug face to mark the `c-is-sws' property.")
1577 ; (defface c-debug-in-sws-face
1578 ; '((t (:underline t)))
1579 ; "Debug face to mark the `c-in-sws' property.")
1581 ; (defun c-debug-put-sws-faces ()
1582 ; ;; Put the sws debug faces on all the `c-is-sws' and `c-in-sws'
1583 ; ;; properties in the buffer.
1584 ; (interactive)
1585 ; (save-excursion
1586 ; (c-save-buffer-state (in-face)
1587 ; (goto-char (point-min))
1588 ; (setq in-face (if (get-text-property (point) 'c-is-sws)
1589 ; (point)))
1590 ; (while (progn
1591 ; (goto-char (next-single-property-change
1592 ; (point) 'c-is-sws nil (point-max)))
1593 ; (if in-face
1594 ; (progn
1595 ; (c-debug-add-face in-face (point) 'c-debug-is-sws-face)
1596 ; (setq in-face nil))
1597 ; (setq in-face (point)))
1598 ; (not (eobp))))
1599 ; (goto-char (point-min))
1600 ; (setq in-face (if (get-text-property (point) 'c-in-sws)
1601 ; (point)))
1602 ; (while (progn
1603 ; (goto-char (next-single-property-change
1604 ; (point) 'c-in-sws nil (point-max)))
1605 ; (if in-face
1606 ; (progn
1607 ; (c-debug-add-face in-face (point) 'c-debug-in-sws-face)
1608 ; (setq in-face nil))
1609 ; (setq in-face (point)))
1610 ; (not (eobp)))))))
1613 ;;`(message ,@args)
1614 )
1617 ;; This macro does a hidden buffer change.
1624 ;; This macro does a hidden buffer change.
1631 ;; This macro does a hidden buffer change.
1638 ;; This macro does a hidden buffer change.
1645 ;; This macro does a hidden buffer change.
1653 ;; Called from `after-change-functions'. Note that if
1654 ;; `c-forward-sws' or `c-backward-sws' are used outside
1655 ;; `c-save-buffer-state' or similar then this will remove the cache
1656 ;; properties right after they're added.
1657 ;;
1658 ;; This function does hidden buffer changes.
1661 ;; Adjust the end to remove the properties in any following simple
1662 ;; ws up to and including the next line break, if there is any
1663 ;; after the changed region. This is necessary e.g. when a rung
1664 ;; marked empty line is converted to a line comment by inserting
1665 ;; "//" before the line break. In that case the line break would
1666 ;; keep the rung mark which could make a later `c-backward-sws'
1667 ;; move into the line comment instead of over it.
1677 ;; Ensure that an `c-in-sws' range gets broken. Note that it isn't
1678 ;; safe to keep a range that was continuous before the change. E.g:
1679 ;;
1680 ;; #define foo
1681 ;; \
1682 ;; bar
1683 ;;
1684 ;; There can be a "ladder" between "#" and "b". Now, if the newline
1685 ;; after "foo" is removed then "bar" will become part of the cpp
1686 ;; directive instead of a syntactically relevant token. In that
1687 ;; case there's no longer syntactic ws from "#" to "b".
1694 ;; Used by `c-forward-syntactic-ws' to implement the unbounded search.
1695 ;;
1696 ;; This function might do hidden buffer changes.
1699 ;; unmarked part of the simple ws region.
1701 rung-is-marked next-rung-is-marked simple-ws-end
1702 ;; `safe-start' is set when it's safe to cache the start position.
1703 ;; It's not set if we've initially skipped over comments and line
1704 ;; continuations since we might have gone out through the end of a
1705 ;; macro then. This provision makes `c-forward-sws' not populate the
1706 ;; cache in the majority of cases, but otoh is `c-backward-sws' by far
1707 ;; more common.
1708 safe-start)
1710 ;; Skip simple ws and do a quick check on the following character to see
1711 ;; if it's anything that can't start syntactic ws, so we can bail out
1712 ;; early in the majority of cases when there just are a few ws chars.
1719 ;; Find the last rung position to avoid setting properties in all
1720 ;; the cases when the marked rung is complete.
1721 ;; (`next-single-property-change' is certain to move at least one
1722 ;; step forward.)
1725 ;; Got no marked rung here. Since the simple ws might have started
1726 ;; inside a line comment or cpp directive we must set `rung-pos' as
1727 ;; high as possible.
1737 ;; The following search is the main reason that `c-in-sws'
1738 ;; and `c-is-sws' aren't combined to one property.
1742 ;; If the `c-in-sws' region extended past the last
1743 ;; `c-is-sws' char we have to go back a bit.
1750 "c-forward-sws cached move %s -> %s (max %s)"
1757 ;; We'll loop here if there is simple ws after the last rung.
1758 ;; That means that there's been some change in it and it's
1759 ;; possible that we've stepped into another ladder, so extend
1760 ;; the previous one to join with it if there is one, and try to
1761 ;; use the cache again.
1763 "c-forward-sws extending rung with [%s..%s] (max %s)"
1766 ;; Remove any `c-in-sws' property from the last char of
1767 ;; the rung before we mark it with `c-is-sws', so that we
1768 ;; won't connect with the remains of a broken "ladder".
1774 last-put-in-sws-pos rung-pos)))
1781 ;; Skipped over comments. Don't cache at eob in case the buffer
1782 ;; is narrowed.
1793 ;; Skip a preprocessor directive.
1800 ;; Don't cache at eob in case the buffer is narrowed.
1803 ;; We've searched over a piece of non-white syntactic ws. See if this
1804 ;; can be cached.
1810 ;; Cache if we haven't skipped comments only, and if we started
1811 ;; either from a marked rung or from a completely uncached
1812 ;; position.
1817 ;; See if there's a marked rung in the encountered simple ws. If
1818 ;; so then we can cache, unless `safe-start' is nil. Even then
1819 ;; we need to do this to check if the cache can be used for the
1820 ;; next step.
1824 safe-start))
1828 "c-forward-sws caching [%s..%s] - [%s..%s] (max %s)"
1832 ;; Remove the properties for any nested ws that might be cached.
1833 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
1834 ;; anyway.
1842 last-put-in-sws-pos rung-pos))
1844 ;; Remove any `c-in-sws' property from the last char of
1845 ;; the rung before we mark it with `c-is-sws', so that we
1846 ;; won't connect with the remains of a broken "ladder".
1849 rung-end-pos))
1852 "c-forward-sws not caching [%s..%s] - [%s..%s] (max %s)"
1856 ;; Set `rung-pos' for the next rung. It's the same thing here as
1857 ;; initially, except that the rung position is set as early as
1858 ;; possible since we can't be in the ending ws of a line comment or
1859 ;; cpp directive now.
1866 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
1867 ;; another one after the point (which might occur when editing inside a
1868 ;; comment or macro).
1872 "c-forward-sws clearing at %s for cache separation"
1873 last-put-in-sws-pos)
1877 ;; If at eob we have to clear the last character before the end
1878 ;; instead since the buffer might be narrowed and there might
1879 ;; be a `c-in-sws' after (point-max). In this case it's
1880 ;; necessary to clear both properties.
1882 "c-forward-sws clearing thoroughly at %s for cache separation"
1885 last-put-in-sws-pos))))
1886 ))))
1889 ;; Used by `c-backward-syntactic-ws' to implement the unbounded search.
1890 ;;
1891 ;; This function might do hidden buffer changes.
1894 ;; part of the simple ws region.
1896 rung-is-marked simple-ws-beg cmt-skip-pos)
1898 ;; Skip simple horizontal ws and do a quick check on the preceding
1899 ;; character to see if it's anything that can't end syntactic ws, so we can
1900 ;; bail out early in the majority of cases when there just are a few ws
1901 ;; chars. Newlines are complicated in the backward direction, so we can't
1902 ;; skip over them.
1909 ;; Try to find a rung position in the simple ws preceding point, so that
1910 ;; we can get a cache hit even if the last bit of the simple ws has
1911 ;; changed recently.
1917 ;; `rung-pos' will be the earliest marked position, which means that
1918 ;; there might be later unmarked parts in the simple ws region.
1919 ;; It's not worth the effort to fix that; the last part of the
1920 ;; simple ws is also typically edited often, so it could be wasted.
1932 ;; The following search is the main reason that `c-in-sws'
1933 ;; and `c-is-sws' aren't combined to one property.
1937 ;; If the `c-in-sws' region extended past the first
1938 ;; `c-is-sws' char we have to go forward a bit.
1943 "c-backward-sws cached move %s <- %s (min %s)"
1955 t
1957 nil))
1959 ;; We'll loop here if there is simple ws before the first rung.
1960 ;; That means that there's been some change in it and it's
1961 ;; possible that we've stepped into another ladder, so extend
1962 ;; the previous one to join with it if there is one, and try to
1963 ;; use the cache again.
1965 "c-backward-sws extending rung with [%s..%s] (min %s)"
1968 ;; Remove any `c-in-sws' property from the last char of
1969 ;; the rung before we mark it with `c-is-sws', so that we
1970 ;; won't connect with the remains of a broken "ladder".
1973 rung-pos)
1977 last-put-in-sws-pos rung-pos))
1986 ;; Inside a cpp directive. See if it should be skipped over.
1989 ;; Move back over all line continuations in the region skipped
1990 ;; over by `c-backward-comments'. If we go past it then we
1991 ;; started inside the cpp directive.
2000 ;; Don't move past the cpp directive if we began inside
2001 ;; it. Note that the position at the end of the last line
2002 ;; of the macro is also considered to be within it.
2004 nil)
2006 ;; It's worthwhile to spend a little bit of effort on finding
2007 ;; the end of the macro, to get a good `simple-ws-beg'
2008 ;; position for the cache. Note that `c-backward-comments'
2009 ;; could have stepped over some comments before going into
2010 ;; the macro, and then `simple-ws-beg' must be kept on the
2011 ;; same side of those comments.
2018 ;; Might happen if comments after the macro were skipped
2019 ;; over.
2023 t)))
2028 simple-ws-beg)
2029 ;; Skipped over comments. Must put point at the end of
2030 ;; the simple ws at point since we might be after a line
2031 ;; comment or cpp directive that's been partially
2032 ;; narrowed out, and we can't risk marking the simple ws
2033 ;; at the end of it.
2035 t)))
2037 ;; We've searched over a piece of non-white syntactic ws. See if this
2038 ;; can be cached.
2043 ;; Cache if we started either from a marked rung or from a
2044 ;; completely uncached position.
2045 rung-is-marked
2048 ;; Cache if there's a marked rung in the encountered simple ws.
2056 "c-backward-sws caching [%s..%s] - [%s..%s] (min %s)"
2061 ;; Remove the properties for any nested ws that might be cached.
2062 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
2063 ;; anyway.
2068 ;; Remove any `c-in-sws' property from the last char of
2069 ;; the rung before we mark it with `c-is-sws', so that we
2070 ;; won't connect with the remains of a broken "ladder".
2073 rung-end-pos)
2076 last-put-in-sws-pos simple-ws-beg)
2077 rung-pos)
2082 "c-backward-sws not caching [%s..%s] - [%s..%s] (min %s)"
2088 ))
2090 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
2091 ;; another one before the point (which might occur when editing inside a
2092 ;; comment or macro).
2096 "c-backward-sws clearing at %s for cache separation"
2099 last-put-in-sws-pos))
2101 ;; If at bob and the buffer is narrowed, we have to clear the
2102 ;; character we're standing on instead since there might be a
2103 ;; `c-in-sws' before (point-min). In this case it's necessary
2104 ;; to clear both properties.
2106 "c-backward-sws clearing thoroughly at %s for cache separation"
2107 last-put-in-sws-pos)
2110 ))))
2112 \f
2113 ;; Other whitespace tools
2115 ;; Is the region (beg end) WS, and is there WS (or BOB/EOB) next to the
2116 ;; region? This is a "heuristic" function. .....
2117 ;;
2118 ;; The motivation for the second bit is to check whether removing this
2119 ;; region would coalesce two symbols.
2120 ;;
2121 ;; FIXME!!! This function doesn't check virtual semicolons in any way. Be
2122 ;; careful about using this function for, e.g. AWK. (2007/3/7)
2131 \f
2132 ;; A system for finding noteworthy parens before the point.
2135 ;; A maximum comfortable scanning distance, e.g. between
2136 ;; `c-state-cache-good-pos' and "HERE" (where we call c-parse-state). When
2137 ;; this distance is exceeded, we take "emergency measures", e.g. by clearing
2138 ;; the cache and starting again from point-min or a beginning of defun. This
2139 ;; value can be tuned for efficiency or set to a lower value for testing.
2143 ;; The state cache used by `c-parse-state' to cut down the amount of
2144 ;; searching. It's the result from some earlier `c-parse-state' call. See
2145 ;; `c-parse-state''s doc string for details of its structure.
2146 ;;
2147 ;; The use of the cached info is more effective if the next
2148 ;; `c-parse-state' call is on a line close by the one the cached state
2149 ;; was made at; the cache can actually slow down a little if the
2150 ;; cached state was made very far back in the buffer. The cache is
2151 ;; most effective if `c-parse-state' is used on each line while moving
2152 ;; forward.
2156 ;; This is a position where `c-state-cache' is known to be correct, or
2157 ;; nil (see below). It's a position inside one of the recorded unclosed
2158 ;; parens or the top level, but not further nested inside any literal or
2159 ;; subparen that is closed before the last recorded position.
2160 ;;
2161 ;; The exact position is chosen to try to be close to yet earlier than
2162 ;; the position where `c-state-cache' will be called next. Right now
2163 ;; the heuristic is to set it to the position after the last found
2164 ;; closing paren (of any type) before the line on which
2165 ;; `c-parse-state' was called. That is chosen primarily to work well
2166 ;; with refontification of the current line.
2167 ;;
2168 ;; 2009-07-28: When `c-state-point-min' and the last position where
2169 ;; `c-parse-state' or for which `c-invalidate-state-cache' was called, are
2170 ;; both in the same literal, there is no such "good position", and
2171 ;; c-state-cache-good-pos is then nil. This is the ONLY circumstance in which
2172 ;; it can be nil. In this case, `c-state-point-min-literal' will be non-nil.
2173 ;;
2174 ;; 2009-06-12: In a brace desert, c-state-cache-good-pos may also be in
2175 ;; the middle of the desert, as long as it is not within a brace pair
2176 ;; recorded in `c-state-cache' or a paren/bracket pair.
2179 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2180 ;; We maintain a simple cache of positions which aren't in a literal, so as to
2181 ;; speed up testing for non-literality.
2183 ;; The approximate interval between entries in `c-state-nonlit-pos-cache'.
2187 ;; A list of buffer positions which are known not to be in a literal or a cpp
2188 ;; construct. This is ordered with higher positions at the front of the list.
2189 ;; Only those which are less than `c-state-nonlit-pos-cache-limit' are valid.
2193 ;; An upper limit on valid entries in `c-state-nonlit-pos-cache'. This is
2194 ;; reduced by buffer changes, and increased by invocations of
2195 ;; `c-state-literal-at'.
2199 ;; A list of buffer positions which are known not to be in a literal. This is
2200 ;; ordered with higher positions at the front of the list. Only those which
2201 ;; are less than `c-state-semi-nonlit-pos-cache-limit' are valid.
2205 ;; An upper limit on valid entries in `c-state-semi-nonlit-pos-cache'. This is
2206 ;; reduced by buffer changes, and increased by invocations of
2207 ;; `c-state-literal-at'. FIXME!!!
2210 ;; Do a parse-partial-sexp from FROM to TO, returning either
2211 ;; (STATE TYPE (BEG . END)) if TO is in a literal; or
2212 ;; (STATE) otherwise,
2213 ;; where STATE is the parsing state at TO, TYPE is the type of the literal
2214 ;; (one of 'c, 'c++, 'string) and (BEG . END) is the boundaries of the literal.
2215 ;;
2216 ;; Unless NOT-IN-DELIMITER is non-nil, when TO is inside a two-character
2217 ;; comment opener, this is recognized as being in a comment literal.
2218 ;;
2219 ;; Only elements 3 (in a string), 4 (in a comment), 5 (following a quote),
2220 ;; 7 (comment type) and 8 (start of comment/string) (and possibly 9) of
2221 ;; STATE are valid.
2224 ty co-st)
2232 nil ; TARGETDEPTH
2233 nil ; STOPBEFORE
2234 s ; OLDSTATE
2251 ;; Return a buffer position before HERE which is "safe", i.e. outside any
2252 ;; string, comment, or macro.
2253 ;;
2254 ;; NOTE: This function manipulates `c-state-nonlit-pos-cache'. This cache
2255 ;; MAY NOT contain any positions within macros, since macros are frequently
2256 ;; turned into comments by use of the `c-cpp-delimiter' category properties.
2257 ;; We cannot rely on this mechanism whilst determining a cache pos since
2258 ;; this function is also called from outwith `c-parse-state'.
2263 pos npos high-pos lit macro-beg macro-end)
2264 ;; Trim the cache to take account of buffer changes.
2276 ;; Add an element to `c-state-nonlit-pos-cache' each iteration.
2282 ;; Test for being in a literal. If so, go to after it.
2289 ;; Test for being in a macro. If so, go to after it.
2304 ;; Add one extra element above HERE so as to to avoid the previous
2305 ;; expensive calculation when the next call is close to the current
2306 ;; one. This is especially useful when inside a large macro.
2313 pos))))
2316 ;; Return a buffer position before HERE which is "safe", i.e. outside any
2317 ;; string or comment. It may be in a macro.
2322 pos npos high-pos lit macro-beg macro-end)
2323 ;; Trim the cache to take account of buffer changes.
2335 ;; Add an element to `c-state-semi-nonlit-pos-cache' each iteration.
2339 ;; Test for being in a literal. If so, go to after it.
2352 pos))))
2355 ;; If position HERE is inside a literal, return (START . END), the
2356 ;; boundaries of the literal (which may be outside the accessible bit of the
2357 ;; buffer). Otherwise, return nil.
2358 ;;
2359 ;; This function is almost the same as `c-literal-limits'. Previously, it
2360 ;; differed in that it was a lower level function, and that it rigorously
2361 ;; followed the syntax from BOB. `c-literal-limits' is now (2011-12)
2362 ;; virtually identical to this function.
2370 ;; Return the start of the literal containing POS, or POS itself.
2372 pos))
2375 ;; Return a position outside of a string/comment/macro at or before POS.
2376 ;; STATE is the parse-partial-sexp state at POS.
2380 pos)))
2385 res))))
2387 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2388 ;; Stuff to do with point-min, and coping with any literal there.
2391 ;; This is (point-min) when `c-state-cache' was last calculated. A change of
2392 ;; narrowing is likely to affect the parens that are visible before the point.
2398 ;; These two variables define the literal, if any, containing point-min.
2399 ;; Their values are, respectively, 'string, c, or c++, and the start of the
2400 ;; literal. If there's no literal there, they're both nil.
2404 ;; This is the earliest buffer-pos from which scanning can be done. It is
2405 ;; either the end of the literal containing point-min, or point-min itself.
2406 ;; It becomes nil if the buffer is changed earlier than this point.
2408 ;; Return the lowest valid scanning pos. This will be the end of the
2409 ;; literal enclosing point-min, or point-min itself.
2421 ;; Determine the properties of any literal containing POINT-MIN, setting the
2422 ;; variables `c-state-point-min-lit-type', `c-state-point-min-lit-start',
2423 ;; and `c-state-min-scan-pos' accordingly. The return value is meaningless.
2425 lit)
2440 c-state-point-min-lit-start nil
2441 c-state-min-scan-pos p-min)))))
2444 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2445 ;; A variable which signals a brace dessert - helpful for reducing the number
2446 ;; of fruitless backward scans.
2449 ;; Used only in `c-append-lower-brace-pair-to-state-cache'. It is set when
2450 ;; that defun has searched backwards for a brace pair and not found one. Its
2451 ;; value is either nil or a cons (PA . FROM), where PA is the position of the
2452 ;; enclosing opening paren/brace/bracket which bounds the backwards search (or
2453 ;; nil when at top level) and FROM is where the backward search started. It
2454 ;; is reset to nil in `c-invalidate-state-cache'.
2457 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2458 ;; Lowish level functions/macros which work directly on `c-state-cache', or a
2459 ;; list of like structure.
2461 ;; Return the address of the top left brace/bracket/paren recorded in CACHE
2462 ;; (default `c-state-cache') (or nil).
2469 ;; Return the address of the latest brace/bracket/paren (whether left or
2470 ;; right) recorded in CACHE (default `c-state-cache') or nil.
2477 ;; Return the position just after the latest brace/bracket/paren (whether
2478 ;; left or right) recorded in CACHE (default `c-state-cache') or nil.
2486 ;; From the state-cache, determine the buffer position from which we might
2487 ;; scan forward to HERE to update this cache. This position will be just
2488 ;; after a paren/brace/bracket recorded in the cache, if possible, otherwise
2489 ;; return the earliest position in the accessible region which isn't within
2490 ;; a literal. If the visible portion of the buffer is entirely within a
2491 ;; literal, return NIL.
2493 ;(while (>= (or (c-state-cache-top-lparen c) 1) here)
2509 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2510 ;; Variables which keep track of preprocessor constructs.
2519 ;; These are the limits of the macro containing point at the previous call of
2520 ;; `c-parse-state', or nil.
2522 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2523 ;; Defuns which analyze the buffer, yet don't change `c-state-cache'.
2525 ;; Return the position of the opening paren/brace/bracket before HERE- which
2526 ;; matches the outermost close p/b/b between HERE+ and TOP. Except when
2527 ;; there's a macro, HERE- and HERE+ are the same. Like this:
2528 ;;
2529 ;; ............................................
2530 ;; | |
2531 ;; ( [ ( .........#macro.. ) ( ) ] )
2532 ;; ^ ^ ^ ^
2533 ;; | | | |
2534 ;; return HERE- HERE+ TOP
2535 ;;
2536 ;; If there aren't enough opening paren/brace/brackets, return the position
2537 ;; of the outermost one found, or HERE- if there are none. If there are no
2538 ;; closing p/b/bs between HERE+ and TOP, return HERE-. HERE-/+ and TOP
2539 ;; must not be inside literals. Only the accessible portion of the buffer
2540 ;; will be scanned.
2542 ;; PART 1: scan from `here+' up to `top', accumulating ")"s which enclose
2543 ;; `here'. Go round the next loop each time we pass over such a ")". These
2544 ;; probably match "("s before `here-'.
2556 ;; PART 2: Scan back before `here-' searching for the "("s
2557 ;; matching/mismatching the ")"s found above. We only need to direct the
2558 ;; caller to scan when we've encountered unmatched right parens.
2567 pos))
2570 ;; Determine the scanning strategy for adjusting `c-parse-state', attempting
2571 ;; to minimize the amount of scanning. HERE is the pertinent position in
2572 ;; the buffer, GOOD-POS is a position where `c-state-cache' (possibly with
2573 ;; its head trimmed) is known to be good, or nil if there is no such
2574 ;; position.
2575 ;;
2576 ;; The return value is a list, one of the following:
2577 ;;
2578 ;; o - ('forward START-POINT) - scan forward from START-POINT,
2579 ;; which is not less than the highest position in `c-state-cache' below HERE,
2580 ;; which is after GOOD-POS.
2581 ;; o - ('backward nil) - scan backwards (from HERE).
2582 ;; o - ('back-and-forward START-POINT) - like 'forward, but when HERE is earlier
2583 ;; than GOOD-POS.
2584 ;; o - ('IN-LIT nil) - point is inside the literal containing point-min.
2586 strategy ; 'forward, 'backward, or 'IN-LIT.
2587 start-point)
2599 start-point cache-pos)))
2603 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2604 ;; Routines which change `c-state-cache' and associated values.
2606 ;; The region (more precisely, point-min) has changed since we
2607 ;; calculated `c-state-cache'. Amend `c-state-cache' accordingly.
2609 ;; If point-min has MOVED BACKWARDS then we drop the state completely.
2610 ;; It would be possible to do a better job here and recalculate the top
2611 ;; only.
2615 c-state-cache-good-pos c-state-min-scan-pos
2616 c-state-brace-pair-desert nil))
2618 ;; point-min has MOVED FORWARD.
2620 ;; Is the new point-min inside a (different) literal?
2625 ;; Cut off a bit of the tail from `c-state-cache'.
2627 pa)
2635 c-state-cache-good-pos c-state-min-scan-pos)
2638 )))
2643 ;; If there is a brace pair preceding FROM in the buffer, at the same level
2644 ;; of nesting (not necessarily immediately preceding), push a cons onto
2645 ;; `c-state-cache' to represent it. FROM must not be inside a literal. If
2646 ;; UPPER-LIM is non-nil, we append the highest brace pair whose "}" is below
2647 ;; UPPER-LIM.
2648 ;;
2649 ;; Return non-nil when this has been done.
2650 ;;
2651 ;; The situation it copes with is this transformation:
2652 ;;
2653 ;; OLD: { (.) {...........}
2654 ;; ^ ^
2655 ;; FROM HERE
2656 ;;
2657 ;; NEW: { {....} (.) {.........
2658 ;; ^ ^ ^
2659 ;; LOWER BRACE PAIR HERE or HERE
2660 ;;
2661 ;; This routine should be fast. Since it can get called a LOT, we maintain
2662 ;; `c-state-brace-pair-desert', a small cache of "failures", such that we
2663 ;; reduce the time wasted in repeated fruitless searches in brace deserts.
2673 ;; Don't start scanning in the middle of a CPP construct unless
2674 ;; it contains HERE - these constructs, in Emacs, are "commented
2675 ;; out" with category properties.
2678 macro-start-or-from
2679 from))
2683 ;; If we're essentially repeating a fruitless search, just give up.
2689 ;; DESERT-LIM. Avoid repeated searching through the cached desert.
2695 ;; CACHE-LIM. This limit will be necessary when an opening
2696 ;; paren at `cache-pos' has just had its matching close paren
2697 ;; inserted into the buffer. `cache-pos' continues to be a
2698 ;; search bound, even though the algorithm below would skip
2699 ;; over the new paren pair.
2708 ;; The top limit is EOB to ensure that `bra' is inside the
2709 ;; accessible part of the buffer at the next scan operation.
2712 ;; In the next pair of nested loops, the inner one moves back past a
2713 ;; pair of (mis-)matching parens or brackets; the outer one moves
2714 ;; back over a sequence of unmatched close brace/paren/bracket each
2715 ;; time round.
2731 ; brace, ignore it.
2734 ;; We've found the desired brace-pair.
2746 ;; We haven't found a brace pair. Record this in the cache.
2749 bra
2754 ;; If BRA+1 is nil, do nothing. Otherwise, BRA+1 is the buffer position
2755 ;; following a {, and that brace has a (mis-)matching } (or ]), and we
2756 ;; "push" "a" brace pair onto `c-state-cache'.
2757 ;;
2758 ;; Here "push" means overwrite the top element if it's itself a brace-pair,
2759 ;; otherwise push it normally.
2760 ;;
2761 ;; The brace pair we push is normally the one surrounding BRA+1, but if the
2762 ;; latter is inside a macro, not being a macro containing
2763 ;; MACRO-START-OR-HERE, we scan backwards through the buffer for a non-macro
2764 ;; base pair. This latter case is assumed to be rare.
2765 ;;
2766 ;; Note: POINT is not preserved in this routine.
2776 c-state-cache)))
2777 ;; N.B. This defsubst codes one method for the simple, normal case,
2778 ;; and a more sophisticated, slower way for the general case. Don't
2779 ;; eliminate this defsubst - it's a speed optimization.
2783 ;; Scan the buffer from FROM to HERE, adding elements into `c-state-cache'
2784 ;; for braces etc. Return a candidate for `c-state-cache-good-pos'.
2785 ;;
2786 ;; FROM must be after the latest brace/paren/bracket in `c-state-cache', if
2787 ;; any. Typically, it is immediately after it. It must not be inside a
2788 ;; literal.
2794 here)))
2797 ; Is actually the pos. to scan for a (/{/[ from,
2798 ; which sometimes is after a silly )/}/].
2801 ; good-pos.
2809 ;; Each time round the following loop, we enter a successively deeper
2810 ;; level of brace/paren nesting. (Except sometimes we "continue at
2811 ;; the existing level".) `pa+1' is a pos inside an opening
2812 ;; brace/paren/bracket, usually just after it.
2815 ;; Each time round the next loop moves forward over an opening then
2816 ;; a closing brace/bracket/paren. This loop is white hot, so it
2817 ;; plays ugly tricks to go fast. DON'T PUT ANYTHING INTO THIS
2818 ;; LOOP WHICH ISN'T ABSOLUTELY NECESSARY!!! It terminates when a
2819 ;; call of `scan-lists' signals an error, which happens when there
2820 ;; are no more b/b/p's to scan.
2831 ;; We've just entered a deeper nesting level.
2833 ;; Insert the brace pair (if present) and the single open
2834 ;; paren/brace/bracket into `c-state-cache' It cannot be
2835 ;; inside a macro, except one around point, because of what
2836 ;; `c-neutralize-syntax-in-CPP' has done.
2838 ;; Insert the opening brace/bracket/paren position.
2840 ;; Clear admin stuff for the next more nested part of the scan.
2844 ;; All open p/b/b's at this nesting level, if any, have probably
2845 ;; been closed by matching/mismatching ones. We're probably
2846 ;; finished - we just need to check for having found an
2847 ;; unmatched )/}/], which we ignore. Such a )/}/] can't be in a
2848 ;; macro, due the action of `c-neutralize-syntax-in-CPP'.
2851 ;; Record the final, innermost, brace-pair if there is one.
2854 ;; Determine a good pos
2862 here-bol))
2871 ;; Remove stale entries from the `c-cache-state', i.e. those which will
2872 ;; not be in it when it is amended for position HERE. This may involve
2873 ;; replacing a CONS element for a brace pair containing HERE with its car.
2874 ;; Additionally, the "outermost" open-brace entry before HERE will be
2875 ;; converted to a cons if the matching close-brace is below HERE.
2876 ;;
2877 ;; START-POINT is a "maximal" "safe position" - there must be no open
2878 ;; parens/braces/brackets between START-POINT and HERE.
2879 ;;
2880 ;; As a second thing, calculate the result of parse-partial-sexp at
2881 ;; PPS-POINT, w.r.t. START-POINT. The motivation here is that
2882 ;; `c-state-cache-good-pos' may become PPS-POINT, but the caller may need to
2883 ;; adjust it to get outside a string/comment. (Sorry about this! The code
2884 ;; needs to be FAST).
2885 ;;
2886 ;; Return a list (GOOD-POS SCAN-BACK-POS CONS-SEPARATED PPS-STATE), where
2887 ;; o - GOOD-POS is a position where the new value `c-state-cache' is known
2888 ;; to be good (we aim for this to be as high as possible);
2889 ;; o - SCAN-BACK-POS, if not nil, indicates there may be a brace pair
2890 ;; preceding POS which needs to be recorded in `c-state-cache'. It is a
2891 ;; position to scan backwards from. It is the position of the "{" of the
2892 ;; last element to be removed from `c-state-cache', when that elt is a
2893 ;; cons, otherwise nil.
2894 ;; o - CONS-SEPARATED is t when a cons element in `c-state-cache' has been
2895 ;; replaced by its car because HERE lies inside the brace pair represented
2896 ;; by the cons.
2897 ;; o - PPS-STATE is the parse-partial-sexp state at PPS-POINT.
2907 ; start-point or nil
2914 ; HERE), or nil.
2920 pps-state ; Will be 9 or 10 elements long.
2921 pos
2922 upper-lim ; ,beyond which `c-state-cache' entries are removed
2923 scan-back-pos
2924 cons-separated
2925 pair-beg pps-point-state target-depth)
2927 ;; Remove entries beyond HERE. Also remove any entries inside
2928 ;; a macro, unless HERE is in the same macro.
2933 here
2939 ;; If `upper-lim' is inside the last recorded brace pair, remove its
2940 ;; RBrace and indicate we'll need to search backwards for a previous
2941 ;; brace pair.
2947 cons-separated t))
2949 ;; The next loop jumps forward out of a nested level of parens each
2950 ;; time round; the corresponding elements in `c-state-cache' are
2951 ;; removed. `pos' is just after the brace-pair or the open paren at
2952 ;; (car c-state-cache). There can be no open parens/braces/brackets
2953 ;; between `start-point'/`start-point-actual-macro-start' and HERE,
2954 ;; due to the interface spec to this function.
2957 in-macro-start)))
2959 ; marked by a `category' text property.
2960 start-point))
2971 ;; Do nothing when we've merely reached pps-point.
2972 )
2974 ;; Scan!
2978 target-depth
2979 nil pps-state))
2989 ;; We've just moved out of the paren pair containing the brace-pair
2990 ;; at (car c-state-cache). `pair-beg' is where the open paren is,
2991 ;; and is potentially where the open brace of a cons in
2992 ;; c-state-cache will be.
2998 ; containing Lparen
3002 ; together with enclosed brace pair.
3003 ;; (t nil) ; Ignore an unmated Rparen.
3004 )))
3008 nil nil ; TARGETDEPTH, STOPBEFORE
3009 pps-state)))
3011 ;; If the last paren pair we moved out of was actually a brace pair,
3012 ;; insert it into `c-state-cache'.
3017 c-state-cache)))
3022 ;; Strip stale elements of `c-state-cache' by moving backwards through the
3023 ;; buffer, and inform the caller of the scenario detected.
3024 ;;
3025 ;; HERE is the position we're setting `c-state-cache' for.
3026 ;; CACHE-POS (a locally bound variable) is just after the latest recorded
3027 ;; position in `c-state-cache' before HERE, or a position at or near
3028 ;; point-min which isn't in a literal.
3029 ;;
3030 ;; This function must only be called only when (> `c-state-cache-good-pos'
3031 ;; HERE). Usually the gap between CACHE-POS and HERE is large. It is thus
3032 ;; optimized to eliminate (or minimize) scanning between these two
3033 ;; positions.
3034 ;;
3035 ;; Return a three element list (GOOD-POS SCAN-BACK-POS FWD-FLAG), where:
3036 ;; o - GOOD-POS is a "good position", where `c-state-cache' is valid, or
3037 ;; could become so after missing elements are inserted into
3038 ;; `c-state-cache'. This is JUST AFTER an opening or closing
3039 ;; brace/paren/bracket which is already in `c-state-cache' or just before
3040 ;; one otherwise. exceptionally (when there's no such b/p/b handy) the BOL
3041 ;; before `here''s line, or the start of the literal containing it.
3042 ;; o - SCAN-BACK-POS, if non-nil, indicates there may be a brace pair
3043 ;; preceding POS which isn't recorded in `c-state-cache'. It is a position
3044 ;; to scan backwards from.
3045 ;; o - FWD-FLAG, if non-nil, indicates there may be parens/braces between
3046 ;; POS and HERE which aren't recorded in `c-state-cache'.
3047 ;;
3048 ;; The comments in this defun use "paren" to mean parenthesis or square
3049 ;; bracket (as contrasted with a brace), and "(" and ")" likewise.
3050 ;;
3051 ;; . {..} (..) (..) ( .. { } ) (...) ( .... . ..)
3052 ;; | | | | | |
3053 ;; CP E here D C good
3056 pa ren ; positions of "(" and ")"
3057 dropped-cons ; whether the last element dropped from `c-state-cache'
3058 ; was a cons (representing a brace-pair)
3059 good-pos ; see above.
3060 lit ; (START . END) of a literal containing some point.
3061 here-lit-start here-lit-end ; bounds of literal containing `here'
3062 ; or `here' itself.
3067 ;; Remove completely irrelevant entries from `c-state-cache'.
3073 ;; At this stage, (>= pos here);
3074 ;; (< (c-state-cache-top-lparen) here) (or is nil).
3079 ;; CASE 1: The top of the cache is a brace pair which now encloses
3080 ;; `here'. As good-pos, return the address. of the "{". Since we've no
3081 ;; knowledge of what's inside these braces, we have no alternative but
3082 ;; to direct the caller to scan the buffer from the opening brace.
3086 ; entry into a { entry, so the caller needs to
3087 ; search for a brace pair before the {.
3089 ;; `here' might be inside a literal. Check for this.
3094 ;; Has `here' just "newly entered" a macro?
3107 ;; `here' might be nested inside any depth of parens (or brackets but
3108 ;; not braces). Scan backwards to find the outermost such opening
3109 ;; paren, if there is one. This will be the scan position to return.
3116 ;; CASE 2: Address of outermost ( or [ which now encloses `here', but
3117 ;; didn't enclose the (previous) `c-state-cache-good-pos'. If there is
3118 ;; a brace pair preceding this, it will already be in `c-state-cache',
3119 ;; unless there was a brace pair after it, i.e. there'll only be one to
3120 ;; scan for if we've just deleted one.
3123 ;; `here' isn't enclosed in a (previously unrecorded) bracket/paren.
3124 ;; Further forward scanning isn't needed, but we still need to find a
3125 ;; GOOD-POS. Step out of all enclosing "("s on HERE's line.
3135 ;; CASE 3: After a }/)/] before `here''s BOL.
3139 ;; CASE 4; Best of a bad job: BOL before `here-bol', or beginning of
3140 ;; literal containing it.
3145 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3146 ;; Externally visible routines.
3150 c-state-cache-good-pos 1
3151 c-state-nonlit-pos-cache nil
3152 c-state-nonlit-pos-cache-limit 1
3153 c-state-semi-nonlit-pos-cache nil
3154 c-state-semi-nonlit-pos-cache-limit 1
3155 c-state-brace-pair-desert nil
3156 c-state-point-min 1
3157 c-state-point-min-lit-type nil
3158 c-state-point-min-lit-start nil
3159 c-state-min-scan-pos 1
3160 c-state-old-cpp-beg nil
3161 c-state-old-cpp-end nil)
3164 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3165 ;; Debugging routines to dump `c-state-cache' in a "replayable" form.
3166 ;; (defmacro c-sc-de (elt) ; "c-state-cache-dump-element"
3167 ;; `(format ,(concat "(setq " (symbol-name elt) " %s) ") ,elt))
3168 ;; (defmacro c-sc-qde (elt) ; "c-state-cache-quote-dump-element"
3169 ;; `(format ,(concat "(setq " (symbol-name elt) " '%s) ") ,elt))
3170 ;; (defun c-state-dump ()
3171 ;; ;; For debugging.
3172 ;; ;(message
3173 ;; (concat
3174 ;; (c-sc-qde c-state-cache)
3175 ;; (c-sc-de c-state-cache-good-pos)
3176 ;; (c-sc-qde c-state-nonlit-pos-cache)
3177 ;; (c-sc-de c-state-nonlit-pos-cache-limit)
3178 ;; (c-sc-qde c-state-brace-pair-desert)
3179 ;; (c-sc-de c-state-point-min)
3180 ;; (c-sc-de c-state-point-min-lit-type)
3181 ;; (c-sc-de c-state-point-min-lit-start)
3182 ;; (c-sc-de c-state-min-scan-pos)
3183 ;; (c-sc-de c-state-old-cpp-beg)
3184 ;; (c-sc-de c-state-old-cpp-end)))
3185 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3188 ;; Invalidate all info on `c-state-cache' that applies to the buffer at HERE
3189 ;; or higher and set `c-state-cache-good-pos' accordingly. The cache is
3190 ;; left in a consistent state.
3191 ;;
3192 ;; This is much like `c-whack-state-after', but it never changes a paren
3193 ;; pair element into an open paren element. Doing that would mean that the
3194 ;; new open paren wouldn't have the required preceding paren pair element.
3195 ;;
3196 ;; This function is called from c-after-change.
3198 ;; The caches of non-literals:
3199 ;; Note that we use "<=" for the possibility of the second char of a two-char
3200 ;; comment opener being typed; this would invalidate any cache position at
3201 ;; HERE.
3207 ;; `c-state-cache':
3208 ;; Case 1: if `here' is in a literal containing point-min, everything
3209 ;; becomes (or is already) nil.
3213 c-state-cache-good-pos nil
3214 c-state-min-scan-pos nil)
3216 ;; Truncate `c-state-cache' and set `c-state-cache-good-pos' to a value
3217 ;; below `here'. To maintain its consistency, we may need to insert a new
3218 ;; brace pair.
3221 too-high-pa ; recorded {/(/[ next above here, or nil.
3222 dropped-cons ; was the last removed element a brace pair?
3223 pa)
3224 ;; The easy bit - knock over-the-top bits off `c-state-cache'.
3231 ;; Do we need to add in an earlier brace pair, having lopped one off?
3238 ;; The brace-pair desert marker:
3246 ;; Find and record all noteworthy parens between some good point earlier in
3247 ;; the file and point. That good point is at least the beginning of the
3248 ;; top-level construct we are in, or the beginning of the preceding
3249 ;; top-level construct if we aren't in one.
3250 ;;
3251 ;; The returned value is a list of the noteworthy parens with the last one
3252 ;; first. If an element in the list is an integer, it's the position of an
3253 ;; open paren (of any type) which has not been closed before the point. If
3254 ;; an element is a cons, it gives the position of a closed BRACE paren
3255 ;; pair[*]; the car is the start brace position and the cdr is the position
3256 ;; following the closing brace. Only the last closed brace paren pair
3257 ;; before each open paren and before the point is recorded, and thus the
3258 ;; state never contains two cons elements in succession. When a close brace
3259 ;; has no matching open brace (e.g., the matching brace is outside the
3260 ;; visible region), it is not represented in the returned value.
3261 ;;
3262 ;; [*] N.B. The close "brace" might be a mismatching close bracket or paren.
3263 ;; This defun explicitly treats mismatching parens/braces/brackets as
3264 ;; matching. It is the open brace which makes it a "brace" pair.
3265 ;;
3266 ;; If POINT is within a macro, open parens and brace pairs within
3267 ;; THIS macro MIGHT be recorded. This depends on whether their
3268 ;; syntactic properties have been suppressed by
3269 ;; `c-neutralize-syntax-in-CPP'. This might need fixing (2008-12-11).
3270 ;;
3271 ;; Currently no characters which are given paren syntax with the
3272 ;; syntax-table property are recorded, i.e. angle bracket arglist
3273 ;; parens are never present here. Note that this might change.
3274 ;;
3275 ;; BUG: This function doesn't cope entirely well with unbalanced
3276 ;; parens in macros. (2008-12-11: this has probably been resolved
3277 ;; by the function `c-neutralize-syntax-in-CPP'.) E.g. in the
3278 ;; following case the brace before the macro isn't balanced with the
3279 ;; one after it:
3280 ;;
3281 ;; {
3282 ;; #define X {
3283 ;; }
3284 ;;
3285 ;; Note to maintainers: this function DOES get called with point
3286 ;; within comments and strings, so don't assume it doesn't!
3287 ;;
3288 ;; This function might do hidden buffer changes.
3291 open-paren-in-column-0-is-defun-start
3292 strategy ; 'forward, 'backward etc..
3293 ;; Candidate positions to start scanning from:
3294 cache-pos ; highest position below HERE already existing in
3295 ; cache (or 1).
3296 good-pos
3297 start-point ; (when scanning forward) a place below HERE where there
3298 ; are no open parens/braces between it and HERE.
3299 bopl-state
3300 res
3301 cons-separated
3303 ;; If POINT-MIN has changed, adjust the cache
3307 ;; Strategy?
3312 ;; SCAN!
3320 ; start-point)
3330 good-pos)))
3342 good-pos)))
3346 c-state-cache-good-pos nil))))
3348 c-state-cache)
3351 ;; This is a wrapper over `c-invalidate-state-cache-1'.
3352 ;;
3353 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3354 ;; of all parens in preprocessor constructs, except for any such construct
3355 ;; containing point. We can then call `c-invalidate-state-cache-1' without
3356 ;; worrying further about macros and template delimiters.
3361 c-state-old-cpp-beg
3368 ;; If PLACE is non-nil, return a marker marking it, otherwise nil.
3369 ;; We (re)use MARKER.
3375 ;; This is a wrapper over `c-parse-state-1'. See that function for a
3376 ;; description of the functionality and return value.
3377 ;;
3378 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3379 ;; of all parens in preprocessor constructs, except for any such construct
3380 ;; containing point. We can then call `c-parse-state-1' without worrying
3381 ;; further about macros and template delimiters.
3388 here-cpp-beg)
3390 ;; FIXME!!! Put in a `condition-case' here to protect the integrity of the
3391 ;; subsystem.
3396 here-cpp-beg here-cpp-end
3402 c-state-old-cpp-end
3405 ;; Debug tool to catch cache inconsistencies. This is called from
3406 ;; 000tests.el.
3423 val))))
3425 c-state-cache-good-pos
3426 c-state-nonlit-pos-cache
3427 c-state-nonlit-pos-cache-limit
3428 c-state-semi-nonlit-pos-cache
3429 c-state-semi-nonlit-pos-cache-limit
3430 c-state-brace-pair-desert
3431 c-state-point-min
3432 c-state-point-min-lit-type
3433 c-state-point-min-lit-start
3434 c-state-min-scan-pos
3435 c-state-old-cpp-beg
3436 c-state-old-cpp-end
3437 c-parse-state-point))))
3455 conses-not-ok))
3472 ;; The cache can actually go further back due to the ad-hoc way
3473 ;; the first paren is found, so try to whack off a bit of its
3474 ;; start before complaining.
3475 ;; (save-excursion
3476 ;; (goto-char (or (c-least-enclosing-brace res2) (point)))
3477 ;; (c-beginning-of-defun-1)
3478 ;; (while (not (or (bobp) (eq (char-after) ?{)))
3479 ;; (c-beginning-of-defun-1))
3480 ;; (unless (equal (c-whack-state-before (point) res1) res2)
3481 ;; (message (concat "c-parse-state inconsistency at %s: "
3482 ;; "using cache: %s, from scratch: %s")
3483 ;; here res1 res2)))
3486 here res1 res2)
3492 here res1)
3497 res2 ; res1 correct a cascading series of errors ASAP
3498 ))
3504 'c-debug-parse-state
3512 \f
3514 ;; Whack off any state information from PAREN-STATE which lies
3515 ;; before BUFPOS. Not destructive on PAREN-STATE.
3518 car)
3529 ;; Whack off any state information from PAREN-STATE which lies at or
3530 ;; after BUFPOS. Not destructive on PAREN-STATE.
3535 ;; just check the car, because in a balanced brace
3536 ;; expression, it must be impossible for the corresponding
3537 ;; close brace to be before point, but the open brace to
3538 ;; be after.
3540 nil ; whack it off
3542 ;; its possible that the open brace is before
3543 ;; bufpos, but the close brace is after. In that
3544 ;; case, convert this to a non-cons element. The
3545 ;; rest of the state is before bufpos, so we're
3546 ;; done.
3548 ;; we know that both the open and close braces are
3549 ;; before bufpos, so we also know that everything else
3550 ;; on state is before bufpos.
3553 nil ; whack it off
3554 ;; it's before bufpos, so everything else should too.
3557 nil)))
3560 ;; Return the bufpos of the innermost enclosing open paren before
3561 ;; bufpos, or nil if none was found.
3571 enclosingp))
3574 ;; Return the bufpos of the outermost enclosing open paren, or nil
3575 ;; if none was found.
3582 pos))
3585 ;; Return the closest "safe" position recorded on PAREN-STATE that
3586 ;; is higher up than BUFPOS. Return nil if PAREN-STATE doesn't
3587 ;; contain any. Return nil if BUFPOS is nil, which is useful to
3588 ;; find the closest limit before a given limit that might be nil.
3589 ;;
3590 ;; A "safe" position is a position at or after a recorded open
3591 ;; paren, or after a recorded close paren. The returned position is
3592 ;; thus either the first position after a close brace, or the first
3593 ;; position after an enclosing paren, or at the enclosing paren in
3594 ;; case BUFPOS is immediately after it.
3604 ;; See below.
3607 ;; elem is the position at and not after the opening paren, so
3608 ;; we can go forward one more step unless it's equal to
3609 ;; bufpos. This is useful in some cases avoid an extra paren
3610 ;; level between the safe position and bufpos.
3615 ;; This is used for `font-lock-beginning-of-syntax-function'. It
3616 ;; goes to the closest previous point that is known to be outside
3617 ;; any string literal or comment. `c-state-cache' is used if it has
3618 ;; a position in the vicinity.
3620 elem
3623 ;; Note: Similar code in `c-safe-position'. The
3624 ;; difference is that we accept a safe position at
3625 ;; the point and don't bother to go forward past open
3626 ;; parens.
3641 ;; The position is far back. Try `c-beginning-of-defun-1'
3642 ;; (although we can't be entirely sure it will go to a position
3643 ;; outside a comment or string in current emacsen). FIXME:
3644 ;; Consult `syntax-ppss' here.
3649 \f
3650 ;; Tools for scanning identifiers and other tokens.
3653 "Return non-nil if the point is on or directly after an identifier.
3654 Keywords are recognized and not considered identifiers. If an
3655 identifier is detected, the returned value is its starting position.
3656 If an identifier ends at the point and another begins at it \(can only
3657 happen in Pike) then the point for the preceding one is returned.
3659 Note that this function might do hidden buffer changes. See the
3660 comment at the start of cc-engine.el for more info."
3662 ;; FIXME: Shouldn't this function handle "operator" in C++?
3669 ;; Check for a normal (non-keyword) identifier.
3675 ;; Handle the `<operator> syntax in Pike.
3679 t
3686 ;; Handle the "operator +" syntax in C++.
3703 )))
3706 ;; If the point is at the end of a symbol then skip backward to the
3707 ;; beginning of it. Don't move otherwise. Return non-nil if point
3708 ;; moved.
3709 ;;
3710 ;; This function might do hidden buffer changes.
3713 ;; Handle the `<operator> syntax in Pike.
3719 t
3721 nil)))))
3724 ;; Move to the beginning of the current token. Do not move if not
3725 ;; in the middle of one. BACK-LIMIT may be used to bound the
3726 ;; backward search; if given it's assumed to be at the boundary
3727 ;; between two tokens. Return non-nil if the point is moved, nil
3728 ;; otherwise.
3729 ;;
3730 ;; This function might do hidden buffer changes.
3737 ;; `c-nonsymbol-token-regexp' should always match
3738 ;; since we've skipped backward over punctuation
3739 ;; or paren syntax, but consume one char in case
3740 ;; it doesn't so that we don't leave point before
3741 ;; some earlier incorrect token.
3748 ;; Move to the end of the current token. Do not move if not in the
3749 ;; middle of one. BACK-LIMIT may be used to bound the backward
3750 ;; search; if given it's assumed to be at the boundary between two
3751 ;; tokens. Return non-nil if the point is moved, nil otherwise.
3752 ;;
3753 ;; This function might do hidden buffer changes.
3761 ;; `c-nonsymbol-token-regexp' should always match since
3762 ;; we've skipped backward over punctuation or paren
3763 ;; syntax, but move forward in case it doesn't so that
3764 ;; we don't leave point earlier than we started with.
3780 "Move forward by tokens.
3781 A token is defined as all symbols and identifiers which aren't
3783 treated properly). Point is always either left at the beginning of a
3784 token or not moved at all. COUNT specifies the number of tokens to
3785 move; a negative COUNT moves in the opposite direction. A COUNT of 0
3786 moves to the next token beginning only if not already at one. If
3787 BALANCED is true, move over balanced parens, otherwise move into them.
3788 Also, if BALANCED is true, never move out of an enclosing paren.
3790 LIMIT sets the limit for the movement and defaults to the point limit.
3791 The case when LIMIT is set in the middle of a token, comment or macro
3792 is handled correctly, i.e. the point won't be left there.
3794 Return the number of tokens left to move \(positive or negative). If
3795 BALANCED is true, a move over a balanced paren counts as one. Note
3796 that if COUNT is 0 and no appropriate token beginning is found, 1 will
3797 be returned. Thus, a return value of 0 guarantees that point is at
3798 the requested position and a return value less \(without signs) than
3799 COUNT guarantees that point is at the beginning of some token.
3801 Note that this function might do hidden buffer changes. See the
3802 comment at the start of cc-engine.el for more info."
3809 c-jump-syntax-balanced
3810 c-jump-syntax-unbalanced))
3815 ;; If count is zero we should jump if in the middle of a token.
3822 ;; Skip whitespace. Count this as a move if we did in
3823 ;; fact move.
3827 ;; Moved out of bounds. Make sure the returned count isn't zero.
3832 ;; Use `condition-case' to avoid having the limit tests
3833 ;; inside the loop.
3841 t)
3844 t)
3845 ;; `c-nonsymbol-token-regexp' above should always
3846 ;; match if there are correct tokens. Try to
3847 ;; widen to see if the limit was set in the
3848 ;; middle of one, else fall back to treating
3849 ;; the offending thing as a one character token.
3854 nil)
3857 t))))
3867 count)))
3870 "Move backward by tokens.
3871 See `c-forward-token-2' for details."
3879 c-jump-syntax-balanced
3880 c-jump-syntax-unbalanced))
3884 ;; The count is zero so try to skip to the beginning of the
3885 ;; current token.
3889 ;; The limit is inside the same token, so return 1.
3892 ;; We're not in the middle of a token. If there's
3893 ;; whitespace after the point then we must move backward,
3894 ;; so set count to 1 in that case.
3896 ;; If we're looking at a '#' that might start a cpp
3897 ;; directive then we have to do a more elaborate check.
3910 ;; Use `condition-case' to avoid having to check for buffer
3911 ;; limits in `backward-char', `scan-sexps' and `goto-char' below.
3920 ;; This can be very inefficient if there's a long
3921 ;; sequence of operator tokens without any separation.
3922 ;; That doesn't happen in practice, anyway.
3932 count)))
3935 "Like `c-forward-token-2' but doesn't treat multicharacter operator
3937 characters are jumped over character by character. This function is
3938 for compatibility only; it's only a wrapper over `c-forward-token-2'."
3943 "Like `c-backward-token-2' but doesn't treat multicharacter operator
3945 characters are jumped over character by character. This function is
3946 for compatibility only; it's only a wrapper over `c-backward-token-2'."
3950 \f
3951 ;; Tools for doing searches restricted to syntactically relevant text.
3954 paren-level not-inside-token
3955 lookbehind-submatch)
3956 "Like `re-search-forward', but only report matches that are found
3957 in syntactically significant text. I.e. matches in comments, macros
3958 or string literals are ignored. The start point is assumed to be
3959 outside any comment, macro or string literal, or else the content of
3960 that region is taken as syntactically significant text.
3962 If PAREN-LEVEL is non-nil, an additional restriction is added to
3963 ignore matches in nested paren sexps. The search will also not go
3964 outside the current list sexp, which has the effect that if the point
3965 should be moved to BOUND when no match is found \(i.e. NOERROR is
3966 neither nil nor t), then it will be at the closing paren if the end of
3967 the current list sexp is encountered first.
3969 If NOT-INSIDE-TOKEN is non-nil, matches in the middle of tokens are
3970 ignored. Things like multicharacter operators and special symbols
3972 constants.
3974 If LOOKBEHIND-SUBMATCH is non-nil, it's taken as a number of a
3975 subexpression in REGEXP. The end of that submatch is used as the
3976 position to check for syntactic significance. If LOOKBEHIND-SUBMATCH
3977 isn't used or if that subexpression didn't match then the start
3979 subexpression is never tested before the starting position, so it
3983 subexpression can match the end of nonwhite syntactic whitespace,
3984 i.e. the end of comments or cpp directives. This since the function
3985 skips over such things before resuming the search. It's on the other
3987 matches syntactic whitespace.
3989 Bug: Unbalanced parens inside cpp directives are currently not handled
3990 correctly \(i.e. they don't get ignored as they should) when
3991 PAREN-LEVEL is set.
3993 Note that this function might do hidden buffer changes. See the
3994 comment at the start of cc-engine.el for more info."
3999 ;;(message "c-syntactic-re-search-forward %s %s %S" (point) bound regexp)
4002 tmp
4003 ;; Start position for the last search.
4004 search-pos
4005 ;; The `parse-partial-sexp' state between the start position
4006 ;; and the point.
4007 state
4008 ;; The current position after the last state update. The next
4009 ;; `parse-partial-sexp' continues from here.
4011 ;; The position at which to check the state and the state
4012 ;; there. This is separate from `state-pos' since we might
4013 ;; need to back up before doing the next search round.
4014 check-pos check-state
4015 ;; Last position known to end a token.
4017 ;; Set when a valid match is found.
4018 found)
4036 state-pos check-pos paren-level nil state))
4038 check-state state))
4040 ;; NOTE: If we got a look behind subexpression and get
4041 ;; an insignificant match in something that isn't
4042 ;; syntactic whitespace (i.e. strings or in nested
4043 ;; parentheses), then we can never skip more than a
4044 ;; single character from the match start position
4045 ;; (i.e. `state-pos' here) before continuing the
4046 ;; search. That since the look behind subexpression
4047 ;; might match the end of the insignificant region in
4048 ;; the next search.
4052 ;; Match inside a line comment. Skip to eol. Use
4053 ;; `re-search-forward' instead of `skip-chars-forward' to get
4054 ;; the right bound behavior.
4058 ;; Match inside a block comment. Skip to the '*/'.
4065 ;; Match in the middle of the opener of a block or line
4066 ;; comment.
4071 ;; The last `parse-partial-sexp' above might have
4072 ;; stopped short of the real check position if the end
4073 ;; of the current sexp was encountered in paren-level
4074 ;; mode. The checks above are always false in that
4075 ;; case, and since they can do better skipping in
4076 ;; lookbehind-submatch mode, we do them before
4077 ;; checking the paren level.
4081 ;; Check the paren level first since we're short of the
4082 ;; syntactic checking position if the end of the
4083 ;; current sexp was encountered by `parse-partial-sexp'.
4086 ;; Inside a nested paren sexp.
4088 ;; See the NOTE above.
4090 ;; Skip out of the paren quickly.
4094 ;; Have exited the current paren sexp.
4097 ;; The last `parse-partial-sexp' call above
4098 ;; has left us just after the closing paren
4099 ;; in this case, so we can modify the bound
4100 ;; to leave the point at the right position
4101 ;; upon return.
4103 nil)
4107 ;; Match inside a string.
4110 ;; See the NOTE above.
4112 ;; Skip to the end of the string before continuing.
4121 continue)))
4126 ;; Match inside a macro. Skip to the end of it.
4134 (< check-pos
4140 ;; Inside a token.
4142 ;; See the NOTE above.
4147 ;; A real match.
4149 nil)))
4151 ;; Should loop to search again, but take care to avoid
4152 ;; looping on the same spot.
4156 nil
4159 t))))
4165 ;;(message "c-syntactic-re-search-forward done %s" (or (match-end 0) (point)))
4172 ;; Search failed. Set point as appropriate.
4176 nil)))
4181 ;; Return the start of the literal point is in, or nil.
4182 ;; We read and write the variables `safe-pos', `safe-pos-list', `state'
4183 ;; bound in the caller.
4185 ;; Use `parse-partial-sexp' from a safe position down to the point to check
4186 ;; if it's outside comments and strings.
4189 ;; Pick a safe position as close to the point as possible.
4190 ;;
4191 ;; FIXME: Consult `syntax-ppss' here if our cache doesn't give a good
4192 ;; position.
4205 ;; Cache positions along the way to use if we have to back up more. We
4206 ;; cache every closing paren on the same level. If the paren cache is
4207 ;; relevant in this region then we're typically already on the same
4208 ;; level as the target position. Note that we might cache positions
4209 ;; after opening parens in case safe-pos is in a nested list. That's
4210 ;; both uncommon and harmless.
4218 ;; If the state contains the start of the containing sexp we cache that
4219 ;; position too, so that parse-partial-sexp in the next run has a bigger
4220 ;; chance of starting at the same level as the target position and thus
4221 ;; will get more good safe positions into the list.
4227 ;; Inside string or comment. Continue search at the
4228 ;; beginning of it.
4232 "Like `skip-chars-backward' but only look at syntactically relevant chars,
4233 i.e. don't stop at positions inside syntactic whitespace or string
4234 literals. Preprocessor directives are also ignored, with the exception
4235 of the one that the point starts within, if any. If LIMIT is given,
4236 it's assumed to be at a syntactically relevant position.
4238 If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4239 sexps, and the search will also not go outside the current paren sexp.
4240 However, if LIMIT or the buffer limit is reached inside a nested paren
4241 then the point will be left at the limit.
4243 Non-nil is returned if the point moved, nil otherwise.
4245 Note that this function might do hidden buffer changes. See the
4246 comment at the start of cc-engine.el for more info."
4249 state-2
4250 ;; A list of syntactically relevant positions in descending
4251 ;; order. It's used to avoid scanning repeatedly over
4252 ;; potentially large regions with `parse-partial-sexp' to verify
4253 ;; each position. Used in `c-ssb-lit-begin'
4254 safe-pos-list
4255 ;; The result from `c-beginning-of-macro' at the start position or the
4256 ;; start position itself if it isn't within a macro. Evaluated on
4257 ;; demand.
4258 start-macro-beg
4259 ;; The earliest position after the current one with the same paren
4260 ;; level. Used only when `paren-level' is set.
4261 lit-beg
4266 ;; The next loop "tries" to find the end point each time round,
4267 ;; loops when it hasn't succeeded.
4275 ;; Don't stop inside a literal
4278 t)
4286 ;; Not at the right level.
4289 ;; We stop above if we go out of a paren.
4290 ;; Now check whether it precedes or is
4291 ;; nested in the starting sexp.
4295 pps-end-pos paren-level-pos
4296 nil nil state-2))
4299 ;; We've stopped short of the starting position
4300 ;; so the hit was inside a nested list. Go up
4301 ;; until we are at the right level.
4310 nil)
4311 t))
4314 nil))
4316 ;; The hit was outside the list at the start
4317 ;; position. Go to the start of the list and exit.
4319 nil))
4322 ;; Inside a macro.
4330 t
4332 ;; It's inside the same macro we started in so it's
4333 ;; a relevant match.
4335 nil))))))
4339 ;; Skip syntactic ws afterwards so that we don't stop at the
4340 ;; end of a comment if `skip-chars' is something like "^/".
4344 ;; We might want to extend this with more useful return values in
4345 ;; the future.
4348 ;; The following is an alternative implementation of
4349 ;; `c-syntactic-skip-backward' that uses backward movement to keep
4350 ;; track of the syntactic context. It turned out to be generally
4351 ;; slower than the one above which uses forward checks from earlier
4352 ;; safe positions.
4353 ;;
4354 ;;(defconst c-ssb-stop-re
4355 ;; ;; The regexp matching chars `c-syntactic-skip-backward' needs to
4356 ;; ;; stop at to avoid going into comments and literals.
4357 ;; (concat
4358 ;; ;; Match comment end syntax and string literal syntax. Also match
4359 ;; ;; '/' for block comment endings (not covered by comment end
4360 ;; ;; syntax).
4361 ;; "\\s>\\|/\\|\\s\""
4362 ;; (if (memq 'gen-string-delim c-emacs-features)
4363 ;; "\\|\\s|"
4364 ;; "")
4365 ;; (if (memq 'gen-comment-delim c-emacs-features)
4366 ;; "\\|\\s!"
4367 ;; "")))
4368 ;;
4369 ;;(defconst c-ssb-stop-paren-re
4370 ;; ;; Like `c-ssb-stop-re' but also stops at paren chars.
4371 ;; (concat c-ssb-stop-re "\\|\\s(\\|\\s)"))
4372 ;;
4373 ;;(defconst c-ssb-sexp-end-re
4374 ;; ;; Regexp matching the ending syntax of a complex sexp.
4375 ;; (concat c-string-limit-regexp "\\|\\s)"))
4376 ;;
4377 ;;(defun c-syntactic-skip-backward (skip-chars &optional limit paren-level)
4378 ;; "Like `skip-chars-backward' but only look at syntactically relevant chars,
4379 ;;i.e. don't stop at positions inside syntactic whitespace or string
4380 ;;literals. Preprocessor directives are also ignored. However, if the
4381 ;;point is within a comment, string literal or preprocessor directory to
4382 ;;begin with, its contents is treated as syntactically relevant chars.
4383 ;;If LIMIT is given, it limits the backward search and the point will be
4384 ;;left there if no earlier position is found.
4385 ;;
4386 ;;If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4387 ;;sexps, and the search will also not go outside the current paren sexp.
4388 ;;However, if LIMIT or the buffer limit is reached inside a nested paren
4389 ;;then the point will be left at the limit.
4390 ;;
4391 ;;Non-nil is returned if the point moved, nil otherwise.
4392 ;;
4393 ;;Note that this function might do hidden buffer changes. See the
4394 ;;comment at the start of cc-engine.el for more info."
4395 ;;
4396 ;; (save-restriction
4397 ;; (when limit
4398 ;; (narrow-to-region limit (point-max)))
4399 ;;
4400 ;; (let ((start (point)))
4401 ;; (catch 'done
4402 ;; (while (let ((last-pos (point))
4403 ;; (stop-pos (progn
4404 ;; (skip-chars-backward skip-chars)
4405 ;; (point))))
4406 ;;
4407 ;; ;; Skip back over the same region as
4408 ;; ;; `skip-chars-backward' above, but keep to
4409 ;; ;; syntactically relevant positions.
4410 ;; (goto-char last-pos)
4411 ;; (while (and
4412 ;; ;; `re-search-backward' with a single char regexp
4413 ;; ;; should be fast.
4414 ;; (re-search-backward
4415 ;; (if paren-level c-ssb-stop-paren-re c-ssb-stop-re)
4416 ;; stop-pos 'move)
4417 ;;
4418 ;; (progn
4419 ;; (cond
4420 ;; ((looking-at "\\s(")
4421 ;; ;; `paren-level' is set and we've found the
4422 ;; ;; start of the containing paren.
4423 ;; (forward-char)
4424 ;; (throw 'done t))
4425 ;;
4426 ;; ((looking-at c-ssb-sexp-end-re)
4427 ;; ;; We're at the end of a string literal or paren
4428 ;; ;; sexp (if `paren-level' is set).
4429 ;; (forward-char)
4430 ;; (condition-case nil
4431 ;; (c-backward-sexp)
4432 ;; (error
4433 ;; (goto-char limit)
4434 ;; (throw 'done t))))
4435 ;;
4436 ;; (t
4437 ;; (forward-char)
4438 ;; ;; At the end of some syntactic ws or possibly
4439 ;; ;; after a plain '/' operator.
4440 ;; (let ((pos (point)))
4441 ;; (c-backward-syntactic-ws)
4442 ;; (if (= pos (point))
4443 ;; ;; Was a plain '/' operator. Go past it.
4444 ;; (backward-char)))))
4445 ;;
4446 ;; (> (point) stop-pos))))
4447 ;;
4448 ;; ;; Now the point is either at `stop-pos' or at some
4449 ;; ;; position further back if `stop-pos' was at a
4450 ;; ;; syntactically irrelevant place.
4451 ;;
4452 ;; ;; Skip additional syntactic ws so that we don't stop
4453 ;; ;; at the end of a comment if `skip-chars' is
4454 ;; ;; something like "^/".
4455 ;; (c-backward-syntactic-ws)
4456 ;;
4457 ;; (< (point) stop-pos))))
4458 ;;
4459 ;; ;; We might want to extend this with more useful return values
4460 ;; ;; in the future.
4461 ;; (/= (point) start))))
4463 \f
4464 ;; Tools for handling comments and string literals.
4467 "Return the type of literal point is in, if any.
4468 The return value is `c' if in a C-style comment, `c++' if in a C++
4469 style comment, `string' if in a string literal, `pound' if DETECT-CPP
4470 is non-nil and in a preprocessor line, or nil if somewhere else.
4471 Optional LIM is used as the backward limit of the search. If omitted,
4472 or nil, `c-beginning-of-defun' is used.
4474 The last point calculated is cached if the cache is enabled, i.e. if
4475 `c-in-literal-cache' is bound to a two element vector.
4477 Note that this function might do hidden buffer changes. See the
4478 comment at the start of cc-engine.el for more info."
4489 "Return a cons of the beginning and end positions of the comment or
4490 string surrounding point (including both delimiters), or nil if point
4492 to start parsing from. If NEAR is non-nil, then the limits of any
4494 spaces and tabs between point and the literal. The search for such a
4495 literal is done first in forward direction. If NOT-IN-DELIMITER is
4496 non-nil, the case when point is inside a starting delimiter won't be
4497 recognized. This only has effect for comments which have starting
4498 delimiters with more than one character.
4500 Note that this function might do hidden buffer changes. See the
4501 comment at the start of cc-engine.el for more info."
4517 ;; Search forward for a literal.
4528 ;; Search backward.
4539 ;; Block comment. Due to the nature of line
4540 ;; comments, they will always be covered by the
4541 ;; normal case above.
4544 ;; If LIM is bogus, beg will be bogus.
4548 ))))
4550 ;; In case external callers use this; it did have a docstring.
4554 "If the argument is a cons of two buffer positions (such as returned by
4555 `c-literal-limits'), and that range contains a C++ style line comment,
4556 then an extended range is returned that contains all adjacent line
4557 comments (i.e. all comments that starts in the same column with no
4558 empty lines or non-whitespace characters between them). Otherwise the
4559 argument is returned.
4561 Note that this function might do hidden buffer changes. See the
4562 comment at the start of cc-engine.el for more info."
4573 ;; Got to take care in the backward direction to handle
4574 ;; comments which are preceded by code.
4588 range)
4592 "Convenience function that given the result of `c-literal-limits',
4593 returns nil or the type of literal that the range surrounds, one
4594 of the symbols 'c, 'c++ or 'string. It's much faster than using
4595 `c-in-literal' and is intended to be used when you need both the
4596 type of a literal and its limits.
4598 Note that this function might do hidden buffer changes. See the
4599 comment at the start of cc-engine.el for more info."
4610 range))
4613 ;; Get a "safe place" approximately TRY-SIZE characters before START.
4614 ;; This doesn't preserve point.
4623 ;; Return a buffer position HOW-FAR-BACK non-literal characters from START
4624 ;; (default point). This is done by going back further in the buffer then
4625 ;; searching forward for literals. The position found won't be in a
4626 ;; literal. We start searching for the sought position TRY-SIZE (default
4627 ;; twice HOW-FAR-BACK) bytes back from START. This function must be fast.
4628 ;; :-)
4636 stack elt size
4639 ;; Move forward one literal each time round this loop.
4640 ;; Move forward to the start of a comment or string.
4642 pos
4643 start
4644 nil ; target-depth
4645 nil ; stop-before
4646 s ; state
4649 ;; Gather details of the non-literal-bit - starting pos and size.
4653 pos))
4657 ;; Move forward to the end of the comment/string.
4661 start
4662 nil ; target-depth
4663 nil ; stop-before
4664 s ; state
4668 ;; Now try and find enough non-literal characters recorded on the stack.
4669 ;; Go back one recorded literal each time round this loop.
4671 stack)
4676 ;; Have we found enough yet?
4686 ;; Return a buffer position about HOW-FAR non-literal characters forward
4687 ;; from START-POS (default point), which must not be inside a literal.
4694 ;; Scan over counted characters.
4696 pos
4698 nil ; target-depth
4699 nil ; stop-before
4700 s ; state
4704 ;; Scan over literal characters.
4707 pos
4709 nil ; target-depth
4710 nil ; stop-before
4711 s ; state
4716 \f
4717 ;; `c-find-decl-spots' and accompanying stuff.
4719 ;; Variables used in `c-find-decl-spots' to cache the search done for
4720 ;; the first declaration in the last call. When that function starts,
4721 ;; it needs to back up over syntactic whitespace to look at the last
4722 ;; token before the region being searched. That can sometimes cause
4723 ;; moves back and forth over a quite large region of comments and
4724 ;; macros, which would be repeated for each changed character when
4725 ;; we're called during fontification, since font-lock refontifies the
4726 ;; current line for each change. Thus it's worthwhile to cache the
4727 ;; first match.
4728 ;;
4729 ;; `c-find-decl-syntactic-pos' is a syntactically relevant position in
4730 ;; the syntactic whitespace less or equal to some start position.
4731 ;; There's no cached value if it's nil.
4732 ;;
4733 ;; `c-find-decl-match-pos' is the match position if
4734 ;; `c-find-decl-prefix-search' matched before the syntactic whitespace
4735 ;; at `c-find-decl-syntactic-pos', or nil if there's no such match.
4746 ; (defface c-debug-decl-spot-face
4747 ; '((t (:background "Turquoise")))
4748 ; "Debug face to mark the spots where `c-find-decl-spots' stopped.")
4749 ; (defface c-debug-decl-sws-face
4750 ; '((t (:background "Khaki")))
4751 ; "Debug face to mark the syntactic whitespace between the declaration
4752 ; spots and the preceding token end.")
4768 ;; Macro used inside `c-find-decl-spots'. It ought to be a defun,
4769 ;; but it contains lots of free variables that refer to things
4770 ;; inside `c-find-decl-spots'. The point is left at `cfd-match-pos'
4771 ;; if there is a match, otherwise at `cfd-limit'.
4772 ;;
4773 ;; The macro moves point forward to the next putative start of a declaration
4774 ;; or cfd-limit. This decl start is the next token after a "declaration
4775 ;; prefix". The declaration prefix is the earlier of `cfd-prop-match' and
4776 ;; `cfd-re-match'. `cfd-match-pos' is set to the decl prefix.
4777 ;;
4778 ;; This macro might do hidden buffer changes.
4781 ;; Find the next property match position if we haven't got one already.
4792 ;; Find the next `c-decl-prefix-or-start-re' match if we haven't
4793 ;; got one already.
4799 ;; Each time round, the next `while' moves forward over a pseudo match
4800 ;; of `c-decl-prefix-or-start-re' which is either inside a literal, or
4801 ;; is a ":" not preceded by "public", etc.. `cfd-re-match' and
4802 ;; `cfd-re-match-end' get set.
4809 ;; No match. Finish up and exit the loop.
4811 nil)
4814 ;; Matched the end of a token preceding a decl spot.
4818 ;; Matched a token that start a decl spot.
4821 c-literal-faces)
4822 ;; Pseudo match inside a comment or string literal. Skip out
4823 ;; of comments and string literals.
4835 ;; Found a ":" which isn't part of "public:", etc.
4836 t)
4839 ;; If our match was at the decl start, we have to back up over the
4840 ;; preceding syntactic ws to set `cfd-match-pos' and to catch
4841 ;; any decl spots in the syntactic ws.
4846 ;; Choose whichever match is closer to the start.
4849 cfd-re-match nil)
4851 cfd-prop-match nil))
4856 ;; Skip forward past comments only so we don't skip macros.
4858 ;; Set the position to continue at. We can avoid going over
4859 ;; the comments skipped above a second time, but it's possible
4860 ;; that the comment skipping has taken us past `cfd-prop-match'
4861 ;; since the property might be used inside comments.
4867 ;; Call CFD-FUN for each possible spot for a declaration, cast or
4868 ;; label from the point to CFD-LIMIT.
4869 ;;
4870 ;; CFD-FUN is called with point at the start of the spot. It's passed two
4871 ;; arguments: The first is the end position of the token preceding the spot,
4872 ;; or 0 for the implicit match at bob. The second is a flag that is t when
4873 ;; the match is inside a macro. Point should be moved forward by at least
4874 ;; one token.
4875 ;;
4876 ;; If CFD-FUN adds `c-decl-end' properties somewhere below the current spot,
4877 ;; it should return non-nil to ensure that the next search will find them.
4878 ;;
4879 ;; Such a spot is:
4880 ;; o The first token after bob.
4881 ;; o The first token after the end of submatch 1 in
4882 ;; `c-decl-prefix-or-start-re' when that submatch matches.
4883 ;; o The start of each `c-decl-prefix-or-start-re' match when
4884 ;; submatch 1 doesn't match.
4885 ;; o The first token after the end of each occurrence of the
4886 ;; `c-type' text property with the value `c-decl-end', provided
4887 ;; `c-type-decl-end-used' is set.
4888 ;;
4889 ;; Only a spot that match CFD-DECL-RE and whose face is in the
4890 ;; CFD-FACE-CHECKLIST list causes CFD-FUN to be called. The face
4891 ;; check is disabled if CFD-FACE-CHECKLIST is nil.
4892 ;;
4893 ;; If the match is inside a macro then the buffer is narrowed to the
4894 ;; end of it, so that CFD-FUN can investigate the following tokens
4895 ;; without matching something that begins inside a macro and ends
4896 ;; outside it. It's to avoid this work that the CFD-DECL-RE and
4897 ;; CFD-FACE-CHECKLIST checks exist.
4898 ;;
4899 ;; The spots are visited approximately in order from top to bottom.
4900 ;; It's however the positions where `c-decl-prefix-or-start-re'
4901 ;; matches and where `c-decl-end' properties are found that are in
4902 ;; order. Since the spots often are at the following token, they
4903 ;; might be visited out of order insofar as more spots are reported
4904 ;; later on within the syntactic whitespace between the match
4905 ;; positions and their spots.
4906 ;;
4907 ;; It's assumed that comments and strings are fontified in the
4908 ;; searched range.
4909 ;;
4910 ;; This is mainly used in fontification, and so has an elaborate
4911 ;; cache to handle repeated calls from the same start position; see
4912 ;; the variables above.
4913 ;;
4914 ;; All variables in this function begin with `cfd-' to avoid name
4915 ;; collision with the (dynamically bound) variables used in CFD-FUN.
4916 ;;
4917 ;; This function might do hidden buffer changes.
4921 ;; The end of the token preceding the decl spot last found
4922 ;; with `c-decl-prefix-or-start-re'. `cfd-limit' if there's
4923 ;; no match.
4924 cfd-re-match
4925 ;; The end position of the last `c-decl-prefix-or-start-re'
4926 ;; match. If this is greater than `cfd-continue-pos', the
4927 ;; next regexp search is started here instead.
4929 ;; The end of the last `c-decl-end' found by
4930 ;; `c-find-decl-prefix-search'. `cfd-limit' if there's no
4931 ;; match. If searching for the property isn't needed then we
4932 ;; disable it by setting it to `cfd-limit' directly.
4934 ;; The end of the token preceding the decl spot last found by
4935 ;; `c-find-decl-prefix-search'. 0 for the implicit match at
4936 ;; bob. `cfd-limit' if there's no match. In other words,
4937 ;; this is the minimum of `cfd-re-match' and `cfd-prop-match'.
4939 ;; The position to continue searching at.
4940 cfd-continue-pos
4941 ;; The position of the last "real" token we've stopped at.
4942 ;; This can be greater than `cfd-continue-pos' when we get
4943 ;; hits inside macros or at `c-decl-end' positions inside
4944 ;; comments.
4946 ;; The end position of the last entered macro.
4949 ;; Initialize by finding a syntactically relevant start position
4950 ;; before the point, and do the first `c-decl-prefix-or-start-re'
4951 ;; search unless we're at bob.
4954 ;; Must back up a bit since we look for the end of the previous
4955 ;; statement or declaration, which is earlier than the first
4956 ;; returned match.
4959 ;; First we need to move to a syntactically relevant position.
4960 ;; Begin by backing out of comment or string literals.
4963 ;; Try to use the faces to back up to the start of the
4964 ;; literal. FIXME: What if the point is on a declaration
4965 ;; inside a comment?
4971 ;; XEmacs doesn't fontify the quotes surrounding string
4972 ;; literals.
4981 ;; Don't trust the literal to contain only literal faces
4982 ;; (the font lock package might not have fontified the
4983 ;; start of it at all, for instance) so check that we have
4984 ;; arrived at something that looks like a start or else
4985 ;; resort to `c-literal-limits'.
4992 ;; The start is in a literal. If the limit is in the same
4993 ;; one we don't have to find a syntactic position etc. We
4994 ;; only check that if the limit is at or before bonl to save
4995 ;; time; it covers the by far most common case when font-lock
4996 ;; refontifies the current line only.
5007 ;; Completely inside a literal. Set up variables to trig the
5008 ;; (< cfd-continue-pos cfd-start-pos) case below and it'll
5009 ;; find a suitable start position.
5012 ;; Check if the region might be completely inside a macro, to
5013 ;; optimize that like the completely-inside-literal above.
5020 ;; (Maybe) completely inside a macro. Only need to trig the
5021 ;; (< cfd-continue-pos cfd-start-pos) case below to make it
5022 ;; set things up.
5024 start-in-macro t))
5027 ;; Back out of any macro so we don't miss any declaration
5028 ;; that could follow after it.
5032 ;; Now we're at a proper syntactically relevant position so we
5033 ;; can use the cache. But first clear it if it applied
5034 ;; further down.
5039 ;; Don't have to do this if the cache is relevant here,
5040 ;; typically if the same line is refontified again. If
5041 ;; we're just some syntactic whitespace further down we can
5042 ;; still use the cache to limit the skipping.
5045 ;; If we hit `c-find-decl-syntactic-pos' and
5046 ;; `c-find-decl-match-pos' is set then we install the cached
5047 ;; values. If we hit `c-find-decl-syntactic-pos' and
5048 ;; `c-find-decl-match-pos' is nil then we know there's no decl
5049 ;; prefix in the whitespace before `c-find-decl-syntactic-pos'
5050 ;; and so we can continue the search from this point. If we
5051 ;; didn't hit `c-find-decl-syntactic-pos' then we're now in
5052 ;; the right spot to begin searching anyway.
5054 c-find-decl-match-pos)
5056 cfd-continue-pos syntactic-pos)
5061 ;; Always consider bob a match to get the first
5062 ;; declaration in the file. Do this separately instead of
5063 ;; letting `c-decl-prefix-or-start-re' match bob, so that
5064 ;; regexp always can consume at least one character to
5065 ;; ensure that we won't get stuck in an infinite loop.
5070 ;; Do an initial search now. In the bob case above it's
5071 ;; only done to search for a `c-decl-end' spot.
5075 cfd-match-pos)))))
5077 ;; Advance `cfd-continue-pos' if it's before the start position.
5078 ;; The closest continue position that might have effect at or
5079 ;; after the start depends on what we started in. This also
5080 ;; finds a suitable start position in the special cases when the
5081 ;; region is completely within a literal or macro.
5086 ;; If we're in a macro then it's the closest preceding token
5087 ;; in the macro. Check this before `start-in-literal',
5088 ;; since if we're inside a literal in a macro, the preceding
5089 ;; token is earlier than any `c-decl-end' spot inside the
5090 ;; literal (comment).
5092 ;; The only syntactic ws in macros are comments.
5098 ;; If we're in a comment it can only be the closest
5099 ;; preceding `c-decl-end' position within that comment, if
5100 ;; any. Go back to the beginning of such a property so that
5101 ;; `c-find-decl-prefix-search' will find the end of it.
5102 ;; (Can't stop at the end and install it directly on
5103 ;; `cfd-prop-match' since that variable might be cleared
5104 ;; after `cfd-fun' below.)
5105 ;;
5106 ;; Note that if the literal is a string then the property
5107 ;; search will simply skip to the beginning of it right
5108 ;; away.
5120 ;; Didn't find any property inside the comment, so we can
5121 ;; skip it entirely. (This won't skip past a string, but
5122 ;; that'll be handled quickly by the next
5123 ;; `c-find-decl-prefix-search' anyway.)
5129 ;; If we started in normal code, the only match that might
5130 ;; apply before the start is what we already got in
5131 ;; `cfd-match-pos' so we can continue at the start position.
5132 ;; (Note that we don't get here if the first match is below
5133 ;; it.)
5136 ;; Delete found matches if they are before our new continue
5137 ;; position, so that `c-find-decl-prefix-search' won't back up
5138 ;; to them later on.
5146 ;; This is the normal case and we got a proper syntactic
5147 ;; position. If there's a match then it's always outside
5148 ;; macros and comments, so advance to the next token and set
5149 ;; `cfd-token-pos'. The loop below will later go back using
5150 ;; `cfd-continue-pos' to fix declarations inside the
5151 ;; syntactic ws.
5159 ;; Have one of the special cases when the region is completely
5160 ;; within a literal or macro. `cfd-continue-pos' is set to a
5161 ;; good start position for the search, so do it.
5164 ;; Now loop. Round what? (ACM, 2006/7/5). We already got the first match.
5171 ;; Kludge to filter out matches on the "<" that
5172 ;; aren't open parens, for the sake of languages
5173 ;; that got `c-recognize-<>-arglists' set.
5178 ;; If `cfd-continue-pos' is less or equal to
5179 ;; `cfd-token-pos', we've got a hit inside a macro
5180 ;; that's in the syntactic whitespace before the last
5181 ;; "real" declaration we've checked. If they're equal
5182 ;; we've arrived at the declaration a second time, so
5183 ;; there's nothing to do.
5187 ;; If `cfd-continue-pos' is less than `cfd-token-pos'
5188 ;; we're still searching for declarations embedded in
5189 ;; the syntactic whitespace. In that case we need
5190 ;; only to skip comments and not macros, since they
5191 ;; can't be nested, and that's already been done in
5192 ;; `c-find-decl-prefix-search'.
5197 ;; Continue if the following token fails the
5198 ;; CFD-DECL-RE and CFD-FACE-CHECKLIST checks.
5205 t)))
5216 ;; Narrow to the end of the macro if we got a hit inside
5217 ;; one, to avoid recognizing things that start inside the
5218 ;; macro and end outside it.
5220 ;; Not in the same macro as in the previous round.
5231 t
5234 t)
5235 ;; The matched token was the last thing in the macro,
5236 ;; so the whole match is bogus.
5238 nil))))
5245 ;; Restore limits if we did macro narrowing above.
5252 ; cfd-match-pos, etc.
5254 \f
5255 ;; A cache for found types.
5257 ;; Buffer local variable that contains an obarray with the types we've
5258 ;; found. If a declaration is recognized somewhere we record the
5259 ;; fully qualified identifier in it to recognize it as a type
5260 ;; elsewhere in the file too. This is not accurate since we do not
5261 ;; bother with the scoping rules of the languages, but in practice the
5262 ;; same name is seldom used as both a type and something else in a
5263 ;; file, and we only use this as a last resort in ambiguous cases (see
5264 ;; `c-forward-decl-or-cast-1').
5265 ;;
5266 ;; Not every type need be in this cache. However, things which have
5267 ;; ceased to be types must be removed from it.
5268 ;;
5269 ;; Template types in C++ are added here too but with the template
5270 ;; arglist replaced with "<>" in references or "<" for the one in the
5271 ;; primary type. E.g. the type "Foo<A,B>::Bar<C>" is stored as
5272 ;; "Foo<>::Bar<". This avoids storing very long strings (since C++
5273 ;; template specs can be fairly sized programs in themselves) and
5274 ;; improves the hit ratio (it's a type regardless of the template
5275 ;; args; it's just not the same type, but we're only interested in
5276 ;; recognizing types, not telling distinct types apart). Note that
5277 ;; template types in references are added here too; from the example
5278 ;; above there will also be an entry "Foo<".
5283 ;; Clears `c-found-types'.
5287 ;; Add the given region as a type in `c-found-types'. If the region
5288 ;; doesn't match an existing type but there is a type which is equal
5289 ;; to the given one except that the last character is missing, then
5290 ;; the shorter type is removed. That's done to avoid adding all
5291 ;; prefixes of a type as it's being entered and font locked. This
5292 ;; doesn't cover cases like when characters are removed from a type
5293 ;; or added in the middle. We'd need the position of point when the
5294 ;; font locking is invoked to solve this well.
5295 ;;
5296 ;; This function might do hidden buffer changes.
5303 ;; Remove the "NAME" from c-found-types, if present.
5307 ;; Return non-nil if the given region contains a type in
5308 ;; `c-found-types'.
5309 ;;
5310 ;; This function might do hidden buffer changes.
5312 c-found-types))
5315 ;; Return all the types in `c-found-types' as a sorted list of
5316 ;; strings.
5320 type-list)))
5321 c-found-types)
5324 ;; Shut up the byte compiler.
5328 ;; An after change function which, in conjunction with the info in
5329 ;; c-maybe-stale-found-type (set in c-before-change), removes a type
5330 ;; from `c-found-types', should this type have become stale. For
5331 ;; example, this happens to "foo" when "foo \n bar();" becomes
5332 ;; "foo(); \n bar();". Such stale types, if not removed, foul up
5333 ;; the fontification.
5334 ;;
5335 ;; Have we, perhaps, added non-ws characters to the front/back of a found
5336 ;; type?
5356 ;; Changing the amount of (already existing) whitespace - don't do anything.
5361 ;; The syntactic relationship which defined a "found type" has been
5362 ;; destroyed.
5365 ;; ((eq (car c-maybe-stale-found-type) 'c-decl-type-start) FIXME!!!
5366 )))
5368 \f
5369 ;; Setting and removing syntax properties on < and > in languages (C++
5370 ;; and Java) where they can be template/generic delimiters as well as
5371 ;; their normal meaning of "less/greater than".
5373 ;; Normally, < and > have syntax 'punctuation'. When they are found to
5374 ;; be delimiters, they are marked as such with the category properties
5375 ;; c-<-as-paren-syntax, c->-as-paren-syntax respectively.
5377 ;; STRATEGY:
5378 ;;
5379 ;; It is impossible to determine with certainty whether a <..> pair in
5380 ;; C++ is two comparison operators or is template delimiters, unless
5381 ;; one duplicates a lot of a C++ compiler. For example, the following
5382 ;; code fragment:
5383 ;;
5384 ;; foo (a < b, c > d) ;
5385 ;;
5386 ;; could be a function call with two integer parameters (each a
5387 ;; relational expression), or it could be a constructor for class foo
5388 ;; taking one parameter d of templated type "a < b, c >". They are
5389 ;; somewhat easier to distinguish in Java.
5390 ;;
5391 ;; The strategy now (2010-01) adopted is to mark and unmark < and
5392 ;; > IN MATCHING PAIRS ONLY. [Previously, they were marked
5393 ;; individually when their context so indicated. This gave rise to
5394 ;; intractable problems when one of a matching pair was deleted, or
5395 ;; pulled into a literal.]
5396 ;;
5397 ;; At each buffer change, the syntax-table properties are removed in a
5398 ;; before-change function and reapplied, when needed, in an
5399 ;; after-change function. It is far more important that the
5400 ;; properties get removed when they they are spurious than that they
5401 ;; be present when wanted.
5402 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
5404 ;; POS (default point) is at a < character. If it is marked with
5405 ;; open paren syntax-table text property, remove the property,
5406 ;; together with the close paren property on the matching > (if
5407 ;; any).
5422 ;; POS (default point) is at a > character. If it is marked with
5423 ;; close paren syntax-table property, remove the property, together
5424 ;; with the open paren property on the matching < (if any).
5439 ;; POS (default point) is at a < or > character. If it has an
5440 ;; open/close paren syntax-table property, remove this property both
5441 ;; from the current character and its partner (which will also be
5442 ;; thusly marked).
5452 ;; POS (default point) is at a < character. If it is both marked
5453 ;; with open/close paren syntax-table property, and has a matching >
5454 ;; (also marked) which is after LIM, remove the property both from
5455 ;; the current > and its partner. Return t when this happens, nil
5456 ;; when it doesn't.
5470 t)))
5473 ;; POS (default point) is at a > character. If it is both marked
5474 ;; with open/close paren syntax-table property, and has a matching <
5475 ;; (also marked) which is before LIM, remove the property both from
5476 ;; the current < and its partner. Return t when this happens, nil
5477 ;; when it doesn't.
5491 t)))
5493 ;; Set by c-common-init in cc-mode.el.
5498 ;; Unmark certain pairs of "< .... >" which are currently marked as
5499 ;; template/generic delimiters. (This marking is via syntax-table
5500 ;; text properties).
5501 ;;
5502 ;; These pairs are those which are in the current "statement" (i.e.,
5503 ;; the region between the {, }, or ; before BEG and the one after
5504 ;; END), and which enclose any part of the interval (BEG END).
5505 ;;
5506 ;; Note that in C++ (?and Java), template/generic parens cannot
5507 ;; enclose a brace or semicolon, so we use these as bounds on the
5508 ;; region we must work on.
5509 ;;
5510 ;; This function is called from before-change-functions (via
5511 ;; c-get-state-before-change-functions). Thus the buffer is widened,
5512 ;; and point is undefined, both at entry and exit.
5513 ;;
5514 ;; FIXME!!! This routine ignores the possibility of macros entirely.
5515 ;; 2010-01-29.
5519 new-beg new-end need-new-beg need-new-end)
5520 ;; Locate the barrier before the changed region
5525 ;; Remove the syntax-table properties from each pertinent <...> pair.
5526 ;; Firsly, the ones with the < before beg and > after beg.
5531 ;; Locate the barrier after END.
5536 ;; Remove syntax-table properties from the remaining pertinent <...>
5537 ;; pairs, those with a > after end and < before end.
5542 ;; Extend the fontification region, if needed.
5554 ;; This is called from `after-change-functions' when
5555 ;; c-recognize-<>-arglists' is set. It ensures that no "<" or ">"
5556 ;; chars with paren syntax become part of another operator like "<<"
5557 ;; or ">=".
5558 ;;
5559 ;; This function might do hidden buffer changes.
5592 \f
5593 ;; Handling of small scale constructs like types and names.
5595 ;; Dynamically bound variable that instructs `c-forward-type' to also
5596 ;; treat possible types (i.e. those that it normally returns 'maybe or
5597 ;; 'found for) as actual types (and always return 'found for them).
5598 ;; This means that it records them in `c-record-type-identifiers' if
5599 ;; that is set, and that it adds them to `c-found-types'.
5602 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5603 ;; mark up successfully parsed arglists with paren syntax properties on
5604 ;; the surrounding angle brackets and with `c-<>-arg-sep' in the
5605 ;; `c-type' property of each argument separating comma.
5606 ;;
5607 ;; Setting this variable also makes `c-forward-<>-arglist' recurse into
5608 ;; all arglists for side effects (i.e. recording types), otherwise it
5609 ;; exploits any existing paren syntax properties to quickly jump to the
5610 ;; end of already parsed arglists.
5611 ;;
5612 ;; Marking up the arglists is not the default since doing that correctly
5613 ;; depends on a proper value for `c-restricted-<>-arglists'.
5616 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5617 ;; not accept arglists that contain binary operators.
5618 ;;
5619 ;; This is primarily used to handle C++ template arglists. C++
5620 ;; disambiguates them by checking whether the preceding name is a
5621 ;; template or not. We can't do that, so we assume it is a template
5622 ;; if it can be parsed as one. That usually works well since
5623 ;; comparison expressions on the forms "a < b > c" or "a < b, c > d"
5624 ;; in almost all cases would be pointless.
5625 ;;
5626 ;; However, in function arglists, e.g. in "foo (a < b, c > d)", we
5627 ;; should let the comma separate the function arguments instead. And
5628 ;; in a context where the value of the expression is taken, e.g. in
5629 ;; "if (a < b || c > d)", it's probably not a template.
5632 ;; Dynamically bound variables that instructs
5633 ;; `c-forward-keyword-clause', `c-forward-<>-arglist',
5634 ;; `c-forward-name', `c-forward-type', `c-forward-decl-or-cast-1', and
5635 ;; `c-forward-label' to record the ranges of all the type and
5636 ;; reference identifiers they encounter. They will build lists on
5637 ;; these variables where each element is a cons of the buffer
5638 ;; positions surrounding each identifier. This recording is only
5639 ;; activated when `c-record-type-identifiers' is non-nil.
5640 ;;
5641 ;; All known types that can't be identifiers are recorded, and also
5642 ;; other possible types if `c-promote-possible-types' is set.
5643 ;; Recording is however disabled inside angle bracket arglists that
5644 ;; are encountered inside names and other angle bracket arglists.
5645 ;; Such occurrences are taken care of by `c-font-lock-<>-arglists'
5646 ;; instead.
5647 ;;
5648 ;; Only the names in C++ template style references (e.g. "tmpl" in
5649 ;; "tmpl<a,b>::foo") are recorded as references, other references
5650 ;; aren't handled here.
5651 ;;
5652 ;; `c-forward-label' records the label identifier(s) on
5653 ;; `c-record-ref-identifiers'.
5657 ;; This variable will receive a cons cell of the range of the last
5658 ;; single identifier symbol stepped over by `c-forward-name' if it's
5659 ;; successful. This is the range that should be put on one of the
5660 ;; record lists above by the caller. It's assigned nil if there's no
5661 ;; such symbol in the name.
5666 ;; Always true.
5676 ;; Always true.
5684 ;; Dynamically bound variable that instructs `c-forward-type' to
5685 ;; record the ranges of types that only are found. Behaves otherwise
5686 ;; like `c-record-type-identifiers'.
5690 ;; Used internally in `c-forward-keyword-clause' to move forward
5691 ;; over a type (if TYPE is 'type) or a name (otherwise) which
5692 ;; possibly is prefixed by keywords and their associated clauses.
5693 ;; Try with a type/name first to not trip up on those that begin
5694 ;; with a keyword. Return t if a known or found type is moved
5695 ;; over. The point is clobbered if nil is returned. If range
5696 ;; recording is enabled, the identifier is recorded on as a type
5697 ;; if TYPE is 'type or as a reference if TYPE is 'ref.
5698 ;;
5699 ;; This macro might do hidden buffer changes.
5704 nil
5711 t)))
5714 ;; Used internally in `c-forward-keyword-clause' to move forward
5715 ;; over a comma separated list of types or names using
5716 ;; `c-forward-keyword-prefixed-id'.
5717 ;;
5718 ;; This macro might do hidden buffer changes.
5729 ;; Submatch MATCH in the current match data is assumed to surround a
5730 ;; token. If it's a keyword, move over it and any immediately
5731 ;; following clauses associated with it, stopping at the start of
5732 ;; the next token. t is returned in that case, otherwise the point
5733 ;; stays and nil is returned. The kind of clauses that are
5734 ;; recognized are those specified by `c-type-list-kwds',
5735 ;; `c-ref-list-kwds', `c-colon-type-list-kwds',
5736 ;; `c-paren-nontype-kwds', `c-paren-type-kwds', `c-<>-type-kwds',
5737 ;; and `c-<>-arglist-kwds'.
5738 ;;
5739 ;; This function records identifier ranges on
5740 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5741 ;; `c-record-type-identifiers' is non-nil.
5742 ;;
5743 ;; Note that for `c-colon-type-list-kwds', which doesn't necessary
5744 ;; apply directly after the keyword, the type list is moved over
5745 ;; only when there is no unaccounted token before it (i.e. a token
5746 ;; that isn't moved over due to some other keyword list). The
5747 ;; identifier ranges in the list are still recorded if that should
5748 ;; be done, though.
5749 ;;
5750 ;; This function might do hidden buffer changes.
5753 ;; The call to `c-forward-<>-arglist' below is made after
5754 ;; `c-<>-sexp-kwds' keywords, so we're certain they actually
5755 ;; are angle bracket arglists and `c-restricted-<>-arglists'
5756 ;; should therefore be nil.
5768 ;; There's a type directly after a keyword in `c-type-list-kwds'.
5773 ;; There's a name directly after a keyword in `c-ref-list-kwds'.
5778 ;; There's an open paren after a keyword in `c-paren-any-kwds'.
5785 ;; Use `c-forward-type' on every identifier we can find
5786 ;; inside the paren, to record the types.
5811 ;; If we are at the colon already, we move over the type
5812 ;; list after it.
5818 ;; Not at the colon, so stop here. But the identifier
5819 ;; ranges in the type list later on should still be
5820 ;; recorded.
5823 ;; If a keyword matched both one of the types above and
5824 ;; this one, we match `c-colon-type-list-re' after the
5825 ;; clause matched above.
5832 ;; There's a type after the `c-colon-type-list-re' match
5833 ;; after a keyword in `c-colon-type-list-kwds'.
5837 t)))
5839 ;; cc-mode requires cc-fonts.
5843 ;; The point is assumed to be at a "<". Try to treat it as the open
5844 ;; paren of an angle bracket arglist and move forward to the
5845 ;; corresponding ">". If successful, the point is left after the
5846 ;; ">" and t is returned, otherwise the point isn't moved and nil is
5847 ;; returned. If ALL-TYPES is t then all encountered arguments in
5848 ;; the arglist that might be types are treated as found types.
5849 ;;
5850 ;; The variable `c-parse-and-markup-<>-arglists' controls how this
5851 ;; function handles text properties on the angle brackets and argument
5852 ;; separating commas.
5853 ;;
5854 ;; `c-restricted-<>-arglists' controls how lenient the template
5855 ;; arglist recognition should be.
5856 ;;
5857 ;; This function records identifier ranges on
5858 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5859 ;; `c-record-type-identifiers' is non-nil.
5860 ;;
5861 ;; This function might do hidden buffer changes.
5864 ;; If `c-record-type-identifiers' is set then activate
5865 ;; recording of any found types that constitute an argument in
5866 ;; the arglist.
5874 ;; `nconc' doesn't mind that the tail of
5875 ;; `c-record-found-types' is t.
5878 t)
5881 nil)))
5884 ;; Recursive part of `c-forward-<>-arglist'.
5885 ;;
5886 ;; This function might do hidden buffer changes.
5889 ;; Cover this so that any recorded found type ranges are
5890 ;; automatically lost if it turns out to not be an angle
5891 ;; bracket arglist. It's propagated through the return value
5892 ;; on successful completion.
5894 ;; List that collects the positions after the argument
5895 ;; separating ',' in the arglist.
5896 arg-start-pos)
5897 ;; If the '<' has paren open syntax then we've marked it as an angle
5898 ;; bracket arglist before, so skip to the end.
5906 t
5907 ;; Got unmatched paren angle brackets. We don't clear the paren
5908 ;; syntax properties and retry, on the basis that it's very
5909 ;; unlikely that paren angle brackets become operators by code
5910 ;; manipulation. It's far more likely that it doesn't match due
5911 ;; to narrowing or some temporary change.
5913 nil))
5918 ;; go forward one non-alphanumeric character (group) per iteration of
5919 ;; this loop.
5926 ;; All encountered identifiers are types, so set the
5927 ;; promote flag and parse the type.
5950 ;; Note: These regexps exploit the match order in \| so
5951 ;; that "<>" is matched by "<" rather than "[^>:-]>".
5953 ;; Stop on ',', '|', '&', '+' and '-' to catch
5954 ;; common binary operators that could be between
5955 ;; two comparison expressions "a<b" and "c>d".
5957 nil t t))
5961 ;; Either an operator starting with '>' or the end of
5962 ;; the angle bracket arglist.
5969 ;; The angle bracket arglist is finished.
5981 ;; Either an operator starting with '<' or a nested arglist.
5985 ;; The '<' begins a multi-char operator.
5989 ;; We're at a nested <.....>
5995 ;; There's always an identifier before an angle
5996 ;; bracket arglist, or a keyword in `c-<>-type-kwds'
5997 ;; or `c-<>-arglist-kwds'.
6014 ;; It was an angle bracket arglist.
6017 ;; Record the identifier before the template as a type
6018 ;; or reference depending on whether the arglist is last
6019 ;; in a qualified identifier.
6029 ;; At a "less than" operator.
6032 )))
6039 ;; Just another argument. Record the position. The
6040 ;; type check stuff that made us stop at it is at
6041 ;; the top of the loop.
6045 ;; Got a character that can't be in an angle bracket
6046 ;; arglist argument. Abort using `throw', since
6047 ;; it's useless to try to find a surrounding arglist
6048 ;; if we're nested.
6054 ;; The point is assumed to be directly after a ">". Try to treat it
6055 ;; as the close paren of an angle bracket arglist and move back to
6056 ;; the corresponding "<". If successful, the point is left at
6057 ;; the "<" and t is returned, otherwise the point isn't moved and
6058 ;; nil is returned. ALL-TYPES is passed on to
6059 ;; `c-forward-<>-arglist'.
6060 ;;
6061 ;; If the optional LIMIT is given, it bounds the backward search.
6062 ;; It's then assumed to be at a syntactically relevant position.
6063 ;;
6064 ;; This is a wrapper around `c-forward-<>-arglist'. See that
6065 ;; function for more details.
6074 t
6075 ;; See corresponding note in `c-forward-<>-arglist'.
6077 nil)
6084 t
6085 ;; Stopped at bob or a char that isn't allowed in an
6086 ;; arglist, so we've failed.
6088 nil)
6093 ;; If we moved then the "<" was part of some
6094 ;; multicharacter token.
6095 t
6101 ;; Matched the arglist. Break the while.
6103 nil)
6105 ;; We started from a non-paren ">" inside an
6106 ;; arglist.
6108 nil)
6110 ;; Matched a shorter arglist. Can be a nested
6111 ;; one so continue looking.
6113 t))
6114 t))))))
6119 ;; Move forward over a complete name if at the beginning of one,
6120 ;; stopping at the next following token. A keyword, as such,
6121 ;; doesn't count as a name. If the point is not at something that
6122 ;; is recognized as a name then it stays put.
6123 ;;
6124 ;; A name could be something as simple as "foo" in C or something as
6125 ;; complex as "X<Y<class A<int>::B, BIT_MAX >> b>, ::operator<> ::
6126 ;; Z<(a>b)> :: operator const X<&foo>::T Q::G<unsigned short
6127 ;; int>::*volatile const" in C++ (this function is actually little
6128 ;; more than a `looking-at' call in all modes except those that,
6129 ;; like C++, have `c-recognize-<>-arglists' set).
6130 ;;
6131 ;; Return
6132 ;; o - nil if no name is found;
6133 ;; o - 'template if it's an identifier ending with an angle bracket
6134 ;; arglist;
6135 ;; o - 'operator of it's an operator identifier;
6136 ;; o - t if it's some other kind of name.
6137 ;;
6138 ;; This function records identifier ranges on
6139 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6140 ;; `c-record-type-identifiers' is non-nil.
6141 ;;
6142 ;; This function might do hidden buffer changes.
6145 ;; Turn off `c-promote-possible-types' here since we might
6146 ;; call `c-forward-<>-arglist' and we don't want it to promote
6147 ;; every suspect thing in the arglist to a type. We're
6148 ;; typically called from `c-forward-type' in this case, and
6149 ;; the caller only wants the top level type that it finds to
6150 ;; be promoted.
6151 c-promote-possible-types)
6157 ;; Check for keyword. We go to the last symbol in
6158 ;; `c-identifier-key' first.
6171 ;; "template" is only valid inside an
6172 ;; identifier if preceded by "::".
6177 t))
6179 ;; Handle a C++ operator or template identifier.
6183 ;; Got "... ::template".
6187 res subres))))
6190 ;; Got a cast operator.
6194 ;; Now we should match a sequence of either
6195 ;; '*', '&' or a name followed by ":: *",
6196 ;; where each can be followed by a sequence
6197 ;; of `c-opt-type-modifier-key'.
6200 t)
6210 t))))
6218 ;; Got some other operator.
6226 nil)
6228 ;; `id-start' is equal to `id-end' if we've jumped over
6229 ;; an identifier that doesn't end with a symbol token.
6230 ;; That can occur e.g. for Java import directives on the
6231 ;; form "foo.bar.*".
6238 res t)))
6248 ;; Got a concatenated identifier. This handles the
6249 ;; cases with tricky syntactic whitespace that aren't
6250 ;; covered in `c-identifier-key'.
6253 t)
6257 ;; Maybe an angle bracket arglist.
6265 c-last-identifier-range nil)
6270 ;; Continue if there's an identifier concatenation
6271 ;; operator after the template argument.
6277 t)
6282 nil)))
6283 )))))
6286 res))
6289 ;; Move forward over a type spec if at the beginning of one,
6290 ;; stopping at the next following token. The keyword "typedef"
6291 ;; isn't part of a type spec here.
6292 ;;
6293 ;; BRACE-BLOCK-TOO, when non-nil, means move over the brace block in
6294 ;; constructs like "struct foo {...} bar ;" or "struct {...} bar;".
6295 ;; The current (2009-03-10) intention is to convert all uses of
6296 ;; `c-forward-type' to call with this parameter set, then to
6297 ;; eliminate it.
6298 ;;
6299 ;; Return
6300 ;; o - t if it's a known type that can't be a name or other
6301 ;; expression;
6302 ;; o - 'known if it's an otherwise known type (according to
6303 ;; `*-font-lock-extra-types');
6304 ;; o - 'prefix if it's a known prefix of a type;
6305 ;; o - 'found if it's a type that matches one in `c-found-types';
6306 ;; o - 'maybe if it's an identifier that might be a type; or
6307 ;; o - nil if it can't be a type (the point isn't moved then).
6308 ;;
6309 ;; The point is assumed to be at the beginning of a token.
6310 ;;
6311 ;; Note that this function doesn't skip past the brace definition
6312 ;; that might be considered part of the type, e.g.
6313 ;; "enum {a, b, c} foo".
6314 ;;
6315 ;; This function records identifier ranges on
6316 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6317 ;; `c-record-type-identifiers' is non-nil.
6318 ;;
6319 ;; This function might do hidden buffer changes.
6327 ;; Skip leading type modifiers. If any are found we know it's a
6328 ;; prefix of a type.
6337 ; "typedef".
6345 ;; In many languages the name can be used without the
6346 ;; prefix, so we add it to `c-found-types'.
6349 c-last-identifier-range)
6371 id-range c-last-identifier-range))))
6383 id-end)
6385 ;; Looking at a primitive or known type identifier. We've
6386 ;; checked for a name first so that we don't go here if the
6387 ;; known type match only is a prefix of another name.
6398 ;; There might be more keywords for the type.
6426 ;; A normal identifier.
6436 ;; It's an identifier that has been used as
6437 ;; a type somewhere else.
6438 'found
6439 ;; It's an identifier that might be a type.
6442 ;; A template is a type.
6446 ;; Otherwise it's an operator identifier, which is not a type.
6451 ;; Skip trailing type modifiers. If any are found we know it's
6452 ;; a type.
6458 ;; Step over any type suffix operator. Do not let the existence
6459 ;; of these alter the classification of the found type, since
6460 ;; these operators typically are allowed in normal expressions
6461 ;; too.
6468 ;; Look for a trailing operator that concatenates the type
6469 ;; with a following one, and if so step past that one through
6470 ;; a recursive call. Note that we don't record concatenated
6471 ;; types in `c-found-types' - it's the component types that
6472 ;; are recorded when appropriate.
6475 c-promote-possible-types))
6476 ;; If we can't promote then set `c-record-found-types' so that
6477 ;; we can merge in the types from the second part afterwards if
6478 ;; it turns out to be a known type there.
6481 subres)
6490 ;; If either operand certainly is a type then both are, but we
6491 ;; don't let the existence of the operator itself promote two
6492 ;; uncertain types to a certain one.
6511 ;; Merge in the ranges of any types found by the second
6512 ;; `c-forward-type'.
6514 ;; `nconc' doesn't mind that the tail of
6515 ;; `c-record-found-types' is t.
6517 c-record-type-identifiers))))
6525 ;;(message "c-forward-type %s -> %s: %s" start (point) res)
6527 res))
6530 ;; Used for Java code only at the moment. Assumes point is on the
6531 ;; @, moves forward an annotation. returns nil if there is no
6532 ;; annotation at point.
6539 t)))
6542 ;; Pull the next open brace from PS (which has the form of paren-state),
6543 ;; skipping over any brace pairs. Returns NIL when PS is exhausted.
6551 ;; Test whether we are in a C++ member initializer list, and if so, go back
6552 ;; to the introducing ":", returning the position of the opening paren of
6553 ;; the function's arglist. Otherwise return nil, leaving point unchanged.
6556 res)
6594 res))
6596 \f
6597 ;; Handling of large scale constructs like statements and declarations.
6599 ;; Macro used inside `c-forward-decl-or-cast-1'. It ought to be a
6600 ;; defsubst or perhaps even a defun, but it contains lots of free
6601 ;; variables that refer to things inside `c-forward-decl-or-cast-1'.
6603 ;; `c-forward-decl-or-cast-1' can consume an arbitrary length list
6604 ;; of types when parsing a declaration, which means that it
6605 ;; sometimes consumes the identifier in the declaration as a type.
6606 ;; This is used to "backtrack" and make the last type be treated as
6607 ;; an identifier instead.
6610 ;; These identifiers are bound only in the inner let.
6612 identifier-start type-start
6613 got-parens nil
6614 got-identifier t
6615 got-suffix t
6616 got-suffix-after-parens id-start
6620 t
6621 backup-at-type))
6623 id-start backup-id-start)
6625 id-start start-pos))
6627 ;; When these flags already are set we've found specifiers that
6628 ;; unconditionally signal these attributes - backtracking doesn't
6629 ;; change that. So keep them set in that case.
6636 ;; This identifier is bound only in the inner let.
6640 ;; Move forward over a declaration or a cast if at the start of one.
6641 ;; The point is assumed to be at the start of some token. Nil is
6642 ;; returned if no declaration or cast is recognized, and the point
6643 ;; is clobbered in that case.
6644 ;;
6645 ;; If a declaration is parsed:
6646 ;;
6647 ;; The point is left at the first token after the first complete
6648 ;; declarator, if there is one. The return value is a cons where
6649 ;; the car is the position of the first token in the declarator. (See
6650 ;; below for the cdr.)
6651 ;; Some examples:
6652 ;;
6653 ;; void foo (int a, char *b) stuff ...
6654 ;; car ^ ^ point
6655 ;; float (*a)[], b;
6656 ;; car ^ ^ point
6657 ;; unsigned int a = c_style_initializer, b;
6658 ;; car ^ ^ point
6659 ;; unsigned int a (cplusplus_style_initializer), b;
6660 ;; car ^ ^ point (might change)
6661 ;; class Foo : public Bar {}
6662 ;; car ^ ^ point
6663 ;; class PikeClass (int a, string b) stuff ...
6664 ;; car ^ ^ point
6665 ;; enum bool;
6666 ;; car ^ ^ point
6667 ;; enum bool flag;
6668 ;; car ^ ^ point
6669 ;; void cplusplus_function (int x) throw (Bad);
6670 ;; car ^ ^ point
6671 ;; Foo::Foo (int b) : Base (b) {}
6672 ;; car ^ ^ point
6673 ;;
6674 ;; The cdr of the return value is non-nil when a
6675 ;; `c-typedef-decl-kwds' specifier is found in the declaration.
6676 ;; Specifically it is a dotted pair (A . B) where B is t when a
6677 ;; `c-typedef-kwds' ("typedef") is present, and A is t when some
6678 ;; other `c-typedef-decl-kwds' (e.g. class, struct, enum)
6679 ;; specifier is present. I.e., (some of) the declared
6680 ;; identifier(s) are types.
6681 ;;
6682 ;; If a cast is parsed:
6683 ;;
6684 ;; The point is left at the first token after the closing paren of
6685 ;; the cast. The return value is `cast'. Note that the start
6686 ;; position must be at the first token inside the cast parenthesis
6687 ;; to recognize it.
6688 ;;
6689 ;; PRECEDING-TOKEN-END is the first position after the preceding
6690 ;; token, i.e. on the other side of the syntactic ws from the point.
6691 ;; Use a value less than or equal to (point-min) if the point is at
6692 ;; the first token in (the visible part of) the buffer.
6693 ;;
6694 ;; CONTEXT is a symbol that describes the context at the point:
6695 ;; 'decl In a comma-separated declaration context (typically
6696 ;; inside a function declaration arglist).
6697 ;; '<> In an angle bracket arglist.
6698 ;; 'arglist Some other type of arglist.
6699 ;; nil Some other context or unknown context. Includes
6700 ;; within the parens of an if, for, ... construct.
6701 ;;
6702 ;; LAST-CAST-END is the first token after the closing paren of a
6703 ;; preceding cast, or nil if none is known. If
6704 ;; `c-forward-decl-or-cast-1' is used in succession, it should be
6705 ;; the position after the closest preceding call where a cast was
6706 ;; matched. In that case it's used to discover chains of casts like
6707 ;; "(a) (b) c".
6708 ;;
6709 ;; This function records identifier ranges on
6710 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6711 ;; `c-record-type-identifiers' is non-nil.
6712 ;;
6713 ;; This function might do hidden buffer changes.
6716 ;; first type, i.e. after any leading specifiers. It might
6717 ;; also point at the beginning of the preceding syntactic
6718 ;; whitespace.
6720 ;; Set to the result of `c-forward-type'.
6721 at-type
6722 ;; The position of the first token in what we currently
6723 ;; believe is the type in the declaration or cast, after any
6724 ;; specifiers and their associated clauses.
6725 type-start
6726 ;; The position of the first token in what we currently
6727 ;; believe is the declarator for the first identifier. Set
6728 ;; when the type is found, and moved forward over any
6729 ;; `c-decl-hangon-kwds' and their associated clauses that
6730 ;; occurs after the type.
6731 id-start
6732 ;; These store `at-type', `type-start' and `id-start' of the
6733 ;; identifier before the one in those variables. The previous
6734 ;; identifier might turn out to be the real type in a
6735 ;; declaration if the last one has to be the declarator in it.
6736 ;; If `backup-at-type' is nil then the other variables have
6737 ;; undefined values.
6738 backup-at-type backup-type-start backup-id-start
6739 ;; Set if we've found a specifier (apart from "typedef") that makes
6740 ;; the defined identifier(s) types.
6741 at-type-decl
6742 ;; Set if we've a "typedef" keyword.
6743 at-typedef
6744 ;; Set if we've found a specifier that can start a declaration
6745 ;; where there's no type.
6746 maybe-typeless
6747 ;; If a specifier is found that also can be a type prefix,
6748 ;; these flags are set instead of those above. If we need to
6749 ;; back up an identifier, they are copied to the real flag
6750 ;; variables. Thus they only take effect if we fail to
6751 ;; interpret it as a type.
6752 backup-at-type-decl backup-maybe-typeless
6753 ;; Whether we've found a declaration or a cast. We might know
6754 ;; this before we've found the type in it. It's 'ids if we've
6755 ;; found two consecutive identifiers (usually a sure sign, but
6756 ;; we should allow that in labels too), and t if we've found a
6757 ;; specifier keyword (a 100% sure sign).
6758 at-decl-or-cast
6759 ;; Set when we need to back up to parse this as a declaration
6760 ;; but not as a cast.
6761 backup-if-not-cast
6762 ;; For casts, the return position.
6763 cast-end
6764 ;; Save `c-record-type-identifiers' and
6765 ;; `c-record-ref-identifiers' since ranges are recorded
6766 ;; speculatively and should be thrown away if it turns out
6767 ;; that it isn't a declaration or cast.
6774 ;; Check for a type. Unknown symbols are treated as possible
6775 ;; types, but they could also be specifiers disguised through
6776 ;; macros like __INLINE__, so we recognize both types and known
6777 ;; specifiers after them too.
6781 ;; Look for a specifier keyword clause.
6793 ;; Found a known or possible type or a prefix of a known type.
6796 ;; Got two identifiers with nothing but whitespace
6797 ;; between them. That can only happen in declarations.
6801 ;; If the previous identifier is a found type we
6802 ;; record it as a real one; it might be some sort of
6803 ;; alias for a prefix like "unsigned".
6810 backup-type-start type-start
6811 backup-id-start id-start
6812 at-type found-type
6813 type-start start
6815 ;; The previous ambiguous specifier/type turned out
6816 ;; to be a type since we've parsed another one after
6817 ;; it, so clear these backup flags.
6818 backup-at-type-decl nil
6819 backup-maybe-typeless nil))
6823 ;; Handle known specifier keywords and
6824 ;; `c-decl-hangon-kwds' which can occur after known
6825 ;; types.
6828 ;; It's a hang-on keyword that can occur anywhere.
6832 ;; Move the identifier start position if
6833 ;; we've passed a type.
6835 ;; Otherwise treat this as a specifier and
6836 ;; move the fallback position.
6840 ;; It's an ordinary specifier so we know that
6841 ;; anything before this can't be the type.
6843 start-pos kwd-clause-end)
6846 ;; It's ambiguous whether this keyword is a
6847 ;; specifier or a type prefix, so set the backup
6848 ;; flags. (It's assumed that `c-forward-type'
6849 ;; moved further than `c-forward-keyword-clause'.)
6857 ;; This test only happens after we've scanned a type.
6858 ;; So, with valid syntax, kwd-sym can't be 'typedef.
6863 ;; Haven't matched a type so it's an unambiguous
6864 ;; specifier keyword and we know we're in a
6865 ;; declaration.
6870 ;; If the type isn't known we continue so that we'll jump
6871 ;; over all specifiers and type identifiers. The reason
6872 ;; to do this for a known type prefix is to make things
6873 ;; like "unsigned INT16" work.
6878 ;; If a known type was found, we still need to skip over any
6879 ;; hangon keyword clauses after it. Otherwise it has already
6880 ;; been done in the loop above.
6886 ;; A prefix type is itself a primitive type when it's not
6887 ;; followed by another type.
6891 ;; Got no type but set things up to continue anyway to handle
6892 ;; the various cases when a declaration doesn't start with a
6893 ;; type.
6898 ;; If it's C++ then check if the last "type" ends on the form
6899 ;; "foo::foo" or "foo::~foo", i.e. if it's the name of a
6900 ;; (con|de)structor.
6911 ;; Cheating in the handling of syntactic ws below.
6918 name))
6919 ;; It is a (con|de)structor name. In that case the
6920 ;; declaration is typeless so zap out any preceding
6921 ;; identifier(s) that we might have taken as types.
6924 backup-at-type nil
6925 id-start type-start))))))
6927 ;; Check for and step over a type decl expression after the thing
6928 ;; that is or might be a type. This can't be skipped since we
6929 ;; need the correct end position of the declarator for
6930 ;; `max-type-decl-end-*'.
6932 ;; True if there's a non-open-paren match of
6933 ;; `c-type-decl-prefix-key'.
6934 got-prefix
6935 ;; True if the declarator is surrounded by a parenthesis pair.
6936 got-parens
6937 ;; True if there is an identifier in the declarator.
6938 got-identifier
6939 ;; True if there's a non-close-paren match of
6940 ;; `c-type-decl-suffix-key'.
6941 got-suffix
6942 ;; True if there's a prefix match outside the outermost
6943 ;; paren pair that surrounds the declarator.
6944 got-prefix-before-parens
6945 ;; True if there's a suffix match outside the outermost
6946 ;; paren pair that surrounds the declarator. The value is
6947 ;; the position of the first suffix match.
6948 got-suffix-after-parens
6949 ;; True if we've parsed the type decl to a token that is
6950 ;; known to end declarations in this context.
6951 at-decl-end
6952 ;; The earlier values of `at-type' and `type-start' if we've
6953 ;; shifted the type backwards.
6954 identifier-type identifier-start
6955 ;; If `c-parse-and-markup-<>-arglists' is set we need to
6956 ;; turn it off during the name skipping below to avoid
6957 ;; getting `c-type' properties that might be bogus. That
6958 ;; can happen since we don't know if
6959 ;; `c-restricted-<>-arglists' will be correct inside the
6960 ;; arglist paren that gets entered.
6961 c-parse-and-markup-<>-arglists
6962 ;; Start of the identifier for which `got-identifier' was set.
6963 name-start)
6967 ;; Skip over type decl prefix operators. (Note similar code in
6968 ;; `c-font-lock-declarators'.)
6978 ;; If the third submatch matches in C++ then
6979 ;; we're looking at an identifier that's a
6980 ;; prefix only if it specifies a member pointer.
6985 ;; We only check for a trailing "::" and
6986 ;; let the "*" that should follow be
6987 ;; matched in the next round.
6989 ;; It turned out to be the real identifier,
6990 ;; so stop.
6991 nil))
6992 t))
7006 ;; Skip over an identifier.
7013 ;; Skip over type decl suffix operators.
7020 t)
7024 t)
7030 ;; No suffix matched. We might have matched the
7031 ;; identifier as a type and the open paren of a
7032 ;; function arglist as a type decl prefix. In that
7033 ;; case we should "backtrack": Reinterpret the last
7034 ;; type as the identifier, move out of the arglist and
7035 ;; continue searching for suffix operators.
7036 ;;
7037 ;; Do this even if there's no preceding type, to cope
7038 ;; with old style function declarations in K&R C,
7039 ;; (con|de)structors in C++ and `c-typeless-decl-kwds'
7040 ;; style declarations. That isn't applicable in an
7041 ;; arglist context, though.
7046 maybe-typeless
7047 backup-maybe-typeless
7054 t))
7061 at-type)
7062 ;; Have found no identifier but `c-typeless-decl-kwds' has
7063 ;; matched so we know we're inside a declaration. The
7064 ;; preceding type must be the identifier instead.
7068 at-decl-or-cast
7071 ;; CASE 1
7073 ;; Encountered something inside parens that isn't matched by
7074 ;; the `c-type-decl-*' regexps, so it's not a type decl
7075 ;; expression. Try to skip out to the same paren depth to
7076 ;; not confuse the cast check below.
7078 ;; If we've found a specifier keyword then it's a
7079 ;; declaration regardless.
7087 ;; Now we've collected info about various characteristics of
7088 ;; the construct we're looking at. Below follows a decision
7089 ;; tree based on that. It's ordered to check more certain
7090 ;; signs before less certain ones.
7095 ;; CASE 2
7098 ;; Got another identifier directly after the type, so it's a
7099 ;; declaration.
7105 ;; (not got-suffix-after-parens)
7107 maybe-typeless
7108 backup-maybe-typeless
7113 ;; Got a declaration of the form "foo bar (gnu);" or "bar
7114 ;; (gnu);" where we've recognized "bar" as the type and "gnu"
7115 ;; as the declarator. In this case it's however more likely
7116 ;; that "bar" is the declarator and "gnu" a function argument
7117 ;; or initializer (if `c-recognize-paren-inits' is set),
7118 ;; since the parens around "gnu" would be superfluous if it's
7119 ;; a declarator. Shift the type one step backward.
7122 ;; Found no identifier.
7127 ;; CASE 3
7129 ;; Got a plain list of identifiers. If a colon follows it's
7130 ;; a valid label, or maybe a bitfield. Otherwise the last
7131 ;; one probably is the declared identifier and we should
7132 ;; back up to the previous type, providing it isn't a cast.
7136 ;; If we've found a specifier keyword then it's a
7137 ;; declaration regardless.
7148 ;; CASE 4
7152 ;; Got a plain list of identifiers followed by some suffix.
7153 ;; If this isn't a cast then the last identifier probably is
7154 ;; the declared one and we should back up to the previous
7155 ;; type.
7159 ;; CASE 5
7161 ;; If the type is known we know that there can't be any
7162 ;; identifier somewhere else, and it's only in declarations in
7163 ;; e.g. function prototypes and in casts that the identifier may
7164 ;; be left out.
7168 ;; Only got a single identifier (parsed as a type so far).
7169 ;; CASE 6
7171 ;; Check that the identifier isn't at the start of an
7172 ;; expression.
7173 at-decl-end
7176 ;; Inside an arglist that contains declarations. If K&R
7177 ;; style declarations and parenthesis style initializers
7178 ;; aren't allowed then the single identifier must be a
7179 ;; type, else we require that it's known or found
7180 ;; (primitive types are handled above).
7185 ;; Inside a template arglist. Accept known and found
7186 ;; types; other identifiers could just as well be
7187 ;; constants in C++.
7190 ;; CASE 7
7191 ;; Can't be a valid declaration or cast, but if we've found a
7192 ;; specifier it can't be anything else either, so treat it as
7193 ;; an invalid/unfinished declaration or cast.
7201 maybe-typeless
7202 backup-maybe-typeless
7206 c-after-suffixed-type-maybe-decl-key))))))
7207 ;; Got an empty paren pair and a preceding type that probably
7208 ;; really is the identifier. Shift the type backwards to make
7209 ;; the last one the identifier. This is analogous to the
7210 ;; "backtracking" done inside the `c-type-decl-suffix-key' loop
7211 ;; above.
7212 ;;
7213 ;; Exception: In addition to the conditions in that
7214 ;; "backtracking" code, do not shift backward if we're not
7215 ;; looking at either `c-after-suffixed-type-decl-key' or "[;,]".
7216 ;; Since there's no preceding type, the shift would mean that
7217 ;; the declaration is typeless. But if the regexp doesn't match
7218 ;; then we will simply fall through in the tests below and not
7219 ;; recognize it at all, so it's better to try it as an abstract
7220 ;; declarator instead.
7223 ;; Still no identifier.
7224 ;; CASE 8
7226 ;; Require `got-prefix' together with either `got-parens' or
7227 ;; `got-suffix' to recognize it as an abstract declarator:
7228 ;; `got-parens' only is probably an empty function call.
7229 ;; `got-suffix' only can build an ordinary expression together
7230 ;; with the preceding identifier which we've taken as a type.
7231 ;; We could actually accept on `got-prefix' only, but that can
7232 ;; easily occur temporarily while writing an expression so we
7233 ;; avoid that case anyway. We could do a better job if we knew
7234 ;; the point when the fontification was invoked.
7237 ;; CASE 9
7241 got-suffix-after-parens
7243 ;; Got a type, no declarator but a paren suffix. I.e. it's a
7244 ;; normal function call after all (or perhaps a C++ style object
7245 ;; instantiation expression).
7248 ;; CASE 10
7250 ;; By now we've located the type in the declaration that we know
7251 ;; we're in.
7254 ;; CASE 11
7262 ;; Shift the type backward in the case that there's a
7263 ;; single identifier inside parens. That can only
7264 ;; occur in K&R style function declarations so it's
7265 ;; more likely that it really is a function call.
7266 ;; Therefore we only do this after
7267 ;; `c-after-suffixed-type-decl-key' has matched.
7269 got-suffix-after-parens))
7270 ;; A declaration according to `c-after-suffixed-type-decl-key'.
7273 ;; CASE 12
7276 ;; It's a declaration if a known type precedes it and it can't be a
7277 ;; function call.
7280 ;; If we get here we can't tell if this is a type decl or a normal
7281 ;; expression by looking at it alone. (That's under the assumption
7282 ;; that normal expressions always can look like type decl expressions,
7283 ;; which isn't really true but the cases where it doesn't hold are so
7284 ;; uncommon (e.g. some placements of "const" in C++) it's not worth
7285 ;; the effort to look for them.)
7287 ;;; 2008-04-16: commented out the next form, to allow the function to recognize
7288 ;;; "foo (int bar)" in CC (an implicit type (in class foo) without a semicolon)
7289 ;;; as a(n almost complete) declaration, enabling it to be fontified.
7290 ;; CASE 13
7291 ;; (unless (or at-decl-end (looking-at "=[^=]"))
7292 ;; If this is a declaration it should end here or its initializer(*)
7293 ;; should start here, so check for allowed separation tokens. Note
7294 ;; that this rule doesn't work e.g. with a K&R arglist after a
7295 ;; function header.
7296 ;;
7297 ;; *) Don't check for C++ style initializers using parens
7298 ;; since those already have been matched as suffixes.
7299 ;;
7300 ;; If `at-decl-or-cast' is then we've found some other sign that
7301 ;; it's a declaration or cast, so then it's probably an
7302 ;; invalid/unfinished one.
7303 ;; (throw 'at-decl-or-cast at-decl-or-cast))
7305 ;; Below are tests that only should be applied when we're certain to
7306 ;; not have parsed halfway through an expression.
7308 ;; CASE 14
7310 ;; The expression starts with a known type so treat it as a
7311 ;; declaration.
7314 ;; CASE 15
7316 ;; In C++ we check if the identifier is a known type, since
7317 ;; (con|de)structors use the class name as identifier.
7318 ;; We've always shifted over the identifier as a type and
7319 ;; then backed up again in this case.
7320 identifier-type
7323 ;; `at-type' probably won't be 'found for
7324 ;; destructors since the "~" is then part of the
7325 ;; type name being checked against the list of
7326 ;; known types, so do a check without that
7327 ;; operator.
7332 c-identifier-syntax-table
7336 ;; We have already parsed the type earlier,
7337 ;; so it'd be possible to cache the end
7338 ;; position instead of redoing it here, but
7339 ;; then we'd need to keep track of another
7340 ;; position everywhere.
7348 ;; CASE 16
7350 at-type
7354 ;; Got something like "foo * bar;". Since we're not inside an
7355 ;; arglist it would be a meaningless expression because the
7356 ;; result isn't used. We therefore choose to recognize it as
7357 ;; a declaration. Do not allow a suffix since it could then
7358 ;; be a function call.
7361 ;; CASE 17
7366 ;; Got something like "a (*b) (c);" or "a (b) = c;". It could
7367 ;; be an odd expression or it could be a declaration. Treat
7368 ;; it as a declaration if "a" has been used as a type
7369 ;; somewhere else (if it's a known type we won't get here).
7372 ;; CASE 18
7378 ;; Got a type followed by an abstract declarator. If `got-prefix'
7379 ;; is set it's something like "a *" without anything after it. If
7380 ;; `got-parens' or `got-suffix' is set it's "a()", "a[]", "a()[]",
7381 ;; or similar, which we accept only if the context rules out
7382 ;; expressions.
7385 ;; If we had a complete symbol table here (which rules out
7386 ;; `c-found-types') we should return t due to the disambiguation rule
7387 ;; (in at least C++) that anything that can be parsed as a declaration
7388 ;; is a declaration. Now we're being more defensive and prefer to
7389 ;; highlight things like "foo (bar);" as a declaration only if we're
7390 ;; inside an arglist that contains declarations.
7393 ;; The point is now after the type decl expression.
7396 ;; Check for a cast.
7399 c-cast-parens
7401 ;; Should be the first type/identifier in a cast paren.
7405 ;; The closing paren should follow.
7410 ;; There should be a primary expression after it.
7419 ;; Check if the expression begins with a prefix keyword.
7422 ;; Expression begins with an ambiguous operator. Treat
7423 ;; it as a cast if it's a type decl or if we've
7424 ;; recognized the type somewhere else.
7427 ;; Unless it's a keyword, it's the beginning of a primary
7428 ;; expression.
7430 ;; If `c-primary-expr-regexp' matched a nonsymbol token, check
7431 ;; that it matched a whole one so that we don't e.g. confuse
7432 ;; the operator '-' with '->'. It's ok if it matches further,
7433 ;; though, since it e.g. can match the float '.5' while the
7434 ;; operator regexp only matches '.'.
7438 ;; There should either be a cast before it or something that isn't an
7439 ;; identifier or close paren.
7447 ;; It's a symbol. Accept it only if it's one of the
7448 ;; keywords that can precede an expression (without
7449 ;; surrounding parens).
7452 ;; Check that it isn't a close paren (block close is ok,
7453 ;; though).
7455 ;; Check that it isn't a nonsymbol identifier.
7458 ;; Handle the cast.
7468 ;; We're at a declaration. Highlight the type and the following
7469 ;; declarators.
7475 ;; Make sure to propagate the `c-decl-arg-start' property to
7476 ;; the next argument if it's set in this one, to cope with
7477 ;; interactive refontification.
7481 ;; There seems no reason to exclude a token from
7482 ;; fontification just because it's "a known type that can't
7483 ;; be a name or other expression". 2013-09-18.
7484 )
7495 ;; False alarm. Restore the recorded ranges.
7497 c-record-ref-identifiers save-rec-ref-ids)
7498 nil))))
7501 ;; Assuming that point is at the beginning of a token, check if it starts a
7502 ;; label and if so move over it and return non-nil (t in default situations,
7503 ;; specific symbols (see below) for interesting situations), otherwise don't
7504 ;; move and return nil. "Label" here means "most things with a colon".
7505 ;;
7506 ;; More precisely, a "label" is regarded as one of:
7507 ;; (i) a goto target like "foo:" - returns the symbol `goto-target';
7508 ;; (ii) A case label - either the entire construct "case FOO:", or just the
7509 ;; bare "case", should the colon be missing. We return t;
7510 ;; (iii) a keyword which needs a colon, like "default:" or "private:"; We
7511 ;; return t;
7512 ;; (iv) One of QT's "extended" C++ variants of
7513 ;; "private:"/"protected:"/"public:"/"more:" looking like "public slots:".
7514 ;; Returns the symbol `qt-2kwds-colon'.
7515 ;; (v) QT's construct "signals:". Returns the symbol `qt-1kwd-colon'.
7516 ;; (vi) One of the keywords matched by `c-opt-extra-label-key' (without any
7517 ;; colon). Currently (2006-03), this applies only to Objective C's
7518 ;; keywords "@private", "@protected", and "@public". Returns t.
7519 ;;
7520 ;; One of the things which will NOT be recognized as a label is a bit-field
7521 ;; element of a struct, something like "int foo:5".
7522 ;;
7523 ;; The end of the label is taken to be just after the colon, or the end of
7524 ;; the first submatch in `c-opt-extra-label-key'. The point is directly
7525 ;; after the end on return. The terminating char gets marked with
7526 ;; `c-decl-end' to improve recognition of the following declaration or
7527 ;; statement.
7528 ;;
7529 ;; If ASSUME-MARKUP is non-nil, it's assumed that the preceding
7530 ;; label, if any, has already been marked up like that.
7531 ;;
7532 ;; If PRECEDING-TOKEN-END is given, it should be the first position
7533 ;; after the preceding token, i.e. on the other side of the
7534 ;; syntactic ws from the point. Use a value less than or equal to
7535 ;; (point-min) if the point is at the first token in (the visible
7536 ;; part of) the buffer.
7537 ;;
7538 ;; The optional LIMIT limits the forward scan for the colon.
7539 ;;
7540 ;; This function records the ranges of the label symbols on
7541 ;; `c-record-ref-identifiers' if `c-record-type-identifiers' (!) is
7542 ;; non-nil.
7543 ;;
7544 ;; This function might do hidden buffer changes.
7547 label-end
7548 qt-symbol-idx
7549 macro-start ; if we're in one.
7550 label-type
7551 kwd)
7553 ;; "case" or "default" (Doesn't apply to AWK).
7556 ;; Record only the keyword itself for fontification, since in
7557 ;; case labels the following is a constant expression and not
7558 ;; a label.
7562 ;; Find the label end.
7566 ;; Stop on chars that aren't allowed in expressions,
7567 ;; and on operator chars that would be meaningless
7568 ;; there. FIXME: This doesn't cope with ?: operators.
7576 t)
7578 ;; It's an unfinished label. We consider the keyword enough
7579 ;; to recognize it as a label, so that it gets fontified.
7580 ;; Leave the point at the end of it, but don't put any
7581 ;; `c-decl-end' marker.
7583 t))))
7585 ;; @private, @protected, @public, in Objective C, or similar.
7588 ;; For a `c-opt-extra-label-key' match, we record the whole
7589 ;; thing for fontification. That's to get the leading '@' in
7590 ;; Objective-C protection labels fontified.
7597 ;; All other cases of labels.
7600 ;; A colon label must have something before the colon.
7603 ;; Check that we're not after a token that can't precede a label.
7605 ;; Trivially succeeds when there's no preceding token.
7606 ;; Succeeds when we're at a virtual semicolon.
7615 ;; Check if we're after a label, if we're after a closing
7616 ;; paren that belong to statement, and with
7617 ;; `c-label-prefix-re'. It's done in different order
7618 ;; depending on `assume-markup' since the checks have
7619 ;; different expensiveness.
7646 ;; Might be after another label, so check it recursively.
7650 ;; Essentially the same as the
7651 ;; `c-syntactic-re-search-forward' regexp below.
7657 ;; Note: the following should work instead of the
7658 ;; narrow-to-region above. Investigate why not,
7659 ;; sometime. ACM, 2006-03-31.
7660 ;; (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+"
7661 ;; macro-start t)
7663 ;; If the caller turned on recording for us,
7664 ;; it shouldn't apply when we check the
7665 ;; preceding label.
7666 c-record-type-identifiers)
7667 ;; A label can't start at a cpp directive. Check for
7668 ;; this, since c-forward-syntactic-ws would foul up on it.
7673 ;; Point is still at the beginning of the possible label construct.
7674 ;;
7675 ;; Check that the next nonsymbol token is ":", or that we're in one
7676 ;; of QT's "slots" declarations. Allow '(' for the sake of macro
7677 ;; arguments. FIXME: Should build this regexp from the language
7678 ;; constants.
7680 ;; public: protected: private:
7690 ;; QT double keyword like "protected slots:" or goto target.
7709 'qt-1kwd-colon
7721 ;; Check that `c-nonlabel-token-key' doesn't match anywhere.
7731 t)
7734 ;; Record the identifiers in the label for fontification, unless
7735 ;; it begins with `c-label-kwds' in which case the following
7736 ;; identifiers are part of a (constant) expression that
7737 ;; shouldn't be fontified.
7749 ;; Not a label.
7751 label-type))
7754 ;; Assuming the point is at the beginning of a token, try to move
7755 ;; forward to the end of the Objective-C directive that starts
7756 ;; there. Return t if a directive was fully recognized, otherwise
7757 ;; the point is moved as far as one could be successfully parsed and
7758 ;; nil is returned.
7759 ;;
7760 ;; This function records identifier ranges on
7761 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
7762 ;; `c-record-type-identifiers' is non-nil.
7763 ;;
7764 ;; This function might do hidden buffer changes.
7767 start-char
7769 lim
7770 ;; Turn off recognition of angle bracket arglists while parsing
7771 ;; types here since the protocol reference list might then be
7772 ;; considered part of the preceding name or superclass-name.
7783 t)
7792 ;; Handle the name of the class itself.
7794 ; (c-forward-token-2) ; 2006/1/13 This doesn't move if the token's
7795 ; at EOB.
7802 ;; Look for ": superclass-name" or "( category-name )".
7813 ;; Look for a protocol reference list.
7819 t))))
7825 t)
7828 nil)))
7831 ;; Go to the first non-whitespace after the colon that starts a
7832 ;; multiple inheritance introduction. Optional LIM is the farthest
7833 ;; back we should search.
7834 ;;
7835 ;; This function might do hidden buffer changes.
7843 ;; Return nil if we aren't in a method definition, otherwise the
7844 ;; position of the initial [+-].
7845 ;;
7846 ;; This function might do hidden buffer changes.
7852 ))
7854 ;; Contributed by Kevin Ryde <user42@zip.com.au>.
7856 ;; Return non-nil if point is within a gcc \"asm\" block.
7857 ;;
7858 ;; This should be called with point inside an argument list.
7859 ;;
7860 ;; Only one level of enclosing parentheses is considered, so for
7861 ;; instance `nil' is returned when in a function call within an asm
7862 ;; operand.
7863 ;;
7864 ;; This function might do hidden buffer changes.
7876 a function.
7878 More precisely, being at the top-level means that point is either
7879 outside any enclosing block (such as a function definition), or
7880 directly inside a class, namespace or other block that contains
7881 another declaration level.
7883 If point is not at the top-level (e.g. it is inside a method
7884 definition), then nil is returned. Otherwise, if point is at a
7885 top-level not enclosed within a class definition, t is returned.
7886 Otherwise, a 2-vector is returned where the zeroth element is the
7887 buffer position of the start of the class declaration, and the first
7888 element is the buffer position of the enclosing class's opening
7889 brace.
7891 Note that this function might do hidden buffer changes. See the
7892 comment at the start of cc-engine.el for more info."
7898 ;; Return non-nil if the point is in the region after the argument
7899 ;; list of a function and its opening brace (or semicolon in case it
7900 ;; got no body). If there are K&R style argument declarations in
7901 ;; that region, the point has to be inside the first one for this
7902 ;; function to recognize it.
7903 ;;
7904 ;; If successful, the point is moved to the first token after the
7905 ;; function header (see `c-forward-decl-or-cast-1' for details) and
7906 ;; the position of the opening paren of the function arglist is
7907 ;; returned.
7908 ;;
7909 ;; The point is clobbered if not successful.
7910 ;;
7911 ;; LIM is used as bound for backward buffer searches.
7912 ;;
7913 ;; This function might do hidden buffer changes.
7926 ;; There should not be a '=' or ',' between beg and the
7927 ;; start of the declaration since that means we were in the
7928 ;; "expression part" of the declaration.
7933 ;; Check that there's an arglist paren in the
7934 ;; declaration.
7937 ;; The declarator is a paren expression, so skip past it
7938 ;; so that we don't get stuck on that instead of the
7939 ;; function arglist.
7943 ;; Don't trip up on "operator ()".
7950 ;; Return the position of the first argument declaration if point is
7951 ;; inside a K&R style argument declaration list, nil otherwise.
7952 ;; `c-recognize-knr-p' is not checked. If LIM is non-nil, it's a
7953 ;; position that bounds the backward search for the argument list.
7954 ;;
7955 ;; Point must be within a possible K&R region, e.g. just before a top-level
7956 ;; "{". It must be outside of parens and brackets. The test can return
7957 ;; false positives otherwise.
7958 ;;
7959 ;; This function might do hidden buffer changes.
7963 ;; If we're in a macro, our search range is restricted to it. Narrow to
7964 ;; the searchable range.
7968 before-lparen after-rparen
7970 ; we give up
7973 ;; Search backwards for the defun's argument list. We give up if we
7974 ;; encounter a "}" (end of a previous defun) an "=" (which can't be in
7975 ;; a knr region) or BOB.
7976 ;;
7977 ;; The criterion for a paren structure being the arg list is:
7978 ;; o - there is non-WS stuff after it but before any "{"; AND
7979 ;; o - the token after it isn't a ";" AND
7980 ;; o - it is preceded by either an identifier (the function name) or
7981 ;; a macro expansion like "DEFUN (...)"; AND
7982 ;; o - its content is a non-empty comma-separated list of identifiers
7983 ;; (an empty arg list won't have a knr region).
7984 ;;
7985 ;; The following snippet illustrates these rules:
7986 ;; int foo (bar, baz, yuk)
7987 ;; int bar [] ;
7988 ;; int (*baz) (my_type) ;
7989 ;; int (*) (void) (*yuk) (void) ;
7990 ;; {
8001 ; parens/brackets.
8005 ;; We're inside a paren. Could it be our argument list....?
8011 ;; FIXME!!! What about macros between the parens? 2007/01/20
8014 ;; It can't be the arg list if next token is ; or {
8019 ;; Is the thing preceding the list an identifier (the
8020 ;; function name), or a macro expansion?
8030 ;; Have we got a non-empty list of comma-separated
8031 ;; identifiers?
8045 ;; ...Yes. We've identified the function's argument list.
8051 ;; ...No. The current parens aren't the function's arg list.
8058 ;; skip forward over conditional at point, including any predicate
8059 ;; statements in parentheses. No error checking is performed.
8060 ;;
8061 ;; This function might do hidden buffer changes.
8063 ;; else if()
8068 ;; do, else, try, finally
8073 ;; for, if, while, switch, catch, synchronized, foreach
8077 ;; If looking at the token after a conditional then return the
8078 ;; position of its start, otherwise return nil.
8079 ;;
8080 ;; This function might do hidden buffer changes.
8091 ;; If the point is after an operator identifier that isn't handled
8092 ;; like an ordinary symbol (i.e. like "operator =" in C++) then the
8093 ;; position of the start of that identifier is returned. nil is
8094 ;; returned otherwise. The point may be anywhere in the syntactic
8095 ;; whitespace after the last token of the operator identifier.
8096 ;;
8097 ;; This function might do hidden buffer changes.
8109 ;; Assuming point is at a brace that opens a statement block of some
8110 ;; kind, move to the proper anchor point for that block. It might
8111 ;; need to be adjusted further by c-add-stmt-syntax, but the
8112 ;; position at return is suitable as start position for that
8113 ;; function.
8114 ;;
8115 ;; This function might do hidden buffer changes.
8122 ;; Assuming point is at a brace that opens the block of a top level
8123 ;; declaration of some kind, move to the proper anchor point for
8124 ;; that block.
8125 ;;
8126 ;; This function might do hidden buffer changes.
8131 ;; Search forward for the end of the "header" of the current
8132 ;; declaration. That's the position where the definition body
8133 ;; starts, or the first variable initializer, or the ending
8134 ;; semicolon. I.e. search forward for the closest following
8135 ;; (syntactically relevant) '{', '=' or ';' token. Point is left
8136 ;; _after_ the first found token, or at point-max if none is found.
8137 ;;
8138 ;; This function might do hidden buffer changes.
8143 ;; In C++ we need to take special care to handle operator
8144 ;; tokens and those pesky template brackets.
8149 ;; Handle operator identifiers, i.e. ignore any
8150 ;; operator token preceded by "operator".
8157 t
8159 nil)))))
8168 ;; Go to the beginning of the current declaration, or the beginning
8169 ;; of the previous one if already at the start of it. Point won't
8170 ;; be moved out of any surrounding paren. Return a cons cell of the
8171 ;; form (MOVE . KNR-POS). MOVE is like the return value from
8172 ;; `c-beginning-of-statement-1'. If point skipped over some K&R
8173 ;; style argument declarations (and they are to be recognized) then
8174 ;; KNR-POS is set to the start of the first such argument
8175 ;; declaration, otherwise KNR-POS is nil. If LIM is non-nil, it's a
8176 ;; position that bounds the backward search.
8177 ;;
8178 ;; NB: Cases where the declaration continues after the block, as in
8179 ;; "struct foo { ... } bar;", are currently recognized as two
8180 ;; declarations, e.g. "struct foo { ... }" and "bar;" in this case.
8181 ;;
8182 ;; This function might do hidden buffer changes.
8188 ;; `c-beginning-of-statement-1' stops at a block start, but we
8189 ;; want to continue if the block doesn't begin a top level
8190 ;; construct, i.e. if it isn't preceded by ';', '}', ':', bob,
8191 ;; or an open paren.
8193 ;; Go back one "statement" each time round the loop until we're just
8194 ;; after a ;, }, or :, or at BOB or the start of a macro or start of
8195 ;; an ObjC method. This will move over a multiple declaration whose
8196 ;; components are comma separated.
8198 ;; Must check with c-opt-method-key in ObjC mode.
8208 ;; Check that we don't move from the first thing in a
8209 ;; macro to its header.
8215 move tentative-move))
8220 ;; Handle K&R argdecls. Back up after the "statement" jumped
8221 ;; over by `c-beginning-of-statement-1', unless it was the
8222 ;; function body, in which case we're sitting on the opening
8223 ;; brace now. Then test if we're in a K&R argdecl region and
8224 ;; that we started at the other side of the first argdecl in
8225 ;; it.
8235 'previous
8237 knr-argdecl-start))
8240 ;; `c-beginning-of-statement-1' counts each brace block as a separate
8241 ;; statement, so the result will be 'previous if we've moved over any.
8242 ;; So change our result back to 'same if necessary.
8243 ;;
8244 ;; If they were brace list initializers we might not have moved over a
8245 ;; declaration boundary though, so change it to 'same if we've moved
8246 ;; past a '=' before '{', but not ';'. (This ought to be integrated
8247 ;; into `c-beginning-of-statement-1', so we avoid this extra pass which
8248 ;; potentially can search over a large amount of text.). Take special
8249 ;; pains not to get mislead by C++'s "operator=", and the like.
8252 c++-template-syntax-table
8258 ; no more, or get to one which isn't an "operator ="
8261 c-overloadable-operators-regexp
8262 c-opt-op-identifier-prefix
8277 ;; Assuming point is at the start of a declaration (as detected by
8278 ;; e.g. `c-beginning-of-decl-1'), go to the end of it. Unlike
8279 ;; `c-beginning-of-decl-1', this function handles the case when a
8280 ;; block is followed by identifiers in e.g. struct declarations in C
8281 ;; or C++. If a proper end was found then t is returned, otherwise
8282 ;; point is moved as far as possible within the current sexp and nil
8283 ;; is returned. This function doesn't handle macros; use
8284 ;; `c-end-of-macro' instead in those cases.
8285 ;;
8286 ;; This function might do hidden buffer changes.
8289 c++-template-syntax-table
8297 ;; Stopped at the ';' in a K&R argdecl section which is
8298 ;; detected using the same criteria as in
8299 ;; `c-beginning-of-decl-1'. Move to the following block
8300 ;; start.
8304 ;; Encountered a block in the declaration. Jump over it.
8315 ;; Check for `c-opt-block-decls-with-vars-key'
8316 ;; before the first paren.
8319 c-opt-block-decls-with-vars-key
8321 lim t t t)
8324 ;; Check that the first following paren is
8325 ;; the block.
8327 lim t t t)
8329 ;; The declaration doesn't have any of the
8330 ;; `c-opt-block-decls-with-vars' keywords in the
8331 ;; beginning, so it ends here at the end of the block.
8339 nil)))
8342 ;; Assuming the point is at an open brace, check if it starts a
8343 ;; block that contains another declaration level, i.e. that isn't a
8344 ;; statement block or a brace list, and if so return non-nil.
8345 ;;
8346 ;; If the check is successful, the return value is the start of the
8347 ;; keyword that tells what kind of construct it is, i.e. typically
8348 ;; what `c-decl-block-key' matched. Also, if GOTO-START is set then
8349 ;; the point will be at the start of the construct, before any
8350 ;; leading specifiers, otherwise it's at the returned position.
8351 ;;
8352 ;; The point is clobbered if the check is unsuccessful.
8353 ;;
8354 ;; CONTAINING-SEXP is the position of the open of the surrounding
8355 ;; paren, or nil if none.
8356 ;;
8357 ;; The optional LIMIT limits the backward search for the start of
8358 ;; the construct. It's assumed to be at a syntactically relevant
8359 ;; position.
8360 ;;
8361 ;; If any template arglists are found in the searched region before
8362 ;; the open brace, they get marked with paren syntax.
8363 ;;
8364 ;; This function might do hidden buffer changes.
8371 ;; Could be at the end of a template arglist.
8382 ;; Note: Can't get bogus hits inside template arglists below since they
8383 ;; have gotten paren syntax above.
8385 ;; If `goto-start' is set we begin by searching for the
8386 ;; first possible position of a leading specifier list.
8387 ;; The `c-decl-block-key' search continues from there since
8388 ;; we know it can't match earlier.
8391 open-brace t t)
8393 t)
8394 t)
8401 ;; Found a keyword that can't be a type?
8404 ;; Can be a type too, in which case it's the return type of a
8405 ;; function (under the assumption that no declaration level
8406 ;; block construct starts with a type).
8409 ;; Jumped over a type, but it could be a declaration keyword
8410 ;; followed by the declared identifier that we've jumped over
8411 ;; instead (e.g. in "class Foo {"). If it indeed is a type
8412 ;; then we should be at the declarator now, so check for a
8413 ;; valid declarator start.
8414 ;;
8415 ;; Note: This doesn't cope with the case when a declared
8416 ;; identifier is followed by e.g. '(' in a language where '('
8417 ;; also might be part of a declarator expression. Currently
8418 ;; there's no such language.
8422 ;; In Pike a list of modifiers may be followed by a brace
8423 ;; to make them apply to many identifiers. Note that the
8424 ;; match data will be empty on return in this case.
8430 ;; Use this variant to avoid yet another special regexp.
8434 t)))
8436 ;; Got a match.
8439 ;; Back up over any preceding specifiers and their clauses
8440 ;; by going forward from `first-specifier-pos', which is the
8441 ;; earliest possible position where the specifier list can
8442 ;; start.
8448 ;; Accept any plain symbol token on the ground that
8449 ;; it's a specifier masked through a macro (just
8450 ;; like `c-forward-decl-or-cast-1' skip forward over
8451 ;; such tokens).
8452 ;;
8453 ;; Could be more restrictive wrt invalid keywords,
8454 ;; but that'd only occur in invalid code so there's
8455 ;; no use spending effort on it.
8461 ;; Can't parse a declaration preamble and is still
8462 ;; before `kwd-start'. That means `first-specifier-pos'
8463 ;; was in some earlier construct. Search again.
8467 ;; Got no preamble before the block declaration keyword.
8473 kwd-start)))
8476 ;; Check if the closest containing paren sexp is a declaration
8477 ;; block, returning a 2 element vector in that case. Aref 0
8478 ;; contains the bufpos at boi of the class key line, and aref 1
8479 ;; contains the bufpos of the open brace. This function is an
8480 ;; obsolete wrapper for `c-looking-at-decl-block'.
8481 ;;
8482 ;; This function might do hidden buffer changes.
8490 nil))
8495 ;; Return the buffer position of the most enclosing decl-block brace (in the
8496 ;; sense of c-looking-at-decl-block) in the PAREN-STATE structure, or nil if
8497 ;; none was found.
8506 open-brace))
8509 ;; Return the position of the L-brace if point is inside a brace list
8510 ;; initialization of an array, etc. This is an approximate function,
8511 ;; designed for speed over accuracy. It will not find every bracelist, but
8512 ;; a non-nil result is reliable. We simply search for "= {" (naturally with
8513 ;; syntactic whitespace allowed). PAREN-STATE is the normal thing that it
8514 ;; is everywhere else.
8523 b-pos)))
8526 ;; We're at a "{". Move back to the enum-like keyword that starts this
8527 ;; declaration and return t, otherwise don't move and return nil.
8529 up-sexp-pos before-identifier)
8543 t)
8548 t)
8554 ;; return the buffer position of the beginning of the brace list
8555 ;; statement if we're inside a brace list, otherwise return nil.
8556 ;; CONTAINING-SEXP is the buffer pos of the innermost containing
8557 ;; paren. PAREN-STATE is the remainder of the state of enclosing
8558 ;; braces
8559 ;;
8560 ;; N.B.: This algorithm can potentially get confused by cpp macros
8561 ;; placed in inconvenient locations. It's a trade-off we make for
8562 ;; speed.
8563 ;;
8564 ;; This function might do hidden buffer changes.
8566 ;; This will pick up brace list declarations.
8570 ;; this will pick up array/aggregate init lists, even if they are nested.
8573 ;; Pike can have class definitions anywhere, so we must
8574 ;; check for the class key here.
8576 c-decl-block-key))
8577 bufpos braceassignp lim next-containing macro-start)
8579 containing-sexp)
8590 ;; We're in an in-expression block of some kind. Do not
8591 ;; check nesting. We deliberately set the limit to the
8592 ;; containing sexp, so that c-looking-at-inexpr-block
8593 ;; doesn't check for an identifier before it.
8595 ;; see if the open brace is preceded by = or [...] in
8596 ;; this statement, but watch out for operator=
8599 ;; Checks to do only on the first sexp before the brace.
8602 ;; In Java, an initialization brace list may follow
8603 ;; directly after "new Foo[]", so check for a "new"
8604 ;; earlier.
8610 ;; Carry on looking if this is an
8611 ;; identifier (may contain "." in Java)
8612 ;; or another "[]" sexp.
8615 ;; Checks to do on all sexps before the brace, up to the
8616 ;; beginning of the statement.
8624 ;; We've seen a =, but must check earlier tokens so
8625 ;; that it isn't something that should be ignored.
8631 ;; Check for operator =
8634 nil)
8635 ;; Check for `<opchar>= in Pike.
8638 ;; Special case for Pikes
8639 ;; `[]=, since '[' is not in
8640 ;; the punctuation class.
8643 nil)
8645 ;; make sure we're not in a C++ template
8646 ;; argument assignment
8658 ))))
8659 nil)
8666 ;; We've hit the beginning of the aggregate list.
8671 ;; Brace lists can't contain a semicolon, so we're done.
8676 ;; We've a macro whose expansion starts with the '{'.
8677 ;; Heuristically, if we have a ';' in it we've not got a
8678 ;; brace list, otherwise we have.
8685 containing-sexp nil)
8688 ;; Go up one level
8690 lim nil
8691 next-containing nil)))))
8693 bufpos))
8694 ))
8697 ;; If we're looking at the start of a pike-style list, i.e., `({Â })',
8698 ;; `([Â ])', `(<Â >)', etc., a cons of a cons of its starting and ending
8699 ;; positions and its entry in c-special-brace-lists is returned, nil
8700 ;; otherwise. The ending position is nil if the list is still open.
8701 ;; LIM is the limit for forward search. The point may either be at
8702 ;; the `(' or at the following paren character. Tries to check the
8703 ;; matching closer, but assumes it's correct if no balanced paren is
8704 ;; found (i.e. the case `({ ... } ... )' is detected as _not_ being
8705 ;; a special brace list).
8706 ;;
8707 ;; This function might do hidden buffer changes.
8712 inner-beg end type)
8727 nil)))))
8737 ;; Check balancing of the inner paren
8738 ;; below.
8741 t)
8742 ;; If the inner char isn't a paren then
8743 ;; we can't check balancing, so just
8744 ;; check the char before the outer
8745 ;; closing paren.
8760 ;; Return non-nil if between two statements or declarations, assuming
8761 ;; point is not inside a literal or comment.
8762 ;;
8763 ;; Obsolete - `c-at-statement-start-p' or `c-at-expression-start-p'
8764 ;; are recommended instead.
8765 ;;
8766 ;; This function might do hidden buffer changes.
8771 ;; Return non-nil if we're looking at the beginning of a block
8772 ;; inside an expression. The value returned is actually a cons of
8773 ;; either 'inlambda, 'inexpr-statement or 'inexpr-class and the
8774 ;; position of the beginning of the construct.
8775 ;;
8776 ;; LIM limits the backward search. CONTAINING-SEXP is the start
8777 ;; position of the closest containing list. If it's nil, the
8778 ;; containing paren isn't used to decide whether we're inside an
8779 ;; expression or not. If both LIM and CONTAINING-SEXP are used, LIM
8780 ;; needs to be farther back.
8781 ;;
8782 ;; If CHECK-AT-END is non-nil then extra checks at the end of the
8783 ;; brace block might be done. It should only be used when the
8784 ;; construct can be assumed to be complete, i.e. when the original
8785 ;; starting position was further down than that.
8786 ;;
8787 ;; This function might do hidden buffer changes.
8792 ;; Look at the character after point only as a last resort
8793 ;; when we can't disambiguate.
8813 ;; If the class definition is at the start of
8814 ;; a statement, we don't consider it an
8815 ;; in-expression class.
8823 ;; Also, in Pike we treat it as an
8824 ;; in-expression class if it's used in an
8825 ;; object clone expression.
8841 nil)
8849 ;; Accept several square bracket sexps for
8850 ;; Java array initializations.
8858 block-follows
8859 containing-sexp
8868 nil
8871 res))))
8874 ;; Returns non-nil if we're looking at the end of an in-expression
8875 ;; block, otherwise the same as `c-looking-at-inexpr-block'.
8876 ;; PAREN-STATE is the paren state relevant at the current position.
8877 ;;
8878 ;; This function might do hidden buffer changes.
8880 ;; We currently only recognize a block.
8883 containing-sexp)
8892 paren-state)
8893 containing-sexp)))))
8896 ;; Is there a "virtual semicolon" at POS or point?
8897 ;; (See cc-defs.el for full details of "virtual semicolons".)
8898 ;;
8899 ;; This is true when point is at the last non syntactic WS position on the
8900 ;; line, there is a macro call last on the line, and this particular macro's
8901 ;; name is defined by the regexp `c-vs-macro-regexp' as not needing a
8902 ;; semicolon.
8910 c-macro-with-semi-re
8913 ;; Check we've got nothing after this except comments and empty lines
8914 ;; joined by escaped EOLs.
8927 nil)
8935 ;; Check for one of the listed macros being before point.
8939 t))
8947 \f
8948 ;; `c-guess-basic-syntax' and the functions that precedes it below
8949 ;; implements the main decision tree for determining the syntactic
8950 ;; analysis of the current line of code.
8952 ;; Dynamically bound to t when `c-guess-basic-syntax' is called during
8953 ;; auto newline analysis.
8957 ;; BRACEPOS is the position of a brace in a construct like "namespace
8958 ;; Bar {". Return the anchor point in this construct; this is the
8959 ;; earliest symbol on the brace's line which isn't earlier than
8960 ;; "namespace".
8961 ;;
8962 ;; Currently (2007-08-17), "like namespace" means "matches
8963 ;; c-other-block-decl-kwds". It doesn't work with "class" or "struct"
8964 ;; or anything like that.
8974 ;; A simple function to prepend a new syntax element to
8975 ;; `c-syntactic-context'. Using `setq' on it is unsafe since it
8976 ;; should always be dynamically bound but since we read it first
8977 ;; we'll fail properly anyway if this function is misused.
8979 c-syntactic-context)))
8982 ;; Like `c-add-syntax' but appends to the end of the syntax list.
8983 ;; (Normally not necessary.)
8988 syntax-extra-args
8989 stop-at-boi-only
8990 containing-sexp
8991 paren-state)
8992 ;; Add the indicated SYNTAX-SYMBOL to `c-syntactic-context', extending it as
8993 ;; needed with further syntax elements of the types `substatement',
8994 ;; `inexpr-statement', `arglist-cont-nonempty', `statement-block-intro', and
8995 ;; `defun-block-intro'.
8996 ;;
8997 ;; Do the generic processing to anchor the given syntax symbol on
8998 ;; the preceding statement: Skip over any labels and containing
8999 ;; statements on the same line, and then search backward until we
9000 ;; find a statement or block start that begins at boi without a
9001 ;; label or comment.
9002 ;;
9003 ;; Point is assumed to be at the prospective anchor point for the
9004 ;; given SYNTAX-SYMBOL. More syntax entries are added if we need to
9005 ;; skip past open parens and containing statements. Most of the added
9006 ;; syntax elements will get the same anchor point - the exception is
9007 ;; for an anchor in a construct like "namespace"[*] - this is as early
9008 ;; as possible in the construct but on the same line as the {.
9009 ;;
9010 ;; [*] i.e. with a keyword matching c-other-block-decl-kwds.
9011 ;;
9012 ;; SYNTAX-EXTRA-ARGS are a list of the extra arguments for the
9013 ;; syntax symbol. They are appended after the anchor point.
9014 ;;
9015 ;; If STOP-AT-BOI-ONLY is nil, we can stop in the middle of the line
9016 ;; if the current statement starts there.
9017 ;;
9018 ;; Note: It's not a problem if PAREN-STATE "overshoots"
9019 ;; CONTAINING-SEXP, i.e. contains info about parens further down.
9020 ;;
9021 ;; This function might do hidden buffer changes.
9024 ;; This is by far the most common case, so let's give it special
9025 ;; treatment.
9030 ;; Set when we're on a label, so that we don't stop there.
9031 ;; FIXME: To be complete we should check if we're on a label
9032 ;; now at the start.
9033 on-label)
9035 ;; Use point as the anchor point for "namespace", "extern", etc.
9039 syntax-extra-args)
9041 ;; Loop while we have to back out of containing blocks.
9046 ;; Loop while we have to back up statements.
9048 on-label
9051 ;; Skip past any comments that stands between the
9052 ;; statement start and boi.
9060 ;; Skip to the beginning of this statement or backward
9061 ;; another one.
9069 ;; If we didn't move we're at the start of a block and
9070 ;; have to continue outside it.
9079 ;; Special case to avoid deeper and deeper indentation
9080 ;; of "else if" clauses.
9081 )
9086 ;; If stop-at-boi-only is nil, we shouldn't back up
9087 ;; over previous or containing statements to try to
9088 ;; reach boi, so go back to the last position and
9089 ;; exit.
9096 ;; If we've moved into another statement then we
9097 ;; should no longer try to stop in the middle of a
9098 ;; line.
9101 ;; Record this as a substatement if we skipped up one
9102 ;; level.
9105 )))
9107 containing-sexp)
9109 ;; Now we have to go out of this block.
9112 ;; Don't stop in the middle of a special brace list opener
9113 ;; like "({".
9125 ;; Analyze the construct in front of the block we've stepped out
9126 ;; from and add the right syntactic element for it.
9129 step-type)
9132 ;; Stepped out of a parenthesis block, so we're in an
9133 ;; expression now.
9145 ;; Stepped out of an in-expression statement. This
9146 ;; syntactic element won't get an anchor pos.
9149 ;; A parenthesis normally belongs to an arglist.
9157 on-label nil))
9159 ;; Stepped out of a brace block.
9171 containing-sexp)))
9173 'defun-block-intro
9175 nil))
9179 c-other-decl-block-key-in-symbols-alist))
9186 ;; Always done if the open brace was at boi. The
9187 ;; c-beginning-of-statement-1 call above is necessary
9188 ;; anyway, to decide the type of block-intro to add.
9191 ))
9193 ;; Fill in the current point as the anchor for all the symbols
9194 ;; added above.
9203 )))
9206 containing-decl-open
9207 containing-decl-start
9208 containing-decl-kwd
9209 paren-state)
9210 ;; The inclass and class-close syntactic symbols are added in
9211 ;; several places and some work is needed to fix everything.
9212 ;; Therefore it's collected here.
9213 ;;
9214 ;; This function might do hidden buffer changes.
9219 containing-decl-open)
9221 ;; Ought to use `c-add-stmt-syntax' instead of backing up to boi
9222 ;; here, but we have to do like this for compatibility.
9232 char-after-ip
9233 beg-of-same-or-containing-stmt
9234 containing-sexp
9235 paren-state)
9236 ;; This function contains the decision tree reached through both
9237 ;; cases 18 and 10. It's a continued statement or top level
9238 ;; construct of some kind.
9239 ;;
9240 ;; This function might do hidden buffer changes.
9247 ;; (CASE A removed.)
9248 ;; CASE B: open braces for class or brace-lists
9255 ;; CASE B.1: class-open
9262 ;; CASE B.2: brace-list-open
9267 indent-point t t t)))
9268 ;; The most semantically accurate symbol here is
9269 ;; brace-list-open, but we normally report it simply as a
9270 ;; statement-cont. The reason is that one normally adjusts
9271 ;; brace-list-open for brace lists as top-level constructs,
9272 ;; and brace lists inside statements is a completely different
9273 ;; context. C.f. case 5A.3.
9276 ;; Turn off the dwim above when we're
9277 ;; analyzing the nature of the brace
9278 ;; for the auto newline feature.
9279 'brace-list-open
9281 nil nil
9282 containing-sexp paren-state))
9284 ;; CASE B.3: The body of a function declared inside a normal
9285 ;; block. Can occur e.g. in Pike and when using gcc
9286 ;; extensions, but watch out for macros followed by blocks.
9287 ;; C.f. cases E, 16F and 17G.
9293 ;; Turn off recognition of constructs that lacks a
9294 ;; type in this case, since that's more likely to be
9295 ;; a macro followed by a block.
9298 containing-sexp paren-state))
9300 ;; CASE B.4: Continued statement with block open. The most
9301 ;; accurate analysis is perhaps `statement-cont' together with
9302 ;; `block-open' but we play DWIM and use `substatement-open'
9303 ;; instead. The rationale is that this typically is a macro
9304 ;; followed by a block which makes it very similar to a
9305 ;; statement with a substatement block.
9308 containing-sexp paren-state))
9309 ))
9311 ;; CASE C: iostream insertion or extraction operator
9315 ;; If there is no preceding streamop in the statement
9316 ;; then indent this line as a normal statement-cont.
9320 t))))
9322 ;; CASE E: In the "K&R region" of a function declared inside a
9323 ;; normal block. C.f. case B.3.
9325 ;; Check that the next token is a '{'. This works as
9326 ;; long as no language that allows nested function
9327 ;; definitions allows stuff like member init lists, K&R
9328 ;; declarations or throws clauses there.
9329 ;;
9330 ;; Note that we do a forward search for something ahead
9331 ;; of the indentation line here. That's not good since
9332 ;; the user might not have typed it yet. Unfortunately
9333 ;; it's exceedingly tricky to recognize a function
9334 ;; prototype in a code block without resorting to this.
9342 ;; Turn off recognition of constructs that lacks a
9343 ;; type in this case, since that's more likely to be
9344 ;; a macro followed by a block.
9347 containing-sexp paren-state))
9349 ;;CASE F: continued statement and the only preceding items are
9350 ;;annotations.
9358 t)
9365 ;; CASE G: a template list continuation?
9366 ;; Mostly a duplication of case 5D.3 to fix templates-19:
9384 ;; In a nested template arglist.
9390 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
9391 ;; template aware.
9394 ;; CASE D: continued statement.
9398 containing-sexp paren-state))
9399 )))
9401 ;; The next autoload was added by RMS on 2005/8/9 - don't know why (ACM,
9402 ;; 2005/11/29).
9403 ;;;###autoload
9405 "Return the syntactic context of the current line."
9411 open-paren-in-column-0-is-defun-start
9412 ;; A whole ugly bunch of various temporary variables. Have
9413 ;; to declare them here since it's not possible to declare
9414 ;; a variable with only the scope of a cond test and the
9415 ;; following result clauses, and most of this function is a
9416 ;; single gigantic cond. :P
9417 literal char-before-ip before-ws-ip char-after-ip macro-start
9418 in-macro-expr c-syntactic-context placeholder c-in-literal-cache
9419 step-type tmpsymbol keyword injava-inher special-brace-list tmp-pos
9420 containing-<
9421 ;; The following record some positions for the containing
9422 ;; declaration block if we're directly within one:
9423 ;; `containing-decl-open' is the position of the open
9424 ;; brace. `containing-decl-start' is the start of the
9425 ;; declaration. `containing-decl-kwd' is the keyword
9426 ;; symbol of the keyword that tells what kind of block it
9427 ;; is.
9428 containing-decl-open
9429 containing-decl-start
9430 containing-decl-kwd
9431 ;; The open paren of the closest surrounding sexp or nil if
9432 ;; there is none.
9433 containing-sexp
9434 ;; The position after the closest preceding brace sexp
9435 ;; (nested sexps are ignored), or the position after
9436 ;; `containing-sexp' if there is none, or (point-min) if
9437 ;; `containing-sexp' is nil.
9438 lim
9439 ;; The paren state outside `containing-sexp', or at
9440 ;; `indent-point' if `containing-sexp' is nil.
9442 ;; There's always at most one syntactic element which got
9443 ;; an anchor pos. It's stored in syntactic-relpos.
9444 syntactic-relpos
9447 ;; Check if we're directly inside an enclosing declaration
9448 ;; level block.
9457 containing-sexp)
9458 t)))
9461 containing-sexp nil)
9466 ;; Init some position variables.
9475 ;; Ignore balanced paren. The next entry
9476 ;; can't be another one.
9479 ;; If there is no surrounding open paren then
9480 ;; put the last balanced pair back on paren-state.
9482 containing-sexp nil)))
9486 ;; If we're in a parenthesis list then ',' delimits the
9487 ;; "statements" rather than being an operator (with the
9488 ;; exception of the "for" clause). This difference is
9489 ;; typically only noticeable when statements are used in macro
9490 ;; arglists.
9494 ;; cache char before and after indent point, and move point to
9495 ;; the most likely position to perform the majority of tests
9504 ;; are we in a literal?
9507 ;; now figure out syntactic qualities of the current line
9510 ;; CASE 1: in a string.
9514 ;; CASE 2: in a C or C++ style comment.
9516 ;; This is a kludge for XEmacs where we use
9517 ;; `buffer-syntactic-context', which doesn't correctly
9518 ;; recognize "\*/" to end a block comment.
9519 ;; `parse-partial-sexp' which is used by
9520 ;; `c-literal-limits' will however do that in most
9521 ;; versions, which results in that we get nil from
9522 ;; `c-literal-limits' even when `c-in-literal' claims
9523 ;; we're inside a comment.
9527 ;; CASE 3: in a cpp preprocessor macro continuation.
9537 ;; If at the beginning of the body of a #define
9538 ;; directive then analyze as cpp-define-intro
9539 ;; only. Go on with the syntactic analysis
9540 ;; otherwise. in-macro-expr is set if we're in a
9541 ;; cpp expression, i.e. before the #define body
9542 ;; or anywhere in a non-#define directive.
9549 nil)))))
9553 ;; CASE 11: an else clause?
9557 containing-sexp paren-state))
9559 ;; CASE 12: while closure of a do/while construct?
9567 containing-sexp paren-state))
9569 ;; CASE 13: A catch or finally clause? This case is simpler
9570 ;; than if-else and do-while, because a block is required
9571 ;; after every try, catch and finally.
9579 t)
9583 t)
9586 t))
9591 containing-sexp paren-state))
9593 ;; CASE 18: A substatement we can recognize by keyword.
9603 ;; Ought to cache the result from the
9604 ;; c-beginning-of-statement-1 calls here.
9614 ;; Step up to the containing statement if we
9615 ;; stayed in the same one.
9623 ;; There was no containing statement after all.
9625 placeholder))
9627 ;; Require a parenthesis after these keywords.
9628 ;; Necessary to catch e.g. synchronized in Java,
9629 ;; which can be used both as statement and
9630 ;; modifier.
9636 ;; CASE 18A: Simple substatement.
9642 containing-sexp paren-state))
9648 containing-sexp paren-state))
9651 containing-sexp paren-state))))
9653 ;; CASE 18B: Some other substatement. This is shared
9654 ;; with case 10.
9656 char-after-ip
9657 placeholder
9658 lim
9659 paren-state)))
9661 ;; CASE 14: A case or default label
9667 containing-sexp))
9670 ;; Got a bogus label at the top level. In lack of better
9671 ;; alternatives, anchor it on (point-min).
9674 ;; CASE 15: any other label
9681 containing-decl-open
9682 containing-decl-start
9683 containing-decl-kwd
9684 paren-state))
9685 ;; Append access-label with the same anchor point as
9686 ;; inclass gets.
9692 containing-sexp))
9697 ;; If the surrounding statement is a switch then
9698 ;; let's analyze all labels as switch labels, so
9699 ;; that they get lined up consistently.
9700 'case-label
9706 ;; A label on the top level. Treat it as a class
9707 ;; context. (point-min) is the closest we get to the
9708 ;; class open brace.
9711 ;; CASE 4: In-expression statement. C.f. cases 7B, 16A and
9712 ;; 17E.
9715 containing-sexp
9716 ;; Have to turn on the heuristics after
9717 ;; the point even though it doesn't work
9718 ;; very well. C.f. test case class-16.pike.
9719 t))
9724 ;; It's a statement block or an anonymous class.
9726 ;; It's a Pike lambda. Check whether we are between the
9727 ;; lambda keyword and the argument list or at the defun
9728 ;; opener.
9730 'inline-open
9736 paren-state)
9740 ;; CASE 5: Line is inside a declaration level block or at top level.
9744 ;; CASE 5A: we are looking at a defun, brace list, class,
9745 ;; or inline-inclass method opening brace
9752 ;; CASE 5A.1: Non-class declaration block open.
9767 ;; Special case for extern-lang-open.
9768 'extern-lang-open
9770 nil t containing-sexp paren-state))
9772 ;; CASE 5A.2: we are looking at a class opening brace
9781 ;; CASE 5A.3: brace list open
9806 ))))
9810 ;; We're in Java and have found that the open brace
9811 ;; belongs to a "new Foo[]" initialization list,
9812 ;; which means the brace list is part of an
9813 ;; expression and not a top level definition. We
9814 ;; therefore treat it as any topmost continuation
9815 ;; even though the semantically correct symbol still
9816 ;; is brace-list-open, on the same grounds as in
9817 ;; case B.2.
9823 ;; CASE 5A.4: inline defun open
9829 containing-decl-open
9830 containing-decl-start
9831 containing-decl-kwd
9832 paren-state))
9834 ;; CASE 5A.5: ordinary defun open
9842 ;; Bogus to use bol here, but it's the legacy. (Resolved,
9843 ;; 2007-11-09)
9844 ))))
9846 ;; CASE 5R: Member init list. (Used to be part of CASE 5B.1)
9847 ;; Note there is no limit on the backward search here, since member
9848 ;; init lists can, in practice, be very large.
9854 ;; There is no preceding member init clause.
9855 ;; Indent relative to the beginning of indentation
9856 ;; for the topmost-intro line that contains the
9857 ;; prototype's open paren.
9860 ;; Indent relative to the first member init clause.
9865 ;; CASE 5B: After a function header but before the body (or
9866 ;; the ending semicolon if there's no body).
9873 ;; CASE 5B.1: Member init list.
9875 ;; There is no preceding member init clause.
9876 ;; Indent relative to the beginning of indentation
9877 ;; for the topmost-intro line that contains the
9878 ;; prototype's open paren.
9882 ;; CASE 5B.2: K&R arg decl intro
9889 containing-decl-open
9890 containing-decl-start
9891 containing-decl-kwd
9892 paren-state)))
9894 ;; CASE 5B.4: Nether region after a C++ or Java func
9895 ;; decl, which could include a `throws' declaration.
9899 )))
9901 ;; CASE 5C: inheritance line. could be first inheritance
9902 ;; line, or continuation of a multiple inheritance
9910 ;; watch out for scope operator
9915 )))
9924 ;; for Java
9929 cont done)
9934 done t))
9938 )
9940 injava-inher)
9943 ))
9946 ;; CASE 5C.1: non-hanging colon on an inher intro
9950 ;; don't add inclass symbol since relative point already
9951 ;; contains any class offset
9952 )
9954 ;; CASE 5C.2: hanging colon on an inher intro
9960 containing-decl-open
9961 containing-decl-start
9962 containing-decl-kwd
9963 paren-state)))
9965 ;; CASE 5C.3: in a Java implements/extends
9979 )))
9981 ;; CASE 5C.4: a continued inheritance line
9985 ;; don't add inclass symbol since relative point already
9986 ;; contains any class offset
9987 )))
9989 ;; CASE 5P: AWK pattern or function or continuation
9990 ;; thereof.
9996 'topmost-intro-cont
9998 nil nil
9999 containing-sexp paren-state))
10001 ;; CASE 5D: this could be a top-level initialization, a
10002 ;; member init list continuation, or a template argument
10003 ;; list continuation.
10005 ;; Note: We use the fact that lim is always after any
10006 ;; preceding brace sexp.
10016 t))
10021 t)
10027 nil)
10028 t))
10030 ;; NB: No c-after-special-operator-id stuff in this
10031 ;; clause - we assume only C++ needs it.
10036 ;; CASE 5D.3: perhaps a template list continuation?
10051 ;; In a nested template arglist.
10057 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
10058 ;; template aware.
10061 ;; CASE 5D.4: perhaps a multiple inheritance line?
10073 t)
10078 ;; CASE 5D.5: Continuation of the "expression part" of a
10079 ;; top level construct. Or, perhaps, an unrecognized construct.
10091 ;; A preceding comma at the top level means that a
10092 ;; new variable declaration starts here. Use
10093 ;; topmost-intro-cont for it, for consistency with
10094 ;; the first variable declaration. C.f. case 5N.
10097 nil nil containing-sexp paren-state))
10098 ))
10100 ;; CASE 5F: Close of a non-class declaration level block.
10104 ;; This is inconsistent: Should use `containing-decl-open'
10105 ;; here if it's at boi, like in case 5J.
10109 ;; Special case for compatibility with the
10110 ;; extern-lang syntactic symbols.
10111 'extern-lang-close
10114 nil t
10116 paren-state))
10118 ;; CASE 5G: we are looking at the brace which closes the
10119 ;; enclosing nested class decl
10124 containing-decl-open
10125 containing-decl-start
10126 containing-decl-kwd
10127 paren-state))
10129 ;; CASE 5H: we could be looking at subsequent knr-argdecls
10136 ;; Do an extra check to avoid tripping up on
10137 ;; statements that occur in invalid contexts
10138 ;; (e.g. in macro bodies where we don't really
10139 ;; know the context of what we're looking at).
10146 ;; CASE 5I: ObjC method definition.
10151 ;; Handle the case when it's the first (non-comment)
10152 ;; thing in the buffer. Can't look for a 'same return
10153 ;; value from cbos1 since ObjC directives currently
10154 ;; aren't recognized fully, so that we get 'same
10155 ;; instead of 'previous if it moved over a preceding
10156 ;; directive.
10160 ;; CASE 5N: At a variable declaration that follows a class
10161 ;; definition or some other block declaration that doesn't
10162 ;; end at the closing '}'. C.f. case 5D.5.
10171 ;; Speed up the backward search a bit.
10176 ;; The '}' is unbalanced.
10177 nil
10182 containing-sexp paren-state))
10184 ;; NOTE: The point is at the end of the previous token here.
10186 ;; CASE 5J: we are at the topmost level, make
10187 ;; sure we skip back past any access specifiers
10189 ;; A macro continuation line is never at top level.
10211 nil)))))
10212 ;; For historic reasons we anchor at bol of the last
10213 ;; line of the previous declaration. That's clearly
10214 ;; highly bogus and useless, and it makes our lives hard
10215 ;; to remain compatible. :P
10226 ;; Special case for compatibility with the
10227 ;; extern-lang syntactic symbols.
10228 'inextern-lang
10231 nil t
10233 paren-state))
10235 containing-decl-open
10236 containing-decl-start
10237 containing-decl-kwd
10238 paren-state)))
10240 macro-start
10245 ;; CASE 5K: we are at an ObjC method definition
10246 ;; continuation line.
10255 ;; CASE 5L: we are at the first argument of a template
10256 ;; arglist that begins on the previous line.
10264 ;; CASE 5Q: we are at a statement within a macro.
10269 ;;CASE 5N: We are at a topmost continuation line and the only
10270 ;;preceding items are annotations.
10277 t)
10283 ;; CASE 5M: we are at a topmost continuation line
10294 ))
10297 ;; (CASE 6 has been removed.)
10299 ;; CASE 7: line is an expression, not a statement. Most
10300 ;; likely we are either in a function prototype or a function
10301 ;; call argument list
10309 ;; CASE 7A: we are looking at the arglist closing paren.
10310 ;; C.f. case 7F.
10322 paren-state))
10324 ;; CASE 7B: Looking at the opening brace of an
10325 ;; in-expression block or brace list. C.f. cases 4, 16A
10326 ;; and 17E.
10330 paren-state))
10334 placeholder
10337 paren-state)
10338 containing-sexp)))
10339 ;; placeholder is nil if it's a block directly in
10340 ;; a function arglist. That makes us skip out of
10341 ;; this case.
10342 )))
10347 paren-state)
10351 ;; CASE 7C: we are looking at the first argument in an empty
10352 ;; argument list. Use arglist-close if we're actually
10353 ;; looking at a close paren or bracket.
10365 paren-state))
10367 ;; CASE 7D: we are inside a conditional test clause. treat
10368 ;; these things as statements
10378 ))
10380 ;; CASE 7E: maybe a continued ObjC method call. This is the
10381 ;; case when we are inside a [] bracketed exp, and what
10382 ;; precede the opening bracket is not an identifier.
10390 )))
10392 ;; CASE 7F: we are looking at an arglist continuation line,
10393 ;; but the preceding argument is on the same line as the
10394 ;; opening paren. This case includes multi-line
10395 ;; mathematical paren groupings, but we could be on a
10396 ;; for-list continuation line. C.f. case 7A.
10413 paren-state))
10415 ;; CASE 7G: we are looking at just a normal arglist
10416 ;; continuation line
10419 ))
10421 ;; CASE 8: func-local multi-inheritance line
10431 ;; CASE 8A: non-hanging colon on an inher intro
10436 ;; CASE 8B: hanging colon on an inher intro
10440 ;; CASE 8C: a continued inheritance line
10444 )))
10446 ;; CASE 9: we are inside a brace-list
10456 ;; CASE 9A: In the middle of a special brace list opener.
10476 ;; CASE 9B: brace-list-close brace
10478 ;; Check special brace list closer.
10485 ;; We were between the special close char and the `)'.
10488 ;; We were before the special close char.
10492 ;; Normal brace list check.
10503 ;; Prepare for the rest of the cases below by going to the
10504 ;; token following the opening brace
10517 ;; CASE 9C: we're looking at the first line in a brace-list
10528 ;; CASE 9D: this is just a later brace-list-entry or
10529 ;; brace-entry-open
10538 ))
10539 ))))
10541 ;; CASE 10: A continued statement or top level construct.
10551 ;; This is shared with case 18.
10553 char-after-ip
10554 placeholder
10555 containing-sexp
10556 paren-state))
10558 ;; CASE 16: block close brace, possibly closing the defun or
10559 ;; the class
10561 ;; From here on we have the next containing sexp in lim.
10566 ;; CASE 16E: Closing a statement block? This catches
10567 ;; cases where it's preceded by a statement keyword,
10568 ;; which works even when used in an "invalid" context,
10569 ;; e.g. a macro argument.
10574 ;; CASE 16A: closing a lambda defun or an in-expression
10575 ;; block? C.f. cases 4, 7B and 17E.
10578 nil))
10580 'inline-close
10590 paren-state)
10594 ;; CASE 16B: does this close an inline or a function in
10595 ;; a non-class declaration level block?
10602 nil))
10612 ;; CASE 16F: Can be a defun-close of a function declared
10613 ;; in a statement block, e.g. in Pike or when using gcc
10614 ;; extensions, but watch out for macros followed by
10615 ;; blocks. Let it through to be handled below.
10616 ;; C.f. cases B.3 and 17G.
10622 ;; Turn off recognition of constructs that
10623 ;; lacks a type in this case, since that's more
10624 ;; likely to be a macro followed by a block.
10631 ;; CASE 16C: If there is an enclosing brace then this is
10632 ;; a block close since defun closes inside declaration
10633 ;; level blocks have been handled above.
10635 ;; If the block is preceded by a case/switch label on
10636 ;; the same line, we anchor at the first preceding label
10637 ;; at boi. The default handling in c-add-stmt-syntax
10638 ;; really fixes it better, but we do like this to keep
10639 ;; the indentation compatible with version 5.28 and
10640 ;; earlier. C.f. case 17H.
10647 ;; c-backward-to-block-anchor not necessary here; those
10648 ;; situations are handled in case 16E above.
10651 ;; CASE 16D: Only top level defun close left.
10657 paren-state))
10658 ))
10660 ;; CASE 19: line is an expression, not a statement, and is directly
10661 ;; contained by a template delimiter. Most likely, we are in a
10662 ;; template arglist within a statement. This case is based on CASE
10663 ;; 7. At some point in the future, we may wish to create more
10664 ;; syntactic symbols such as `template-intro',
10665 ;; `template-cont-nonempty', etc., and distinguish between them as we
10666 ;; do for `arglist-intro' etc. (2009-12-07).
10672 ; '<') before indent-point.
10680 paren-state))
10682 ;; CASE 17: Statement or defun catchall.
10685 ;; Back up statements until we find one that starts at boi.
10688 containing-sexp)))
10692 nil)
10697 ;; CASE 17B: continued statement
10701 containing-sexp paren-state))
10703 ;; CASE 17A: After a case/default label?
10711 'statement-case-open
10713 nil t containing-sexp paren-state))
10715 ;; CASE 17D: any old statement
10722 containing-sexp paren-state)
10726 ;; CASE 17I: Inside a substatement block.
10728 ;; The following tests are all based on containing-sexp.
10730 ;; From here on we have the next containing sexp in lim.
10735 lim paren-state)
10739 ;; CASE 17E: first statement in an in-expression block.
10740 ;; C.f. cases 4, 7B and 16A.
10743 nil))
10745 'defun-block-intro
10754 paren-state)
10760 ;; CASE 17F: first statement in an inline, or first
10761 ;; statement in a top-level defun. we can tell this is it
10762 ;; if there are no enclosing braces that haven't been
10763 ;; narrowed out by a class (i.e. don't use bod here).
10766 paren-state)))
10772 nil))))
10777 ;; CASE 17G: First statement in a function declared inside
10778 ;; a normal block. This can occur in Pike and with
10779 ;; e.g. the gcc extensions, but watch out for macros
10780 ;; followed by blocks. C.f. cases B.3 and 16F.
10786 ;; Turn off recognition of constructs that lacks
10787 ;; a type in this case, since that's more likely
10788 ;; to be a macro followed by a block.
10794 lim paren-state))
10796 ;; CASE 17H: First statement in a block.
10798 ;; If the block is preceded by a case/switch label on the
10799 ;; same line, we anchor at the first preceding label at
10800 ;; boi. The default handling in c-add-stmt-syntax is
10801 ;; really fixes it better, but we do like this to keep the
10802 ;; indentation compatible with version 5.28 and earlier.
10803 ;; C.f. case 16C.
10810 ;; c-backward-to-block-anchor not necessary here; those
10811 ;; situations are handled in case 17I above.
10813 lim paren-state))
10816 ))
10817 )
10819 ;; now we need to look at any modifiers
10823 ;; are we looking at a comment only line?
10828 ;; we might want to give additional offset to friends (in C++).
10833 ;; Set syntactic-relpos.
10839 nil)
10840 t))
10843 ;; Start of or a continuation of a preprocessor directive?
10858 ;; If inside a cpp expression, i.e. anywhere in a
10859 ;; cpp directive except a #define body, we only let
10860 ;; through the syntactic analysis that is internal
10861 ;; in the expression. That means the arglist
10862 ;; elements, if they are anchored inside the cpp
10863 ;; expression.
10872 ;; Inside a #define body and the syntactic analysis is
10873 ;; anchored on the start of the #define. In this case
10874 ;; we add cpp-define-intro to get the extra
10875 ;; indentation of the #define body.
10878 ;; return the syntax
10879 c-syntactic-context)))
10881 \f
10882 ;; Indentation calculation.
10885 ;; offset can be a number, a function, a variable, a list, or one of
10886 ;; the symbols + or -
10887 ;;
10888 ;; This function might do hidden buffer changes.
10907 langelem symbol))
10913 offset symbol)
10914 nil)
10928 Error evaluating offset %S for %s: \
10929 Cannot combine absolute offset %S with relative %S in `%s' method"
10935 Error evaluating offset %S for %s: \
10936 Cannot combine relative offset %S with absolute %S in `%s' method"
10941 res))
10959 Error evaluating offset %S for %s: \
10960 Cannot combine absolute offsets %S and %S in `add' method"
10964 res))
10973 res))))
10980 nil))))
10984 res
10986 offset symbol res)
10987 nil)))
10990 ;; Get offset from LANGELEM which is a list beginning with the
10991 ;; syntactic symbol and followed by any analysis data it provides.
10992 ;; That data may be zero or more elements, but if at least one is
10993 ;; given then the first is the anchor position (or nil). The symbol
10994 ;; is matched against `c-offsets-alist' and the offset calculated
10995 ;; from that is returned.
10996 ;;
10997 ;; This function might do hidden buffer changes.
11007 offset
11011 ))
11014 ;; This is a compatibility wrapper for `c-calc-offset' in case
11015 ;; someone is calling it directly. It takes an old style syntactic
11016 ;; element on the form (SYMBOL . ANCHOR-POS) and converts it to the
11017 ;; new list form.
11018 ;;
11019 ;; This function might do hidden buffer changes.
11026 ;; Calculate the syntactic indentation from a syntactic description
11027 ;; as returned by `c-guess-syntax'.
11028 ;;
11029 ;; Note that topmost-intro always has an anchor position at bol, for
11030 ;; historical reasons. It's often used together with other symbols
11031 ;; that has more sane positions. Since we always use the first
11032 ;; found anchor position, we rely on that these other symbols always
11033 ;; precede topmost-intro in the LANGELEMS list.
11034 ;;
11035 ;; This function might do hidden buffer changes.
11043 ;; Got an absolute column that overrides any indentation
11044 ;; we've collected so far, but not the relative
11045 ;; indentation we might get for the nested structures
11046 ;; further down the langelems list.
11050 ;; Got a relative change of the current calculated
11051 ;; indentation.
11054 ;; Use the anchor position from the first syntactic
11055 ;; element with one.
11065 indent)))
11067 \f
11070 ;;; cc-engine.el ends here