| blob | 32c82eb1c1d2345ebc99eb12056152f047196e02 |
1 ;;; cc-engine.el --- core syntax guessing engine for CC mode
3 ;; Copyright (C) 1985,1987,1992-2003, 2004, 2005, 2006 Free Software Foundation,
4 ;; Inc.
6 ;; Authors: 1998- Martin Stjernholm
7 ;; 1992-1999 Barry A. Warsaw
8 ;; 1987 Dave Detlefs and Stewart Clamen
9 ;; 1985 Richard M. Stallman
10 ;; Maintainer: bug-cc-mode@gnu.org
11 ;; Created: 22-Apr-1997 (split from cc-mode.el)
12 ;; Version: See cc-mode.el
13 ;; Keywords: c languages oop
15 ;; This file is part of GNU Emacs.
17 ;; GNU Emacs is free software; you can redistribute it and/or modify
18 ;; it under the terms of the GNU General Public License as published by
19 ;; the Free Software Foundation; either version 2, or (at your option)
20 ;; any later version.
22 ;; GNU Emacs is distributed in the hope that it will be useful,
23 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
24 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 ;; GNU General Public License for more details.
27 ;; You should have received a copy of the GNU General Public License
28 ;; along with this program; see the file COPYING. If not, write to
29 ;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
30 ;; Boston, MA 02110-1301, USA.
32 ;;; Commentary:
34 ;; The functions which have docstring documentation can be considered
35 ;; part of an API which other packages can use in CC Mode buffers.
36 ;; Otoh, undocumented functions and functions with the documentation
37 ;; in comments are considered purely internal and can change semantics
38 ;; or even disappear in the future.
39 ;;
40 ;; (This policy applies to CC Mode as a whole, not just this file. It
41 ;; probably also applies to many other Emacs packages, but here it's
42 ;; clearly spelled out.)
44 ;; Hidden buffer changes
45 ;;
46 ;; Various functions in CC Mode use text properties for caching and
47 ;; syntactic markup purposes, and those of them that might modify such
48 ;; properties but still don't modify the buffer in a visible way are
49 ;; said to do "hidden buffer changes". They should be used within
50 ;; `c-save-buffer-state' or a similar function that saves and restores
51 ;; buffer modifiedness, disables buffer change hooks, etc.
52 ;;
53 ;; Interactive functions are assumed to not do hidden buffer changes,
54 ;; except in the specific parts of them that do real changes.
55 ;;
56 ;; Lineup functions are assumed to do hidden buffer changes. They
57 ;; must not do real changes, though.
58 ;;
59 ;; All other functions that do hidden buffer changes have that noted
60 ;; in their doc string or comment.
61 ;;
62 ;; The intention with this system is to avoid wrapping every leaf
63 ;; function that do hidden buffer changes inside
64 ;; `c-save-buffer-state'. It should be used as near the top of the
65 ;; interactive functions as possible.
66 ;;
67 ;; Functions called during font locking are allowed to do hidden
68 ;; buffer changes since the font-lock package run them in a context
69 ;; similar to `c-save-buffer-state' (in fact, that function is heavily
70 ;; inspired by `save-buffer-state' in the font-lock package).
72 ;; Use of text properties
73 ;;
74 ;; CC Mode uses several text properties internally to mark up various
75 ;; positions, e.g. to improve speed and to eliminate glitches in
76 ;; interactive refontification.
77 ;;
78 ;; Note: This doc is for internal use only. Other packages should not
79 ;; assume that these text properties are used as described here.
80 ;;
81 ;; 'syntax-table
82 ;; Used to modify the syntax of some characters. Currently used to
83 ;; mark the "<" and ">" of angle bracket parens with paren syntax.
84 ;;
85 ;; This property is used on single characters and is therefore
86 ;; always treated as front and rear nonsticky (or start and end open
87 ;; in XEmacs vocabulary). It's therefore installed on
88 ;; `text-property-default-nonsticky' if that variable exists (Emacs
89 ;; >= 21).
90 ;;
91 ;; 'c-is-sws and 'c-in-sws
92 ;; Used by `c-forward-syntactic-ws' and `c-backward-syntactic-ws' to
93 ;; speed them up. See the comment blurb before `c-put-is-sws'
94 ;; below for further details.
95 ;;
96 ;; 'c-type
97 ;; This property is used on single characters to mark positions with
98 ;; special syntactic relevance of various sorts. Its primary use is
99 ;; to avoid glitches when multiline constructs are refontified
100 ;; interactively (on font lock decoration level 3). It's cleared in
101 ;; a region before it's fontified and is then put on relevant chars
102 ;; in that region as they are encountered during the fontification.
103 ;; The value specifies the kind of position:
104 ;;
105 ;; 'c-decl-arg-start
106 ;; Put on the last char of the token preceding each declaration
107 ;; inside a declaration style arglist (typically in a function
108 ;; prototype).
109 ;;
110 ;; 'c-decl-end
111 ;; Put on the last char of the token preceding a declaration.
112 ;; This is used in cases where declaration boundaries can't be
113 ;; recognized simply by looking for a token like ";" or "}".
114 ;; `c-type-decl-end-used' must be set if this is used (see also
115 ;; `c-find-decl-spots').
116 ;;
117 ;; 'c-<>-arg-sep
118 ;; Put on the commas that separate arguments in angle bracket
119 ;; arglists like C++ template arglists.
120 ;;
121 ;; 'c-decl-id-start and 'c-decl-type-start
122 ;; Put on the last char of the token preceding each declarator
123 ;; in the declarator list of a declaration. They are also used
124 ;; between the identifiers cases like enum declarations.
125 ;; 'c-decl-type-start is used when the declarators are types,
126 ;; 'c-decl-id-start otherwise.
127 ;;
128 ;; 'c-awk-NL-prop
129 ;; Used in AWK mode to mark the various kinds of newlines. See
130 ;; cc-awk.el.
132 ;;; Code:
139 load-path)))
146 ;; Silence the compiler.
149 \f
150 ;; Make declarations for all the `c-lang-defvar' variables in cc-langs.
163 \f
164 ;;; Internal state variables.
166 ;; Internal state of hungry delete key feature
170 ;; The electric flag (toggled by `c-toggle-electric-state').
171 ;; If t, electric actions (like automatic reindentation, and (if
172 ;; c-auto-newline is also set) auto newlining) will happen when an electric
173 ;; key like `{' is pressed (or an electric keyword like `else').
177 ;; Internal state of auto newline feature.
181 ;; Included in the mode line to indicate the active submodes.
182 ;; (defvar c-submode-indicators nil)
183 ;; (make-variable-buffer-local 'c-submode-indicators)
186 ;; Calculate the new state of PREVSTATE, t or nil, based on arg. If
187 ;; arg is nil or zero, toggle the state. If arg is negative, turn
188 ;; the state off, and if arg is positive, turn the state on
194 ;; Dynamically bound cache for `c-in-literal'.
197 \f
198 ;; Basic handling of preprocessor directives.
200 ;; This is a dynamically bound cache used together with
201 ;; `c-query-macro-start' and `c-query-and-set-macro-start'. It only
202 ;; works as long as point doesn't cross a macro boundary.
211 c-macro-start))
219 c-macro-start))
222 "Go to the beginning of a preprocessor directive.
223 Leave point at the beginning of the directive and return t if in one,
224 otherwise return nil and leave point unchanged.
226 Note that this function might do hidden buffer changes. See the
227 comment at the start of cc-engine.el for more info."
238 t
240 nil)))))
243 "Go to the end of a preprocessor directive.
244 More accurately, move the point to the end of the closest following
245 line that doesn't end with a line continuation backslash - no check is
246 done that the point is inside a cpp directive to begin with.
248 Note that this function might do hidden buffer changes. See the
249 comment at the start of cc-engine.el for more info."
255 t))))
258 ;; Assuming point is at the "#" that introduces a preprocessor
259 ;; directive, it's moved forward to the start of the definition body
260 ;; if it's a "#define" (or whatever c-opt-cpp-macro-define
261 ;; specifies). Non-nil is returned in this case, in all other cases
262 ;; nil is returned and point isn't moved.
263 ;;
264 ;; This function might do hidden buffer changes.
270 \f
271 ;;; Basic utility functions.
274 ;; Return the given region as a string where all syntactic
275 ;; whitespace is removed or, where necessary, replaced with a single
276 ;; space. If PAREN-LEVEL is given then all parens in the region are
277 ;; collapsed to "()", "[]" etc.
278 ;;
279 ;; This function might do hidden buffer changes.
323 ;; Shift the indentation of the current line with the specified
324 ;; amount (positive inwards). The buffer is modified only if
325 ;; SHIFT-AMT isn't equal to zero.
328 tmp-char-inserted)
330 nil
331 ;; If we're on an empty line inside a macro, we take the point
332 ;; to be at the current indentation and shift it to the
333 ;; appropriate column. This way we don't treat the extra
334 ;; whitespace out to the line continuation as indentation.
350 ;; If initial point was within line's indentation and we're not on
351 ;; a line with a line continuation in a macro, position after the
352 ;; indentation. Else stay at same point in text.
360 ;; Return non-nil if the string KEYWORD is a known keyword. More
361 ;; precisely, the value is the symbol for the keyword in
362 ;; `c-keywords-obarray'.
366 ;; Return non-nil if the symbol KEYWORD-SYM, as returned by
367 ;; `c-keyword-sym', is a member of LANG-CONSTANT, which is the name
368 ;; of a language constant that ends with "-kwds". If KEYWORD-SYM is
369 ;; nil then the result is nil.
372 ;; String syntax chars, suitable for skip-syntax-(forward|backward).
377 ;; Regexp matching string limit syntax.
382 ;; Regexp matching WS followed by string limit syntax.
386 ;; Holds formatted error strings for the few cases where parse errors
387 ;; are reported.
394 c-parsing-error)
396 ;; Faces given to comments and string literals. This is used in some
397 ;; situations to speed up recognition; it isn't mandatory that font
398 ;; locking is in use. This variable is extended with the face in
399 ;; `c-doc-face-name' when fontification is activated in cc-fonts.el.
403 ;; New in Emacs 22.
407 ;; Put a c-type property with the given value at POS.
411 ;; Remove all occurences of the c-type property that has the given
412 ;; value in the region between FROM and TO. VALUE is assumed to not
413 ;; be nil.
414 ;;
415 ;; Note: This assumes that c-type is put on single chars only; it's
416 ;; very inefficient if matching properties cover large regions.
425 \f
426 ;; Some debug tools to visualize various special positions. This
427 ;; debug code isn't as portable as the rest of CC Mode.
463 \f
464 ;; `c-beginning-of-statement-1' and accompanying stuff.
466 ;; KLUDGE ALERT: c-maybe-labelp is used to pass information between
467 ;; c-crosses-statement-barrier-p and c-beginning-of-statement-1. A
468 ;; better way should be implemented, but this will at least shut up
469 ;; the byte compiler.
472 ;; New awk-compatible version of c-beginning-of-statement-1, ACM 2002/6/22
474 ;; Macros used internally in c-beginning-of-statement-1 for the
475 ;; automaton actions.
478 stack)))
483 t
484 ,do-if-done
489 ;; Throw nil if stack is empty, else throw non-nil.
513 noerror comma-delim)
514 "Move to the start of the current statement or declaration, or to
515 the previous one if already at the beginning of one. Only
516 statements/declarations on the same level are considered, i.e. don't
517 move into or out of sexps (not even normal expression parentheses).
521 is within the continuation. If starting at such a token, move to the
522 corresponding statement start. If at the beginning of a statement,
523 move to the closest containing statement if there is any. This might
524 also stop at a continuation clause.
526 Labels are treated as part of the following statements if
527 IGNORE-LABELS is non-nil. (FIXME: Doesn't work if we stop at a known
528 statement start keyword.) Otherwise, each label is treated as a
529 separate statement.
531 Macros are ignored \(i.e. skipped over) unless point is within one, in
532 which case the content of the macro is treated as normal code. Aside
533 from any normal statement starts found in it, stop at the first token
536 macros before leaving them.
538 Return 'label if stopped at a label, 'same if stopped at the beginning
539 of the current statement, 'up if stepped to a containing statement,
540 'previous if stepped to a preceding statement, 'beginning if stepped
541 from a statement continuation clause to its start clause, or 'macro if
542 stepped to a macro start. Note that 'same and not 'label is returned
543 if stopped at the same label without crossing the colon character.
545 LIM may be given to limit the search. If the search hits the limit,
546 point will be left at the closest following token, or at the start
547 position if that is less ('same is returned in this case).
549 NOERROR turns off error logging to `c-parsing-error'.
551 Normally only ';' and virtual semicolons are considered to delimit
552 statements, but if COMMA-DELIM is non-nil then ',' is treated
553 as a delimiter too.
555 Note that this function might do hidden buffer changes. See the
556 comment at the start of cc-engine.el for more info."
558 ;; The bulk of this function is a pushdown automaton that looks at statement
559 ;; boundaries and the tokens (such as "while") in c-opt-block-stmt-key. Its
560 ;; purpose is to keep track of nested statements, ensuring that such
561 ;; statments are skipped over in their entirety (somewhat akin to what C-M-p
562 ;; does with nested braces/brackets/parentheses).
563 ;;
564 ;; Note: The position of a boundary is the following token.
565 ;;
566 ;; Beginning with the current token (the one following point), move back one
567 ;; sexp at a time (where a sexp is, more or less, either a token or the
568 ;; entire contents of a brace/bracket/paren pair). Each time a statement
569 ;; boundary is crossed or a "while"-like token is found, update the state of
570 ;; the PDA. Stop at the beginning of a statement when the stack (holding
571 ;; nested statement info) is empty and the position has been moved.
572 ;;
573 ;; The following variables constitute the PDA:
574 ;;
575 ;; sym: This is either the "while"-like token (e.g. 'for) we've just
576 ;; scanned back over, 'boundary if we've just gone back over a
577 ;; statement boundary, or nil otherwise.
578 ;; state: takes one of the values (nil else else-boundary while
579 ;; while-boundary catch catch-boundary).
580 ;; nil means "no "while"-like token yet scanned".
581 ;; 'else, for example, means "just gone back over an else".
582 ;; 'else-boundary means "just gone back over a statement boundary
583 ;; immediately after having gone back over an else".
584 ;; saved-pos: A vector of either saved positions (tok ptok pptok, etc.) or
585 ;; of error reporting information.
586 ;; stack: The stack onto which the PDA pushes its state. Each entry
587 ;; consists of a saved value of state and saved-pos. An entry is
588 ;; pushed when we move back over a "continuation" token (e.g. else)
589 ;; and popped when we encounter the corresponding opening token
590 ;; (e.g. if).
591 ;;
592 ;;
593 ;; The following diagram briefly outlines the PDA.
594 ;;
595 ;; Common state:
596 ;; "else": Push state, goto state `else'.
597 ;; "while": Push state, goto state `while'.
598 ;; "catch" or "finally": Push state, goto state `catch'.
599 ;; boundary: Pop state.
600 ;; other: Do nothing special.
601 ;;
602 ;; State `else':
603 ;; boundary: Goto state `else-boundary'.
604 ;; other: Error, pop state, retry token.
605 ;;
606 ;; State `else-boundary':
607 ;; "if": Pop state.
608 ;; boundary: Error, pop state.
609 ;; other: See common state.
610 ;;
611 ;; State `while':
612 ;; boundary: Save position, goto state `while-boundary'.
613 ;; other: Pop state, retry token.
614 ;;
615 ;; State `while-boundary':
616 ;; "do": Pop state.
617 ;; boundary: Restore position if it's not at start, pop state. [*see below]
618 ;; other: See common state.
619 ;;
620 ;; State `catch':
621 ;; boundary: Goto state `catch-boundary'.
622 ;; other: Error, pop state, retry token.
623 ;;
624 ;; State `catch-boundary':
625 ;; "try": Pop state.
626 ;; "catch": Goto state `catch'.
627 ;; boundary: Error, pop state.
628 ;; other: See common state.
629 ;;
630 ;; [*] In the `while-boundary' state, we had pushed a 'while state, and were
631 ;; searching for a "do" which would have opened a do-while. If we didn't
632 ;; find it, we discard the analysis done since the "while", go back to this
633 ;; token in the buffer and restart the scanning there, this time WITHOUT
634 ;; pushing the 'while state onto the stack.
635 ;;
636 ;; In addition to the above there is some special handling of labels
637 ;; and macros.
641 macro-start
644 c-stmt-delim-chars-with-comma
645 c-stmt-delim-chars))
646 c-in-literal-cache c-maybe-labelp saved
647 ;; Current position.
648 pos
649 ;; Position of last stmt boundary character (e.g. ;).
650 boundary-pos
651 ;; The position of the last sexp or bound that follows the
652 ;; first found colon, i.e. the start of the nonlabel part of
653 ;; the statement. It's `start' if a colon is found just after
654 ;; the start.
655 after-labels-pos
656 ;; Like `after-labels-pos', but the first such position inside
657 ;; a label, i.e. the start of the last label before the start
658 ;; of the nonlabel part of the statement.
659 last-label-pos
660 ;; The last position where a label is possible provided the
661 ;; statement started there. It's nil as long as no invalid
662 ;; label content has been found (according to
663 ;; `c-nonlabel-token-key'. It's `start' if no valid label
664 ;; content was found in the label. Note that we might still
665 ;; regard it a label if it starts with `c-label-kwds'.
666 label-good-pos
667 ;; Symbol just scanned back over (e.g. 'while or 'boundary).
668 ;; See above.
669 sym
670 ;; Current state in the automaton. See above.
671 state
672 ;; Current saved positions. See above.
673 saved-pos
674 ;; Stack of conses (state . saved-pos).
675 stack
676 ;; Regexp which matches "for", "if", etc.
679 ;; Return value.
681 ;; Positions of the last three sexps or bounds we've stopped at.
682 tok ptok pptok)
692 ;; Try to skip back over unary operator characters, to register
693 ;; that we've moved.
697 ;; Protect post-++/-- operators just before a virtual semicolon.
701 ;; Skip back over any semicolon here. If it was a bare semicolon, we're
702 ;; done. Later on we ignore the boundaries for statements that don't
703 ;; contain any sexp. The only thing that is affected is that the error
704 ;; checking is a little less strict, and we really don't bother.
714 pos saved)
716 ;; Begin at start and not pos to detect macros if we stand
717 ;; directly after the #.
720 ;; Record this as the first token if not starting inside it.
723 ;; The following while loop goes back one sexp (balanced parens,
724 ;; etc. with contents, or symbol or suchlike) each iteration. This
725 ;; movement is accomplished with a call to scan-sexps approx 130 lines
726 ;; below.
744 ;; Stop at the first token in the content of the macro.
748 ret 'macro
749 ignore-labels t))
752 ;; Do a round through the automaton if we've just passed a
753 ;; statement boundary or passed a "while"-like token.
761 ;; The PDA state handling.
762 ;;
763 ;; Refer to the description of the PDA in the opening
764 ;; comments. In the following OR form, the first leaf
765 ;; attempts to handles one of the specific actions detailed
766 ;; (e.g., finding token "if" whilst in state `else-boundary').
767 ;; We drop through to the second leaf (which handles common
768 ;; state) if no specific handler is found in the first cond.
769 ;; If a parsing error is detected (e.g. an "else" with no
770 ;; preceding "if"), we throw to the enclosing catch.
771 ;;
772 ;; Note that the (eq state 'else) means
773 ;; "we've just passed an else", NOT "we're looking for an
774 ;; else".
791 ;; Since this can cause backtracking we do a
792 ;; little more careful analysis to avoid it:
793 ;; If there's a label in front of the while
794 ;; it can't be part of a do-while.
823 ;; This is state common. We get here when the previous
824 ;; cond statement found no particular state handler.
826 ;; If we have a boundary at the start
827 ;; position we push a frame to go to the
828 ;; previous statement.
837 ;; Is this a real while, or a do-while?
838 ;; The next `when' triggers unless we are SURE that
839 ;; the `while' is not the tailend of a `do-while'.
842 ;; The following kludge is to prevent
843 ;; infinite recursion when called from
844 ;; c-awk-after-if-for-while-condition-p,
845 ;; or the like.
849 ;; Since this can cause backtracking we do a
850 ;; little more careful analysis to avoid it: If
851 ;; the while isn't followed by a (possibly
852 ;; virtual) semicolon it can't be a do-while.
861 ;; We're either past a statement boundary or at the
862 ;; start of a statement, so throw away any label data
863 ;; for the previous one.
865 last-label-pos nil
866 c-maybe-labelp nil))))
868 ;; Step to the previous sexp, but not if we crossed a
869 ;; boundary, since that doesn't consume an sexp.
873 ;; HERE IS THE SINGLE PLACE INSIDE THE PDA LOOP WHERE WE MOVE
874 ;; BACKWARDS THROUGH THE SOURCE.
876 ;; This is typically fast with the caching done by
877 ;; c-(backward|forward)-sws.
881 ;; Set as long as we have to continue jumping by sexps.
882 ;; It's the position to use as end in the next round.
883 sexp-loop-continue-pos
884 ;; The end position of the area to search for statement
885 ;; barriers in this round.
888 ;; The following while goes back one sexp per iteration.
892 ;; Give up if we hit an unbalanced block. Since the
893 ;; stack won't be empty the code below will report a
894 ;; suitable error.
897 ;; Check if the sexp movement crossed a statement or
898 ;; declaration boundary. But first modify the point
899 ;; so that `c-crosses-statement-barrier-p' only looks
900 ;; at the non-sexp chars following the sexp.
903 boundary-pos
906 nil
909 ;; Set continuation position in case
910 ;; `c-crosses-statement-barrier-p'
911 ;; doesn't detect anything below.
913 ;; If the sexp movement took us into a
914 ;; macro then there were only some non-sexp
915 ;; chars after it. Skip out of the macro
916 ;; to analyze them but not the non-sexp
917 ;; chars that might be inside the macro.
925 ;; Passed a block sexp. That's a boundary
926 ;; alright.
930 ;; Passed some other paren. Only analyze
931 ;; the non-sexp chars after it.
933 before-sws-pos)))
934 ;; We're at a valid token start position
935 ;; (outside the `save-excursion') if
936 ;; `c-crosses-statement-barrier-p' failed.
941 ;; Passed a symbol sexp or line
942 ;; continuation. It doesn't matter that
943 ;; it's included in the analyzed region.
946 t
947 ;; If it was a line continuation then we
948 ;; have to continue looping.
951 nil))))
954 ptok tok
955 tok boundary-pos
957 ;; Like a C "continue". Analyze the next sexp.
963 sexp-loop-continue-pos nil))))
965 ;; ObjC method def?
972 ;; Handle labels.
975 ;; `c-crosses-statement-barrier-p' has found a colon, so we
976 ;; might be in a label now. Have we got a real label
977 ;; (including a case label) or something like C++'s "public:"?
982 ; wrong for AWK. 2006/1/14.
989 label-good-pos nil))
993 ; been found.
995 ;; We're in a potential label and it's the first
996 ;; time we've found something that isn't allowed in
997 ;; one.
1000 ;; We've moved back by a sexp, so update the token positions.
1002 pptok ptok
1003 ptok tok
1007 ;; If the stack isn't empty there might be errors to report.
1016 ;; Need to investigate closer whether we've crossed
1017 ;; between a substatement and its containing statement.
1019 ptok
1020 pptok))
1027 after-labels-pos
1033 last-label-pos
1034 pos))
1036 ;; We're in a label. Maybe we should step to the statement
1037 ;; after it.
1042 ;; Might have jumped over several labels. Go to the last one.
1045 ;; Skip over the unary operators that can start the statement.
1049 ;; protect AWK post-inc/decrement operators, etc.
1054 ret)))
1057 "Return non-nil if buffer positions FROM to TO cross one or more
1058 statement or declaration boundaries. The returned value is actually
1059 the position of the earliest boundary char. FROM must not be within
1060 a string or comment.
1062 The variable `c-maybe-labelp' is set to the position of the first `:' that
1063 might start a label (i.e. not part of `::' and not preceded by `?'). If a
1064 single `?' is found, then `c-maybe-labelp' is cleared.
1066 For AWK, a statement which is terminated by an EOL (not a \; or a }) is
1068 the line. If this virtual semicolon is _at_ from, the function recognises it.
1070 Note that this function might do hidden buffer changes. See the
1071 comment at the start of cc-engine.el for more info."
1073 lit-range)
1086 ;; Ignore scope operators.
1090 ;; A question mark. Can't be a label, so stop
1091 ;; looking for more : and ?.
1102 ;; In trailing space after an as yet undetected virtual semicolon?
1107 nil)))))
1110 "Return non-nil if the point is at the first token in a statement
1111 or somewhere in the syntactic whitespace before it.
1114 Any kind of declaration-like construct that occur outside function
1117 Note that this function might do hidden buffer changes. See the
1118 comment at the start of cc-engine.el for more info."
1122 c-maybe-labelp)
1133 "Return non-nil if the point is at the first token in an expression or
1134 statement, or somewhere in the syntactic whitespace before it.
1137 grammar sense: It's any sequence of expression tokens except commas,
1138 unless they are enclosed inside parentheses of some kind. Also, an
1139 expression never continues past an enclosing parenthesis, but it might
1140 contain parenthesis pairs of any sort except braces.
1142 Since expressions never cross statement boundaries, this function also
1143 recognizes statement beginnings, just like `c-at-statement-start-p'.
1145 Note that this function might do hidden buffer changes. See the
1146 comment at the start of cc-engine.el for more info."
1151 c-maybe-labelp)
1159 \f
1160 ;; A set of functions that covers various idiosyncrasies in
1161 ;; implementations of `forward-comment'.
1163 ;; Note: Some emacsen considers incorrectly that any line comment
1164 ;; ending with a backslash continues to the next line. I can't think
1165 ;; of any way to work around that in a reliable way without changing
1166 ;; the buffer, though. Suggestions welcome. ;) (No, temporarily
1167 ;; changing the syntax for backslash doesn't work since we must treat
1168 ;; escapes in string literals correctly.)
1171 "Move forward past whitespace and the closest following comment, if any.
1172 Return t if a comment was found, nil otherwise. In either case, the
1173 point is moved past the following whitespace. Line continuations,
1174 i.e. a backslashes followed by line breaks, are treated as whitespace.
1175 The line breaks that end line comments are considered to be the
1176 comment enders, so the point will be put on the beginning of the next
1177 line if it moved past a line comment.
1179 This function does not do any hidden buffer changes."
1187 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1188 ;; forwards at eob.
1189 nil
1191 ;; Emacs includes the ending newline in a b-style (c++)
1192 ;; comment, but XEmacs doesn't. We depend on the Emacs
1193 ;; behavior (which also is symmetric).
1197 t))))
1200 "Move forward past all following whitespace and comments.
1201 Line continuations, i.e. a backslashes followed by line breaks, are
1202 treated as whitespace.
1204 Note that this function might do hidden buffer changes. See the
1205 comment at the start of cc-engine.el for more info."
1208 ;; If forward-comment in at least XEmacs 21 is given a large
1209 ;; positive value, it'll loop all the way through if it hits
1210 ;; eob.
1212 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1213 ;; forwards at eob.
1218 t))))
1221 "Move backward past whitespace and the closest preceding comment, if any.
1222 Return t if a comment was found, nil otherwise. In either case, the
1223 point is moved past the preceding whitespace. Line continuations,
1224 i.e. a backslashes followed by line breaks, are treated as whitespace.
1225 The line breaks that end line comments are considered to be the
1226 comment enders, so the point cannot be at the end of the same line to
1227 move over a line comment.
1229 This function does not do any hidden buffer changes."
1232 ;; When we got newline terminated comments, forward-comment in all
1233 ;; supported emacsen so far will stop at eol of each line not
1234 ;; ending with a comment when moving backwards. This corrects for
1235 ;; that, and at the same time handles line continuations.
1243 ;; Some emacsen (e.g. Emacs 19.34) return t when moving
1244 ;; backwards at bob.
1245 nil
1247 ;; Leave point after the closest following newline if we've
1248 ;; backed up over any above, since forward-comment won't move
1249 ;; backward over a line comment if point is at the end of the
1250 ;; same line.
1255 ;; If forward-comment above succeeded and we're at eol
1256 ;; then the newline we moved over above didn't end a
1257 ;; line comment, so we give it another go.
1259 t))
1261 ;; Emacs <= 20 and XEmacs move back over the closer of a
1262 ;; block comment that lacks an opener.
1265 t)))))
1268 "Move backward past all preceding whitespace and comments.
1269 Line continuations, i.e. a backslashes followed by line breaks, are
1270 treated as whitespace. The line breaks that end line comments are
1271 considered to be the comment enders, so the point cannot be at the end
1272 of the same line to move over a line comment. Unlike
1273 c-backward-syntactic-ws, this function doesn't move back over
1274 preprocessor directives.
1276 Note that this function might do hidden buffer changes. See the
1277 comment at the start of cc-engine.el for more info."
1281 ;; `forward-comment' in some emacsen (e.g. XEmacs 21.4)
1282 ;; return t when moving backwards at bob.
1287 ;; Emacs <= 20 and XEmacs move back over the
1288 ;; closer of a block comment that lacks an opener.
1290 t)
1292 ;; XEmacs treats line continuations as whitespace but
1293 ;; only in the backward direction, which seems a bit
1294 ;; odd. Anyway, this is necessary for Emacs.
1299 t))))))
1301 \f
1302 ;; Tools for skipping over syntactic whitespace.
1304 ;; The following functions use text properties to cache searches over
1305 ;; large regions of syntactic whitespace. It works as follows:
1306 ;;
1307 ;; o If a syntactic whitespace region contains anything but simple
1308 ;; whitespace (i.e. space, tab and line breaks), the text property
1309 ;; `c-in-sws' is put over it. At places where we have stopped
1310 ;; within that region there's also a `c-is-sws' text property.
1311 ;; That since there typically are nested whitespace inside that
1312 ;; must be handled separately, e.g. whitespace inside a comment or
1313 ;; cpp directive. Thus, from one point with `c-is-sws' it's safe
1314 ;; to jump to another point with that property within the same
1315 ;; `c-in-sws' region. It can be likened to a ladder where
1316 ;; `c-in-sws' marks the bars and `c-is-sws' the rungs.
1317 ;;
1318 ;; o The `c-is-sws' property is put on the simple whitespace chars at
1319 ;; a "rung position" and also maybe on the first following char.
1320 ;; As many characters as can be conveniently found in this range
1321 ;; are marked, but no assumption can be made that the whole range
1322 ;; is marked (it could be clobbered by later changes, for
1323 ;; instance).
1324 ;;
1325 ;; Note that some part of the beginning of a sequence of simple
1326 ;; whitespace might be part of the end of a preceding line comment
1327 ;; or cpp directive and must not be considered part of the "rung".
1328 ;; Such whitespace is some amount of horizontal whitespace followed
1329 ;; by a newline. In the case of cpp directives it could also be
1330 ;; two newlines with horizontal whitespace between them.
1331 ;;
1332 ;; The reason to include the first following char is to cope with
1333 ;; "rung positions" that doesn't have any ordinary whitespace. If
1334 ;; `c-is-sws' is put on a token character it does not have
1335 ;; `c-in-sws' set simultaneously. That's the only case when that
1336 ;; can occur, and the reason for not extending the `c-in-sws'
1337 ;; region to cover it is that the `c-in-sws' region could then be
1338 ;; accidentally merged with a following one if the token is only
1339 ;; one character long.
1340 ;;
1341 ;; o On buffer changes the `c-in-sws' and `c-is-sws' properties are
1342 ;; removed in the changed region. If the change was inside
1343 ;; syntactic whitespace that means that the "ladder" is broken, but
1344 ;; a later call to `c-forward-sws' or `c-backward-sws' will use the
1345 ;; parts on either side and use an ordinary search only to "repair"
1346 ;; the gap.
1347 ;;
1348 ;; Special care needs to be taken if a region is removed: If there
1349 ;; are `c-in-sws' on both sides of it which do not connect inside
1350 ;; the region then they can't be joined. If e.g. a marked macro is
1351 ;; broken, syntactic whitespace inside the new text might be
1352 ;; marked. If those marks would become connected with the old
1353 ;; `c-in-sws' range around the macro then we could get a ladder
1354 ;; with one end outside the macro and the other at some whitespace
1355 ;; within it.
1356 ;;
1357 ;; The main motivation for this system is to increase the speed in
1358 ;; skipping over the large whitespace regions that can occur at the
1359 ;; top level in e.g. header files that contain a lot of comments and
1360 ;; cpp directives. For small comments inside code it's probably
1361 ;; slower than using `forward-comment' straightforwardly, but speed is
1362 ;; not a significant factor there anyway.
1364 ; (defface c-debug-is-sws-face
1365 ; '((t (:background "GreenYellow")))
1366 ; "Debug face to mark the `c-is-sws' property.")
1367 ; (defface c-debug-in-sws-face
1368 ; '((t (:underline t)))
1369 ; "Debug face to mark the `c-in-sws' property.")
1371 ; (defun c-debug-put-sws-faces ()
1372 ; ;; Put the sws debug faces on all the `c-is-sws' and `c-in-sws'
1373 ; ;; properties in the buffer.
1374 ; (interactive)
1375 ; (save-excursion
1376 ; (c-save-buffer-state (in-face)
1377 ; (goto-char (point-min))
1378 ; (setq in-face (if (get-text-property (point) 'c-is-sws)
1379 ; (point)))
1380 ; (while (progn
1381 ; (goto-char (next-single-property-change
1382 ; (point) 'c-is-sws nil (point-max)))
1383 ; (if in-face
1384 ; (progn
1385 ; (c-debug-add-face in-face (point) 'c-debug-is-sws-face)
1386 ; (setq in-face nil))
1387 ; (setq in-face (point)))
1388 ; (not (eobp))))
1389 ; (goto-char (point-min))
1390 ; (setq in-face (if (get-text-property (point) 'c-in-sws)
1391 ; (point)))
1392 ; (while (progn
1393 ; (goto-char (next-single-property-change
1394 ; (point) 'c-in-sws nil (point-max)))
1395 ; (if in-face
1396 ; (progn
1397 ; (c-debug-add-face in-face (point) 'c-debug-in-sws-face)
1398 ; (setq in-face nil))
1399 ; (setq in-face (point)))
1400 ; (not (eobp)))))))
1403 ;;`(message ,@args)
1404 )
1407 ;; This macro does a hidden buffer change.
1414 ;; This macro does a hidden buffer change.
1421 ;; This macro does a hidden buffer change.
1428 ;; This macro does a hidden buffer change.
1435 ;; This macro does a hidden buffer change.
1443 ;; Called from `after-change-functions'. Note that if
1444 ;; `c-forward-sws' or `c-backward-sws' are used outside
1445 ;; `c-save-buffer-state' or similar then this will remove the cache
1446 ;; properties right after they're added.
1447 ;;
1448 ;; This function does hidden buffer changes.
1451 ;; Adjust the end to remove the properties in any following simple
1452 ;; ws up to and including the next line break, if there is any
1453 ;; after the changed region. This is necessary e.g. when a rung
1454 ;; marked empty line is converted to a line comment by inserting
1455 ;; "//" before the line break. In that case the line break would
1456 ;; keep the rung mark which could make a later `c-backward-sws'
1457 ;; move into the line comment instead of over it.
1467 ;; Ensure that an `c-in-sws' range gets broken. Note that it isn't
1468 ;; safe to keep a range that was continuous before the change. E.g:
1469 ;;
1470 ;; #define foo
1471 ;; \
1472 ;; bar
1473 ;;
1474 ;; There can be a "ladder" between "#" and "b". Now, if the newline
1475 ;; after "foo" is removed then "bar" will become part of the cpp
1476 ;; directive instead of a syntactically relevant token. In that
1477 ;; case there's no longer syntactic ws from "#" to "b".
1484 ;; Used by `c-forward-syntactic-ws' to implement the unbounded search.
1485 ;;
1486 ;; This function might do hidden buffer changes.
1489 ;; unmarked part of the simple ws region.
1491 rung-is-marked next-rung-is-marked simple-ws-end
1492 ;; `safe-start' is set when it's safe to cache the start position.
1493 ;; It's not set if we've initially skipped over comments and line
1494 ;; continuations since we might have gone out through the end of a
1495 ;; macro then. This provision makes `c-forward-sws' not populate the
1496 ;; cache in the majority of cases, but otoh is `c-backward-sws' by far
1497 ;; more common.
1498 safe-start)
1500 ;; Skip simple ws and do a quick check on the following character to see
1501 ;; if it's anything that can't start syntactic ws, so we can bail out
1502 ;; early in the majority of cases when there just are a few ws chars.
1509 ;; Find the last rung position to avoid setting properties in all
1510 ;; the cases when the marked rung is complete.
1511 ;; (`next-single-property-change' is certain to move at least one
1512 ;; step forward.)
1515 ;; Got no marked rung here. Since the simple ws might have started
1516 ;; inside a line comment or cpp directive we must set `rung-pos' as
1517 ;; high as possible.
1526 ;; The following search is the main reason that `c-in-sws'
1527 ;; and `c-is-sws' aren't combined to one property.
1531 ;; If the `c-in-sws' region extended past the last
1532 ;; `c-is-sws' char we have to go back a bit.
1539 "c-forward-sws cached move %s -> %s (max %s)"
1546 ;; We'll loop here if there is simple ws after the last rung.
1547 ;; That means that there's been some change in it and it's
1548 ;; possible that we've stepped into another ladder, so extend
1549 ;; the previous one to join with it if there is one, and try to
1550 ;; use the cache again.
1552 "c-forward-sws extending rung with [%s..%s] (max %s)"
1555 ;; Remove any `c-in-sws' property from the last char of
1556 ;; the rung before we mark it with `c-is-sws', so that we
1557 ;; won't connect with the remains of a broken "ladder".
1563 last-put-in-sws-pos rung-pos)))
1570 ;; Skipped over comments. Don't cache at eob in case the buffer
1571 ;; is narrowed.
1582 ;; Skip a preprocessor directive.
1589 ;; Don't cache at eob in case the buffer is narrowed.
1592 ;; We've searched over a piece of non-white syntactic ws. See if this
1593 ;; can be cached.
1599 ;; Cache if we haven't skipped comments only, and if we started
1600 ;; either from a marked rung or from a completely uncached
1601 ;; position.
1606 ;; See if there's a marked rung in the encountered simple ws. If
1607 ;; so then we can cache, unless `safe-start' is nil. Even then
1608 ;; we need to do this to check if the cache can be used for the
1609 ;; next step.
1613 safe-start))
1617 "c-forward-sws caching [%s..%s] - [%s..%s] (max %s)"
1621 ;; Remove the properties for any nested ws that might be cached.
1622 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
1623 ;; anyway.
1631 last-put-in-sws-pos rung-pos))
1633 ;; Remove any `c-in-sws' property from the last char of
1634 ;; the rung before we mark it with `c-is-sws', so that we
1635 ;; won't connect with the remains of a broken "ladder".
1638 rung-end-pos))
1641 "c-forward-sws not caching [%s..%s] - [%s..%s] (max %s)"
1645 ;; Set `rung-pos' for the next rung. It's the same thing here as
1646 ;; initially, except that the rung position is set as early as
1647 ;; possible since we can't be in the ending ws of a line comment or
1648 ;; cpp directive now.
1655 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
1656 ;; another one after the point (which might occur when editing inside a
1657 ;; comment or macro).
1661 "c-forward-sws clearing at %s for cache separation"
1662 last-put-in-sws-pos)
1666 ;; If at eob we have to clear the last character before the end
1667 ;; instead since the buffer might be narrowed and there might
1668 ;; be a `c-in-sws' after (point-max). In this case it's
1669 ;; necessary to clear both properties.
1671 "c-forward-sws clearing thoroughly at %s for cache separation"
1674 last-put-in-sws-pos))))
1675 )))
1678 ;; Used by `c-backward-syntactic-ws' to implement the unbounded search.
1679 ;;
1680 ;; This function might do hidden buffer changes.
1683 ;; part of the simple ws region.
1685 rung-is-marked simple-ws-beg cmt-skip-pos)
1687 ;; Skip simple horizontal ws and do a quick check on the preceding
1688 ;; character to see if it's anying that can't end syntactic ws, so we can
1689 ;; bail out early in the majority of cases when there just are a few ws
1690 ;; chars. Newlines are complicated in the backward direction, so we can't
1691 ;; skip over them.
1698 ;; Try to find a rung position in the simple ws preceding point, so that
1699 ;; we can get a cache hit even if the last bit of the simple ws has
1700 ;; changed recently.
1706 ;; `rung-pos' will be the earliest marked position, which means that
1707 ;; there might be later unmarked parts in the simple ws region.
1708 ;; It's not worth the effort to fix that; the last part of the
1709 ;; simple ws is also typically edited often, so it could be wasted.
1720 ;; The following search is the main reason that `c-in-sws'
1721 ;; and `c-is-sws' aren't combined to one property.
1725 ;; If the `c-in-sws' region extended past the first
1726 ;; `c-is-sws' char we have to go forward a bit.
1731 "c-backward-sws cached move %s <- %s (min %s)"
1743 t
1745 nil))
1747 ;; We'll loop here if there is simple ws before the first rung.
1748 ;; That means that there's been some change in it and it's
1749 ;; possible that we've stepped into another ladder, so extend
1750 ;; the previous one to join with it if there is one, and try to
1751 ;; use the cache again.
1753 "c-backward-sws extending rung with [%s..%s] (min %s)"
1756 ;; Remove any `c-in-sws' property from the last char of
1757 ;; the rung before we mark it with `c-is-sws', so that we
1758 ;; won't connect with the remains of a broken "ladder".
1761 rung-pos)
1765 last-put-in-sws-pos rung-pos))
1774 ;; Inside a cpp directive. See if it should be skipped over.
1777 ;; Move back over all line continuations in the region skipped
1778 ;; over by `c-backward-comments'. If we go past it then we
1779 ;; started inside the cpp directive.
1788 ;; Don't move past the cpp directive if we began inside
1789 ;; it. Note that the position at the end of the last line
1790 ;; of the macro is also considered to be within it.
1792 nil)
1794 ;; It's worthwhile to spend a little bit of effort on finding
1795 ;; the end of the macro, to get a good `simple-ws-beg'
1796 ;; position for the cache. Note that `c-backward-comments'
1797 ;; could have stepped over some comments before going into
1798 ;; the macro, and then `simple-ws-beg' must be kept on the
1799 ;; same side of those comments.
1806 ;; Might happen if comments after the macro were skipped
1807 ;; over.
1811 t)))
1816 simple-ws-beg)
1817 ;; Skipped over comments. Must put point at the end of
1818 ;; the simple ws at point since we might be after a line
1819 ;; comment or cpp directive that's been partially
1820 ;; narrowed out, and we can't risk marking the simple ws
1821 ;; at the end of it.
1823 t)))
1825 ;; We've searched over a piece of non-white syntactic ws. See if this
1826 ;; can be cached.
1831 ;; Cache if we started either from a marked rung or from a
1832 ;; completely uncached position.
1833 rung-is-marked
1836 ;; Cache if there's a marked rung in the encountered simple ws.
1844 "c-backward-sws caching [%s..%s] - [%s..%s] (min %s)"
1849 ;; Remove the properties for any nested ws that might be cached.
1850 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
1851 ;; anyway.
1856 ;; Remove any `c-in-sws' property from the last char of
1857 ;; the rung before we mark it with `c-is-sws', so that we
1858 ;; won't connect with the remains of a broken "ladder".
1861 rung-end-pos)
1864 last-put-in-sws-pos simple-ws-beg)
1865 rung-pos)
1870 "c-backward-sws not caching [%s..%s] - [%s..%s] (min %s)"
1876 ))
1878 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
1879 ;; another one before the point (which might occur when editing inside a
1880 ;; comment or macro).
1884 "c-backward-sws clearing at %s for cache separation"
1887 last-put-in-sws-pos))
1889 ;; If at bob and the buffer is narrowed, we have to clear the
1890 ;; character we're standing on instead since there might be a
1891 ;; `c-in-sws' before (point-min). In this case it's necessary
1892 ;; to clear both properties.
1894 "c-backward-sws clearing thoroughly at %s for cache separation"
1895 last-put-in-sws-pos)
1898 )))
1900 \f
1901 ;; A system for finding noteworthy parens before the point.
1905 ;; The state cache used by `c-parse-state' to cut down the amount of
1906 ;; searching. It's the result from some earlier `c-parse-state' call.
1907 ;;
1908 ;; The use of the cached info is more effective if the next
1909 ;; `c-parse-state' call is on a line close by the one the cached state
1910 ;; was made at; the cache can actually slow down a little if the
1911 ;; cached state was made very far back in the buffer. The cache is
1912 ;; most effective if `c-parse-state' is used on each line while moving
1913 ;; forward.
1917 ;; This is (point-min) when `c-state-cache' was calculated, since a
1918 ;; change of narrowing is likely to affect the parens that are visible
1919 ;; before the point.
1923 ;; This is a position where `c-state-cache' is known to be correct.
1924 ;; It's a position inside one of the recorded unclosed parens or the
1925 ;; top level, but not further nested inside any literal or subparen
1926 ;; that is closed before the last recorded position.
1927 ;;
1928 ;; The exact position is chosen to try to be close to yet earlier than
1929 ;; the position where `c-state-cache' will be called next. Right now
1930 ;; the heuristic is to set it to the position after the last found
1931 ;; closing paren (of any type) before the line on which
1932 ;; `c-parse-state' was called. That is chosen primarily to work well
1933 ;; with refontification of the current line.
1936 ;; Invalidate all info on `c-state-cache' that applies to the buffer
1937 ;; at POS or higher. This is much like `c-whack-state-after', but
1938 ;; it never changes a paren pair element into an open paren element.
1939 ;; Doing that would mean that the new open paren wouldn't have the
1940 ;; required preceding paren pair element.
1944 nil))
1950 nil))
1954 nil)))))
1958 ;; Return the start position for building `c-state-cache' from
1959 ;; scratch.
1961 ;; Go back 2 bods, but ignore any bogus positions returned by
1962 ;; beginning-of-defun (i.e. open paren in column zero).
1972 ;; Find and record all noteworthy parens between some good point
1973 ;; earlier in the file and point. That good point is at least the
1974 ;; beginning of the top-level construct we are in, or the beginning
1975 ;; of the preceding top-level construct if we aren't in one.
1976 ;;
1977 ;; The returned value is a list of the noteworthy parens with the
1978 ;; last one first. If an element in the list is an integer, it's
1979 ;; the position of an open paren which has not been closed before
1980 ;; the point. If an element is a cons, it gives the position of a
1981 ;; closed brace paren pair; the car is the start paren position and
1982 ;; the cdr is the position following the closing paren. Only the
1983 ;; last closed brace paren pair before each open paren and before
1984 ;; the point is recorded, and thus the state never contains two cons
1985 ;; elements in succession.
1986 ;;
1987 ;; Currently no characters which are given paren syntax with the
1988 ;; syntax-table property are recorded, i.e. angle bracket arglist
1989 ;; parens are never present here. Note that this might change.
1990 ;;
1991 ;; BUG: This function doesn't cope entirely well with unbalanced
1992 ;; parens in macros. E.g. in the following case the brace before
1993 ;; the macro isn't balanced with the one after it:
1994 ;;
1995 ;; {
1996 ;; #define X {
1997 ;; }
1998 ;;
1999 ;; This function might do hidden buffer changes.
2006 old-state last-pos brace-pair-open brace-pair-close
2007 pos save-pos)
2010 ;; If the minimum position has changed due to narrowing then we
2011 ;; have to fix the tail of `c-state-cache' accordingly.
2014 ;; If point-min has moved forward then we just need to cut
2015 ;; off a bit of the tail.
2026 ;; If point-min has moved backward then we drop the state
2027 ;; completely. It's possible to do a better job here and
2028 ;; recalculate the top only.
2033 ;; Get the latest position we know are directly inside the
2034 ;; closest containing paren of the cached state.
2042 ;; Take the opportunity to move the cached good position
2043 ;; further down.
2047 ;; Check if `last-pos' is in a macro. If it is, and we're not
2048 ;; in the same macro, we must discard everything on
2049 ;; `c-state-cache' that is inside the macro before using it.
2055 ;; Set `last-pos' again just like above except that there's
2056 ;; no use looking at `c-state-cache-good-pos' here.
2063 ;; If we've moved very far from the last cached position then
2064 ;; it's probably better to redo it from scratch, otherwise we
2065 ;; might spend a lot of time searching from `last-pos' down to
2066 ;; here.
2068 ;; First get the fallback start position. If it turns out
2069 ;; that it's so far back that the cached state is closer then
2070 ;; we'll keep it afterall.
2075 c-state-cache nil
2078 ;; Find the start position for the forward search. (Can't
2079 ;; search in the backward direction since the point might be in
2080 ;; some kind of literal.)
2085 ;; There's a cached state with a containing paren. Pop off
2086 ;; the stale containing sexps from it by going forward out of
2087 ;; parens as far as possible.
2101 ;; The last paren pair we moved out from was a brace
2102 ;; pair. Modify the state to record this as a closed
2103 ;; pair now.
2107 c-state-cache))))
2109 ;; Check if the preceding balanced paren is within a
2110 ;; macro; it should be ignored if we're outside the
2111 ;; macro. There's no need to check any further upwards;
2112 ;; if the macro contains an unbalanced opening paren then
2113 ;; we're smoked anyway.
2123 ;; Have to adjust the cached good position if state has been
2124 ;; popped off.
2131 old-state c-state-cache))
2136 ;; Get the fallback start position.
2139 c-state-cache nil
2146 brace-pair-open nil)
2148 ;; Find the balanced brace pairs. This loop is hot, so it
2149 ;; does ugly tricks to go faster.
2159 ;; Update the cached good position and record the brace
2160 ;; pair, whichever is applicable for the paren we've
2161 ;; just jumped over. But first check that it isn't
2162 ;; inside a macro and the point isn't inside the same
2163 ;; one.
2173 brace-pair-close pos))))))
2175 ;; Record the last brace pair.
2183 brace-pair-close)
2184 c-state-cache)))))
2187 ;; Prepare to loop, but record the open paren only if it's
2188 ;; outside a macro or within the same macro as point, and
2189 ;; if it is a legitimate open paren and not some character
2190 ;; that got an open paren syntax-table property.
2197 ;; Check for known types of parens that we
2198 ;; want to record. The syntax table is not to
2199 ;; be trusted here since the caller might be
2200 ;; using e.g. `c++-template-syntax-table'.
2207 ;; Found a close paren without a corresponding opening
2208 ;; one. Maybe we didn't go back far enough, so try to
2209 ;; scan backward for the start paren and then start over.
2212 c-state-cache nil
2213 c-state-cache-good-pos c-state-cache-start)
2215 ;; Emacs (up to at least 21.2) can get confused by
2216 ;; open parens in column zero inside comments: The
2217 ;; sexp functions can then misbehave and bring us
2218 ;; back to the same point again. Check this so that
2219 ;; we don't get an infinite loop.
2222 c-parsing-error
2228 ;;(message "c-parse-state: %S end: %S" c-state-cache c-state-cache-good-pos)
2229 c-state-cache)))
2231 ;; Debug tool to catch cache inconsistencies.
2243 ;; The cache can actually go further back due to the ad-hoc way
2244 ;; the first paren is found, so try to whack off a bit of its
2245 ;; start before complaining.
2254 res1 res2))))
2255 res1))
2260 'c-debug-parse-state
2267 ;; Whack off any state information from PAREN-STATE which lies
2268 ;; before BUFPOS. Not destructive on PAREN-STATE.
2271 car)
2282 ;; Whack off any state information from PAREN-STATE which lies at or
2283 ;; after BUFPOS. Not destructive on PAREN-STATE.
2288 ;; just check the car, because in a balanced brace
2289 ;; expression, it must be impossible for the corresponding
2290 ;; close brace to be before point, but the open brace to
2291 ;; be after.
2293 nil ; whack it off
2295 ;; its possible that the open brace is before
2296 ;; bufpos, but the close brace is after. In that
2297 ;; case, convert this to a non-cons element. The
2298 ;; rest of the state is before bufpos, so we're
2299 ;; done.
2301 ;; we know that both the open and close braces are
2302 ;; before bufpos, so we also know that everything else
2303 ;; on state is before bufpos.
2306 nil ; whack it off
2307 ;; it's before bufpos, so everything else should too.
2310 nil)))
2313 ;; Return the bufpos of the innermost enclosing open paren before
2314 ;; bufpos, or nil if none was found.
2324 enclosingp))
2327 ;; Return the bufpos of the outermost enclosing open paren, or nil
2328 ;; if none was found.
2335 pos))
2338 ;; Return the closest "safe" position recorded on PAREN-STATE that
2339 ;; is higher up than BUFPOS. Return nil if PAREN-STATE doesn't
2340 ;; contain any. Return nil if BUFPOS is nil, which is useful to
2341 ;; find the closest limit before a given limit that might be nil.
2342 ;;
2343 ;; A "safe" position is a position at or after a recorded open
2344 ;; paren, or after a recorded close paren. The returned position is
2345 ;; thus either the first position after a close brace, or the first
2346 ;; position after an enclosing paren, or at the enclosing paren in
2347 ;; case BUFPOS is immediately after it.
2357 ;; See below.
2360 ;; elem is the position at and not after the opening paren, so
2361 ;; we can go forward one more step unless it's equal to
2362 ;; bufpos. This is useful in some cases avoid an extra paren
2363 ;; level between the safe position and bufpos.
2368 ;; This is used for `font-lock-beginning-of-syntax-function'. It
2369 ;; goes to the closest previous point that is known to be outside
2370 ;; any string literal or comment. `c-state-cache' is used if it has
2371 ;; a position in the vicinity.
2373 elem
2376 ;; Note: Similar code in `c-safe-position'. The
2377 ;; difference is that we accept a safe position at
2378 ;; the point and don't bother to go forward past open
2379 ;; parens.
2394 ;; The position is far back. Try `c-beginning-of-defun-1'
2395 ;; (although we can't be entirely sure it will go to a position
2396 ;; outside a comment or string in current emacsen). FIXME:
2397 ;; Consult `syntax-ppss' here.
2402 \f
2403 ;; Tools for scanning identifiers and other tokens.
2406 "Return non-nil if the point is on or directly after an identifier.
2407 Keywords are recognized and not considered identifiers. If an
2408 identifier is detected, the returned value is its starting position.
2409 If an identifier ends at the point and another begins at it \(can only
2410 happen in Pike) then the point for the preceding one is returned.
2412 Note that this function might do hidden buffer changes. See the
2413 comment at the start of cc-engine.el for more info."
2415 ;; FIXME: Shouldn't this function handle "operator" in C++?
2422 ;; Check for a normal (non-keyword) identifier.
2428 ;; Handle the `<operator> syntax in Pike.
2432 t
2439 ;; Handle the "operator +" syntax in C++.
2456 )))
2459 ;; If the point is at the end of a symbol then skip backward to the
2460 ;; beginning of it. Don't move otherwise. Return non-nil if point
2461 ;; moved.
2462 ;;
2463 ;; This function might do hidden buffer changes.
2466 ;; Handle the `<operator> syntax in Pike.
2472 t
2474 nil)))))
2477 ;; Move to the beginning of the current token. Do not move if not
2478 ;; in the middle of one. BACK-LIMIT may be used to bound the
2479 ;; backward search; if given it's assumed to be at the boundary
2480 ;; between two tokens.
2481 ;;
2482 ;; This function might do hidden buffer changes.
2489 ;; `c-nonsymbol-token-regexp' should always match
2490 ;; since we've skipped backward over punctuator
2491 ;; or paren syntax, but consume one char in case
2492 ;; it doesn't so that we don't leave point before
2493 ;; some earlier incorrect token.
2500 ;; Move to the end of the current token. Do not move if not in the
2501 ;; middle of one. BACK-LIMIT may be used to bound the backward
2502 ;; search; if given it's assumed to be at the boundary between two
2503 ;; tokens. Return non-nil if the point is moved, nil otherwise.
2504 ;;
2505 ;; This function might do hidden buffer changes.
2513 ;; `c-nonsymbol-token-regexp' should always match since
2514 ;; we've skipped backward over punctuator or paren
2515 ;; syntax, but move forward in case it doesn't so that
2516 ;; we don't leave point earlier than we started with.
2532 "Move forward by tokens.
2533 A token is defined as all symbols and identifiers which aren't
2535 treated properly). Point is always either left at the beginning of a
2536 token or not moved at all. COUNT specifies the number of tokens to
2537 move; a negative COUNT moves in the opposite direction. A COUNT of 0
2538 moves to the next token beginning only if not already at one. If
2539 BALANCED is true, move over balanced parens, otherwise move into them.
2540 Also, if BALANCED is true, never move out of an enclosing paren.
2542 LIMIT sets the limit for the movement and defaults to the point limit.
2543 The case when LIMIT is set in the middle of a token, comment or macro
2544 is handled correctly, i.e. the point won't be left there.
2546 Return the number of tokens left to move \(positive or negative). If
2547 BALANCED is true, a move over a balanced paren counts as one. Note
2548 that if COUNT is 0 and no appropriate token beginning is found, 1 will
2549 be returned. Thus, a return value of 0 guarantees that point is at
2550 the requested position and a return value less \(without signs) than
2551 COUNT guarantees that point is at the beginning of some token.
2553 Note that this function might do hidden buffer changes. See the
2554 comment at the start of cc-engine.el for more info."
2561 c-jump-syntax-balanced
2562 c-jump-syntax-unbalanced))
2567 ;; If count is zero we should jump if in the middle of a token.
2574 ;; Skip whitespace. Count this as a move if we did in
2575 ;; fact move.
2579 ;; Moved out of bounds. Make sure the returned count isn't zero.
2584 ;; Use `condition-case' to avoid having the limit tests
2585 ;; inside the loop.
2593 t)
2596 t)
2597 ;; `c-nonsymbol-token-regexp' above should always
2598 ;; match if there are correct tokens. Try to
2599 ;; widen to see if the limit was set in the
2600 ;; middle of one, else fall back to treating
2601 ;; the offending thing as a one character token.
2606 nil)
2609 t))))
2619 count)))
2622 "Move backward by tokens.
2623 See `c-forward-token-2' for details."
2631 c-jump-syntax-balanced
2632 c-jump-syntax-unbalanced))
2636 ;; The count is zero so try to skip to the beginning of the
2637 ;; current token.
2641 ;; The limit is inside the same token, so return 1.
2644 ;; We're not in the middle of a token. If there's
2645 ;; whitespace after the point then we must move backward,
2646 ;; so set count to 1 in that case.
2648 ;; If we're looking at a '#' that might start a cpp
2649 ;; directive then we have to do a more elaborate check.
2662 ;; Use `condition-case' to avoid having to check for buffer
2663 ;; limits in `backward-char', `scan-sexps' and `goto-char' below.
2672 ;; This can be very inefficient if there's a long
2673 ;; sequence of operator tokens without any separation.
2674 ;; That doesn't happen in practice, anyway.
2684 count)))
2687 "Like `c-forward-token-2' but doesn't treat multicharacter operator
2689 characters are jumped over character by character. This function is
2690 for compatibility only; it's only a wrapper over `c-forward-token-2'."
2695 "Like `c-backward-token-2' but doesn't treat multicharacter operator
2697 characters are jumped over character by character. This function is
2698 for compatibility only; it's only a wrapper over `c-backward-token-2'."
2702 \f
2703 ;; Tools for doing searches restricted to syntactically relevant text.
2706 paren-level not-inside-token
2707 lookbehind-submatch)
2708 "Like `re-search-forward', but only report matches that are found
2709 in syntactically significant text. I.e. matches in comments, macros
2710 or string literals are ignored. The start point is assumed to be
2711 outside any comment, macro or string literal, or else the content of
2712 that region is taken as syntactically significant text.
2714 If PAREN-LEVEL is non-nil, an additional restriction is added to
2715 ignore matches in nested paren sexps. The search will also not go
2716 outside the current list sexp, which has the effect that if the point
2717 should be moved to BOUND when no match is found \(i.e. NOERROR is
2718 neither nil nor t), then it will be at the closing paren if the end of
2719 the current list sexp is encountered first.
2721 If NOT-INSIDE-TOKEN is non-nil, matches in the middle of tokens are
2722 ignored. Things like multicharacter operators and special symbols
2724 constants.
2726 If LOOKBEHIND-SUBMATCH is non-nil, it's taken as a number of a
2727 subexpression in REGEXP. The end of that submatch is used as the
2728 position to check for syntactic significance. If LOOKBEHIND-SUBMATCH
2729 isn't used or if that subexpression didn't match then the start
2731 subexpression is never tested before the starting position, so it
2735 subexpression can match the end of nonwhite syntactic whitespace,
2736 i.e. the end of comments or cpp directives. This since the function
2737 skips over such things before resuming the search. It's on the other
2739 matches syntactic whitespace.
2741 Bug: Unbalanced parens inside cpp directives are currently not handled
2742 correctly \(i.e. they don't get ignored as they should) when
2743 PAREN-LEVEL is set.
2745 Note that this function might do hidden buffer changes. See the
2746 comment at the start of cc-engine.el for more info."
2751 ;;(message "c-syntactic-re-search-forward %s %s %S" (point) bound regexp)
2754 tmp
2755 ;; Start position for the last search.
2756 search-pos
2757 ;; The `parse-partial-sexp' state between the start position
2758 ;; and the point.
2759 state
2760 ;; The current position after the last state update. The next
2761 ;; `parse-partial-sexp' continues from here.
2763 ;; The position at which to check the state and the state
2764 ;; there. This is separate from `state-pos' since we might
2765 ;; need to back up before doing the next search round.
2766 check-pos check-state
2767 ;; Last position known to end a token.
2769 ;; Set when a valid match is found.
2770 found)
2788 state-pos check-pos paren-level nil state))
2790 check-state state))
2792 ;; NOTE: If we got a look behind subexpression and get
2793 ;; an insignificant match in something that isn't
2794 ;; syntactic whitespace (i.e. strings or in nested
2795 ;; parentheses), then we can never skip more than a
2796 ;; single character from the match start position
2797 ;; (i.e. `state-pos' here) before continuing the
2798 ;; search. That since the look behind subexpression
2799 ;; might match the end of the insignificant region in
2800 ;; the next search.
2804 ;; Match inside a line comment. Skip to eol. Use
2805 ;; `re-search-forward' instead of `skip-chars-forward' to get
2806 ;; the right bound behavior.
2810 ;; Match inside a block comment. Skip to the '*/'.
2817 ;; Match in the middle of the opener of a block or line
2818 ;; comment.
2823 ;; The last `parse-partial-sexp' above might have
2824 ;; stopped short of the real check position if the end
2825 ;; of the current sexp was encountered in paren-level
2826 ;; mode. The checks above are always false in that
2827 ;; case, and since they can do better skipping in
2828 ;; lookbehind-submatch mode, we do them before
2829 ;; checking the paren level.
2833 ;; Check the paren level first since we're short of the
2834 ;; syntactic checking position if the end of the
2835 ;; current sexp was encountered by `parse-partial-sexp'.
2838 ;; Inside a nested paren sexp.
2840 ;; See the NOTE above.
2842 ;; Skip out of the paren quickly.
2846 ;; Have exited the current paren sexp.
2849 ;; The last `parse-partial-sexp' call above
2850 ;; has left us just after the closing paren
2851 ;; in this case, so we can modify the bound
2852 ;; to leave the point at the right position
2853 ;; upon return.
2855 nil)
2859 ;; Match inside a string.
2862 ;; See the NOTE above.
2864 ;; Skip to the end of the string before continuing.
2873 continue)))
2878 ;; Match inside a macro. Skip to the end of it.
2886 (< check-pos
2892 ;; Inside a token.
2894 ;; See the NOTE above.
2899 ;; A real match.
2901 nil)))
2903 ;; Should loop to search again, but take care to avoid
2904 ;; looping on the same spot.
2908 nil
2911 t))))
2917 ;;(message "c-syntactic-re-search-forward done %s" (or (match-end 0) (point)))
2924 ;; Search failed. Set point as appropriate.
2928 nil)))
2931 "Like `skip-chars-backward' but only look at syntactically relevant chars,
2932 i.e. don't stop at positions inside syntactic whitespace or string
2933 literals. Preprocessor directives are also ignored, with the exception
2934 of the one that the point starts within, if any. If LIMIT is given,
2935 it's assumed to be at a syntactically relevant position.
2937 If PAREN-LEVEL is non-nil, the function won't stop in nested paren
2938 sexps, and the search will also not go outside the current paren sexp.
2939 However, if LIMIT or the buffer limit is reached inside a nested paren
2940 then the point will be left at the limit.
2942 Non-nil is returned if the point moved, nil otherwise.
2944 Note that this function might do hidden buffer changes. See the
2945 comment at the start of cc-engine.el for more info."
2948 state
2949 ;; A list of syntactically relevant positions in descending
2950 ;; order. It's used to avoid scanning repeatedly over
2951 ;; potentially large regions with `parse-partial-sexp' to verify
2952 ;; each position.
2953 safe-pos-list
2954 ;; The position at the beginning of `safe-pos-list'.
2955 safe-pos
2956 ;; The result from `c-beginning-of-macro' at the start position or the
2957 ;; start position itself if it isn't within a macro. Evaluated on
2958 ;; demand.
2959 start-macro-beg
2960 ;; The earliest position after the current one with the same paren
2961 ;; level. Used only when `paren-level' is set.
2968 ;; Use `parse-partial-sexp' from a safe position down to
2969 ;; the point to check if it's outside comments and
2970 ;; strings.
2972 ;; Pick a safe position as close to the point as
2973 ;; possible.
2974 ;;
2975 ;; FIXME: Consult `syntax-ppss' here if our
2976 ;; cache doesn't give a good position.
2988 ;; Cache positions along the way to use if we have to
2989 ;; back up more. We cache every closing paren on the
2990 ;; same level. If the paren cache is relevant in this
2991 ;; region then we're typically already on the same
2992 ;; level as the target position. Note that we might
2993 ;; cache positions after opening parens in case
2994 ;; safe-pos is in a nested list. That's both uncommon
2995 ;; and harmless.
3005 ;; Inside string or comment. Continue search at the
3006 ;; beginning of it.
3008 t)
3016 ;; Not at the right level.
3019 ;; We stop above if we go out of a paren.
3020 ;; Now check whether it precedes or is
3021 ;; nested in the starting sexp.
3025 pps-end-pos paren-level-pos
3026 nil nil state-2))
3029 ;; We've stopped short of the starting position
3030 ;; so the hit was inside a nested list. Go up
3031 ;; until we are at the right level.
3040 nil)
3041 t))
3044 nil))
3046 ;; The hit was outside the list at the start
3047 ;; position. Go to the start of the list and exit.
3049 nil))
3052 ;; Inside a macro.
3060 t
3062 ;; It's inside the same macro we started in so it's
3063 ;; a relevant match.
3065 nil)))))
3067 ;; If the state contains the start of the containing sexp we
3068 ;; cache that position too, so that parse-partial-sexp in the
3069 ;; next run has a bigger chance of starting at the same level
3070 ;; as the target position and thus will get more good safe
3071 ;; positions into the list.
3078 ;; Skip syntactic ws afterwards so that we don't stop at the
3079 ;; end of a comment if `skip-chars' is something like "^/".
3083 ;; We might want to extend this with more useful return values in
3084 ;; the future.
3087 ;; The following is an alternative implementation of
3088 ;; `c-syntactic-skip-backward' that uses backward movement to keep
3089 ;; track of the syntactic context. It turned out to be generally
3090 ;; slower than the one above which uses forward checks from earlier
3091 ;; safe positions.
3092 ;;
3093 ;;(defconst c-ssb-stop-re
3094 ;; ;; The regexp matching chars `c-syntactic-skip-backward' needs to
3095 ;; ;; stop at to avoid going into comments and literals.
3096 ;; (concat
3097 ;; ;; Match comment end syntax and string literal syntax. Also match
3098 ;; ;; '/' for block comment endings (not covered by comment end
3099 ;; ;; syntax).
3100 ;; "\\s>\\|/\\|\\s\""
3101 ;; (if (memq 'gen-string-delim c-emacs-features)
3102 ;; "\\|\\s|"
3103 ;; "")
3104 ;; (if (memq 'gen-comment-delim c-emacs-features)
3105 ;; "\\|\\s!"
3106 ;; "")))
3107 ;;
3108 ;;(defconst c-ssb-stop-paren-re
3109 ;; ;; Like `c-ssb-stop-re' but also stops at paren chars.
3110 ;; (concat c-ssb-stop-re "\\|\\s(\\|\\s)"))
3111 ;;
3112 ;;(defconst c-ssb-sexp-end-re
3113 ;; ;; Regexp matching the ending syntax of a complex sexp.
3114 ;; (concat c-string-limit-regexp "\\|\\s)"))
3115 ;;
3116 ;;(defun c-syntactic-skip-backward (skip-chars &optional limit paren-level)
3117 ;; "Like `skip-chars-backward' but only look at syntactically relevant chars,
3118 ;;i.e. don't stop at positions inside syntactic whitespace or string
3119 ;;literals. Preprocessor directives are also ignored. However, if the
3120 ;;point is within a comment, string literal or preprocessor directory to
3121 ;;begin with, its contents is treated as syntactically relevant chars.
3122 ;;If LIMIT is given, it limits the backward search and the point will be
3123 ;;left there if no earlier position is found.
3124 ;;
3125 ;;If PAREN-LEVEL is non-nil, the function won't stop in nested paren
3126 ;;sexps, and the search will also not go outside the current paren sexp.
3127 ;;However, if LIMIT or the buffer limit is reached inside a nested paren
3128 ;;then the point will be left at the limit.
3129 ;;
3130 ;;Non-nil is returned if the point moved, nil otherwise.
3131 ;;
3132 ;;Note that this function might do hidden buffer changes. See the
3133 ;;comment at the start of cc-engine.el for more info."
3134 ;;
3135 ;; (save-restriction
3136 ;; (when limit
3137 ;; (narrow-to-region limit (point-max)))
3138 ;;
3139 ;; (let ((start (point)))
3140 ;; (catch 'done
3141 ;; (while (let ((last-pos (point))
3142 ;; (stop-pos (progn
3143 ;; (skip-chars-backward skip-chars)
3144 ;; (point))))
3145 ;;
3146 ;; ;; Skip back over the same region as
3147 ;; ;; `skip-chars-backward' above, but keep to
3148 ;; ;; syntactically relevant positions.
3149 ;; (goto-char last-pos)
3150 ;; (while (and
3151 ;; ;; `re-search-backward' with a single char regexp
3152 ;; ;; should be fast.
3153 ;; (re-search-backward
3154 ;; (if paren-level c-ssb-stop-paren-re c-ssb-stop-re)
3155 ;; stop-pos 'move)
3156 ;;
3157 ;; (progn
3158 ;; (cond
3159 ;; ((looking-at "\\s(")
3160 ;; ;; `paren-level' is set and we've found the
3161 ;; ;; start of the containing paren.
3162 ;; (forward-char)
3163 ;; (throw 'done t))
3164 ;;
3165 ;; ((looking-at c-ssb-sexp-end-re)
3166 ;; ;; We're at the end of a string literal or paren
3167 ;; ;; sexp (if `paren-level' is set).
3168 ;; (forward-char)
3169 ;; (condition-case nil
3170 ;; (c-backward-sexp)
3171 ;; (error
3172 ;; (goto-char limit)
3173 ;; (throw 'done t))))
3174 ;;
3175 ;; (t
3176 ;; (forward-char)
3177 ;; ;; At the end of some syntactic ws or possibly
3178 ;; ;; after a plain '/' operator.
3179 ;; (let ((pos (point)))
3180 ;; (c-backward-syntactic-ws)
3181 ;; (if (= pos (point))
3182 ;; ;; Was a plain '/' operator. Go past it.
3183 ;; (backward-char)))))
3184 ;;
3185 ;; (> (point) stop-pos))))
3186 ;;
3187 ;; ;; Now the point is either at `stop-pos' or at some
3188 ;; ;; position further back if `stop-pos' was at a
3189 ;; ;; syntactically irrelevant place.
3190 ;;
3191 ;; ;; Skip additional syntactic ws so that we don't stop
3192 ;; ;; at the end of a comment if `skip-chars' is
3193 ;; ;; something like "^/".
3194 ;; (c-backward-syntactic-ws)
3195 ;;
3196 ;; (< (point) stop-pos))))
3197 ;;
3198 ;; ;; We might want to extend this with more useful return values
3199 ;; ;; in the future.
3200 ;; (/= (point) start))))
3202 \f
3203 ;; Tools for handling comments and string literals.
3206 "Return the type of literal point is in, if any.
3207 The return value is `c' if in a C-style comment, `c++' if in a C++
3208 style comment, `string' if in a string literal, `pound' if DETECT-CPP
3209 is non-nil and in a preprocessor line, or nil if somewhere else.
3210 Optional LIM is used as the backward limit of the search. If omitted,
3211 or nil, `c-beginning-of-defun' is used.
3213 The last point calculated is cached if the cache is enabled, i.e. if
3214 `c-in-literal-cache' is bound to a two element vector.
3216 Note that this function might do hidden buffer changes. See the
3217 comment at the start of cc-engine.el for more info."
3233 ;; cache this result if the cache is enabled
3236 rtn)))
3238 ;; XEmacs has a built-in function that should make this much quicker.
3239 ;; I don't think we even need the cache, which makes our lives more
3240 ;; complicated anyway. In this case, lim is only used to detect
3241 ;; cpp directives.
3242 ;;
3243 ;; Note that there is a bug in Xemacs's buffer-syntactic-context when used in
3244 ;; conjunction with syntax-table-properties. The bug is present in, e.g.,
3245 ;; Xemacs 21.4.4. It manifested itself thus:
3246 ;;
3247 ;; Starting with an empty AWK Mode buffer, type
3248 ;; /regexp/ {<C-j>
3249 ;; Point gets wrongly left at column 0, rather than being indented to tab-width.
3250 ;;
3251 ;; AWK Mode is designed such that when the first / is typed, it gets the
3252 ;; syntax-table property "string fence". When the second / is typed, BOTH /s
3253 ;; are given the s-t property "string". However, buffer-syntactic-context
3254 ;; fails to take account of the change of the s-t property on the opening / to
3255 ;; "string", and reports that the { is within a string started by the second /.
3256 ;;
3257 ;; The workaround for this is for the AWK Mode initialisation to switch the
3258 ;; defalias for c-in-literal to c-slow-in-literal. This will slow down other
3259 ;; cc-modes in Xemacs whenever an awk-buffer has been initialised.
3260 ;;
3261 ;; (Alan Mackenzie, 2003/4/30).
3264 ;; This function might do hidden buffer changes.
3277 ;; The defalias above isn't enough to shut up the byte compiler.
3281 "Return a cons of the beginning and end positions of the comment or
3282 string surrounding point (including both delimiters), or nil if point
3284 to start parsing from. If NEAR is non-nil, then the limits of any
3286 spaces and tabs between point and the literal. The search for such a
3287 literal is done first in forward direction. If NOT-IN-DELIMITER is
3288 non-nil, the case when point is inside a starting delimiter won't be
3289 recognized. This only has effect for comments, which have starting
3290 delimiters with more than one character.
3292 Note that this function might do hidden buffer changes. See the
3293 comment at the start of cc-engine.el for more info."
3315 ;; We're standing in a comment starter.
3322 ;; Search forward for a literal.
3334 ;; Search backward.
3345 ;; Block comment. Due to the nature of line
3346 ;; comments, they will always be covered by the
3347 ;; normal case above.
3350 ;; If LIM is bogus, beg will be bogus.
3354 ))))
3356 ;; In case external callers use this; it did have a docstring.
3360 "If the argument is a cons of two buffer positions (such as returned by
3361 `c-literal-limits'), and that range contains a C++ style line comment,
3362 then an extended range is returned that contains all adjacent line
3363 comments (i.e. all comments that starts in the same column with no
3364 empty lines or non-whitespace characters between them). Otherwise the
3365 argument is returned.
3367 Note that this function might do hidden buffer changes. See the
3368 comment at the start of cc-engine.el for more info."
3379 ;; Got to take care in the backward direction to handle
3380 ;; comments which are preceded by code.
3394 range)
3398 "Convenience function that given the result of `c-literal-limits',
3399 returns nil or the type of literal that the range surrounds. It's
3400 much faster than using `c-in-literal' and is intended to be used when
3401 you need both the type of a literal and its limits.
3403 Note that this function might do hidden buffer changes. See the
3404 comment at the start of cc-engine.el for more info."
3415 range))
3417 \f
3418 ;; `c-find-decl-spots' and accompanying stuff.
3420 ;; Variables used in `c-find-decl-spots' to cache the search done for
3421 ;; the first declaration in the last call. When that function starts,
3422 ;; it needs to back up over syntactic whitespace to look at the last
3423 ;; token before the region being searched. That can sometimes cause
3424 ;; moves back and forth over a quite large region of comments and
3425 ;; macros, which would be repeated for each changed character when
3426 ;; we're called during fontification, since font-lock refontifies the
3427 ;; current line for each change. Thus it's worthwhile to cache the
3428 ;; first match.
3429 ;;
3430 ;; `c-find-decl-syntactic-pos' is a syntactically relevant position in
3431 ;; the syntactic whitespace less or equal to some start position.
3432 ;; There's no cached value if it's nil.
3433 ;;
3434 ;; `c-find-decl-match-pos' is the match position if
3435 ;; `c-find-decl-prefix-search' matched before the syntactic whitespace
3436 ;; at `c-find-decl-syntactic-pos', or nil if there's no such match.
3447 ; (defface c-debug-decl-spot-face
3448 ; '((t (:background "Turquoise")))
3449 ; "Debug face to mark the spots where `c-find-decl-spots' stopped.")
3450 ; (defface c-debug-decl-sws-face
3451 ; '((t (:background "Khaki")))
3452 ; "Debug face to mark the syntactic whitespace between the declaration
3453 ; spots and the preceding token end.")
3469 ;; Macro used inside `c-find-decl-spots'. It ought to be a defun,
3470 ;; but it contains lots of free variables that refer to things
3471 ;; inside `c-find-decl-spots'. The point is left at `cfd-match-pos'
3472 ;; if there is a match, otherwise at `cfd-limit'.
3473 ;;
3474 ;; This macro might do hidden buffer changes.
3477 ;; Find the next property match position if we haven't got one already.
3488 ;; Find the next `c-decl-prefix-or-start-re' match if we haven't
3489 ;; got one already.
3499 ;; Match. Check if it's inside a comment or string literal.
3502 ;; Matched the end of a token preceding a decl spot.
3506 ;; Matched a token that start a decl spot.
3509 c-literal-faces)
3511 ;; No match. Finish up and exit the loop.
3513 nil)
3515 ;; Skip out of comments and string literals.
3522 ;; If we matched at the decl start, we have to back up over the
3523 ;; preceding syntactic ws to set `cfd-match-pos' and to catch
3524 ;; any decl spots in the syntactic ws.
3529 ;; Choose whichever match is closer to the start.
3532 cfd-re-match nil)
3534 cfd-prop-match nil))
3539 ;; Skip forward past comments only so we don't skip macros.
3541 ;; Set the position to continue at. We can avoid going over
3542 ;; the comments skipped above a second time, but it's possible
3543 ;; that the comment skipping has taken us past `cfd-prop-match'
3544 ;; since the property might be used inside comments.
3550 ;; Call CFD-FUN for each possible spot for a declaration, cast or
3551 ;; label from the point to CFD-LIMIT. Such a spot is:
3552 ;;
3553 ;; o The first token after bob.
3554 ;; o The first token after the end of submatch 1 in
3555 ;; `c-decl-prefix-or-start-re' when that submatch matches.
3556 ;; o The start of each `c-decl-prefix-or-start-re' match when
3557 ;; submatch 1 doesn't match.
3558 ;; o The first token after the end of each occurence of the
3559 ;; `c-type' text property with the value `c-decl-end', provided
3560 ;; `c-type-decl-end-used' is set.
3561 ;;
3562 ;; Only a spot that match CFD-DECL-RE and whose face is in the
3563 ;; CFD-FACE-CHECKLIST list causes CFD-FUN to be called. The face
3564 ;; check is disabled if CFD-FACE-CHECKLIST is nil.
3565 ;;
3566 ;; If the match is inside a macro then the buffer is narrowed to the
3567 ;; end of it, so that CFD-FUN can investigate the following tokens
3568 ;; without matching something that begins inside a macro and ends
3569 ;; outside it. It's to avoid this work that the CFD-DECL-RE and
3570 ;; CFD-FACE-CHECKLIST checks exist.
3571 ;;
3572 ;; CFD-FUN is called with point at the start of the spot. It's
3573 ;; passed two arguments: The first is the end position of the token
3574 ;; preceding the spot, or 0 for the implicit match at bob. The
3575 ;; second is a flag that is t when the match is inside a macro. If
3576 ;; CFD-FUN adds `c-decl-end' properties somewhere below the current
3577 ;; spot, it should return non-nil to ensure that the next search
3578 ;; will find them.
3579 ;;
3580 ;; The spots are visited approximately in order from top to bottom.
3581 ;; It's however the positions where `c-decl-prefix-or-start-re'
3582 ;; matches and where `c-decl-end' properties are found that are in
3583 ;; order. Since the spots often are at the following token, they
3584 ;; might be visited out of order insofar as more spots are reported
3585 ;; later on within the syntactic whitespace between the match
3586 ;; positions and their spots.
3587 ;;
3588 ;; It's assumed that comments and strings are fontified in the
3589 ;; searched range.
3590 ;;
3591 ;; This is mainly used in fontification, and so has an elaborate
3592 ;; cache to handle repeated calls from the same start position; see
3593 ;; the variables above.
3594 ;;
3595 ;; All variables in this function begin with `cfd-' to avoid name
3596 ;; collision with the (dynamically bound) variables used in CFD-FUN.
3597 ;;
3598 ;; This function might do hidden buffer changes.
3602 ;; The end of the token preceding the decl spot last found
3603 ;; with `c-decl-prefix-or-start-re'. `cfd-limit' if there's
3604 ;; no match.
3605 cfd-re-match
3606 ;; The end position of the last `c-decl-prefix-or-start-re'
3607 ;; match. If this is greater than `cfd-continue-pos', the
3608 ;; next regexp search is started here instead.
3610 ;; The end of the last `c-decl-end' found by
3611 ;; `c-find-decl-prefix-search'. `cfd-limit' if there's no
3612 ;; match. If searching for the property isn't needed then we
3613 ;; disable it by setting it to `cfd-limit' directly.
3615 ;; The end of the token preceding the decl spot last found by
3616 ;; `c-find-decl-prefix-search'. 0 for the implicit match at
3617 ;; bob. `cfd-limit' if there's no match. In other words,
3618 ;; this is the minimum of `cfd-re-match' and `cfd-prop-match'.
3620 ;; The position to continue searching at.
3621 cfd-continue-pos
3622 ;; The position of the last "real" token we've stopped at.
3623 ;; This can be greater than `cfd-continue-pos' when we get
3624 ;; hits inside macros or at `c-decl-end' positions inside
3625 ;; comments.
3627 ;; The end position of the last entered macro.
3630 ;; Initialize by finding a syntactically relevant start position
3631 ;; before the point, and do the first `c-decl-prefix-or-start-re'
3632 ;; search unless we're at bob.
3635 ;; Must back up a bit since we look for the end of the previous
3636 ;; statement or declaration, which is earlier than the first
3637 ;; returned match.
3640 ;; First we need to move to a syntactically relevant position.
3641 ;; Begin by backing out of comment or string literals.
3644 ;; Try to use the faces to back up to the start of the
3645 ;; literal. FIXME: What if the point is on a declaration
3646 ;; inside a comment?
3652 ;; XEmacs doesn't fontify the quotes surrounding string
3653 ;; literals.
3662 ;; Don't trust the literal to contain only literal faces
3663 ;; (the font lock package might not have fontified the
3664 ;; start of it at all, for instance) so check that we have
3665 ;; arrived at something that looks like a start or else
3666 ;; resort to `c-literal-limits'.
3673 ;; The start is in a literal. If the limit is in the same
3674 ;; one we don't have to find a syntactic position etc. We
3675 ;; only check that if the limit is at or before bonl to save
3676 ;; time; it covers the by far most common case when font-lock
3677 ;; refontifies the current line only.
3688 ;; Completely inside a literal. Set up variables to trig the
3689 ;; (< cfd-continue-pos cfd-start-pos) case below and it'll
3690 ;; find a suitable start position.
3693 ;; Check if the region might be completely inside a macro, to
3694 ;; optimize that like the completely-inside-literal above.
3701 ;; (Maybe) completely inside a macro. Only need to trig the
3702 ;; (< cfd-continue-pos cfd-start-pos) case below to make it
3703 ;; set things up.
3705 start-in-macro t))
3708 ;; Back out of any macro so we don't miss any declaration
3709 ;; that could follow after it.
3713 ;; Now we're at a proper syntactically relevant position so we
3714 ;; can use the cache. But first clear it if it applied
3715 ;; further down.
3720 ;; Don't have to do this if the cache is relevant here,
3721 ;; typically if the same line is refontified again. If
3722 ;; we're just some syntactic whitespace further down we can
3723 ;; still use the cache to limit the skipping.
3726 ;; If we hit `c-find-decl-syntactic-pos' and
3727 ;; `c-find-decl-match-pos' is set then we install the cached
3728 ;; values. If we hit `c-find-decl-syntactic-pos' and
3729 ;; `c-find-decl-match-pos' is nil then we know there's no decl
3730 ;; prefix in the whitespace before `c-find-decl-syntactic-pos'
3731 ;; and so we can continue the search from this point. If we
3732 ;; didn't hit `c-find-decl-syntactic-pos' then we're now in
3733 ;; the right spot to begin searching anyway.
3735 c-find-decl-match-pos)
3737 cfd-continue-pos syntactic-pos)
3742 ;; Always consider bob a match to get the first
3743 ;; declaration in the file. Do this separately instead of
3744 ;; letting `c-decl-prefix-or-start-re' match bob, so that
3745 ;; regexp always can consume at least one character to
3746 ;; ensure that we won't get stuck in an infinite loop.
3751 ;; Do an initial search now. In the bob case above it's
3752 ;; only done to search for a `c-decl-end' spot.
3756 cfd-match-pos)))))
3758 ;; Advance `cfd-continue-pos' if it's before the start position.
3759 ;; The closest continue position that might have effect at or
3760 ;; after the start depends on what we started in. This also
3761 ;; finds a suitable start position in the special cases when the
3762 ;; region is completely within a literal or macro.
3767 ;; If we're in a macro then it's the closest preceding token
3768 ;; in the macro. Check this before `start-in-literal',
3769 ;; since if we're inside a literal in a macro, the preceding
3770 ;; token is earlier than any `c-decl-end' spot inside the
3771 ;; literal (comment).
3773 ;; The only syntactic ws in macros are comments.
3779 ;; If we're in a comment it can only be the closest
3780 ;; preceding `c-decl-end' position within that comment, if
3781 ;; any. Go back to the beginning of such a property so that
3782 ;; `c-find-decl-prefix-search' will find the end of it.
3783 ;; (Can't stop at the end and install it directly on
3784 ;; `cfd-prop-match' since that variable might be cleared
3785 ;; after `cfd-fun' below.)
3786 ;;
3787 ;; Note that if the literal is a string then the property
3788 ;; search will simply skip to the beginning of it right
3789 ;; away.
3801 ;; Didn't find any property inside the comment, so we can
3802 ;; skip it entirely. (This won't skip past a string, but
3803 ;; that'll be handled quickly by the next
3804 ;; `c-find-decl-prefix-search' anyway.)
3810 ;; If we started in normal code, the only match that might
3811 ;; apply before the start is what we already got in
3812 ;; `cfd-match-pos' so we can continue at the start position.
3813 ;; (Note that we don't get here if the first match is below
3814 ;; it.)
3817 ;; Delete found matches if they are before our new continue
3818 ;; position, so that `c-find-decl-prefix-search' won't back up
3819 ;; to them later on.
3827 ;; This is the normal case and we got a proper syntactic
3828 ;; position. If there's a match then it's always outside
3829 ;; macros and comments, so advance to the next token and set
3830 ;; `cfd-token-pos'. The loop below will later go back using
3831 ;; `cfd-continue-pos' to fix declarations inside the
3832 ;; syntactic ws.
3840 ;; Have one of the special cases when the region is completely
3841 ;; within a literal or macro. `cfd-continue-pos' is set to a
3842 ;; good start position for the search, so do it.
3845 ;; Now loop. We already got the first match.
3852 ;; Kludge to filter out matches on the "<" that
3853 ;; aren't open parens, for the sake of languages
3854 ;; that got `c-recognize-<>-arglists' set.
3859 ;; If `cfd-continue-pos' is less or equal to
3860 ;; `cfd-token-pos', we've got a hit inside a macro
3861 ;; that's in the syntactic whitespace before the last
3862 ;; "real" declaration we've checked. If they're equal
3863 ;; we've arrived at the declaration a second time, so
3864 ;; there's nothing to do.
3868 ;; If `cfd-continue-pos' is less than `cfd-token-pos'
3869 ;; we're still searching for declarations embedded in
3870 ;; the syntactic whitespace. In that case we need
3871 ;; only to skip comments and not macros, since they
3872 ;; can't be nested, and that's already been done in
3873 ;; `c-find-decl-prefix-search'.
3878 ;; Continue if the following token fails the
3879 ;; CFD-DECL-RE and CFD-FACE-CHECKLIST checks.
3886 t)))
3897 ;; Narrow to the end of the macro if we got a hit inside
3898 ;; one, to avoid recognizing things that start inside the
3899 ;; macro and end outside it.
3901 ;; Not in the same macro as in the previous round.
3912 t
3915 t)
3916 ;; The matched token was the last thing in the macro,
3917 ;; so the whole match is bogus.
3919 nil))))
3926 ;; Restore limits if we did macro narrowment above.
3934 \f
3935 ;; A cache for found types.
3937 ;; Buffer local variable that contains an obarray with the types we've
3938 ;; found. If a declaration is recognized somewhere we record the
3939 ;; fully qualified identifier in it to recognize it as a type
3940 ;; elsewhere in the file too. This is not accurate since we do not
3941 ;; bother with the scoping rules of the languages, but in practice the
3942 ;; same name is seldom used as both a type and something else in a
3943 ;; file, and we only use this as a last resort in ambiguous cases (see
3944 ;; `c-forward-decl-or-cast-1').
3945 ;;
3946 ;; Template types in C++ are added here too but with the template
3947 ;; arglist replaced with "<>" in references or "<" for the one in the
3948 ;; primary type. E.g. the type "Foo<A,B>::Bar<C>" is stored as
3949 ;; "Foo<>::Bar<". This avoids storing very long strings (since C++
3950 ;; template specs can be fairly sized programs in themselves) and
3951 ;; improves the hit ratio (it's a type regardless of the template
3952 ;; args; it's just not the same type, but we're only interested in
3953 ;; recognizing types, not telling distinct types apart). Note that
3954 ;; template types in references are added here too; from the example
3955 ;; above there will also be an entry "Foo<".
3960 ;; Clears `c-found-types'.
3964 ;; Add the given region as a type in `c-found-types'. If the region
3965 ;; doesn't match an existing type but there is a type which is equal
3966 ;; to the given one except that the last character is missing, then
3967 ;; the shorter type is removed. That's done to avoid adding all
3968 ;; prefixes of a type as it's being entered and font locked. This
3969 ;; doesn't cover cases like when characters are removed from a type
3970 ;; or added in the middle. We'd need the position of point when the
3971 ;; font locking is invoked to solve this well.
3972 ;;
3973 ;; This function might do hidden buffer changes.
3980 ;; Return non-nil if the given region contains a type in
3981 ;; `c-found-types'.
3982 ;;
3983 ;; This function might do hidden buffer changes.
3985 c-found-types))
3988 ;; Return all the types in `c-found-types' as a sorted list of
3989 ;; strings.
3993 type-list)))
3994 c-found-types)
3997 \f
3998 ;; Handling of small scale constructs like types and names.
4001 ;; This is called from `after-change-functions' when
4002 ;; c-recognize-<>-arglists' is set. It ensures that no "<" or ">"
4003 ;; chars with paren syntax become part of another operator like "<<"
4004 ;; or ">=".
4005 ;;
4006 ;; This function might do hidden buffer changes.
4038 ;; Dynamically bound variable that instructs `c-forward-type' to also
4039 ;; treat possible types (i.e. those that it normally returns 'maybe or
4040 ;; 'found for) as actual types (and always return 'found for them).
4041 ;; This means that it records them in `c-record-type-identifiers' if
4042 ;; that is set, and that it adds them to `c-found-types'.
4045 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
4046 ;; mark up successfully parsed arglists with paren syntax properties on
4047 ;; the surrounding angle brackets and with `c-<>-arg-sep' in the
4048 ;; `c-type' property of each argument separating comma.
4049 ;;
4050 ;; Setting this variable also makes `c-forward-<>-arglist' recurse into
4051 ;; all arglists for side effects (i.e. recording types), otherwise it
4052 ;; exploits any existing paren syntax properties to quickly jump to the
4053 ;; end of already parsed arglists.
4054 ;;
4055 ;; Marking up the arglists is not the default since doing that correctly
4056 ;; depends on a proper value for `c-restricted-<>-arglists'.
4059 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
4060 ;; not accept arglists that contain binary operators.
4061 ;;
4062 ;; This is primarily used to handle C++ template arglists. C++
4063 ;; disambiguates them by checking whether the preceding name is a
4064 ;; template or not. We can't do that, so we assume it is a template
4065 ;; if it can be parsed as one. That usually works well since
4066 ;; comparison expressions on the forms "a < b > c" or "a < b, c > d"
4067 ;; in almost all cases would be pointless.
4068 ;;
4069 ;; However, in function arglists, e.g. in "foo (a < b, c > d)", we
4070 ;; should let the comma separate the function arguments instead. And
4071 ;; in a context where the value of the expression is taken, e.g. in
4072 ;; "if (a < b || c > d)", it's probably not a template.
4075 ;; Dynamically bound variables that instructs
4076 ;; `c-forward-keyword-clause', `c-forward-<>-arglist',
4077 ;; `c-forward-name', `c-forward-type', `c-forward-decl-or-cast-1', and
4078 ;; `c-forward-label' to record the ranges of all the type and
4079 ;; reference identifiers they encounter. They will build lists on
4080 ;; these variables where each element is a cons of the buffer
4081 ;; positions surrounding each identifier. This recording is only
4082 ;; activated when `c-record-type-identifiers' is non-nil.
4083 ;;
4084 ;; All known types that can't be identifiers are recorded, and also
4085 ;; other possible types if `c-promote-possible-types' is set.
4086 ;; Recording is however disabled inside angle bracket arglists that
4087 ;; are encountered inside names and other angle bracket arglists.
4088 ;; Such occurrences are taken care of by `c-font-lock-<>-arglists'
4089 ;; instead.
4090 ;;
4091 ;; Only the names in C++ template style references (e.g. "tmpl" in
4092 ;; "tmpl<a,b>::foo") are recorded as references, other references
4093 ;; aren't handled here.
4094 ;;
4095 ;; `c-forward-label' records the label identifier(s) on
4096 ;; `c-record-ref-identifiers'.
4100 ;; This variable will receive a cons cell of the range of the last
4101 ;; single identifier symbol stepped over by `c-forward-name' if it's
4102 ;; successful. This is the range that should be put on one of the
4103 ;; record lists above by the caller. It's assigned nil if there's no
4104 ;; such symbol in the name.
4109 ;; Always true.
4119 ;; Always true.
4127 ;; Dynamically bound variable that instructs `c-forward-type' to
4128 ;; record the ranges of types that only are found. Behaves otherwise
4129 ;; like `c-record-type-identifiers'.
4133 ;; Used internally in `c-forward-keyword-clause' to move forward
4134 ;; over a type (if TYPE is 'type) or a name (otherwise) which
4135 ;; possibly is prefixed by keywords and their associated clauses.
4136 ;; Try with a type/name first to not trip up on those that begin
4137 ;; with a keyword. Return t if a known or found type is moved
4138 ;; over. The point is clobbered if nil is returned. If range
4139 ;; recording is enabled, the identifier is recorded on as a type
4140 ;; if TYPE is 'type or as a reference if TYPE is 'ref.
4141 ;;
4142 ;; This macro might do hidden buffer changes.
4147 nil
4154 t)))
4157 ;; Used internally in `c-forward-keyword-clause' to move forward
4158 ;; over a comma separated list of types or names using
4159 ;; `c-forward-keyword-prefixed-id'.
4160 ;;
4161 ;; This macro might do hidden buffer changes.
4172 ;; Submatch MATCH in the current match data is assumed to surround a
4173 ;; token. If it's a keyword, move over it and any immediately
4174 ;; following clauses associated with it, stopping at the start of
4175 ;; the next token. t is returned in that case, otherwise the point
4176 ;; stays and nil is returned. The kind of clauses that are
4177 ;; recognized are those specified by `c-type-list-kwds',
4178 ;; `c-ref-list-kwds', `c-colon-type-list-kwds',
4179 ;; `c-paren-nontype-kwds', `c-paren-type-kwds', `c-<>-type-kwds',
4180 ;; and `c-<>-arglist-kwds'.
4181 ;;
4182 ;; This function records identifier ranges on
4183 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
4184 ;; `c-record-type-identifiers' is non-nil.
4185 ;;
4186 ;; Note that for `c-colon-type-list-kwds', which doesn't necessary
4187 ;; apply directly after the keyword, the type list is moved over
4188 ;; only when there is no unaccounted token before it (i.e. a token
4189 ;; that isn't moved over due to some other keyword list). The
4190 ;; identifier ranges in the list are still recorded if that should
4191 ;; be done, though.
4192 ;;
4193 ;; This function might do hidden buffer changes.
4196 ;; The call to `c-forward-<>-arglist' below is made after
4197 ;; `c-<>-sexp-kwds' keywords, so we're certain they actually
4198 ;; are angle bracket arglists and `c-restricted-<>-arglists'
4199 ;; should therefore be nil.
4211 ;; There's a type directly after a keyword in `c-type-list-kwds'.
4216 ;; There's a name directly after a keyword in `c-ref-list-kwds'.
4221 ;; There's an open paren after a keyword in `c-paren-any-kwds'.
4228 ;; Use `c-forward-type' on every identifier we can find
4229 ;; inside the paren, to record the types.
4254 ;; If we are at the colon already, we move over the type
4255 ;; list after it.
4261 ;; Not at the colon, so stop here. But the identifier
4262 ;; ranges in the type list later on should still be
4263 ;; recorded.
4266 ;; If a keyword matched both one of the types above and
4267 ;; this one, we match `c-colon-type-list-re' after the
4268 ;; clause matched above.
4275 ;; There's a type after the `c-colon-type-list-re' match
4276 ;; after a keyword in `c-colon-type-list-kwds'.
4280 t)))
4283 ;; The point is assumed to be at a "<". Try to treat it as the open
4284 ;; paren of an angle bracket arglist and move forward to the the
4285 ;; corresponding ">". If successful, the point is left after the
4286 ;; ">" and t is returned, otherwise the point isn't moved and nil is
4287 ;; returned. If ALL-TYPES is t then all encountered arguments in
4288 ;; the arglist that might be types are treated as found types.
4289 ;;
4290 ;; The variable `c-parse-and-markup-<>-arglists' controls how this
4291 ;; function handles text properties on the angle brackets and argument
4292 ;; separating commas.
4293 ;;
4294 ;; `c-restricted-<>-arglists' controls how lenient the template
4295 ;; arglist recognition should be.
4296 ;;
4297 ;; This function records identifier ranges on
4298 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
4299 ;; `c-record-type-identifiers' is non-nil.
4300 ;;
4301 ;; This function might do hidden buffer changes.
4304 ;; If `c-record-type-identifiers' is set then activate
4305 ;; recording of any found types that constitute an argument in
4306 ;; the arglist.
4314 ;; `nconc' doesn't mind that the tail of
4315 ;; `c-record-found-types' is t.
4317 t)
4320 nil)))
4323 ;; Recursive part of `c-forward-<>-arglist'.
4324 ;;
4325 ;; This function might do hidden buffer changes.
4328 ;; Cover this so that any recorded found type ranges are
4329 ;; automatically lost if it turns out to not be an angle
4330 ;; bracket arglist. It's propagated through the return value
4331 ;; on successful completion.
4333 ;; List that collects the positions after the argument
4334 ;; separating ',' in the arglist.
4335 arg-start-pos)
4337 ;; If the '<' has paren open syntax then we've marked it as an angle
4338 ;; bracket arglist before, so skip to the end.
4346 t
4348 ;; Got unmatched paren angle brackets. We don't clear the paren
4349 ;; syntax properties and retry, on the basis that it's very
4350 ;; unlikely that paren angle brackets become operators by code
4351 ;; manipulation. It's far more likely that it doesn't match due
4352 ;; to narrowing or some temporary change.
4354 nil))
4364 ;; All encountered identifiers are types, so set the
4365 ;; promote flag and parse the type.
4372 ;; Check if this arglist argument is a sole type. If
4373 ;; it's known then it's recorded in
4374 ;; `c-record-type-identifiers'. If it only is found
4375 ;; then it's recorded in `c-record-found-types' which we
4376 ;; might roll back if it turns out that this isn't an
4377 ;; angle bracket arglist afterall.
4383 ;; A found type was recorded but it's not the
4384 ;; only thing in the arglist argument, so reset
4385 ;; `c-record-found-types'.
4387 orig-record-found-types))))))
4391 ;; Must check for '>' at the very start separately,
4392 ;; since the regexp below has to avoid ">>" without
4393 ;; using \\=.
4395 t)
4397 ;; Note: These regexps exploit the match order in \| so
4398 ;; that "<>" is matched by "<" rather than "[^>:-]>".
4401 ;; Stop on ',', '|', '&', '+' and '-' to catch
4402 ;; common binary operators that could be between
4403 ;; two comparison expressions "a<b" and "c>d".
4405 ;; Otherwise we still stop on ',' to find the
4406 ;; argument start positions.
4410 ;; If the arglist starter has lost its open paren
4411 ;; syntax but not the closer, we won't find the
4412 ;; closer above since we only search in the
4413 ;; balanced sexp. In that case we stop just short
4414 ;; of it so check if the following char is the closer.
4417 t)))
4421 ;; Either an operator starting with '>' or the end of
4422 ;; the angle bracket arglist.
4429 ;; The angle bracket arglist is finished.
4441 ;; Either an operator starting with '<' or a nested arglist.
4453 ;; There's always an identifier before an angle
4454 ;; bracket arglist, or a keyword in
4455 ;; `c-<>-type-kwds' or `c-<>-arglist-kwds'.
4472 )))
4474 ;; It was not an angle bracket arglist.
4477 ;; It was an angle bracket arglist.
4480 ;; Record the identifier before the template as a type
4481 ;; or reference depending on whether the arglist is last
4482 ;; in a qualified identifier.
4491 t)
4495 ;; Just another argument. Record the position. The
4496 ;; type check stuff that made us stop at it is at
4497 ;; the top of the loop.
4501 ;; Got a character that can't be in an angle bracket
4502 ;; arglist argument. Abort using `throw', since
4503 ;; it's useless to try to find a surrounding arglist
4504 ;; if we're nested.
4511 ;; The point is assumed to be directly after a ">". Try to treat it
4512 ;; as the close paren of an angle bracket arglist and move back to
4513 ;; the corresponding "<". If successful, the point is left at
4514 ;; the "<" and t is returned, otherwise the point isn't moved and
4515 ;; nil is returned. ALL-TYPES is passed on to
4516 ;; `c-forward-<>-arglist'.
4517 ;;
4518 ;; If the optional LIMIT is given, it bounds the backward search.
4519 ;; It's then assumed to be at a syntactically relevant position.
4520 ;;
4521 ;; This is a wrapper around `c-forward-<>-arglist'. See that
4522 ;; function for more details.
4531 t
4532 ;; See corresponding note in `c-forward-<>-arglist'.
4534 nil)
4540 t
4541 ;; Stopped at bob or a char that isn't allowed in an
4542 ;; arglist, so we've failed.
4544 nil)
4549 ;; If we moved then the "<" was part of some
4550 ;; multicharacter token.
4551 t
4557 ;; Matched the arglist. Break the while.
4559 nil)
4561 ;; We started from a non-paren ">" inside an
4562 ;; arglist.
4564 nil)
4566 ;; Matched a shorter arglist. Can be a nested
4567 ;; one so continue looking.
4569 t))
4570 t)))))
4575 ;; Move forward over a complete name if at the beginning of one,
4576 ;; stopping at the next following token. If the point is not at
4577 ;; something that are recognized as name then it stays put. A name
4578 ;; could be something as simple as "foo" in C or something as
4579 ;; complex as "X<Y<class A<int>::B, BIT_MAX >> b>, ::operator<> ::
4580 ;; Z<(a>b)> :: operator const X<&foo>::T Q::G<unsigned short
4581 ;; int>::*volatile const" in C++ (this function is actually little
4582 ;; more than a `looking-at' call in all modes except those that,
4583 ;; like C++, have `c-recognize-<>-arglists' set). Return nil if no
4584 ;; name is found, 'template if it's an identifier ending with an
4585 ;; angle bracket arglist, 'operator of it's an operator identifier,
4586 ;; or t if it's some other kind of name.
4587 ;;
4588 ;; This function records identifier ranges on
4589 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
4590 ;; `c-record-type-identifiers' is non-nil.
4591 ;;
4592 ;; This function might do hidden buffer changes.
4595 ;; Turn off `c-promote-possible-types' here since we might
4596 ;; call `c-forward-<>-arglist' and we don't want it to promote
4597 ;; every suspect thing in the arglist to a type. We're
4598 ;; typically called from `c-forward-type' in this case, and
4599 ;; the caller only wants the top level type that it finds to
4600 ;; be promoted.
4601 c-promote-possible-types)
4607 ;; Check for keyword. We go to the last symbol in
4608 ;; `c-identifier-key' first.
4621 ;; "template" is only valid inside an
4622 ;; identifier if preceded by "::".
4627 t))
4629 ;; Handle a C++ operator or template identifier.
4633 ;; Got "... ::template".
4637 res subres))))
4640 ;; Got a cast operator.
4644 ;; Now we should match a sequence of either
4645 ;; '*', '&' or a name followed by ":: *",
4646 ;; where each can be followed by a sequence
4647 ;; of `c-opt-type-modifier-key'.
4650 t)
4660 t))))
4668 ;; Got some other operator.
4676 nil)
4678 ;; `id-start' is equal to `id-end' if we've jumped over
4679 ;; an identifier that doesn't end with a symbol token.
4680 ;; That can occur e.g. for Java import directives on the
4681 ;; form "foo.bar.*".
4688 res t)))
4698 ;; Got a concatenated identifier. This handles the
4699 ;; cases with tricky syntactic whitespace that aren't
4700 ;; covered in `c-identifier-key'.
4703 t)
4707 ;; Maybe an angle bracket arglist.
4710 c-record-found-types)
4716 c-last-identifier-range nil)
4721 ;; Continue if there's an identifier concatenation
4722 ;; operator after the template argument.
4728 t)
4733 nil)))
4734 )))))
4737 res))
4740 ;; Move forward over a type spec if at the beginning of one,
4741 ;; stopping at the next following token. Return t if it's a known
4742 ;; type that can't be a name or other expression, 'known if it's an
4743 ;; otherwise known type (according to `*-font-lock-extra-types'),
4744 ;; 'prefix if it's a known prefix of a type, 'found if it's a type
4745 ;; that matches one in `c-found-types', 'maybe if it's an identfier
4746 ;; that might be a type, or nil if it can't be a type (the point
4747 ;; isn't moved then). The point is assumed to be at the beginning
4748 ;; of a token.
4749 ;;
4750 ;; Note that this function doesn't skip past the brace definition
4751 ;; that might be considered part of the type, e.g.
4752 ;; "enum {a, b, c} foo".
4753 ;;
4754 ;; This function records identifier ranges on
4755 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
4756 ;; `c-record-type-identifiers' is non-nil.
4757 ;;
4758 ;; This function might do hidden buffer changes.
4762 ;; Skip leading type modifiers. If any are found we know it's a
4763 ;; prefix of a type.
4772 ;; Looking at a keyword that prefixes a type identifier,
4773 ;; e.g. "class".
4780 ;; In many languages the name can be used without the
4781 ;; prefix, so we add it to `c-found-types'.
4784 c-last-identifier-range)
4787 ;; Invalid syntax.
4799 id-range c-last-identifier-range))))
4811 id-end)
4813 ;; Looking at a primitive or known type identifier. We've
4814 ;; checked for a name first so that we don't go here if the
4815 ;; known type match only is a prefix of another name.
4826 ;; There might be more keywords for the type.
4854 ;; A normal identifier.
4864 ;; It's an identifier that has been used as
4865 ;; a type somewhere else.
4866 'found
4867 ;; It's an identifier that might be a type.
4870 ;; A template is a type.
4874 ;; Otherwise it's an operator identifier, which is not a type.
4879 ;; Skip trailing type modifiers. If any are found we know it's
4880 ;; a type.
4887 ;; Step over any type suffix operator. Do not let the existence
4888 ;; of these alter the classification of the found type, since
4889 ;; these operators typically are allowed in normal expressions
4890 ;; too.
4897 ;; Look for a trailing operator that concatenates the type
4898 ;; with a following one, and if so step past that one through
4899 ;; a recursive call. Note that we don't record concatenated
4900 ;; types in `c-found-types' - it's the component types that
4901 ;; are recorded when appropriate.
4904 c-promote-possible-types))
4905 ;; If we can't promote then set `c-record-found-types' so that
4906 ;; we can merge in the types from the second part afterwards if
4907 ;; it turns out to be a known type there.
4910 subres)
4919 ;; If either operand certainly is a type then both are, but we
4920 ;; don't let the existence of the operator itself promote two
4921 ;; uncertain types to a certain one.
4940 ;; Merge in the ranges of any types found by the second
4941 ;; `c-forward-type'.
4943 ;; `nconc' doesn't mind that the tail of
4944 ;; `c-record-found-types' is t.
4946 c-record-type-identifiers))))
4954 ;;(message "c-forward-type %s -> %s: %s" start (point) res)
4956 res))
4958 \f
4959 ;; Handling of large scale constructs like statements and declarations.
4961 ;; Macro used inside `c-forward-decl-or-cast-1'. It ought to be a
4962 ;; defsubst or perhaps even a defun, but it contains lots of free
4963 ;; variables that refer to things inside `c-forward-decl-or-cast-1'.
4965 ;; `c-forward-decl-or-cast-1' can consume an arbitrary length list
4966 ;; of types when parsing a declaration, which means that it
4967 ;; sometimes consumes the identifier in the declaration as a type.
4968 ;; This is used to "backtrack" and make the last type be treated as
4969 ;; an identifier instead.
4972 ;; These identifiers are bound only in the inner let.
4974 identifier-start type-start
4975 got-parens nil
4976 got-identifier t
4977 got-suffix t
4978 got-suffix-after-parens id-start
4982 t
4983 backup-at-type))
4985 id-start backup-id-start)
4987 id-start start-pos))
4989 ;; When these flags already are set we've found specifiers that
4990 ;; unconditionally signal these attributes - backtracking doesn't
4991 ;; change that. So keep them set in that case.
4998 ;; This identifier is bound only in the inner let.
5002 ;; Move forward over a declaration or a cast if at the start of one.
5003 ;; The point is assumed to be at the start of some token. Nil is
5004 ;; returned if no declaration or cast is recognized, and the point
5005 ;; is clobbered in that case.
5006 ;;
5007 ;; If a declaration is parsed:
5008 ;;
5009 ;; The point is left at the first token after the first complete
5010 ;; declarator, if there is one. The return value is a cons where
5011 ;; the car is the position of the first token in the declarator.
5012 ;; Some examples:
5013 ;;
5014 ;; void foo (int a, char *b) stuff ...
5015 ;; car ^ ^ point
5016 ;; float (*a)[], b;
5017 ;; car ^ ^ point
5018 ;; unsigned int a = c_style_initializer, b;
5019 ;; car ^ ^ point
5020 ;; unsigned int a (cplusplus_style_initializer), b;
5021 ;; car ^ ^ point (might change)
5022 ;; class Foo : public Bar {}
5023 ;; car ^ ^ point
5024 ;; class PikeClass (int a, string b) stuff ...
5025 ;; car ^ ^ point
5026 ;; enum bool;
5027 ;; car ^ ^ point
5028 ;; enum bool flag;
5029 ;; car ^ ^ point
5030 ;; void cplusplus_function (int x) throw (Bad);
5031 ;; car ^ ^ point
5032 ;; Foo::Foo (int b) : Base (b) {}
5033 ;; car ^ ^ point
5034 ;;
5035 ;; The cdr of the return value is non-nil iff a
5036 ;; `c-typedef-decl-kwds' specifier is found in the declaration,
5037 ;; i.e. the declared identifier(s) are types.
5038 ;;
5039 ;; If a cast is parsed:
5040 ;;
5041 ;; The point is left at the first token after the closing paren of
5042 ;; the cast. The return value is `cast'. Note that the start
5043 ;; position must be at the first token inside the cast parenthesis
5044 ;; to recognize it.
5045 ;;
5046 ;; PRECEDING-TOKEN-END is the first position after the preceding
5047 ;; token, i.e. on the other side of the syntactic ws from the point.
5048 ;; Use a value less than or equal to (point-min) if the point is at
5049 ;; the first token in (the visible part of) the buffer.
5050 ;;
5051 ;; CONTEXT is a symbol that describes the context at the point:
5052 ;; 'decl In a comma-separatded declaration context (typically
5053 ;; inside a function declaration arglist).
5054 ;; '<> In an angle bracket arglist.
5055 ;; 'arglist Some other type of arglist.
5056 ;; nil Some other context or unknown context.
5057 ;;
5058 ;; LAST-CAST-END is the first token after the closing paren of a
5059 ;; preceding cast, or nil if none is known. If
5060 ;; `c-forward-decl-or-cast-1' is used in succession, it should be
5061 ;; the position after the closest preceding call where a cast was
5062 ;; matched. In that case it's used to discover chains of casts like
5063 ;; "(a) (b) c".
5064 ;;
5065 ;; This function records identifier ranges on
5066 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5067 ;; `c-record-type-identifiers' is non-nil.
5068 ;;
5069 ;; This function might do hidden buffer changes.
5072 ;; first type, i.e. after any leading specifiers. It might
5073 ;; also point at the beginning of the preceding syntactic
5074 ;; whitespace.
5076 ;; Set to the result of `c-forward-type'.
5077 at-type
5078 ;; The position of the first token in what we currently
5079 ;; believe is the type in the declaration or cast, after any
5080 ;; specifiers and their associated clauses.
5081 type-start
5082 ;; The position of the first token in what we currently
5083 ;; believe is the declarator for the first identifier. Set
5084 ;; when the type is found, and moved forward over any
5085 ;; `c-decl-hangon-kwds' and their associated clauses that
5086 ;; occurs after the type.
5087 id-start
5088 ;; These store `at-type', `type-start' and `id-start' of the
5089 ;; identifier before the one in those variables. The previous
5090 ;; identifier might turn out to be the real type in a
5091 ;; declaration if the last one has to be the declarator in it.
5092 ;; If `backup-at-type' is nil then the other variables have
5093 ;; undefined values.
5094 backup-at-type backup-type-start backup-id-start
5095 ;; Set if we've found a specifier that makes the defined
5096 ;; identifier(s) types.
5097 at-type-decl
5098 ;; Set if we've found a specifier that can start a declaration
5099 ;; where there's no type.
5100 maybe-typeless
5101 ;; If a specifier is found that also can be a type prefix,
5102 ;; these flags are set instead of those above. If we need to
5103 ;; back up an identifier, they are copied to the real flag
5104 ;; variables. Thus they only take effect if we fail to
5105 ;; interpret it as a type.
5106 backup-at-type-decl backup-maybe-typeless
5107 ;; Whether we've found a declaration or a cast. We might know
5108 ;; this before we've found the type in it. It's 'ids if we've
5109 ;; found two consecutive identifiers (usually a sure sign, but
5110 ;; we should allow that in labels too), and t if we've found a
5111 ;; specifier keyword (a 100% sure sign).
5112 at-decl-or-cast
5113 ;; Set when we need to back up to parse this as a declaration
5114 ;; but not as a cast.
5115 backup-if-not-cast
5116 ;; For casts, the return position.
5117 cast-end
5118 ;; Save `c-record-type-identifiers' and
5119 ;; `c-record-ref-identifiers' since ranges are recorded
5120 ;; speculatively and should be thrown away if it turns out
5121 ;; that it isn't a declaration or cast.
5125 ;; Check for a type. Unknown symbols are treated as possible
5126 ;; types, but they could also be specifiers disguised through
5127 ;; macros like __INLINE__, so we recognize both types and known
5128 ;; specifiers after them too.
5132 ;; Look for a specifier keyword clause.
5140 ;; Found a known or possible type or a prefix of a known type.
5143 ;; Got two identifiers with nothing but whitespace
5144 ;; between them. That can only happen in declarations.
5148 ;; If the previous identifier is a found type we
5149 ;; record it as a real one; it might be some sort of
5150 ;; alias for a prefix like "unsigned".
5157 backup-type-start type-start
5158 backup-id-start id-start
5159 at-type found-type
5160 type-start start
5162 ;; The previous ambiguous specifier/type turned out
5163 ;; to be a type since we've parsed another one after
5164 ;; it, so clear these backup flags.
5165 backup-at-type-decl nil
5166 backup-maybe-typeless nil))
5170 ;; Handle known specifier keywords and
5171 ;; `c-decl-hangon-kwds' which can occur after known
5172 ;; types.
5175 ;; It's a hang-on keyword that can occur anywhere.
5179 ;; Move the identifier start position if
5180 ;; we've passed a type.
5182 ;; Otherwise treat this as a specifier and
5183 ;; move the fallback position.
5187 ;; It's an ordinary specifier so we know that
5188 ;; anything before this can't be the type.
5190 start-pos kwd-clause-end)
5193 ;; It's ambiguous whether this keyword is a
5194 ;; specifier or a type prefix, so set the backup
5195 ;; flags. (It's assumed that `c-forward-type'
5196 ;; moved further than `c-forward-keyword-clause'.)
5208 ;; Haven't matched a type so it's an umambiguous
5209 ;; specifier keyword and we know we're in a
5210 ;; declaration.
5215 ;; If the type isn't known we continue so that we'll jump
5216 ;; over all specifiers and type identifiers. The reason
5217 ;; to do this for a known type prefix is to make things
5218 ;; like "unsigned INT16" work.
5223 ;; If a known type was found, we still need to skip over any
5224 ;; hangon keyword clauses after it. Otherwise it has already
5225 ;; been done in the loop above.
5231 ;; A prefix type is itself a primitive type when it's not
5232 ;; followed by another type.
5236 ;; Got no type but set things up to continue anyway to handle
5237 ;; the various cases when a declaration doesn't start with a
5238 ;; type.
5243 ;; If it's C++ then check if the last "type" ends on the form
5244 ;; "foo::foo" or "foo::~foo", i.e. if it's the name of a
5245 ;; (con|de)structor.
5256 ;; Cheating in the handling of syntactic ws below.
5263 name))
5264 ;; It is a (con|de)structor name. In that case the
5265 ;; declaration is typeless so zap out any preceding
5266 ;; identifier(s) that we might have taken as types.
5269 backup-at-type nil
5270 id-start type-start))))))
5272 ;; Check for and step over a type decl expression after the thing
5273 ;; that is or might be a type. This can't be skipped since we
5274 ;; need the correct end position of the declarator for
5275 ;; `max-type-decl-end-*'.
5277 ;; True if there's a non-open-paren match of
5278 ;; `c-type-decl-prefix-key'.
5279 got-prefix
5280 ;; True if the declarator is surrounded by a parenthesis pair.
5281 got-parens
5282 ;; True if there is an identifier in the declarator.
5283 got-identifier
5284 ;; True if there's a non-close-paren match of
5285 ;; `c-type-decl-suffix-key'.
5286 got-suffix
5287 ;; True if there's a prefix match outside the outermost
5288 ;; paren pair that surrounds the declarator.
5289 got-prefix-before-parens
5290 y ;; True if there's a suffix match outside the outermost
5291 ;; paren pair that surrounds the declarator. The value is
5292 ;; the position of the first suffix match.
5293 got-suffix-after-parens
5294 ;; True if we've parsed the type decl to a token that is
5295 ;; known to end declarations in this context.
5296 at-decl-end
5297 ;; The earlier values of `at-type' and `type-start' if we've
5298 ;; shifted the type backwards.
5299 identifier-type identifier-start
5300 ;; If `c-parse-and-markup-<>-arglists' is set we need to
5301 ;; turn it off during the name skipping below to avoid
5302 ;; getting `c-type' properties that might be bogus. That
5303 ;; can happen since we don't know if
5304 ;; `c-restricted-<>-arglists' will be correct inside the
5305 ;; arglist paren that gets entered.
5310 ;; Skip over type decl prefix operators. (Note similar code in
5311 ;; `c-font-lock-declarators'.)
5315 ;; If the second submatch matches in C++ then
5316 ;; we're looking at an identifier that's a
5317 ;; prefix only if it specifies a member pointer.
5320 ;; We only check for a trailing "::" and
5321 ;; let the "*" that should follow be
5322 ;; matched in the next round.
5324 ;; It turned out to be the real identifier,
5325 ;; so stop.
5326 nil))
5327 t))
5341 ;; Skip over an identifier.
5346 ;; Skip over type decl suffix operators.
5353 t)
5357 t)
5363 ;; No suffix matched. We might have matched the
5364 ;; identifier as a type and the open paren of a
5365 ;; function arglist as a type decl prefix. In that
5366 ;; case we should "backtrack": Reinterpret the last
5367 ;; type as the identifier, move out of the arglist and
5368 ;; continue searching for suffix operators.
5369 ;;
5370 ;; Do this even if there's no preceding type, to cope
5371 ;; with old style function declarations in K&R C,
5372 ;; (con|de)structors in C++ and `c-typeless-decl-kwds'
5373 ;; style declarations. That isn't applicable in an
5374 ;; arglist context, though.
5379 maybe-typeless
5380 backup-maybe-typeless
5387 t))
5394 at-type)
5395 ;; Have found no identifier but `c-typeless-decl-kwds' has
5396 ;; matched so we know we're inside a declaration. The
5397 ;; preceding type must be the identifier instead.
5401 at-decl-or-cast
5405 ;; Encountered something inside parens that isn't matched by
5406 ;; the `c-type-decl-*' regexps, so it's not a type decl
5407 ;; expression. Try to skip out to the same paren depth to
5408 ;; not confuse the cast check below.
5410 ;; If we've found a specifier keyword then it's a
5411 ;; declaration regardless.
5419 ;; Now we've collected info about various characteristics of
5420 ;; the construct we're looking at. Below follows a decision
5421 ;; tree based on that. It's ordered to check more certain
5422 ;; signs before less certain ones.
5429 ;; Got another identifier directly after the type, so it's a
5430 ;; declaration.
5437 maybe-typeless
5438 backup-maybe-typeless))
5439 ;; Got a declaration of the form "foo bar (gnu);" where we've
5440 ;; recognized "bar" as the type and "gnu" as the declarator.
5441 ;; In this case it's however more likely that "bar" is the
5442 ;; declarator and "gnu" a function argument or initializer (if
5443 ;; `c-recognize-paren-inits' is set), since the parens around
5444 ;; "gnu" would be superfluous if it's a declarator. Shift the
5445 ;; type one step backward.
5448 ;; Found no identifier.
5454 ;; Got a plain list of identifiers. If a colon follows it's
5455 ;; a valid label. Otherwise the last one probably is the
5456 ;; declared identifier and we should back up to the previous
5457 ;; type, providing it isn't a cast.
5459 ;; If we've found a specifier keyword then it's a
5460 ;; declaration regardless.
5468 ;; Got a plain list of identifiers followed by some suffix.
5469 ;; If this isn't a cast then the last identifier probably is
5470 ;; the declared one and we should back up to the previous
5471 ;; type.
5476 ;; If the type is known we know that there can't be any
5477 ;; identifier somewhere else, and it's only in declarations in
5478 ;; e.g. function prototypes and in casts that the identifier may
5479 ;; be left out.
5483 ;; Only got a single identifier (parsed as a type so far).
5485 ;; Check that the identifier isn't at the start of an
5486 ;; expression.
5487 at-decl-end
5490 ;; Inside an arglist that contains declarations. If K&R
5491 ;; style declarations and parenthesis style initializers
5492 ;; aren't allowed then the single identifier must be a
5493 ;; type, else we require that it's known or found
5494 ;; (primitive types are handled above).
5499 ;; Inside a template arglist. Accept known and found
5500 ;; types; other identifiers could just as well be
5501 ;; constants in C++.
5504 ;; Can't be a valid declaration or cast, but if we've found a
5505 ;; specifier it can't be anything else either, so treat it as
5506 ;; an invalid/unfinished declaration or cast.
5514 maybe-typeless
5515 backup-maybe-typeless
5519 c-after-suffixed-type-maybe-decl-key))))))
5520 ;; Got an empty paren pair and a preceding type that probably
5521 ;; really is the identifier. Shift the type backwards to make
5522 ;; the last one the identifier. This is analogous to the
5523 ;; "backtracking" done inside the `c-type-decl-suffix-key' loop
5524 ;; above.
5525 ;;
5526 ;; Exception: In addition to the conditions in that
5527 ;; "backtracking" code, do not shift backward if we're not
5528 ;; looking at either `c-after-suffixed-type-decl-key' or "[;,]".
5529 ;; Since there's no preceding type, the shift would mean that
5530 ;; the declaration is typeless. But if the regexp doesn't match
5531 ;; then we will simply fall through in the tests below and not
5532 ;; recognize it at all, so it's better to try it as an abstract
5533 ;; declarator instead.
5536 ;; Still no identifier.
5539 ;; Require `got-prefix' together with either `got-parens' or
5540 ;; `got-suffix' to recognize it as an abstract declarator:
5541 ;; `got-parens' only is probably an empty function call.
5542 ;; `got-suffix' only can build an ordinary expression together
5543 ;; with the preceding identifier which we've taken as a type.
5544 ;; We could actually accept on `got-prefix' only, but that can
5545 ;; easily occur temporarily while writing an expression so we
5546 ;; avoid that case anyway. We could do a better job if we knew
5547 ;; the point when the fontification was invoked.
5553 got-suffix-after-parens
5555 ;; Got a type, no declarator but a paren suffix. I.e. it's a
5556 ;; normal function call afterall (or perhaps a C++ style object
5557 ;; instantiation expression).
5561 ;; By now we've located the type in the declaration that we know
5562 ;; we're in.
5572 ;; Shift the type backward in the case that there's a
5573 ;; single identifier inside parens. That can only
5574 ;; occur in K&R style function declarations so it's
5575 ;; more likely that it really is a function call.
5576 ;; Therefore we only do this after
5577 ;; `c-after-suffixed-type-decl-key' has matched.
5579 got-suffix-after-parens))
5580 ;; A declaration according to `c-after-suffixed-type-decl-key'.
5585 ;; It's a declaration if a known type precedes it and it can't be a
5586 ;; function call.
5589 ;; If we get here we can't tell if this is a type decl or a normal
5590 ;; expression by looking at it alone. (That's under the assumption
5591 ;; that normal expressions always can look like type decl expressions,
5592 ;; which isn't really true but the cases where it doesn't hold are so
5593 ;; uncommon (e.g. some placements of "const" in C++) it's not worth
5594 ;; the effort to look for them.)
5597 ;; If this is a declaration it should end here or its initializer(*)
5598 ;; should start here, so check for allowed separation tokens. Note
5599 ;; that this rule doesn't work e.g. with a K&R arglist after a
5600 ;; function header.
5601 ;;
5602 ;; *) Don't check for C++ style initializers using parens
5603 ;; since those already have been matched as suffixes.
5604 ;;
5605 ;; If `at-decl-or-cast' is then we've found some other sign that
5606 ;; it's a declaration or cast, so then it's probably an
5607 ;; invalid/unfinished one.
5610 ;; Below are tests that only should be applied when we're certain to
5611 ;; not have parsed halfway through an expression.
5614 ;; The expression starts with a known type so treat it as a
5615 ;; declaration.
5619 ;; In C++ we check if the identifier is a known type, since
5620 ;; (con|de)structors use the class name as identifier.
5621 ;; We've always shifted over the identifier as a type and
5622 ;; then backed up again in this case.
5623 identifier-type
5626 ;; `at-type' probably won't be 'found for
5627 ;; destructors since the "~" is then part of the
5628 ;; type name being checked against the list of
5629 ;; known types, so do a check without that
5630 ;; operator.
5635 c-identifier-syntax-table
5639 ;; We have already parsed the type earlier,
5640 ;; so it'd be possible to cache the end
5641 ;; position instead of redoing it here, but
5642 ;; then we'd need to keep track of another
5643 ;; position everywhere.
5652 at-type
5656 ;; Got something like "foo * bar;". Since we're not inside an
5657 ;; arglist it would be a meaningless expression because the
5658 ;; result isn't used. We therefore choose to recognize it as
5659 ;; a declaration. Do not allow a suffix since it could then
5660 ;; be a function call.
5667 ;; Got something like "a (*b) (c);" or "a (b) = c;". It could
5668 ;; be an odd expression or it could be a declaration. Treat
5669 ;; it as a declaration if "a" has been used as a type
5670 ;; somewhere else (if it's a known type we won't get here).
5678 ;; Got a type followed by an abstract declarator. If `got-prefix'
5679 ;; is set it's something like "a *" without anything after it. If
5680 ;; `got-parens' or `got-suffix' is set it's "a()", "a[]", "a()[]",
5681 ;; or similar, which we accept only if the context rules out
5682 ;; expressions.
5685 ;; If we had a complete symbol table here (which rules out
5686 ;; `c-found-types') we should return t due to the disambiguation rule
5687 ;; (in at least C++) that anything that can be parsed as a declaration
5688 ;; is a declaration. Now we're being more defensive and prefer to
5689 ;; highlight things like "foo (bar);" as a declaration only if we're
5690 ;; inside an arglist that contains declarations.
5693 ;; The point is now after the type decl expression.
5696 ;; Check for a cast.
5699 c-cast-parens
5701 ;; Should be the first type/identifier in a cast paren.
5705 ;; The closing paren should follow.
5710 ;; There should be a primary expression after it.
5719 ;; Check if the expression begins with a prefix keyword.
5722 ;; Expression begins with an ambiguous operator. Treat
5723 ;; it as a cast if it's a type decl or if we've
5724 ;; recognized the type somewhere else.
5727 ;; Unless it's a keyword, it's the beginning of a primary
5728 ;; expression.
5730 ;; If `c-primary-expr-regexp' matched a nonsymbol token, check
5731 ;; that it matched a whole one so that we don't e.g. confuse
5732 ;; the operator '-' with '->'. It's ok if it matches further,
5733 ;; though, since it e.g. can match the float '.5' while the
5734 ;; operator regexp only matches '.'.
5738 ;; There should either be a cast before it or something that isn't an
5739 ;; identifier or close paren.
5747 ;; It's a symbol. Accept it only if it's one of the
5748 ;; keywords that can precede an expression (without
5749 ;; surrounding parens).
5752 ;; Check that it isn't a close paren (block close is ok,
5753 ;; though).
5755 ;; Check that it isn't a nonsymbol identifier.
5758 ;; Handle the cast.
5768 ;; We're at a declaration. Highlight the type and the following
5769 ;; declarators.
5775 ;; Make sure to propagate the `c-decl-arg-start' property to
5776 ;; the next argument if it's set in this one, to cope with
5777 ;; interactive refontification.
5789 ;; False alarm. Restore the recorded ranges.
5791 c-record-ref-identifiers save-rec-ref-ids)
5792 nil))))
5795 ;; Assuming the point is at the beginning of a token, check if it
5796 ;; starts a label and if so move over it and return t, otherwise
5797 ;; don't move and return nil. The end of the label is taken to be
5798 ;; the end of the first submatch in `c-opt-extra-label-key' if it
5799 ;; matched, otherwise it's the colon. The point is directly after
5800 ;; the end on return. The terminating char is marked with
5801 ;; `c-decl-end' to improve recognition of the following declaration
5802 ;; or statement.
5803 ;;
5804 ;; If ASSUME-MARKUP is non-nil, it's assumed that the preceding
5805 ;; label, if any, has been marked up like that.
5806 ;;
5807 ;; If PRECEDING-TOKEN-END is given, it should be the first position
5808 ;; after the preceding token, i.e. on the other side of the
5809 ;; syntactic ws from the point. Use a value less than or equal to
5810 ;; (point-min) if the point is at the first token in (the visible
5811 ;; part of) the buffer.
5812 ;;
5813 ;; The optional LIMIT limits the forward scan for the colon.
5814 ;;
5815 ;; This function records the ranges of the label symbols on
5816 ;; `c-record-ref-identifiers' if `c-record-type-identifiers' (!) is
5817 ;; non-nil.
5818 ;;
5819 ;; This function might do hidden buffer changes.
5825 ;; Record only the keyword itself for fontification, since in
5826 ;; case labels the following is a constant expression and not
5827 ;; a label.
5831 ;; Find the label end.
5834 ;; Stop on chars that aren't allowed in expressions,
5835 ;; and on operator chars that would be meaningless
5836 ;; there. FIXME: This doesn't cope with ?: operators.
5844 t)
5846 ;; It's an unfinished label. We consider the keyword enough
5847 ;; to recognize it as a label, so that it gets fontified.
5848 ;; Leave the point at the end of it, but don't put any
5849 ;; `c-decl-end' marker.
5851 t)))
5855 ;; For a `c-opt-extra-label-key' match, we record the whole
5856 ;; thing for fontification. That's to get the leading '@' in
5857 ;; Objective-C protection labels fontified.
5862 t)
5866 ;; A colon label must have something before the colon.
5869 ;; Check that we're not after a token that can't precede a label.
5871 ;; Trivially succeeds when there's no preceding token.
5879 ;; Check if we're after a label, if we're after a closing
5880 ;; paren that belong to statement, and with
5881 ;; `c-label-prefix-re'. It's done in different order
5882 ;; depending on `assume-markup' since the checks have
5883 ;; different expensiveness.
5908 ;; Might be after another label, so check it recursively.
5911 ;; Essentially the same as the
5912 ;; `c-syntactic-re-search-forward' regexp below.
5915 ;; If the caller turned on recording for us,
5916 ;; it shouldn't apply when we check the
5917 ;; preceding label.
5918 c-record-type-identifiers)
5922 ;; Check that the next nonsymbol token is ":". Allow '('
5923 ;; for the sake of macro arguments. FIXME: Should build
5924 ;; this regexp from the language constants.
5933 ;; Check that `c-nonlabel-token-key' doesn't match anywhere.
5942 t)
5945 ;; Record the identifiers in the label for fontification, unless
5946 ;; it begins with `c-label-kwds' in which case the following
5947 ;; identifiers are part of a (constant) expression that
5948 ;; shouldn't be fontified.
5958 t)))
5961 ;; Not a label.
5963 nil))))
5966 ;; Assuming the point is at the beginning of a token, try to move
5967 ;; forward to the end of the Objective-C directive that starts
5968 ;; there. Return t if a directive was fully recognized, otherwise
5969 ;; the point is moved as far as one could be successfully parsed and
5970 ;; nil is returned.
5971 ;;
5972 ;; This function records identifier ranges on
5973 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5974 ;; `c-record-type-identifiers' is non-nil.
5975 ;;
5976 ;; This function might do hidden buffer changes.
5979 start-char
5981 ;; Turn off recognition of angle bracket arglists while parsing
5982 ;; types here since the protocol reference list might then be
5983 ;; considered part of the preceding name or superclass-name.
5994 t)
6003 ;; Handle the name of the class itself.
6005 ; (c-forward-token-2) ; 2006/1/13 This doesn't move if the token's
6006 ; at EOB.
6012 ;; Look for ": superclass-name" or "( category-name )".
6023 ;; Look for a protocol reference list.
6029 t))))
6035 t)
6038 nil)))
6041 ;; Go to the first non-whitespace after the colon that starts a
6042 ;; multiple inheritance introduction. Optional LIM is the farthest
6043 ;; back we should search.
6044 ;;
6045 ;; This function might do hidden buffer changes.
6053 ;; Return nil if we aren't in a method definition, otherwise the
6054 ;; position of the initial [+-].
6055 ;;
6056 ;; This function might do hidden buffer changes.
6062 ))
6064 ;; Contributed by Kevin Ryde <user42@zip.com.au>.
6066 ;; Return non-nil if point is within a gcc \"asm\" block.
6067 ;;
6068 ;; This should be called with point inside an argument list.
6069 ;;
6070 ;; Only one level of enclosing parentheses is considered, so for
6071 ;; instance `nil' is returned when in a function call within an asm
6072 ;; operand.
6073 ;;
6074 ;; This function might do hidden buffer changes.
6084 "Return a determination as to whether point is at the `top-level'.
6085 Being at the top-level means that point is either outside any
6086 enclosing block (such function definition), or only inside a class,
6087 namespace or other block that contains another declaration level.
6089 If point is not at the top-level (e.g. it is inside a method
6090 definition), then nil is returned. Otherwise, if point is at a
6091 top-level not enclosed within a class definition, t is returned.
6092 Otherwise, a 2-vector is returned where the zeroth element is the
6093 buffer position of the start of the class declaration, and the first
6094 element is the buffer position of the enclosing class's opening
6095 brace.
6097 Note that this function might do hidden buffer changes. See the
6098 comment at the start of cc-engine.el for more info."
6104 ;; Return non-nil if the point is in the region after the argument
6105 ;; list of a function and its opening brace (or semicolon in case it
6106 ;; got no body). If there are K&R style argument declarations in
6107 ;; that region, the point has to be inside the first one for this
6108 ;; function to recognize it.
6109 ;;
6110 ;; If successful, the point is moved to the first token after the
6111 ;; function header (see `c-forward-decl-or-cast-1' for details) and
6112 ;; the position of the opening paren of the function arglist is
6113 ;; returned.
6114 ;;
6115 ;; The point is clobbered if not successful.
6116 ;;
6117 ;; LIM is used as bound for backward buffer searches.
6118 ;;
6119 ;; This function might do hidden buffer changes.
6132 ;; There should not be a '=' or ',' between beg and the
6133 ;; start of the declaration since that means we were in the
6134 ;; "expression part" of the declaration.
6139 ;; Check that there's an arglist paren in the
6140 ;; declaration.
6143 ;; The declarator is a paren expression, so skip past it
6144 ;; so that we don't get stuck on that instead of the
6145 ;; function arglist.
6149 ;; Don't trip up on "operator ()".
6156 ;; Return the position of the first argument declaration if point is
6157 ;; inside a K&R style argument declaration list, nil otherwise.
6158 ;; `c-recognize-knr-p' is not checked. If LIM is non-nil, it's a
6159 ;; position that bounds the backward search for the argument list.
6160 ;;
6161 ;; Note: A declaration level context is assumed; the test can return
6162 ;; false positives for statements.
6163 ;;
6164 ;; This function might do hidden buffer changes.
6169 ;; Go back to the closest preceding normal parenthesis sexp. We
6170 ;; take that as the argument list in the function header. Then
6171 ;; check that it's followed by some symbol before the next ';'
6172 ;; or '{'. If it does, it's the header of the K&R argdecl we're
6173 ;; in.
6176 paren-end)
6192 ;; The function header in a K&R declaration should only
6193 ;; contain identifiers separated by comma. It should
6194 ;; also contain at least one identifier since there
6195 ;; wouldn't be anything to declare in the K&R region
6196 ;; otherwise.
6212 ;; If it's a K&R declaration then we're now at the
6213 ;; beginning of the function arglist. Check that there
6214 ;; isn't a '=' before it in this statement since that
6215 ;; means it some kind of initialization instead.
6222 ;; skip forward over conditional at point, including any predicate
6223 ;; statements in parentheses. No error checking is performed.
6224 ;;
6225 ;; This function might do hidden buffer changes.
6227 ;; else if()
6232 ;; do, else, try, finally
6237 ;; for, if, while, switch, catch, synchronized, foreach
6241 ;; If looking at the token after a conditional then return the
6242 ;; position of its start, otherwise return nil.
6243 ;;
6244 ;; This function might do hidden buffer changes.
6254 ;; If the point is after an operator identifier that isn't handled
6255 ;; like an ordinary symbol (i.e. like "operator =" in C++) then the
6256 ;; position of the start of that identifier is returned. nil is
6257 ;; returned otherwise. The point may be anywhere in the syntactic
6258 ;; whitespace after the last token of the operator identifier.
6259 ;;
6260 ;; This function might do hidden buffer changes.
6272 ;; Assuming point is at a brace that opens a statement block of some
6273 ;; kind, move to the proper anchor point for that block. It might
6274 ;; need to be adjusted further by c-add-stmt-syntax, but the
6275 ;; position at return is suitable as start position for that
6276 ;; function.
6277 ;;
6278 ;; This function might do hidden buffer changes.
6285 ;; Assuming point is at a brace that opens the block of a top level
6286 ;; declaration of some kind, move to the proper anchor point for
6287 ;; that block.
6288 ;;
6289 ;; This function might do hidden buffer changes.
6294 ;; Search forward for the end of the "header" of the current
6295 ;; declaration. That's the position where the definition body
6296 ;; starts, or the first variable initializer, or the ending
6297 ;; semicolon. I.e. search forward for the closest following
6298 ;; (syntactically relevant) '{', '=' or ';' token. Point is left
6299 ;; _after_ the first found token, or at point-max if none is found.
6300 ;;
6301 ;; This function might do hidden buffer changes.
6306 ;; In C++ we need to take special care to handle operator
6307 ;; tokens and those pesky template brackets.
6312 ;; Handle operator identifiers, i.e. ignore any
6313 ;; operator token preceded by "operator".
6320 t
6322 nil)))))
6331 ;; Go to the beginning of the current declaration, or the beginning
6332 ;; of the previous one if already at the start of it. Point won't
6333 ;; be moved out of any surrounding paren. Return a cons cell of the
6334 ;; form (MOVE . KNR-POS). MOVE is like the return value from
6335 ;; `c-beginning-of-statement-1'. If point skipped over some K&R
6336 ;; style argument declarations (and they are to be recognized) then
6337 ;; KNR-POS is set to the start of the first such argument
6338 ;; declaration, otherwise KNR-POS is nil. If LIM is non-nil, it's a
6339 ;; position that bounds the backward search.
6340 ;;
6341 ;; NB: Cases where the declaration continues after the block, as in
6342 ;; "struct foo { ... } bar;", are currently recognized as two
6343 ;; declarations, e.g. "struct foo { ... }" and "bar;" in this case.
6344 ;;
6345 ;; This function might do hidden buffer changes.
6351 ;; `c-beginning-of-statement-1' stops at a block start, but we
6352 ;; want to continue if the block doesn't begin a top level
6353 ;; construct, i.e. if it isn't preceded by ';', '}', ':', bob,
6354 ;; or an open paren.
6357 ;; Must check with c-opt-method-key in ObjC mode.
6367 ;; Check that we don't move from the first thing in a
6368 ;; macro to its header.
6374 move tentative-move))
6379 ;; Handle K&R argdecls. Back up after the "statement" jumped
6380 ;; over by `c-beginning-of-statement-1', unless it was the
6381 ;; function body, in which case we're sitting on the opening
6382 ;; brace now. Then test if we're in a K&R argdecl region and
6383 ;; that we started at the other side of the first argdecl in
6384 ;; it.
6394 'previous
6396 knr-argdecl-start))
6399 ;; `c-beginning-of-statement-1' counts each brace block as a
6400 ;; separate statement, so the result will be 'previous if we've
6401 ;; moved over any. If they were brace list initializers we might
6402 ;; not have moved over a declaration boundary though, so change it
6403 ;; to 'same if we've moved past a '=' before '{', but not ';'.
6404 ;; (This ought to be integrated into `c-beginning-of-statement-1',
6405 ;; so we avoid this extra pass which potentially can search over a
6406 ;; large amount of text.)
6409 c++-template-syntax-table
6422 ;; Assuming point is at the start of a declaration (as detected by
6423 ;; e.g. `c-beginning-of-decl-1'), go to the end of it. Unlike
6424 ;; `c-beginning-of-decl-1', this function handles the case when a
6425 ;; block is followed by identifiers in e.g. struct declarations in C
6426 ;; or C++. If a proper end was found then t is returned, otherwise
6427 ;; point is moved as far as possible within the current sexp and nil
6428 ;; is returned. This function doesn't handle macros; use
6429 ;; `c-end-of-macro' instead in those cases.
6430 ;;
6431 ;; This function might do hidden buffer changes.
6434 c++-template-syntax-table
6442 ;; Stopped at the ';' in a K&R argdecl section which is
6443 ;; detected using the same criteria as in
6444 ;; `c-beginning-of-decl-1'. Move to the following block
6445 ;; start.
6449 ;; Encountered a block in the declaration. Jump over it.
6460 ;; Check for `c-opt-block-decls-with-vars-key'
6461 ;; before the first paren.
6464 c-opt-block-decls-with-vars-key
6466 lim t t t)
6469 ;; Check that the first following paren is
6470 ;; the block.
6472 lim t t t)
6474 ;; The declaration doesn't have any of the
6475 ;; `c-opt-block-decls-with-vars' keywords in the
6476 ;; beginning, so it ends here at the end of the block.
6484 nil)))
6487 ;; Assuming the point is at an open brace, check if it starts a
6488 ;; block that contains another declaration level, i.e. that isn't a
6489 ;; statement block or a brace list, and if so return non-nil.
6490 ;;
6491 ;; If the check is successful, the return value is the start of the
6492 ;; keyword that tells what kind of construct it is, i.e. typically
6493 ;; what `c-decl-block-key' matched. Also, if GOTO-START is set then
6494 ;; the point will be at the start of the construct, before any
6495 ;; leading specifiers, otherwise it's at the returned position.
6496 ;;
6497 ;; The point is clobbered if the check is unsuccessful.
6498 ;;
6499 ;; CONTAINING-SEXP is the position of the open of the surrounding
6500 ;; paren, or nil if none.
6501 ;;
6502 ;; The optional LIMIT limits the backward search for the start of
6503 ;; the construct. It's assumed to be at a syntactically relevant
6504 ;; position.
6505 ;;
6506 ;; If any template arglists are found in the searched region before
6507 ;; the open brace, they get marked with paren syntax.
6508 ;;
6509 ;; This function might do hidden buffer changes.
6516 ;; Could be at the end of a template arglist.
6527 ;; Note: Can't get bogus hits inside template arglists below since they
6528 ;; have gotten paren syntax above.
6530 ;; If `goto-start' is set we begin by searching for the
6531 ;; first possible position of a leading specifier list.
6532 ;; The `c-decl-block-key' search continues from there since
6533 ;; we know it can't match earlier.
6536 open-brace t t)
6538 t)
6539 t)
6546 ;; Found a keyword that can't be a type?
6549 ;; Can be a type too, in which case it's the return type of a
6550 ;; function (under the assumption that no declaration level
6551 ;; block construct starts with a type).
6554 ;; Jumped over a type, but it could be a declaration keyword
6555 ;; followed by the declared identifier that we've jumped over
6556 ;; instead (e.g. in "class Foo {"). If it indeed is a type
6557 ;; then we should be at the declarator now, so check for a
6558 ;; valid declarator start.
6559 ;;
6560 ;; Note: This doesn't cope with the case when a declared
6561 ;; identifier is followed by e.g. '(' in a language where '('
6562 ;; also might be part of a declarator expression. Currently
6563 ;; there's no such language.
6567 ;; In Pike a list of modifiers may be followed by a brace
6568 ;; to make them apply to many identifiers. Note that the
6569 ;; match data will be empty on return in this case.
6575 ;; Use this variant to avoid yet another special regexp.
6579 t)))
6581 ;; Got a match.
6584 ;; Back up over any preceding specifiers and their clauses
6585 ;; by going forward from `first-specifier-pos', which is the
6586 ;; earliest possible position where the specifier list can
6587 ;; start.
6593 ;; Accept any plain symbol token on the ground that
6594 ;; it's a specifier masked through a macro (just
6595 ;; like `c-forward-decl-or-cast-1' skip forward over
6596 ;; such tokens).
6597 ;;
6598 ;; Could be more restrictive wrt invalid keywords,
6599 ;; but that'd only occur in invalid code so there's
6600 ;; no use spending effort on it.
6606 ;; Can't parse a declaration preamble and is still
6607 ;; before `kwd-start'. That means `first-specifier-pos'
6608 ;; was in some earlier construct. Search again.
6612 ;; Got no preamble before the block declaration keyword.
6618 kwd-start)))
6621 ;; Check if the closest containing paren sexp is a declaration
6622 ;; block, returning a 2 element vector in that case. Aref 0
6623 ;; contains the bufpos at boi of the class key line, and aref 1
6624 ;; contains the bufpos of the open brace. This function is an
6625 ;; obsolete wrapper for `c-looking-at-decl-block'.
6626 ;;
6627 ;; This function might do hidden buffer changes.
6635 nil))
6640 ;; return the buffer position of the beginning of the brace list
6641 ;; statement if we're inside a brace list, otherwise return nil.
6642 ;; CONTAINING-SEXP is the buffer pos of the innermost containing
6643 ;; paren. PAREN-STATE is the remainder of the state of enclosing
6644 ;; braces
6645 ;;
6646 ;; N.B.: This algorithm can potentially get confused by cpp macros
6647 ;; placed in inconvenient locations. It's a trade-off we make for
6648 ;; speed.
6649 ;;
6650 ;; This function might do hidden buffer changes.
6652 ;; This will pick up brace list declarations.
6665 ;; this will pick up array/aggregate init lists, even if they are nested.
6668 ;; Pike can have class definitions anywhere, so we must
6669 ;; check for the class key here.
6671 c-decl-block-key))
6672 bufpos braceassignp lim next-containing)
6674 containing-sexp)
6685 ;; We're in an in-expression block of some kind. Do not
6686 ;; check nesting. We deliberately set the limit to the
6687 ;; containing sexp, so that c-looking-at-inexpr-block
6688 ;; doesn't check for an identifier before it.
6690 ;; see if the open brace is preceded by = or [...] in
6691 ;; this statement, but watch out for operator=
6694 ;; Checks to do only on the first sexp before the brace.
6697 ;; In Java, an initialization brace list may follow
6698 ;; directly after "new Foo[]", so check for a "new"
6699 ;; earlier.
6705 ;; Carry on looking if this is an
6706 ;; identifier (may contain "." in Java)
6707 ;; or another "[]" sexp.
6710 ;; Checks to do on all sexps before the brace, up to the
6711 ;; beginning of the statement.
6719 ;; We've seen a =, but must check earlier tokens so
6720 ;; that it isn't something that should be ignored.
6726 ;; Check for operator =
6729 nil)
6730 ;; Check for `<opchar>= in Pike.
6733 ;; Special case for Pikes
6734 ;; `[]=, since '[' is not in
6735 ;; the punctuation class.
6738 nil)
6740 ;; make sure we're not in a C++ template
6741 ;; argument assignment
6753 ))))
6754 nil)
6761 ;; Brace lists can't contain a semicolon, so we're done.
6763 ;; Go up one level.
6765 lim nil
6766 next-containing nil))
6767 ;; we've hit the beginning of the aggregate list
6771 )
6772 bufpos))
6773 ))
6776 ;; If we're looking at the start of a pike-style list, ie `({Â })',
6777 ;; `([Â ])', `(<Â >)' etc, a cons of a cons of its starting and ending
6778 ;; positions and its entry in c-special-brace-lists is returned, nil
6779 ;; otherwise. The ending position is nil if the list is still open.
6780 ;; LIM is the limit for forward search. The point may either be at
6781 ;; the `(' or at the following paren character. Tries to check the
6782 ;; matching closer, but assumes it's correct if no balanced paren is
6783 ;; found (i.e. the case `({ ... } ... )' is detected as _not_ being
6784 ;; a special brace list).
6785 ;;
6786 ;; This function might do hidden buffer changes.
6791 inner-beg end type)
6806 nil)))))
6816 ;; Check balancing of the inner paren
6817 ;; below.
6820 t)
6821 ;; If the inner char isn't a paren then
6822 ;; we can't check balancing, so just
6823 ;; check the char before the outer
6824 ;; closing paren.
6839 ;; Return non-nil if between two statements or declarations, assuming
6840 ;; point is not inside a literal or comment.
6841 ;;
6842 ;; Obsolete - `c-at-statement-start-p' or `c-at-expression-start-p'
6843 ;; are recommended instead.
6844 ;;
6845 ;; This function might do hidden buffer changes.
6850 ;; Return non-nil if we're looking at the beginning of a block
6851 ;; inside an expression. The value returned is actually a cons of
6852 ;; either 'inlambda, 'inexpr-statement or 'inexpr-class and the
6853 ;; position of the beginning of the construct.
6854 ;;
6855 ;; LIM limits the backward search. CONTAINING-SEXP is the start
6856 ;; position of the closest containing list. If it's nil, the
6857 ;; containing paren isn't used to decide whether we're inside an
6858 ;; expression or not. If both LIM and CONTAINING-SEXP are used, LIM
6859 ;; needs to be farther back.
6860 ;;
6861 ;; If CHECK-AT-END is non-nil then extra checks at the end of the
6862 ;; brace block might be done. It should only be used when the
6863 ;; construct can be assumed to be complete, i.e. when the original
6864 ;; starting position was further down than that.
6865 ;;
6866 ;; This function might do hidden buffer changes.
6871 ;; Look at the character after point only as a last resort
6872 ;; when we can't disambiguate.
6892 ;; If the class definition is at the start of
6893 ;; a statement, we don't consider it an
6894 ;; in-expression class.
6902 ;; Also, in Pike we treat it as an
6903 ;; in-expression class if it's used in an
6904 ;; object clone expression.
6920 nil)
6928 ;; Accept several square bracket sexps for
6929 ;; Java array initializations.
6937 block-follows
6938 containing-sexp
6947 nil
6950 res))))
6953 ;; Returns non-nil if we're looking at the end of an in-expression
6954 ;; block, otherwise the same as `c-looking-at-inexpr-block'.
6955 ;; PAREN-STATE is the paren state relevant at the current position.
6956 ;;
6957 ;; This function might do hidden buffer changes.
6959 ;; We currently only recognize a block.
6962 containing-sexp)
6971 paren-state)
6972 containing-sexp)))))
6974 \f
6975 ;; `c-guess-basic-syntax' and the functions that precedes it below
6976 ;; implements the main decision tree for determining the syntactic
6977 ;; analysis of the current line of code.
6979 ;; Dynamically bound to t when `c-guess-basic-syntax' is called during
6980 ;; auto newline analysis.
6984 ;; A simple function to prepend a new syntax element to
6985 ;; `c-syntactic-context'. Using `setq' on it is unsafe since it
6986 ;; should always be dynamically bound but since we read it first
6987 ;; we'll fail properly anyway if this function is misused.
6989 c-syntactic-context)))
6992 ;; Like `c-add-syntax' but appends to the end of the syntax list.
6993 ;; (Normally not necessary.)
6998 syntax-extra-args
6999 stop-at-boi-only
7000 containing-sexp
7001 paren-state)
7002 ;; Do the generic processing to anchor the given syntax symbol on
7003 ;; the preceding statement: Skip over any labels and containing
7004 ;; statements on the same line, and then search backward until we
7005 ;; find a statement or block start that begins at boi without a
7006 ;; label or comment.
7007 ;;
7008 ;; Point is assumed to be at the prospective anchor point for the
7009 ;; given SYNTAX-SYMBOL. More syntax entries are added if we need to
7010 ;; skip past open parens and containing statements. All the added
7011 ;; syntax elements will get the same anchor point.
7012 ;;
7013 ;; SYNTAX-EXTRA-ARGS are a list of the extra arguments for the
7014 ;; syntax symbol. They are appended after the anchor point.
7015 ;;
7016 ;; If STOP-AT-BOI-ONLY is nil, we can stop in the middle of the line
7017 ;; if the current statement starts there.
7018 ;;
7019 ;; Note: It's not a problem if PAREN-STATE "overshoots"
7020 ;; CONTAINING-SEXP, i.e. contains info about parens further down.
7021 ;;
7022 ;; This function might do hidden buffer changes.
7025 ;; This is by far the most common case, so let's give it special
7026 ;; treatment.
7031 ;; Set when we're on a label, so that we don't stop there.
7032 ;; FIXME: To be complete we should check if we're on a label
7033 ;; now at the start.
7034 on-label)
7038 ;; Loop while we have to back out of containing blocks.
7043 ;; Loop while we have to back up statements.
7045 on-label
7048 ;; Skip past any comments that stands between the
7049 ;; statement start and boi.
7057 ;; Skip to the beginning of this statement or backward
7058 ;; another one.
7066 ;; If we didn't move we're at the start of a block and
7067 ;; have to continue outside it.
7076 ;; Special case to avoid deeper and deeper indentation
7077 ;; of "else if" clauses.
7078 )
7083 ;; If stop-at-boi-only is nil, we shouldn't back up
7084 ;; over previous or containing statements to try to
7085 ;; reach boi, so go back to the last position and
7086 ;; exit.
7093 ;; If we've moved into another statement then we
7094 ;; should no longer try to stop in the middle of a
7095 ;; line.
7098 ;; Record this as a substatement if we skipped up one
7099 ;; level.
7102 )))
7104 containing-sexp)
7106 ;; Now we have to go out of this block.
7109 ;; Don't stop in the middle of a special brace list opener
7110 ;; like "({".
7122 ;; Analyze the construct in front of the block we've stepped out
7123 ;; from and add the right syntactic element for it.
7126 step-type)
7129 ;; Stepped out of a parenthesis block, so we're in an
7130 ;; expression now.
7142 ;; Stepped out of an in-expression statement. This
7143 ;; syntactic element won't get an anchor pos.
7146 ;; A parenthesis normally belongs to an arglist.
7154 on-label nil))
7165 paren-state)
7166 containing-sexp)))
7174 ;; Always done if the open brace was at boi. The
7175 ;; c-beginning-of-statement-1 call above is necessary
7176 ;; anyway, to decide the type of block-intro to add.
7179 ))
7181 ;; Fill in the current point as the anchor for all the symbols
7182 ;; added above.
7188 )))
7191 containing-decl-open
7192 containing-decl-start
7193 containing-decl-kwd
7194 paren-state)
7195 ;; The inclass and class-close syntactic symbols are added in
7196 ;; several places and some work is needed to fix everything.
7197 ;; Therefore it's collected here.
7198 ;;
7199 ;; This function might do hidden buffer changes.
7204 containing-decl-open)
7206 ;; Ought to use `c-add-stmt-syntax' instead of backing up to boi
7207 ;; here, but we have to do like this for compatibility.
7217 char-after-ip
7218 beg-of-same-or-containing-stmt
7219 containing-sexp
7220 paren-state)
7221 ;; This function contains the decision tree reached through both
7222 ;; cases 18 and 10. It's a continued statement or top level
7223 ;; construct of some kind.
7224 ;;
7225 ;; This function might do hidden buffer changes.
7232 ;; (CASE A removed.)
7233 ;; CASE B: open braces for class or brace-lists
7240 ;; CASE B.1: class-open
7247 ;; CASE B.2: brace-list-open
7252 indent-point t t t)))
7253 ;; The most semantically accurate symbol here is
7254 ;; brace-list-open, but we normally report it simply as a
7255 ;; statement-cont. The reason is that one normally adjusts
7256 ;; brace-list-open for brace lists as top-level constructs,
7257 ;; and brace lists inside statements is a completely different
7258 ;; context. C.f. case 5A.3.
7261 ;; Turn off the dwim above when we're
7262 ;; analyzing the nature of the brace
7263 ;; for the auto newline feature.
7264 'brace-list-open
7266 nil nil
7267 containing-sexp paren-state))
7269 ;; CASE B.3: The body of a function declared inside a normal
7270 ;; block. Can occur e.g. in Pike and when using gcc
7271 ;; extensions, but watch out for macros followed by blocks.
7272 ;; C.f. cases E, 16F and 17G.
7278 ;; Turn off recognition of constructs that lacks a
7279 ;; type in this case, since that's more likely to be
7280 ;; a macro followed by a block.
7283 containing-sexp paren-state))
7285 ;; CASE B.4: Continued statement with block open. The most
7286 ;; accurate analysis is perhaps `statement-cont' together with
7287 ;; `block-open' but we play DWIM and use `substatement-open'
7288 ;; instead. The rationaly is that this typically is a macro
7289 ;; followed by a block which makes it very similar to a
7290 ;; statement with a substatement block.
7293 containing-sexp paren-state))
7294 ))
7296 ;; CASE C: iostream insertion or extraction operator
7300 ;; If there is no preceding streamop in the statement
7301 ;; then indent this line as a normal statement-cont.
7305 t))))
7307 ;; CASE E: In the "K&R region" of a function declared inside a
7308 ;; normal block. C.f. case B.3.
7310 ;; Check that the next token is a '{'. This works as
7311 ;; long as no language that allows nested function
7312 ;; definitions allows stuff like member init lists, K&R
7313 ;; declarations or throws clauses there.
7314 ;;
7315 ;; Note that we do a forward search for something ahead
7316 ;; of the indentation line here. That's not good since
7317 ;; the user might not have typed it yet. Unfortunately
7318 ;; it's exceedingly tricky to recognize a function
7319 ;; prototype in a code block without resorting to this.
7327 ;; Turn off recognition of constructs that lacks a
7328 ;; type in this case, since that's more likely to be
7329 ;; a macro followed by a block.
7332 containing-sexp paren-state))
7334 ;; CASE D: continued statement.
7338 containing-sexp paren-state))
7339 )))
7341 ;; The next autoload was added by RMS on 2005/8/9 - don't know why (ACM,
7342 ;; 2005/11/29).
7343 ;;;###autoload
7345 "Return the syntactic context of the current line."
7351 ;; A whole ugly bunch of various temporary variables. Have
7352 ;; to declare them here since it's not possible to declare
7353 ;; a variable with only the scope of a cond test and the
7354 ;; following result clauses, and most of this function is a
7355 ;; single gigantic cond. :P
7356 literal char-before-ip before-ws-ip char-after-ip macro-start
7357 in-macro-expr c-syntactic-context placeholder c-in-literal-cache
7358 step-type tmpsymbol keyword injava-inher special-brace-list tmp-pos
7359 ;; The following record some positions for the containing
7360 ;; declaration block if we're directly within one:
7361 ;; `containing-decl-open' is the position of the open
7362 ;; brace. `containing-decl-start' is the start of the
7363 ;; declaration. `containing-decl-kwd' is the keyword
7364 ;; symbol of the keyword that tells what kind of block it
7365 ;; is.
7366 containing-decl-open
7367 containing-decl-start
7368 containing-decl-kwd
7369 ;; The open paren of the closest surrounding sexp or nil if
7370 ;; there is none.
7371 containing-sexp
7372 ;; The position after the closest preceding brace sexp
7373 ;; (nested sexps are ignored), or the position after
7374 ;; `containing-sexp' if there is none, or (point-min) if
7375 ;; `containing-sexp' is nil.
7376 lim
7377 ;; The paren state outside `containing-sexp', or at
7378 ;; `indent-point' if `containing-sexp' is nil.
7380 ;; There's always at most one syntactic element which got
7381 ;; an anchor pos. It's stored in syntactic-relpos.
7382 syntactic-relpos
7385 ;; Check if we're directly inside an enclosing declaration
7386 ;; level block.
7395 containing-sexp)
7396 t)))
7399 containing-sexp nil)
7404 ;; Init some position variables.
7413 ;; Ignore balanced paren. The next entry
7414 ;; can't be another one.
7417 ;; If there is no surrounding open paren then
7418 ;; put the last balanced pair back on paren-state.
7420 containing-sexp nil)))
7424 ;; If we're in a parenthesis list then ',' delimits the
7425 ;; "statements" rather than being an operator (with the
7426 ;; exception of the "for" clause). This difference is
7427 ;; typically only noticeable when statements are used in macro
7428 ;; arglists.
7433 ;; cache char before and after indent point, and move point to
7434 ;; the most likely position to perform the majority of tests
7443 ;; are we in a literal?
7446 ;; now figure out syntactic qualities of the current line
7449 ;; CASE 1: in a string.
7453 ;; CASE 2: in a C or C++ style comment.
7455 ;; This is a kludge for XEmacs where we use
7456 ;; `buffer-syntactic-context', which doesn't correctly
7457 ;; recognize "\*/" to end a block comment.
7458 ;; `parse-partial-sexp' which is used by
7459 ;; `c-literal-limits' will however do that in most
7460 ;; versions, which results in that we get nil from
7461 ;; `c-literal-limits' even when `c-in-literal' claims
7462 ;; we're inside a comment.
7466 ;; CASE 3: in a cpp preprocessor macro continuation.
7476 ;; If at the beginning of the body of a #define
7477 ;; directive then analyze as cpp-define-intro
7478 ;; only. Go on with the syntactic analysis
7479 ;; otherwise. in-macro-expr is set if we're in a
7480 ;; cpp expression, i.e. before the #define body
7481 ;; or anywhere in a non-#define directive.
7488 nil)))))
7492 ;; CASE 11: an else clause?
7496 containing-sexp paren-state))
7498 ;; CASE 12: while closure of a do/while construct?
7506 containing-sexp paren-state))
7508 ;; CASE 13: A catch or finally clause? This case is simpler
7509 ;; than if-else and do-while, because a block is required
7510 ;; after every try, catch and finally.
7518 t)
7522 t)
7525 t))
7530 containing-sexp paren-state))
7532 ;; CASE 18: A substatement we can recognize by keyword.
7542 ;; Ought to cache the result from the
7543 ;; c-beginning-of-statement-1 calls here.
7553 ;; Step up to the containing statement if we
7554 ;; stayed in the same one.
7562 ;; There was no containing statement afterall.
7564 placeholder))
7566 ;; Require a parenthesis after these keywords.
7567 ;; Necessary to catch e.g. synchronized in Java,
7568 ;; which can be used both as statement and
7569 ;; modifier.
7575 ;; CASE 18A: Simple substatement.
7581 containing-sexp paren-state))
7587 containing-sexp paren-state))
7590 containing-sexp paren-state))))
7592 ;; CASE 18B: Some other substatement. This is shared
7593 ;; with case 10.
7595 char-after-ip
7596 placeholder
7597 lim
7598 paren-state)))
7600 ;; CASE 14: A case or default label
7606 containing-sexp))
7609 ;; Got a bogus label at the top level. In lack of better
7610 ;; alternatives, anchor it on (point-min).
7613 ;; CASE 15: any other label
7620 containing-decl-open
7621 containing-decl-start
7622 containing-decl-kwd
7623 paren-state))
7624 ;; Append access-label with the same anchor point as
7625 ;; inclass gets.
7631 containing-sexp))
7636 ;; If the surrounding statement is a switch then
7637 ;; let's analyze all labels as switch labels, so
7638 ;; that they get lined up consistently.
7639 'case-label
7645 ;; A label on the top level. Treat it as a class
7646 ;; context. (point-min) is the closest we get to the
7647 ;; class open brace.
7650 ;; CASE 4: In-expression statement. C.f. cases 7B, 16A and
7651 ;; 17E.
7654 containing-sexp
7655 ;; Have to turn on the heuristics after
7656 ;; the point even though it doesn't work
7657 ;; very well. C.f. test case class-16.pike.
7658 t))
7663 ;; It's a statement block or an anonymous class.
7665 ;; It's a Pike lambda. Check whether we are between the
7666 ;; lambda keyword and the argument list or at the defun
7667 ;; opener.
7669 'inline-open
7675 paren-state)
7679 ;; CASE 5: Line is inside a declaration level block or at top level.
7683 ;; CASE 5A: we are looking at a defun, brace list, class,
7684 ;; or inline-inclass method opening brace
7691 ;; CASE 5A.1: Non-class declaration block open.
7706 ;; Special case for extern-lang-open.
7707 'extern-lang-open
7709 nil t containing-sexp paren-state))
7711 ;; CASE 5A.2: we are looking at a class opening brace
7720 ;; CASE 5A.3: brace list open
7745 ))))
7749 ;; We're in Java and have found that the open brace
7750 ;; belongs to a "new Foo[]" initialization list,
7751 ;; which means the brace list is part of an
7752 ;; expression and not a top level definition. We
7753 ;; therefore treat it as any topmost continuation
7754 ;; even though the semantically correct symbol still
7755 ;; is brace-list-open, on the same grounds as in
7756 ;; case B.2.
7762 ;; CASE 5A.4: inline defun open
7768 containing-decl-open
7769 containing-decl-start
7770 containing-decl-kwd
7771 paren-state))
7773 ;; CASE 5A.5: ordinary defun open
7778 ;; Bogus to use bol here, but it's the legacy.
7780 )))
7782 ;; CASE 5B: After a function header but before the body (or
7783 ;; the ending semicolon if there's no body).
7789 ;; CASE 5B.1: Member init list.
7794 ;; There is no preceding member init clause.
7795 ;; Indent relative to the beginning of indentation
7796 ;; for the topmost-intro line that contains the
7797 ;; prototype's open paren.
7800 ;; Indent relative to the first member init clause.
7805 ;; CASE 5B.2: K&R arg decl intro
7812 containing-decl-open
7813 containing-decl-start
7814 containing-decl-kwd
7815 paren-state)))
7817 ;; CASE 5B.4: Nether region after a C++ or Java func
7818 ;; decl, which could include a `throws' declaration.
7822 )))
7824 ;; CASE 5C: inheritance line. could be first inheritance
7825 ;; line, or continuation of a multiple inheritance
7833 ;; watch out for scope operator
7838 )))
7847 ;; for Java
7852 cont done)
7857 done t))
7861 )
7863 injava-inher)
7866 ))
7869 ;; CASE 5C.1: non-hanging colon on an inher intro
7873 ;; don't add inclass symbol since relative point already
7874 ;; contains any class offset
7875 )
7877 ;; CASE 5C.2: hanging colon on an inher intro
7883 containing-decl-open
7884 containing-decl-start
7885 containing-decl-kwd
7886 paren-state)))
7888 ;; CASE 5C.3: in a Java implements/extends
7902 )))
7904 ;; CASE 5C.4: a continued inheritance line
7908 ;; don't add inclass symbol since relative point already
7909 ;; contains any class offset
7910 )))
7912 ;; CASE 5D: this could be a top-level initialization, a
7913 ;; member init list continuation, or a template argument
7914 ;; list continuation.
7916 ;; Note: We use the fact that lim always is after any
7917 ;; preceding brace sexp.
7927 t))
7932 t)
7938 nil)
7939 t))
7941 ;; NB: No c-after-special-operator-id stuff in this
7942 ;; clause - we assume only C++ needs it.
7947 ;; CASE 5D.3: perhaps a template list continuation?
7962 ;; In a nested template arglist.
7968 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
7969 ;; template aware.
7972 ;; CASE 5D.4: perhaps a multiple inheritance line?
7984 t)
7989 ;; CASE 5D.5: Continuation of the "expression part" of a
7990 ;; top level construct.
7999 ;; A preceding comma at the top level means that a
8000 ;; new variable declaration starts here. Use
8001 ;; topmost-intro-cont for it, for consistency with
8002 ;; the first variable declaration. C.f. case 5N.
8003 'topmost-intro-cont
8005 nil nil containing-sexp paren-state))
8006 ))
8008 ;; CASE 5F: Close of a non-class declaration level block.
8012 ;; This is inconsistent: Should use `containing-decl-open'
8013 ;; here if it's at boi, like in case 5J.
8017 ;; Special case for compatibility with the
8018 ;; extern-lang syntactic symbols.
8019 'extern-lang-close
8022 nil t
8024 paren-state))
8026 ;; CASE 5G: we are looking at the brace which closes the
8027 ;; enclosing nested class decl
8032 containing-decl-open
8033 containing-decl-start
8034 containing-decl-kwd
8035 paren-state))
8037 ;; CASE 5H: we could be looking at subsequent knr-argdecls
8043 ;; Do an extra check to avoid tripping up on
8044 ;; statements that occur in invalid contexts
8045 ;; (e.g. in macro bodies where we don't really
8046 ;; know the context of what we're looking at).
8053 ;; CASE 5I: ObjC method definition.
8058 ;; Handle the case when it's the first (non-comment)
8059 ;; thing in the buffer. Can't look for a 'same return
8060 ;; value from cbos1 since ObjC directives currently
8061 ;; aren't recognized fully, so that we get 'same
8062 ;; instead of 'previous if it moved over a preceding
8063 ;; directive.
8067 ;; CASE 5P: AWK pattern or function or continuation
8068 ;; thereof.
8074 'topmost-intro-cont
8076 nil nil
8077 containing-sexp paren-state))
8079 ;; CASE 5N: At a variable declaration that follows a class
8080 ;; definition or some other block declaration that doesn't
8081 ;; end at the closing '}'. C.f. case 5D.5.
8088 ;; Speed up the backward search a bit.
8093 ;; The '}' is unbalanced.
8094 nil
8099 containing-sexp paren-state))
8101 ;; NOTE: The point is at the end of the previous token here.
8103 ;; CASE 5J: we are at the topmost level, make
8104 ;; sure we skip back past any access specifiers
8124 nil))))
8125 ;; For historic reasons we anchor at bol of the last
8126 ;; line of the previous declaration. That's clearly
8127 ;; highly bogus and useless, and it makes our lives hard
8128 ;; to remain compatible. :P
8141 ;; Special case for compatibility with the
8142 ;; extern-lang syntactic symbols.
8143 'inextern-lang
8146 nil t
8148 paren-state))
8150 containing-decl-open
8151 containing-decl-start
8152 containing-decl-kwd
8153 paren-state)))
8155 macro-start
8160 ;; CASE 5K: we are at an ObjC method definition
8161 ;; continuation line.
8170 ;; CASE 5L: we are at the first argument of a template
8171 ;; arglist that begins on the previous line.
8179 ;; CASE 5M: we are at a topmost continuation line
8190 ))
8192 ;; (CASE 6 has been removed.)
8194 ;; CASE 7: line is an expression, not a statement. Most
8195 ;; likely we are either in a function prototype or a function
8196 ;; call argument list
8204 ;; CASE 7A: we are looking at the arglist closing paren.
8205 ;; C.f. case 7F.
8217 paren-state))
8219 ;; CASE 7B: Looking at the opening brace of an
8220 ;; in-expression block or brace list. C.f. cases 4, 16A
8221 ;; and 17E.
8225 paren-state))
8229 placeholder
8232 paren-state)
8233 containing-sexp)))
8234 ;; placeholder is nil if it's a block directly in
8235 ;; a function arglist. That makes us skip out of
8236 ;; this case.
8237 )))
8242 paren-state)
8246 ;; CASE 7C: we are looking at the first argument in an empty
8247 ;; argument list. Use arglist-close if we're actually
8248 ;; looking at a close paren or bracket.
8260 paren-state))
8262 ;; CASE 7D: we are inside a conditional test clause. treat
8263 ;; these things as statements
8273 ))
8275 ;; CASE 7E: maybe a continued ObjC method call. This is the
8276 ;; case when we are inside a [] bracketed exp, and what
8277 ;; precede the opening bracket is not an identifier.
8285 )))
8287 ;; CASE 7F: we are looking at an arglist continuation line,
8288 ;; but the preceding argument is on the same line as the
8289 ;; opening paren. This case includes multi-line
8290 ;; mathematical paren groupings, but we could be on a
8291 ;; for-list continuation line. C.f. case 7A.
8308 paren-state))
8310 ;; CASE 7G: we are looking at just a normal arglist
8311 ;; continuation line
8314 ))
8316 ;; CASE 8: func-local multi-inheritance line
8326 ;; CASE 8A: non-hanging colon on an inher intro
8331 ;; CASE 8B: hanging colon on an inher intro
8335 ;; CASE 8C: a continued inheritance line
8339 )))
8341 ;; CASE 9: we are inside a brace-list
8351 ;; CASE 9A: In the middle of a special brace list opener.
8371 ;; CASE 9B: brace-list-close brace
8373 ;; Check special brace list closer.
8380 ;; We were between the special close char and the `)'.
8383 ;; We were before the special close char.
8387 ;; Normal brace list check.
8398 ;; Prepare for the rest of the cases below by going to the
8399 ;; token following the opening brace
8412 ;; CASE 9C: we're looking at the first line in a brace-list
8423 ;; CASE 9D: this is just a later brace-list-entry or
8424 ;; brace-entry-open
8433 ))
8434 ))))
8436 ;; CASE 10: A continued statement or top level construct.
8446 ;; This is shared with case 18.
8448 char-after-ip
8449 placeholder
8450 containing-sexp
8451 paren-state))
8453 ;; CASE 16: block close brace, possibly closing the defun or
8454 ;; the class
8456 ;; From here on we have the next containing sexp in lim.
8461 ;; CASE 16E: Closing a statement block? This catches
8462 ;; cases where it's preceded by a statement keyword,
8463 ;; which works even when used in an "invalid" context,
8464 ;; e.g. a macro argument.
8469 ;; CASE 16A: closing a lambda defun or an in-expression
8470 ;; block? C.f. cases 4, 7B and 17E.
8473 nil))
8475 'inline-close
8485 paren-state)
8489 ;; CASE 16B: does this close an inline or a function in
8490 ;; a non-class declaration level block?
8497 nil))
8507 ;; CASE 16F: Can be a defun-close of a function declared
8508 ;; in a statement block, e.g. in Pike or when using gcc
8509 ;; extensions, but watch out for macros followed by
8510 ;; blocks. Let it through to be handled below.
8511 ;; C.f. cases B.3 and 17G.
8517 ;; Turn off recognition of constructs that
8518 ;; lacks a type in this case, since that's more
8519 ;; likely to be a macro followed by a block.
8526 ;; CASE 16C: If there is an enclosing brace then this is
8527 ;; a block close since defun closes inside declaration
8528 ;; level blocks have been handled above.
8530 ;; If the block is preceded by a case/switch label on
8531 ;; the same line, we anchor at the first preceding label
8532 ;; at boi. The default handling in c-add-stmt-syntax
8533 ;; really fixes it better, but we do like this to keep
8534 ;; the indentation compatible with version 5.28 and
8535 ;; earlier. C.f. case 17H.
8542 ;; c-backward-to-block-anchor not necessary here; those
8543 ;; situations are handled in case 16E above.
8546 ;; CASE 16D: Only top level defun close left.
8552 paren-state))
8553 ))
8555 ;; CASE 17: Statement or defun catchall.
8558 ;; Back up statements until we find one that starts at boi.
8561 containing-sexp)))
8565 nil)
8570 ;; CASE 17B: continued statement
8574 containing-sexp paren-state))
8576 ;; CASE 17A: After a case/default label?
8584 'statement-case-open
8586 nil t containing-sexp paren-state))
8588 ;; CASE 17D: any old statement
8595 containing-sexp paren-state)
8599 ;; CASE 17I: Inside a substatement block.
8601 ;; The following tests are all based on containing-sexp.
8603 ;; From here on we have the next containing sexp in lim.
8608 lim paren-state)
8612 ;; CASE 17E: first statement in an in-expression block.
8613 ;; C.f. cases 4, 7B and 16A.
8616 nil))
8618 'defun-block-intro
8627 paren-state)
8633 ;; CASE 17F: first statement in an inline, or first
8634 ;; statement in a top-level defun. we can tell this is it
8635 ;; if there are no enclosing braces that haven't been
8636 ;; narrowed out by a class (i.e. don't use bod here).
8639 paren-state)))
8645 nil))))
8650 ;; CASE 17G: First statement in a function declared inside
8651 ;; a normal block. This can occur in Pike and with
8652 ;; e.g. the gcc extensions, but watch out for macros
8653 ;; followed by blocks. C.f. cases B.3 and 16F.
8659 ;; Turn off recognition of constructs that lacks
8660 ;; a type in this case, since that's more likely
8661 ;; to be a macro followed by a block.
8667 lim paren-state))
8669 ;; CASE 17H: First statement in a block.
8671 ;; If the block is preceded by a case/switch label on the
8672 ;; same line, we anchor at the first preceding label at
8673 ;; boi. The default handling in c-add-stmt-syntax is
8674 ;; really fixes it better, but we do like this to keep the
8675 ;; indentation compatible with version 5.28 and earlier.
8676 ;; C.f. case 16C.
8683 ;; c-backward-to-block-anchor not necessary here; those
8684 ;; situations are handled in case 17I above.
8686 lim paren-state))
8689 ))
8690 )
8692 ;; now we need to look at any modifiers
8696 ;; are we looking at a comment only line?
8701 ;; we might want to give additional offset to friends (in C++).
8706 ;; Set syntactic-relpos.
8712 nil)
8713 t))
8716 ;; Start of or a continuation of a preprocessor directive?
8731 ;; If inside a cpp expression, i.e. anywhere in a
8732 ;; cpp directive except a #define body, we only let
8733 ;; through the syntactic analysis that is internal
8734 ;; in the expression. That means the arglist
8735 ;; elements, if they are anchored inside the cpp
8736 ;; expression.
8745 ;; Inside a #define body and the syntactic analysis is
8746 ;; anchored on the start of the #define. In this case
8747 ;; we add cpp-define-intro to get the extra
8748 ;; indentation of the #define body.
8751 ;; return the syntax
8752 c-syntactic-context)))
8754 \f
8755 ;; Indentation calculation.
8758 ;; offset can be a number, a function, a variable, a list, or one of
8759 ;; the symbols + or -
8760 ;;
8761 ;; This function might do hidden buffer changes.
8780 langelem symbol))
8786 offset symbol)
8787 nil)
8801 Error evaluating offset %S for %s: \
8802 Cannot combine absolute offset %S with relative %S in `%s' method"
8808 Error evaluating offset %S for %s: \
8809 Cannot combine relative offset %S with absolute %S in `%s' method"
8814 res))
8832 Error evaluating offset %S for %s: \
8833 Cannot combine absolute offsets %S and %S in `add' method"
8837 res))
8846 res))))
8853 nil))))
8857 res
8859 offset symbol res)
8860 nil)))
8863 ;; Get offset from LANGELEM which is a list beginning with the
8864 ;; syntactic symbol and followed by any analysis data it provides.
8865 ;; That data may be zero or more elements, but if at least one is
8866 ;; given then the first is the anchor position (or nil). The symbol
8867 ;; is matched against `c-offsets-alist' and the offset calculated
8868 ;; from that is returned.
8869 ;;
8870 ;; This function might do hidden buffer changes.
8880 offset
8884 ))
8887 ;; This is a compatibility wrapper for `c-calc-offset' in case
8888 ;; someone is calling it directly. It takes an old style syntactic
8889 ;; element on the form (SYMBOL . ANCHOR-POS) and converts it to the
8890 ;; new list form.
8891 ;;
8892 ;; This function might do hidden buffer changes.
8899 ;; Calculate the syntactic indentation from a syntactic description
8900 ;; as returned by `c-guess-syntax'.
8901 ;;
8902 ;; Note that topmost-intro always has an anchor position at bol, for
8903 ;; historical reasons. It's often used together with other symbols
8904 ;; that has more sane positions. Since we always use the first
8905 ;; found anchor position, we rely on that these other symbols always
8906 ;; precede topmost-intro in the LANGELEMS list.
8907 ;;
8908 ;; This function might do hidden buffer changes.
8916 ;; Got an absolute column that overrides any indentation
8917 ;; we've collected so far, but not the relative
8918 ;; indentation we might get for the nested structures
8919 ;; further down the langelems list.
8923 ;; Got a relative change of the current calculated
8924 ;; indentation.
8927 ;; Use the anchor position from the first syntactic
8928 ;; element with one.
8938 indent)))
8940 \f
8943 ;;; arch-tag: 149add18-4673-4da5-ac47-6805e4eae089
8944 ;;; cc-engine.el ends here