| blob | c9a836ff198daee641d61aaa29365ca388b7b17d |
1 ;;; cc-engine.el --- core syntax guessing engine for CC mode
3 ;; Copyright (C) 1985, 1987, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
4 ;; 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
5 ;; Free Software Foundation, Inc.
7 ;; Authors: 2001- Alan Mackenzie
8 ;; 1998- Martin Stjernholm
9 ;; 1992-1999 Barry A. Warsaw
10 ;; 1987 Dave Detlefs and Stewart Clamen
11 ;; 1985 Richard M. Stallman
12 ;; Maintainer: bug-cc-mode@gnu.org
13 ;; Created: 22-Apr-1997 (split from cc-mode.el)
14 ;; Version: See cc-mode.el
15 ;; Keywords: c languages oop
17 ;; This file is part of GNU Emacs.
19 ;; GNU Emacs is free software; you can redistribute it and/or modify
20 ;; it under the terms of the GNU General Public License as published by
21 ;; the Free Software Foundation; either version 3, or (at your option)
22 ;; any later version.
24 ;; GNU Emacs is distributed in the hope that it will be useful,
25 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
26 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 ;; GNU General Public License for more details.
29 ;; You should have received a copy of the GNU General Public License
30 ;; along with this program; see the file COPYING. If not, write to
31 ;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
32 ;; Boston, MA 02110-1301, USA.
34 ;;; Commentary:
36 ;; The functions which have docstring documentation can be considered
37 ;; part of an API which other packages can use in CC Mode buffers.
38 ;; Otoh, undocumented functions and functions with the documentation
39 ;; in comments are considered purely internal and can change semantics
40 ;; or even disappear in the future.
41 ;;
42 ;; (This policy applies to CC Mode as a whole, not just this file. It
43 ;; probably also applies to many other Emacs packages, but here it's
44 ;; clearly spelled out.)
46 ;; Hidden buffer changes
47 ;;
48 ;; Various functions in CC Mode use text properties for caching and
49 ;; syntactic markup purposes, and those of them that might modify such
50 ;; properties but still don't modify the buffer in a visible way are
51 ;; said to do "hidden buffer changes". They should be used within
52 ;; `c-save-buffer-state' or a similar function that saves and restores
53 ;; buffer modifiedness, disables buffer change hooks, etc.
54 ;;
55 ;; Interactive functions are assumed to not do hidden buffer changes,
56 ;; except in the specific parts of them that do real changes.
57 ;;
58 ;; Lineup functions are assumed to do hidden buffer changes. They
59 ;; must not do real changes, though.
60 ;;
61 ;; All other functions that do hidden buffer changes have that noted
62 ;; in their doc string or comment.
63 ;;
64 ;; The intention with this system is to avoid wrapping every leaf
65 ;; function that do hidden buffer changes inside
66 ;; `c-save-buffer-state'. It should be used as near the top of the
67 ;; interactive functions as possible.
68 ;;
69 ;; Functions called during font locking are allowed to do hidden
70 ;; buffer changes since the font-lock package run them in a context
71 ;; similar to `c-save-buffer-state' (in fact, that function is heavily
72 ;; inspired by `save-buffer-state' in the font-lock package).
74 ;; Use of text properties
75 ;;
76 ;; CC Mode uses several text properties internally to mark up various
77 ;; positions, e.g. to improve speed and to eliminate glitches in
78 ;; interactive refontification.
79 ;;
80 ;; Note: This doc is for internal use only. Other packages should not
81 ;; assume that these text properties are used as described here.
82 ;;
83 ;; 'syntax-table
84 ;; Used to modify the syntax of some characters. It is used to
85 ;; mark the "<" and ">" of angle bracket parens with paren syntax, and
86 ;; to "hide" obtrusive characters in preprocessor lines.
87 ;;
88 ;; This property is used on single characters and is therefore
89 ;; always treated as front and rear nonsticky (or start and end open
90 ;; in XEmacs vocabulary). It's therefore installed on
91 ;; `text-property-default-nonsticky' if that variable exists (Emacs
92 ;; >= 21).
93 ;;
94 ;; 'c-is-sws and 'c-in-sws
95 ;; Used by `c-forward-syntactic-ws' and `c-backward-syntactic-ws' to
96 ;; speed them up. See the comment blurb before `c-put-is-sws'
97 ;; below for further details.
98 ;;
99 ;; 'c-type
100 ;; This property is used on single characters to mark positions with
101 ;; special syntactic relevance of various sorts. Its primary use is
102 ;; to avoid glitches when multiline constructs are refontified
103 ;; interactively (on font lock decoration level 3). It's cleared in
104 ;; a region before it's fontified and is then put on relevant chars
105 ;; in that region as they are encountered during the fontification.
106 ;; The value specifies the kind of position:
107 ;;
108 ;; 'c-decl-arg-start
109 ;; Put on the last char of the token preceding each declaration
110 ;; inside a declaration style arglist (typically in a function
111 ;; prototype).
112 ;;
113 ;; 'c-decl-end
114 ;; Put on the last char of the token preceding a declaration.
115 ;; This is used in cases where declaration boundaries can't be
116 ;; recognized simply by looking for a token like ";" or "}".
117 ;; `c-type-decl-end-used' must be set if this is used (see also
118 ;; `c-find-decl-spots').
119 ;;
120 ;; 'c-<>-arg-sep
121 ;; Put on the commas that separate arguments in angle bracket
122 ;; arglists like C++ template arglists.
123 ;;
124 ;; 'c-decl-id-start and 'c-decl-type-start
125 ;; Put on the last char of the token preceding each declarator
126 ;; in the declarator list of a declaration. They are also used
127 ;; between the identifiers cases like enum declarations.
128 ;; 'c-decl-type-start is used when the declarators are types,
129 ;; 'c-decl-id-start otherwise.
130 ;;
131 ;; 'c-awk-NL-prop
132 ;; Used in AWK mode to mark the various kinds of newlines. See
133 ;; cc-awk.el.
135 ;;; Code:
142 load-path)))
149 ;; Silence the compiler.
152 \f
153 ;; Make declarations for all the `c-lang-defvar' variables in cc-langs.
166 \f
167 ;;; Internal state variables.
169 ;; Internal state of hungry delete key feature
173 ;; The electric flag (toggled by `c-toggle-electric-state').
174 ;; If t, electric actions (like automatic reindentation, and (if
175 ;; c-auto-newline is also set) auto newlining) will happen when an electric
176 ;; key like `{' is pressed (or an electric keyword like `else').
180 ;; Internal state of auto newline feature.
184 ;; Included in the mode line to indicate the active submodes.
185 ;; (defvar c-submode-indicators nil)
186 ;; (make-variable-buffer-local 'c-submode-indicators)
189 ;; Calculate the new state of PREVSTATE, t or nil, based on arg. If
190 ;; arg is nil or zero, toggle the state. If arg is negative, turn
191 ;; the state off, and if arg is positive, turn the state on
197 ;; Dynamically bound cache for `c-in-literal'.
200 \f
201 ;; Basic handling of preprocessor directives.
203 ;; This is a dynamically bound cache used together with
204 ;; `c-query-macro-start' and `c-query-and-set-macro-start'. It only
205 ;; works as long as point doesn't cross a macro boundary.
214 c-macro-start))
222 c-macro-start))
225 "Go to the beginning of a preprocessor directive.
226 Leave point at the beginning of the directive and return t if in one,
227 otherwise return nil and leave point unchanged.
229 Note that this function might do hidden buffer changes. See the
230 comment at the start of cc-engine.el for more info."
241 t
243 nil)))))
246 "Go to the end of a preprocessor directive.
247 More accurately, move the point to the end of the closest following
248 line that doesn't end with a line continuation backslash - no check is
249 done that the point is inside a cpp directive to begin with.
251 Note that this function might do hidden buffer changes. See the
252 comment at the start of cc-engine.el for more info."
258 t))))
261 ;; Assuming point is at the "#" that introduces a preprocessor
262 ;; directive, it's moved forward to the end of the identifier which is
263 ;; "#define"d (or whatever c-opt-cpp-macro-define specifies). Non-nil
264 ;; is returned in this case, in all other cases nil is returned and
265 ;; point isn't moved.
266 ;;
267 ;; This function might do hidden buffer changes.
273 ;; Assuming point is at the "#" that introduces a preprocessor
274 ;; directive, it's moved forward to the start of the definition body
275 ;; if it's a "#define" (or whatever c-opt-cpp-macro-define
276 ;; specifies). Non-nil is returned in this case, in all other cases
277 ;; nil is returned and point isn't moved.
278 ;;
279 ;; This function might do hidden buffer changes.
285 \f
286 ;;; Basic utility functions.
289 ;; Return the given region as a string where all syntactic
290 ;; whitespace is removed or, where necessary, replaced with a single
291 ;; space. If PAREN-LEVEL is given then all parens in the region are
292 ;; collapsed to "()", "[]" etc.
293 ;;
294 ;; This function might do hidden buffer changes.
338 ;; Shift the indentation of the current line with the specified
339 ;; amount (positive inwards). The buffer is modified only if
340 ;; SHIFT-AMT isn't equal to zero.
343 tmp-char-inserted)
345 nil
346 ;; If we're on an empty line inside a macro, we take the point
347 ;; to be at the current indentation and shift it to the
348 ;; appropriate column. This way we don't treat the extra
349 ;; whitespace out to the line continuation as indentation.
365 ;; If initial point was within line's indentation and we're not on
366 ;; a line with a line continuation in a macro, position after the
367 ;; indentation. Else stay at same point in text.
375 ;; Return non-nil if the string KEYWORD is a known keyword. More
376 ;; precisely, the value is the symbol for the keyword in
377 ;; `c-keywords-obarray'.
381 ;; Return non-nil if the symbol KEYWORD-SYM, as returned by
382 ;; `c-keyword-sym', is a member of LANG-CONSTANT, which is the name
383 ;; of a language constant that ends with "-kwds". If KEYWORD-SYM is
384 ;; nil then the result is nil.
387 ;; String syntax chars, suitable for skip-syntax-(forward|backward).
392 ;; Regexp matching string limit syntax.
397 ;; Regexp matching WS followed by string limit syntax.
401 ;; Holds formatted error strings for the few cases where parse errors
402 ;; are reported.
409 c-parsing-error)
411 ;; Faces given to comments and string literals. This is used in some
412 ;; situations to speed up recognition; it isn't mandatory that font
413 ;; locking is in use. This variable is extended with the face in
414 ;; `c-doc-face-name' when fontification is activated in cc-fonts.el.
418 ;; New in Emacs 22.
422 ;; Put a c-type property with the given value at POS.
426 ;; Remove all occurences of the c-type property that has the given
427 ;; value in the region between FROM and TO. VALUE is assumed to not
428 ;; be nil.
429 ;;
430 ;; Note: This assumes that c-type is put on single chars only; it's
431 ;; very inefficient if matching properties cover large regions.
440 \f
441 ;; Some debug tools to visualize various special positions. This
442 ;; debug code isn't as portable as the rest of CC Mode.
478 \f
479 ;; `c-beginning-of-statement-1' and accompanying stuff.
481 ;; KLUDGE ALERT: c-maybe-labelp is used to pass information between
482 ;; c-crosses-statement-barrier-p and c-beginning-of-statement-1. A
483 ;; better way should be implemented, but this will at least shut up
484 ;; the byte compiler.
487 ;; New awk-compatible version of c-beginning-of-statement-1, ACM 2002/6/22
489 ;; Macros used internally in c-beginning-of-statement-1 for the
490 ;; automaton actions.
493 stack)))
498 t
499 ,do-if-done
504 ;; Throw nil if stack is empty, else throw non-nil.
528 noerror comma-delim)
529 "Move to the start of the current statement or declaration, or to
530 the previous one if already at the beginning of one. Only
531 statements/declarations on the same level are considered, i.e. don't
532 move into or out of sexps (not even normal expression parentheses).
536 is within the continuation. If starting at such a token, move to the
537 corresponding statement start. If at the beginning of a statement,
538 move to the closest containing statement if there is any. This might
539 also stop at a continuation clause.
541 Labels are treated as part of the following statements if
542 IGNORE-LABELS is non-nil. (FIXME: Doesn't work if we stop at a known
543 statement start keyword.) Otherwise, each label is treated as a
544 separate statement.
546 Macros are ignored \(i.e. skipped over) unless point is within one, in
547 which case the content of the macro is treated as normal code. Aside
548 from any normal statement starts found in it, stop at the first token
551 macros before leaving them.
553 Return 'label if stopped at a label, 'same if stopped at the beginning
554 of the current statement, 'up if stepped to a containing statement,
555 'previous if stepped to a preceding statement, 'beginning if stepped
556 from a statement continuation clause to its start clause, or 'macro if
557 stepped to a macro start. Note that 'same and not 'label is returned
558 if stopped at the same label without crossing the colon character.
560 LIM may be given to limit the search. If the search hits the limit,
561 point will be left at the closest following token, or at the start
562 position if that is less ('same is returned in this case).
564 NOERROR turns off error logging to `c-parsing-error'.
566 Normally only ';' and virtual semicolons are considered to delimit
567 statements, but if COMMA-DELIM is non-nil then ',' is treated
568 as a delimiter too.
570 Note that this function might do hidden buffer changes. See the
571 comment at the start of cc-engine.el for more info."
573 ;; The bulk of this function is a pushdown automaton that looks at statement
574 ;; boundaries and the tokens (such as "while") in c-opt-block-stmt-key. Its
575 ;; purpose is to keep track of nested statements, ensuring that such
576 ;; statments are skipped over in their entirety (somewhat akin to what C-M-p
577 ;; does with nested braces/brackets/parentheses).
578 ;;
579 ;; Note: The position of a boundary is the following token.
580 ;;
581 ;; Beginning with the current token (the one following point), move back one
582 ;; sexp at a time (where a sexp is, more or less, either a token or the
583 ;; entire contents of a brace/bracket/paren pair). Each time a statement
584 ;; boundary is crossed or a "while"-like token is found, update the state of
585 ;; the PDA. Stop at the beginning of a statement when the stack (holding
586 ;; nested statement info) is empty and the position has been moved.
587 ;;
588 ;; The following variables constitute the PDA:
589 ;;
590 ;; sym: This is either the "while"-like token (e.g. 'for) we've just
591 ;; scanned back over, 'boundary if we've just gone back over a
592 ;; statement boundary, or nil otherwise.
593 ;; state: takes one of the values (nil else else-boundary while
594 ;; while-boundary catch catch-boundary).
595 ;; nil means "no "while"-like token yet scanned".
596 ;; 'else, for example, means "just gone back over an else".
597 ;; 'else-boundary means "just gone back over a statement boundary
598 ;; immediately after having gone back over an else".
599 ;; saved-pos: A vector of either saved positions (tok ptok pptok, etc.) or
600 ;; of error reporting information.
601 ;; stack: The stack onto which the PDA pushes its state. Each entry
602 ;; consists of a saved value of state and saved-pos. An entry is
603 ;; pushed when we move back over a "continuation" token (e.g. else)
604 ;; and popped when we encounter the corresponding opening token
605 ;; (e.g. if).
606 ;;
607 ;;
608 ;; The following diagram briefly outlines the PDA.
609 ;;
610 ;; Common state:
611 ;; "else": Push state, goto state `else'.
612 ;; "while": Push state, goto state `while'.
613 ;; "catch" or "finally": Push state, goto state `catch'.
614 ;; boundary: Pop state.
615 ;; other: Do nothing special.
616 ;;
617 ;; State `else':
618 ;; boundary: Goto state `else-boundary'.
619 ;; other: Error, pop state, retry token.
620 ;;
621 ;; State `else-boundary':
622 ;; "if": Pop state.
623 ;; boundary: Error, pop state.
624 ;; other: See common state.
625 ;;
626 ;; State `while':
627 ;; boundary: Save position, goto state `while-boundary'.
628 ;; other: Pop state, retry token.
629 ;;
630 ;; State `while-boundary':
631 ;; "do": Pop state.
632 ;; boundary: Restore position if it's not at start, pop state. [*see below]
633 ;; other: See common state.
634 ;;
635 ;; State `catch':
636 ;; boundary: Goto state `catch-boundary'.
637 ;; other: Error, pop state, retry token.
638 ;;
639 ;; State `catch-boundary':
640 ;; "try": Pop state.
641 ;; "catch": Goto state `catch'.
642 ;; boundary: Error, pop state.
643 ;; other: See common state.
644 ;;
645 ;; [*] In the `while-boundary' state, we had pushed a 'while state, and were
646 ;; searching for a "do" which would have opened a do-while. If we didn't
647 ;; find it, we discard the analysis done since the "while", go back to this
648 ;; token in the buffer and restart the scanning there, this time WITHOUT
649 ;; pushing the 'while state onto the stack.
650 ;;
651 ;; In addition to the above there is some special handling of labels
652 ;; and macros.
656 macro-start
659 c-stmt-delim-chars-with-comma
660 c-stmt-delim-chars))
661 c-in-literal-cache c-maybe-labelp saved
662 ;; Current position.
663 pos
664 ;; Position of last stmt boundary character (e.g. ;).
665 boundary-pos
666 ;; The position of the last sexp or bound that follows the
667 ;; first found colon, i.e. the start of the nonlabel part of
668 ;; the statement. It's `start' if a colon is found just after
669 ;; the start.
670 after-labels-pos
671 ;; Like `after-labels-pos', but the first such position inside
672 ;; a label, i.e. the start of the last label before the start
673 ;; of the nonlabel part of the statement.
674 last-label-pos
675 ;; The last position where a label is possible provided the
676 ;; statement started there. It's nil as long as no invalid
677 ;; label content has been found (according to
678 ;; `c-nonlabel-token-key'. It's `start' if no valid label
679 ;; content was found in the label. Note that we might still
680 ;; regard it a label if it starts with `c-label-kwds'.
681 label-good-pos
682 ;; Symbol just scanned back over (e.g. 'while or 'boundary).
683 ;; See above.
684 sym
685 ;; Current state in the automaton. See above.
686 state
687 ;; Current saved positions. See above.
688 saved-pos
689 ;; Stack of conses (state . saved-pos).
690 stack
691 ;; Regexp which matches "for", "if", etc.
694 ;; Return value.
696 ;; Positions of the last three sexps or bounds we've stopped at.
697 tok ptok pptok)
707 ;; Try to skip back over unary operator characters, to register
708 ;; that we've moved.
712 ;; Protect post-++/-- operators just before a virtual semicolon.
716 ;; Skip back over any semicolon here. If it was a bare semicolon, we're
717 ;; done. Later on we ignore the boundaries for statements that don't
718 ;; contain any sexp. The only thing that is affected is that the error
719 ;; checking is a little less strict, and we really don't bother.
729 pos saved)
731 ;; Begin at start and not pos to detect macros if we stand
732 ;; directly after the #.
735 ;; Record this as the first token if not starting inside it.
738 ;; The following while loop goes back one sexp (balanced parens,
739 ;; etc. with contents, or symbol or suchlike) each iteration. This
740 ;; movement is accomplished with a call to scan-sexps approx 130 lines
741 ;; below.
759 ;; Stop at the first token in the content of the macro.
763 ret 'macro
764 ignore-labels t))
767 ;; Do a round through the automaton if we've just passed a
768 ;; statement boundary or passed a "while"-like token.
776 ;; The PDA state handling.
777 ;;
778 ;; Refer to the description of the PDA in the opening
779 ;; comments. In the following OR form, the first leaf
780 ;; attempts to handles one of the specific actions detailed
781 ;; (e.g., finding token "if" whilst in state `else-boundary').
782 ;; We drop through to the second leaf (which handles common
783 ;; state) if no specific handler is found in the first cond.
784 ;; If a parsing error is detected (e.g. an "else" with no
785 ;; preceding "if"), we throw to the enclosing catch.
786 ;;
787 ;; Note that the (eq state 'else) means
788 ;; "we've just passed an else", NOT "we're looking for an
789 ;; else".
806 ;; Since this can cause backtracking we do a
807 ;; little more careful analysis to avoid it:
808 ;; If there's a label in front of the while
809 ;; it can't be part of a do-while.
838 ;; This is state common. We get here when the previous
839 ;; cond statement found no particular state handler.
841 ;; If we have a boundary at the start
842 ;; position we push a frame to go to the
843 ;; previous statement.
852 ;; Is this a real while, or a do-while?
853 ;; The next `when' triggers unless we are SURE that
854 ;; the `while' is not the tailend of a `do-while'.
857 ;; The following kludge is to prevent
858 ;; infinite recursion when called from
859 ;; c-awk-after-if-for-while-condition-p,
860 ;; or the like.
864 ;; Since this can cause backtracking we do a
865 ;; little more careful analysis to avoid it: If
866 ;; the while isn't followed by a (possibly
867 ;; virtual) semicolon it can't be a do-while.
876 ;; We're either past a statement boundary or at the
877 ;; start of a statement, so throw away any label data
878 ;; for the previous one.
880 last-label-pos nil
881 c-maybe-labelp nil))))
883 ;; Step to the previous sexp, but not if we crossed a
884 ;; boundary, since that doesn't consume an sexp.
888 ;; HERE IS THE SINGLE PLACE INSIDE THE PDA LOOP WHERE WE MOVE
889 ;; BACKWARDS THROUGH THE SOURCE.
891 ;; This is typically fast with the caching done by
892 ;; c-(backward|forward)-sws.
896 ;; Set as long as we have to continue jumping by sexps.
897 ;; It's the position to use as end in the next round.
898 sexp-loop-continue-pos
899 ;; The end position of the area to search for statement
900 ;; barriers in this round.
903 ;; The following while goes back one sexp per iteration.
907 ;; Give up if we hit an unbalanced block. Since the
908 ;; stack won't be empty the code below will report a
909 ;; suitable error.
912 ;; Check if the sexp movement crossed a statement or
913 ;; declaration boundary. But first modify the point
914 ;; so that `c-crosses-statement-barrier-p' only looks
915 ;; at the non-sexp chars following the sexp.
918 boundary-pos
921 nil
924 ;; Set continuation position in case
925 ;; `c-crosses-statement-barrier-p'
926 ;; doesn't detect anything below.
928 ;; If the sexp movement took us into a
929 ;; macro then there were only some non-sexp
930 ;; chars after it. Skip out of the macro
931 ;; to analyze them but not the non-sexp
932 ;; chars that might be inside the macro.
940 ;; Passed a block sexp. That's a boundary
941 ;; alright.
945 ;; Passed some other paren. Only analyze
946 ;; the non-sexp chars after it.
948 before-sws-pos)))
949 ;; We're at a valid token start position
950 ;; (outside the `save-excursion') if
951 ;; `c-crosses-statement-barrier-p' failed.
956 ;; Passed a symbol sexp or line
957 ;; continuation. It doesn't matter that
958 ;; it's included in the analyzed region.
961 t
962 ;; If it was a line continuation then we
963 ;; have to continue looping.
966 nil))))
969 ptok tok
970 tok boundary-pos
972 ;; Like a C "continue". Analyze the next sexp.
978 sexp-loop-continue-pos nil))))
980 ;; ObjC method def?
987 ;; Handle labels.
990 ;; `c-crosses-statement-barrier-p' has found a colon, so we
991 ;; might be in a label now. Have we got a real label
992 ;; (including a case label) or something like C++'s "public:"?
997 ; wrong for AWK. 2006/1/14.
1004 label-good-pos nil))
1008 ; been found.
1010 ;; We're in a potential label and it's the first
1011 ;; time we've found something that isn't allowed in
1012 ;; one.
1015 ;; We've moved back by a sexp, so update the token positions.
1017 pptok ptok
1018 ptok tok
1022 ;; If the stack isn't empty there might be errors to report.
1031 ;; Need to investigate closer whether we've crossed
1032 ;; between a substatement and its containing statement.
1034 ptok
1035 pptok))
1042 after-labels-pos
1048 last-label-pos
1049 pos))
1051 ;; We're in a label. Maybe we should step to the statement
1052 ;; after it.
1057 ;; Might have jumped over several labels. Go to the last one.
1060 ;; Skip over the unary operators that can start the statement.
1064 ;; protect AWK post-inc/decrement operators, etc.
1069 ret)))
1072 "Return non-nil if buffer positions FROM to TO cross one or more
1073 statement or declaration boundaries. The returned value is actually
1074 the position of the earliest boundary char. FROM must not be within
1075 a string or comment.
1077 The variable `c-maybe-labelp' is set to the position of the first `:' that
1078 might start a label (i.e. not part of `::' and not preceded by `?'). If a
1079 single `?' is found, then `c-maybe-labelp' is cleared.
1081 For AWK, a statement which is terminated by an EOL (not a \; or a }) is
1083 the line. If this virtual semicolon is _at_ from, the function recognizes it.
1085 Note that this function might do hidden buffer changes. See the
1086 comment at the start of cc-engine.el for more info."
1088 lit-range)
1101 ;; Ignore scope operators.
1105 ;; A question mark. Can't be a label, so stop
1106 ;; looking for more : and ?.
1117 ;; In trailing space after an as yet undetected virtual semicolon?
1122 nil)))))
1125 "Return non-nil if the point is at the first token in a statement
1126 or somewhere in the syntactic whitespace before it.
1129 Any kind of declaration-like construct that occur outside function
1132 Note that this function might do hidden buffer changes. See the
1133 comment at the start of cc-engine.el for more info."
1137 c-maybe-labelp)
1148 "Return non-nil if the point is at the first token in an expression or
1149 statement, or somewhere in the syntactic whitespace before it.
1152 grammar sense: It's any sequence of expression tokens except commas,
1153 unless they are enclosed inside parentheses of some kind. Also, an
1154 expression never continues past an enclosing parenthesis, but it might
1155 contain parenthesis pairs of any sort except braces.
1157 Since expressions never cross statement boundaries, this function also
1158 recognizes statement beginnings, just like `c-at-statement-start-p'.
1160 Note that this function might do hidden buffer changes. See the
1161 comment at the start of cc-engine.el for more info."
1166 c-maybe-labelp)
1174 \f
1175 ;; A set of functions that covers various idiosyncrasies in
1176 ;; implementations of `forward-comment'.
1178 ;; Note: Some emacsen considers incorrectly that any line comment
1179 ;; ending with a backslash continues to the next line. I can't think
1180 ;; of any way to work around that in a reliable way without changing
1181 ;; the buffer, though. Suggestions welcome. ;) (No, temporarily
1182 ;; changing the syntax for backslash doesn't work since we must treat
1183 ;; escapes in string literals correctly.)
1186 "Move forward past whitespace and the closest following comment, if any.
1187 Return t if a comment was found, nil otherwise. In either case, the
1188 point is moved past the following whitespace. Line continuations,
1189 i.e. a backslashes followed by line breaks, are treated as whitespace.
1190 The line breaks that end line comments are considered to be the
1191 comment enders, so the point will be put on the beginning of the next
1192 line if it moved past a line comment.
1194 This function does not do any hidden buffer changes."
1202 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1203 ;; forwards at eob.
1204 nil
1206 ;; Emacs includes the ending newline in a b-style (c++)
1207 ;; comment, but XEmacs doesn't. We depend on the Emacs
1208 ;; behavior (which also is symmetric).
1212 t))))
1215 "Move forward past all following whitespace and comments.
1216 Line continuations, i.e. a backslashes followed by line breaks, are
1217 treated as whitespace.
1219 Note that this function might do hidden buffer changes. See the
1220 comment at the start of cc-engine.el for more info."
1223 ;; If forward-comment in at least XEmacs 21 is given a large
1224 ;; positive value, it'll loop all the way through if it hits
1225 ;; eob.
1227 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1228 ;; forwards at eob.
1233 t))))
1236 "Move backward past whitespace and the closest preceding comment, if any.
1237 Return t if a comment was found, nil otherwise. In either case, the
1238 point is moved past the preceding whitespace. Line continuations,
1239 i.e. a backslashes followed by line breaks, are treated as whitespace.
1240 The line breaks that end line comments are considered to be the
1241 comment enders, so the point cannot be at the end of the same line to
1242 move over a line comment.
1244 This function does not do any hidden buffer changes."
1247 ;; When we got newline terminated comments, forward-comment in all
1248 ;; supported emacsen so far will stop at eol of each line not
1249 ;; ending with a comment when moving backwards. This corrects for
1250 ;; that, and at the same time handles line continuations.
1258 ;; Some emacsen (e.g. Emacs 19.34) return t when moving
1259 ;; backwards at bob.
1260 nil
1262 ;; Leave point after the closest following newline if we've
1263 ;; backed up over any above, since forward-comment won't move
1264 ;; backward over a line comment if point is at the end of the
1265 ;; same line.
1270 ;; If forward-comment above succeeded and we're at eol
1271 ;; then the newline we moved over above didn't end a
1272 ;; line comment, so we give it another go.
1274 t))
1276 ;; Emacs <= 20 and XEmacs move back over the closer of a
1277 ;; block comment that lacks an opener.
1280 t)))))
1283 "Move backward past all preceding whitespace and comments.
1284 Line continuations, i.e. a backslashes followed by line breaks, are
1285 treated as whitespace. The line breaks that end line comments are
1286 considered to be the comment enders, so the point cannot be at the end
1287 of the same line to move over a line comment. Unlike
1288 c-backward-syntactic-ws, this function doesn't move back over
1289 preprocessor directives.
1291 Note that this function might do hidden buffer changes. See the
1292 comment at the start of cc-engine.el for more info."
1296 ;; `forward-comment' in some emacsen (e.g. XEmacs 21.4)
1297 ;; return t when moving backwards at bob.
1302 ;; Emacs <= 20 and XEmacs move back over the
1303 ;; closer of a block comment that lacks an opener.
1305 t)
1307 ;; XEmacs treats line continuations as whitespace but
1308 ;; only in the backward direction, which seems a bit
1309 ;; odd. Anyway, this is necessary for Emacs.
1314 t))))))
1316 \f
1317 ;; Tools for skipping over syntactic whitespace.
1319 ;; The following functions use text properties to cache searches over
1320 ;; large regions of syntactic whitespace. It works as follows:
1321 ;;
1322 ;; o If a syntactic whitespace region contains anything but simple
1323 ;; whitespace (i.e. space, tab and line breaks), the text property
1324 ;; `c-in-sws' is put over it. At places where we have stopped
1325 ;; within that region there's also a `c-is-sws' text property.
1326 ;; That since there typically are nested whitespace inside that
1327 ;; must be handled separately, e.g. whitespace inside a comment or
1328 ;; cpp directive. Thus, from one point with `c-is-sws' it's safe
1329 ;; to jump to another point with that property within the same
1330 ;; `c-in-sws' region. It can be likened to a ladder where
1331 ;; `c-in-sws' marks the bars and `c-is-sws' the rungs.
1332 ;;
1333 ;; o The `c-is-sws' property is put on the simple whitespace chars at
1334 ;; a "rung position" and also maybe on the first following char.
1335 ;; As many characters as can be conveniently found in this range
1336 ;; are marked, but no assumption can be made that the whole range
1337 ;; is marked (it could be clobbered by later changes, for
1338 ;; instance).
1339 ;;
1340 ;; Note that some part of the beginning of a sequence of simple
1341 ;; whitespace might be part of the end of a preceding line comment
1342 ;; or cpp directive and must not be considered part of the "rung".
1343 ;; Such whitespace is some amount of horizontal whitespace followed
1344 ;; by a newline. In the case of cpp directives it could also be
1345 ;; two newlines with horizontal whitespace between them.
1346 ;;
1347 ;; The reason to include the first following char is to cope with
1348 ;; "rung positions" that doesn't have any ordinary whitespace. If
1349 ;; `c-is-sws' is put on a token character it does not have
1350 ;; `c-in-sws' set simultaneously. That's the only case when that
1351 ;; can occur, and the reason for not extending the `c-in-sws'
1352 ;; region to cover it is that the `c-in-sws' region could then be
1353 ;; accidentally merged with a following one if the token is only
1354 ;; one character long.
1355 ;;
1356 ;; o On buffer changes the `c-in-sws' and `c-is-sws' properties are
1357 ;; removed in the changed region. If the change was inside
1358 ;; syntactic whitespace that means that the "ladder" is broken, but
1359 ;; a later call to `c-forward-sws' or `c-backward-sws' will use the
1360 ;; parts on either side and use an ordinary search only to "repair"
1361 ;; the gap.
1362 ;;
1363 ;; Special care needs to be taken if a region is removed: If there
1364 ;; are `c-in-sws' on both sides of it which do not connect inside
1365 ;; the region then they can't be joined. If e.g. a marked macro is
1366 ;; broken, syntactic whitespace inside the new text might be
1367 ;; marked. If those marks would become connected with the old
1368 ;; `c-in-sws' range around the macro then we could get a ladder
1369 ;; with one end outside the macro and the other at some whitespace
1370 ;; within it.
1371 ;;
1372 ;; The main motivation for this system is to increase the speed in
1373 ;; skipping over the large whitespace regions that can occur at the
1374 ;; top level in e.g. header files that contain a lot of comments and
1375 ;; cpp directives. For small comments inside code it's probably
1376 ;; slower than using `forward-comment' straightforwardly, but speed is
1377 ;; not a significant factor there anyway.
1379 ; (defface c-debug-is-sws-face
1380 ; '((t (:background "GreenYellow")))
1381 ; "Debug face to mark the `c-is-sws' property.")
1382 ; (defface c-debug-in-sws-face
1383 ; '((t (:underline t)))
1384 ; "Debug face to mark the `c-in-sws' property.")
1386 ; (defun c-debug-put-sws-faces ()
1387 ; ;; Put the sws debug faces on all the `c-is-sws' and `c-in-sws'
1388 ; ;; properties in the buffer.
1389 ; (interactive)
1390 ; (save-excursion
1391 ; (c-save-buffer-state (in-face)
1392 ; (goto-char (point-min))
1393 ; (setq in-face (if (get-text-property (point) 'c-is-sws)
1394 ; (point)))
1395 ; (while (progn
1396 ; (goto-char (next-single-property-change
1397 ; (point) 'c-is-sws nil (point-max)))
1398 ; (if in-face
1399 ; (progn
1400 ; (c-debug-add-face in-face (point) 'c-debug-is-sws-face)
1401 ; (setq in-face nil))
1402 ; (setq in-face (point)))
1403 ; (not (eobp))))
1404 ; (goto-char (point-min))
1405 ; (setq in-face (if (get-text-property (point) 'c-in-sws)
1406 ; (point)))
1407 ; (while (progn
1408 ; (goto-char (next-single-property-change
1409 ; (point) 'c-in-sws nil (point-max)))
1410 ; (if in-face
1411 ; (progn
1412 ; (c-debug-add-face in-face (point) 'c-debug-in-sws-face)
1413 ; (setq in-face nil))
1414 ; (setq in-face (point)))
1415 ; (not (eobp)))))))
1418 ;;`(message ,@args)
1419 )
1422 ;; This macro does a hidden buffer change.
1429 ;; This macro does a hidden buffer change.
1436 ;; This macro does a hidden buffer change.
1443 ;; This macro does a hidden buffer change.
1450 ;; This macro does a hidden buffer change.
1458 ;; Called from `after-change-functions'. Note that if
1459 ;; `c-forward-sws' or `c-backward-sws' are used outside
1460 ;; `c-save-buffer-state' or similar then this will remove the cache
1461 ;; properties right after they're added.
1462 ;;
1463 ;; This function does hidden buffer changes.
1466 ;; Adjust the end to remove the properties in any following simple
1467 ;; ws up to and including the next line break, if there is any
1468 ;; after the changed region. This is necessary e.g. when a rung
1469 ;; marked empty line is converted to a line comment by inserting
1470 ;; "//" before the line break. In that case the line break would
1471 ;; keep the rung mark which could make a later `c-backward-sws'
1472 ;; move into the line comment instead of over it.
1482 ;; Ensure that an `c-in-sws' range gets broken. Note that it isn't
1483 ;; safe to keep a range that was continuous before the change. E.g:
1484 ;;
1485 ;; #define foo
1486 ;; \
1487 ;; bar
1488 ;;
1489 ;; There can be a "ladder" between "#" and "b". Now, if the newline
1490 ;; after "foo" is removed then "bar" will become part of the cpp
1491 ;; directive instead of a syntactically relevant token. In that
1492 ;; case there's no longer syntactic ws from "#" to "b".
1499 ;; Used by `c-forward-syntactic-ws' to implement the unbounded search.
1500 ;;
1501 ;; This function might do hidden buffer changes.
1504 ;; unmarked part of the simple ws region.
1506 rung-is-marked next-rung-is-marked simple-ws-end
1507 ;; `safe-start' is set when it's safe to cache the start position.
1508 ;; It's not set if we've initially skipped over comments and line
1509 ;; continuations since we might have gone out through the end of a
1510 ;; macro then. This provision makes `c-forward-sws' not populate the
1511 ;; cache in the majority of cases, but otoh is `c-backward-sws' by far
1512 ;; more common.
1513 safe-start)
1515 ;; Skip simple ws and do a quick check on the following character to see
1516 ;; if it's anything that can't start syntactic ws, so we can bail out
1517 ;; early in the majority of cases when there just are a few ws chars.
1524 ;; Find the last rung position to avoid setting properties in all
1525 ;; the cases when the marked rung is complete.
1526 ;; (`next-single-property-change' is certain to move at least one
1527 ;; step forward.)
1530 ;; Got no marked rung here. Since the simple ws might have started
1531 ;; inside a line comment or cpp directive we must set `rung-pos' as
1532 ;; high as possible.
1541 ;; The following search is the main reason that `c-in-sws'
1542 ;; and `c-is-sws' aren't combined to one property.
1546 ;; If the `c-in-sws' region extended past the last
1547 ;; `c-is-sws' char we have to go back a bit.
1554 "c-forward-sws cached move %s -> %s (max %s)"
1561 ;; We'll loop here if there is simple ws after the last rung.
1562 ;; That means that there's been some change in it and it's
1563 ;; possible that we've stepped into another ladder, so extend
1564 ;; the previous one to join with it if there is one, and try to
1565 ;; use the cache again.
1567 "c-forward-sws extending rung with [%s..%s] (max %s)"
1570 ;; Remove any `c-in-sws' property from the last char of
1571 ;; the rung before we mark it with `c-is-sws', so that we
1572 ;; won't connect with the remains of a broken "ladder".
1578 last-put-in-sws-pos rung-pos)))
1585 ;; Skipped over comments. Don't cache at eob in case the buffer
1586 ;; is narrowed.
1597 ;; Skip a preprocessor directive.
1604 ;; Don't cache at eob in case the buffer is narrowed.
1607 ;; We've searched over a piece of non-white syntactic ws. See if this
1608 ;; can be cached.
1614 ;; Cache if we haven't skipped comments only, and if we started
1615 ;; either from a marked rung or from a completely uncached
1616 ;; position.
1621 ;; See if there's a marked rung in the encountered simple ws. If
1622 ;; so then we can cache, unless `safe-start' is nil. Even then
1623 ;; we need to do this to check if the cache can be used for the
1624 ;; next step.
1628 safe-start))
1632 "c-forward-sws caching [%s..%s] - [%s..%s] (max %s)"
1636 ;; Remove the properties for any nested ws that might be cached.
1637 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
1638 ;; anyway.
1646 last-put-in-sws-pos rung-pos))
1648 ;; Remove any `c-in-sws' property from the last char of
1649 ;; the rung before we mark it with `c-is-sws', so that we
1650 ;; won't connect with the remains of a broken "ladder".
1653 rung-end-pos))
1656 "c-forward-sws not caching [%s..%s] - [%s..%s] (max %s)"
1660 ;; Set `rung-pos' for the next rung. It's the same thing here as
1661 ;; initially, except that the rung position is set as early as
1662 ;; possible since we can't be in the ending ws of a line comment or
1663 ;; cpp directive now.
1670 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
1671 ;; another one after the point (which might occur when editing inside a
1672 ;; comment or macro).
1676 "c-forward-sws clearing at %s for cache separation"
1677 last-put-in-sws-pos)
1681 ;; If at eob we have to clear the last character before the end
1682 ;; instead since the buffer might be narrowed and there might
1683 ;; be a `c-in-sws' after (point-max). In this case it's
1684 ;; necessary to clear both properties.
1686 "c-forward-sws clearing thoroughly at %s for cache separation"
1689 last-put-in-sws-pos))))
1690 )))
1693 ;; Used by `c-backward-syntactic-ws' to implement the unbounded search.
1694 ;;
1695 ;; This function might do hidden buffer changes.
1698 ;; part of the simple ws region.
1700 rung-is-marked simple-ws-beg cmt-skip-pos)
1702 ;; Skip simple horizontal ws and do a quick check on the preceding
1703 ;; character to see if it's anying that can't end syntactic ws, so we can
1704 ;; bail out early in the majority of cases when there just are a few ws
1705 ;; chars. Newlines are complicated in the backward direction, so we can't
1706 ;; skip over them.
1713 ;; Try to find a rung position in the simple ws preceding point, so that
1714 ;; we can get a cache hit even if the last bit of the simple ws has
1715 ;; changed recently.
1721 ;; `rung-pos' will be the earliest marked position, which means that
1722 ;; there might be later unmarked parts in the simple ws region.
1723 ;; It's not worth the effort to fix that; the last part of the
1724 ;; simple ws is also typically edited often, so it could be wasted.
1735 ;; The following search is the main reason that `c-in-sws'
1736 ;; and `c-is-sws' aren't combined to one property.
1740 ;; If the `c-in-sws' region extended past the first
1741 ;; `c-is-sws' char we have to go forward a bit.
1746 "c-backward-sws cached move %s <- %s (min %s)"
1758 t
1760 nil))
1762 ;; We'll loop here if there is simple ws before the first rung.
1763 ;; That means that there's been some change in it and it's
1764 ;; possible that we've stepped into another ladder, so extend
1765 ;; the previous one to join with it if there is one, and try to
1766 ;; use the cache again.
1768 "c-backward-sws extending rung with [%s..%s] (min %s)"
1771 ;; Remove any `c-in-sws' property from the last char of
1772 ;; the rung before we mark it with `c-is-sws', so that we
1773 ;; won't connect with the remains of a broken "ladder".
1776 rung-pos)
1780 last-put-in-sws-pos rung-pos))
1789 ;; Inside a cpp directive. See if it should be skipped over.
1792 ;; Move back over all line continuations in the region skipped
1793 ;; over by `c-backward-comments'. If we go past it then we
1794 ;; started inside the cpp directive.
1803 ;; Don't move past the cpp directive if we began inside
1804 ;; it. Note that the position at the end of the last line
1805 ;; of the macro is also considered to be within it.
1807 nil)
1809 ;; It's worthwhile to spend a little bit of effort on finding
1810 ;; the end of the macro, to get a good `simple-ws-beg'
1811 ;; position for the cache. Note that `c-backward-comments'
1812 ;; could have stepped over some comments before going into
1813 ;; the macro, and then `simple-ws-beg' must be kept on the
1814 ;; same side of those comments.
1821 ;; Might happen if comments after the macro were skipped
1822 ;; over.
1826 t)))
1831 simple-ws-beg)
1832 ;; Skipped over comments. Must put point at the end of
1833 ;; the simple ws at point since we might be after a line
1834 ;; comment or cpp directive that's been partially
1835 ;; narrowed out, and we can't risk marking the simple ws
1836 ;; at the end of it.
1838 t)))
1840 ;; We've searched over a piece of non-white syntactic ws. See if this
1841 ;; can be cached.
1846 ;; Cache if we started either from a marked rung or from a
1847 ;; completely uncached position.
1848 rung-is-marked
1851 ;; Cache if there's a marked rung in the encountered simple ws.
1859 "c-backward-sws caching [%s..%s] - [%s..%s] (min %s)"
1864 ;; Remove the properties for any nested ws that might be cached.
1865 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
1866 ;; anyway.
1871 ;; Remove any `c-in-sws' property from the last char of
1872 ;; the rung before we mark it with `c-is-sws', so that we
1873 ;; won't connect with the remains of a broken "ladder".
1876 rung-end-pos)
1879 last-put-in-sws-pos simple-ws-beg)
1880 rung-pos)
1885 "c-backward-sws not caching [%s..%s] - [%s..%s] (min %s)"
1891 ))
1893 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
1894 ;; another one before the point (which might occur when editing inside a
1895 ;; comment or macro).
1899 "c-backward-sws clearing at %s for cache separation"
1902 last-put-in-sws-pos))
1904 ;; If at bob and the buffer is narrowed, we have to clear the
1905 ;; character we're standing on instead since there might be a
1906 ;; `c-in-sws' before (point-min). In this case it's necessary
1907 ;; to clear both properties.
1909 "c-backward-sws clearing thoroughly at %s for cache separation"
1910 last-put-in-sws-pos)
1913 )))
1915 \f
1916 ;; Other whitespace tools
1918 ;; Is the region (beg end) WS, and is there WS (or BOB/EOB) next to the
1919 ;; region? This is a "heuristic" function. .....
1920 ;;
1921 ;; The motivation for the second bit is to check whether removing this
1922 ;; region would coalesce two symbols.
1923 ;;
1924 ;; FIXME!!! This function doesn't check virtual semicolons in any way. Be
1925 ;; careful about using this function for, e.g. AWK. (2007/3/7)
1934 \f
1935 ;; A system for finding noteworthy parens before the point.
1939 ;; The state cache used by `c-parse-state' to cut down the amount of
1940 ;; searching. It's the result from some earlier `c-parse-state' call.
1941 ;;
1942 ;; The use of the cached info is more effective if the next
1943 ;; `c-parse-state' call is on a line close by the one the cached state
1944 ;; was made at; the cache can actually slow down a little if the
1945 ;; cached state was made very far back in the buffer. The cache is
1946 ;; most effective if `c-parse-state' is used on each line while moving
1947 ;; forward.
1951 ;; This is (point-min) when `c-state-cache' was calculated, since a
1952 ;; change of narrowing is likely to affect the parens that are visible
1953 ;; before the point.
1957 ;; This is a position where `c-state-cache' is known to be correct.
1958 ;; It's a position inside one of the recorded unclosed parens or the
1959 ;; top level, but not further nested inside any literal or subparen
1960 ;; that is closed before the last recorded position.
1961 ;;
1962 ;; The exact position is chosen to try to be close to yet earlier than
1963 ;; the position where `c-state-cache' will be called next. Right now
1964 ;; the heuristic is to set it to the position after the last found
1965 ;; closing paren (of any type) before the line on which
1966 ;; `c-parse-state' was called. That is chosen primarily to work well
1967 ;; with refontification of the current line.
1970 ;; Invalidate all info on `c-state-cache' that applies to the buffer
1971 ;; at POS or higher. This is much like `c-whack-state-after', but
1972 ;; it never changes a paren pair element into an open paren element.
1973 ;; Doing that would mean that the new open paren wouldn't have the
1974 ;; required preceding paren pair element.
1978 nil))
1984 nil))
1988 nil)))))
1992 ;; Return the start position for building `c-state-cache' from
1993 ;; scratch.
1995 ;; Go back 2 bods, but ignore any bogus positions returned by
1996 ;; beginning-of-defun (i.e. open paren in column zero).
2006 ;; Find and record all noteworthy parens between some good point
2007 ;; earlier in the file and point. That good point is at least the
2008 ;; beginning of the top-level construct we are in, or the beginning
2009 ;; of the preceding top-level construct if we aren't in one.
2010 ;;
2011 ;; The returned value is a list of the noteworthy parens with the
2012 ;; last one first. If an element in the list is an integer, it's
2013 ;; the position of an open paren which has not been closed before
2014 ;; the point. If an element is a cons, it gives the position of a
2015 ;; closed brace paren pair; the car is the start paren position and
2016 ;; the cdr is the position following the closing paren. Only the
2017 ;; last closed brace paren pair before each open paren and before
2018 ;; the point is recorded, and thus the state never contains two cons
2019 ;; elements in succession.
2020 ;;
2021 ;; Currently no characters which are given paren syntax with the
2022 ;; syntax-table property are recorded, i.e. angle bracket arglist
2023 ;; parens are never present here. Note that this might change.
2024 ;;
2025 ;; BUG: This function doesn't cope entirely well with unbalanced
2026 ;; parens in macros. E.g. in the following case the brace before
2027 ;; the macro isn't balanced with the one after it:
2028 ;;
2029 ;; {
2030 ;; #define X {
2031 ;; }
2032 ;;
2033 ;; This function might do hidden buffer changes.
2040 old-state last-pos brace-pair-open brace-pair-close
2041 pos save-pos)
2044 ;; If the minimum position has changed due to narrowing then we
2045 ;; have to fix the tail of `c-state-cache' accordingly.
2048 ;; If point-min has moved forward then we just need to cut
2049 ;; off a bit of the tail.
2060 ;; If point-min has moved backward then we drop the state
2061 ;; completely. It's possible to do a better job here and
2062 ;; recalculate the top only.
2067 ;; Get the latest position we know are directly inside the
2068 ;; closest containing paren of the cached state.
2076 ;; Take the opportunity to move the cached good position
2077 ;; further down.
2081 ;; Check if `last-pos' is in a macro. If it is, and we're not
2082 ;; in the same macro, we must discard everything on
2083 ;; `c-state-cache' that is inside the macro before using it.
2089 ;; Set `last-pos' again just like above except that there's
2090 ;; no use looking at `c-state-cache-good-pos' here.
2097 ;; If we've moved very far from the last cached position then
2098 ;; it's probably better to redo it from scratch, otherwise we
2099 ;; might spend a lot of time searching from `last-pos' down to
2100 ;; here.
2102 ;; First get the fallback start position. If it turns out
2103 ;; that it's so far back that the cached state is closer then
2104 ;; we'll keep it afterall.
2109 c-state-cache nil
2112 ;; Find the start position for the forward search. (Can't
2113 ;; search in the backward direction since the point might be in
2114 ;; some kind of literal.)
2119 ;; There's a cached state with a containing paren. Pop off
2120 ;; the stale containing sexps from it by going forward out of
2121 ;; parens as far as possible.
2135 ;; The last paren pair we moved out from was a brace
2136 ;; pair. Modify the state to record this as a closed
2137 ;; pair now.
2141 c-state-cache))))
2143 ;; Check if the preceding balanced paren is within a
2144 ;; macro; it should be ignored if we're outside the
2145 ;; macro. There's no need to check any further upwards;
2146 ;; if the macro contains an unbalanced opening paren then
2147 ;; we're smoked anyway.
2157 ;; Have to adjust the cached good position if state has been
2158 ;; popped off.
2165 old-state c-state-cache))
2170 ;; Get the fallback start position.
2173 c-state-cache nil
2180 brace-pair-open nil)
2182 ;; Find the balanced brace pairs. This loop is hot, so it
2183 ;; does ugly tricks to go faster.
2193 ;; Update the cached good position and record the brace
2194 ;; pair, whichever is applicable for the paren we've
2195 ;; just jumped over. But first check that it isn't
2196 ;; inside a macro and the point isn't inside the same
2197 ;; one.
2207 brace-pair-close pos))))))
2209 ;; Record the last brace pair.
2217 brace-pair-close)
2218 c-state-cache)))))
2221 ;; Prepare to loop, but record the open paren only if it's
2222 ;; outside a macro or within the same macro as point, and
2223 ;; if it is a legitimate open paren and not some character
2224 ;; that got an open paren syntax-table property.
2231 ;; Check for known types of parens that we
2232 ;; want to record. The syntax table is not to
2233 ;; be trusted here since the caller might be
2234 ;; using e.g. `c++-template-syntax-table'.
2241 ;; Found a close paren without a corresponding opening
2242 ;; one. Maybe we didn't go back far enough, so try to
2243 ;; scan backward for the start paren and then start over.
2246 c-state-cache nil
2247 c-state-cache-good-pos c-state-cache-start)
2249 ;; Emacs (up to at least 21.2) can get confused by
2250 ;; open parens in column zero inside comments: The
2251 ;; sexp functions can then misbehave and bring us
2252 ;; back to the same point again. Check this so that
2253 ;; we don't get an infinite loop.
2256 c-parsing-error
2262 ;;(message "c-parse-state: %S end: %S" c-state-cache c-state-cache-good-pos)
2263 c-state-cache)))
2265 ;; Debug tool to catch cache inconsistencies.
2277 ;; The cache can actually go further back due to the ad-hoc way
2278 ;; the first paren is found, so try to whack off a bit of its
2279 ;; start before complaining.
2288 res1 res2))))
2289 res1))
2294 'c-debug-parse-state
2301 ;; Whack off any state information from PAREN-STATE which lies
2302 ;; before BUFPOS. Not destructive on PAREN-STATE.
2305 car)
2316 ;; Whack off any state information from PAREN-STATE which lies at or
2317 ;; after BUFPOS. Not destructive on PAREN-STATE.
2322 ;; just check the car, because in a balanced brace
2323 ;; expression, it must be impossible for the corresponding
2324 ;; close brace to be before point, but the open brace to
2325 ;; be after.
2327 nil ; whack it off
2329 ;; its possible that the open brace is before
2330 ;; bufpos, but the close brace is after. In that
2331 ;; case, convert this to a non-cons element. The
2332 ;; rest of the state is before bufpos, so we're
2333 ;; done.
2335 ;; we know that both the open and close braces are
2336 ;; before bufpos, so we also know that everything else
2337 ;; on state is before bufpos.
2340 nil ; whack it off
2341 ;; it's before bufpos, so everything else should too.
2344 nil)))
2347 ;; Return the bufpos of the innermost enclosing open paren before
2348 ;; bufpos, or nil if none was found.
2358 enclosingp))
2361 ;; Return the bufpos of the outermost enclosing open paren, or nil
2362 ;; if none was found.
2369 pos))
2372 ;; Return the closest "safe" position recorded on PAREN-STATE that
2373 ;; is higher up than BUFPOS. Return nil if PAREN-STATE doesn't
2374 ;; contain any. Return nil if BUFPOS is nil, which is useful to
2375 ;; find the closest limit before a given limit that might be nil.
2376 ;;
2377 ;; A "safe" position is a position at or after a recorded open
2378 ;; paren, or after a recorded close paren. The returned position is
2379 ;; thus either the first position after a close brace, or the first
2380 ;; position after an enclosing paren, or at the enclosing paren in
2381 ;; case BUFPOS is immediately after it.
2391 ;; See below.
2394 ;; elem is the position at and not after the opening paren, so
2395 ;; we can go forward one more step unless it's equal to
2396 ;; bufpos. This is useful in some cases avoid an extra paren
2397 ;; level between the safe position and bufpos.
2402 ;; This is used for `font-lock-beginning-of-syntax-function'. It
2403 ;; goes to the closest previous point that is known to be outside
2404 ;; any string literal or comment. `c-state-cache' is used if it has
2405 ;; a position in the vicinity.
2407 elem
2410 ;; Note: Similar code in `c-safe-position'. The
2411 ;; difference is that we accept a safe position at
2412 ;; the point and don't bother to go forward past open
2413 ;; parens.
2428 ;; The position is far back. Try `c-beginning-of-defun-1'
2429 ;; (although we can't be entirely sure it will go to a position
2430 ;; outside a comment or string in current emacsen). FIXME:
2431 ;; Consult `syntax-ppss' here.
2436 \f
2437 ;; Tools for scanning identifiers and other tokens.
2440 "Return non-nil if the point is on or directly after an identifier.
2441 Keywords are recognized and not considered identifiers. If an
2442 identifier is detected, the returned value is its starting position.
2443 If an identifier ends at the point and another begins at it \(can only
2444 happen in Pike) then the point for the preceding one is returned.
2446 Note that this function might do hidden buffer changes. See the
2447 comment at the start of cc-engine.el for more info."
2449 ;; FIXME: Shouldn't this function handle "operator" in C++?
2456 ;; Check for a normal (non-keyword) identifier.
2462 ;; Handle the `<operator> syntax in Pike.
2466 t
2473 ;; Handle the "operator +" syntax in C++.
2490 )))
2493 ;; If the point is at the end of a symbol then skip backward to the
2494 ;; beginning of it. Don't move otherwise. Return non-nil if point
2495 ;; moved.
2496 ;;
2497 ;; This function might do hidden buffer changes.
2500 ;; Handle the `<operator> syntax in Pike.
2506 t
2508 nil)))))
2511 ;; Move to the beginning of the current token. Do not move if not
2512 ;; in the middle of one. BACK-LIMIT may be used to bound the
2513 ;; backward search; if given it's assumed to be at the boundary
2514 ;; between two tokens. Return non-nil if the point is move, nil
2515 ;; otherwise.
2516 ;;
2517 ;; This function might do hidden buffer changes.
2524 ;; `c-nonsymbol-token-regexp' should always match
2525 ;; since we've skipped backward over punctuator
2526 ;; or paren syntax, but consume one char in case
2527 ;; it doesn't so that we don't leave point before
2528 ;; some earlier incorrect token.
2535 ;; Move to the end of the current token. Do not move if not in the
2536 ;; middle of one. BACK-LIMIT may be used to bound the backward
2537 ;; search; if given it's assumed to be at the boundary between two
2538 ;; tokens. Return non-nil if the point is moved, nil otherwise.
2539 ;;
2540 ;; This function might do hidden buffer changes.
2548 ;; `c-nonsymbol-token-regexp' should always match since
2549 ;; we've skipped backward over punctuator or paren
2550 ;; syntax, but move forward in case it doesn't so that
2551 ;; we don't leave point earlier than we started with.
2567 "Move forward by tokens.
2568 A token is defined as all symbols and identifiers which aren't
2570 treated properly). Point is always either left at the beginning of a
2571 token or not moved at all. COUNT specifies the number of tokens to
2572 move; a negative COUNT moves in the opposite direction. A COUNT of 0
2573 moves to the next token beginning only if not already at one. If
2574 BALANCED is true, move over balanced parens, otherwise move into them.
2575 Also, if BALANCED is true, never move out of an enclosing paren.
2577 LIMIT sets the limit for the movement and defaults to the point limit.
2578 The case when LIMIT is set in the middle of a token, comment or macro
2579 is handled correctly, i.e. the point won't be left there.
2581 Return the number of tokens left to move \(positive or negative). If
2582 BALANCED is true, a move over a balanced paren counts as one. Note
2583 that if COUNT is 0 and no appropriate token beginning is found, 1 will
2584 be returned. Thus, a return value of 0 guarantees that point is at
2585 the requested position and a return value less \(without signs) than
2586 COUNT guarantees that point is at the beginning of some token.
2588 Note that this function might do hidden buffer changes. See the
2589 comment at the start of cc-engine.el for more info."
2596 c-jump-syntax-balanced
2597 c-jump-syntax-unbalanced))
2602 ;; If count is zero we should jump if in the middle of a token.
2609 ;; Skip whitespace. Count this as a move if we did in
2610 ;; fact move.
2614 ;; Moved out of bounds. Make sure the returned count isn't zero.
2619 ;; Use `condition-case' to avoid having the limit tests
2620 ;; inside the loop.
2628 t)
2631 t)
2632 ;; `c-nonsymbol-token-regexp' above should always
2633 ;; match if there are correct tokens. Try to
2634 ;; widen to see if the limit was set in the
2635 ;; middle of one, else fall back to treating
2636 ;; the offending thing as a one character token.
2641 nil)
2644 t))))
2654 count)))
2657 "Move backward by tokens.
2658 See `c-forward-token-2' for details."
2666 c-jump-syntax-balanced
2667 c-jump-syntax-unbalanced))
2671 ;; The count is zero so try to skip to the beginning of the
2672 ;; current token.
2676 ;; The limit is inside the same token, so return 1.
2679 ;; We're not in the middle of a token. If there's
2680 ;; whitespace after the point then we must move backward,
2681 ;; so set count to 1 in that case.
2683 ;; If we're looking at a '#' that might start a cpp
2684 ;; directive then we have to do a more elaborate check.
2697 ;; Use `condition-case' to avoid having to check for buffer
2698 ;; limits in `backward-char', `scan-sexps' and `goto-char' below.
2707 ;; This can be very inefficient if there's a long
2708 ;; sequence of operator tokens without any separation.
2709 ;; That doesn't happen in practice, anyway.
2719 count)))
2722 "Like `c-forward-token-2' but doesn't treat multicharacter operator
2724 characters are jumped over character by character. This function is
2725 for compatibility only; it's only a wrapper over `c-forward-token-2'."
2730 "Like `c-backward-token-2' but doesn't treat multicharacter operator
2732 characters are jumped over character by character. This function is
2733 for compatibility only; it's only a wrapper over `c-backward-token-2'."
2737 \f
2738 ;; Tools for doing searches restricted to syntactically relevant text.
2741 paren-level not-inside-token
2742 lookbehind-submatch)
2743 "Like `re-search-forward', but only report matches that are found
2744 in syntactically significant text. I.e. matches in comments, macros
2745 or string literals are ignored. The start point is assumed to be
2746 outside any comment, macro or string literal, or else the content of
2747 that region is taken as syntactically significant text.
2749 If PAREN-LEVEL is non-nil, an additional restriction is added to
2750 ignore matches in nested paren sexps. The search will also not go
2751 outside the current list sexp, which has the effect that if the point
2752 should be moved to BOUND when no match is found \(i.e. NOERROR is
2753 neither nil nor t), then it will be at the closing paren if the end of
2754 the current list sexp is encountered first.
2756 If NOT-INSIDE-TOKEN is non-nil, matches in the middle of tokens are
2757 ignored. Things like multicharacter operators and special symbols
2759 constants.
2761 If LOOKBEHIND-SUBMATCH is non-nil, it's taken as a number of a
2762 subexpression in REGEXP. The end of that submatch is used as the
2763 position to check for syntactic significance. If LOOKBEHIND-SUBMATCH
2764 isn't used or if that subexpression didn't match then the start
2766 subexpression is never tested before the starting position, so it
2770 subexpression can match the end of nonwhite syntactic whitespace,
2771 i.e. the end of comments or cpp directives. This since the function
2772 skips over such things before resuming the search. It's on the other
2774 matches syntactic whitespace.
2776 Bug: Unbalanced parens inside cpp directives are currently not handled
2777 correctly \(i.e. they don't get ignored as they should) when
2778 PAREN-LEVEL is set.
2780 Note that this function might do hidden buffer changes. See the
2781 comment at the start of cc-engine.el for more info."
2786 ;;(message "c-syntactic-re-search-forward %s %s %S" (point) bound regexp)
2789 tmp
2790 ;; Start position for the last search.
2791 search-pos
2792 ;; The `parse-partial-sexp' state between the start position
2793 ;; and the point.
2794 state
2795 ;; The current position after the last state update. The next
2796 ;; `parse-partial-sexp' continues from here.
2798 ;; The position at which to check the state and the state
2799 ;; there. This is separate from `state-pos' since we might
2800 ;; need to back up before doing the next search round.
2801 check-pos check-state
2802 ;; Last position known to end a token.
2804 ;; Set when a valid match is found.
2805 found)
2823 state-pos check-pos paren-level nil state))
2825 check-state state))
2827 ;; NOTE: If we got a look behind subexpression and get
2828 ;; an insignificant match in something that isn't
2829 ;; syntactic whitespace (i.e. strings or in nested
2830 ;; parentheses), then we can never skip more than a
2831 ;; single character from the match start position
2832 ;; (i.e. `state-pos' here) before continuing the
2833 ;; search. That since the look behind subexpression
2834 ;; might match the end of the insignificant region in
2835 ;; the next search.
2839 ;; Match inside a line comment. Skip to eol. Use
2840 ;; `re-search-forward' instead of `skip-chars-forward' to get
2841 ;; the right bound behavior.
2845 ;; Match inside a block comment. Skip to the '*/'.
2852 ;; Match in the middle of the opener of a block or line
2853 ;; comment.
2858 ;; The last `parse-partial-sexp' above might have
2859 ;; stopped short of the real check position if the end
2860 ;; of the current sexp was encountered in paren-level
2861 ;; mode. The checks above are always false in that
2862 ;; case, and since they can do better skipping in
2863 ;; lookbehind-submatch mode, we do them before
2864 ;; checking the paren level.
2868 ;; Check the paren level first since we're short of the
2869 ;; syntactic checking position if the end of the
2870 ;; current sexp was encountered by `parse-partial-sexp'.
2873 ;; Inside a nested paren sexp.
2875 ;; See the NOTE above.
2877 ;; Skip out of the paren quickly.
2881 ;; Have exited the current paren sexp.
2884 ;; The last `parse-partial-sexp' call above
2885 ;; has left us just after the closing paren
2886 ;; in this case, so we can modify the bound
2887 ;; to leave the point at the right position
2888 ;; upon return.
2890 nil)
2894 ;; Match inside a string.
2897 ;; See the NOTE above.
2899 ;; Skip to the end of the string before continuing.
2908 continue)))
2913 ;; Match inside a macro. Skip to the end of it.
2921 (< check-pos
2927 ;; Inside a token.
2929 ;; See the NOTE above.
2934 ;; A real match.
2936 nil)))
2938 ;; Should loop to search again, but take care to avoid
2939 ;; looping on the same spot.
2943 nil
2946 t))))
2952 ;;(message "c-syntactic-re-search-forward done %s" (or (match-end 0) (point)))
2959 ;; Search failed. Set point as appropriate.
2963 nil)))
2966 "Like `skip-chars-backward' but only look at syntactically relevant chars,
2967 i.e. don't stop at positions inside syntactic whitespace or string
2968 literals. Preprocessor directives are also ignored, with the exception
2969 of the one that the point starts within, if any. If LIMIT is given,
2970 it's assumed to be at a syntactically relevant position.
2972 If PAREN-LEVEL is non-nil, the function won't stop in nested paren
2973 sexps, and the search will also not go outside the current paren sexp.
2974 However, if LIMIT or the buffer limit is reached inside a nested paren
2975 then the point will be left at the limit.
2977 Non-nil is returned if the point moved, nil otherwise.
2979 Note that this function might do hidden buffer changes. See the
2980 comment at the start of cc-engine.el for more info."
2983 state
2984 ;; A list of syntactically relevant positions in descending
2985 ;; order. It's used to avoid scanning repeatedly over
2986 ;; potentially large regions with `parse-partial-sexp' to verify
2987 ;; each position.
2988 safe-pos-list
2989 ;; The position at the beginning of `safe-pos-list'.
2990 safe-pos
2991 ;; The result from `c-beginning-of-macro' at the start position or the
2992 ;; start position itself if it isn't within a macro. Evaluated on
2993 ;; demand.
2994 start-macro-beg
2995 ;; The earliest position after the current one with the same paren
2996 ;; level. Used only when `paren-level' is set.
3003 ;; Use `parse-partial-sexp' from a safe position down to
3004 ;; the point to check if it's outside comments and
3005 ;; strings.
3007 ;; Pick a safe position as close to the point as
3008 ;; possible.
3009 ;;
3010 ;; FIXME: Consult `syntax-ppss' here if our
3011 ;; cache doesn't give a good position.
3023 ;; Cache positions along the way to use if we have to
3024 ;; back up more. We cache every closing paren on the
3025 ;; same level. If the paren cache is relevant in this
3026 ;; region then we're typically already on the same
3027 ;; level as the target position. Note that we might
3028 ;; cache positions after opening parens in case
3029 ;; safe-pos is in a nested list. That's both uncommon
3030 ;; and harmless.
3040 ;; Inside string or comment. Continue search at the
3041 ;; beginning of it.
3043 t)
3051 ;; Not at the right level.
3054 ;; We stop above if we go out of a paren.
3055 ;; Now check whether it precedes or is
3056 ;; nested in the starting sexp.
3060 pps-end-pos paren-level-pos
3061 nil nil state-2))
3064 ;; We've stopped short of the starting position
3065 ;; so the hit was inside a nested list. Go up
3066 ;; until we are at the right level.
3075 nil)
3076 t))
3079 nil))
3081 ;; The hit was outside the list at the start
3082 ;; position. Go to the start of the list and exit.
3084 nil))
3087 ;; Inside a macro.
3095 t
3097 ;; It's inside the same macro we started in so it's
3098 ;; a relevant match.
3100 nil)))))
3102 ;; If the state contains the start of the containing sexp we
3103 ;; cache that position too, so that parse-partial-sexp in the
3104 ;; next run has a bigger chance of starting at the same level
3105 ;; as the target position and thus will get more good safe
3106 ;; positions into the list.
3113 ;; Skip syntactic ws afterwards so that we don't stop at the
3114 ;; end of a comment if `skip-chars' is something like "^/".
3118 ;; We might want to extend this with more useful return values in
3119 ;; the future.
3122 ;; The following is an alternative implementation of
3123 ;; `c-syntactic-skip-backward' that uses backward movement to keep
3124 ;; track of the syntactic context. It turned out to be generally
3125 ;; slower than the one above which uses forward checks from earlier
3126 ;; safe positions.
3127 ;;
3128 ;;(defconst c-ssb-stop-re
3129 ;; ;; The regexp matching chars `c-syntactic-skip-backward' needs to
3130 ;; ;; stop at to avoid going into comments and literals.
3131 ;; (concat
3132 ;; ;; Match comment end syntax and string literal syntax. Also match
3133 ;; ;; '/' for block comment endings (not covered by comment end
3134 ;; ;; syntax).
3135 ;; "\\s>\\|/\\|\\s\""
3136 ;; (if (memq 'gen-string-delim c-emacs-features)
3137 ;; "\\|\\s|"
3138 ;; "")
3139 ;; (if (memq 'gen-comment-delim c-emacs-features)
3140 ;; "\\|\\s!"
3141 ;; "")))
3142 ;;
3143 ;;(defconst c-ssb-stop-paren-re
3144 ;; ;; Like `c-ssb-stop-re' but also stops at paren chars.
3145 ;; (concat c-ssb-stop-re "\\|\\s(\\|\\s)"))
3146 ;;
3147 ;;(defconst c-ssb-sexp-end-re
3148 ;; ;; Regexp matching the ending syntax of a complex sexp.
3149 ;; (concat c-string-limit-regexp "\\|\\s)"))
3150 ;;
3151 ;;(defun c-syntactic-skip-backward (skip-chars &optional limit paren-level)
3152 ;; "Like `skip-chars-backward' but only look at syntactically relevant chars,
3153 ;;i.e. don't stop at positions inside syntactic whitespace or string
3154 ;;literals. Preprocessor directives are also ignored. However, if the
3155 ;;point is within a comment, string literal or preprocessor directory to
3156 ;;begin with, its contents is treated as syntactically relevant chars.
3157 ;;If LIMIT is given, it limits the backward search and the point will be
3158 ;;left there if no earlier position is found.
3159 ;;
3160 ;;If PAREN-LEVEL is non-nil, the function won't stop in nested paren
3161 ;;sexps, and the search will also not go outside the current paren sexp.
3162 ;;However, if LIMIT or the buffer limit is reached inside a nested paren
3163 ;;then the point will be left at the limit.
3164 ;;
3165 ;;Non-nil is returned if the point moved, nil otherwise.
3166 ;;
3167 ;;Note that this function might do hidden buffer changes. See the
3168 ;;comment at the start of cc-engine.el for more info."
3169 ;;
3170 ;; (save-restriction
3171 ;; (when limit
3172 ;; (narrow-to-region limit (point-max)))
3173 ;;
3174 ;; (let ((start (point)))
3175 ;; (catch 'done
3176 ;; (while (let ((last-pos (point))
3177 ;; (stop-pos (progn
3178 ;; (skip-chars-backward skip-chars)
3179 ;; (point))))
3180 ;;
3181 ;; ;; Skip back over the same region as
3182 ;; ;; `skip-chars-backward' above, but keep to
3183 ;; ;; syntactically relevant positions.
3184 ;; (goto-char last-pos)
3185 ;; (while (and
3186 ;; ;; `re-search-backward' with a single char regexp
3187 ;; ;; should be fast.
3188 ;; (re-search-backward
3189 ;; (if paren-level c-ssb-stop-paren-re c-ssb-stop-re)
3190 ;; stop-pos 'move)
3191 ;;
3192 ;; (progn
3193 ;; (cond
3194 ;; ((looking-at "\\s(")
3195 ;; ;; `paren-level' is set and we've found the
3196 ;; ;; start of the containing paren.
3197 ;; (forward-char)
3198 ;; (throw 'done t))
3199 ;;
3200 ;; ((looking-at c-ssb-sexp-end-re)
3201 ;; ;; We're at the end of a string literal or paren
3202 ;; ;; sexp (if `paren-level' is set).
3203 ;; (forward-char)
3204 ;; (condition-case nil
3205 ;; (c-backward-sexp)
3206 ;; (error
3207 ;; (goto-char limit)
3208 ;; (throw 'done t))))
3209 ;;
3210 ;; (t
3211 ;; (forward-char)
3212 ;; ;; At the end of some syntactic ws or possibly
3213 ;; ;; after a plain '/' operator.
3214 ;; (let ((pos (point)))
3215 ;; (c-backward-syntactic-ws)
3216 ;; (if (= pos (point))
3217 ;; ;; Was a plain '/' operator. Go past it.
3218 ;; (backward-char)))))
3219 ;;
3220 ;; (> (point) stop-pos))))
3221 ;;
3222 ;; ;; Now the point is either at `stop-pos' or at some
3223 ;; ;; position further back if `stop-pos' was at a
3224 ;; ;; syntactically irrelevant place.
3225 ;;
3226 ;; ;; Skip additional syntactic ws so that we don't stop
3227 ;; ;; at the end of a comment if `skip-chars' is
3228 ;; ;; something like "^/".
3229 ;; (c-backward-syntactic-ws)
3230 ;;
3231 ;; (< (point) stop-pos))))
3232 ;;
3233 ;; ;; We might want to extend this with more useful return values
3234 ;; ;; in the future.
3235 ;; (/= (point) start))))
3237 \f
3238 ;; Tools for handling comments and string literals.
3241 "Return the type of literal point is in, if any.
3242 The return value is `c' if in a C-style comment, `c++' if in a C++
3243 style comment, `string' if in a string literal, `pound' if DETECT-CPP
3244 is non-nil and in a preprocessor line, or nil if somewhere else.
3245 Optional LIM is used as the backward limit of the search. If omitted,
3246 or nil, `c-beginning-of-defun' is used.
3248 The last point calculated is cached if the cache is enabled, i.e. if
3249 `c-in-literal-cache' is bound to a two element vector.
3251 Note that this function might do hidden buffer changes. See the
3252 comment at the start of cc-engine.el for more info."
3268 ;; cache this result if the cache is enabled
3271 rtn)))
3273 ;; XEmacs has a built-in function that should make this much quicker.
3274 ;; I don't think we even need the cache, which makes our lives more
3275 ;; complicated anyway. In this case, lim is only used to detect
3276 ;; cpp directives.
3277 ;;
3278 ;; Note that there is a bug in Xemacs's buffer-syntactic-context when used in
3279 ;; conjunction with syntax-table-properties. The bug is present in, e.g.,
3280 ;; Xemacs 21.4.4. It manifested itself thus:
3281 ;;
3282 ;; Starting with an empty AWK Mode buffer, type
3283 ;; /regexp/ {<C-j>
3284 ;; Point gets wrongly left at column 0, rather than being indented to tab-width.
3285 ;;
3286 ;; AWK Mode is designed such that when the first / is typed, it gets the
3287 ;; syntax-table property "string fence". When the second / is typed, BOTH /s
3288 ;; are given the s-t property "string". However, buffer-syntactic-context
3289 ;; fails to take account of the change of the s-t property on the opening / to
3290 ;; "string", and reports that the { is within a string started by the second /.
3291 ;;
3292 ;; The workaround for this is for the AWK Mode initialisation to switch the
3293 ;; defalias for c-in-literal to c-slow-in-literal. This will slow down other
3294 ;; cc-modes in Xemacs whenever an awk-buffer has been initialised.
3295 ;;
3296 ;; (Alan Mackenzie, 2003/4/30).
3299 ;; This function might do hidden buffer changes.
3312 ;; The defalias above isn't enough to shut up the byte compiler.
3316 "Return a cons of the beginning and end positions of the comment or
3317 string surrounding point (including both delimiters), or nil if point
3319 to start parsing from. If NEAR is non-nil, then the limits of any
3321 spaces and tabs between point and the literal. The search for such a
3322 literal is done first in forward direction. If NOT-IN-DELIMITER is
3323 non-nil, the case when point is inside a starting delimiter won't be
3324 recognized. This only has effect for comments, which have starting
3325 delimiters with more than one character.
3327 Note that this function might do hidden buffer changes. See the
3328 comment at the start of cc-engine.el for more info."
3350 ;; We're standing in a comment starter.
3357 ;; Search forward for a literal.
3369 ;; Search backward.
3380 ;; Block comment. Due to the nature of line
3381 ;; comments, they will always be covered by the
3382 ;; normal case above.
3385 ;; If LIM is bogus, beg will be bogus.
3389 ))))
3391 ;; In case external callers use this; it did have a docstring.
3395 "If the argument is a cons of two buffer positions (such as returned by
3396 `c-literal-limits'), and that range contains a C++ style line comment,
3397 then an extended range is returned that contains all adjacent line
3398 comments (i.e. all comments that starts in the same column with no
3399 empty lines or non-whitespace characters between them). Otherwise the
3400 argument is returned.
3402 Note that this function might do hidden buffer changes. See the
3403 comment at the start of cc-engine.el for more info."
3414 ;; Got to take care in the backward direction to handle
3415 ;; comments which are preceded by code.
3429 range)
3433 "Convenience function that given the result of `c-literal-limits',
3434 returns nil or the type of literal that the range surrounds. It's
3435 much faster than using `c-in-literal' and is intended to be used when
3436 you need both the type of a literal and its limits.
3438 Note that this function might do hidden buffer changes. See the
3439 comment at the start of cc-engine.el for more info."
3450 range))
3452 \f
3453 ;; `c-find-decl-spots' and accompanying stuff.
3455 ;; Variables used in `c-find-decl-spots' to cache the search done for
3456 ;; the first declaration in the last call. When that function starts,
3457 ;; it needs to back up over syntactic whitespace to look at the last
3458 ;; token before the region being searched. That can sometimes cause
3459 ;; moves back and forth over a quite large region of comments and
3460 ;; macros, which would be repeated for each changed character when
3461 ;; we're called during fontification, since font-lock refontifies the
3462 ;; current line for each change. Thus it's worthwhile to cache the
3463 ;; first match.
3464 ;;
3465 ;; `c-find-decl-syntactic-pos' is a syntactically relevant position in
3466 ;; the syntactic whitespace less or equal to some start position.
3467 ;; There's no cached value if it's nil.
3468 ;;
3469 ;; `c-find-decl-match-pos' is the match position if
3470 ;; `c-find-decl-prefix-search' matched before the syntactic whitespace
3471 ;; at `c-find-decl-syntactic-pos', or nil if there's no such match.
3482 ; (defface c-debug-decl-spot-face
3483 ; '((t (:background "Turquoise")))
3484 ; "Debug face to mark the spots where `c-find-decl-spots' stopped.")
3485 ; (defface c-debug-decl-sws-face
3486 ; '((t (:background "Khaki")))
3487 ; "Debug face to mark the syntactic whitespace between the declaration
3488 ; spots and the preceding token end.")
3504 ;; Macro used inside `c-find-decl-spots'. It ought to be a defun,
3505 ;; but it contains lots of free variables that refer to things
3506 ;; inside `c-find-decl-spots'. The point is left at `cfd-match-pos'
3507 ;; if there is a match, otherwise at `cfd-limit'.
3508 ;;
3509 ;; This macro might do hidden buffer changes.
3512 ;; Find the next property match position if we haven't got one already.
3523 ;; Find the next `c-decl-prefix-or-start-re' match if we haven't
3524 ;; got one already.
3534 ;; Match. Check if it's inside a comment or string literal.
3537 ;; Matched the end of a token preceding a decl spot.
3541 ;; Matched a token that start a decl spot.
3544 c-literal-faces)
3546 ;; No match. Finish up and exit the loop.
3548 nil)
3550 ;; Skip out of comments and string literals.
3557 ;; If we matched at the decl start, we have to back up over the
3558 ;; preceding syntactic ws to set `cfd-match-pos' and to catch
3559 ;; any decl spots in the syntactic ws.
3564 ;; Choose whichever match is closer to the start.
3567 cfd-re-match nil)
3569 cfd-prop-match nil))
3574 ;; Skip forward past comments only so we don't skip macros.
3576 ;; Set the position to continue at. We can avoid going over
3577 ;; the comments skipped above a second time, but it's possible
3578 ;; that the comment skipping has taken us past `cfd-prop-match'
3579 ;; since the property might be used inside comments.
3585 ;; Call CFD-FUN for each possible spot for a declaration, cast or
3586 ;; label from the point to CFD-LIMIT. Such a spot is:
3587 ;;
3588 ;; o The first token after bob.
3589 ;; o The first token after the end of submatch 1 in
3590 ;; `c-decl-prefix-or-start-re' when that submatch matches.
3591 ;; o The start of each `c-decl-prefix-or-start-re' match when
3592 ;; submatch 1 doesn't match.
3593 ;; o The first token after the end of each occurence of the
3594 ;; `c-type' text property with the value `c-decl-end', provided
3595 ;; `c-type-decl-end-used' is set.
3596 ;;
3597 ;; Only a spot that match CFD-DECL-RE and whose face is in the
3598 ;; CFD-FACE-CHECKLIST list causes CFD-FUN to be called. The face
3599 ;; check is disabled if CFD-FACE-CHECKLIST is nil.
3600 ;;
3601 ;; If the match is inside a macro then the buffer is narrowed to the
3602 ;; end of it, so that CFD-FUN can investigate the following tokens
3603 ;; without matching something that begins inside a macro and ends
3604 ;; outside it. It's to avoid this work that the CFD-DECL-RE and
3605 ;; CFD-FACE-CHECKLIST checks exist.
3606 ;;
3607 ;; CFD-FUN is called with point at the start of the spot. It's
3608 ;; passed two arguments: The first is the end position of the token
3609 ;; preceding the spot, or 0 for the implicit match at bob. The
3610 ;; second is a flag that is t when the match is inside a macro. If
3611 ;; CFD-FUN adds `c-decl-end' properties somewhere below the current
3612 ;; spot, it should return non-nil to ensure that the next search
3613 ;; will find them.
3614 ;;
3615 ;; The spots are visited approximately in order from top to bottom.
3616 ;; It's however the positions where `c-decl-prefix-or-start-re'
3617 ;; matches and where `c-decl-end' properties are found that are in
3618 ;; order. Since the spots often are at the following token, they
3619 ;; might be visited out of order insofar as more spots are reported
3620 ;; later on within the syntactic whitespace between the match
3621 ;; positions and their spots.
3622 ;;
3623 ;; It's assumed that comments and strings are fontified in the
3624 ;; searched range.
3625 ;;
3626 ;; This is mainly used in fontification, and so has an elaborate
3627 ;; cache to handle repeated calls from the same start position; see
3628 ;; the variables above.
3629 ;;
3630 ;; All variables in this function begin with `cfd-' to avoid name
3631 ;; collision with the (dynamically bound) variables used in CFD-FUN.
3632 ;;
3633 ;; This function might do hidden buffer changes.
3637 ;; The end of the token preceding the decl spot last found
3638 ;; with `c-decl-prefix-or-start-re'. `cfd-limit' if there's
3639 ;; no match.
3640 cfd-re-match
3641 ;; The end position of the last `c-decl-prefix-or-start-re'
3642 ;; match. If this is greater than `cfd-continue-pos', the
3643 ;; next regexp search is started here instead.
3645 ;; The end of the last `c-decl-end' found by
3646 ;; `c-find-decl-prefix-search'. `cfd-limit' if there's no
3647 ;; match. If searching for the property isn't needed then we
3648 ;; disable it by setting it to `cfd-limit' directly.
3650 ;; The end of the token preceding the decl spot last found by
3651 ;; `c-find-decl-prefix-search'. 0 for the implicit match at
3652 ;; bob. `cfd-limit' if there's no match. In other words,
3653 ;; this is the minimum of `cfd-re-match' and `cfd-prop-match'.
3655 ;; The position to continue searching at.
3656 cfd-continue-pos
3657 ;; The position of the last "real" token we've stopped at.
3658 ;; This can be greater than `cfd-continue-pos' when we get
3659 ;; hits inside macros or at `c-decl-end' positions inside
3660 ;; comments.
3662 ;; The end position of the last entered macro.
3665 ;; Initialize by finding a syntactically relevant start position
3666 ;; before the point, and do the first `c-decl-prefix-or-start-re'
3667 ;; search unless we're at bob.
3670 ;; Must back up a bit since we look for the end of the previous
3671 ;; statement or declaration, which is earlier than the first
3672 ;; returned match.
3675 ;; First we need to move to a syntactically relevant position.
3676 ;; Begin by backing out of comment or string literals.
3679 ;; Try to use the faces to back up to the start of the
3680 ;; literal. FIXME: What if the point is on a declaration
3681 ;; inside a comment?
3687 ;; XEmacs doesn't fontify the quotes surrounding string
3688 ;; literals.
3697 ;; Don't trust the literal to contain only literal faces
3698 ;; (the font lock package might not have fontified the
3699 ;; start of it at all, for instance) so check that we have
3700 ;; arrived at something that looks like a start or else
3701 ;; resort to `c-literal-limits'.
3708 ;; The start is in a literal. If the limit is in the same
3709 ;; one we don't have to find a syntactic position etc. We
3710 ;; only check that if the limit is at or before bonl to save
3711 ;; time; it covers the by far most common case when font-lock
3712 ;; refontifies the current line only.
3723 ;; Completely inside a literal. Set up variables to trig the
3724 ;; (< cfd-continue-pos cfd-start-pos) case below and it'll
3725 ;; find a suitable start position.
3728 ;; Check if the region might be completely inside a macro, to
3729 ;; optimize that like the completely-inside-literal above.
3736 ;; (Maybe) completely inside a macro. Only need to trig the
3737 ;; (< cfd-continue-pos cfd-start-pos) case below to make it
3738 ;; set things up.
3740 start-in-macro t))
3743 ;; Back out of any macro so we don't miss any declaration
3744 ;; that could follow after it.
3748 ;; Now we're at a proper syntactically relevant position so we
3749 ;; can use the cache. But first clear it if it applied
3750 ;; further down.
3755 ;; Don't have to do this if the cache is relevant here,
3756 ;; typically if the same line is refontified again. If
3757 ;; we're just some syntactic whitespace further down we can
3758 ;; still use the cache to limit the skipping.
3761 ;; If we hit `c-find-decl-syntactic-pos' and
3762 ;; `c-find-decl-match-pos' is set then we install the cached
3763 ;; values. If we hit `c-find-decl-syntactic-pos' and
3764 ;; `c-find-decl-match-pos' is nil then we know there's no decl
3765 ;; prefix in the whitespace before `c-find-decl-syntactic-pos'
3766 ;; and so we can continue the search from this point. If we
3767 ;; didn't hit `c-find-decl-syntactic-pos' then we're now in
3768 ;; the right spot to begin searching anyway.
3770 c-find-decl-match-pos)
3772 cfd-continue-pos syntactic-pos)
3777 ;; Always consider bob a match to get the first
3778 ;; declaration in the file. Do this separately instead of
3779 ;; letting `c-decl-prefix-or-start-re' match bob, so that
3780 ;; regexp always can consume at least one character to
3781 ;; ensure that we won't get stuck in an infinite loop.
3786 ;; Do an initial search now. In the bob case above it's
3787 ;; only done to search for a `c-decl-end' spot.
3791 cfd-match-pos)))))
3793 ;; Advance `cfd-continue-pos' if it's before the start position.
3794 ;; The closest continue position that might have effect at or
3795 ;; after the start depends on what we started in. This also
3796 ;; finds a suitable start position in the special cases when the
3797 ;; region is completely within a literal or macro.
3802 ;; If we're in a macro then it's the closest preceding token
3803 ;; in the macro. Check this before `start-in-literal',
3804 ;; since if we're inside a literal in a macro, the preceding
3805 ;; token is earlier than any `c-decl-end' spot inside the
3806 ;; literal (comment).
3808 ;; The only syntactic ws in macros are comments.
3814 ;; If we're in a comment it can only be the closest
3815 ;; preceding `c-decl-end' position within that comment, if
3816 ;; any. Go back to the beginning of such a property so that
3817 ;; `c-find-decl-prefix-search' will find the end of it.
3818 ;; (Can't stop at the end and install it directly on
3819 ;; `cfd-prop-match' since that variable might be cleared
3820 ;; after `cfd-fun' below.)
3821 ;;
3822 ;; Note that if the literal is a string then the property
3823 ;; search will simply skip to the beginning of it right
3824 ;; away.
3836 ;; Didn't find any property inside the comment, so we can
3837 ;; skip it entirely. (This won't skip past a string, but
3838 ;; that'll be handled quickly by the next
3839 ;; `c-find-decl-prefix-search' anyway.)
3845 ;; If we started in normal code, the only match that might
3846 ;; apply before the start is what we already got in
3847 ;; `cfd-match-pos' so we can continue at the start position.
3848 ;; (Note that we don't get here if the first match is below
3849 ;; it.)
3852 ;; Delete found matches if they are before our new continue
3853 ;; position, so that `c-find-decl-prefix-search' won't back up
3854 ;; to them later on.
3862 ;; This is the normal case and we got a proper syntactic
3863 ;; position. If there's a match then it's always outside
3864 ;; macros and comments, so advance to the next token and set
3865 ;; `cfd-token-pos'. The loop below will later go back using
3866 ;; `cfd-continue-pos' to fix declarations inside the
3867 ;; syntactic ws.
3875 ;; Have one of the special cases when the region is completely
3876 ;; within a literal or macro. `cfd-continue-pos' is set to a
3877 ;; good start position for the search, so do it.
3880 ;; Now loop. Round what? (ACM, 2006/7/5). We already got the first match.
3887 ;; Kludge to filter out matches on the "<" that
3888 ;; aren't open parens, for the sake of languages
3889 ;; that got `c-recognize-<>-arglists' set.
3894 ;; If `cfd-continue-pos' is less or equal to
3895 ;; `cfd-token-pos', we've got a hit inside a macro
3896 ;; that's in the syntactic whitespace before the last
3897 ;; "real" declaration we've checked. If they're equal
3898 ;; we've arrived at the declaration a second time, so
3899 ;; there's nothing to do.
3903 ;; If `cfd-continue-pos' is less than `cfd-token-pos'
3904 ;; we're still searching for declarations embedded in
3905 ;; the syntactic whitespace. In that case we need
3906 ;; only to skip comments and not macros, since they
3907 ;; can't be nested, and that's already been done in
3908 ;; `c-find-decl-prefix-search'.
3913 ;; Continue if the following token fails the
3914 ;; CFD-DECL-RE and CFD-FACE-CHECKLIST checks.
3921 t)))
3932 ;; Narrow to the end of the macro if we got a hit inside
3933 ;; one, to avoid recognizing things that start inside the
3934 ;; macro and end outside it.
3936 ;; Not in the same macro as in the previous round.
3947 t
3950 t)
3951 ;; The matched token was the last thing in the macro,
3952 ;; so the whole match is bogus.
3954 nil))))
3961 ;; Restore limits if we did macro narrowment above.
3969 \f
3970 ;; A cache for found types.
3972 ;; Buffer local variable that contains an obarray with the types we've
3973 ;; found. If a declaration is recognized somewhere we record the
3974 ;; fully qualified identifier in it to recognize it as a type
3975 ;; elsewhere in the file too. This is not accurate since we do not
3976 ;; bother with the scoping rules of the languages, but in practice the
3977 ;; same name is seldom used as both a type and something else in a
3978 ;; file, and we only use this as a last resort in ambiguous cases (see
3979 ;; `c-forward-decl-or-cast-1').
3980 ;;
3981 ;; Not every type need be in this cache. However, things which have
3982 ;; ceased to be types must be removed from it.
3983 ;;
3984 ;; Template types in C++ are added here too but with the template
3985 ;; arglist replaced with "<>" in references or "<" for the one in the
3986 ;; primary type. E.g. the type "Foo<A,B>::Bar<C>" is stored as
3987 ;; "Foo<>::Bar<". This avoids storing very long strings (since C++
3988 ;; template specs can be fairly sized programs in themselves) and
3989 ;; improves the hit ratio (it's a type regardless of the template
3990 ;; args; it's just not the same type, but we're only interested in
3991 ;; recognizing types, not telling distinct types apart). Note that
3992 ;; template types in references are added here too; from the example
3993 ;; above there will also be an entry "Foo<".
3998 ;; Clears `c-found-types'.
4002 ;; Add the given region as a type in `c-found-types'. If the region
4003 ;; doesn't match an existing type but there is a type which is equal
4004 ;; to the given one except that the last character is missing, then
4005 ;; the shorter type is removed. That's done to avoid adding all
4006 ;; prefixes of a type as it's being entered and font locked. This
4007 ;; doesn't cover cases like when characters are removed from a type
4008 ;; or added in the middle. We'd need the position of point when the
4009 ;; font locking is invoked to solve this well.
4010 ;;
4011 ;; This function might do hidden buffer changes.
4018 ;; Remove the "NAME" from c-found-types, if present.
4022 ;; Return non-nil if the given region contains a type in
4023 ;; `c-found-types'.
4024 ;;
4025 ;; This function might do hidden buffer changes.
4027 c-found-types))
4030 ;; Return all the types in `c-found-types' as a sorted list of
4031 ;; strings.
4035 type-list)))
4036 c-found-types)
4040 ;; An after change function which, in conjunction with the info in
4041 ;; c-maybe-stale-found-type (set in c-before-change), removes a type
4042 ;; from `c-found-types', should this type have become stale. For
4043 ;; example, this happens to "foo" when "foo \n bar();" becomes
4044 ;; "foo(); \n bar();". Such stale types, if not removed, foul up
4045 ;; the fontification.
4046 ;;
4047 ;; Have we, perhaps, added non-ws characters to the front/back of a found
4048 ;; type?
4068 ;; Changing the amount of (already existing) whitespace - don't do anything.
4073 ;; The syntactic relationship which defined a "found type" has been
4074 ;; destroyed.
4077 ;; ((eq (car c-maybe-stale-found-type) 'c-decl-type-start) FIXME!!!
4078 )))
4080 \f
4081 ;; Handling of small scale constructs like types and names.
4084 ;; This is called from `after-change-functions' when
4085 ;; c-recognize-<>-arglists' is set. It ensures that no "<" or ">"
4086 ;; chars with paren syntax become part of another operator like "<<"
4087 ;; or ">=".
4088 ;;
4089 ;; This function might do hidden buffer changes.
4121 ;; Dynamically bound variable that instructs `c-forward-type' to also
4122 ;; treat possible types (i.e. those that it normally returns 'maybe or
4123 ;; 'found for) as actual types (and always return 'found for them).
4124 ;; This means that it records them in `c-record-type-identifiers' if
4125 ;; that is set, and that it adds them to `c-found-types'.
4128 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
4129 ;; mark up successfully parsed arglists with paren syntax properties on
4130 ;; the surrounding angle brackets and with `c-<>-arg-sep' in the
4131 ;; `c-type' property of each argument separating comma.
4132 ;;
4133 ;; Setting this variable also makes `c-forward-<>-arglist' recurse into
4134 ;; all arglists for side effects (i.e. recording types), otherwise it
4135 ;; exploits any existing paren syntax properties to quickly jump to the
4136 ;; end of already parsed arglists.
4137 ;;
4138 ;; Marking up the arglists is not the default since doing that correctly
4139 ;; depends on a proper value for `c-restricted-<>-arglists'.
4142 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
4143 ;; not accept arglists that contain binary operators.
4144 ;;
4145 ;; This is primarily used to handle C++ template arglists. C++
4146 ;; disambiguates them by checking whether the preceding name is a
4147 ;; template or not. We can't do that, so we assume it is a template
4148 ;; if it can be parsed as one. That usually works well since
4149 ;; comparison expressions on the forms "a < b > c" or "a < b, c > d"
4150 ;; in almost all cases would be pointless.
4151 ;;
4152 ;; However, in function arglists, e.g. in "foo (a < b, c > d)", we
4153 ;; should let the comma separate the function arguments instead. And
4154 ;; in a context where the value of the expression is taken, e.g. in
4155 ;; "if (a < b || c > d)", it's probably not a template.
4158 ;; Dynamically bound variables that instructs
4159 ;; `c-forward-keyword-clause', `c-forward-<>-arglist',
4160 ;; `c-forward-name', `c-forward-type', `c-forward-decl-or-cast-1', and
4161 ;; `c-forward-label' to record the ranges of all the type and
4162 ;; reference identifiers they encounter. They will build lists on
4163 ;; these variables where each element is a cons of the buffer
4164 ;; positions surrounding each identifier. This recording is only
4165 ;; activated when `c-record-type-identifiers' is non-nil.
4166 ;;
4167 ;; All known types that can't be identifiers are recorded, and also
4168 ;; other possible types if `c-promote-possible-types' is set.
4169 ;; Recording is however disabled inside angle bracket arglists that
4170 ;; are encountered inside names and other angle bracket arglists.
4171 ;; Such occurrences are taken care of by `c-font-lock-<>-arglists'
4172 ;; instead.
4173 ;;
4174 ;; Only the names in C++ template style references (e.g. "tmpl" in
4175 ;; "tmpl<a,b>::foo") are recorded as references, other references
4176 ;; aren't handled here.
4177 ;;
4178 ;; `c-forward-label' records the label identifier(s) on
4179 ;; `c-record-ref-identifiers'.
4183 ;; This variable will receive a cons cell of the range of the last
4184 ;; single identifier symbol stepped over by `c-forward-name' if it's
4185 ;; successful. This is the range that should be put on one of the
4186 ;; record lists above by the caller. It's assigned nil if there's no
4187 ;; such symbol in the name.
4192 ;; Always true.
4202 ;; Always true.
4210 ;; Dynamically bound variable that instructs `c-forward-type' to
4211 ;; record the ranges of types that only are found. Behaves otherwise
4212 ;; like `c-record-type-identifiers'.
4216 ;; Used internally in `c-forward-keyword-clause' to move forward
4217 ;; over a type (if TYPE is 'type) or a name (otherwise) which
4218 ;; possibly is prefixed by keywords and their associated clauses.
4219 ;; Try with a type/name first to not trip up on those that begin
4220 ;; with a keyword. Return t if a known or found type is moved
4221 ;; over. The point is clobbered if nil is returned. If range
4222 ;; recording is enabled, the identifier is recorded on as a type
4223 ;; if TYPE is 'type or as a reference if TYPE is 'ref.
4224 ;;
4225 ;; This macro might do hidden buffer changes.
4230 nil
4237 t)))
4240 ;; Used internally in `c-forward-keyword-clause' to move forward
4241 ;; over a comma separated list of types or names using
4242 ;; `c-forward-keyword-prefixed-id'.
4243 ;;
4244 ;; This macro might do hidden buffer changes.
4255 ;; Submatch MATCH in the current match data is assumed to surround a
4256 ;; token. If it's a keyword, move over it and any immediately
4257 ;; following clauses associated with it, stopping at the start of
4258 ;; the next token. t is returned in that case, otherwise the point
4259 ;; stays and nil is returned. The kind of clauses that are
4260 ;; recognized are those specified by `c-type-list-kwds',
4261 ;; `c-ref-list-kwds', `c-colon-type-list-kwds',
4262 ;; `c-paren-nontype-kwds', `c-paren-type-kwds', `c-<>-type-kwds',
4263 ;; and `c-<>-arglist-kwds'.
4264 ;;
4265 ;; This function records identifier ranges on
4266 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
4267 ;; `c-record-type-identifiers' is non-nil.
4268 ;;
4269 ;; Note that for `c-colon-type-list-kwds', which doesn't necessary
4270 ;; apply directly after the keyword, the type list is moved over
4271 ;; only when there is no unaccounted token before it (i.e. a token
4272 ;; that isn't moved over due to some other keyword list). The
4273 ;; identifier ranges in the list are still recorded if that should
4274 ;; be done, though.
4275 ;;
4276 ;; This function might do hidden buffer changes.
4279 ;; The call to `c-forward-<>-arglist' below is made after
4280 ;; `c-<>-sexp-kwds' keywords, so we're certain they actually
4281 ;; are angle bracket arglists and `c-restricted-<>-arglists'
4282 ;; should therefore be nil.
4294 ;; There's a type directly after a keyword in `c-type-list-kwds'.
4299 ;; There's a name directly after a keyword in `c-ref-list-kwds'.
4304 ;; There's an open paren after a keyword in `c-paren-any-kwds'.
4311 ;; Use `c-forward-type' on every identifier we can find
4312 ;; inside the paren, to record the types.
4337 ;; If we are at the colon already, we move over the type
4338 ;; list after it.
4344 ;; Not at the colon, so stop here. But the identifier
4345 ;; ranges in the type list later on should still be
4346 ;; recorded.
4349 ;; If a keyword matched both one of the types above and
4350 ;; this one, we match `c-colon-type-list-re' after the
4351 ;; clause matched above.
4358 ;; There's a type after the `c-colon-type-list-re' match
4359 ;; after a keyword in `c-colon-type-list-kwds'.
4363 t)))
4366 ;; The point is assumed to be at a "<". Try to treat it as the open
4367 ;; paren of an angle bracket arglist and move forward to the the
4368 ;; corresponding ">". If successful, the point is left after the
4369 ;; ">" and t is returned, otherwise the point isn't moved and nil is
4370 ;; returned. If ALL-TYPES is t then all encountered arguments in
4371 ;; the arglist that might be types are treated as found types.
4372 ;;
4373 ;; The variable `c-parse-and-markup-<>-arglists' controls how this
4374 ;; function handles text properties on the angle brackets and argument
4375 ;; separating commas.
4376 ;;
4377 ;; `c-restricted-<>-arglists' controls how lenient the template
4378 ;; arglist recognition should be.
4379 ;;
4380 ;; This function records identifier ranges on
4381 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
4382 ;; `c-record-type-identifiers' is non-nil.
4383 ;;
4384 ;; This function might do hidden buffer changes.
4387 ;; If `c-record-type-identifiers' is set then activate
4388 ;; recording of any found types that constitute an argument in
4389 ;; the arglist.
4397 ;; `nconc' doesn't mind that the tail of
4398 ;; `c-record-found-types' is t.
4400 t)
4403 nil)))
4406 ;; Recursive part of `c-forward-<>-arglist'.
4407 ;;
4408 ;; This function might do hidden buffer changes.
4411 ;; Cover this so that any recorded found type ranges are
4412 ;; automatically lost if it turns out to not be an angle
4413 ;; bracket arglist. It's propagated through the return value
4414 ;; on successful completion.
4416 ;; List that collects the positions after the argument
4417 ;; separating ',' in the arglist.
4418 arg-start-pos)
4420 ;; If the '<' has paren open syntax then we've marked it as an angle
4421 ;; bracket arglist before, so skip to the end.
4429 t
4431 ;; Got unmatched paren angle brackets. We don't clear the paren
4432 ;; syntax properties and retry, on the basis that it's very
4433 ;; unlikely that paren angle brackets become operators by code
4434 ;; manipulation. It's far more likely that it doesn't match due
4435 ;; to narrowing or some temporary change.
4437 nil))
4447 ;; All encountered identifiers are types, so set the
4448 ;; promote flag and parse the type.
4455 ;; Check if this arglist argument is a sole type. If
4456 ;; it's known then it's recorded in
4457 ;; `c-record-type-identifiers'. If it only is found
4458 ;; then it's recorded in `c-record-found-types' which we
4459 ;; might roll back if it turns out that this isn't an
4460 ;; angle bracket arglist afterall.
4466 ;; A found type was recorded but it's not the
4467 ;; only thing in the arglist argument, so reset
4468 ;; `c-record-found-types'.
4470 orig-record-found-types))))))
4474 ;; Must check for '>' at the very start separately,
4475 ;; since the regexp below has to avoid ">>" without
4476 ;; using \\=.
4478 t)
4480 ;; Note: These regexps exploit the match order in \| so
4481 ;; that "<>" is matched by "<" rather than "[^>:-]>".
4484 ;; Stop on ',', '|', '&', '+' and '-' to catch
4485 ;; common binary operators that could be between
4486 ;; two comparison expressions "a<b" and "c>d".
4488 ;; Otherwise we still stop on ',' to find the
4489 ;; argument start positions.
4493 ;; If the arglist starter has lost its open paren
4494 ;; syntax but not the closer, we won't find the
4495 ;; closer above since we only search in the
4496 ;; balanced sexp. In that case we stop just short
4497 ;; of it so check if the following char is the closer.
4500 t)))
4504 ;; Either an operator starting with '>' or the end of
4505 ;; the angle bracket arglist.
4512 ;; The angle bracket arglist is finished.
4524 ;; Either an operator starting with '<' or a nested arglist.
4536 ;; There's always an identifier before an angle
4537 ;; bracket arglist, or a keyword in
4538 ;; `c-<>-type-kwds' or `c-<>-arglist-kwds'.
4555 )))
4557 ;; It was not an angle bracket arglist.
4560 ;; It was an angle bracket arglist.
4563 ;; Record the identifier before the template as a type
4564 ;; or reference depending on whether the arglist is last
4565 ;; in a qualified identifier.
4574 t)
4578 ;; Just another argument. Record the position. The
4579 ;; type check stuff that made us stop at it is at
4580 ;; the top of the loop.
4584 ;; Got a character that can't be in an angle bracket
4585 ;; arglist argument. Abort using `throw', since
4586 ;; it's useless to try to find a surrounding arglist
4587 ;; if we're nested.
4594 ;; The point is assumed to be directly after a ">". Try to treat it
4595 ;; as the close paren of an angle bracket arglist and move back to
4596 ;; the corresponding "<". If successful, the point is left at
4597 ;; the "<" and t is returned, otherwise the point isn't moved and
4598 ;; nil is returned. ALL-TYPES is passed on to
4599 ;; `c-forward-<>-arglist'.
4600 ;;
4601 ;; If the optional LIMIT is given, it bounds the backward search.
4602 ;; It's then assumed to be at a syntactically relevant position.
4603 ;;
4604 ;; This is a wrapper around `c-forward-<>-arglist'. See that
4605 ;; function for more details.
4614 t
4615 ;; See corresponding note in `c-forward-<>-arglist'.
4617 nil)
4624 t
4625 ;; Stopped at bob or a char that isn't allowed in an
4626 ;; arglist, so we've failed.
4628 nil)
4633 ;; If we moved then the "<" was part of some
4634 ;; multicharacter token.
4635 t
4641 ;; Matched the arglist. Break the while.
4643 nil)
4645 ;; We started from a non-paren ">" inside an
4646 ;; arglist.
4648 nil)
4650 ;; Matched a shorter arglist. Can be a nested
4651 ;; one so continue looking.
4653 t))
4654 t))))))
4659 ;; Move forward over a complete name if at the beginning of one,
4660 ;; stopping at the next following token. If the point is not at
4661 ;; something that are recognized as name then it stays put. A name
4662 ;; could be something as simple as "foo" in C or something as
4663 ;; complex as "X<Y<class A<int>::B, BIT_MAX >> b>, ::operator<> ::
4664 ;; Z<(a>b)> :: operator const X<&foo>::T Q::G<unsigned short
4665 ;; int>::*volatile const" in C++ (this function is actually little
4666 ;; more than a `looking-at' call in all modes except those that,
4667 ;; like C++, have `c-recognize-<>-arglists' set). Return nil if no
4668 ;; name is found, 'template if it's an identifier ending with an
4669 ;; angle bracket arglist, 'operator of it's an operator identifier,
4670 ;; or t if it's some other kind of name.
4671 ;;
4672 ;; This function records identifier ranges on
4673 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
4674 ;; `c-record-type-identifiers' is non-nil.
4675 ;;
4676 ;; This function might do hidden buffer changes.
4679 ;; Turn off `c-promote-possible-types' here since we might
4680 ;; call `c-forward-<>-arglist' and we don't want it to promote
4681 ;; every suspect thing in the arglist to a type. We're
4682 ;; typically called from `c-forward-type' in this case, and
4683 ;; the caller only wants the top level type that it finds to
4684 ;; be promoted.
4685 c-promote-possible-types)
4691 ;; Check for keyword. We go to the last symbol in
4692 ;; `c-identifier-key' first.
4705 ;; "template" is only valid inside an
4706 ;; identifier if preceded by "::".
4711 t))
4713 ;; Handle a C++ operator or template identifier.
4717 ;; Got "... ::template".
4721 res subres))))
4724 ;; Got a cast operator.
4728 ;; Now we should match a sequence of either
4729 ;; '*', '&' or a name followed by ":: *",
4730 ;; where each can be followed by a sequence
4731 ;; of `c-opt-type-modifier-key'.
4734 t)
4744 t))))
4752 ;; Got some other operator.
4760 nil)
4762 ;; `id-start' is equal to `id-end' if we've jumped over
4763 ;; an identifier that doesn't end with a symbol token.
4764 ;; That can occur e.g. for Java import directives on the
4765 ;; form "foo.bar.*".
4772 res t)))
4782 ;; Got a concatenated identifier. This handles the
4783 ;; cases with tricky syntactic whitespace that aren't
4784 ;; covered in `c-identifier-key'.
4787 t)
4791 ;; Maybe an angle bracket arglist.
4794 c-record-found-types)
4800 c-last-identifier-range nil)
4805 ;; Continue if there's an identifier concatenation
4806 ;; operator after the template argument.
4812 t)
4817 nil)))
4818 )))))
4821 res))
4824 ;; Move forward over a type spec if at the beginning of one,
4825 ;; stopping at the next following token. Return t if it's a known
4826 ;; type that can't be a name or other expression, 'known if it's an
4827 ;; otherwise known type (according to `*-font-lock-extra-types'),
4828 ;; 'prefix if it's a known prefix of a type, 'found if it's a type
4829 ;; that matches one in `c-found-types', 'maybe if it's an identfier
4830 ;; that might be a type, or nil if it can't be a type (the point
4831 ;; isn't moved then). The point is assumed to be at the beginning
4832 ;; of a token.
4833 ;;
4834 ;; Note that this function doesn't skip past the brace definition
4835 ;; that might be considered part of the type, e.g.
4836 ;; "enum {a, b, c} foo".
4837 ;;
4838 ;; This function records identifier ranges on
4839 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
4840 ;; `c-record-type-identifiers' is non-nil.
4841 ;;
4842 ;; This function might do hidden buffer changes.
4846 ;; Skip leading type modifiers. If any are found we know it's a
4847 ;; prefix of a type.
4856 ;; Looking at a keyword that prefixes a type identifier,
4857 ;; e.g. "class".
4864 ;; In many languages the name can be used without the
4865 ;; prefix, so we add it to `c-found-types'.
4868 c-last-identifier-range)
4871 ;; Invalid syntax.
4883 id-range c-last-identifier-range))))
4895 id-end)
4897 ;; Looking at a primitive or known type identifier. We've
4898 ;; checked for a name first so that we don't go here if the
4899 ;; known type match only is a prefix of another name.
4910 ;; There might be more keywords for the type.
4938 ;; A normal identifier.
4948 ;; It's an identifier that has been used as
4949 ;; a type somewhere else.
4950 'found
4951 ;; It's an identifier that might be a type.
4954 ;; A template is a type.
4958 ;; Otherwise it's an operator identifier, which is not a type.
4963 ;; Skip trailing type modifiers. If any are found we know it's
4964 ;; a type.
4971 ;; Step over any type suffix operator. Do not let the existence
4972 ;; of these alter the classification of the found type, since
4973 ;; these operators typically are allowed in normal expressions
4974 ;; too.
4981 ;; Look for a trailing operator that concatenates the type
4982 ;; with a following one, and if so step past that one through
4983 ;; a recursive call. Note that we don't record concatenated
4984 ;; types in `c-found-types' - it's the component types that
4985 ;; are recorded when appropriate.
4988 c-promote-possible-types))
4989 ;; If we can't promote then set `c-record-found-types' so that
4990 ;; we can merge in the types from the second part afterwards if
4991 ;; it turns out to be a known type there.
4994 subres)
5003 ;; If either operand certainly is a type then both are, but we
5004 ;; don't let the existence of the operator itself promote two
5005 ;; uncertain types to a certain one.
5024 ;; Merge in the ranges of any types found by the second
5025 ;; `c-forward-type'.
5027 ;; `nconc' doesn't mind that the tail of
5028 ;; `c-record-found-types' is t.
5030 c-record-type-identifiers))))
5038 ;;(message "c-forward-type %s -> %s: %s" start (point) res)
5040 res))
5042 \f
5043 ;; Handling of large scale constructs like statements and declarations.
5045 ;; Macro used inside `c-forward-decl-or-cast-1'. It ought to be a
5046 ;; defsubst or perhaps even a defun, but it contains lots of free
5047 ;; variables that refer to things inside `c-forward-decl-or-cast-1'.
5049 ;; `c-forward-decl-or-cast-1' can consume an arbitrary length list
5050 ;; of types when parsing a declaration, which means that it
5051 ;; sometimes consumes the identifier in the declaration as a type.
5052 ;; This is used to "backtrack" and make the last type be treated as
5053 ;; an identifier instead.
5056 ;; These identifiers are bound only in the inner let.
5058 identifier-start type-start
5059 got-parens nil
5060 got-identifier t
5061 got-suffix t
5062 got-suffix-after-parens id-start
5066 t
5067 backup-at-type))
5069 id-start backup-id-start)
5071 id-start start-pos))
5073 ;; When these flags already are set we've found specifiers that
5074 ;; unconditionally signal these attributes - backtracking doesn't
5075 ;; change that. So keep them set in that case.
5082 ;; This identifier is bound only in the inner let.
5086 ;; Move forward over a declaration or a cast if at the start of one.
5087 ;; The point is assumed to be at the start of some token. Nil is
5088 ;; returned if no declaration or cast is recognized, and the point
5089 ;; is clobbered in that case.
5090 ;;
5091 ;; If a declaration is parsed:
5092 ;;
5093 ;; The point is left at the first token after the first complete
5094 ;; declarator, if there is one. The return value is a cons where
5095 ;; the car is the position of the first token in the declarator. (See
5096 ;; below for the cdr.)
5097 ;; Some examples:
5098 ;;
5099 ;; void foo (int a, char *b) stuff ...
5100 ;; car ^ ^ point
5101 ;; float (*a)[], b;
5102 ;; car ^ ^ point
5103 ;; unsigned int a = c_style_initializer, b;
5104 ;; car ^ ^ point
5105 ;; unsigned int a (cplusplus_style_initializer), b;
5106 ;; car ^ ^ point (might change)
5107 ;; class Foo : public Bar {}
5108 ;; car ^ ^ point
5109 ;; class PikeClass (int a, string b) stuff ...
5110 ;; car ^ ^ point
5111 ;; enum bool;
5112 ;; car ^ ^ point
5113 ;; enum bool flag;
5114 ;; car ^ ^ point
5115 ;; void cplusplus_function (int x) throw (Bad);
5116 ;; car ^ ^ point
5117 ;; Foo::Foo (int b) : Base (b) {}
5118 ;; car ^ ^ point
5119 ;;
5120 ;; The cdr of the return value is non-nil iff a `c-typedef-decl-kwds'
5121 ;; specifier (e.g. class, struct, enum, typedef) is found in the
5122 ;; declaration, i.e. the declared identifier(s) are types.
5123 ;;
5124 ;; If a cast is parsed:
5125 ;;
5126 ;; The point is left at the first token after the closing paren of
5127 ;; the cast. The return value is `cast'. Note that the start
5128 ;; position must be at the first token inside the cast parenthesis
5129 ;; to recognize it.
5130 ;;
5131 ;; PRECEDING-TOKEN-END is the first position after the preceding
5132 ;; token, i.e. on the other side of the syntactic ws from the point.
5133 ;; Use a value less than or equal to (point-min) if the point is at
5134 ;; the first token in (the visible part of) the buffer.
5135 ;;
5136 ;; CONTEXT is a symbol that describes the context at the point:
5137 ;; 'decl In a comma-separated declaration context (typically
5138 ;; inside a function declaration arglist).
5139 ;; '<> In an angle bracket arglist.
5140 ;; 'arglist Some other type of arglist.
5141 ;; nil Some other context or unknown context.
5142 ;;
5143 ;; LAST-CAST-END is the first token after the closing paren of a
5144 ;; preceding cast, or nil if none is known. If
5145 ;; `c-forward-decl-or-cast-1' is used in succession, it should be
5146 ;; the position after the closest preceding call where a cast was
5147 ;; matched. In that case it's used to discover chains of casts like
5148 ;; "(a) (b) c".
5149 ;;
5150 ;; This function records identifier ranges on
5151 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5152 ;; `c-record-type-identifiers' is non-nil.
5153 ;;
5154 ;; This function might do hidden buffer changes.
5157 ;; first type, i.e. after any leading specifiers. It might
5158 ;; also point at the beginning of the preceding syntactic
5159 ;; whitespace.
5161 ;; Set to the result of `c-forward-type'.
5162 at-type
5163 ;; The position of the first token in what we currently
5164 ;; believe is the type in the declaration or cast, after any
5165 ;; specifiers and their associated clauses.
5166 type-start
5167 ;; The position of the first token in what we currently
5168 ;; believe is the declarator for the first identifier. Set
5169 ;; when the type is found, and moved forward over any
5170 ;; `c-decl-hangon-kwds' and their associated clauses that
5171 ;; occurs after the type.
5172 id-start
5173 ;; These store `at-type', `type-start' and `id-start' of the
5174 ;; identifier before the one in those variables. The previous
5175 ;; identifier might turn out to be the real type in a
5176 ;; declaration if the last one has to be the declarator in it.
5177 ;; If `backup-at-type' is nil then the other variables have
5178 ;; undefined values.
5179 backup-at-type backup-type-start backup-id-start
5180 ;; Set if we've found a specifier that makes the defined
5181 ;; identifier(s) types.
5182 at-type-decl
5183 ;; Set if we've found a specifier that can start a declaration
5184 ;; where there's no type.
5185 maybe-typeless
5186 ;; If a specifier is found that also can be a type prefix,
5187 ;; these flags are set instead of those above. If we need to
5188 ;; back up an identifier, they are copied to the real flag
5189 ;; variables. Thus they only take effect if we fail to
5190 ;; interpret it as a type.
5191 backup-at-type-decl backup-maybe-typeless
5192 ;; Whether we've found a declaration or a cast. We might know
5193 ;; this before we've found the type in it. It's 'ids if we've
5194 ;; found two consecutive identifiers (usually a sure sign, but
5195 ;; we should allow that in labels too), and t if we've found a
5196 ;; specifier keyword (a 100% sure sign).
5197 at-decl-or-cast
5198 ;; Set when we need to back up to parse this as a declaration
5199 ;; but not as a cast.
5200 backup-if-not-cast
5201 ;; For casts, the return position.
5202 cast-end
5203 ;; Save `c-record-type-identifiers' and
5204 ;; `c-record-ref-identifiers' since ranges are recorded
5205 ;; speculatively and should be thrown away if it turns out
5206 ;; that it isn't a declaration or cast.
5210 ;; Check for a type. Unknown symbols are treated as possible
5211 ;; types, but they could also be specifiers disguised through
5212 ;; macros like __INLINE__, so we recognize both types and known
5213 ;; specifiers after them too.
5217 ;; Look for a specifier keyword clause.
5225 ;; Found a known or possible type or a prefix of a known type.
5228 ;; Got two identifiers with nothing but whitespace
5229 ;; between them. That can only happen in declarations.
5233 ;; If the previous identifier is a found type we
5234 ;; record it as a real one; it might be some sort of
5235 ;; alias for a prefix like "unsigned".
5242 backup-type-start type-start
5243 backup-id-start id-start
5244 at-type found-type
5245 type-start start
5247 ;; The previous ambiguous specifier/type turned out
5248 ;; to be a type since we've parsed another one after
5249 ;; it, so clear these backup flags.
5250 backup-at-type-decl nil
5251 backup-maybe-typeless nil))
5255 ;; Handle known specifier keywords and
5256 ;; `c-decl-hangon-kwds' which can occur after known
5257 ;; types.
5260 ;; It's a hang-on keyword that can occur anywhere.
5264 ;; Move the identifier start position if
5265 ;; we've passed a type.
5267 ;; Otherwise treat this as a specifier and
5268 ;; move the fallback position.
5272 ;; It's an ordinary specifier so we know that
5273 ;; anything before this can't be the type.
5275 start-pos kwd-clause-end)
5278 ;; It's ambiguous whether this keyword is a
5279 ;; specifier or a type prefix, so set the backup
5280 ;; flags. (It's assumed that `c-forward-type'
5281 ;; moved further than `c-forward-keyword-clause'.)
5293 ;; Haven't matched a type so it's an umambiguous
5294 ;; specifier keyword and we know we're in a
5295 ;; declaration.
5300 ;; If the type isn't known we continue so that we'll jump
5301 ;; over all specifiers and type identifiers. The reason
5302 ;; to do this for a known type prefix is to make things
5303 ;; like "unsigned INT16" work.
5308 ;; If a known type was found, we still need to skip over any
5309 ;; hangon keyword clauses after it. Otherwise it has already
5310 ;; been done in the loop above.
5316 ;; A prefix type is itself a primitive type when it's not
5317 ;; followed by another type.
5321 ;; Got no type but set things up to continue anyway to handle
5322 ;; the various cases when a declaration doesn't start with a
5323 ;; type.
5328 ;; If it's C++ then check if the last "type" ends on the form
5329 ;; "foo::foo" or "foo::~foo", i.e. if it's the name of a
5330 ;; (con|de)structor.
5341 ;; Cheating in the handling of syntactic ws below.
5348 name))
5349 ;; It is a (con|de)structor name. In that case the
5350 ;; declaration is typeless so zap out any preceding
5351 ;; identifier(s) that we might have taken as types.
5354 backup-at-type nil
5355 id-start type-start))))))
5357 ;; Check for and step over a type decl expression after the thing
5358 ;; that is or might be a type. This can't be skipped since we
5359 ;; need the correct end position of the declarator for
5360 ;; `max-type-decl-end-*'.
5362 ;; True if there's a non-open-paren match of
5363 ;; `c-type-decl-prefix-key'.
5364 got-prefix
5365 ;; True if the declarator is surrounded by a parenthesis pair.
5366 got-parens
5367 ;; True if there is an identifier in the declarator.
5368 got-identifier
5369 ;; True if there's a non-close-paren match of
5370 ;; `c-type-decl-suffix-key'.
5371 got-suffix
5372 ;; True if there's a prefix match outside the outermost
5373 ;; paren pair that surrounds the declarator.
5374 got-prefix-before-parens
5375 ;; True if there's a suffix match outside the outermost
5376 ;; paren pair that surrounds the declarator. The value is
5377 ;; the position of the first suffix match.
5378 got-suffix-after-parens
5379 ;; True if we've parsed the type decl to a token that is
5380 ;; known to end declarations in this context.
5381 at-decl-end
5382 ;; The earlier values of `at-type' and `type-start' if we've
5383 ;; shifted the type backwards.
5384 identifier-type identifier-start
5385 ;; If `c-parse-and-markup-<>-arglists' is set we need to
5386 ;; turn it off during the name skipping below to avoid
5387 ;; getting `c-type' properties that might be bogus. That
5388 ;; can happen since we don't know if
5389 ;; `c-restricted-<>-arglists' will be correct inside the
5390 ;; arglist paren that gets entered.
5395 ;; Skip over type decl prefix operators. (Note similar code in
5396 ;; `c-font-lock-declarators'.)
5400 ;; If the second submatch matches in C++ then
5401 ;; we're looking at an identifier that's a
5402 ;; prefix only if it specifies a member pointer.
5405 ;; We only check for a trailing "::" and
5406 ;; let the "*" that should follow be
5407 ;; matched in the next round.
5409 ;; It turned out to be the real identifier,
5410 ;; so stop.
5411 nil))
5412 t))
5426 ;; Skip over an identifier.
5431 ;; Skip over type decl suffix operators.
5438 t)
5442 t)
5448 ;; No suffix matched. We might have matched the
5449 ;; identifier as a type and the open paren of a
5450 ;; function arglist as a type decl prefix. In that
5451 ;; case we should "backtrack": Reinterpret the last
5452 ;; type as the identifier, move out of the arglist and
5453 ;; continue searching for suffix operators.
5454 ;;
5455 ;; Do this even if there's no preceding type, to cope
5456 ;; with old style function declarations in K&R C,
5457 ;; (con|de)structors in C++ and `c-typeless-decl-kwds'
5458 ;; style declarations. That isn't applicable in an
5459 ;; arglist context, though.
5464 maybe-typeless
5465 backup-maybe-typeless
5472 t))
5479 at-type)
5480 ;; Have found no identifier but `c-typeless-decl-kwds' has
5481 ;; matched so we know we're inside a declaration. The
5482 ;; preceding type must be the identifier instead.
5486 at-decl-or-cast
5490 ;; Encountered something inside parens that isn't matched by
5491 ;; the `c-type-decl-*' regexps, so it's not a type decl
5492 ;; expression. Try to skip out to the same paren depth to
5493 ;; not confuse the cast check below.
5495 ;; If we've found a specifier keyword then it's a
5496 ;; declaration regardless.
5504 ;; Now we've collected info about various characteristics of
5505 ;; the construct we're looking at. Below follows a decision
5506 ;; tree based on that. It's ordered to check more certain
5507 ;; signs before less certain ones.
5514 ;; Got another identifier directly after the type, so it's a
5515 ;; declaration.
5522 maybe-typeless
5523 backup-maybe-typeless))
5524 ;; Got a declaration of the form "foo bar (gnu);" where we've
5525 ;; recognized "bar" as the type and "gnu" as the declarator.
5526 ;; In this case it's however more likely that "bar" is the
5527 ;; declarator and "gnu" a function argument or initializer (if
5528 ;; `c-recognize-paren-inits' is set), since the parens around
5529 ;; "gnu" would be superfluous if it's a declarator. Shift the
5530 ;; type one step backward.
5533 ;; Found no identifier.
5539 ;; Got a plain list of identifiers. If a colon follows it's
5540 ;; a valid label. Otherwise the last one probably is the
5541 ;; declared identifier and we should back up to the previous
5542 ;; type, providing it isn't a cast.
5544 ;; If we've found a specifier keyword then it's a
5545 ;; declaration regardless.
5553 ;; Got a plain list of identifiers followed by some suffix.
5554 ;; If this isn't a cast then the last identifier probably is
5555 ;; the declared one and we should back up to the previous
5556 ;; type.
5561 ;; If the type is known we know that there can't be any
5562 ;; identifier somewhere else, and it's only in declarations in
5563 ;; e.g. function prototypes and in casts that the identifier may
5564 ;; be left out.
5568 ;; Only got a single identifier (parsed as a type so far).
5570 ;; Check that the identifier isn't at the start of an
5571 ;; expression.
5572 at-decl-end
5575 ;; Inside an arglist that contains declarations. If K&R
5576 ;; style declarations and parenthesis style initializers
5577 ;; aren't allowed then the single identifier must be a
5578 ;; type, else we require that it's known or found
5579 ;; (primitive types are handled above).
5584 ;; Inside a template arglist. Accept known and found
5585 ;; types; other identifiers could just as well be
5586 ;; constants in C++.
5589 ;; Can't be a valid declaration or cast, but if we've found a
5590 ;; specifier it can't be anything else either, so treat it as
5591 ;; an invalid/unfinished declaration or cast.
5599 maybe-typeless
5600 backup-maybe-typeless
5604 c-after-suffixed-type-maybe-decl-key))))))
5605 ;; Got an empty paren pair and a preceding type that probably
5606 ;; really is the identifier. Shift the type backwards to make
5607 ;; the last one the identifier. This is analogous to the
5608 ;; "backtracking" done inside the `c-type-decl-suffix-key' loop
5609 ;; above.
5610 ;;
5611 ;; Exception: In addition to the conditions in that
5612 ;; "backtracking" code, do not shift backward if we're not
5613 ;; looking at either `c-after-suffixed-type-decl-key' or "[;,]".
5614 ;; Since there's no preceding type, the shift would mean that
5615 ;; the declaration is typeless. But if the regexp doesn't match
5616 ;; then we will simply fall through in the tests below and not
5617 ;; recognize it at all, so it's better to try it as an abstract
5618 ;; declarator instead.
5621 ;; Still no identifier.
5624 ;; Require `got-prefix' together with either `got-parens' or
5625 ;; `got-suffix' to recognize it as an abstract declarator:
5626 ;; `got-parens' only is probably an empty function call.
5627 ;; `got-suffix' only can build an ordinary expression together
5628 ;; with the preceding identifier which we've taken as a type.
5629 ;; We could actually accept on `got-prefix' only, but that can
5630 ;; easily occur temporarily while writing an expression so we
5631 ;; avoid that case anyway. We could do a better job if we knew
5632 ;; the point when the fontification was invoked.
5638 got-suffix-after-parens
5640 ;; Got a type, no declarator but a paren suffix. I.e. it's a
5641 ;; normal function call afterall (or perhaps a C++ style object
5642 ;; instantiation expression).
5646 ;; By now we've located the type in the declaration that we know
5647 ;; we're in.
5657 ;; Shift the type backward in the case that there's a
5658 ;; single identifier inside parens. That can only
5659 ;; occur in K&R style function declarations so it's
5660 ;; more likely that it really is a function call.
5661 ;; Therefore we only do this after
5662 ;; `c-after-suffixed-type-decl-key' has matched.
5664 got-suffix-after-parens))
5665 ;; A declaration according to `c-after-suffixed-type-decl-key'.
5670 ;; It's a declaration if a known type precedes it and it can't be a
5671 ;; function call.
5674 ;; If we get here we can't tell if this is a type decl or a normal
5675 ;; expression by looking at it alone. (That's under the assumption
5676 ;; that normal expressions always can look like type decl expressions,
5677 ;; which isn't really true but the cases where it doesn't hold are so
5678 ;; uncommon (e.g. some placements of "const" in C++) it's not worth
5679 ;; the effort to look for them.)
5682 ;; If this is a declaration it should end here or its initializer(*)
5683 ;; should start here, so check for allowed separation tokens. Note
5684 ;; that this rule doesn't work e.g. with a K&R arglist after a
5685 ;; function header.
5686 ;;
5687 ;; *) Don't check for C++ style initializers using parens
5688 ;; since those already have been matched as suffixes.
5689 ;;
5690 ;; If `at-decl-or-cast' is then we've found some other sign that
5691 ;; it's a declaration or cast, so then it's probably an
5692 ;; invalid/unfinished one.
5695 ;; Below are tests that only should be applied when we're certain to
5696 ;; not have parsed halfway through an expression.
5699 ;; The expression starts with a known type so treat it as a
5700 ;; declaration.
5704 ;; In C++ we check if the identifier is a known type, since
5705 ;; (con|de)structors use the class name as identifier.
5706 ;; We've always shifted over the identifier as a type and
5707 ;; then backed up again in this case.
5708 identifier-type
5711 ;; `at-type' probably won't be 'found for
5712 ;; destructors since the "~" is then part of the
5713 ;; type name being checked against the list of
5714 ;; known types, so do a check without that
5715 ;; operator.
5720 c-identifier-syntax-table
5724 ;; We have already parsed the type earlier,
5725 ;; so it'd be possible to cache the end
5726 ;; position instead of redoing it here, but
5727 ;; then we'd need to keep track of another
5728 ;; position everywhere.
5737 at-type
5741 ;; Got something like "foo * bar;". Since we're not inside an
5742 ;; arglist it would be a meaningless expression because the
5743 ;; result isn't used. We therefore choose to recognize it as
5744 ;; a declaration. Do not allow a suffix since it could then
5745 ;; be a function call.
5752 ;; Got something like "a (*b) (c);" or "a (b) = c;". It could
5753 ;; be an odd expression or it could be a declaration. Treat
5754 ;; it as a declaration if "a" has been used as a type
5755 ;; somewhere else (if it's a known type we won't get here).
5763 ;; Got a type followed by an abstract declarator. If `got-prefix'
5764 ;; is set it's something like "a *" without anything after it. If
5765 ;; `got-parens' or `got-suffix' is set it's "a()", "a[]", "a()[]",
5766 ;; or similar, which we accept only if the context rules out
5767 ;; expressions.
5770 ;; If we had a complete symbol table here (which rules out
5771 ;; `c-found-types') we should return t due to the disambiguation rule
5772 ;; (in at least C++) that anything that can be parsed as a declaration
5773 ;; is a declaration. Now we're being more defensive and prefer to
5774 ;; highlight things like "foo (bar);" as a declaration only if we're
5775 ;; inside an arglist that contains declarations.
5778 ;; The point is now after the type decl expression.
5781 ;; Check for a cast.
5784 c-cast-parens
5786 ;; Should be the first type/identifier in a cast paren.
5790 ;; The closing paren should follow.
5795 ;; There should be a primary expression after it.
5804 ;; Check if the expression begins with a prefix keyword.
5807 ;; Expression begins with an ambiguous operator. Treat
5808 ;; it as a cast if it's a type decl or if we've
5809 ;; recognized the type somewhere else.
5812 ;; Unless it's a keyword, it's the beginning of a primary
5813 ;; expression.
5815 ;; If `c-primary-expr-regexp' matched a nonsymbol token, check
5816 ;; that it matched a whole one so that we don't e.g. confuse
5817 ;; the operator '-' with '->'. It's ok if it matches further,
5818 ;; though, since it e.g. can match the float '.5' while the
5819 ;; operator regexp only matches '.'.
5823 ;; There should either be a cast before it or something that isn't an
5824 ;; identifier or close paren.
5832 ;; It's a symbol. Accept it only if it's one of the
5833 ;; keywords that can precede an expression (without
5834 ;; surrounding parens).
5837 ;; Check that it isn't a close paren (block close is ok,
5838 ;; though).
5840 ;; Check that it isn't a nonsymbol identifier.
5843 ;; Handle the cast.
5853 ;; We're at a declaration. Highlight the type and the following
5854 ;; declarators.
5860 ;; Make sure to propagate the `c-decl-arg-start' property to
5861 ;; the next argument if it's set in this one, to cope with
5862 ;; interactive refontification.
5874 ;; False alarm. Restore the recorded ranges.
5876 c-record-ref-identifiers save-rec-ref-ids)
5877 nil))))
5880 ;; Assuming that point is at the beginning of a token, check if it starts a
5881 ;; label and if so move over it and return non-nil (t in default situations,
5882 ;; specific symbols (see below) for interesting situations), otherwise don't
5883 ;; move and return nil. "Label" here means "most things with a colon".
5884 ;;
5885 ;; More precisely, a "label" is regarded as one of:
5886 ;; (i) a goto target like "foo:" - returns the symbol `goto-target';
5887 ;; (ii) A case label - either the entire construct "case FOO:", or just the
5888 ;; bare "case", should the colon be missing. We return t;
5889 ;; (iii) a keyword which needs a colon, like "default:" or "private:"; We
5890 ;; return t;
5891 ;; (iv) One of QT's "extended" C++ variants of
5892 ;; "private:"/"protected:"/"public:"/"more:" looking like "public slots:".
5893 ;; Returns the symbol `qt-2kwds-colon'.
5894 ;; (v) QT's construct "signals:". Returns the symbol `qt-1kwd-colon'.
5895 ;; (vi) One of the keywords matched by `c-opt-extra-label-key' (without any
5896 ;; colon). Currently (2006-03), this applies only to Objective C's
5897 ;; keywords "@private", "@protected", and "@public". Returns t.
5898 ;;
5899 ;; One of the things which will NOT be recognised as a label is a bit-field
5900 ;; element of a struct, something like "int foo:5".
5901 ;;
5902 ;; The end of the label is taken to be just after the colon, or the end of
5903 ;; the first submatch in `c-opt-extra-label-key'. The point is directly
5904 ;; after the end on return. The terminating char gets marked with
5905 ;; `c-decl-end' to improve recognition of the following declaration or
5906 ;; statement.
5907 ;;
5908 ;; If ASSUME-MARKUP is non-nil, it's assumed that the preceding
5909 ;; label, if any, has already been marked up like that.
5910 ;;
5911 ;; If PRECEDING-TOKEN-END is given, it should be the first position
5912 ;; after the preceding token, i.e. on the other side of the
5913 ;; syntactic ws from the point. Use a value less than or equal to
5914 ;; (point-min) if the point is at the first token in (the visible
5915 ;; part of) the buffer.
5916 ;;
5917 ;; The optional LIMIT limits the forward scan for the colon.
5918 ;;
5919 ;; This function records the ranges of the label symbols on
5920 ;; `c-record-ref-identifiers' if `c-record-type-identifiers' (!) is
5921 ;; non-nil.
5922 ;;
5923 ;; This function might do hidden buffer changes.
5926 label-end
5927 qt-symbol-idx
5928 macro-start ; if we're in one.
5929 label-type)
5931 ;; "case" or "default" (Doesn't apply to AWK).
5934 ;; Record only the keyword itself for fontification, since in
5935 ;; case labels the following is a constant expression and not
5936 ;; a label.
5940 ;; Find the label end.
5944 ;; Stop on chars that aren't allowed in expressions,
5945 ;; and on operator chars that would be meaningless
5946 ;; there. FIXME: This doesn't cope with ?: operators.
5954 t)
5956 ;; It's an unfinished label. We consider the keyword enough
5957 ;; to recognize it as a label, so that it gets fontified.
5958 ;; Leave the point at the end of it, but don't put any
5959 ;; `c-decl-end' marker.
5961 t))))
5963 ;; @private, @protected, @public, in Objective C, or similar.
5966 ;; For a `c-opt-extra-label-key' match, we record the whole
5967 ;; thing for fontification. That's to get the leading '@' in
5968 ;; Objective-C protection labels fontified.
5975 ;; All other cases of labels.
5978 ;; A colon label must have something before the colon.
5981 ;; Check that we're not after a token that can't precede a label.
5983 ;; Trivially succeeds when there's no preceding token.
5991 ;; Check if we're after a label, if we're after a closing
5992 ;; paren that belong to statement, and with
5993 ;; `c-label-prefix-re'. It's done in different order
5994 ;; depending on `assume-markup' since the checks have
5995 ;; different expensiveness.
6022 ;; Might be after another label, so check it recursively.
6026 ;; Essentially the same as the
6027 ;; `c-syntactic-re-search-forward' regexp below.
6033 ;; Note: the following should work instead of the
6034 ;; narrow-to-region above. Investigate why not,
6035 ;; sometime. ACM, 2006-03-31.
6036 ;; (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+"
6037 ;; macro-start t)
6039 ;; If the caller turned on recording for us,
6040 ;; it shouldn't apply when we check the
6041 ;; preceding label.
6042 c-record-type-identifiers)
6043 ;; A label can't start at a cpp directive. Check for
6044 ;; this, since c-forward-syntactic-ws would foul up on it.
6049 ;; Point is still at the beginning of the possible label construct.
6050 ;;
6051 ;; Check that the next nonsymbol token is ":", or that we're in one
6052 ;; of QT's "slots" declarations. Allow '(' for the sake of macro
6053 ;; arguments. FIXME: Should build this regexp from the language
6054 ;; constants.
6056 ;; public: protected: private:
6066 ;; QT double keyword like "protected slots:" or goto target.
6084 'qt-1kwd-colon
6096 ;; Check that `c-nonlabel-token-key' doesn't match anywhere.
6106 t)
6109 ;; Record the identifiers in the label for fontification, unless
6110 ;; it begins with `c-label-kwds' in which case the following
6111 ;; identifiers are part of a (constant) expression that
6112 ;; shouldn't be fontified.
6124 ;; Not a label.
6126 label-type))
6129 ;; Assuming the point is at the beginning of a token, try to move
6130 ;; forward to the end of the Objective-C directive that starts
6131 ;; there. Return t if a directive was fully recognized, otherwise
6132 ;; the point is moved as far as one could be successfully parsed and
6133 ;; nil is returned.
6134 ;;
6135 ;; This function records identifier ranges on
6136 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6137 ;; `c-record-type-identifiers' is non-nil.
6138 ;;
6139 ;; This function might do hidden buffer changes.
6142 start-char
6144 ;; Turn off recognition of angle bracket arglists while parsing
6145 ;; types here since the protocol reference list might then be
6146 ;; considered part of the preceding name or superclass-name.
6157 t)
6166 ;; Handle the name of the class itself.
6168 ; (c-forward-token-2) ; 2006/1/13 This doesn't move if the token's
6169 ; at EOB.
6175 ;; Look for ": superclass-name" or "( category-name )".
6186 ;; Look for a protocol reference list.
6192 t))))
6198 t)
6201 nil)))
6204 ;; Go to the first non-whitespace after the colon that starts a
6205 ;; multiple inheritance introduction. Optional LIM is the farthest
6206 ;; back we should search.
6207 ;;
6208 ;; This function might do hidden buffer changes.
6216 ;; Return nil if we aren't in a method definition, otherwise the
6217 ;; position of the initial [+-].
6218 ;;
6219 ;; This function might do hidden buffer changes.
6225 ))
6227 ;; Contributed by Kevin Ryde <user42@zip.com.au>.
6229 ;; Return non-nil if point is within a gcc \"asm\" block.
6230 ;;
6231 ;; This should be called with point inside an argument list.
6232 ;;
6233 ;; Only one level of enclosing parentheses is considered, so for
6234 ;; instance `nil' is returned when in a function call within an asm
6235 ;; operand.
6236 ;;
6237 ;; This function might do hidden buffer changes.
6247 "Return a determination as to whether point is at the `top-level'.
6248 Being at the top-level means that point is either outside any
6249 enclosing block (such function definition), or only inside a class,
6250 namespace or other block that contains another declaration level.
6252 If point is not at the top-level (e.g. it is inside a method
6253 definition), then nil is returned. Otherwise, if point is at a
6254 top-level not enclosed within a class definition, t is returned.
6255 Otherwise, a 2-vector is returned where the zeroth element is the
6256 buffer position of the start of the class declaration, and the first
6257 element is the buffer position of the enclosing class's opening
6258 brace.
6260 Note that this function might do hidden buffer changes. See the
6261 comment at the start of cc-engine.el for more info."
6267 ;; Return non-nil if the point is in the region after the argument
6268 ;; list of a function and its opening brace (or semicolon in case it
6269 ;; got no body). If there are K&R style argument declarations in
6270 ;; that region, the point has to be inside the first one for this
6271 ;; function to recognize it.
6272 ;;
6273 ;; If successful, the point is moved to the first token after the
6274 ;; function header (see `c-forward-decl-or-cast-1' for details) and
6275 ;; the position of the opening paren of the function arglist is
6276 ;; returned.
6277 ;;
6278 ;; The point is clobbered if not successful.
6279 ;;
6280 ;; LIM is used as bound for backward buffer searches.
6281 ;;
6282 ;; This function might do hidden buffer changes.
6295 ;; There should not be a '=' or ',' between beg and the
6296 ;; start of the declaration since that means we were in the
6297 ;; "expression part" of the declaration.
6302 ;; Check that there's an arglist paren in the
6303 ;; declaration.
6306 ;; The declarator is a paren expression, so skip past it
6307 ;; so that we don't get stuck on that instead of the
6308 ;; function arglist.
6312 ;; Don't trip up on "operator ()".
6319 ;; Return the position of the first argument declaration if point is
6320 ;; inside a K&R style argument declaration list, nil otherwise.
6321 ;; `c-recognize-knr-p' is not checked. If LIM is non-nil, it's a
6322 ;; position that bounds the backward search for the argument list.
6323 ;;
6324 ;; Point must be within a possible K&R region, e.g. just before a top-level
6325 ;; "{". It must be outside of parens and brackets. The test can return
6326 ;; false positives otherwise.
6327 ;;
6328 ;; This function might do hidden buffer changes.
6332 ;; If we're in a macro, our search range is restricted to it. Narrow to
6333 ;; the searchable range.
6336 before-lparen after-rparen
6340 ;; Search backwards for the defun's argument list. We give up if we
6341 ;; encounter a "}" (end of a previous defun) or BOB.
6342 ;;
6343 ;; The criterion for a paren structure being the arg list is:
6344 ;; o - there is non-WS stuff after it but before any "{"; AND
6345 ;; o - the token after it isn't a ";" AND
6346 ;; o - it is preceded by either an identifier (the function name) or
6347 ;; a macro expansion like "DEFUN (...)"; AND
6348 ;; o - its content is a non-empty comma-separated list of identifiers
6349 ;; (an empty arg list won't have a knr region).
6350 ;;
6351 ;; The following snippet illustrates these rules:
6352 ;; int foo (bar, baz, yuk)
6353 ;; int bar [] ;
6354 ;; int (*baz) (my_type) ;
6355 ;; int (*) (void) (*yuk) (void) ;
6356 ;; {
6370 ;; We're inside a paren. Could it be our argument list....?
6376 ;; FIXME!!! What about macros between the parens? 2007/01/20
6379 ;; It can't be the arg list if next token is ; or {
6384 ;; Is the thing preceding the list an identifier (the
6385 ;; function name), or a macro expansion?
6395 ;; Have we got a non-empty list of comma-separated
6396 ;; identifiers?
6410 ;; ...Yes. We've identified the function's argument list.
6416 ;; ...No. The current parens aren't the function's arg list.
6423 ;; skip forward over conditional at point, including any predicate
6424 ;; statements in parentheses. No error checking is performed.
6425 ;;
6426 ;; This function might do hidden buffer changes.
6428 ;; else if()
6433 ;; do, else, try, finally
6438 ;; for, if, while, switch, catch, synchronized, foreach
6442 ;; If looking at the token after a conditional then return the
6443 ;; position of its start, otherwise return nil.
6444 ;;
6445 ;; This function might do hidden buffer changes.
6455 ;; If the point is after an operator identifier that isn't handled
6456 ;; like an ordinary symbol (i.e. like "operator =" in C++) then the
6457 ;; position of the start of that identifier is returned. nil is
6458 ;; returned otherwise. The point may be anywhere in the syntactic
6459 ;; whitespace after the last token of the operator identifier.
6460 ;;
6461 ;; This function might do hidden buffer changes.
6473 ;; Assuming point is at a brace that opens a statement block of some
6474 ;; kind, move to the proper anchor point for that block. It might
6475 ;; need to be adjusted further by c-add-stmt-syntax, but the
6476 ;; position at return is suitable as start position for that
6477 ;; function.
6478 ;;
6479 ;; This function might do hidden buffer changes.
6486 ;; Assuming point is at a brace that opens the block of a top level
6487 ;; declaration of some kind, move to the proper anchor point for
6488 ;; that block.
6489 ;;
6490 ;; This function might do hidden buffer changes.
6495 ;; Search forward for the end of the "header" of the current
6496 ;; declaration. That's the position where the definition body
6497 ;; starts, or the first variable initializer, or the ending
6498 ;; semicolon. I.e. search forward for the closest following
6499 ;; (syntactically relevant) '{', '=' or ';' token. Point is left
6500 ;; _after_ the first found token, or at point-max if none is found.
6501 ;;
6502 ;; This function might do hidden buffer changes.
6507 ;; In C++ we need to take special care to handle operator
6508 ;; tokens and those pesky template brackets.
6513 ;; Handle operator identifiers, i.e. ignore any
6514 ;; operator token preceded by "operator".
6521 t
6523 nil)))))
6532 ;; Go to the beginning of the current declaration, or the beginning
6533 ;; of the previous one if already at the start of it. Point won't
6534 ;; be moved out of any surrounding paren. Return a cons cell of the
6535 ;; form (MOVE . KNR-POS). MOVE is like the return value from
6536 ;; `c-beginning-of-statement-1'. If point skipped over some K&R
6537 ;; style argument declarations (and they are to be recognized) then
6538 ;; KNR-POS is set to the start of the first such argument
6539 ;; declaration, otherwise KNR-POS is nil. If LIM is non-nil, it's a
6540 ;; position that bounds the backward search.
6541 ;;
6542 ;; NB: Cases where the declaration continues after the block, as in
6543 ;; "struct foo { ... } bar;", are currently recognized as two
6544 ;; declarations, e.g. "struct foo { ... }" and "bar;" in this case.
6545 ;;
6546 ;; This function might do hidden buffer changes.
6552 ;; `c-beginning-of-statement-1' stops at a block start, but we
6553 ;; want to continue if the block doesn't begin a top level
6554 ;; construct, i.e. if it isn't preceded by ';', '}', ':', bob,
6555 ;; or an open paren.
6557 ;; Go back one "statement" each time round the loop until we're just
6558 ;; after a ;, }, or :, or at BOB or the start of a macro or start of
6559 ;; an ObjC method. This will move over a multiple declaration whose
6560 ;; components are comma separated.
6562 ;; Must check with c-opt-method-key in ObjC mode.
6572 ;; Check that we don't move from the first thing in a
6573 ;; macro to its header.
6579 move tentative-move))
6584 ;; Handle K&R argdecls. Back up after the "statement" jumped
6585 ;; over by `c-beginning-of-statement-1', unless it was the
6586 ;; function body, in which case we're sitting on the opening
6587 ;; brace now. Then test if we're in a K&R argdecl region and
6588 ;; that we started at the other side of the first argdecl in
6589 ;; it.
6599 'previous
6601 knr-argdecl-start))
6604 ;; `c-beginning-of-statement-1' counts each brace block as a separate
6605 ;; statement, so the result will be 'previous if we've moved over any.
6606 ;; So change our result back to 'same if necessary.
6607 ;;
6608 ;; If they were brace list initializers we might not have moved over a
6609 ;; declaration boundary though, so change it to 'same if we've moved
6610 ;; past a '=' before '{', but not ';'. (This ought to be integrated
6611 ;; into `c-beginning-of-statement-1', so we avoid this extra pass which
6612 ;; potentially can search over a large amount of text.). Take special
6613 ;; pains not to get mislead by C++'s "operator=", and the like.
6616 c++-template-syntax-table
6622 ; no more, or get to one which isn't an "operator ="
6625 c-overloadable-operators-regexp
6626 c-opt-op-identifier-prefix
6641 ;; Assuming point is at the start of a declaration (as detected by
6642 ;; e.g. `c-beginning-of-decl-1'), go to the end of it. Unlike
6643 ;; `c-beginning-of-decl-1', this function handles the case when a
6644 ;; block is followed by identifiers in e.g. struct declarations in C
6645 ;; or C++. If a proper end was found then t is returned, otherwise
6646 ;; point is moved as far as possible within the current sexp and nil
6647 ;; is returned. This function doesn't handle macros; use
6648 ;; `c-end-of-macro' instead in those cases.
6649 ;;
6650 ;; This function might do hidden buffer changes.
6653 c++-template-syntax-table
6661 ;; Stopped at the ';' in a K&R argdecl section which is
6662 ;; detected using the same criteria as in
6663 ;; `c-beginning-of-decl-1'. Move to the following block
6664 ;; start.
6668 ;; Encountered a block in the declaration. Jump over it.
6679 ;; Check for `c-opt-block-decls-with-vars-key'
6680 ;; before the first paren.
6683 c-opt-block-decls-with-vars-key
6685 lim t t t)
6688 ;; Check that the first following paren is
6689 ;; the block.
6691 lim t t t)
6693 ;; The declaration doesn't have any of the
6694 ;; `c-opt-block-decls-with-vars' keywords in the
6695 ;; beginning, so it ends here at the end of the block.
6703 nil)))
6706 ;; Assuming the point is at an open brace, check if it starts a
6707 ;; block that contains another declaration level, i.e. that isn't a
6708 ;; statement block or a brace list, and if so return non-nil.
6709 ;;
6710 ;; If the check is successful, the return value is the start of the
6711 ;; keyword that tells what kind of construct it is, i.e. typically
6712 ;; what `c-decl-block-key' matched. Also, if GOTO-START is set then
6713 ;; the point will be at the start of the construct, before any
6714 ;; leading specifiers, otherwise it's at the returned position.
6715 ;;
6716 ;; The point is clobbered if the check is unsuccessful.
6717 ;;
6718 ;; CONTAINING-SEXP is the position of the open of the surrounding
6719 ;; paren, or nil if none.
6720 ;;
6721 ;; The optional LIMIT limits the backward search for the start of
6722 ;; the construct. It's assumed to be at a syntactically relevant
6723 ;; position.
6724 ;;
6725 ;; If any template arglists are found in the searched region before
6726 ;; the open brace, they get marked with paren syntax.
6727 ;;
6728 ;; This function might do hidden buffer changes.
6735 ;; Could be at the end of a template arglist.
6746 ;; Note: Can't get bogus hits inside template arglists below since they
6747 ;; have gotten paren syntax above.
6749 ;; If `goto-start' is set we begin by searching for the
6750 ;; first possible position of a leading specifier list.
6751 ;; The `c-decl-block-key' search continues from there since
6752 ;; we know it can't match earlier.
6755 open-brace t t)
6757 t)
6758 t)
6765 ;; Found a keyword that can't be a type?
6768 ;; Can be a type too, in which case it's the return type of a
6769 ;; function (under the assumption that no declaration level
6770 ;; block construct starts with a type).
6773 ;; Jumped over a type, but it could be a declaration keyword
6774 ;; followed by the declared identifier that we've jumped over
6775 ;; instead (e.g. in "class Foo {"). If it indeed is a type
6776 ;; then we should be at the declarator now, so check for a
6777 ;; valid declarator start.
6778 ;;
6779 ;; Note: This doesn't cope with the case when a declared
6780 ;; identifier is followed by e.g. '(' in a language where '('
6781 ;; also might be part of a declarator expression. Currently
6782 ;; there's no such language.
6786 ;; In Pike a list of modifiers may be followed by a brace
6787 ;; to make them apply to many identifiers. Note that the
6788 ;; match data will be empty on return in this case.
6794 ;; Use this variant to avoid yet another special regexp.
6798 t)))
6800 ;; Got a match.
6803 ;; Back up over any preceding specifiers and their clauses
6804 ;; by going forward from `first-specifier-pos', which is the
6805 ;; earliest possible position where the specifier list can
6806 ;; start.
6812 ;; Accept any plain symbol token on the ground that
6813 ;; it's a specifier masked through a macro (just
6814 ;; like `c-forward-decl-or-cast-1' skip forward over
6815 ;; such tokens).
6816 ;;
6817 ;; Could be more restrictive wrt invalid keywords,
6818 ;; but that'd only occur in invalid code so there's
6819 ;; no use spending effort on it.
6825 ;; Can't parse a declaration preamble and is still
6826 ;; before `kwd-start'. That means `first-specifier-pos'
6827 ;; was in some earlier construct. Search again.
6831 ;; Got no preamble before the block declaration keyword.
6837 kwd-start)))
6840 ;; Check if the closest containing paren sexp is a declaration
6841 ;; block, returning a 2 element vector in that case. Aref 0
6842 ;; contains the bufpos at boi of the class key line, and aref 1
6843 ;; contains the bufpos of the open brace. This function is an
6844 ;; obsolete wrapper for `c-looking-at-decl-block'.
6845 ;;
6846 ;; This function might do hidden buffer changes.
6854 nil))
6859 ;; return the buffer position of the beginning of the brace list
6860 ;; statement if we're inside a brace list, otherwise return nil.
6861 ;; CONTAINING-SEXP is the buffer pos of the innermost containing
6862 ;; paren. PAREN-STATE is the remainder of the state of enclosing
6863 ;; braces
6864 ;;
6865 ;; N.B.: This algorithm can potentially get confused by cpp macros
6866 ;; placed in inconvenient locations. It's a trade-off we make for
6867 ;; speed.
6868 ;;
6869 ;; This function might do hidden buffer changes.
6871 ;; This will pick up brace list declarations.
6884 ;; this will pick up array/aggregate init lists, even if they are nested.
6887 ;; Pike can have class definitions anywhere, so we must
6888 ;; check for the class key here.
6890 c-decl-block-key))
6891 bufpos braceassignp lim next-containing)
6893 containing-sexp)
6904 ;; We're in an in-expression block of some kind. Do not
6905 ;; check nesting. We deliberately set the limit to the
6906 ;; containing sexp, so that c-looking-at-inexpr-block
6907 ;; doesn't check for an identifier before it.
6909 ;; see if the open brace is preceded by = or [...] in
6910 ;; this statement, but watch out for operator=
6913 ;; Checks to do only on the first sexp before the brace.
6916 ;; In Java, an initialization brace list may follow
6917 ;; directly after "new Foo[]", so check for a "new"
6918 ;; earlier.
6924 ;; Carry on looking if this is an
6925 ;; identifier (may contain "." in Java)
6926 ;; or another "[]" sexp.
6929 ;; Checks to do on all sexps before the brace, up to the
6930 ;; beginning of the statement.
6938 ;; We've seen a =, but must check earlier tokens so
6939 ;; that it isn't something that should be ignored.
6945 ;; Check for operator =
6948 nil)
6949 ;; Check for `<opchar>= in Pike.
6952 ;; Special case for Pikes
6953 ;; `[]=, since '[' is not in
6954 ;; the punctuation class.
6957 nil)
6959 ;; make sure we're not in a C++ template
6960 ;; argument assignment
6972 ))))
6973 nil)
6980 ;; Brace lists can't contain a semicolon, so we're done.
6982 ;; Go up one level.
6984 lim nil
6985 next-containing nil))
6986 ;; we've hit the beginning of the aggregate list
6990 )
6991 bufpos))
6992 ))
6995 ;; If we're looking at the start of a pike-style list, ie `({Â })',
6996 ;; `([Â ])', `(<Â >)' etc, a cons of a cons of its starting and ending
6997 ;; positions and its entry in c-special-brace-lists is returned, nil
6998 ;; otherwise. The ending position is nil if the list is still open.
6999 ;; LIM is the limit for forward search. The point may either be at
7000 ;; the `(' or at the following paren character. Tries to check the
7001 ;; matching closer, but assumes it's correct if no balanced paren is
7002 ;; found (i.e. the case `({ ... } ... )' is detected as _not_ being
7003 ;; a special brace list).
7004 ;;
7005 ;; This function might do hidden buffer changes.
7010 inner-beg end type)
7025 nil)))))
7035 ;; Check balancing of the inner paren
7036 ;; below.
7039 t)
7040 ;; If the inner char isn't a paren then
7041 ;; we can't check balancing, so just
7042 ;; check the char before the outer
7043 ;; closing paren.
7058 ;; Return non-nil if between two statements or declarations, assuming
7059 ;; point is not inside a literal or comment.
7060 ;;
7061 ;; Obsolete - `c-at-statement-start-p' or `c-at-expression-start-p'
7062 ;; are recommended instead.
7063 ;;
7064 ;; This function might do hidden buffer changes.
7069 ;; Return non-nil if we're looking at the beginning of a block
7070 ;; inside an expression. The value returned is actually a cons of
7071 ;; either 'inlambda, 'inexpr-statement or 'inexpr-class and the
7072 ;; position of the beginning of the construct.
7073 ;;
7074 ;; LIM limits the backward search. CONTAINING-SEXP is the start
7075 ;; position of the closest containing list. If it's nil, the
7076 ;; containing paren isn't used to decide whether we're inside an
7077 ;; expression or not. If both LIM and CONTAINING-SEXP are used, LIM
7078 ;; needs to be farther back.
7079 ;;
7080 ;; If CHECK-AT-END is non-nil then extra checks at the end of the
7081 ;; brace block might be done. It should only be used when the
7082 ;; construct can be assumed to be complete, i.e. when the original
7083 ;; starting position was further down than that.
7084 ;;
7085 ;; This function might do hidden buffer changes.
7090 ;; Look at the character after point only as a last resort
7091 ;; when we can't disambiguate.
7111 ;; If the class definition is at the start of
7112 ;; a statement, we don't consider it an
7113 ;; in-expression class.
7121 ;; Also, in Pike we treat it as an
7122 ;; in-expression class if it's used in an
7123 ;; object clone expression.
7139 nil)
7147 ;; Accept several square bracket sexps for
7148 ;; Java array initializations.
7156 block-follows
7157 containing-sexp
7166 nil
7169 res))))
7172 ;; Returns non-nil if we're looking at the end of an in-expression
7173 ;; block, otherwise the same as `c-looking-at-inexpr-block'.
7174 ;; PAREN-STATE is the paren state relevant at the current position.
7175 ;;
7176 ;; This function might do hidden buffer changes.
7178 ;; We currently only recognize a block.
7181 containing-sexp)
7190 paren-state)
7191 containing-sexp)))))
7193 \f
7194 ;; `c-guess-basic-syntax' and the functions that precedes it below
7195 ;; implements the main decision tree for determining the syntactic
7196 ;; analysis of the current line of code.
7198 ;; Dynamically bound to t when `c-guess-basic-syntax' is called during
7199 ;; auto newline analysis.
7203 ;; BRACEPOS is the position of a brace in a construct like "namespace
7204 ;; Bar {". Return the anchor point in this construct; this is the
7205 ;; earliest symbol on the brace's line which isn't earlier than
7206 ;; "namespace".
7207 ;;
7208 ;; Currently (2007-08-17), "like namespace" means "matches
7209 ;; c-other-block-decl-kwds". It doesn't work with "class" or "struct"
7210 ;; or anything like that.
7220 ;; A simple function to prepend a new syntax element to
7221 ;; `c-syntactic-context'. Using `setq' on it is unsafe since it
7222 ;; should always be dynamically bound but since we read it first
7223 ;; we'll fail properly anyway if this function is misused.
7225 c-syntactic-context)))
7228 ;; Like `c-add-syntax' but appends to the end of the syntax list.
7229 ;; (Normally not necessary.)
7234 syntax-extra-args
7235 stop-at-boi-only
7236 containing-sexp
7237 paren-state)
7238 ;; Add the indicated SYNTAX-SYMBOL to `c-syntactic-context', extending it as
7239 ;; needed with further syntax elements of the types `substatement',
7240 ;; `inexpr-statement', `arglist-cont-nonempty', `statement-block-intro', and
7241 ;; `defun-block-intro'.
7242 ;;
7243 ;; Do the generic processing to anchor the given syntax symbol on
7244 ;; the preceding statement: Skip over any labels and containing
7245 ;; statements on the same line, and then search backward until we
7246 ;; find a statement or block start that begins at boi without a
7247 ;; label or comment.
7248 ;;
7249 ;; Point is assumed to be at the prospective anchor point for the
7250 ;; given SYNTAX-SYMBOL. More syntax entries are added if we need to
7251 ;; skip past open parens and containing statements. Most of the added
7252 ;; syntax elements will get the same anchor point - the exception is
7253 ;; for an anchor in a construct like "namespace"[*] - this is as early
7254 ;; as possible in the construct but on the same line as the {.
7255 ;;
7256 ;; [*] i.e. with a keyword matching c-other-block-decl-kwds.
7257 ;;
7258 ;; SYNTAX-EXTRA-ARGS are a list of the extra arguments for the
7259 ;; syntax symbol. They are appended after the anchor point.
7260 ;;
7261 ;; If STOP-AT-BOI-ONLY is nil, we can stop in the middle of the line
7262 ;; if the current statement starts there.
7263 ;;
7264 ;; Note: It's not a problem if PAREN-STATE "overshoots"
7265 ;; CONTAINING-SEXP, i.e. contains info about parens further down.
7266 ;;
7267 ;; This function might do hidden buffer changes.
7270 ;; This is by far the most common case, so let's give it special
7271 ;; treatment.
7276 ;; Set when we're on a label, so that we don't stop there.
7277 ;; FIXME: To be complete we should check if we're on a label
7278 ;; now at the start.
7279 on-label)
7281 ;; Use point as the anchor point for "namespace", "extern", etc.
7285 syntax-extra-args)
7287 ;; Loop while we have to back out of containing blocks.
7292 ;; Loop while we have to back up statements.
7294 on-label
7297 ;; Skip past any comments that stands between the
7298 ;; statement start and boi.
7306 ;; Skip to the beginning of this statement or backward
7307 ;; another one.
7315 ;; If we didn't move we're at the start of a block and
7316 ;; have to continue outside it.
7325 ;; Special case to avoid deeper and deeper indentation
7326 ;; of "else if" clauses.
7327 )
7332 ;; If stop-at-boi-only is nil, we shouldn't back up
7333 ;; over previous or containing statements to try to
7334 ;; reach boi, so go back to the last position and
7335 ;; exit.
7342 ;; If we've moved into another statement then we
7343 ;; should no longer try to stop in the middle of a
7344 ;; line.
7347 ;; Record this as a substatement if we skipped up one
7348 ;; level.
7351 )))
7353 containing-sexp)
7355 ;; Now we have to go out of this block.
7358 ;; Don't stop in the middle of a special brace list opener
7359 ;; like "({".
7371 ;; Analyze the construct in front of the block we've stepped out
7372 ;; from and add the right syntactic element for it.
7375 step-type)
7378 ;; Stepped out of a parenthesis block, so we're in an
7379 ;; expression now.
7391 ;; Stepped out of an in-expression statement. This
7392 ;; syntactic element won't get an anchor pos.
7395 ;; A parenthesis normally belongs to an arglist.
7403 on-label nil))
7405 ;; Stepped out of a brace block.
7417 containing-sexp)))
7419 'defun-block-intro
7421 nil))
7425 c-other-decl-block-key-in-symbols-alist))
7432 ;; Always done if the open brace was at boi. The
7433 ;; c-beginning-of-statement-1 call above is necessary
7434 ;; anyway, to decide the type of block-intro to add.
7437 ))
7439 ;; Fill in the current point as the anchor for all the symbols
7440 ;; added above.
7449 )))
7452 containing-decl-open
7453 containing-decl-start
7454 containing-decl-kwd
7455 paren-state)
7456 ;; The inclass and class-close syntactic symbols are added in
7457 ;; several places and some work is needed to fix everything.
7458 ;; Therefore it's collected here.
7459 ;;
7460 ;; This function might do hidden buffer changes.
7465 containing-decl-open)
7467 ;; Ought to use `c-add-stmt-syntax' instead of backing up to boi
7468 ;; here, but we have to do like this for compatibility.
7478 char-after-ip
7479 beg-of-same-or-containing-stmt
7480 containing-sexp
7481 paren-state)
7482 ;; This function contains the decision tree reached through both
7483 ;; cases 18 and 10. It's a continued statement or top level
7484 ;; construct of some kind.
7485 ;;
7486 ;; This function might do hidden buffer changes.
7493 ;; (CASE A removed.)
7494 ;; CASE B: open braces for class or brace-lists
7501 ;; CASE B.1: class-open
7508 ;; CASE B.2: brace-list-open
7513 indent-point t t t)))
7514 ;; The most semantically accurate symbol here is
7515 ;; brace-list-open, but we normally report it simply as a
7516 ;; statement-cont. The reason is that one normally adjusts
7517 ;; brace-list-open for brace lists as top-level constructs,
7518 ;; and brace lists inside statements is a completely different
7519 ;; context. C.f. case 5A.3.
7522 ;; Turn off the dwim above when we're
7523 ;; analyzing the nature of the brace
7524 ;; for the auto newline feature.
7525 'brace-list-open
7527 nil nil
7528 containing-sexp paren-state))
7530 ;; CASE B.3: The body of a function declared inside a normal
7531 ;; block. Can occur e.g. in Pike and when using gcc
7532 ;; extensions, but watch out for macros followed by blocks.
7533 ;; C.f. cases E, 16F and 17G.
7539 ;; Turn off recognition of constructs that lacks a
7540 ;; type in this case, since that's more likely to be
7541 ;; a macro followed by a block.
7544 containing-sexp paren-state))
7546 ;; CASE B.4: Continued statement with block open. The most
7547 ;; accurate analysis is perhaps `statement-cont' together with
7548 ;; `block-open' but we play DWIM and use `substatement-open'
7549 ;; instead. The rationaly is that this typically is a macro
7550 ;; followed by a block which makes it very similar to a
7551 ;; statement with a substatement block.
7554 containing-sexp paren-state))
7555 ))
7557 ;; CASE C: iostream insertion or extraction operator
7561 ;; If there is no preceding streamop in the statement
7562 ;; then indent this line as a normal statement-cont.
7566 t))))
7568 ;; CASE E: In the "K&R region" of a function declared inside a
7569 ;; normal block. C.f. case B.3.
7571 ;; Check that the next token is a '{'. This works as
7572 ;; long as no language that allows nested function
7573 ;; definitions allows stuff like member init lists, K&R
7574 ;; declarations or throws clauses there.
7575 ;;
7576 ;; Note that we do a forward search for something ahead
7577 ;; of the indentation line here. That's not good since
7578 ;; the user might not have typed it yet. Unfortunately
7579 ;; it's exceedingly tricky to recognize a function
7580 ;; prototype in a code block without resorting to this.
7588 ;; Turn off recognition of constructs that lacks a
7589 ;; type in this case, since that's more likely to be
7590 ;; a macro followed by a block.
7593 containing-sexp paren-state))
7595 ;; CASE D: continued statement.
7599 containing-sexp paren-state))
7600 )))
7602 ;; The next autoload was added by RMS on 2005/8/9 - don't know why (ACM,
7603 ;; 2005/11/29).
7604 ;;;###autoload
7606 "Return the syntactic context of the current line."
7612 ;; A whole ugly bunch of various temporary variables. Have
7613 ;; to declare them here since it's not possible to declare
7614 ;; a variable with only the scope of a cond test and the
7615 ;; following result clauses, and most of this function is a
7616 ;; single gigantic cond. :P
7617 literal char-before-ip before-ws-ip char-after-ip macro-start
7618 in-macro-expr c-syntactic-context placeholder c-in-literal-cache
7619 step-type tmpsymbol keyword injava-inher special-brace-list tmp-pos
7620 ;; The following record some positions for the containing
7621 ;; declaration block if we're directly within one:
7622 ;; `containing-decl-open' is the position of the open
7623 ;; brace. `containing-decl-start' is the start of the
7624 ;; declaration. `containing-decl-kwd' is the keyword
7625 ;; symbol of the keyword that tells what kind of block it
7626 ;; is.
7627 containing-decl-open
7628 containing-decl-start
7629 containing-decl-kwd
7630 ;; The open paren of the closest surrounding sexp or nil if
7631 ;; there is none.
7632 containing-sexp
7633 ;; The position after the closest preceding brace sexp
7634 ;; (nested sexps are ignored), or the position after
7635 ;; `containing-sexp' if there is none, or (point-min) if
7636 ;; `containing-sexp' is nil.
7637 lim
7638 ;; The paren state outside `containing-sexp', or at
7639 ;; `indent-point' if `containing-sexp' is nil.
7641 ;; There's always at most one syntactic element which got
7642 ;; an anchor pos. It's stored in syntactic-relpos.
7643 syntactic-relpos
7646 ;; Check if we're directly inside an enclosing declaration
7647 ;; level block.
7656 containing-sexp)
7657 t)))
7660 containing-sexp nil)
7665 ;; Init some position variables.
7674 ;; Ignore balanced paren. The next entry
7675 ;; can't be another one.
7678 ;; If there is no surrounding open paren then
7679 ;; put the last balanced pair back on paren-state.
7681 containing-sexp nil)))
7685 ;; If we're in a parenthesis list then ',' delimits the
7686 ;; "statements" rather than being an operator (with the
7687 ;; exception of the "for" clause). This difference is
7688 ;; typically only noticeable when statements are used in macro
7689 ;; arglists.
7694 ;; cache char before and after indent point, and move point to
7695 ;; the most likely position to perform the majority of tests
7704 ;; are we in a literal?
7707 ;; now figure out syntactic qualities of the current line
7710 ;; CASE 1: in a string.
7714 ;; CASE 2: in a C or C++ style comment.
7716 ;; This is a kludge for XEmacs where we use
7717 ;; `buffer-syntactic-context', which doesn't correctly
7718 ;; recognize "\*/" to end a block comment.
7719 ;; `parse-partial-sexp' which is used by
7720 ;; `c-literal-limits' will however do that in most
7721 ;; versions, which results in that we get nil from
7722 ;; `c-literal-limits' even when `c-in-literal' claims
7723 ;; we're inside a comment.
7727 ;; CASE 3: in a cpp preprocessor macro continuation.
7737 ;; If at the beginning of the body of a #define
7738 ;; directive then analyze as cpp-define-intro
7739 ;; only. Go on with the syntactic analysis
7740 ;; otherwise. in-macro-expr is set if we're in a
7741 ;; cpp expression, i.e. before the #define body
7742 ;; or anywhere in a non-#define directive.
7749 nil)))))
7753 ;; CASE 11: an else clause?
7757 containing-sexp paren-state))
7759 ;; CASE 12: while closure of a do/while construct?
7767 containing-sexp paren-state))
7769 ;; CASE 13: A catch or finally clause? This case is simpler
7770 ;; than if-else and do-while, because a block is required
7771 ;; after every try, catch and finally.
7779 t)
7783 t)
7786 t))
7791 containing-sexp paren-state))
7793 ;; CASE 18: A substatement we can recognize by keyword.
7803 ;; Ought to cache the result from the
7804 ;; c-beginning-of-statement-1 calls here.
7814 ;; Step up to the containing statement if we
7815 ;; stayed in the same one.
7823 ;; There was no containing statement afterall.
7825 placeholder))
7827 ;; Require a parenthesis after these keywords.
7828 ;; Necessary to catch e.g. synchronized in Java,
7829 ;; which can be used both as statement and
7830 ;; modifier.
7836 ;; CASE 18A: Simple substatement.
7842 containing-sexp paren-state))
7848 containing-sexp paren-state))
7851 containing-sexp paren-state))))
7853 ;; CASE 18B: Some other substatement. This is shared
7854 ;; with case 10.
7856 char-after-ip
7857 placeholder
7858 lim
7859 paren-state)))
7861 ;; CASE 14: A case or default label
7867 containing-sexp))
7870 ;; Got a bogus label at the top level. In lack of better
7871 ;; alternatives, anchor it on (point-min).
7874 ;; CASE 15: any other label
7881 containing-decl-open
7882 containing-decl-start
7883 containing-decl-kwd
7884 paren-state))
7885 ;; Append access-label with the same anchor point as
7886 ;; inclass gets.
7892 containing-sexp))
7897 ;; If the surrounding statement is a switch then
7898 ;; let's analyze all labels as switch labels, so
7899 ;; that they get lined up consistently.
7900 'case-label
7906 ;; A label on the top level. Treat it as a class
7907 ;; context. (point-min) is the closest we get to the
7908 ;; class open brace.
7911 ;; CASE 4: In-expression statement. C.f. cases 7B, 16A and
7912 ;; 17E.
7915 containing-sexp
7916 ;; Have to turn on the heuristics after
7917 ;; the point even though it doesn't work
7918 ;; very well. C.f. test case class-16.pike.
7919 t))
7924 ;; It's a statement block or an anonymous class.
7926 ;; It's a Pike lambda. Check whether we are between the
7927 ;; lambda keyword and the argument list or at the defun
7928 ;; opener.
7930 'inline-open
7936 paren-state)
7940 ;; CASE 5: Line is inside a declaration level block or at top level.
7944 ;; CASE 5A: we are looking at a defun, brace list, class,
7945 ;; or inline-inclass method opening brace
7952 ;; CASE 5A.1: Non-class declaration block open.
7967 ;; Special case for extern-lang-open.
7968 'extern-lang-open
7970 nil t containing-sexp paren-state))
7972 ;; CASE 5A.2: we are looking at a class opening brace
7981 ;; CASE 5A.3: brace list open
8006 ))))
8010 ;; We're in Java and have found that the open brace
8011 ;; belongs to a "new Foo[]" initialization list,
8012 ;; which means the brace list is part of an
8013 ;; expression and not a top level definition. We
8014 ;; therefore treat it as any topmost continuation
8015 ;; even though the semantically correct symbol still
8016 ;; is brace-list-open, on the same grounds as in
8017 ;; case B.2.
8023 ;; CASE 5A.4: inline defun open
8029 containing-decl-open
8030 containing-decl-start
8031 containing-decl-kwd
8032 paren-state))
8034 ;; CASE 5A.5: ordinary defun open
8042 ;; Bogus to use bol here, but it's the legacy. (Resolved,
8043 ;; 2007-11-09)
8044 ))))
8046 ;; CASE 5B: After a function header but before the body (or
8047 ;; the ending semicolon if there's no body).
8053 ;; CASE 5B.1: Member init list.
8058 ;; There is no preceding member init clause.
8059 ;; Indent relative to the beginning of indentation
8060 ;; for the topmost-intro line that contains the
8061 ;; prototype's open paren.
8064 ;; Indent relative to the first member init clause.
8069 ;; CASE 5B.2: K&R arg decl intro
8076 containing-decl-open
8077 containing-decl-start
8078 containing-decl-kwd
8079 paren-state)))
8081 ;; CASE 5B.4: Nether region after a C++ or Java func
8082 ;; decl, which could include a `throws' declaration.
8086 )))
8088 ;; CASE 5C: inheritance line. could be first inheritance
8089 ;; line, or continuation of a multiple inheritance
8097 ;; watch out for scope operator
8102 )))
8111 ;; for Java
8116 cont done)
8121 done t))
8125 )
8127 injava-inher)
8130 ))
8133 ;; CASE 5C.1: non-hanging colon on an inher intro
8137 ;; don't add inclass symbol since relative point already
8138 ;; contains any class offset
8139 )
8141 ;; CASE 5C.2: hanging colon on an inher intro
8147 containing-decl-open
8148 containing-decl-start
8149 containing-decl-kwd
8150 paren-state)))
8152 ;; CASE 5C.3: in a Java implements/extends
8166 )))
8168 ;; CASE 5C.4: a continued inheritance line
8172 ;; don't add inclass symbol since relative point already
8173 ;; contains any class offset
8174 )))
8176 ;; CASE 5D: this could be a top-level initialization, a
8177 ;; member init list continuation, or a template argument
8178 ;; list continuation.
8180 ;; Note: We use the fact that lim always is after any
8181 ;; preceding brace sexp.
8191 t))
8196 t)
8202 nil)
8203 t))
8205 ;; NB: No c-after-special-operator-id stuff in this
8206 ;; clause - we assume only C++ needs it.
8211 ;; CASE 5D.3: perhaps a template list continuation?
8226 ;; In a nested template arglist.
8232 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
8233 ;; template aware.
8236 ;; CASE 5D.4: perhaps a multiple inheritance line?
8248 t)
8253 ;; CASE 5D.5: Continuation of the "expression part" of a
8254 ;; top level construct. Or, perhaps, an unrecognised construct.
8266 ;; A preceding comma at the top level means that a
8267 ;; new variable declaration starts here. Use
8268 ;; topmost-intro-cont for it, for consistency with
8269 ;; the first variable declaration. C.f. case 5N.
8272 nil nil containing-sexp paren-state))
8273 ))
8275 ;; CASE 5F: Close of a non-class declaration level block.
8279 ;; This is inconsistent: Should use `containing-decl-open'
8280 ;; here if it's at boi, like in case 5J.
8284 ;; Special case for compatibility with the
8285 ;; extern-lang syntactic symbols.
8286 'extern-lang-close
8289 nil t
8291 paren-state))
8293 ;; CASE 5G: we are looking at the brace which closes the
8294 ;; enclosing nested class decl
8299 containing-decl-open
8300 containing-decl-start
8301 containing-decl-kwd
8302 paren-state))
8304 ;; CASE 5H: we could be looking at subsequent knr-argdecls
8311 ;; Do an extra check to avoid tripping up on
8312 ;; statements that occur in invalid contexts
8313 ;; (e.g. in macro bodies where we don't really
8314 ;; know the context of what we're looking at).
8321 ;; CASE 5I: ObjC method definition.
8326 ;; Handle the case when it's the first (non-comment)
8327 ;; thing in the buffer. Can't look for a 'same return
8328 ;; value from cbos1 since ObjC directives currently
8329 ;; aren't recognized fully, so that we get 'same
8330 ;; instead of 'previous if it moved over a preceding
8331 ;; directive.
8335 ;; CASE 5P: AWK pattern or function or continuation
8336 ;; thereof.
8342 'topmost-intro-cont
8344 nil nil
8345 containing-sexp paren-state))
8347 ;; CASE 5N: At a variable declaration that follows a class
8348 ;; definition or some other block declaration that doesn't
8349 ;; end at the closing '}'. C.f. case 5D.5.
8358 ;; Speed up the backward search a bit.
8363 ;; The '}' is unbalanced.
8364 nil
8369 containing-sexp paren-state))
8371 ;; NOTE: The point is at the end of the previous token here.
8373 ;; CASE 5J: we are at the topmost level, make
8374 ;; sure we skip back past any access specifiers
8376 ;; A macro continuation line is never at top level.
8398 nil)))))
8399 ;; For historic reasons we anchor at bol of the last
8400 ;; line of the previous declaration. That's clearly
8401 ;; highly bogus and useless, and it makes our lives hard
8402 ;; to remain compatible. :P
8413 ;; Special case for compatibility with the
8414 ;; extern-lang syntactic symbols.
8415 'inextern-lang
8418 nil t
8420 paren-state))
8422 containing-decl-open
8423 containing-decl-start
8424 containing-decl-kwd
8425 paren-state)))
8427 macro-start
8432 ;; CASE 5K: we are at an ObjC method definition
8433 ;; continuation line.
8442 ;; CASE 5L: we are at the first argument of a template
8443 ;; arglist that begins on the previous line.
8451 ;; CASE 5Q: we are at a statement within a macro.
8456 ;; CASE 5M: we are at a topmost continuation line
8467 ))
8469 ;; (CASE 6 has been removed.)
8471 ;; CASE 7: line is an expression, not a statement. Most
8472 ;; likely we are either in a function prototype or a function
8473 ;; call argument list
8481 ;; CASE 7A: we are looking at the arglist closing paren.
8482 ;; C.f. case 7F.
8494 paren-state))
8496 ;; CASE 7B: Looking at the opening brace of an
8497 ;; in-expression block or brace list. C.f. cases 4, 16A
8498 ;; and 17E.
8502 paren-state))
8506 placeholder
8509 paren-state)
8510 containing-sexp)))
8511 ;; placeholder is nil if it's a block directly in
8512 ;; a function arglist. That makes us skip out of
8513 ;; this case.
8514 )))
8519 paren-state)
8523 ;; CASE 7C: we are looking at the first argument in an empty
8524 ;; argument list. Use arglist-close if we're actually
8525 ;; looking at a close paren or bracket.
8537 paren-state))
8539 ;; CASE 7D: we are inside a conditional test clause. treat
8540 ;; these things as statements
8550 ))
8552 ;; CASE 7E: maybe a continued ObjC method call. This is the
8553 ;; case when we are inside a [] bracketed exp, and what
8554 ;; precede the opening bracket is not an identifier.
8562 )))
8564 ;; CASE 7F: we are looking at an arglist continuation line,
8565 ;; but the preceding argument is on the same line as the
8566 ;; opening paren. This case includes multi-line
8567 ;; mathematical paren groupings, but we could be on a
8568 ;; for-list continuation line. C.f. case 7A.
8585 paren-state))
8587 ;; CASE 7G: we are looking at just a normal arglist
8588 ;; continuation line
8591 ))
8593 ;; CASE 8: func-local multi-inheritance line
8603 ;; CASE 8A: non-hanging colon on an inher intro
8608 ;; CASE 8B: hanging colon on an inher intro
8612 ;; CASE 8C: a continued inheritance line
8616 )))
8618 ;; CASE 9: we are inside a brace-list
8628 ;; CASE 9A: In the middle of a special brace list opener.
8648 ;; CASE 9B: brace-list-close brace
8650 ;; Check special brace list closer.
8657 ;; We were between the special close char and the `)'.
8660 ;; We were before the special close char.
8664 ;; Normal brace list check.
8675 ;; Prepare for the rest of the cases below by going to the
8676 ;; token following the opening brace
8689 ;; CASE 9C: we're looking at the first line in a brace-list
8700 ;; CASE 9D: this is just a later brace-list-entry or
8701 ;; brace-entry-open
8710 ))
8711 ))))
8713 ;; CASE 10: A continued statement or top level construct.
8723 ;; This is shared with case 18.
8725 char-after-ip
8726 placeholder
8727 containing-sexp
8728 paren-state))
8730 ;; CASE 16: block close brace, possibly closing the defun or
8731 ;; the class
8733 ;; From here on we have the next containing sexp in lim.
8738 ;; CASE 16E: Closing a statement block? This catches
8739 ;; cases where it's preceded by a statement keyword,
8740 ;; which works even when used in an "invalid" context,
8741 ;; e.g. a macro argument.
8746 ;; CASE 16A: closing a lambda defun or an in-expression
8747 ;; block? C.f. cases 4, 7B and 17E.
8750 nil))
8752 'inline-close
8762 paren-state)
8766 ;; CASE 16B: does this close an inline or a function in
8767 ;; a non-class declaration level block?
8774 nil))
8784 ;; CASE 16F: Can be a defun-close of a function declared
8785 ;; in a statement block, e.g. in Pike or when using gcc
8786 ;; extensions, but watch out for macros followed by
8787 ;; blocks. Let it through to be handled below.
8788 ;; C.f. cases B.3 and 17G.
8794 ;; Turn off recognition of constructs that
8795 ;; lacks a type in this case, since that's more
8796 ;; likely to be a macro followed by a block.
8803 ;; CASE 16C: If there is an enclosing brace then this is
8804 ;; a block close since defun closes inside declaration
8805 ;; level blocks have been handled above.
8807 ;; If the block is preceded by a case/switch label on
8808 ;; the same line, we anchor at the first preceding label
8809 ;; at boi. The default handling in c-add-stmt-syntax
8810 ;; really fixes it better, but we do like this to keep
8811 ;; the indentation compatible with version 5.28 and
8812 ;; earlier. C.f. case 17H.
8819 ;; c-backward-to-block-anchor not necessary here; those
8820 ;; situations are handled in case 16E above.
8823 ;; CASE 16D: Only top level defun close left.
8829 paren-state))
8830 ))
8832 ;; CASE 17: Statement or defun catchall.
8835 ;; Back up statements until we find one that starts at boi.
8838 containing-sexp)))
8842 nil)
8847 ;; CASE 17B: continued statement
8851 containing-sexp paren-state))
8853 ;; CASE 17A: After a case/default label?
8861 'statement-case-open
8863 nil t containing-sexp paren-state))
8865 ;; CASE 17D: any old statement
8872 containing-sexp paren-state)
8876 ;; CASE 17I: Inside a substatement block.
8878 ;; The following tests are all based on containing-sexp.
8880 ;; From here on we have the next containing sexp in lim.
8885 lim paren-state)
8889 ;; CASE 17E: first statement in an in-expression block.
8890 ;; C.f. cases 4, 7B and 16A.
8893 nil))
8895 'defun-block-intro
8904 paren-state)
8910 ;; CASE 17F: first statement in an inline, or first
8911 ;; statement in a top-level defun. we can tell this is it
8912 ;; if there are no enclosing braces that haven't been
8913 ;; narrowed out by a class (i.e. don't use bod here).
8916 paren-state)))
8922 nil))))
8927 ;; CASE 17G: First statement in a function declared inside
8928 ;; a normal block. This can occur in Pike and with
8929 ;; e.g. the gcc extensions, but watch out for macros
8930 ;; followed by blocks. C.f. cases B.3 and 16F.
8936 ;; Turn off recognition of constructs that lacks
8937 ;; a type in this case, since that's more likely
8938 ;; to be a macro followed by a block.
8944 lim paren-state))
8946 ;; CASE 17H: First statement in a block.
8948 ;; If the block is preceded by a case/switch label on the
8949 ;; same line, we anchor at the first preceding label at
8950 ;; boi. The default handling in c-add-stmt-syntax is
8951 ;; really fixes it better, but we do like this to keep the
8952 ;; indentation compatible with version 5.28 and earlier.
8953 ;; C.f. case 16C.
8960 ;; c-backward-to-block-anchor not necessary here; those
8961 ;; situations are handled in case 17I above.
8963 lim paren-state))
8966 ))
8967 )
8969 ;; now we need to look at any modifiers
8973 ;; are we looking at a comment only line?
8978 ;; we might want to give additional offset to friends (in C++).
8983 ;; Set syntactic-relpos.
8989 nil)
8990 t))
8993 ;; Start of or a continuation of a preprocessor directive?
9008 ;; If inside a cpp expression, i.e. anywhere in a
9009 ;; cpp directive except a #define body, we only let
9010 ;; through the syntactic analysis that is internal
9011 ;; in the expression. That means the arglist
9012 ;; elements, if they are anchored inside the cpp
9013 ;; expression.
9022 ;; Inside a #define body and the syntactic analysis is
9023 ;; anchored on the start of the #define. In this case
9024 ;; we add cpp-define-intro to get the extra
9025 ;; indentation of the #define body.
9028 ;; return the syntax
9029 c-syntactic-context)))
9031 \f
9032 ;; Indentation calculation.
9035 ;; offset can be a number, a function, a variable, a list, or one of
9036 ;; the symbols + or -
9037 ;;
9038 ;; This function might do hidden buffer changes.
9057 langelem symbol))
9063 offset symbol)
9064 nil)
9078 Error evaluating offset %S for %s: \
9079 Cannot combine absolute offset %S with relative %S in `%s' method"
9085 Error evaluating offset %S for %s: \
9086 Cannot combine relative offset %S with absolute %S in `%s' method"
9091 res))
9109 Error evaluating offset %S for %s: \
9110 Cannot combine absolute offsets %S and %S in `add' method"
9114 res))
9123 res))))
9130 nil))))
9134 res
9136 offset symbol res)
9137 nil)))
9140 ;; Get offset from LANGELEM which is a list beginning with the
9141 ;; syntactic symbol and followed by any analysis data it provides.
9142 ;; That data may be zero or more elements, but if at least one is
9143 ;; given then the first is the anchor position (or nil). The symbol
9144 ;; is matched against `c-offsets-alist' and the offset calculated
9145 ;; from that is returned.
9146 ;;
9147 ;; This function might do hidden buffer changes.
9157 offset
9161 ))
9164 ;; This is a compatibility wrapper for `c-calc-offset' in case
9165 ;; someone is calling it directly. It takes an old style syntactic
9166 ;; element on the form (SYMBOL . ANCHOR-POS) and converts it to the
9167 ;; new list form.
9168 ;;
9169 ;; This function might do hidden buffer changes.
9176 ;; Calculate the syntactic indentation from a syntactic description
9177 ;; as returned by `c-guess-syntax'.
9178 ;;
9179 ;; Note that topmost-intro always has an anchor position at bol, for
9180 ;; historical reasons. It's often used together with other symbols
9181 ;; that has more sane positions. Since we always use the first
9182 ;; found anchor position, we rely on that these other symbols always
9183 ;; precede topmost-intro in the LANGELEMS list.
9184 ;;
9185 ;; This function might do hidden buffer changes.
9193 ;; Got an absolute column that overrides any indentation
9194 ;; we've collected so far, but not the relative
9195 ;; indentation we might get for the nested structures
9196 ;; further down the langelems list.
9200 ;; Got a relative change of the current calculated
9201 ;; indentation.
9204 ;; Use the anchor position from the first syntactic
9205 ;; element with one.
9215 indent)))
9217 \f
9220 ;;; arch-tag: 149add18-4673-4da5-ac47-6805e4eae089
9221 ;;; cc-engine.el ends here