| blob | 65e28c11e21c663c8488611ad68bef440d69edb9 |
1 ;;; cc-engine.el --- core syntax guessing engine for CC mode
3 ;; Copyright (C) 1985, 1987, 1992-2012 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 ;; Emacs <= 20 and XEmacs move back over the
1459 ;; closer of a block comment that lacks an opener.
1461 t)
1463 ;; XEmacs treats line continuations as whitespace but
1464 ;; only in the backward direction, which seems a bit
1465 ;; odd. Anyway, this is necessary for Emacs.
1470 t))))))
1472 \f
1473 ;; Tools for skipping over syntactic whitespace.
1475 ;; The following functions use text properties to cache searches over
1476 ;; large regions of syntactic whitespace. It works as follows:
1477 ;;
1478 ;; o If a syntactic whitespace region contains anything but simple
1479 ;; whitespace (i.e. space, tab and line breaks), the text property
1480 ;; `c-in-sws' is put over it. At places where we have stopped
1481 ;; within that region there's also a `c-is-sws' text property.
1482 ;; That since there typically are nested whitespace inside that
1483 ;; must be handled separately, e.g. whitespace inside a comment or
1484 ;; cpp directive. Thus, from one point with `c-is-sws' it's safe
1485 ;; to jump to another point with that property within the same
1486 ;; `c-in-sws' region. It can be likened to a ladder where
1487 ;; `c-in-sws' marks the bars and `c-is-sws' the rungs.
1488 ;;
1489 ;; o The `c-is-sws' property is put on the simple whitespace chars at
1490 ;; a "rung position" and also maybe on the first following char.
1491 ;; As many characters as can be conveniently found in this range
1492 ;; are marked, but no assumption can be made that the whole range
1493 ;; is marked (it could be clobbered by later changes, for
1494 ;; instance).
1495 ;;
1496 ;; Note that some part of the beginning of a sequence of simple
1497 ;; whitespace might be part of the end of a preceding line comment
1498 ;; or cpp directive and must not be considered part of the "rung".
1499 ;; Such whitespace is some amount of horizontal whitespace followed
1500 ;; by a newline. In the case of cpp directives it could also be
1501 ;; two newlines with horizontal whitespace between them.
1502 ;;
1503 ;; The reason to include the first following char is to cope with
1504 ;; "rung positions" that doesn't have any ordinary whitespace. If
1505 ;; `c-is-sws' is put on a token character it does not have
1506 ;; `c-in-sws' set simultaneously. That's the only case when that
1507 ;; can occur, and the reason for not extending the `c-in-sws'
1508 ;; region to cover it is that the `c-in-sws' region could then be
1509 ;; accidentally merged with a following one if the token is only
1510 ;; one character long.
1511 ;;
1512 ;; o On buffer changes the `c-in-sws' and `c-is-sws' properties are
1513 ;; removed in the changed region. If the change was inside
1514 ;; syntactic whitespace that means that the "ladder" is broken, but
1515 ;; a later call to `c-forward-sws' or `c-backward-sws' will use the
1516 ;; parts on either side and use an ordinary search only to "repair"
1517 ;; the gap.
1518 ;;
1519 ;; Special care needs to be taken if a region is removed: If there
1520 ;; are `c-in-sws' on both sides of it which do not connect inside
1521 ;; the region then they can't be joined. If e.g. a marked macro is
1522 ;; broken, syntactic whitespace inside the new text might be
1523 ;; marked. If those marks would become connected with the old
1524 ;; `c-in-sws' range around the macro then we could get a ladder
1525 ;; with one end outside the macro and the other at some whitespace
1526 ;; within it.
1527 ;;
1528 ;; The main motivation for this system is to increase the speed in
1529 ;; skipping over the large whitespace regions that can occur at the
1530 ;; top level in e.g. header files that contain a lot of comments and
1531 ;; cpp directives. For small comments inside code it's probably
1532 ;; slower than using `forward-comment' straightforwardly, but speed is
1533 ;; not a significant factor there anyway.
1535 ; (defface c-debug-is-sws-face
1536 ; '((t (:background "GreenYellow")))
1537 ; "Debug face to mark the `c-is-sws' property.")
1538 ; (defface c-debug-in-sws-face
1539 ; '((t (:underline t)))
1540 ; "Debug face to mark the `c-in-sws' property.")
1542 ; (defun c-debug-put-sws-faces ()
1543 ; ;; Put the sws debug faces on all the `c-is-sws' and `c-in-sws'
1544 ; ;; properties in the buffer.
1545 ; (interactive)
1546 ; (save-excursion
1547 ; (c-save-buffer-state (in-face)
1548 ; (goto-char (point-min))
1549 ; (setq in-face (if (get-text-property (point) 'c-is-sws)
1550 ; (point)))
1551 ; (while (progn
1552 ; (goto-char (next-single-property-change
1553 ; (point) 'c-is-sws nil (point-max)))
1554 ; (if in-face
1555 ; (progn
1556 ; (c-debug-add-face in-face (point) 'c-debug-is-sws-face)
1557 ; (setq in-face nil))
1558 ; (setq in-face (point)))
1559 ; (not (eobp))))
1560 ; (goto-char (point-min))
1561 ; (setq in-face (if (get-text-property (point) 'c-in-sws)
1562 ; (point)))
1563 ; (while (progn
1564 ; (goto-char (next-single-property-change
1565 ; (point) 'c-in-sws nil (point-max)))
1566 ; (if in-face
1567 ; (progn
1568 ; (c-debug-add-face in-face (point) 'c-debug-in-sws-face)
1569 ; (setq in-face nil))
1570 ; (setq in-face (point)))
1571 ; (not (eobp)))))))
1574 ;;`(message ,@args)
1575 )
1578 ;; This macro does a hidden buffer change.
1585 ;; This macro does a hidden buffer change.
1592 ;; This macro does a hidden buffer change.
1599 ;; This macro does a hidden buffer change.
1606 ;; This macro does a hidden buffer change.
1614 ;; Called from `after-change-functions'. Note that if
1615 ;; `c-forward-sws' or `c-backward-sws' are used outside
1616 ;; `c-save-buffer-state' or similar then this will remove the cache
1617 ;; properties right after they're added.
1618 ;;
1619 ;; This function does hidden buffer changes.
1622 ;; Adjust the end to remove the properties in any following simple
1623 ;; ws up to and including the next line break, if there is any
1624 ;; after the changed region. This is necessary e.g. when a rung
1625 ;; marked empty line is converted to a line comment by inserting
1626 ;; "//" before the line break. In that case the line break would
1627 ;; keep the rung mark which could make a later `c-backward-sws'
1628 ;; move into the line comment instead of over it.
1638 ;; Ensure that an `c-in-sws' range gets broken. Note that it isn't
1639 ;; safe to keep a range that was continuous before the change. E.g:
1640 ;;
1641 ;; #define foo
1642 ;; \
1643 ;; bar
1644 ;;
1645 ;; There can be a "ladder" between "#" and "b". Now, if the newline
1646 ;; after "foo" is removed then "bar" will become part of the cpp
1647 ;; directive instead of a syntactically relevant token. In that
1648 ;; case there's no longer syntactic ws from "#" to "b".
1655 ;; Used by `c-forward-syntactic-ws' to implement the unbounded search.
1656 ;;
1657 ;; This function might do hidden buffer changes.
1660 ;; unmarked part of the simple ws region.
1662 rung-is-marked next-rung-is-marked simple-ws-end
1663 ;; `safe-start' is set when it's safe to cache the start position.
1664 ;; It's not set if we've initially skipped over comments and line
1665 ;; continuations since we might have gone out through the end of a
1666 ;; macro then. This provision makes `c-forward-sws' not populate the
1667 ;; cache in the majority of cases, but otoh is `c-backward-sws' by far
1668 ;; more common.
1669 safe-start)
1671 ;; Skip simple ws and do a quick check on the following character to see
1672 ;; if it's anything that can't start syntactic ws, so we can bail out
1673 ;; early in the majority of cases when there just are a few ws chars.
1680 ;; Find the last rung position to avoid setting properties in all
1681 ;; the cases when the marked rung is complete.
1682 ;; (`next-single-property-change' is certain to move at least one
1683 ;; step forward.)
1686 ;; Got no marked rung here. Since the simple ws might have started
1687 ;; inside a line comment or cpp directive we must set `rung-pos' as
1688 ;; high as possible.
1697 ;; The following search is the main reason that `c-in-sws'
1698 ;; and `c-is-sws' aren't combined to one property.
1702 ;; If the `c-in-sws' region extended past the last
1703 ;; `c-is-sws' char we have to go back a bit.
1710 "c-forward-sws cached move %s -> %s (max %s)"
1717 ;; We'll loop here if there is simple ws after the last rung.
1718 ;; That means that there's been some change in it and it's
1719 ;; possible that we've stepped into another ladder, so extend
1720 ;; the previous one to join with it if there is one, and try to
1721 ;; use the cache again.
1723 "c-forward-sws extending rung with [%s..%s] (max %s)"
1726 ;; Remove any `c-in-sws' property from the last char of
1727 ;; the rung before we mark it with `c-is-sws', so that we
1728 ;; won't connect with the remains of a broken "ladder".
1734 last-put-in-sws-pos rung-pos)))
1741 ;; Skipped over comments. Don't cache at eob in case the buffer
1742 ;; is narrowed.
1753 ;; Skip a preprocessor directive.
1760 ;; Don't cache at eob in case the buffer is narrowed.
1763 ;; We've searched over a piece of non-white syntactic ws. See if this
1764 ;; can be cached.
1770 ;; Cache if we haven't skipped comments only, and if we started
1771 ;; either from a marked rung or from a completely uncached
1772 ;; position.
1777 ;; See if there's a marked rung in the encountered simple ws. If
1778 ;; so then we can cache, unless `safe-start' is nil. Even then
1779 ;; we need to do this to check if the cache can be used for the
1780 ;; next step.
1784 safe-start))
1788 "c-forward-sws caching [%s..%s] - [%s..%s] (max %s)"
1792 ;; Remove the properties for any nested ws that might be cached.
1793 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
1794 ;; anyway.
1802 last-put-in-sws-pos rung-pos))
1804 ;; Remove any `c-in-sws' property from the last char of
1805 ;; the rung before we mark it with `c-is-sws', so that we
1806 ;; won't connect with the remains of a broken "ladder".
1809 rung-end-pos))
1812 "c-forward-sws not caching [%s..%s] - [%s..%s] (max %s)"
1816 ;; Set `rung-pos' for the next rung. It's the same thing here as
1817 ;; initially, except that the rung position is set as early as
1818 ;; possible since we can't be in the ending ws of a line comment or
1819 ;; cpp directive now.
1826 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
1827 ;; another one after the point (which might occur when editing inside a
1828 ;; comment or macro).
1832 "c-forward-sws clearing at %s for cache separation"
1833 last-put-in-sws-pos)
1837 ;; If at eob we have to clear the last character before the end
1838 ;; instead since the buffer might be narrowed and there might
1839 ;; be a `c-in-sws' after (point-max). In this case it's
1840 ;; necessary to clear both properties.
1842 "c-forward-sws clearing thoroughly at %s for cache separation"
1845 last-put-in-sws-pos))))
1846 )))
1849 ;; Used by `c-backward-syntactic-ws' to implement the unbounded search.
1850 ;;
1851 ;; This function might do hidden buffer changes.
1854 ;; part of the simple ws region.
1856 rung-is-marked simple-ws-beg cmt-skip-pos)
1858 ;; Skip simple horizontal ws and do a quick check on the preceding
1859 ;; character to see if it's anything that can't end syntactic ws, so we can
1860 ;; bail out early in the majority of cases when there just are a few ws
1861 ;; chars. Newlines are complicated in the backward direction, so we can't
1862 ;; skip over them.
1869 ;; Try to find a rung position in the simple ws preceding point, so that
1870 ;; we can get a cache hit even if the last bit of the simple ws has
1871 ;; changed recently.
1877 ;; `rung-pos' will be the earliest marked position, which means that
1878 ;; there might be later unmarked parts in the simple ws region.
1879 ;; It's not worth the effort to fix that; the last part of the
1880 ;; simple ws is also typically edited often, so it could be wasted.
1891 ;; The following search is the main reason that `c-in-sws'
1892 ;; and `c-is-sws' aren't combined to one property.
1896 ;; If the `c-in-sws' region extended past the first
1897 ;; `c-is-sws' char we have to go forward a bit.
1902 "c-backward-sws cached move %s <- %s (min %s)"
1914 t
1916 nil))
1918 ;; We'll loop here if there is simple ws before the first rung.
1919 ;; That means that there's been some change in it and it's
1920 ;; possible that we've stepped into another ladder, so extend
1921 ;; the previous one to join with it if there is one, and try to
1922 ;; use the cache again.
1924 "c-backward-sws extending rung with [%s..%s] (min %s)"
1927 ;; Remove any `c-in-sws' property from the last char of
1928 ;; the rung before we mark it with `c-is-sws', so that we
1929 ;; won't connect with the remains of a broken "ladder".
1932 rung-pos)
1936 last-put-in-sws-pos rung-pos))
1945 ;; Inside a cpp directive. See if it should be skipped over.
1948 ;; Move back over all line continuations in the region skipped
1949 ;; over by `c-backward-comments'. If we go past it then we
1950 ;; started inside the cpp directive.
1959 ;; Don't move past the cpp directive if we began inside
1960 ;; it. Note that the position at the end of the last line
1961 ;; of the macro is also considered to be within it.
1963 nil)
1965 ;; It's worthwhile to spend a little bit of effort on finding
1966 ;; the end of the macro, to get a good `simple-ws-beg'
1967 ;; position for the cache. Note that `c-backward-comments'
1968 ;; could have stepped over some comments before going into
1969 ;; the macro, and then `simple-ws-beg' must be kept on the
1970 ;; same side of those comments.
1977 ;; Might happen if comments after the macro were skipped
1978 ;; over.
1982 t)))
1987 simple-ws-beg)
1988 ;; Skipped over comments. Must put point at the end of
1989 ;; the simple ws at point since we might be after a line
1990 ;; comment or cpp directive that's been partially
1991 ;; narrowed out, and we can't risk marking the simple ws
1992 ;; at the end of it.
1994 t)))
1996 ;; We've searched over a piece of non-white syntactic ws. See if this
1997 ;; can be cached.
2002 ;; Cache if we started either from a marked rung or from a
2003 ;; completely uncached position.
2004 rung-is-marked
2007 ;; Cache if there's a marked rung in the encountered simple ws.
2015 "c-backward-sws caching [%s..%s] - [%s..%s] (min %s)"
2020 ;; Remove the properties for any nested ws that might be cached.
2021 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
2022 ;; anyway.
2027 ;; Remove any `c-in-sws' property from the last char of
2028 ;; the rung before we mark it with `c-is-sws', so that we
2029 ;; won't connect with the remains of a broken "ladder".
2032 rung-end-pos)
2035 last-put-in-sws-pos simple-ws-beg)
2036 rung-pos)
2041 "c-backward-sws not caching [%s..%s] - [%s..%s] (min %s)"
2047 ))
2049 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
2050 ;; another one before the point (which might occur when editing inside a
2051 ;; comment or macro).
2055 "c-backward-sws clearing at %s for cache separation"
2058 last-put-in-sws-pos))
2060 ;; If at bob and the buffer is narrowed, we have to clear the
2061 ;; character we're standing on instead since there might be a
2062 ;; `c-in-sws' before (point-min). In this case it's necessary
2063 ;; to clear both properties.
2065 "c-backward-sws clearing thoroughly at %s for cache separation"
2066 last-put-in-sws-pos)
2069 )))
2071 \f
2072 ;; Other whitespace tools
2074 ;; Is the region (beg end) WS, and is there WS (or BOB/EOB) next to the
2075 ;; region? This is a "heuristic" function. .....
2076 ;;
2077 ;; The motivation for the second bit is to check whether removing this
2078 ;; region would coalesce two symbols.
2079 ;;
2080 ;; FIXME!!! This function doesn't check virtual semicolons in any way. Be
2081 ;; careful about using this function for, e.g. AWK. (2007/3/7)
2090 \f
2091 ;; A system for finding noteworthy parens before the point.
2094 ;; A maximum comfortable scanning distance, e.g. between
2095 ;; `c-state-cache-good-pos' and "HERE" (where we call c-parse-state). When
2096 ;; this distance is exceeded, we take "emergency measures", e.g. by clearing
2097 ;; the cache and starting again from point-min or a beginning of defun. This
2098 ;; value can be tuned for efficiency or set to a lower value for testing.
2102 ;; The state cache used by `c-parse-state' to cut down the amount of
2103 ;; searching. It's the result from some earlier `c-parse-state' call. See
2104 ;; `c-parse-state''s doc string for details of its structure.
2105 ;;
2106 ;; The use of the cached info is more effective if the next
2107 ;; `c-parse-state' call is on a line close by the one the cached state
2108 ;; was made at; the cache can actually slow down a little if the
2109 ;; cached state was made very far back in the buffer. The cache is
2110 ;; most effective if `c-parse-state' is used on each line while moving
2111 ;; forward.
2115 ;; This is a position where `c-state-cache' is known to be correct, or
2116 ;; nil (see below). It's a position inside one of the recorded unclosed
2117 ;; parens or the top level, but not further nested inside any literal or
2118 ;; subparen that is closed before the last recorded position.
2119 ;;
2120 ;; The exact position is chosen to try to be close to yet earlier than
2121 ;; the position where `c-state-cache' will be called next. Right now
2122 ;; the heuristic is to set it to the position after the last found
2123 ;; closing paren (of any type) before the line on which
2124 ;; `c-parse-state' was called. That is chosen primarily to work well
2125 ;; with refontification of the current line.
2126 ;;
2127 ;; 2009-07-28: When `c-state-point-min' and the last position where
2128 ;; `c-parse-state' or for which `c-invalidate-state-cache' was called, are
2129 ;; both in the same literal, there is no such "good position", and
2130 ;; c-state-cache-good-pos is then nil. This is the ONLY circumstance in which
2131 ;; it can be nil. In this case, `c-state-point-min-literal' will be non-nil.
2132 ;;
2133 ;; 2009-06-12: In a brace desert, c-state-cache-good-pos may also be in
2134 ;; the middle of the desert, as long as it is not within a brace pair
2135 ;; recorded in `c-state-cache' or a paren/bracket pair.
2138 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2139 ;; We maintain a simple cache of positions which aren't in a literal, so as to
2140 ;; speed up testing for non-literality.
2142 ;; The approximate interval between entries in `c-state-nonlit-pos-cache'.
2146 ;; A list of buffer positions which are known not to be in a literal or a cpp
2147 ;; construct. This is ordered with higher positions at the front of the list.
2148 ;; Only those which are less than `c-state-nonlit-pos-cache-limit' are valid.
2152 ;; An upper limit on valid entries in `c-state-nonlit-pos-cache'. This is
2153 ;; reduced by buffer changes, and increased by invocations of
2154 ;; `c-state-literal-at'.
2158 ;; A list of buffer positions which are known not to be in a literal. This is
2159 ;; ordered with higher positions at the front of the list. Only those which
2160 ;; are less than `c-state-semi-nonlit-pos-cache-limit' are valid.
2164 ;; An upper limit on valid entries in `c-state-semi-nonlit-pos-cache'. This is
2165 ;; reduced by buffer changes, and increased by invocations of
2166 ;; `c-state-literal-at'. FIXME!!!
2169 ;; Do a parse-partial-sexp from FROM to TO, returning either
2170 ;; (STATE TYPE (BEG . END)) if TO is in a literal; or
2171 ;; (STATE) otherwise,
2172 ;; where STATE is the parsing state at TO, TYPE is the type of the literal
2173 ;; (one of 'c, 'c++, 'string) and (BEG . END) is the boundaries of the literal.
2174 ;;
2175 ;; Only elements 3 (in a string), 4 (in a comment), 5 (following a quote),
2176 ;; 7 (comment type) and 8 (start of comment/string) (and possibly 9) of
2177 ;; STATE are valid.
2180 ty)
2187 nil ; TARGETDEPTH
2188 nil ; STOPBEFORE
2189 s ; OLDSTATE
2196 ;; Return a buffer position before HERE which is "safe", i.e. outside any
2197 ;; string, comment, or macro.
2198 ;;
2199 ;; NOTE: This function manipulates `c-state-nonlit-pos-cache'. This cache
2200 ;; MAY NOT contain any positions within macros, since macros are frequently
2201 ;; turned into comments by use of the `c-cpp-delimiter' category properties.
2202 ;; We cannot rely on this mechanism whilst determining a cache pos since
2203 ;; this function is also called from outwith `c-parse-state'.
2208 pos npos high-pos lit macro-beg macro-end)
2209 ;; Trim the cache to take account of buffer changes.
2221 ;; Add an element to `c-state-nonlit-pos-cache' each iteration.
2225 ;; Test for being in a literal. If so, go to after it.
2232 ;; Test for being in a macro. If so, go to after it.
2247 ;; Add one extra element above HERE so as to to avoid the previous
2248 ;; expensive calculation when the next call is close to the current
2249 ;; one. This is especially useful when inside a large macro.
2254 pos))))
2257 ;; Return a buffer position before HERE which is "safe", i.e. outside any
2258 ;; string or comment. It may be in a macro.
2263 pos npos high-pos lit macro-beg macro-end)
2264 ;; Trim the cache to take account of buffer changes.
2276 ;; Add an element to `c-state-semi-nonlit-pos-cache' each iteration.
2280 ;; Test for being in a literal. If so, go to after it.
2293 pos))))
2296 ;; If position HERE is inside a literal, return (START . END), the
2297 ;; boundaries of the literal (which may be outside the accessible bit of the
2298 ;; buffer). Otherwise, return nil.
2299 ;;
2300 ;; This function is almost the same as `c-literal-limits'. Previously, it
2301 ;; differed in that it was a lower level function, and that it rigorously
2302 ;; followed the syntax from BOB. `c-literal-limits' is now (2011-12)
2303 ;; virtually identical to this function.
2311 ;; Return the start of the literal containing POS, or POS itself.
2313 pos))
2316 ;; Return a position outside of a string/comment/macro at or before POS.
2317 ;; STATE is the parse-partial-sexp state at POS.
2321 pos)))
2326 res))))
2328 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2329 ;; Stuff to do with point-min, and coping with any literal there.
2332 ;; This is (point-min) when `c-state-cache' was last calculated. A change of
2333 ;; narrowing is likely to affect the parens that are visible before the point.
2339 ;; These two variables define the literal, if any, containing point-min.
2340 ;; Their values are, respectively, 'string, c, or c++, and the start of the
2341 ;; literal. If there's no literal there, they're both nil.
2345 ;; This is the earliest buffer-pos from which scanning can be done. It is
2346 ;; either the end of the literal containing point-min, or point-min itself.
2347 ;; It becomes nil if the buffer is changed earlier than this point.
2349 ;; Return the lowest valid scanning pos. This will be the end of the
2350 ;; literal enclosing point-min, or point-min itself.
2362 ;; Determine the properties of any literal containing POINT-MIN, setting the
2363 ;; variables `c-state-point-min-lit-type', `c-state-point-min-lit-start',
2364 ;; and `c-state-min-scan-pos' accordingly. The return value is meaningless.
2366 lit)
2381 c-state-point-min-lit-start nil
2382 c-state-min-scan-pos p-min)))))
2385 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2386 ;; A variable which signals a brace dessert - helpful for reducing the number
2387 ;; of fruitless backward scans.
2390 ;; Used only in `c-append-lower-brace-pair-to-state-cache'. It is set when
2391 ;; that defun has searched backwards for a brace pair and not found one. Its
2392 ;; value is either nil or a cons (PA . FROM), where PA is the position of the
2393 ;; enclosing opening paren/brace/bracket which bounds the backwards search (or
2394 ;; nil when at top level) and FROM is where the backward search started. It
2395 ;; is reset to nil in `c-invalidate-state-cache'.
2398 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2399 ;; Lowish level functions/macros which work directly on `c-state-cache', or a
2400 ;; list of like structure.
2402 ;; Return the address of the top left brace/bracket/paren recorded in CACHE
2403 ;; (default `c-state-cache') (or nil).
2410 ;; Return the address of the latest brace/bracket/paren (whether left or
2411 ;; right) recorded in CACHE (default `c-state-cache') or nil.
2418 ;; Return the position just after the latest brace/bracket/paren (whether
2419 ;; left or right) recorded in CACHE (default `c-state-cache') or nil.
2427 ;; From the state-cache, determine the buffer position from which we might
2428 ;; scan forward to HERE to update this cache. This position will be just
2429 ;; after a paren/brace/bracket recorded in the cache, if possible, otherwise
2430 ;; return the earliest position in the accessible region which isn't within
2431 ;; a literal. If the visible portion of the buffer is entirely within a
2432 ;; literal, return NIL.
2434 ;(while (>= (or (c-state-cache-top-lparen c) 1) here)
2450 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2451 ;; Variables which keep track of preprocessor constructs.
2456 ;; These are the limits of the macro containing point at the previous call of
2457 ;; `c-parse-state', or nil.
2459 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2460 ;; Defuns which analyze the buffer, yet don't change `c-state-cache'.
2462 ;; Return a start position for building `c-state-cache' from
2463 ;; scratch. This will be at the top level, 2 defuns back.
2465 ;; Go back 2 bods, but ignore any bogus positions returned by
2466 ;; beginning-of-defun (i.e. open paren in column zero).
2476 ;; Return the position of the opening paren/brace/bracket before HERE- which
2477 ;; matches the outermost close p/b/b between HERE+ and TOP. Except when
2478 ;; there's a macro, HERE- and HERE+ are the same. Like this:
2479 ;;
2480 ;; ............................................
2481 ;; | |
2482 ;; ( [ ( .........#macro.. ) ( ) ] )
2483 ;; ^ ^ ^ ^
2484 ;; | | | |
2485 ;; return HERE- HERE+ TOP
2486 ;;
2487 ;; If there aren't enough opening paren/brace/brackets, return the position
2488 ;; of the outermost one found, or HERE- if there are none. If there are no
2489 ;; closing p/b/bs between HERE+ and TOP, return HERE-. HERE-/+ and TOP
2490 ;; must not be inside literals. Only the accessible portion of the buffer
2491 ;; will be scanned.
2493 ;; PART 1: scan from `here+' up to `top', accumulating ")"s which enclose
2494 ;; `here'. Go round the next loop each time we pass over such a ")". These
2495 ;; probably match "("s before `here-'.
2507 ;; PART 2: Scan back before `here-' searching for the "("s
2508 ;; matching/mismatching the ")"s found above. We only need to direct the
2509 ;; caller to scan when we've encountered unmatched right parens.
2518 pos))
2521 ;; Determine the scanning strategy for adjusting `c-parse-state', attempting
2522 ;; to minimize the amount of scanning. HERE is the pertinent position in
2523 ;; the buffer, GOOD-POS is a position where `c-state-cache' (possibly with
2524 ;; its head trimmed) is known to be good, or nil if there is no such
2525 ;; position.
2526 ;;
2527 ;; The return value is a list, one of the following:
2528 ;;
2529 ;; o - ('forward CACHE-POS START-POINT) - scan forward from START-POINT,
2530 ;; which is not less than CACHE-POS.
2531 ;; o - ('backward CACHE-POS nil) - scan backwards (from HERE).
2532 ;; o - ('BOD nil START-POINT) - scan forwards from START-POINT, which is at the
2533 ;; top level.
2534 ;; o - ('IN-LIT nil nil) - point is inside the literal containing point-min.
2535 ;; , where CACHE-POS is the highest position recorded in `c-state-cache' at
2536 ;; or below HERE.
2538 BOD-pos ; position of 2nd BOD before HERE.
2539 strategy ; 'forward, 'backward, 'BOD, or 'IN-LIT.
2540 start-point
2546 start-point nil
2547 cache-pos nil
2559 start-point cache-pos)))
2561 ;; Might we be better off starting from the top level, two defuns back,
2562 ;; instead?
2567 start-point BOD-pos)))
2570 strategy
2575 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2576 ;; Routines which change `c-state-cache' and associated values.
2578 ;; The region (more precisely, point-min) has changed since we
2579 ;; calculated `c-state-cache'. Amend `c-state-cache' accordingly.
2581 ;; If point-min has MOVED BACKWARDS then we drop the state completely.
2582 ;; It would be possible to do a better job here and recalculate the top
2583 ;; only.
2587 c-state-cache-good-pos c-state-min-scan-pos
2588 c-state-brace-pair-desert nil))
2590 ;; point-min has MOVED FORWARD.
2592 ;; Is the new point-min inside a (different) literal?
2597 ;; Cut off a bit of the tail from `c-state-cache'.
2599 pa)
2607 c-state-cache-good-pos c-state-min-scan-pos)
2610 )))
2615 ;; If there is a brace pair preceding FROM in the buffer (not necessarily
2616 ;; immediately preceding), push a cons onto `c-state-cache' to represent it.
2617 ;; FROM must not be inside a literal. If UPPER-LIM is non-nil, we append
2618 ;; the highest brace pair whose "}" is below UPPER-LIM.
2619 ;;
2620 ;; Return non-nil when this has been done.
2621 ;;
2622 ;; This routine should be fast. Since it can get called a LOT, we maintain
2623 ;; `c-state-brace-pair-desert', a small cache of "failures", such that we
2624 ;; reduce the time wasted in repeated fruitless searches in brace deserts.
2628 new-cons
2636 ;; If we're essentially repeating a fruitless search, just give up.
2640 ;; Only search what we absolutely need to:
2645 ;; In the next pair of nested loops, the inner one moves back past a
2646 ;; pair of (mis-)matching parens or brackets; the outer one moves
2647 ;; back over a sequence of unmatched close brace/paren/bracket each
2648 ;; time round.
2662 ; brace, ignore it.
2665 ;; We've found the desired brace-pair.
2677 ;; We haven't found a brace pair. Record this.
2681 ;; If BRA+1 is nil, do nothing. Otherwise, BRA+1 is the buffer position
2682 ;; following a {, and that brace has a (mis-)matching } (or ]), and we
2683 ;; "push" "a" brace pair onto `c-state-cache'.
2684 ;;
2685 ;; Here "push" means overwrite the top element if it's itself a brace-pair,
2686 ;; otherwise push it normally.
2687 ;;
2688 ;; The brace pair we push is normally the one surrounding BRA+1, but if the
2689 ;; latter is inside a macro, not being a macro containing
2690 ;; MACRO-START-OR-HERE, we scan backwards through the buffer for a non-macro
2691 ;; base pair. This latter case is assumed to be rare.
2692 ;;
2693 ;; Note: POINT is not preserved in this routine.
2703 c-state-cache)))
2704 ;; N.B. This defsubst codes one method for the simple, normal case,
2705 ;; and a more sophisticated, slower way for the general case. Don't
2706 ;; eliminate this defsubst - it's a speed optimization.
2710 ;; Scan the buffer from FROM to (point-max), adding elements into
2711 ;; `c-state-cache' for braces etc. Return a candidate for
2712 ;; `c-state-cache-good-pos'.
2713 ;;
2714 ;; FROM must be after the latest brace/paren/bracket in `c-state-cache', if
2715 ;; any. Typically, it is immediately after it. It must not be inside a
2716 ;; literal.
2725 ; Is actually the pos. to scan for a (/{/[ from,
2726 ; which sometimes is after a silly )/}/].
2729 ; good-pos.
2735 ;; Each time round the following loop, we enter a successively deeper
2736 ;; level of brace/paren nesting. (Except sometimes we "continue at
2737 ;; the existing level".) `pa+1' is a pos inside an opening
2738 ;; brace/paren/bracket, usually just after it.
2741 ;; Each time round the next loop moves forward over an opening then
2742 ;; a closing brace/bracket/paren. This loop is white hot, so it
2743 ;; plays ugly tricks to go fast. DON'T PUT ANYTHING INTO THIS
2744 ;; LOOP WHICH ISN'T ABSOLUTELY NECESSARY!!! It terminates when a
2745 ;; call of `scan-lists' signals an error, which happens when there
2746 ;; are no more b/b/p's to scan.
2757 ;; We've just entered a deeper nesting level.
2759 ;; Insert the brace pair (if present) and the single open
2760 ;; paren/brace/bracket into `c-state-cache' It cannot be
2761 ;; inside a macro, except one around point, because of what
2762 ;; `c-neutralize-syntax-in-CPP' has done.
2764 ;; Insert the opening brace/bracket/paren position.
2766 ;; Clear admin stuff for the next more nested part of the scan.
2770 ;; All open p/b/b's at this nesting level, if any, have probably
2771 ;; been closed by matching/mismatching ones. We're probably
2772 ;; finished - we just need to check for having found an
2773 ;; unmatched )/}/], which we ignore. Such a )/}/] can't be in a
2774 ;; macro, due the action of `c-neutralize-syntax-in-CPP'.
2777 ;; Record the final, innermost, brace-pair if there is one.
2780 ;; Determine a good pos
2788 here-bol))
2797 ;; Remove stale entries from the `c-cache-state', i.e. those which will
2798 ;; not be in it when it is amended for position (point-max).
2799 ;; Additionally, the "outermost" open-brace entry before (point-max)
2800 ;; will be converted to a cons if the matching close-brace is scanned.
2801 ;;
2802 ;; GOOD-POS is a "maximal" "safe position" - there must be no open
2803 ;; parens/braces/brackets between GOOD-POS and (point-max).
2804 ;;
2805 ;; As a second thing, calculate the result of parse-partial-sexp at
2806 ;; PPS-POINT, w.r.t. GOOD-POS. The motivation here is that
2807 ;; `c-state-cache-good-pos' may become PPS-POINT, but the caller may need to
2808 ;; adjust it to get outside a string/comment. (Sorry about this! The code
2809 ;; needs to be FAST).
2810 ;;
2811 ;; Return a list (GOOD-POS SCAN-BACK-POS PPS-STATE), where
2812 ;; o - GOOD-POS is a position where the new value `c-state-cache' is known
2813 ;; to be good (we aim for this to be as high as possible);
2814 ;; o - SCAN-BACK-POS, if not nil, indicates there may be a brace pair
2815 ;; preceding POS which needs to be recorded in `c-state-cache'. It is a
2816 ;; position to scan backwards from.
2817 ;; o - PPS-STATE is the parse-partial-sexp state at PPS-POINT.
2827 ; or nil
2834 ; (point-max)), or nil.
2840 pps-state ; Will be 9 or 10 elements long.
2841 pos
2842 upper-lim ; ,beyond which `c-state-cache' entries are removed
2843 scan-back-pos
2844 pair-beg pps-point-state target-depth)
2846 ;; Remove entries beyond (point-max). Also remove any entries inside
2847 ;; a macro, unless (point-max) is in the same macro.
2856 ;; If `upper-lim' is inside the last recorded brace pair, remove its
2857 ;; RBrace and indicate we'll need to search backwards for a previous
2858 ;; brace pair.
2865 ;; The next loop jumps forward out of a nested level of parens each
2866 ;; time round; the corresponding elements in `c-state-cache' are
2867 ;; removed. `pos' is just after the brace-pair or the open paren at
2868 ;; (car c-state-cache). There can be no open parens/braces/brackets
2869 ;; between `good-pos'/`good-pos-actual-macro-start' and (point-max),
2870 ;; due to the interface spec to this function.
2873 in-macro-start)))
2875 ; marked by a `category' text property.
2876 good-pos))
2885 ;; Do nothing when we've merely reached pps-point.
2886 )
2888 ;; Scan!
2892 target-depth
2893 nil pps-state))
2903 ;; We've just moved out of the paren pair containing the brace-pair
2904 ;; at (car c-state-cache). `pair-beg' is where the open paren is,
2905 ;; and is potentially where the open brace of a cons in
2906 ;; c-state-cache will be.
2912 ; containing Lparen
2916 ; together with enclosed brace pair.
2917 ;; (t nil) ; Ignore an unmated Rparen.
2918 )))
2922 nil nil ; TARGETDEPTH, STOPBEFORE
2923 pps-state)))
2925 ;; If the last paren pair we moved out of was actually a brace pair,
2926 ;; insert it into `c-state-cache'.
2931 c-state-cache)))
2936 ;; Strip stale elements of `c-state-cache' by moving backwards through the
2937 ;; buffer, and inform the caller of the scenario detected.
2938 ;;
2939 ;; HERE is the position we're setting `c-state-cache' for.
2940 ;; CACHE-POS is just after the latest recorded position in `c-state-cache'
2941 ;; before HERE, or a position at or near point-min which isn't in a
2942 ;; literal.
2943 ;;
2944 ;; This function must only be called only when (> `c-state-cache-good-pos'
2945 ;; HERE). Usually the gap between CACHE-POS and HERE is large. It is thus
2946 ;; optimized to eliminate (or minimize) scanning between these two
2947 ;; positions.
2948 ;;
2949 ;; Return a three element list (GOOD-POS SCAN-BACK-POS FWD-FLAG), where:
2950 ;; o - GOOD-POS is a "good position", where `c-state-cache' is valid, or
2951 ;; could become so after missing elements are inserted into
2952 ;; `c-state-cache'. This is JUST AFTER an opening or closing
2953 ;; brace/paren/bracket which is already in `c-state-cache' or just before
2954 ;; one otherwise. exceptionally (when there's no such b/p/b handy) the BOL
2955 ;; before `here''s line, or the start of the literal containing it.
2956 ;; o - SCAN-BACK-POS, if non-nil, indicates there may be a brace pair
2957 ;; preceding POS which isn't recorded in `c-state-cache'. It is a position
2958 ;; to scan backwards from.
2959 ;; o - FWD-FLAG, if non-nil, indicates there may be parens/braces between
2960 ;; POS and HERE which aren't recorded in `c-state-cache'.
2961 ;;
2962 ;; The comments in this defun use "paren" to mean parenthesis or square
2963 ;; bracket (as contrasted with a brace), and "(" and ")" likewise.
2964 ;;
2965 ;; . {..} (..) (..) ( .. { } ) (...) ( .... . ..)
2966 ;; | | | | | |
2967 ;; CP E here D C good
2969 pa ren ; positions of "(" and ")"
2970 dropped-cons ; whether the last element dropped from `c-state-cache'
2971 ; was a cons (representing a brace-pair)
2972 good-pos ; see above.
2973 lit ; (START . END) of a literal containing some point.
2974 here-lit-start here-lit-end ; bounds of literal containing `here'
2975 ; or `here' itself.
2980 ;; Remove completely irrelevant entries from `c-state-cache'.
2986 ;; At this stage, (> pos here);
2987 ;; (< (c-state-cache-top-lparen) here) (or is nil).
2992 ;; CASE 1: The top of the cache is a brace pair which now encloses
2993 ;; `here'. As good-pos, return the address. of the "{". Since we've no
2994 ;; knowledge of what's inside these braces, we have no alternative but
2995 ;; to direct the caller to scan the buffer from the opening brace.
2999 ; entry into a { entry, so the caller needs to
3000 ; search for a brace pair before the {.
3002 ;; `here' might be inside a literal. Check for this.
3007 ;; Has `here' just "newly entered" a macro?
3020 ;; `here' might be nested inside any depth of parens (or brackets but
3021 ;; not braces). Scan backwards to find the outermost such opening
3022 ;; paren, if there is one. This will be the scan position to return.
3029 ;; CASE 2: Address of outermost ( or [ which now encloses `here', but
3030 ;; didn't enclose the (previous) `c-state-cache-good-pos'. If there is
3031 ;; a brace pair preceding this, it will already be in `c-state-cache',
3032 ;; unless there was a brace pair after it, i.e. there'll only be one to
3033 ;; scan for if we've just deleted one.
3036 ;; `here' isn't enclosed in a (previously unrecorded) bracket/paren.
3037 ;; Further forward scanning isn't needed, but we still need to find a
3038 ;; GOOD-POS. Step out of all enclosing "("s on HERE's line.
3048 ;; CASE 3: After a }/)/] before `here''s BOL.
3052 ;; CASE 4; Best of a bad job: BOL before `here-bol', or beginning of
3053 ;; literal containing it.
3058 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3059 ;; Externally visible routines.
3063 c-state-cache-good-pos 1
3064 c-state-nonlit-pos-cache nil
3065 c-state-nonlit-pos-cache-limit 1
3066 c-state-brace-pair-desert nil
3067 c-state-point-min 1
3068 c-state-point-min-lit-type nil
3069 c-state-point-min-lit-start nil
3070 c-state-min-scan-pos 1
3071 c-state-old-cpp-beg nil
3072 c-state-old-cpp-end nil)
3075 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3076 ;; Debugging routines to dump `c-state-cache' in a "replayable" form.
3077 ;; (defmacro c-sc-de (elt) ; "c-state-cache-dump-element"
3078 ;; `(format ,(concat "(setq " (symbol-name elt) " %s) ") ,elt))
3079 ;; (defmacro c-sc-qde (elt) ; "c-state-cache-quote-dump-element"
3080 ;; `(format ,(concat "(setq " (symbol-name elt) " '%s) ") ,elt))
3081 ;; (defun c-state-dump ()
3082 ;; ;; For debugging.
3083 ;; ;(message
3084 ;; (concat
3085 ;; (c-sc-qde c-state-cache)
3086 ;; (c-sc-de c-state-cache-good-pos)
3087 ;; (c-sc-qde c-state-nonlit-pos-cache)
3088 ;; (c-sc-de c-state-nonlit-pos-cache-limit)
3089 ;; (c-sc-qde c-state-brace-pair-desert)
3090 ;; (c-sc-de c-state-point-min)
3091 ;; (c-sc-de c-state-point-min-lit-type)
3092 ;; (c-sc-de c-state-point-min-lit-start)
3093 ;; (c-sc-de c-state-min-scan-pos)
3094 ;; (c-sc-de c-state-old-cpp-beg)
3095 ;; (c-sc-de c-state-old-cpp-end)))
3096 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3099 ;; Invalidate all info on `c-state-cache' that applies to the buffer at HERE
3100 ;; or higher and set `c-state-cache-good-pos' accordingly. The cache is
3101 ;; left in a consistent state.
3102 ;;
3103 ;; This is much like `c-whack-state-after', but it never changes a paren
3104 ;; pair element into an open paren element. Doing that would mean that the
3105 ;; new open paren wouldn't have the required preceding paren pair element.
3106 ;;
3107 ;; This function is called from c-after-change.
3109 ;; The caches of non-literals:
3115 ;; `c-state-cache':
3116 ;; Case 1: if `here' is in a literal containing point-min, everything
3117 ;; becomes (or is already) nil.
3121 c-state-cache-good-pos nil
3122 c-state-min-scan-pos nil)
3124 ;; Truncate `c-state-cache' and set `c-state-cache-good-pos' to a value
3125 ;; below `here'. To maintain its consistency, we may need to insert a new
3126 ;; brace pair.
3128 too-high-pa ; recorded {/(/[ next above here, or nil.
3129 dropped-cons ; was the last removed element a brace pair?
3130 pa)
3131 ;; The easy bit - knock over-the-top bits off `c-state-cache'.
3138 ;; Do we need to add in an earlier brace pair, having lopped one off?
3145 ;; The brace-pair desert marker:
3153 ;; Find and record all noteworthy parens between some good point earlier in
3154 ;; the file and point. That good point is at least the beginning of the
3155 ;; top-level construct we are in, or the beginning of the preceding
3156 ;; top-level construct if we aren't in one.
3157 ;;
3158 ;; The returned value is a list of the noteworthy parens with the last one
3159 ;; first. If an element in the list is an integer, it's the position of an
3160 ;; open paren (of any type) which has not been closed before the point. If
3161 ;; an element is a cons, it gives the position of a closed BRACE paren
3162 ;; pair[*]; the car is the start brace position and the cdr is the position
3163 ;; following the closing brace. Only the last closed brace paren pair
3164 ;; before each open paren and before the point is recorded, and thus the
3165 ;; state never contains two cons elements in succession. When a close brace
3166 ;; has no matching open brace (e.g., the matching brace is outside the
3167 ;; visible region), it is not represented in the returned value.
3168 ;;
3169 ;; [*] N.B. The close "brace" might be a mismatching close bracket or paren.
3170 ;; This defun explicitly treats mismatching parens/braces/brackets as
3171 ;; matching. It is the open brace which makes it a "brace" pair.
3172 ;;
3173 ;; If POINT is within a macro, open parens and brace pairs within
3174 ;; THIS macro MIGHT be recorded. This depends on whether their
3175 ;; syntactic properties have been suppressed by
3176 ;; `c-neutralize-syntax-in-CPP'. This might need fixing (2008-12-11).
3177 ;;
3178 ;; Currently no characters which are given paren syntax with the
3179 ;; syntax-table property are recorded, i.e. angle bracket arglist
3180 ;; parens are never present here. Note that this might change.
3181 ;;
3182 ;; BUG: This function doesn't cope entirely well with unbalanced
3183 ;; parens in macros. (2008-12-11: this has probably been resolved
3184 ;; by the function `c-neutralize-syntax-in-CPP'.) E.g. in the
3185 ;; following case the brace before the macro isn't balanced with the
3186 ;; one after it:
3187 ;;
3188 ;; {
3189 ;; #define X {
3190 ;; }
3191 ;;
3192 ;; Note to maintainers: this function DOES get called with point
3193 ;; within comments and strings, so don't assume it doesn't!
3194 ;;
3195 ;; This function might do hidden buffer changes.
3198 strategy ; 'forward, 'backward etc..
3199 ;; Candidate positions to start scanning from:
3200 cache-pos ; highest position below HERE already existing in
3201 ; cache (or 1).
3202 good-pos
3203 start-point
3204 bopl-state
3205 res
3207 ;; If POINT-MIN has changed, adjust the cache
3211 ;; Strategy?
3219 c-state-cache-good-pos start-point))
3221 ;; SCAN!
3230 ; start-point)
3239 good-pos)))
3248 scan-backward-pos))
3253 good-pos)))
3257 c-state-cache-good-pos nil)))))
3259 c-state-cache)
3262 ;; This is a wrapper over `c-invalidate-state-cache-1'.
3263 ;;
3264 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3265 ;; of all parens in preprocessor constructs, except for any such construct
3266 ;; containing point. We can then call `c-invalidate-state-cache-1' without
3267 ;; worrying further about macros and template delimiters.
3272 c-state-old-cpp-beg
3279 ;; This is a wrapper over `c-parse-state-1'. See that function for a
3280 ;; description of the functionality and return value.
3281 ;;
3282 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3283 ;; of all parens in preprocessor constructs, except for any such construct
3284 ;; containing point. We can then call `c-parse-state-1' without worrying
3285 ;; further about macros and template delimiters.
3292 here-cpp-beg)
3294 ;; FIXME!!! Put in a `condition-case' here to protect the integrity of the
3295 ;; subsystem.
3300 here-cpp-beg here-cpp-end
3306 )))
3308 ;; Debug tool to catch cache inconsistencies. This is called from
3309 ;; 000tests.el.
3322 c-state-cache-good-pos
3323 c-state-nonlit-pos-cache
3324 c-state-nonlit-pos-cache-limit
3325 c-state-brace-pair-desert
3326 c-state-point-min
3327 c-state-point-min-lit-type
3328 c-state-point-min-lit-start
3329 c-state-min-scan-pos
3330 c-state-old-cpp-beg
3331 c-state-old-cpp-end))))
3356 ;; The cache can actually go further back due to the ad-hoc way
3357 ;; the first paren is found, so try to whack off a bit of its
3358 ;; start before complaining.
3359 ;; (save-excursion
3360 ;; (goto-char (or (c-least-enclosing-brace res2) (point)))
3361 ;; (c-beginning-of-defun-1)
3362 ;; (while (not (or (bobp) (eq (char-after) ?{)))
3363 ;; (c-beginning-of-defun-1))
3364 ;; (unless (equal (c-whack-state-before (point) res1) res2)
3365 ;; (message (concat "c-parse-state inconsistency at %s: "
3366 ;; "using cache: %s, from scratch: %s")
3367 ;; here res1 res2)))
3370 here res1 res2)
3374 res1))
3380 'c-debug-parse-state
3386 \f
3388 ;; Whack off any state information from PAREN-STATE which lies
3389 ;; before BUFPOS. Not destructive on PAREN-STATE.
3392 car)
3403 ;; Whack off any state information from PAREN-STATE which lies at or
3404 ;; after BUFPOS. Not destructive on PAREN-STATE.
3409 ;; just check the car, because in a balanced brace
3410 ;; expression, it must be impossible for the corresponding
3411 ;; close brace to be before point, but the open brace to
3412 ;; be after.
3414 nil ; whack it off
3416 ;; its possible that the open brace is before
3417 ;; bufpos, but the close brace is after. In that
3418 ;; case, convert this to a non-cons element. The
3419 ;; rest of the state is before bufpos, so we're
3420 ;; done.
3422 ;; we know that both the open and close braces are
3423 ;; before bufpos, so we also know that everything else
3424 ;; on state is before bufpos.
3427 nil ; whack it off
3428 ;; it's before bufpos, so everything else should too.
3431 nil)))
3434 ;; Return the bufpos of the innermost enclosing open paren before
3435 ;; bufpos, or nil if none was found.
3445 enclosingp))
3448 ;; Return the bufpos of the outermost enclosing open paren, or nil
3449 ;; if none was found.
3456 pos))
3459 ;; Return the closest "safe" position recorded on PAREN-STATE that
3460 ;; is higher up than BUFPOS. Return nil if PAREN-STATE doesn't
3461 ;; contain any. Return nil if BUFPOS is nil, which is useful to
3462 ;; find the closest limit before a given limit that might be nil.
3463 ;;
3464 ;; A "safe" position is a position at or after a recorded open
3465 ;; paren, or after a recorded close paren. The returned position is
3466 ;; thus either the first position after a close brace, or the first
3467 ;; position after an enclosing paren, or at the enclosing paren in
3468 ;; case BUFPOS is immediately after it.
3478 ;; See below.
3481 ;; elem is the position at and not after the opening paren, so
3482 ;; we can go forward one more step unless it's equal to
3483 ;; bufpos. This is useful in some cases avoid an extra paren
3484 ;; level between the safe position and bufpos.
3489 ;; This is used for `font-lock-beginning-of-syntax-function'. It
3490 ;; goes to the closest previous point that is known to be outside
3491 ;; any string literal or comment. `c-state-cache' is used if it has
3492 ;; a position in the vicinity.
3494 elem
3497 ;; Note: Similar code in `c-safe-position'. The
3498 ;; difference is that we accept a safe position at
3499 ;; the point and don't bother to go forward past open
3500 ;; parens.
3515 ;; The position is far back. Try `c-beginning-of-defun-1'
3516 ;; (although we can't be entirely sure it will go to a position
3517 ;; outside a comment or string in current emacsen). FIXME:
3518 ;; Consult `syntax-ppss' here.
3523 \f
3524 ;; Tools for scanning identifiers and other tokens.
3527 "Return non-nil if the point is on or directly after an identifier.
3528 Keywords are recognized and not considered identifiers. If an
3529 identifier is detected, the returned value is its starting position.
3530 If an identifier ends at the point and another begins at it \(can only
3531 happen in Pike) then the point for the preceding one is returned.
3533 Note that this function might do hidden buffer changes. See the
3534 comment at the start of cc-engine.el for more info."
3536 ;; FIXME: Shouldn't this function handle "operator" in C++?
3543 ;; Check for a normal (non-keyword) identifier.
3549 ;; Handle the `<operator> syntax in Pike.
3553 t
3560 ;; Handle the "operator +" syntax in C++.
3577 )))
3580 ;; If the point is at the end of a symbol then skip backward to the
3581 ;; beginning of it. Don't move otherwise. Return non-nil if point
3582 ;; moved.
3583 ;;
3584 ;; This function might do hidden buffer changes.
3587 ;; Handle the `<operator> syntax in Pike.
3593 t
3595 nil)))))
3598 ;; Move to the beginning of the current token. Do not move if not
3599 ;; in the middle of one. BACK-LIMIT may be used to bound the
3600 ;; backward search; if given it's assumed to be at the boundary
3601 ;; between two tokens. Return non-nil if the point is moved, nil
3602 ;; otherwise.
3603 ;;
3604 ;; This function might do hidden buffer changes.
3611 ;; `c-nonsymbol-token-regexp' should always match
3612 ;; since we've skipped backward over punctuator
3613 ;; or paren syntax, but consume one char in case
3614 ;; it doesn't so that we don't leave point before
3615 ;; some earlier incorrect token.
3622 ;; Move to the end of the current token. Do not move if not in the
3623 ;; middle of one. BACK-LIMIT may be used to bound the backward
3624 ;; search; if given it's assumed to be at the boundary between two
3625 ;; tokens. Return non-nil if the point is moved, nil otherwise.
3626 ;;
3627 ;; This function might do hidden buffer changes.
3635 ;; `c-nonsymbol-token-regexp' should always match since
3636 ;; we've skipped backward over punctuator or paren
3637 ;; syntax, but move forward in case it doesn't so that
3638 ;; we don't leave point earlier than we started with.
3654 "Move forward by tokens.
3655 A token is defined as all symbols and identifiers which aren't
3657 treated properly). Point is always either left at the beginning of a
3658 token or not moved at all. COUNT specifies the number of tokens to
3659 move; a negative COUNT moves in the opposite direction. A COUNT of 0
3660 moves to the next token beginning only if not already at one. If
3661 BALANCED is true, move over balanced parens, otherwise move into them.
3662 Also, if BALANCED is true, never move out of an enclosing paren.
3664 LIMIT sets the limit for the movement and defaults to the point limit.
3665 The case when LIMIT is set in the middle of a token, comment or macro
3666 is handled correctly, i.e. the point won't be left there.
3668 Return the number of tokens left to move \(positive or negative). If
3669 BALANCED is true, a move over a balanced paren counts as one. Note
3670 that if COUNT is 0 and no appropriate token beginning is found, 1 will
3671 be returned. Thus, a return value of 0 guarantees that point is at
3672 the requested position and a return value less \(without signs) than
3673 COUNT guarantees that point is at the beginning of some token.
3675 Note that this function might do hidden buffer changes. See the
3676 comment at the start of cc-engine.el for more info."
3683 c-jump-syntax-balanced
3684 c-jump-syntax-unbalanced))
3689 ;; If count is zero we should jump if in the middle of a token.
3696 ;; Skip whitespace. Count this as a move if we did in
3697 ;; fact move.
3701 ;; Moved out of bounds. Make sure the returned count isn't zero.
3706 ;; Use `condition-case' to avoid having the limit tests
3707 ;; inside the loop.
3715 t)
3718 t)
3719 ;; `c-nonsymbol-token-regexp' above should always
3720 ;; match if there are correct tokens. Try to
3721 ;; widen to see if the limit was set in the
3722 ;; middle of one, else fall back to treating
3723 ;; the offending thing as a one character token.
3728 nil)
3731 t))))
3741 count)))
3744 "Move backward by tokens.
3745 See `c-forward-token-2' for details."
3753 c-jump-syntax-balanced
3754 c-jump-syntax-unbalanced))
3758 ;; The count is zero so try to skip to the beginning of the
3759 ;; current token.
3763 ;; The limit is inside the same token, so return 1.
3766 ;; We're not in the middle of a token. If there's
3767 ;; whitespace after the point then we must move backward,
3768 ;; so set count to 1 in that case.
3770 ;; If we're looking at a '#' that might start a cpp
3771 ;; directive then we have to do a more elaborate check.
3784 ;; Use `condition-case' to avoid having to check for buffer
3785 ;; limits in `backward-char', `scan-sexps' and `goto-char' below.
3794 ;; This can be very inefficient if there's a long
3795 ;; sequence of operator tokens without any separation.
3796 ;; That doesn't happen in practice, anyway.
3806 count)))
3809 "Like `c-forward-token-2' but doesn't treat multicharacter operator
3811 characters are jumped over character by character. This function is
3812 for compatibility only; it's only a wrapper over `c-forward-token-2'."
3817 "Like `c-backward-token-2' but doesn't treat multicharacter operator
3819 characters are jumped over character by character. This function is
3820 for compatibility only; it's only a wrapper over `c-backward-token-2'."
3824 \f
3825 ;; Tools for doing searches restricted to syntactically relevant text.
3828 paren-level not-inside-token
3829 lookbehind-submatch)
3830 "Like `re-search-forward', but only report matches that are found
3831 in syntactically significant text. I.e. matches in comments, macros
3832 or string literals are ignored. The start point is assumed to be
3833 outside any comment, macro or string literal, or else the content of
3834 that region is taken as syntactically significant text.
3836 If PAREN-LEVEL is non-nil, an additional restriction is added to
3837 ignore matches in nested paren sexps. The search will also not go
3838 outside the current list sexp, which has the effect that if the point
3839 should be moved to BOUND when no match is found \(i.e. NOERROR is
3840 neither nil nor t), then it will be at the closing paren if the end of
3841 the current list sexp is encountered first.
3843 If NOT-INSIDE-TOKEN is non-nil, matches in the middle of tokens are
3844 ignored. Things like multicharacter operators and special symbols
3846 constants.
3848 If LOOKBEHIND-SUBMATCH is non-nil, it's taken as a number of a
3849 subexpression in REGEXP. The end of that submatch is used as the
3850 position to check for syntactic significance. If LOOKBEHIND-SUBMATCH
3851 isn't used or if that subexpression didn't match then the start
3853 subexpression is never tested before the starting position, so it
3857 subexpression can match the end of nonwhite syntactic whitespace,
3858 i.e. the end of comments or cpp directives. This since the function
3859 skips over such things before resuming the search. It's on the other
3861 matches syntactic whitespace.
3863 Bug: Unbalanced parens inside cpp directives are currently not handled
3864 correctly \(i.e. they don't get ignored as they should) when
3865 PAREN-LEVEL is set.
3867 Note that this function might do hidden buffer changes. See the
3868 comment at the start of cc-engine.el for more info."
3873 ;;(message "c-syntactic-re-search-forward %s %s %S" (point) bound regexp)
3876 tmp
3877 ;; Start position for the last search.
3878 search-pos
3879 ;; The `parse-partial-sexp' state between the start position
3880 ;; and the point.
3881 state
3882 ;; The current position after the last state update. The next
3883 ;; `parse-partial-sexp' continues from here.
3885 ;; The position at which to check the state and the state
3886 ;; there. This is separate from `state-pos' since we might
3887 ;; need to back up before doing the next search round.
3888 check-pos check-state
3889 ;; Last position known to end a token.
3891 ;; Set when a valid match is found.
3892 found)
3910 state-pos check-pos paren-level nil state))
3912 check-state state))
3914 ;; NOTE: If we got a look behind subexpression and get
3915 ;; an insignificant match in something that isn't
3916 ;; syntactic whitespace (i.e. strings or in nested
3917 ;; parentheses), then we can never skip more than a
3918 ;; single character from the match start position
3919 ;; (i.e. `state-pos' here) before continuing the
3920 ;; search. That since the look behind subexpression
3921 ;; might match the end of the insignificant region in
3922 ;; the next search.
3926 ;; Match inside a line comment. Skip to eol. Use
3927 ;; `re-search-forward' instead of `skip-chars-forward' to get
3928 ;; the right bound behavior.
3932 ;; Match inside a block comment. Skip to the '*/'.
3939 ;; Match in the middle of the opener of a block or line
3940 ;; comment.
3945 ;; The last `parse-partial-sexp' above might have
3946 ;; stopped short of the real check position if the end
3947 ;; of the current sexp was encountered in paren-level
3948 ;; mode. The checks above are always false in that
3949 ;; case, and since they can do better skipping in
3950 ;; lookbehind-submatch mode, we do them before
3951 ;; checking the paren level.
3955 ;; Check the paren level first since we're short of the
3956 ;; syntactic checking position if the end of the
3957 ;; current sexp was encountered by `parse-partial-sexp'.
3960 ;; Inside a nested paren sexp.
3962 ;; See the NOTE above.
3964 ;; Skip out of the paren quickly.
3968 ;; Have exited the current paren sexp.
3971 ;; The last `parse-partial-sexp' call above
3972 ;; has left us just after the closing paren
3973 ;; in this case, so we can modify the bound
3974 ;; to leave the point at the right position
3975 ;; upon return.
3977 nil)
3981 ;; Match inside a string.
3984 ;; See the NOTE above.
3986 ;; Skip to the end of the string before continuing.
3995 continue)))
4000 ;; Match inside a macro. Skip to the end of it.
4008 (< check-pos
4014 ;; Inside a token.
4016 ;; See the NOTE above.
4021 ;; A real match.
4023 nil)))
4025 ;; Should loop to search again, but take care to avoid
4026 ;; looping on the same spot.
4030 nil
4033 t))))
4039 ;;(message "c-syntactic-re-search-forward done %s" (or (match-end 0) (point)))
4046 ;; Search failed. Set point as appropriate.
4050 nil)))
4055 ;; Return the start of the literal point is in, or nil.
4056 ;; We read and write the variables `safe-pos', `safe-pos-list', `state'
4057 ;; bound in the caller.
4059 ;; Use `parse-partial-sexp' from a safe position down to the point to check
4060 ;; if it's outside comments and strings.
4063 ;; Pick a safe position as close to the point as possible.
4064 ;;
4065 ;; FIXME: Consult `syntax-ppss' here if our cache doesn't give a good
4066 ;; position.
4079 ;; Cache positions along the way to use if we have to back up more. We
4080 ;; cache every closing paren on the same level. If the paren cache is
4081 ;; relevant in this region then we're typically already on the same
4082 ;; level as the target position. Note that we might cache positions
4083 ;; after opening parens in case safe-pos is in a nested list. That's
4084 ;; both uncommon and harmless.
4092 ;; If the state contains the start of the containing sexp we cache that
4093 ;; position too, so that parse-partial-sexp in the next run has a bigger
4094 ;; chance of starting at the same level as the target position and thus
4095 ;; will get more good safe positions into the list.
4101 ;; Inside string or comment. Continue search at the
4102 ;; beginning of it.
4106 "Like `skip-chars-backward' but only look at syntactically relevant chars,
4107 i.e. don't stop at positions inside syntactic whitespace or string
4108 literals. Preprocessor directives are also ignored, with the exception
4109 of the one that the point starts within, if any. If LIMIT is given,
4110 it's assumed to be at a syntactically relevant position.
4112 If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4113 sexps, and the search will also not go outside the current paren sexp.
4114 However, if LIMIT or the buffer limit is reached inside a nested paren
4115 then the point will be left at the limit.
4117 Non-nil is returned if the point moved, nil otherwise.
4119 Note that this function might do hidden buffer changes. See the
4120 comment at the start of cc-engine.el for more info."
4123 state-2
4124 ;; A list of syntactically relevant positions in descending
4125 ;; order. It's used to avoid scanning repeatedly over
4126 ;; potentially large regions with `parse-partial-sexp' to verify
4127 ;; each position. Used in `c-ssb-lit-begin'
4128 safe-pos-list
4129 ;; The result from `c-beginning-of-macro' at the start position or the
4130 ;; start position itself if it isn't within a macro. Evaluated on
4131 ;; demand.
4132 start-macro-beg
4133 ;; The earliest position after the current one with the same paren
4134 ;; level. Used only when `paren-level' is set.
4135 lit-beg
4140 ;; The next loop "tries" to find the end point each time round,
4141 ;; loops when it hasn't succeeded.
4149 ;; Don't stop inside a literal
4152 t)
4160 ;; Not at the right level.
4163 ;; We stop above if we go out of a paren.
4164 ;; Now check whether it precedes or is
4165 ;; nested in the starting sexp.
4169 pps-end-pos paren-level-pos
4170 nil nil state-2))
4173 ;; We've stopped short of the starting position
4174 ;; so the hit was inside a nested list. Go up
4175 ;; until we are at the right level.
4184 nil)
4185 t))
4188 nil))
4190 ;; The hit was outside the list at the start
4191 ;; position. Go to the start of the list and exit.
4193 nil))
4196 ;; Inside a macro.
4204 t
4206 ;; It's inside the same macro we started in so it's
4207 ;; a relevant match.
4209 nil))))))
4213 ;; Skip syntactic ws afterwards so that we don't stop at the
4214 ;; end of a comment if `skip-chars' is something like "^/".
4218 ;; We might want to extend this with more useful return values in
4219 ;; the future.
4222 ;; The following is an alternative implementation of
4223 ;; `c-syntactic-skip-backward' that uses backward movement to keep
4224 ;; track of the syntactic context. It turned out to be generally
4225 ;; slower than the one above which uses forward checks from earlier
4226 ;; safe positions.
4227 ;;
4228 ;;(defconst c-ssb-stop-re
4229 ;; ;; The regexp matching chars `c-syntactic-skip-backward' needs to
4230 ;; ;; stop at to avoid going into comments and literals.
4231 ;; (concat
4232 ;; ;; Match comment end syntax and string literal syntax. Also match
4233 ;; ;; '/' for block comment endings (not covered by comment end
4234 ;; ;; syntax).
4235 ;; "\\s>\\|/\\|\\s\""
4236 ;; (if (memq 'gen-string-delim c-emacs-features)
4237 ;; "\\|\\s|"
4238 ;; "")
4239 ;; (if (memq 'gen-comment-delim c-emacs-features)
4240 ;; "\\|\\s!"
4241 ;; "")))
4242 ;;
4243 ;;(defconst c-ssb-stop-paren-re
4244 ;; ;; Like `c-ssb-stop-re' but also stops at paren chars.
4245 ;; (concat c-ssb-stop-re "\\|\\s(\\|\\s)"))
4246 ;;
4247 ;;(defconst c-ssb-sexp-end-re
4248 ;; ;; Regexp matching the ending syntax of a complex sexp.
4249 ;; (concat c-string-limit-regexp "\\|\\s)"))
4250 ;;
4251 ;;(defun c-syntactic-skip-backward (skip-chars &optional limit paren-level)
4252 ;; "Like `skip-chars-backward' but only look at syntactically relevant chars,
4253 ;;i.e. don't stop at positions inside syntactic whitespace or string
4254 ;;literals. Preprocessor directives are also ignored. However, if the
4255 ;;point is within a comment, string literal or preprocessor directory to
4256 ;;begin with, its contents is treated as syntactically relevant chars.
4257 ;;If LIMIT is given, it limits the backward search and the point will be
4258 ;;left there if no earlier position is found.
4259 ;;
4260 ;;If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4261 ;;sexps, and the search will also not go outside the current paren sexp.
4262 ;;However, if LIMIT or the buffer limit is reached inside a nested paren
4263 ;;then the point will be left at the limit.
4264 ;;
4265 ;;Non-nil is returned if the point moved, nil otherwise.
4266 ;;
4267 ;;Note that this function might do hidden buffer changes. See the
4268 ;;comment at the start of cc-engine.el for more info."
4269 ;;
4270 ;; (save-restriction
4271 ;; (when limit
4272 ;; (narrow-to-region limit (point-max)))
4273 ;;
4274 ;; (let ((start (point)))
4275 ;; (catch 'done
4276 ;; (while (let ((last-pos (point))
4277 ;; (stop-pos (progn
4278 ;; (skip-chars-backward skip-chars)
4279 ;; (point))))
4280 ;;
4281 ;; ;; Skip back over the same region as
4282 ;; ;; `skip-chars-backward' above, but keep to
4283 ;; ;; syntactically relevant positions.
4284 ;; (goto-char last-pos)
4285 ;; (while (and
4286 ;; ;; `re-search-backward' with a single char regexp
4287 ;; ;; should be fast.
4288 ;; (re-search-backward
4289 ;; (if paren-level c-ssb-stop-paren-re c-ssb-stop-re)
4290 ;; stop-pos 'move)
4291 ;;
4292 ;; (progn
4293 ;; (cond
4294 ;; ((looking-at "\\s(")
4295 ;; ;; `paren-level' is set and we've found the
4296 ;; ;; start of the containing paren.
4297 ;; (forward-char)
4298 ;; (throw 'done t))
4299 ;;
4300 ;; ((looking-at c-ssb-sexp-end-re)
4301 ;; ;; We're at the end of a string literal or paren
4302 ;; ;; sexp (if `paren-level' is set).
4303 ;; (forward-char)
4304 ;; (condition-case nil
4305 ;; (c-backward-sexp)
4306 ;; (error
4307 ;; (goto-char limit)
4308 ;; (throw 'done t))))
4309 ;;
4310 ;; (t
4311 ;; (forward-char)
4312 ;; ;; At the end of some syntactic ws or possibly
4313 ;; ;; after a plain '/' operator.
4314 ;; (let ((pos (point)))
4315 ;; (c-backward-syntactic-ws)
4316 ;; (if (= pos (point))
4317 ;; ;; Was a plain '/' operator. Go past it.
4318 ;; (backward-char)))))
4319 ;;
4320 ;; (> (point) stop-pos))))
4321 ;;
4322 ;; ;; Now the point is either at `stop-pos' or at some
4323 ;; ;; position further back if `stop-pos' was at a
4324 ;; ;; syntactically irrelevant place.
4325 ;;
4326 ;; ;; Skip additional syntactic ws so that we don't stop
4327 ;; ;; at the end of a comment if `skip-chars' is
4328 ;; ;; something like "^/".
4329 ;; (c-backward-syntactic-ws)
4330 ;;
4331 ;; (< (point) stop-pos))))
4332 ;;
4333 ;; ;; We might want to extend this with more useful return values
4334 ;; ;; in the future.
4335 ;; (/= (point) start))))
4337 \f
4338 ;; Tools for handling comments and string literals.
4341 "Return the type of literal point is in, if any.
4342 The return value is `c' if in a C-style comment, `c++' if in a C++
4343 style comment, `string' if in a string literal, `pound' if DETECT-CPP
4344 is non-nil and in a preprocessor line, or nil if somewhere else.
4345 Optional LIM is used as the backward limit of the search. If omitted,
4346 or nil, `c-beginning-of-defun' is used.
4348 The last point calculated is cached if the cache is enabled, i.e. if
4349 `c-in-literal-cache' is bound to a two element vector.
4351 Note that this function might do hidden buffer changes. See the
4352 comment at the start of cc-engine.el for more info."
4363 "Return a cons of the beginning and end positions of the comment or
4364 string surrounding point (including both delimiters), or nil if point
4366 to start parsing from. If NEAR is non-nil, then the limits of any
4368 spaces and tabs between point and the literal. The search for such a
4369 literal is done first in forward direction. If NOT-IN-DELIMITER is
4370 non-nil, the case when point is inside a starting delimiter won't be
4371 recognized. This only has effect for comments which have starting
4372 delimiters with more than one character.
4374 Note that this function might do hidden buffer changes. See the
4375 comment at the start of cc-engine.el for more info."
4392 ;; We're standing in a comment starter.
4398 ;; Search forward for a literal.
4409 ;; Search backward.
4420 ;; Block comment. Due to the nature of line
4421 ;; comments, they will always be covered by the
4422 ;; normal case above.
4425 ;; If LIM is bogus, beg will be bogus.
4429 ))))
4431 ;; In case external callers use this; it did have a docstring.
4435 "If the argument is a cons of two buffer positions (such as returned by
4436 `c-literal-limits'), and that range contains a C++ style line comment,
4437 then an extended range is returned that contains all adjacent line
4438 comments (i.e. all comments that starts in the same column with no
4439 empty lines or non-whitespace characters between them). Otherwise the
4440 argument is returned.
4442 Note that this function might do hidden buffer changes. See the
4443 comment at the start of cc-engine.el for more info."
4454 ;; Got to take care in the backward direction to handle
4455 ;; comments which are preceded by code.
4469 range)
4473 "Convenience function that given the result of `c-literal-limits',
4474 returns nil or the type of literal that the range surrounds, one
4475 of the symbols 'c, 'c++ or 'string. It's much faster than using
4476 `c-in-literal' and is intended to be used when you need both the
4477 type of a literal and its limits.
4479 Note that this function might do hidden buffer changes. See the
4480 comment at the start of cc-engine.el for more info."
4491 range))
4494 ;; Get a "safe place" approximately TRY-SIZE characters before START.
4495 ;; This doesn't preserve point.
4504 ;; Return a buffer position HOW-FAR-BACK non-literal characters from START
4505 ;; (default point). This is done by going back further in the buffer then
4506 ;; searching forward for literals. The position found won't be in a
4507 ;; literal. We start searching for the sought position TRY-SIZE (default
4508 ;; twice HOW-FAR-BACK) bytes back from START. This function must be fast.
4509 ;; :-)
4517 stack elt size
4520 ;; Move forward one literal each time round this loop.
4521 ;; Move forward to the start of a comment or string.
4523 pos
4524 start
4525 nil ; target-depth
4526 nil ; stop-before
4527 s ; state
4530 ;; Gather details of the non-literal-bit - starting pos and size.
4534 pos))
4538 ;; Move forward to the end of the comment/string.
4542 start
4543 nil ; target-depth
4544 nil ; stop-before
4545 s ; state
4549 ;; Now try and find enough non-literal characters recorded on the stack.
4550 ;; Go back one recorded literal each time round this loop.
4552 stack)
4557 ;; Have we found enough yet?
4567 ;; Return a buffer position about HOW-FAR non-literal characters forward
4568 ;; from START-POS (default point), which must not be inside a literal.
4575 ;; Scan over counted characters.
4577 pos
4579 nil ; target-depth
4580 nil ; stop-before
4581 s ; state
4585 ;; Scan over literal characters.
4588 pos
4590 nil ; target-depth
4591 nil ; stop-before
4592 s ; state
4597 \f
4598 ;; `c-find-decl-spots' and accompanying stuff.
4600 ;; Variables used in `c-find-decl-spots' to cache the search done for
4601 ;; the first declaration in the last call. When that function starts,
4602 ;; it needs to back up over syntactic whitespace to look at the last
4603 ;; token before the region being searched. That can sometimes cause
4604 ;; moves back and forth over a quite large region of comments and
4605 ;; macros, which would be repeated for each changed character when
4606 ;; we're called during fontification, since font-lock refontifies the
4607 ;; current line for each change. Thus it's worthwhile to cache the
4608 ;; first match.
4609 ;;
4610 ;; `c-find-decl-syntactic-pos' is a syntactically relevant position in
4611 ;; the syntactic whitespace less or equal to some start position.
4612 ;; There's no cached value if it's nil.
4613 ;;
4614 ;; `c-find-decl-match-pos' is the match position if
4615 ;; `c-find-decl-prefix-search' matched before the syntactic whitespace
4616 ;; at `c-find-decl-syntactic-pos', or nil if there's no such match.
4627 ; (defface c-debug-decl-spot-face
4628 ; '((t (:background "Turquoise")))
4629 ; "Debug face to mark the spots where `c-find-decl-spots' stopped.")
4630 ; (defface c-debug-decl-sws-face
4631 ; '((t (:background "Khaki")))
4632 ; "Debug face to mark the syntactic whitespace between the declaration
4633 ; spots and the preceding token end.")
4649 ;; Macro used inside `c-find-decl-spots'. It ought to be a defun,
4650 ;; but it contains lots of free variables that refer to things
4651 ;; inside `c-find-decl-spots'. The point is left at `cfd-match-pos'
4652 ;; if there is a match, otherwise at `cfd-limit'.
4653 ;;
4654 ;; This macro might do hidden buffer changes.
4657 ;; Find the next property match position if we haven't got one already.
4668 ;; Find the next `c-decl-prefix-or-start-re' match if we haven't
4669 ;; got one already.
4679 ;; Match. Check if it's inside a comment or string literal.
4682 ;; Matched the end of a token preceding a decl spot.
4686 ;; Matched a token that start a decl spot.
4689 c-literal-faces)
4691 ;; No match. Finish up and exit the loop.
4693 nil)
4695 ;; Skip out of comments and string literals.
4702 ;; If we matched at the decl start, we have to back up over the
4703 ;; preceding syntactic ws to set `cfd-match-pos' and to catch
4704 ;; any decl spots in the syntactic ws.
4709 ;; Choose whichever match is closer to the start.
4712 cfd-re-match nil)
4714 cfd-prop-match nil))
4719 ;; Skip forward past comments only so we don't skip macros.
4721 ;; Set the position to continue at. We can avoid going over
4722 ;; the comments skipped above a second time, but it's possible
4723 ;; that the comment skipping has taken us past `cfd-prop-match'
4724 ;; since the property might be used inside comments.
4730 ;; Call CFD-FUN for each possible spot for a declaration, cast or
4731 ;; label from the point to CFD-LIMIT.
4732 ;;
4733 ;; CFD-FUN is called with point at the start of the spot. It's passed two
4734 ;; arguments: The first is the end position of the token preceding the spot,
4735 ;; or 0 for the implicit match at bob. The second is a flag that is t when
4736 ;; the match is inside a macro. Point should be moved forward by at least
4737 ;; one token.
4738 ;;
4739 ;; If CFD-FUN adds `c-decl-end' properties somewhere below the current spot,
4740 ;; it should return non-nil to ensure that the next search will find them.
4741 ;;
4742 ;; Such a spot is:
4743 ;; o The first token after bob.
4744 ;; o The first token after the end of submatch 1 in
4745 ;; `c-decl-prefix-or-start-re' when that submatch matches.
4746 ;; o The start of each `c-decl-prefix-or-start-re' match when
4747 ;; submatch 1 doesn't match.
4748 ;; o The first token after the end of each occurrence of the
4749 ;; `c-type' text property with the value `c-decl-end', provided
4750 ;; `c-type-decl-end-used' is set.
4751 ;;
4752 ;; Only a spot that match CFD-DECL-RE and whose face is in the
4753 ;; CFD-FACE-CHECKLIST list causes CFD-FUN to be called. The face
4754 ;; check is disabled if CFD-FACE-CHECKLIST is nil.
4755 ;;
4756 ;; If the match is inside a macro then the buffer is narrowed to the
4757 ;; end of it, so that CFD-FUN can investigate the following tokens
4758 ;; without matching something that begins inside a macro and ends
4759 ;; outside it. It's to avoid this work that the CFD-DECL-RE and
4760 ;; CFD-FACE-CHECKLIST checks exist.
4761 ;;
4762 ;; The spots are visited approximately in order from top to bottom.
4763 ;; It's however the positions where `c-decl-prefix-or-start-re'
4764 ;; matches and where `c-decl-end' properties are found that are in
4765 ;; order. Since the spots often are at the following token, they
4766 ;; might be visited out of order insofar as more spots are reported
4767 ;; later on within the syntactic whitespace between the match
4768 ;; positions and their spots.
4769 ;;
4770 ;; It's assumed that comments and strings are fontified in the
4771 ;; searched range.
4772 ;;
4773 ;; This is mainly used in fontification, and so has an elaborate
4774 ;; cache to handle repeated calls from the same start position; see
4775 ;; the variables above.
4776 ;;
4777 ;; All variables in this function begin with `cfd-' to avoid name
4778 ;; collision with the (dynamically bound) variables used in CFD-FUN.
4779 ;;
4780 ;; This function might do hidden buffer changes.
4784 ;; The end of the token preceding the decl spot last found
4785 ;; with `c-decl-prefix-or-start-re'. `cfd-limit' if there's
4786 ;; no match.
4787 cfd-re-match
4788 ;; The end position of the last `c-decl-prefix-or-start-re'
4789 ;; match. If this is greater than `cfd-continue-pos', the
4790 ;; next regexp search is started here instead.
4792 ;; The end of the last `c-decl-end' found by
4793 ;; `c-find-decl-prefix-search'. `cfd-limit' if there's no
4794 ;; match. If searching for the property isn't needed then we
4795 ;; disable it by setting it to `cfd-limit' directly.
4797 ;; The end of the token preceding the decl spot last found by
4798 ;; `c-find-decl-prefix-search'. 0 for the implicit match at
4799 ;; bob. `cfd-limit' if there's no match. In other words,
4800 ;; this is the minimum of `cfd-re-match' and `cfd-prop-match'.
4802 ;; The position to continue searching at.
4803 cfd-continue-pos
4804 ;; The position of the last "real" token we've stopped at.
4805 ;; This can be greater than `cfd-continue-pos' when we get
4806 ;; hits inside macros or at `c-decl-end' positions inside
4807 ;; comments.
4809 ;; The end position of the last entered macro.
4812 ;; Initialize by finding a syntactically relevant start position
4813 ;; before the point, and do the first `c-decl-prefix-or-start-re'
4814 ;; search unless we're at bob.
4817 ;; Must back up a bit since we look for the end of the previous
4818 ;; statement or declaration, which is earlier than the first
4819 ;; returned match.
4822 ;; First we need to move to a syntactically relevant position.
4823 ;; Begin by backing out of comment or string literals.
4826 ;; Try to use the faces to back up to the start of the
4827 ;; literal. FIXME: What if the point is on a declaration
4828 ;; inside a comment?
4834 ;; XEmacs doesn't fontify the quotes surrounding string
4835 ;; literals.
4844 ;; Don't trust the literal to contain only literal faces
4845 ;; (the font lock package might not have fontified the
4846 ;; start of it at all, for instance) so check that we have
4847 ;; arrived at something that looks like a start or else
4848 ;; resort to `c-literal-limits'.
4855 ;; The start is in a literal. If the limit is in the same
4856 ;; one we don't have to find a syntactic position etc. We
4857 ;; only check that if the limit is at or before bonl to save
4858 ;; time; it covers the by far most common case when font-lock
4859 ;; refontifies the current line only.
4870 ;; Completely inside a literal. Set up variables to trig the
4871 ;; (< cfd-continue-pos cfd-start-pos) case below and it'll
4872 ;; find a suitable start position.
4875 ;; Check if the region might be completely inside a macro, to
4876 ;; optimize that like the completely-inside-literal above.
4883 ;; (Maybe) completely inside a macro. Only need to trig the
4884 ;; (< cfd-continue-pos cfd-start-pos) case below to make it
4885 ;; set things up.
4887 start-in-macro t))
4890 ;; Back out of any macro so we don't miss any declaration
4891 ;; that could follow after it.
4895 ;; Now we're at a proper syntactically relevant position so we
4896 ;; can use the cache. But first clear it if it applied
4897 ;; further down.
4902 ;; Don't have to do this if the cache is relevant here,
4903 ;; typically if the same line is refontified again. If
4904 ;; we're just some syntactic whitespace further down we can
4905 ;; still use the cache to limit the skipping.
4908 ;; If we hit `c-find-decl-syntactic-pos' and
4909 ;; `c-find-decl-match-pos' is set then we install the cached
4910 ;; values. If we hit `c-find-decl-syntactic-pos' and
4911 ;; `c-find-decl-match-pos' is nil then we know there's no decl
4912 ;; prefix in the whitespace before `c-find-decl-syntactic-pos'
4913 ;; and so we can continue the search from this point. If we
4914 ;; didn't hit `c-find-decl-syntactic-pos' then we're now in
4915 ;; the right spot to begin searching anyway.
4917 c-find-decl-match-pos)
4919 cfd-continue-pos syntactic-pos)
4924 ;; Always consider bob a match to get the first
4925 ;; declaration in the file. Do this separately instead of
4926 ;; letting `c-decl-prefix-or-start-re' match bob, so that
4927 ;; regexp always can consume at least one character to
4928 ;; ensure that we won't get stuck in an infinite loop.
4933 ;; Do an initial search now. In the bob case above it's
4934 ;; only done to search for a `c-decl-end' spot.
4938 cfd-match-pos)))))
4940 ;; Advance `cfd-continue-pos' if it's before the start position.
4941 ;; The closest continue position that might have effect at or
4942 ;; after the start depends on what we started in. This also
4943 ;; finds a suitable start position in the special cases when the
4944 ;; region is completely within a literal or macro.
4949 ;; If we're in a macro then it's the closest preceding token
4950 ;; in the macro. Check this before `start-in-literal',
4951 ;; since if we're inside a literal in a macro, the preceding
4952 ;; token is earlier than any `c-decl-end' spot inside the
4953 ;; literal (comment).
4955 ;; The only syntactic ws in macros are comments.
4961 ;; If we're in a comment it can only be the closest
4962 ;; preceding `c-decl-end' position within that comment, if
4963 ;; any. Go back to the beginning of such a property so that
4964 ;; `c-find-decl-prefix-search' will find the end of it.
4965 ;; (Can't stop at the end and install it directly on
4966 ;; `cfd-prop-match' since that variable might be cleared
4967 ;; after `cfd-fun' below.)
4968 ;;
4969 ;; Note that if the literal is a string then the property
4970 ;; search will simply skip to the beginning of it right
4971 ;; away.
4983 ;; Didn't find any property inside the comment, so we can
4984 ;; skip it entirely. (This won't skip past a string, but
4985 ;; that'll be handled quickly by the next
4986 ;; `c-find-decl-prefix-search' anyway.)
4992 ;; If we started in normal code, the only match that might
4993 ;; apply before the start is what we already got in
4994 ;; `cfd-match-pos' so we can continue at the start position.
4995 ;; (Note that we don't get here if the first match is below
4996 ;; it.)
4999 ;; Delete found matches if they are before our new continue
5000 ;; position, so that `c-find-decl-prefix-search' won't back up
5001 ;; to them later on.
5009 ;; This is the normal case and we got a proper syntactic
5010 ;; position. If there's a match then it's always outside
5011 ;; macros and comments, so advance to the next token and set
5012 ;; `cfd-token-pos'. The loop below will later go back using
5013 ;; `cfd-continue-pos' to fix declarations inside the
5014 ;; syntactic ws.
5022 ;; Have one of the special cases when the region is completely
5023 ;; within a literal or macro. `cfd-continue-pos' is set to a
5024 ;; good start position for the search, so do it.
5027 ;; Now loop. Round what? (ACM, 2006/7/5). We already got the first match.
5034 ;; Kludge to filter out matches on the "<" that
5035 ;; aren't open parens, for the sake of languages
5036 ;; that got `c-recognize-<>-arglists' set.
5041 ;; If `cfd-continue-pos' is less or equal to
5042 ;; `cfd-token-pos', we've got a hit inside a macro
5043 ;; that's in the syntactic whitespace before the last
5044 ;; "real" declaration we've checked. If they're equal
5045 ;; we've arrived at the declaration a second time, so
5046 ;; there's nothing to do.
5050 ;; If `cfd-continue-pos' is less than `cfd-token-pos'
5051 ;; we're still searching for declarations embedded in
5052 ;; the syntactic whitespace. In that case we need
5053 ;; only to skip comments and not macros, since they
5054 ;; can't be nested, and that's already been done in
5055 ;; `c-find-decl-prefix-search'.
5060 ;; Continue if the following token fails the
5061 ;; CFD-DECL-RE and CFD-FACE-CHECKLIST checks.
5068 t)))
5079 ;; Narrow to the end of the macro if we got a hit inside
5080 ;; one, to avoid recognizing things that start inside the
5081 ;; macro and end outside it.
5083 ;; Not in the same macro as in the previous round.
5094 t
5097 t)
5098 ;; The matched token was the last thing in the macro,
5099 ;; so the whole match is bogus.
5101 nil))))
5108 ;; Restore limits if we did macro narrowing above.
5115 ; cfd-match-pos, etc.
5117 \f
5118 ;; A cache for found types.
5120 ;; Buffer local variable that contains an obarray with the types we've
5121 ;; found. If a declaration is recognized somewhere we record the
5122 ;; fully qualified identifier in it to recognize it as a type
5123 ;; elsewhere in the file too. This is not accurate since we do not
5124 ;; bother with the scoping rules of the languages, but in practice the
5125 ;; same name is seldom used as both a type and something else in a
5126 ;; file, and we only use this as a last resort in ambiguous cases (see
5127 ;; `c-forward-decl-or-cast-1').
5128 ;;
5129 ;; Not every type need be in this cache. However, things which have
5130 ;; ceased to be types must be removed from it.
5131 ;;
5132 ;; Template types in C++ are added here too but with the template
5133 ;; arglist replaced with "<>" in references or "<" for the one in the
5134 ;; primary type. E.g. the type "Foo<A,B>::Bar<C>" is stored as
5135 ;; "Foo<>::Bar<". This avoids storing very long strings (since C++
5136 ;; template specs can be fairly sized programs in themselves) and
5137 ;; improves the hit ratio (it's a type regardless of the template
5138 ;; args; it's just not the same type, but we're only interested in
5139 ;; recognizing types, not telling distinct types apart). Note that
5140 ;; template types in references are added here too; from the example
5141 ;; above there will also be an entry "Foo<".
5146 ;; Clears `c-found-types'.
5150 ;; Add the given region as a type in `c-found-types'. If the region
5151 ;; doesn't match an existing type but there is a type which is equal
5152 ;; to the given one except that the last character is missing, then
5153 ;; the shorter type is removed. That's done to avoid adding all
5154 ;; prefixes of a type as it's being entered and font locked. This
5155 ;; doesn't cover cases like when characters are removed from a type
5156 ;; or added in the middle. We'd need the position of point when the
5157 ;; font locking is invoked to solve this well.
5158 ;;
5159 ;; This function might do hidden buffer changes.
5166 ;; Remove the "NAME" from c-found-types, if present.
5170 ;; Return non-nil if the given region contains a type in
5171 ;; `c-found-types'.
5172 ;;
5173 ;; This function might do hidden buffer changes.
5175 c-found-types))
5178 ;; Return all the types in `c-found-types' as a sorted list of
5179 ;; strings.
5183 type-list)))
5184 c-found-types)
5187 ;; Shut up the byte compiler.
5191 ;; An after change function which, in conjunction with the info in
5192 ;; c-maybe-stale-found-type (set in c-before-change), removes a type
5193 ;; from `c-found-types', should this type have become stale. For
5194 ;; example, this happens to "foo" when "foo \n bar();" becomes
5195 ;; "foo(); \n bar();". Such stale types, if not removed, foul up
5196 ;; the fontification.
5197 ;;
5198 ;; Have we, perhaps, added non-ws characters to the front/back of a found
5199 ;; type?
5219 ;; Changing the amount of (already existing) whitespace - don't do anything.
5224 ;; The syntactic relationship which defined a "found type" has been
5225 ;; destroyed.
5228 ;; ((eq (car c-maybe-stale-found-type) 'c-decl-type-start) FIXME!!!
5229 )))
5231 \f
5232 ;; Setting and removing syntax properties on < and > in languages (C++
5233 ;; and Java) where they can be template/generic delimiters as well as
5234 ;; their normal meaning of "less/greater than".
5236 ;; Normally, < and > have syntax 'punctuation'. When they are found to
5237 ;; be delimiters, they are marked as such with the category properties
5238 ;; c-<-as-paren-syntax, c->-as-paren-syntax respectively.
5240 ;; STRATEGY:
5241 ;;
5242 ;; It is impossible to determine with certainty whether a <..> pair in
5243 ;; C++ is two comparison operators or is template delimiters, unless
5244 ;; one duplicates a lot of a C++ compiler. For example, the following
5245 ;; code fragment:
5246 ;;
5247 ;; foo (a < b, c > d) ;
5248 ;;
5249 ;; could be a function call with two integer parameters (each a
5250 ;; relational expression), or it could be a constructor for class foo
5251 ;; taking one parameter d of templated type "a < b, c >". They are
5252 ;; somewhat easier to distinguish in Java.
5253 ;;
5254 ;; The strategy now (2010-01) adopted is to mark and unmark < and
5255 ;; > IN MATCHING PAIRS ONLY. [Previously, they were marked
5256 ;; individually when their context so indicated. This gave rise to
5257 ;; intractable problems when one of a matching pair was deleted, or
5258 ;; pulled into a literal.]
5259 ;;
5260 ;; At each buffer change, the syntax-table properties are removed in a
5261 ;; before-change function and reapplied, when needed, in an
5262 ;; after-change function. It is far more important that the
5263 ;; properties get removed when they they are spurious than that they
5264 ;; be present when wanted.
5265 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
5267 ;; POS (default point) is at a < character. If it is marked with
5268 ;; open paren syntax-table text property, remove the property,
5269 ;; together with the close paren property on the matching > (if
5270 ;; any).
5285 ;; POS (default point) is at a > character. If it is marked with
5286 ;; close paren syntax-table property, remove the property, together
5287 ;; with the open paren property on the matching < (if any).
5302 ;; POS (default point) is at a < or > character. If it has an
5303 ;; open/close paren syntax-table property, remove this property both
5304 ;; from the current character and its partner (which will also be
5305 ;; thusly marked).
5315 ;; POS (default point) is at a < character. If it is both marked
5316 ;; with open/close paren syntax-table property, and has a matching >
5317 ;; (also marked) which is after LIM, remove the property both from
5318 ;; the current > and its partner. Return t when this happens, nil
5319 ;; when it doesn't.
5333 t)))
5336 ;; POS (default point) is at a > character. If it is both marked
5337 ;; with open/close paren syntax-table property, and has a matching <
5338 ;; (also marked) which is before LIM, remove the property both from
5339 ;; the current < and its partner. Return t when this happens, nil
5340 ;; when it doesn't.
5354 t)))
5356 ;; Set by c-common-init in cc-mode.el.
5361 ;; Unmark certain pairs of "< .... >" which are currently marked as
5362 ;; template/generic delimiters. (This marking is via syntax-table
5363 ;; text properties).
5364 ;;
5365 ;; These pairs are those which are in the current "statement" (i.e.,
5366 ;; the region between the {, }, or ; before BEG and the one after
5367 ;; END), and which enclose any part of the interval (BEG END).
5368 ;;
5369 ;; Note that in C++ (?and Java), template/generic parens cannot
5370 ;; enclose a brace or semicolon, so we use these as bounds on the
5371 ;; region we must work on.
5372 ;;
5373 ;; This function is called from before-change-functions (via
5374 ;; c-get-state-before-change-functions). Thus the buffer is widened,
5375 ;; and point is undefined, both at entry and exit.
5376 ;;
5377 ;; FIXME!!! This routine ignores the possibility of macros entirely.
5378 ;; 2010-01-29.
5382 new-beg new-end need-new-beg need-new-end)
5383 ;; Locate the barrier before the changed region
5388 ;; Remove the syntax-table properties from each pertinent <...> pair.
5389 ;; Firsly, the ones with the < before beg and > after beg.
5394 ;; Locate the barrier after END.
5399 ;; Remove syntax-table properties from the remaining pertinent <...>
5400 ;; pairs, those with a > after end and < before end.
5405 ;; Extend the fontification region, if needed.
5417 ;; This is called from `after-change-functions' when
5418 ;; c-recognize-<>-arglists' is set. It ensures that no "<" or ">"
5419 ;; chars with paren syntax become part of another operator like "<<"
5420 ;; or ">=".
5421 ;;
5422 ;; This function might do hidden buffer changes.
5455 \f
5456 ;; Handling of small scale constructs like types and names.
5458 ;; Dynamically bound variable that instructs `c-forward-type' to also
5459 ;; treat possible types (i.e. those that it normally returns 'maybe or
5460 ;; 'found for) as actual types (and always return 'found for them).
5461 ;; This means that it records them in `c-record-type-identifiers' if
5462 ;; that is set, and that it adds them to `c-found-types'.
5465 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5466 ;; mark up successfully parsed arglists with paren syntax properties on
5467 ;; the surrounding angle brackets and with `c-<>-arg-sep' in the
5468 ;; `c-type' property of each argument separating comma.
5469 ;;
5470 ;; Setting this variable also makes `c-forward-<>-arglist' recurse into
5471 ;; all arglists for side effects (i.e. recording types), otherwise it
5472 ;; exploits any existing paren syntax properties to quickly jump to the
5473 ;; end of already parsed arglists.
5474 ;;
5475 ;; Marking up the arglists is not the default since doing that correctly
5476 ;; depends on a proper value for `c-restricted-<>-arglists'.
5479 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5480 ;; not accept arglists that contain binary operators.
5481 ;;
5482 ;; This is primarily used to handle C++ template arglists. C++
5483 ;; disambiguates them by checking whether the preceding name is a
5484 ;; template or not. We can't do that, so we assume it is a template
5485 ;; if it can be parsed as one. That usually works well since
5486 ;; comparison expressions on the forms "a < b > c" or "a < b, c > d"
5487 ;; in almost all cases would be pointless.
5488 ;;
5489 ;; However, in function arglists, e.g. in "foo (a < b, c > d)", we
5490 ;; should let the comma separate the function arguments instead. And
5491 ;; in a context where the value of the expression is taken, e.g. in
5492 ;; "if (a < b || c > d)", it's probably not a template.
5495 ;; Dynamically bound variables that instructs
5496 ;; `c-forward-keyword-clause', `c-forward-<>-arglist',
5497 ;; `c-forward-name', `c-forward-type', `c-forward-decl-or-cast-1', and
5498 ;; `c-forward-label' to record the ranges of all the type and
5499 ;; reference identifiers they encounter. They will build lists on
5500 ;; these variables where each element is a cons of the buffer
5501 ;; positions surrounding each identifier. This recording is only
5502 ;; activated when `c-record-type-identifiers' is non-nil.
5503 ;;
5504 ;; All known types that can't be identifiers are recorded, and also
5505 ;; other possible types if `c-promote-possible-types' is set.
5506 ;; Recording is however disabled inside angle bracket arglists that
5507 ;; are encountered inside names and other angle bracket arglists.
5508 ;; Such occurrences are taken care of by `c-font-lock-<>-arglists'
5509 ;; instead.
5510 ;;
5511 ;; Only the names in C++ template style references (e.g. "tmpl" in
5512 ;; "tmpl<a,b>::foo") are recorded as references, other references
5513 ;; aren't handled here.
5514 ;;
5515 ;; `c-forward-label' records the label identifier(s) on
5516 ;; `c-record-ref-identifiers'.
5520 ;; This variable will receive a cons cell of the range of the last
5521 ;; single identifier symbol stepped over by `c-forward-name' if it's
5522 ;; successful. This is the range that should be put on one of the
5523 ;; record lists above by the caller. It's assigned nil if there's no
5524 ;; such symbol in the name.
5529 ;; Always true.
5539 ;; Always true.
5547 ;; Dynamically bound variable that instructs `c-forward-type' to
5548 ;; record the ranges of types that only are found. Behaves otherwise
5549 ;; like `c-record-type-identifiers'.
5553 ;; Used internally in `c-forward-keyword-clause' to move forward
5554 ;; over a type (if TYPE is 'type) or a name (otherwise) which
5555 ;; possibly is prefixed by keywords and their associated clauses.
5556 ;; Try with a type/name first to not trip up on those that begin
5557 ;; with a keyword. Return t if a known or found type is moved
5558 ;; over. The point is clobbered if nil is returned. If range
5559 ;; recording is enabled, the identifier is recorded on as a type
5560 ;; if TYPE is 'type or as a reference if TYPE is 'ref.
5561 ;;
5562 ;; This macro might do hidden buffer changes.
5567 nil
5574 t)))
5577 ;; Used internally in `c-forward-keyword-clause' to move forward
5578 ;; over a comma separated list of types or names using
5579 ;; `c-forward-keyword-prefixed-id'.
5580 ;;
5581 ;; This macro might do hidden buffer changes.
5592 ;; Submatch MATCH in the current match data is assumed to surround a
5593 ;; token. If it's a keyword, move over it and any immediately
5594 ;; following clauses associated with it, stopping at the start of
5595 ;; the next token. t is returned in that case, otherwise the point
5596 ;; stays and nil is returned. The kind of clauses that are
5597 ;; recognized are those specified by `c-type-list-kwds',
5598 ;; `c-ref-list-kwds', `c-colon-type-list-kwds',
5599 ;; `c-paren-nontype-kwds', `c-paren-type-kwds', `c-<>-type-kwds',
5600 ;; and `c-<>-arglist-kwds'.
5601 ;;
5602 ;; This function records identifier ranges on
5603 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5604 ;; `c-record-type-identifiers' is non-nil.
5605 ;;
5606 ;; Note that for `c-colon-type-list-kwds', which doesn't necessary
5607 ;; apply directly after the keyword, the type list is moved over
5608 ;; only when there is no unaccounted token before it (i.e. a token
5609 ;; that isn't moved over due to some other keyword list). The
5610 ;; identifier ranges in the list are still recorded if that should
5611 ;; be done, though.
5612 ;;
5613 ;; This function might do hidden buffer changes.
5616 ;; The call to `c-forward-<>-arglist' below is made after
5617 ;; `c-<>-sexp-kwds' keywords, so we're certain they actually
5618 ;; are angle bracket arglists and `c-restricted-<>-arglists'
5619 ;; should therefore be nil.
5631 ;; There's a type directly after a keyword in `c-type-list-kwds'.
5636 ;; There's a name directly after a keyword in `c-ref-list-kwds'.
5641 ;; There's an open paren after a keyword in `c-paren-any-kwds'.
5648 ;; Use `c-forward-type' on every identifier we can find
5649 ;; inside the paren, to record the types.
5674 ;; If we are at the colon already, we move over the type
5675 ;; list after it.
5681 ;; Not at the colon, so stop here. But the identifier
5682 ;; ranges in the type list later on should still be
5683 ;; recorded.
5686 ;; If a keyword matched both one of the types above and
5687 ;; this one, we match `c-colon-type-list-re' after the
5688 ;; clause matched above.
5695 ;; There's a type after the `c-colon-type-list-re' match
5696 ;; after a keyword in `c-colon-type-list-kwds'.
5700 t)))
5702 ;; cc-mode requires cc-fonts.
5706 ;; The point is assumed to be at a "<". Try to treat it as the open
5707 ;; paren of an angle bracket arglist and move forward to the
5708 ;; corresponding ">". If successful, the point is left after the
5709 ;; ">" and t is returned, otherwise the point isn't moved and nil is
5710 ;; returned. If ALL-TYPES is t then all encountered arguments in
5711 ;; the arglist that might be types are treated as found types.
5712 ;;
5713 ;; The variable `c-parse-and-markup-<>-arglists' controls how this
5714 ;; function handles text properties on the angle brackets and argument
5715 ;; separating commas.
5716 ;;
5717 ;; `c-restricted-<>-arglists' controls how lenient the template
5718 ;; arglist recognition should be.
5719 ;;
5720 ;; This function records identifier ranges on
5721 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5722 ;; `c-record-type-identifiers' is non-nil.
5723 ;;
5724 ;; This function might do hidden buffer changes.
5727 ;; If `c-record-type-identifiers' is set then activate
5728 ;; recording of any found types that constitute an argument in
5729 ;; the arglist.
5737 ;; `nconc' doesn't mind that the tail of
5738 ;; `c-record-found-types' is t.
5741 t)
5744 nil)))
5747 ;; Recursive part of `c-forward-<>-arglist'.
5748 ;;
5749 ;; This function might do hidden buffer changes.
5752 ;; Cover this so that any recorded found type ranges are
5753 ;; automatically lost if it turns out to not be an angle
5754 ;; bracket arglist. It's propagated through the return value
5755 ;; on successful completion.
5757 ;; List that collects the positions after the argument
5758 ;; separating ',' in the arglist.
5759 arg-start-pos)
5760 ;; If the '<' has paren open syntax then we've marked it as an angle
5761 ;; bracket arglist before, so skip to the end.
5769 t
5770 ;; Got unmatched paren angle brackets. We don't clear the paren
5771 ;; syntax properties and retry, on the basis that it's very
5772 ;; unlikely that paren angle brackets become operators by code
5773 ;; manipulation. It's far more likely that it doesn't match due
5774 ;; to narrowing or some temporary change.
5776 nil))
5781 ;; go forward one non-alphanumeric character (group) per iteration of
5782 ;; this loop.
5789 ;; All encountered identifiers are types, so set the
5790 ;; promote flag and parse the type.
5813 ;; Note: These regexps exploit the match order in \| so
5814 ;; that "<>" is matched by "<" rather than "[^>:-]>".
5816 ;; Stop on ',', '|', '&', '+' and '-' to catch
5817 ;; common binary operators that could be between
5818 ;; two comparison expressions "a<b" and "c>d".
5820 nil t t))
5824 ;; Either an operator starting with '>' or the end of
5825 ;; the angle bracket arglist.
5832 ;; The angle bracket arglist is finished.
5844 ;; Either an operator starting with '<' or a nested arglist.
5848 ;; The '<' begins a multi-char operator.
5852 ;; We're at a nested <.....>
5858 ;; There's always an identifier before an angle
5859 ;; bracket arglist, or a keyword in `c-<>-type-kwds'
5860 ;; or `c-<>-arglist-kwds'.
5877 ;; It was an angle bracket arglist.
5880 ;; Record the identifier before the template as a type
5881 ;; or reference depending on whether the arglist is last
5882 ;; in a qualified identifier.
5892 ;; At a "less than" operator.
5895 )))
5902 ;; Just another argument. Record the position. The
5903 ;; type check stuff that made us stop at it is at
5904 ;; the top of the loop.
5908 ;; Got a character that can't be in an angle bracket
5909 ;; arglist argument. Abort using `throw', since
5910 ;; it's useless to try to find a surrounding arglist
5911 ;; if we're nested.
5917 ;; The point is assumed to be directly after a ">". Try to treat it
5918 ;; as the close paren of an angle bracket arglist and move back to
5919 ;; the corresponding "<". If successful, the point is left at
5920 ;; the "<" and t is returned, otherwise the point isn't moved and
5921 ;; nil is returned. ALL-TYPES is passed on to
5922 ;; `c-forward-<>-arglist'.
5923 ;;
5924 ;; If the optional LIMIT is given, it bounds the backward search.
5925 ;; It's then assumed to be at a syntactically relevant position.
5926 ;;
5927 ;; This is a wrapper around `c-forward-<>-arglist'. See that
5928 ;; function for more details.
5937 t
5938 ;; See corresponding note in `c-forward-<>-arglist'.
5940 nil)
5947 t
5948 ;; Stopped at bob or a char that isn't allowed in an
5949 ;; arglist, so we've failed.
5951 nil)
5956 ;; If we moved then the "<" was part of some
5957 ;; multicharacter token.
5958 t
5964 ;; Matched the arglist. Break the while.
5966 nil)
5968 ;; We started from a non-paren ">" inside an
5969 ;; arglist.
5971 nil)
5973 ;; Matched a shorter arglist. Can be a nested
5974 ;; one so continue looking.
5976 t))
5977 t))))))
5982 ;; Move forward over a complete name if at the beginning of one,
5983 ;; stopping at the next following token. A keyword, as such,
5984 ;; doesn't count as a name. If the point is not at something that
5985 ;; is recognized as a name then it stays put.
5986 ;;
5987 ;; A name could be something as simple as "foo" in C or something as
5988 ;; complex as "X<Y<class A<int>::B, BIT_MAX >> b>, ::operator<> ::
5989 ;; Z<(a>b)> :: operator const X<&foo>::T Q::G<unsigned short
5990 ;; int>::*volatile const" in C++ (this function is actually little
5991 ;; more than a `looking-at' call in all modes except those that,
5992 ;; like C++, have `c-recognize-<>-arglists' set).
5993 ;;
5994 ;; Return
5995 ;; o - nil if no name is found;
5996 ;; o - 'template if it's an identifier ending with an angle bracket
5997 ;; arglist;
5998 ;; o - 'operator of it's an operator identifier;
5999 ;; o - t if it's some other kind of name.
6000 ;;
6001 ;; This function records identifier ranges on
6002 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6003 ;; `c-record-type-identifiers' is non-nil.
6004 ;;
6005 ;; This function might do hidden buffer changes.
6008 ;; Turn off `c-promote-possible-types' here since we might
6009 ;; call `c-forward-<>-arglist' and we don't want it to promote
6010 ;; every suspect thing in the arglist to a type. We're
6011 ;; typically called from `c-forward-type' in this case, and
6012 ;; the caller only wants the top level type that it finds to
6013 ;; be promoted.
6014 c-promote-possible-types)
6020 ;; Check for keyword. We go to the last symbol in
6021 ;; `c-identifier-key' first.
6034 ;; "template" is only valid inside an
6035 ;; identifier if preceded by "::".
6040 t))
6042 ;; Handle a C++ operator or template identifier.
6046 ;; Got "... ::template".
6050 res subres))))
6053 ;; Got a cast operator.
6057 ;; Now we should match a sequence of either
6058 ;; '*', '&' or a name followed by ":: *",
6059 ;; where each can be followed by a sequence
6060 ;; of `c-opt-type-modifier-key'.
6063 t)
6073 t))))
6081 ;; Got some other operator.
6089 nil)
6091 ;; `id-start' is equal to `id-end' if we've jumped over
6092 ;; an identifier that doesn't end with a symbol token.
6093 ;; That can occur e.g. for Java import directives on the
6094 ;; form "foo.bar.*".
6101 res t)))
6111 ;; Got a concatenated identifier. This handles the
6112 ;; cases with tricky syntactic whitespace that aren't
6113 ;; covered in `c-identifier-key'.
6116 t)
6120 ;; Maybe an angle bracket arglist.
6128 c-last-identifier-range nil)
6133 ;; Continue if there's an identifier concatenation
6134 ;; operator after the template argument.
6140 t)
6145 nil)))
6146 )))))
6149 res))
6152 ;; Move forward over a type spec if at the beginning of one,
6153 ;; stopping at the next following token. The keyword "typedef"
6154 ;; isn't part of a type spec here.
6155 ;;
6156 ;; BRACE-BLOCK-TOO, when non-nil, means move over the brace block in
6157 ;; constructs like "struct foo {...} bar ;" or "struct {...} bar;".
6158 ;; The current (2009-03-10) intention is to convert all uses of
6159 ;; `c-forward-type' to call with this parameter set, then to
6160 ;; eliminate it.
6161 ;;
6162 ;; Return
6163 ;; o - t if it's a known type that can't be a name or other
6164 ;; expression;
6165 ;; o - 'known if it's an otherwise known type (according to
6166 ;; `*-font-lock-extra-types');
6167 ;; o - 'prefix if it's a known prefix of a type;
6168 ;; o - 'found if it's a type that matches one in `c-found-types';
6169 ;; o - 'maybe if it's an identifier that might be a type; or
6170 ;; o - nil if it can't be a type (the point isn't moved then).
6171 ;;
6172 ;; The point is assumed to be at the beginning of a token.
6173 ;;
6174 ;; Note that this function doesn't skip past the brace definition
6175 ;; that might be considered part of the type, e.g.
6176 ;; "enum {a, b, c} foo".
6177 ;;
6178 ;; This function records identifier ranges on
6179 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6180 ;; `c-record-type-identifiers' is non-nil.
6181 ;;
6182 ;; This function might do hidden buffer changes.
6190 ;; Skip leading type modifiers. If any are found we know it's a
6191 ;; prefix of a type.
6200 ; "typedef".
6208 ;; In many languages the name can be used without the
6209 ;; prefix, so we add it to `c-found-types'.
6212 c-last-identifier-range)
6234 id-range c-last-identifier-range))))
6246 id-end)
6248 ;; Looking at a primitive or known type identifier. We've
6249 ;; checked for a name first so that we don't go here if the
6250 ;; known type match only is a prefix of another name.
6261 ;; There might be more keywords for the type.
6289 ;; A normal identifier.
6299 ;; It's an identifier that has been used as
6300 ;; a type somewhere else.
6301 'found
6302 ;; It's an identifier that might be a type.
6305 ;; A template is a type.
6309 ;; Otherwise it's an operator identifier, which is not a type.
6314 ;; Skip trailing type modifiers. If any are found we know it's
6315 ;; a type.
6321 ;; Step over any type suffix operator. Do not let the existence
6322 ;; of these alter the classification of the found type, since
6323 ;; these operators typically are allowed in normal expressions
6324 ;; too.
6331 ;; Look for a trailing operator that concatenates the type
6332 ;; with a following one, and if so step past that one through
6333 ;; a recursive call. Note that we don't record concatenated
6334 ;; types in `c-found-types' - it's the component types that
6335 ;; are recorded when appropriate.
6338 c-promote-possible-types))
6339 ;; If we can't promote then set `c-record-found-types' so that
6340 ;; we can merge in the types from the second part afterwards if
6341 ;; it turns out to be a known type there.
6344 subres)
6353 ;; If either operand certainly is a type then both are, but we
6354 ;; don't let the existence of the operator itself promote two
6355 ;; uncertain types to a certain one.
6374 ;; Merge in the ranges of any types found by the second
6375 ;; `c-forward-type'.
6377 ;; `nconc' doesn't mind that the tail of
6378 ;; `c-record-found-types' is t.
6380 c-record-type-identifiers))))
6388 ;;(message "c-forward-type %s -> %s: %s" start (point) res)
6390 res))
6393 ;; Used for Java code only at the moment. Assumes point is on the
6394 ;; @, moves forward an annotation. returns nil if there is no
6395 ;; annotation at point.
6402 t)))
6404 \f
6405 ;; Handling of large scale constructs like statements and declarations.
6407 ;; Macro used inside `c-forward-decl-or-cast-1'. It ought to be a
6408 ;; defsubst or perhaps even a defun, but it contains lots of free
6409 ;; variables that refer to things inside `c-forward-decl-or-cast-1'.
6411 ;; `c-forward-decl-or-cast-1' can consume an arbitrary length list
6412 ;; of types when parsing a declaration, which means that it
6413 ;; sometimes consumes the identifier in the declaration as a type.
6414 ;; This is used to "backtrack" and make the last type be treated as
6415 ;; an identifier instead.
6418 ;; These identifiers are bound only in the inner let.
6420 identifier-start type-start
6421 got-parens nil
6422 got-identifier t
6423 got-suffix t
6424 got-suffix-after-parens id-start
6428 t
6429 backup-at-type))
6431 id-start backup-id-start)
6433 id-start start-pos))
6435 ;; When these flags already are set we've found specifiers that
6436 ;; unconditionally signal these attributes - backtracking doesn't
6437 ;; change that. So keep them set in that case.
6444 ;; This identifier is bound only in the inner let.
6448 ;; Move forward over a declaration or a cast if at the start of one.
6449 ;; The point is assumed to be at the start of some token. Nil is
6450 ;; returned if no declaration or cast is recognized, and the point
6451 ;; is clobbered in that case.
6452 ;;
6453 ;; If a declaration is parsed:
6454 ;;
6455 ;; The point is left at the first token after the first complete
6456 ;; declarator, if there is one. The return value is a cons where
6457 ;; the car is the position of the first token in the declarator. (See
6458 ;; below for the cdr.)
6459 ;; Some examples:
6460 ;;
6461 ;; void foo (int a, char *b) stuff ...
6462 ;; car ^ ^ point
6463 ;; float (*a)[], b;
6464 ;; car ^ ^ point
6465 ;; unsigned int a = c_style_initializer, b;
6466 ;; car ^ ^ point
6467 ;; unsigned int a (cplusplus_style_initializer), b;
6468 ;; car ^ ^ point (might change)
6469 ;; class Foo : public Bar {}
6470 ;; car ^ ^ point
6471 ;; class PikeClass (int a, string b) stuff ...
6472 ;; car ^ ^ point
6473 ;; enum bool;
6474 ;; car ^ ^ point
6475 ;; enum bool flag;
6476 ;; car ^ ^ point
6477 ;; void cplusplus_function (int x) throw (Bad);
6478 ;; car ^ ^ point
6479 ;; Foo::Foo (int b) : Base (b) {}
6480 ;; car ^ ^ point
6481 ;;
6482 ;; The cdr of the return value is non-nil when a
6483 ;; `c-typedef-decl-kwds' specifier is found in the declaration.
6484 ;; Specifically it is a dotted pair (A . B) where B is t when a
6485 ;; `c-typedef-kwds' ("typedef") is present, and A is t when some
6486 ;; other `c-typedef-decl-kwds' (e.g. class, struct, enum)
6487 ;; specifier is present. I.e., (some of) the declared
6488 ;; identifier(s) are types.
6489 ;;
6490 ;; If a cast is parsed:
6491 ;;
6492 ;; The point is left at the first token after the closing paren of
6493 ;; the cast. The return value is `cast'. Note that the start
6494 ;; position must be at the first token inside the cast parenthesis
6495 ;; to recognize it.
6496 ;;
6497 ;; PRECEDING-TOKEN-END is the first position after the preceding
6498 ;; token, i.e. on the other side of the syntactic ws from the point.
6499 ;; Use a value less than or equal to (point-min) if the point is at
6500 ;; the first token in (the visible part of) the buffer.
6501 ;;
6502 ;; CONTEXT is a symbol that describes the context at the point:
6503 ;; 'decl In a comma-separated declaration context (typically
6504 ;; inside a function declaration arglist).
6505 ;; '<> In an angle bracket arglist.
6506 ;; 'arglist Some other type of arglist.
6507 ;; nil Some other context or unknown context. Includes
6508 ;; within the parens of an if, for, ... construct.
6509 ;;
6510 ;; LAST-CAST-END is the first token after the closing paren of a
6511 ;; preceding cast, or nil if none is known. If
6512 ;; `c-forward-decl-or-cast-1' is used in succession, it should be
6513 ;; the position after the closest preceding call where a cast was
6514 ;; matched. In that case it's used to discover chains of casts like
6515 ;; "(a) (b) c".
6516 ;;
6517 ;; This function records identifier ranges on
6518 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6519 ;; `c-record-type-identifiers' is non-nil.
6520 ;;
6521 ;; This function might do hidden buffer changes.
6524 ;; first type, i.e. after any leading specifiers. It might
6525 ;; also point at the beginning of the preceding syntactic
6526 ;; whitespace.
6528 ;; Set to the result of `c-forward-type'.
6529 at-type
6530 ;; The position of the first token in what we currently
6531 ;; believe is the type in the declaration or cast, after any
6532 ;; specifiers and their associated clauses.
6533 type-start
6534 ;; The position of the first token in what we currently
6535 ;; believe is the declarator for the first identifier. Set
6536 ;; when the type is found, and moved forward over any
6537 ;; `c-decl-hangon-kwds' and their associated clauses that
6538 ;; occurs after the type.
6539 id-start
6540 ;; These store `at-type', `type-start' and `id-start' of the
6541 ;; identifier before the one in those variables. The previous
6542 ;; identifier might turn out to be the real type in a
6543 ;; declaration if the last one has to be the declarator in it.
6544 ;; If `backup-at-type' is nil then the other variables have
6545 ;; undefined values.
6546 backup-at-type backup-type-start backup-id-start
6547 ;; Set if we've found a specifier (apart from "typedef") that makes
6548 ;; the defined identifier(s) types.
6549 at-type-decl
6550 ;; Set if we've a "typedef" keyword.
6551 at-typedef
6552 ;; Set if we've found a specifier that can start a declaration
6553 ;; where there's no type.
6554 maybe-typeless
6555 ;; If a specifier is found that also can be a type prefix,
6556 ;; these flags are set instead of those above. If we need to
6557 ;; back up an identifier, they are copied to the real flag
6558 ;; variables. Thus they only take effect if we fail to
6559 ;; interpret it as a type.
6560 backup-at-type-decl backup-maybe-typeless
6561 ;; Whether we've found a declaration or a cast. We might know
6562 ;; this before we've found the type in it. It's 'ids if we've
6563 ;; found two consecutive identifiers (usually a sure sign, but
6564 ;; we should allow that in labels too), and t if we've found a
6565 ;; specifier keyword (a 100% sure sign).
6566 at-decl-or-cast
6567 ;; Set when we need to back up to parse this as a declaration
6568 ;; but not as a cast.
6569 backup-if-not-cast
6570 ;; For casts, the return position.
6571 cast-end
6572 ;; Save `c-record-type-identifiers' and
6573 ;; `c-record-ref-identifiers' since ranges are recorded
6574 ;; speculatively and should be thrown away if it turns out
6575 ;; that it isn't a declaration or cast.
6582 ;; Check for a type. Unknown symbols are treated as possible
6583 ;; types, but they could also be specifiers disguised through
6584 ;; macros like __INLINE__, so we recognize both types and known
6585 ;; specifiers after them too.
6589 ;; Look for a specifier keyword clause.
6601 ;; Found a known or possible type or a prefix of a known type.
6604 ;; Got two identifiers with nothing but whitespace
6605 ;; between them. That can only happen in declarations.
6609 ;; If the previous identifier is a found type we
6610 ;; record it as a real one; it might be some sort of
6611 ;; alias for a prefix like "unsigned".
6618 backup-type-start type-start
6619 backup-id-start id-start
6620 at-type found-type
6621 type-start start
6623 ;; The previous ambiguous specifier/type turned out
6624 ;; to be a type since we've parsed another one after
6625 ;; it, so clear these backup flags.
6626 backup-at-type-decl nil
6627 backup-maybe-typeless nil))
6631 ;; Handle known specifier keywords and
6632 ;; `c-decl-hangon-kwds' which can occur after known
6633 ;; types.
6636 ;; It's a hang-on keyword that can occur anywhere.
6640 ;; Move the identifier start position if
6641 ;; we've passed a type.
6643 ;; Otherwise treat this as a specifier and
6644 ;; move the fallback position.
6648 ;; It's an ordinary specifier so we know that
6649 ;; anything before this can't be the type.
6651 start-pos kwd-clause-end)
6654 ;; It's ambiguous whether this keyword is a
6655 ;; specifier or a type prefix, so set the backup
6656 ;; flags. (It's assumed that `c-forward-type'
6657 ;; moved further than `c-forward-keyword-clause'.)
6665 ;; This test only happens after we've scanned a type.
6666 ;; So, with valid syntax, kwd-sym can't be 'typedef.
6671 ;; Haven't matched a type so it's an unambiguous
6672 ;; specifier keyword and we know we're in a
6673 ;; declaration.
6678 ;; If the type isn't known we continue so that we'll jump
6679 ;; over all specifiers and type identifiers. The reason
6680 ;; to do this for a known type prefix is to make things
6681 ;; like "unsigned INT16" work.
6686 ;; If a known type was found, we still need to skip over any
6687 ;; hangon keyword clauses after it. Otherwise it has already
6688 ;; been done in the loop above.
6694 ;; A prefix type is itself a primitive type when it's not
6695 ;; followed by another type.
6699 ;; Got no type but set things up to continue anyway to handle
6700 ;; the various cases when a declaration doesn't start with a
6701 ;; type.
6706 ;; If it's C++ then check if the last "type" ends on the form
6707 ;; "foo::foo" or "foo::~foo", i.e. if it's the name of a
6708 ;; (con|de)structor.
6719 ;; Cheating in the handling of syntactic ws below.
6726 name))
6727 ;; It is a (con|de)structor name. In that case the
6728 ;; declaration is typeless so zap out any preceding
6729 ;; identifier(s) that we might have taken as types.
6732 backup-at-type nil
6733 id-start type-start))))))
6735 ;; Check for and step over a type decl expression after the thing
6736 ;; that is or might be a type. This can't be skipped since we
6737 ;; need the correct end position of the declarator for
6738 ;; `max-type-decl-end-*'.
6740 ;; True if there's a non-open-paren match of
6741 ;; `c-type-decl-prefix-key'.
6742 got-prefix
6743 ;; True if the declarator is surrounded by a parenthesis pair.
6744 got-parens
6745 ;; True if there is an identifier in the declarator.
6746 got-identifier
6747 ;; True if there's a non-close-paren match of
6748 ;; `c-type-decl-suffix-key'.
6749 got-suffix
6750 ;; True if there's a prefix match outside the outermost
6751 ;; paren pair that surrounds the declarator.
6752 got-prefix-before-parens
6753 ;; True if there's a suffix match outside the outermost
6754 ;; paren pair that surrounds the declarator. The value is
6755 ;; the position of the first suffix match.
6756 got-suffix-after-parens
6757 ;; True if we've parsed the type decl to a token that is
6758 ;; known to end declarations in this context.
6759 at-decl-end
6760 ;; The earlier values of `at-type' and `type-start' if we've
6761 ;; shifted the type backwards.
6762 identifier-type identifier-start
6763 ;; If `c-parse-and-markup-<>-arglists' is set we need to
6764 ;; turn it off during the name skipping below to avoid
6765 ;; getting `c-type' properties that might be bogus. That
6766 ;; can happen since we don't know if
6767 ;; `c-restricted-<>-arglists' will be correct inside the
6768 ;; arglist paren that gets entered.
6773 ;; Skip over type decl prefix operators. (Note similar code in
6774 ;; `c-font-lock-declarators'.)
6778 ;; If the second submatch matches in C++ then
6779 ;; we're looking at an identifier that's a
6780 ;; prefix only if it specifies a member pointer.
6783 ;; We only check for a trailing "::" and
6784 ;; let the "*" that should follow be
6785 ;; matched in the next round.
6787 ;; It turned out to be the real identifier,
6788 ;; so stop.
6789 nil))
6790 t))
6804 ;; Skip over an identifier.
6809 ;; Skip over type decl suffix operators.
6816 t)
6820 t)
6826 ;; No suffix matched. We might have matched the
6827 ;; identifier as a type and the open paren of a
6828 ;; function arglist as a type decl prefix. In that
6829 ;; case we should "backtrack": Reinterpret the last
6830 ;; type as the identifier, move out of the arglist and
6831 ;; continue searching for suffix operators.
6832 ;;
6833 ;; Do this even if there's no preceding type, to cope
6834 ;; with old style function declarations in K&R C,
6835 ;; (con|de)structors in C++ and `c-typeless-decl-kwds'
6836 ;; style declarations. That isn't applicable in an
6837 ;; arglist context, though.
6842 maybe-typeless
6843 backup-maybe-typeless
6850 t))
6857 at-type)
6858 ;; Have found no identifier but `c-typeless-decl-kwds' has
6859 ;; matched so we know we're inside a declaration. The
6860 ;; preceding type must be the identifier instead.
6864 at-decl-or-cast
6867 ;; CASE 1
6869 ;; Encountered something inside parens that isn't matched by
6870 ;; the `c-type-decl-*' regexps, so it's not a type decl
6871 ;; expression. Try to skip out to the same paren depth to
6872 ;; not confuse the cast check below.
6874 ;; If we've found a specifier keyword then it's a
6875 ;; declaration regardless.
6883 ;; Now we've collected info about various characteristics of
6884 ;; the construct we're looking at. Below follows a decision
6885 ;; tree based on that. It's ordered to check more certain
6886 ;; signs before less certain ones.
6891 ;; CASE 2
6894 ;; Got another identifier directly after the type, so it's a
6895 ;; declaration.
6902 maybe-typeless
6903 backup-maybe-typeless))
6904 ;; Got a declaration of the form "foo bar (gnu);" where we've
6905 ;; recognized "bar" as the type and "gnu" as the declarator.
6906 ;; In this case it's however more likely that "bar" is the
6907 ;; declarator and "gnu" a function argument or initializer (if
6908 ;; `c-recognize-paren-inits' is set), since the parens around
6909 ;; "gnu" would be superfluous if it's a declarator. Shift the
6910 ;; type one step backward.
6913 ;; Found no identifier.
6919 ;; CASE 3
6921 ;; Got a plain list of identifiers. If a colon follows it's
6922 ;; a valid label, or maybe a bitfield. Otherwise the last
6923 ;; one probably is the declared identifier and we should
6924 ;; back up to the previous type, providing it isn't a cast.
6928 ;; If we've found a specifier keyword then it's a
6929 ;; declaration regardless.
6940 ;; CASE 4
6944 ;; Got a plain list of identifiers followed by some suffix.
6945 ;; If this isn't a cast then the last identifier probably is
6946 ;; the declared one and we should back up to the previous
6947 ;; type.
6951 ;; CASE 5
6953 ;; If the type is known we know that there can't be any
6954 ;; identifier somewhere else, and it's only in declarations in
6955 ;; e.g. function prototypes and in casts that the identifier may
6956 ;; be left out.
6960 ;; Only got a single identifier (parsed as a type so far).
6961 ;; CASE 6
6963 ;; Check that the identifier isn't at the start of an
6964 ;; expression.
6965 at-decl-end
6968 ;; Inside an arglist that contains declarations. If K&R
6969 ;; style declarations and parenthesis style initializers
6970 ;; aren't allowed then the single identifier must be a
6971 ;; type, else we require that it's known or found
6972 ;; (primitive types are handled above).
6977 ;; Inside a template arglist. Accept known and found
6978 ;; types; other identifiers could just as well be
6979 ;; constants in C++.
6982 ;; CASE 7
6983 ;; Can't be a valid declaration or cast, but if we've found a
6984 ;; specifier it can't be anything else either, so treat it as
6985 ;; an invalid/unfinished declaration or cast.
6993 maybe-typeless
6994 backup-maybe-typeless
6998 c-after-suffixed-type-maybe-decl-key))))))
6999 ;; Got an empty paren pair and a preceding type that probably
7000 ;; really is the identifier. Shift the type backwards to make
7001 ;; the last one the identifier. This is analogous to the
7002 ;; "backtracking" done inside the `c-type-decl-suffix-key' loop
7003 ;; above.
7004 ;;
7005 ;; Exception: In addition to the conditions in that
7006 ;; "backtracking" code, do not shift backward if we're not
7007 ;; looking at either `c-after-suffixed-type-decl-key' or "[;,]".
7008 ;; Since there's no preceding type, the shift would mean that
7009 ;; the declaration is typeless. But if the regexp doesn't match
7010 ;; then we will simply fall through in the tests below and not
7011 ;; recognize it at all, so it's better to try it as an abstract
7012 ;; declarator instead.
7015 ;; Still no identifier.
7016 ;; CASE 8
7018 ;; Require `got-prefix' together with either `got-parens' or
7019 ;; `got-suffix' to recognize it as an abstract declarator:
7020 ;; `got-parens' only is probably an empty function call.
7021 ;; `got-suffix' only can build an ordinary expression together
7022 ;; with the preceding identifier which we've taken as a type.
7023 ;; We could actually accept on `got-prefix' only, but that can
7024 ;; easily occur temporarily while writing an expression so we
7025 ;; avoid that case anyway. We could do a better job if we knew
7026 ;; the point when the fontification was invoked.
7029 ;; CASE 9
7033 got-suffix-after-parens
7035 ;; Got a type, no declarator but a paren suffix. I.e. it's a
7036 ;; normal function call after all (or perhaps a C++ style object
7037 ;; instantiation expression).
7040 ;; CASE 10
7042 ;; By now we've located the type in the declaration that we know
7043 ;; we're in.
7046 ;; CASE 11
7054 ;; Shift the type backward in the case that there's a
7055 ;; single identifier inside parens. That can only
7056 ;; occur in K&R style function declarations so it's
7057 ;; more likely that it really is a function call.
7058 ;; Therefore we only do this after
7059 ;; `c-after-suffixed-type-decl-key' has matched.
7061 got-suffix-after-parens))
7062 ;; A declaration according to `c-after-suffixed-type-decl-key'.
7065 ;; CASE 12
7068 ;; It's a declaration if a known type precedes it and it can't be a
7069 ;; function call.
7072 ;; If we get here we can't tell if this is a type decl or a normal
7073 ;; expression by looking at it alone. (That's under the assumption
7074 ;; that normal expressions always can look like type decl expressions,
7075 ;; which isn't really true but the cases where it doesn't hold are so
7076 ;; uncommon (e.g. some placements of "const" in C++) it's not worth
7077 ;; the effort to look for them.)
7080 ;; If this is a declaration it should end here or its initializer(*)
7081 ;; should start here, so check for allowed separation tokens. Note
7082 ;; that this rule doesn't work e.g. with a K&R arglist after a
7083 ;; function header.
7084 ;;
7085 ;; *) Don't check for C++ style initializers using parens
7086 ;; since those already have been matched as suffixes.
7087 ;;
7088 ;; If `at-decl-or-cast' is then we've found some other sign that
7089 ;; it's a declaration or cast, so then it's probably an
7090 ;; invalid/unfinished one.
7093 ;; Below are tests that only should be applied when we're certain to
7094 ;; not have parsed halfway through an expression.
7096 ;; CASE 14
7098 ;; The expression starts with a known type so treat it as a
7099 ;; declaration.
7102 ;; CASE 15
7104 ;; In C++ we check if the identifier is a known type, since
7105 ;; (con|de)structors use the class name as identifier.
7106 ;; We've always shifted over the identifier as a type and
7107 ;; then backed up again in this case.
7108 identifier-type
7111 ;; `at-type' probably won't be 'found for
7112 ;; destructors since the "~" is then part of the
7113 ;; type name being checked against the list of
7114 ;; known types, so do a check without that
7115 ;; operator.
7120 c-identifier-syntax-table
7124 ;; We have already parsed the type earlier,
7125 ;; so it'd be possible to cache the end
7126 ;; position instead of redoing it here, but
7127 ;; then we'd need to keep track of another
7128 ;; position everywhere.
7136 ;; CASE 16
7138 at-type
7142 ;; Got something like "foo * bar;". Since we're not inside an
7143 ;; arglist it would be a meaningless expression because the
7144 ;; result isn't used. We therefore choose to recognize it as
7145 ;; a declaration. Do not allow a suffix since it could then
7146 ;; be a function call.
7149 ;; CASE 17
7154 ;; Got something like "a (*b) (c);" or "a (b) = c;". It could
7155 ;; be an odd expression or it could be a declaration. Treat
7156 ;; it as a declaration if "a" has been used as a type
7157 ;; somewhere else (if it's a known type we won't get here).
7160 ;; CASE 18
7166 ;; Got a type followed by an abstract declarator. If `got-prefix'
7167 ;; is set it's something like "a *" without anything after it. If
7168 ;; `got-parens' or `got-suffix' is set it's "a()", "a[]", "a()[]",
7169 ;; or similar, which we accept only if the context rules out
7170 ;; expressions.
7173 ;; If we had a complete symbol table here (which rules out
7174 ;; `c-found-types') we should return t due to the disambiguation rule
7175 ;; (in at least C++) that anything that can be parsed as a declaration
7176 ;; is a declaration. Now we're being more defensive and prefer to
7177 ;; highlight things like "foo (bar);" as a declaration only if we're
7178 ;; inside an arglist that contains declarations.
7181 ;; The point is now after the type decl expression.
7184 ;; Check for a cast.
7187 c-cast-parens
7189 ;; Should be the first type/identifier in a cast paren.
7193 ;; The closing paren should follow.
7198 ;; There should be a primary expression after it.
7207 ;; Check if the expression begins with a prefix keyword.
7210 ;; Expression begins with an ambiguous operator. Treat
7211 ;; it as a cast if it's a type decl or if we've
7212 ;; recognized the type somewhere else.
7215 ;; Unless it's a keyword, it's the beginning of a primary
7216 ;; expression.
7218 ;; If `c-primary-expr-regexp' matched a nonsymbol token, check
7219 ;; that it matched a whole one so that we don't e.g. confuse
7220 ;; the operator '-' with '->'. It's ok if it matches further,
7221 ;; though, since it e.g. can match the float '.5' while the
7222 ;; operator regexp only matches '.'.
7226 ;; There should either be a cast before it or something that isn't an
7227 ;; identifier or close paren.
7235 ;; It's a symbol. Accept it only if it's one of the
7236 ;; keywords that can precede an expression (without
7237 ;; surrounding parens).
7240 ;; Check that it isn't a close paren (block close is ok,
7241 ;; though).
7243 ;; Check that it isn't a nonsymbol identifier.
7246 ;; Handle the cast.
7256 ;; We're at a declaration. Highlight the type and the following
7257 ;; declarators.
7263 ;; Make sure to propagate the `c-decl-arg-start' property to
7264 ;; the next argument if it's set in this one, to cope with
7265 ;; interactive refontification.
7279 ;; False alarm. Restore the recorded ranges.
7281 c-record-ref-identifiers save-rec-ref-ids)
7282 nil))))
7285 ;; Assuming that point is at the beginning of a token, check if it starts a
7286 ;; label and if so move over it and return non-nil (t in default situations,
7287 ;; specific symbols (see below) for interesting situations), otherwise don't
7288 ;; move and return nil. "Label" here means "most things with a colon".
7289 ;;
7290 ;; More precisely, a "label" is regarded as one of:
7291 ;; (i) a goto target like "foo:" - returns the symbol `goto-target';
7292 ;; (ii) A case label - either the entire construct "case FOO:", or just the
7293 ;; bare "case", should the colon be missing. We return t;
7294 ;; (iii) a keyword which needs a colon, like "default:" or "private:"; We
7295 ;; return t;
7296 ;; (iv) One of QT's "extended" C++ variants of
7297 ;; "private:"/"protected:"/"public:"/"more:" looking like "public slots:".
7298 ;; Returns the symbol `qt-2kwds-colon'.
7299 ;; (v) QT's construct "signals:". Returns the symbol `qt-1kwd-colon'.
7300 ;; (vi) One of the keywords matched by `c-opt-extra-label-key' (without any
7301 ;; colon). Currently (2006-03), this applies only to Objective C's
7302 ;; keywords "@private", "@protected", and "@public". Returns t.
7303 ;;
7304 ;; One of the things which will NOT be recognized as a label is a bit-field
7305 ;; element of a struct, something like "int foo:5".
7306 ;;
7307 ;; The end of the label is taken to be just after the colon, or the end of
7308 ;; the first submatch in `c-opt-extra-label-key'. The point is directly
7309 ;; after the end on return. The terminating char gets marked with
7310 ;; `c-decl-end' to improve recognition of the following declaration or
7311 ;; statement.
7312 ;;
7313 ;; If ASSUME-MARKUP is non-nil, it's assumed that the preceding
7314 ;; label, if any, has already been marked up like that.
7315 ;;
7316 ;; If PRECEDING-TOKEN-END is given, it should be the first position
7317 ;; after the preceding token, i.e. on the other side of the
7318 ;; syntactic ws from the point. Use a value less than or equal to
7319 ;; (point-min) if the point is at the first token in (the visible
7320 ;; part of) the buffer.
7321 ;;
7322 ;; The optional LIMIT limits the forward scan for the colon.
7323 ;;
7324 ;; This function records the ranges of the label symbols on
7325 ;; `c-record-ref-identifiers' if `c-record-type-identifiers' (!) is
7326 ;; non-nil.
7327 ;;
7328 ;; This function might do hidden buffer changes.
7331 label-end
7332 qt-symbol-idx
7333 macro-start ; if we're in one.
7334 label-type
7335 kwd)
7337 ;; "case" or "default" (Doesn't apply to AWK).
7340 ;; Record only the keyword itself for fontification, since in
7341 ;; case labels the following is a constant expression and not
7342 ;; a label.
7346 ;; Find the label end.
7350 ;; Stop on chars that aren't allowed in expressions,
7351 ;; and on operator chars that would be meaningless
7352 ;; there. FIXME: This doesn't cope with ?: operators.
7360 t)
7362 ;; It's an unfinished label. We consider the keyword enough
7363 ;; to recognize it as a label, so that it gets fontified.
7364 ;; Leave the point at the end of it, but don't put any
7365 ;; `c-decl-end' marker.
7367 t))))
7369 ;; @private, @protected, @public, in Objective C, or similar.
7372 ;; For a `c-opt-extra-label-key' match, we record the whole
7373 ;; thing for fontification. That's to get the leading '@' in
7374 ;; Objective-C protection labels fontified.
7381 ;; All other cases of labels.
7384 ;; A colon label must have something before the colon.
7387 ;; Check that we're not after a token that can't precede a label.
7389 ;; Trivially succeeds when there's no preceding token.
7390 ;; Succeeds when we're at a virtual semicolon.
7399 ;; Check if we're after a label, if we're after a closing
7400 ;; paren that belong to statement, and with
7401 ;; `c-label-prefix-re'. It's done in different order
7402 ;; depending on `assume-markup' since the checks have
7403 ;; different expensiveness.
7430 ;; Might be after another label, so check it recursively.
7434 ;; Essentially the same as the
7435 ;; `c-syntactic-re-search-forward' regexp below.
7441 ;; Note: the following should work instead of the
7442 ;; narrow-to-region above. Investigate why not,
7443 ;; sometime. ACM, 2006-03-31.
7444 ;; (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+"
7445 ;; macro-start t)
7447 ;; If the caller turned on recording for us,
7448 ;; it shouldn't apply when we check the
7449 ;; preceding label.
7450 c-record-type-identifiers)
7451 ;; A label can't start at a cpp directive. Check for
7452 ;; this, since c-forward-syntactic-ws would foul up on it.
7457 ;; Point is still at the beginning of the possible label construct.
7458 ;;
7459 ;; Check that the next nonsymbol token is ":", or that we're in one
7460 ;; of QT's "slots" declarations. Allow '(' for the sake of macro
7461 ;; arguments. FIXME: Should build this regexp from the language
7462 ;; constants.
7464 ;; public: protected: private:
7474 ;; QT double keyword like "protected slots:" or goto target.
7493 'qt-1kwd-colon
7505 ;; Check that `c-nonlabel-token-key' doesn't match anywhere.
7515 t)
7518 ;; Record the identifiers in the label for fontification, unless
7519 ;; it begins with `c-label-kwds' in which case the following
7520 ;; identifiers are part of a (constant) expression that
7521 ;; shouldn't be fontified.
7533 ;; Not a label.
7535 label-type))
7538 ;; Assuming the point is at the beginning of a token, try to move
7539 ;; forward to the end of the Objective-C directive that starts
7540 ;; there. Return t if a directive was fully recognized, otherwise
7541 ;; the point is moved as far as one could be successfully parsed and
7542 ;; nil is returned.
7543 ;;
7544 ;; This function records identifier ranges on
7545 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
7546 ;; `c-record-type-identifiers' is non-nil.
7547 ;;
7548 ;; This function might do hidden buffer changes.
7551 start-char
7553 lim
7554 ;; Turn off recognition of angle bracket arglists while parsing
7555 ;; types here since the protocol reference list might then be
7556 ;; considered part of the preceding name or superclass-name.
7567 t)
7576 ;; Handle the name of the class itself.
7578 ; (c-forward-token-2) ; 2006/1/13 This doesn't move if the token's
7579 ; at EOB.
7586 ;; Look for ": superclass-name" or "( category-name )".
7597 ;; Look for a protocol reference list.
7603 t))))
7609 t)
7612 nil)))
7615 ;; Go to the first non-whitespace after the colon that starts a
7616 ;; multiple inheritance introduction. Optional LIM is the farthest
7617 ;; back we should search.
7618 ;;
7619 ;; This function might do hidden buffer changes.
7627 ;; Return nil if we aren't in a method definition, otherwise the
7628 ;; position of the initial [+-].
7629 ;;
7630 ;; This function might do hidden buffer changes.
7636 ))
7638 ;; Contributed by Kevin Ryde <user42@zip.com.au>.
7640 ;; Return non-nil if point is within a gcc \"asm\" block.
7641 ;;
7642 ;; This should be called with point inside an argument list.
7643 ;;
7644 ;; Only one level of enclosing parentheses is considered, so for
7645 ;; instance `nil' is returned when in a function call within an asm
7646 ;; operand.
7647 ;;
7648 ;; This function might do hidden buffer changes.
7660 a function.
7662 More precisely, being at the top-level means that point is either
7663 outside any enclosing block (such as a function definition), or
7664 directly inside a class, namespace or other block that contains
7665 another declaration level.
7667 If point is not at the top-level (e.g. it is inside a method
7668 definition), then nil is returned. Otherwise, if point is at a
7669 top-level not enclosed within a class definition, t is returned.
7670 Otherwise, a 2-vector is returned where the zeroth element is the
7671 buffer position of the start of the class declaration, and the first
7672 element is the buffer position of the enclosing class's opening
7673 brace.
7675 Note that this function might do hidden buffer changes. See the
7676 comment at the start of cc-engine.el for more info."
7682 ;; Return non-nil if the point is in the region after the argument
7683 ;; list of a function and its opening brace (or semicolon in case it
7684 ;; got no body). If there are K&R style argument declarations in
7685 ;; that region, the point has to be inside the first one for this
7686 ;; function to recognize it.
7687 ;;
7688 ;; If successful, the point is moved to the first token after the
7689 ;; function header (see `c-forward-decl-or-cast-1' for details) and
7690 ;; the position of the opening paren of the function arglist is
7691 ;; returned.
7692 ;;
7693 ;; The point is clobbered if not successful.
7694 ;;
7695 ;; LIM is used as bound for backward buffer searches.
7696 ;;
7697 ;; This function might do hidden buffer changes.
7710 ;; There should not be a '=' or ',' between beg and the
7711 ;; start of the declaration since that means we were in the
7712 ;; "expression part" of the declaration.
7717 ;; Check that there's an arglist paren in the
7718 ;; declaration.
7721 ;; The declarator is a paren expression, so skip past it
7722 ;; so that we don't get stuck on that instead of the
7723 ;; function arglist.
7727 ;; Don't trip up on "operator ()".
7734 ;; Return the position of the first argument declaration if point is
7735 ;; inside a K&R style argument declaration list, nil otherwise.
7736 ;; `c-recognize-knr-p' is not checked. If LIM is non-nil, it's a
7737 ;; position that bounds the backward search for the argument list.
7738 ;;
7739 ;; Point must be within a possible K&R region, e.g. just before a top-level
7740 ;; "{". It must be outside of parens and brackets. The test can return
7741 ;; false positives otherwise.
7742 ;;
7743 ;; This function might do hidden buffer changes.
7747 ;; If we're in a macro, our search range is restricted to it. Narrow to
7748 ;; the searchable range.
7752 before-lparen after-rparen
7754 ; we give up
7757 ;; Search backwards for the defun's argument list. We give up if we
7758 ;; encounter a "}" (end of a previous defun) an "=" (which can't be in
7759 ;; a knr region) or BOB.
7760 ;;
7761 ;; The criterion for a paren structure being the arg list is:
7762 ;; o - there is non-WS stuff after it but before any "{"; AND
7763 ;; o - the token after it isn't a ";" AND
7764 ;; o - it is preceded by either an identifier (the function name) or
7765 ;; a macro expansion like "DEFUN (...)"; AND
7766 ;; o - its content is a non-empty comma-separated list of identifiers
7767 ;; (an empty arg list won't have a knr region).
7768 ;;
7769 ;; The following snippet illustrates these rules:
7770 ;; int foo (bar, baz, yuk)
7771 ;; int bar [] ;
7772 ;; int (*baz) (my_type) ;
7773 ;; int (*) (void) (*yuk) (void) ;
7774 ;; {
7785 ; parens/brackets.
7789 ;; We're inside a paren. Could it be our argument list....?
7795 ;; FIXME!!! What about macros between the parens? 2007/01/20
7798 ;; It can't be the arg list if next token is ; or {
7803 ;; Is the thing preceding the list an identifier (the
7804 ;; function name), or a macro expansion?
7814 ;; Have we got a non-empty list of comma-separated
7815 ;; identifiers?
7829 ;; ...Yes. We've identified the function's argument list.
7835 ;; ...No. The current parens aren't the function's arg list.
7842 ;; skip forward over conditional at point, including any predicate
7843 ;; statements in parentheses. No error checking is performed.
7844 ;;
7845 ;; This function might do hidden buffer changes.
7847 ;; else if()
7852 ;; do, else, try, finally
7857 ;; for, if, while, switch, catch, synchronized, foreach
7861 ;; If looking at the token after a conditional then return the
7862 ;; position of its start, otherwise return nil.
7863 ;;
7864 ;; This function might do hidden buffer changes.
7874 ;; If the point is after an operator identifier that isn't handled
7875 ;; like an ordinary symbol (i.e. like "operator =" in C++) then the
7876 ;; position of the start of that identifier is returned. nil is
7877 ;; returned otherwise. The point may be anywhere in the syntactic
7878 ;; whitespace after the last token of the operator identifier.
7879 ;;
7880 ;; This function might do hidden buffer changes.
7892 ;; Assuming point is at a brace that opens a statement block of some
7893 ;; kind, move to the proper anchor point for that block. It might
7894 ;; need to be adjusted further by c-add-stmt-syntax, but the
7895 ;; position at return is suitable as start position for that
7896 ;; function.
7897 ;;
7898 ;; This function might do hidden buffer changes.
7905 ;; Assuming point is at a brace that opens the block of a top level
7906 ;; declaration of some kind, move to the proper anchor point for
7907 ;; that block.
7908 ;;
7909 ;; This function might do hidden buffer changes.
7914 ;; Search forward for the end of the "header" of the current
7915 ;; declaration. That's the position where the definition body
7916 ;; starts, or the first variable initializer, or the ending
7917 ;; semicolon. I.e. search forward for the closest following
7918 ;; (syntactically relevant) '{', '=' or ';' token. Point is left
7919 ;; _after_ the first found token, or at point-max if none is found.
7920 ;;
7921 ;; This function might do hidden buffer changes.
7926 ;; In C++ we need to take special care to handle operator
7927 ;; tokens and those pesky template brackets.
7932 ;; Handle operator identifiers, i.e. ignore any
7933 ;; operator token preceded by "operator".
7940 t
7942 nil)))))
7951 ;; Go to the beginning of the current declaration, or the beginning
7952 ;; of the previous one if already at the start of it. Point won't
7953 ;; be moved out of any surrounding paren. Return a cons cell of the
7954 ;; form (MOVE . KNR-POS). MOVE is like the return value from
7955 ;; `c-beginning-of-statement-1'. If point skipped over some K&R
7956 ;; style argument declarations (and they are to be recognized) then
7957 ;; KNR-POS is set to the start of the first such argument
7958 ;; declaration, otherwise KNR-POS is nil. If LIM is non-nil, it's a
7959 ;; position that bounds the backward search.
7960 ;;
7961 ;; NB: Cases where the declaration continues after the block, as in
7962 ;; "struct foo { ... } bar;", are currently recognized as two
7963 ;; declarations, e.g. "struct foo { ... }" and "bar;" in this case.
7964 ;;
7965 ;; This function might do hidden buffer changes.
7971 ;; `c-beginning-of-statement-1' stops at a block start, but we
7972 ;; want to continue if the block doesn't begin a top level
7973 ;; construct, i.e. if it isn't preceded by ';', '}', ':', bob,
7974 ;; or an open paren.
7976 ;; Go back one "statement" each time round the loop until we're just
7977 ;; after a ;, }, or :, or at BOB or the start of a macro or start of
7978 ;; an ObjC method. This will move over a multiple declaration whose
7979 ;; components are comma separated.
7981 ;; Must check with c-opt-method-key in ObjC mode.
7991 ;; Check that we don't move from the first thing in a
7992 ;; macro to its header.
7998 move tentative-move))
8003 ;; Handle K&R argdecls. Back up after the "statement" jumped
8004 ;; over by `c-beginning-of-statement-1', unless it was the
8005 ;; function body, in which case we're sitting on the opening
8006 ;; brace now. Then test if we're in a K&R argdecl region and
8007 ;; that we started at the other side of the first argdecl in
8008 ;; it.
8018 'previous
8020 knr-argdecl-start))
8023 ;; `c-beginning-of-statement-1' counts each brace block as a separate
8024 ;; statement, so the result will be 'previous if we've moved over any.
8025 ;; So change our result back to 'same if necessary.
8026 ;;
8027 ;; If they were brace list initializers we might not have moved over a
8028 ;; declaration boundary though, so change it to 'same if we've moved
8029 ;; past a '=' before '{', but not ';'. (This ought to be integrated
8030 ;; into `c-beginning-of-statement-1', so we avoid this extra pass which
8031 ;; potentially can search over a large amount of text.). Take special
8032 ;; pains not to get mislead by C++'s "operator=", and the like.
8035 c++-template-syntax-table
8041 ; no more, or get to one which isn't an "operator ="
8044 c-overloadable-operators-regexp
8045 c-opt-op-identifier-prefix
8060 ;; Assuming point is at the start of a declaration (as detected by
8061 ;; e.g. `c-beginning-of-decl-1'), go to the end of it. Unlike
8062 ;; `c-beginning-of-decl-1', this function handles the case when a
8063 ;; block is followed by identifiers in e.g. struct declarations in C
8064 ;; or C++. If a proper end was found then t is returned, otherwise
8065 ;; point is moved as far as possible within the current sexp and nil
8066 ;; is returned. This function doesn't handle macros; use
8067 ;; `c-end-of-macro' instead in those cases.
8068 ;;
8069 ;; This function might do hidden buffer changes.
8072 c++-template-syntax-table
8080 ;; Stopped at the ';' in a K&R argdecl section which is
8081 ;; detected using the same criteria as in
8082 ;; `c-beginning-of-decl-1'. Move to the following block
8083 ;; start.
8087 ;; Encountered a block in the declaration. Jump over it.
8098 ;; Check for `c-opt-block-decls-with-vars-key'
8099 ;; before the first paren.
8102 c-opt-block-decls-with-vars-key
8104 lim t t t)
8107 ;; Check that the first following paren is
8108 ;; the block.
8110 lim t t t)
8112 ;; The declaration doesn't have any of the
8113 ;; `c-opt-block-decls-with-vars' keywords in the
8114 ;; beginning, so it ends here at the end of the block.
8122 nil)))
8125 ;; Assuming the point is at an open brace, check if it starts a
8126 ;; block that contains another declaration level, i.e. that isn't a
8127 ;; statement block or a brace list, and if so return non-nil.
8128 ;;
8129 ;; If the check is successful, the return value is the start of the
8130 ;; keyword that tells what kind of construct it is, i.e. typically
8131 ;; what `c-decl-block-key' matched. Also, if GOTO-START is set then
8132 ;; the point will be at the start of the construct, before any
8133 ;; leading specifiers, otherwise it's at the returned position.
8134 ;;
8135 ;; The point is clobbered if the check is unsuccessful.
8136 ;;
8137 ;; CONTAINING-SEXP is the position of the open of the surrounding
8138 ;; paren, or nil if none.
8139 ;;
8140 ;; The optional LIMIT limits the backward search for the start of
8141 ;; the construct. It's assumed to be at a syntactically relevant
8142 ;; position.
8143 ;;
8144 ;; If any template arglists are found in the searched region before
8145 ;; the open brace, they get marked with paren syntax.
8146 ;;
8147 ;; This function might do hidden buffer changes.
8154 ;; Could be at the end of a template arglist.
8165 ;; Note: Can't get bogus hits inside template arglists below since they
8166 ;; have gotten paren syntax above.
8168 ;; If `goto-start' is set we begin by searching for the
8169 ;; first possible position of a leading specifier list.
8170 ;; The `c-decl-block-key' search continues from there since
8171 ;; we know it can't match earlier.
8174 open-brace t t)
8176 t)
8177 t)
8184 ;; Found a keyword that can't be a type?
8187 ;; Can be a type too, in which case it's the return type of a
8188 ;; function (under the assumption that no declaration level
8189 ;; block construct starts with a type).
8192 ;; Jumped over a type, but it could be a declaration keyword
8193 ;; followed by the declared identifier that we've jumped over
8194 ;; instead (e.g. in "class Foo {"). If it indeed is a type
8195 ;; then we should be at the declarator now, so check for a
8196 ;; valid declarator start.
8197 ;;
8198 ;; Note: This doesn't cope with the case when a declared
8199 ;; identifier is followed by e.g. '(' in a language where '('
8200 ;; also might be part of a declarator expression. Currently
8201 ;; there's no such language.
8205 ;; In Pike a list of modifiers may be followed by a brace
8206 ;; to make them apply to many identifiers. Note that the
8207 ;; match data will be empty on return in this case.
8213 ;; Use this variant to avoid yet another special regexp.
8217 t)))
8219 ;; Got a match.
8222 ;; Back up over any preceding specifiers and their clauses
8223 ;; by going forward from `first-specifier-pos', which is the
8224 ;; earliest possible position where the specifier list can
8225 ;; start.
8231 ;; Accept any plain symbol token on the ground that
8232 ;; it's a specifier masked through a macro (just
8233 ;; like `c-forward-decl-or-cast-1' skip forward over
8234 ;; such tokens).
8235 ;;
8236 ;; Could be more restrictive wrt invalid keywords,
8237 ;; but that'd only occur in invalid code so there's
8238 ;; no use spending effort on it.
8244 ;; Can't parse a declaration preamble and is still
8245 ;; before `kwd-start'. That means `first-specifier-pos'
8246 ;; was in some earlier construct. Search again.
8250 ;; Got no preamble before the block declaration keyword.
8256 kwd-start)))
8259 ;; Check if the closest containing paren sexp is a declaration
8260 ;; block, returning a 2 element vector in that case. Aref 0
8261 ;; contains the bufpos at boi of the class key line, and aref 1
8262 ;; contains the bufpos of the open brace. This function is an
8263 ;; obsolete wrapper for `c-looking-at-decl-block'.
8264 ;;
8265 ;; This function might do hidden buffer changes.
8273 nil))
8278 ;; Pull the next open brace from PS (which has the form of paren-state),
8279 ;; skipping over any brace pairs. Returns NIL when PS is exhausted.
8287 ;; Return the buffer position of the most enclosing decl-block brace (in the
8288 ;; sense of c-looking-at-decl-block) in the PAREN-STATE structure, or nil if
8289 ;; none was found.
8298 open-brace))
8301 ;; Return the position of the L-brace if point is inside a brace list
8302 ;; initialization of an array, etc. This is an approximate function,
8303 ;; designed for speed over accuracy. It will not find every bracelist, but
8304 ;; a non-nil result is reliable. We simply search for "= {" (naturally with
8305 ;; syntactic whitespace allowed). PAREN-STATE is the normal thing that it
8306 ;; is everywhere else.
8315 b-pos)))
8318 ;; return the buffer position of the beginning of the brace list
8319 ;; statement if we're inside a brace list, otherwise return nil.
8320 ;; CONTAINING-SEXP is the buffer pos of the innermost containing
8321 ;; paren. PAREN-STATE is the remainder of the state of enclosing
8322 ;; braces
8323 ;;
8324 ;; N.B.: This algorithm can potentially get confused by cpp macros
8325 ;; placed in inconvenient locations. It's a trade-off we make for
8326 ;; speed.
8327 ;;
8328 ;; This function might do hidden buffer changes.
8330 ;; This will pick up brace list declarations.
8343 ;; this will pick up array/aggregate init lists, even if they are nested.
8346 ;; Pike can have class definitions anywhere, so we must
8347 ;; check for the class key here.
8349 c-decl-block-key))
8350 bufpos braceassignp lim next-containing)
8352 containing-sexp)
8363 ;; We're in an in-expression block of some kind. Do not
8364 ;; check nesting. We deliberately set the limit to the
8365 ;; containing sexp, so that c-looking-at-inexpr-block
8366 ;; doesn't check for an identifier before it.
8368 ;; see if the open brace is preceded by = or [...] in
8369 ;; this statement, but watch out for operator=
8372 ;; Checks to do only on the first sexp before the brace.
8375 ;; In Java, an initialization brace list may follow
8376 ;; directly after "new Foo[]", so check for a "new"
8377 ;; earlier.
8383 ;; Carry on looking if this is an
8384 ;; identifier (may contain "." in Java)
8385 ;; or another "[]" sexp.
8388 ;; Checks to do on all sexps before the brace, up to the
8389 ;; beginning of the statement.
8397 ;; We've seen a =, but must check earlier tokens so
8398 ;; that it isn't something that should be ignored.
8404 ;; Check for operator =
8407 nil)
8408 ;; Check for `<opchar>= in Pike.
8411 ;; Special case for Pikes
8412 ;; `[]=, since '[' is not in
8413 ;; the punctuation class.
8416 nil)
8418 ;; make sure we're not in a C++ template
8419 ;; argument assignment
8431 ))))
8432 nil)
8439 ;; Brace lists can't contain a semicolon, so we're done.
8441 ;; Go up one level.
8443 lim nil
8444 next-containing nil))
8445 ;; we've hit the beginning of the aggregate list
8449 )
8450 bufpos))
8451 ))
8454 ;; If we're looking at the start of a pike-style list, ie `({Â })',
8455 ;; `([Â ])', `(<Â >)' etc, a cons of a cons of its starting and ending
8456 ;; positions and its entry in c-special-brace-lists is returned, nil
8457 ;; otherwise. The ending position is nil if the list is still open.
8458 ;; LIM is the limit for forward search. The point may either be at
8459 ;; the `(' or at the following paren character. Tries to check the
8460 ;; matching closer, but assumes it's correct if no balanced paren is
8461 ;; found (i.e. the case `({ ... } ... )' is detected as _not_ being
8462 ;; a special brace list).
8463 ;;
8464 ;; This function might do hidden buffer changes.
8469 inner-beg end type)
8484 nil)))))
8494 ;; Check balancing of the inner paren
8495 ;; below.
8498 t)
8499 ;; If the inner char isn't a paren then
8500 ;; we can't check balancing, so just
8501 ;; check the char before the outer
8502 ;; closing paren.
8517 ;; Return non-nil if between two statements or declarations, assuming
8518 ;; point is not inside a literal or comment.
8519 ;;
8520 ;; Obsolete - `c-at-statement-start-p' or `c-at-expression-start-p'
8521 ;; are recommended instead.
8522 ;;
8523 ;; This function might do hidden buffer changes.
8528 ;; Return non-nil if we're looking at the beginning of a block
8529 ;; inside an expression. The value returned is actually a cons of
8530 ;; either 'inlambda, 'inexpr-statement or 'inexpr-class and the
8531 ;; position of the beginning of the construct.
8532 ;;
8533 ;; LIM limits the backward search. CONTAINING-SEXP is the start
8534 ;; position of the closest containing list. If it's nil, the
8535 ;; containing paren isn't used to decide whether we're inside an
8536 ;; expression or not. If both LIM and CONTAINING-SEXP are used, LIM
8537 ;; needs to be farther back.
8538 ;;
8539 ;; If CHECK-AT-END is non-nil then extra checks at the end of the
8540 ;; brace block might be done. It should only be used when the
8541 ;; construct can be assumed to be complete, i.e. when the original
8542 ;; starting position was further down than that.
8543 ;;
8544 ;; This function might do hidden buffer changes.
8549 ;; Look at the character after point only as a last resort
8550 ;; when we can't disambiguate.
8570 ;; If the class definition is at the start of
8571 ;; a statement, we don't consider it an
8572 ;; in-expression class.
8580 ;; Also, in Pike we treat it as an
8581 ;; in-expression class if it's used in an
8582 ;; object clone expression.
8598 nil)
8606 ;; Accept several square bracket sexps for
8607 ;; Java array initializations.
8615 block-follows
8616 containing-sexp
8625 nil
8628 res))))
8631 ;; Returns non-nil if we're looking at the end of an in-expression
8632 ;; block, otherwise the same as `c-looking-at-inexpr-block'.
8633 ;; PAREN-STATE is the paren state relevant at the current position.
8634 ;;
8635 ;; This function might do hidden buffer changes.
8637 ;; We currently only recognize a block.
8640 containing-sexp)
8649 paren-state)
8650 containing-sexp)))))
8653 ;; Is there a "virtual semicolon" at POS or point?
8654 ;; (See cc-defs.el for full details of "virtual semicolons".)
8655 ;;
8656 ;; This is true when point is at the last non syntactic WS position on the
8657 ;; line, there is a macro call last on the line, and this particular macro's
8658 ;; name is defined by the regexp `c-vs-macro-regexp' as not needing a
8659 ;; semicolon.
8667 c-macro-with-semi-re
8670 ;; Check we've got nothing after this except comments and empty lines
8671 ;; joined by escaped EOLs.
8684 nil)
8692 ;; Check for one of the listed macros being before point.
8696 t))
8704 \f
8705 ;; `c-guess-basic-syntax' and the functions that precedes it below
8706 ;; implements the main decision tree for determining the syntactic
8707 ;; analysis of the current line of code.
8709 ;; Dynamically bound to t when `c-guess-basic-syntax' is called during
8710 ;; auto newline analysis.
8714 ;; BRACEPOS is the position of a brace in a construct like "namespace
8715 ;; Bar {". Return the anchor point in this construct; this is the
8716 ;; earliest symbol on the brace's line which isn't earlier than
8717 ;; "namespace".
8718 ;;
8719 ;; Currently (2007-08-17), "like namespace" means "matches
8720 ;; c-other-block-decl-kwds". It doesn't work with "class" or "struct"
8721 ;; or anything like that.
8731 ;; A simple function to prepend a new syntax element to
8732 ;; `c-syntactic-context'. Using `setq' on it is unsafe since it
8733 ;; should always be dynamically bound but since we read it first
8734 ;; we'll fail properly anyway if this function is misused.
8736 c-syntactic-context)))
8739 ;; Like `c-add-syntax' but appends to the end of the syntax list.
8740 ;; (Normally not necessary.)
8745 syntax-extra-args
8746 stop-at-boi-only
8747 containing-sexp
8748 paren-state)
8749 ;; Add the indicated SYNTAX-SYMBOL to `c-syntactic-context', extending it as
8750 ;; needed with further syntax elements of the types `substatement',
8751 ;; `inexpr-statement', `arglist-cont-nonempty', `statement-block-intro', and
8752 ;; `defun-block-intro'.
8753 ;;
8754 ;; Do the generic processing to anchor the given syntax symbol on
8755 ;; the preceding statement: Skip over any labels and containing
8756 ;; statements on the same line, and then search backward until we
8757 ;; find a statement or block start that begins at boi without a
8758 ;; label or comment.
8759 ;;
8760 ;; Point is assumed to be at the prospective anchor point for the
8761 ;; given SYNTAX-SYMBOL. More syntax entries are added if we need to
8762 ;; skip past open parens and containing statements. Most of the added
8763 ;; syntax elements will get the same anchor point - the exception is
8764 ;; for an anchor in a construct like "namespace"[*] - this is as early
8765 ;; as possible in the construct but on the same line as the {.
8766 ;;
8767 ;; [*] i.e. with a keyword matching c-other-block-decl-kwds.
8768 ;;
8769 ;; SYNTAX-EXTRA-ARGS are a list of the extra arguments for the
8770 ;; syntax symbol. They are appended after the anchor point.
8771 ;;
8772 ;; If STOP-AT-BOI-ONLY is nil, we can stop in the middle of the line
8773 ;; if the current statement starts there.
8774 ;;
8775 ;; Note: It's not a problem if PAREN-STATE "overshoots"
8776 ;; CONTAINING-SEXP, i.e. contains info about parens further down.
8777 ;;
8778 ;; This function might do hidden buffer changes.
8781 ;; This is by far the most common case, so let's give it special
8782 ;; treatment.
8787 ;; Set when we're on a label, so that we don't stop there.
8788 ;; FIXME: To be complete we should check if we're on a label
8789 ;; now at the start.
8790 on-label)
8792 ;; Use point as the anchor point for "namespace", "extern", etc.
8796 syntax-extra-args)
8798 ;; Loop while we have to back out of containing blocks.
8803 ;; Loop while we have to back up statements.
8805 on-label
8808 ;; Skip past any comments that stands between the
8809 ;; statement start and boi.
8817 ;; Skip to the beginning of this statement or backward
8818 ;; another one.
8826 ;; If we didn't move we're at the start of a block and
8827 ;; have to continue outside it.
8836 ;; Special case to avoid deeper and deeper indentation
8837 ;; of "else if" clauses.
8838 )
8843 ;; If stop-at-boi-only is nil, we shouldn't back up
8844 ;; over previous or containing statements to try to
8845 ;; reach boi, so go back to the last position and
8846 ;; exit.
8853 ;; If we've moved into another statement then we
8854 ;; should no longer try to stop in the middle of a
8855 ;; line.
8858 ;; Record this as a substatement if we skipped up one
8859 ;; level.
8862 )))
8864 containing-sexp)
8866 ;; Now we have to go out of this block.
8869 ;; Don't stop in the middle of a special brace list opener
8870 ;; like "({".
8882 ;; Analyze the construct in front of the block we've stepped out
8883 ;; from and add the right syntactic element for it.
8886 step-type)
8889 ;; Stepped out of a parenthesis block, so we're in an
8890 ;; expression now.
8902 ;; Stepped out of an in-expression statement. This
8903 ;; syntactic element won't get an anchor pos.
8906 ;; A parenthesis normally belongs to an arglist.
8914 on-label nil))
8916 ;; Stepped out of a brace block.
8928 containing-sexp)))
8930 'defun-block-intro
8932 nil))
8936 c-other-decl-block-key-in-symbols-alist))
8943 ;; Always done if the open brace was at boi. The
8944 ;; c-beginning-of-statement-1 call above is necessary
8945 ;; anyway, to decide the type of block-intro to add.
8948 ))
8950 ;; Fill in the current point as the anchor for all the symbols
8951 ;; added above.
8960 )))
8963 containing-decl-open
8964 containing-decl-start
8965 containing-decl-kwd
8966 paren-state)
8967 ;; The inclass and class-close syntactic symbols are added in
8968 ;; several places and some work is needed to fix everything.
8969 ;; Therefore it's collected here.
8970 ;;
8971 ;; This function might do hidden buffer changes.
8976 containing-decl-open)
8978 ;; Ought to use `c-add-stmt-syntax' instead of backing up to boi
8979 ;; here, but we have to do like this for compatibility.
8989 char-after-ip
8990 beg-of-same-or-containing-stmt
8991 containing-sexp
8992 paren-state)
8993 ;; This function contains the decision tree reached through both
8994 ;; cases 18 and 10. It's a continued statement or top level
8995 ;; construct of some kind.
8996 ;;
8997 ;; This function might do hidden buffer changes.
9004 ;; (CASE A removed.)
9005 ;; CASE B: open braces for class or brace-lists
9012 ;; CASE B.1: class-open
9019 ;; CASE B.2: brace-list-open
9024 indent-point t t t)))
9025 ;; The most semantically accurate symbol here is
9026 ;; brace-list-open, but we normally report it simply as a
9027 ;; statement-cont. The reason is that one normally adjusts
9028 ;; brace-list-open for brace lists as top-level constructs,
9029 ;; and brace lists inside statements is a completely different
9030 ;; context. C.f. case 5A.3.
9033 ;; Turn off the dwim above when we're
9034 ;; analyzing the nature of the brace
9035 ;; for the auto newline feature.
9036 'brace-list-open
9038 nil nil
9039 containing-sexp paren-state))
9041 ;; CASE B.3: The body of a function declared inside a normal
9042 ;; block. Can occur e.g. in Pike and when using gcc
9043 ;; extensions, but watch out for macros followed by blocks.
9044 ;; C.f. cases E, 16F and 17G.
9050 ;; Turn off recognition of constructs that lacks a
9051 ;; type in this case, since that's more likely to be
9052 ;; a macro followed by a block.
9055 containing-sexp paren-state))
9057 ;; CASE B.4: Continued statement with block open. The most
9058 ;; accurate analysis is perhaps `statement-cont' together with
9059 ;; `block-open' but we play DWIM and use `substatement-open'
9060 ;; instead. The rationale is that this typically is a macro
9061 ;; followed by a block which makes it very similar to a
9062 ;; statement with a substatement block.
9065 containing-sexp paren-state))
9066 ))
9068 ;; CASE C: iostream insertion or extraction operator
9072 ;; If there is no preceding streamop in the statement
9073 ;; then indent this line as a normal statement-cont.
9077 t))))
9079 ;; CASE E: In the "K&R region" of a function declared inside a
9080 ;; normal block. C.f. case B.3.
9082 ;; Check that the next token is a '{'. This works as
9083 ;; long as no language that allows nested function
9084 ;; definitions allows stuff like member init lists, K&R
9085 ;; declarations or throws clauses there.
9086 ;;
9087 ;; Note that we do a forward search for something ahead
9088 ;; of the indentation line here. That's not good since
9089 ;; the user might not have typed it yet. Unfortunately
9090 ;; it's exceedingly tricky to recognize a function
9091 ;; prototype in a code block without resorting to this.
9099 ;; Turn off recognition of constructs that lacks a
9100 ;; type in this case, since that's more likely to be
9101 ;; a macro followed by a block.
9104 containing-sexp paren-state))
9106 ;;CASE F: continued statement and the only preceding items are
9107 ;;annotations.
9115 t)
9122 ;; CASE G: a template list continuation?
9123 ;; Mostly a duplication of case 5D.3 to fix templates-19:
9141 ;; In a nested template arglist.
9147 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
9148 ;; template aware.
9151 ;; CASE D: continued statement.
9155 containing-sexp paren-state))
9156 )))
9158 ;; The next autoload was added by RMS on 2005/8/9 - don't know why (ACM,
9159 ;; 2005/11/29).
9160 ;;;###autoload
9162 "Return the syntactic context of the current line."
9168 ;; A whole ugly bunch of various temporary variables. Have
9169 ;; to declare them here since it's not possible to declare
9170 ;; a variable with only the scope of a cond test and the
9171 ;; following result clauses, and most of this function is a
9172 ;; single gigantic cond. :P
9173 literal char-before-ip before-ws-ip char-after-ip macro-start
9174 in-macro-expr c-syntactic-context placeholder c-in-literal-cache
9175 step-type tmpsymbol keyword injava-inher special-brace-list tmp-pos
9176 containing-<
9177 ;; The following record some positions for the containing
9178 ;; declaration block if we're directly within one:
9179 ;; `containing-decl-open' is the position of the open
9180 ;; brace. `containing-decl-start' is the start of the
9181 ;; declaration. `containing-decl-kwd' is the keyword
9182 ;; symbol of the keyword that tells what kind of block it
9183 ;; is.
9184 containing-decl-open
9185 containing-decl-start
9186 containing-decl-kwd
9187 ;; The open paren of the closest surrounding sexp or nil if
9188 ;; there is none.
9189 containing-sexp
9190 ;; The position after the closest preceding brace sexp
9191 ;; (nested sexps are ignored), or the position after
9192 ;; `containing-sexp' if there is none, or (point-min) if
9193 ;; `containing-sexp' is nil.
9194 lim
9195 ;; The paren state outside `containing-sexp', or at
9196 ;; `indent-point' if `containing-sexp' is nil.
9198 ;; There's always at most one syntactic element which got
9199 ;; an anchor pos. It's stored in syntactic-relpos.
9200 syntactic-relpos
9203 ;; Check if we're directly inside an enclosing declaration
9204 ;; level block.
9213 containing-sexp)
9214 t)))
9217 containing-sexp nil)
9222 ;; Init some position variables.
9231 ;; Ignore balanced paren. The next entry
9232 ;; can't be another one.
9235 ;; If there is no surrounding open paren then
9236 ;; put the last balanced pair back on paren-state.
9238 containing-sexp nil)))
9246 ;; If we're in a parenthesis list then ',' delimits the
9247 ;; "statements" rather than being an operator (with the
9248 ;; exception of the "for" clause). This difference is
9249 ;; typically only noticeable when statements are used in macro
9250 ;; arglists.
9254 ;; cache char before and after indent point, and move point to
9255 ;; the most likely position to perform the majority of tests
9264 ;; are we in a literal?
9267 ;; now figure out syntactic qualities of the current line
9270 ;; CASE 1: in a string.
9274 ;; CASE 2: in a C or C++ style comment.
9276 ;; This is a kludge for XEmacs where we use
9277 ;; `buffer-syntactic-context', which doesn't correctly
9278 ;; recognize "\*/" to end a block comment.
9279 ;; `parse-partial-sexp' which is used by
9280 ;; `c-literal-limits' will however do that in most
9281 ;; versions, which results in that we get nil from
9282 ;; `c-literal-limits' even when `c-in-literal' claims
9283 ;; we're inside a comment.
9287 ;; CASE 3: in a cpp preprocessor macro continuation.
9297 ;; If at the beginning of the body of a #define
9298 ;; directive then analyze as cpp-define-intro
9299 ;; only. Go on with the syntactic analysis
9300 ;; otherwise. in-macro-expr is set if we're in a
9301 ;; cpp expression, i.e. before the #define body
9302 ;; or anywhere in a non-#define directive.
9309 nil)))))
9313 ;; CASE 11: an else clause?
9317 containing-sexp paren-state))
9319 ;; CASE 12: while closure of a do/while construct?
9327 containing-sexp paren-state))
9329 ;; CASE 13: A catch or finally clause? This case is simpler
9330 ;; than if-else and do-while, because a block is required
9331 ;; after every try, catch and finally.
9339 t)
9343 t)
9346 t))
9351 containing-sexp paren-state))
9353 ;; CASE 18: A substatement we can recognize by keyword.
9363 ;; Ought to cache the result from the
9364 ;; c-beginning-of-statement-1 calls here.
9374 ;; Step up to the containing statement if we
9375 ;; stayed in the same one.
9383 ;; There was no containing statement after all.
9385 placeholder))
9387 ;; Require a parenthesis after these keywords.
9388 ;; Necessary to catch e.g. synchronized in Java,
9389 ;; which can be used both as statement and
9390 ;; modifier.
9396 ;; CASE 18A: Simple substatement.
9402 containing-sexp paren-state))
9408 containing-sexp paren-state))
9411 containing-sexp paren-state))))
9413 ;; CASE 18B: Some other substatement. This is shared
9414 ;; with case 10.
9416 char-after-ip
9417 placeholder
9418 lim
9419 paren-state)))
9421 ;; CASE 14: A case or default label
9427 containing-sexp))
9430 ;; Got a bogus label at the top level. In lack of better
9431 ;; alternatives, anchor it on (point-min).
9434 ;; CASE 15: any other label
9441 containing-decl-open
9442 containing-decl-start
9443 containing-decl-kwd
9444 paren-state))
9445 ;; Append access-label with the same anchor point as
9446 ;; inclass gets.
9452 containing-sexp))
9457 ;; If the surrounding statement is a switch then
9458 ;; let's analyze all labels as switch labels, so
9459 ;; that they get lined up consistently.
9460 'case-label
9466 ;; A label on the top level. Treat it as a class
9467 ;; context. (point-min) is the closest we get to the
9468 ;; class open brace.
9471 ;; CASE 4: In-expression statement. C.f. cases 7B, 16A and
9472 ;; 17E.
9475 containing-sexp
9476 ;; Have to turn on the heuristics after
9477 ;; the point even though it doesn't work
9478 ;; very well. C.f. test case class-16.pike.
9479 t))
9484 ;; It's a statement block or an anonymous class.
9486 ;; It's a Pike lambda. Check whether we are between the
9487 ;; lambda keyword and the argument list or at the defun
9488 ;; opener.
9490 'inline-open
9496 paren-state)
9500 ;; CASE 5: Line is inside a declaration level block or at top level.
9504 ;; CASE 5A: we are looking at a defun, brace list, class,
9505 ;; or inline-inclass method opening brace
9512 ;; CASE 5A.1: Non-class declaration block open.
9527 ;; Special case for extern-lang-open.
9528 'extern-lang-open
9530 nil t containing-sexp paren-state))
9532 ;; CASE 5A.2: we are looking at a class opening brace
9541 ;; CASE 5A.3: brace list open
9566 ))))
9570 ;; We're in Java and have found that the open brace
9571 ;; belongs to a "new Foo[]" initialization list,
9572 ;; which means the brace list is part of an
9573 ;; expression and not a top level definition. We
9574 ;; therefore treat it as any topmost continuation
9575 ;; even though the semantically correct symbol still
9576 ;; is brace-list-open, on the same grounds as in
9577 ;; case B.2.
9583 ;; CASE 5A.4: inline defun open
9589 containing-decl-open
9590 containing-decl-start
9591 containing-decl-kwd
9592 paren-state))
9594 ;; CASE 5A.5: ordinary defun open
9602 ;; Bogus to use bol here, but it's the legacy. (Resolved,
9603 ;; 2007-11-09)
9604 ))))
9606 ;; CASE 5B: After a function header but before the body (or
9607 ;; the ending semicolon if there's no body).
9614 ;; CASE 5B.1: Member init list.
9619 ;; There is no preceding member init clause.
9620 ;; Indent relative to the beginning of indentation
9621 ;; for the topmost-intro line that contains the
9622 ;; prototype's open paren.
9625 ;; Indent relative to the first member init clause.
9630 ;; CASE 5B.2: K&R arg decl intro
9637 containing-decl-open
9638 containing-decl-start
9639 containing-decl-kwd
9640 paren-state)))
9642 ;; CASE 5B.4: Nether region after a C++ or Java func
9643 ;; decl, which could include a `throws' declaration.
9647 )))
9649 ;; CASE 5C: inheritance line. could be first inheritance
9650 ;; line, or continuation of a multiple inheritance
9658 ;; watch out for scope operator
9663 )))
9672 ;; for Java
9677 cont done)
9682 done t))
9686 )
9688 injava-inher)
9691 ))
9694 ;; CASE 5C.1: non-hanging colon on an inher intro
9698 ;; don't add inclass symbol since relative point already
9699 ;; contains any class offset
9700 )
9702 ;; CASE 5C.2: hanging colon on an inher intro
9708 containing-decl-open
9709 containing-decl-start
9710 containing-decl-kwd
9711 paren-state)))
9713 ;; CASE 5C.3: in a Java implements/extends
9727 )))
9729 ;; CASE 5C.4: a continued inheritance line
9733 ;; don't add inclass symbol since relative point already
9734 ;; contains any class offset
9735 )))
9737 ;; CASE 5D: this could be a top-level initialization, a
9738 ;; member init list continuation, or a template argument
9739 ;; list continuation.
9741 ;; Note: We use the fact that lim is always after any
9742 ;; preceding brace sexp.
9752 t))
9757 t)
9763 nil)
9764 t))
9766 ;; NB: No c-after-special-operator-id stuff in this
9767 ;; clause - we assume only C++ needs it.
9772 ;; CASE 5D.3: perhaps a template list continuation?
9787 ;; In a nested template arglist.
9793 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
9794 ;; template aware.
9797 ;; CASE 5D.4: perhaps a multiple inheritance line?
9809 t)
9814 ;; CASE 5D.5: Continuation of the "expression part" of a
9815 ;; top level construct. Or, perhaps, an unrecognized construct.
9827 ;; A preceding comma at the top level means that a
9828 ;; new variable declaration starts here. Use
9829 ;; topmost-intro-cont for it, for consistency with
9830 ;; the first variable declaration. C.f. case 5N.
9833 nil nil containing-sexp paren-state))
9834 ))
9836 ;; CASE 5F: Close of a non-class declaration level block.
9840 ;; This is inconsistent: Should use `containing-decl-open'
9841 ;; here if it's at boi, like in case 5J.
9845 ;; Special case for compatibility with the
9846 ;; extern-lang syntactic symbols.
9847 'extern-lang-close
9850 nil t
9852 paren-state))
9854 ;; CASE 5G: we are looking at the brace which closes the
9855 ;; enclosing nested class decl
9860 containing-decl-open
9861 containing-decl-start
9862 containing-decl-kwd
9863 paren-state))
9865 ;; CASE 5H: we could be looking at subsequent knr-argdecls
9872 ;; Do an extra check to avoid tripping up on
9873 ;; statements that occur in invalid contexts
9874 ;; (e.g. in macro bodies where we don't really
9875 ;; know the context of what we're looking at).
9882 ;; CASE 5I: ObjC method definition.
9887 ;; Handle the case when it's the first (non-comment)
9888 ;; thing in the buffer. Can't look for a 'same return
9889 ;; value from cbos1 since ObjC directives currently
9890 ;; aren't recognized fully, so that we get 'same
9891 ;; instead of 'previous if it moved over a preceding
9892 ;; directive.
9896 ;; CASE 5P: AWK pattern or function or continuation
9897 ;; thereof.
9903 'topmost-intro-cont
9905 nil nil
9906 containing-sexp paren-state))
9908 ;; CASE 5N: At a variable declaration that follows a class
9909 ;; definition or some other block declaration that doesn't
9910 ;; end at the closing '}'. C.f. case 5D.5.
9919 ;; Speed up the backward search a bit.
9924 ;; The '}' is unbalanced.
9925 nil
9930 containing-sexp paren-state))
9932 ;; NOTE: The point is at the end of the previous token here.
9934 ;; CASE 5J: we are at the topmost level, make
9935 ;; sure we skip back past any access specifiers
9937 ;; A macro continuation line is never at top level.
9959 nil)))))
9960 ;; For historic reasons we anchor at bol of the last
9961 ;; line of the previous declaration. That's clearly
9962 ;; highly bogus and useless, and it makes our lives hard
9963 ;; to remain compatible. :P
9974 ;; Special case for compatibility with the
9975 ;; extern-lang syntactic symbols.
9976 'inextern-lang
9979 nil t
9981 paren-state))
9983 containing-decl-open
9984 containing-decl-start
9985 containing-decl-kwd
9986 paren-state)))
9988 macro-start
9993 ;; CASE 5K: we are at an ObjC method definition
9994 ;; continuation line.
10003 ;; CASE 5L: we are at the first argument of a template
10004 ;; arglist that begins on the previous line.
10012 ;; CASE 5Q: we are at a statement within a macro.
10017 ;;CASE 5N: We are at a topmost continuation line and the only
10018 ;;preceding items are annotations.
10025 t)
10031 ;; CASE 5M: we are at a topmost continuation line
10042 ))
10045 ;; (CASE 6 has been removed.)
10047 ;; CASE 7: line is an expression, not a statement. Most
10048 ;; likely we are either in a function prototype or a function
10049 ;; call argument list
10057 ;; CASE 7A: we are looking at the arglist closing paren.
10058 ;; C.f. case 7F.
10070 paren-state))
10072 ;; CASE 7B: Looking at the opening brace of an
10073 ;; in-expression block or brace list. C.f. cases 4, 16A
10074 ;; and 17E.
10078 paren-state))
10082 placeholder
10085 paren-state)
10086 containing-sexp)))
10087 ;; placeholder is nil if it's a block directly in
10088 ;; a function arglist. That makes us skip out of
10089 ;; this case.
10090 )))
10095 paren-state)
10099 ;; CASE 7C: we are looking at the first argument in an empty
10100 ;; argument list. Use arglist-close if we're actually
10101 ;; looking at a close paren or bracket.
10113 paren-state))
10115 ;; CASE 7D: we are inside a conditional test clause. treat
10116 ;; these things as statements
10126 ))
10128 ;; CASE 7E: maybe a continued ObjC method call. This is the
10129 ;; case when we are inside a [] bracketed exp, and what
10130 ;; precede the opening bracket is not an identifier.
10138 )))
10140 ;; CASE 7F: we are looking at an arglist continuation line,
10141 ;; but the preceding argument is on the same line as the
10142 ;; opening paren. This case includes multi-line
10143 ;; mathematical paren groupings, but we could be on a
10144 ;; for-list continuation line. C.f. case 7A.
10161 paren-state))
10163 ;; CASE 7G: we are looking at just a normal arglist
10164 ;; continuation line
10167 ))
10169 ;; CASE 8: func-local multi-inheritance line
10179 ;; CASE 8A: non-hanging colon on an inher intro
10184 ;; CASE 8B: hanging colon on an inher intro
10188 ;; CASE 8C: a continued inheritance line
10192 )))
10194 ;; CASE 9: we are inside a brace-list
10204 ;; CASE 9A: In the middle of a special brace list opener.
10224 ;; CASE 9B: brace-list-close brace
10226 ;; Check special brace list closer.
10233 ;; We were between the special close char and the `)'.
10236 ;; We were before the special close char.
10240 ;; Normal brace list check.
10251 ;; Prepare for the rest of the cases below by going to the
10252 ;; token following the opening brace
10265 ;; CASE 9C: we're looking at the first line in a brace-list
10276 ;; CASE 9D: this is just a later brace-list-entry or
10277 ;; brace-entry-open
10286 ))
10287 ))))
10289 ;; CASE 10: A continued statement or top level construct.
10299 ;; This is shared with case 18.
10301 char-after-ip
10302 placeholder
10303 containing-sexp
10304 paren-state))
10306 ;; CASE 16: block close brace, possibly closing the defun or
10307 ;; the class
10309 ;; From here on we have the next containing sexp in lim.
10314 ;; CASE 16E: Closing a statement block? This catches
10315 ;; cases where it's preceded by a statement keyword,
10316 ;; which works even when used in an "invalid" context,
10317 ;; e.g. a macro argument.
10322 ;; CASE 16A: closing a lambda defun or an in-expression
10323 ;; block? C.f. cases 4, 7B and 17E.
10326 nil))
10328 'inline-close
10338 paren-state)
10342 ;; CASE 16B: does this close an inline or a function in
10343 ;; a non-class declaration level block?
10350 nil))
10360 ;; CASE 16F: Can be a defun-close of a function declared
10361 ;; in a statement block, e.g. in Pike or when using gcc
10362 ;; extensions, but watch out for macros followed by
10363 ;; blocks. Let it through to be handled below.
10364 ;; C.f. cases B.3 and 17G.
10370 ;; Turn off recognition of constructs that
10371 ;; lacks a type in this case, since that's more
10372 ;; likely to be a macro followed by a block.
10379 ;; CASE 16C: If there is an enclosing brace then this is
10380 ;; a block close since defun closes inside declaration
10381 ;; level blocks have been handled above.
10383 ;; If the block is preceded by a case/switch label on
10384 ;; the same line, we anchor at the first preceding label
10385 ;; at boi. The default handling in c-add-stmt-syntax
10386 ;; really fixes it better, but we do like this to keep
10387 ;; the indentation compatible with version 5.28 and
10388 ;; earlier. C.f. case 17H.
10395 ;; c-backward-to-block-anchor not necessary here; those
10396 ;; situations are handled in case 16E above.
10399 ;; CASE 16D: Only top level defun close left.
10405 paren-state))
10406 ))
10408 ;; CASE 19: line is an expression, not a statement, and is directly
10409 ;; contained by a template delimiter. Most likely, we are in a
10410 ;; template arglist within a statement. This case is based on CASE
10411 ;; 7. At some point in the future, we may wish to create more
10412 ;; syntactic symbols such as `template-intro',
10413 ;; `template-cont-nonempty', etc., and distinguish between them as we
10414 ;; do for `arglist-intro' etc. (2009-12-07).
10420 ; '<') before indent-point.
10428 paren-state))
10430 ;; CASE 17: Statement or defun catchall.
10433 ;; Back up statements until we find one that starts at boi.
10436 containing-sexp)))
10440 nil)
10445 ;; CASE 17B: continued statement
10449 containing-sexp paren-state))
10451 ;; CASE 17A: After a case/default label?
10459 'statement-case-open
10461 nil t containing-sexp paren-state))
10463 ;; CASE 17D: any old statement
10470 containing-sexp paren-state)
10474 ;; CASE 17I: Inside a substatement block.
10476 ;; The following tests are all based on containing-sexp.
10478 ;; From here on we have the next containing sexp in lim.
10483 lim paren-state)
10487 ;; CASE 17E: first statement in an in-expression block.
10488 ;; C.f. cases 4, 7B and 16A.
10491 nil))
10493 'defun-block-intro
10502 paren-state)
10508 ;; CASE 17F: first statement in an inline, or first
10509 ;; statement in a top-level defun. we can tell this is it
10510 ;; if there are no enclosing braces that haven't been
10511 ;; narrowed out by a class (i.e. don't use bod here).
10514 paren-state)))
10520 nil))))
10525 ;; CASE 17G: First statement in a function declared inside
10526 ;; a normal block. This can occur in Pike and with
10527 ;; e.g. the gcc extensions, but watch out for macros
10528 ;; followed by blocks. C.f. cases B.3 and 16F.
10534 ;; Turn off recognition of constructs that lacks
10535 ;; a type in this case, since that's more likely
10536 ;; to be a macro followed by a block.
10542 lim paren-state))
10544 ;; CASE 17H: First statement in a block.
10546 ;; If the block is preceded by a case/switch label on the
10547 ;; same line, we anchor at the first preceding label at
10548 ;; boi. The default handling in c-add-stmt-syntax is
10549 ;; really fixes it better, but we do like this to keep the
10550 ;; indentation compatible with version 5.28 and earlier.
10551 ;; C.f. case 16C.
10558 ;; c-backward-to-block-anchor not necessary here; those
10559 ;; situations are handled in case 17I above.
10561 lim paren-state))
10564 ))
10565 )
10567 ;; now we need to look at any modifiers
10571 ;; are we looking at a comment only line?
10576 ;; we might want to give additional offset to friends (in C++).
10581 ;; Set syntactic-relpos.
10587 nil)
10588 t))
10591 ;; Start of or a continuation of a preprocessor directive?
10606 ;; If inside a cpp expression, i.e. anywhere in a
10607 ;; cpp directive except a #define body, we only let
10608 ;; through the syntactic analysis that is internal
10609 ;; in the expression. That means the arglist
10610 ;; elements, if they are anchored inside the cpp
10611 ;; expression.
10620 ;; Inside a #define body and the syntactic analysis is
10621 ;; anchored on the start of the #define. In this case
10622 ;; we add cpp-define-intro to get the extra
10623 ;; indentation of the #define body.
10626 ;; return the syntax
10627 c-syntactic-context)))
10629 \f
10630 ;; Indentation calculation.
10633 ;; offset can be a number, a function, a variable, a list, or one of
10634 ;; the symbols + or -
10635 ;;
10636 ;; This function might do hidden buffer changes.
10655 langelem symbol))
10661 offset symbol)
10662 nil)
10676 Error evaluating offset %S for %s: \
10677 Cannot combine absolute offset %S with relative %S in `%s' method"
10683 Error evaluating offset %S for %s: \
10684 Cannot combine relative offset %S with absolute %S in `%s' method"
10689 res))
10707 Error evaluating offset %S for %s: \
10708 Cannot combine absolute offsets %S and %S in `add' method"
10712 res))
10721 res))))
10728 nil))))
10732 res
10734 offset symbol res)
10735 nil)))
10738 ;; Get offset from LANGELEM which is a list beginning with the
10739 ;; syntactic symbol and followed by any analysis data it provides.
10740 ;; That data may be zero or more elements, but if at least one is
10741 ;; given then the first is the anchor position (or nil). The symbol
10742 ;; is matched against `c-offsets-alist' and the offset calculated
10743 ;; from that is returned.
10744 ;;
10745 ;; This function might do hidden buffer changes.
10755 offset
10759 ))
10762 ;; This is a compatibility wrapper for `c-calc-offset' in case
10763 ;; someone is calling it directly. It takes an old style syntactic
10764 ;; element on the form (SYMBOL . ANCHOR-POS) and converts it to the
10765 ;; new list form.
10766 ;;
10767 ;; This function might do hidden buffer changes.
10774 ;; Calculate the syntactic indentation from a syntactic description
10775 ;; as returned by `c-guess-syntax'.
10776 ;;
10777 ;; Note that topmost-intro always has an anchor position at bol, for
10778 ;; historical reasons. It's often used together with other symbols
10779 ;; that has more sane positions. Since we always use the first
10780 ;; found anchor position, we rely on that these other symbols always
10781 ;; precede topmost-intro in the LANGELEMS list.
10782 ;;
10783 ;; This function might do hidden buffer changes.
10791 ;; Got an absolute column that overrides any indentation
10792 ;; we've collected so far, but not the relative
10793 ;; indentation we might get for the nested structures
10794 ;; further down the langelems list.
10798 ;; Got a relative change of the current calculated
10799 ;; indentation.
10802 ;; Use the anchor position from the first syntactic
10803 ;; element with one.
10813 indent)))
10815 \f
10818 ;;; cc-engine.el ends here