| blob | 6ffa67f59c10d034912cc87b8fa51ed403ef8133 |
1 ;;; cc-engine.el --- core syntax guessing engine for CC mode
3 ;; Copyright (C) 1985, 1987, 1992-2013 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 ;; Silence the compiler.
153 \f
154 ;; Make declarations for all the `c-lang-defvar' variables in cc-langs.
167 \f
168 ;;; Internal state variables.
170 ;; Internal state of hungry delete key feature
174 ;; The electric flag (toggled by `c-toggle-electric-state').
175 ;; If t, electric actions (like automatic reindentation, and (if
176 ;; c-auto-newline is also set) auto newlining) will happen when an electric
177 ;; key like `{' is pressed (or an electric keyword like `else').
181 ;; Internal state of auto newline feature.
185 ;; Included in the mode line to indicate the active submodes.
186 ;; (defvar c-submode-indicators nil)
187 ;; (make-variable-buffer-local 'c-submode-indicators)
190 ;; Calculate the new state of PREVSTATE, t or nil, based on arg. If
191 ;; arg is nil or zero, toggle the state. If arg is negative, turn
192 ;; the state off, and if arg is positive, turn the state on
198 \f
199 ;; Basic handling of preprocessor directives.
201 ;; This is a dynamically bound cache used together with
202 ;; `c-query-macro-start' and `c-query-and-set-macro-start'. It only
203 ;; works as long as point doesn't cross a macro boundary.
212 c-macro-start))
220 c-macro-start))
222 ;; One element macro cache to cope with continual movement within very large
223 ;; CPP macros.
226 ;; Nil or cons of the bounds of the most recent CPP form probed by
227 ;; `c-beginning-of-macro', `c-end-of-macro' or `c-syntactic-end-of-macro'.
228 ;; The cdr will be nil if we know only the start of the CPP form.
231 ;; The starting position from where we determined `c-macro-cache'.
234 ;; non-nil iff `c-macro-cache' has both elements set AND the cdr is at a
235 ;; syntactic end of macro, not merely an apparent one.
238 ;; Called from a before-change function. If the change region is before or
239 ;; in the macro characterized by `c-macro-cache' etc., nullify it
240 ;; appropriately. BEG and END are the standard before-change-functions
241 ;; parameters. END isn't used.
246 c-macro-cache-start-pos nil
247 c-macro-cache-syntactic nil))
252 c-macro-cache-syntactic nil))))
255 "Go to the beginning of a preprocessor directive.
256 Leave point at the beginning of the directive and return t if in one,
257 otherwise return nil and leave point unchanged.
259 Note that this function might do hidden buffer changes. See the
260 comment at the start of cc-engine.el for more info."
272 t))
274 c-macro-cache-start-pos nil
275 c-macro-cache-syntactic nil)
287 c-macro-cache-start-pos here)
288 t)
290 nil))))))
293 "Go to the end of a preprocessor directive.
294 More accurately, move the point to the end of the closest following
295 line that doesn't end with a line continuation backslash - no check is
296 done that the point is inside a cpp directive to begin with.
298 Note that this function might do hidden buffer changes. See the
299 comment at the start of cc-engine.el for more info."
308 c-macro-cache-start-pos nil
309 c-macro-cache-syntactic nil))
315 t)))
320 ;; Go to the end of a CPP directive, or a "safe" pos just before.
321 ;;
322 ;; This is normally the end of the next non-escaped line. A "safe"
323 ;; position is one not within a string or comment. (The EOL on a line
324 ;; comment is NOT "safe").
325 ;;
326 ;; This function must only be called from the beginning of a CPP construct.
327 ;;
328 ;; Note that this function might do hidden buffer changes. See the comment
329 ;; at the start of cc-engine.el for more info.
332 s)
344 ;; Assuming point is at the "#" that introduces a preprocessor
345 ;; directive, it's moved forward to the end of the identifier which is
346 ;; "#define"d (or whatever c-opt-cpp-macro-define specifies). Non-nil
347 ;; is returned in this case, in all other cases nil is returned and
348 ;; point isn't moved.
349 ;;
350 ;; This function might do hidden buffer changes.
356 ;; Assuming point is at the "#" that introduces a preprocessor
357 ;; directive, it's moved forward to the start of the definition body
358 ;; if it's a "#define" (or whatever c-opt-cpp-macro-define
359 ;; specifies). Non-nil is returned in this case, in all other cases
360 ;; nil is returned and point isn't moved.
361 ;;
362 ;; This function might do hidden buffer changes.
368 \f
369 ;;; Basic utility functions.
372 ;; Return the given region as a string where all syntactic
373 ;; whitespace is removed or, where necessary, replaced with a single
374 ;; space. If PAREN-LEVEL is given then all parens in the region are
375 ;; collapsed to "()", "[]" etc.
376 ;;
377 ;; This function might do hidden buffer changes.
421 ;; Shift the indentation of the current line with the specified
422 ;; amount (positive inwards). The buffer is modified only if
423 ;; SHIFT-AMT isn't equal to zero.
426 tmp-char-inserted)
428 nil
429 ;; If we're on an empty line inside a macro, we take the point
430 ;; to be at the current indentation and shift it to the
431 ;; appropriate column. This way we don't treat the extra
432 ;; whitespace out to the line continuation as indentation.
448 ;; If initial point was within line's indentation and we're not on
449 ;; a line with a line continuation in a macro, position after the
450 ;; indentation. Else stay at same point in text.
458 ;; Return non-nil if the string KEYWORD is a known keyword. More
459 ;; precisely, the value is the symbol for the keyword in
460 ;; `c-keywords-obarray'.
464 ;; Return non-nil if the symbol KEYWORD-SYM, as returned by
465 ;; `c-keyword-sym', is a member of LANG-CONSTANT, which is the name
466 ;; of a language constant that ends with "-kwds". If KEYWORD-SYM is
467 ;; nil then the result is nil.
470 ;; String syntax chars, suitable for skip-syntax-(forward|backward).
475 ;; Regexp matching string limit syntax.
480 ;; Regexp matching WS followed by string limit syntax.
484 ;; Holds formatted error strings for the few cases where parse errors
485 ;; are reported.
492 c-parsing-error)
494 ;; Faces given to comments and string literals. This is used in some
495 ;; situations to speed up recognition; it isn't mandatory that font
496 ;; locking is in use. This variable is extended with the face in
497 ;; `c-doc-face-name' when fontification is activated in cc-fonts.el.
501 ;; New in Emacs 22.
505 ;; Put a c-type property with the given value at POS.
509 ;; Remove all occurrences of the c-type property that has the given
510 ;; value in the region between FROM and TO. VALUE is assumed to not
511 ;; be nil.
512 ;;
513 ;; Note: This assumes that c-type is put on single chars only; it's
514 ;; very inefficient if matching properties cover large regions.
523 \f
524 ;; Some debug tools to visualize various special positions. This
525 ;; debug code isn't as portable as the rest of CC Mode.
561 \f
562 ;; `c-beginning-of-statement-1' and accompanying stuff.
564 ;; KLUDGE ALERT: c-maybe-labelp is used to pass information between
565 ;; c-crosses-statement-barrier-p and c-beginning-of-statement-1. A
566 ;; better way should be implemented, but this will at least shut up
567 ;; the byte compiler.
570 ;; New awk-compatible version of c-beginning-of-statement-1, ACM 2002/6/22
572 ;; Macros used internally in c-beginning-of-statement-1 for the
573 ;; automaton actions.
576 stack)))
581 t
582 ,do-if-done
587 ;; Throw nil if stack is empty, else throw non-nil.
611 noerror comma-delim)
612 "Move to the start of the current statement or declaration, or to
613 the previous one if already at the beginning of one. Only
614 statements/declarations on the same level are considered, i.e. don't
615 move into or out of sexps (not even normal expression parentheses).
617 If point is already at the earliest statement within braces or parens,
618 this function doesn't move back into any whitespace preceding it; it
619 returns 'same in this case.
623 is within the continuation. If starting at such a token, move to the
624 corresponding statement start. If at the beginning of a statement,
625 move to the closest containing statement if there is any. This might
626 also stop at a continuation clause.
628 Labels are treated as part of the following statements if
629 IGNORE-LABELS is non-nil. (FIXME: Doesn't work if we stop at a known
630 statement start keyword.) Otherwise, each label is treated as a
631 separate statement.
633 Macros are ignored \(i.e. skipped over) unless point is within one, in
634 which case the content of the macro is treated as normal code. Aside
635 from any normal statement starts found in it, stop at the first token
638 macros before leaving them.
640 Return:
642 'same if stopped at the beginning of the current statement;
643 'up if stepped to a containing statement;
644 'previous if stepped to a preceding statement;
645 'beginning if stepped from a statement continuation clause to
646 its start clause; or
647 'macro if stepped to a macro start.
648 Note that 'same and not 'label is returned if stopped at the same
649 label without crossing the colon character.
651 LIM may be given to limit the search. If the search hits the limit,
652 point will be left at the closest following token, or at the start
653 position if that is less ('same is returned in this case).
655 NOERROR turns off error logging to `c-parsing-error'.
657 Normally only ';' and virtual semicolons are considered to delimit
658 statements, but if COMMA-DELIM is non-nil then ',' is treated
659 as a delimiter too.
661 Note that this function might do hidden buffer changes. See the
662 comment at the start of cc-engine.el for more info."
664 ;; The bulk of this function is a pushdown automaton that looks at statement
665 ;; boundaries and the tokens (such as "while") in c-opt-block-stmt-key. Its
666 ;; purpose is to keep track of nested statements, ensuring that such
667 ;; statements are skipped over in their entirety (somewhat akin to what C-M-p
668 ;; does with nested braces/brackets/parentheses).
669 ;;
670 ;; Note: The position of a boundary is the following token.
671 ;;
672 ;; Beginning with the current token (the one following point), move back one
673 ;; sexp at a time (where a sexp is, more or less, either a token or the
674 ;; entire contents of a brace/bracket/paren pair). Each time a statement
675 ;; boundary is crossed or a "while"-like token is found, update the state of
676 ;; the PDA. Stop at the beginning of a statement when the stack (holding
677 ;; nested statement info) is empty and the position has been moved.
678 ;;
679 ;; The following variables constitute the PDA:
680 ;;
681 ;; sym: This is either the "while"-like token (e.g. 'for) we've just
682 ;; scanned back over, 'boundary if we've just gone back over a
683 ;; statement boundary, or nil otherwise.
684 ;; state: takes one of the values (nil else else-boundary while
685 ;; while-boundary catch catch-boundary).
686 ;; nil means "no "while"-like token yet scanned".
687 ;; 'else, for example, means "just gone back over an else".
688 ;; 'else-boundary means "just gone back over a statement boundary
689 ;; immediately after having gone back over an else".
690 ;; saved-pos: A vector of either saved positions (tok ptok pptok, etc.) or
691 ;; of error reporting information.
692 ;; stack: The stack onto which the PDA pushes its state. Each entry
693 ;; consists of a saved value of state and saved-pos. An entry is
694 ;; pushed when we move back over a "continuation" token (e.g. else)
695 ;; and popped when we encounter the corresponding opening token
696 ;; (e.g. if).
697 ;;
698 ;;
699 ;; The following diagram briefly outlines the PDA.
700 ;;
701 ;; Common state:
702 ;; "else": Push state, goto state `else'.
703 ;; "while": Push state, goto state `while'.
704 ;; "catch" or "finally": Push state, goto state `catch'.
705 ;; boundary: Pop state.
706 ;; other: Do nothing special.
707 ;;
708 ;; State `else':
709 ;; boundary: Goto state `else-boundary'.
710 ;; other: Error, pop state, retry token.
711 ;;
712 ;; State `else-boundary':
713 ;; "if": Pop state.
714 ;; boundary: Error, pop state.
715 ;; other: See common state.
716 ;;
717 ;; State `while':
718 ;; boundary: Save position, goto state `while-boundary'.
719 ;; other: Pop state, retry token.
720 ;;
721 ;; State `while-boundary':
722 ;; "do": Pop state.
723 ;; boundary: Restore position if it's not at start, pop state. [*see below]
724 ;; other: See common state.
725 ;;
726 ;; State `catch':
727 ;; boundary: Goto state `catch-boundary'.
728 ;; other: Error, pop state, retry token.
729 ;;
730 ;; State `catch-boundary':
731 ;; "try": Pop state.
732 ;; "catch": Goto state `catch'.
733 ;; boundary: Error, pop state.
734 ;; other: See common state.
735 ;;
736 ;; [*] In the `while-boundary' state, we had pushed a 'while state, and were
737 ;; searching for a "do" which would have opened a do-while. If we didn't
738 ;; find it, we discard the analysis done since the "while", go back to this
739 ;; token in the buffer and restart the scanning there, this time WITHOUT
740 ;; pushing the 'while state onto the stack.
741 ;;
742 ;; In addition to the above there is some special handling of labels
743 ;; and macros.
747 macro-start
750 c-stmt-delim-chars-with-comma
751 c-stmt-delim-chars))
752 c-in-literal-cache c-maybe-labelp after-case:-pos saved
753 ;; Current position.
754 pos
755 ;; Position of last stmt boundary character (e.g. ;).
756 boundary-pos
757 ;; The position of the last sexp or bound that follows the
758 ;; first found colon, i.e. the start of the nonlabel part of
759 ;; the statement. It's `start' if a colon is found just after
760 ;; the start.
761 after-labels-pos
762 ;; Like `after-labels-pos', but the first such position inside
763 ;; a label, i.e. the start of the last label before the start
764 ;; of the nonlabel part of the statement.
765 last-label-pos
766 ;; The last position where a label is possible provided the
767 ;; statement started there. It's nil as long as no invalid
768 ;; label content has been found (according to
769 ;; `c-nonlabel-token-key'). It's `start' if no valid label
770 ;; content was found in the label. Note that we might still
771 ;; regard it a label if it starts with `c-label-kwds'.
772 label-good-pos
773 ;; Putative positions of the components of a bitfield declaration,
774 ;; e.g. "int foo : NUM_FOO_BITS ;"
775 bitfield-type-pos bitfield-id-pos bitfield-size-pos
776 ;; Symbol just scanned back over (e.g. 'while or 'boundary).
777 ;; See above.
778 sym
779 ;; Current state in the automaton. See above.
780 state
781 ;; Current saved positions. See above.
782 saved-pos
783 ;; Stack of conses (state . saved-pos).
784 stack
785 ;; Regexp which matches "for", "if", etc.
788 ;; Return value.
790 ;; Positions of the last three sexps or bounds we've stopped at.
791 tok ptok pptok)
801 ;; Try to skip back over unary operator characters, to register
802 ;; that we've moved.
806 ;; Protect post-++/-- operators just before a virtual semicolon.
810 ;; Skip back over any semicolon here. If it was a bare semicolon, we're
811 ;; done. Later on we ignore the boundaries for statements that don't
812 ;; contain any sexp. The only thing that is affected is that the error
813 ;; checking is a little less strict, and we really don't bother.
823 pos saved)
825 ;; Begin at start and not pos to detect macros if we stand
826 ;; directly after the #.
829 ;; Record this as the first token if not starting inside it.
833 ;; The following while loop goes back one sexp (balanced parens,
834 ;; etc. with contents, or symbol or suchlike) each iteration. This
835 ;; movement is accomplished with a call to c-backward-sexp approx 170
836 ;; lines below.
837 ;;
838 ;; The loop is exited only by throwing nil to the (catch 'loop ...):
839 ;; 1. On reaching the start of a macro;
840 ;; 2. On having passed a stmt boundary with the PDA stack empty;
841 ;; 3. On reaching the start of an Objective C method def;
842 ;; 4. From macro `c-bos-pop-state'; when the stack is empty;
843 ;; 5. From macro `c-bos-pop-state-and-retry' when the stack is empty.
847 ;; Are we in a macro, just after the opening #?
862 ;; Stop at the first token in the content of the macro.
866 ret 'macro
867 ignore-labels t))
870 ;; Do a round through the automaton if we've just passed a
871 ;; statement boundary or passed a "while"-like token.
879 ;; The PDA state handling.
880 ;;
881 ;; Refer to the description of the PDA in the opening
882 ;; comments. In the following OR form, the first leaf
883 ;; attempts to handles one of the specific actions detailed
884 ;; (e.g., finding token "if" whilst in state `else-boundary').
885 ;; We drop through to the second leaf (which handles common
886 ;; state) if no specific handler is found in the first cond.
887 ;; If a parsing error is detected (e.g. an "else" with no
888 ;; preceding "if"), we throw to the enclosing catch.
889 ;;
890 ;; Note that the (eq state 'else) means
891 ;; "we've just passed an else", NOT "we're looking for an
892 ;; else".
909 ;; Since this can cause backtracking we do a
910 ;; little more careful analysis to avoid it:
911 ;; If there's a label in front of the while
912 ;; it can't be part of a do-while.
941 ;; This is state common. We get here when the previous
942 ;; cond statement found no particular state handler.
944 ;; If we have a boundary at the start
945 ;; position we push a frame to go to the
946 ;; previous statement.
955 ;; Is this a real while, or a do-while?
956 ;; The next `when' triggers unless we are SURE that
957 ;; the `while' is not the tail end of a `do-while'.
960 ;; The following kludge is to prevent
961 ;; infinite recursion when called from
962 ;; c-awk-after-if-for-while-condition-p,
963 ;; or the like.
967 ;; Since this can cause backtracking we do a
968 ;; little more careful analysis to avoid it: If
969 ;; the while isn't followed by a (possibly
970 ;; virtual) semicolon it can't be a do-while.
979 ;; We're either past a statement boundary or at the
980 ;; start of a statement, so throw away any label data
981 ;; for the previous one.
983 last-label-pos nil
984 c-maybe-labelp nil))))
986 ;; Step to the previous sexp, but not if we crossed a
987 ;; boundary, since that doesn't consume an sexp.
991 ;; HERE IS THE SINGLE PLACE INSIDE THE PDA LOOP WHERE WE MOVE
992 ;; BACKWARDS THROUGH THE SOURCE.
996 ;; The end position of the area to search for statement
997 ;; barriers in this round.
1000 ;; Go back over exactly one logical sexp, taking proper
1001 ;; account of macros and escaped EOLs.
1005 ;; Give up if we hit an unbalanced block. Since the
1006 ;; stack won't be empty the code below will report a
1007 ;; suitable error.
1010 ;; Have we moved into a macro?
1013 ;; Have we crossed a statement boundary? If not,
1014 ;; keep going back until we find one or a "real" sexp.
1021 ;; Have we just gone back over an escaped NL? This
1022 ;; doesn't count as a sexp.
1025 ;; Have we crossed a statement boundary?
1028 ;; Are we at a macro beginning?
1030 c-opt-cpp-prefix
1036 ;; Just gone back over a brace block?
1042 ;; Just gone back over some paren block?
1046 before-sws-pos)))
1049 ;; Just gone back over an ordinary symbol of some sort?
1055 ptok tok
1056 tok boundary-pos
1058 ;; Like a C "continue". Analyze the next sexp.
1061 ;; ObjC method def?
1068 ;; Might we have a bitfield declaration, "<type> <id> : <size>"?
1071 ;; The : <size> and <id> fields?
1081 ;; The <type> field?
1089 bitfield-id-pos nil)))))
1091 ;; Handle labels.
1094 ;; `c-crosses-statement-barrier-p' has found a colon, so we
1095 ;; might be in a label now. Have we got a real label
1096 ;; (including a case label) or something like C++'s "public:"?
1097 ;; A case label might use an expression rather than a token.
1100 ;; Catch C++'s inheritance construct "class foo : bar".
1114 ; been found.
1116 ;; We're in a potential label and it's the first
1117 ;; time we've found something that isn't allowed in
1118 ;; one.
1121 ;; We've moved back by a sexp, so update the token positions.
1123 pptok ptok
1124 ptok tok
1130 ;; If the stack isn't empty there might be errors to report.
1139 ;; Need to investigate closer whether we've crossed
1140 ;; between a substatement and its containing statement.
1142 ptok
1143 pptok))
1150 after-labels-pos
1157 last-label-pos
1158 pos))
1160 ;; We're in a label. Maybe we should step to the statement
1161 ;; after it.
1166 ;; Might have jumped over several labels. Go to the last one.
1169 ;; Have we got "case <expression>:"?
1179 ;; Skip over the unary operators that can start the statement.
1182 ;; protect AWK post-inc/decrement operators, etc.
1187 ret)))
1190 "Return non-nil if there is a non-comment non-macro punctuation character
1191 between FROM and TO. FROM must not be in a string or comment. The returned
1192 value is the position of the first such character."
1203 "Return non-nil if buffer positions FROM to TO cross one or more
1204 statement or declaration boundaries. The returned value is actually
1205 the position of the earliest boundary char. FROM must not be within
1206 a string or comment.
1208 The variable `c-maybe-labelp' is set to the position of the first `:' that
1209 might start a label (i.e. not part of `::' and not preceded by `?'). If a
1210 single `?' is found, then `c-maybe-labelp' is cleared.
1212 For AWK, a statement which is terminated by an EOL (not a \; or a }) is
1214 the line. If this virtual semicolon is _at_ from, the function recognizes it.
1216 Note that this function might do hidden buffer changes. See the
1217 comment at the start of cc-engine.el for more info."
1219 ;; If the current language has CPP macros, insert # into skip-chars.
1222 c-opt-cpp-symbol ; usually "#"
1224 c-stmt-delim-chars))
1227 lit-range vsemi-pos)
1234 skip-chars
1238 ;; Virtual semicolon?
1248 ;; In a string/comment?
1255 ;; Ignore scope operators.
1259 ;; A question mark. Can't be a label, so stop
1260 ;; looking for more : and ?.
1263 ;; At a CPP construct?
1271 ;; In trailing space after an as yet undetected virtual semicolon?
1276 nil))))))
1279 "Return non-nil if the point is at the first token in a statement
1280 or somewhere in the syntactic whitespace before it.
1283 Any kind of declaration-like construct that occur outside function
1286 Note that this function might do hidden buffer changes. See the
1287 comment at the start of cc-engine.el for more info."
1291 c-maybe-labelp)
1302 "Return non-nil if the point is at the first token in an expression or
1303 statement, or somewhere in the syntactic whitespace before it.
1306 grammar sense: It's any sequence of expression tokens except commas,
1307 unless they are enclosed inside parentheses of some kind. Also, an
1308 expression never continues past an enclosing parenthesis, but it might
1309 contain parenthesis pairs of any sort except braces.
1311 Since expressions never cross statement boundaries, this function also
1312 recognizes statement beginnings, just like `c-at-statement-start-p'.
1314 Note that this function might do hidden buffer changes. See the
1315 comment at the start of cc-engine.el for more info."
1320 c-maybe-labelp)
1328 \f
1329 ;; A set of functions that covers various idiosyncrasies in
1330 ;; implementations of `forward-comment'.
1332 ;; Note: Some emacsen considers incorrectly that any line comment
1333 ;; ending with a backslash continues to the next line. I can't think
1334 ;; of any way to work around that in a reliable way without changing
1335 ;; the buffer, though. Suggestions welcome. ;) (No, temporarily
1336 ;; changing the syntax for backslash doesn't work since we must treat
1337 ;; escapes in string literals correctly.)
1340 "Move forward past whitespace and the closest following comment, if any.
1341 Return t if a comment was found, nil otherwise. In either case, the
1342 point is moved past the following whitespace. Line continuations,
1343 i.e. a backslashes followed by line breaks, are treated as whitespace.
1344 The line breaks that end line comments are considered to be the
1345 comment enders, so the point will be put on the beginning of the next
1346 line if it moved past a line comment.
1348 This function does not do any hidden buffer changes."
1356 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1357 ;; forwards at eob.
1358 nil
1360 ;; Emacs includes the ending newline in a b-style (c++)
1361 ;; comment, but XEmacs doesn't. We depend on the Emacs
1362 ;; behavior (which also is symmetric).
1366 t))))
1369 "Move forward past all following whitespace and comments.
1370 Line continuations, i.e. a backslashes followed by line breaks, are
1371 treated as whitespace.
1373 Note that this function might do hidden buffer changes. See the
1374 comment at the start of cc-engine.el for more info."
1377 ;; If forward-comment in at least XEmacs 21 is given a large
1378 ;; positive value, it'll loop all the way through if it hits
1379 ;; eob.
1381 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1382 ;; forwards at eob.
1387 t))))
1390 "Move backward past whitespace and the closest preceding comment, if any.
1391 Return t if a comment was found, nil otherwise. In either case, the
1392 point is moved past the preceding whitespace. Line continuations,
1393 i.e. a backslashes followed by line breaks, are treated as whitespace.
1394 The line breaks that end line comments are considered to be the
1395 comment enders, so the point cannot be at the end of the same line to
1396 move over a line comment.
1398 This function does not do any hidden buffer changes."
1401 ;; When we got newline terminated comments, forward-comment in all
1402 ;; supported emacsen so far will stop at eol of each line not
1403 ;; ending with a comment when moving backwards. This corrects for
1404 ;; that, and at the same time handles line continuations.
1412 ;; Some emacsen (e.g. Emacs 19.34) return t when moving
1413 ;; backwards at bob.
1414 nil
1416 ;; Leave point after the closest following newline if we've
1417 ;; backed up over any above, since forward-comment won't move
1418 ;; backward over a line comment if point is at the end of the
1419 ;; same line.
1424 ;; If forward-comment above succeeded and we're at eol
1425 ;; then the newline we moved over above didn't end a
1426 ;; line comment, so we give it another go.
1429 t))
1431 ;; Emacs <= 20 and XEmacs move back over the closer of a
1432 ;; block comment that lacks an opener.
1435 t)))))
1438 "Move backward past all preceding whitespace and comments.
1439 Line continuations, i.e. a backslashes followed by line breaks, are
1440 treated as whitespace. The line breaks that end line comments are
1441 considered to be the comment enders, so the point cannot be at the end
1442 of the same line to move over a line comment. Unlike
1443 c-backward-syntactic-ws, this function doesn't move back over
1444 preprocessor directives.
1446 Note that this function might do hidden buffer changes. See the
1447 comment at the start of cc-engine.el for more info."
1451 ;; `forward-comment' in some emacsen (e.g. XEmacs 21.4)
1452 ;; return t when moving backwards at bob.
1458 ;; Cope specifically with ^M^J here -
1459 ;; forward-comment sometimes gets stuck after ^Ms,
1460 ;; sometimes after ^M^J.
1464 t)
1468 t))))
1469 moved-comment)
1471 ;; Emacs <= 20 and XEmacs move back over the
1472 ;; closer of a block comment that lacks an opener.
1474 t)
1476 ;; XEmacs treats line continuations as whitespace but
1477 ;; only in the backward direction, which seems a bit
1478 ;; odd. Anyway, this is necessary for Emacs.
1483 t))))))
1485 \f
1486 ;; Tools for skipping over syntactic whitespace.
1488 ;; The following functions use text properties to cache searches over
1489 ;; large regions of syntactic whitespace. It works as follows:
1490 ;;
1491 ;; o If a syntactic whitespace region contains anything but simple
1492 ;; whitespace (i.e. space, tab and line breaks), the text property
1493 ;; `c-in-sws' is put over it. At places where we have stopped
1494 ;; within that region there's also a `c-is-sws' text property.
1495 ;; That since there typically are nested whitespace inside that
1496 ;; must be handled separately, e.g. whitespace inside a comment or
1497 ;; cpp directive. Thus, from one point with `c-is-sws' it's safe
1498 ;; to jump to another point with that property within the same
1499 ;; `c-in-sws' region. It can be likened to a ladder where
1500 ;; `c-in-sws' marks the bars and `c-is-sws' the rungs.
1501 ;;
1502 ;; o The `c-is-sws' property is put on the simple whitespace chars at
1503 ;; a "rung position" and also maybe on the first following char.
1504 ;; As many characters as can be conveniently found in this range
1505 ;; are marked, but no assumption can be made that the whole range
1506 ;; is marked (it could be clobbered by later changes, for
1507 ;; instance).
1508 ;;
1509 ;; Note that some part of the beginning of a sequence of simple
1510 ;; whitespace might be part of the end of a preceding line comment
1511 ;; or cpp directive and must not be considered part of the "rung".
1512 ;; Such whitespace is some amount of horizontal whitespace followed
1513 ;; by a newline. In the case of cpp directives it could also be
1514 ;; two newlines with horizontal whitespace between them.
1515 ;;
1516 ;; The reason to include the first following char is to cope with
1517 ;; "rung positions" that doesn't have any ordinary whitespace. If
1518 ;; `c-is-sws' is put on a token character it does not have
1519 ;; `c-in-sws' set simultaneously. That's the only case when that
1520 ;; can occur, and the reason for not extending the `c-in-sws'
1521 ;; region to cover it is that the `c-in-sws' region could then be
1522 ;; accidentally merged with a following one if the token is only
1523 ;; one character long.
1524 ;;
1525 ;; o On buffer changes the `c-in-sws' and `c-is-sws' properties are
1526 ;; removed in the changed region. If the change was inside
1527 ;; syntactic whitespace that means that the "ladder" is broken, but
1528 ;; a later call to `c-forward-sws' or `c-backward-sws' will use the
1529 ;; parts on either side and use an ordinary search only to "repair"
1530 ;; the gap.
1531 ;;
1532 ;; Special care needs to be taken if a region is removed: If there
1533 ;; are `c-in-sws' on both sides of it which do not connect inside
1534 ;; the region then they can't be joined. If e.g. a marked macro is
1535 ;; broken, syntactic whitespace inside the new text might be
1536 ;; marked. If those marks would become connected with the old
1537 ;; `c-in-sws' range around the macro then we could get a ladder
1538 ;; with one end outside the macro and the other at some whitespace
1539 ;; within it.
1540 ;;
1541 ;; The main motivation for this system is to increase the speed in
1542 ;; skipping over the large whitespace regions that can occur at the
1543 ;; top level in e.g. header files that contain a lot of comments and
1544 ;; cpp directives. For small comments inside code it's probably
1545 ;; slower than using `forward-comment' straightforwardly, but speed is
1546 ;; not a significant factor there anyway.
1548 ; (defface c-debug-is-sws-face
1549 ; '((t (:background "GreenYellow")))
1550 ; "Debug face to mark the `c-is-sws' property.")
1551 ; (defface c-debug-in-sws-face
1552 ; '((t (:underline t)))
1553 ; "Debug face to mark the `c-in-sws' property.")
1555 ; (defun c-debug-put-sws-faces ()
1556 ; ;; Put the sws debug faces on all the `c-is-sws' and `c-in-sws'
1557 ; ;; properties in the buffer.
1558 ; (interactive)
1559 ; (save-excursion
1560 ; (c-save-buffer-state (in-face)
1561 ; (goto-char (point-min))
1562 ; (setq in-face (if (get-text-property (point) 'c-is-sws)
1563 ; (point)))
1564 ; (while (progn
1565 ; (goto-char (next-single-property-change
1566 ; (point) 'c-is-sws nil (point-max)))
1567 ; (if in-face
1568 ; (progn
1569 ; (c-debug-add-face in-face (point) 'c-debug-is-sws-face)
1570 ; (setq in-face nil))
1571 ; (setq in-face (point)))
1572 ; (not (eobp))))
1573 ; (goto-char (point-min))
1574 ; (setq in-face (if (get-text-property (point) 'c-in-sws)
1575 ; (point)))
1576 ; (while (progn
1577 ; (goto-char (next-single-property-change
1578 ; (point) 'c-in-sws nil (point-max)))
1579 ; (if in-face
1580 ; (progn
1581 ; (c-debug-add-face in-face (point) 'c-debug-in-sws-face)
1582 ; (setq in-face nil))
1583 ; (setq in-face (point)))
1584 ; (not (eobp)))))))
1587 ;;`(message ,@args)
1588 )
1591 ;; This macro does a hidden buffer change.
1598 ;; This macro does a hidden buffer change.
1605 ;; This macro does a hidden buffer change.
1612 ;; This macro does a hidden buffer change.
1619 ;; This macro does a hidden buffer change.
1627 ;; Called from `after-change-functions'. Note that if
1628 ;; `c-forward-sws' or `c-backward-sws' are used outside
1629 ;; `c-save-buffer-state' or similar then this will remove the cache
1630 ;; properties right after they're added.
1631 ;;
1632 ;; This function does hidden buffer changes.
1635 ;; Adjust the end to remove the properties in any following simple
1636 ;; ws up to and including the next line break, if there is any
1637 ;; after the changed region. This is necessary e.g. when a rung
1638 ;; marked empty line is converted to a line comment by inserting
1639 ;; "//" before the line break. In that case the line break would
1640 ;; keep the rung mark which could make a later `c-backward-sws'
1641 ;; move into the line comment instead of over it.
1651 ;; Ensure that an `c-in-sws' range gets broken. Note that it isn't
1652 ;; safe to keep a range that was continuous before the change. E.g:
1653 ;;
1654 ;; #define foo
1655 ;; \
1656 ;; bar
1657 ;;
1658 ;; There can be a "ladder" between "#" and "b". Now, if the newline
1659 ;; after "foo" is removed then "bar" will become part of the cpp
1660 ;; directive instead of a syntactically relevant token. In that
1661 ;; case there's no longer syntactic ws from "#" to "b".
1668 ;; Used by `c-forward-syntactic-ws' to implement the unbounded search.
1669 ;;
1670 ;; This function might do hidden buffer changes.
1673 ;; unmarked part of the simple ws region.
1675 rung-is-marked next-rung-is-marked simple-ws-end
1676 ;; `safe-start' is set when it's safe to cache the start position.
1677 ;; It's not set if we've initially skipped over comments and line
1678 ;; continuations since we might have gone out through the end of a
1679 ;; macro then. This provision makes `c-forward-sws' not populate the
1680 ;; cache in the majority of cases, but otoh is `c-backward-sws' by far
1681 ;; more common.
1682 safe-start)
1684 ;; Skip simple ws and do a quick check on the following character to see
1685 ;; if it's anything that can't start syntactic ws, so we can bail out
1686 ;; early in the majority of cases when there just are a few ws chars.
1693 ;; Find the last rung position to avoid setting properties in all
1694 ;; the cases when the marked rung is complete.
1695 ;; (`next-single-property-change' is certain to move at least one
1696 ;; step forward.)
1699 ;; Got no marked rung here. Since the simple ws might have started
1700 ;; inside a line comment or cpp directive we must set `rung-pos' as
1701 ;; high as possible.
1711 ;; The following search is the main reason that `c-in-sws'
1712 ;; and `c-is-sws' aren't combined to one property.
1716 ;; If the `c-in-sws' region extended past the last
1717 ;; `c-is-sws' char we have to go back a bit.
1724 "c-forward-sws cached move %s -> %s (max %s)"
1731 ;; We'll loop here if there is simple ws after the last rung.
1732 ;; That means that there's been some change in it and it's
1733 ;; possible that we've stepped into another ladder, so extend
1734 ;; the previous one to join with it if there is one, and try to
1735 ;; use the cache again.
1737 "c-forward-sws extending rung with [%s..%s] (max %s)"
1740 ;; Remove any `c-in-sws' property from the last char of
1741 ;; the rung before we mark it with `c-is-sws', so that we
1742 ;; won't connect with the remains of a broken "ladder".
1748 last-put-in-sws-pos rung-pos)))
1755 ;; Skipped over comments. Don't cache at eob in case the buffer
1756 ;; is narrowed.
1767 ;; Skip a preprocessor directive.
1774 ;; Don't cache at eob in case the buffer is narrowed.
1777 ;; We've searched over a piece of non-white syntactic ws. See if this
1778 ;; can be cached.
1784 ;; Cache if we haven't skipped comments only, and if we started
1785 ;; either from a marked rung or from a completely uncached
1786 ;; position.
1791 ;; See if there's a marked rung in the encountered simple ws. If
1792 ;; so then we can cache, unless `safe-start' is nil. Even then
1793 ;; we need to do this to check if the cache can be used for the
1794 ;; next step.
1798 safe-start))
1802 "c-forward-sws caching [%s..%s] - [%s..%s] (max %s)"
1806 ;; Remove the properties for any nested ws that might be cached.
1807 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
1808 ;; anyway.
1816 last-put-in-sws-pos rung-pos))
1818 ;; Remove any `c-in-sws' property from the last char of
1819 ;; the rung before we mark it with `c-is-sws', so that we
1820 ;; won't connect with the remains of a broken "ladder".
1823 rung-end-pos))
1826 "c-forward-sws not caching [%s..%s] - [%s..%s] (max %s)"
1830 ;; Set `rung-pos' for the next rung. It's the same thing here as
1831 ;; initially, except that the rung position is set as early as
1832 ;; possible since we can't be in the ending ws of a line comment or
1833 ;; cpp directive now.
1840 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
1841 ;; another one after the point (which might occur when editing inside a
1842 ;; comment or macro).
1846 "c-forward-sws clearing at %s for cache separation"
1847 last-put-in-sws-pos)
1851 ;; If at eob we have to clear the last character before the end
1852 ;; instead since the buffer might be narrowed and there might
1853 ;; be a `c-in-sws' after (point-max). In this case it's
1854 ;; necessary to clear both properties.
1856 "c-forward-sws clearing thoroughly at %s for cache separation"
1859 last-put-in-sws-pos))))
1860 ))))
1863 ;; Used by `c-backward-syntactic-ws' to implement the unbounded search.
1864 ;;
1865 ;; This function might do hidden buffer changes.
1868 ;; part of the simple ws region.
1870 rung-is-marked simple-ws-beg cmt-skip-pos)
1872 ;; Skip simple horizontal ws and do a quick check on the preceding
1873 ;; character to see if it's anything that can't end syntactic ws, so we can
1874 ;; bail out early in the majority of cases when there just are a few ws
1875 ;; chars. Newlines are complicated in the backward direction, so we can't
1876 ;; skip over them.
1883 ;; Try to find a rung position in the simple ws preceding point, so that
1884 ;; we can get a cache hit even if the last bit of the simple ws has
1885 ;; changed recently.
1891 ;; `rung-pos' will be the earliest marked position, which means that
1892 ;; there might be later unmarked parts in the simple ws region.
1893 ;; It's not worth the effort to fix that; the last part of the
1894 ;; simple ws is also typically edited often, so it could be wasted.
1906 ;; The following search is the main reason that `c-in-sws'
1907 ;; and `c-is-sws' aren't combined to one property.
1911 ;; If the `c-in-sws' region extended past the first
1912 ;; `c-is-sws' char we have to go forward a bit.
1917 "c-backward-sws cached move %s <- %s (min %s)"
1929 t
1931 nil))
1933 ;; We'll loop here if there is simple ws before the first rung.
1934 ;; That means that there's been some change in it and it's
1935 ;; possible that we've stepped into another ladder, so extend
1936 ;; the previous one to join with it if there is one, and try to
1937 ;; use the cache again.
1939 "c-backward-sws extending rung with [%s..%s] (min %s)"
1942 ;; Remove any `c-in-sws' property from the last char of
1943 ;; the rung before we mark it with `c-is-sws', so that we
1944 ;; won't connect with the remains of a broken "ladder".
1947 rung-pos)
1951 last-put-in-sws-pos rung-pos))
1960 ;; Inside a cpp directive. See if it should be skipped over.
1963 ;; Move back over all line continuations in the region skipped
1964 ;; over by `c-backward-comments'. If we go past it then we
1965 ;; started inside the cpp directive.
1974 ;; Don't move past the cpp directive if we began inside
1975 ;; it. Note that the position at the end of the last line
1976 ;; of the macro is also considered to be within it.
1978 nil)
1980 ;; It's worthwhile to spend a little bit of effort on finding
1981 ;; the end of the macro, to get a good `simple-ws-beg'
1982 ;; position for the cache. Note that `c-backward-comments'
1983 ;; could have stepped over some comments before going into
1984 ;; the macro, and then `simple-ws-beg' must be kept on the
1985 ;; same side of those comments.
1992 ;; Might happen if comments after the macro were skipped
1993 ;; over.
1997 t)))
2002 simple-ws-beg)
2003 ;; Skipped over comments. Must put point at the end of
2004 ;; the simple ws at point since we might be after a line
2005 ;; comment or cpp directive that's been partially
2006 ;; narrowed out, and we can't risk marking the simple ws
2007 ;; at the end of it.
2009 t)))
2011 ;; We've searched over a piece of non-white syntactic ws. See if this
2012 ;; can be cached.
2017 ;; Cache if we started either from a marked rung or from a
2018 ;; completely uncached position.
2019 rung-is-marked
2022 ;; Cache if there's a marked rung in the encountered simple ws.
2030 "c-backward-sws caching [%s..%s] - [%s..%s] (min %s)"
2035 ;; Remove the properties for any nested ws that might be cached.
2036 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
2037 ;; anyway.
2042 ;; Remove any `c-in-sws' property from the last char of
2043 ;; the rung before we mark it with `c-is-sws', so that we
2044 ;; won't connect with the remains of a broken "ladder".
2047 rung-end-pos)
2050 last-put-in-sws-pos simple-ws-beg)
2051 rung-pos)
2056 "c-backward-sws not caching [%s..%s] - [%s..%s] (min %s)"
2062 ))
2064 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
2065 ;; another one before the point (which might occur when editing inside a
2066 ;; comment or macro).
2070 "c-backward-sws clearing at %s for cache separation"
2073 last-put-in-sws-pos))
2075 ;; If at bob and the buffer is narrowed, we have to clear the
2076 ;; character we're standing on instead since there might be a
2077 ;; `c-in-sws' before (point-min). In this case it's necessary
2078 ;; to clear both properties.
2080 "c-backward-sws clearing thoroughly at %s for cache separation"
2081 last-put-in-sws-pos)
2084 ))))
2086 \f
2087 ;; Other whitespace tools
2089 ;; Is the region (beg end) WS, and is there WS (or BOB/EOB) next to the
2090 ;; region? This is a "heuristic" function. .....
2091 ;;
2092 ;; The motivation for the second bit is to check whether removing this
2093 ;; region would coalesce two symbols.
2094 ;;
2095 ;; FIXME!!! This function doesn't check virtual semicolons in any way. Be
2096 ;; careful about using this function for, e.g. AWK. (2007/3/7)
2105 \f
2106 ;; A system for finding noteworthy parens before the point.
2109 ;; A maximum comfortable scanning distance, e.g. between
2110 ;; `c-state-cache-good-pos' and "HERE" (where we call c-parse-state). When
2111 ;; this distance is exceeded, we take "emergency measures", e.g. by clearing
2112 ;; the cache and starting again from point-min or a beginning of defun. This
2113 ;; value can be tuned for efficiency or set to a lower value for testing.
2117 ;; The state cache used by `c-parse-state' to cut down the amount of
2118 ;; searching. It's the result from some earlier `c-parse-state' call. See
2119 ;; `c-parse-state''s doc string for details of its structure.
2120 ;;
2121 ;; The use of the cached info is more effective if the next
2122 ;; `c-parse-state' call is on a line close by the one the cached state
2123 ;; was made at; the cache can actually slow down a little if the
2124 ;; cached state was made very far back in the buffer. The cache is
2125 ;; most effective if `c-parse-state' is used on each line while moving
2126 ;; forward.
2130 ;; This is a position where `c-state-cache' is known to be correct, or
2131 ;; nil (see below). It's a position inside one of the recorded unclosed
2132 ;; parens or the top level, but not further nested inside any literal or
2133 ;; subparen that is closed before the last recorded position.
2134 ;;
2135 ;; The exact position is chosen to try to be close to yet earlier than
2136 ;; the position where `c-state-cache' will be called next. Right now
2137 ;; the heuristic is to set it to the position after the last found
2138 ;; closing paren (of any type) before the line on which
2139 ;; `c-parse-state' was called. That is chosen primarily to work well
2140 ;; with refontification of the current line.
2141 ;;
2142 ;; 2009-07-28: When `c-state-point-min' and the last position where
2143 ;; `c-parse-state' or for which `c-invalidate-state-cache' was called, are
2144 ;; both in the same literal, there is no such "good position", and
2145 ;; c-state-cache-good-pos is then nil. This is the ONLY circumstance in which
2146 ;; it can be nil. In this case, `c-state-point-min-literal' will be non-nil.
2147 ;;
2148 ;; 2009-06-12: In a brace desert, c-state-cache-good-pos may also be in
2149 ;; the middle of the desert, as long as it is not within a brace pair
2150 ;; recorded in `c-state-cache' or a paren/bracket pair.
2153 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2154 ;; We maintain a simple cache of positions which aren't in a literal, so as to
2155 ;; speed up testing for non-literality.
2157 ;; The approximate interval between entries in `c-state-nonlit-pos-cache'.
2161 ;; A list of buffer positions which are known not to be in a literal or a cpp
2162 ;; construct. This is ordered with higher positions at the front of the list.
2163 ;; Only those which are less than `c-state-nonlit-pos-cache-limit' are valid.
2167 ;; An upper limit on valid entries in `c-state-nonlit-pos-cache'. This is
2168 ;; reduced by buffer changes, and increased by invocations of
2169 ;; `c-state-literal-at'.
2173 ;; A list of buffer positions which are known not to be in a literal. This is
2174 ;; ordered with higher positions at the front of the list. Only those which
2175 ;; are less than `c-state-semi-nonlit-pos-cache-limit' are valid.
2179 ;; An upper limit on valid entries in `c-state-semi-nonlit-pos-cache'. This is
2180 ;; reduced by buffer changes, and increased by invocations of
2181 ;; `c-state-literal-at'. FIXME!!!
2184 ;; Do a parse-partial-sexp from FROM to TO, returning either
2185 ;; (STATE TYPE (BEG . END)) if TO is in a literal; or
2186 ;; (STATE) otherwise,
2187 ;; where STATE is the parsing state at TO, TYPE is the type of the literal
2188 ;; (one of 'c, 'c++, 'string) and (BEG . END) is the boundaries of the literal.
2189 ;;
2190 ;; Only elements 3 (in a string), 4 (in a comment), 5 (following a quote),
2191 ;; 7 (comment type) and 8 (start of comment/string) (and possibly 9) of
2192 ;; STATE are valid.
2195 ty)
2202 nil ; TARGETDEPTH
2203 nil ; STOPBEFORE
2204 s ; OLDSTATE
2211 ;; Return a buffer position before HERE which is "safe", i.e. outside any
2212 ;; string, comment, or macro.
2213 ;;
2214 ;; NOTE: This function manipulates `c-state-nonlit-pos-cache'. This cache
2215 ;; MAY NOT contain any positions within macros, since macros are frequently
2216 ;; turned into comments by use of the `c-cpp-delimiter' category properties.
2217 ;; We cannot rely on this mechanism whilst determining a cache pos since
2218 ;; this function is also called from outwith `c-parse-state'.
2223 pos npos high-pos lit macro-beg macro-end)
2224 ;; Trim the cache to take account of buffer changes.
2236 ;; Add an element to `c-state-nonlit-pos-cache' each iteration.
2240 ;; Test for being in a literal. If so, go to after it.
2247 ;; Test for being in a macro. If so, go to after it.
2262 ;; Add one extra element above HERE so as to to avoid the previous
2263 ;; expensive calculation when the next call is close to the current
2264 ;; one. This is especially useful when inside a large macro.
2269 pos))))
2272 ;; Return a buffer position before HERE which is "safe", i.e. outside any
2273 ;; string or comment. It may be in a macro.
2278 pos npos high-pos lit macro-beg macro-end)
2279 ;; Trim the cache to take account of buffer changes.
2291 ;; Add an element to `c-state-semi-nonlit-pos-cache' each iteration.
2295 ;; Test for being in a literal. If so, go to after it.
2308 pos))))
2311 ;; If position HERE is inside a literal, return (START . END), the
2312 ;; boundaries of the literal (which may be outside the accessible bit of the
2313 ;; buffer). Otherwise, return nil.
2314 ;;
2315 ;; This function is almost the same as `c-literal-limits'. Previously, it
2316 ;; differed in that it was a lower level function, and that it rigorously
2317 ;; followed the syntax from BOB. `c-literal-limits' is now (2011-12)
2318 ;; virtually identical to this function.
2326 ;; Return the start of the literal containing POS, or POS itself.
2328 pos))
2331 ;; Return a position outside of a string/comment/macro at or before POS.
2332 ;; STATE is the parse-partial-sexp state at POS.
2336 pos)))
2341 res))))
2343 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2344 ;; Stuff to do with point-min, and coping with any literal there.
2347 ;; This is (point-min) when `c-state-cache' was last calculated. A change of
2348 ;; narrowing is likely to affect the parens that are visible before the point.
2354 ;; These two variables define the literal, if any, containing point-min.
2355 ;; Their values are, respectively, 'string, c, or c++, and the start of the
2356 ;; literal. If there's no literal there, they're both nil.
2360 ;; This is the earliest buffer-pos from which scanning can be done. It is
2361 ;; either the end of the literal containing point-min, or point-min itself.
2362 ;; It becomes nil if the buffer is changed earlier than this point.
2364 ;; Return the lowest valid scanning pos. This will be the end of the
2365 ;; literal enclosing point-min, or point-min itself.
2377 ;; Determine the properties of any literal containing POINT-MIN, setting the
2378 ;; variables `c-state-point-min-lit-type', `c-state-point-min-lit-start',
2379 ;; and `c-state-min-scan-pos' accordingly. The return value is meaningless.
2381 lit)
2396 c-state-point-min-lit-start nil
2397 c-state-min-scan-pos p-min)))))
2400 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2401 ;; A variable which signals a brace dessert - helpful for reducing the number
2402 ;; of fruitless backward scans.
2405 ;; Used only in `c-append-lower-brace-pair-to-state-cache'. It is set when
2406 ;; that defun has searched backwards for a brace pair and not found one. Its
2407 ;; value is either nil or a cons (PA . FROM), where PA is the position of the
2408 ;; enclosing opening paren/brace/bracket which bounds the backwards search (or
2409 ;; nil when at top level) and FROM is where the backward search started. It
2410 ;; is reset to nil in `c-invalidate-state-cache'.
2413 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2414 ;; Lowish level functions/macros which work directly on `c-state-cache', or a
2415 ;; list of like structure.
2417 ;; Return the address of the top left brace/bracket/paren recorded in CACHE
2418 ;; (default `c-state-cache') (or nil).
2425 ;; Return the address of the latest brace/bracket/paren (whether left or
2426 ;; right) recorded in CACHE (default `c-state-cache') or nil.
2433 ;; Return the position just after the latest brace/bracket/paren (whether
2434 ;; left or right) recorded in CACHE (default `c-state-cache') or nil.
2442 ;; From the state-cache, determine the buffer position from which we might
2443 ;; scan forward to HERE to update this cache. This position will be just
2444 ;; after a paren/brace/bracket recorded in the cache, if possible, otherwise
2445 ;; return the earliest position in the accessible region which isn't within
2446 ;; a literal. If the visible portion of the buffer is entirely within a
2447 ;; literal, return NIL.
2449 ;(while (>= (or (c-state-cache-top-lparen c) 1) here)
2465 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2466 ;; Variables which keep track of preprocessor constructs.
2471 ;; These are the limits of the macro containing point at the previous call of
2472 ;; `c-parse-state', or nil.
2474 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2475 ;; Defuns which analyze the buffer, yet don't change `c-state-cache'.
2477 ;; Return a start position for building `c-state-cache' from
2478 ;; scratch. This will be at the top level, 2 defuns back.
2480 ;; Go back 2 bods, but ignore any bogus positions returned by
2481 ;; beginning-of-defun (i.e. open paren in column zero).
2491 ;; Return the position of the opening paren/brace/bracket before HERE- which
2492 ;; matches the outermost close p/b/b between HERE+ and TOP. Except when
2493 ;; there's a macro, HERE- and HERE+ are the same. Like this:
2494 ;;
2495 ;; ............................................
2496 ;; | |
2497 ;; ( [ ( .........#macro.. ) ( ) ] )
2498 ;; ^ ^ ^ ^
2499 ;; | | | |
2500 ;; return HERE- HERE+ TOP
2501 ;;
2502 ;; If there aren't enough opening paren/brace/brackets, return the position
2503 ;; of the outermost one found, or HERE- if there are none. If there are no
2504 ;; closing p/b/bs between HERE+ and TOP, return HERE-. HERE-/+ and TOP
2505 ;; must not be inside literals. Only the accessible portion of the buffer
2506 ;; will be scanned.
2508 ;; PART 1: scan from `here+' up to `top', accumulating ")"s which enclose
2509 ;; `here'. Go round the next loop each time we pass over such a ")". These
2510 ;; probably match "("s before `here-'.
2522 ;; PART 2: Scan back before `here-' searching for the "("s
2523 ;; matching/mismatching the ")"s found above. We only need to direct the
2524 ;; caller to scan when we've encountered unmatched right parens.
2533 pos))
2536 ;; Determine the scanning strategy for adjusting `c-parse-state', attempting
2537 ;; to minimize the amount of scanning. HERE is the pertinent position in
2538 ;; the buffer, GOOD-POS is a position where `c-state-cache' (possibly with
2539 ;; its head trimmed) is known to be good, or nil if there is no such
2540 ;; position.
2541 ;;
2542 ;; The return value is a list, one of the following:
2543 ;;
2544 ;; o - ('forward CACHE-POS START-POINT) - scan forward from START-POINT,
2545 ;; which is not less than CACHE-POS.
2546 ;; o - ('backward CACHE-POS nil) - scan backwards (from HERE).
2547 ;; o - ('BOD nil START-POINT) - scan forwards from START-POINT, which is at the
2548 ;; top level.
2549 ;; o - ('IN-LIT nil nil) - point is inside the literal containing point-min.
2550 ;; , where CACHE-POS is the highest position recorded in `c-state-cache' at
2551 ;; or below HERE.
2553 BOD-pos ; position of 2nd BOD before HERE.
2554 strategy ; 'forward, 'backward, 'BOD, or 'IN-LIT.
2555 start-point
2561 start-point nil
2562 cache-pos nil
2574 start-point cache-pos)))
2576 ;; Might we be better off starting from the top level, two defuns back,
2577 ;; instead? This heuristic no longer works well in C++, where
2578 ;; declarations inside namespace brace blocks are frequently placed at
2579 ;; column zero.
2585 start-point BOD-pos)))
2588 strategy
2593 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2594 ;; Routines which change `c-state-cache' and associated values.
2596 ;; The region (more precisely, point-min) has changed since we
2597 ;; calculated `c-state-cache'. Amend `c-state-cache' accordingly.
2599 ;; If point-min has MOVED BACKWARDS then we drop the state completely.
2600 ;; It would be possible to do a better job here and recalculate the top
2601 ;; only.
2605 c-state-cache-good-pos c-state-min-scan-pos
2606 c-state-brace-pair-desert nil))
2608 ;; point-min has MOVED FORWARD.
2610 ;; Is the new point-min inside a (different) literal?
2615 ;; Cut off a bit of the tail from `c-state-cache'.
2617 pa)
2625 c-state-cache-good-pos c-state-min-scan-pos)
2628 )))
2633 ;; If there is a brace pair preceding FROM in the buffer, at the same level
2634 ;; of nesting (not necessarily immediately preceding), push a cons onto
2635 ;; `c-state-cache' to represent it. FROM must not be inside a literal. If
2636 ;; UPPER-LIM is non-nil, we append the highest brace pair whose "}" is below
2637 ;; UPPER-LIM.
2638 ;;
2639 ;; Return non-nil when this has been done.
2640 ;;
2641 ;; The situation it copes with is this transformation:
2642 ;;
2643 ;; OLD: { (.) {...........}
2644 ;; ^ ^
2645 ;; FROM HERE
2646 ;;
2647 ;; NEW: { {....} (.) {.........
2648 ;; ^ ^ ^
2649 ;; LOWER BRACE PAIR HERE or HERE
2650 ;;
2651 ;; This routine should be fast. Since it can get called a LOT, we maintain
2652 ;; `c-state-brace-pair-desert', a small cache of "failures", such that we
2653 ;; reduce the time wasted in repeated fruitless searches in brace deserts.
2657 new-cons
2665 ;; If we're essentially repeating a fruitless search, just give up.
2671 ;; DESERT-LIM. Avoid repeated searching through the cached desert.
2677 ;; CACHE-LIM. This limit will be necessary when an opening
2678 ;; paren at `cache-pos' has just had its matching close paren
2679 ;; inserted into the buffer. `cache-pos' continues to be a
2680 ;; search bound, even though the algorithm below would skip
2681 ;; over the new paren pair.
2692 ;; In the next pair of nested loops, the inner one moves back past a
2693 ;; pair of (mis-)matching parens or brackets; the outer one moves
2694 ;; back over a sequence of unmatched close brace/paren/bracket each
2695 ;; time round.
2709 ; brace, ignore it.
2712 ;; We've found the desired brace-pair.
2724 ;; We haven't found a brace pair. Record this in the cache.
2728 ;; If BRA+1 is nil, do nothing. Otherwise, BRA+1 is the buffer position
2729 ;; following a {, and that brace has a (mis-)matching } (or ]), and we
2730 ;; "push" "a" brace pair onto `c-state-cache'.
2731 ;;
2732 ;; Here "push" means overwrite the top element if it's itself a brace-pair,
2733 ;; otherwise push it normally.
2734 ;;
2735 ;; The brace pair we push is normally the one surrounding BRA+1, but if the
2736 ;; latter is inside a macro, not being a macro containing
2737 ;; MACRO-START-OR-HERE, we scan backwards through the buffer for a non-macro
2738 ;; base pair. This latter case is assumed to be rare.
2739 ;;
2740 ;; Note: POINT is not preserved in this routine.
2750 c-state-cache)))
2751 ;; N.B. This defsubst codes one method for the simple, normal case,
2752 ;; and a more sophisticated, slower way for the general case. Don't
2753 ;; eliminate this defsubst - it's a speed optimization.
2757 ;; Scan the buffer from FROM to (point-max), adding elements into
2758 ;; `c-state-cache' for braces etc. Return a candidate for
2759 ;; `c-state-cache-good-pos'.
2760 ;;
2761 ;; FROM must be after the latest brace/paren/bracket in `c-state-cache', if
2762 ;; any. Typically, it is immediately after it. It must not be inside a
2763 ;; literal.
2772 ; Is actually the pos. to scan for a (/{/[ from,
2773 ; which sometimes is after a silly )/}/].
2776 ; good-pos.
2782 ;; Each time round the following loop, we enter a successively deeper
2783 ;; level of brace/paren nesting. (Except sometimes we "continue at
2784 ;; the existing level".) `pa+1' is a pos inside an opening
2785 ;; brace/paren/bracket, usually just after it.
2788 ;; Each time round the next loop moves forward over an opening then
2789 ;; a closing brace/bracket/paren. This loop is white hot, so it
2790 ;; plays ugly tricks to go fast. DON'T PUT ANYTHING INTO THIS
2791 ;; LOOP WHICH ISN'T ABSOLUTELY NECESSARY!!! It terminates when a
2792 ;; call of `scan-lists' signals an error, which happens when there
2793 ;; are no more b/b/p's to scan.
2804 ;; We've just entered a deeper nesting level.
2806 ;; Insert the brace pair (if present) and the single open
2807 ;; paren/brace/bracket into `c-state-cache' It cannot be
2808 ;; inside a macro, except one around point, because of what
2809 ;; `c-neutralize-syntax-in-CPP' has done.
2811 ;; Insert the opening brace/bracket/paren position.
2813 ;; Clear admin stuff for the next more nested part of the scan.
2817 ;; All open p/b/b's at this nesting level, if any, have probably
2818 ;; been closed by matching/mismatching ones. We're probably
2819 ;; finished - we just need to check for having found an
2820 ;; unmatched )/}/], which we ignore. Such a )/}/] can't be in a
2821 ;; macro, due the action of `c-neutralize-syntax-in-CPP'.
2824 ;; Record the final, innermost, brace-pair if there is one.
2827 ;; Determine a good pos
2835 here-bol))
2844 ;; Remove stale entries from the `c-cache-state', i.e. those which will
2845 ;; not be in it when it is amended for position (point-max).
2846 ;; Additionally, the "outermost" open-brace entry before (point-max)
2847 ;; will be converted to a cons if the matching close-brace is scanned.
2848 ;;
2849 ;; GOOD-POS is a "maximal" "safe position" - there must be no open
2850 ;; parens/braces/brackets between GOOD-POS and (point-max).
2851 ;;
2852 ;; As a second thing, calculate the result of parse-partial-sexp at
2853 ;; PPS-POINT, w.r.t. GOOD-POS. The motivation here is that
2854 ;; `c-state-cache-good-pos' may become PPS-POINT, but the caller may need to
2855 ;; adjust it to get outside a string/comment. (Sorry about this! The code
2856 ;; needs to be FAST).
2857 ;;
2858 ;; Return a list (GOOD-POS SCAN-BACK-POS PPS-STATE), where
2859 ;; o - GOOD-POS is a position where the new value `c-state-cache' is known
2860 ;; to be good (we aim for this to be as high as possible);
2861 ;; o - SCAN-BACK-POS, if not nil, indicates there may be a brace pair
2862 ;; preceding POS which needs to be recorded in `c-state-cache'. It is a
2863 ;; position to scan backwards from.
2864 ;; o - PPS-STATE is the parse-partial-sexp state at PPS-POINT.
2874 ; or nil
2881 ; (point-max)), or nil.
2887 pps-state ; Will be 9 or 10 elements long.
2888 pos
2889 upper-lim ; ,beyond which `c-state-cache' entries are removed
2890 scan-back-pos
2891 pair-beg pps-point-state target-depth)
2893 ;; Remove entries beyond (point-max). Also remove any entries inside
2894 ;; a macro, unless (point-max) is in the same macro.
2903 ;; If `upper-lim' is inside the last recorded brace pair, remove its
2904 ;; RBrace and indicate we'll need to search backwards for a previous
2905 ;; brace pair.
2912 ;; The next loop jumps forward out of a nested level of parens each
2913 ;; time round; the corresponding elements in `c-state-cache' are
2914 ;; removed. `pos' is just after the brace-pair or the open paren at
2915 ;; (car c-state-cache). There can be no open parens/braces/brackets
2916 ;; between `good-pos'/`good-pos-actual-macro-start' and (point-max),
2917 ;; due to the interface spec to this function.
2920 in-macro-start)))
2922 ; marked by a `category' text property.
2923 good-pos))
2932 ;; Do nothing when we've merely reached pps-point.
2933 )
2935 ;; Scan!
2939 target-depth
2940 nil pps-state))
2950 ;; We've just moved out of the paren pair containing the brace-pair
2951 ;; at (car c-state-cache). `pair-beg' is where the open paren is,
2952 ;; and is potentially where the open brace of a cons in
2953 ;; c-state-cache will be.
2959 ; containing Lparen
2963 ; together with enclosed brace pair.
2964 ;; (t nil) ; Ignore an unmated Rparen.
2965 )))
2969 nil nil ; TARGETDEPTH, STOPBEFORE
2970 pps-state)))
2972 ;; If the last paren pair we moved out of was actually a brace pair,
2973 ;; insert it into `c-state-cache'.
2978 c-state-cache)))
2983 ;; Strip stale elements of `c-state-cache' by moving backwards through the
2984 ;; buffer, and inform the caller of the scenario detected.
2985 ;;
2986 ;; HERE is the position we're setting `c-state-cache' for.
2987 ;; CACHE-POS is just after the latest recorded position in `c-state-cache'
2988 ;; before HERE, or a position at or near point-min which isn't in a
2989 ;; literal.
2990 ;;
2991 ;; This function must only be called only when (> `c-state-cache-good-pos'
2992 ;; HERE). Usually the gap between CACHE-POS and HERE is large. It is thus
2993 ;; optimized to eliminate (or minimize) scanning between these two
2994 ;; positions.
2995 ;;
2996 ;; Return a three element list (GOOD-POS SCAN-BACK-POS FWD-FLAG), where:
2997 ;; o - GOOD-POS is a "good position", where `c-state-cache' is valid, or
2998 ;; could become so after missing elements are inserted into
2999 ;; `c-state-cache'. This is JUST AFTER an opening or closing
3000 ;; brace/paren/bracket which is already in `c-state-cache' or just before
3001 ;; one otherwise. exceptionally (when there's no such b/p/b handy) the BOL
3002 ;; before `here''s line, or the start of the literal containing it.
3003 ;; o - SCAN-BACK-POS, if non-nil, indicates there may be a brace pair
3004 ;; preceding POS which isn't recorded in `c-state-cache'. It is a position
3005 ;; to scan backwards from.
3006 ;; o - FWD-FLAG, if non-nil, indicates there may be parens/braces between
3007 ;; POS and HERE which aren't recorded in `c-state-cache'.
3008 ;;
3009 ;; The comments in this defun use "paren" to mean parenthesis or square
3010 ;; bracket (as contrasted with a brace), and "(" and ")" likewise.
3011 ;;
3012 ;; . {..} (..) (..) ( .. { } ) (...) ( .... . ..)
3013 ;; | | | | | |
3014 ;; CP E here D C good
3016 pa ren ; positions of "(" and ")"
3017 dropped-cons ; whether the last element dropped from `c-state-cache'
3018 ; was a cons (representing a brace-pair)
3019 good-pos ; see above.
3020 lit ; (START . END) of a literal containing some point.
3021 here-lit-start here-lit-end ; bounds of literal containing `here'
3022 ; or `here' itself.
3027 ;; Remove completely irrelevant entries from `c-state-cache'.
3033 ;; At this stage, (> pos here);
3034 ;; (< (c-state-cache-top-lparen) here) (or is nil).
3039 ;; CASE 1: The top of the cache is a brace pair which now encloses
3040 ;; `here'. As good-pos, return the address. of the "{". Since we've no
3041 ;; knowledge of what's inside these braces, we have no alternative but
3042 ;; to direct the caller to scan the buffer from the opening brace.
3046 ; entry into a { entry, so the caller needs to
3047 ; search for a brace pair before the {.
3049 ;; `here' might be inside a literal. Check for this.
3054 ;; Has `here' just "newly entered" a macro?
3067 ;; `here' might be nested inside any depth of parens (or brackets but
3068 ;; not braces). Scan backwards to find the outermost such opening
3069 ;; paren, if there is one. This will be the scan position to return.
3076 ;; CASE 2: Address of outermost ( or [ which now encloses `here', but
3077 ;; didn't enclose the (previous) `c-state-cache-good-pos'. If there is
3078 ;; a brace pair preceding this, it will already be in `c-state-cache',
3079 ;; unless there was a brace pair after it, i.e. there'll only be one to
3080 ;; scan for if we've just deleted one.
3083 ;; `here' isn't enclosed in a (previously unrecorded) bracket/paren.
3084 ;; Further forward scanning isn't needed, but we still need to find a
3085 ;; GOOD-POS. Step out of all enclosing "("s on HERE's line.
3095 ;; CASE 3: After a }/)/] before `here''s BOL.
3099 ;; CASE 4; Best of a bad job: BOL before `here-bol', or beginning of
3100 ;; literal containing it.
3105 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3106 ;; Externally visible routines.
3110 c-state-cache-good-pos 1
3111 c-state-nonlit-pos-cache nil
3112 c-state-nonlit-pos-cache-limit 1
3113 c-state-semi-nonlit-pos-cache nil
3114 c-state-semi-nonlit-pos-cache-limit 1
3115 c-state-brace-pair-desert nil
3116 c-state-point-min 1
3117 c-state-point-min-lit-type nil
3118 c-state-point-min-lit-start nil
3119 c-state-min-scan-pos 1
3120 c-state-old-cpp-beg nil
3121 c-state-old-cpp-end nil)
3124 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3125 ;; Debugging routines to dump `c-state-cache' in a "replayable" form.
3126 ;; (defmacro c-sc-de (elt) ; "c-state-cache-dump-element"
3127 ;; `(format ,(concat "(setq " (symbol-name elt) " %s) ") ,elt))
3128 ;; (defmacro c-sc-qde (elt) ; "c-state-cache-quote-dump-element"
3129 ;; `(format ,(concat "(setq " (symbol-name elt) " '%s) ") ,elt))
3130 ;; (defun c-state-dump ()
3131 ;; ;; For debugging.
3132 ;; ;(message
3133 ;; (concat
3134 ;; (c-sc-qde c-state-cache)
3135 ;; (c-sc-de c-state-cache-good-pos)
3136 ;; (c-sc-qde c-state-nonlit-pos-cache)
3137 ;; (c-sc-de c-state-nonlit-pos-cache-limit)
3138 ;; (c-sc-qde c-state-brace-pair-desert)
3139 ;; (c-sc-de c-state-point-min)
3140 ;; (c-sc-de c-state-point-min-lit-type)
3141 ;; (c-sc-de c-state-point-min-lit-start)
3142 ;; (c-sc-de c-state-min-scan-pos)
3143 ;; (c-sc-de c-state-old-cpp-beg)
3144 ;; (c-sc-de c-state-old-cpp-end)))
3145 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3148 ;; Invalidate all info on `c-state-cache' that applies to the buffer at HERE
3149 ;; or higher and set `c-state-cache-good-pos' accordingly. The cache is
3150 ;; left in a consistent state.
3151 ;;
3152 ;; This is much like `c-whack-state-after', but it never changes a paren
3153 ;; pair element into an open paren element. Doing that would mean that the
3154 ;; new open paren wouldn't have the required preceding paren pair element.
3155 ;;
3156 ;; This function is called from c-after-change.
3158 ;; The caches of non-literals:
3164 ;; `c-state-cache':
3165 ;; Case 1: if `here' is in a literal containing point-min, everything
3166 ;; becomes (or is already) nil.
3170 c-state-cache-good-pos nil
3171 c-state-min-scan-pos nil)
3173 ;; Truncate `c-state-cache' and set `c-state-cache-good-pos' to a value
3174 ;; below `here'. To maintain its consistency, we may need to insert a new
3175 ;; brace pair.
3177 too-high-pa ; recorded {/(/[ next above here, or nil.
3178 dropped-cons ; was the last removed element a brace pair?
3179 pa)
3180 ;; The easy bit - knock over-the-top bits off `c-state-cache'.
3187 ;; Do we need to add in an earlier brace pair, having lopped one off?
3194 ;; The brace-pair desert marker:
3202 ;; Find and record all noteworthy parens between some good point earlier in
3203 ;; the file and point. That good point is at least the beginning of the
3204 ;; top-level construct we are in, or the beginning of the preceding
3205 ;; top-level construct if we aren't in one.
3206 ;;
3207 ;; The returned value is a list of the noteworthy parens with the last one
3208 ;; first. If an element in the list is an integer, it's the position of an
3209 ;; open paren (of any type) which has not been closed before the point. If
3210 ;; an element is a cons, it gives the position of a closed BRACE paren
3211 ;; pair[*]; the car is the start brace position and the cdr is the position
3212 ;; following the closing brace. Only the last closed brace paren pair
3213 ;; before each open paren and before the point is recorded, and thus the
3214 ;; state never contains two cons elements in succession. When a close brace
3215 ;; has no matching open brace (e.g., the matching brace is outside the
3216 ;; visible region), it is not represented in the returned value.
3217 ;;
3218 ;; [*] N.B. The close "brace" might be a mismatching close bracket or paren.
3219 ;; This defun explicitly treats mismatching parens/braces/brackets as
3220 ;; matching. It is the open brace which makes it a "brace" pair.
3221 ;;
3222 ;; If POINT is within a macro, open parens and brace pairs within
3223 ;; THIS macro MIGHT be recorded. This depends on whether their
3224 ;; syntactic properties have been suppressed by
3225 ;; `c-neutralize-syntax-in-CPP'. This might need fixing (2008-12-11).
3226 ;;
3227 ;; Currently no characters which are given paren syntax with the
3228 ;; syntax-table property are recorded, i.e. angle bracket arglist
3229 ;; parens are never present here. Note that this might change.
3230 ;;
3231 ;; BUG: This function doesn't cope entirely well with unbalanced
3232 ;; parens in macros. (2008-12-11: this has probably been resolved
3233 ;; by the function `c-neutralize-syntax-in-CPP'.) E.g. in the
3234 ;; following case the brace before the macro isn't balanced with the
3235 ;; one after it:
3236 ;;
3237 ;; {
3238 ;; #define X {
3239 ;; }
3240 ;;
3241 ;; Note to maintainers: this function DOES get called with point
3242 ;; within comments and strings, so don't assume it doesn't!
3243 ;;
3244 ;; This function might do hidden buffer changes.
3247 strategy ; 'forward, 'backward etc..
3248 ;; Candidate positions to start scanning from:
3249 cache-pos ; highest position below HERE already existing in
3250 ; cache (or 1).
3251 good-pos
3252 start-point
3253 bopl-state
3254 res
3256 ;; If POINT-MIN has changed, adjust the cache
3260 ;; Strategy?
3268 c-state-cache-good-pos start-point))
3270 ;; SCAN!
3279 ; start-point)
3288 good-pos)))
3297 scan-backward-pos))
3302 good-pos)))
3306 c-state-cache-good-pos nil)))))
3308 c-state-cache)
3311 ;; This is a wrapper over `c-invalidate-state-cache-1'.
3312 ;;
3313 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3314 ;; of all parens in preprocessor constructs, except for any such construct
3315 ;; containing point. We can then call `c-invalidate-state-cache-1' without
3316 ;; worrying further about macros and template delimiters.
3321 c-state-old-cpp-beg
3328 ;; This is a wrapper over `c-parse-state-1'. See that function for a
3329 ;; description of the functionality and return value.
3330 ;;
3331 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3332 ;; of all parens in preprocessor constructs, except for any such construct
3333 ;; containing point. We can then call `c-parse-state-1' without worrying
3334 ;; further about macros and template delimiters.
3341 here-cpp-beg)
3343 ;; FIXME!!! Put in a `condition-case' here to protect the integrity of the
3344 ;; subsystem.
3349 here-cpp-beg here-cpp-end
3355 )))
3357 ;; Debug tool to catch cache inconsistencies. This is called from
3358 ;; 000tests.el.
3375 val))))
3377 c-state-cache-good-pos
3378 c-state-nonlit-pos-cache
3379 c-state-nonlit-pos-cache-limit
3380 c-state-semi-nonlit-pos-cache
3381 c-state-semi-nonlit-pos-cache-limit
3382 c-state-brace-pair-desert
3383 c-state-point-min
3384 c-state-point-min-lit-type
3385 c-state-point-min-lit-start
3386 c-state-min-scan-pos
3387 c-state-old-cpp-beg
3388 c-state-old-cpp-end
3389 c-parse-state-point))))
3407 conses-not-ok))
3424 ;; The cache can actually go further back due to the ad-hoc way
3425 ;; the first paren is found, so try to whack off a bit of its
3426 ;; start before complaining.
3427 ;; (save-excursion
3428 ;; (goto-char (or (c-least-enclosing-brace res2) (point)))
3429 ;; (c-beginning-of-defun-1)
3430 ;; (while (not (or (bobp) (eq (char-after) ?{)))
3431 ;; (c-beginning-of-defun-1))
3432 ;; (unless (equal (c-whack-state-before (point) res1) res2)
3433 ;; (message (concat "c-parse-state inconsistency at %s: "
3434 ;; "using cache: %s, from scratch: %s")
3435 ;; here res1 res2)))
3438 here res1 res2)
3444 here res1)
3449 res2 ; res1 correct a cascading series of errors ASAP
3450 ))
3456 'c-debug-parse-state
3464 \f
3466 ;; Whack off any state information from PAREN-STATE which lies
3467 ;; before BUFPOS. Not destructive on PAREN-STATE.
3470 car)
3481 ;; Whack off any state information from PAREN-STATE which lies at or
3482 ;; after BUFPOS. Not destructive on PAREN-STATE.
3487 ;; just check the car, because in a balanced brace
3488 ;; expression, it must be impossible for the corresponding
3489 ;; close brace to be before point, but the open brace to
3490 ;; be after.
3492 nil ; whack it off
3494 ;; its possible that the open brace is before
3495 ;; bufpos, but the close brace is after. In that
3496 ;; case, convert this to a non-cons element. The
3497 ;; rest of the state is before bufpos, so we're
3498 ;; done.
3500 ;; we know that both the open and close braces are
3501 ;; before bufpos, so we also know that everything else
3502 ;; on state is before bufpos.
3505 nil ; whack it off
3506 ;; it's before bufpos, so everything else should too.
3509 nil)))
3512 ;; Return the bufpos of the innermost enclosing open paren before
3513 ;; bufpos, or nil if none was found.
3523 enclosingp))
3526 ;; Return the bufpos of the outermost enclosing open paren, or nil
3527 ;; if none was found.
3534 pos))
3537 ;; Return the closest "safe" position recorded on PAREN-STATE that
3538 ;; is higher up than BUFPOS. Return nil if PAREN-STATE doesn't
3539 ;; contain any. Return nil if BUFPOS is nil, which is useful to
3540 ;; find the closest limit before a given limit that might be nil.
3541 ;;
3542 ;; A "safe" position is a position at or after a recorded open
3543 ;; paren, or after a recorded close paren. The returned position is
3544 ;; thus either the first position after a close brace, or the first
3545 ;; position after an enclosing paren, or at the enclosing paren in
3546 ;; case BUFPOS is immediately after it.
3556 ;; See below.
3559 ;; elem is the position at and not after the opening paren, so
3560 ;; we can go forward one more step unless it's equal to
3561 ;; bufpos. This is useful in some cases avoid an extra paren
3562 ;; level between the safe position and bufpos.
3567 ;; This is used for `font-lock-beginning-of-syntax-function'. It
3568 ;; goes to the closest previous point that is known to be outside
3569 ;; any string literal or comment. `c-state-cache' is used if it has
3570 ;; a position in the vicinity.
3572 elem
3575 ;; Note: Similar code in `c-safe-position'. The
3576 ;; difference is that we accept a safe position at
3577 ;; the point and don't bother to go forward past open
3578 ;; parens.
3593 ;; The position is far back. Try `c-beginning-of-defun-1'
3594 ;; (although we can't be entirely sure it will go to a position
3595 ;; outside a comment or string in current emacsen). FIXME:
3596 ;; Consult `syntax-ppss' here.
3601 \f
3602 ;; Tools for scanning identifiers and other tokens.
3605 "Return non-nil if the point is on or directly after an identifier.
3606 Keywords are recognized and not considered identifiers. If an
3607 identifier is detected, the returned value is its starting position.
3608 If an identifier ends at the point and another begins at it \(can only
3609 happen in Pike) then the point for the preceding one is returned.
3611 Note that this function might do hidden buffer changes. See the
3612 comment at the start of cc-engine.el for more info."
3614 ;; FIXME: Shouldn't this function handle "operator" in C++?
3621 ;; Check for a normal (non-keyword) identifier.
3627 ;; Handle the `<operator> syntax in Pike.
3631 t
3638 ;; Handle the "operator +" syntax in C++.
3655 )))
3658 ;; If the point is at the end of a symbol then skip backward to the
3659 ;; beginning of it. Don't move otherwise. Return non-nil if point
3660 ;; moved.
3661 ;;
3662 ;; This function might do hidden buffer changes.
3665 ;; Handle the `<operator> syntax in Pike.
3671 t
3673 nil)))))
3676 ;; Move to the beginning of the current token. Do not move if not
3677 ;; in the middle of one. BACK-LIMIT may be used to bound the
3678 ;; backward search; if given it's assumed to be at the boundary
3679 ;; between two tokens. Return non-nil if the point is moved, nil
3680 ;; otherwise.
3681 ;;
3682 ;; This function might do hidden buffer changes.
3689 ;; `c-nonsymbol-token-regexp' should always match
3690 ;; since we've skipped backward over punctuator
3691 ;; or paren syntax, but consume one char in case
3692 ;; it doesn't so that we don't leave point before
3693 ;; some earlier incorrect token.
3700 ;; Move to the end of the current token. Do not move if not in the
3701 ;; middle of one. BACK-LIMIT may be used to bound the backward
3702 ;; search; if given it's assumed to be at the boundary between two
3703 ;; tokens. Return non-nil if the point is moved, nil otherwise.
3704 ;;
3705 ;; This function might do hidden buffer changes.
3713 ;; `c-nonsymbol-token-regexp' should always match since
3714 ;; we've skipped backward over punctuator or paren
3715 ;; syntax, but move forward in case it doesn't so that
3716 ;; we don't leave point earlier than we started with.
3732 "Move forward by tokens.
3733 A token is defined as all symbols and identifiers which aren't
3735 treated properly). Point is always either left at the beginning of a
3736 token or not moved at all. COUNT specifies the number of tokens to
3737 move; a negative COUNT moves in the opposite direction. A COUNT of 0
3738 moves to the next token beginning only if not already at one. If
3739 BALANCED is true, move over balanced parens, otherwise move into them.
3740 Also, if BALANCED is true, never move out of an enclosing paren.
3742 LIMIT sets the limit for the movement and defaults to the point limit.
3743 The case when LIMIT is set in the middle of a token, comment or macro
3744 is handled correctly, i.e. the point won't be left there.
3746 Return the number of tokens left to move \(positive or negative). If
3747 BALANCED is true, a move over a balanced paren counts as one. Note
3748 that if COUNT is 0 and no appropriate token beginning is found, 1 will
3749 be returned. Thus, a return value of 0 guarantees that point is at
3750 the requested position and a return value less \(without signs) than
3751 COUNT guarantees that point is at the beginning of some token.
3753 Note that this function might do hidden buffer changes. See the
3754 comment at the start of cc-engine.el for more info."
3761 c-jump-syntax-balanced
3762 c-jump-syntax-unbalanced))
3767 ;; If count is zero we should jump if in the middle of a token.
3774 ;; Skip whitespace. Count this as a move if we did in
3775 ;; fact move.
3779 ;; Moved out of bounds. Make sure the returned count isn't zero.
3784 ;; Use `condition-case' to avoid having the limit tests
3785 ;; inside the loop.
3793 t)
3796 t)
3797 ;; `c-nonsymbol-token-regexp' above should always
3798 ;; match if there are correct tokens. Try to
3799 ;; widen to see if the limit was set in the
3800 ;; middle of one, else fall back to treating
3801 ;; the offending thing as a one character token.
3806 nil)
3809 t))))
3819 count)))
3822 "Move backward by tokens.
3823 See `c-forward-token-2' for details."
3831 c-jump-syntax-balanced
3832 c-jump-syntax-unbalanced))
3836 ;; The count is zero so try to skip to the beginning of the
3837 ;; current token.
3841 ;; The limit is inside the same token, so return 1.
3844 ;; We're not in the middle of a token. If there's
3845 ;; whitespace after the point then we must move backward,
3846 ;; so set count to 1 in that case.
3848 ;; If we're looking at a '#' that might start a cpp
3849 ;; directive then we have to do a more elaborate check.
3862 ;; Use `condition-case' to avoid having to check for buffer
3863 ;; limits in `backward-char', `scan-sexps' and `goto-char' below.
3872 ;; This can be very inefficient if there's a long
3873 ;; sequence of operator tokens without any separation.
3874 ;; That doesn't happen in practice, anyway.
3884 count)))
3887 "Like `c-forward-token-2' but doesn't treat multicharacter operator
3889 characters are jumped over character by character. This function is
3890 for compatibility only; it's only a wrapper over `c-forward-token-2'."
3895 "Like `c-backward-token-2' but doesn't treat multicharacter operator
3897 characters are jumped over character by character. This function is
3898 for compatibility only; it's only a wrapper over `c-backward-token-2'."
3902 \f
3903 ;; Tools for doing searches restricted to syntactically relevant text.
3906 paren-level not-inside-token
3907 lookbehind-submatch)
3908 "Like `re-search-forward', but only report matches that are found
3909 in syntactically significant text. I.e. matches in comments, macros
3910 or string literals are ignored. The start point is assumed to be
3911 outside any comment, macro or string literal, or else the content of
3912 that region is taken as syntactically significant text.
3914 If PAREN-LEVEL is non-nil, an additional restriction is added to
3915 ignore matches in nested paren sexps. The search will also not go
3916 outside the current list sexp, which has the effect that if the point
3917 should be moved to BOUND when no match is found \(i.e. NOERROR is
3918 neither nil nor t), then it will be at the closing paren if the end of
3919 the current list sexp is encountered first.
3921 If NOT-INSIDE-TOKEN is non-nil, matches in the middle of tokens are
3922 ignored. Things like multicharacter operators and special symbols
3924 constants.
3926 If LOOKBEHIND-SUBMATCH is non-nil, it's taken as a number of a
3927 subexpression in REGEXP. The end of that submatch is used as the
3928 position to check for syntactic significance. If LOOKBEHIND-SUBMATCH
3929 isn't used or if that subexpression didn't match then the start
3931 subexpression is never tested before the starting position, so it
3935 subexpression can match the end of nonwhite syntactic whitespace,
3936 i.e. the end of comments or cpp directives. This since the function
3937 skips over such things before resuming the search. It's on the other
3939 matches syntactic whitespace.
3941 Bug: Unbalanced parens inside cpp directives are currently not handled
3942 correctly \(i.e. they don't get ignored as they should) when
3943 PAREN-LEVEL is set.
3945 Note that this function might do hidden buffer changes. See the
3946 comment at the start of cc-engine.el for more info."
3951 ;;(message "c-syntactic-re-search-forward %s %s %S" (point) bound regexp)
3954 tmp
3955 ;; Start position for the last search.
3956 search-pos
3957 ;; The `parse-partial-sexp' state between the start position
3958 ;; and the point.
3959 state
3960 ;; The current position after the last state update. The next
3961 ;; `parse-partial-sexp' continues from here.
3963 ;; The position at which to check the state and the state
3964 ;; there. This is separate from `state-pos' since we might
3965 ;; need to back up before doing the next search round.
3966 check-pos check-state
3967 ;; Last position known to end a token.
3969 ;; Set when a valid match is found.
3970 found)
3988 state-pos check-pos paren-level nil state))
3990 check-state state))
3992 ;; NOTE: If we got a look behind subexpression and get
3993 ;; an insignificant match in something that isn't
3994 ;; syntactic whitespace (i.e. strings or in nested
3995 ;; parentheses), then we can never skip more than a
3996 ;; single character from the match start position
3997 ;; (i.e. `state-pos' here) before continuing the
3998 ;; search. That since the look behind subexpression
3999 ;; might match the end of the insignificant region in
4000 ;; the next search.
4004 ;; Match inside a line comment. Skip to eol. Use
4005 ;; `re-search-forward' instead of `skip-chars-forward' to get
4006 ;; the right bound behavior.
4010 ;; Match inside a block comment. Skip to the '*/'.
4017 ;; Match in the middle of the opener of a block or line
4018 ;; comment.
4023 ;; The last `parse-partial-sexp' above might have
4024 ;; stopped short of the real check position if the end
4025 ;; of the current sexp was encountered in paren-level
4026 ;; mode. The checks above are always false in that
4027 ;; case, and since they can do better skipping in
4028 ;; lookbehind-submatch mode, we do them before
4029 ;; checking the paren level.
4033 ;; Check the paren level first since we're short of the
4034 ;; syntactic checking position if the end of the
4035 ;; current sexp was encountered by `parse-partial-sexp'.
4038 ;; Inside a nested paren sexp.
4040 ;; See the NOTE above.
4042 ;; Skip out of the paren quickly.
4046 ;; Have exited the current paren sexp.
4049 ;; The last `parse-partial-sexp' call above
4050 ;; has left us just after the closing paren
4051 ;; in this case, so we can modify the bound
4052 ;; to leave the point at the right position
4053 ;; upon return.
4055 nil)
4059 ;; Match inside a string.
4062 ;; See the NOTE above.
4064 ;; Skip to the end of the string before continuing.
4073 continue)))
4078 ;; Match inside a macro. Skip to the end of it.
4086 (< check-pos
4092 ;; Inside a token.
4094 ;; See the NOTE above.
4099 ;; A real match.
4101 nil)))
4103 ;; Should loop to search again, but take care to avoid
4104 ;; looping on the same spot.
4108 nil
4111 t))))
4117 ;;(message "c-syntactic-re-search-forward done %s" (or (match-end 0) (point)))
4124 ;; Search failed. Set point as appropriate.
4128 nil)))
4133 ;; Return the start of the literal point is in, or nil.
4134 ;; We read and write the variables `safe-pos', `safe-pos-list', `state'
4135 ;; bound in the caller.
4137 ;; Use `parse-partial-sexp' from a safe position down to the point to check
4138 ;; if it's outside comments and strings.
4141 ;; Pick a safe position as close to the point as possible.
4142 ;;
4143 ;; FIXME: Consult `syntax-ppss' here if our cache doesn't give a good
4144 ;; position.
4157 ;; Cache positions along the way to use if we have to back up more. We
4158 ;; cache every closing paren on the same level. If the paren cache is
4159 ;; relevant in this region then we're typically already on the same
4160 ;; level as the target position. Note that we might cache positions
4161 ;; after opening parens in case safe-pos is in a nested list. That's
4162 ;; both uncommon and harmless.
4170 ;; If the state contains the start of the containing sexp we cache that
4171 ;; position too, so that parse-partial-sexp in the next run has a bigger
4172 ;; chance of starting at the same level as the target position and thus
4173 ;; will get more good safe positions into the list.
4179 ;; Inside string or comment. Continue search at the
4180 ;; beginning of it.
4184 "Like `skip-chars-backward' but only look at syntactically relevant chars,
4185 i.e. don't stop at positions inside syntactic whitespace or string
4186 literals. Preprocessor directives are also ignored, with the exception
4187 of the one that the point starts within, if any. If LIMIT is given,
4188 it's assumed to be at a syntactically relevant position.
4190 If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4191 sexps, and the search will also not go outside the current paren sexp.
4192 However, if LIMIT or the buffer limit is reached inside a nested paren
4193 then the point will be left at the limit.
4195 Non-nil is returned if the point moved, nil otherwise.
4197 Note that this function might do hidden buffer changes. See the
4198 comment at the start of cc-engine.el for more info."
4201 state-2
4202 ;; A list of syntactically relevant positions in descending
4203 ;; order. It's used to avoid scanning repeatedly over
4204 ;; potentially large regions with `parse-partial-sexp' to verify
4205 ;; each position. Used in `c-ssb-lit-begin'
4206 safe-pos-list
4207 ;; The result from `c-beginning-of-macro' at the start position or the
4208 ;; start position itself if it isn't within a macro. Evaluated on
4209 ;; demand.
4210 start-macro-beg
4211 ;; The earliest position after the current one with the same paren
4212 ;; level. Used only when `paren-level' is set.
4213 lit-beg
4218 ;; The next loop "tries" to find the end point each time round,
4219 ;; loops when it hasn't succeeded.
4227 ;; Don't stop inside a literal
4230 t)
4238 ;; Not at the right level.
4241 ;; We stop above if we go out of a paren.
4242 ;; Now check whether it precedes or is
4243 ;; nested in the starting sexp.
4247 pps-end-pos paren-level-pos
4248 nil nil state-2))
4251 ;; We've stopped short of the starting position
4252 ;; so the hit was inside a nested list. Go up
4253 ;; until we are at the right level.
4262 nil)
4263 t))
4266 nil))
4268 ;; The hit was outside the list at the start
4269 ;; position. Go to the start of the list and exit.
4271 nil))
4274 ;; Inside a macro.
4282 t
4284 ;; It's inside the same macro we started in so it's
4285 ;; a relevant match.
4287 nil))))))
4291 ;; Skip syntactic ws afterwards so that we don't stop at the
4292 ;; end of a comment if `skip-chars' is something like "^/".
4296 ;; We might want to extend this with more useful return values in
4297 ;; the future.
4300 ;; The following is an alternative implementation of
4301 ;; `c-syntactic-skip-backward' that uses backward movement to keep
4302 ;; track of the syntactic context. It turned out to be generally
4303 ;; slower than the one above which uses forward checks from earlier
4304 ;; safe positions.
4305 ;;
4306 ;;(defconst c-ssb-stop-re
4307 ;; ;; The regexp matching chars `c-syntactic-skip-backward' needs to
4308 ;; ;; stop at to avoid going into comments and literals.
4309 ;; (concat
4310 ;; ;; Match comment end syntax and string literal syntax. Also match
4311 ;; ;; '/' for block comment endings (not covered by comment end
4312 ;; ;; syntax).
4313 ;; "\\s>\\|/\\|\\s\""
4314 ;; (if (memq 'gen-string-delim c-emacs-features)
4315 ;; "\\|\\s|"
4316 ;; "")
4317 ;; (if (memq 'gen-comment-delim c-emacs-features)
4318 ;; "\\|\\s!"
4319 ;; "")))
4320 ;;
4321 ;;(defconst c-ssb-stop-paren-re
4322 ;; ;; Like `c-ssb-stop-re' but also stops at paren chars.
4323 ;; (concat c-ssb-stop-re "\\|\\s(\\|\\s)"))
4324 ;;
4325 ;;(defconst c-ssb-sexp-end-re
4326 ;; ;; Regexp matching the ending syntax of a complex sexp.
4327 ;; (concat c-string-limit-regexp "\\|\\s)"))
4328 ;;
4329 ;;(defun c-syntactic-skip-backward (skip-chars &optional limit paren-level)
4330 ;; "Like `skip-chars-backward' but only look at syntactically relevant chars,
4331 ;;i.e. don't stop at positions inside syntactic whitespace or string
4332 ;;literals. Preprocessor directives are also ignored. However, if the
4333 ;;point is within a comment, string literal or preprocessor directory to
4334 ;;begin with, its contents is treated as syntactically relevant chars.
4335 ;;If LIMIT is given, it limits the backward search and the point will be
4336 ;;left there if no earlier position is found.
4337 ;;
4338 ;;If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4339 ;;sexps, and the search will also not go outside the current paren sexp.
4340 ;;However, if LIMIT or the buffer limit is reached inside a nested paren
4341 ;;then the point will be left at the limit.
4342 ;;
4343 ;;Non-nil is returned if the point moved, nil otherwise.
4344 ;;
4345 ;;Note that this function might do hidden buffer changes. See the
4346 ;;comment at the start of cc-engine.el for more info."
4347 ;;
4348 ;; (save-restriction
4349 ;; (when limit
4350 ;; (narrow-to-region limit (point-max)))
4351 ;;
4352 ;; (let ((start (point)))
4353 ;; (catch 'done
4354 ;; (while (let ((last-pos (point))
4355 ;; (stop-pos (progn
4356 ;; (skip-chars-backward skip-chars)
4357 ;; (point))))
4358 ;;
4359 ;; ;; Skip back over the same region as
4360 ;; ;; `skip-chars-backward' above, but keep to
4361 ;; ;; syntactically relevant positions.
4362 ;; (goto-char last-pos)
4363 ;; (while (and
4364 ;; ;; `re-search-backward' with a single char regexp
4365 ;; ;; should be fast.
4366 ;; (re-search-backward
4367 ;; (if paren-level c-ssb-stop-paren-re c-ssb-stop-re)
4368 ;; stop-pos 'move)
4369 ;;
4370 ;; (progn
4371 ;; (cond
4372 ;; ((looking-at "\\s(")
4373 ;; ;; `paren-level' is set and we've found the
4374 ;; ;; start of the containing paren.
4375 ;; (forward-char)
4376 ;; (throw 'done t))
4377 ;;
4378 ;; ((looking-at c-ssb-sexp-end-re)
4379 ;; ;; We're at the end of a string literal or paren
4380 ;; ;; sexp (if `paren-level' is set).
4381 ;; (forward-char)
4382 ;; (condition-case nil
4383 ;; (c-backward-sexp)
4384 ;; (error
4385 ;; (goto-char limit)
4386 ;; (throw 'done t))))
4387 ;;
4388 ;; (t
4389 ;; (forward-char)
4390 ;; ;; At the end of some syntactic ws or possibly
4391 ;; ;; after a plain '/' operator.
4392 ;; (let ((pos (point)))
4393 ;; (c-backward-syntactic-ws)
4394 ;; (if (= pos (point))
4395 ;; ;; Was a plain '/' operator. Go past it.
4396 ;; (backward-char)))))
4397 ;;
4398 ;; (> (point) stop-pos))))
4399 ;;
4400 ;; ;; Now the point is either at `stop-pos' or at some
4401 ;; ;; position further back if `stop-pos' was at a
4402 ;; ;; syntactically irrelevant place.
4403 ;;
4404 ;; ;; Skip additional syntactic ws so that we don't stop
4405 ;; ;; at the end of a comment if `skip-chars' is
4406 ;; ;; something like "^/".
4407 ;; (c-backward-syntactic-ws)
4408 ;;
4409 ;; (< (point) stop-pos))))
4410 ;;
4411 ;; ;; We might want to extend this with more useful return values
4412 ;; ;; in the future.
4413 ;; (/= (point) start))))
4415 \f
4416 ;; Tools for handling comments and string literals.
4419 "Return the type of literal point is in, if any.
4420 The return value is `c' if in a C-style comment, `c++' if in a C++
4421 style comment, `string' if in a string literal, `pound' if DETECT-CPP
4422 is non-nil and in a preprocessor line, or nil if somewhere else.
4423 Optional LIM is used as the backward limit of the search. If omitted,
4424 or nil, `c-beginning-of-defun' is used.
4426 The last point calculated is cached if the cache is enabled, i.e. if
4427 `c-in-literal-cache' is bound to a two element vector.
4429 Note that this function might do hidden buffer changes. See the
4430 comment at the start of cc-engine.el for more info."
4441 "Return a cons of the beginning and end positions of the comment or
4442 string surrounding point (including both delimiters), or nil if point
4444 to start parsing from. If NEAR is non-nil, then the limits of any
4446 spaces and tabs between point and the literal. The search for such a
4447 literal is done first in forward direction. If NOT-IN-DELIMITER is
4448 non-nil, the case when point is inside a starting delimiter won't be
4449 recognized. This only has effect for comments which have starting
4450 delimiters with more than one character.
4452 Note that this function might do hidden buffer changes. See the
4453 comment at the start of cc-engine.el for more info."
4470 ;; We're standing in a comment starter.
4476 ;; Search forward for a literal.
4487 ;; Search backward.
4498 ;; Block comment. Due to the nature of line
4499 ;; comments, they will always be covered by the
4500 ;; normal case above.
4503 ;; If LIM is bogus, beg will be bogus.
4507 ))))
4509 ;; In case external callers use this; it did have a docstring.
4513 "If the argument is a cons of two buffer positions (such as returned by
4514 `c-literal-limits'), and that range contains a C++ style line comment,
4515 then an extended range is returned that contains all adjacent line
4516 comments (i.e. all comments that starts in the same column with no
4517 empty lines or non-whitespace characters between them). Otherwise the
4518 argument is returned.
4520 Note that this function might do hidden buffer changes. See the
4521 comment at the start of cc-engine.el for more info."
4532 ;; Got to take care in the backward direction to handle
4533 ;; comments which are preceded by code.
4547 range)
4551 "Convenience function that given the result of `c-literal-limits',
4552 returns nil or the type of literal that the range surrounds, one
4553 of the symbols 'c, 'c++ or 'string. It's much faster than using
4554 `c-in-literal' and is intended to be used when you need both the
4555 type of a literal and its limits.
4557 Note that this function might do hidden buffer changes. See the
4558 comment at the start of cc-engine.el for more info."
4569 range))
4572 ;; Get a "safe place" approximately TRY-SIZE characters before START.
4573 ;; This doesn't preserve point.
4582 ;; Return a buffer position HOW-FAR-BACK non-literal characters from START
4583 ;; (default point). This is done by going back further in the buffer then
4584 ;; searching forward for literals. The position found won't be in a
4585 ;; literal. We start searching for the sought position TRY-SIZE (default
4586 ;; twice HOW-FAR-BACK) bytes back from START. This function must be fast.
4587 ;; :-)
4595 stack elt size
4598 ;; Move forward one literal each time round this loop.
4599 ;; Move forward to the start of a comment or string.
4601 pos
4602 start
4603 nil ; target-depth
4604 nil ; stop-before
4605 s ; state
4608 ;; Gather details of the non-literal-bit - starting pos and size.
4612 pos))
4616 ;; Move forward to the end of the comment/string.
4620 start
4621 nil ; target-depth
4622 nil ; stop-before
4623 s ; state
4627 ;; Now try and find enough non-literal characters recorded on the stack.
4628 ;; Go back one recorded literal each time round this loop.
4630 stack)
4635 ;; Have we found enough yet?
4645 ;; Return a buffer position about HOW-FAR non-literal characters forward
4646 ;; from START-POS (default point), which must not be inside a literal.
4653 ;; Scan over counted characters.
4655 pos
4657 nil ; target-depth
4658 nil ; stop-before
4659 s ; state
4663 ;; Scan over literal characters.
4666 pos
4668 nil ; target-depth
4669 nil ; stop-before
4670 s ; state
4675 \f
4676 ;; `c-find-decl-spots' and accompanying stuff.
4678 ;; Variables used in `c-find-decl-spots' to cache the search done for
4679 ;; the first declaration in the last call. When that function starts,
4680 ;; it needs to back up over syntactic whitespace to look at the last
4681 ;; token before the region being searched. That can sometimes cause
4682 ;; moves back and forth over a quite large region of comments and
4683 ;; macros, which would be repeated for each changed character when
4684 ;; we're called during fontification, since font-lock refontifies the
4685 ;; current line for each change. Thus it's worthwhile to cache the
4686 ;; first match.
4687 ;;
4688 ;; `c-find-decl-syntactic-pos' is a syntactically relevant position in
4689 ;; the syntactic whitespace less or equal to some start position.
4690 ;; There's no cached value if it's nil.
4691 ;;
4692 ;; `c-find-decl-match-pos' is the match position if
4693 ;; `c-find-decl-prefix-search' matched before the syntactic whitespace
4694 ;; at `c-find-decl-syntactic-pos', or nil if there's no such match.
4705 ; (defface c-debug-decl-spot-face
4706 ; '((t (:background "Turquoise")))
4707 ; "Debug face to mark the spots where `c-find-decl-spots' stopped.")
4708 ; (defface c-debug-decl-sws-face
4709 ; '((t (:background "Khaki")))
4710 ; "Debug face to mark the syntactic whitespace between the declaration
4711 ; spots and the preceding token end.")
4727 ;; Macro used inside `c-find-decl-spots'. It ought to be a defun,
4728 ;; but it contains lots of free variables that refer to things
4729 ;; inside `c-find-decl-spots'. The point is left at `cfd-match-pos'
4730 ;; if there is a match, otherwise at `cfd-limit'.
4731 ;;
4732 ;; This macro might do hidden buffer changes.
4735 ;; Find the next property match position if we haven't got one already.
4746 ;; Find the next `c-decl-prefix-or-start-re' match if we haven't
4747 ;; got one already.
4757 ;; Match. Check if it's inside a comment or string literal.
4760 ;; Matched the end of a token preceding a decl spot.
4764 ;; Matched a token that start a decl spot.
4767 c-literal-faces)
4769 ;; No match. Finish up and exit the loop.
4771 nil)
4773 ;; Skip out of comments and string literals.
4780 ;; If we matched at the decl start, we have to back up over the
4781 ;; preceding syntactic ws to set `cfd-match-pos' and to catch
4782 ;; any decl spots in the syntactic ws.
4787 ;; Choose whichever match is closer to the start.
4790 cfd-re-match nil)
4792 cfd-prop-match nil))
4797 ;; Skip forward past comments only so we don't skip macros.
4799 ;; Set the position to continue at. We can avoid going over
4800 ;; the comments skipped above a second time, but it's possible
4801 ;; that the comment skipping has taken us past `cfd-prop-match'
4802 ;; since the property might be used inside comments.
4808 ;; Call CFD-FUN for each possible spot for a declaration, cast or
4809 ;; label from the point to CFD-LIMIT.
4810 ;;
4811 ;; CFD-FUN is called with point at the start of the spot. It's passed two
4812 ;; arguments: The first is the end position of the token preceding the spot,
4813 ;; or 0 for the implicit match at bob. The second is a flag that is t when
4814 ;; the match is inside a macro. Point should be moved forward by at least
4815 ;; one token.
4816 ;;
4817 ;; If CFD-FUN adds `c-decl-end' properties somewhere below the current spot,
4818 ;; it should return non-nil to ensure that the next search will find them.
4819 ;;
4820 ;; Such a spot is:
4821 ;; o The first token after bob.
4822 ;; o The first token after the end of submatch 1 in
4823 ;; `c-decl-prefix-or-start-re' when that submatch matches.
4824 ;; o The start of each `c-decl-prefix-or-start-re' match when
4825 ;; submatch 1 doesn't match.
4826 ;; o The first token after the end of each occurrence of the
4827 ;; `c-type' text property with the value `c-decl-end', provided
4828 ;; `c-type-decl-end-used' is set.
4829 ;;
4830 ;; Only a spot that match CFD-DECL-RE and whose face is in the
4831 ;; CFD-FACE-CHECKLIST list causes CFD-FUN to be called. The face
4832 ;; check is disabled if CFD-FACE-CHECKLIST is nil.
4833 ;;
4834 ;; If the match is inside a macro then the buffer is narrowed to the
4835 ;; end of it, so that CFD-FUN can investigate the following tokens
4836 ;; without matching something that begins inside a macro and ends
4837 ;; outside it. It's to avoid this work that the CFD-DECL-RE and
4838 ;; CFD-FACE-CHECKLIST checks exist.
4839 ;;
4840 ;; The spots are visited approximately in order from top to bottom.
4841 ;; It's however the positions where `c-decl-prefix-or-start-re'
4842 ;; matches and where `c-decl-end' properties are found that are in
4843 ;; order. Since the spots often are at the following token, they
4844 ;; might be visited out of order insofar as more spots are reported
4845 ;; later on within the syntactic whitespace between the match
4846 ;; positions and their spots.
4847 ;;
4848 ;; It's assumed that comments and strings are fontified in the
4849 ;; searched range.
4850 ;;
4851 ;; This is mainly used in fontification, and so has an elaborate
4852 ;; cache to handle repeated calls from the same start position; see
4853 ;; the variables above.
4854 ;;
4855 ;; All variables in this function begin with `cfd-' to avoid name
4856 ;; collision with the (dynamically bound) variables used in CFD-FUN.
4857 ;;
4858 ;; This function might do hidden buffer changes.
4862 ;; The end of the token preceding the decl spot last found
4863 ;; with `c-decl-prefix-or-start-re'. `cfd-limit' if there's
4864 ;; no match.
4865 cfd-re-match
4866 ;; The end position of the last `c-decl-prefix-or-start-re'
4867 ;; match. If this is greater than `cfd-continue-pos', the
4868 ;; next regexp search is started here instead.
4870 ;; The end of the last `c-decl-end' found by
4871 ;; `c-find-decl-prefix-search'. `cfd-limit' if there's no
4872 ;; match. If searching for the property isn't needed then we
4873 ;; disable it by setting it to `cfd-limit' directly.
4875 ;; The end of the token preceding the decl spot last found by
4876 ;; `c-find-decl-prefix-search'. 0 for the implicit match at
4877 ;; bob. `cfd-limit' if there's no match. In other words,
4878 ;; this is the minimum of `cfd-re-match' and `cfd-prop-match'.
4880 ;; The position to continue searching at.
4881 cfd-continue-pos
4882 ;; The position of the last "real" token we've stopped at.
4883 ;; This can be greater than `cfd-continue-pos' when we get
4884 ;; hits inside macros or at `c-decl-end' positions inside
4885 ;; comments.
4887 ;; The end position of the last entered macro.
4890 ;; Initialize by finding a syntactically relevant start position
4891 ;; before the point, and do the first `c-decl-prefix-or-start-re'
4892 ;; search unless we're at bob.
4895 ;; Must back up a bit since we look for the end of the previous
4896 ;; statement or declaration, which is earlier than the first
4897 ;; returned match.
4900 ;; First we need to move to a syntactically relevant position.
4901 ;; Begin by backing out of comment or string literals.
4904 ;; Try to use the faces to back up to the start of the
4905 ;; literal. FIXME: What if the point is on a declaration
4906 ;; inside a comment?
4912 ;; XEmacs doesn't fontify the quotes surrounding string
4913 ;; literals.
4922 ;; Don't trust the literal to contain only literal faces
4923 ;; (the font lock package might not have fontified the
4924 ;; start of it at all, for instance) so check that we have
4925 ;; arrived at something that looks like a start or else
4926 ;; resort to `c-literal-limits'.
4933 ;; The start is in a literal. If the limit is in the same
4934 ;; one we don't have to find a syntactic position etc. We
4935 ;; only check that if the limit is at or before bonl to save
4936 ;; time; it covers the by far most common case when font-lock
4937 ;; refontifies the current line only.
4948 ;; Completely inside a literal. Set up variables to trig the
4949 ;; (< cfd-continue-pos cfd-start-pos) case below and it'll
4950 ;; find a suitable start position.
4953 ;; Check if the region might be completely inside a macro, to
4954 ;; optimize that like the completely-inside-literal above.
4961 ;; (Maybe) completely inside a macro. Only need to trig the
4962 ;; (< cfd-continue-pos cfd-start-pos) case below to make it
4963 ;; set things up.
4965 start-in-macro t))
4968 ;; Back out of any macro so we don't miss any declaration
4969 ;; that could follow after it.
4973 ;; Now we're at a proper syntactically relevant position so we
4974 ;; can use the cache. But first clear it if it applied
4975 ;; further down.
4980 ;; Don't have to do this if the cache is relevant here,
4981 ;; typically if the same line is refontified again. If
4982 ;; we're just some syntactic whitespace further down we can
4983 ;; still use the cache to limit the skipping.
4986 ;; If we hit `c-find-decl-syntactic-pos' and
4987 ;; `c-find-decl-match-pos' is set then we install the cached
4988 ;; values. If we hit `c-find-decl-syntactic-pos' and
4989 ;; `c-find-decl-match-pos' is nil then we know there's no decl
4990 ;; prefix in the whitespace before `c-find-decl-syntactic-pos'
4991 ;; and so we can continue the search from this point. If we
4992 ;; didn't hit `c-find-decl-syntactic-pos' then we're now in
4993 ;; the right spot to begin searching anyway.
4995 c-find-decl-match-pos)
4997 cfd-continue-pos syntactic-pos)
5002 ;; Always consider bob a match to get the first
5003 ;; declaration in the file. Do this separately instead of
5004 ;; letting `c-decl-prefix-or-start-re' match bob, so that
5005 ;; regexp always can consume at least one character to
5006 ;; ensure that we won't get stuck in an infinite loop.
5011 ;; Do an initial search now. In the bob case above it's
5012 ;; only done to search for a `c-decl-end' spot.
5016 cfd-match-pos)))))
5018 ;; Advance `cfd-continue-pos' if it's before the start position.
5019 ;; The closest continue position that might have effect at or
5020 ;; after the start depends on what we started in. This also
5021 ;; finds a suitable start position in the special cases when the
5022 ;; region is completely within a literal or macro.
5027 ;; If we're in a macro then it's the closest preceding token
5028 ;; in the macro. Check this before `start-in-literal',
5029 ;; since if we're inside a literal in a macro, the preceding
5030 ;; token is earlier than any `c-decl-end' spot inside the
5031 ;; literal (comment).
5033 ;; The only syntactic ws in macros are comments.
5039 ;; If we're in a comment it can only be the closest
5040 ;; preceding `c-decl-end' position within that comment, if
5041 ;; any. Go back to the beginning of such a property so that
5042 ;; `c-find-decl-prefix-search' will find the end of it.
5043 ;; (Can't stop at the end and install it directly on
5044 ;; `cfd-prop-match' since that variable might be cleared
5045 ;; after `cfd-fun' below.)
5046 ;;
5047 ;; Note that if the literal is a string then the property
5048 ;; search will simply skip to the beginning of it right
5049 ;; away.
5061 ;; Didn't find any property inside the comment, so we can
5062 ;; skip it entirely. (This won't skip past a string, but
5063 ;; that'll be handled quickly by the next
5064 ;; `c-find-decl-prefix-search' anyway.)
5070 ;; If we started in normal code, the only match that might
5071 ;; apply before the start is what we already got in
5072 ;; `cfd-match-pos' so we can continue at the start position.
5073 ;; (Note that we don't get here if the first match is below
5074 ;; it.)
5077 ;; Delete found matches if they are before our new continue
5078 ;; position, so that `c-find-decl-prefix-search' won't back up
5079 ;; to them later on.
5087 ;; This is the normal case and we got a proper syntactic
5088 ;; position. If there's a match then it's always outside
5089 ;; macros and comments, so advance to the next token and set
5090 ;; `cfd-token-pos'. The loop below will later go back using
5091 ;; `cfd-continue-pos' to fix declarations inside the
5092 ;; syntactic ws.
5100 ;; Have one of the special cases when the region is completely
5101 ;; within a literal or macro. `cfd-continue-pos' is set to a
5102 ;; good start position for the search, so do it.
5105 ;; Now loop. Round what? (ACM, 2006/7/5). We already got the first match.
5112 ;; Kludge to filter out matches on the "<" that
5113 ;; aren't open parens, for the sake of languages
5114 ;; that got `c-recognize-<>-arglists' set.
5119 ;; If `cfd-continue-pos' is less or equal to
5120 ;; `cfd-token-pos', we've got a hit inside a macro
5121 ;; that's in the syntactic whitespace before the last
5122 ;; "real" declaration we've checked. If they're equal
5123 ;; we've arrived at the declaration a second time, so
5124 ;; there's nothing to do.
5128 ;; If `cfd-continue-pos' is less than `cfd-token-pos'
5129 ;; we're still searching for declarations embedded in
5130 ;; the syntactic whitespace. In that case we need
5131 ;; only to skip comments and not macros, since they
5132 ;; can't be nested, and that's already been done in
5133 ;; `c-find-decl-prefix-search'.
5138 ;; Continue if the following token fails the
5139 ;; CFD-DECL-RE and CFD-FACE-CHECKLIST checks.
5146 t)))
5157 ;; Narrow to the end of the macro if we got a hit inside
5158 ;; one, to avoid recognizing things that start inside the
5159 ;; macro and end outside it.
5161 ;; Not in the same macro as in the previous round.
5172 t
5175 t)
5176 ;; The matched token was the last thing in the macro,
5177 ;; so the whole match is bogus.
5179 nil))))
5186 ;; Restore limits if we did macro narrowing above.
5193 ; cfd-match-pos, etc.
5195 \f
5196 ;; A cache for found types.
5198 ;; Buffer local variable that contains an obarray with the types we've
5199 ;; found. If a declaration is recognized somewhere we record the
5200 ;; fully qualified identifier in it to recognize it as a type
5201 ;; elsewhere in the file too. This is not accurate since we do not
5202 ;; bother with the scoping rules of the languages, but in practice the
5203 ;; same name is seldom used as both a type and something else in a
5204 ;; file, and we only use this as a last resort in ambiguous cases (see
5205 ;; `c-forward-decl-or-cast-1').
5206 ;;
5207 ;; Not every type need be in this cache. However, things which have
5208 ;; ceased to be types must be removed from it.
5209 ;;
5210 ;; Template types in C++ are added here too but with the template
5211 ;; arglist replaced with "<>" in references or "<" for the one in the
5212 ;; primary type. E.g. the type "Foo<A,B>::Bar<C>" is stored as
5213 ;; "Foo<>::Bar<". This avoids storing very long strings (since C++
5214 ;; template specs can be fairly sized programs in themselves) and
5215 ;; improves the hit ratio (it's a type regardless of the template
5216 ;; args; it's just not the same type, but we're only interested in
5217 ;; recognizing types, not telling distinct types apart). Note that
5218 ;; template types in references are added here too; from the example
5219 ;; above there will also be an entry "Foo<".
5224 ;; Clears `c-found-types'.
5228 ;; Add the given region as a type in `c-found-types'. If the region
5229 ;; doesn't match an existing type but there is a type which is equal
5230 ;; to the given one except that the last character is missing, then
5231 ;; the shorter type is removed. That's done to avoid adding all
5232 ;; prefixes of a type as it's being entered and font locked. This
5233 ;; doesn't cover cases like when characters are removed from a type
5234 ;; or added in the middle. We'd need the position of point when the
5235 ;; font locking is invoked to solve this well.
5236 ;;
5237 ;; This function might do hidden buffer changes.
5244 ;; Remove the "NAME" from c-found-types, if present.
5248 ;; Return non-nil if the given region contains a type in
5249 ;; `c-found-types'.
5250 ;;
5251 ;; This function might do hidden buffer changes.
5253 c-found-types))
5256 ;; Return all the types in `c-found-types' as a sorted list of
5257 ;; strings.
5261 type-list)))
5262 c-found-types)
5265 ;; Shut up the byte compiler.
5269 ;; An after change function which, in conjunction with the info in
5270 ;; c-maybe-stale-found-type (set in c-before-change), removes a type
5271 ;; from `c-found-types', should this type have become stale. For
5272 ;; example, this happens to "foo" when "foo \n bar();" becomes
5273 ;; "foo(); \n bar();". Such stale types, if not removed, foul up
5274 ;; the fontification.
5275 ;;
5276 ;; Have we, perhaps, added non-ws characters to the front/back of a found
5277 ;; type?
5297 ;; Changing the amount of (already existing) whitespace - don't do anything.
5302 ;; The syntactic relationship which defined a "found type" has been
5303 ;; destroyed.
5306 ;; ((eq (car c-maybe-stale-found-type) 'c-decl-type-start) FIXME!!!
5307 )))
5309 \f
5310 ;; Setting and removing syntax properties on < and > in languages (C++
5311 ;; and Java) where they can be template/generic delimiters as well as
5312 ;; their normal meaning of "less/greater than".
5314 ;; Normally, < and > have syntax 'punctuation'. When they are found to
5315 ;; be delimiters, they are marked as such with the category properties
5316 ;; c-<-as-paren-syntax, c->-as-paren-syntax respectively.
5318 ;; STRATEGY:
5319 ;;
5320 ;; It is impossible to determine with certainty whether a <..> pair in
5321 ;; C++ is two comparison operators or is template delimiters, unless
5322 ;; one duplicates a lot of a C++ compiler. For example, the following
5323 ;; code fragment:
5324 ;;
5325 ;; foo (a < b, c > d) ;
5326 ;;
5327 ;; could be a function call with two integer parameters (each a
5328 ;; relational expression), or it could be a constructor for class foo
5329 ;; taking one parameter d of templated type "a < b, c >". They are
5330 ;; somewhat easier to distinguish in Java.
5331 ;;
5332 ;; The strategy now (2010-01) adopted is to mark and unmark < and
5333 ;; > IN MATCHING PAIRS ONLY. [Previously, they were marked
5334 ;; individually when their context so indicated. This gave rise to
5335 ;; intractable problems when one of a matching pair was deleted, or
5336 ;; pulled into a literal.]
5337 ;;
5338 ;; At each buffer change, the syntax-table properties are removed in a
5339 ;; before-change function and reapplied, when needed, in an
5340 ;; after-change function. It is far more important that the
5341 ;; properties get removed when they they are spurious than that they
5342 ;; be present when wanted.
5343 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
5345 ;; POS (default point) is at a < character. If it is marked with
5346 ;; open paren syntax-table text property, remove the property,
5347 ;; together with the close paren property on the matching > (if
5348 ;; any).
5363 ;; POS (default point) is at a > character. If it is marked with
5364 ;; close paren syntax-table property, remove the property, together
5365 ;; with the open paren property on the matching < (if any).
5380 ;; POS (default point) is at a < or > character. If it has an
5381 ;; open/close paren syntax-table property, remove this property both
5382 ;; from the current character and its partner (which will also be
5383 ;; thusly marked).
5393 ;; POS (default point) is at a < character. If it is both marked
5394 ;; with open/close paren syntax-table property, and has a matching >
5395 ;; (also marked) which is after LIM, remove the property both from
5396 ;; the current > and its partner. Return t when this happens, nil
5397 ;; when it doesn't.
5411 t)))
5414 ;; POS (default point) is at a > character. If it is both marked
5415 ;; with open/close paren syntax-table property, and has a matching <
5416 ;; (also marked) which is before LIM, remove the property both from
5417 ;; the current < and its partner. Return t when this happens, nil
5418 ;; when it doesn't.
5432 t)))
5434 ;; Set by c-common-init in cc-mode.el.
5439 ;; Unmark certain pairs of "< .... >" which are currently marked as
5440 ;; template/generic delimiters. (This marking is via syntax-table
5441 ;; text properties).
5442 ;;
5443 ;; These pairs are those which are in the current "statement" (i.e.,
5444 ;; the region between the {, }, or ; before BEG and the one after
5445 ;; END), and which enclose any part of the interval (BEG END).
5446 ;;
5447 ;; Note that in C++ (?and Java), template/generic parens cannot
5448 ;; enclose a brace or semicolon, so we use these as bounds on the
5449 ;; region we must work on.
5450 ;;
5451 ;; This function is called from before-change-functions (via
5452 ;; c-get-state-before-change-functions). Thus the buffer is widened,
5453 ;; and point is undefined, both at entry and exit.
5454 ;;
5455 ;; FIXME!!! This routine ignores the possibility of macros entirely.
5456 ;; 2010-01-29.
5460 new-beg new-end need-new-beg need-new-end)
5461 ;; Locate the barrier before the changed region
5466 ;; Remove the syntax-table properties from each pertinent <...> pair.
5467 ;; Firsly, the ones with the < before beg and > after beg.
5472 ;; Locate the barrier after END.
5477 ;; Remove syntax-table properties from the remaining pertinent <...>
5478 ;; pairs, those with a > after end and < before end.
5483 ;; Extend the fontification region, if needed.
5495 ;; This is called from `after-change-functions' when
5496 ;; c-recognize-<>-arglists' is set. It ensures that no "<" or ">"
5497 ;; chars with paren syntax become part of another operator like "<<"
5498 ;; or ">=".
5499 ;;
5500 ;; This function might do hidden buffer changes.
5533 \f
5534 ;; Handling of small scale constructs like types and names.
5536 ;; Dynamically bound variable that instructs `c-forward-type' to also
5537 ;; treat possible types (i.e. those that it normally returns 'maybe or
5538 ;; 'found for) as actual types (and always return 'found for them).
5539 ;; This means that it records them in `c-record-type-identifiers' if
5540 ;; that is set, and that it adds them to `c-found-types'.
5543 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5544 ;; mark up successfully parsed arglists with paren syntax properties on
5545 ;; the surrounding angle brackets and with `c-<>-arg-sep' in the
5546 ;; `c-type' property of each argument separating comma.
5547 ;;
5548 ;; Setting this variable also makes `c-forward-<>-arglist' recurse into
5549 ;; all arglists for side effects (i.e. recording types), otherwise it
5550 ;; exploits any existing paren syntax properties to quickly jump to the
5551 ;; end of already parsed arglists.
5552 ;;
5553 ;; Marking up the arglists is not the default since doing that correctly
5554 ;; depends on a proper value for `c-restricted-<>-arglists'.
5557 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5558 ;; not accept arglists that contain binary operators.
5559 ;;
5560 ;; This is primarily used to handle C++ template arglists. C++
5561 ;; disambiguates them by checking whether the preceding name is a
5562 ;; template or not. We can't do that, so we assume it is a template
5563 ;; if it can be parsed as one. That usually works well since
5564 ;; comparison expressions on the forms "a < b > c" or "a < b, c > d"
5565 ;; in almost all cases would be pointless.
5566 ;;
5567 ;; However, in function arglists, e.g. in "foo (a < b, c > d)", we
5568 ;; should let the comma separate the function arguments instead. And
5569 ;; in a context where the value of the expression is taken, e.g. in
5570 ;; "if (a < b || c > d)", it's probably not a template.
5573 ;; Dynamically bound variables that instructs
5574 ;; `c-forward-keyword-clause', `c-forward-<>-arglist',
5575 ;; `c-forward-name', `c-forward-type', `c-forward-decl-or-cast-1', and
5576 ;; `c-forward-label' to record the ranges of all the type and
5577 ;; reference identifiers they encounter. They will build lists on
5578 ;; these variables where each element is a cons of the buffer
5579 ;; positions surrounding each identifier. This recording is only
5580 ;; activated when `c-record-type-identifiers' is non-nil.
5581 ;;
5582 ;; All known types that can't be identifiers are recorded, and also
5583 ;; other possible types if `c-promote-possible-types' is set.
5584 ;; Recording is however disabled inside angle bracket arglists that
5585 ;; are encountered inside names and other angle bracket arglists.
5586 ;; Such occurrences are taken care of by `c-font-lock-<>-arglists'
5587 ;; instead.
5588 ;;
5589 ;; Only the names in C++ template style references (e.g. "tmpl" in
5590 ;; "tmpl<a,b>::foo") are recorded as references, other references
5591 ;; aren't handled here.
5592 ;;
5593 ;; `c-forward-label' records the label identifier(s) on
5594 ;; `c-record-ref-identifiers'.
5598 ;; This variable will receive a cons cell of the range of the last
5599 ;; single identifier symbol stepped over by `c-forward-name' if it's
5600 ;; successful. This is the range that should be put on one of the
5601 ;; record lists above by the caller. It's assigned nil if there's no
5602 ;; such symbol in the name.
5607 ;; Always true.
5617 ;; Always true.
5625 ;; Dynamically bound variable that instructs `c-forward-type' to
5626 ;; record the ranges of types that only are found. Behaves otherwise
5627 ;; like `c-record-type-identifiers'.
5631 ;; Used internally in `c-forward-keyword-clause' to move forward
5632 ;; over a type (if TYPE is 'type) or a name (otherwise) which
5633 ;; possibly is prefixed by keywords and their associated clauses.
5634 ;; Try with a type/name first to not trip up on those that begin
5635 ;; with a keyword. Return t if a known or found type is moved
5636 ;; over. The point is clobbered if nil is returned. If range
5637 ;; recording is enabled, the identifier is recorded on as a type
5638 ;; if TYPE is 'type or as a reference if TYPE is 'ref.
5639 ;;
5640 ;; This macro might do hidden buffer changes.
5645 nil
5652 t)))
5655 ;; Used internally in `c-forward-keyword-clause' to move forward
5656 ;; over a comma separated list of types or names using
5657 ;; `c-forward-keyword-prefixed-id'.
5658 ;;
5659 ;; This macro might do hidden buffer changes.
5670 ;; Submatch MATCH in the current match data is assumed to surround a
5671 ;; token. If it's a keyword, move over it and any immediately
5672 ;; following clauses associated with it, stopping at the start of
5673 ;; the next token. t is returned in that case, otherwise the point
5674 ;; stays and nil is returned. The kind of clauses that are
5675 ;; recognized are those specified by `c-type-list-kwds',
5676 ;; `c-ref-list-kwds', `c-colon-type-list-kwds',
5677 ;; `c-paren-nontype-kwds', `c-paren-type-kwds', `c-<>-type-kwds',
5678 ;; and `c-<>-arglist-kwds'.
5679 ;;
5680 ;; This function records identifier ranges on
5681 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5682 ;; `c-record-type-identifiers' is non-nil.
5683 ;;
5684 ;; Note that for `c-colon-type-list-kwds', which doesn't necessary
5685 ;; apply directly after the keyword, the type list is moved over
5686 ;; only when there is no unaccounted token before it (i.e. a token
5687 ;; that isn't moved over due to some other keyword list). The
5688 ;; identifier ranges in the list are still recorded if that should
5689 ;; be done, though.
5690 ;;
5691 ;; This function might do hidden buffer changes.
5694 ;; The call to `c-forward-<>-arglist' below is made after
5695 ;; `c-<>-sexp-kwds' keywords, so we're certain they actually
5696 ;; are angle bracket arglists and `c-restricted-<>-arglists'
5697 ;; should therefore be nil.
5709 ;; There's a type directly after a keyword in `c-type-list-kwds'.
5714 ;; There's a name directly after a keyword in `c-ref-list-kwds'.
5719 ;; There's an open paren after a keyword in `c-paren-any-kwds'.
5726 ;; Use `c-forward-type' on every identifier we can find
5727 ;; inside the paren, to record the types.
5752 ;; If we are at the colon already, we move over the type
5753 ;; list after it.
5759 ;; Not at the colon, so stop here. But the identifier
5760 ;; ranges in the type list later on should still be
5761 ;; recorded.
5764 ;; If a keyword matched both one of the types above and
5765 ;; this one, we match `c-colon-type-list-re' after the
5766 ;; clause matched above.
5773 ;; There's a type after the `c-colon-type-list-re' match
5774 ;; after a keyword in `c-colon-type-list-kwds'.
5778 t)))
5780 ;; cc-mode requires cc-fonts.
5784 ;; The point is assumed to be at a "<". Try to treat it as the open
5785 ;; paren of an angle bracket arglist and move forward to the
5786 ;; corresponding ">". If successful, the point is left after the
5787 ;; ">" and t is returned, otherwise the point isn't moved and nil is
5788 ;; returned. If ALL-TYPES is t then all encountered arguments in
5789 ;; the arglist that might be types are treated as found types.
5790 ;;
5791 ;; The variable `c-parse-and-markup-<>-arglists' controls how this
5792 ;; function handles text properties on the angle brackets and argument
5793 ;; separating commas.
5794 ;;
5795 ;; `c-restricted-<>-arglists' controls how lenient the template
5796 ;; arglist recognition should be.
5797 ;;
5798 ;; This function records identifier ranges on
5799 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5800 ;; `c-record-type-identifiers' is non-nil.
5801 ;;
5802 ;; This function might do hidden buffer changes.
5805 ;; If `c-record-type-identifiers' is set then activate
5806 ;; recording of any found types that constitute an argument in
5807 ;; the arglist.
5815 ;; `nconc' doesn't mind that the tail of
5816 ;; `c-record-found-types' is t.
5819 t)
5822 nil)))
5825 ;; Recursive part of `c-forward-<>-arglist'.
5826 ;;
5827 ;; This function might do hidden buffer changes.
5830 ;; Cover this so that any recorded found type ranges are
5831 ;; automatically lost if it turns out to not be an angle
5832 ;; bracket arglist. It's propagated through the return value
5833 ;; on successful completion.
5835 ;; List that collects the positions after the argument
5836 ;; separating ',' in the arglist.
5837 arg-start-pos)
5838 ;; If the '<' has paren open syntax then we've marked it as an angle
5839 ;; bracket arglist before, so skip to the end.
5847 t
5848 ;; Got unmatched paren angle brackets. We don't clear the paren
5849 ;; syntax properties and retry, on the basis that it's very
5850 ;; unlikely that paren angle brackets become operators by code
5851 ;; manipulation. It's far more likely that it doesn't match due
5852 ;; to narrowing or some temporary change.
5854 nil))
5859 ;; go forward one non-alphanumeric character (group) per iteration of
5860 ;; this loop.
5867 ;; All encountered identifiers are types, so set the
5868 ;; promote flag and parse the type.
5891 ;; Note: These regexps exploit the match order in \| so
5892 ;; that "<>" is matched by "<" rather than "[^>:-]>".
5894 ;; Stop on ',', '|', '&', '+' and '-' to catch
5895 ;; common binary operators that could be between
5896 ;; two comparison expressions "a<b" and "c>d".
5898 nil t t))
5902 ;; Either an operator starting with '>' or the end of
5903 ;; the angle bracket arglist.
5910 ;; The angle bracket arglist is finished.
5922 ;; Either an operator starting with '<' or a nested arglist.
5926 ;; The '<' begins a multi-char operator.
5930 ;; We're at a nested <.....>
5936 ;; There's always an identifier before an angle
5937 ;; bracket arglist, or a keyword in `c-<>-type-kwds'
5938 ;; or `c-<>-arglist-kwds'.
5955 ;; It was an angle bracket arglist.
5958 ;; Record the identifier before the template as a type
5959 ;; or reference depending on whether the arglist is last
5960 ;; in a qualified identifier.
5970 ;; At a "less than" operator.
5973 )))
5980 ;; Just another argument. Record the position. The
5981 ;; type check stuff that made us stop at it is at
5982 ;; the top of the loop.
5986 ;; Got a character that can't be in an angle bracket
5987 ;; arglist argument. Abort using `throw', since
5988 ;; it's useless to try to find a surrounding arglist
5989 ;; if we're nested.
5995 ;; The point is assumed to be directly after a ">". Try to treat it
5996 ;; as the close paren of an angle bracket arglist and move back to
5997 ;; the corresponding "<". If successful, the point is left at
5998 ;; the "<" and t is returned, otherwise the point isn't moved and
5999 ;; nil is returned. ALL-TYPES is passed on to
6000 ;; `c-forward-<>-arglist'.
6001 ;;
6002 ;; If the optional LIMIT is given, it bounds the backward search.
6003 ;; It's then assumed to be at a syntactically relevant position.
6004 ;;
6005 ;; This is a wrapper around `c-forward-<>-arglist'. See that
6006 ;; function for more details.
6015 t
6016 ;; See corresponding note in `c-forward-<>-arglist'.
6018 nil)
6025 t
6026 ;; Stopped at bob or a char that isn't allowed in an
6027 ;; arglist, so we've failed.
6029 nil)
6034 ;; If we moved then the "<" was part of some
6035 ;; multicharacter token.
6036 t
6042 ;; Matched the arglist. Break the while.
6044 nil)
6046 ;; We started from a non-paren ">" inside an
6047 ;; arglist.
6049 nil)
6051 ;; Matched a shorter arglist. Can be a nested
6052 ;; one so continue looking.
6054 t))
6055 t))))))
6060 ;; Move forward over a complete name if at the beginning of one,
6061 ;; stopping at the next following token. A keyword, as such,
6062 ;; doesn't count as a name. If the point is not at something that
6063 ;; is recognized as a name then it stays put.
6064 ;;
6065 ;; A name could be something as simple as "foo" in C or something as
6066 ;; complex as "X<Y<class A<int>::B, BIT_MAX >> b>, ::operator<> ::
6067 ;; Z<(a>b)> :: operator const X<&foo>::T Q::G<unsigned short
6068 ;; int>::*volatile const" in C++ (this function is actually little
6069 ;; more than a `looking-at' call in all modes except those that,
6070 ;; like C++, have `c-recognize-<>-arglists' set).
6071 ;;
6072 ;; Return
6073 ;; o - nil if no name is found;
6074 ;; o - 'template if it's an identifier ending with an angle bracket
6075 ;; arglist;
6076 ;; o - 'operator of it's an operator identifier;
6077 ;; o - t if it's some other kind of name.
6078 ;;
6079 ;; This function records identifier ranges on
6080 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6081 ;; `c-record-type-identifiers' is non-nil.
6082 ;;
6083 ;; This function might do hidden buffer changes.
6086 ;; Turn off `c-promote-possible-types' here since we might
6087 ;; call `c-forward-<>-arglist' and we don't want it to promote
6088 ;; every suspect thing in the arglist to a type. We're
6089 ;; typically called from `c-forward-type' in this case, and
6090 ;; the caller only wants the top level type that it finds to
6091 ;; be promoted.
6092 c-promote-possible-types)
6098 ;; Check for keyword. We go to the last symbol in
6099 ;; `c-identifier-key' first.
6112 ;; "template" is only valid inside an
6113 ;; identifier if preceded by "::".
6118 t))
6120 ;; Handle a C++ operator or template identifier.
6124 ;; Got "... ::template".
6128 res subres))))
6131 ;; Got a cast operator.
6135 ;; Now we should match a sequence of either
6136 ;; '*', '&' or a name followed by ":: *",
6137 ;; where each can be followed by a sequence
6138 ;; of `c-opt-type-modifier-key'.
6141 t)
6151 t))))
6159 ;; Got some other operator.
6167 nil)
6169 ;; `id-start' is equal to `id-end' if we've jumped over
6170 ;; an identifier that doesn't end with a symbol token.
6171 ;; That can occur e.g. for Java import directives on the
6172 ;; form "foo.bar.*".
6179 res t)))
6189 ;; Got a concatenated identifier. This handles the
6190 ;; cases with tricky syntactic whitespace that aren't
6191 ;; covered in `c-identifier-key'.
6194 t)
6198 ;; Maybe an angle bracket arglist.
6206 c-last-identifier-range nil)
6211 ;; Continue if there's an identifier concatenation
6212 ;; operator after the template argument.
6218 t)
6223 nil)))
6224 )))))
6227 res))
6230 ;; Move forward over a type spec if at the beginning of one,
6231 ;; stopping at the next following token. The keyword "typedef"
6232 ;; isn't part of a type spec here.
6233 ;;
6234 ;; BRACE-BLOCK-TOO, when non-nil, means move over the brace block in
6235 ;; constructs like "struct foo {...} bar ;" or "struct {...} bar;".
6236 ;; The current (2009-03-10) intention is to convert all uses of
6237 ;; `c-forward-type' to call with this parameter set, then to
6238 ;; eliminate it.
6239 ;;
6240 ;; Return
6241 ;; o - t if it's a known type that can't be a name or other
6242 ;; expression;
6243 ;; o - 'known if it's an otherwise known type (according to
6244 ;; `*-font-lock-extra-types');
6245 ;; o - 'prefix if it's a known prefix of a type;
6246 ;; o - 'found if it's a type that matches one in `c-found-types';
6247 ;; o - 'maybe if it's an identifier that might be a type; or
6248 ;; o - nil if it can't be a type (the point isn't moved then).
6249 ;;
6250 ;; The point is assumed to be at the beginning of a token.
6251 ;;
6252 ;; Note that this function doesn't skip past the brace definition
6253 ;; that might be considered part of the type, e.g.
6254 ;; "enum {a, b, c} foo".
6255 ;;
6256 ;; This function records identifier ranges on
6257 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6258 ;; `c-record-type-identifiers' is non-nil.
6259 ;;
6260 ;; This function might do hidden buffer changes.
6268 ;; Skip leading type modifiers. If any are found we know it's a
6269 ;; prefix of a type.
6278 ; "typedef".
6286 ;; In many languages the name can be used without the
6287 ;; prefix, so we add it to `c-found-types'.
6290 c-last-identifier-range)
6312 id-range c-last-identifier-range))))
6324 id-end)
6326 ;; Looking at a primitive or known type identifier. We've
6327 ;; checked for a name first so that we don't go here if the
6328 ;; known type match only is a prefix of another name.
6339 ;; There might be more keywords for the type.
6367 ;; A normal identifier.
6377 ;; It's an identifier that has been used as
6378 ;; a type somewhere else.
6379 'found
6380 ;; It's an identifier that might be a type.
6383 ;; A template is a type.
6387 ;; Otherwise it's an operator identifier, which is not a type.
6392 ;; Skip trailing type modifiers. If any are found we know it's
6393 ;; a type.
6399 ;; Step over any type suffix operator. Do not let the existence
6400 ;; of these alter the classification of the found type, since
6401 ;; these operators typically are allowed in normal expressions
6402 ;; too.
6409 ;; Look for a trailing operator that concatenates the type
6410 ;; with a following one, and if so step past that one through
6411 ;; a recursive call. Note that we don't record concatenated
6412 ;; types in `c-found-types' - it's the component types that
6413 ;; are recorded when appropriate.
6416 c-promote-possible-types))
6417 ;; If we can't promote then set `c-record-found-types' so that
6418 ;; we can merge in the types from the second part afterwards if
6419 ;; it turns out to be a known type there.
6422 subres)
6431 ;; If either operand certainly is a type then both are, but we
6432 ;; don't let the existence of the operator itself promote two
6433 ;; uncertain types to a certain one.
6452 ;; Merge in the ranges of any types found by the second
6453 ;; `c-forward-type'.
6455 ;; `nconc' doesn't mind that the tail of
6456 ;; `c-record-found-types' is t.
6458 c-record-type-identifiers))))
6466 ;;(message "c-forward-type %s -> %s: %s" start (point) res)
6468 res))
6471 ;; Used for Java code only at the moment. Assumes point is on the
6472 ;; @, moves forward an annotation. returns nil if there is no
6473 ;; annotation at point.
6480 t)))
6482 \f
6483 ;; Handling of large scale constructs like statements and declarations.
6485 ;; Macro used inside `c-forward-decl-or-cast-1'. It ought to be a
6486 ;; defsubst or perhaps even a defun, but it contains lots of free
6487 ;; variables that refer to things inside `c-forward-decl-or-cast-1'.
6489 ;; `c-forward-decl-or-cast-1' can consume an arbitrary length list
6490 ;; of types when parsing a declaration, which means that it
6491 ;; sometimes consumes the identifier in the declaration as a type.
6492 ;; This is used to "backtrack" and make the last type be treated as
6493 ;; an identifier instead.
6496 ;; These identifiers are bound only in the inner let.
6498 identifier-start type-start
6499 got-parens nil
6500 got-identifier t
6501 got-suffix t
6502 got-suffix-after-parens id-start
6506 t
6507 backup-at-type))
6509 id-start backup-id-start)
6511 id-start start-pos))
6513 ;; When these flags already are set we've found specifiers that
6514 ;; unconditionally signal these attributes - backtracking doesn't
6515 ;; change that. So keep them set in that case.
6522 ;; This identifier is bound only in the inner let.
6526 ;; Move forward over a declaration or a cast if at the start of one.
6527 ;; The point is assumed to be at the start of some token. Nil is
6528 ;; returned if no declaration or cast is recognized, and the point
6529 ;; is clobbered in that case.
6530 ;;
6531 ;; If a declaration is parsed:
6532 ;;
6533 ;; The point is left at the first token after the first complete
6534 ;; declarator, if there is one. The return value is a cons where
6535 ;; the car is the position of the first token in the declarator. (See
6536 ;; below for the cdr.)
6537 ;; Some examples:
6538 ;;
6539 ;; void foo (int a, char *b) stuff ...
6540 ;; car ^ ^ point
6541 ;; float (*a)[], b;
6542 ;; car ^ ^ point
6543 ;; unsigned int a = c_style_initializer, b;
6544 ;; car ^ ^ point
6545 ;; unsigned int a (cplusplus_style_initializer), b;
6546 ;; car ^ ^ point (might change)
6547 ;; class Foo : public Bar {}
6548 ;; car ^ ^ point
6549 ;; class PikeClass (int a, string b) stuff ...
6550 ;; car ^ ^ point
6551 ;; enum bool;
6552 ;; car ^ ^ point
6553 ;; enum bool flag;
6554 ;; car ^ ^ point
6555 ;; void cplusplus_function (int x) throw (Bad);
6556 ;; car ^ ^ point
6557 ;; Foo::Foo (int b) : Base (b) {}
6558 ;; car ^ ^ point
6559 ;;
6560 ;; The cdr of the return value is non-nil when a
6561 ;; `c-typedef-decl-kwds' specifier is found in the declaration.
6562 ;; Specifically it is a dotted pair (A . B) where B is t when a
6563 ;; `c-typedef-kwds' ("typedef") is present, and A is t when some
6564 ;; other `c-typedef-decl-kwds' (e.g. class, struct, enum)
6565 ;; specifier is present. I.e., (some of) the declared
6566 ;; identifier(s) are types.
6567 ;;
6568 ;; If a cast is parsed:
6569 ;;
6570 ;; The point is left at the first token after the closing paren of
6571 ;; the cast. The return value is `cast'. Note that the start
6572 ;; position must be at the first token inside the cast parenthesis
6573 ;; to recognize it.
6574 ;;
6575 ;; PRECEDING-TOKEN-END is the first position after the preceding
6576 ;; token, i.e. on the other side of the syntactic ws from the point.
6577 ;; Use a value less than or equal to (point-min) if the point is at
6578 ;; the first token in (the visible part of) the buffer.
6579 ;;
6580 ;; CONTEXT is a symbol that describes the context at the point:
6581 ;; 'decl In a comma-separated declaration context (typically
6582 ;; inside a function declaration arglist).
6583 ;; '<> In an angle bracket arglist.
6584 ;; 'arglist Some other type of arglist.
6585 ;; nil Some other context or unknown context. Includes
6586 ;; within the parens of an if, for, ... construct.
6587 ;;
6588 ;; LAST-CAST-END is the first token after the closing paren of a
6589 ;; preceding cast, or nil if none is known. If
6590 ;; `c-forward-decl-or-cast-1' is used in succession, it should be
6591 ;; the position after the closest preceding call where a cast was
6592 ;; matched. In that case it's used to discover chains of casts like
6593 ;; "(a) (b) c".
6594 ;;
6595 ;; This function records identifier ranges on
6596 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6597 ;; `c-record-type-identifiers' is non-nil.
6598 ;;
6599 ;; This function might do hidden buffer changes.
6602 ;; first type, i.e. after any leading specifiers. It might
6603 ;; also point at the beginning of the preceding syntactic
6604 ;; whitespace.
6606 ;; Set to the result of `c-forward-type'.
6607 at-type
6608 ;; The position of the first token in what we currently
6609 ;; believe is the type in the declaration or cast, after any
6610 ;; specifiers and their associated clauses.
6611 type-start
6612 ;; The position of the first token in what we currently
6613 ;; believe is the declarator for the first identifier. Set
6614 ;; when the type is found, and moved forward over any
6615 ;; `c-decl-hangon-kwds' and their associated clauses that
6616 ;; occurs after the type.
6617 id-start
6618 ;; These store `at-type', `type-start' and `id-start' of the
6619 ;; identifier before the one in those variables. The previous
6620 ;; identifier might turn out to be the real type in a
6621 ;; declaration if the last one has to be the declarator in it.
6622 ;; If `backup-at-type' is nil then the other variables have
6623 ;; undefined values.
6624 backup-at-type backup-type-start backup-id-start
6625 ;; Set if we've found a specifier (apart from "typedef") that makes
6626 ;; the defined identifier(s) types.
6627 at-type-decl
6628 ;; Set if we've a "typedef" keyword.
6629 at-typedef
6630 ;; Set if we've found a specifier that can start a declaration
6631 ;; where there's no type.
6632 maybe-typeless
6633 ;; If a specifier is found that also can be a type prefix,
6634 ;; these flags are set instead of those above. If we need to
6635 ;; back up an identifier, they are copied to the real flag
6636 ;; variables. Thus they only take effect if we fail to
6637 ;; interpret it as a type.
6638 backup-at-type-decl backup-maybe-typeless
6639 ;; Whether we've found a declaration or a cast. We might know
6640 ;; this before we've found the type in it. It's 'ids if we've
6641 ;; found two consecutive identifiers (usually a sure sign, but
6642 ;; we should allow that in labels too), and t if we've found a
6643 ;; specifier keyword (a 100% sure sign).
6644 at-decl-or-cast
6645 ;; Set when we need to back up to parse this as a declaration
6646 ;; but not as a cast.
6647 backup-if-not-cast
6648 ;; For casts, the return position.
6649 cast-end
6650 ;; Save `c-record-type-identifiers' and
6651 ;; `c-record-ref-identifiers' since ranges are recorded
6652 ;; speculatively and should be thrown away if it turns out
6653 ;; that it isn't a declaration or cast.
6660 ;; Check for a type. Unknown symbols are treated as possible
6661 ;; types, but they could also be specifiers disguised through
6662 ;; macros like __INLINE__, so we recognize both types and known
6663 ;; specifiers after them too.
6667 ;; Look for a specifier keyword clause.
6679 ;; Found a known or possible type or a prefix of a known type.
6682 ;; Got two identifiers with nothing but whitespace
6683 ;; between them. That can only happen in declarations.
6687 ;; If the previous identifier is a found type we
6688 ;; record it as a real one; it might be some sort of
6689 ;; alias for a prefix like "unsigned".
6696 backup-type-start type-start
6697 backup-id-start id-start
6698 at-type found-type
6699 type-start start
6701 ;; The previous ambiguous specifier/type turned out
6702 ;; to be a type since we've parsed another one after
6703 ;; it, so clear these backup flags.
6704 backup-at-type-decl nil
6705 backup-maybe-typeless nil))
6709 ;; Handle known specifier keywords and
6710 ;; `c-decl-hangon-kwds' which can occur after known
6711 ;; types.
6714 ;; It's a hang-on keyword that can occur anywhere.
6718 ;; Move the identifier start position if
6719 ;; we've passed a type.
6721 ;; Otherwise treat this as a specifier and
6722 ;; move the fallback position.
6726 ;; It's an ordinary specifier so we know that
6727 ;; anything before this can't be the type.
6729 start-pos kwd-clause-end)
6732 ;; It's ambiguous whether this keyword is a
6733 ;; specifier or a type prefix, so set the backup
6734 ;; flags. (It's assumed that `c-forward-type'
6735 ;; moved further than `c-forward-keyword-clause'.)
6743 ;; This test only happens after we've scanned a type.
6744 ;; So, with valid syntax, kwd-sym can't be 'typedef.
6749 ;; Haven't matched a type so it's an unambiguous
6750 ;; specifier keyword and we know we're in a
6751 ;; declaration.
6756 ;; If the type isn't known we continue so that we'll jump
6757 ;; over all specifiers and type identifiers. The reason
6758 ;; to do this for a known type prefix is to make things
6759 ;; like "unsigned INT16" work.
6764 ;; If a known type was found, we still need to skip over any
6765 ;; hangon keyword clauses after it. Otherwise it has already
6766 ;; been done in the loop above.
6772 ;; A prefix type is itself a primitive type when it's not
6773 ;; followed by another type.
6777 ;; Got no type but set things up to continue anyway to handle
6778 ;; the various cases when a declaration doesn't start with a
6779 ;; type.
6784 ;; If it's C++ then check if the last "type" ends on the form
6785 ;; "foo::foo" or "foo::~foo", i.e. if it's the name of a
6786 ;; (con|de)structor.
6797 ;; Cheating in the handling of syntactic ws below.
6804 name))
6805 ;; It is a (con|de)structor name. In that case the
6806 ;; declaration is typeless so zap out any preceding
6807 ;; identifier(s) that we might have taken as types.
6810 backup-at-type nil
6811 id-start type-start))))))
6813 ;; Check for and step over a type decl expression after the thing
6814 ;; that is or might be a type. This can't be skipped since we
6815 ;; need the correct end position of the declarator for
6816 ;; `max-type-decl-end-*'.
6818 ;; True if there's a non-open-paren match of
6819 ;; `c-type-decl-prefix-key'.
6820 got-prefix
6821 ;; True if the declarator is surrounded by a parenthesis pair.
6822 got-parens
6823 ;; True if there is an identifier in the declarator.
6824 got-identifier
6825 ;; True if there's a non-close-paren match of
6826 ;; `c-type-decl-suffix-key'.
6827 got-suffix
6828 ;; True if there's a prefix match outside the outermost
6829 ;; paren pair that surrounds the declarator.
6830 got-prefix-before-parens
6831 ;; True if there's a suffix match outside the outermost
6832 ;; paren pair that surrounds the declarator. The value is
6833 ;; the position of the first suffix match.
6834 got-suffix-after-parens
6835 ;; True if we've parsed the type decl to a token that is
6836 ;; known to end declarations in this context.
6837 at-decl-end
6838 ;; The earlier values of `at-type' and `type-start' if we've
6839 ;; shifted the type backwards.
6840 identifier-type identifier-start
6841 ;; If `c-parse-and-markup-<>-arglists' is set we need to
6842 ;; turn it off during the name skipping below to avoid
6843 ;; getting `c-type' properties that might be bogus. That
6844 ;; can happen since we don't know if
6845 ;; `c-restricted-<>-arglists' will be correct inside the
6846 ;; arglist paren that gets entered.
6851 ;; Skip over type decl prefix operators. (Note similar code in
6852 ;; `c-font-lock-declarators'.)
6856 ;; If the second submatch matches in C++ then
6857 ;; we're looking at an identifier that's a
6858 ;; prefix only if it specifies a member pointer.
6861 ;; We only check for a trailing "::" and
6862 ;; let the "*" that should follow be
6863 ;; matched in the next round.
6865 ;; It turned out to be the real identifier,
6866 ;; so stop.
6867 nil))
6868 t))
6882 ;; Skip over an identifier.
6887 ;; Skip over type decl suffix operators.
6894 t)
6898 t)
6904 ;; No suffix matched. We might have matched the
6905 ;; identifier as a type and the open paren of a
6906 ;; function arglist as a type decl prefix. In that
6907 ;; case we should "backtrack": Reinterpret the last
6908 ;; type as the identifier, move out of the arglist and
6909 ;; continue searching for suffix operators.
6910 ;;
6911 ;; Do this even if there's no preceding type, to cope
6912 ;; with old style function declarations in K&R C,
6913 ;; (con|de)structors in C++ and `c-typeless-decl-kwds'
6914 ;; style declarations. That isn't applicable in an
6915 ;; arglist context, though.
6920 maybe-typeless
6921 backup-maybe-typeless
6928 t))
6935 at-type)
6936 ;; Have found no identifier but `c-typeless-decl-kwds' has
6937 ;; matched so we know we're inside a declaration. The
6938 ;; preceding type must be the identifier instead.
6942 at-decl-or-cast
6945 ;; CASE 1
6947 ;; Encountered something inside parens that isn't matched by
6948 ;; the `c-type-decl-*' regexps, so it's not a type decl
6949 ;; expression. Try to skip out to the same paren depth to
6950 ;; not confuse the cast check below.
6952 ;; If we've found a specifier keyword then it's a
6953 ;; declaration regardless.
6961 ;; Now we've collected info about various characteristics of
6962 ;; the construct we're looking at. Below follows a decision
6963 ;; tree based on that. It's ordered to check more certain
6964 ;; signs before less certain ones.
6969 ;; CASE 2
6972 ;; Got another identifier directly after the type, so it's a
6973 ;; declaration.
6980 maybe-typeless
6981 backup-maybe-typeless))
6982 ;; Got a declaration of the form "foo bar (gnu);" where we've
6983 ;; recognized "bar" as the type and "gnu" as the declarator.
6984 ;; In this case it's however more likely that "bar" is the
6985 ;; declarator and "gnu" a function argument or initializer (if
6986 ;; `c-recognize-paren-inits' is set), since the parens around
6987 ;; "gnu" would be superfluous if it's a declarator. Shift the
6988 ;; type one step backward.
6991 ;; Found no identifier.
6997 ;; CASE 3
6999 ;; Got a plain list of identifiers. If a colon follows it's
7000 ;; a valid label, or maybe a bitfield. Otherwise the last
7001 ;; one probably is the declared identifier and we should
7002 ;; back up to the previous type, providing it isn't a cast.
7006 ;; If we've found a specifier keyword then it's a
7007 ;; declaration regardless.
7018 ;; CASE 4
7022 ;; Got a plain list of identifiers followed by some suffix.
7023 ;; If this isn't a cast then the last identifier probably is
7024 ;; the declared one and we should back up to the previous
7025 ;; type.
7029 ;; CASE 5
7031 ;; If the type is known we know that there can't be any
7032 ;; identifier somewhere else, and it's only in declarations in
7033 ;; e.g. function prototypes and in casts that the identifier may
7034 ;; be left out.
7038 ;; Only got a single identifier (parsed as a type so far).
7039 ;; CASE 6
7041 ;; Check that the identifier isn't at the start of an
7042 ;; expression.
7043 at-decl-end
7046 ;; Inside an arglist that contains declarations. If K&R
7047 ;; style declarations and parenthesis style initializers
7048 ;; aren't allowed then the single identifier must be a
7049 ;; type, else we require that it's known or found
7050 ;; (primitive types are handled above).
7055 ;; Inside a template arglist. Accept known and found
7056 ;; types; other identifiers could just as well be
7057 ;; constants in C++.
7060 ;; CASE 7
7061 ;; Can't be a valid declaration or cast, but if we've found a
7062 ;; specifier it can't be anything else either, so treat it as
7063 ;; an invalid/unfinished declaration or cast.
7071 maybe-typeless
7072 backup-maybe-typeless
7076 c-after-suffixed-type-maybe-decl-key))))))
7077 ;; Got an empty paren pair and a preceding type that probably
7078 ;; really is the identifier. Shift the type backwards to make
7079 ;; the last one the identifier. This is analogous to the
7080 ;; "backtracking" done inside the `c-type-decl-suffix-key' loop
7081 ;; above.
7082 ;;
7083 ;; Exception: In addition to the conditions in that
7084 ;; "backtracking" code, do not shift backward if we're not
7085 ;; looking at either `c-after-suffixed-type-decl-key' or "[;,]".
7086 ;; Since there's no preceding type, the shift would mean that
7087 ;; the declaration is typeless. But if the regexp doesn't match
7088 ;; then we will simply fall through in the tests below and not
7089 ;; recognize it at all, so it's better to try it as an abstract
7090 ;; declarator instead.
7093 ;; Still no identifier.
7094 ;; CASE 8
7096 ;; Require `got-prefix' together with either `got-parens' or
7097 ;; `got-suffix' to recognize it as an abstract declarator:
7098 ;; `got-parens' only is probably an empty function call.
7099 ;; `got-suffix' only can build an ordinary expression together
7100 ;; with the preceding identifier which we've taken as a type.
7101 ;; We could actually accept on `got-prefix' only, but that can
7102 ;; easily occur temporarily while writing an expression so we
7103 ;; avoid that case anyway. We could do a better job if we knew
7104 ;; the point when the fontification was invoked.
7107 ;; CASE 9
7111 got-suffix-after-parens
7113 ;; Got a type, no declarator but a paren suffix. I.e. it's a
7114 ;; normal function call after all (or perhaps a C++ style object
7115 ;; instantiation expression).
7118 ;; CASE 10
7120 ;; By now we've located the type in the declaration that we know
7121 ;; we're in.
7124 ;; CASE 11
7132 ;; Shift the type backward in the case that there's a
7133 ;; single identifier inside parens. That can only
7134 ;; occur in K&R style function declarations so it's
7135 ;; more likely that it really is a function call.
7136 ;; Therefore we only do this after
7137 ;; `c-after-suffixed-type-decl-key' has matched.
7139 got-suffix-after-parens))
7140 ;; A declaration according to `c-after-suffixed-type-decl-key'.
7143 ;; CASE 12
7146 ;; It's a declaration if a known type precedes it and it can't be a
7147 ;; function call.
7150 ;; If we get here we can't tell if this is a type decl or a normal
7151 ;; expression by looking at it alone. (That's under the assumption
7152 ;; that normal expressions always can look like type decl expressions,
7153 ;; which isn't really true but the cases where it doesn't hold are so
7154 ;; uncommon (e.g. some placements of "const" in C++) it's not worth
7155 ;; the effort to look for them.)
7158 ;; If this is a declaration it should end here or its initializer(*)
7159 ;; should start here, so check for allowed separation tokens. Note
7160 ;; that this rule doesn't work e.g. with a K&R arglist after a
7161 ;; function header.
7162 ;;
7163 ;; *) Don't check for C++ style initializers using parens
7164 ;; since those already have been matched as suffixes.
7165 ;;
7166 ;; If `at-decl-or-cast' is then we've found some other sign that
7167 ;; it's a declaration or cast, so then it's probably an
7168 ;; invalid/unfinished one.
7171 ;; Below are tests that only should be applied when we're certain to
7172 ;; not have parsed halfway through an expression.
7174 ;; CASE 14
7176 ;; The expression starts with a known type so treat it as a
7177 ;; declaration.
7180 ;; CASE 15
7182 ;; In C++ we check if the identifier is a known type, since
7183 ;; (con|de)structors use the class name as identifier.
7184 ;; We've always shifted over the identifier as a type and
7185 ;; then backed up again in this case.
7186 identifier-type
7189 ;; `at-type' probably won't be 'found for
7190 ;; destructors since the "~" is then part of the
7191 ;; type name being checked against the list of
7192 ;; known types, so do a check without that
7193 ;; operator.
7198 c-identifier-syntax-table
7202 ;; We have already parsed the type earlier,
7203 ;; so it'd be possible to cache the end
7204 ;; position instead of redoing it here, but
7205 ;; then we'd need to keep track of another
7206 ;; position everywhere.
7214 ;; CASE 16
7216 at-type
7220 ;; Got something like "foo * bar;". Since we're not inside an
7221 ;; arglist it would be a meaningless expression because the
7222 ;; result isn't used. We therefore choose to recognize it as
7223 ;; a declaration. Do not allow a suffix since it could then
7224 ;; be a function call.
7227 ;; CASE 17
7232 ;; Got something like "a (*b) (c);" or "a (b) = c;". It could
7233 ;; be an odd expression or it could be a declaration. Treat
7234 ;; it as a declaration if "a" has been used as a type
7235 ;; somewhere else (if it's a known type we won't get here).
7238 ;; CASE 18
7244 ;; Got a type followed by an abstract declarator. If `got-prefix'
7245 ;; is set it's something like "a *" without anything after it. If
7246 ;; `got-parens' or `got-suffix' is set it's "a()", "a[]", "a()[]",
7247 ;; or similar, which we accept only if the context rules out
7248 ;; expressions.
7251 ;; If we had a complete symbol table here (which rules out
7252 ;; `c-found-types') we should return t due to the disambiguation rule
7253 ;; (in at least C++) that anything that can be parsed as a declaration
7254 ;; is a declaration. Now we're being more defensive and prefer to
7255 ;; highlight things like "foo (bar);" as a declaration only if we're
7256 ;; inside an arglist that contains declarations.
7259 ;; The point is now after the type decl expression.
7262 ;; Check for a cast.
7265 c-cast-parens
7267 ;; Should be the first type/identifier in a cast paren.
7271 ;; The closing paren should follow.
7276 ;; There should be a primary expression after it.
7285 ;; Check if the expression begins with a prefix keyword.
7288 ;; Expression begins with an ambiguous operator. Treat
7289 ;; it as a cast if it's a type decl or if we've
7290 ;; recognized the type somewhere else.
7293 ;; Unless it's a keyword, it's the beginning of a primary
7294 ;; expression.
7296 ;; If `c-primary-expr-regexp' matched a nonsymbol token, check
7297 ;; that it matched a whole one so that we don't e.g. confuse
7298 ;; the operator '-' with '->'. It's ok if it matches further,
7299 ;; though, since it e.g. can match the float '.5' while the
7300 ;; operator regexp only matches '.'.
7304 ;; There should either be a cast before it or something that isn't an
7305 ;; identifier or close paren.
7313 ;; It's a symbol. Accept it only if it's one of the
7314 ;; keywords that can precede an expression (without
7315 ;; surrounding parens).
7318 ;; Check that it isn't a close paren (block close is ok,
7319 ;; though).
7321 ;; Check that it isn't a nonsymbol identifier.
7324 ;; Handle the cast.
7334 ;; We're at a declaration. Highlight the type and the following
7335 ;; declarators.
7341 ;; Make sure to propagate the `c-decl-arg-start' property to
7342 ;; the next argument if it's set in this one, to cope with
7343 ;; interactive refontification.
7357 ;; False alarm. Restore the recorded ranges.
7359 c-record-ref-identifiers save-rec-ref-ids)
7360 nil))))
7363 ;; Assuming that point is at the beginning of a token, check if it starts a
7364 ;; label and if so move over it and return non-nil (t in default situations,
7365 ;; specific symbols (see below) for interesting situations), otherwise don't
7366 ;; move and return nil. "Label" here means "most things with a colon".
7367 ;;
7368 ;; More precisely, a "label" is regarded as one of:
7369 ;; (i) a goto target like "foo:" - returns the symbol `goto-target';
7370 ;; (ii) A case label - either the entire construct "case FOO:", or just the
7371 ;; bare "case", should the colon be missing. We return t;
7372 ;; (iii) a keyword which needs a colon, like "default:" or "private:"; We
7373 ;; return t;
7374 ;; (iv) One of QT's "extended" C++ variants of
7375 ;; "private:"/"protected:"/"public:"/"more:" looking like "public slots:".
7376 ;; Returns the symbol `qt-2kwds-colon'.
7377 ;; (v) QT's construct "signals:". Returns the symbol `qt-1kwd-colon'.
7378 ;; (vi) One of the keywords matched by `c-opt-extra-label-key' (without any
7379 ;; colon). Currently (2006-03), this applies only to Objective C's
7380 ;; keywords "@private", "@protected", and "@public". Returns t.
7381 ;;
7382 ;; One of the things which will NOT be recognized as a label is a bit-field
7383 ;; element of a struct, something like "int foo:5".
7384 ;;
7385 ;; The end of the label is taken to be just after the colon, or the end of
7386 ;; the first submatch in `c-opt-extra-label-key'. The point is directly
7387 ;; after the end on return. The terminating char gets marked with
7388 ;; `c-decl-end' to improve recognition of the following declaration or
7389 ;; statement.
7390 ;;
7391 ;; If ASSUME-MARKUP is non-nil, it's assumed that the preceding
7392 ;; label, if any, has already been marked up like that.
7393 ;;
7394 ;; If PRECEDING-TOKEN-END is given, it should be the first position
7395 ;; after the preceding token, i.e. on the other side of the
7396 ;; syntactic ws from the point. Use a value less than or equal to
7397 ;; (point-min) if the point is at the first token in (the visible
7398 ;; part of) the buffer.
7399 ;;
7400 ;; The optional LIMIT limits the forward scan for the colon.
7401 ;;
7402 ;; This function records the ranges of the label symbols on
7403 ;; `c-record-ref-identifiers' if `c-record-type-identifiers' (!) is
7404 ;; non-nil.
7405 ;;
7406 ;; This function might do hidden buffer changes.
7409 label-end
7410 qt-symbol-idx
7411 macro-start ; if we're in one.
7412 label-type
7413 kwd)
7415 ;; "case" or "default" (Doesn't apply to AWK).
7418 ;; Record only the keyword itself for fontification, since in
7419 ;; case labels the following is a constant expression and not
7420 ;; a label.
7424 ;; Find the label end.
7428 ;; Stop on chars that aren't allowed in expressions,
7429 ;; and on operator chars that would be meaningless
7430 ;; there. FIXME: This doesn't cope with ?: operators.
7438 t)
7440 ;; It's an unfinished label. We consider the keyword enough
7441 ;; to recognize it as a label, so that it gets fontified.
7442 ;; Leave the point at the end of it, but don't put any
7443 ;; `c-decl-end' marker.
7445 t))))
7447 ;; @private, @protected, @public, in Objective C, or similar.
7450 ;; For a `c-opt-extra-label-key' match, we record the whole
7451 ;; thing for fontification. That's to get the leading '@' in
7452 ;; Objective-C protection labels fontified.
7459 ;; All other cases of labels.
7462 ;; A colon label must have something before the colon.
7465 ;; Check that we're not after a token that can't precede a label.
7467 ;; Trivially succeeds when there's no preceding token.
7468 ;; Succeeds when we're at a virtual semicolon.
7477 ;; Check if we're after a label, if we're after a closing
7478 ;; paren that belong to statement, and with
7479 ;; `c-label-prefix-re'. It's done in different order
7480 ;; depending on `assume-markup' since the checks have
7481 ;; different expensiveness.
7508 ;; Might be after another label, so check it recursively.
7512 ;; Essentially the same as the
7513 ;; `c-syntactic-re-search-forward' regexp below.
7519 ;; Note: the following should work instead of the
7520 ;; narrow-to-region above. Investigate why not,
7521 ;; sometime. ACM, 2006-03-31.
7522 ;; (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+"
7523 ;; macro-start t)
7525 ;; If the caller turned on recording for us,
7526 ;; it shouldn't apply when we check the
7527 ;; preceding label.
7528 c-record-type-identifiers)
7529 ;; A label can't start at a cpp directive. Check for
7530 ;; this, since c-forward-syntactic-ws would foul up on it.
7535 ;; Point is still at the beginning of the possible label construct.
7536 ;;
7537 ;; Check that the next nonsymbol token is ":", or that we're in one
7538 ;; of QT's "slots" declarations. Allow '(' for the sake of macro
7539 ;; arguments. FIXME: Should build this regexp from the language
7540 ;; constants.
7542 ;; public: protected: private:
7552 ;; QT double keyword like "protected slots:" or goto target.
7571 'qt-1kwd-colon
7583 ;; Check that `c-nonlabel-token-key' doesn't match anywhere.
7593 t)
7596 ;; Record the identifiers in the label for fontification, unless
7597 ;; it begins with `c-label-kwds' in which case the following
7598 ;; identifiers are part of a (constant) expression that
7599 ;; shouldn't be fontified.
7611 ;; Not a label.
7613 label-type))
7616 ;; Assuming the point is at the beginning of a token, try to move
7617 ;; forward to the end of the Objective-C directive that starts
7618 ;; there. Return t if a directive was fully recognized, otherwise
7619 ;; the point is moved as far as one could be successfully parsed and
7620 ;; nil is returned.
7621 ;;
7622 ;; This function records identifier ranges on
7623 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
7624 ;; `c-record-type-identifiers' is non-nil.
7625 ;;
7626 ;; This function might do hidden buffer changes.
7629 start-char
7631 lim
7632 ;; Turn off recognition of angle bracket arglists while parsing
7633 ;; types here since the protocol reference list might then be
7634 ;; considered part of the preceding name or superclass-name.
7645 t)
7654 ;; Handle the name of the class itself.
7656 ; (c-forward-token-2) ; 2006/1/13 This doesn't move if the token's
7657 ; at EOB.
7664 ;; Look for ": superclass-name" or "( category-name )".
7675 ;; Look for a protocol reference list.
7681 t))))
7687 t)
7690 nil)))
7693 ;; Go to the first non-whitespace after the colon that starts a
7694 ;; multiple inheritance introduction. Optional LIM is the farthest
7695 ;; back we should search.
7696 ;;
7697 ;; This function might do hidden buffer changes.
7705 ;; Return nil if we aren't in a method definition, otherwise the
7706 ;; position of the initial [+-].
7707 ;;
7708 ;; This function might do hidden buffer changes.
7714 ))
7716 ;; Contributed by Kevin Ryde <user42@zip.com.au>.
7718 ;; Return non-nil if point is within a gcc \"asm\" block.
7719 ;;
7720 ;; This should be called with point inside an argument list.
7721 ;;
7722 ;; Only one level of enclosing parentheses is considered, so for
7723 ;; instance `nil' is returned when in a function call within an asm
7724 ;; operand.
7725 ;;
7726 ;; This function might do hidden buffer changes.
7738 a function.
7740 More precisely, being at the top-level means that point is either
7741 outside any enclosing block (such as a function definition), or
7742 directly inside a class, namespace or other block that contains
7743 another declaration level.
7745 If point is not at the top-level (e.g. it is inside a method
7746 definition), then nil is returned. Otherwise, if point is at a
7747 top-level not enclosed within a class definition, t is returned.
7748 Otherwise, a 2-vector is returned where the zeroth element is the
7749 buffer position of the start of the class declaration, and the first
7750 element is the buffer position of the enclosing class's opening
7751 brace.
7753 Note that this function might do hidden buffer changes. See the
7754 comment at the start of cc-engine.el for more info."
7760 ;; Return non-nil if the point is in the region after the argument
7761 ;; list of a function and its opening brace (or semicolon in case it
7762 ;; got no body). If there are K&R style argument declarations in
7763 ;; that region, the point has to be inside the first one for this
7764 ;; function to recognize it.
7765 ;;
7766 ;; If successful, the point is moved to the first token after the
7767 ;; function header (see `c-forward-decl-or-cast-1' for details) and
7768 ;; the position of the opening paren of the function arglist is
7769 ;; returned.
7770 ;;
7771 ;; The point is clobbered if not successful.
7772 ;;
7773 ;; LIM is used as bound for backward buffer searches.
7774 ;;
7775 ;; This function might do hidden buffer changes.
7788 ;; There should not be a '=' or ',' between beg and the
7789 ;; start of the declaration since that means we were in the
7790 ;; "expression part" of the declaration.
7795 ;; Check that there's an arglist paren in the
7796 ;; declaration.
7799 ;; The declarator is a paren expression, so skip past it
7800 ;; so that we don't get stuck on that instead of the
7801 ;; function arglist.
7805 ;; Don't trip up on "operator ()".
7812 ;; Return the position of the first argument declaration if point is
7813 ;; inside a K&R style argument declaration list, nil otherwise.
7814 ;; `c-recognize-knr-p' is not checked. If LIM is non-nil, it's a
7815 ;; position that bounds the backward search for the argument list.
7816 ;;
7817 ;; Point must be within a possible K&R region, e.g. just before a top-level
7818 ;; "{". It must be outside of parens and brackets. The test can return
7819 ;; false positives otherwise.
7820 ;;
7821 ;; This function might do hidden buffer changes.
7825 ;; If we're in a macro, our search range is restricted to it. Narrow to
7826 ;; the searchable range.
7830 before-lparen after-rparen
7832 ; we give up
7835 ;; Search backwards for the defun's argument list. We give up if we
7836 ;; encounter a "}" (end of a previous defun) an "=" (which can't be in
7837 ;; a knr region) or BOB.
7838 ;;
7839 ;; The criterion for a paren structure being the arg list is:
7840 ;; o - there is non-WS stuff after it but before any "{"; AND
7841 ;; o - the token after it isn't a ";" AND
7842 ;; o - it is preceded by either an identifier (the function name) or
7843 ;; a macro expansion like "DEFUN (...)"; AND
7844 ;; o - its content is a non-empty comma-separated list of identifiers
7845 ;; (an empty arg list won't have a knr region).
7846 ;;
7847 ;; The following snippet illustrates these rules:
7848 ;; int foo (bar, baz, yuk)
7849 ;; int bar [] ;
7850 ;; int (*baz) (my_type) ;
7851 ;; int (*) (void) (*yuk) (void) ;
7852 ;; {
7863 ; parens/brackets.
7867 ;; We're inside a paren. Could it be our argument list....?
7873 ;; FIXME!!! What about macros between the parens? 2007/01/20
7876 ;; It can't be the arg list if next token is ; or {
7881 ;; Is the thing preceding the list an identifier (the
7882 ;; function name), or a macro expansion?
7892 ;; Have we got a non-empty list of comma-separated
7893 ;; identifiers?
7907 ;; ...Yes. We've identified the function's argument list.
7913 ;; ...No. The current parens aren't the function's arg list.
7920 ;; skip forward over conditional at point, including any predicate
7921 ;; statements in parentheses. No error checking is performed.
7922 ;;
7923 ;; This function might do hidden buffer changes.
7925 ;; else if()
7930 ;; do, else, try, finally
7935 ;; for, if, while, switch, catch, synchronized, foreach
7939 ;; If looking at the token after a conditional then return the
7940 ;; position of its start, otherwise return nil.
7941 ;;
7942 ;; This function might do hidden buffer changes.
7952 ;; If the point is after an operator identifier that isn't handled
7953 ;; like an ordinary symbol (i.e. like "operator =" in C++) then the
7954 ;; position of the start of that identifier is returned. nil is
7955 ;; returned otherwise. The point may be anywhere in the syntactic
7956 ;; whitespace after the last token of the operator identifier.
7957 ;;
7958 ;; This function might do hidden buffer changes.
7970 ;; Assuming point is at a brace that opens a statement block of some
7971 ;; kind, move to the proper anchor point for that block. It might
7972 ;; need to be adjusted further by c-add-stmt-syntax, but the
7973 ;; position at return is suitable as start position for that
7974 ;; function.
7975 ;;
7976 ;; This function might do hidden buffer changes.
7983 ;; Assuming point is at a brace that opens the block of a top level
7984 ;; declaration of some kind, move to the proper anchor point for
7985 ;; that block.
7986 ;;
7987 ;; This function might do hidden buffer changes.
7992 ;; Search forward for the end of the "header" of the current
7993 ;; declaration. That's the position where the definition body
7994 ;; starts, or the first variable initializer, or the ending
7995 ;; semicolon. I.e. search forward for the closest following
7996 ;; (syntactically relevant) '{', '=' or ';' token. Point is left
7997 ;; _after_ the first found token, or at point-max if none is found.
7998 ;;
7999 ;; This function might do hidden buffer changes.
8004 ;; In C++ we need to take special care to handle operator
8005 ;; tokens and those pesky template brackets.
8010 ;; Handle operator identifiers, i.e. ignore any
8011 ;; operator token preceded by "operator".
8018 t
8020 nil)))))
8029 ;; Go to the beginning of the current declaration, or the beginning
8030 ;; of the previous one if already at the start of it. Point won't
8031 ;; be moved out of any surrounding paren. Return a cons cell of the
8032 ;; form (MOVE . KNR-POS). MOVE is like the return value from
8033 ;; `c-beginning-of-statement-1'. If point skipped over some K&R
8034 ;; style argument declarations (and they are to be recognized) then
8035 ;; KNR-POS is set to the start of the first such argument
8036 ;; declaration, otherwise KNR-POS is nil. If LIM is non-nil, it's a
8037 ;; position that bounds the backward search.
8038 ;;
8039 ;; NB: Cases where the declaration continues after the block, as in
8040 ;; "struct foo { ... } bar;", are currently recognized as two
8041 ;; declarations, e.g. "struct foo { ... }" and "bar;" in this case.
8042 ;;
8043 ;; This function might do hidden buffer changes.
8049 ;; `c-beginning-of-statement-1' stops at a block start, but we
8050 ;; want to continue if the block doesn't begin a top level
8051 ;; construct, i.e. if it isn't preceded by ';', '}', ':', bob,
8052 ;; or an open paren.
8054 ;; Go back one "statement" each time round the loop until we're just
8055 ;; after a ;, }, or :, or at BOB or the start of a macro or start of
8056 ;; an ObjC method. This will move over a multiple declaration whose
8057 ;; components are comma separated.
8059 ;; Must check with c-opt-method-key in ObjC mode.
8069 ;; Check that we don't move from the first thing in a
8070 ;; macro to its header.
8076 move tentative-move))
8081 ;; Handle K&R argdecls. Back up after the "statement" jumped
8082 ;; over by `c-beginning-of-statement-1', unless it was the
8083 ;; function body, in which case we're sitting on the opening
8084 ;; brace now. Then test if we're in a K&R argdecl region and
8085 ;; that we started at the other side of the first argdecl in
8086 ;; it.
8096 'previous
8098 knr-argdecl-start))
8101 ;; `c-beginning-of-statement-1' counts each brace block as a separate
8102 ;; statement, so the result will be 'previous if we've moved over any.
8103 ;; So change our result back to 'same if necessary.
8104 ;;
8105 ;; If they were brace list initializers we might not have moved over a
8106 ;; declaration boundary though, so change it to 'same if we've moved
8107 ;; past a '=' before '{', but not ';'. (This ought to be integrated
8108 ;; into `c-beginning-of-statement-1', so we avoid this extra pass which
8109 ;; potentially can search over a large amount of text.). Take special
8110 ;; pains not to get mislead by C++'s "operator=", and the like.
8113 c++-template-syntax-table
8119 ; no more, or get to one which isn't an "operator ="
8122 c-overloadable-operators-regexp
8123 c-opt-op-identifier-prefix
8138 ;; Assuming point is at the start of a declaration (as detected by
8139 ;; e.g. `c-beginning-of-decl-1'), go to the end of it. Unlike
8140 ;; `c-beginning-of-decl-1', this function handles the case when a
8141 ;; block is followed by identifiers in e.g. struct declarations in C
8142 ;; or C++. If a proper end was found then t is returned, otherwise
8143 ;; point is moved as far as possible within the current sexp and nil
8144 ;; is returned. This function doesn't handle macros; use
8145 ;; `c-end-of-macro' instead in those cases.
8146 ;;
8147 ;; This function might do hidden buffer changes.
8150 c++-template-syntax-table
8158 ;; Stopped at the ';' in a K&R argdecl section which is
8159 ;; detected using the same criteria as in
8160 ;; `c-beginning-of-decl-1'. Move to the following block
8161 ;; start.
8165 ;; Encountered a block in the declaration. Jump over it.
8176 ;; Check for `c-opt-block-decls-with-vars-key'
8177 ;; before the first paren.
8180 c-opt-block-decls-with-vars-key
8182 lim t t t)
8185 ;; Check that the first following paren is
8186 ;; the block.
8188 lim t t t)
8190 ;; The declaration doesn't have any of the
8191 ;; `c-opt-block-decls-with-vars' keywords in the
8192 ;; beginning, so it ends here at the end of the block.
8200 nil)))
8203 ;; Assuming the point is at an open brace, check if it starts a
8204 ;; block that contains another declaration level, i.e. that isn't a
8205 ;; statement block or a brace list, and if so return non-nil.
8206 ;;
8207 ;; If the check is successful, the return value is the start of the
8208 ;; keyword that tells what kind of construct it is, i.e. typically
8209 ;; what `c-decl-block-key' matched. Also, if GOTO-START is set then
8210 ;; the point will be at the start of the construct, before any
8211 ;; leading specifiers, otherwise it's at the returned position.
8212 ;;
8213 ;; The point is clobbered if the check is unsuccessful.
8214 ;;
8215 ;; CONTAINING-SEXP is the position of the open of the surrounding
8216 ;; paren, or nil if none.
8217 ;;
8218 ;; The optional LIMIT limits the backward search for the start of
8219 ;; the construct. It's assumed to be at a syntactically relevant
8220 ;; position.
8221 ;;
8222 ;; If any template arglists are found in the searched region before
8223 ;; the open brace, they get marked with paren syntax.
8224 ;;
8225 ;; This function might do hidden buffer changes.
8232 ;; Could be at the end of a template arglist.
8243 ;; Note: Can't get bogus hits inside template arglists below since they
8244 ;; have gotten paren syntax above.
8246 ;; If `goto-start' is set we begin by searching for the
8247 ;; first possible position of a leading specifier list.
8248 ;; The `c-decl-block-key' search continues from there since
8249 ;; we know it can't match earlier.
8252 open-brace t t)
8254 t)
8255 t)
8262 ;; Found a keyword that can't be a type?
8265 ;; Can be a type too, in which case it's the return type of a
8266 ;; function (under the assumption that no declaration level
8267 ;; block construct starts with a type).
8270 ;; Jumped over a type, but it could be a declaration keyword
8271 ;; followed by the declared identifier that we've jumped over
8272 ;; instead (e.g. in "class Foo {"). If it indeed is a type
8273 ;; then we should be at the declarator now, so check for a
8274 ;; valid declarator start.
8275 ;;
8276 ;; Note: This doesn't cope with the case when a declared
8277 ;; identifier is followed by e.g. '(' in a language where '('
8278 ;; also might be part of a declarator expression. Currently
8279 ;; there's no such language.
8283 ;; In Pike a list of modifiers may be followed by a brace
8284 ;; to make them apply to many identifiers. Note that the
8285 ;; match data will be empty on return in this case.
8291 ;; Use this variant to avoid yet another special regexp.
8295 t)))
8297 ;; Got a match.
8300 ;; Back up over any preceding specifiers and their clauses
8301 ;; by going forward from `first-specifier-pos', which is the
8302 ;; earliest possible position where the specifier list can
8303 ;; start.
8309 ;; Accept any plain symbol token on the ground that
8310 ;; it's a specifier masked through a macro (just
8311 ;; like `c-forward-decl-or-cast-1' skip forward over
8312 ;; such tokens).
8313 ;;
8314 ;; Could be more restrictive wrt invalid keywords,
8315 ;; but that'd only occur in invalid code so there's
8316 ;; no use spending effort on it.
8322 ;; Can't parse a declaration preamble and is still
8323 ;; before `kwd-start'. That means `first-specifier-pos'
8324 ;; was in some earlier construct. Search again.
8328 ;; Got no preamble before the block declaration keyword.
8334 kwd-start)))
8337 ;; Check if the closest containing paren sexp is a declaration
8338 ;; block, returning a 2 element vector in that case. Aref 0
8339 ;; contains the bufpos at boi of the class key line, and aref 1
8340 ;; contains the bufpos of the open brace. This function is an
8341 ;; obsolete wrapper for `c-looking-at-decl-block'.
8342 ;;
8343 ;; This function might do hidden buffer changes.
8351 nil))
8356 ;; Pull the next open brace from PS (which has the form of paren-state),
8357 ;; skipping over any brace pairs. Returns NIL when PS is exhausted.
8365 ;; Return the buffer position of the most enclosing decl-block brace (in the
8366 ;; sense of c-looking-at-decl-block) in the PAREN-STATE structure, or nil if
8367 ;; none was found.
8376 open-brace))
8379 ;; Return the position of the L-brace if point is inside a brace list
8380 ;; initialization of an array, etc. This is an approximate function,
8381 ;; designed for speed over accuracy. It will not find every bracelist, but
8382 ;; a non-nil result is reliable. We simply search for "= {" (naturally with
8383 ;; syntactic whitespace allowed). PAREN-STATE is the normal thing that it
8384 ;; is everywhere else.
8393 b-pos)))
8396 ;; return the buffer position of the beginning of the brace list
8397 ;; statement if we're inside a brace list, otherwise return nil.
8398 ;; CONTAINING-SEXP is the buffer pos of the innermost containing
8399 ;; paren. PAREN-STATE is the remainder of the state of enclosing
8400 ;; braces
8401 ;;
8402 ;; N.B.: This algorithm can potentially get confused by cpp macros
8403 ;; placed in inconvenient locations. It's a trade-off we make for
8404 ;; speed.
8405 ;;
8406 ;; This function might do hidden buffer changes.
8408 ;; This will pick up brace list declarations.
8421 ;; this will pick up array/aggregate init lists, even if they are nested.
8424 ;; Pike can have class definitions anywhere, so we must
8425 ;; check for the class key here.
8427 c-decl-block-key))
8428 bufpos braceassignp lim next-containing)
8430 containing-sexp)
8441 ;; We're in an in-expression block of some kind. Do not
8442 ;; check nesting. We deliberately set the limit to the
8443 ;; containing sexp, so that c-looking-at-inexpr-block
8444 ;; doesn't check for an identifier before it.
8446 ;; see if the open brace is preceded by = or [...] in
8447 ;; this statement, but watch out for operator=
8450 ;; Checks to do only on the first sexp before the brace.
8453 ;; In Java, an initialization brace list may follow
8454 ;; directly after "new Foo[]", so check for a "new"
8455 ;; earlier.
8461 ;; Carry on looking if this is an
8462 ;; identifier (may contain "." in Java)
8463 ;; or another "[]" sexp.
8466 ;; Checks to do on all sexps before the brace, up to the
8467 ;; beginning of the statement.
8475 ;; We've seen a =, but must check earlier tokens so
8476 ;; that it isn't something that should be ignored.
8482 ;; Check for operator =
8485 nil)
8486 ;; Check for `<opchar>= in Pike.
8489 ;; Special case for Pikes
8490 ;; `[]=, since '[' is not in
8491 ;; the punctuation class.
8494 nil)
8496 ;; make sure we're not in a C++ template
8497 ;; argument assignment
8509 ))))
8510 nil)
8517 ;; Brace lists can't contain a semicolon, so we're done.
8519 ;; Go up one level.
8521 lim nil
8522 next-containing nil))
8523 ;; we've hit the beginning of the aggregate list
8527 )
8528 bufpos))
8529 ))
8532 ;; If we're looking at the start of a pike-style list, ie `({Â })',
8533 ;; `([Â ])', `(<Â >)' etc, a cons of a cons of its starting and ending
8534 ;; positions and its entry in c-special-brace-lists is returned, nil
8535 ;; otherwise. The ending position is nil if the list is still open.
8536 ;; LIM is the limit for forward search. The point may either be at
8537 ;; the `(' or at the following paren character. Tries to check the
8538 ;; matching closer, but assumes it's correct if no balanced paren is
8539 ;; found (i.e. the case `({ ... } ... )' is detected as _not_ being
8540 ;; a special brace list).
8541 ;;
8542 ;; This function might do hidden buffer changes.
8547 inner-beg end type)
8562 nil)))))
8572 ;; Check balancing of the inner paren
8573 ;; below.
8576 t)
8577 ;; If the inner char isn't a paren then
8578 ;; we can't check balancing, so just
8579 ;; check the char before the outer
8580 ;; closing paren.
8595 ;; Return non-nil if between two statements or declarations, assuming
8596 ;; point is not inside a literal or comment.
8597 ;;
8598 ;; Obsolete - `c-at-statement-start-p' or `c-at-expression-start-p'
8599 ;; are recommended instead.
8600 ;;
8601 ;; This function might do hidden buffer changes.
8606 ;; Return non-nil if we're looking at the beginning of a block
8607 ;; inside an expression. The value returned is actually a cons of
8608 ;; either 'inlambda, 'inexpr-statement or 'inexpr-class and the
8609 ;; position of the beginning of the construct.
8610 ;;
8611 ;; LIM limits the backward search. CONTAINING-SEXP is the start
8612 ;; position of the closest containing list. If it's nil, the
8613 ;; containing paren isn't used to decide whether we're inside an
8614 ;; expression or not. If both LIM and CONTAINING-SEXP are used, LIM
8615 ;; needs to be farther back.
8616 ;;
8617 ;; If CHECK-AT-END is non-nil then extra checks at the end of the
8618 ;; brace block might be done. It should only be used when the
8619 ;; construct can be assumed to be complete, i.e. when the original
8620 ;; starting position was further down than that.
8621 ;;
8622 ;; This function might do hidden buffer changes.
8627 ;; Look at the character after point only as a last resort
8628 ;; when we can't disambiguate.
8648 ;; If the class definition is at the start of
8649 ;; a statement, we don't consider it an
8650 ;; in-expression class.
8658 ;; Also, in Pike we treat it as an
8659 ;; in-expression class if it's used in an
8660 ;; object clone expression.
8676 nil)
8684 ;; Accept several square bracket sexps for
8685 ;; Java array initializations.
8693 block-follows
8694 containing-sexp
8703 nil
8706 res))))
8709 ;; Returns non-nil if we're looking at the end of an in-expression
8710 ;; block, otherwise the same as `c-looking-at-inexpr-block'.
8711 ;; PAREN-STATE is the paren state relevant at the current position.
8712 ;;
8713 ;; This function might do hidden buffer changes.
8715 ;; We currently only recognize a block.
8718 containing-sexp)
8727 paren-state)
8728 containing-sexp)))))
8731 ;; Is there a "virtual semicolon" at POS or point?
8732 ;; (See cc-defs.el for full details of "virtual semicolons".)
8733 ;;
8734 ;; This is true when point is at the last non syntactic WS position on the
8735 ;; line, there is a macro call last on the line, and this particular macro's
8736 ;; name is defined by the regexp `c-vs-macro-regexp' as not needing a
8737 ;; semicolon.
8745 c-macro-with-semi-re
8748 ;; Check we've got nothing after this except comments and empty lines
8749 ;; joined by escaped EOLs.
8762 nil)
8770 ;; Check for one of the listed macros being before point.
8774 t))
8782 \f
8783 ;; `c-guess-basic-syntax' and the functions that precedes it below
8784 ;; implements the main decision tree for determining the syntactic
8785 ;; analysis of the current line of code.
8787 ;; Dynamically bound to t when `c-guess-basic-syntax' is called during
8788 ;; auto newline analysis.
8792 ;; BRACEPOS is the position of a brace in a construct like "namespace
8793 ;; Bar {". Return the anchor point in this construct; this is the
8794 ;; earliest symbol on the brace's line which isn't earlier than
8795 ;; "namespace".
8796 ;;
8797 ;; Currently (2007-08-17), "like namespace" means "matches
8798 ;; c-other-block-decl-kwds". It doesn't work with "class" or "struct"
8799 ;; or anything like that.
8809 ;; A simple function to prepend a new syntax element to
8810 ;; `c-syntactic-context'. Using `setq' on it is unsafe since it
8811 ;; should always be dynamically bound but since we read it first
8812 ;; we'll fail properly anyway if this function is misused.
8814 c-syntactic-context)))
8817 ;; Like `c-add-syntax' but appends to the end of the syntax list.
8818 ;; (Normally not necessary.)
8823 syntax-extra-args
8824 stop-at-boi-only
8825 containing-sexp
8826 paren-state)
8827 ;; Add the indicated SYNTAX-SYMBOL to `c-syntactic-context', extending it as
8828 ;; needed with further syntax elements of the types `substatement',
8829 ;; `inexpr-statement', `arglist-cont-nonempty', `statement-block-intro', and
8830 ;; `defun-block-intro'.
8831 ;;
8832 ;; Do the generic processing to anchor the given syntax symbol on
8833 ;; the preceding statement: Skip over any labels and containing
8834 ;; statements on the same line, and then search backward until we
8835 ;; find a statement or block start that begins at boi without a
8836 ;; label or comment.
8837 ;;
8838 ;; Point is assumed to be at the prospective anchor point for the
8839 ;; given SYNTAX-SYMBOL. More syntax entries are added if we need to
8840 ;; skip past open parens and containing statements. Most of the added
8841 ;; syntax elements will get the same anchor point - the exception is
8842 ;; for an anchor in a construct like "namespace"[*] - this is as early
8843 ;; as possible in the construct but on the same line as the {.
8844 ;;
8845 ;; [*] i.e. with a keyword matching c-other-block-decl-kwds.
8846 ;;
8847 ;; SYNTAX-EXTRA-ARGS are a list of the extra arguments for the
8848 ;; syntax symbol. They are appended after the anchor point.
8849 ;;
8850 ;; If STOP-AT-BOI-ONLY is nil, we can stop in the middle of the line
8851 ;; if the current statement starts there.
8852 ;;
8853 ;; Note: It's not a problem if PAREN-STATE "overshoots"
8854 ;; CONTAINING-SEXP, i.e. contains info about parens further down.
8855 ;;
8856 ;; This function might do hidden buffer changes.
8859 ;; This is by far the most common case, so let's give it special
8860 ;; treatment.
8865 ;; Set when we're on a label, so that we don't stop there.
8866 ;; FIXME: To be complete we should check if we're on a label
8867 ;; now at the start.
8868 on-label)
8870 ;; Use point as the anchor point for "namespace", "extern", etc.
8874 syntax-extra-args)
8876 ;; Loop while we have to back out of containing blocks.
8881 ;; Loop while we have to back up statements.
8883 on-label
8886 ;; Skip past any comments that stands between the
8887 ;; statement start and boi.
8895 ;; Skip to the beginning of this statement or backward
8896 ;; another one.
8904 ;; If we didn't move we're at the start of a block and
8905 ;; have to continue outside it.
8914 ;; Special case to avoid deeper and deeper indentation
8915 ;; of "else if" clauses.
8916 )
8921 ;; If stop-at-boi-only is nil, we shouldn't back up
8922 ;; over previous or containing statements to try to
8923 ;; reach boi, so go back to the last position and
8924 ;; exit.
8931 ;; If we've moved into another statement then we
8932 ;; should no longer try to stop in the middle of a
8933 ;; line.
8936 ;; Record this as a substatement if we skipped up one
8937 ;; level.
8940 )))
8942 containing-sexp)
8944 ;; Now we have to go out of this block.
8947 ;; Don't stop in the middle of a special brace list opener
8948 ;; like "({".
8960 ;; Analyze the construct in front of the block we've stepped out
8961 ;; from and add the right syntactic element for it.
8964 step-type)
8967 ;; Stepped out of a parenthesis block, so we're in an
8968 ;; expression now.
8980 ;; Stepped out of an in-expression statement. This
8981 ;; syntactic element won't get an anchor pos.
8984 ;; A parenthesis normally belongs to an arglist.
8992 on-label nil))
8994 ;; Stepped out of a brace block.
9006 containing-sexp)))
9008 'defun-block-intro
9010 nil))
9014 c-other-decl-block-key-in-symbols-alist))
9021 ;; Always done if the open brace was at boi. The
9022 ;; c-beginning-of-statement-1 call above is necessary
9023 ;; anyway, to decide the type of block-intro to add.
9026 ))
9028 ;; Fill in the current point as the anchor for all the symbols
9029 ;; added above.
9038 )))
9041 containing-decl-open
9042 containing-decl-start
9043 containing-decl-kwd
9044 paren-state)
9045 ;; The inclass and class-close syntactic symbols are added in
9046 ;; several places and some work is needed to fix everything.
9047 ;; Therefore it's collected here.
9048 ;;
9049 ;; This function might do hidden buffer changes.
9054 containing-decl-open)
9056 ;; Ought to use `c-add-stmt-syntax' instead of backing up to boi
9057 ;; here, but we have to do like this for compatibility.
9067 char-after-ip
9068 beg-of-same-or-containing-stmt
9069 containing-sexp
9070 paren-state)
9071 ;; This function contains the decision tree reached through both
9072 ;; cases 18 and 10. It's a continued statement or top level
9073 ;; construct of some kind.
9074 ;;
9075 ;; This function might do hidden buffer changes.
9082 ;; (CASE A removed.)
9083 ;; CASE B: open braces for class or brace-lists
9090 ;; CASE B.1: class-open
9097 ;; CASE B.2: brace-list-open
9102 indent-point t t t)))
9103 ;; The most semantically accurate symbol here is
9104 ;; brace-list-open, but we normally report it simply as a
9105 ;; statement-cont. The reason is that one normally adjusts
9106 ;; brace-list-open for brace lists as top-level constructs,
9107 ;; and brace lists inside statements is a completely different
9108 ;; context. C.f. case 5A.3.
9111 ;; Turn off the dwim above when we're
9112 ;; analyzing the nature of the brace
9113 ;; for the auto newline feature.
9114 'brace-list-open
9116 nil nil
9117 containing-sexp paren-state))
9119 ;; CASE B.3: The body of a function declared inside a normal
9120 ;; block. Can occur e.g. in Pike and when using gcc
9121 ;; extensions, but watch out for macros followed by blocks.
9122 ;; C.f. cases E, 16F and 17G.
9128 ;; Turn off recognition of constructs that lacks a
9129 ;; type in this case, since that's more likely to be
9130 ;; a macro followed by a block.
9133 containing-sexp paren-state))
9135 ;; CASE B.4: Continued statement with block open. The most
9136 ;; accurate analysis is perhaps `statement-cont' together with
9137 ;; `block-open' but we play DWIM and use `substatement-open'
9138 ;; instead. The rationale is that this typically is a macro
9139 ;; followed by a block which makes it very similar to a
9140 ;; statement with a substatement block.
9143 containing-sexp paren-state))
9144 ))
9146 ;; CASE C: iostream insertion or extraction operator
9150 ;; If there is no preceding streamop in the statement
9151 ;; then indent this line as a normal statement-cont.
9155 t))))
9157 ;; CASE E: In the "K&R region" of a function declared inside a
9158 ;; normal block. C.f. case B.3.
9160 ;; Check that the next token is a '{'. This works as
9161 ;; long as no language that allows nested function
9162 ;; definitions allows stuff like member init lists, K&R
9163 ;; declarations or throws clauses there.
9164 ;;
9165 ;; Note that we do a forward search for something ahead
9166 ;; of the indentation line here. That's not good since
9167 ;; the user might not have typed it yet. Unfortunately
9168 ;; it's exceedingly tricky to recognize a function
9169 ;; prototype in a code block without resorting to this.
9177 ;; Turn off recognition of constructs that lacks a
9178 ;; type in this case, since that's more likely to be
9179 ;; a macro followed by a block.
9182 containing-sexp paren-state))
9184 ;;CASE F: continued statement and the only preceding items are
9185 ;;annotations.
9193 t)
9200 ;; CASE G: a template list continuation?
9201 ;; Mostly a duplication of case 5D.3 to fix templates-19:
9219 ;; In a nested template arglist.
9225 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
9226 ;; template aware.
9229 ;; CASE D: continued statement.
9233 containing-sexp paren-state))
9234 )))
9236 ;; The next autoload was added by RMS on 2005/8/9 - don't know why (ACM,
9237 ;; 2005/11/29).
9238 ;;;###autoload
9240 "Return the syntactic context of the current line."
9246 ;; A whole ugly bunch of various temporary variables. Have
9247 ;; to declare them here since it's not possible to declare
9248 ;; a variable with only the scope of a cond test and the
9249 ;; following result clauses, and most of this function is a
9250 ;; single gigantic cond. :P
9251 literal char-before-ip before-ws-ip char-after-ip macro-start
9252 in-macro-expr c-syntactic-context placeholder c-in-literal-cache
9253 step-type tmpsymbol keyword injava-inher special-brace-list tmp-pos
9254 containing-<
9255 ;; The following record some positions for the containing
9256 ;; declaration block if we're directly within one:
9257 ;; `containing-decl-open' is the position of the open
9258 ;; brace. `containing-decl-start' is the start of the
9259 ;; declaration. `containing-decl-kwd' is the keyword
9260 ;; symbol of the keyword that tells what kind of block it
9261 ;; is.
9262 containing-decl-open
9263 containing-decl-start
9264 containing-decl-kwd
9265 ;; The open paren of the closest surrounding sexp or nil if
9266 ;; there is none.
9267 containing-sexp
9268 ;; The position after the closest preceding brace sexp
9269 ;; (nested sexps are ignored), or the position after
9270 ;; `containing-sexp' if there is none, or (point-min) if
9271 ;; `containing-sexp' is nil.
9272 lim
9273 ;; The paren state outside `containing-sexp', or at
9274 ;; `indent-point' if `containing-sexp' is nil.
9276 ;; There's always at most one syntactic element which got
9277 ;; an anchor pos. It's stored in syntactic-relpos.
9278 syntactic-relpos
9281 ;; Check if we're directly inside an enclosing declaration
9282 ;; level block.
9291 containing-sexp)
9292 t)))
9295 containing-sexp nil)
9300 ;; Init some position variables.
9309 ;; Ignore balanced paren. The next entry
9310 ;; can't be another one.
9313 ;; If there is no surrounding open paren then
9314 ;; put the last balanced pair back on paren-state.
9316 containing-sexp nil)))
9324 ;; If we're in a parenthesis list then ',' delimits the
9325 ;; "statements" rather than being an operator (with the
9326 ;; exception of the "for" clause). This difference is
9327 ;; typically only noticeable when statements are used in macro
9328 ;; arglists.
9332 ;; cache char before and after indent point, and move point to
9333 ;; the most likely position to perform the majority of tests
9342 ;; are we in a literal?
9345 ;; now figure out syntactic qualities of the current line
9348 ;; CASE 1: in a string.
9352 ;; CASE 2: in a C or C++ style comment.
9354 ;; This is a kludge for XEmacs where we use
9355 ;; `buffer-syntactic-context', which doesn't correctly
9356 ;; recognize "\*/" to end a block comment.
9357 ;; `parse-partial-sexp' which is used by
9358 ;; `c-literal-limits' will however do that in most
9359 ;; versions, which results in that we get nil from
9360 ;; `c-literal-limits' even when `c-in-literal' claims
9361 ;; we're inside a comment.
9365 ;; CASE 3: in a cpp preprocessor macro continuation.
9375 ;; If at the beginning of the body of a #define
9376 ;; directive then analyze as cpp-define-intro
9377 ;; only. Go on with the syntactic analysis
9378 ;; otherwise. in-macro-expr is set if we're in a
9379 ;; cpp expression, i.e. before the #define body
9380 ;; or anywhere in a non-#define directive.
9387 nil)))))
9391 ;; CASE 11: an else clause?
9395 containing-sexp paren-state))
9397 ;; CASE 12: while closure of a do/while construct?
9405 containing-sexp paren-state))
9407 ;; CASE 13: A catch or finally clause? This case is simpler
9408 ;; than if-else and do-while, because a block is required
9409 ;; after every try, catch and finally.
9417 t)
9421 t)
9424 t))
9429 containing-sexp paren-state))
9431 ;; CASE 18: A substatement we can recognize by keyword.
9441 ;; Ought to cache the result from the
9442 ;; c-beginning-of-statement-1 calls here.
9452 ;; Step up to the containing statement if we
9453 ;; stayed in the same one.
9461 ;; There was no containing statement after all.
9463 placeholder))
9465 ;; Require a parenthesis after these keywords.
9466 ;; Necessary to catch e.g. synchronized in Java,
9467 ;; which can be used both as statement and
9468 ;; modifier.
9474 ;; CASE 18A: Simple substatement.
9480 containing-sexp paren-state))
9486 containing-sexp paren-state))
9489 containing-sexp paren-state))))
9491 ;; CASE 18B: Some other substatement. This is shared
9492 ;; with case 10.
9494 char-after-ip
9495 placeholder
9496 lim
9497 paren-state)))
9499 ;; CASE 14: A case or default label
9505 containing-sexp))
9508 ;; Got a bogus label at the top level. In lack of better
9509 ;; alternatives, anchor it on (point-min).
9512 ;; CASE 15: any other label
9519 containing-decl-open
9520 containing-decl-start
9521 containing-decl-kwd
9522 paren-state))
9523 ;; Append access-label with the same anchor point as
9524 ;; inclass gets.
9530 containing-sexp))
9535 ;; If the surrounding statement is a switch then
9536 ;; let's analyze all labels as switch labels, so
9537 ;; that they get lined up consistently.
9538 'case-label
9544 ;; A label on the top level. Treat it as a class
9545 ;; context. (point-min) is the closest we get to the
9546 ;; class open brace.
9549 ;; CASE 4: In-expression statement. C.f. cases 7B, 16A and
9550 ;; 17E.
9553 containing-sexp
9554 ;; Have to turn on the heuristics after
9555 ;; the point even though it doesn't work
9556 ;; very well. C.f. test case class-16.pike.
9557 t))
9562 ;; It's a statement block or an anonymous class.
9564 ;; It's a Pike lambda. Check whether we are between the
9565 ;; lambda keyword and the argument list or at the defun
9566 ;; opener.
9568 'inline-open
9574 paren-state)
9578 ;; CASE 5: Line is inside a declaration level block or at top level.
9582 ;; CASE 5A: we are looking at a defun, brace list, class,
9583 ;; or inline-inclass method opening brace
9590 ;; CASE 5A.1: Non-class declaration block open.
9605 ;; Special case for extern-lang-open.
9606 'extern-lang-open
9608 nil t containing-sexp paren-state))
9610 ;; CASE 5A.2: we are looking at a class opening brace
9619 ;; CASE 5A.3: brace list open
9644 ))))
9648 ;; We're in Java and have found that the open brace
9649 ;; belongs to a "new Foo[]" initialization list,
9650 ;; which means the brace list is part of an
9651 ;; expression and not a top level definition. We
9652 ;; therefore treat it as any topmost continuation
9653 ;; even though the semantically correct symbol still
9654 ;; is brace-list-open, on the same grounds as in
9655 ;; case B.2.
9661 ;; CASE 5A.4: inline defun open
9667 containing-decl-open
9668 containing-decl-start
9669 containing-decl-kwd
9670 paren-state))
9672 ;; CASE 5A.5: ordinary defun open
9680 ;; Bogus to use bol here, but it's the legacy. (Resolved,
9681 ;; 2007-11-09)
9682 ))))
9684 ;; CASE 5B: After a function header but before the body (or
9685 ;; the ending semicolon if there's no body).
9692 ;; CASE 5B.1: Member init list.
9697 ;; There is no preceding member init clause.
9698 ;; Indent relative to the beginning of indentation
9699 ;; for the topmost-intro line that contains the
9700 ;; prototype's open paren.
9703 ;; Indent relative to the first member init clause.
9708 ;; CASE 5B.2: K&R arg decl intro
9715 containing-decl-open
9716 containing-decl-start
9717 containing-decl-kwd
9718 paren-state)))
9720 ;; CASE 5B.4: Nether region after a C++ or Java func
9721 ;; decl, which could include a `throws' declaration.
9725 )))
9727 ;; CASE 5C: inheritance line. could be first inheritance
9728 ;; line, or continuation of a multiple inheritance
9736 ;; watch out for scope operator
9741 )))
9750 ;; for Java
9755 cont done)
9760 done t))
9764 )
9766 injava-inher)
9769 ))
9772 ;; CASE 5C.1: non-hanging colon on an inher intro
9776 ;; don't add inclass symbol since relative point already
9777 ;; contains any class offset
9778 )
9780 ;; CASE 5C.2: hanging colon on an inher intro
9786 containing-decl-open
9787 containing-decl-start
9788 containing-decl-kwd
9789 paren-state)))
9791 ;; CASE 5C.3: in a Java implements/extends
9805 )))
9807 ;; CASE 5C.4: a continued inheritance line
9811 ;; don't add inclass symbol since relative point already
9812 ;; contains any class offset
9813 )))
9815 ;; CASE 5D: this could be a top-level initialization, a
9816 ;; member init list continuation, or a template argument
9817 ;; list continuation.
9819 ;; Note: We use the fact that lim is always after any
9820 ;; preceding brace sexp.
9830 t))
9835 t)
9841 nil)
9842 t))
9844 ;; NB: No c-after-special-operator-id stuff in this
9845 ;; clause - we assume only C++ needs it.
9850 ;; CASE 5D.3: perhaps a template list continuation?
9865 ;; In a nested template arglist.
9871 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
9872 ;; template aware.
9875 ;; CASE 5D.4: perhaps a multiple inheritance line?
9887 t)
9892 ;; CASE 5D.5: Continuation of the "expression part" of a
9893 ;; top level construct. Or, perhaps, an unrecognized construct.
9905 ;; A preceding comma at the top level means that a
9906 ;; new variable declaration starts here. Use
9907 ;; topmost-intro-cont for it, for consistency with
9908 ;; the first variable declaration. C.f. case 5N.
9911 nil nil containing-sexp paren-state))
9912 ))
9914 ;; CASE 5F: Close of a non-class declaration level block.
9918 ;; This is inconsistent: Should use `containing-decl-open'
9919 ;; here if it's at boi, like in case 5J.
9923 ;; Special case for compatibility with the
9924 ;; extern-lang syntactic symbols.
9925 'extern-lang-close
9928 nil t
9930 paren-state))
9932 ;; CASE 5G: we are looking at the brace which closes the
9933 ;; enclosing nested class decl
9938 containing-decl-open
9939 containing-decl-start
9940 containing-decl-kwd
9941 paren-state))
9943 ;; CASE 5H: we could be looking at subsequent knr-argdecls
9950 ;; Do an extra check to avoid tripping up on
9951 ;; statements that occur in invalid contexts
9952 ;; (e.g. in macro bodies where we don't really
9953 ;; know the context of what we're looking at).
9960 ;; CASE 5I: ObjC method definition.
9965 ;; Handle the case when it's the first (non-comment)
9966 ;; thing in the buffer. Can't look for a 'same return
9967 ;; value from cbos1 since ObjC directives currently
9968 ;; aren't recognized fully, so that we get 'same
9969 ;; instead of 'previous if it moved over a preceding
9970 ;; directive.
9974 ;; CASE 5P: AWK pattern or function or continuation
9975 ;; thereof.
9981 'topmost-intro-cont
9983 nil nil
9984 containing-sexp paren-state))
9986 ;; CASE 5N: At a variable declaration that follows a class
9987 ;; definition or some other block declaration that doesn't
9988 ;; end at the closing '}'. C.f. case 5D.5.
9997 ;; Speed up the backward search a bit.
10002 ;; The '}' is unbalanced.
10003 nil
10008 containing-sexp paren-state))
10010 ;; NOTE: The point is at the end of the previous token here.
10012 ;; CASE 5J: we are at the topmost level, make
10013 ;; sure we skip back past any access specifiers
10015 ;; A macro continuation line is never at top level.
10037 nil)))))
10038 ;; For historic reasons we anchor at bol of the last
10039 ;; line of the previous declaration. That's clearly
10040 ;; highly bogus and useless, and it makes our lives hard
10041 ;; to remain compatible. :P
10052 ;; Special case for compatibility with the
10053 ;; extern-lang syntactic symbols.
10054 'inextern-lang
10057 nil t
10059 paren-state))
10061 containing-decl-open
10062 containing-decl-start
10063 containing-decl-kwd
10064 paren-state)))
10066 macro-start
10071 ;; CASE 5K: we are at an ObjC method definition
10072 ;; continuation line.
10081 ;; CASE 5L: we are at the first argument of a template
10082 ;; arglist that begins on the previous line.
10090 ;; CASE 5Q: we are at a statement within a macro.
10095 ;;CASE 5N: We are at a topmost continuation line and the only
10096 ;;preceding items are annotations.
10103 t)
10109 ;; CASE 5M: we are at a topmost continuation line
10120 ))
10123 ;; (CASE 6 has been removed.)
10125 ;; CASE 7: line is an expression, not a statement. Most
10126 ;; likely we are either in a function prototype or a function
10127 ;; call argument list
10135 ;; CASE 7A: we are looking at the arglist closing paren.
10136 ;; C.f. case 7F.
10148 paren-state))
10150 ;; CASE 7B: Looking at the opening brace of an
10151 ;; in-expression block or brace list. C.f. cases 4, 16A
10152 ;; and 17E.
10156 paren-state))
10160 placeholder
10163 paren-state)
10164 containing-sexp)))
10165 ;; placeholder is nil if it's a block directly in
10166 ;; a function arglist. That makes us skip out of
10167 ;; this case.
10168 )))
10173 paren-state)
10177 ;; CASE 7C: we are looking at the first argument in an empty
10178 ;; argument list. Use arglist-close if we're actually
10179 ;; looking at a close paren or bracket.
10191 paren-state))
10193 ;; CASE 7D: we are inside a conditional test clause. treat
10194 ;; these things as statements
10204 ))
10206 ;; CASE 7E: maybe a continued ObjC method call. This is the
10207 ;; case when we are inside a [] bracketed exp, and what
10208 ;; precede the opening bracket is not an identifier.
10216 )))
10218 ;; CASE 7F: we are looking at an arglist continuation line,
10219 ;; but the preceding argument is on the same line as the
10220 ;; opening paren. This case includes multi-line
10221 ;; mathematical paren groupings, but we could be on a
10222 ;; for-list continuation line. C.f. case 7A.
10239 paren-state))
10241 ;; CASE 7G: we are looking at just a normal arglist
10242 ;; continuation line
10245 ))
10247 ;; CASE 8: func-local multi-inheritance line
10257 ;; CASE 8A: non-hanging colon on an inher intro
10262 ;; CASE 8B: hanging colon on an inher intro
10266 ;; CASE 8C: a continued inheritance line
10270 )))
10272 ;; CASE 9: we are inside a brace-list
10282 ;; CASE 9A: In the middle of a special brace list opener.
10302 ;; CASE 9B: brace-list-close brace
10304 ;; Check special brace list closer.
10311 ;; We were between the special close char and the `)'.
10314 ;; We were before the special close char.
10318 ;; Normal brace list check.
10329 ;; Prepare for the rest of the cases below by going to the
10330 ;; token following the opening brace
10343 ;; CASE 9C: we're looking at the first line in a brace-list
10354 ;; CASE 9D: this is just a later brace-list-entry or
10355 ;; brace-entry-open
10364 ))
10365 ))))
10367 ;; CASE 10: A continued statement or top level construct.
10377 ;; This is shared with case 18.
10379 char-after-ip
10380 placeholder
10381 containing-sexp
10382 paren-state))
10384 ;; CASE 16: block close brace, possibly closing the defun or
10385 ;; the class
10387 ;; From here on we have the next containing sexp in lim.
10392 ;; CASE 16E: Closing a statement block? This catches
10393 ;; cases where it's preceded by a statement keyword,
10394 ;; which works even when used in an "invalid" context,
10395 ;; e.g. a macro argument.
10400 ;; CASE 16A: closing a lambda defun or an in-expression
10401 ;; block? C.f. cases 4, 7B and 17E.
10404 nil))
10406 'inline-close
10416 paren-state)
10420 ;; CASE 16B: does this close an inline or a function in
10421 ;; a non-class declaration level block?
10428 nil))
10438 ;; CASE 16F: Can be a defun-close of a function declared
10439 ;; in a statement block, e.g. in Pike or when using gcc
10440 ;; extensions, but watch out for macros followed by
10441 ;; blocks. Let it through to be handled below.
10442 ;; C.f. cases B.3 and 17G.
10448 ;; Turn off recognition of constructs that
10449 ;; lacks a type in this case, since that's more
10450 ;; likely to be a macro followed by a block.
10457 ;; CASE 16C: If there is an enclosing brace then this is
10458 ;; a block close since defun closes inside declaration
10459 ;; level blocks have been handled above.
10461 ;; If the block is preceded by a case/switch label on
10462 ;; the same line, we anchor at the first preceding label
10463 ;; at boi. The default handling in c-add-stmt-syntax
10464 ;; really fixes it better, but we do like this to keep
10465 ;; the indentation compatible with version 5.28 and
10466 ;; earlier. C.f. case 17H.
10473 ;; c-backward-to-block-anchor not necessary here; those
10474 ;; situations are handled in case 16E above.
10477 ;; CASE 16D: Only top level defun close left.
10483 paren-state))
10484 ))
10486 ;; CASE 19: line is an expression, not a statement, and is directly
10487 ;; contained by a template delimiter. Most likely, we are in a
10488 ;; template arglist within a statement. This case is based on CASE
10489 ;; 7. At some point in the future, we may wish to create more
10490 ;; syntactic symbols such as `template-intro',
10491 ;; `template-cont-nonempty', etc., and distinguish between them as we
10492 ;; do for `arglist-intro' etc. (2009-12-07).
10498 ; '<') before indent-point.
10506 paren-state))
10508 ;; CASE 17: Statement or defun catchall.
10511 ;; Back up statements until we find one that starts at boi.
10514 containing-sexp)))
10518 nil)
10523 ;; CASE 17B: continued statement
10527 containing-sexp paren-state))
10529 ;; CASE 17A: After a case/default label?
10537 'statement-case-open
10539 nil t containing-sexp paren-state))
10541 ;; CASE 17D: any old statement
10548 containing-sexp paren-state)
10552 ;; CASE 17I: Inside a substatement block.
10554 ;; The following tests are all based on containing-sexp.
10556 ;; From here on we have the next containing sexp in lim.
10561 lim paren-state)
10565 ;; CASE 17E: first statement in an in-expression block.
10566 ;; C.f. cases 4, 7B and 16A.
10569 nil))
10571 'defun-block-intro
10580 paren-state)
10586 ;; CASE 17F: first statement in an inline, or first
10587 ;; statement in a top-level defun. we can tell this is it
10588 ;; if there are no enclosing braces that haven't been
10589 ;; narrowed out by a class (i.e. don't use bod here).
10592 paren-state)))
10598 nil))))
10603 ;; CASE 17G: First statement in a function declared inside
10604 ;; a normal block. This can occur in Pike and with
10605 ;; e.g. the gcc extensions, but watch out for macros
10606 ;; followed by blocks. C.f. cases B.3 and 16F.
10612 ;; Turn off recognition of constructs that lacks
10613 ;; a type in this case, since that's more likely
10614 ;; to be a macro followed by a block.
10620 lim paren-state))
10622 ;; CASE 17H: First statement in a block.
10624 ;; If the block is preceded by a case/switch label on the
10625 ;; same line, we anchor at the first preceding label at
10626 ;; boi. The default handling in c-add-stmt-syntax is
10627 ;; really fixes it better, but we do like this to keep the
10628 ;; indentation compatible with version 5.28 and earlier.
10629 ;; C.f. case 16C.
10636 ;; c-backward-to-block-anchor not necessary here; those
10637 ;; situations are handled in case 17I above.
10639 lim paren-state))
10642 ))
10643 )
10645 ;; now we need to look at any modifiers
10649 ;; are we looking at a comment only line?
10654 ;; we might want to give additional offset to friends (in C++).
10659 ;; Set syntactic-relpos.
10665 nil)
10666 t))
10669 ;; Start of or a continuation of a preprocessor directive?
10684 ;; If inside a cpp expression, i.e. anywhere in a
10685 ;; cpp directive except a #define body, we only let
10686 ;; through the syntactic analysis that is internal
10687 ;; in the expression. That means the arglist
10688 ;; elements, if they are anchored inside the cpp
10689 ;; expression.
10698 ;; Inside a #define body and the syntactic analysis is
10699 ;; anchored on the start of the #define. In this case
10700 ;; we add cpp-define-intro to get the extra
10701 ;; indentation of the #define body.
10704 ;; return the syntax
10705 c-syntactic-context)))
10707 \f
10708 ;; Indentation calculation.
10711 ;; offset can be a number, a function, a variable, a list, or one of
10712 ;; the symbols + or -
10713 ;;
10714 ;; This function might do hidden buffer changes.
10733 langelem symbol))
10739 offset symbol)
10740 nil)
10754 Error evaluating offset %S for %s: \
10755 Cannot combine absolute offset %S with relative %S in `%s' method"
10761 Error evaluating offset %S for %s: \
10762 Cannot combine relative offset %S with absolute %S in `%s' method"
10767 res))
10785 Error evaluating offset %S for %s: \
10786 Cannot combine absolute offsets %S and %S in `add' method"
10790 res))
10799 res))))
10806 nil))))
10810 res
10812 offset symbol res)
10813 nil)))
10816 ;; Get offset from LANGELEM which is a list beginning with the
10817 ;; syntactic symbol and followed by any analysis data it provides.
10818 ;; That data may be zero or more elements, but if at least one is
10819 ;; given then the first is the anchor position (or nil). The symbol
10820 ;; is matched against `c-offsets-alist' and the offset calculated
10821 ;; from that is returned.
10822 ;;
10823 ;; This function might do hidden buffer changes.
10833 offset
10837 ))
10840 ;; This is a compatibility wrapper for `c-calc-offset' in case
10841 ;; someone is calling it directly. It takes an old style syntactic
10842 ;; element on the form (SYMBOL . ANCHOR-POS) and converts it to the
10843 ;; new list form.
10844 ;;
10845 ;; This function might do hidden buffer changes.
10852 ;; Calculate the syntactic indentation from a syntactic description
10853 ;; as returned by `c-guess-syntax'.
10854 ;;
10855 ;; Note that topmost-intro always has an anchor position at bol, for
10856 ;; historical reasons. It's often used together with other symbols
10857 ;; that has more sane positions. Since we always use the first
10858 ;; found anchor position, we rely on that these other symbols always
10859 ;; precede topmost-intro in the LANGELEMS list.
10860 ;;
10861 ;; This function might do hidden buffer changes.
10869 ;; Got an absolute column that overrides any indentation
10870 ;; we've collected so far, but not the relative
10871 ;; indentation we might get for the nested structures
10872 ;; further down the langelems list.
10876 ;; Got a relative change of the current calculated
10877 ;; indentation.
10880 ;; Use the anchor position from the first syntactic
10881 ;; element with one.
10891 indent)))
10893 \f
10896 ;;; cc-engine.el ends here