1 ;;; cc-engine.el --- core syntax guessing engine for CC mode
3 ;; Copyright (C) 1985, 1987, 1992-2011 Free Software Foundation, Inc.
5 ;; Authors: 2001- Alan Mackenzie
6 ;; 1998- Martin Stjernholm
7 ;; 1992-1999 Barry A. Warsaw
10 ;; 1985 Richard M. Stallman
11 ;; Maintainer: bug-cc-mode@gnu.org
12 ;; Created: 22-Apr-1997 (split from cc-mode.el)
13 ;; Keywords: c languages
16 ;; This file is part of GNU Emacs.
18 ;; GNU Emacs is free software: you can redistribute it and/or modify
19 ;; it under the terms of the GNU General Public License as published by
20 ;; the Free Software Foundation, either version 3 of the License, or
21 ;; (at your option) any later version.
23 ;; GNU Emacs is distributed in the hope that it will be useful,
24 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
25 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 ;; GNU General Public License for more details.
28 ;; You should have received a copy of the GNU General Public License
29 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
33 ;; The functions which have docstring documentation can be considered
34 ;; part of an API which other packages can use in CC Mode buffers.
35 ;; Otoh, undocumented functions and functions with the documentation
36 ;; in comments are considered purely internal and can change semantics
37 ;; or even disappear in the future.
39 ;; (This policy applies to CC Mode as a whole, not just this file. It
40 ;; probably also applies to many other Emacs packages, but here it's
41 ;; clearly spelled out.)
43 ;; Hidden buffer changes
45 ;; Various functions in CC Mode use text properties for caching and
46 ;; syntactic markup purposes, and those of them that might modify such
47 ;; properties but still don't modify the buffer in a visible way are
48 ;; said to do "hidden buffer changes". They should be used within
49 ;; `c-save-buffer-state' or a similar function that saves and restores
50 ;; buffer modifiedness, disables buffer change hooks, etc.
52 ;; Interactive functions are assumed to not do hidden buffer changes,
53 ;; except in the specific parts of them that do real changes.
55 ;; Lineup functions are assumed to do hidden buffer changes. They
56 ;; must not do real changes, though.
58 ;; All other functions that do hidden buffer changes have that noted
59 ;; in their doc string or comment.
61 ;; The intention with this system is to avoid wrapping every leaf
62 ;; function that do hidden buffer changes inside
63 ;; `c-save-buffer-state'. It should be used as near the top of the
64 ;; interactive functions as possible.
66 ;; Functions called during font locking are allowed to do hidden
67 ;; buffer changes since the font-lock package run them in a context
68 ;; similar to `c-save-buffer-state' (in fact, that function is heavily
69 ;; inspired by `save-buffer-state' in the font-lock package).
71 ;; Use of text properties
73 ;; CC Mode uses several text properties internally to mark up various
74 ;; positions, e.g. to improve speed and to eliminate glitches in
75 ;; interactive refontification.
77 ;; Note: This doc is for internal use only. Other packages should not
78 ;; assume that these text properties are used as described here.
81 ;; Used for "indirection". With its help, some other property can
82 ;; be cheaply and easily switched on or off everywhere it occurs.
85 ;; Used to modify the syntax of some characters. It is used to
86 ;; mark the "<" and ">" of angle bracket parens with paren syntax, and
87 ;; to "hide" obtrusive characters in preprocessor lines.
89 ;; This property is used on single characters and is therefore
90 ;; always treated as front and rear nonsticky (or start and end open
91 ;; in XEmacs vocabulary). It's therefore installed on
92 ;; `text-property-default-nonsticky' if that variable exists (Emacs
95 ;; 'c-is-sws and 'c-in-sws
96 ;; Used by `c-forward-syntactic-ws' and `c-backward-syntactic-ws' to
97 ;; speed them up. See the comment blurb before `c-put-is-sws'
98 ;; below for further details.
101 ;; This property is used on single characters to mark positions with
102 ;; special syntactic relevance of various sorts. Its primary use is
103 ;; to avoid glitches when multiline constructs are refontified
104 ;; interactively (on font lock decoration level 3). It's cleared in
105 ;; a region before it's fontified and is then put on relevant chars
106 ;; in that region as they are encountered during the fontification.
107 ;; The value specifies the kind of position:
110 ;; Put on the last char of the token preceding each declaration
111 ;; inside a declaration style arglist (typically in a function
115 ;; Put on the last char of the token preceding a declaration.
116 ;; This is used in cases where declaration boundaries can't be
117 ;; recognized simply by looking for a token like ";" or "}".
118 ;; `c-type-decl-end-used' must be set if this is used (see also
119 ;; `c-find-decl-spots').
122 ;; Put on the commas that separate arguments in angle bracket
123 ;; arglists like C++ template arglists.
125 ;; 'c-decl-id-start and 'c-decl-type-start
126 ;; Put on the last char of the token preceding each declarator
127 ;; in the declarator list of a declaration. They are also used
128 ;; between the identifiers cases like enum declarations.
129 ;; 'c-decl-type-start is used when the declarators are types,
130 ;; 'c-decl-id-start otherwise.
133 ;; Used in AWK mode to mark the various kinds of newlines. See
140 (if (and (boundp 'byte-compile-dest-file
)
141 (stringp byte-compile-dest-file
))
142 (cons (file-name-directory byte-compile-dest-file
) load-path
)
144 (load "cc-bytecomp" nil t
)))
146 (cc-require 'cc-defs
)
147 (cc-require-when-compile 'cc-langs
)
148 (cc-require 'cc-vars
)
150 ;; Silence the compiler.
151 (cc-bytecomp-defun buffer-syntactic-context) ; XEmacs
154 ;; Make declarations for all the `c-lang-defvar' variables in cc-langs.
156 (defmacro c-declare-lang-variables
()
159 (mapcar (lambda (init)
161 `(defvar ,(car init
) nil
,(elt init
2))
162 `(defvar ,(car init
) nil
))
163 (make-variable-buffer-local ',(car init
))))
164 (cdr c-lang-variable-inits
)))))
165 (c-declare-lang-variables)
168 ;;; Internal state variables.
170 ;; Internal state of hungry delete key feature
171 (defvar c-hungry-delete-key nil
)
172 (make-variable-buffer-local 'c-hungry-delete-key
)
174 ;; The electric flag (toggled by `c-toggle-electric-state').
175 ;; If t, electric actions (like automatic reindentation, and (if
176 ;; c-auto-newline is also set) auto newlining) will happen when an electric
177 ;; key like `{' is pressed (or an electric keyword like `else').
178 (defvar c-electric-flag t
)
179 (make-variable-buffer-local 'c-electric-flag
)
181 ;; Internal state of auto newline feature.
182 (defvar c-auto-newline nil
)
183 (make-variable-buffer-local 'c-auto-newline
)
185 ;; Included in the mode line to indicate the active submodes.
186 ;; (defvar c-submode-indicators nil)
187 ;; (make-variable-buffer-local 'c-submode-indicators)
189 (defun c-calculate-state (arg prevstate
)
190 ;; Calculate the new state of PREVSTATE, t or nil, based on arg. If
191 ;; arg is nil or zero, toggle the state. If arg is negative, turn
192 ;; the state off, and if arg is positive, turn the state on
194 (zerop (setq arg
(prefix-numeric-value arg
))))
198 ;; Dynamically bound cache for `c-in-literal'.
199 (defvar c-in-literal-cache t
)
202 ;; Basic handling of preprocessor directives.
204 ;; This is a dynamically bound cache used together with
205 ;; `c-query-macro-start' and `c-query-and-set-macro-start'. It only
206 ;; works as long as point doesn't cross a macro boundary.
207 (defvar c-macro-start
'unknown
)
209 (defsubst c-query-and-set-macro-start
()
210 (if (symbolp c-macro-start
)
211 (setq c-macro-start
(save-excursion
212 (c-save-buffer-state ()
213 (and (c-beginning-of-macro)
217 (defsubst c-query-macro-start
()
218 (if (symbolp c-macro-start
)
220 (c-save-buffer-state ()
221 (and (c-beginning-of-macro)
225 (defun c-beginning-of-macro (&optional lim
)
226 "Go to the beginning of a preprocessor directive.
227 Leave point at the beginning of the directive and return t if in one,
228 otherwise return nil and leave point unchanged.
230 Note that this function might do hidden buffer changes. See the
231 comment at the start of cc-engine.el for more info."
232 (when c-opt-cpp-prefix
233 (let ((here (point)))
235 (if lim
(narrow-to-region lim
(point-max)))
237 (while (eq (char-before (1- (point))) ?
\\)
239 (back-to-indentation)
240 (if (and (<= (point) here
)
241 (looking-at c-opt-cpp-start
))
246 (defun c-end-of-macro ()
247 "Go to the end of a preprocessor directive.
248 More accurately, move the point to the end of the closest following
249 line that doesn't end with a line continuation backslash - no check is
250 done that the point is inside a cpp directive to begin with.
252 Note that this function might do hidden buffer changes. See the
253 comment at the start of cc-engine.el for more info."
256 (when (and (eq (char-before) ?
\\)
261 (defun c-syntactic-end-of-macro ()
262 ;; Go to the end of a CPP directive, or a "safe" pos just before.
264 ;; This is normally the end of the next non-escaped line. A "safe"
265 ;; position is one not within a string or comment. (The EOL on a line
266 ;; comment is NOT "safe").
268 ;; This function must only be called from the beginning of a CPP construct.
270 ;; Note that this function might do hidden buffer changes. See the comment
271 ;; at the start of cc-engine.el for more info.
272 (let* ((here (point))
273 (there (progn (c-end-of-macro) (point)))
274 (s (parse-partial-sexp here there
)))
275 (while (and (or (nth 3 s
) ; in a string
276 (nth 4 s
)) ; in a comment (maybe at end of line comment)
277 (> there here
)) ; No infinite loops, please.
278 (setq there
(1- (nth 8 s
)))
279 (setq s
(parse-partial-sexp here there
)))
282 (defun c-forward-over-cpp-define-id ()
283 ;; Assuming point is at the "#" that introduces a preprocessor
284 ;; directive, it's moved forward to the end of the identifier which is
285 ;; "#define"d (or whatever c-opt-cpp-macro-define specifies). Non-nil
286 ;; is returned in this case, in all other cases nil is returned and
287 ;; point isn't moved.
289 ;; This function might do hidden buffer changes.
290 (when (and c-opt-cpp-macro-define-id
291 (looking-at c-opt-cpp-macro-define-id
))
292 (goto-char (match-end 0))))
294 (defun c-forward-to-cpp-define-body ()
295 ;; Assuming point is at the "#" that introduces a preprocessor
296 ;; directive, it's moved forward to the start of the definition body
297 ;; if it's a "#define" (or whatever c-opt-cpp-macro-define
298 ;; specifies). Non-nil is returned in this case, in all other cases
299 ;; nil is returned and point isn't moved.
301 ;; This function might do hidden buffer changes.
302 (when (and c-opt-cpp-macro-define-start
303 (looking-at c-opt-cpp-macro-define-start
)
304 (not (= (match-end 0) (c-point 'eol
))))
305 (goto-char (match-end 0))))
308 ;;; Basic utility functions.
310 (defun c-syntactic-content (from to paren-level
)
311 ;; Return the given region as a string where all syntactic
312 ;; whitespace is removed or, where necessary, replaced with a single
313 ;; space. If PAREN-LEVEL is given then all parens in the region are
314 ;; collapsed to "()", "[]" etc.
316 ;; This function might do hidden buffer changes.
320 (narrow-to-region from to
)
322 (let* ((parts (list nil
)) (tail parts
) pos in-paren
)
324 (while (re-search-forward c-syntactic-ws-start to t
)
325 (goto-char (setq pos
(match-beginning 0)))
326 (c-forward-syntactic-ws)
332 (setq in-paren
(= (car (parse-partial-sexp from pos
1)) 1)
335 (if (and (> pos from
)
337 (looking-at "\\w\\|\\s_")
340 (looking-at "\\w\\|\\s_")))
342 (setcdr tail
(list (buffer-substring-no-properties from pos
)
344 (setq tail
(cddr tail
)))
345 (setcdr tail
(list (buffer-substring-no-properties from pos
)))
346 (setq tail
(cdr tail
)))
349 (when (= (car (parse-partial-sexp pos to -
1)) -
1)
350 (setcdr tail
(list (buffer-substring-no-properties
351 (1- (point)) (point))))
352 (setq tail
(cdr tail
))))
354 (setq from
(point))))
356 (setcdr tail
(list (buffer-substring-no-properties from to
)))
357 (apply 'concat
(cdr parts
))))))
359 (defun c-shift-line-indentation (shift-amt)
360 ;; Shift the indentation of the current line with the specified
361 ;; amount (positive inwards). The buffer is modified only if
362 ;; SHIFT-AMT isn't equal to zero.
363 (let ((pos (- (point-max) (point)))
364 (c-macro-start c-macro-start
)
366 (if (zerop shift-amt
)
368 ;; If we're on an empty line inside a macro, we take the point
369 ;; to be at the current indentation and shift it to the
370 ;; appropriate column. This way we don't treat the extra
371 ;; whitespace out to the line continuation as indentation.
372 (when (and (c-query-and-set-macro-start)
373 (looking-at "[ \t]*\\\\$")
375 (skip-chars-backward " \t")
379 (setq tmp-char-inserted t
))
381 (let ((col (current-indentation)))
382 (delete-region (c-point 'bol
) (c-point 'boi
))
384 (indent-to (+ col shift-amt
)))
385 (when tmp-char-inserted
387 ;; If initial point was within line's indentation and we're not on
388 ;; a line with a line continuation in a macro, position after the
389 ;; indentation. Else stay at same point in text.
390 (if (and (< (point) (c-point 'boi
))
391 (not tmp-char-inserted
))
392 (back-to-indentation)
393 (if (> (- (point-max) pos
) (point))
394 (goto-char (- (point-max) pos
))))))
396 (defsubst c-keyword-sym
(keyword)
397 ;; Return non-nil if the string KEYWORD is a known keyword. More
398 ;; precisely, the value is the symbol for the keyword in
399 ;; `c-keywords-obarray'.
400 (intern-soft keyword c-keywords-obarray
))
402 (defsubst c-keyword-member
(keyword-sym lang-constant
)
403 ;; Return non-nil if the symbol KEYWORD-SYM, as returned by
404 ;; `c-keyword-sym', is a member of LANG-CONSTANT, which is the name
405 ;; of a language constant that ends with "-kwds". If KEYWORD-SYM is
406 ;; nil then the result is nil.
407 (get keyword-sym lang-constant
))
409 ;; String syntax chars, suitable for skip-syntax-(forward|backward).
410 (defconst c-string-syntax
(if (memq 'gen-string-delim c-emacs-features
)
414 ;; Regexp matching string limit syntax.
415 (defconst c-string-limit-regexp
(if (memq 'gen-string-delim c-emacs-features
)
419 ;; Regexp matching WS followed by string limit syntax.
420 (defconst c-ws
*-string-limit-regexp
421 (concat "[ \t]*\\(" c-string-limit-regexp
"\\)"))
423 ;; Holds formatted error strings for the few cases where parse errors
425 (defvar c-parsing-error nil
)
426 (make-variable-buffer-local 'c-parsing-error
)
428 (defun c-echo-parsing-error (&optional quiet
)
429 (when (and c-report-syntactic-errors c-parsing-error
(not quiet
))
430 (c-benign-error "%s" c-parsing-error
))
433 ;; Faces given to comments and string literals. This is used in some
434 ;; situations to speed up recognition; it isn't mandatory that font
435 ;; locking is in use. This variable is extended with the face in
436 ;; `c-doc-face-name' when fontification is activated in cc-fonts.el.
437 (defvar c-literal-faces
438 (append '(font-lock-comment-face font-lock-string-face
)
439 (when (facep 'font-lock-comment-delimiter-face
)
441 '(font-lock-comment-delimiter-face))))
443 (defsubst c-put-c-type-property
(pos value
)
444 ;; Put a c-type property with the given value at POS.
445 (c-put-char-property pos
'c-type value
))
447 (defun c-clear-c-type-property (from to value
)
448 ;; Remove all occurrences of the c-type property that has the given
449 ;; value in the region between FROM and TO. VALUE is assumed to not
452 ;; Note: This assumes that c-type is put on single chars only; it's
453 ;; very inefficient if matching properties cover large regions.
457 (when (eq (get-text-property (point) 'c-type
) value
)
458 (c-clear-char-property (point) 'c-type
))
459 (goto-char (next-single-property-change (point) 'c-type nil to
))
463 ;; Some debug tools to visualize various special positions. This
464 ;; debug code isn't as portable as the rest of CC Mode.
466 (cc-bytecomp-defun overlays-in)
467 (cc-bytecomp-defun overlay-get)
468 (cc-bytecomp-defun overlay-start)
469 (cc-bytecomp-defun overlay-end)
470 (cc-bytecomp-defun delete-overlay)
471 (cc-bytecomp-defun overlay-put)
472 (cc-bytecomp-defun make-overlay)
474 (defun c-debug-add-face (beg end face
)
475 (c-save-buffer-state ((overlays (overlays-in beg end
)) overlay
)
477 (setq overlay
(car overlays
)
478 overlays
(cdr overlays
))
479 (when (eq (overlay-get overlay
'face
) face
)
480 (setq beg
(min beg
(overlay-start overlay
))
481 end
(max end
(overlay-end overlay
)))
482 (delete-overlay overlay
)))
483 (overlay-put (make-overlay beg end
) 'face face
)))
485 (defun c-debug-remove-face (beg end face
)
486 (c-save-buffer-state ((overlays (overlays-in beg end
)) overlay
487 (ol-beg beg
) (ol-end end
))
489 (setq overlay
(car overlays
)
490 overlays
(cdr overlays
))
491 (when (eq (overlay-get overlay
'face
) face
)
492 (setq ol-beg
(min ol-beg
(overlay-start overlay
))
493 ol-end
(max ol-end
(overlay-end overlay
)))
494 (delete-overlay overlay
)))
496 (overlay-put (make-overlay ol-beg beg
) 'face face
))
498 (overlay-put (make-overlay end ol-end
) 'face face
))))
501 ;; `c-beginning-of-statement-1' and accompanying stuff.
503 ;; KLUDGE ALERT: c-maybe-labelp is used to pass information between
504 ;; c-crosses-statement-barrier-p and c-beginning-of-statement-1. A
505 ;; better way should be implemented, but this will at least shut up
506 ;; the byte compiler.
507 (defvar c-maybe-labelp
)
509 ;; New awk-compatible version of c-beginning-of-statement-1, ACM 2002/6/22
511 ;; Macros used internally in c-beginning-of-statement-1 for the
512 ;; automaton actions.
513 (defmacro c-bos-push-state
()
514 '(setq stack
(cons (cons state saved-pos
)
516 (defmacro c-bos-pop-state
(&optional do-if-done
)
517 `(if (setq state
(car (car stack
))
518 saved-pos
(cdr (car stack
))
523 (defmacro c-bos-pop-state-and-retry
()
524 '(throw 'loop
(setq state
(car (car stack
))
525 saved-pos
(cdr (car stack
))
526 ;; Throw nil if stack is empty, else throw non-nil.
528 (defmacro c-bos-save-pos
()
529 '(setq saved-pos
(vector pos tok ptok pptok
)))
530 (defmacro c-bos-restore-pos
()
531 '(unless (eq (elt saved-pos
0) start
)
532 (setq pos
(elt saved-pos
0)
533 tok
(elt saved-pos
1)
534 ptok
(elt saved-pos
2)
535 pptok
(elt saved-pos
3))
538 (defmacro c-bos-save-error-info
(missing got
)
539 `(setq saved-pos
(vector pos
,missing
,got
)))
540 (defmacro c-bos-report-error
()
542 (setq c-parsing-error
543 (format "No matching `%s' found for `%s' on line %d"
546 (1+ (count-lines (point-min)
547 (c-point 'bol
(elt saved-pos
0))))))))
549 (defun c-beginning-of-statement-1 (&optional lim ignore-labels
551 "Move to the start of the current statement or declaration, or to
552 the previous one if already at the beginning of one. Only
553 statements/declarations on the same level are considered, i.e. don't
554 move into or out of sexps (not even normal expression parentheses).
556 If point is already at the earliest statement within braces or parens,
557 this function doesn't move back into any whitespace preceding it; it
558 returns 'same in this case.
560 Stop at statement continuation tokens like \"else\", \"catch\",
561 \"finally\" and the \"while\" in \"do ... while\" if the start point
562 is within the continuation. If starting at such a token, move to the
563 corresponding statement start. If at the beginning of a statement,
564 move to the closest containing statement if there is any. This might
565 also stop at a continuation clause.
567 Labels are treated as part of the following statements if
568 IGNORE-LABELS is non-nil. (FIXME: Doesn't work if we stop at a known
569 statement start keyword.) Otherwise, each label is treated as a
572 Macros are ignored \(i.e. skipped over) unless point is within one, in
573 which case the content of the macro is treated as normal code. Aside
574 from any normal statement starts found in it, stop at the first token
575 of the content in the macro, i.e. the expression of an \"#if\" or the
576 start of the definition in a \"#define\". Also stop at start of
577 macros before leaving them.
580 'label if stopped at a label or \"case...:\" or \"default:\";
581 'same if stopped at the beginning of the current statement;
582 'up if stepped to a containing statement;
583 'previous if stepped to a preceding statement;
584 'beginning if stepped from a statement continuation clause to
586 'macro if stepped to a macro start.
587 Note that 'same and not 'label is returned if stopped at the same
588 label without crossing the colon character.
590 LIM may be given to limit the search. If the search hits the limit,
591 point will be left at the closest following token, or at the start
592 position if that is less ('same is returned in this case).
594 NOERROR turns off error logging to `c-parsing-error'.
596 Normally only ';' and virtual semicolons are considered to delimit
597 statements, but if COMMA-DELIM is non-nil then ',' is treated
600 Note that this function might do hidden buffer changes. See the
601 comment at the start of cc-engine.el for more info."
603 ;; The bulk of this function is a pushdown automaton that looks at statement
604 ;; boundaries and the tokens (such as "while") in c-opt-block-stmt-key. Its
605 ;; purpose is to keep track of nested statements, ensuring that such
606 ;; statements are skipped over in their entirety (somewhat akin to what C-M-p
607 ;; does with nested braces/brackets/parentheses).
609 ;; Note: The position of a boundary is the following token.
611 ;; Beginning with the current token (the one following point), move back one
612 ;; sexp at a time (where a sexp is, more or less, either a token or the
613 ;; entire contents of a brace/bracket/paren pair). Each time a statement
614 ;; boundary is crossed or a "while"-like token is found, update the state of
615 ;; the PDA. Stop at the beginning of a statement when the stack (holding
616 ;; nested statement info) is empty and the position has been moved.
618 ;; The following variables constitute the PDA:
620 ;; sym: This is either the "while"-like token (e.g. 'for) we've just
621 ;; scanned back over, 'boundary if we've just gone back over a
622 ;; statement boundary, or nil otherwise.
623 ;; state: takes one of the values (nil else else-boundary while
624 ;; while-boundary catch catch-boundary).
625 ;; nil means "no "while"-like token yet scanned".
626 ;; 'else, for example, means "just gone back over an else".
627 ;; 'else-boundary means "just gone back over a statement boundary
628 ;; immediately after having gone back over an else".
629 ;; saved-pos: A vector of either saved positions (tok ptok pptok, etc.) or
630 ;; of error reporting information.
631 ;; stack: The stack onto which the PDA pushes its state. Each entry
632 ;; consists of a saved value of state and saved-pos. An entry is
633 ;; pushed when we move back over a "continuation" token (e.g. else)
634 ;; and popped when we encounter the corresponding opening token
638 ;; The following diagram briefly outlines the PDA.
641 ;; "else": Push state, goto state `else'.
642 ;; "while": Push state, goto state `while'.
643 ;; "catch" or "finally": Push state, goto state `catch'.
644 ;; boundary: Pop state.
645 ;; other: Do nothing special.
648 ;; boundary: Goto state `else-boundary'.
649 ;; other: Error, pop state, retry token.
651 ;; State `else-boundary':
653 ;; boundary: Error, pop state.
654 ;; other: See common state.
657 ;; boundary: Save position, goto state `while-boundary'.
658 ;; other: Pop state, retry token.
660 ;; State `while-boundary':
662 ;; boundary: Restore position if it's not at start, pop state. [*see below]
663 ;; other: See common state.
666 ;; boundary: Goto state `catch-boundary'.
667 ;; other: Error, pop state, retry token.
669 ;; State `catch-boundary':
671 ;; "catch": Goto state `catch'.
672 ;; boundary: Error, pop state.
673 ;; other: See common state.
675 ;; [*] In the `while-boundary' state, we had pushed a 'while state, and were
676 ;; searching for a "do" which would have opened a do-while. If we didn't
677 ;; find it, we discard the analysis done since the "while", go back to this
678 ;; token in the buffer and restart the scanning there, this time WITHOUT
679 ;; pushing the 'while state onto the stack.
681 ;; In addition to the above there is some special handling of labels
684 (let ((case-fold-search nil
)
687 (delims (if comma-delim
'(?\
; ?,) '(?\;)))
688 (c-stmt-delim-chars (if comma-delim
689 c-stmt-delim-chars-with-comma
691 c-in-literal-cache c-maybe-labelp after-case
:-pos saved
694 ;; Position of last stmt boundary character (e.g. ;).
696 ;; The position of the last sexp or bound that follows the
697 ;; first found colon, i.e. the start of the nonlabel part of
698 ;; the statement. It's `start' if a colon is found just after
701 ;; Like `after-labels-pos', but the first such position inside
702 ;; a label, i.e. the start of the last label before the start
703 ;; of the nonlabel part of the statement.
705 ;; The last position where a label is possible provided the
706 ;; statement started there. It's nil as long as no invalid
707 ;; label content has been found (according to
708 ;; `c-nonlabel-token-key'. It's `start' if no valid label
709 ;; content was found in the label. Note that we might still
710 ;; regard it a label if it starts with `c-label-kwds'.
712 ;; Putative positions of the components of a bitfield declaration,
713 ;; e.g. "int foo : NUM_FOO_BITS ;"
714 bitfield-type-pos bitfield-id-pos bitfield-size-pos
715 ;; Symbol just scanned back over (e.g. 'while or 'boundary).
718 ;; Current state in the automaton. See above.
720 ;; Current saved positions. See above.
722 ;; Stack of conses (state . saved-pos).
724 ;; Regexp which matches "for", "if", etc.
725 (cond-key (or c-opt-block-stmt-key
726 "\\<\\>")) ; Matches nothing.
729 ;; Positions of the last three sexps or bounds we've stopped at.
733 (if lim
(narrow-to-region lim
(point-max)))
736 (and (c-beginning-of-macro)
738 (setq macro-start
(point)))
740 ;; Try to skip back over unary operator characters, to register
744 (c-backward-syntactic-ws)
745 ;; Protect post-++/-- operators just before a virtual semicolon.
746 (and (not (c-at-vsemi-p))
747 (/= (skip-chars-backward "-+!*&~@`#") 0))))
749 ;; Skip back over any semicolon here. If it was a bare semicolon, we're
750 ;; done. Later on we ignore the boundaries for statements that don't
751 ;; contain any sexp. The only thing that is affected is that the error
752 ;; checking is a little less strict, and we really don't bother.
753 (if (and (memq (char-before) delims
)
754 (progn (forward-char -
1)
756 (c-backward-syntactic-ws)
757 (or (memq (char-before) delims
)
758 (memq (char-before) '(?
: nil
))
759 (eq (char-syntax (char-before)) ?\
()
764 ;; Begin at start and not pos to detect macros if we stand
765 ;; directly after the #.
767 (if (looking-at "\\<\\|\\W")
768 ;; Record this as the first token if not starting inside it.
772 ;; The following while loop goes back one sexp (balanced parens,
773 ;; etc. with contents, or symbol or suchlike) each iteration. This
774 ;; movement is accomplished with a call to c-backward-sexp approx 170
777 ;; The loop is exited only by throwing nil to the (catch 'loop ...):
778 ;; 1. On reaching the start of a macro;
779 ;; 2. On having passed a stmt boundary with the PDA stack empty;
780 ;; 3. On reaching the start of an Objective C method def;
781 ;; 4. From macro `c-bos-pop-state'; when the stack is empty;
782 ;; 5. From macro `c-bos-pop-state-and-retry' when the stack is empty.
784 (catch 'loop
;; Throw nil to break, non-nil to continue.
786 ;; Are we in a macro, just after the opening #?
788 (and macro-start
; Always NIL for AWK.
789 (progn (skip-chars-backward " \t")
790 (eq (char-before) ?
#))
791 (progn (setq saved
(1- (point)))
793 (not (eq (char-before (1- (point))) ?
\\)))
794 (looking-at c-opt-cpp-start
)
795 (progn (skip-chars-forward " \t")
796 (eq (point) saved
))))
798 (if (and (c-forward-to-cpp-define-body)
799 (progn (c-forward-syntactic-ws start
)
801 ;; Stop at the first token in the content of the macro.
803 ignore-labels t
) ; Avoid the label check on exit.
807 (throw 'loop nil
)) ; 1. Start of macro.
809 ;; Do a round through the automaton if we've just passed a
810 ;; statement boundary or passed a "while"-like token.
812 (and (looking-at cond-key
)
813 (setq sym
(intern (match-string 1)))))
815 (when (and (< pos start
) (null stack
))
816 (throw 'loop nil
)) ; 2. Statement boundary.
818 ;; The PDA state handling.
820 ;; Refer to the description of the PDA in the opening
821 ;; comments. In the following OR form, the first leaf
822 ;; attempts to handles one of the specific actions detailed
823 ;; (e.g., finding token "if" whilst in state `else-boundary').
824 ;; We drop through to the second leaf (which handles common
825 ;; state) if no specific handler is found in the first cond.
826 ;; If a parsing error is detected (e.g. an "else" with no
827 ;; preceding "if"), we throw to the enclosing catch.
829 ;; Note that the (eq state 'else) means
830 ;; "we've just passed an else", NOT "we're looking for an
834 (if (eq sym
'boundary
)
835 (setq state
'else-boundary
)
837 (c-bos-pop-state-and-retry)))
839 ((eq state
'else-boundary
)
841 (c-bos-pop-state (setq ret
'beginning
)))
847 (if (and (eq sym
'boundary
)
848 ;; Since this can cause backtracking we do a
849 ;; little more careful analysis to avoid it:
850 ;; If there's a label in front of the while
851 ;; it can't be part of a do-while.
852 (not after-labels-pos
))
853 (progn (c-bos-save-pos)
854 (setq state
'while-boundary
))
855 (c-bos-pop-state-and-retry))) ; Can't be a do-while
857 ((eq state
'while-boundary
)
859 (c-bos-pop-state (setq ret
'beginning
)))
860 ((eq sym
'boundary
) ; isn't a do-while
861 (c-bos-restore-pos) ; the position of the while
862 (c-bos-pop-state)))) ; no longer searching for do.
865 (if (eq sym
'boundary
)
866 (setq state
'catch-boundary
)
868 (c-bos-pop-state-and-retry)))
870 ((eq state
'catch-boundary
)
873 (c-bos-pop-state (setq ret
'beginning
)))
878 (c-bos-pop-state)))))
880 ;; This is state common. We get here when the previous
881 ;; cond statement found no particular state handler.
882 (cond ((eq sym
'boundary
)
883 ;; If we have a boundary at the start
884 ;; position we push a frame to go to the
885 ;; previous statement.
891 (c-bos-save-error-info 'if
'else
)
894 ;; Is this a real while, or a do-while?
895 ;; The next `when' triggers unless we are SURE that
896 ;; the `while' is not the tailend of a `do-while'.
897 (when (or (not pptok
)
898 (memq (char-after pptok
) delims
)
899 ;; The following kludge is to prevent
900 ;; infinite recursion when called from
901 ;; c-awk-after-if-for-while-condition-p,
903 (and (eq (point) start
)
904 (c-vsemi-status-unknown-p))
905 (c-at-vsemi-p pptok
))
906 ;; Since this can cause backtracking we do a
907 ;; little more careful analysis to avoid it: If
908 ;; the while isn't followed by a (possibly
909 ;; virtual) semicolon it can't be a do-while.
911 (setq state
'while
)))
912 ((memq sym
'(catch finally
))
914 (c-bos-save-error-info 'try sym
)
915 (setq state
'catch
))))
918 ;; We're either past a statement boundary or at the
919 ;; start of a statement, so throw away any label data
920 ;; for the previous one.
921 (setq after-labels-pos nil
923 c-maybe-labelp nil
))))
925 ;; Step to the previous sexp, but not if we crossed a
926 ;; boundary, since that doesn't consume an sexp.
927 (if (eq sym
'boundary
)
930 ;; HERE IS THE SINGLE PLACE INSIDE THE PDA LOOP WHERE WE MOVE
931 ;; BACKWARDS THROUGH THE SOURCE.
933 (c-backward-syntactic-ws)
934 (let ((before-sws-pos (point))
935 ;; The end position of the area to search for statement
936 ;; barriers in this round.
937 (maybe-after-boundary-pos pos
))
939 ;; Go back over exactly one logical sexp, taking proper
940 ;; account of macros and escaped EOLs.
943 (unless (c-safe (c-backward-sexp) t
)
944 ;; Give up if we hit an unbalanced block. Since the
945 ;; stack won't be empty the code below will report a
949 ;; Have we moved into a macro?
950 ((and (not macro-start
)
951 (c-beginning-of-macro))
952 ;; Have we crossed a statement boundary? If not,
953 ;; keep going back until we find one or a "real" sexp.
957 (not (c-crosses-statement-barrier-p
958 (point) maybe-after-boundary-pos
)))
959 (setq maybe-after-boundary-pos
(point))))
960 ;; Have we just gone back over an escaped NL? This
961 ;; doesn't count as a sexp.
962 ((looking-at "\\\\$")))))
964 ;; Have we crossed a statement boundary?
967 ;; Are we at a macro beginning?
968 ((and (not macro-start
)
970 (looking-at c-opt-cpp-prefix
))
973 (c-crosses-statement-barrier-p
974 (point) maybe-after-boundary-pos
)))
975 ;; Just gone back over a brace block?
978 (not (c-looking-at-inexpr-block lim nil t
)))
980 (c-forward-sexp) (point)))
981 ;; Just gone back over some paren block?
982 ((looking-at "\\s\(")
984 (goto-char (1+ (c-down-list-backward
986 (c-crosses-statement-barrier-p
987 (point) maybe-after-boundary-pos
)))
988 ;; Just gone back over an ordinary symbol of some sort?
989 (t (c-crosses-statement-barrier-p
990 (point) maybe-after-boundary-pos
))))
997 ;; Like a C "continue". Analyze the next sexp.
1001 (when (and c-opt-method-key
1002 (setq saved
(c-in-method-def-p)))
1004 ignore-labels t
) ; Avoid the label check on exit.
1005 (throw 'loop nil
)) ; 3. ObjC method def.
1007 ;; Might we have a bitfield declaration, "<type> <id> : <size>"?
1010 ;; The : <size> and <id> fields?
1011 ((and (numberp c-maybe-labelp
)
1012 (not bitfield-size-pos
)
1014 (goto-char (or tok start
))
1015 (not (looking-at c-keywords-regexp
)))
1016 (not (looking-at c-keywords-regexp
))
1017 (not (c-punctuation-in (point) c-maybe-labelp
)))
1018 (setq bitfield-size-pos
(or tok start
)
1019 bitfield-id-pos
(point)))
1020 ;; The <type> field?
1021 ((and bitfield-id-pos
1022 (not bitfield-type-pos
))
1023 (if (and (looking-at c-symbol-key
) ; Can only be an integer type. :-)
1024 (not (looking-at c-not-primitive-type-keywords-regexp
))
1025 (not (c-punctuation-in (point) tok
)))
1026 (setq bitfield-type-pos
(point))
1027 (setq bitfield-size-pos nil
1028 bitfield-id-pos nil
)))))
1031 (unless (eq ignore-labels t
)
1032 (when (numberp c-maybe-labelp
)
1033 ;; `c-crosses-statement-barrier-p' has found a colon, so we
1034 ;; might be in a label now. Have we got a real label
1035 ;; (including a case label) or something like C++'s "public:"?
1036 ;; A case label might use an expression rather than a token.
1037 (setq after-case
:-pos
(or tok start
))
1038 (if (looking-at c-nonlabel-token-key
) ; e.g. "while" or "'a'"
1039 (setq c-maybe-labelp nil
)
1040 (if after-labels-pos
; Have we already encountered a label?
1041 (if (not last-label-pos
)
1042 (setq last-label-pos
(or tok start
)))
1043 (setq after-labels-pos
(or tok start
)))
1044 (setq c-maybe-labelp t
1045 label-good-pos nil
))) ; bogus "label"
1047 (when (and (not label-good-pos
) ; i.e. no invalid "label"'s yet
1049 (looking-at c-nonlabel-token-key
)) ; e.g. "while :"
1050 ;; We're in a potential label and it's the first
1051 ;; time we've found something that isn't allowed in
1053 (setq label-good-pos
(or tok start
))))
1055 ;; We've moved back by a sexp, so update the token positions.
1060 pos tok
) ; always non-nil
1061 ) ; end of (catch loop ....)
1062 ) ; end of sexp-at-a-time (while ....)
1064 ;; If the stack isn't empty there might be errors to report.
1066 (if (and (vectorp saved-pos
) (eq (length saved-pos
) 3))
1067 (c-bos-report-error))
1068 (setq saved-pos
(cdr (car stack
))
1071 (when (and (eq ret
'same
)
1072 (not (memq sym
'(boundary ignore nil
))))
1073 ;; Need to investigate closer whether we've crossed
1074 ;; between a substatement and its containing statement.
1075 (if (setq saved
(if (looking-at c-block-stmt-1-key
)
1078 (cond ((> start saved
) (setq pos saved
))
1079 ((= start saved
) (setq ret
'up
)))))
1081 (when (and (not ignore-labels
)
1082 (eq c-maybe-labelp t
)
1083 (not (eq ret
'beginning
))
1085 (not bitfield-type-pos
) ; Bitfields take precedence over labels.
1086 (or (not label-good-pos
)
1087 (<= label-good-pos pos
)
1089 (goto-char (if (and last-label-pos
1090 (< last-label-pos start
))
1093 (looking-at c-label-kwds-regexp
))))
1094 ;; We're in a label. Maybe we should step to the statement
1096 (if (< after-labels-pos start
)
1097 (setq pos after-labels-pos
)
1099 (if (and last-label-pos
(< last-label-pos start
))
1100 ;; Might have jumped over several labels. Go to the last one.
1101 (setq pos last-label-pos
)))))
1103 ;; Have we got "case <expression>:"?
1105 (when (and after-case
:-pos
1106 (not (eq ret
'beginning
))
1107 (looking-at c-case-kwds-regexp
))
1108 (if (< after-case
:-pos start
)
1109 (setq pos after-case
:-pos
))
1113 ;; Skip over the unary operators that can start the statement.
1115 (c-backward-syntactic-ws)
1116 ;; protect AWK post-inc/decrement operators, etc.
1117 (and (not (c-at-vsemi-p (point)))
1118 (/= (skip-chars-backward "-+!*&~@`#") 0)))
1123 (defun c-punctuation-in (from to
)
1124 "Return non-nil if there is a non-comment non-macro punctuation character
1125 between FROM and TO. FROM must not be in a string or comment. The returned
1126 value is the position of the first such character."
1129 (let ((pos (point)))
1130 (while (progn (skip-chars-forward c-symbol-chars to
)
1131 (c-forward-syntactic-ws to
)
1133 (setq pos
(point))))
1134 (and (< (point) to
) (point))))
1136 (defun c-crosses-statement-barrier-p (from to
)
1137 "Return non-nil if buffer positions FROM to TO cross one or more
1138 statement or declaration boundaries. The returned value is actually
1139 the position of the earliest boundary char. FROM must not be within
1140 a string or comment.
1142 The variable `c-maybe-labelp' is set to the position of the first `:' that
1143 might start a label (i.e. not part of `::' and not preceded by `?'). If a
1144 single `?' is found, then `c-maybe-labelp' is cleared.
1146 For AWK, a statement which is terminated by an EOL (not a \; or a }) is
1147 regarded as having a \"virtual semicolon\" immediately after the last token on
1148 the line. If this virtual semicolon is _at_ from, the function recognizes it.
1150 Note that this function might do hidden buffer changes. See the
1151 comment at the start of cc-engine.el for more info."
1152 (let ((skip-chars c-stmt-delim-chars
)
1157 (while (progn (skip-chars-forward skip-chars to
)
1160 ((setq lit-range
(c-literal-limits from
)) ; Have we landed in a string/comment?
1161 (goto-char (cdr lit-range
)))
1162 ((eq (char-after) ?
:)
1164 (if (and (eq (char-after) ?
:)
1166 ;; Ignore scope operators.
1168 (setq c-maybe-labelp
(1- (point)))))
1169 ((eq (char-after) ??
)
1170 ;; A question mark. Can't be a label, so stop
1171 ;; looking for more : and ?.
1172 (setq c-maybe-labelp nil
1173 skip-chars
(substring c-stmt-delim-chars
0 -
2)))
1174 ((memq (char-after) '(?
# ?
\n ?
\r)) ; A virtual semicolon?
1175 (if (and (eq (char-before) ?
\\) (memq (char-after) '(?
\n ?
\r)))
1177 (skip-chars-backward " \t" from
)
1179 (throw 'done
(point))
1181 (t (throw 'done
(point)))))
1182 ;; In trailing space after an as yet undetected virtual semicolon?
1183 (c-backward-syntactic-ws from
)
1184 (if (and (< (point) to
)
1189 (defun c-at-statement-start-p ()
1190 "Return non-nil if the point is at the first token in a statement
1191 or somewhere in the syntactic whitespace before it.
1193 A \"statement\" here is not restricted to those inside code blocks.
1194 Any kind of declaration-like construct that occur outside function
1195 bodies is also considered a \"statement\".
1197 Note that this function might do hidden buffer changes. See the
1198 comment at the start of cc-engine.el for more info."
1203 (c-syntactic-skip-backward (substring c-stmt-delim-chars
1) nil t
)
1205 (eq (char-before) ?
})
1206 (and (eq (char-before) ?
{)
1207 (not (and c-special-brace-lists
1208 (progn (backward-char)
1209 (c-looking-at-special-brace-list)))))
1210 (c-crosses-statement-barrier-p (point) end
)))))
1212 (defun c-at-expression-start-p ()
1213 "Return non-nil if the point is at the first token in an expression or
1214 statement, or somewhere in the syntactic whitespace before it.
1216 An \"expression\" here is a bit different from the normal language
1217 grammar sense: It's any sequence of expression tokens except commas,
1218 unless they are enclosed inside parentheses of some kind. Also, an
1219 expression never continues past an enclosing parenthesis, but it might
1220 contain parenthesis pairs of any sort except braces.
1222 Since expressions never cross statement boundaries, this function also
1223 recognizes statement beginnings, just like `c-at-statement-start-p'.
1225 Note that this function might do hidden buffer changes. See the
1226 comment at the start of cc-engine.el for more info."
1230 (c-stmt-delim-chars c-stmt-delim-chars-with-comma
)
1232 (c-syntactic-skip-backward (substring c-stmt-delim-chars
1) nil t
)
1234 (memq (char-before) '(?
{ ?
}))
1235 (save-excursion (backward-char)
1236 (looking-at "\\s("))
1237 (c-crosses-statement-barrier-p (point) end
)))))
1240 ;; A set of functions that covers various idiosyncrasies in
1241 ;; implementations of `forward-comment'.
1243 ;; Note: Some emacsen considers incorrectly that any line comment
1244 ;; ending with a backslash continues to the next line. I can't think
1245 ;; of any way to work around that in a reliable way without changing
1246 ;; the buffer, though. Suggestions welcome. ;) (No, temporarily
1247 ;; changing the syntax for backslash doesn't work since we must treat
1248 ;; escapes in string literals correctly.)
1250 (defun c-forward-single-comment ()
1251 "Move forward past whitespace and the closest following comment, if any.
1252 Return t if a comment was found, nil otherwise. In either case, the
1253 point is moved past the following whitespace. Line continuations,
1254 i.e. a backslashes followed by line breaks, are treated as whitespace.
1255 The line breaks that end line comments are considered to be the
1256 comment enders, so the point will be put on the beginning of the next
1257 line if it moved past a line comment.
1259 This function does not do any hidden buffer changes."
1261 (let ((start (point)))
1262 (when (looking-at "\\([ \t\n\r\f\v]\\|\\\\[\n\r]\\)+")
1263 (goto-char (match-end 0)))
1265 (when (forward-comment 1)
1267 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1271 ;; Emacs includes the ending newline in a b-style (c++)
1272 ;; comment, but XEmacs doesn't. We depend on the Emacs
1273 ;; behavior (which also is symmetric).
1274 (if (and (eolp) (elt (parse-partial-sexp start
(point)) 7))
1275 (condition-case nil
(forward-char 1)))
1279 (defsubst c-forward-comments
()
1280 "Move forward past all following whitespace and comments.
1281 Line continuations, i.e. a backslashes followed by line breaks, are
1282 treated as whitespace.
1284 Note that this function might do hidden buffer changes. See the
1285 comment at the start of cc-engine.el for more info."
1288 ;; If forward-comment in at least XEmacs 21 is given a large
1289 ;; positive value, it'll loop all the way through if it hits
1291 (and (forward-comment 5)
1292 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1296 (when (looking-at "\\\\[\n\r]")
1300 (defun c-backward-single-comment ()
1301 "Move backward past whitespace and the closest preceding comment, if any.
1302 Return t if a comment was found, nil otherwise. In either case, the
1303 point is moved past the preceding whitespace. Line continuations,
1304 i.e. a backslashes followed by line breaks, are treated as whitespace.
1305 The line breaks that end line comments are considered to be the
1306 comment enders, so the point cannot be at the end of the same line to
1307 move over a line comment.
1309 This function does not do any hidden buffer changes."
1311 (let ((start (point)))
1312 ;; When we got newline terminated comments, forward-comment in all
1313 ;; supported emacsen so far will stop at eol of each line not
1314 ;; ending with a comment when moving backwards. This corrects for
1315 ;; that, and at the same time handles line continuations.
1317 (skip-chars-backward " \t\n\r\f\v")
1318 (and (looking-at "[\n\r]")
1319 (eq (char-before) ?
\\)))
1323 ;; Some emacsen (e.g. Emacs 19.34) return t when moving
1324 ;; backwards at bob.
1327 ;; Leave point after the closest following newline if we've
1328 ;; backed up over any above, since forward-comment won't move
1329 ;; backward over a line comment if point is at the end of the
1331 (re-search-forward "\\=\\s *[\n\r]" start t
)
1333 (if (if (let (open-paren-in-column-0-is-defun-start) (forward-comment -
1))
1335 ;; If forward-comment above succeeded and we're at eol
1336 ;; then the newline we moved over above didn't end a
1337 ;; line comment, so we give it another go.
1338 (let (open-paren-in-column-0-is-defun-start)
1339 (forward-comment -
1))
1342 ;; Emacs <= 20 and XEmacs move back over the closer of a
1343 ;; block comment that lacks an opener.
1344 (if (looking-at "\\*/")
1345 (progn (forward-char 2) nil
)
1348 (defsubst c-backward-comments
()
1349 "Move backward past all preceding whitespace and comments.
1350 Line continuations, i.e. a backslashes followed by line breaks, are
1351 treated as whitespace. The line breaks that end line comments are
1352 considered to be the comment enders, so the point cannot be at the end
1353 of the same line to move over a line comment. Unlike
1354 c-backward-syntactic-ws, this function doesn't move back over
1355 preprocessor directives.
1357 Note that this function might do hidden buffer changes. See the
1358 comment at the start of cc-engine.el for more info."
1360 (let ((start (point)))
1362 ;; `forward-comment' in some emacsen (e.g. XEmacs 21.4)
1363 ;; return t when moving backwards at bob.
1366 (if (let (open-paren-in-column-0-is-defun-start)
1367 (forward-comment -
1))
1368 (if (looking-at "\\*/")
1369 ;; Emacs <= 20 and XEmacs move back over the
1370 ;; closer of a block comment that lacks an opener.
1371 (progn (forward-char 2) nil
)
1374 ;; XEmacs treats line continuations as whitespace but
1375 ;; only in the backward direction, which seems a bit
1376 ;; odd. Anyway, this is necessary for Emacs.
1377 (when (and (looking-at "[\n\r]")
1378 (eq (char-before) ?
\\)
1384 ;; Tools for skipping over syntactic whitespace.
1386 ;; The following functions use text properties to cache searches over
1387 ;; large regions of syntactic whitespace. It works as follows:
1389 ;; o If a syntactic whitespace region contains anything but simple
1390 ;; whitespace (i.e. space, tab and line breaks), the text property
1391 ;; `c-in-sws' is put over it. At places where we have stopped
1392 ;; within that region there's also a `c-is-sws' text property.
1393 ;; That since there typically are nested whitespace inside that
1394 ;; must be handled separately, e.g. whitespace inside a comment or
1395 ;; cpp directive. Thus, from one point with `c-is-sws' it's safe
1396 ;; to jump to another point with that property within the same
1397 ;; `c-in-sws' region. It can be likened to a ladder where
1398 ;; `c-in-sws' marks the bars and `c-is-sws' the rungs.
1400 ;; o The `c-is-sws' property is put on the simple whitespace chars at
1401 ;; a "rung position" and also maybe on the first following char.
1402 ;; As many characters as can be conveniently found in this range
1403 ;; are marked, but no assumption can be made that the whole range
1404 ;; is marked (it could be clobbered by later changes, for
1407 ;; Note that some part of the beginning of a sequence of simple
1408 ;; whitespace might be part of the end of a preceding line comment
1409 ;; or cpp directive and must not be considered part of the "rung".
1410 ;; Such whitespace is some amount of horizontal whitespace followed
1411 ;; by a newline. In the case of cpp directives it could also be
1412 ;; two newlines with horizontal whitespace between them.
1414 ;; The reason to include the first following char is to cope with
1415 ;; "rung positions" that doesn't have any ordinary whitespace. If
1416 ;; `c-is-sws' is put on a token character it does not have
1417 ;; `c-in-sws' set simultaneously. That's the only case when that
1418 ;; can occur, and the reason for not extending the `c-in-sws'
1419 ;; region to cover it is that the `c-in-sws' region could then be
1420 ;; accidentally merged with a following one if the token is only
1421 ;; one character long.
1423 ;; o On buffer changes the `c-in-sws' and `c-is-sws' properties are
1424 ;; removed in the changed region. If the change was inside
1425 ;; syntactic whitespace that means that the "ladder" is broken, but
1426 ;; a later call to `c-forward-sws' or `c-backward-sws' will use the
1427 ;; parts on either side and use an ordinary search only to "repair"
1430 ;; Special care needs to be taken if a region is removed: If there
1431 ;; are `c-in-sws' on both sides of it which do not connect inside
1432 ;; the region then they can't be joined. If e.g. a marked macro is
1433 ;; broken, syntactic whitespace inside the new text might be
1434 ;; marked. If those marks would become connected with the old
1435 ;; `c-in-sws' range around the macro then we could get a ladder
1436 ;; with one end outside the macro and the other at some whitespace
1439 ;; The main motivation for this system is to increase the speed in
1440 ;; skipping over the large whitespace regions that can occur at the
1441 ;; top level in e.g. header files that contain a lot of comments and
1442 ;; cpp directives. For small comments inside code it's probably
1443 ;; slower than using `forward-comment' straightforwardly, but speed is
1444 ;; not a significant factor there anyway.
1446 ; (defface c-debug-is-sws-face
1447 ; '((t (:background "GreenYellow")))
1448 ; "Debug face to mark the `c-is-sws' property.")
1449 ; (defface c-debug-in-sws-face
1450 ; '((t (:underline t)))
1451 ; "Debug face to mark the `c-in-sws' property.")
1453 ; (defun c-debug-put-sws-faces ()
1454 ; ;; Put the sws debug faces on all the `c-is-sws' and `c-in-sws'
1455 ; ;; properties in the buffer.
1458 ; (c-save-buffer-state (in-face)
1459 ; (goto-char (point-min))
1460 ; (setq in-face (if (get-text-property (point) 'c-is-sws)
1463 ; (goto-char (next-single-property-change
1464 ; (point) 'c-is-sws nil (point-max)))
1467 ; (c-debug-add-face in-face (point) 'c-debug-is-sws-face)
1468 ; (setq in-face nil))
1469 ; (setq in-face (point)))
1471 ; (goto-char (point-min))
1472 ; (setq in-face (if (get-text-property (point) 'c-in-sws)
1475 ; (goto-char (next-single-property-change
1476 ; (point) 'c-in-sws nil (point-max)))
1479 ; (c-debug-add-face in-face (point) 'c-debug-in-sws-face)
1480 ; (setq in-face nil))
1481 ; (setq in-face (point)))
1484 (defmacro c-debug-sws-msg
(&rest args
)
1488 (defmacro c-put-is-sws
(beg end
)
1489 ;; This macro does a hidden buffer change.
1490 `(let ((beg ,beg
) (end ,end
))
1491 (put-text-property beg end
'c-is-sws t
)
1492 ,@(when (facep 'c-debug-is-sws-face
)
1493 `((c-debug-add-face beg end
'c-debug-is-sws-face
)))))
1495 (defmacro c-put-in-sws
(beg end
)
1496 ;; This macro does a hidden buffer change.
1497 `(let ((beg ,beg
) (end ,end
))
1498 (put-text-property beg end
'c-in-sws t
)
1499 ,@(when (facep 'c-debug-is-sws-face
)
1500 `((c-debug-add-face beg end
'c-debug-in-sws-face
)))))
1502 (defmacro c-remove-is-sws
(beg end
)
1503 ;; This macro does a hidden buffer change.
1504 `(let ((beg ,beg
) (end ,end
))
1505 (remove-text-properties beg end
'(c-is-sws nil
))
1506 ,@(when (facep 'c-debug-is-sws-face
)
1507 `((c-debug-remove-face beg end
'c-debug-is-sws-face
)))))
1509 (defmacro c-remove-in-sws
(beg end
)
1510 ;; This macro does a hidden buffer change.
1511 `(let ((beg ,beg
) (end ,end
))
1512 (remove-text-properties beg end
'(c-in-sws nil
))
1513 ,@(when (facep 'c-debug-is-sws-face
)
1514 `((c-debug-remove-face beg end
'c-debug-in-sws-face
)))))
1516 (defmacro c-remove-is-and-in-sws
(beg end
)
1517 ;; This macro does a hidden buffer change.
1518 `(let ((beg ,beg
) (end ,end
))
1519 (remove-text-properties beg end
'(c-is-sws nil c-in-sws nil
))
1520 ,@(when (facep 'c-debug-is-sws-face
)
1521 `((c-debug-remove-face beg end
'c-debug-is-sws-face
)
1522 (c-debug-remove-face beg end
'c-debug-in-sws-face
)))))
1524 (defsubst c-invalidate-sws-region-after
(beg end
)
1525 ;; Called from `after-change-functions'. Note that if
1526 ;; `c-forward-sws' or `c-backward-sws' are used outside
1527 ;; `c-save-buffer-state' or similar then this will remove the cache
1528 ;; properties right after they're added.
1530 ;; This function does hidden buffer changes.
1533 ;; Adjust the end to remove the properties in any following simple
1534 ;; ws up to and including the next line break, if there is any
1535 ;; after the changed region. This is necessary e.g. when a rung
1536 ;; marked empty line is converted to a line comment by inserting
1537 ;; "//" before the line break. In that case the line break would
1538 ;; keep the rung mark which could make a later `c-backward-sws'
1539 ;; move into the line comment instead of over it.
1541 (skip-chars-forward " \t\f\v")
1542 (when (and (eolp) (not (eobp)))
1543 (setq end
(1+ (point)))))
1545 (when (and (= beg end
)
1546 (get-text-property beg
'c-in-sws
)
1548 (get-text-property (1- beg
) 'c-in-sws
))
1549 ;; Ensure that an `c-in-sws' range gets broken. Note that it isn't
1550 ;; safe to keep a range that was continuous before the change. E.g:
1556 ;; There can be a "ladder" between "#" and "b". Now, if the newline
1557 ;; after "foo" is removed then "bar" will become part of the cpp
1558 ;; directive instead of a syntactically relevant token. In that
1559 ;; case there's no longer syntactic ws from "#" to "b".
1560 (setq beg
(1- beg
)))
1562 (c-debug-sws-msg "c-invalidate-sws-region-after [%s..%s]" beg end
)
1563 (c-remove-is-and-in-sws beg end
))
1565 (defun c-forward-sws ()
1566 ;; Used by `c-forward-syntactic-ws' to implement the unbounded search.
1568 ;; This function might do hidden buffer changes.
1570 (let (;; `rung-pos' is set to a position as early as possible in the
1571 ;; unmarked part of the simple ws region.
1572 (rung-pos (point)) next-rung-pos rung-end-pos last-put-in-sws-pos
1573 rung-is-marked next-rung-is-marked simple-ws-end
1574 ;; `safe-start' is set when it's safe to cache the start position.
1575 ;; It's not set if we've initially skipped over comments and line
1576 ;; continuations since we might have gone out through the end of a
1577 ;; macro then. This provision makes `c-forward-sws' not populate the
1578 ;; cache in the majority of cases, but otoh is `c-backward-sws' by far
1582 ;; Skip simple ws and do a quick check on the following character to see
1583 ;; if it's anything that can't start syntactic ws, so we can bail out
1584 ;; early in the majority of cases when there just are a few ws chars.
1585 (skip-chars-forward " \t\n\r\f\v")
1586 (when (looking-at c-syntactic-ws-start
)
1588 (setq rung-end-pos
(min (1+ (point)) (point-max)))
1589 (if (setq rung-is-marked
(text-property-any rung-pos rung-end-pos
1591 ;; Find the last rung position to avoid setting properties in all
1592 ;; the cases when the marked rung is complete.
1593 ;; (`next-single-property-change' is certain to move at least one
1595 (setq rung-pos
(1- (next-single-property-change
1596 rung-is-marked
'c-is-sws nil rung-end-pos
)))
1597 ;; Got no marked rung here. Since the simple ws might have started
1598 ;; inside a line comment or cpp directive we must set `rung-pos' as
1599 ;; high as possible.
1600 (setq rung-pos
(point)))
1605 (when (and rung-is-marked
1606 (get-text-property (point) 'c-in-sws
))
1608 ;; The following search is the main reason that `c-in-sws'
1609 ;; and `c-is-sws' aren't combined to one property.
1610 (goto-char (next-single-property-change
1611 (point) 'c-in-sws nil
(point-max)))
1612 (unless (get-text-property (point) 'c-is-sws
)
1613 ;; If the `c-in-sws' region extended past the last
1614 ;; `c-is-sws' char we have to go back a bit.
1615 (or (get-text-property (1- (point)) 'c-is-sws
)
1616 (goto-char (previous-single-property-change
1617 (point) 'c-is-sws
)))
1621 "c-forward-sws cached move %s -> %s (max %s)"
1622 rung-pos
(point) (point-max))
1624 (setq rung-pos
(point))
1625 (and (> (skip-chars-forward " \t\n\r\f\v") 0)
1628 ;; We'll loop here if there is simple ws after the last rung.
1629 ;; That means that there's been some change in it and it's
1630 ;; possible that we've stepped into another ladder, so extend
1631 ;; the previous one to join with it if there is one, and try to
1632 ;; use the cache again.
1634 "c-forward-sws extending rung with [%s..%s] (max %s)"
1635 (1+ rung-pos
) (1+ (point)) (point-max))
1636 (unless (get-text-property (point) 'c-is-sws
)
1637 ;; Remove any `c-in-sws' property from the last char of
1638 ;; the rung before we mark it with `c-is-sws', so that we
1639 ;; won't connect with the remains of a broken "ladder".
1640 (c-remove-in-sws (point) (1+ (point))))
1641 (c-put-is-sws (1+ rung-pos
)
1643 (c-put-in-sws rung-pos
1644 (setq rung-pos
(point)
1645 last-put-in-sws-pos rung-pos
)))
1647 (setq simple-ws-end
(point))
1648 (c-forward-comments)
1651 ((/= (point) simple-ws-end
)
1652 ;; Skipped over comments. Don't cache at eob in case the buffer
1657 (and c-opt-cpp-prefix
1658 (looking-at c-opt-cpp-start
)
1659 (progn (skip-chars-backward " \t")
1662 (progn (backward-char)
1663 (not (eq (char-before) ?
\\))))))
1664 ;; Skip a preprocessor directive.
1666 (while (and (eq (char-before) ?
\\)
1667 (= (forward-line 1) 0))
1671 ;; Don't cache at eob in case the buffer is narrowed.
1674 ;; We've searched over a piece of non-white syntactic ws. See if this
1676 (setq next-rung-pos
(point))
1677 (skip-chars-forward " \t\n\r\f\v")
1678 (setq rung-end-pos
(min (1+ (point)) (point-max)))
1681 ;; Cache if we haven't skipped comments only, and if we started
1682 ;; either from a marked rung or from a completely uncached
1686 (not (get-text-property simple-ws-end
'c-in-sws
))))
1688 ;; See if there's a marked rung in the encountered simple ws. If
1689 ;; so then we can cache, unless `safe-start' is nil. Even then
1690 ;; we need to do this to check if the cache can be used for the
1692 (and (setq next-rung-is-marked
1693 (text-property-any next-rung-pos rung-end-pos
1699 "c-forward-sws caching [%s..%s] - [%s..%s] (max %s)"
1700 rung-pos
(1+ simple-ws-end
) next-rung-pos rung-end-pos
1703 ;; Remove the properties for any nested ws that might be cached.
1704 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
1706 (c-remove-is-sws (1+ simple-ws-end
) next-rung-pos
)
1707 (unless (and rung-is-marked
(= rung-pos simple-ws-end
))
1708 (c-put-is-sws rung-pos
1710 (setq rung-is-marked t
))
1711 (c-put-in-sws rung-pos
1712 (setq rung-pos
(point)
1713 last-put-in-sws-pos rung-pos
))
1714 (unless (get-text-property (1- rung-end-pos
) 'c-is-sws
)
1715 ;; Remove any `c-in-sws' property from the last char of
1716 ;; the rung before we mark it with `c-is-sws', so that we
1717 ;; won't connect with the remains of a broken "ladder".
1718 (c-remove-in-sws (1- rung-end-pos
) rung-end-pos
))
1719 (c-put-is-sws next-rung-pos
1723 "c-forward-sws not caching [%s..%s] - [%s..%s] (max %s)"
1724 rung-pos
(1+ simple-ws-end
) next-rung-pos rung-end-pos
1727 ;; Set `rung-pos' for the next rung. It's the same thing here as
1728 ;; initially, except that the rung position is set as early as
1729 ;; possible since we can't be in the ending ws of a line comment or
1730 ;; cpp directive now.
1731 (if (setq rung-is-marked next-rung-is-marked
)
1732 (setq rung-pos
(1- (next-single-property-change
1733 rung-is-marked
'c-is-sws nil rung-end-pos
)))
1734 (setq rung-pos next-rung-pos
))
1735 (setq safe-start t
)))
1737 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
1738 ;; another one after the point (which might occur when editing inside a
1739 ;; comment or macro).
1740 (when (eq last-put-in-sws-pos
(point))
1741 (cond ((< last-put-in-sws-pos
(point-max))
1743 "c-forward-sws clearing at %s for cache separation"
1744 last-put-in-sws-pos
)
1745 (c-remove-in-sws last-put-in-sws-pos
1746 (1+ last-put-in-sws-pos
)))
1748 ;; If at eob we have to clear the last character before the end
1749 ;; instead since the buffer might be narrowed and there might
1750 ;; be a `c-in-sws' after (point-max). In this case it's
1751 ;; necessary to clear both properties.
1753 "c-forward-sws clearing thoroughly at %s for cache separation"
1754 (1- last-put-in-sws-pos
))
1755 (c-remove-is-and-in-sws (1- last-put-in-sws-pos
)
1756 last-put-in-sws-pos
))))
1759 (defun c-backward-sws ()
1760 ;; Used by `c-backward-syntactic-ws' to implement the unbounded search.
1762 ;; This function might do hidden buffer changes.
1764 (let (;; `rung-pos' is set to a position as late as possible in the unmarked
1765 ;; part of the simple ws region.
1766 (rung-pos (point)) next-rung-pos last-put-in-sws-pos
1767 rung-is-marked simple-ws-beg cmt-skip-pos
)
1769 ;; Skip simple horizontal ws and do a quick check on the preceding
1770 ;; character to see if it's anying that can't end syntactic ws, so we can
1771 ;; bail out early in the majority of cases when there just are a few ws
1772 ;; chars. Newlines are complicated in the backward direction, so we can't
1774 (skip-chars-backward " \t\f")
1775 (when (and (not (bobp))
1778 (looking-at c-syntactic-ws-end
)))
1780 ;; Try to find a rung position in the simple ws preceding point, so that
1781 ;; we can get a cache hit even if the last bit of the simple ws has
1782 ;; changed recently.
1783 (setq simple-ws-beg
(point))
1784 (skip-chars-backward " \t\n\r\f\v")
1785 (if (setq rung-is-marked
(text-property-any
1786 (point) (min (1+ rung-pos
) (point-max))
1788 ;; `rung-pos' will be the earliest marked position, which means that
1789 ;; there might be later unmarked parts in the simple ws region.
1790 ;; It's not worth the effort to fix that; the last part of the
1791 ;; simple ws is also typically edited often, so it could be wasted.
1792 (goto-char (setq rung-pos rung-is-marked
))
1793 (goto-char simple-ws-beg
))
1798 (when (and rung-is-marked
1800 (get-text-property (1- (point)) 'c-in-sws
))
1802 ;; The following search is the main reason that `c-in-sws'
1803 ;; and `c-is-sws' aren't combined to one property.
1804 (goto-char (previous-single-property-change
1805 (point) 'c-in-sws nil
(point-min)))
1806 (unless (get-text-property (point) 'c-is-sws
)
1807 ;; If the `c-in-sws' region extended past the first
1808 ;; `c-is-sws' char we have to go forward a bit.
1809 (goto-char (next-single-property-change
1810 (point) 'c-is-sws
)))
1813 "c-backward-sws cached move %s <- %s (min %s)"
1814 (point) rung-pos
(point-min))
1816 (setq rung-pos
(point))
1817 (if (and (< (min (skip-chars-backward " \t\f\v")
1819 (setq simple-ws-beg
(point))
1820 (skip-chars-backward " \t\n\r\f\v")))
1822 (setq rung-is-marked
1823 (text-property-any (point) rung-pos
1826 (goto-char simple-ws-beg
)
1829 ;; We'll loop here if there is simple ws before the first rung.
1830 ;; That means that there's been some change in it and it's
1831 ;; possible that we've stepped into another ladder, so extend
1832 ;; the previous one to join with it if there is one, and try to
1833 ;; use the cache again.
1835 "c-backward-sws extending rung with [%s..%s] (min %s)"
1836 rung-is-marked rung-pos
(point-min))
1837 (unless (get-text-property (1- rung-pos
) 'c-is-sws
)
1838 ;; Remove any `c-in-sws' property from the last char of
1839 ;; the rung before we mark it with `c-is-sws', so that we
1840 ;; won't connect with the remains of a broken "ladder".
1841 (c-remove-in-sws (1- rung-pos
) rung-pos
))
1842 (c-put-is-sws rung-is-marked
1844 (c-put-in-sws rung-is-marked
1846 (setq rung-pos rung-is-marked
1847 last-put-in-sws-pos rung-pos
))
1849 (c-backward-comments)
1850 (setq cmt-skip-pos
(point))
1853 ((and c-opt-cpp-prefix
1854 (/= cmt-skip-pos simple-ws-beg
)
1855 (c-beginning-of-macro))
1856 ;; Inside a cpp directive. See if it should be skipped over.
1857 (let ((cpp-beg (point)))
1859 ;; Move back over all line continuations in the region skipped
1860 ;; over by `c-backward-comments'. If we go past it then we
1861 ;; started inside the cpp directive.
1862 (goto-char simple-ws-beg
)
1864 (while (and (> (point) cmt-skip-pos
)
1865 (progn (backward-char)
1866 (eq (char-before) ?
\\)))
1867 (beginning-of-line))
1869 (if (< (point) cmt-skip-pos
)
1870 ;; Don't move past the cpp directive if we began inside
1871 ;; it. Note that the position at the end of the last line
1872 ;; of the macro is also considered to be within it.
1873 (progn (goto-char cmt-skip-pos
)
1876 ;; It's worthwhile to spend a little bit of effort on finding
1877 ;; the end of the macro, to get a good `simple-ws-beg'
1878 ;; position for the cache. Note that `c-backward-comments'
1879 ;; could have stepped over some comments before going into
1880 ;; the macro, and then `simple-ws-beg' must be kept on the
1881 ;; same side of those comments.
1882 (goto-char simple-ws-beg
)
1883 (skip-chars-backward " \t\n\r\f\v")
1884 (if (eq (char-before) ?
\\)
1887 (if (< (point) simple-ws-beg
)
1888 ;; Might happen if comments after the macro were skipped
1890 (setq simple-ws-beg
(point)))
1895 ((/= (save-excursion
1896 (skip-chars-forward " \t\n\r\f\v" simple-ws-beg
)
1897 (setq next-rung-pos
(point)))
1899 ;; Skipped over comments. Must put point at the end of
1900 ;; the simple ws at point since we might be after a line
1901 ;; comment or cpp directive that's been partially
1902 ;; narrowed out, and we can't risk marking the simple ws
1903 ;; at the end of it.
1904 (goto-char next-rung-pos
)
1907 ;; We've searched over a piece of non-white syntactic ws. See if this
1909 (setq next-rung-pos
(point))
1910 (skip-chars-backward " \t\f\v")
1913 ;; Cache if we started either from a marked rung or from a
1914 ;; completely uncached position.
1916 (not (get-text-property (1- simple-ws-beg
) 'c-in-sws
))
1918 ;; Cache if there's a marked rung in the encountered simple ws.
1920 (skip-chars-backward " \t\n\r\f\v")
1921 (text-property-any (point) (min (1+ next-rung-pos
) (point-max))
1926 "c-backward-sws caching [%s..%s] - [%s..%s] (min %s)"
1927 (point) (1+ next-rung-pos
)
1928 simple-ws-beg
(min (1+ rung-pos
) (point-max))
1931 ;; Remove the properties for any nested ws that might be cached.
1932 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
1934 (c-remove-is-sws (1+ next-rung-pos
) simple-ws-beg
)
1935 (unless (and rung-is-marked
(= simple-ws-beg rung-pos
))
1936 (let ((rung-end-pos (min (1+ rung-pos
) (point-max))))
1937 (unless (get-text-property (1- rung-end-pos
) 'c-is-sws
)
1938 ;; Remove any `c-in-sws' property from the last char of
1939 ;; the rung before we mark it with `c-is-sws', so that we
1940 ;; won't connect with the remains of a broken "ladder".
1941 (c-remove-in-sws (1- rung-end-pos
) rung-end-pos
))
1942 (c-put-is-sws simple-ws-beg
1944 (setq rung-is-marked t
)))
1945 (c-put-in-sws (setq simple-ws-beg
(point)
1946 last-put-in-sws-pos simple-ws-beg
)
1948 (c-put-is-sws (setq rung-pos simple-ws-beg
)
1949 (1+ next-rung-pos
)))
1952 "c-backward-sws not caching [%s..%s] - [%s..%s] (min %s)"
1953 (point) (1+ next-rung-pos
)
1954 simple-ws-beg
(min (1+ rung-pos
) (point-max))
1956 (setq rung-pos next-rung-pos
1957 simple-ws-beg
(point))
1960 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
1961 ;; another one before the point (which might occur when editing inside a
1962 ;; comment or macro).
1963 (when (eq last-put-in-sws-pos
(point))
1964 (cond ((< (point-min) last-put-in-sws-pos
)
1966 "c-backward-sws clearing at %s for cache separation"
1967 (1- last-put-in-sws-pos
))
1968 (c-remove-in-sws (1- last-put-in-sws-pos
)
1969 last-put-in-sws-pos
))
1971 ;; If at bob and the buffer is narrowed, we have to clear the
1972 ;; character we're standing on instead since there might be a
1973 ;; `c-in-sws' before (point-min). In this case it's necessary
1974 ;; to clear both properties.
1976 "c-backward-sws clearing thoroughly at %s for cache separation"
1977 last-put-in-sws-pos
)
1978 (c-remove-is-and-in-sws last-put-in-sws-pos
1979 (1+ last-put-in-sws-pos
)))))
1983 ;; Other whitespace tools
1984 (defun c-partial-ws-p (beg end
)
1985 ;; Is the region (beg end) WS, and is there WS (or BOB/EOB) next to the
1986 ;; region? This is a "heuristic" function. .....
1988 ;; The motivation for the second bit is to check whether removing this
1989 ;; region would coalesce two symbols.
1991 ;; FIXME!!! This function doesn't check virtual semicolons in any way. Be
1992 ;; careful about using this function for, e.g. AWK. (2007/3/7)
1994 (let ((end+1 (min (1+ end
) (point-max))))
1995 (or (progn (goto-char (max (point-min) (1- beg
)))
1996 (c-skip-ws-forward end
)
1998 (progn (goto-char beg
)
1999 (c-skip-ws-forward end
+1)
2000 (eq (point) end
+1))))))
2002 ;; A system for finding noteworthy parens before the point.
2004 (defconst c-state-cache-too-far
5000)
2005 ;; A maximum comfortable scanning distance, e.g. between
2006 ;; `c-state-cache-good-pos' and "HERE" (where we call c-parse-state). When
2007 ;; this distance is exceeded, we take "emergency meausures", e.g. by clearing
2008 ;; the cache and starting again from point-min or a beginning of defun. This
2009 ;; value can be tuned for efficiency or set to a lower value for testing.
2011 (defvar c-state-cache nil
)
2012 (make-variable-buffer-local 'c-state-cache
)
2013 ;; The state cache used by `c-parse-state' to cut down the amount of
2014 ;; searching. It's the result from some earlier `c-parse-state' call. See
2015 ;; `c-parse-state''s doc string for details of its structure.
2017 ;; The use of the cached info is more effective if the next
2018 ;; `c-parse-state' call is on a line close by the one the cached state
2019 ;; was made at; the cache can actually slow down a little if the
2020 ;; cached state was made very far back in the buffer. The cache is
2021 ;; most effective if `c-parse-state' is used on each line while moving
2024 (defvar c-state-cache-good-pos
1)
2025 (make-variable-buffer-local 'c-state-cache-good-pos
)
2026 ;; This is a position where `c-state-cache' is known to be correct, or
2027 ;; nil (see below). It's a position inside one of the recorded unclosed
2028 ;; parens or the top level, but not further nested inside any literal or
2029 ;; subparen that is closed before the last recorded position.
2031 ;; The exact position is chosen to try to be close to yet earlier than
2032 ;; the position where `c-state-cache' will be called next. Right now
2033 ;; the heuristic is to set it to the position after the last found
2034 ;; closing paren (of any type) before the line on which
2035 ;; `c-parse-state' was called. That is chosen primarily to work well
2036 ;; with refontification of the current line.
2038 ;; 2009-07-28: When `c-state-point-min' and the last position where
2039 ;; `c-parse-state' or for which `c-invalidate-state-cache' was called, are
2040 ;; both in the same literal, there is no such "good position", and
2041 ;; c-state-cache-good-pos is then nil. This is the ONLY circumstance in which
2042 ;; it can be nil. In this case, `c-state-point-min-literal' will be non-nil.
2044 ;; 2009-06-12: In a brace desert, c-state-cache-good-pos may also be in
2045 ;; the middle of the desert, as long as it is not within a brace pair
2046 ;; recorded in `c-state-cache' or a paren/bracket pair.
2049 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2050 ;; We maintain a simple cache of positions which aren't in a literal, so as to
2051 ;; speed up testing for non-literality.
2052 (defconst c-state-nonlit-pos-interval
10000)
2053 ;; The approximate interval between entries in `c-state-nonlit-pos-cache'.
2055 (defvar c-state-nonlit-pos-cache nil
)
2056 (make-variable-buffer-local 'c-state-nonlit-pos-cache
)
2057 ;; A list of buffer positions which are known not to be in a literal or a cpp
2058 ;; construct. This is ordered with higher positions at the front of the list.
2059 ;; Only those which are less than `c-state-nonlit-pos-cache-limit' are valid.
2061 (defvar c-state-nonlit-pos-cache-limit
1)
2062 (make-variable-buffer-local 'c-state-nonlit-pos-cache-limit
)
2063 ;; An upper limit on valid entries in `c-state-nonlit-pos-cache'. This is
2064 ;; reduced by buffer changes, and increased by invocations of
2065 ;; `c-state-literal-at'.
2067 (defsubst c-state-pp-to-literal
(from to
)
2068 ;; Do a parse-partial-sexp from FROM to TO, returning the bounds of any
2069 ;; literal at TO as a cons, otherwise NIL.
2070 ;; FROM must not be in a literal, and the buffer should already be wide
2073 (let ((s (parse-partial-sexp from to
)))
2074 (when (or (nth 3 s
) (nth 4 s
)) ; in a string or comment
2075 (parse-partial-sexp (point) (point-max)
2079 'syntax-table
) ; stop at end of literal
2080 (cons (nth 8 s
) (point))))))
2082 (defun c-state-literal-at (here)
2083 ;; If position HERE is inside a literal, return (START . END), the
2084 ;; boundaries of the literal (which may be outside the accessible bit of the
2085 ;; buffer). Otherwise, return nil.
2087 ;; This function is almost the same as `c-literal-limits'. It differs in
2088 ;; that it is a lower level function, and that it rigourously follows the
2089 ;; syntax from BOB, whereas `c-literal-limits' uses a "local" safe position.
2091 ;; NOTE: This function manipulates `c-state-nonlit-pos-cache'. This cache
2092 ;; MAY NOT contain any positions within macros, since macros are frequently
2093 ;; turned into comments by use of the `c-cpp-delimiter' category properties.
2094 ;; We cannot rely on this mechanism whilst determining a cache pos since
2095 ;; this function is also called from outwith `c-parse-state'.
2099 (let ((c c-state-nonlit-pos-cache
)
2101 ;; Trim the cache to take account of buffer changes.
2102 (while (and c
(> (car c
) c-state-nonlit-pos-cache-limit
))
2104 (setq c-state-nonlit-pos-cache c
)
2106 (while (and c
(> (car c
) here
))
2108 (setq pos
(or (car c
) (point-min)))
2110 (while (<= (setq npos
(+ pos c-state-nonlit-pos-interval
))
2112 (setq lit
(c-state-pp-to-literal pos npos
))
2113 (setq pos
(or (cdr lit
) npos
)) ; end of literal containing npos.
2115 (when (and (c-beginning-of-macro) (/= (point) pos
))
2116 (c-syntactic-end-of-macro)
2117 (or (eobp) (forward-char))
2119 (setq c-state-nonlit-pos-cache
(cons pos c-state-nonlit-pos-cache
)))
2121 (if (> pos c-state-nonlit-pos-cache-limit
)
2122 (setq c-state-nonlit-pos-cache-limit pos
))
2124 (setq lit
(c-state-pp-to-literal pos here
)))
2127 (defsubst c-state-lit-beg
(pos)
2128 ;; Return the start of the literal containing POS, or POS itself.
2129 (or (car (c-state-literal-at pos
))
2132 (defsubst c-state-cache-non-literal-place
(pos state
)
2133 ;; Return a position outside of a string/comment/macro at or before POS.
2134 ;; STATE is the parse-partial-sexp state at POS.
2135 (let ((res (if (or (nth 3 state
) ; in a string?
2136 (nth 4 state
)) ; in a comment?
2141 (if (c-beginning-of-macro)
2145 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2146 ;; Stuff to do with point-min, and coping with any literal there.
2147 (defvar c-state-point-min
1)
2148 (make-variable-buffer-local 'c-state-point-min
)
2149 ;; This is (point-min) when `c-state-cache' was last calculated. A change of
2150 ;; narrowing is likely to affect the parens that are visible before the point.
2152 (defvar c-state-point-min-lit-type nil
)
2153 (make-variable-buffer-local 'c-state-point-min-lit-type
)
2154 (defvar c-state-point-min-lit-start nil
)
2155 (make-variable-buffer-local 'c-state-point-min-lit-start
)
2156 ;; These two variables define the literal, if any, containing point-min.
2157 ;; Their values are, respectively, 'string, c, or c++, and the start of the
2158 ;; literal. If there's no literal there, they're both nil.
2160 (defvar c-state-min-scan-pos
1)
2161 (make-variable-buffer-local 'c-state-min-scan-pos
)
2162 ;; This is the earliest buffer-pos from which scanning can be done. It is
2163 ;; either the end of the literal containing point-min, or point-min itself.
2164 ;; It becomes nil if the buffer is changed earlier than this point.
2165 (defun c-state-get-min-scan-pos ()
2166 ;; Return the lowest valid scanning pos. This will be the end of the
2167 ;; literal enclosing point-min, or point-min itself.
2168 (or c-state-min-scan-pos
2172 (goto-char c-state-point-min-lit-start
)
2173 (if (eq c-state-point-min-lit-type
'string
)
2175 (forward-comment 1))
2176 (setq c-state-min-scan-pos
(point))))))
2178 (defun c-state-mark-point-min-literal ()
2179 ;; Determine the properties of any literal containing POINT-MIN, setting the
2180 ;; variables `c-state-point-min-lit-type', `c-state-point-min-lit-start',
2181 ;; and `c-state-min-scan-pos' accordingly. The return value is meaningless.
2182 (let ((p-min (point-min))
2186 (setq lit
(c-state-literal-at p-min
))
2188 (setq c-state-point-min-lit-type
2190 (goto-char (car lit
))
2192 ((looking-at c-block-comment-start-regexp
) 'c
)
2193 ((looking-at c-line-comment-starter
) 'c
++)
2195 c-state-point-min-lit-start
(car lit
)
2196 c-state-min-scan-pos
(cdr lit
))
2197 (setq c-state-point-min-lit-type nil
2198 c-state-point-min-lit-start nil
2199 c-state-min-scan-pos p-min
)))))
2202 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2203 ;; A variable which signals a brace dessert - helpful for reducing the number
2204 ;; of fruitless backward scans.
2205 (defvar c-state-brace-pair-desert nil
)
2206 (make-variable-buffer-local 'c-state-brace-pair-desert
)
2207 ;; Used only in `c-append-lower-brace-pair-to-state-cache'. It is set when
2208 ;; that defun has searched backwards for a brace pair and not found one. Its
2209 ;; value is either nil or a cons (PA . FROM), where PA is the position of the
2210 ;; enclosing opening paren/brace/bracket which bounds the backwards search (or
2211 ;; nil when at top level) and FROM is where the backward search started. It
2212 ;; is reset to nil in `c-invalidate-state-cache'.
2215 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2216 ;; Lowish level functions/macros which work directly on `c-state-cache', or a
2217 ;; list of like structure.
2218 (defmacro c-state-cache-top-lparen
(&optional cache
)
2219 ;; Return the address of the top left brace/bracket/paren recorded in CACHE
2220 ;; (default `c-state-cache') (or nil).
2221 (let ((cash (or cache
'c-state-cache
)))
2222 `(if (consp (car ,cash
))
2226 (defmacro c-state-cache-top-paren
(&optional cache
)
2227 ;; Return the address of the latest brace/bracket/paren (whether left or
2228 ;; right) recorded in CACHE (default `c-state-cache') or nil.
2229 (let ((cash (or cache
'c-state-cache
)))
2230 `(if (consp (car ,cash
))
2234 (defmacro c-state-cache-after-top-paren
(&optional cache
)
2235 ;; Return the position just after the latest brace/bracket/paren (whether
2236 ;; left or right) recorded in CACHE (default `c-state-cache') or nil.
2237 (let ((cash (or cache
'c-state-cache
)))
2238 `(if (consp (car ,cash
))
2241 (1+ (car ,cash
))))))
2243 (defun c-get-cache-scan-pos (here)
2244 ;; From the state-cache, determine the buffer position from which we might
2245 ;; scan forward to HERE to update this cache. This position will be just
2246 ;; after a paren/brace/bracket recorded in the cache, if possible, otherwise
2247 ;; return the earliest position in the accessible region which isn't within
2248 ;; a literal. If the visible portion of the buffer is entirely within a
2249 ;; literal, return NIL.
2250 (let ((c c-state-cache
) elt
)
2251 ;(while (>= (or (c-state-cache-top-lparen c) 1) here)
2253 (>= (c-state-cache-top-lparen c
) here
))
2259 (if (> (cdr elt
) here
)
2263 ((<= (c-state-get-min-scan-pos) here
)
2264 (c-state-get-min-scan-pos))
2267 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2268 ;; Variables which keep track of preprocessor constructs.
2269 (defvar c-state-old-cpp-beg nil
)
2270 (make-variable-buffer-local 'c-state-old-cpp-beg
)
2271 (defvar c-state-old-cpp-end nil
)
2272 (make-variable-buffer-local 'c-state-old-cpp-end
)
2273 ;; These are the limits of the macro containing point at the previous call of
2274 ;; `c-parse-state', or nil.
2276 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2277 ;; Defuns which analyse the buffer, yet don't change `c-state-cache'.
2278 (defun c-get-fallback-scan-pos (here)
2279 ;; Return a start position for building `c-state-cache' from
2280 ;; scratch. This will be at the top level, 2 defuns back.
2282 ;; Go back 2 bods, but ignore any bogus positions returned by
2283 ;; beginning-of-defun (i.e. open paren in column zero).
2286 (while (not (or (bobp) (zerop cnt
)))
2287 (c-beginning-of-defun-1) ; Pure elisp BOD.
2288 (if (eq (char-after) ?\
{)
2289 (setq cnt
(1- cnt
)))))
2292 (defun c-state-balance-parens-backwards (here- here
+ top
)
2293 ;; Return the position of the opening paren/brace/bracket before HERE- which
2294 ;; matches the outermost close p/b/b between HERE+ and TOP. Except when
2295 ;; there's a macro, HERE- and HERE+ are the same. Like this:
2297 ;; ............................................
2299 ;; ( [ ( .........#macro.. ) ( ) ] )
2302 ;; return HERE- HERE+ TOP
2304 ;; If there aren't enough opening paren/brace/brackets, return the position
2305 ;; of the outermost one found, or HERE- if there are none. If there are no
2306 ;; closeing p/b/bs between HERE+ and TOP, return HERE-. HERE-/+ and TOP
2307 ;; must not be inside literals. Only the accessible portion of the buffer
2310 ;; PART 1: scan from `here+' up to `top', accumulating ")"s which enclose
2311 ;; `here'. Go round the next loop each time we pass over such a ")". These
2312 ;; probably match "("s before `here-'.
2313 (let (pos pa ren
+1 lonely-rens
)
2316 (narrow-to-region (point-min) top
) ; This can move point, sometimes.
2320 (setq ren
+1 (scan-lists pos
1 1)) ; might signal
2321 (setq lonely-rens
(cons ren
+1 lonely-rens
)
2324 ;; PART 2: Scan back before `here-' searching for the "("s
2325 ;; matching/mismatching the ")"s found above. We only need to direct the
2326 ;; caller to scan when we've encountered unmatched right parens.
2331 (and lonely-rens
; actual values aren't used.
2332 (setq pa
(scan-lists pos -
1 1)))
2334 (setq lonely-rens
(cdr lonely-rens
)))))
2337 (defun c-parse-state-get-strategy (here good-pos
)
2338 ;; Determine the scanning strategy for adjusting `c-parse-state', attempting
2339 ;; to minimise the amount of scanning. HERE is the pertinent position in
2340 ;; the buffer, GOOD-POS is a position where `c-state-cache' (possibly with
2341 ;; its head trimmed) is known to be good, or nil if there is no such
2344 ;; The return value is a list, one of the following:
2346 ;; o - ('forward CACHE-POS START-POINT) - scan forward from START-POINT,
2347 ;; which is not less than CACHE-POS.
2348 ;; o - ('backward CACHE-POS nil) - scan backwards (from HERE).
2349 ;; o - ('BOD nil START-POINT) - scan forwards from START-POINT, which is at the
2351 ;; o - ('IN-LIT nil nil) - point is inside the literal containing point-min.
2352 ;; , where CACHE-POS is the highest position recorded in `c-state-cache' at
2354 (let ((cache-pos (c-get-cache-scan-pos here
)) ; highest position below HERE in cache (or 1)
2355 BOD-pos
; position of 2nd BOD before HERE.
2356 strategy
; 'forward, 'backward, 'BOD, or 'IN-LIT.
2358 how-far
) ; putative scanning distance.
2359 (setq good-pos
(or good-pos
(c-state-get-min-scan-pos)))
2361 ((< here
(c-state-get-min-scan-pos))
2362 (setq strategy
'IN-LIT
2367 (setq strategy
'forward
2368 start-point
(max good-pos cache-pos
)
2369 how-far
(- here start-point
)))
2370 ((< (- good-pos here
) (- here cache-pos
)) ; FIXME!!! ; apply some sort of weighting.
2371 (setq strategy
'backward
2372 how-far
(- good-pos here
)))
2374 (setq strategy
'forward
2375 how-far
(- here cache-pos
)
2376 start-point cache-pos
)))
2378 ;; Might we be better off starting from the top level, two defuns back,
2380 (when (> how-far c-state-cache-too-far
)
2381 (setq BOD-pos
(c-get-fallback-scan-pos here
)) ; somewhat EXPENSIVE!!!
2382 (if (< (- here BOD-pos
) how-far
)
2384 start-point BOD-pos
)))
2388 (and (memq strategy
'(forward backward
)) cache-pos
)
2389 (and (memq strategy
'(forward BOD
)) start-point
))))
2392 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2393 ;; Routines which change `c-state-cache' and associated values.
2394 (defun c-renarrow-state-cache ()
2395 ;; The region (more precisely, point-min) has changed since we
2396 ;; calculated `c-state-cache'. Amend `c-state-cache' accordingly.
2397 (if (< (point-min) c-state-point-min
)
2398 ;; If point-min has MOVED BACKWARDS then we drop the state completely.
2399 ;; It would be possible to do a better job here and recalculate the top
2402 (c-state-mark-point-min-literal)
2403 (setq c-state-cache nil
2404 c-state-cache-good-pos c-state-min-scan-pos
2405 c-state-brace-pair-desert nil
))
2407 ;; point-min has MOVED FORWARD.
2409 ;; Is the new point-min inside a (different) literal?
2410 (unless (and c-state-point-min-lit-start
; at prev. point-min
2411 (< (point-min) (c-state-get-min-scan-pos)))
2412 (c-state-mark-point-min-literal))
2414 ;; Cut off a bit of the tail from `c-state-cache'.
2415 (let ((ptr (cons nil c-state-cache
))
2417 (while (and (setq pa
(c-state-cache-top-lparen (cdr ptr
)))
2418 (>= pa
(point-min)))
2419 (setq ptr
(cdr ptr
)))
2422 (if (eq (cdr ptr
) c-state-cache
)
2423 (setq c-state-cache nil
2424 c-state-cache-good-pos c-state-min-scan-pos
)
2426 (setq c-state-cache-good-pos
(1+ (c-state-cache-top-lparen))))
2429 (setq c-state-point-min
(point-min)))
2431 (defun c-append-lower-brace-pair-to-state-cache (from &optional upper-lim
)
2432 ;; If there is a brace pair preceding FROM in the buffer (not necessarily
2433 ;; immediately preceding), push a cons onto `c-state-cache' to represent it.
2434 ;; FROM must not be inside a literal. If UPPER-LIM is non-nil, we append
2435 ;; the highest brace pair whose "}" is below UPPER-LIM.
2437 ;; Return non-nil when this has been done.
2439 ;; This routine should be fast. Since it can get called a LOT, we maintain
2440 ;; `c-state-brace-pair-desert', a small cache of "failures", such that we
2441 ;; reduce the time wasted in repeated fruitless searches in brace deserts.
2444 (let ((bra from
) ce
; Positions of "{" and "}".
2446 (cache-pos (c-state-cache-top-lparen)) ; might be nil.
2447 (macro-start-or-from
2448 (progn (goto-char from
)
2449 (c-beginning-of-macro)
2451 (or upper-lim
(setq upper-lim from
))
2453 ;; If we're essentially repeating a fruitless search, just give up.
2454 (unless (and c-state-brace-pair-desert
2455 (eq cache-pos
(car c-state-brace-pair-desert
))
2456 (<= from
(cdr c-state-brace-pair-desert
)))
2457 ;; Only search what we absolutely need to:
2458 (if (and c-state-brace-pair-desert
2459 (> from
(cdr c-state-brace-pair-desert
)))
2460 (narrow-to-region (cdr c-state-brace-pair-desert
) (point-max)))
2462 ;; In the next pair of nested loops, the inner one moves back past a
2463 ;; pair of (mis-)matching parens or brackets; the outer one moves
2464 ;; back over a sequence of unmatched close brace/paren/bracket each
2470 (and (setq ce
(scan-lists bra -
1 -
1)) ; back past )/]/}; might signal
2471 (setq bra
(scan-lists ce -
1 1)) ; back past (/[/{; might signal
2472 (or (> ce upper-lim
)
2473 (not (eq (char-after bra
) ?\
{))
2474 (and (goto-char bra
)
2475 (c-beginning-of-macro)
2476 (< (point) macro-start-or-from
))))))
2477 (and ce
(< ce bra
)))
2478 (setq bra ce
)) ; If we just backed over an unbalanced closing
2481 (if (and ce
(< bra ce
) (eq (char-after bra
) ?\
{))
2482 ;; We've found the desired brace-pair.
2484 (setq new-cons
(cons bra
(1+ ce
)))
2486 ((consp (car c-state-cache
))
2487 (setcar c-state-cache new-cons
))
2488 ((and (numberp (car c-state-cache
)) ; probably never happens
2489 (< ce
(car c-state-cache
)))
2490 (setcdr c-state-cache
2491 (cons new-cons
(cdr c-state-cache
))))
2492 (t (setq c-state-cache
(cons new-cons c-state-cache
)))))
2494 ;; We haven't found a brace pair. Record this.
2495 (setq c-state-brace-pair-desert
(cons cache-pos from
))))))))
2497 (defsubst c-state-push-any-brace-pair
(bra+1 macro-start-or-here
)
2498 ;; If BRA+1 is nil, do nothing. Otherwise, BRA+1 is the buffer position
2499 ;; following a {, and that brace has a (mis-)matching } (or ]), and we
2500 ;; "push" "a" brace pair onto `c-state-cache'.
2502 ;; Here "push" means overwrite the top element if it's itself a brace-pair,
2503 ;; otherwise push it normally.
2505 ;; The brace pair we push is normally the one surrounding BRA+1, but if the
2506 ;; latter is inside a macro, not being a macro containing
2507 ;; MACRO-START-OR-HERE, we scan backwards through the buffer for a non-macro
2508 ;; base pair. This latter case is assumed to be rare.
2510 ;; Note: POINT is not preserved in this routine.
2512 (if (or (> bra
+1 macro-start-or-here
)
2513 (progn (goto-char bra
+1)
2514 (not (c-beginning-of-macro))))
2516 (cons (cons (1- bra
+1)
2517 (scan-lists bra
+1 1 1))
2518 (if (consp (car c-state-cache
))
2521 ;; N.B. This defsubst codes one method for the simple, normal case,
2522 ;; and a more sophisticated, slower way for the general case. Don't
2523 ;; eliminate this defsubst - it's a speed optimisation.
2524 (c-append-lower-brace-pair-to-state-cache (1- bra
+1)))))
2526 (defun c-append-to-state-cache (from)
2527 ;; Scan the buffer from FROM to (point-max), adding elements into
2528 ;; `c-state-cache' for braces etc. Return a candidate for
2529 ;; `c-state-cache-good-pos'.
2531 ;; FROM must be after the latest brace/paren/bracket in `c-state-cache', if
2532 ;; any. Typically, it is immediately after it. It must not be inside a
2534 (let ((here-bol (c-point 'bol
(point-max)))
2535 (macro-start-or-here
2536 (save-excursion (goto-char (point-max))
2537 (if (c-beginning-of-macro)
2540 pa
+1 ; pos just after an opening PAren (or brace).
2541 (ren+1 from
) ; usually a pos just after an closing paREN etc.
2542 ; Is actually the pos. to scan for a (/{/[ from,
2543 ; which sometimes is after a silly )/}/].
2544 paren
+1 ; Pos after some opening or closing paren.
2545 paren
+1s
; A list of `paren+1's; used to determine a
2547 bra
+1 ce
+1 ; just after L/R bra-ces.
2548 bra
+1s
; list of OLD values of bra+1.
2549 mstart
) ; start of a macro.
2552 ;; Each time round the following loop, we enter a succesively deeper
2553 ;; level of brace/paren nesting. (Except sometimes we "continue at
2554 ;; the existing level".) `pa+1' is a pos inside an opening
2555 ;; brace/paren/bracket, usually just after it.
2558 ;; Each time round the next loop moves forward over an opening then
2559 ;; a closing brace/bracket/paren. This loop is white hot, so it
2560 ;; plays ugly tricks to go fast. DON'T PUT ANYTHING INTO THIS
2561 ;; LOOP WHICH ISN'T ABSOLUTELY NECESSARY!!! It terminates when a
2562 ;; call of `scan-lists' signals an error, which happens when there
2563 ;; are no more b/b/p's to scan.
2566 (setq pa
+1 (scan-lists ren
+1 1 -
1) ; Into (/{/[; might signal
2567 paren
+1s
(cons pa
+1 paren
+1s
))
2568 (setq ren
+1 (scan-lists pa
+1 1 1)) ; Out of )/}/]; might signal
2569 (if (and (eq (char-before pa
+1) ?
{)) ; Check for a macro later.
2571 (setcar paren
+1s ren
+1)))
2573 (if (and pa
+1 (> pa
+1 ren
+1))
2574 ;; We've just entered a deeper nesting level.
2576 ;; Insert the brace pair (if present) and the single open
2577 ;; paren/brace/bracket into `c-state-cache' It cannot be
2578 ;; inside a macro, except one around point, because of what
2579 ;; `c-neutralize-syntax-in-CPP' has done.
2580 (c-state-push-any-brace-pair bra
+1 macro-start-or-here
)
2581 ;; Insert the opening brace/bracket/paren position.
2582 (setq c-state-cache
(cons (1- pa
+1) c-state-cache
))
2583 ;; Clear admin stuff for the next more nested part of the scan.
2584 (setq ren
+1 pa
+1 pa
+1 nil bra
+1 nil bra
+1s nil
)
2585 t
) ; Carry on the loop
2587 ;; All open p/b/b's at this nesting level, if any, have probably
2588 ;; been closed by matching/mismatching ones. We're probably
2589 ;; finished - we just need to check for having found an
2590 ;; unmatched )/}/], which we ignore. Such a )/}/] can't be in a
2591 ;; macro, due the action of `c-neutralize-syntax-in-CPP'.
2592 (c-safe (setq ren
+1 (scan-lists ren
+1 1 1)))))) ; acts as loop control.
2594 ;; Record the final, innermost, brace-pair if there is one.
2595 (c-state-push-any-brace-pair bra
+1 macro-start-or-here
)
2597 ;; Determine a good pos
2598 (while (and (setq paren
+1 (car paren
+1s
))
2599 (> (if (> paren
+1 macro-start-or-here
)
2602 (setq mstart
(and (c-beginning-of-macro)
2604 (or mstart paren
+1))
2606 (setq paren
+1s
(cdr paren
+1s
)))
2608 ((and paren
+1 mstart
)
2609 (min paren
+1 mstart
))
2613 (defun c-remove-stale-state-cache (good-pos pps-point
)
2614 ;; Remove stale entries from the `c-cache-state', i.e. those which will
2615 ;; not be in it when it is amended for position (point-max).
2616 ;; Additionally, the "outermost" open-brace entry before (point-max)
2617 ;; will be converted to a cons if the matching close-brace is scanned.
2619 ;; GOOD-POS is a "maximal" "safe position" - there must be no open
2620 ;; parens/braces/brackets between GOOD-POS and (point-max).
2622 ;; As a second thing, calculate the result of parse-partial-sexp at
2623 ;; PPS-POINT, w.r.t. GOOD-POS. The motivation here is that
2624 ;; `c-state-cache-good-pos' may become PPS-POINT, but the caller may need to
2625 ;; adjust it to get outside a string/comment. (Sorry about this! The code
2626 ;; needs to be FAST).
2628 ;; Return a list (GOOD-POS SCAN-BACK-POS PPS-STATE), where
2629 ;; o - GOOD-POS is a position where the new value `c-state-cache' is known
2630 ;; to be good (we aim for this to be as high as possible);
2631 ;; o - SCAN-BACK-POS, if not nil, indicates there may be a brace pair
2632 ;; preceding POS which needs to be recorded in `c-state-cache'. It is a
2633 ;; position to scan backwards from.
2634 ;; o - PPS-STATE is the parse-partial-sexp state at PPS-POINT.
2636 (narrow-to-region 1 (point-max))
2638 (let* ((in-macro-start ; start of macro containing (point-max) or nil.
2640 (goto-char (point-max))
2641 (and (c-beginning-of-macro)
2643 (good-pos-actual-macro-start ; Start of macro containing good-pos
2645 (and (< good-pos
(point-max))
2647 (goto-char good-pos
)
2648 (and (c-beginning-of-macro)
2650 (good-pos-actual-macro-end ; End of this macro, (maybe
2651 ; (point-max)), or nil.
2652 (and good-pos-actual-macro-start
2654 (goto-char good-pos-actual-macro-start
)
2657 pps-state
; Will be 9 or 10 elements long.
2659 upper-lim
; ,beyond which `c-state-cache' entries are removed
2661 pair-beg pps-point-state target-depth
)
2663 ;; Remove entries beyond (point-max). Also remove any entries inside
2664 ;; a macro, unless (point-max) is in the same macro.
2666 (if (or (null c-state-old-cpp-beg
)
2667 (and (> (point-max) c-state-old-cpp-beg
)
2668 (< (point-max) c-state-old-cpp-end
)))
2670 (min (point-max) c-state-old-cpp-beg
)))
2671 (while (and c-state-cache
(>= (c-state-cache-top-lparen) upper-lim
))
2672 (setq c-state-cache
(cdr c-state-cache
)))
2673 ;; If `upper-lim' is inside the last recorded brace pair, remove its
2674 ;; RBrace and indicate we'll need to search backwards for a previous
2676 (when (and c-state-cache
2677 (consp (car c-state-cache
))
2678 (> (cdar c-state-cache
) upper-lim
))
2679 (setcar c-state-cache
(caar c-state-cache
))
2680 (setq scan-back-pos
(car c-state-cache
)))
2682 ;; The next loop jumps forward out of a nested level of parens each
2683 ;; time round; the corresponding elements in `c-state-cache' are
2684 ;; removed. `pos' is just after the brace-pair or the open paren at
2685 ;; (car c-state-cache). There can be no open parens/braces/brackets
2686 ;; between `good-pos'/`good-pos-actual-macro-start' and (point-max),
2687 ;; due to the interface spec to this function.
2688 (setq pos
(if (and good-pos-actual-macro-end
2689 (not (eq good-pos-actual-macro-start
2691 (1+ good-pos-actual-macro-end
) ; get outside the macro as
2692 ; marked by a `category' text property.
2695 (while (and c-state-cache
2696 (< (point) (point-max)))
2698 ((null pps-state
) ; first time through
2699 (setq target-depth -
1))
2700 ((eq (car pps-state
) target-depth
) ; found closing ),},]
2701 (setq target-depth
(1- (car pps-state
))))
2702 ;; Do nothing when we've merely reached pps-point.
2708 (point) (if (< (point) pps-point
) pps-point
(point-max))
2712 (if (= (point) pps-point
)
2713 (setq pps-point-state pps-state
))
2715 (when (eq (car pps-state
) target-depth
)
2716 (setq pos
(point)) ; POS is now just after an R-paren/brace.
2718 ((and (consp (car c-state-cache
))
2719 (eq (point) (cdar c-state-cache
)))
2720 ;; We've just moved out of the paren pair containing the brace-pair
2721 ;; at (car c-state-cache). `pair-beg' is where the open paren is,
2722 ;; and is potentially where the open brace of a cons in
2723 ;; c-state-cache will be.
2724 (setq pair-beg
(car-safe (cdr c-state-cache
))
2725 c-state-cache
(cdr-safe (cdr c-state-cache
)))) ; remove {}pair + containing Lparen.
2726 ((numberp (car c-state-cache
))
2727 (setq pair-beg
(car c-state-cache
)
2728 c-state-cache
(cdr c-state-cache
))) ; remove this
2730 ((numberp (cadr c-state-cache
))
2731 (setq pair-beg
(cadr c-state-cache
)
2732 c-state-cache
(cddr c-state-cache
))) ; Remove a paren pair
2733 ; together with enclosed brace pair.
2734 ;; (t nil) ; Ignore an unmated Rparen.
2737 (if (< (point) pps-point
)
2738 (setq pps-state
(parse-partial-sexp (point) pps-point
2739 nil nil
; TARGETDEPTH, STOPBEFORE
2742 ;; If the last paren pair we moved out of was actually a brace pair,
2743 ;; insert it into `c-state-cache'.
2744 (when (and pair-beg
(eq (char-after pair-beg
) ?
{))
2745 (if (consp (car-safe c-state-cache
))
2746 (setq c-state-cache
(cdr c-state-cache
)))
2747 (setq c-state-cache
(cons (cons pair-beg pos
)
2750 (list pos scan-back-pos pps-state
)))))
2752 (defun c-remove-stale-state-cache-backwards (here cache-pos
)
2753 ;; Strip stale elements of `c-state-cache' by moving backwards through the
2754 ;; buffer, and inform the caller of the scenario detected.
2756 ;; HERE is the position we're setting `c-state-cache' for.
2757 ;; CACHE-POS is just after the latest recorded position in `c-state-cache'
2758 ;; before HERE, or a position at or near point-min which isn't in a
2761 ;; This function must only be called only when (> `c-state-cache-good-pos'
2762 ;; HERE). Usually the gap between CACHE-POS and HERE is large. It is thus
2763 ;; optimised to eliminate (or minimise) scanning between these two
2766 ;; Return a three element list (GOOD-POS SCAN-BACK-POS FWD-FLAG), where:
2767 ;; o - GOOD-POS is a "good position", where `c-state-cache' is valid, or
2768 ;; could become so after missing elements are inserted into
2769 ;; `c-state-cache'. This is JUST AFTER an opening or closing
2770 ;; brace/paren/bracket which is already in `c-state-cache' or just before
2771 ;; one otherwise. exceptionally (when there's no such b/p/b handy) the BOL
2772 ;; before `here''s line, or the start of the literal containing it.
2773 ;; o - SCAN-BACK-POS, if non-nil, indicates there may be a brace pair
2774 ;; preceding POS which isn't recorded in `c-state-cache'. It is a position
2775 ;; to scan backwards from.
2776 ;; o - FWD-FLAG, if non-nil, indicates there may be parens/braces between
2777 ;; POS and HERE which aren't recorded in `c-state-cache'.
2779 ;; The comments in this defun use "paren" to mean parenthesis or square
2780 ;; bracket (as contrasted with a brace), and "(" and ")" likewise.
2782 ;; . {..} (..) (..) ( .. { } ) (...) ( .... . ..)
2784 ;; CP E here D C good
2785 (let ((pos c-state-cache-good-pos
)
2786 pa ren
; positions of "(" and ")"
2787 dropped-cons
; whether the last element dropped from `c-state-cache'
2788 ; was a cons (representing a brace-pair)
2789 good-pos
; see above.
2790 lit
; (START . END) of a literal containing some point.
2791 here-lit-start here-lit-end
; bounds of literal containing `here'
2793 here- here
+ ; start/end of macro around HERE, or HERE
2794 (here-bol (c-point 'bol here
))
2795 (too-far-back (max (- here c-state-cache-too-far
) 1)))
2797 ;; Remove completely irrelevant entries from `c-state-cache'.
2798 (while (and c-state-cache
2799 (>= (setq pa
(c-state-cache-top-lparen)) here
))
2800 (setq dropped-cons
(consp (car c-state-cache
)))
2801 (setq c-state-cache
(cdr c-state-cache
))
2803 ;; At this stage, (> pos here);
2804 ;; (< (c-state-cache-top-lparen) here) (or is nil).
2807 ((and (consp (car c-state-cache
))
2808 (> (cdar c-state-cache
) here
))
2809 ;; CASE 1: The top of the cache is a brace pair which now encloses
2810 ;; `here'. As good-pos, return the address. of the "{". Since we've no
2811 ;; knowledge of what's inside these braces, we have no alternative but
2812 ;; to direct the caller to scan the buffer from the opening brace.
2813 (setq pos
(caar c-state-cache
))
2814 (setcar c-state-cache pos
)
2815 (list (1+ pos
) pos t
)) ; return value. We've just converted a brace pair
2816 ; entry into a { entry, so the caller needs to
2817 ; search for a brace pair before the {.
2819 ;; `here' might be inside a literal. Check for this.
2821 (setq lit
(c-state-literal-at here
)
2822 here-lit-start
(or (car lit
) here
)
2823 here-lit-end
(or (cdr lit
) here
))
2824 ;; Has `here' just "newly entered" a macro?
2826 (goto-char here-lit-start
)
2827 (if (and (c-beginning-of-macro)
2828 (or (null c-state-old-cpp-beg
)
2829 (not (= (point) c-state-old-cpp-beg
))))
2831 (setq here-
(point))
2833 (setq here
+ (point)))
2834 (setq here- here-lit-start
2835 here
+ here-lit-end
)))
2837 ;; `here' might be nested inside any depth of parens (or brackets but
2838 ;; not braces). Scan backwards to find the outermost such opening
2839 ;; paren, if there is one. This will be the scan position to return.
2841 (narrow-to-region cache-pos
(point-max))
2842 (setq pos
(c-state-balance-parens-backwards here- here
+ pos
)))
2843 nil
)) ; for the cond
2845 ((< pos here-lit-start
)
2846 ;; CASE 2: Address of outermost ( or [ which now encloses `here', but
2847 ;; didn't enclose the (previous) `c-state-cache-good-pos'. If there is
2848 ;; a brace pair preceding this, it will already be in `c-state-cache',
2849 ;; unless there was a brace pair after it, i.e. there'll only be one to
2850 ;; scan for if we've just deleted one.
2851 (list pos
(and dropped-cons pos
) t
)) ; Return value.
2853 ;; `here' isn't enclosed in a (previously unrecorded) bracket/paren.
2854 ;; Further forward scanning isn't needed, but we still need to find a
2855 ;; GOOD-POS. Step out of all enclosing "("s on HERE's line.
2858 (narrow-to-region here-bol
(point-max))
2859 (setq pos here-lit-start
)
2860 (c-safe (while (setq pa
(scan-lists pos -
1 1))
2861 (setq pos pa
)))) ; might signal
2862 nil
)) ; for the cond
2864 ((setq ren
(c-safe-scan-lists pos -
1 -
1 too-far-back
))
2865 ;; CASE 3: After a }/)/] before `here''s BOL.
2866 (list (1+ ren
) (and dropped-cons pos
) nil
)) ; Return value
2869 ;; CASE 4; Best of a bad job: BOL before `here-bol', or beginning of
2870 ;; literal containing it.
2871 (setq good-pos
(c-state-lit-beg (c-point 'bopl here-bol
)))
2872 (list good-pos
(and dropped-cons good-pos
) nil
)))))
2875 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2876 ;; Externally visible routines.
2878 (defun c-state-cache-init ()
2879 (setq c-state-cache nil
2880 c-state-cache-good-pos
1
2881 c-state-nonlit-pos-cache nil
2882 c-state-nonlit-pos-cache-limit
1
2883 c-state-brace-pair-desert nil
2885 c-state-point-min-lit-type nil
2886 c-state-point-min-lit-start nil
2887 c-state-min-scan-pos
1
2888 c-state-old-cpp-beg nil
2889 c-state-old-cpp-end nil
)
2890 (c-state-mark-point-min-literal))
2892 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2893 ;; Debugging routines to dump `c-state-cache' in a "replayable" form.
2894 ;; (defmacro c-sc-de (elt) ; "c-state-cache-dump-element"
2895 ;; `(format ,(concat "(setq " (symbol-name elt) " %s) ") ,elt))
2896 ;; (defmacro c-sc-qde (elt) ; "c-state-cache-quote-dump-element"
2897 ;; `(format ,(concat "(setq " (symbol-name elt) " '%s) ") ,elt))
2898 ;; (defun c-state-dump ()
2899 ;; ;; For debugging.
2902 ;; (c-sc-qde c-state-cache)
2903 ;; (c-sc-de c-state-cache-good-pos)
2904 ;; (c-sc-qde c-state-nonlit-pos-cache)
2905 ;; (c-sc-de c-state-nonlit-pos-cache-limit)
2906 ;; (c-sc-qde c-state-brace-pair-desert)
2907 ;; (c-sc-de c-state-point-min)
2908 ;; (c-sc-de c-state-point-min-lit-type)
2909 ;; (c-sc-de c-state-point-min-lit-start)
2910 ;; (c-sc-de c-state-min-scan-pos)
2911 ;; (c-sc-de c-state-old-cpp-beg)
2912 ;; (c-sc-de c-state-old-cpp-end)))
2913 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2915 (defun c-invalidate-state-cache-1 (here)
2916 ;; Invalidate all info on `c-state-cache' that applies to the buffer at HERE
2917 ;; or higher and set `c-state-cache-good-pos' accordingly. The cache is
2918 ;; left in a consistent state.
2920 ;; This is much like `c-whack-state-after', but it never changes a paren
2921 ;; pair element into an open paren element. Doing that would mean that the
2922 ;; new open paren wouldn't have the required preceding paren pair element.
2924 ;; This function is called from c-after-change.
2926 ;; The cache of non-literals:
2927 (if (< here c-state-nonlit-pos-cache-limit
)
2928 (setq c-state-nonlit-pos-cache-limit here
))
2931 ;; Case 1: if `here' is in a literal containing point-min, everything
2932 ;; becomes (or is already) nil.
2933 (if (or (null c-state-cache-good-pos
)
2934 (< here
(c-state-get-min-scan-pos)))
2935 (setq c-state-cache nil
2936 c-state-cache-good-pos nil
2937 c-state-min-scan-pos nil
)
2939 ;;; Truncate `c-state-cache' and set `c-state-cache-good-pos' to a value below
2940 ;;; `here'. To maintain its consistency, we may need to insert a new brace
2942 (let ((here-bol (c-point 'bol here
))
2943 too-high-pa
; recorded {/(/[ next above here, or nil.
2944 dropped-cons
; was the last removed element a brace pair?
2946 ;; The easy bit - knock over-the-top bits off `c-state-cache'.
2947 (while (and c-state-cache
2948 (>= (setq pa
(c-state-cache-top-paren)) here
))
2949 (setq dropped-cons
(consp (car c-state-cache
))
2950 too-high-pa
(c-state-cache-top-lparen)
2951 c-state-cache
(cdr c-state-cache
)))
2953 ;; Do we need to add in an earlier brace pair, having lopped one off?
2954 (if (and dropped-cons
2955 (< too-high-pa
(+ here c-state-cache-too-far
)))
2956 (c-append-lower-brace-pair-to-state-cache too-high-pa here-bol
))
2957 (setq c-state-cache-good-pos
(or (c-state-cache-after-top-paren)
2958 (c-state-get-min-scan-pos)))))
2960 ;; The brace-pair desert marker:
2961 (when (car c-state-brace-pair-desert
)
2962 (if (< here
(car c-state-brace-pair-desert
))
2963 (setq c-state-brace-pair-desert nil
)
2964 (if (< here
(cdr c-state-brace-pair-desert
))
2965 (setcdr c-state-brace-pair-desert here
)))))
2967 (defun c-parse-state-1 ()
2968 ;; Find and record all noteworthy parens between some good point earlier in
2969 ;; the file and point. That good point is at least the beginning of the
2970 ;; top-level construct we are in, or the beginning of the preceding
2971 ;; top-level construct if we aren't in one.
2973 ;; The returned value is a list of the noteworthy parens with the last one
2974 ;; first. If an element in the list is an integer, it's the position of an
2975 ;; open paren (of any type) which has not been closed before the point. If
2976 ;; an element is a cons, it gives the position of a closed BRACE paren
2977 ;; pair[*]; the car is the start brace position and the cdr is the position
2978 ;; following the closing brace. Only the last closed brace paren pair
2979 ;; before each open paren and before the point is recorded, and thus the
2980 ;; state never contains two cons elements in succession. When a close brace
2981 ;; has no matching open brace (e.g., the matching brace is outside the
2982 ;; visible region), it is not represented in the returned value.
2984 ;; [*] N.B. The close "brace" might be a mismatching close bracket or paren.
2985 ;; This defun explicitly treats mismatching parens/braces/brackets as
2986 ;; matching. It is the open brace which makes it a "brace" pair.
2988 ;; If POINT is within a macro, open parens and brace pairs within
2989 ;; THIS macro MIGHT be recorded. This depends on whether their
2990 ;; syntactic properties have been suppressed by
2991 ;; `c-neutralize-syntax-in-CPP'. This might need fixing (2008-12-11).
2993 ;; Currently no characters which are given paren syntax with the
2994 ;; syntax-table property are recorded, i.e. angle bracket arglist
2995 ;; parens are never present here. Note that this might change.
2997 ;; BUG: This function doesn't cope entirely well with unbalanced
2998 ;; parens in macros. (2008-12-11: this has probably been resolved
2999 ;; by the function `c-neutralize-syntax-in-CPP'.) E.g. in the
3000 ;; following case the brace before the macro isn't balanced with the
3007 ;; Note to maintainers: this function DOES get called with point
3008 ;; within comments and strings, so don't assume it doesn't!
3010 ;; This function might do hidden buffer changes.
3011 (let* ((here (point))
3012 (here-bopl (c-point 'bopl
))
3013 strategy
; 'forward, 'backward etc..
3014 ;; Candidate positions to start scanning from:
3015 cache-pos
; highest position below HERE already existing in
3021 scan-backward-pos scan-forward-p
) ; used for 'backward.
3022 ;; If POINT-MIN has changed, adjust the cache
3023 (unless (= (point-min) c-state-point-min
)
3024 (c-renarrow-state-cache))
3027 (setq res
(c-parse-state-get-strategy here c-state-cache-good-pos
)
3029 cache-pos
(cadr res
)
3030 start-point
(nth 2 res
))
3032 (when (eq strategy
'BOD
)
3033 (setq c-state-cache nil
3034 c-state-cache-good-pos start-point
))
3039 ((memq strategy
'(forward BOD
))
3040 (narrow-to-region (point-min) here
)
3041 (setq res
(c-remove-stale-state-cache start-point here-bopl
))
3042 (setq cache-pos
(car res
)
3043 scan-backward-pos
(cadr res
)
3044 bopl-state
(car (cddr res
))) ; will be nil if (< here-bopl
3046 (if scan-backward-pos
3047 (c-append-lower-brace-pair-to-state-cache scan-backward-pos
))
3049 (c-append-to-state-cache cache-pos
))
3050 (setq c-state-cache-good-pos
3052 (< good-pos
(- here c-state-cache-too-far
)))
3053 (c-state-cache-non-literal-place here-bopl bopl-state
)
3056 ((eq strategy
'backward
)
3057 (setq res
(c-remove-stale-state-cache-backwards here cache-pos
)
3059 scan-backward-pos
(cadr res
)
3060 scan-forward-p
(car (cddr res
)))
3061 (if scan-backward-pos
3062 (c-append-lower-brace-pair-to-state-cache
3064 (setq c-state-cache-good-pos
3066 (progn (narrow-to-region (point-min) here
)
3067 (c-append-to-state-cache good-pos
))
3069 (c-get-cache-scan-pos good-pos
))))
3071 (t ; (eq strategy 'IN-LIT)
3072 (setq c-state-cache nil
3073 c-state-cache-good-pos nil
)))))
3077 (defun c-invalidate-state-cache (here)
3078 ;; This is a wrapper over `c-invalidate-state-cache-1'.
3080 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3081 ;; of all parens in preprocessor constructs, except for any such construct
3082 ;; containing point. We can then call `c-invalidate-state-cache-1' without
3083 ;; worrying further about macros and template delimiters.
3084 (c-with-<-
>-as-parens-suppressed
3085 (if (and c-state-old-cpp-beg
3086 (< c-state-old-cpp-beg here
))
3087 (c-with-all-but-one-cpps-commented-out
3089 (min c-state-old-cpp-end here
)
3090 (c-invalidate-state-cache-1 here
))
3091 (c-with-cpps-commented-out
3092 (c-invalidate-state-cache-1 here
)))))
3094 (defun c-parse-state ()
3095 ;; This is a wrapper over `c-parse-state-1'. See that function for a
3096 ;; description of the functionality and return value.
3098 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3099 ;; of all parens in preprocessor constructs, except for any such construct
3100 ;; containing point. We can then call `c-parse-state-1' without worrying
3101 ;; further about macros and template delimiters.
3102 (let (here-cpp-beg here-cpp-end
)
3104 (when (c-beginning-of-macro)
3105 (setq here-cpp-beg
(point))
3107 (> (setq here-cpp-end
(c-syntactic-end-of-macro))
3109 (setq here-cpp-beg nil here-cpp-end nil
))))
3110 ;; FIXME!!! Put in a `condition-case' here to protect the integrity of the
3113 (c-with-<-
>-as-parens-suppressed
3114 (if (and here-cpp-beg
(> here-cpp-end here-cpp-beg
))
3115 (c-with-all-but-one-cpps-commented-out
3116 here-cpp-beg here-cpp-end
3118 (c-with-cpps-commented-out
3119 (c-parse-state-1))))
3120 (setq c-state-old-cpp-beg
(and here-cpp-beg
(copy-marker here-cpp-beg t
))
3121 c-state-old-cpp-end
(and here-cpp-end
(copy-marker here-cpp-end t
)))
3124 ;; Debug tool to catch cache inconsistencies. This is called from
3126 (defvar c-debug-parse-state nil
)
3127 (unless (fboundp 'c-real-parse-state
)
3128 (fset 'c-real-parse-state
(symbol-function 'c-parse-state
)))
3129 (cc-bytecomp-defun c-real-parse-state)
3130 (defun c-debug-parse-state ()
3131 (let ((here (point)) (res1 (c-real-parse-state)) res2
)
3132 (let ((c-state-cache nil
)
3133 (c-state-cache-good-pos 1)
3134 (c-state-nonlit-pos-cache nil
)
3135 (c-state-nonlit-pos-cache-limit 1)
3136 (c-state-brace-pair-desert nil
)
3137 (c-state-point-min 1)
3138 (c-state-point-min-lit-type nil
)
3139 (c-state-point-min-lit-start nil
)
3140 (c-state-min-scan-pos 1)
3141 (c-state-old-cpp-beg nil
)
3142 (c-state-old-cpp-end nil
))
3143 (setq res2
(c-real-parse-state)))
3144 (unless (equal res1 res2
)
3145 ;; The cache can actually go further back due to the ad-hoc way
3146 ;; the first paren is found, so try to whack off a bit of its
3147 ;; start before complaining.
3149 (goto-char (or (c-least-enclosing-brace res2
) (point)))
3150 (c-beginning-of-defun-1)
3151 (while (not (or (bobp) (eq (char-after) ?
{)))
3152 (c-beginning-of-defun-1))
3153 (unless (equal (c-whack-state-before (point) res1
) res2
)
3154 (message (concat "c-parse-state inconsistency at %s: "
3155 "using cache: %s, from scratch: %s")
3159 (defun c-toggle-parse-state-debug (&optional arg
)
3161 (setq c-debug-parse-state
(c-calculate-state arg c-debug-parse-state
))
3162 (fset 'c-parse-state
(symbol-function (if c-debug-parse-state
3163 'c-debug-parse-state
3164 'c-real-parse-state
)))
3165 (c-keep-region-active))
3166 (when c-debug-parse-state
3167 (c-toggle-parse-state-debug 1))
3170 (defun c-whack-state-before (bufpos paren-state
)
3171 ;; Whack off any state information from PAREN-STATE which lies
3172 ;; before BUFPOS. Not destructive on PAREN-STATE.
3173 (let* ((newstate (list nil
))
3177 (setq car
(car paren-state
)
3178 paren-state
(cdr paren-state
))
3179 (if (< (if (consp car
) (car car
) car
) bufpos
)
3180 (setq paren-state nil
)
3181 (setcdr ptr
(list car
))
3182 (setq ptr
(cdr ptr
))))
3185 (defun c-whack-state-after (bufpos paren-state
)
3186 ;; Whack off any state information from PAREN-STATE which lies at or
3187 ;; after BUFPOS. Not destructive on PAREN-STATE.
3190 (let ((car (car paren-state
)))
3192 ;; just check the car, because in a balanced brace
3193 ;; expression, it must be impossible for the corresponding
3194 ;; close brace to be before point, but the open brace to
3196 (if (<= bufpos
(car car
))
3198 (if (< bufpos
(cdr car
))
3199 ;; its possible that the open brace is before
3200 ;; bufpos, but the close brace is after. In that
3201 ;; case, convert this to a non-cons element. The
3202 ;; rest of the state is before bufpos, so we're
3204 (throw 'done
(cons (car car
) (cdr paren-state
)))
3205 ;; we know that both the open and close braces are
3206 ;; before bufpos, so we also know that everything else
3207 ;; on state is before bufpos.
3208 (throw 'done paren-state
)))
3211 ;; it's before bufpos, so everything else should too.
3212 (throw 'done paren-state
)))
3213 (setq paren-state
(cdr paren-state
)))
3216 (defun c-most-enclosing-brace (paren-state &optional bufpos
)
3217 ;; Return the bufpos of the innermost enclosing open paren before
3218 ;; bufpos, or nil if none was found.
3220 (or bufpos
(setq bufpos
134217727))
3222 (setq enclosingp
(car paren-state
)
3223 paren-state
(cdr paren-state
))
3224 (if (or (consp enclosingp
)
3225 (>= enclosingp bufpos
))
3226 (setq enclosingp nil
)
3227 (setq paren-state nil
)))
3230 (defun c-least-enclosing-brace (paren-state)
3231 ;; Return the bufpos of the outermost enclosing open paren, or nil
3232 ;; if none was found.
3235 (setq elem
(car paren-state
)
3236 paren-state
(cdr paren-state
))
3241 (defun c-safe-position (bufpos paren-state
)
3242 ;; Return the closest "safe" position recorded on PAREN-STATE that
3243 ;; is higher up than BUFPOS. Return nil if PAREN-STATE doesn't
3244 ;; contain any. Return nil if BUFPOS is nil, which is useful to
3245 ;; find the closest limit before a given limit that might be nil.
3247 ;; A "safe" position is a position at or after a recorded open
3248 ;; paren, or after a recorded close paren. The returned position is
3249 ;; thus either the first position after a close brace, or the first
3250 ;; position after an enclosing paren, or at the enclosing paren in
3251 ;; case BUFPOS is immediately after it.
3256 (setq elem
(car paren-state
))
3258 (cond ((< (cdr elem
) bufpos
)
3259 (throw 'done
(cdr elem
)))
3260 ((< (car elem
) bufpos
)
3262 (throw 'done
(min (1+ (car elem
)) bufpos
))))
3264 ;; elem is the position at and not after the opening paren, so
3265 ;; we can go forward one more step unless it's equal to
3266 ;; bufpos. This is useful in some cases avoid an extra paren
3267 ;; level between the safe position and bufpos.
3268 (throw 'done
(min (1+ elem
) bufpos
))))
3269 (setq paren-state
(cdr paren-state
)))))))
3271 (defun c-beginning-of-syntax ()
3272 ;; This is used for `font-lock-beginning-of-syntax-function'. It
3273 ;; goes to the closest previous point that is known to be outside
3274 ;; any string literal or comment. `c-state-cache' is used if it has
3275 ;; a position in the vicinity.
3276 (let* ((paren-state c-state-cache
)
3280 ;; Note: Similar code in `c-safe-position'. The
3281 ;; difference is that we accept a safe position at
3282 ;; the point and don't bother to go forward past open
3285 (setq elem
(car paren-state
))
3287 (cond ((<= (cdr elem
) (point))
3288 (throw 'done
(cdr elem
)))
3289 ((<= (car elem
) (point))
3290 (throw 'done
(car elem
))))
3291 (if (<= elem
(point))
3292 (throw 'done elem
)))
3293 (setq paren-state
(cdr paren-state
)))
3296 (if (> pos
(- (point) 4000))
3298 ;; The position is far back. Try `c-beginning-of-defun-1'
3299 ;; (although we can't be entirely sure it will go to a position
3300 ;; outside a comment or string in current emacsen). FIXME:
3301 ;; Consult `syntax-ppss' here.
3302 (c-beginning-of-defun-1)
3307 ;; Tools for scanning identifiers and other tokens.
3309 (defun c-on-identifier ()
3310 "Return non-nil if the point is on or directly after an identifier.
3311 Keywords are recognized and not considered identifiers. If an
3312 identifier is detected, the returned value is its starting position.
3313 If an identifier ends at the point and another begins at it \(can only
3314 happen in Pike) then the point for the preceding one is returned.
3316 Note that this function might do hidden buffer changes. See the
3317 comment at the start of cc-engine.el for more info."
3319 ;; FIXME: Shouldn't this function handle "operator" in C++?
3322 (skip-syntax-backward "w_")
3326 ;; Check for a normal (non-keyword) identifier.
3327 (and (looking-at c-symbol-start
)
3328 (not (looking-at c-keywords-regexp
))
3331 (when (c-major-mode-is 'pike-mode
)
3332 ;; Handle the `<operator> syntax in Pike.
3333 (let ((pos (point)))
3334 (skip-chars-backward "-!%&*+/<=>^|~[]()")
3335 (and (if (< (skip-chars-backward "`") 0)
3338 (eq (char-after) ?\
`))
3339 (looking-at c-symbol-key
)
3340 (>= (match-end 0) pos
)
3343 ;; Handle the "operator +" syntax in C++.
3344 (when (and c-overloadable-operators-regexp
3345 (= (c-backward-token-2 0) 0))
3347 (cond ((and (looking-at c-overloadable-operators-regexp
)
3348 (or (not c-opt-op-identifier-prefix
)
3349 (and (= (c-backward-token-2 1) 0)
3350 (looking-at c-opt-op-identifier-prefix
))))
3354 (and c-opt-op-identifier-prefix
3355 (looking-at c-opt-op-identifier-prefix
)
3356 (= (c-forward-token-2 1) 0)
3357 (looking-at c-overloadable-operators-regexp
)))
3362 (defsubst c-simple-skip-symbol-backward
()
3363 ;; If the point is at the end of a symbol then skip backward to the
3364 ;; beginning of it. Don't move otherwise. Return non-nil if point
3367 ;; This function might do hidden buffer changes.
3368 (or (< (skip-syntax-backward "w_") 0)
3369 (and (c-major-mode-is 'pike-mode
)
3370 ;; Handle the `<operator> syntax in Pike.
3371 (let ((pos (point)))
3372 (if (and (< (skip-chars-backward "-!%&*+/<=>^|~[]()") 0)
3373 (< (skip-chars-backward "`") 0)
3374 (looking-at c-symbol-key
)
3375 (>= (match-end 0) pos
))
3380 (defun c-beginning-of-current-token (&optional back-limit
)
3381 ;; Move to the beginning of the current token. Do not move if not
3382 ;; in the middle of one. BACK-LIMIT may be used to bound the
3383 ;; backward search; if given it's assumed to be at the boundary
3384 ;; between two tokens. Return non-nil if the point is moved, nil
3387 ;; This function might do hidden buffer changes.
3388 (let ((start (point)))
3389 (if (looking-at "\\w\\|\\s_")
3390 (skip-syntax-backward "w_" back-limit
)
3391 (when (< (skip-syntax-backward ".()" back-limit
) 0)
3392 (while (let ((pos (or (and (looking-at c-nonsymbol-token-regexp
)
3394 ;; `c-nonsymbol-token-regexp' should always match
3395 ;; since we've skipped backward over punctuator
3396 ;; or paren syntax, but consume one char in case
3397 ;; it doesn't so that we don't leave point before
3398 ;; some earlier incorrect token.
3401 (goto-char pos
))))))
3404 (defun c-end-of-current-token (&optional back-limit
)
3405 ;; Move to the end of the current token. Do not move if not in the
3406 ;; middle of one. BACK-LIMIT may be used to bound the backward
3407 ;; search; if given it's assumed to be at the boundary between two
3408 ;; tokens. Return non-nil if the point is moved, nil otherwise.
3410 ;; This function might do hidden buffer changes.
3411 (let ((start (point)))
3412 (cond ((< (skip-syntax-backward "w_" (1- start
)) 0)
3413 (skip-syntax-forward "w_"))
3414 ((< (skip-syntax-backward ".()" back-limit
) 0)
3416 (if (looking-at c-nonsymbol-token-regexp
)
3417 (goto-char (match-end 0))
3418 ;; `c-nonsymbol-token-regexp' should always match since
3419 ;; we've skipped backward over punctuator or paren
3420 ;; syntax, but move forward in case it doesn't so that
3421 ;; we don't leave point earlier than we started with.
3423 (< (point) start
)))))
3426 (defconst c-jump-syntax-balanced
3427 (if (memq 'gen-string-delim c-emacs-features
)
3428 "\\w\\|\\s_\\|\\s\(\\|\\s\)\\|\\s\"\\|\\s|"
3429 "\\w\\|\\s_\\|\\s\(\\|\\s\)\\|\\s\""))
3431 (defconst c-jump-syntax-unbalanced
3432 (if (memq 'gen-string-delim c-emacs-features
)
3433 "\\w\\|\\s_\\|\\s\"\\|\\s|"
3434 "\\w\\|\\s_\\|\\s\""))
3436 (defun c-forward-token-2 (&optional count balanced limit
)
3437 "Move forward by tokens.
3438 A token is defined as all symbols and identifiers which aren't
3439 syntactic whitespace \(note that multicharacter tokens like \"==\" are
3440 treated properly). Point is always either left at the beginning of a
3441 token or not moved at all. COUNT specifies the number of tokens to
3442 move; a negative COUNT moves in the opposite direction. A COUNT of 0
3443 moves to the next token beginning only if not already at one. If
3444 BALANCED is true, move over balanced parens, otherwise move into them.
3445 Also, if BALANCED is true, never move out of an enclosing paren.
3447 LIMIT sets the limit for the movement and defaults to the point limit.
3448 The case when LIMIT is set in the middle of a token, comment or macro
3449 is handled correctly, i.e. the point won't be left there.
3451 Return the number of tokens left to move \(positive or negative). If
3452 BALANCED is true, a move over a balanced paren counts as one. Note
3453 that if COUNT is 0 and no appropriate token beginning is found, 1 will
3454 be returned. Thus, a return value of 0 guarantees that point is at
3455 the requested position and a return value less \(without signs) than
3456 COUNT guarantees that point is at the beginning of some token.
3458 Note that this function might do hidden buffer changes. See the
3459 comment at the start of cc-engine.el for more info."
3461 (or count
(setq count
1))
3463 (- (c-backward-token-2 (- count
) balanced limit
))
3465 (let ((jump-syntax (if balanced
3466 c-jump-syntax-balanced
3467 c-jump-syntax-unbalanced
))
3472 ;; If count is zero we should jump if in the middle of a token.
3473 (c-end-of-current-token))
3476 (if limit
(narrow-to-region (point-min) limit
))
3478 (progn (c-forward-syntactic-ws) (point)))
3479 ;; Skip whitespace. Count this as a move if we did in
3481 (setq count
(max (1- count
) 0)))
3484 ;; Moved out of bounds. Make sure the returned count isn't zero.
3486 (if (zerop count
) (setq count
1))
3489 ;; Use `condition-case' to avoid having the limit tests
3496 (cond ((looking-at jump-syntax
)
3497 (goto-char (scan-sexps (point) 1))
3499 ((looking-at c-nonsymbol-token-regexp
)
3500 (goto-char (match-end 0))
3502 ;; `c-nonsymbol-token-regexp' above should always
3503 ;; match if there are correct tokens. Try to
3504 ;; widen to see if the limit was set in the
3505 ;; middle of one, else fall back to treating
3506 ;; the offending thing as a one character token.
3510 (looking-at c-nonsymbol-token-regexp
)))
3515 (c-forward-syntactic-ws)
3518 (error (goto-char last
)))
3522 (setq count
(1+ count
)))))
3526 (defun c-backward-token-2 (&optional count balanced limit
)
3527 "Move backward by tokens.
3528 See `c-forward-token-2' for details."
3530 (or count
(setq count
1))
3532 (- (c-forward-token-2 (- count
) balanced limit
))
3534 (or limit
(setq limit
(point-min)))
3535 (let ((jump-syntax (if balanced
3536 c-jump-syntax-balanced
3537 c-jump-syntax-unbalanced
))
3541 ;; The count is zero so try to skip to the beginning of the
3544 (progn (c-beginning-of-current-token) (point)))
3545 (if (< (point) limit
)
3546 ;; The limit is inside the same token, so return 1.
3549 ;; We're not in the middle of a token. If there's
3550 ;; whitespace after the point then we must move backward,
3551 ;; so set count to 1 in that case.
3552 (and (looking-at c-syntactic-ws-start
)
3553 ;; If we're looking at a '#' that might start a cpp
3554 ;; directive then we have to do a more elaborate check.
3555 (or (/= (char-after) ?
#)
3556 (not c-opt-cpp-prefix
)
3559 (progn (beginning-of-line)
3560 (looking-at "[ \t]*")
3563 (progn (backward-char)
3564 (not (eq (char-before) ?
\\)))))))
3567 ;; Use `condition-case' to avoid having to check for buffer
3568 ;; limits in `backward-char', `scan-sexps' and `goto-char' below.
3573 (c-backward-syntactic-ws)
3575 (if (looking-at jump-syntax
)
3576 (goto-char (scan-sexps (1+ (point)) -
1))
3577 ;; This can be very inefficient if there's a long
3578 ;; sequence of operator tokens without any separation.
3579 ;; That doesn't happen in practice, anyway.
3580 (c-beginning-of-current-token))
3581 (>= (point) limit
)))
3584 (error (goto-char last
)))
3586 (if (< (point) limit
)
3591 (defun c-forward-token-1 (&optional count balanced limit
)
3592 "Like `c-forward-token-2' but doesn't treat multicharacter operator
3593 tokens like \"==\" as single tokens, i.e. all sequences of symbol
3594 characters are jumped over character by character. This function is
3595 for compatibility only; it's only a wrapper over `c-forward-token-2'."
3596 (let ((c-nonsymbol-token-regexp "\\s.\\|\\s\(\\|\\s\)"))
3597 (c-forward-token-2 count balanced limit
)))
3599 (defun c-backward-token-1 (&optional count balanced limit
)
3600 "Like `c-backward-token-2' but doesn't treat multicharacter operator
3601 tokens like \"==\" as single tokens, i.e. all sequences of symbol
3602 characters are jumped over character by character. This function is
3603 for compatibility only; it's only a wrapper over `c-backward-token-2'."
3604 (let ((c-nonsymbol-token-regexp "\\s.\\|\\s\(\\|\\s\)"))
3605 (c-backward-token-2 count balanced limit
)))
3608 ;; Tools for doing searches restricted to syntactically relevant text.
3610 (defun c-syntactic-re-search-forward (regexp &optional bound noerror
3611 paren-level not-inside-token
3612 lookbehind-submatch
)
3613 "Like `re-search-forward', but only report matches that are found
3614 in syntactically significant text. I.e. matches in comments, macros
3615 or string literals are ignored. The start point is assumed to be
3616 outside any comment, macro or string literal, or else the content of
3617 that region is taken as syntactically significant text.
3619 If PAREN-LEVEL is non-nil, an additional restriction is added to
3620 ignore matches in nested paren sexps. The search will also not go
3621 outside the current list sexp, which has the effect that if the point
3622 should be moved to BOUND when no match is found \(i.e. NOERROR is
3623 neither nil nor t), then it will be at the closing paren if the end of
3624 the current list sexp is encountered first.
3626 If NOT-INSIDE-TOKEN is non-nil, matches in the middle of tokens are
3627 ignored. Things like multicharacter operators and special symbols
3628 \(e.g. \"`()\" in Pike) are handled but currently not floating point
3631 If LOOKBEHIND-SUBMATCH is non-nil, it's taken as a number of a
3632 subexpression in REGEXP. The end of that submatch is used as the
3633 position to check for syntactic significance. If LOOKBEHIND-SUBMATCH
3634 isn't used or if that subexpression didn't match then the start
3635 position of the whole match is used instead. The \"look behind\"
3636 subexpression is never tested before the starting position, so it
3637 might be a good idea to include \\=\\= as a match alternative in it.
3639 Optimization note: Matches might be missed if the \"look behind\"
3640 subexpression can match the end of nonwhite syntactic whitespace,
3641 i.e. the end of comments or cpp directives. This since the function
3642 skips over such things before resuming the search. It's on the other
3643 hand not safe to assume that the \"look behind\" subexpression never
3644 matches syntactic whitespace.
3646 Bug: Unbalanced parens inside cpp directives are currently not handled
3647 correctly \(i.e. they don't get ignored as they should) when
3650 Note that this function might do hidden buffer changes. See the
3651 comment at the start of cc-engine.el for more info."
3653 (or bound
(setq bound
(point-max)))
3654 (if paren-level
(setq paren-level -
1))
3656 ;;(message "c-syntactic-re-search-forward %s %s %S" (point) bound regexp)
3658 (let ((start (point))
3660 ;; Start position for the last search.
3662 ;; The `parse-partial-sexp' state between the start position
3665 ;; The current position after the last state update. The next
3666 ;; `parse-partial-sexp' continues from here.
3668 ;; The position at which to check the state and the state
3669 ;; there. This is separate from `state-pos' since we might
3670 ;; need to back up before doing the next search round.
3671 check-pos check-state
3672 ;; Last position known to end a token.
3673 (last-token-end-pos (point-min))
3674 ;; Set when a valid match is found.
3681 (setq search-pos
(point))
3682 (re-search-forward regexp bound noerror
))
3685 (setq state
(parse-partial-sexp
3686 state-pos
(match-beginning 0) paren-level nil state
)
3688 (if (setq check-pos
(and lookbehind-submatch
3689 (or (not paren-level
)
3691 (match-end lookbehind-submatch
)))
3692 (setq check-state
(parse-partial-sexp
3693 state-pos check-pos paren-level nil state
))
3694 (setq check-pos state-pos
3697 ;; NOTE: If we got a look behind subexpression and get
3698 ;; an insignificant match in something that isn't
3699 ;; syntactic whitespace (i.e. strings or in nested
3700 ;; parentheses), then we can never skip more than a
3701 ;; single character from the match start position
3702 ;; (i.e. `state-pos' here) before continuing the
3703 ;; search. That since the look behind subexpression
3704 ;; might match the end of the insignificant region in
3708 ((elt check-state
7)
3709 ;; Match inside a line comment. Skip to eol. Use
3710 ;; `re-search-forward' instead of `skip-chars-forward' to get
3711 ;; the right bound behavior.
3712 (re-search-forward "[\n\r]" bound noerror
))
3714 ((elt check-state
4)
3715 ;; Match inside a block comment. Skip to the '*/'.
3716 (search-forward "*/" bound noerror
))
3718 ((and (not (elt check-state
5))
3719 (eq (char-before check-pos
) ?
/)
3720 (not (c-get-char-property (1- check-pos
) 'syntax-table
))
3721 (memq (char-after check-pos
) '(?
/ ?
*)))
3722 ;; Match in the middle of the opener of a block or line
3724 (if (= (char-after check-pos
) ?
/)
3725 (re-search-forward "[\n\r]" bound noerror
)
3726 (search-forward "*/" bound noerror
)))
3728 ;; The last `parse-partial-sexp' above might have
3729 ;; stopped short of the real check position if the end
3730 ;; of the current sexp was encountered in paren-level
3731 ;; mode. The checks above are always false in that
3732 ;; case, and since they can do better skipping in
3733 ;; lookbehind-submatch mode, we do them before
3734 ;; checking the paren level.
3737 (/= (setq tmp
(car check-state
)) 0))
3738 ;; Check the paren level first since we're short of the
3739 ;; syntactic checking position if the end of the
3740 ;; current sexp was encountered by `parse-partial-sexp'.
3743 ;; Inside a nested paren sexp.
3744 (if lookbehind-submatch
3745 ;; See the NOTE above.
3746 (progn (goto-char state-pos
) t
)
3747 ;; Skip out of the paren quickly.
3748 (setq state
(parse-partial-sexp state-pos bound
0 nil state
)
3751 ;; Have exited the current paren sexp.
3754 ;; The last `parse-partial-sexp' call above
3755 ;; has left us just after the closing paren
3756 ;; in this case, so we can modify the bound
3757 ;; to leave the point at the right position
3759 (setq bound
(1- (point)))
3761 (signal 'search-failed
(list regexp
)))))
3763 ((setq tmp
(elt check-state
3))
3764 ;; Match inside a string.
3765 (if (or lookbehind-submatch
3766 (not (integerp tmp
)))
3767 ;; See the NOTE above.
3768 (progn (goto-char state-pos
) t
)
3769 ;; Skip to the end of the string before continuing.
3770 (let ((ender (make-string 1 tmp
)) (continue t
))
3771 (while (if (search-forward ender bound noerror
)
3773 (setq state
(parse-partial-sexp
3774 state-pos
(point) nil nil state
)
3777 (setq continue nil
)))
3782 (c-beginning-of-macro start
)))
3783 ;; Match inside a macro. Skip to the end of it.
3785 (cond ((<= (point) bound
) t
)
3787 (t (signal 'search-failed
(list regexp
)))))
3789 ((and not-inside-token
3790 (or (< check-pos last-token-end-pos
)
3793 (goto-char check-pos
)
3795 (c-end-of-current-token last-token-end-pos
))
3796 (setq last-token-end-pos
(point))))))
3798 (if lookbehind-submatch
3799 ;; See the NOTE above.
3800 (goto-char state-pos
)
3801 (goto-char (min last-token-end-pos bound
))))
3808 ;; Should loop to search again, but take care to avoid
3809 ;; looping on the same spot.
3810 (or (/= search-pos
(point))
3811 (if (= (point) bound
)
3814 (signal 'search-failed
(list regexp
)))
3820 (signal (car err
) (cdr err
))))
3822 ;;(message "c-syntactic-re-search-forward done %s" (or (match-end 0) (point)))
3826 (goto-char (match-end 0))
3829 ;; Search failed. Set point as appropriate.
3835 (defvar safe-pos-list
) ; bound in c-syntactic-skip-backward
3837 (defsubst c-ssb-lit-begin
()
3838 ;; Return the start of the literal point is in, or nil.
3839 ;; We read and write the variables `safe-pos', `safe-pos-list', `state'
3840 ;; bound in the caller.
3842 ;; Use `parse-partial-sexp' from a safe position down to the point to check
3843 ;; if it's outside comments and strings.
3845 (let ((pos (point)) safe-pos state pps-end-pos
)
3846 ;; Pick a safe position as close to the point as possible.
3848 ;; FIXME: Consult `syntax-ppss' here if our cache doesn't give a good
3851 (while (and safe-pos-list
3852 (> (car safe-pos-list
) (point)))
3853 (setq safe-pos-list
(cdr safe-pos-list
)))
3854 (unless (setq safe-pos
(car-safe safe-pos-list
))
3855 (setq safe-pos
(max (or (c-safe-position
3856 (point) (or c-state-cache
3860 safe-pos-list
(list safe-pos
)))
3862 ;; Cache positions along the way to use if we have to back up more. We
3863 ;; cache every closing paren on the same level. If the paren cache is
3864 ;; relevant in this region then we're typically already on the same
3865 ;; level as the target position. Note that we might cache positions
3866 ;; after opening parens in case safe-pos is in a nested list. That's
3867 ;; both uncommon and harmless.
3869 (setq state
(parse-partial-sexp
3872 (setq safe-pos
(point)
3873 safe-pos-list
(cons safe-pos safe-pos-list
)))
3875 ;; If the state contains the start of the containing sexp we cache that
3876 ;; position too, so that parse-partial-sexp in the next run has a bigger
3877 ;; chance of starting at the same level as the target position and thus
3878 ;; will get more good safe positions into the list.
3880 (setq safe-pos
(1+ (elt state
1))
3881 safe-pos-list
(cons safe-pos safe-pos-list
)))
3883 (if (or (elt state
3) (elt state
4))
3884 ;; Inside string or comment. Continue search at the
3888 (defun c-syntactic-skip-backward (skip-chars &optional limit paren-level
)
3889 "Like `skip-chars-backward' but only look at syntactically relevant chars,
3890 i.e. don't stop at positions inside syntactic whitespace or string
3891 literals. Preprocessor directives are also ignored, with the exception
3892 of the one that the point starts within, if any. If LIMIT is given,
3893 it's assumed to be at a syntactically relevant position.
3895 If PAREN-LEVEL is non-nil, the function won't stop in nested paren
3896 sexps, and the search will also not go outside the current paren sexp.
3897 However, if LIMIT or the buffer limit is reached inside a nested paren
3898 then the point will be left at the limit.
3900 Non-nil is returned if the point moved, nil otherwise.
3902 Note that this function might do hidden buffer changes. See the
3903 comment at the start of cc-engine.el for more info."
3905 (let ((start (point))
3907 ;; A list of syntactically relevant positions in descending
3908 ;; order. It's used to avoid scanning repeatedly over
3909 ;; potentially large regions with `parse-partial-sexp' to verify
3910 ;; each position. Used in `c-ssb-lit-begin'
3912 ;; The result from `c-beginning-of-macro' at the start position or the
3913 ;; start position itself if it isn't within a macro. Evaluated on
3916 ;; The earliest position after the current one with the same paren
3917 ;; level. Used only when `paren-level' is set.
3919 (paren-level-pos (point)))
3923 ;; The next loop "tries" to find the end point each time round,
3924 ;; loops when it hasn't succeeded.
3927 (< (skip-chars-backward skip-chars limit
) 0)
3929 (let ((pos (point)) state-2 pps-end-pos
)
3932 ;; Don't stop inside a literal
3933 ((setq lit-beg
(c-ssb-lit-begin))
3939 (setq state-2
(parse-partial-sexp
3940 pos paren-level-pos -
1)
3941 pps-end-pos
(point))
3942 (/= (car state-2
) 0)))
3943 ;; Not at the right level.
3945 (if (and (< (car state-2
) 0)
3946 ;; We stop above if we go out of a paren.
3947 ;; Now check whether it precedes or is
3948 ;; nested in the starting sexp.
3952 pps-end-pos paren-level-pos
3954 (< (car state-2
) 0)))
3956 ;; We've stopped short of the starting position
3957 ;; so the hit was inside a nested list. Go up
3958 ;; until we are at the right level.
3961 (goto-char (scan-lists pos -
1
3963 (setq paren-level-pos
(point))
3964 (if (and limit
(>= limit paren-level-pos
))
3970 (goto-char (or limit
(point-min)))
3973 ;; The hit was outside the list at the start
3974 ;; position. Go to the start of the list and exit.
3975 (goto-char (1+ (elt state-2
1)))
3978 ((c-beginning-of-macro limit
)
3982 (setq start-macro-beg
3985 (c-beginning-of-macro limit
)
3989 ;; It's inside the same macro we started in so it's
3990 ;; a relevant match.
3996 ;; Skip syntactic ws afterwards so that we don't stop at the
3997 ;; end of a comment if `skip-chars' is something like "^/".
3998 (c-backward-syntactic-ws)
4001 ;; We might want to extend this with more useful return values in
4003 (/= (point) start
)))
4005 ;; The following is an alternative implementation of
4006 ;; `c-syntactic-skip-backward' that uses backward movement to keep
4007 ;; track of the syntactic context. It turned out to be generally
4008 ;; slower than the one above which uses forward checks from earlier
4011 ;;(defconst c-ssb-stop-re
4012 ;; ;; The regexp matching chars `c-syntactic-skip-backward' needs to
4013 ;; ;; stop at to avoid going into comments and literals.
4015 ;; ;; Match comment end syntax and string literal syntax. Also match
4016 ;; ;; '/' for block comment endings (not covered by comment end
4018 ;; "\\s>\\|/\\|\\s\""
4019 ;; (if (memq 'gen-string-delim c-emacs-features)
4022 ;; (if (memq 'gen-comment-delim c-emacs-features)
4026 ;;(defconst c-ssb-stop-paren-re
4027 ;; ;; Like `c-ssb-stop-re' but also stops at paren chars.
4028 ;; (concat c-ssb-stop-re "\\|\\s(\\|\\s)"))
4030 ;;(defconst c-ssb-sexp-end-re
4031 ;; ;; Regexp matching the ending syntax of a complex sexp.
4032 ;; (concat c-string-limit-regexp "\\|\\s)"))
4034 ;;(defun c-syntactic-skip-backward (skip-chars &optional limit paren-level)
4035 ;; "Like `skip-chars-backward' but only look at syntactically relevant chars,
4036 ;;i.e. don't stop at positions inside syntactic whitespace or string
4037 ;;literals. Preprocessor directives are also ignored. However, if the
4038 ;;point is within a comment, string literal or preprocessor directory to
4039 ;;begin with, its contents is treated as syntactically relevant chars.
4040 ;;If LIMIT is given, it limits the backward search and the point will be
4041 ;;left there if no earlier position is found.
4043 ;;If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4044 ;;sexps, and the search will also not go outside the current paren sexp.
4045 ;;However, if LIMIT or the buffer limit is reached inside a nested paren
4046 ;;then the point will be left at the limit.
4048 ;;Non-nil is returned if the point moved, nil otherwise.
4050 ;;Note that this function might do hidden buffer changes. See the
4051 ;;comment at the start of cc-engine.el for more info."
4053 ;; (save-restriction
4055 ;; (narrow-to-region limit (point-max)))
4057 ;; (let ((start (point)))
4059 ;; (while (let ((last-pos (point))
4061 ;; (skip-chars-backward skip-chars)
4064 ;; ;; Skip back over the same region as
4065 ;; ;; `skip-chars-backward' above, but keep to
4066 ;; ;; syntactically relevant positions.
4067 ;; (goto-char last-pos)
4069 ;; ;; `re-search-backward' with a single char regexp
4070 ;; ;; should be fast.
4071 ;; (re-search-backward
4072 ;; (if paren-level c-ssb-stop-paren-re c-ssb-stop-re)
4077 ;; ((looking-at "\\s(")
4078 ;; ;; `paren-level' is set and we've found the
4079 ;; ;; start of the containing paren.
4083 ;; ((looking-at c-ssb-sexp-end-re)
4084 ;; ;; We're at the end of a string literal or paren
4085 ;; ;; sexp (if `paren-level' is set).
4087 ;; (condition-case nil
4088 ;; (c-backward-sexp)
4090 ;; (goto-char limit)
4091 ;; (throw 'done t))))
4095 ;; ;; At the end of some syntactic ws or possibly
4096 ;; ;; after a plain '/' operator.
4097 ;; (let ((pos (point)))
4098 ;; (c-backward-syntactic-ws)
4099 ;; (if (= pos (point))
4100 ;; ;; Was a plain '/' operator. Go past it.
4101 ;; (backward-char)))))
4103 ;; (> (point) stop-pos))))
4105 ;; ;; Now the point is either at `stop-pos' or at some
4106 ;; ;; position further back if `stop-pos' was at a
4107 ;; ;; syntactically irrelevant place.
4109 ;; ;; Skip additional syntactic ws so that we don't stop
4110 ;; ;; at the end of a comment if `skip-chars' is
4111 ;; ;; something like "^/".
4112 ;; (c-backward-syntactic-ws)
4114 ;; (< (point) stop-pos))))
4116 ;; ;; We might want to extend this with more useful return values
4117 ;; ;; in the future.
4118 ;; (/= (point) start))))
4121 ;; Tools for handling comments and string literals.
4123 (defun c-slow-in-literal (&optional lim detect-cpp
)
4124 "Return the type of literal point is in, if any.
4125 The return value is `c' if in a C-style comment, `c++' if in a C++
4126 style comment, `string' if in a string literal, `pound' if DETECT-CPP
4127 is non-nil and in a preprocessor line, or nil if somewhere else.
4128 Optional LIM is used as the backward limit of the search. If omitted,
4129 or nil, `c-beginning-of-defun' is used.
4131 The last point calculated is cached if the cache is enabled, i.e. if
4132 `c-in-literal-cache' is bound to a two element vector.
4134 Note that this function might do hidden buffer changes. See the
4135 comment at the start of cc-engine.el for more info."
4137 (if (and (vectorp c-in-literal-cache
)
4138 (= (point) (aref c-in-literal-cache
0)))
4139 (aref c-in-literal-cache
1)
4140 (let ((rtn (save-excursion
4141 (let* ((pos (point))
4143 (c-beginning-of-syntax)
4145 (state (parse-partial-sexp lim pos
)))
4147 ((elt state
3) 'string
)
4148 ((elt state
4) (if (elt state
7) 'c
++ 'c
))
4149 ((and detect-cpp
(c-beginning-of-macro lim
)) 'pound
)
4151 ;; cache this result if the cache is enabled
4152 (if (not c-in-literal-cache
)
4153 (setq c-in-literal-cache
(vector (point) rtn
)))
4156 ;; XEmacs has a built-in function that should make this much quicker.
4157 ;; I don't think we even need the cache, which makes our lives more
4158 ;; complicated anyway. In this case, lim is only used to detect
4161 ;; Note that there is a bug in Xemacs's buffer-syntactic-context when used in
4162 ;; conjunction with syntax-table-properties. The bug is present in, e.g.,
4163 ;; Xemacs 21.4.4. It manifested itself thus:
4165 ;; Starting with an empty AWK Mode buffer, type
4167 ;; Point gets wrongly left at column 0, rather than being indented to tab-width.
4169 ;; AWK Mode is designed such that when the first / is typed, it gets the
4170 ;; syntax-table property "string fence". When the second / is typed, BOTH /s
4171 ;; are given the s-t property "string". However, buffer-syntactic-context
4172 ;; fails to take account of the change of the s-t property on the opening / to
4173 ;; "string", and reports that the { is within a string started by the second /.
4175 ;; The workaround for this is for the AWK Mode initialisation to switch the
4176 ;; defalias for c-in-literal to c-slow-in-literal. This will slow down other
4177 ;; cc-modes in Xemacs whenever an awk-buffer has been initialised.
4179 ;; (Alan Mackenzie, 2003/4/30).
4181 (defun c-fast-in-literal (&optional lim detect-cpp
)
4182 ;; This function might do hidden buffer changes.
4183 (let ((context (buffer-syntactic-context)))
4185 ((eq context
'string
) 'string
)
4186 ((eq context
'comment
) 'c
++)
4187 ((eq context
'block-comment
) 'c
)
4188 ((and detect-cpp
(save-excursion (c-beginning-of-macro lim
))) 'pound
))))
4190 (defalias 'c-in-literal
4191 (if (fboundp 'buffer-syntactic-context
)
4192 'c-fast-in-literal
; XEmacs
4193 'c-slow-in-literal
)) ; GNU Emacs
4195 ;; The defalias above isn't enough to shut up the byte compiler.
4196 (cc-bytecomp-defun c-in-literal)
4198 (defun c-literal-limits (&optional lim near not-in-delimiter
)
4199 "Return a cons of the beginning and end positions of the comment or
4200 string surrounding point (including both delimiters), or nil if point
4201 isn't in one. If LIM is non-nil, it's used as the \"safe\" position
4202 to start parsing from. If NEAR is non-nil, then the limits of any
4203 literal next to point is returned. \"Next to\" means there's only
4204 spaces and tabs between point and the literal. The search for such a
4205 literal is done first in forward direction. If NOT-IN-DELIMITER is
4206 non-nil, the case when point is inside a starting delimiter won't be
4207 recognized. This only has effect for comments which have starting
4208 delimiters with more than one character.
4210 Note that this function might do hidden buffer changes. See the
4211 comment at the start of cc-engine.el for more info."
4214 (let* ((pos (point))
4216 (c-beginning-of-syntax)
4218 (state (parse-partial-sexp lim pos
)))
4220 (cond ((elt state
3) ; String.
4221 (goto-char (elt state
8))
4222 (cons (point) (or (c-safe (c-forward-sexp 1) (point))
4225 ((elt state
4) ; Comment.
4226 (goto-char (elt state
8))
4227 (cons (point) (progn (c-forward-single-comment) (point))))
4229 ((and (not not-in-delimiter
)
4231 (eq (char-before) ?
/)
4232 (looking-at "[/*]"))
4233 ;; We're standing in a comment starter.
4235 (cons (point) (progn (c-forward-single-comment) (point))))
4240 ;; Search forward for a literal.
4241 (skip-chars-forward " \t")
4244 ((looking-at c-string-limit-regexp
) ; String.
4245 (cons (point) (or (c-safe (c-forward-sexp 1) (point))
4248 ((looking-at c-comment-start-regexp
) ; Line or block comment.
4249 (cons (point) (progn (c-forward-single-comment) (point))))
4253 (skip-chars-backward " \t")
4255 (let ((end (point)) beg
)
4258 (< (skip-syntax-backward c-string-syntax
) 0)) ; String.
4259 (setq beg
(c-safe (c-backward-sexp 1) (point))))
4261 ((and (c-safe (forward-char -
2) t
)
4263 ;; Block comment. Due to the nature of line
4264 ;; comments, they will always be covered by the
4265 ;; normal case above.
4267 (c-backward-single-comment)
4268 ;; If LIM is bogus, beg will be bogus.
4269 (setq beg
(point))))
4271 (if beg
(cons beg end
))))))
4274 ;; In case external callers use this; it did have a docstring.
4275 (defalias 'c-literal-limits-fast
'c-literal-limits
)
4277 (defun c-collect-line-comments (range)
4278 "If the argument is a cons of two buffer positions (such as returned by
4279 `c-literal-limits'), and that range contains a C++ style line comment,
4280 then an extended range is returned that contains all adjacent line
4281 comments (i.e. all comments that starts in the same column with no
4282 empty lines or non-whitespace characters between them). Otherwise the
4283 argument is returned.
4285 Note that this function might do hidden buffer changes. See the
4286 comment at the start of cc-engine.el for more info."
4290 (if (and (consp range
) (progn
4291 (goto-char (car range
))
4292 (looking-at c-line-comment-starter
)))
4293 (let ((col (current-column))
4295 (bopl (c-point 'bopl
))
4297 ;; Got to take care in the backward direction to handle
4298 ;; comments which are preceded by code.
4299 (while (and (c-backward-single-comment)
4301 (looking-at c-line-comment-starter
)
4302 (= col
(current-column)))
4304 bopl
(c-point 'bopl
)))
4306 (while (and (progn (skip-chars-forward " \t")
4307 (looking-at c-line-comment-starter
))
4308 (= col
(current-column))
4309 (prog1 (zerop (forward-line 1))
4310 (setq end
(point)))))
4315 (defun c-literal-type (range)
4316 "Convenience function that given the result of `c-literal-limits',
4317 returns nil or the type of literal that the range surrounds, one
4318 of the symbols 'c, 'c++ or 'string. It's much faster than using
4319 `c-in-literal' and is intended to be used when you need both the
4320 type of a literal and its limits.
4322 Note that this function might do hidden buffer changes. See the
4323 comment at the start of cc-engine.el for more info."
4327 (goto-char (car range
))
4328 (cond ((looking-at c-string-limit-regexp
) 'string
)
4329 ((or (looking-at "//") ; c++ line comment
4330 (and (looking-at "\\s<") ; comment starter
4331 (looking-at "#"))) ; awk comment.
4333 (t 'c
))) ; Assuming the range is valid.
4337 ;; `c-find-decl-spots' and accompanying stuff.
4339 ;; Variables used in `c-find-decl-spots' to cache the search done for
4340 ;; the first declaration in the last call. When that function starts,
4341 ;; it needs to back up over syntactic whitespace to look at the last
4342 ;; token before the region being searched. That can sometimes cause
4343 ;; moves back and forth over a quite large region of comments and
4344 ;; macros, which would be repeated for each changed character when
4345 ;; we're called during fontification, since font-lock refontifies the
4346 ;; current line for each change. Thus it's worthwhile to cache the
4349 ;; `c-find-decl-syntactic-pos' is a syntactically relevant position in
4350 ;; the syntactic whitespace less or equal to some start position.
4351 ;; There's no cached value if it's nil.
4353 ;; `c-find-decl-match-pos' is the match position if
4354 ;; `c-find-decl-prefix-search' matched before the syntactic whitespace
4355 ;; at `c-find-decl-syntactic-pos', or nil if there's no such match.
4356 (defvar c-find-decl-syntactic-pos nil
)
4357 (make-variable-buffer-local 'c-find-decl-syntactic-pos
)
4358 (defvar c-find-decl-match-pos nil
)
4359 (make-variable-buffer-local 'c-find-decl-match-pos
)
4361 (defsubst c-invalidate-find-decl-cache
(change-min-pos)
4362 (and c-find-decl-syntactic-pos
4363 (< change-min-pos c-find-decl-syntactic-pos
)
4364 (setq c-find-decl-syntactic-pos nil
)))
4366 ; (defface c-debug-decl-spot-face
4367 ; '((t (:background "Turquoise")))
4368 ; "Debug face to mark the spots where `c-find-decl-spots' stopped.")
4369 ; (defface c-debug-decl-sws-face
4370 ; '((t (:background "Khaki")))
4371 ; "Debug face to mark the syntactic whitespace between the declaration
4372 ; spots and the preceding token end.")
4374 (defmacro c-debug-put-decl-spot-faces
(match-pos decl-pos
)
4375 (when (facep 'c-debug-decl-spot-face
)
4376 `(c-save-buffer-state ((match-pos ,match-pos
) (decl-pos ,decl-pos
))
4377 (c-debug-add-face (max match-pos
(point-min)) decl-pos
4378 'c-debug-decl-sws-face
)
4379 (c-debug-add-face decl-pos
(min (1+ decl-pos
) (point-max))
4380 'c-debug-decl-spot-face
))))
4381 (defmacro c-debug-remove-decl-spot-faces
(beg end
)
4382 (when (facep 'c-debug-decl-spot-face
)
4383 `(c-save-buffer-state ()
4384 (c-debug-remove-face ,beg
,end
'c-debug-decl-spot-face
)
4385 (c-debug-remove-face ,beg
,end
'c-debug-decl-sws-face
))))
4387 (defmacro c-find-decl-prefix-search
()
4388 ;; Macro used inside `c-find-decl-spots'. It ought to be a defun,
4389 ;; but it contains lots of free variables that refer to things
4390 ;; inside `c-find-decl-spots'. The point is left at `cfd-match-pos'
4391 ;; if there is a match, otherwise at `cfd-limit'.
4393 ;; This macro might do hidden buffer changes.
4396 ;; Find the next property match position if we haven't got one already.
4397 (unless cfd-prop-match
4400 (goto-char (next-single-property-change
4401 (point) 'c-type nil cfd-limit
))
4402 (and (< (point) cfd-limit
)
4403 (not (eq (c-get-char-property (1- (point)) 'c-type
)
4405 (setq cfd-prop-match
(point))))
4407 ;; Find the next `c-decl-prefix-or-start-re' match if we haven't
4409 (unless cfd-re-match
4411 (if (> cfd-re-match-end
(point))
4412 (goto-char cfd-re-match-end
))
4414 (while (if (setq cfd-re-match-end
4415 (re-search-forward c-decl-prefix-or-start-re
4418 ;; Match. Check if it's inside a comment or string literal.
4420 (if (setq cfd-re-match
(match-end 1))
4421 ;; Matched the end of a token preceding a decl spot.
4423 (goto-char cfd-re-match
)
4425 ;; Matched a token that start a decl spot.
4426 (goto-char (match-beginning 0))
4430 ;; No match. Finish up and exit the loop.
4431 (setq cfd-re-match cfd-limit
)
4434 ;; Skip out of comments and string literals.
4436 (goto-char (next-single-property-change
4437 (point) 'face nil cfd-limit
))
4438 (and (< (point) cfd-limit
)
4439 (c-got-face-at (point) c-literal-faces
)))))
4441 ;; If we matched at the decl start, we have to back up over the
4442 ;; preceding syntactic ws to set `cfd-match-pos' and to catch
4443 ;; any decl spots in the syntactic ws.
4444 (unless cfd-re-match
4445 (c-backward-syntactic-ws)
4446 (setq cfd-re-match
(point))))
4448 ;; Choose whichever match is closer to the start.
4449 (if (< cfd-re-match cfd-prop-match
)
4450 (setq cfd-match-pos cfd-re-match
4452 (setq cfd-match-pos cfd-prop-match
4453 cfd-prop-match nil
))
4455 (goto-char cfd-match-pos
)
4457 (when (< cfd-match-pos cfd-limit
)
4458 ;; Skip forward past comments only so we don't skip macros.
4459 (c-forward-comments)
4460 ;; Set the position to continue at. We can avoid going over
4461 ;; the comments skipped above a second time, but it's possible
4462 ;; that the comment skipping has taken us past `cfd-prop-match'
4463 ;; since the property might be used inside comments.
4464 (setq cfd-continue-pos
(if cfd-prop-match
4465 (min cfd-prop-match
(point))
4468 (defun c-find-decl-spots (cfd-limit cfd-decl-re cfd-face-checklist cfd-fun
)
4469 ;; Call CFD-FUN for each possible spot for a declaration, cast or
4470 ;; label from the point to CFD-LIMIT.
4472 ;; CFD-FUN is called with point at the start of the spot. It's
4473 ;; passed two arguments: The first is the end position of the token
4474 ;; preceding the spot, or 0 for the implicit match at bob. The
4475 ;; second is a flag that is t when the match is inside a macro. If
4476 ;; CFD-FUN adds `c-decl-end' properties somewhere below the current
4477 ;; spot, it should return non-nil to ensure that the next search
4481 ;; o The first token after bob.
4482 ;; o The first token after the end of submatch 1 in
4483 ;; `c-decl-prefix-or-start-re' when that submatch matches.
4484 ;; o The start of each `c-decl-prefix-or-start-re' match when
4485 ;; submatch 1 doesn't match.
4486 ;; o The first token after the end of each occurrence of the
4487 ;; `c-type' text property with the value `c-decl-end', provided
4488 ;; `c-type-decl-end-used' is set.
4490 ;; Only a spot that match CFD-DECL-RE and whose face is in the
4491 ;; CFD-FACE-CHECKLIST list causes CFD-FUN to be called. The face
4492 ;; check is disabled if CFD-FACE-CHECKLIST is nil.
4494 ;; If the match is inside a macro then the buffer is narrowed to the
4495 ;; end of it, so that CFD-FUN can investigate the following tokens
4496 ;; without matching something that begins inside a macro and ends
4497 ;; outside it. It's to avoid this work that the CFD-DECL-RE and
4498 ;; CFD-FACE-CHECKLIST checks exist.
4500 ;; The spots are visited approximately in order from top to bottom.
4501 ;; It's however the positions where `c-decl-prefix-or-start-re'
4502 ;; matches and where `c-decl-end' properties are found that are in
4503 ;; order. Since the spots often are at the following token, they
4504 ;; might be visited out of order insofar as more spots are reported
4505 ;; later on within the syntactic whitespace between the match
4506 ;; positions and their spots.
4508 ;; It's assumed that comments and strings are fontified in the
4511 ;; This is mainly used in fontification, and so has an elaborate
4512 ;; cache to handle repeated calls from the same start position; see
4513 ;; the variables above.
4515 ;; All variables in this function begin with `cfd-' to avoid name
4516 ;; collision with the (dynamically bound) variables used in CFD-FUN.
4518 ;; This function might do hidden buffer changes.
4520 (let ((cfd-start-pos (point))
4521 (cfd-buffer-end (point-max))
4522 ;; The end of the token preceding the decl spot last found
4523 ;; with `c-decl-prefix-or-start-re'. `cfd-limit' if there's
4526 ;; The end position of the last `c-decl-prefix-or-start-re'
4527 ;; match. If this is greater than `cfd-continue-pos', the
4528 ;; next regexp search is started here instead.
4529 (cfd-re-match-end (point-min))
4530 ;; The end of the last `c-decl-end' found by
4531 ;; `c-find-decl-prefix-search'. `cfd-limit' if there's no
4532 ;; match. If searching for the property isn't needed then we
4533 ;; disable it by setting it to `cfd-limit' directly.
4534 (cfd-prop-match (unless c-type-decl-end-used cfd-limit
))
4535 ;; The end of the token preceding the decl spot last found by
4536 ;; `c-find-decl-prefix-search'. 0 for the implicit match at
4537 ;; bob. `cfd-limit' if there's no match. In other words,
4538 ;; this is the minimum of `cfd-re-match' and `cfd-prop-match'.
4539 (cfd-match-pos cfd-limit
)
4540 ;; The position to continue searching at.
4542 ;; The position of the last "real" token we've stopped at.
4543 ;; This can be greater than `cfd-continue-pos' when we get
4544 ;; hits inside macros or at `c-decl-end' positions inside
4547 ;; The end position of the last entered macro.
4550 ;; Initialize by finding a syntactically relevant start position
4551 ;; before the point, and do the first `c-decl-prefix-or-start-re'
4552 ;; search unless we're at bob.
4554 (let (start-in-literal start-in-macro syntactic-pos
)
4555 ;; Must back up a bit since we look for the end of the previous
4556 ;; statement or declaration, which is earlier than the first
4560 ;; First we need to move to a syntactically relevant position.
4561 ;; Begin by backing out of comment or string literals.
4563 (when (c-got-face-at (point) c-literal-faces
)
4564 ;; Try to use the faces to back up to the start of the
4565 ;; literal. FIXME: What if the point is on a declaration
4566 ;; inside a comment?
4567 (while (and (not (bobp))
4568 (c-got-face-at (1- (point)) c-literal-faces
))
4569 (goto-char (previous-single-property-change
4570 (point) 'face nil
(point-min))))
4572 ;; XEmacs doesn't fontify the quotes surrounding string
4574 (and (featurep 'xemacs
)
4575 (eq (get-text-property (point) 'face
)
4576 'font-lock-string-face
)
4578 (progn (backward-char)
4579 (not (looking-at c-string-limit-regexp
)))
4582 ;; Don't trust the literal to contain only literal faces
4583 ;; (the font lock package might not have fontified the
4584 ;; start of it at all, for instance) so check that we have
4585 ;; arrived at something that looks like a start or else
4586 ;; resort to `c-literal-limits'.
4587 (unless (looking-at c-literal-start-regexp
)
4588 (let ((range (c-literal-limits)))
4589 (if range
(goto-char (car range
)))))
4591 (setq start-in-literal
(point)))
4593 ;; The start is in a literal. If the limit is in the same
4594 ;; one we don't have to find a syntactic position etc. We
4595 ;; only check that if the limit is at or before bonl to save
4596 ;; time; it covers the by far most common case when font-lock
4597 ;; refontifies the current line only.
4598 (<= cfd-limit
(c-point 'bonl cfd-start-pos
))
4600 (goto-char cfd-start-pos
)
4602 (goto-char (next-single-property-change
4603 (point) 'face nil cfd-limit
))
4604 (and (< (point) cfd-limit
)
4605 (c-got-face-at (point) c-literal-faces
))))
4606 (= (point) cfd-limit
)))
4608 ;; Completely inside a literal. Set up variables to trig the
4609 ;; (< cfd-continue-pos cfd-start-pos) case below and it'll
4610 ;; find a suitable start position.
4611 (setq cfd-continue-pos start-in-literal
))
4613 ;; Check if the region might be completely inside a macro, to
4614 ;; optimize that like the completely-inside-literal above.
4616 (and (= (forward-line 1) 0)
4617 (bolp) ; forward-line has funny behavior at eob.
4618 (>= (point) cfd-limit
)
4619 (progn (backward-char)
4620 (eq (char-before) ?
\\))))
4621 ;; (Maybe) completely inside a macro. Only need to trig the
4622 ;; (< cfd-continue-pos cfd-start-pos) case below to make it
4624 (setq cfd-continue-pos
(1- cfd-start-pos
)
4628 ;; Back out of any macro so we don't miss any declaration
4629 ;; that could follow after it.
4630 (when (c-beginning-of-macro)
4631 (setq start-in-macro t
))
4633 ;; Now we're at a proper syntactically relevant position so we
4634 ;; can use the cache. But first clear it if it applied
4636 (c-invalidate-find-decl-cache cfd-start-pos
)
4638 (setq syntactic-pos
(point))
4639 (unless (eq syntactic-pos c-find-decl-syntactic-pos
)
4640 ;; Don't have to do this if the cache is relevant here,
4641 ;; typically if the same line is refontified again. If
4642 ;; we're just some syntactic whitespace further down we can
4643 ;; still use the cache to limit the skipping.
4644 (c-backward-syntactic-ws c-find-decl-syntactic-pos
))
4646 ;; If we hit `c-find-decl-syntactic-pos' and
4647 ;; `c-find-decl-match-pos' is set then we install the cached
4648 ;; values. If we hit `c-find-decl-syntactic-pos' and
4649 ;; `c-find-decl-match-pos' is nil then we know there's no decl
4650 ;; prefix in the whitespace before `c-find-decl-syntactic-pos'
4651 ;; and so we can continue the search from this point. If we
4652 ;; didn't hit `c-find-decl-syntactic-pos' then we're now in
4653 ;; the right spot to begin searching anyway.
4654 (if (and (eq (point) c-find-decl-syntactic-pos
)
4655 c-find-decl-match-pos
)
4656 (setq cfd-match-pos c-find-decl-match-pos
4657 cfd-continue-pos syntactic-pos
)
4659 (setq c-find-decl-syntactic-pos syntactic-pos
)
4662 ;; Always consider bob a match to get the first
4663 ;; declaration in the file. Do this separately instead of
4664 ;; letting `c-decl-prefix-or-start-re' match bob, so that
4665 ;; regexp always can consume at least one character to
4666 ;; ensure that we won't get stuck in an infinite loop.
4667 (setq cfd-re-match
0)
4669 (c-beginning-of-current-token)
4670 (< (point) cfd-limit
))
4671 ;; Do an initial search now. In the bob case above it's
4672 ;; only done to search for a `c-decl-end' spot.
4673 (c-find-decl-prefix-search))
4675 (setq c-find-decl-match-pos
(and (< cfd-match-pos cfd-start-pos
)
4678 ;; Advance `cfd-continue-pos' if it's before the start position.
4679 ;; The closest continue position that might have effect at or
4680 ;; after the start depends on what we started in. This also
4681 ;; finds a suitable start position in the special cases when the
4682 ;; region is completely within a literal or macro.
4683 (when (and cfd-continue-pos
(< cfd-continue-pos cfd-start-pos
))
4687 ;; If we're in a macro then it's the closest preceding token
4688 ;; in the macro. Check this before `start-in-literal',
4689 ;; since if we're inside a literal in a macro, the preceding
4690 ;; token is earlier than any `c-decl-end' spot inside the
4691 ;; literal (comment).
4692 (goto-char (or start-in-literal cfd-start-pos
))
4693 ;; The only syntactic ws in macros are comments.
4694 (c-backward-comments)
4696 (c-beginning-of-current-token))
4699 ;; If we're in a comment it can only be the closest
4700 ;; preceding `c-decl-end' position within that comment, if
4701 ;; any. Go back to the beginning of such a property so that
4702 ;; `c-find-decl-prefix-search' will find the end of it.
4703 ;; (Can't stop at the end and install it directly on
4704 ;; `cfd-prop-match' since that variable might be cleared
4705 ;; after `cfd-fun' below.)
4707 ;; Note that if the literal is a string then the property
4708 ;; search will simply skip to the beginning of it right
4710 (if (not c-type-decl-end-used
)
4711 (goto-char start-in-literal
)
4712 (goto-char cfd-start-pos
)
4714 (goto-char (previous-single-property-change
4715 (point) 'c-type nil start-in-literal
))
4716 (and (> (point) start-in-literal
)
4717 (not (eq (c-get-char-property (point) 'c-type
)
4720 (when (= (point) start-in-literal
)
4721 ;; Didn't find any property inside the comment, so we can
4722 ;; skip it entirely. (This won't skip past a string, but
4723 ;; that'll be handled quickly by the next
4724 ;; `c-find-decl-prefix-search' anyway.)
4725 (c-forward-single-comment)
4726 (if (> (point) cfd-limit
)
4727 (goto-char cfd-limit
))))
4730 ;; If we started in normal code, the only match that might
4731 ;; apply before the start is what we already got in
4732 ;; `cfd-match-pos' so we can continue at the start position.
4733 ;; (Note that we don't get here if the first match is below
4735 (goto-char cfd-start-pos
)))
4737 ;; Delete found matches if they are before our new continue
4738 ;; position, so that `c-find-decl-prefix-search' won't back up
4739 ;; to them later on.
4740 (setq cfd-continue-pos
(point))
4741 (when (and cfd-re-match
(< cfd-re-match cfd-continue-pos
))
4742 (setq cfd-re-match nil
))
4743 (when (and cfd-prop-match
(< cfd-prop-match cfd-continue-pos
))
4744 (setq cfd-prop-match nil
)))
4747 ;; This is the normal case and we got a proper syntactic
4748 ;; position. If there's a match then it's always outside
4749 ;; macros and comments, so advance to the next token and set
4750 ;; `cfd-token-pos'. The loop below will later go back using
4751 ;; `cfd-continue-pos' to fix declarations inside the
4753 (when (and cfd-match-pos
(< cfd-match-pos syntactic-pos
))
4754 (goto-char syntactic-pos
)
4755 (c-forward-syntactic-ws)
4756 (and cfd-continue-pos
4757 (< cfd-continue-pos
(point))
4758 (setq cfd-token-pos
(point))))
4760 ;; Have one of the special cases when the region is completely
4761 ;; within a literal or macro. `cfd-continue-pos' is set to a
4762 ;; good start position for the search, so do it.
4763 (c-find-decl-prefix-search)))
4765 ;; Now loop. Round what? (ACM, 2006/7/5). We already got the first match.
4769 (< cfd-match-pos cfd-limit
)
4772 ;; Kludge to filter out matches on the "<" that
4773 ;; aren't open parens, for the sake of languages
4774 ;; that got `c-recognize-<>-arglists' set.
4775 (and (eq (char-before cfd-match-pos
) ?
<)
4776 (not (c-get-char-property (1- cfd-match-pos
)
4779 ;; If `cfd-continue-pos' is less or equal to
4780 ;; `cfd-token-pos', we've got a hit inside a macro
4781 ;; that's in the syntactic whitespace before the last
4782 ;; "real" declaration we've checked. If they're equal
4783 ;; we've arrived at the declaration a second time, so
4784 ;; there's nothing to do.
4785 (= cfd-continue-pos cfd-token-pos
)
4788 ;; If `cfd-continue-pos' is less than `cfd-token-pos'
4789 ;; we're still searching for declarations embedded in
4790 ;; the syntactic whitespace. In that case we need
4791 ;; only to skip comments and not macros, since they
4792 ;; can't be nested, and that's already been done in
4793 ;; `c-find-decl-prefix-search'.
4794 (when (> cfd-continue-pos cfd-token-pos
)
4795 (c-forward-syntactic-ws)
4796 (setq cfd-token-pos
(point)))
4798 ;; Continue if the following token fails the
4799 ;; CFD-DECL-RE and CFD-FACE-CHECKLIST checks.
4800 (when (or (>= (point) cfd-limit
)
4801 (not (looking-at cfd-decl-re
))
4802 (and cfd-face-checklist
4804 (point) cfd-face-checklist
))))
4805 (goto-char cfd-continue-pos
)
4808 (< (point) cfd-limit
))
4809 (c-find-decl-prefix-search))
4811 (< (point) cfd-limit
))
4814 (>= (point) cfd-start-pos
)
4817 ;; Narrow to the end of the macro if we got a hit inside
4818 ;; one, to avoid recognizing things that start inside the
4819 ;; macro and end outside it.
4820 (when (> cfd-match-pos cfd-macro-end
)
4821 ;; Not in the same macro as in the previous round.
4823 (goto-char cfd-match-pos
)
4825 (if (save-excursion (and (c-beginning-of-macro)
4826 (< (point) cfd-match-pos
)))
4827 (progn (c-end-of-macro)
4831 (if (zerop cfd-macro-end
)
4833 (if (> cfd-macro-end
(point))
4834 (progn (narrow-to-region (point-min) cfd-macro-end
)
4836 ;; The matched token was the last thing in the macro,
4837 ;; so the whole match is bogus.
4838 (setq cfd-macro-end
0)
4841 (c-debug-put-decl-spot-faces cfd-match-pos
(point))
4842 (if (funcall cfd-fun cfd-match-pos
(/= cfd-macro-end
0))
4843 (setq cfd-prop-match nil
))
4845 (when (/= cfd-macro-end
0)
4846 ;; Restore limits if we did macro narrowment above.
4847 (narrow-to-region (point-min) cfd-buffer-end
)))
4849 (goto-char cfd-continue-pos
)
4850 (if (= cfd-continue-pos cfd-limit
)
4851 (setq cfd-match-pos cfd-limit
)
4852 (c-find-decl-prefix-search)))))
4855 ;; A cache for found types.
4857 ;; Buffer local variable that contains an obarray with the types we've
4858 ;; found. If a declaration is recognized somewhere we record the
4859 ;; fully qualified identifier in it to recognize it as a type
4860 ;; elsewhere in the file too. This is not accurate since we do not
4861 ;; bother with the scoping rules of the languages, but in practice the
4862 ;; same name is seldom used as both a type and something else in a
4863 ;; file, and we only use this as a last resort in ambiguous cases (see
4864 ;; `c-forward-decl-or-cast-1').
4866 ;; Not every type need be in this cache. However, things which have
4867 ;; ceased to be types must be removed from it.
4869 ;; Template types in C++ are added here too but with the template
4870 ;; arglist replaced with "<>" in references or "<" for the one in the
4871 ;; primary type. E.g. the type "Foo<A,B>::Bar<C>" is stored as
4872 ;; "Foo<>::Bar<". This avoids storing very long strings (since C++
4873 ;; template specs can be fairly sized programs in themselves) and
4874 ;; improves the hit ratio (it's a type regardless of the template
4875 ;; args; it's just not the same type, but we're only interested in
4876 ;; recognizing types, not telling distinct types apart). Note that
4877 ;; template types in references are added here too; from the example
4878 ;; above there will also be an entry "Foo<".
4879 (defvar c-found-types nil
)
4880 (make-variable-buffer-local 'c-found-types
)
4882 (defsubst c-clear-found-types
()
4883 ;; Clears `c-found-types'.
4884 (setq c-found-types
(make-vector 53 0)))
4886 (defun c-add-type (from to
)
4887 ;; Add the given region as a type in `c-found-types'. If the region
4888 ;; doesn't match an existing type but there is a type which is equal
4889 ;; to the given one except that the last character is missing, then
4890 ;; the shorter type is removed. That's done to avoid adding all
4891 ;; prefixes of a type as it's being entered and font locked. This
4892 ;; doesn't cover cases like when characters are removed from a type
4893 ;; or added in the middle. We'd need the position of point when the
4894 ;; font locking is invoked to solve this well.
4896 ;; This function might do hidden buffer changes.
4897 (let ((type (c-syntactic-content from to c-recognize-
<>-arglists
)))
4898 (unless (intern-soft type c-found-types
)
4899 (unintern (substring type
0 -
1) c-found-types
)
4900 (intern type c-found-types
))))
4902 (defun c-unfind-type (name)
4903 ;; Remove the "NAME" from c-found-types, if present.
4904 (unintern name c-found-types
))
4906 (defsubst c-check-type
(from to
)
4907 ;; Return non-nil if the given region contains a type in
4910 ;; This function might do hidden buffer changes.
4911 (intern-soft (c-syntactic-content from to c-recognize-
<>-arglists
)
4914 (defun c-list-found-types ()
4915 ;; Return all the types in `c-found-types' as a sorted list of
4918 (mapatoms (lambda (type)
4919 (setq type-list
(cons (symbol-name type
)
4922 (sort type-list
'string-lessp
)))
4924 ;; Shut up the byte compiler.
4925 (defvar c-maybe-stale-found-type
)
4927 (defun c-trim-found-types (beg end old-len
)
4928 ;; An after change function which, in conjunction with the info in
4929 ;; c-maybe-stale-found-type (set in c-before-change), removes a type
4930 ;; from `c-found-types', should this type have become stale. For
4931 ;; example, this happens to "foo" when "foo \n bar();" becomes
4932 ;; "foo(); \n bar();". Such stale types, if not removed, foul up
4933 ;; the fontification.
4935 ;; Have we, perhaps, added non-ws characters to the front/back of a found
4939 (when (< end
(point-max))
4941 (if (and (c-beginning-of-current-token) ; only moves when we started in the middle
4942 (progn (goto-char end
)
4943 (c-end-of-current-token)))
4944 (c-unfind-type (buffer-substring-no-properties
4946 (when (> beg
(point-min))
4948 (if (and (c-end-of-current-token) ; only moves when we started in the middle
4949 (progn (goto-char beg
)
4950 (c-beginning-of-current-token)))
4951 (c-unfind-type (buffer-substring-no-properties
4954 (if c-maybe-stale-found-type
; e.g. (c-decl-id-start "foo" 97 107 " (* ooka) " "o")
4956 ;; Changing the amount of (already existing) whitespace - don't do anything.
4957 ((and (c-partial-ws-p beg end
)
4958 (or (= beg end
) ; removal of WS
4959 (string-match "^[ \t\n\r\f\v]*$" (nth 5 c-maybe-stale-found-type
)))))
4961 ;; The syntactic relationship which defined a "found type" has been
4963 ((eq (car c-maybe-stale-found-type
) 'c-decl-id-start
)
4964 (c-unfind-type (cadr c-maybe-stale-found-type
)))
4965 ;; ((eq (car c-maybe-stale-found-type) 'c-decl-type-start) FIXME!!!
4969 ;; Setting and removing syntax properties on < and > in languages (C++
4970 ;; and Java) where they can be template/generic delimiters as well as
4971 ;; their normal meaning of "less/greater than".
4973 ;; Normally, < and > have syntax 'punctuation'. When they are found to
4974 ;; be delimiters, they are marked as such with the category properties
4975 ;; c-<-as-paren-syntax, c->-as-paren-syntax respectively.
4979 ;; It is impossible to determine with certainty whether a <..> pair in
4980 ;; C++ is two comparison operators or is template delimiters, unless
4981 ;; one duplicates a lot of a C++ compiler. For example, the following
4984 ;; foo (a < b, c > d) ;
4986 ;; could be a function call with two integer parameters (each a
4987 ;; relational expression), or it could be a constructor for class foo
4988 ;; taking one parameter d of templated type "a < b, c >". They are
4989 ;; somewhat easier to distinguish in Java.
4991 ;; The strategy now (2010-01) adopted is to mark and unmark < and
4992 ;; > IN MATCHING PAIRS ONLY. [Previously, they were marked
4993 ;; individually when their context so indicated. This gave rise to
4994 ;; intractible problems when one of a matching pair was deleted, or
4995 ;; pulled into a literal.]
4997 ;; At each buffer change, the syntax-table properties are removed in a
4998 ;; before-change function and reapplied, when needed, in an
4999 ;; after-change function. It is far more important that the
5000 ;; properties get removed when they they are spurious than that they
5001 ;; be present when wanted.
5002 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
5003 (defun c-clear-<-pair-props
(&optional pos
)
5004 ;; POS (default point) is at a < character. If it is marked with
5005 ;; open paren syntax-table text property, remove the property,
5006 ;; together with the close paren property on the matching > (if
5012 (when (equal (c-get-char-property (point) 'syntax-table
)
5013 c-
<-as-paren-syntax
)
5014 (with-syntax-table c-no-parens-syntax-table
; ignore unbalanced [,{,(,..
5015 (c-go-list-forward))
5016 (when (equal (c-get-char-property (1- (point)) 'syntax-table
)
5017 c-
>-as-paren-syntax
) ; should always be true.
5018 (c-clear-char-property (1- (point)) 'category
))
5019 (c-clear-char-property pos
'category
))))
5021 (defun c-clear->-pair-props
(&optional pos
)
5022 ;; POS (default point) is at a > character. If it is marked with
5023 ;; close paren syntax-table property, remove the property, together
5024 ;; with the open paren property on the matching < (if any).
5029 (when (equal (c-get-char-property (point) 'syntax-table
)
5030 c-
>-as-paren-syntax
)
5031 (with-syntax-table c-no-parens-syntax-table
; ignore unbalanced [,{,(,..
5032 (c-go-up-list-backward))
5033 (when (equal (c-get-char-property (point) 'syntax-table
)
5034 c-
<-as-paren-syntax
) ; should always be true.
5035 (c-clear-char-property (point) 'category
))
5036 (c-clear-char-property pos
'category
))))
5038 (defun c-clear-<>-pair-props
(&optional pos
)
5039 ;; POS (default point) is at a < or > character. If it has an
5040 ;; open/close paren syntax-table property, remove this property both
5041 ;; from the current character and its partner (which will also be
5044 ((eq (char-after) ?\
<)
5045 (c-clear-<-pair-props pos
))
5046 ((eq (char-after) ?\
>)
5047 (c-clear->-pair-props pos
))
5049 "c-clear-<>-pair-props called from wrong position"))))
5051 (defun c-clear-<-pair-props-if-match-after
(lim &optional pos
)
5052 ;; POS (default point) is at a < character. If it is both marked
5053 ;; with open/close paren syntax-table property, and has a matching >
5054 ;; (also marked) which is after LIM, remove the property both from
5055 ;; the current > and its partner. Return t when this happens, nil
5061 (when (equal (c-get-char-property (point) 'syntax-table
)
5062 c-
<-as-paren-syntax
)
5063 (with-syntax-table c-no-parens-syntax-table
; ignore unbalanced [,{,(,..
5064 (c-go-list-forward))
5065 (when (and (>= (point) lim
)
5066 (equal (c-get-char-property (1- (point)) 'syntax-table
)
5067 c-
>-as-paren-syntax
)) ; should always be true.
5068 (c-unmark-<-
>-as-paren
(1- (point)))
5069 (c-unmark-<-
>-as-paren pos
))
5072 (defun c-clear->-pair-props-if-match-before
(lim &optional pos
)
5073 ;; POS (default point) is at a > character. If it is both marked
5074 ;; with open/close paren syntax-table property, and has a matching <
5075 ;; (also marked) which is before LIM, remove the property both from
5076 ;; the current < and its partner. Return t when this happens, nil
5082 (when (equal (c-get-char-property (point) 'syntax-table
)
5083 c-
>-as-paren-syntax
)
5084 (with-syntax-table c-no-parens-syntax-table
; ignore unbalanced [,{,(,..
5085 (c-go-up-list-backward))
5086 (when (and (<= (point) lim
)
5087 (equal (c-get-char-property (point) 'syntax-table
)
5088 c-
<-as-paren-syntax
)) ; should always be true.
5089 (c-unmark-<-
>-as-paren
(point))
5090 (c-unmark-<-
>-as-paren pos
))
5093 ;; Set by c-common-init in cc-mode.el.
5097 (defun c-before-change-check-<>-operators
(beg end
)
5098 ;; Unmark certain pairs of "< .... >" which are currently marked as
5099 ;; template/generic delimiters. (This marking is via syntax-table
5100 ;; text properties).
5102 ;; These pairs are those which are in the current "statement" (i.e.,
5103 ;; the region between the {, }, or ; before BEG and the one after
5104 ;; END), and which enclose any part of the interval (BEG END).
5106 ;; Note that in C++ (?and Java), template/generic parens cannot
5107 ;; enclose a brace or semicolon, so we use these as bounds on the
5108 ;; region we must work on.
5110 ;; This function is called from before-change-functions (via
5111 ;; c-get-state-before-change-functions). Thus the buffer is widened,
5112 ;; and point is undefined, both at entry and exit.
5114 ;; FIXME!!! This routine ignores the possibility of macros entirely.
5117 (let ((beg-lit-limits (progn (goto-char beg
) (c-literal-limits)))
5118 (end-lit-limits (progn (goto-char end
) (c-literal-limits)))
5119 new-beg new-end need-new-beg need-new-end
)
5120 ;; Locate the barrier before the changed region
5121 (goto-char (if beg-lit-limits
(car beg-lit-limits
) beg
))
5122 (c-syntactic-skip-backward "^;{}" (max (- beg
2048) (point-min)))
5123 (setq new-beg
(point))
5125 ;; Remove the syntax-table properties from each pertinent <...> pair.
5126 ;; Firsly, the ones with the < before beg and > after beg.
5127 (while (c-search-forward-char-property 'category
'c-
<-as-paren-syntax beg
)
5128 (if (c-clear-<-pair-props-if-match-after beg
(1- (point)))
5129 (setq need-new-beg t
)))
5131 ;; Locate the barrier after END.
5132 (goto-char (if end-lit-limits
(cdr end-lit-limits
) end
))
5133 (c-syntactic-re-search-forward "[;{}]"
5134 (min (+ end
2048) (point-max)) 'end
)
5135 (setq new-end
(point))
5137 ;; Remove syntax-table properties from the remaining pertinent <...>
5138 ;; pairs, those with a > after end and < before end.
5139 (while (c-search-backward-char-property 'category
'c-
>-as-paren-syntax end
)
5140 (if (c-clear->-pair-props-if-match-before end
)
5141 (setq need-new-end t
)))
5143 ;; Extend the fontification region, if needed.
5146 (c-forward-syntactic-ws)
5147 (and (< (point) c-new-BEG
) (setq c-new-BEG
(point))))
5150 (and (> new-end c-new-END
) (setq c-new-END new-end
))))))
5154 (defun c-after-change-check-<>-operators
(beg end
)
5155 ;; This is called from `after-change-functions' when
5156 ;; c-recognize-<>-arglists' is set. It ensures that no "<" or ">"
5157 ;; chars with paren syntax become part of another operator like "<<"
5160 ;; This function might do hidden buffer changes.
5164 (when (or (looking-at "[<>]")
5165 (< (skip-chars-backward "<>") 0))
5168 (c-beginning-of-current-token)
5169 (when (and (< (point) beg
)
5170 (looking-at c-
<>-multichar-token-regexp
)
5171 (< beg
(setq beg
(match-end 0))))
5172 (while (progn (skip-chars-forward "^<>" beg
)
5174 (c-clear-<>-pair-props
)
5179 (when (or (looking-at "[<>]")
5180 (< (skip-chars-backward "<>") 0))
5183 (c-beginning-of-current-token)
5184 (when (and (< (point) end
)
5185 (looking-at c-
<>-multichar-token-regexp
)
5186 (< end
(setq end
(match-end 0))))
5187 (while (progn (skip-chars-forward "^<>" end
)
5189 (c-clear-<>-pair-props
)
5190 (forward-char)))))))
5194 ;; Handling of small scale constructs like types and names.
5196 ;; Dynamically bound variable that instructs `c-forward-type' to also
5197 ;; treat possible types (i.e. those that it normally returns 'maybe or
5198 ;; 'found for) as actual types (and always return 'found for them).
5199 ;; This means that it records them in `c-record-type-identifiers' if
5200 ;; that is set, and that it adds them to `c-found-types'.
5201 (defvar c-promote-possible-types nil
)
5203 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5204 ;; mark up successfully parsed arglists with paren syntax properties on
5205 ;; the surrounding angle brackets and with `c-<>-arg-sep' in the
5206 ;; `c-type' property of each argument separating comma.
5208 ;; Setting this variable also makes `c-forward-<>-arglist' recurse into
5209 ;; all arglists for side effects (i.e. recording types), otherwise it
5210 ;; exploits any existing paren syntax properties to quickly jump to the
5211 ;; end of already parsed arglists.
5213 ;; Marking up the arglists is not the default since doing that correctly
5214 ;; depends on a proper value for `c-restricted-<>-arglists'.
5215 (defvar c-parse-and-markup-
<>-arglists nil
)
5217 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5218 ;; not accept arglists that contain binary operators.
5220 ;; This is primarily used to handle C++ template arglists. C++
5221 ;; disambiguates them by checking whether the preceding name is a
5222 ;; template or not. We can't do that, so we assume it is a template
5223 ;; if it can be parsed as one. That usually works well since
5224 ;; comparison expressions on the forms "a < b > c" or "a < b, c > d"
5225 ;; in almost all cases would be pointless.
5227 ;; However, in function arglists, e.g. in "foo (a < b, c > d)", we
5228 ;; should let the comma separate the function arguments instead. And
5229 ;; in a context where the value of the expression is taken, e.g. in
5230 ;; "if (a < b || c > d)", it's probably not a template.
5231 (defvar c-restricted-
<>-arglists nil
)
5233 ;; Dynamically bound variables that instructs
5234 ;; `c-forward-keyword-clause', `c-forward-<>-arglist',
5235 ;; `c-forward-name', `c-forward-type', `c-forward-decl-or-cast-1', and
5236 ;; `c-forward-label' to record the ranges of all the type and
5237 ;; reference identifiers they encounter. They will build lists on
5238 ;; these variables where each element is a cons of the buffer
5239 ;; positions surrounding each identifier. This recording is only
5240 ;; activated when `c-record-type-identifiers' is non-nil.
5242 ;; All known types that can't be identifiers are recorded, and also
5243 ;; other possible types if `c-promote-possible-types' is set.
5244 ;; Recording is however disabled inside angle bracket arglists that
5245 ;; are encountered inside names and other angle bracket arglists.
5246 ;; Such occurrences are taken care of by `c-font-lock-<>-arglists'
5249 ;; Only the names in C++ template style references (e.g. "tmpl" in
5250 ;; "tmpl<a,b>::foo") are recorded as references, other references
5251 ;; aren't handled here.
5253 ;; `c-forward-label' records the label identifier(s) on
5254 ;; `c-record-ref-identifiers'.
5255 (defvar c-record-type-identifiers nil
)
5256 (defvar c-record-ref-identifiers nil
)
5258 ;; This variable will receive a cons cell of the range of the last
5259 ;; single identifier symbol stepped over by `c-forward-name' if it's
5260 ;; successful. This is the range that should be put on one of the
5261 ;; record lists above by the caller. It's assigned nil if there's no
5262 ;; such symbol in the name.
5263 (defvar c-last-identifier-range nil
)
5265 (defmacro c-record-type-id
(range)
5266 (if (eq (car-safe range
) 'cons
)
5268 `(setq c-record-type-identifiers
5269 (cons ,range c-record-type-identifiers
))
5270 `(let ((range ,range
))
5272 (setq c-record-type-identifiers
5273 (cons range c-record-type-identifiers
))))))
5275 (defmacro c-record-ref-id
(range)
5276 (if (eq (car-safe range
) 'cons
)
5278 `(setq c-record-ref-identifiers
5279 (cons ,range c-record-ref-identifiers
))
5280 `(let ((range ,range
))
5282 (setq c-record-ref-identifiers
5283 (cons range c-record-ref-identifiers
))))))
5285 ;; Dynamically bound variable that instructs `c-forward-type' to
5286 ;; record the ranges of types that only are found. Behaves otherwise
5287 ;; like `c-record-type-identifiers'.
5288 (defvar c-record-found-types nil
)
5290 (defmacro c-forward-keyword-prefixed-id
(type)
5291 ;; Used internally in `c-forward-keyword-clause' to move forward
5292 ;; over a type (if TYPE is 'type) or a name (otherwise) which
5293 ;; possibly is prefixed by keywords and their associated clauses.
5294 ;; Try with a type/name first to not trip up on those that begin
5295 ;; with a keyword. Return t if a known or found type is moved
5296 ;; over. The point is clobbered if nil is returned. If range
5297 ;; recording is enabled, the identifier is recorded on as a type
5298 ;; if TYPE is 'type or as a reference if TYPE is 'ref.
5300 ;; This macro might do hidden buffer changes.
5302 (while (if (setq res
,(if (eq type
'type
)
5306 (and (looking-at c-keywords-regexp
)
5307 (c-forward-keyword-clause 1))))
5308 (when (memq res
'(t known found prefix
))
5309 ,(when (eq type
'ref
)
5310 `(when c-record-type-identifiers
5311 (c-record-ref-id c-last-identifier-range
)))
5314 (defmacro c-forward-id-comma-list
(type update-safe-pos
)
5315 ;; Used internally in `c-forward-keyword-clause' to move forward
5316 ;; over a comma separated list of types or names using
5317 ;; `c-forward-keyword-prefixed-id'.
5319 ;; This macro might do hidden buffer changes.
5321 ,(when update-safe-pos
5322 `(setq safe-pos
(point)))
5323 (eq (char-after) ?
,))
5326 (c-forward-syntactic-ws)
5327 (c-forward-keyword-prefixed-id ,type
)))))
5329 (defun c-forward-keyword-clause (match)
5330 ;; Submatch MATCH in the current match data is assumed to surround a
5331 ;; token. If it's a keyword, move over it and any immediately
5332 ;; following clauses associated with it, stopping at the start of
5333 ;; the next token. t is returned in that case, otherwise the point
5334 ;; stays and nil is returned. The kind of clauses that are
5335 ;; recognized are those specified by `c-type-list-kwds',
5336 ;; `c-ref-list-kwds', `c-colon-type-list-kwds',
5337 ;; `c-paren-nontype-kwds', `c-paren-type-kwds', `c-<>-type-kwds',
5338 ;; and `c-<>-arglist-kwds'.
5340 ;; This function records identifier ranges on
5341 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5342 ;; `c-record-type-identifiers' is non-nil.
5344 ;; Note that for `c-colon-type-list-kwds', which doesn't necessary
5345 ;; apply directly after the keyword, the type list is moved over
5346 ;; only when there is no unaccounted token before it (i.e. a token
5347 ;; that isn't moved over due to some other keyword list). The
5348 ;; identifier ranges in the list are still recorded if that should
5351 ;; This function might do hidden buffer changes.
5353 (let ((kwd-sym (c-keyword-sym (match-string match
))) safe-pos pos
5354 ;; The call to `c-forward-<>-arglist' below is made after
5355 ;; `c-<>-sexp-kwds' keywords, so we're certain they actually
5356 ;; are angle bracket arglists and `c-restricted-<>-arglists'
5357 ;; should therefore be nil.
5358 (c-parse-and-markup-<>-arglists t
)
5359 c-restricted-
<>-arglists
)
5362 (goto-char (match-end match
))
5363 (c-forward-syntactic-ws)
5364 (setq safe-pos
(point))
5367 ((and (c-keyword-member kwd-sym
'c-type-list-kwds
)
5368 (c-forward-keyword-prefixed-id type
))
5369 ;; There's a type directly after a keyword in `c-type-list-kwds'.
5370 (c-forward-id-comma-list type t
))
5372 ((and (c-keyword-member kwd-sym
'c-ref-list-kwds
)
5373 (c-forward-keyword-prefixed-id ref
))
5374 ;; There's a name directly after a keyword in `c-ref-list-kwds'.
5375 (c-forward-id-comma-list ref t
))
5377 ((and (c-keyword-member kwd-sym
'c-paren-any-kwds
)
5378 (eq (char-after) ?\
())
5379 ;; There's an open paren after a keyword in `c-paren-any-kwds'.
5382 (when (and (setq pos
(c-up-list-forward))
5383 (eq (char-before pos
) ?\
)))
5384 (when (and c-record-type-identifiers
5385 (c-keyword-member kwd-sym
'c-paren-type-kwds
))
5386 ;; Use `c-forward-type' on every identifier we can find
5387 ;; inside the paren, to record the types.
5388 (while (c-syntactic-re-search-forward c-symbol-start pos t
)
5389 (goto-char (match-beginning 0))
5390 (unless (c-forward-type)
5391 (looking-at c-symbol-key
) ; Always matches.
5392 (goto-char (match-end 0)))))
5395 (c-forward-syntactic-ws)
5396 (setq safe-pos
(point))))
5398 ((and (c-keyword-member kwd-sym
'c-
<>-sexp-kwds
)
5399 (eq (char-after) ?
<)
5400 (c-forward-<>-arglist
(c-keyword-member kwd-sym
'c-
<>-type-kwds
)))
5401 (c-forward-syntactic-ws)
5402 (setq safe-pos
(point)))
5404 ((and (c-keyword-member kwd-sym
'c-nonsymbol-sexp-kwds
)
5405 (not (looking-at c-symbol-start
))
5406 (c-safe (c-forward-sexp) t
))
5407 (c-forward-syntactic-ws)
5408 (setq safe-pos
(point))))
5410 (when (c-keyword-member kwd-sym
'c-colon-type-list-kwds
)
5411 (if (eq (char-after) ?
:)
5412 ;; If we are at the colon already, we move over the type
5416 (c-forward-syntactic-ws)
5417 (when (c-forward-keyword-prefixed-id type
)
5418 (c-forward-id-comma-list type t
)))
5419 ;; Not at the colon, so stop here. But the identifier
5420 ;; ranges in the type list later on should still be
5422 (and c-record-type-identifiers
5424 ;; If a keyword matched both one of the types above and
5425 ;; this one, we match `c-colon-type-list-re' after the
5426 ;; clause matched above.
5427 (goto-char safe-pos
)
5428 (looking-at c-colon-type-list-re
))
5430 (goto-char (match-end 0))
5431 (c-forward-syntactic-ws)
5432 (c-forward-keyword-prefixed-id type
))
5433 ;; There's a type after the `c-colon-type-list-re' match
5434 ;; after a keyword in `c-colon-type-list-kwds'.
5435 (c-forward-id-comma-list type nil
))))
5437 (goto-char safe-pos
)
5440 ;; cc-mode requires cc-fonts.
5441 (declare-function c-fontify-recorded-types-and-refs
"cc-fonts" ())
5443 (defun c-forward-<>-arglist
(all-types)
5444 ;; The point is assumed to be at a "<". Try to treat it as the open
5445 ;; paren of an angle bracket arglist and move forward to the
5446 ;; corresponding ">". If successful, the point is left after the
5447 ;; ">" and t is returned, otherwise the point isn't moved and nil is
5448 ;; returned. If ALL-TYPES is t then all encountered arguments in
5449 ;; the arglist that might be types are treated as found types.
5451 ;; The variable `c-parse-and-markup-<>-arglists' controls how this
5452 ;; function handles text properties on the angle brackets and argument
5453 ;; separating commas.
5455 ;; `c-restricted-<>-arglists' controls how lenient the template
5456 ;; arglist recognition should be.
5458 ;; This function records identifier ranges on
5459 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5460 ;; `c-record-type-identifiers' is non-nil.
5462 ;; This function might do hidden buffer changes.
5464 (let ((start (point))
5465 ;; If `c-record-type-identifiers' is set then activate
5466 ;; recording of any found types that constitute an argument in
5468 (c-record-found-types (if c-record-type-identifiers t
)))
5469 (if (catch 'angle-bracket-arglist-escape
5470 (setq c-record-found-types
5471 (c-forward-<>-arglist-recur all-types
)))
5473 (when (consp c-record-found-types
)
5474 (setq c-record-type-identifiers
5475 ;; `nconc' doesn't mind that the tail of
5476 ;; `c-record-found-types' is t.
5477 (nconc c-record-found-types c-record-type-identifiers
)))
5478 (if (c-major-mode-is 'java-mode
) (c-fontify-recorded-types-and-refs))
5484 (defun c-forward-<>-arglist-recur
(all-types)
5485 ;; Recursive part of `c-forward-<>-arglist'.
5487 ;; This function might do hidden buffer changes.
5489 (let ((start (point)) res pos tmp
5490 ;; Cover this so that any recorded found type ranges are
5491 ;; automatically lost if it turns out to not be an angle
5492 ;; bracket arglist. It's propagated through the return value
5493 ;; on successful completion.
5494 (c-record-found-types c-record-found-types
)
5495 ;; List that collects the positions after the argument
5496 ;; separating ',' in the arglist.
5498 ;; If the '<' has paren open syntax then we've marked it as an angle
5499 ;; bracket arglist before, so skip to the end.
5500 (if (and (not c-parse-and-markup-
<>-arglists
)
5501 (c-get-char-property (point) 'syntax-table
))
5505 (if (and (c-go-up-list-forward)
5506 (eq (char-before) ?
>))
5508 ;; Got unmatched paren angle brackets. We don't clear the paren
5509 ;; syntax properties and retry, on the basis that it's very
5510 ;; unlikely that paren angle brackets become operators by code
5511 ;; manipulation. It's far more likely that it doesn't match due
5512 ;; to narrowing or some temporary change.
5516 (forward-char) ; Forward over the opening '<'.
5518 (unless (looking-at c-
<-op-cont-regexp
)
5519 ;; go forward one non-alphanumeric character (group) per iteration of
5523 (c-forward-syntactic-ws)
5524 (let ((orig-record-found-types c-record-found-types
))
5525 (when (or (and c-record-type-identifiers all-types
)
5526 (c-major-mode-is 'java-mode
))
5527 ;; All encountered identifiers are types, so set the
5528 ;; promote flag and parse the type.
5530 (c-forward-syntactic-ws)
5531 (if (looking-at "\\?")
5533 (when (looking-at c-identifier-start
)
5534 (let ((c-promote-possible-types t
)
5535 (c-record-found-types t
))
5538 (c-forward-syntactic-ws)
5540 (when (or (looking-at "extends")
5541 (looking-at "super"))
5543 (c-forward-syntactic-ws)
5544 (let ((c-promote-possible-types t
)
5545 (c-record-found-types t
))
5547 (c-forward-syntactic-ws))))))
5549 (setq pos
(point)) ; e.g. first token inside the '<'
5551 ;; Note: These regexps exploit the match order in \| so
5552 ;; that "<>" is matched by "<" rather than "[^>:-]>".
5553 (c-syntactic-re-search-forward
5554 ;; Stop on ',', '|', '&', '+' and '-' to catch
5555 ;; common binary operators that could be between
5556 ;; two comparison expressions "a<b" and "c>d".
5557 "[<;{},|+&-]\\|[>)]"
5561 ((eq (char-before) ?
>)
5562 ;; Either an operator starting with '>' or the end of
5563 ;; the angle bracket arglist.
5565 (if (looking-at c-
>-op-cont-regexp
)
5567 (goto-char (match-end 0))
5568 t
) ; Continue the loop.
5570 ;; The angle bracket arglist is finished.
5571 (when c-parse-and-markup-
<>-arglists
5572 (while arg-start-pos
5573 (c-put-c-type-property (1- (car arg-start-pos
))
5575 (setq arg-start-pos
(cdr arg-start-pos
)))
5576 (c-mark-<-as-paren start
)
5577 (c-mark->-as-paren
(1- (point))))
5579 nil
)) ; Exit the loop.
5581 ((eq (char-before) ?
<)
5582 ;; Either an operator starting with '<' or a nested arglist.
5584 (let (id-start id-end subres keyword-match
)
5586 ;; The '<' begins a multi-char operator.
5587 ((looking-at c-
<-op-cont-regexp
)
5588 (setq tmp
(match-end 0))
5589 (goto-char (match-end 0)))
5590 ;; We're at a nested <.....>
5593 (backward-char) ; to the '<'
5596 ;; There's always an identifier before an angle
5597 ;; bracket arglist, or a keyword in `c-<>-type-kwds'
5598 ;; or `c-<>-arglist-kwds'.
5599 (c-backward-syntactic-ws)
5600 (setq id-end
(point))
5601 (c-simple-skip-symbol-backward)
5602 (when (or (setq keyword-match
5603 (looking-at c-opt-
<>-sexp-key
))
5604 (not (looking-at c-keywords-regexp
)))
5605 (setq id-start
(point))))
5607 (let ((c-promote-possible-types t
)
5608 (c-record-found-types t
))
5609 (c-forward-<>-arglist-recur
5612 (c-keyword-sym (match-string 1))
5613 'c-
<>-type-kwds
)))))))
5615 ;; It was an angle bracket arglist.
5616 (setq c-record-found-types subres
)
5618 ;; Record the identifier before the template as a type
5619 ;; or reference depending on whether the arglist is last
5620 ;; in a qualified identifier.
5621 (when (and c-record-type-identifiers
5622 (not keyword-match
))
5623 (if (and c-opt-identifier-concat-key
5625 (c-forward-syntactic-ws)
5626 (looking-at c-opt-identifier-concat-key
)))
5627 (c-record-ref-id (cons id-start id-end
))
5628 (c-record-type-id (cons id-start id-end
)))))
5630 ;; At a "less than" operator.
5634 t
) ; carry on looping.
5636 ((and (not c-restricted-
<>-arglists
)
5637 (or (and (eq (char-before) ?
&)
5638 (not (eq (char-after) ?
&)))
5639 (eq (char-before) ?
,)))
5640 ;; Just another argument. Record the position. The
5641 ;; type check stuff that made us stop at it is at
5642 ;; the top of the loop.
5643 (setq arg-start-pos
(cons (point) arg-start-pos
)))
5646 ;; Got a character that can't be in an angle bracket
5647 ;; arglist argument. Abort using `throw', since
5648 ;; it's useless to try to find a surrounding arglist
5650 (throw 'angle-bracket-arglist-escape nil
))))))
5652 (or c-record-found-types t
)))))
5654 (defun c-backward-<>-arglist
(all-types &optional limit
)
5655 ;; The point is assumed to be directly after a ">". Try to treat it
5656 ;; as the close paren of an angle bracket arglist and move back to
5657 ;; the corresponding "<". If successful, the point is left at
5658 ;; the "<" and t is returned, otherwise the point isn't moved and
5659 ;; nil is returned. ALL-TYPES is passed on to
5660 ;; `c-forward-<>-arglist'.
5662 ;; If the optional LIMIT is given, it bounds the backward search.
5663 ;; It's then assumed to be at a syntactically relevant position.
5665 ;; This is a wrapper around `c-forward-<>-arglist'. See that
5666 ;; function for more details.
5668 (let ((start (point)))
5670 (if (and (not c-parse-and-markup-
<>-arglists
)
5671 (c-get-char-property (point) 'syntax-table
))
5673 (if (and (c-go-up-list-backward)
5674 (eq (char-after) ?
<))
5676 ;; See corresponding note in `c-forward-<>-arglist'.
5681 (c-syntactic-skip-backward "^<;{}" limit t
)
5684 (if (eq (char-before) ?
<)
5686 ;; Stopped at bob or a char that isn't allowed in an
5687 ;; arglist, so we've failed.
5692 (progn (c-beginning-of-current-token)
5694 ;; If we moved then the "<" was part of some
5695 ;; multicharacter token.
5699 (let ((beg-pos (point)))
5700 (if (c-forward-<>-arglist all-types
)
5701 (cond ((= (point) start
)
5702 ;; Matched the arglist. Break the while.
5706 ;; We started from a non-paren ">" inside an
5711 ;; Matched a shorter arglist. Can be a nested
5712 ;; one so continue looking.
5717 (/= (point) start
))))
5719 (defun c-forward-name ()
5720 ;; Move forward over a complete name if at the beginning of one,
5721 ;; stopping at the next following token. A keyword, as such,
5722 ;; doesn't count as a name. If the point is not at something that
5723 ;; is recognized as a name then it stays put.
5725 ;; A name could be something as simple as "foo" in C or something as
5726 ;; complex as "X<Y<class A<int>::B, BIT_MAX >> b>, ::operator<> ::
5727 ;; Z<(a>b)> :: operator const X<&foo>::T Q::G<unsigned short
5728 ;; int>::*volatile const" in C++ (this function is actually little
5729 ;; more than a `looking-at' call in all modes except those that,
5730 ;; like C++, have `c-recognize-<>-arglists' set).
5733 ;; o - nil if no name is found;
5734 ;; o - 'template if it's an identifier ending with an angle bracket
5736 ;; o - 'operator of it's an operator identifier;
5737 ;; o - t if it's some other kind of name.
5739 ;; This function records identifier ranges on
5740 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5741 ;; `c-record-type-identifiers' is non-nil.
5743 ;; This function might do hidden buffer changes.
5745 (let ((pos (point)) (start (point)) res id-start id-end
5746 ;; Turn off `c-promote-possible-types' here since we might
5747 ;; call `c-forward-<>-arglist' and we don't want it to promote
5748 ;; every suspect thing in the arglist to a type. We're
5749 ;; typically called from `c-forward-type' in this case, and
5750 ;; the caller only wants the top level type that it finds to
5752 c-promote-possible-types
)
5755 (looking-at c-identifier-key
)
5758 ;; Check for keyword. We go to the last symbol in
5759 ;; `c-identifier-key' first.
5760 (goto-char (setq id-end
(match-end 0)))
5761 (c-simple-skip-symbol-backward)
5762 (setq id-start
(point))
5764 (if (looking-at c-keywords-regexp
)
5765 (when (and (c-major-mode-is 'c
++-mode
)
5767 (cc-eval-when-compile
5768 (concat "\\(operator\\|\\(template\\)\\)"
5769 "\\(" (c-lang-const c-nonsymbol-key c
++)
5771 (if (match-beginning 2)
5772 ;; "template" is only valid inside an
5773 ;; identifier if preceded by "::".
5775 (c-backward-syntactic-ws)
5776 (and (c-safe (backward-char 2) t
)
5780 ;; Handle a C++ operator or template identifier.
5782 (c-forward-syntactic-ws)
5783 (cond ((eq (char-before id-end
) ?e
)
5784 ;; Got "... ::template".
5785 (let ((subres (c-forward-name)))
5790 ((looking-at c-identifier-start
)
5791 ;; Got a cast operator.
5792 (when (c-forward-type)
5795 ;; Now we should match a sequence of either
5796 ;; '*', '&' or a name followed by ":: *",
5797 ;; where each can be followed by a sequence
5798 ;; of `c-opt-type-modifier-key'.
5799 (while (cond ((looking-at "[*&]")
5800 (goto-char (match-end 0))
5802 ((looking-at c-identifier-start
)
5803 (and (c-forward-name)
5806 (goto-char (match-end 0))
5807 (c-forward-syntactic-ws)
5808 (eq (char-after) ?
*))
5813 (c-forward-syntactic-ws)
5815 (looking-at c-opt-type-modifier-key
))
5816 (goto-char (match-end 1))))))
5818 ((looking-at c-overloadable-operators-regexp
)
5819 ;; Got some other operator.
5820 (setq c-last-identifier-range
5821 (cons (point) (match-end 0)))
5822 (goto-char (match-end 0))
5823 (c-forward-syntactic-ws)
5829 ;; `id-start' is equal to `id-end' if we've jumped over
5830 ;; an identifier that doesn't end with a symbol token.
5831 ;; That can occur e.g. for Java import directives on the
5832 ;; form "foo.bar.*".
5833 (when (and id-start
(/= id-start id-end
))
5834 (setq c-last-identifier-range
5835 (cons id-start id-end
)))
5837 (c-forward-syntactic-ws)
5843 (when (or c-opt-identifier-concat-key
5844 c-recognize-
<>-arglists
)
5847 ((and c-opt-identifier-concat-key
5848 (looking-at c-opt-identifier-concat-key
))
5849 ;; Got a concatenated identifier. This handles the
5850 ;; cases with tricky syntactic whitespace that aren't
5851 ;; covered in `c-identifier-key'.
5852 (goto-char (match-end 0))
5853 (c-forward-syntactic-ws)
5856 ((and c-recognize-
<>-arglists
5857 (eq (char-after) ?
<))
5858 ;; Maybe an angle bracket arglist.
5859 (when (let ((c-record-type-identifiers t
)
5860 (c-record-found-types t
))
5861 (c-forward-<>-arglist nil
))
5863 (c-add-type start
(1+ pos
))
5864 (c-forward-syntactic-ws)
5866 c-last-identifier-range nil
)
5868 (if (and c-opt-identifier-concat-key
5869 (looking-at c-opt-identifier-concat-key
))
5871 ;; Continue if there's an identifier concatenation
5872 ;; operator after the template argument.
5874 (when (and c-record-type-identifiers id-start
)
5875 (c-record-ref-id (cons id-start id-end
)))
5877 (c-forward-syntactic-ws)
5880 (when (and c-record-type-identifiers id-start
)
5881 (c-record-type-id (cons id-start id-end
)))
5882 (setq res
'template
)
5889 (defun c-forward-type (&optional brace-block-too
)
5890 ;; Move forward over a type spec if at the beginning of one,
5891 ;; stopping at the next following token. The keyword "typedef"
5892 ;; isn't part of a type spec here.
5894 ;; BRACE-BLOCK-TOO, when non-nil, means move over the brace block in
5895 ;; constructs like "struct foo {...} bar ;" or "struct {...} bar;".
5896 ;; The current (2009-03-10) intention is to convert all uses of
5897 ;; `c-forward-type' to call with this parameter set, then to
5901 ;; o - t if it's a known type that can't be a name or other
5903 ;; o - 'known if it's an otherwise known type (according to
5904 ;; `*-font-lock-extra-types');
5905 ;; o - 'prefix if it's a known prefix of a type;
5906 ;; o - 'found if it's a type that matches one in `c-found-types';
5907 ;; o - 'maybe if it's an identfier that might be a type; or
5908 ;; o - nil if it can't be a type (the point isn't moved then).
5910 ;; The point is assumed to be at the beginning of a token.
5912 ;; Note that this function doesn't skip past the brace definition
5913 ;; that might be considered part of the type, e.g.
5914 ;; "enum {a, b, c} foo".
5916 ;; This function records identifier ranges on
5917 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5918 ;; `c-record-type-identifiers' is non-nil.
5920 ;; This function might do hidden buffer changes.
5921 (when (and c-recognize-
<>-arglists
5923 (c-forward-<>-arglist t
)
5924 (c-forward-syntactic-ws))
5926 (let ((start (point)) pos res name-res id-start id-end id-range
)
5928 ;; Skip leading type modifiers. If any are found we know it's a
5929 ;; prefix of a type.
5930 (when c-opt-type-modifier-key
; e.g. "const" "volatile", but NOT "typedef"
5931 (while (looking-at c-opt-type-modifier-key
)
5932 (goto-char (match-end 1))
5933 (c-forward-syntactic-ws)
5934 (setq res
'prefix
)))
5937 ((looking-at c-type-prefix-key
) ; e.g. "struct", "class", but NOT
5939 (goto-char (match-end 1))
5940 (c-forward-syntactic-ws)
5943 (setq name-res
(c-forward-name))
5944 (setq res
(not (null name-res
)))
5945 (when (eq name-res t
)
5946 ;; In many languages the name can be used without the
5947 ;; prefix, so we add it to `c-found-types'.
5948 (c-add-type pos
(point))
5949 (when (and c-record-type-identifiers
5950 c-last-identifier-range
)
5951 (c-record-type-id c-last-identifier-range
)))
5952 (when (and brace-block-too
5954 (eq (char-after) ?\
{)
5957 (progn (c-forward-sexp)
5958 (c-forward-syntactic-ws)
5959 (setq pos
(point))))))
5962 (unless res
(goto-char start
))) ; invalid syntax
5966 (if (looking-at c-identifier-start
)
5968 (setq id-start
(point)
5969 name-res
(c-forward-name))
5971 (setq id-end
(point)
5972 id-range c-last-identifier-range
))))
5973 (and (cond ((looking-at c-primitive-type-key
)
5975 ((c-with-syntax-table c-identifier-syntax-table
5976 (looking-at c-known-type-key
))
5981 (goto-char (match-end 1))
5982 (c-forward-syntactic-ws)
5983 (setq pos
(point))))
5986 ;; Looking at a primitive or known type identifier. We've
5987 ;; checked for a name first so that we don't go here if the
5988 ;; known type match only is a prefix of another name.
5990 (setq id-end
(match-end 1))
5992 (when (and c-record-type-identifiers
5993 (or c-promote-possible-types
(eq res t
)))
5994 (c-record-type-id (cons (match-beginning 1) (match-end 1))))
5996 (if (and c-opt-type-component-key
5998 (looking-at c-opt-type-component-key
)))
5999 ;; There might be more keywords for the type.
6001 (c-forward-keyword-clause 1)
6003 (setq safe-pos
(point))
6004 (looking-at c-opt-type-component-key
))
6005 (when (and c-record-type-identifiers
6006 (looking-at c-primitive-type-key
))
6007 (c-record-type-id (cons (match-beginning 1)
6009 (c-forward-keyword-clause 1))
6010 (if (looking-at c-primitive-type-key
)
6012 (when c-record-type-identifiers
6013 (c-record-type-id (cons (match-beginning 1)
6015 (c-forward-keyword-clause 1)
6017 (goto-char safe-pos
)
6018 (setq res
'prefix
)))
6019 (unless (save-match-data (c-forward-keyword-clause 1))
6022 (goto-char (match-end 1))
6023 (c-forward-syntactic-ws)))))
6026 (cond ((eq name-res t
)
6027 ;; A normal identifier.
6029 (if (or res c-promote-possible-types
)
6031 (c-add-type id-start id-end
)
6032 (when (and c-record-type-identifiers id-range
)
6033 (c-record-type-id id-range
))
6036 (setq res
(if (c-check-type id-start id-end
)
6037 ;; It's an identifier that has been used as
6038 ;; a type somewhere else.
6040 ;; It's an identifier that might be a type.
6042 ((eq name-res
'template
)
6043 ;; A template is a type.
6047 ;; Otherwise it's an operator identifier, which is not a type.
6052 ;; Skip trailing type modifiers. If any are found we know it's
6054 (when c-opt-type-modifier-key
6055 (while (looking-at c-opt-type-modifier-key
) ; e.g. "const", "volatile"
6056 (goto-char (match-end 1))
6057 (c-forward-syntactic-ws)
6059 ;; Step over any type suffix operator. Do not let the existence
6060 ;; of these alter the classification of the found type, since
6061 ;; these operators typically are allowed in normal expressions
6063 (when c-opt-type-suffix-key
6064 (while (looking-at c-opt-type-suffix-key
)
6065 (goto-char (match-end 1))
6066 (c-forward-syntactic-ws)))
6068 (when c-opt-type-concat-key
; Only/mainly for pike.
6069 ;; Look for a trailing operator that concatenates the type
6070 ;; with a following one, and if so step past that one through
6071 ;; a recursive call. Note that we don't record concatenated
6072 ;; types in `c-found-types' - it's the component types that
6073 ;; are recorded when appropriate.
6075 (let* ((c-promote-possible-types (or (memq res
'(t known
))
6076 c-promote-possible-types
))
6077 ;; If we can't promote then set `c-record-found-types' so that
6078 ;; we can merge in the types from the second part afterwards if
6079 ;; it turns out to be a known type there.
6080 (c-record-found-types (and c-record-type-identifiers
6081 (not c-promote-possible-types
)))
6083 (if (and (looking-at c-opt-type-concat-key
)
6086 (goto-char (match-end 1))
6087 (c-forward-syntactic-ws)
6088 (setq subres
(c-forward-type))))
6091 ;; If either operand certainly is a type then both are, but we
6092 ;; don't let the existence of the operator itself promote two
6093 ;; uncertain types to a certain one.
6096 (unless (eq name-res
'template
)
6097 (c-add-type id-start id-end
))
6098 (when (and c-record-type-identifiers id-range
)
6099 (c-record-type-id id-range
))
6110 (when (and (eq res t
)
6111 (consp c-record-found-types
))
6112 ;; Merge in the ranges of any types found by the second
6113 ;; `c-forward-type'.
6114 (setq c-record-type-identifiers
6115 ;; `nconc' doesn't mind that the tail of
6116 ;; `c-record-found-types' is t.
6117 (nconc c-record-found-types
6118 c-record-type-identifiers
))))
6122 (when (and c-record-found-types
(memq res
'(known found
)) id-range
)
6123 (setq c-record-found-types
6124 (cons id-range c-record-found-types
))))
6126 ;;(message "c-forward-type %s -> %s: %s" start (point) res)
6130 (defun c-forward-annotation ()
6131 ;; Used for Java code only at the moment. Assumes point is on the
6132 ;; @, moves forward an annotation. returns nil if there is no
6133 ;; annotation at point.
6134 (and (looking-at "@")
6135 (progn (forward-char) t
)
6137 (progn (c-forward-syntactic-ws) t
)
6138 (if (looking-at "(")
6143 ;; Handling of large scale constructs like statements and declarations.
6145 ;; Macro used inside `c-forward-decl-or-cast-1'. It ought to be a
6146 ;; defsubst or perhaps even a defun, but it contains lots of free
6147 ;; variables that refer to things inside `c-forward-decl-or-cast-1'.
6148 (defmacro c-fdoc-shift-type-backward
(&optional short
)
6149 ;; `c-forward-decl-or-cast-1' can consume an arbitrary length list
6150 ;; of types when parsing a declaration, which means that it
6151 ;; sometimes consumes the identifier in the declaration as a type.
6152 ;; This is used to "backtrack" and make the last type be treated as
6153 ;; an identifier instead.
6156 ;; These identifiers are bound only in the inner let.
6157 '(setq identifier-type at-type
6158 identifier-start type-start
6162 got-suffix-after-parens id-start
6165 (if (setq at-type
(if (eq backup-at-type
'prefix
)
6168 (setq type-start backup-type-start
6169 id-start backup-id-start
)
6170 (setq type-start start-pos
6171 id-start start-pos
))
6173 ;; When these flags already are set we've found specifiers that
6174 ;; unconditionally signal these attributes - backtracking doesn't
6175 ;; change that. So keep them set in that case.
6177 (setq at-type-decl backup-at-type-decl
))
6179 (setq maybe-typeless backup-maybe-typeless
))
6182 ;; This identifier is bound only in the inner let.
6183 '(setq start id-start
))))
6185 (defun c-forward-decl-or-cast-1 (preceding-token-end context last-cast-end
)
6186 ;; Move forward over a declaration or a cast if at the start of one.
6187 ;; The point is assumed to be at the start of some token. Nil is
6188 ;; returned if no declaration or cast is recognized, and the point
6189 ;; is clobbered in that case.
6191 ;; If a declaration is parsed:
6193 ;; The point is left at the first token after the first complete
6194 ;; declarator, if there is one. The return value is a cons where
6195 ;; the car is the position of the first token in the declarator. (See
6196 ;; below for the cdr.)
6199 ;; void foo (int a, char *b) stuff ...
6203 ;; unsigned int a = c_style_initializer, b;
6205 ;; unsigned int a (cplusplus_style_initializer), b;
6206 ;; car ^ ^ point (might change)
6207 ;; class Foo : public Bar {}
6209 ;; class PikeClass (int a, string b) stuff ...
6215 ;; void cplusplus_function (int x) throw (Bad);
6217 ;; Foo::Foo (int b) : Base (b) {}
6220 ;; The cdr of the return value is non-nil when a
6221 ;; `c-typedef-decl-kwds' specifier is found in the declaration.
6222 ;; Specifically it is a dotted pair (A . B) where B is t when a
6223 ;; `c-typedef-kwds' ("typedef") is present, and A is t when some
6224 ;; other `c-typedef-decl-kwds' (e.g. class, struct, enum)
6225 ;; specifier is present. I.e., (some of) the declared
6226 ;; identifier(s) are types.
6228 ;; If a cast is parsed:
6230 ;; The point is left at the first token after the closing paren of
6231 ;; the cast. The return value is `cast'. Note that the start
6232 ;; position must be at the first token inside the cast parenthesis
6235 ;; PRECEDING-TOKEN-END is the first position after the preceding
6236 ;; token, i.e. on the other side of the syntactic ws from the point.
6237 ;; Use a value less than or equal to (point-min) if the point is at
6238 ;; the first token in (the visible part of) the buffer.
6240 ;; CONTEXT is a symbol that describes the context at the point:
6241 ;; 'decl In a comma-separated declaration context (typically
6242 ;; inside a function declaration arglist).
6243 ;; '<> In an angle bracket arglist.
6244 ;; 'arglist Some other type of arglist.
6245 ;; nil Some other context or unknown context. Includes
6246 ;; within the parens of an if, for, ... construct.
6248 ;; LAST-CAST-END is the first token after the closing paren of a
6249 ;; preceding cast, or nil if none is known. If
6250 ;; `c-forward-decl-or-cast-1' is used in succession, it should be
6251 ;; the position after the closest preceding call where a cast was
6252 ;; matched. In that case it's used to discover chains of casts like
6255 ;; This function records identifier ranges on
6256 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6257 ;; `c-record-type-identifiers' is non-nil.
6259 ;; This function might do hidden buffer changes.
6261 (let (;; `start-pos' is used below to point to the start of the
6262 ;; first type, i.e. after any leading specifiers. It might
6263 ;; also point at the beginning of the preceding syntactic
6266 ;; Set to the result of `c-forward-type'.
6268 ;; The position of the first token in what we currently
6269 ;; believe is the type in the declaration or cast, after any
6270 ;; specifiers and their associated clauses.
6272 ;; The position of the first token in what we currently
6273 ;; believe is the declarator for the first identifier. Set
6274 ;; when the type is found, and moved forward over any
6275 ;; `c-decl-hangon-kwds' and their associated clauses that
6276 ;; occurs after the type.
6278 ;; These store `at-type', `type-start' and `id-start' of the
6279 ;; identifier before the one in those variables. The previous
6280 ;; identifier might turn out to be the real type in a
6281 ;; declaration if the last one has to be the declarator in it.
6282 ;; If `backup-at-type' is nil then the other variables have
6283 ;; undefined values.
6284 backup-at-type backup-type-start backup-id-start
6285 ;; Set if we've found a specifier (apart from "typedef") that makes
6286 ;; the defined identifier(s) types.
6288 ;; Set if we've a "typedef" keyword.
6290 ;; Set if we've found a specifier that can start a declaration
6291 ;; where there's no type.
6293 ;; If a specifier is found that also can be a type prefix,
6294 ;; these flags are set instead of those above. If we need to
6295 ;; back up an identifier, they are copied to the real flag
6296 ;; variables. Thus they only take effect if we fail to
6297 ;; interpret it as a type.
6298 backup-at-type-decl backup-maybe-typeless
6299 ;; Whether we've found a declaration or a cast. We might know
6300 ;; this before we've found the type in it. It's 'ids if we've
6301 ;; found two consecutive identifiers (usually a sure sign, but
6302 ;; we should allow that in labels too), and t if we've found a
6303 ;; specifier keyword (a 100% sure sign).
6305 ;; Set when we need to back up to parse this as a declaration
6306 ;; but not as a cast.
6308 ;; For casts, the return position.
6310 ;; Save `c-record-type-identifiers' and
6311 ;; `c-record-ref-identifiers' since ranges are recorded
6312 ;; speculatively and should be thrown away if it turns out
6313 ;; that it isn't a declaration or cast.
6314 (save-rec-type-ids c-record-type-identifiers
)
6315 (save-rec-ref-ids c-record-ref-identifiers
))
6317 (while (c-forward-annotation)
6318 (c-forward-syntactic-ws))
6320 ;; Check for a type. Unknown symbols are treated as possible
6321 ;; types, but they could also be specifiers disguised through
6322 ;; macros like __INLINE__, so we recognize both types and known
6323 ;; specifiers after them too.
6325 (let* ((start (point)) kwd-sym kwd-clause-end found-type
)
6327 ;; Look for a specifier keyword clause.
6328 (when (or (looking-at c-prefix-spec-kwds-re
)
6329 (and (c-major-mode-is 'java-mode
)
6330 (looking-at "@[A-Za-z0-9]+")))
6331 (if (looking-at c-typedef-key
)
6332 (setq at-typedef t
))
6333 (setq kwd-sym
(c-keyword-sym (match-string 1)))
6335 (c-forward-keyword-clause 1)
6336 (setq kwd-clause-end
(point))))
6338 (when (setq found-type
(c-forward-type t
)) ; brace-block-too
6339 ;; Found a known or possible type or a prefix of a known type.
6342 ;; Got two identifiers with nothing but whitespace
6343 ;; between them. That can only happen in declarations.
6344 (setq at-decl-or-cast
'ids
)
6346 (when (eq at-type
'found
)
6347 ;; If the previous identifier is a found type we
6348 ;; record it as a real one; it might be some sort of
6349 ;; alias for a prefix like "unsigned".
6351 (goto-char type-start
)
6352 (let ((c-promote-possible-types t
))
6353 (c-forward-type)))))
6355 (setq backup-at-type at-type
6356 backup-type-start type-start
6357 backup-id-start id-start
6361 ;; The previous ambiguous specifier/type turned out
6362 ;; to be a type since we've parsed another one after
6363 ;; it, so clear these backup flags.
6364 backup-at-type-decl nil
6365 backup-maybe-typeless nil
))
6369 ;; Handle known specifier keywords and
6370 ;; `c-decl-hangon-kwds' which can occur after known
6373 (if (c-keyword-member kwd-sym
'c-decl-hangon-kwds
)
6374 ;; It's a hang-on keyword that can occur anywhere.
6376 (setq at-decl-or-cast t
)
6378 ;; Move the identifier start position if
6379 ;; we've passed a type.
6380 (setq id-start kwd-clause-end
)
6381 ;; Otherwise treat this as a specifier and
6382 ;; move the fallback position.
6383 (setq start-pos kwd-clause-end
))
6384 (goto-char kwd-clause-end
))
6386 ;; It's an ordinary specifier so we know that
6387 ;; anything before this can't be the type.
6388 (setq backup-at-type nil
6389 start-pos kwd-clause-end
)
6392 ;; It's ambiguous whether this keyword is a
6393 ;; specifier or a type prefix, so set the backup
6394 ;; flags. (It's assumed that `c-forward-type'
6395 ;; moved further than `c-forward-keyword-clause'.)
6397 (when (c-keyword-member kwd-sym
'c-typedef-decl-kwds
)
6398 (setq backup-at-type-decl t
))
6399 (when (c-keyword-member kwd-sym
'c-typeless-decl-kwds
)
6400 (setq backup-maybe-typeless t
)))
6402 (when (c-keyword-member kwd-sym
'c-typedef-decl-kwds
)
6403 ;; This test only happens after we've scanned a type.
6404 ;; So, with valid syntax, kwd-sym can't be 'typedef.
6405 (setq at-type-decl t
))
6406 (when (c-keyword-member kwd-sym
'c-typeless-decl-kwds
)
6407 (setq maybe-typeless t
))
6409 ;; Haven't matched a type so it's an umambiguous
6410 ;; specifier keyword and we know we're in a
6412 (setq at-decl-or-cast t
)
6414 (goto-char kwd-clause-end
))))
6416 ;; If the type isn't known we continue so that we'll jump
6417 ;; over all specifiers and type identifiers. The reason
6418 ;; to do this for a known type prefix is to make things
6419 ;; like "unsigned INT16" work.
6420 (and found-type
(not (eq found-type t
))))))
6424 ;; If a known type was found, we still need to skip over any
6425 ;; hangon keyword clauses after it. Otherwise it has already
6426 ;; been done in the loop above.
6427 (while (looking-at c-decl-hangon-key
)
6428 (c-forward-keyword-clause 1))
6429 (setq id-start
(point)))
6431 ((eq at-type
'prefix
)
6432 ;; A prefix type is itself a primitive type when it's not
6433 ;; followed by another type.
6437 ;; Got no type but set things up to continue anyway to handle
6438 ;; the various cases when a declaration doesn't start with a
6440 (setq id-start start-pos
))
6442 ((and (eq at-type
'maybe
)
6443 (c-major-mode-is 'c
++-mode
))
6444 ;; If it's C++ then check if the last "type" ends on the form
6445 ;; "foo::foo" or "foo::~foo", i.e. if it's the name of a
6446 ;; (con|de)structor.
6448 (let (name end-2 end-1
)
6449 (goto-char id-start
)
6450 (c-backward-syntactic-ws)
6451 (setq end-2
(point))
6453 (c-simple-skip-symbol-backward)
6456 (buffer-substring-no-properties (point) end-2
))
6457 ;; Cheating in the handling of syntactic ws below.
6458 (< (skip-chars-backward ":~ \t\n\r\v\f") 0))
6460 (setq end-1
(point))
6461 (c-simple-skip-symbol-backward))
6462 (>= (point) type-start
)
6463 (equal (buffer-substring-no-properties (point) end-1
)
6465 ;; It is a (con|de)structor name. In that case the
6466 ;; declaration is typeless so zap out any preceding
6467 ;; identifier(s) that we might have taken as types.
6468 (goto-char type-start
)
6471 id-start type-start
))))))
6473 ;; Check for and step over a type decl expression after the thing
6474 ;; that is or might be a type. This can't be skipped since we
6475 ;; need the correct end position of the declarator for
6476 ;; `max-type-decl-end-*'.
6477 (let ((start (point)) (paren-depth 0) pos
6478 ;; True if there's a non-open-paren match of
6479 ;; `c-type-decl-prefix-key'.
6481 ;; True if the declarator is surrounded by a parenthesis pair.
6483 ;; True if there is an identifier in the declarator.
6485 ;; True if there's a non-close-paren match of
6486 ;; `c-type-decl-suffix-key'.
6488 ;; True if there's a prefix match outside the outermost
6489 ;; paren pair that surrounds the declarator.
6490 got-prefix-before-parens
6491 ;; True if there's a suffix match outside the outermost
6492 ;; paren pair that surrounds the declarator. The value is
6493 ;; the position of the first suffix match.
6494 got-suffix-after-parens
6495 ;; True if we've parsed the type decl to a token that is
6496 ;; known to end declarations in this context.
6498 ;; The earlier values of `at-type' and `type-start' if we've
6499 ;; shifted the type backwards.
6500 identifier-type identifier-start
6501 ;; If `c-parse-and-markup-<>-arglists' is set we need to
6502 ;; turn it off during the name skipping below to avoid
6503 ;; getting `c-type' properties that might be bogus. That
6504 ;; can happen since we don't know if
6505 ;; `c-restricted-<>-arglists' will be correct inside the
6506 ;; arglist paren that gets entered.
6507 c-parse-and-markup-
<>-arglists
)
6509 (goto-char id-start
)
6511 ;; Skip over type decl prefix operators. (Note similar code in
6512 ;; `c-font-lock-declarators'.)
6513 (while (and (looking-at c-type-decl-prefix-key
)
6514 (if (and (c-major-mode-is 'c
++-mode
)
6515 (match-beginning 3))
6516 ;; If the second submatch matches in C++ then
6517 ;; we're looking at an identifier that's a
6518 ;; prefix only if it specifies a member pointer.
6519 (when (setq got-identifier
(c-forward-name))
6520 (if (looking-at "\\(::\\)")
6521 ;; We only check for a trailing "::" and
6522 ;; let the "*" that should follow be
6523 ;; matched in the next round.
6524 (progn (setq got-identifier nil
) t
)
6525 ;; It turned out to be the real identifier,
6530 (if (eq (char-after) ?\
()
6532 (setq paren-depth
(1+ paren-depth
))
6534 (unless got-prefix-before-parens
6535 (setq got-prefix-before-parens
(= paren-depth
0)))
6537 (goto-char (match-end 1)))
6538 (c-forward-syntactic-ws))
6540 (setq got-parens
(> paren-depth
0))
6542 ;; Skip over an identifier.
6544 (and (looking-at c-identifier-start
)
6545 (setq got-identifier
(c-forward-name))))
6547 ;; Skip over type decl suffix operators.
6548 (while (if (looking-at c-type-decl-suffix-key
)
6550 (if (eq (char-after) ?\
))
6551 (when (> paren-depth
0)
6552 (setq paren-depth
(1- paren-depth
))
6555 (when (if (save-match-data (looking-at "\\s\("))
6556 (c-safe (c-forward-sexp 1) t
)
6557 (goto-char (match-end 1))
6559 (when (and (not got-suffix-after-parens
)
6561 (setq got-suffix-after-parens
(match-beginning 0)))
6562 (setq got-suffix t
)))
6564 ;; No suffix matched. We might have matched the
6565 ;; identifier as a type and the open paren of a
6566 ;; function arglist as a type decl prefix. In that
6567 ;; case we should "backtrack": Reinterpret the last
6568 ;; type as the identifier, move out of the arglist and
6569 ;; continue searching for suffix operators.
6571 ;; Do this even if there's no preceding type, to cope
6572 ;; with old style function declarations in K&R C,
6573 ;; (con|de)structors in C++ and `c-typeless-decl-kwds'
6574 ;; style declarations. That isn't applicable in an
6575 ;; arglist context, though.
6576 (when (and (= paren-depth
1)
6577 (not got-prefix-before-parens
)
6578 (not (eq at-type t
))
6581 backup-maybe-typeless
6582 (when c-recognize-typeless-decls
6584 (setq pos
(c-up-list-forward (point)))
6585 (eq (char-before pos
) ?\
)))
6586 (c-fdoc-shift-type-backward)
6590 (c-forward-syntactic-ws))
6592 (when (and (or maybe-typeless backup-maybe-typeless
)
6593 (not got-identifier
)
6596 ;; Have found no identifier but `c-typeless-decl-kwds' has
6597 ;; matched so we know we're inside a declaration. The
6598 ;; preceding type must be the identifier instead.
6599 (c-fdoc-shift-type-backward))
6603 (catch 'at-decl-or-cast
6606 (when (> paren-depth
0)
6607 ;; Encountered something inside parens that isn't matched by
6608 ;; the `c-type-decl-*' regexps, so it's not a type decl
6609 ;; expression. Try to skip out to the same paren depth to
6610 ;; not confuse the cast check below.
6611 (c-safe (goto-char (scan-lists (point) 1 paren-depth
)))
6612 ;; If we've found a specifier keyword then it's a
6613 ;; declaration regardless.
6614 (throw 'at-decl-or-cast
(eq at-decl-or-cast t
)))
6617 (looking-at (cond ((eq context
'<>) "[,>]")
6621 ;; Now we've collected info about various characteristics of
6622 ;; the construct we're looking at. Below follows a decision
6623 ;; tree based on that. It's ordered to check more certain
6624 ;; signs before less certain ones.
6630 (when (and (or at-type maybe-typeless
)
6631 (not (or got-prefix got-parens
)))
6632 ;; Got another identifier directly after the type, so it's a
6634 (throw 'at-decl-or-cast t
))
6636 (when (and got-parens
6638 (not got-suffix-after-parens
)
6641 backup-maybe-typeless
))
6642 ;; Got a declaration of the form "foo bar (gnu);" where we've
6643 ;; recognized "bar" as the type and "gnu" as the declarator.
6644 ;; In this case it's however more likely that "bar" is the
6645 ;; declarator and "gnu" a function argument or initializer (if
6646 ;; `c-recognize-paren-inits' is set), since the parens around
6647 ;; "gnu" would be superfluous if it's a declarator. Shift the
6648 ;; type one step backward.
6649 (c-fdoc-shift-type-backward)))
6651 ;; Found no identifier.
6658 (when (= (point) start
)
6659 ;; Got a plain list of identifiers. If a colon follows it's
6660 ;; a valid label, or maybe a bitfield. Otherwise the last
6661 ;; one probably is the declared identifier and we should
6662 ;; back up to the previous type, providing it isn't a cast.
6663 (if (and (eq (char-after) ?
:)
6664 (not (c-major-mode-is 'java-mode
)))
6666 ;; If we've found a specifier keyword then it's a
6667 ;; declaration regardless.
6668 ((eq at-decl-or-cast t
)
6669 (throw 'at-decl-or-cast t
))
6670 ((and c-has-bitfields
6671 (eq at-decl-or-cast
'ids
)) ; bitfield.
6672 (setq backup-if-not-cast t
)
6673 (throw 'at-decl-or-cast t
)))
6675 (setq backup-if-not-cast t
)
6676 (throw 'at-decl-or-cast t
)))
6679 (when (and got-suffix
6682 ;; Got a plain list of identifiers followed by some suffix.
6683 ;; If this isn't a cast then the last identifier probably is
6684 ;; the declared one and we should back up to the previous
6686 (setq backup-if-not-cast t
)
6687 (throw 'at-decl-or-cast t
)))
6690 (when (eq at-type t
)
6691 ;; If the type is known we know that there can't be any
6692 ;; identifier somewhere else, and it's only in declarations in
6693 ;; e.g. function prototypes and in casts that the identifier may
6695 (throw 'at-decl-or-cast t
))
6697 (when (= (point) start
)
6698 ;; Only got a single identifier (parsed as a type so far).
6701 ;; Check that the identifier isn't at the start of an
6706 ;; Inside an arglist that contains declarations. If K&R
6707 ;; style declarations and parenthesis style initializers
6708 ;; aren't allowed then the single identifier must be a
6709 ;; type, else we require that it's known or found
6710 ;; (primitive types are handled above).
6711 (or (and (not c-recognize-knr-p
)
6712 (not c-recognize-paren-inits
))
6713 (memq at-type
'(known found
))))
6715 ;; Inside a template arglist. Accept known and found
6716 ;; types; other identifiers could just as well be
6717 ;; constants in C++.
6718 (memq at-type
'(known found
)))))
6719 (throw 'at-decl-or-cast t
)
6721 ;; Can't be a valid declaration or cast, but if we've found a
6722 ;; specifier it can't be anything else either, so treat it as
6723 ;; an invalid/unfinished declaration or cast.
6724 (throw 'at-decl-or-cast at-decl-or-cast
))))
6729 (not (eq at-type t
))
6732 backup-maybe-typeless
6733 (when c-recognize-typeless-decls
6734 (or (not got-suffix
)
6736 c-after-suffixed-type-maybe-decl-key
))))))
6737 ;; Got an empty paren pair and a preceding type that probably
6738 ;; really is the identifier. Shift the type backwards to make
6739 ;; the last one the identifier. This is analogous to the
6740 ;; "backtracking" done inside the `c-type-decl-suffix-key' loop
6743 ;; Exception: In addition to the conditions in that
6744 ;; "backtracking" code, do not shift backward if we're not
6745 ;; looking at either `c-after-suffixed-type-decl-key' or "[;,]".
6746 ;; Since there's no preceding type, the shift would mean that
6747 ;; the declaration is typeless. But if the regexp doesn't match
6748 ;; then we will simply fall through in the tests below and not
6749 ;; recognize it at all, so it's better to try it as an abstract
6750 ;; declarator instead.
6751 (c-fdoc-shift-type-backward)
6753 ;; Still no identifier.
6755 (when (and got-prefix
(or got-parens got-suffix
))
6756 ;; Require `got-prefix' together with either `got-parens' or
6757 ;; `got-suffix' to recognize it as an abstract declarator:
6758 ;; `got-parens' only is probably an empty function call.
6759 ;; `got-suffix' only can build an ordinary expression together
6760 ;; with the preceding identifier which we've taken as a type.
6761 ;; We could actually accept on `got-prefix' only, but that can
6762 ;; easily occur temporarily while writing an expression so we
6763 ;; avoid that case anyway. We could do a better job if we knew
6764 ;; the point when the fontification was invoked.
6765 (throw 'at-decl-or-cast t
))
6771 got-suffix-after-parens
6772 (eq (char-after got-suffix-after-parens
) ?\
())
6773 ;; Got a type, no declarator but a paren suffix. I.e. it's a
6774 ;; normal function call afterall (or perhaps a C++ style object
6775 ;; instantiation expression).
6776 (throw 'at-decl-or-cast nil
))))
6779 (when at-decl-or-cast
6780 ;; By now we've located the type in the declaration that we know
6782 (throw 'at-decl-or-cast t
))
6785 (when (and got-identifier
6787 (looking-at c-after-suffixed-type-decl-key
)
6791 (not (eq at-type t
)))
6792 ;; Shift the type backward in the case that there's a
6793 ;; single identifier inside parens. That can only
6794 ;; occur in K&R style function declarations so it's
6795 ;; more likely that it really is a function call.
6796 ;; Therefore we only do this after
6797 ;; `c-after-suffixed-type-decl-key' has matched.
6798 (progn (c-fdoc-shift-type-backward) t
)
6799 got-suffix-after-parens
))
6800 ;; A declaration according to `c-after-suffixed-type-decl-key'.
6801 (throw 'at-decl-or-cast t
))
6804 (when (and (or got-prefix
(not got-parens
))
6805 (memq at-type
'(t known
)))
6806 ;; It's a declaration if a known type precedes it and it can't be a
6808 (throw 'at-decl-or-cast t
))
6810 ;; If we get here we can't tell if this is a type decl or a normal
6811 ;; expression by looking at it alone. (That's under the assumption
6812 ;; that normal expressions always can look like type decl expressions,
6813 ;; which isn't really true but the cases where it doesn't hold are so
6814 ;; uncommon (e.g. some placements of "const" in C++) it's not worth
6815 ;; the effort to look for them.)
6817 (unless (or at-decl-end
(looking-at "=[^=]"))
6818 ;; If this is a declaration it should end here or its initializer(*)
6819 ;; should start here, so check for allowed separation tokens. Note
6820 ;; that this rule doesn't work e.g. with a K&R arglist after a
6823 ;; *) Don't check for C++ style initializers using parens
6824 ;; since those already have been matched as suffixes.
6826 ;; If `at-decl-or-cast' is then we've found some other sign that
6827 ;; it's a declaration or cast, so then it's probably an
6828 ;; invalid/unfinished one.
6829 (throw 'at-decl-or-cast at-decl-or-cast
))
6831 ;; Below are tests that only should be applied when we're certain to
6832 ;; not have parsed halfway through an expression.
6835 (when (memq at-type
'(t known
))
6836 ;; The expression starts with a known type so treat it as a
6838 (throw 'at-decl-or-cast t
))
6841 (when (and (c-major-mode-is 'c
++-mode
)
6842 ;; In C++ we check if the identifier is a known type, since
6843 ;; (con|de)structors use the class name as identifier.
6844 ;; We've always shifted over the identifier as a type and
6845 ;; then backed up again in this case.
6847 (or (memq identifier-type
'(found known
))
6848 (and (eq (char-after identifier-start
) ?~
)
6849 ;; `at-type' probably won't be 'found for
6850 ;; destructors since the "~" is then part of the
6851 ;; type name being checked against the list of
6852 ;; known types, so do a check without that
6855 (goto-char (1+ identifier-start
))
6856 (c-forward-syntactic-ws)
6857 (c-with-syntax-table
6858 c-identifier-syntax-table
6859 (looking-at c-known-type-key
)))
6861 (goto-char (1+ identifier-start
))
6862 ;; We have already parsed the type earlier,
6863 ;; so it'd be possible to cache the end
6864 ;; position instead of redoing it here, but
6865 ;; then we'd need to keep track of another
6866 ;; position everywhere.
6867 (c-check-type (point)
6868 (progn (c-forward-type)
6870 (throw 'at-decl-or-cast t
))
6875 (when (and got-prefix-before-parens
6877 (or at-decl-end
(looking-at "=[^=]"))
6880 ;; Got something like "foo * bar;". Since we're not inside an
6881 ;; arglist it would be a meaningless expression because the
6882 ;; result isn't used. We therefore choose to recognize it as
6883 ;; a declaration. Do not allow a suffix since it could then
6884 ;; be a function call.
6885 (throw 'at-decl-or-cast t
))
6888 (when (and (or got-suffix-after-parens
6889 (looking-at "=[^=]"))
6891 (not (eq context
'arglist
)))
6892 ;; Got something like "a (*b) (c);" or "a (b) = c;". It could
6893 ;; be an odd expression or it could be a declaration. Treat
6894 ;; it as a declaration if "a" has been used as a type
6895 ;; somewhere else (if it's a known type we won't get here).
6896 (throw 'at-decl-or-cast t
)))
6901 (and (eq context
'decl
)
6902 (not c-recognize-paren-inits
)
6903 (or got-parens got-suffix
))))
6904 ;; Got a type followed by an abstract declarator. If `got-prefix'
6905 ;; is set it's something like "a *" without anything after it. If
6906 ;; `got-parens' or `got-suffix' is set it's "a()", "a[]", "a()[]",
6907 ;; or similar, which we accept only if the context rules out
6909 (throw 'at-decl-or-cast t
)))
6911 ;; If we had a complete symbol table here (which rules out
6912 ;; `c-found-types') we should return t due to the disambiguation rule
6913 ;; (in at least C++) that anything that can be parsed as a declaration
6914 ;; is a declaration. Now we're being more defensive and prefer to
6915 ;; highlight things like "foo (bar);" as a declaration only if we're
6916 ;; inside an arglist that contains declarations.
6917 (eq context
'decl
))))
6919 ;; The point is now after the type decl expression.
6922 ;; Check for a cast.
6927 ;; Should be the first type/identifier in a cast paren.
6928 (> preceding-token-end
(point-min))
6929 (memq (char-before preceding-token-end
) c-cast-parens
)
6931 ;; The closing paren should follow.
6933 (c-forward-syntactic-ws)
6934 (looking-at "\\s\)"))
6936 ;; There should be a primary expression after it.
6939 (c-forward-syntactic-ws)
6940 (setq cast-end
(point))
6941 (and (looking-at c-primary-expr-regexp
)
6943 (setq pos
(match-end 0))
6945 ;; Check if the expression begins with a prefix keyword.
6947 (if (match-beginning 1)
6948 ;; Expression begins with an ambiguous operator. Treat
6949 ;; it as a cast if it's a type decl or if we've
6950 ;; recognized the type somewhere else.
6952 (memq at-type
'(t known found
)))
6953 ;; Unless it's a keyword, it's the beginning of a primary
6955 (not (looking-at c-keywords-regexp
)))))
6956 ;; If `c-primary-expr-regexp' matched a nonsymbol token, check
6957 ;; that it matched a whole one so that we don't e.g. confuse
6958 ;; the operator '-' with '->'. It's ok if it matches further,
6959 ;; though, since it e.g. can match the float '.5' while the
6960 ;; operator regexp only matches '.'.
6961 (or (not (looking-at c-nonsymbol-token-regexp
))
6962 (<= (match-end 0) pos
))))
6964 ;; There should either be a cast before it or something that isn't an
6965 ;; identifier or close paren.
6966 (> preceding-token-end
(point-min))
6968 (goto-char (1- preceding-token-end
))
6969 (or (eq (point) last-cast-end
)
6971 (c-backward-syntactic-ws)
6972 (if (< (skip-syntax-backward "w_") 0)
6973 ;; It's a symbol. Accept it only if it's one of the
6974 ;; keywords that can precede an expression (without
6975 ;; surrounding parens).
6976 (looking-at c-simple-stmt-key
)
6978 ;; Check that it isn't a close paren (block close is ok,
6980 (not (memq (char-before) '(?\
) ?\
])))
6981 ;; Check that it isn't a nonsymbol identifier.
6982 (not (c-on-identifier)))))))))
6985 (when (and c-record-type-identifiers at-type
(not (eq at-type t
)))
6986 (let ((c-promote-possible-types t
))
6987 (goto-char type-start
)
6990 (goto-char cast-end
)
6994 ;; We're at a declaration. Highlight the type and the following
6997 (when backup-if-not-cast
6998 (c-fdoc-shift-type-backward t
))
7000 (when (and (eq context
'decl
) (looking-at ","))
7001 ;; Make sure to propagate the `c-decl-arg-start' property to
7002 ;; the next argument if it's set in this one, to cope with
7003 ;; interactive refontification.
7004 (c-put-c-type-property (point) 'c-decl-arg-start
))
7006 (when (and c-record-type-identifiers at-type
(not (eq at-type t
)))
7007 (let ((c-promote-possible-types t
))
7009 (goto-char type-start
)
7013 (and (or at-type-decl at-typedef
)
7014 (cons at-type-decl at-typedef
))))
7017 ;; False alarm. Restore the recorded ranges.
7018 (setq c-record-type-identifiers save-rec-type-ids
7019 c-record-ref-identifiers save-rec-ref-ids
)
7022 (defun c-forward-label (&optional assume-markup preceding-token-end limit
)
7023 ;; Assuming that point is at the beginning of a token, check if it starts a
7024 ;; label and if so move over it and return non-nil (t in default situations,
7025 ;; specific symbols (see below) for interesting situations), otherwise don't
7026 ;; move and return nil. "Label" here means "most things with a colon".
7028 ;; More precisely, a "label" is regarded as one of:
7029 ;; (i) a goto target like "foo:" - returns the symbol `goto-target';
7030 ;; (ii) A case label - either the entire construct "case FOO:", or just the
7031 ;; bare "case", should the colon be missing. We return t;
7032 ;; (iii) a keyword which needs a colon, like "default:" or "private:"; We
7034 ;; (iv) One of QT's "extended" C++ variants of
7035 ;; "private:"/"protected:"/"public:"/"more:" looking like "public slots:".
7036 ;; Returns the symbol `qt-2kwds-colon'.
7037 ;; (v) QT's construct "signals:". Returns the symbol `qt-1kwd-colon'.
7038 ;; (vi) One of the keywords matched by `c-opt-extra-label-key' (without any
7039 ;; colon). Currently (2006-03), this applies only to Objective C's
7040 ;; keywords "@private", "@protected", and "@public". Returns t.
7042 ;; One of the things which will NOT be recognised as a label is a bit-field
7043 ;; element of a struct, something like "int foo:5".
7045 ;; The end of the label is taken to be just after the colon, or the end of
7046 ;; the first submatch in `c-opt-extra-label-key'. The point is directly
7047 ;; after the end on return. The terminating char gets marked with
7048 ;; `c-decl-end' to improve recognition of the following declaration or
7051 ;; If ASSUME-MARKUP is non-nil, it's assumed that the preceding
7052 ;; label, if any, has already been marked up like that.
7054 ;; If PRECEDING-TOKEN-END is given, it should be the first position
7055 ;; after the preceding token, i.e. on the other side of the
7056 ;; syntactic ws from the point. Use a value less than or equal to
7057 ;; (point-min) if the point is at the first token in (the visible
7058 ;; part of) the buffer.
7060 ;; The optional LIMIT limits the forward scan for the colon.
7062 ;; This function records the ranges of the label symbols on
7063 ;; `c-record-ref-identifiers' if `c-record-type-identifiers' (!) is
7066 ;; This function might do hidden buffer changes.
7068 (let ((start (point))
7071 macro-start
; if we're in one.
7075 ;; "case" or "default" (Doesn't apply to AWK).
7076 ((looking-at c-label-kwds-regexp
)
7077 (let ((kwd-end (match-end 1)))
7078 ;; Record only the keyword itself for fontification, since in
7079 ;; case labels the following is a constant expression and not
7081 (when c-record-type-identifiers
7082 (c-record-ref-id (cons (match-beginning 1) kwd-end
)))
7084 ;; Find the label end.
7087 (if (and (c-syntactic-re-search-forward
7088 ;; Stop on chars that aren't allowed in expressions,
7089 ;; and on operator chars that would be meaningless
7090 ;; there. FIXME: This doesn't cope with ?: operators.
7091 "[;{=,@]\\|\\(\\=\\|[^:]\\):\\([^:]\\|\\'\\)"
7093 (match-beginning 2))
7095 (progn ; there's a proper :
7096 (goto-char (match-beginning 2)) ; just after the :
7097 (c-put-c-type-property (1- (point)) 'c-decl-end
)
7100 ;; It's an unfinished label. We consider the keyword enough
7101 ;; to recognize it as a label, so that it gets fontified.
7102 ;; Leave the point at the end of it, but don't put any
7103 ;; `c-decl-end' marker.
7107 ;; @private, @protected, @public, in Objective C, or similar.
7108 ((and c-opt-extra-label-key
7109 (looking-at c-opt-extra-label-key
))
7110 ;; For a `c-opt-extra-label-key' match, we record the whole
7111 ;; thing for fontification. That's to get the leading '@' in
7112 ;; Objective-C protection labels fontified.
7113 (goto-char (match-end 1))
7114 (when c-record-type-identifiers
7115 (c-record-ref-id (cons (match-beginning 1) (point))))
7116 (c-put-c-type-property (1- (point)) 'c-decl-end
)
7117 (setq label-type t
))
7119 ;; All other cases of labels.
7120 ((and c-recognize-colon-labels
; nil for AWK and IDL, otherwise t.
7122 ;; A colon label must have something before the colon.
7123 (not (eq (char-after) ?
:))
7125 ;; Check that we're not after a token that can't precede a label.
7127 ;; Trivially succeeds when there's no preceding token.
7128 (if preceding-token-end
7129 (<= preceding-token-end
(point-min))
7131 (c-backward-syntactic-ws)
7132 (setq preceding-token-end
(point))
7135 ;; Check if we're after a label, if we're after a closing
7136 ;; paren that belong to statement, and with
7137 ;; `c-label-prefix-re'. It's done in different order
7138 ;; depending on `assume-markup' since the checks have
7139 ;; different expensiveness.
7142 (eq (c-get-char-property (1- preceding-token-end
) 'c-type
)
7146 (goto-char (1- preceding-token-end
))
7147 (c-beginning-of-current-token)
7148 (or (looking-at c-label-prefix-re
)
7149 (looking-at c-block-stmt-1-key
)))
7151 (and (eq (char-before preceding-token-end
) ?\
))
7152 (c-after-conditional)))
7156 (goto-char (1- preceding-token-end
))
7157 (c-beginning-of-current-token)
7158 (or (looking-at c-label-prefix-re
)
7159 (looking-at c-block-stmt-1-key
)))
7162 ((eq (char-before preceding-token-end
) ?\
))
7163 (c-after-conditional))
7165 ((eq (char-before preceding-token-end
) ?
:)
7166 ;; Might be after another label, so check it recursively.
7169 (goto-char (1- preceding-token-end
))
7170 ;; Essentially the same as the
7171 ;; `c-syntactic-re-search-forward' regexp below.
7173 (save-excursion (and (c-beginning-of-macro)
7175 (if macro-start
(narrow-to-region macro-start
(point-max)))
7176 (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+" nil t
)
7177 ;; Note: the following should work instead of the
7178 ;; narrow-to-region above. Investigate why not,
7179 ;; sometime. ACM, 2006-03-31.
7180 ;; (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+"
7183 ;; If the caller turned on recording for us,
7184 ;; it shouldn't apply when we check the
7186 c-record-type-identifiers
)
7187 ;; A label can't start at a cpp directive. Check for
7188 ;; this, since c-forward-syntactic-ws would foul up on it.
7189 (unless (and c-opt-cpp-prefix
(looking-at c-opt-cpp-prefix
))
7190 (c-forward-syntactic-ws)
7191 (c-forward-label nil pte start
))))))))))
7193 ;; Point is still at the beginning of the possible label construct.
7195 ;; Check that the next nonsymbol token is ":", or that we're in one
7196 ;; of QT's "slots" declarations. Allow '(' for the sake of macro
7197 ;; arguments. FIXME: Should build this regexp from the language
7200 ;; public: protected: private:
7202 (c-major-mode-is 'c
++-mode
)
7203 (search-forward-regexp
7204 "\\=p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\>[^_]" nil t
)
7205 (progn (backward-char)
7206 (c-forward-syntactic-ws limit
)
7207 (looking-at ":\\([^:]\\|\\'\\)"))) ; A single colon.
7209 (setq label-type t
))
7210 ;; QT double keyword like "protected slots:" or goto target.
7211 ((progn (goto-char start
) nil
))
7212 ((when (c-syntactic-re-search-forward
7213 "[ \t\n[:?;{=*/%&|,<>!@+-]" limit t t
) ; not at EOB
7215 (setq label-end
(point))
7217 (and (c-major-mode-is 'c
++-mode
)
7219 "\\(p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\|more\\)\\>"
7220 (buffer-substring start
(point)))))
7221 (c-forward-syntactic-ws limit
)
7223 ((looking-at ":\\([^:]\\|\\'\\)") ; A single colon.
7226 (if (or (string= "signals" ; Special QT macro
7227 (setq kwd
(buffer-substring-no-properties start label-end
)))
7228 (string= "Q_SIGNALS" kwd
))
7232 (search-forward-regexp "\\=\\(slots\\|Q_SLOTS\\)\\>" limit t
)
7233 (progn (c-forward-syntactic-ws limit
)
7234 (looking-at ":\\([^:]\\|\\'\\)"))) ; A single colon
7236 (setq label-type
'qt-2kwds-colon
)))))))
7239 (narrow-to-region start
(point))
7241 ;; Check that `c-nonlabel-token-key' doesn't match anywhere.
7245 (when (looking-at c-nonlabel-token-key
)
7247 (setq label-type nil
)
7248 (throw 'check-label nil
))
7249 (and (c-safe (c-forward-sexp)
7250 (c-forward-syntactic-ws)
7254 ;; Record the identifiers in the label for fontification, unless
7255 ;; it begins with `c-label-kwds' in which case the following
7256 ;; identifiers are part of a (constant) expression that
7257 ;; shouldn't be fontified.
7258 (when (and c-record-type-identifiers
7259 (progn (goto-char start
)
7260 (not (looking-at c-label-kwds-regexp
))))
7261 (while (c-syntactic-re-search-forward c-symbol-key nil t
)
7262 (c-record-ref-id (cons (match-beginning 0)
7265 (c-put-c-type-property (1- (point-max)) 'c-decl-end
)
7266 (goto-char (point-max)))))
7273 (defun c-forward-objc-directive ()
7274 ;; Assuming the point is at the beginning of a token, try to move
7275 ;; forward to the end of the Objective-C directive that starts
7276 ;; there. Return t if a directive was fully recognized, otherwise
7277 ;; the point is moved as far as one could be successfully parsed and
7280 ;; This function records identifier ranges on
7281 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
7282 ;; `c-record-type-identifiers' is non-nil.
7284 ;; This function might do hidden buffer changes.
7286 (let ((start (point))
7288 (c-promote-possible-types t
)
7289 ;; Turn off recognition of angle bracket arglists while parsing
7290 ;; types here since the protocol reference list might then be
7291 ;; considered part of the preceding name or superclass-name.
7292 c-recognize-
<>-arglists
)
7297 (c-make-keywords-re t
7298 (append (c-lang-const c-protection-kwds objc
)
7301 (goto-char (match-end 1))
7307 (c-make-keywords-re t
7308 '("@interface" "@implementation" "@protocol")
7311 ;; Handle the name of the class itself.
7313 ; (c-forward-token-2) ; 2006/1/13 This doesn't move if the token's
7315 (goto-char (match-end 0))
7320 ;; Look for ": superclass-name" or "( category-name )".
7321 (when (looking-at "[:\(]")
7322 (setq start-char
(char-after))
7324 (c-forward-syntactic-ws)
7325 (unless (c-forward-type) (throw 'break nil
))
7326 (when (eq start-char ?\
()
7327 (unless (eq (char-after) ?\
)) (throw 'break nil
))
7329 (c-forward-syntactic-ws)))
7331 ;; Look for a protocol reference list.
7332 (if (eq (char-after) ?
<)
7333 (let ((c-recognize-<>-arglists t
)
7334 (c-parse-and-markup-<>-arglists t
)
7335 c-restricted-
<>-arglists
)
7336 (c-forward-<>-arglist t
))
7340 (c-backward-syntactic-ws)
7341 (c-clear-c-type-property start
(1- (point)) 'c-decl-end
)
7342 (c-put-c-type-property (1- (point)) 'c-decl-end
)
7345 (c-clear-c-type-property start
(point) 'c-decl-end
)
7348 (defun c-beginning-of-inheritance-list (&optional lim
)
7349 ;; Go to the first non-whitespace after the colon that starts a
7350 ;; multiple inheritance introduction. Optional LIM is the farthest
7351 ;; back we should search.
7353 ;; This function might do hidden buffer changes.
7354 (c-with-syntax-table c
++-template-syntax-table
7355 (c-backward-token-2 0 t lim
)
7356 (while (and (or (looking-at c-symbol-start
)
7357 (looking-at "[<,]\\|::"))
7358 (zerop (c-backward-token-2 1 t lim
))))))
7360 (defun c-in-method-def-p ()
7361 ;; Return nil if we aren't in a method definition, otherwise the
7362 ;; position of the initial [+-].
7364 ;; This function might do hidden buffer changes.
7367 (and c-opt-method-key
7368 (looking-at c-opt-method-key
)
7372 ;; Contributed by Kevin Ryde <user42@zip.com.au>.
7373 (defun c-in-gcc-asm-p ()
7374 ;; Return non-nil if point is within a gcc \"asm\" block.
7376 ;; This should be called with point inside an argument list.
7378 ;; Only one level of enclosing parentheses is considered, so for
7379 ;; instance `nil' is returned when in a function call within an asm
7382 ;; This function might do hidden buffer changes.
7384 (and c-opt-asm-stmt-key
7387 (backward-up-list 1)
7388 (c-beginning-of-statement-1 (point-min) nil t
)
7389 (looking-at c-opt-asm-stmt-key
))))
7391 (defun c-at-toplevel-p ()
7392 "Return a determination as to whether point is \"at the top level\".
7393 Informally, \"at the top level\" is anywhere where you can write
7396 More precisely, being at the top-level means that point is either
7397 outside any enclosing block (such as a function definition), or
7398 directly inside a class, namespace or other block that contains
7399 another declaration level.
7401 If point is not at the top-level (e.g. it is inside a method
7402 definition), then nil is returned. Otherwise, if point is at a
7403 top-level not enclosed within a class definition, t is returned.
7404 Otherwise, a 2-vector is returned where the zeroth element is the
7405 buffer position of the start of the class declaration, and the first
7406 element is the buffer position of the enclosing class's opening
7409 Note that this function might do hidden buffer changes. See the
7410 comment at the start of cc-engine.el for more info."
7411 (let ((paren-state (c-parse-state)))
7412 (or (not (c-most-enclosing-brace paren-state
))
7413 (c-search-uplist-for-classkey paren-state
))))
7415 (defun c-just-after-func-arglist-p (&optional lim
)
7416 ;; Return non-nil if the point is in the region after the argument
7417 ;; list of a function and its opening brace (or semicolon in case it
7418 ;; got no body). If there are K&R style argument declarations in
7419 ;; that region, the point has to be inside the first one for this
7420 ;; function to recognize it.
7422 ;; If successful, the point is moved to the first token after the
7423 ;; function header (see `c-forward-decl-or-cast-1' for details) and
7424 ;; the position of the opening paren of the function arglist is
7427 ;; The point is clobbered if not successful.
7429 ;; LIM is used as bound for backward buffer searches.
7431 ;; This function might do hidden buffer changes.
7433 (let ((beg (point)) end id-start
)
7435 (eq (c-beginning-of-statement-1 lim
) 'same
)
7437 (not (or (c-major-mode-is 'objc-mode
)
7438 (c-forward-objc-directive)))
7441 (car-safe (c-forward-decl-or-cast-1 (c-point 'bosws
) nil nil
)))
7444 ;; There should not be a '=' or ',' between beg and the
7445 ;; start of the declaration since that means we were in the
7446 ;; "expression part" of the declaration.
7448 (not (looking-at "[=,]")))
7451 ;; Check that there's an arglist paren in the
7453 (goto-char id-start
)
7454 (cond ((eq (char-after) ?\
()
7455 ;; The declarator is a paren expression, so skip past it
7456 ;; so that we don't get stuck on that instead of the
7457 ;; function arglist.
7459 ((and c-opt-op-identifier-prefix
7460 (looking-at c-opt-op-identifier-prefix
))
7461 ;; Don't trip up on "operator ()".
7462 (c-forward-token-2 2 t
)))
7463 (and (< (point) beg
)
7464 (c-syntactic-re-search-forward "(" beg t t
)
7467 (defun c-in-knr-argdecl (&optional lim
)
7468 ;; Return the position of the first argument declaration if point is
7469 ;; inside a K&R style argument declaration list, nil otherwise.
7470 ;; `c-recognize-knr-p' is not checked. If LIM is non-nil, it's a
7471 ;; position that bounds the backward search for the argument list.
7473 ;; Point must be within a possible K&R region, e.g. just before a top-level
7474 ;; "{". It must be outside of parens and brackets. The test can return
7475 ;; false positives otherwise.
7477 ;; This function might do hidden buffer changes.
7481 ;; If we're in a macro, our search range is restricted to it. Narrow to
7482 ;; the searchable range.
7483 (let* ((macro-start (c-query-macro-start))
7484 (lim (max (or lim
(point-min)) (or macro-start
(point-min))))
7485 before-lparen after-rparen
7486 (pp-count-out 20)) ; Max number of paren/brace constructs before we give up
7487 (narrow-to-region lim
(c-point 'eol
))
7489 ;; Search backwards for the defun's argument list. We give up if we
7490 ;; encounter a "}" (end of a previous defun) or BOB.
7492 ;; The criterion for a paren structure being the arg list is:
7493 ;; o - there is non-WS stuff after it but before any "{"; AND
7494 ;; o - the token after it isn't a ";" AND
7495 ;; o - it is preceded by either an identifier (the function name) or
7496 ;; a macro expansion like "DEFUN (...)"; AND
7497 ;; o - its content is a non-empty comma-separated list of identifiers
7498 ;; (an empty arg list won't have a knr region).
7500 ;; The following snippet illustrates these rules:
7501 ;; int foo (bar, baz, yuk)
7503 ;; int (*baz) (my_type) ;
7504 ;; int (*) (void) (*yuk) (void) ;
7508 (while (> pp-count-out
0) ; go back one paren/bracket pair each time.
7509 (setq pp-count-out
(1- pp-count-out
))
7510 (c-syntactic-skip-backward "^)]}")
7511 (cond ((eq (char-before) ?\
))
7512 (setq after-rparen
(point)))
7513 ((eq (char-before) ?\
])
7514 (setq after-rparen nil
))
7515 (t ; either } (hit previous defun) or no more parens/brackets
7519 ;; We're inside a paren. Could it be our argument list....?
7523 (goto-char after-rparen
)
7524 (unless (c-go-list-backward) (throw 'knr nil
)) ;
7525 ;; FIXME!!! What about macros between the parens? 2007/01/20
7526 (setq before-lparen
(point)))
7528 ;; It can't be the arg list if next token is ; or {
7529 (progn (goto-char after-rparen
)
7530 (c-forward-syntactic-ws)
7531 (not (memq (char-after) '(?\
; ?\{))))
7533 ;; Is the thing preceding the list an identifier (the
7534 ;; function name), or a macro expansion?
7536 (goto-char before-lparen
)
7537 (eq (c-backward-token-2) 0)
7538 (or (c-on-identifier)
7539 (and (eq (char-after) ?\
))
7540 (c-go-up-list-backward)
7541 (eq (c-backward-token-2) 0)
7542 (c-on-identifier))))
7544 ;; Have we got a non-empty list of comma-separated
7547 (goto-char before-lparen
)
7548 (c-forward-token-2) ; to first token inside parens
7553 (while (eq (char-after) ?\
,)
7555 (unless (c-on-identifier) (throw 'id-list nil
))
7556 (c-forward-token-2))
7557 (eq (char-after) ?\
))))))
7559 ;; ...Yes. We've identified the function's argument list.
7561 (progn (goto-char after-rparen
)
7562 (c-forward-syntactic-ws)
7565 ;; ...No. The current parens aren't the function's arg list.
7566 (goto-char before-lparen
))
7568 (or (c-go-list-backward) ; backwards over [ .... ]
7569 (throw 'knr nil
)))))))))
7571 (defun c-skip-conditional ()
7572 ;; skip forward over conditional at point, including any predicate
7573 ;; statements in parentheses. No error checking is performed.
7575 ;; This function might do hidden buffer changes.
7576 (c-forward-sexp (cond
7578 ((looking-at (concat "\\<else"
7579 "\\([ \t\n]\\|\\\\\n\\)+"
7580 "if\\>\\([^_]\\|$\\)"))
7582 ;; do, else, try, finally
7583 ((looking-at (concat "\\<\\("
7584 "do\\|else\\|try\\|finally"
7585 "\\)\\>\\([^_]\\|$\\)"))
7587 ;; for, if, while, switch, catch, synchronized, foreach
7590 (defun c-after-conditional (&optional lim
)
7591 ;; If looking at the token after a conditional then return the
7592 ;; position of its start, otherwise return nil.
7594 ;; This function might do hidden buffer changes.
7596 (and (zerop (c-backward-token-2 1 t lim
))
7597 (or (looking-at c-block-stmt-1-key
)
7598 (and (eq (char-after) ?\
()
7599 (zerop (c-backward-token-2 1 t lim
))
7600 (looking-at c-block-stmt-2-key
)))
7603 (defun c-after-special-operator-id (&optional lim
)
7604 ;; If the point is after an operator identifier that isn't handled
7605 ;; like an ordinary symbol (i.e. like "operator =" in C++) then the
7606 ;; position of the start of that identifier is returned. nil is
7607 ;; returned otherwise. The point may be anywhere in the syntactic
7608 ;; whitespace after the last token of the operator identifier.
7610 ;; This function might do hidden buffer changes.
7612 (and c-overloadable-operators-regexp
7613 (zerop (c-backward-token-2 1 nil lim
))
7614 (looking-at c-overloadable-operators-regexp
)
7615 (or (not c-opt-op-identifier-prefix
)
7617 (zerop (c-backward-token-2 1 nil lim
))
7618 (looking-at c-opt-op-identifier-prefix
)))
7621 (defsubst c-backward-to-block-anchor
(&optional lim
)
7622 ;; Assuming point is at a brace that opens a statement block of some
7623 ;; kind, move to the proper anchor point for that block. It might
7624 ;; need to be adjusted further by c-add-stmt-syntax, but the
7625 ;; position at return is suitable as start position for that
7628 ;; This function might do hidden buffer changes.
7629 (unless (= (point) (c-point 'boi
))
7630 (let ((start (c-after-conditional lim
)))
7632 (goto-char start
)))))
7634 (defsubst c-backward-to-decl-anchor
(&optional lim
)
7635 ;; Assuming point is at a brace that opens the block of a top level
7636 ;; declaration of some kind, move to the proper anchor point for
7639 ;; This function might do hidden buffer changes.
7640 (unless (= (point) (c-point 'boi
))
7641 (c-beginning-of-statement-1 lim
)))
7643 (defun c-search-decl-header-end ()
7644 ;; Search forward for the end of the "header" of the current
7645 ;; declaration. That's the position where the definition body
7646 ;; starts, or the first variable initializer, or the ending
7647 ;; semicolon. I.e. search forward for the closest following
7648 ;; (syntactically relevant) '{', '=' or ';' token. Point is left
7649 ;; _after_ the first found token, or at point-max if none is found.
7651 ;; This function might do hidden buffer changes.
7653 (let ((base (point)))
7654 (if (c-major-mode-is 'c
++-mode
)
7656 ;; In C++ we need to take special care to handle operator
7657 ;; tokens and those pesky template brackets.
7659 (c-syntactic-re-search-forward "[;{<=]" nil
'move t t
)
7661 (c-end-of-current-token base
)
7662 ;; Handle operator identifiers, i.e. ignore any
7663 ;; operator token preceded by "operator".
7665 (and (c-safe (c-backward-sexp) t
)
7666 (looking-at c-opt-op-identifier-prefix
)))
7667 (and (eq (char-before) ?
<)
7668 (c-with-syntax-table c
++-template-syntax-table
7669 (if (c-safe (goto-char (c-up-list-forward (point))))
7671 (goto-char (point-max))
7673 (setq base
(point)))
7676 (c-syntactic-re-search-forward "[;{=]" nil
'move t t
)
7677 (c-end-of-current-token base
))
7678 (setq base
(point))))))
7680 (defun c-beginning-of-decl-1 (&optional lim
)
7681 ;; Go to the beginning of the current declaration, or the beginning
7682 ;; of the previous one if already at the start of it. Point won't
7683 ;; be moved out of any surrounding paren. Return a cons cell of the
7684 ;; form (MOVE . KNR-POS). MOVE is like the return value from
7685 ;; `c-beginning-of-statement-1'. If point skipped over some K&R
7686 ;; style argument declarations (and they are to be recognized) then
7687 ;; KNR-POS is set to the start of the first such argument
7688 ;; declaration, otherwise KNR-POS is nil. If LIM is non-nil, it's a
7689 ;; position that bounds the backward search.
7691 ;; NB: Cases where the declaration continues after the block, as in
7692 ;; "struct foo { ... } bar;", are currently recognized as two
7693 ;; declarations, e.g. "struct foo { ... }" and "bar;" in this case.
7695 ;; This function might do hidden buffer changes.
7697 (let* ((start (point))
7698 (last-stmt-start (point))
7699 (move (c-beginning-of-statement-1 lim nil t
)))
7701 ;; `c-beginning-of-statement-1' stops at a block start, but we
7702 ;; want to continue if the block doesn't begin a top level
7703 ;; construct, i.e. if it isn't preceded by ';', '}', ':', bob,
7704 ;; or an open paren.
7705 (let ((beg (point)) tentative-move
)
7706 ;; Go back one "statement" each time round the loop until we're just
7707 ;; after a ;, }, or :, or at BOB or the start of a macro or start of
7708 ;; an ObjC method. This will move over a multiple declaration whose
7709 ;; components are comma separated.
7711 ;; Must check with c-opt-method-key in ObjC mode.
7712 (not (and c-opt-method-key
7713 (looking-at c-opt-method-key
)))
7714 (/= last-stmt-start
(point))
7716 (c-backward-syntactic-ws lim
)
7717 (not (memq (char-before) '(?\
; ?} ?: nil))))
7720 (not (looking-at "\\s(")))
7721 ;; Check that we don't move from the first thing in a
7722 ;; macro to its header.
7723 (not (eq (setq tentative-move
7724 (c-beginning-of-statement-1 lim nil t
))
7726 (setq last-stmt-start beg
7728 move tentative-move
))
7731 (when c-recognize-knr-p
7732 (let ((fallback-pos (point)) knr-argdecl-start
)
7733 ;; Handle K&R argdecls. Back up after the "statement" jumped
7734 ;; over by `c-beginning-of-statement-1', unless it was the
7735 ;; function body, in which case we're sitting on the opening
7736 ;; brace now. Then test if we're in a K&R argdecl region and
7737 ;; that we started at the other side of the first argdecl in
7739 (unless (eq (char-after) ?
{)
7740 (goto-char last-stmt-start
))
7741 (if (and (setq knr-argdecl-start
(c-in-knr-argdecl lim
))
7742 (< knr-argdecl-start start
)
7744 (goto-char knr-argdecl-start
)
7745 (not (eq (c-beginning-of-statement-1 lim nil t
) 'macro
))))
7747 (cons (if (eq (char-after fallback-pos
) ?
{)
7751 (goto-char fallback-pos
))))
7753 ;; `c-beginning-of-statement-1' counts each brace block as a separate
7754 ;; statement, so the result will be 'previous if we've moved over any.
7755 ;; So change our result back to 'same if necessary.
7757 ;; If they were brace list initializers we might not have moved over a
7758 ;; declaration boundary though, so change it to 'same if we've moved
7759 ;; past a '=' before '{', but not ';'. (This ought to be integrated
7760 ;; into `c-beginning-of-statement-1', so we avoid this extra pass which
7761 ;; potentially can search over a large amount of text.). Take special
7762 ;; pains not to get mislead by C++'s "operator=", and the like.
7763 (if (and (eq move
'previous
)
7764 (c-with-syntax-table (if (c-major-mode-is 'c
++-mode
)
7765 c
++-template-syntax-table
7770 (while ; keep going back to "[;={"s until we either find
7771 ; no more, or get to one which isn't an "operator ="
7772 (and (c-syntactic-re-search-forward "[;={]" start t t t
)
7773 (eq (char-before) ?
=)
7774 c-overloadable-operators-regexp
7775 c-opt-op-identifier-prefix
7777 (eq (c-backward-token-2) 0)
7778 (looking-at c-overloadable-operators-regexp
)
7779 (eq (c-backward-token-2) 0)
7780 (looking-at c-opt-op-identifier-prefix
))))
7781 (eq (char-before) ?
=))
7782 (c-syntactic-re-search-forward "[;{]" start t t
)
7783 (eq (char-before) ?
{)
7784 (c-safe (goto-char (c-up-list-forward (point))) t
)
7785 (not (c-syntactic-re-search-forward ";" start t t
))))))
7789 (defun c-end-of-decl-1 ()
7790 ;; Assuming point is at the start of a declaration (as detected by
7791 ;; e.g. `c-beginning-of-decl-1'), go to the end of it. Unlike
7792 ;; `c-beginning-of-decl-1', this function handles the case when a
7793 ;; block is followed by identifiers in e.g. struct declarations in C
7794 ;; or C++. If a proper end was found then t is returned, otherwise
7795 ;; point is moved as far as possible within the current sexp and nil
7796 ;; is returned. This function doesn't handle macros; use
7797 ;; `c-end-of-macro' instead in those cases.
7799 ;; This function might do hidden buffer changes.
7800 (let ((start (point))
7801 (decl-syntax-table (if (c-major-mode-is 'c
++-mode
)
7802 c
++-template-syntax-table
7805 (c-search-decl-header-end)
7807 (when (and c-recognize-knr-p
7808 (eq (char-before) ?\
;)
7809 (c-in-knr-argdecl start
))
7810 ;; Stopped at the ';' in a K&R argdecl section which is
7811 ;; detected using the same criteria as in
7812 ;; `c-beginning-of-decl-1'. Move to the following block
7814 (c-syntactic-re-search-forward "{" nil
'move t
))
7816 (when (eq (char-before) ?
{)
7817 ;; Encountered a block in the declaration. Jump over it.
7819 (goto-char (c-up-list-forward (point)))
7820 (error (goto-char (point-max))
7821 (throw 'return nil
)))
7822 (if (or (not c-opt-block-decls-with-vars-key
)
7824 (c-with-syntax-table decl-syntax-table
7825 (let ((lim (point)))
7828 ;; Check for `c-opt-block-decls-with-vars-key'
7829 ;; before the first paren.
7830 (c-syntactic-re-search-forward
7831 (concat "[;=\(\[{]\\|\\("
7832 c-opt-block-decls-with-vars-key
7836 (not (eq (char-before) ?_
))
7837 ;; Check that the first following paren is
7839 (c-syntactic-re-search-forward "[;=\(\[{]"
7841 (eq (char-before) ?
{)))))))
7842 ;; The declaration doesn't have any of the
7843 ;; `c-opt-block-decls-with-vars' keywords in the
7844 ;; beginning, so it ends here at the end of the block.
7847 (c-with-syntax-table decl-syntax-table
7849 (if (eq (char-before) ?\
;)
7851 (c-syntactic-re-search-forward ";" nil
'move t
))))
7854 (defun c-looking-at-decl-block (containing-sexp goto-start
&optional limit
)
7855 ;; Assuming the point is at an open brace, check if it starts a
7856 ;; block that contains another declaration level, i.e. that isn't a
7857 ;; statement block or a brace list, and if so return non-nil.
7859 ;; If the check is successful, the return value is the start of the
7860 ;; keyword that tells what kind of construct it is, i.e. typically
7861 ;; what `c-decl-block-key' matched. Also, if GOTO-START is set then
7862 ;; the point will be at the start of the construct, before any
7863 ;; leading specifiers, otherwise it's at the returned position.
7865 ;; The point is clobbered if the check is unsuccessful.
7867 ;; CONTAINING-SEXP is the position of the open of the surrounding
7868 ;; paren, or nil if none.
7870 ;; The optional LIMIT limits the backward search for the start of
7871 ;; the construct. It's assumed to be at a syntactically relevant
7874 ;; If any template arglists are found in the searched region before
7875 ;; the open brace, they get marked with paren syntax.
7877 ;; This function might do hidden buffer changes.
7879 (let ((open-brace (point)) kwd-start first-specifier-pos
)
7880 (c-syntactic-skip-backward c-block-prefix-charset limit t
)
7882 (when (and c-recognize-
<>-arglists
7883 (eq (char-before) ?
>))
7884 ;; Could be at the end of a template arglist.
7885 (let ((c-parse-and-markup-<>-arglists t
)
7886 (c-disallow-comma-in-<>-arglists
7887 (and containing-sexp
7888 (not (eq (char-after containing-sexp
) ?
{)))))
7890 (c-backward-<>-arglist nil limit
)
7892 (c-syntactic-skip-backward c-block-prefix-charset limit t
)
7893 (eq (char-before) ?
>))))))
7895 ;; Note: Can't get bogus hits inside template arglists below since they
7896 ;; have gotten paren syntax above.
7898 ;; If `goto-start' is set we begin by searching for the
7899 ;; first possible position of a leading specifier list.
7900 ;; The `c-decl-block-key' search continues from there since
7901 ;; we know it can't match earlier.
7903 (when (c-syntactic-re-search-forward c-symbol-start
7905 (goto-char (setq first-specifier-pos
(match-beginning 0)))
7910 ((c-syntactic-re-search-forward c-decl-block-key open-brace t t t
)
7911 (goto-char (setq kwd-start
(match-beginning 0)))
7914 ;; Found a keyword that can't be a type?
7917 ;; Can be a type too, in which case it's the return type of a
7918 ;; function (under the assumption that no declaration level
7919 ;; block construct starts with a type).
7920 (not (c-forward-type))
7922 ;; Jumped over a type, but it could be a declaration keyword
7923 ;; followed by the declared identifier that we've jumped over
7924 ;; instead (e.g. in "class Foo {"). If it indeed is a type
7925 ;; then we should be at the declarator now, so check for a
7926 ;; valid declarator start.
7928 ;; Note: This doesn't cope with the case when a declared
7929 ;; identifier is followed by e.g. '(' in a language where '('
7930 ;; also might be part of a declarator expression. Currently
7931 ;; there's no such language.
7932 (not (or (looking-at c-symbol-start
)
7933 (looking-at c-type-decl-prefix-key
)))))
7935 ;; In Pike a list of modifiers may be followed by a brace
7936 ;; to make them apply to many identifiers. Note that the
7937 ;; match data will be empty on return in this case.
7938 ((and (c-major-mode-is 'pike-mode
)
7940 (goto-char open-brace
)
7941 (= (c-backward-token-2) 0))
7942 (looking-at c-specifier-key
)
7943 ;; Use this variant to avoid yet another special regexp.
7944 (c-keyword-member (c-keyword-sym (match-string 1))
7946 (setq kwd-start
(point))
7952 ;; Back up over any preceding specifiers and their clauses
7953 ;; by going forward from `first-specifier-pos', which is the
7954 ;; earliest possible position where the specifier list can
7957 (goto-char first-specifier-pos
)
7959 (while (< (point) kwd-start
)
7960 (if (looking-at c-symbol-key
)
7961 ;; Accept any plain symbol token on the ground that
7962 ;; it's a specifier masked through a macro (just
7963 ;; like `c-forward-decl-or-cast-1' skip forward over
7966 ;; Could be more restrictive wrt invalid keywords,
7967 ;; but that'd only occur in invalid code so there's
7968 ;; no use spending effort on it.
7969 (let ((end (match-end 0)))
7970 (unless (c-forward-keyword-clause 0)
7972 (c-forward-syntactic-ws)))
7974 ;; Can't parse a declaration preamble and is still
7975 ;; before `kwd-start'. That means `first-specifier-pos'
7976 ;; was in some earlier construct. Search again.
7977 (if (c-syntactic-re-search-forward c-symbol-start
7979 (goto-char (setq first-specifier-pos
(match-beginning 0)))
7980 ;; Got no preamble before the block declaration keyword.
7981 (setq first-specifier-pos kwd-start
))))
7983 (goto-char first-specifier-pos
))
7984 (goto-char kwd-start
))
7988 (defun c-search-uplist-for-classkey (paren-state)
7989 ;; Check if the closest containing paren sexp is a declaration
7990 ;; block, returning a 2 element vector in that case. Aref 0
7991 ;; contains the bufpos at boi of the class key line, and aref 1
7992 ;; contains the bufpos of the open brace. This function is an
7993 ;; obsolete wrapper for `c-looking-at-decl-block'.
7995 ;; This function might do hidden buffer changes.
7996 (let ((open-paren-pos (c-most-enclosing-brace paren-state
)))
7997 (when open-paren-pos
7999 (goto-char open-paren-pos
)
8000 (when (and (eq (char-after) ?
{)
8001 (c-looking-at-decl-block
8002 (c-safe-position open-paren-pos paren-state
)
8004 (back-to-indentation)
8005 (vector (point) open-paren-pos
))))))
8007 (defun c-inside-bracelist-p (containing-sexp paren-state
)
8008 ;; return the buffer position of the beginning of the brace list
8009 ;; statement if we're inside a brace list, otherwise return nil.
8010 ;; CONTAINING-SEXP is the buffer pos of the innermost containing
8011 ;; paren. PAREN-STATE is the remainder of the state of enclosing
8014 ;; N.B.: This algorithm can potentially get confused by cpp macros
8015 ;; placed in inconvenient locations. It's a trade-off we make for
8018 ;; This function might do hidden buffer changes.
8020 ;; This will pick up brace list declarations.
8023 (goto-char containing-sexp
)
8026 (if (and (or (looking-at c-brace-list-key
)
8027 (progn (c-forward-sexp -
1)
8028 (looking-at c-brace-list-key
)))
8029 (setq bracepos
(c-down-list-forward (point)))
8030 (not (c-crosses-statement-barrier-p (point)
8033 ;; this will pick up array/aggregate init lists, even if they are nested.
8036 ;; Pike can have class definitions anywhere, so we must
8037 ;; check for the class key here.
8038 (and (c-major-mode-is 'pike-mode
)
8040 bufpos braceassignp lim next-containing
)
8041 (while (and (not bufpos
)
8044 (if (consp (car paren-state
))
8045 (setq lim
(cdr (car paren-state
))
8046 paren-state
(cdr paren-state
))
8047 (setq lim
(car paren-state
)))
8049 (setq next-containing
(car paren-state
)
8050 paren-state
(cdr paren-state
))))
8051 (goto-char containing-sexp
)
8052 (if (c-looking-at-inexpr-block next-containing next-containing
)
8053 ;; We're in an in-expression block of some kind. Do not
8054 ;; check nesting. We deliberately set the limit to the
8055 ;; containing sexp, so that c-looking-at-inexpr-block
8056 ;; doesn't check for an identifier before it.
8057 (setq containing-sexp nil
)
8058 ;; see if the open brace is preceded by = or [...] in
8059 ;; this statement, but watch out for operator=
8060 (setq braceassignp
'dontknow
)
8061 (c-backward-token-2 1 t lim
)
8062 ;; Checks to do only on the first sexp before the brace.
8063 (when (and c-opt-inexpr-brace-list-key
8064 (eq (char-after) ?\
[))
8065 ;; In Java, an initialization brace list may follow
8066 ;; directly after "new Foo[]", so check for a "new"
8068 (while (eq braceassignp
'dontknow
)
8070 (cond ((/= (c-backward-token-2 1 t lim
) 0) nil
)
8071 ((looking-at c-opt-inexpr-brace-list-key
) t
)
8072 ((looking-at "\\sw\\|\\s_\\|[.[]")
8073 ;; Carry on looking if this is an
8074 ;; identifier (may contain "." in Java)
8075 ;; or another "[]" sexp.
8078 ;; Checks to do on all sexps before the brace, up to the
8079 ;; beginning of the statement.
8080 (while (eq braceassignp
'dontknow
)
8081 (cond ((eq (char-after) ?\
;)
8082 (setq braceassignp nil
))
8084 (looking-at class-key
))
8085 (setq braceassignp nil
))
8086 ((eq (char-after) ?
=)
8087 ;; We've seen a =, but must check earlier tokens so
8088 ;; that it isn't something that should be ignored.
8089 (setq braceassignp
'maybe
)
8090 (while (and (eq braceassignp
'maybe
)
8091 (zerop (c-backward-token-2 1 t lim
)))
8094 ;; Check for operator =
8095 ((and c-opt-op-identifier-prefix
8096 (looking-at c-opt-op-identifier-prefix
))
8098 ;; Check for `<opchar>= in Pike.
8099 ((and (c-major-mode-is 'pike-mode
)
8100 (or (eq (char-after) ?
`)
8101 ;; Special case for Pikes
8102 ;; `[]=, since '[' is not in
8103 ;; the punctuation class.
8104 (and (eq (char-after) ?\
[)
8105 (eq (char-before) ?
`))))
8107 ((looking-at "\\s.") 'maybe
)
8108 ;; make sure we're not in a C++ template
8109 ;; argument assignment
8111 (c-major-mode-is 'c
++-mode
)
8113 (let ((here (point))
8115 (skip-chars-backward "^<>")
8117 (and (eq (char-before) ?
<)
8118 (not (c-crosses-statement-barrier-p
8120 (not (c-in-literal))
8124 (if (and (eq braceassignp
'dontknow
)
8125 (/= (c-backward-token-2 1 t lim
) 0))
8126 (setq braceassignp nil
)))
8127 (if (not braceassignp
)
8128 (if (eq (char-after) ?\
;)
8129 ;; Brace lists can't contain a semicolon, so we're done.
8130 (setq containing-sexp nil
)
8132 (setq containing-sexp next-containing
8134 next-containing nil
))
8135 ;; we've hit the beginning of the aggregate list
8136 (c-beginning-of-statement-1
8137 (c-most-enclosing-brace paren-state
))
8138 (setq bufpos
(point))))
8143 (defun c-looking-at-special-brace-list (&optional lim
)
8144 ;; If we're looking at the start of a pike-style list, ie `({Â })',
8145 ;; `([Â ])', `(<Â >)' etc, a cons of a cons of its starting and ending
8146 ;; positions and its entry in c-special-brace-lists is returned, nil
8147 ;; otherwise. The ending position is nil if the list is still open.
8148 ;; LIM is the limit for forward search. The point may either be at
8149 ;; the `(' or at the following paren character. Tries to check the
8150 ;; matching closer, but assumes it's correct if no balanced paren is
8151 ;; found (i.e. the case `({ ... } ... )' is detected as _not_ being
8152 ;; a special brace list).
8154 ;; This function might do hidden buffer changes.
8155 (if c-special-brace-lists
8160 (c-forward-syntactic-ws)
8161 (if (eq (char-after) ?\
()
8164 (c-forward-syntactic-ws)
8165 (setq inner-beg
(point))
8166 (setq type
(assq (char-after) c-special-brace-lists
)))
8167 (if (setq type
(assq (char-after) c-special-brace-lists
))
8169 (setq inner-beg
(point))
8170 (c-backward-syntactic-ws)
8172 (setq beg
(if (eq (char-after) ?\
()
8180 (= (char-before) ?\
)))
8182 (goto-char inner-beg
)
8183 (if (looking-at "\\s(")
8184 ;; Check balancing of the inner paren
8189 ;; If the inner char isn't a paren then
8190 ;; we can't check balancing, so just
8191 ;; check the char before the outer
8195 (c-backward-syntactic-ws)
8196 (= (char-before) (cdr type
)))))
8197 (if (or (/= (char-syntax (char-before)) ?\
))
8199 (c-forward-syntactic-ws)
8202 (cons (cons beg end
) type
))
8203 (cons (list beg
) type
)))))
8206 (defun c-looking-at-bos (&optional lim
)
8207 ;; Return non-nil if between two statements or declarations, assuming
8208 ;; point is not inside a literal or comment.
8210 ;; Obsolete - `c-at-statement-start-p' or `c-at-expression-start-p'
8211 ;; are recommended instead.
8213 ;; This function might do hidden buffer changes.
8214 (c-at-statement-start-p))
8215 (make-obsolete 'c-looking-at-bos
'c-at-statement-start-p
"22.1")
8217 (defun c-looking-at-inexpr-block (lim containing-sexp
&optional check-at-end
)
8218 ;; Return non-nil if we're looking at the beginning of a block
8219 ;; inside an expression. The value returned is actually a cons of
8220 ;; either 'inlambda, 'inexpr-statement or 'inexpr-class and the
8221 ;; position of the beginning of the construct.
8223 ;; LIM limits the backward search. CONTAINING-SEXP is the start
8224 ;; position of the closest containing list. If it's nil, the
8225 ;; containing paren isn't used to decide whether we're inside an
8226 ;; expression or not. If both LIM and CONTAINING-SEXP are used, LIM
8227 ;; needs to be farther back.
8229 ;; If CHECK-AT-END is non-nil then extra checks at the end of the
8230 ;; brace block might be done. It should only be used when the
8231 ;; construct can be assumed to be complete, i.e. when the original
8232 ;; starting position was further down than that.
8234 ;; This function might do hidden buffer changes.
8237 (let ((res 'maybe
) passed-paren
8238 (closest-lim (or containing-sexp lim
(point-min)))
8239 ;; Look at the character after point only as a last resort
8240 ;; when we can't disambiguate.
8241 (block-follows (and (eq (char-after) ?
{) (point))))
8243 (while (and (eq res
'maybe
)
8244 (progn (c-backward-syntactic-ws)
8245 (> (point) closest-lim
))
8247 (progn (backward-char)
8248 (looking-at "[\]\).]\\|\\w\\|\\s_"))
8249 (c-safe (forward-char)
8250 (goto-char (scan-sexps (point) -
1))))
8253 (if (looking-at c-keywords-regexp
)
8254 (let ((kw-sym (c-keyword-sym (match-string 1))))
8257 (c-keyword-member kw-sym
'c-inexpr-class-kwds
))
8258 (and (not (eq passed-paren ?\
[))
8259 (or (not (looking-at c-class-key
))
8260 ;; If the class definition is at the start of
8261 ;; a statement, we don't consider it an
8262 ;; in-expression class.
8263 (let ((prev (point)))
8265 (= (c-backward-token-2 1 nil closest-lim
) 0)
8266 (eq (char-syntax (char-after)) ?w
))
8267 (setq prev
(point)))
8269 (not (c-at-statement-start-p)))
8270 ;; Also, in Pike we treat it as an
8271 ;; in-expression class if it's used in an
8272 ;; object clone expression.
8275 (c-major-mode-is 'pike-mode
)
8276 (progn (goto-char block-follows
)
8277 (zerop (c-forward-token-2 1 t
)))
8278 (eq (char-after) ?\
())))
8279 (cons 'inexpr-class
(point))))
8280 ((c-keyword-member kw-sym
'c-inexpr-block-kwds
)
8281 (when (not passed-paren
)
8282 (cons 'inexpr-statement
(point))))
8283 ((c-keyword-member kw-sym
'c-lambda-kwds
)
8284 (when (or (not passed-paren
)
8285 (eq passed-paren ?\
())
8286 (cons 'inlambda
(point))))
8287 ((c-keyword-member kw-sym
'c-block-stmt-kwds
)
8292 (if (looking-at "\\s(")
8294 (if (and (eq passed-paren ?\
[)
8295 (eq (char-after) ?\
[))
8296 ;; Accept several square bracket sexps for
8297 ;; Java array initializations.
8299 (setq passed-paren
(char-after))
8304 (when (and c-recognize-paren-inexpr-blocks
8307 (eq (char-after containing-sexp
) ?\
())
8308 (goto-char containing-sexp
)
8309 (if (or (save-excursion
8310 (c-backward-syntactic-ws lim
)
8311 (and (> (point) (or lim
(point-min)))
8313 (and c-special-brace-lists
8314 (c-looking-at-special-brace-list)))
8316 (cons 'inexpr-statement
(point))))
8320 (defun c-looking-at-inexpr-block-backward (paren-state)
8321 ;; Returns non-nil if we're looking at the end of an in-expression
8322 ;; block, otherwise the same as `c-looking-at-inexpr-block'.
8323 ;; PAREN-STATE is the paren state relevant at the current position.
8325 ;; This function might do hidden buffer changes.
8327 ;; We currently only recognize a block.
8328 (let ((here (point))
8329 (elem (car-safe paren-state
))
8331 (when (and (consp elem
)
8332 (progn (goto-char (cdr elem
))
8333 (c-forward-syntactic-ws here
)
8335 (goto-char (car elem
))
8336 (if (setq paren-state
(cdr paren-state
))
8337 (setq containing-sexp
(car-safe paren-state
)))
8338 (c-looking-at-inexpr-block (c-safe-position containing-sexp
8340 containing-sexp
)))))
8343 ;; `c-guess-basic-syntax' and the functions that precedes it below
8344 ;; implements the main decision tree for determining the syntactic
8345 ;; analysis of the current line of code.
8347 ;; Dynamically bound to t when `c-guess-basic-syntax' is called during
8348 ;; auto newline analysis.
8349 (defvar c-auto-newline-analysis nil
)
8351 (defun c-brace-anchor-point (bracepos)
8352 ;; BRACEPOS is the position of a brace in a construct like "namespace
8353 ;; Bar {". Return the anchor point in this construct; this is the
8354 ;; earliest symbol on the brace's line which isn't earlier than
8357 ;; Currently (2007-08-17), "like namespace" means "matches
8358 ;; c-other-block-decl-kwds". It doesn't work with "class" or "struct"
8359 ;; or anything like that.
8361 (let ((boi (c-point 'boi bracepos
)))
8362 (goto-char bracepos
)
8363 (while (and (> (point) boi
)
8364 (not (looking-at c-other-decl-block-key
)))
8365 (c-backward-token-2))
8366 (if (> (point) boi
) (point) boi
))))
8368 (defsubst c-add-syntax
(symbol &rest args
)
8369 ;; A simple function to prepend a new syntax element to
8370 ;; `c-syntactic-context'. Using `setq' on it is unsafe since it
8371 ;; should always be dynamically bound but since we read it first
8372 ;; we'll fail properly anyway if this function is misused.
8373 (setq c-syntactic-context
(cons (cons symbol args
)
8374 c-syntactic-context
)))
8376 (defsubst c-append-syntax
(symbol &rest args
)
8377 ;; Like `c-add-syntax' but appends to the end of the syntax list.
8378 ;; (Normally not necessary.)
8379 (setq c-syntactic-context
(nconc c-syntactic-context
8380 (list (cons symbol args
)))))
8382 (defun c-add-stmt-syntax (syntax-symbol
8387 ;; Add the indicated SYNTAX-SYMBOL to `c-syntactic-context', extending it as
8388 ;; needed with further syntax elements of the types `substatement',
8389 ;; `inexpr-statement', `arglist-cont-nonempty', `statement-block-intro', and
8390 ;; `defun-block-intro'.
8392 ;; Do the generic processing to anchor the given syntax symbol on
8393 ;; the preceding statement: Skip over any labels and containing
8394 ;; statements on the same line, and then search backward until we
8395 ;; find a statement or block start that begins at boi without a
8396 ;; label or comment.
8398 ;; Point is assumed to be at the prospective anchor point for the
8399 ;; given SYNTAX-SYMBOL. More syntax entries are added if we need to
8400 ;; skip past open parens and containing statements. Most of the added
8401 ;; syntax elements will get the same anchor point - the exception is
8402 ;; for an anchor in a construct like "namespace"[*] - this is as early
8403 ;; as possible in the construct but on the same line as the {.
8405 ;; [*] i.e. with a keyword matching c-other-block-decl-kwds.
8407 ;; SYNTAX-EXTRA-ARGS are a list of the extra arguments for the
8408 ;; syntax symbol. They are appended after the anchor point.
8410 ;; If STOP-AT-BOI-ONLY is nil, we can stop in the middle of the line
8411 ;; if the current statement starts there.
8413 ;; Note: It's not a problem if PAREN-STATE "overshoots"
8414 ;; CONTAINING-SEXP, i.e. contains info about parens further down.
8416 ;; This function might do hidden buffer changes.
8418 (if (= (point) (c-point 'boi
))
8419 ;; This is by far the most common case, so let's give it special
8421 (apply 'c-add-syntax syntax-symbol
(point) syntax-extra-args
)
8423 (let ((syntax-last c-syntactic-context
)
8424 (boi (c-point 'boi
))
8425 ;; Set when we're on a label, so that we don't stop there.
8426 ;; FIXME: To be complete we should check if we're on a label
8427 ;; now at the start.
8430 ;; Use point as the anchor point for "namespace", "extern", etc.
8431 (apply 'c-add-syntax syntax-symbol
8432 (if (rassq syntax-symbol c-other-decl-block-key-in-symbols-alist
)
8436 ;; Loop while we have to back out of containing blocks.
8439 (catch 'back-up-block
8441 ;; Loop while we have to back up statements.
8442 (while (or (/= (point) boi
)
8444 (looking-at c-comment-start-regexp
))
8446 ;; Skip past any comments that stands between the
8447 ;; statement start and boi.
8448 (let ((savepos (point)))
8449 (while (and (/= savepos boi
)
8450 (c-backward-single-comment))
8451 (setq savepos
(point)
8452 boi
(c-point 'boi
)))
8453 (goto-char savepos
))
8455 ;; Skip to the beginning of this statement or backward
8457 (let ((old-pos (point))
8459 (step-type (c-beginning-of-statement-1 containing-sexp
)))
8460 (setq boi
(c-point 'boi
)
8461 on-label
(eq step-type
'label
))
8463 (cond ((= (point) old-pos
)
8464 ;; If we didn't move we're at the start of a block and
8465 ;; have to continue outside it.
8466 (throw 'back-up-block t
))
8468 ((and (eq step-type
'up
)
8469 (>= (point) old-boi
)
8470 (looking-at "else\\>[^_]")
8473 (looking-at "if\\>[^_]")))
8474 ;; Special case to avoid deeper and deeper indentation
8475 ;; of "else if" clauses.
8478 ((and (not stop-at-boi-only
)
8479 (/= old-pos old-boi
)
8480 (memq step-type
'(up previous
)))
8481 ;; If stop-at-boi-only is nil, we shouldn't back up
8482 ;; over previous or containing statements to try to
8483 ;; reach boi, so go back to the last position and
8486 (throw 'back-up-block nil
))
8489 (if (and (not stop-at-boi-only
)
8490 (memq step-type
'(up previous beginning
)))
8491 ;; If we've moved into another statement then we
8492 ;; should no longer try to stop in the middle of a
8494 (setq stop-at-boi-only t
))
8496 ;; Record this as a substatement if we skipped up one
8498 (when (eq step-type
'up
)
8499 (c-add-syntax 'substatement nil
))))
8504 ;; Now we have to go out of this block.
8505 (goto-char containing-sexp
)
8507 ;; Don't stop in the middle of a special brace list opener
8509 (when c-special-brace-lists
8510 (let ((special-list (c-looking-at-special-brace-list)))
8511 (when (and special-list
8512 (< (car (car special-list
)) (point)))
8513 (setq containing-sexp
(car (car special-list
)))
8514 (goto-char containing-sexp
))))
8516 (setq paren-state
(c-whack-state-after containing-sexp paren-state
)
8517 containing-sexp
(c-most-enclosing-brace paren-state
)
8520 ;; Analyze the construct in front of the block we've stepped out
8521 ;; from and add the right syntactic element for it.
8522 (let ((paren-pos (point))
8523 (paren-char (char-after))
8526 (if (eq paren-char ?\
()
8527 ;; Stepped out of a parenthesis block, so we're in an
8530 (when (/= paren-pos boi
)
8531 (if (and c-recognize-paren-inexpr-blocks
8533 (c-backward-syntactic-ws containing-sexp
)
8534 (or (not (looking-at "\\>"))
8535 (not (c-on-identifier))))
8537 (goto-char (1+ paren-pos
))
8538 (c-forward-syntactic-ws)
8539 (eq (char-after) ?
{)))
8540 ;; Stepped out of an in-expression statement. This
8541 ;; syntactic element won't get an anchor pos.
8542 (c-add-syntax 'inexpr-statement
)
8544 ;; A parenthesis normally belongs to an arglist.
8545 (c-add-syntax 'arglist-cont-nonempty nil paren-pos
)))
8549 (1+ containing-sexp
)
8551 (setq step-type
'same
8554 ;; Stepped out of a brace block.
8555 (setq step-type
(c-beginning-of-statement-1 containing-sexp
)
8556 on-label
(eq step-type
'label
))
8558 (if (and (eq step-type
'same
)
8559 (/= paren-pos
(point)))
8563 (goto-char paren-pos
)
8564 (setq inexpr
(c-looking-at-inexpr-block
8565 (c-safe-position containing-sexp paren-state
)
8567 (c-add-syntax (if (eq (car inexpr
) 'inlambda
)
8569 'statement-block-intro
)
8571 ((looking-at c-other-decl-block-key
)
8573 (cdr (assoc (match-string 1)
8574 c-other-decl-block-key-in-symbols-alist
))
8575 (max (c-point 'boi paren-pos
) (point))))
8576 (t (c-add-syntax 'defun-block-intro nil
))))
8578 (c-add-syntax 'statement-block-intro nil
)))
8580 (if (= paren-pos boi
)
8581 ;; Always done if the open brace was at boi. The
8582 ;; c-beginning-of-statement-1 call above is necessary
8583 ;; anyway, to decide the type of block-intro to add.
8584 (goto-char paren-pos
)
8585 (setq boi
(c-point 'boi
)))
8588 ;; Fill in the current point as the anchor for all the symbols
8590 (let ((p c-syntactic-context
) q
)
8591 (while (not (eq p syntax-last
))
8592 (setq q
(cdr (car p
))) ; e.g. (nil 28) [from (arglist-cont-nonempty nil 28)]
8600 (defun c-add-class-syntax (symbol
8601 containing-decl-open
8602 containing-decl-start
8605 ;; The inclass and class-close syntactic symbols are added in
8606 ;; several places and some work is needed to fix everything.
8607 ;; Therefore it's collected here.
8609 ;; This function might do hidden buffer changes.
8610 (goto-char containing-decl-open
)
8611 (if (and (eq symbol
'inclass
) (= (point) (c-point 'boi
)))
8613 (c-add-syntax symbol containing-decl-open
)
8614 containing-decl-open
)
8615 (goto-char containing-decl-start
)
8616 ;; Ought to use `c-add-stmt-syntax' instead of backing up to boi
8617 ;; here, but we have to do like this for compatibility.
8618 (back-to-indentation)
8619 (c-add-syntax symbol
(point))
8620 (if (and (c-keyword-member containing-decl-kwd
8621 'c-inexpr-class-kwds
)
8622 (/= containing-decl-start
(c-point 'boi containing-decl-start
)))
8623 (c-add-syntax 'inexpr-class
))
8626 (defun c-guess-continued-construct (indent-point
8628 beg-of-same-or-containing-stmt
8631 ;; This function contains the decision tree reached through both
8632 ;; cases 18 and 10. It's a continued statement or top level
8633 ;; construct of some kind.
8635 ;; This function might do hidden buffer changes.
8637 (let (special-brace-list placeholder
)
8638 (goto-char indent-point
)
8639 (skip-chars-forward " \t")
8642 ;; (CASE A removed.)
8643 ;; CASE B: open braces for class or brace-lists
8644 ((setq special-brace-list
8645 (or (and c-special-brace-lists
8646 (c-looking-at-special-brace-list))
8647 (eq char-after-ip ?
{)))
8650 ;; CASE B.1: class-open
8652 (and (eq (char-after) ?
{)
8653 (c-looking-at-decl-block containing-sexp t
)
8654 (setq beg-of-same-or-containing-stmt
(point))))
8655 (c-add-syntax 'class-open beg-of-same-or-containing-stmt
))
8657 ;; CASE B.2: brace-list-open
8658 ((or (consp special-brace-list
)
8660 (goto-char beg-of-same-or-containing-stmt
)
8661 (c-syntactic-re-search-forward "=\\([^=]\\|$\\)"
8662 indent-point t t t
)))
8663 ;; The most semantically accurate symbol here is
8664 ;; brace-list-open, but we normally report it simply as a
8665 ;; statement-cont. The reason is that one normally adjusts
8666 ;; brace-list-open for brace lists as top-level constructs,
8667 ;; and brace lists inside statements is a completely different
8668 ;; context. C.f. case 5A.3.
8669 (c-beginning-of-statement-1 containing-sexp
)
8670 (c-add-stmt-syntax (if c-auto-newline-analysis
8671 ;; Turn off the dwim above when we're
8672 ;; analyzing the nature of the brace
8673 ;; for the auto newline feature.
8677 containing-sexp paren-state
))
8679 ;; CASE B.3: The body of a function declared inside a normal
8680 ;; block. Can occur e.g. in Pike and when using gcc
8681 ;; extensions, but watch out for macros followed by blocks.
8682 ;; C.f. cases E, 16F and 17G.
8683 ((and (not (c-at-statement-start-p))
8684 (eq (c-beginning-of-statement-1 containing-sexp nil nil t
)
8687 (let ((c-recognize-typeless-decls nil
))
8688 ;; Turn off recognition of constructs that lacks a
8689 ;; type in this case, since that's more likely to be
8690 ;; a macro followed by a block.
8691 (c-forward-decl-or-cast-1 (c-point 'bosws
) nil nil
))))
8692 (c-add-stmt-syntax 'defun-open nil t
8693 containing-sexp paren-state
))
8695 ;; CASE B.4: Continued statement with block open. The most
8696 ;; accurate analysis is perhaps `statement-cont' together with
8697 ;; `block-open' but we play DWIM and use `substatement-open'
8698 ;; instead. The rationaly is that this typically is a macro
8699 ;; followed by a block which makes it very similar to a
8700 ;; statement with a substatement block.
8702 (c-add-stmt-syntax 'substatement-open nil nil
8703 containing-sexp paren-state
))
8706 ;; CASE C: iostream insertion or extraction operator
8707 ((and (looking-at "\\(<<\\|>>\\)\\([^=]\\|$\\)")
8709 (goto-char beg-of-same-or-containing-stmt
)
8710 ;; If there is no preceding streamop in the statement
8711 ;; then indent this line as a normal statement-cont.
8712 (when (c-syntactic-re-search-forward
8713 "\\(<<\\|>>\\)\\([^=]\\|$\\)" indent-point
'move t t
)
8714 (c-add-syntax 'stream-op
(c-point 'boi
))
8717 ;; CASE E: In the "K&R region" of a function declared inside a
8718 ;; normal block. C.f. case B.3.
8719 ((and (save-excursion
8720 ;; Check that the next token is a '{'. This works as
8721 ;; long as no language that allows nested function
8722 ;; definitions allows stuff like member init lists, K&R
8723 ;; declarations or throws clauses there.
8725 ;; Note that we do a forward search for something ahead
8726 ;; of the indentation line here. That's not good since
8727 ;; the user might not have typed it yet. Unfortunately
8728 ;; it's exceedingly tricky to recognize a function
8729 ;; prototype in a code block without resorting to this.
8730 (c-forward-syntactic-ws)
8731 (eq (char-after) ?
{))
8732 (not (c-at-statement-start-p))
8733 (eq (c-beginning-of-statement-1 containing-sexp nil nil t
)
8736 (let ((c-recognize-typeless-decls nil
))
8737 ;; Turn off recognition of constructs that lacks a
8738 ;; type in this case, since that's more likely to be
8739 ;; a macro followed by a block.
8740 (c-forward-decl-or-cast-1 (c-point 'bosws
) nil nil
))))
8741 (c-add-stmt-syntax 'func-decl-cont nil t
8742 containing-sexp paren-state
))
8744 ;;CASE F: continued statement and the only preceding items are
8746 ((and (c-major-mode-is 'java-mode
)
8747 (setq placeholder
(point))
8748 (c-beginning-of-statement-1)
8750 (while (and (c-forward-annotation)
8751 (< (point) placeholder
))
8752 (c-forward-syntactic-ws))
8755 (>= (point) placeholder
)
8756 (goto-char placeholder
)))
8757 (c-beginning-of-statement-1 containing-sexp
)
8758 (c-add-syntax 'annotation-var-cont
(point)))
8760 ;; CASE G: a template list continuation?
8761 ;; Mostly a duplication of case 5D.3 to fix templates-19:
8762 ((and (c-major-mode-is 'c
++-mode
)
8764 (goto-char indent-point
)
8765 (c-with-syntax-table c
++-template-syntax-table
8766 (setq placeholder
(c-up-list-backward)))
8768 (eq (char-after placeholder
) ?
<)
8769 (/= (char-before placeholder
) ?
<)
8771 (goto-char (1+ placeholder
))
8772 (not (looking-at c-
<-op-cont-regexp
))))))
8773 (c-with-syntax-table c
++-template-syntax-table
8774 (goto-char placeholder
)
8775 (c-beginning-of-statement-1 containing-sexp t
)
8777 (c-backward-syntactic-ws containing-sexp
)
8778 (eq (char-before) ?
<))
8779 ;; In a nested template arglist.
8781 (goto-char placeholder
)
8782 (c-syntactic-skip-backward "^,;" containing-sexp t
)
8783 (c-forward-syntactic-ws))
8784 (back-to-indentation)))
8785 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
8787 (c-add-syntax 'template-args-cont
(point) placeholder
))
8789 ;; CASE D: continued statement.
8791 (c-beginning-of-statement-1 containing-sexp
)
8792 (c-add-stmt-syntax 'statement-cont nil nil
8793 containing-sexp paren-state
))
8796 ;; The next autoload was added by RMS on 2005/8/9 - don't know why (ACM,
8799 (defun c-guess-basic-syntax ()
8800 "Return the syntactic context of the current line."
8803 (c-save-buffer-state
8804 ((indent-point (point))
8805 (case-fold-search nil
)
8806 ;; A whole ugly bunch of various temporary variables. Have
8807 ;; to declare them here since it's not possible to declare
8808 ;; a variable with only the scope of a cond test and the
8809 ;; following result clauses, and most of this function is a
8810 ;; single gigantic cond. :P
8811 literal char-before-ip before-ws-ip char-after-ip macro-start
8812 in-macro-expr c-syntactic-context placeholder c-in-literal-cache
8813 step-type tmpsymbol keyword injava-inher special-brace-list tmp-pos
8815 ;; The following record some positions for the containing
8816 ;; declaration block if we're directly within one:
8817 ;; `containing-decl-open' is the position of the open
8818 ;; brace. `containing-decl-start' is the start of the
8819 ;; declaration. `containing-decl-kwd' is the keyword
8820 ;; symbol of the keyword that tells what kind of block it
8822 containing-decl-open
8823 containing-decl-start
8825 ;; The open paren of the closest surrounding sexp or nil if
8828 ;; The position after the closest preceding brace sexp
8829 ;; (nested sexps are ignored), or the position after
8830 ;; `containing-sexp' if there is none, or (point-min) if
8831 ;; `containing-sexp' is nil.
8833 ;; The paren state outside `containing-sexp', or at
8834 ;; `indent-point' if `containing-sexp' is nil.
8835 (paren-state (c-parse-state))
8836 ;; There's always at most one syntactic element which got
8837 ;; an anchor pos. It's stored in syntactic-relpos.
8839 (c-stmt-delim-chars c-stmt-delim-chars
))
8841 ;; Check if we're directly inside an enclosing declaration
8843 (when (and (setq containing-sexp
8844 (c-most-enclosing-brace paren-state
))
8846 (goto-char containing-sexp
)
8847 (eq (char-after) ?
{))
8849 (c-looking-at-decl-block
8850 (c-most-enclosing-brace paren-state
8853 (setq containing-decl-open containing-sexp
8854 containing-decl-start
(point)
8855 containing-sexp nil
)
8856 (goto-char placeholder
)
8857 (setq containing-decl-kwd
(and (looking-at c-keywords-regexp
)
8858 (c-keyword-sym (match-string 1)))))
8860 ;; Init some position variables.
8863 (setq containing-sexp
(car paren-state
)
8864 paren-state
(cdr paren-state
))
8865 (if (consp containing-sexp
)
8867 (setq lim
(cdr containing-sexp
))
8868 (if (cdr c-state-cache
)
8869 ;; Ignore balanced paren. The next entry
8870 ;; can't be another one.
8871 (setq containing-sexp
(car (cdr c-state-cache
))
8872 paren-state
(cdr paren-state
))
8873 ;; If there is no surrounding open paren then
8874 ;; put the last balanced pair back on paren-state.
8875 (setq paren-state
(cons containing-sexp paren-state
)
8876 containing-sexp nil
)))
8877 (setq lim
(1+ containing-sexp
))))
8878 (setq lim
(point-min)))
8880 ;; If we're in a parenthesis list then ',' delimits the
8881 ;; "statements" rather than being an operator (with the
8882 ;; exception of the "for" clause). This difference is
8883 ;; typically only noticeable when statements are used in macro
8885 (when (and containing-sexp
8886 (eq (char-after containing-sexp
) ?\
())
8887 (setq c-stmt-delim-chars c-stmt-delim-chars-with-comma
))
8888 ;; cache char before and after indent point, and move point to
8889 ;; the most likely position to perform the majority of tests
8890 (goto-char indent-point
)
8891 (c-backward-syntactic-ws lim
)
8892 (setq before-ws-ip
(point)
8893 char-before-ip
(char-before))
8894 (goto-char indent-point
)
8895 (skip-chars-forward " \t")
8896 (setq char-after-ip
(char-after))
8898 ;; are we in a literal?
8899 (setq literal
(c-in-literal lim
))
8901 ;; now figure out syntactic qualities of the current line
8904 ;; CASE 1: in a string.
8905 ((eq literal
'string
)
8906 (c-add-syntax 'string
(c-point 'bopl
)))
8908 ;; CASE 2: in a C or C++ style comment.
8909 ((and (memq literal
'(c c
++))
8910 ;; This is a kludge for XEmacs where we use
8911 ;; `buffer-syntactic-context', which doesn't correctly
8912 ;; recognize "\*/" to end a block comment.
8913 ;; `parse-partial-sexp' which is used by
8914 ;; `c-literal-limits' will however do that in most
8915 ;; versions, which results in that we get nil from
8916 ;; `c-literal-limits' even when `c-in-literal' claims
8917 ;; we're inside a comment.
8918 (setq placeholder
(c-literal-limits lim
)))
8919 (c-add-syntax literal
(car placeholder
)))
8921 ;; CASE 3: in a cpp preprocessor macro continuation.
8922 ((and (save-excursion
8923 (when (c-beginning-of-macro)
8924 (setq macro-start
(point))))
8925 (/= macro-start
(c-point 'boi
))
8927 (setq tmpsymbol
'cpp-macro-cont
)
8928 (or (not c-syntactic-indentation-in-macros
)
8930 (goto-char macro-start
)
8931 ;; If at the beginning of the body of a #define
8932 ;; directive then analyze as cpp-define-intro
8933 ;; only. Go on with the syntactic analysis
8934 ;; otherwise. in-macro-expr is set if we're in a
8935 ;; cpp expression, i.e. before the #define body
8936 ;; or anywhere in a non-#define directive.
8937 (if (c-forward-to-cpp-define-body)
8938 (let ((indent-boi (c-point 'boi indent-point
)))
8939 (setq in-macro-expr
(> (point) indent-boi
)
8940 tmpsymbol
'cpp-define-intro
)
8941 (= (point) indent-boi
))
8942 (setq in-macro-expr t
)
8944 (c-add-syntax tmpsymbol macro-start
)
8945 (setq macro-start nil
))
8947 ;; CASE 11: an else clause?
8948 ((looking-at "else\\>[^_]")
8949 (c-beginning-of-statement-1 containing-sexp
)
8950 (c-add-stmt-syntax 'else-clause nil t
8951 containing-sexp paren-state
))
8953 ;; CASE 12: while closure of a do/while construct?
8954 ((and (looking-at "while\\>[^_]")
8956 (prog1 (eq (c-beginning-of-statement-1 containing-sexp
)
8958 (setq placeholder
(point)))))
8959 (goto-char placeholder
)
8960 (c-add-stmt-syntax 'do-while-closure nil t
8961 containing-sexp paren-state
))
8963 ;; CASE 13: A catch or finally clause? This case is simpler
8964 ;; than if-else and do-while, because a block is required
8965 ;; after every try, catch and finally.
8967 (and (cond ((c-major-mode-is 'c
++-mode
)
8968 (looking-at "catch\\>[^_]"))
8969 ((c-major-mode-is 'java-mode
)
8970 (looking-at "\\(catch\\|finally\\)\\>[^_]")))
8971 (and (c-safe (c-backward-syntactic-ws)
8974 (eq (char-after) ?
{)
8975 (c-safe (c-backward-syntactic-ws)
8978 (if (eq (char-after) ?\
()
8979 (c-safe (c-backward-sexp) t
)
8981 (looking-at "\\(try\\|catch\\)\\>[^_]")
8982 (setq placeholder
(point))))
8983 (goto-char placeholder
)
8984 (c-add-stmt-syntax 'catch-clause nil t
8985 containing-sexp paren-state
))
8987 ;; CASE 18: A substatement we can recognize by keyword.
8989 (and c-opt-block-stmt-key
8990 (not (eq char-before-ip ?\
;))
8991 (not (c-at-vsemi-p before-ws-ip
))
8992 (not (memq char-after-ip
'(?\
) ?\
] ?
,)))
8993 (or (not (eq char-before-ip ?
}))
8994 (c-looking-at-inexpr-block-backward c-state-cache
))
8997 ;; Ought to cache the result from the
8998 ;; c-beginning-of-statement-1 calls here.
8999 (setq placeholder
(point))
9000 (while (eq (setq step-type
9001 (c-beginning-of-statement-1 lim
))
9003 (if (eq step-type
'previous
)
9004 (goto-char placeholder
)
9005 (setq placeholder
(point))
9006 (if (and (eq step-type
'same
)
9007 (not (looking-at c-opt-block-stmt-key
)))
9008 ;; Step up to the containing statement if we
9009 ;; stayed in the same one.
9013 (c-beginning-of-statement-1 lim
))
9016 (setq placeholder
(point))
9017 ;; There was no containing statement afterall.
9018 (goto-char placeholder
)))))
9020 (if (looking-at c-block-stmt-2-key
)
9021 ;; Require a parenthesis after these keywords.
9022 ;; Necessary to catch e.g. synchronized in Java,
9023 ;; which can be used both as statement and
9025 (and (zerop (c-forward-token-2 1 nil
))
9026 (eq (char-after) ?\
())
9027 (looking-at c-opt-block-stmt-key
))))
9029 (if (eq step-type
'up
)
9030 ;; CASE 18A: Simple substatement.
9032 (goto-char placeholder
)
9034 ((eq char-after-ip ?
{)
9035 (c-add-stmt-syntax 'substatement-open nil nil
9036 containing-sexp paren-state
))
9038 (goto-char indent-point
)
9039 (back-to-indentation)
9041 (c-add-stmt-syntax 'substatement-label nil nil
9042 containing-sexp paren-state
))
9044 (c-add-stmt-syntax 'substatement nil nil
9045 containing-sexp paren-state
))))
9047 ;; CASE 18B: Some other substatement. This is shared
9049 (c-guess-continued-construct indent-point
9055 ;; CASE 14: A case or default label
9056 ((looking-at c-label-kwds-regexp
)
9059 (goto-char containing-sexp
)
9060 (setq lim
(c-most-enclosing-brace c-state-cache
9062 (c-backward-to-block-anchor lim
)
9063 (c-add-stmt-syntax 'case-label nil t lim paren-state
))
9064 ;; Got a bogus label at the top level. In lack of better
9065 ;; alternatives, anchor it on (point-min).
9066 (c-add-syntax 'case-label
(point-min))))
9068 ;; CASE 15: any other label
9070 (back-to-indentation)
9071 (and (not (looking-at c-syntactic-ws-start
))
9073 (cond (containing-decl-open
9074 (setq placeholder
(c-add-class-syntax 'inclass
9075 containing-decl-open
9076 containing-decl-start
9079 ;; Append access-label with the same anchor point as
9081 (c-append-syntax 'access-label placeholder
))
9084 (goto-char containing-sexp
)
9085 (setq lim
(c-most-enclosing-brace c-state-cache
9089 (if (and (eq (c-beginning-of-statement-1 lim
) 'up
)
9090 (looking-at "switch\\>[^_]"))
9091 ;; If the surrounding statement is a switch then
9092 ;; let's analyze all labels as switch labels, so
9093 ;; that they get lined up consistently.
9096 (c-backward-to-block-anchor lim
)
9097 (c-add-stmt-syntax tmpsymbol nil t lim paren-state
))
9100 ;; A label on the top level. Treat it as a class
9101 ;; context. (point-min) is the closest we get to the
9102 ;; class open brace.
9103 (c-add-syntax 'access-label
(point-min)))))
9105 ;; CASE 4: In-expression statement. C.f. cases 7B, 16A and
9107 ((setq placeholder
(c-looking-at-inexpr-block
9108 (c-safe-position containing-sexp paren-state
)
9110 ;; Have to turn on the heuristics after
9111 ;; the point even though it doesn't work
9112 ;; very well. C.f. test case class-16.pike.
9114 (setq tmpsymbol
(assq (car placeholder
)
9115 '((inexpr-class . class-open
)
9116 (inexpr-statement . block-open
))))
9118 ;; It's a statement block or an anonymous class.
9119 (setq tmpsymbol
(cdr tmpsymbol
))
9120 ;; It's a Pike lambda. Check whether we are between the
9121 ;; lambda keyword and the argument list or at the defun
9123 (setq tmpsymbol
(if (eq char-after-ip ?
{)
9125 'lambda-intro-cont
)))
9126 (goto-char (cdr placeholder
))
9127 (back-to-indentation)
9128 (c-add-stmt-syntax tmpsymbol nil t
9129 (c-most-enclosing-brace c-state-cache
(point))
9131 (unless (eq (point) (cdr placeholder
))
9132 (c-add-syntax (car placeholder
))))
9134 ;; CASE 5: Line is inside a declaration level block or at top level.
9135 ((or containing-decl-open
(null containing-sexp
))
9138 ;; CASE 5A: we are looking at a defun, brace list, class,
9139 ;; or inline-inclass method opening brace
9140 ((setq special-brace-list
9141 (or (and c-special-brace-lists
9142 (c-looking-at-special-brace-list))
9143 (eq char-after-ip ?
{)))
9146 ;; CASE 5A.1: Non-class declaration block open.
9149 (and (eq char-after-ip ?
{)
9150 (setq tmp
(c-looking-at-decl-block containing-sexp t
))
9152 (setq placeholder
(point))
9154 (looking-at c-symbol-key
))
9156 (c-keyword-sym (setq keyword
(match-string 0)))
9157 'c-other-block-decl-kwds
))))
9158 (goto-char placeholder
)
9160 (if (string-equal keyword
"extern")
9161 ;; Special case for extern-lang-open.
9163 (intern (concat keyword
"-open")))
9164 nil t containing-sexp paren-state
))
9166 ;; CASE 5A.2: we are looking at a class opening brace
9168 (goto-char indent-point
)
9169 (skip-chars-forward " \t")
9170 (and (eq (char-after) ?
{)
9171 (c-looking-at-decl-block containing-sexp t
)
9172 (setq placeholder
(point))))
9173 (c-add-syntax 'class-open placeholder
))
9175 ;; CASE 5A.3: brace list open
9177 (c-beginning-of-decl-1 lim
)
9178 (while (looking-at c-specifier-key
)
9179 (goto-char (match-end 1))
9180 (c-forward-syntactic-ws indent-point
))
9181 (setq placeholder
(c-point 'boi
))
9182 (or (consp special-brace-list
)
9183 (and (or (save-excursion
9184 (goto-char indent-point
)
9185 (setq tmpsymbol nil
)
9186 (while (and (> (point) placeholder
)
9187 (zerop (c-backward-token-2 1 t
))
9188 (/= (char-after) ?
=))
9189 (and c-opt-inexpr-brace-list-key
9191 (looking-at c-opt-inexpr-brace-list-key
)
9192 (setq tmpsymbol
'topmost-intro-cont
)))
9193 (eq (char-after) ?
=))
9194 (looking-at c-brace-list-key
))
9196 (while (and (< (point) indent-point
)
9197 (zerop (c-forward-token-2 1 t
))
9198 (not (memq (char-after) '(?\
; ?\()))))
9199 (not (memq (char-after) '(?\
; ?\()))
9201 (if (and (not c-auto-newline-analysis
)
9202 (c-major-mode-is 'java-mode
)
9203 (eq tmpsymbol
'topmost-intro-cont
))
9204 ;; We're in Java and have found that the open brace
9205 ;; belongs to a "new Foo[]" initialization list,
9206 ;; which means the brace list is part of an
9207 ;; expression and not a top level definition. We
9208 ;; therefore treat it as any topmost continuation
9209 ;; even though the semantically correct symbol still
9210 ;; is brace-list-open, on the same grounds as in
9213 (c-beginning-of-statement-1 lim
)
9214 (c-add-syntax 'topmost-intro-cont
(c-point 'boi
)))
9215 (c-add-syntax 'brace-list-open placeholder
)))
9217 ;; CASE 5A.4: inline defun open
9218 ((and containing-decl-open
9219 (not (c-keyword-member containing-decl-kwd
9220 'c-other-block-decl-kwds
)))
9221 (c-add-syntax 'inline-open
)
9222 (c-add-class-syntax 'inclass
9223 containing-decl-open
9224 containing-decl-start
9228 ;; CASE 5A.5: ordinary defun open
9231 (c-beginning-of-decl-1 lim
)
9232 (while (looking-at c-specifier-key
)
9233 (goto-char (match-end 1))
9234 (c-forward-syntactic-ws indent-point
))
9235 (c-add-syntax 'defun-open
(c-point 'boi
))
9236 ;; Bogus to use bol here, but it's the legacy. (Resolved,
9240 ;; CASE 5B: After a function header but before the body (or
9241 ;; the ending semicolon if there's no body).
9243 (when (setq placeholder
(c-just-after-func-arglist-p lim
))
9244 (setq tmp-pos
(point))))
9247 ;; CASE 5B.1: Member init list.
9248 ((eq (char-after tmp-pos
) ?
:)
9249 (if (or (> tmp-pos indent-point
)
9250 (= (c-point 'bosws
) (1+ tmp-pos
)))
9252 ;; There is no preceding member init clause.
9253 ;; Indent relative to the beginning of indentation
9254 ;; for the topmost-intro line that contains the
9255 ;; prototype's open paren.
9256 (goto-char placeholder
)
9257 (c-add-syntax 'member-init-intro
(c-point 'boi
)))
9258 ;; Indent relative to the first member init clause.
9259 (goto-char (1+ tmp-pos
))
9260 (c-forward-syntactic-ws)
9261 (c-add-syntax 'member-init-cont
(point))))
9263 ;; CASE 5B.2: K&R arg decl intro
9264 ((and c-recognize-knr-p
9265 (c-in-knr-argdecl lim
))
9266 (c-beginning-of-statement-1 lim
)
9267 (c-add-syntax 'knr-argdecl-intro
(c-point 'boi
))
9268 (if containing-decl-open
9269 (c-add-class-syntax 'inclass
9270 containing-decl-open
9271 containing-decl-start
9275 ;; CASE 5B.4: Nether region after a C++ or Java func
9276 ;; decl, which could include a `throws' declaration.
9278 (c-beginning-of-statement-1 lim
)
9279 (c-add-syntax 'func-decl-cont
(c-point 'boi
))
9282 ;; CASE 5C: inheritance line. could be first inheritance
9283 ;; line, or continuation of a multiple inheritance
9284 ((or (and (c-major-mode-is 'c
++-mode
)
9286 (when (eq char-after-ip ?
,)
9287 (skip-chars-forward " \t")
9289 (looking-at c-opt-postfix-decl-spec-key
)))
9290 (and (or (eq char-before-ip ?
:)
9291 ;; watch out for scope operator
9293 (and (eq char-after-ip ?
:)
9294 (c-safe (forward-char 1) t
)
9295 (not (eq (char-after) ?
:))
9298 (c-backward-syntactic-ws lim
)
9299 (if (eq char-before-ip ?
:)
9302 (c-backward-syntactic-ws lim
)))
9303 (back-to-indentation)
9304 (looking-at c-class-key
)))
9306 (and (c-major-mode-is 'java-mode
)
9307 (let ((fence (save-excursion
9308 (c-beginning-of-statement-1 lim
)
9313 (cond ((looking-at c-opt-postfix-decl-spec-key
)
9314 (setq injava-inher
(cons cont
(point))
9316 ((or (not (c-safe (c-forward-sexp -
1) t
))
9322 (not (c-crosses-statement-barrier-p (cdr injava-inher
)
9327 ;; CASE 5C.1: non-hanging colon on an inher intro
9328 ((eq char-after-ip ?
:)
9329 (c-beginning-of-statement-1 lim
)
9330 (c-add-syntax 'inher-intro
(c-point 'boi
))
9331 ;; don't add inclass symbol since relative point already
9332 ;; contains any class offset
9335 ;; CASE 5C.2: hanging colon on an inher intro
9336 ((eq char-before-ip ?
:)
9337 (c-beginning-of-statement-1 lim
)
9338 (c-add-syntax 'inher-intro
(c-point 'boi
))
9339 (if containing-decl-open
9340 (c-add-class-syntax 'inclass
9341 containing-decl-open
9342 containing-decl-start
9346 ;; CASE 5C.3: in a Java implements/extends
9348 (let ((where (cdr injava-inher
))
9349 (cont (car injava-inher
)))
9351 (cond ((looking-at "throws\\>[^_]")
9352 (c-add-syntax 'func-decl-cont
9353 (progn (c-beginning-of-statement-1 lim
)
9355 (cont (c-add-syntax 'inher-cont where
))
9356 (t (c-add-syntax 'inher-intro
9357 (progn (goto-char (cdr injava-inher
))
9358 (c-beginning-of-statement-1 lim
)
9362 ;; CASE 5C.4: a continued inheritance line
9364 (c-beginning-of-inheritance-list lim
)
9365 (c-add-syntax 'inher-cont
(point))
9366 ;; don't add inclass symbol since relative point already
9367 ;; contains any class offset
9370 ;; CASE 5D: this could be a top-level initialization, a
9371 ;; member init list continuation, or a template argument
9372 ;; list continuation.
9374 ;; Note: We use the fact that lim is always after any
9375 ;; preceding brace sexp.
9376 (if c-recognize-
<>-arglists
9379 (c-syntactic-skip-backward "^;,=<>" lim t
)
9382 (when c-overloadable-operators-regexp
9383 (when (setq placeholder
(c-after-special-operator-id lim
))
9384 (goto-char placeholder
)
9387 ((eq (char-before) ?
>)
9388 (or (c-backward-<>-arglist nil lim
)
9391 ((eq (char-before) ?
<)
9394 (c-forward-<>-arglist nil
))
9395 (progn (forward-char)
9399 ;; NB: No c-after-special-operator-id stuff in this
9400 ;; clause - we assume only C++ needs it.
9401 (c-syntactic-skip-backward "^;,=" lim t
))
9402 (memq (char-before) '(?
, ?
= ?
<)))
9405 ;; CASE 5D.3: perhaps a template list continuation?
9406 ((and (c-major-mode-is 'c
++-mode
)
9409 (c-with-syntax-table c
++-template-syntax-table
9410 (goto-char indent-point
)
9411 (setq placeholder
(c-up-list-backward))
9413 (eq (char-after placeholder
) ?
<))))))
9414 (c-with-syntax-table c
++-template-syntax-table
9415 (goto-char placeholder
)
9416 (c-beginning-of-statement-1 lim t
)
9418 (c-backward-syntactic-ws lim
)
9419 (eq (char-before) ?
<))
9420 ;; In a nested template arglist.
9422 (goto-char placeholder
)
9423 (c-syntactic-skip-backward "^,;" lim t
)
9424 (c-forward-syntactic-ws))
9425 (back-to-indentation)))
9426 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
9428 (c-add-syntax 'template-args-cont
(point) placeholder
))
9430 ;; CASE 5D.4: perhaps a multiple inheritance line?
9431 ((and (c-major-mode-is 'c
++-mode
)
9433 (c-beginning-of-statement-1 lim
)
9434 (setq placeholder
(point))
9435 (if (looking-at "static\\>[^_]")
9436 (c-forward-token-2 1 nil indent-point
))
9437 (and (looking-at c-class-key
)
9438 (zerop (c-forward-token-2 2 nil indent-point
))
9439 (if (eq (char-after) ?
<)
9440 (c-with-syntax-table c
++-template-syntax-table
9441 (zerop (c-forward-token-2 1 t indent-point
)))
9443 (eq (char-after) ?
:))))
9444 (goto-char placeholder
)
9445 (c-add-syntax 'inher-cont
(c-point 'boi
)))
9447 ;; CASE 5D.5: Continuation of the "expression part" of a
9448 ;; top level construct. Or, perhaps, an unrecognised construct.
9450 (while (and (setq placeholder
(point))
9451 (eq (car (c-beginning-of-decl-1 containing-sexp
))
9454 (c-backward-syntactic-ws)
9455 (eq (char-before) ?
}))
9456 (< (point) placeholder
)))
9459 ((eq (point) placeholder
) 'statement
) ; unrecognised construct
9460 ;; A preceding comma at the top level means that a
9461 ;; new variable declaration starts here. Use
9462 ;; topmost-intro-cont for it, for consistency with
9463 ;; the first variable declaration. C.f. case 5N.
9464 ((eq char-before-ip ?
,) 'topmost-intro-cont
)
9465 (t 'statement-cont
))
9466 nil nil containing-sexp paren-state
))
9469 ;; CASE 5F: Close of a non-class declaration level block.
9470 ((and (eq char-after-ip ?
})
9471 (c-keyword-member containing-decl-kwd
9472 'c-other-block-decl-kwds
))
9473 ;; This is inconsistent: Should use `containing-decl-open'
9474 ;; here if it's at boi, like in case 5J.
9475 (goto-char containing-decl-start
)
9477 (if (string-equal (symbol-name containing-decl-kwd
) "extern")
9478 ;; Special case for compatibility with the
9479 ;; extern-lang syntactic symbols.
9481 (intern (concat (symbol-name containing-decl-kwd
)
9484 (c-most-enclosing-brace paren-state
(point))
9487 ;; CASE 5G: we are looking at the brace which closes the
9488 ;; enclosing nested class decl
9489 ((and containing-sexp
9490 (eq char-after-ip ?
})
9491 (eq containing-decl-open containing-sexp
))
9492 (c-add-class-syntax 'class-close
9493 containing-decl-open
9494 containing-decl-start
9498 ;; CASE 5H: we could be looking at subsequent knr-argdecls
9499 ((and c-recognize-knr-p
9500 (not containing-sexp
) ; can't be knr inside braces.
9501 (not (eq char-before-ip ?
}))
9503 (setq placeholder
(cdr (c-beginning-of-decl-1 lim
)))
9505 ;; Do an extra check to avoid tripping up on
9506 ;; statements that occur in invalid contexts
9507 ;; (e.g. in macro bodies where we don't really
9508 ;; know the context of what we're looking at).
9509 (not (and c-opt-block-stmt-key
9510 (looking-at c-opt-block-stmt-key
)))))
9511 (< placeholder indent-point
))
9512 (goto-char placeholder
)
9513 (c-add-syntax 'knr-argdecl
(point)))
9515 ;; CASE 5I: ObjC method definition.
9516 ((and c-opt-method-key
9517 (looking-at c-opt-method-key
))
9518 (c-beginning-of-statement-1 nil t
)
9519 (if (= (point) indent-point
)
9520 ;; Handle the case when it's the first (non-comment)
9521 ;; thing in the buffer. Can't look for a 'same return
9522 ;; value from cbos1 since ObjC directives currently
9523 ;; aren't recognized fully, so that we get 'same
9524 ;; instead of 'previous if it moved over a preceding
9526 (goto-char (point-min)))
9527 (c-add-syntax 'objc-method-intro
(c-point 'boi
)))
9529 ;; CASE 5P: AWK pattern or function or continuation
9531 ((c-major-mode-is 'awk-mode
)
9532 (setq placeholder
(point))
9534 (if (and (eq (c-beginning-of-statement-1) 'same
)
9535 (/= (point) placeholder
))
9539 containing-sexp paren-state
))
9541 ;; CASE 5N: At a variable declaration that follows a class
9542 ;; definition or some other block declaration that doesn't
9543 ;; end at the closing '}'. C.f. case 5D.5.
9545 (c-backward-syntactic-ws lim
)
9546 (and (eq (char-before) ?
})
9548 (let ((start (point)))
9549 (if (and c-state-cache
9550 (consp (car c-state-cache
))
9551 (eq (cdar c-state-cache
) (point)))
9552 ;; Speed up the backward search a bit.
9553 (goto-char (caar c-state-cache
)))
9554 (c-beginning-of-decl-1 containing-sexp
)
9555 (setq placeholder
(point))
9556 (if (= start
(point))
9557 ;; The '}' is unbalanced.
9560 (>= (point) indent-point
))))))
9561 (goto-char placeholder
)
9562 (c-add-stmt-syntax 'topmost-intro-cont nil nil
9563 containing-sexp paren-state
))
9565 ;; NOTE: The point is at the end of the previous token here.
9567 ;; CASE 5J: we are at the topmost level, make
9568 ;; sure we skip back past any access specifiers
9570 ;; A macro continuation line is never at top level.
9571 (not (and macro-start
9572 (> indent-point macro-start
)))
9574 (setq placeholder
(point))
9575 (or (memq char-before-ip
'(?\
; ?{ ?} nil))
9576 (c-at-vsemi-p before-ws-ip
)
9577 (when (and (eq char-before-ip ?
:)
9578 (eq (c-beginning-of-statement-1 lim
)
9580 (c-backward-syntactic-ws lim
)
9581 (setq placeholder
(point)))
9582 (and (c-major-mode-is 'objc-mode
)
9583 (catch 'not-in-directive
9584 (c-beginning-of-statement-1 lim
)
9585 (setq placeholder
(point))
9586 (while (and (c-forward-objc-directive)
9587 (< (point) indent-point
))
9588 (c-forward-syntactic-ws)
9589 (if (>= (point) indent-point
)
9590 (throw 'not-in-directive t
))
9591 (setq placeholder
(point)))
9593 ;; For historic reasons we anchor at bol of the last
9594 ;; line of the previous declaration. That's clearly
9595 ;; highly bogus and useless, and it makes our lives hard
9596 ;; to remain compatible. :P
9597 (goto-char placeholder
)
9598 (c-add-syntax 'topmost-intro
(c-point 'bol
))
9599 (if containing-decl-open
9600 (if (c-keyword-member containing-decl-kwd
9601 'c-other-block-decl-kwds
)
9603 (goto-char (c-brace-anchor-point containing-decl-open
))
9605 (if (string-equal (symbol-name containing-decl-kwd
)
9607 ;; Special case for compatibility with the
9608 ;; extern-lang syntactic symbols.
9610 (intern (concat "in"
9611 (symbol-name containing-decl-kwd
))))
9613 (c-most-enclosing-brace paren-state
(point))
9615 (c-add-class-syntax 'inclass
9616 containing-decl-open
9617 containing-decl-start
9620 (when (and c-syntactic-indentation-in-macros
9622 (/= macro-start
(c-point 'boi indent-point
)))
9623 (c-add-syntax 'cpp-define-intro
)
9624 (setq macro-start nil
)))
9626 ;; CASE 5K: we are at an ObjC method definition
9627 ;; continuation line.
9628 ((and c-opt-method-key
9630 (c-beginning-of-statement-1 lim
)
9632 (when (looking-at c-opt-method-key
)
9633 (setq placeholder
(point)))))
9634 (c-add-syntax 'objc-method-args-cont placeholder
))
9636 ;; CASE 5L: we are at the first argument of a template
9637 ;; arglist that begins on the previous line.
9638 ((and c-recognize-
<>-arglists
9639 (eq (char-before) ?
<)
9640 (not (and c-overloadable-operators-regexp
9641 (c-after-special-operator-id lim
))))
9642 (c-beginning-of-statement-1 (c-safe-position (point) paren-state
))
9643 (c-add-syntax 'template-args-cont
(c-point 'boi
)))
9645 ;; CASE 5Q: we are at a statement within a macro.
9647 (c-beginning-of-statement-1 containing-sexp
)
9648 (c-add-stmt-syntax 'statement nil t containing-sexp paren-state
))
9650 ;;CASE 5N: We are at a tompmost continuation line and the only
9651 ;;preceding items are annotations.
9652 ((and (c-major-mode-is 'java-mode
)
9653 (setq placeholder
(point))
9654 (c-beginning-of-statement-1)
9656 (while (and (c-forward-annotation))
9657 (c-forward-syntactic-ws))
9660 (>= (point) placeholder
)
9661 (goto-char placeholder
)))
9662 (c-add-syntax 'annotation-top-cont
(c-point 'boi
)))
9664 ;; CASE 5M: we are at a topmost continuation line
9666 (c-beginning-of-statement-1 (c-safe-position (point) paren-state
))
9667 (when (c-major-mode-is 'objc-mode
)
9668 (setq placeholder
(point))
9669 (while (and (c-forward-objc-directive)
9670 (< (point) indent-point
))
9671 (c-forward-syntactic-ws)
9672 (setq placeholder
(point)))
9673 (goto-char placeholder
))
9674 (c-add-syntax 'topmost-intro-cont
(c-point 'boi
)))
9678 ;; (CASE 6 has been removed.)
9680 ;; CASE 7: line is an expression, not a statement. Most
9681 ;; likely we are either in a function prototype or a function
9682 ;; call argument list
9683 ((not (or (and c-special-brace-lists
9685 (goto-char containing-sexp
)
9686 (c-looking-at-special-brace-list)))
9687 (eq (char-after containing-sexp
) ?
{)))
9690 ;; CASE 7A: we are looking at the arglist closing paren.
9692 ((memq char-after-ip
'(?\
) ?\
]))
9693 (goto-char containing-sexp
)
9694 (setq placeholder
(c-point 'boi
))
9695 (if (and (c-safe (backward-up-list 1) t
)
9696 (>= (point) placeholder
))
9699 (skip-chars-forward " \t"))
9700 (goto-char placeholder
))
9701 (c-add-stmt-syntax 'arglist-close
(list containing-sexp
) t
9702 (c-most-enclosing-brace paren-state
(point))
9705 ;; CASE 7B: Looking at the opening brace of an
9706 ;; in-expression block or brace list. C.f. cases 4, 16A
9708 ((and (eq char-after-ip ?
{)
9710 (setq placeholder
(c-inside-bracelist-p (point)
9713 (setq tmpsymbol
'(brace-list-open . inexpr-class
))
9714 (setq tmpsymbol
'(block-open . inexpr-statement
)
9716 (cdr-safe (c-looking-at-inexpr-block
9717 (c-safe-position containing-sexp
9720 ;; placeholder is nil if it's a block directly in
9721 ;; a function arglist. That makes us skip out of
9724 (goto-char placeholder
)
9725 (back-to-indentation)
9726 (c-add-stmt-syntax (car tmpsymbol
) nil t
9727 (c-most-enclosing-brace paren-state
(point))
9729 (if (/= (point) placeholder
)
9730 (c-add-syntax (cdr tmpsymbol
))))
9732 ;; CASE 7C: we are looking at the first argument in an empty
9733 ;; argument list. Use arglist-close if we're actually
9734 ;; looking at a close paren or bracket.
9735 ((memq char-before-ip
'(?\
( ?\
[))
9736 (goto-char containing-sexp
)
9737 (setq placeholder
(c-point 'boi
))
9738 (if (and (c-safe (backward-up-list 1) t
)
9739 (>= (point) placeholder
))
9742 (skip-chars-forward " \t"))
9743 (goto-char placeholder
))
9744 (c-add-stmt-syntax 'arglist-intro
(list containing-sexp
) t
9745 (c-most-enclosing-brace paren-state
(point))
9748 ;; CASE 7D: we are inside a conditional test clause. treat
9749 ;; these things as statements
9751 (goto-char containing-sexp
)
9752 (and (c-safe (c-forward-sexp -
1) t
)
9753 (looking-at "\\<for\\>[^_]")))
9754 (goto-char (1+ containing-sexp
))
9755 (c-forward-syntactic-ws indent-point
)
9756 (if (eq char-before-ip ?\
;)
9757 (c-add-syntax 'statement
(point))
9758 (c-add-syntax 'statement-cont
(point))
9761 ;; CASE 7E: maybe a continued ObjC method call. This is the
9762 ;; case when we are inside a [] bracketed exp, and what
9763 ;; precede the opening bracket is not an identifier.
9764 ((and c-opt-method-key
9765 (eq (char-after containing-sexp
) ?\
[)
9767 (goto-char (1- containing-sexp
))
9768 (c-backward-syntactic-ws (c-point 'bod
))
9769 (if (not (looking-at c-symbol-key
))
9770 (c-add-syntax 'objc-method-call-cont containing-sexp
))
9773 ;; CASE 7F: we are looking at an arglist continuation line,
9774 ;; but the preceding argument is on the same line as the
9775 ;; opening paren. This case includes multi-line
9776 ;; mathematical paren groupings, but we could be on a
9777 ;; for-list continuation line. C.f. case 7A.
9779 (goto-char (1+ containing-sexp
))
9781 (c-forward-syntactic-ws)
9784 (goto-char containing-sexp
) ; paren opening the arglist
9785 (setq placeholder
(c-point 'boi
))
9786 (if (and (c-safe (backward-up-list 1) t
)
9787 (>= (point) placeholder
))
9790 (skip-chars-forward " \t"))
9791 (goto-char placeholder
))
9792 (c-add-stmt-syntax 'arglist-cont-nonempty
(list containing-sexp
) t
9793 (c-most-enclosing-brace c-state-cache
(point))
9796 ;; CASE 7G: we are looking at just a normal arglist
9797 ;; continuation line
9798 (t (c-forward-syntactic-ws indent-point
)
9799 (c-add-syntax 'arglist-cont
(c-point 'boi
)))
9802 ;; CASE 8: func-local multi-inheritance line
9803 ((and (c-major-mode-is 'c
++-mode
)
9805 (goto-char indent-point
)
9806 (skip-chars-forward " \t")
9807 (looking-at c-opt-postfix-decl-spec-key
)))
9808 (goto-char indent-point
)
9809 (skip-chars-forward " \t")
9812 ;; CASE 8A: non-hanging colon on an inher intro
9813 ((eq char-after-ip ?
:)
9814 (c-backward-syntactic-ws lim
)
9815 (c-add-syntax 'inher-intro
(c-point 'boi
)))
9817 ;; CASE 8B: hanging colon on an inher intro
9818 ((eq char-before-ip ?
:)
9819 (c-add-syntax 'inher-intro
(c-point 'boi
)))
9821 ;; CASE 8C: a continued inheritance line
9823 (c-beginning-of-inheritance-list lim
)
9824 (c-add-syntax 'inher-cont
(point))
9827 ;; CASE 9: we are inside a brace-list
9828 ((and (not (c-major-mode-is 'awk-mode
)) ; Maybe this isn't needed (ACM, 2002/3/29)
9829 (setq special-brace-list
9830 (or (and c-special-brace-lists
;;;; ALWAYS NIL FOR AWK!!
9832 (goto-char containing-sexp
)
9833 (c-looking-at-special-brace-list)))
9834 (c-inside-bracelist-p containing-sexp paren-state
))))
9837 ;; CASE 9A: In the middle of a special brace list opener.
9838 ((and (consp special-brace-list
)
9840 (goto-char containing-sexp
)
9841 (eq (char-after) ?\
())
9842 (eq char-after-ip
(car (cdr special-brace-list
))))
9843 (goto-char (car (car special-brace-list
)))
9844 (skip-chars-backward " \t")
9846 (assoc 'statement-cont
9847 (setq placeholder
(c-guess-basic-syntax))))
9848 (setq c-syntactic-context placeholder
)
9849 (c-beginning-of-statement-1
9850 (c-safe-position (1- containing-sexp
) paren-state
))
9851 (c-forward-token-2 0)
9852 (while (looking-at c-specifier-key
)
9853 (goto-char (match-end 1))
9854 (c-forward-syntactic-ws))
9855 (c-add-syntax 'brace-list-open
(c-point 'boi
))))
9857 ;; CASE 9B: brace-list-close brace
9858 ((if (consp special-brace-list
)
9859 ;; Check special brace list closer.
9861 (goto-char (car (car special-brace-list
)))
9863 (goto-char indent-point
)
9864 (back-to-indentation)
9866 ;; We were between the special close char and the `)'.
9867 (and (eq (char-after) ?\
))
9868 (eq (1+ (point)) (cdr (car special-brace-list
))))
9869 ;; We were before the special close char.
9870 (and (eq (char-after) (cdr (cdr special-brace-list
)))
9871 (zerop (c-forward-token-2))
9872 (eq (1+ (point)) (cdr (car special-brace-list
)))))))
9873 ;; Normal brace list check.
9874 (and (eq char-after-ip ?
})
9875 (c-safe (goto-char (c-up-list-backward (point))) t
)
9876 (= (point) containing-sexp
)))
9877 (if (eq (point) (c-point 'boi
))
9878 (c-add-syntax 'brace-list-close
(point))
9879 (setq lim
(c-most-enclosing-brace c-state-cache
(point)))
9880 (c-beginning-of-statement-1 lim
)
9881 (c-add-stmt-syntax 'brace-list-close nil t lim paren-state
)))
9884 ;; Prepare for the rest of the cases below by going to the
9885 ;; token following the opening brace
9886 (if (consp special-brace-list
)
9888 (goto-char (car (car special-brace-list
)))
9889 (c-forward-token-2 1 nil indent-point
))
9890 (goto-char containing-sexp
))
9892 (let ((start (point)))
9893 (c-forward-syntactic-ws indent-point
)
9894 (goto-char (max start
(c-point 'bol
))))
9895 (c-skip-ws-forward indent-point
)
9898 ;; CASE 9C: we're looking at the first line in a brace-list
9899 ((= (point) indent-point
)
9900 (if (consp special-brace-list
)
9901 (goto-char (car (car special-brace-list
)))
9902 (goto-char containing-sexp
))
9903 (if (eq (point) (c-point 'boi
))
9904 (c-add-syntax 'brace-list-intro
(point))
9905 (setq lim
(c-most-enclosing-brace c-state-cache
(point)))
9906 (c-beginning-of-statement-1 lim
)
9907 (c-add-stmt-syntax 'brace-list-intro nil t lim paren-state
)))
9909 ;; CASE 9D: this is just a later brace-list-entry or
9911 (t (if (or (eq char-after-ip ?
{)
9912 (and c-special-brace-lists
9914 (goto-char indent-point
)
9915 (c-forward-syntactic-ws (c-point 'eol
))
9916 (c-looking-at-special-brace-list (point)))))
9917 (c-add-syntax 'brace-entry-open
(point))
9918 (c-add-syntax 'brace-list-entry
(point))
9922 ;; CASE 10: A continued statement or top level construct.
9923 ((and (not (memq char-before-ip
'(?\
; ?:)))
9924 (not (c-at-vsemi-p before-ws-ip
))
9925 (or (not (eq char-before-ip ?
}))
9926 (c-looking-at-inexpr-block-backward c-state-cache
))
9929 (c-beginning-of-statement-1 containing-sexp
)
9930 (setq placeholder
(point))))
9931 (/= placeholder containing-sexp
))
9932 ;; This is shared with case 18.
9933 (c-guess-continued-construct indent-point
9939 ;; CASE 16: block close brace, possibly closing the defun or
9941 ((eq char-after-ip ?
})
9942 ;; From here on we have the next containing sexp in lim.
9943 (setq lim
(c-most-enclosing-brace paren-state
))
9944 (goto-char containing-sexp
)
9947 ;; CASE 16E: Closing a statement block? This catches
9948 ;; cases where it's preceded by a statement keyword,
9949 ;; which works even when used in an "invalid" context,
9950 ;; e.g. a macro argument.
9951 ((c-after-conditional)
9952 (c-backward-to-block-anchor lim
)
9953 (c-add-stmt-syntax 'block-close nil t lim paren-state
))
9955 ;; CASE 16A: closing a lambda defun or an in-expression
9956 ;; block? C.f. cases 4, 7B and 17E.
9957 ((setq placeholder
(c-looking-at-inexpr-block
9958 (c-safe-position containing-sexp paren-state
)
9960 (setq tmpsymbol
(if (eq (car placeholder
) 'inlambda
)
9963 (goto-char containing-sexp
)
9964 (back-to-indentation)
9965 (if (= containing-sexp
(point))
9966 (c-add-syntax tmpsymbol
(point))
9967 (goto-char (cdr placeholder
))
9968 (back-to-indentation)
9969 (c-add-stmt-syntax tmpsymbol nil t
9970 (c-most-enclosing-brace paren-state
(point))
9972 (if (/= (point) (cdr placeholder
))
9973 (c-add-syntax (car placeholder
)))))
9975 ;; CASE 16B: does this close an inline or a function in
9976 ;; a non-class declaration level block?
9981 (c-looking-at-decl-block
9982 (c-most-enclosing-brace paren-state lim
)
9984 (setq placeholder
(point))))
9985 (c-backward-to-decl-anchor lim
)
9986 (back-to-indentation)
9988 (goto-char placeholder
)
9989 (looking-at c-other-decl-block-key
))
9990 (c-add-syntax 'defun-close
(point))
9991 (c-add-syntax 'inline-close
(point))))
9993 ;; CASE 16F: Can be a defun-close of a function declared
9994 ;; in a statement block, e.g. in Pike or when using gcc
9995 ;; extensions, but watch out for macros followed by
9996 ;; blocks. Let it through to be handled below.
9997 ;; C.f. cases B.3 and 17G.
9999 (and (not (c-at-statement-start-p))
10000 (eq (c-beginning-of-statement-1 lim nil nil t
) 'same
)
10001 (setq placeholder
(point))
10002 (let ((c-recognize-typeless-decls nil
))
10003 ;; Turn off recognition of constructs that
10004 ;; lacks a type in this case, since that's more
10005 ;; likely to be a macro followed by a block.
10006 (c-forward-decl-or-cast-1 (c-point 'bosws
) nil nil
))))
10007 (back-to-indentation)
10008 (if (/= (point) containing-sexp
)
10009 (goto-char placeholder
))
10010 (c-add-stmt-syntax 'defun-close nil t lim paren-state
))
10012 ;; CASE 16C: If there is an enclosing brace then this is
10013 ;; a block close since defun closes inside declaration
10014 ;; level blocks have been handled above.
10016 ;; If the block is preceded by a case/switch label on
10017 ;; the same line, we anchor at the first preceding label
10018 ;; at boi. The default handling in c-add-stmt-syntax
10019 ;; really fixes it better, but we do like this to keep
10020 ;; the indentation compatible with version 5.28 and
10021 ;; earlier. C.f. case 17H.
10022 (while (and (/= (setq placeholder
(point)) (c-point 'boi
))
10023 (eq (c-beginning-of-statement-1 lim
) 'label
)))
10024 (goto-char placeholder
)
10025 (if (looking-at c-label-kwds-regexp
)
10026 (c-add-syntax 'block-close
(point))
10027 (goto-char containing-sexp
)
10028 ;; c-backward-to-block-anchor not necessary here; those
10029 ;; situations are handled in case 16E above.
10030 (c-add-stmt-syntax 'block-close nil t lim paren-state
)))
10032 ;; CASE 16D: Only top level defun close left.
10034 (goto-char containing-sexp
)
10035 (c-backward-to-decl-anchor lim
)
10036 (c-add-stmt-syntax 'defun-close nil nil
10037 (c-most-enclosing-brace paren-state
)
10041 ;; CASE 19: line is an expression, not a statement, and is directly
10042 ;; contained by a template delimiter. Most likely, we are in a
10043 ;; template arglist within a statement. This case is based on CASE
10044 ;; 7. At some point in the future, we may wish to create more
10045 ;; syntactic symbols such as `template-intro',
10046 ;; `template-cont-nonempty', etc., and distinguish between them as we
10047 ;; do for `arglist-intro' etc. (2009-12-07).
10048 ((and c-recognize-
<>-arglists
10049 (setq containing-
< (c-up-list-backward indent-point containing-sexp
))
10050 (eq (char-after containing-
<) ?\
<))
10051 (setq placeholder
(c-point 'boi containing-
<))
10052 (goto-char containing-sexp
) ; Most nested Lbrace/Lparen (but not
10053 ; '<') before indent-point.
10054 (if (>= (point) placeholder
)
10057 (skip-chars-forward " \t"))
10058 (goto-char placeholder
))
10059 (c-add-stmt-syntax 'template-args-cont
(list containing-
<) t
10060 (c-most-enclosing-brace c-state-cache
(point))
10063 ;; CASE 17: Statement or defun catchall.
10065 (goto-char indent-point
)
10066 ;; Back up statements until we find one that starts at boi.
10067 (while (let* ((prev-point (point))
10068 (last-step-type (c-beginning-of-statement-1
10070 (if (= (point) prev-point
)
10072 (setq step-type
(or step-type last-step-type
))
10074 (setq step-type last-step-type
)
10075 (/= (point) (c-point 'boi
)))))
10078 ;; CASE 17B: continued statement
10079 ((and (eq step-type
'same
)
10080 (/= (point) indent-point
))
10081 (c-add-stmt-syntax 'statement-cont nil nil
10082 containing-sexp paren-state
))
10084 ;; CASE 17A: After a case/default label?
10086 (while (and (eq step-type
'label
)
10087 (not (looking-at c-label-kwds-regexp
)))
10089 (c-beginning-of-statement-1 containing-sexp
)))
10090 (eq step-type
'label
))
10091 (c-add-stmt-syntax (if (eq char-after-ip ?
{)
10092 'statement-case-open
10093 'statement-case-intro
)
10094 nil t containing-sexp paren-state
))
10096 ;; CASE 17D: any old statement
10098 (while (eq step-type
'label
)
10100 (c-beginning-of-statement-1 containing-sexp
)))
10101 (eq step-type
'previous
))
10102 (c-add-stmt-syntax 'statement nil t
10103 containing-sexp paren-state
)
10104 (if (eq char-after-ip ?
{)
10105 (c-add-syntax 'block-open
)))
10107 ;; CASE 17I: Inside a substatement block.
10109 ;; The following tests are all based on containing-sexp.
10110 (goto-char containing-sexp
)
10111 ;; From here on we have the next containing sexp in lim.
10112 (setq lim
(c-most-enclosing-brace paren-state containing-sexp
))
10113 (c-after-conditional))
10114 (c-backward-to-block-anchor lim
)
10115 (c-add-stmt-syntax 'statement-block-intro nil t
10117 (if (eq char-after-ip ?
{)
10118 (c-add-syntax 'block-open
)))
10120 ;; CASE 17E: first statement in an in-expression block.
10121 ;; C.f. cases 4, 7B and 16A.
10122 ((setq placeholder
(c-looking-at-inexpr-block
10123 (c-safe-position containing-sexp paren-state
)
10125 (setq tmpsymbol
(if (eq (car placeholder
) 'inlambda
)
10127 'statement-block-intro
))
10128 (back-to-indentation)
10129 (if (= containing-sexp
(point))
10130 (c-add-syntax tmpsymbol
(point))
10131 (goto-char (cdr placeholder
))
10132 (back-to-indentation)
10133 (c-add-stmt-syntax tmpsymbol nil t
10134 (c-most-enclosing-brace c-state-cache
(point))
10136 (if (/= (point) (cdr placeholder
))
10137 (c-add-syntax (car placeholder
))))
10138 (if (eq char-after-ip ?
{)
10139 (c-add-syntax 'block-open
)))
10141 ;; CASE 17F: first statement in an inline, or first
10142 ;; statement in a top-level defun. we can tell this is it
10143 ;; if there are no enclosing braces that haven't been
10144 ;; narrowed out by a class (i.e. don't use bod here).
10146 (or (not (setq placeholder
(c-most-enclosing-brace
10149 (goto-char placeholder
)
10150 (eq (char-after) ?
{))
10151 (c-looking-at-decl-block (c-most-enclosing-brace
10152 paren-state
(point))
10154 (c-backward-to-decl-anchor lim
)
10155 (back-to-indentation)
10156 (c-add-syntax 'defun-block-intro
(point)))
10158 ;; CASE 17G: First statement in a function declared inside
10159 ;; a normal block. This can occur in Pike and with
10160 ;; e.g. the gcc extensions, but watch out for macros
10161 ;; followed by blocks. C.f. cases B.3 and 16F.
10163 (and (not (c-at-statement-start-p))
10164 (eq (c-beginning-of-statement-1 lim nil nil t
) 'same
)
10165 (setq placeholder
(point))
10166 (let ((c-recognize-typeless-decls nil
))
10167 ;; Turn off recognition of constructs that lacks
10168 ;; a type in this case, since that's more likely
10169 ;; to be a macro followed by a block.
10170 (c-forward-decl-or-cast-1 (c-point 'bosws
) nil nil
))))
10171 (back-to-indentation)
10172 (if (/= (point) containing-sexp
)
10173 (goto-char placeholder
))
10174 (c-add-stmt-syntax 'defun-block-intro nil t
10177 ;; CASE 17H: First statement in a block.
10179 ;; If the block is preceded by a case/switch label on the
10180 ;; same line, we anchor at the first preceding label at
10181 ;; boi. The default handling in c-add-stmt-syntax is
10182 ;; really fixes it better, but we do like this to keep the
10183 ;; indentation compatible with version 5.28 and earlier.
10185 (while (and (/= (setq placeholder
(point)) (c-point 'boi
))
10186 (eq (c-beginning-of-statement-1 lim
) 'label
)))
10187 (goto-char placeholder
)
10188 (if (looking-at c-label-kwds-regexp
)
10189 (c-add-syntax 'statement-block-intro
(point))
10190 (goto-char containing-sexp
)
10191 ;; c-backward-to-block-anchor not necessary here; those
10192 ;; situations are handled in case 17I above.
10193 (c-add-stmt-syntax 'statement-block-intro nil t
10195 (if (eq char-after-ip ?
{)
10196 (c-add-syntax 'block-open
)))
10200 ;; now we need to look at any modifiers
10201 (goto-char indent-point
)
10202 (skip-chars-forward " \t")
10204 ;; are we looking at a comment only line?
10205 (when (and (looking-at c-comment-start-regexp
)
10206 (/= (c-forward-token-2 0 nil
(c-point 'eol
)) 0))
10207 (c-append-syntax 'comment-intro
))
10209 ;; we might want to give additional offset to friends (in C++).
10210 (when (and c-opt-friend-key
10211 (looking-at c-opt-friend-key
))
10212 (c-append-syntax 'friend
))
10214 ;; Set syntactic-relpos.
10215 (let ((p c-syntactic-context
))
10217 (if (integerp (c-langelem-pos (car p
)))
10219 (setq syntactic-relpos
(c-langelem-pos (car p
)))
10224 ;; Start of or a continuation of a preprocessor directive?
10225 (if (and macro-start
10226 (eq macro-start
(c-point 'boi
))
10227 (not (and (c-major-mode-is 'pike-mode
)
10228 (eq (char-after (1+ macro-start
)) ?
\"))))
10229 (c-append-syntax 'cpp-macro
)
10230 (when (and c-syntactic-indentation-in-macros macro-start
)
10233 (< syntactic-relpos macro-start
)
10235 (assq 'arglist-intro c-syntactic-context
)
10236 (assq 'arglist-cont c-syntactic-context
)
10237 (assq 'arglist-cont-nonempty c-syntactic-context
)
10238 (assq 'arglist-close c-syntactic-context
))))
10239 ;; If inside a cpp expression, i.e. anywhere in a
10240 ;; cpp directive except a #define body, we only let
10241 ;; through the syntactic analysis that is internal
10242 ;; in the expression. That means the arglist
10243 ;; elements, if they are anchored inside the cpp
10245 (setq c-syntactic-context nil
)
10246 (c-add-syntax 'cpp-macro-cont macro-start
))
10247 (when (and (eq macro-start syntactic-relpos
)
10248 (not (assq 'cpp-define-intro c-syntactic-context
))
10250 (goto-char macro-start
)
10251 (or (not (c-forward-to-cpp-define-body))
10252 (<= (point) (c-point 'boi indent-point
)))))
10253 ;; Inside a #define body and the syntactic analysis is
10254 ;; anchored on the start of the #define. In this case
10255 ;; we add cpp-define-intro to get the extra
10256 ;; indentation of the #define body.
10257 (c-add-syntax 'cpp-define-intro
)))))
10259 ;; return the syntax
10260 c-syntactic-context
)))
10263 ;; Indentation calculation.
10265 (defun c-evaluate-offset (offset langelem symbol
)
10266 ;; offset can be a number, a function, a variable, a list, or one of
10267 ;; the symbols + or -
10269 ;; This function might do hidden buffer changes.
10272 ((numberp offset
) offset
)
10273 ((vectorp offset
) offset
)
10274 ((null offset
) nil
)
10276 ((eq offset
'+) c-basic-offset
)
10277 ((eq offset
'-
) (- c-basic-offset
))
10278 ((eq offset
'++) (* 2 c-basic-offset
))
10279 ((eq offset
'--
) (* 2 (- c-basic-offset
)))
10280 ((eq offset
'*) (/ c-basic-offset
2))
10281 ((eq offset
'/) (/ (- c-basic-offset
) 2))
10283 ((functionp offset
)
10286 (cons (c-langelem-sym langelem
)
10287 (c-langelem-pos langelem
)))
10292 ((eq (car offset
) 'quote
)
10293 (c-benign-error "The offset %S for %s was mistakenly quoted"
10297 ((memq (car offset
) '(min max
))
10298 (let (res val
(method (car offset
)))
10299 (setq offset
(cdr offset
))
10301 (setq val
(c-evaluate-offset (car offset
) langelem symbol
))
10309 Error evaluating offset %S for %s: \
10310 Cannot combine absolute offset %S with relative %S in `%s' method"
10311 (car offset
) symbol res val method
)
10312 (setq res
(funcall method res val
))))
10316 Error evaluating offset %S for %s: \
10317 Cannot combine relative offset %S with absolute %S in `%s' method"
10318 (car offset
) symbol res val method
)
10319 (setq res
(vector (funcall method
(aref res
0)
10321 (setq offset
(cdr offset
)))
10324 ((eq (car offset
) 'add
)
10326 (setq offset
(cdr offset
))
10328 (setq val
(c-evaluate-offset (car offset
) langelem symbol
))
10335 (setq res
(vector (+ (aref res
0) val
)))
10336 (setq res
(+ res val
))))
10340 Error evaluating offset %S for %s: \
10341 Cannot combine absolute offsets %S and %S in `add' method"
10342 (car offset
) symbol res val
)
10343 (setq res val
)))) ; Override.
10344 (setq offset
(cdr offset
)))
10349 (when (eq (car offset
) 'first
)
10350 (setq offset
(cdr offset
)))
10351 (while (and (not res
) offset
)
10352 (setq res
(c-evaluate-offset (car offset
) langelem symbol
)
10353 offset
(cdr offset
)))
10356 ((and (symbolp offset
) (boundp offset
))
10357 (symbol-value offset
))
10360 (c-benign-error "Unknown offset format %S for %s" offset symbol
)
10363 (if (or (null res
) (integerp res
)
10364 (and (vectorp res
) (= (length res
) 1) (integerp (aref res
0))))
10366 (c-benign-error "Error evaluating offset %S for %s: Got invalid value %S"
10370 (defun c-calc-offset (langelem)
10371 ;; Get offset from LANGELEM which is a list beginning with the
10372 ;; syntactic symbol and followed by any analysis data it provides.
10373 ;; That data may be zero or more elements, but if at least one is
10374 ;; given then the first is the anchor position (or nil). The symbol
10375 ;; is matched against `c-offsets-alist' and the offset calculated
10376 ;; from that is returned.
10378 ;; This function might do hidden buffer changes.
10379 (let* ((symbol (c-langelem-sym langelem
))
10380 (match (assq symbol c-offsets-alist
))
10381 (offset (cdr-safe match
)))
10383 (setq offset
(c-evaluate-offset offset langelem symbol
))
10384 (if c-strict-syntax-p
10385 (c-benign-error "No offset found for syntactic symbol %s" symbol
))
10387 (if (vectorp offset
)
10389 (or (and (numberp offset
) offset
)
10390 (and (symbolp offset
) (symbol-value offset
))
10394 (defun c-get-offset (langelem)
10395 ;; This is a compatibility wrapper for `c-calc-offset' in case
10396 ;; someone is calling it directly. It takes an old style syntactic
10397 ;; element on the form (SYMBOL . ANCHOR-POS) and converts it to the
10400 ;; This function might do hidden buffer changes.
10401 (if (c-langelem-pos langelem
)
10402 (c-calc-offset (list (c-langelem-sym langelem
)
10403 (c-langelem-pos langelem
)))
10404 (c-calc-offset langelem
)))
10406 (defun c-get-syntactic-indentation (langelems)
10407 ;; Calculate the syntactic indentation from a syntactic description
10408 ;; as returned by `c-guess-syntax'.
10410 ;; Note that topmost-intro always has an anchor position at bol, for
10411 ;; historical reasons. It's often used together with other symbols
10412 ;; that has more sane positions. Since we always use the first
10413 ;; found anchor position, we rely on that these other symbols always
10414 ;; precede topmost-intro in the LANGELEMS list.
10416 ;; This function might do hidden buffer changes.
10417 (let ((indent 0) anchor
)
10420 (let* ((c-syntactic-element (car langelems
))
10421 (res (c-calc-offset c-syntactic-element
)))
10424 ;; Got an absolute column that overrides any indentation
10425 ;; we've collected so far, but not the relative
10426 ;; indentation we might get for the nested structures
10427 ;; further down the langelems list.
10428 (setq indent
(elt res
0)
10429 anchor
(point-min)) ; A position at column 0.
10431 ;; Got a relative change of the current calculated
10433 (setq indent
(+ indent res
))
10435 ;; Use the anchor position from the first syntactic
10436 ;; element with one.
10438 (setq anchor
(c-langelem-pos (car langelems
)))))
10440 (setq langelems
(cdr langelems
))))
10443 (+ indent
(save-excursion
10449 (cc-provide 'cc-engine
)
10451 ;;; cc-engine.el ends here