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 ;; Symbol just scanned back over (e.g. 'while or 'boundary).
715 ;; Current state in the automaton. See above.
717 ;; Current saved positions. See above.
719 ;; Stack of conses (state . saved-pos).
721 ;; Regexp which matches "for", "if", etc.
722 (cond-key (or c-opt-block-stmt-key
723 "\\<\\>")) ; Matches nothing.
726 ;; Positions of the last three sexps or bounds we've stopped at.
730 (if lim (narrow-to-region lim (point-max)))
733 (and (c-beginning-of-macro)
735 (setq macro-start (point)))
737 ;; Try to skip back over unary operator characters, to register
741 (c-backward-syntactic-ws)
742 ;; Protect post-++/-- operators just before a virtual semicolon.
743 (and (not (c-at-vsemi-p))
744 (/= (skip-chars-backward "-+!*&~@`#") 0))))
746 ;; Skip back over any semicolon here. If it was a bare semicolon, we're
747 ;; done. Later on we ignore the boundaries for statements that don't
748 ;; contain any sexp. The only thing that is affected is that the error
749 ;; checking is a little less strict, and we really don't bother.
750 (if (and (memq (char-before) delims)
751 (progn (forward-char -1)
753 (c-backward-syntactic-ws)
754 (or (memq (char-before) delims)
755 (memq (char-before) '(?: nil))
756 (eq (char-syntax (char-before)) ?\()
761 ;; Begin at start and not pos to detect macros if we stand
762 ;; directly after the #.
764 (if (looking-at "\\<\\|\\W")
765 ;; Record this as the first token if not starting inside it.
768 ;; The following while loop goes back one sexp (balanced parens,
769 ;; etc. with contents, or symbol or suchlike) each iteration. This
770 ;; movement is accomplished with a call to scan-sexps approx 130 lines
773 (catch 'loop ;; Throw nil to break, non-nil to continue.
776 (and macro-start ; Always NIL for AWK.
777 (progn (skip-chars-backward " \t")
778 (eq (char-before) ?#))
779 (progn (setq saved (1- (point)))
781 (not (eq (char-before (1- (point))) ?\\)))
782 (looking-at c-opt-cpp-start)
783 (progn (skip-chars-forward " \t")
784 (eq (point) saved))))
786 (if (and (c-forward-to-cpp-define-body)
787 (progn (c-forward-syntactic-ws start)
789 ;; Stop at the first token in the content of the macro.
791 ignore-labels t) ; Avoid the label check on exit.
797 ;; Do a round through the automaton if we've just passed a
798 ;; statement boundary or passed a "while"-like token.
800 (and (looking-at cond-key)
801 (setq sym (intern (match-string 1)))))
803 (when (and (< pos start) (null stack))
806 ;; The PDA state handling.
808 ;; Refer to the description of the PDA in the opening
809 ;; comments. In the following OR form, the first leaf
810 ;; attempts to handles one of the specific actions detailed
811 ;; (e.g., finding token "if" whilst in state `else-boundary').
812 ;; We drop through to the second leaf (which handles common
813 ;; state) if no specific handler is found in the first cond.
814 ;; If a parsing error is detected (e.g. an "else" with no
815 ;; preceding "if"), we throw to the enclosing catch.
817 ;; Note that the (eq state 'else) means
818 ;; "we've just passed an else", NOT "we're looking for an
822 (if (eq sym 'boundary)
823 (setq state 'else-boundary)
825 (c-bos-pop-state-and-retry)))
827 ((eq state 'else-boundary)
829 (c-bos-pop-state (setq ret 'beginning)))
835 (if (and (eq sym 'boundary)
836 ;; Since this can cause backtracking we do a
837 ;; little more careful analysis to avoid it:
838 ;; If there's a label in front of the while
839 ;; it can't be part of a do-while.
840 (not after-labels-pos))
841 (progn (c-bos-save-pos)
842 (setq state 'while-boundary))
843 (c-bos-pop-state-and-retry))) ; Can't be a do-while
845 ((eq state 'while-boundary)
847 (c-bos-pop-state (setq ret 'beginning)))
848 ((eq sym 'boundary) ; isn't a do-while
849 (c-bos-restore-pos) ; the position of the while
850 (c-bos-pop-state)))) ; no longer searching for do.
853 (if (eq sym 'boundary)
854 (setq state 'catch-boundary)
856 (c-bos-pop-state-and-retry)))
858 ((eq state 'catch-boundary)
861 (c-bos-pop-state (setq ret 'beginning)))
866 (c-bos-pop-state)))))
868 ;; This is state common. We get here when the previous
869 ;; cond statement found no particular state handler.
870 (cond ((eq sym 'boundary)
871 ;; If we have a boundary at the start
872 ;; position we push a frame to go to the
873 ;; previous statement.
879 (c-bos-save-error-info 'if 'else)
882 ;; Is this a real while, or a do-while?
883 ;; The next `when' triggers unless we are SURE that
884 ;; the `while' is not the tailend of a `do-while'.
885 (when (or (not pptok)
886 (memq (char-after pptok) delims)
887 ;; The following kludge is to prevent
888 ;; infinite recursion when called from
889 ;; c-awk-after-if-for-while-condition-p,
891 (and (eq (point) start)
892 (c-vsemi-status-unknown-p))
893 (c-at-vsemi-p pptok))
894 ;; Since this can cause backtracking we do a
895 ;; little more careful analysis to avoid it: If
896 ;; the while isn't followed by a (possibly
897 ;; virtual) semicolon it can't be a do-while.
899 (setq state 'while)))
900 ((memq sym '(catch finally))
902 (c-bos-save-error-info 'try sym)
903 (setq state 'catch))))
906 ;; We're either past a statement boundary or at the
907 ;; start of a statement, so throw away any label data
908 ;; for the previous one.
909 (setq after-labels-pos nil
911 c-maybe-labelp nil))))
913 ;; Step to the previous sexp, but not if we crossed a
914 ;; boundary, since that doesn't consume an sexp.
915 (if (eq sym 'boundary)
918 ;; HERE IS THE SINGLE PLACE INSIDE THE PDA LOOP WHERE WE MOVE
919 ;; BACKWARDS THROUGH THE SOURCE.
921 ;; This is typically fast with the caching done by
922 ;; c-(backward|forward)-sws.
923 (c-backward-syntactic-ws)
925 (let ((before-sws-pos (point))
926 ;; Set as long as we have to continue jumping by sexps.
927 ;; It's the position to use as end in the next round.
928 sexp-loop-continue-pos
929 ;; The end position of the area to search for statement
930 ;; barriers in this round.
931 (sexp-loop-end-pos pos))
933 ;; The following while goes back one sexp per iteration.
936 (unless (c-safe (c-backward-sexp) t)
937 ;; Give up if we hit an unbalanced block. Since the
938 ;; stack won't be empty the code below will report a
942 ;; Check if the sexp movement crossed a statement or
943 ;; declaration boundary. But first modify the point
944 ;; so that `c-crosses-statement-barrier-p' only looks
945 ;; at the non-sexp chars following the sexp.
953 (when (c-beginning-of-macro)
954 ;; Set continuation position in case
955 ;; `c-crosses-statement-barrier-p'
956 ;; doesn't detect anything below.
957 (setq sexp-loop-continue-pos (point)))))
958 ;; If the sexp movement took us into a
959 ;; macro then there were only some non-sexp
960 ;; chars after it. Skip out of the macro
961 ;; to analyze them but not the non-sexp
962 ;; chars that might be inside the macro.
964 (c-crosses-statement-barrier-p
965 (point) sexp-loop-end-pos))
969 (not (c-looking-at-inexpr-block lim nil t)))
970 ;; Passed a block sexp. That's a boundary
974 ((looking-at "\\s\(")
975 ;; Passed some other paren. Only analyze
976 ;; the non-sexp chars after it.
977 (goto-char (1+ (c-down-list-backward
979 ;; We're at a valid token start position
980 ;; (outside the `save-excursion') if
981 ;; `c-crosses-statement-barrier-p' failed.
982 (c-crosses-statement-barrier-p
983 (point) sexp-loop-end-pos))
986 ;; Passed a symbol sexp or line
987 ;; continuation. It doesn't matter that
988 ;; it's included in the analyzed region.
989 (if (c-crosses-statement-barrier-p
990 (point) sexp-loop-end-pos)
992 ;; If it was a line continuation then we
993 ;; have to continue looping.
994 (if (looking-at "\\\\$")
995 (setq sexp-loop-continue-pos (point)))
1002 ;; Like a C "continue". Analyze the next sexp.
1005 sexp-loop-continue-pos) ; End of "go back a sexp" loop condition.
1006 (goto-char sexp-loop-continue-pos)
1007 (setq sexp-loop-end-pos sexp-loop-continue-pos
1008 sexp-loop-continue-pos nil))))
1011 (when (and c-opt-method-key
1012 (setq saved (c-in-method-def-p)))
1014 ignore-labels t) ; Avoid the label check on exit.
1018 (unless (eq ignore-labels t)
1019 (when (numberp c-maybe-labelp)
1020 ;; `c-crosses-statement-barrier-p' has found a colon, so we
1021 ;; might be in a label now. Have we got a real label
1022 ;; (including a case label) or something like C++'s "public:"?
1023 ;; A case label might use an expression rather than a token.
1024 (setq after-case:-pos (or tok start))
1025 (if (looking-at c-nonlabel-token-key) ; e.g. "while" or "'a'"
1026 (setq c-maybe-labelp nil)
1027 (if after-labels-pos ; Have we already encountered a label?
1028 (if (not last-label-pos)
1029 (setq last-label-pos (or tok start)))
1030 (setq after-labels-pos (or tok start)))
1031 (setq c-maybe-labelp t
1032 label-good-pos nil))) ; bogus "label"
1034 (when (and (not label-good-pos) ; i.e. no invalid "label"'s yet
1036 (looking-at c-nonlabel-token-key)) ; e.g. "while :"
1037 ;; We're in a potential label and it's the first
1038 ;; time we've found something that isn't allowed in
1040 (setq label-good-pos (or tok start))))
1042 ;; We've moved back by a sexp, so update the token positions.
1047 pos tok))) ; Not nil (for the while loop).
1049 ;; If the stack isn't empty there might be errors to report.
1051 (if (and (vectorp saved-pos) (eq (length saved-pos) 3))
1052 (c-bos-report-error))
1053 (setq saved-pos (cdr (car stack))
1056 (when (and (eq ret 'same)
1057 (not (memq sym '(boundary ignore nil))))
1058 ;; Need to investigate closer whether we've crossed
1059 ;; between a substatement and its containing statement.
1060 (if (setq saved (if (looking-at c-block-stmt-1-key)
1063 (cond ((> start saved) (setq pos saved))
1064 ((= start saved) (setq ret 'up)))))
1066 (when (and (not ignore-labels)
1067 (eq c-maybe-labelp t)
1068 (not (eq ret 'beginning))
1070 (or (not label-good-pos)
1071 (<= label-good-pos pos)
1073 (goto-char (if (and last-label-pos
1074 (< last-label-pos start))
1077 (looking-at c-label-kwds-regexp))))
1078 ;; We're in a label. Maybe we should step to the statement
1080 (if (< after-labels-pos start)
1081 (setq pos after-labels-pos)
1083 (if (and last-label-pos (< last-label-pos start))
1084 ;; Might have jumped over several labels. Go to the last one.
1085 (setq pos last-label-pos)))))
1087 ;; Have we got "case <expression>:"?
1089 (when (and after-case:-pos
1090 (not (eq ret 'beginning))
1091 (looking-at c-case-kwds-regexp))
1092 (if (< after-case:-pos start)
1093 (setq pos after-case:-pos))
1097 ;; Skip over the unary operators that can start the statement.
1099 (c-backward-syntactic-ws)
1100 ;; protect AWK post-inc/decrement operators, etc.
1101 (and (not (c-at-vsemi-p (point)))
1102 (/= (skip-chars-backward "-+!*&~@`#") 0)))
1107 (defun c-crosses-statement-barrier-p (from to)
1108 "Return non-nil if buffer positions FROM to TO cross one or more
1109 statement or declaration boundaries. The returned value is actually
1110 the position of the earliest boundary char. FROM must not be within
1111 a string or comment.
1113 The variable `c-maybe-labelp' is set to the position of the first `:' that
1114 might start a label (i.e. not part of `::' and not preceded by `?'). If a
1115 single `?' is found, then `c-maybe-labelp' is cleared.
1117 For AWK, a statement which is terminated by an EOL (not a \; or a }) is
1118 regarded as having a \"virtual semicolon\" immediately after the last token on
1119 the line. If this virtual semicolon is _at_ from, the function recognizes it.
1121 Note that this function might do hidden buffer changes. See the
1122 comment at the start of cc-engine.el for more info."
1123 (let ((skip-chars c-stmt-delim-chars)
1128 (while (progn (skip-chars-forward skip-chars to)
1131 ((setq lit-range (c-literal-limits from)) ; Have we landed in a string/comment?
1132 (goto-char (cdr lit-range)))
1133 ((eq (char-after) ?:)
1135 (if (and (eq (char-after) ?:)
1137 ;; Ignore scope operators.
1139 (setq c-maybe-labelp (1- (point)))))
1140 ((eq (char-after) ??)
1141 ;; A question mark. Can't be a label, so stop
1142 ;; looking for more : and ?.
1143 (setq c-maybe-labelp nil
1144 skip-chars (substring c-stmt-delim-chars 0 -2)))
1145 ((memq (char-after) '(?# ?\n ?\r)) ; A virtual semicolon?
1146 (if (and (eq (char-before) ?\\) (memq (char-after) '(?\n ?\r)))
1148 (skip-chars-backward " \t" from)
1150 (throw 'done (point))
1152 (t (throw 'done (point)))))
1153 ;; In trailing space after an as yet undetected virtual semicolon?
1154 (c-backward-syntactic-ws from)
1155 (if (and (< (point) to)
1160 (defun c-at-statement-start-p ()
1161 "Return non-nil if the point is at the first token in a statement
1162 or somewhere in the syntactic whitespace before it.
1164 A \"statement\" here is not restricted to those inside code blocks.
1165 Any kind of declaration-like construct that occur outside function
1166 bodies is also considered a \"statement\".
1168 Note that this function might do hidden buffer changes. See the
1169 comment at the start of cc-engine.el for more info."
1174 (c-syntactic-skip-backward (substring c-stmt-delim-chars 1) nil t)
1176 (eq (char-before) ?})
1177 (and (eq (char-before) ?{)
1178 (not (and c-special-brace-lists
1179 (progn (backward-char)
1180 (c-looking-at-special-brace-list)))))
1181 (c-crosses-statement-barrier-p (point) end)))))
1183 (defun c-at-expression-start-p ()
1184 "Return non-nil if the point is at the first token in an expression or
1185 statement, or somewhere in the syntactic whitespace before it.
1187 An \"expression\" here is a bit different from the normal language
1188 grammar sense: It's any sequence of expression tokens except commas,
1189 unless they are enclosed inside parentheses of some kind. Also, an
1190 expression never continues past an enclosing parenthesis, but it might
1191 contain parenthesis pairs of any sort except braces.
1193 Since expressions never cross statement boundaries, this function also
1194 recognizes statement beginnings, just like `c-at-statement-start-p'.
1196 Note that this function might do hidden buffer changes. See the
1197 comment at the start of cc-engine.el for more info."
1201 (c-stmt-delim-chars c-stmt-delim-chars-with-comma)
1203 (c-syntactic-skip-backward (substring c-stmt-delim-chars 1) nil t)
1205 (memq (char-before) '(?{ ?}))
1206 (save-excursion (backward-char)
1207 (looking-at "\\s("))
1208 (c-crosses-statement-barrier-p (point) end)))))
1211 ;; A set of functions that covers various idiosyncrasies in
1212 ;; implementations of `forward-comment'.
1214 ;; Note: Some emacsen considers incorrectly that any line comment
1215 ;; ending with a backslash continues to the next line. I can't think
1216 ;; of any way to work around that in a reliable way without changing
1217 ;; the buffer, though. Suggestions welcome. ;) (No, temporarily
1218 ;; changing the syntax for backslash doesn't work since we must treat
1219 ;; escapes in string literals correctly.)
1221 (defun c-forward-single-comment ()
1222 "Move forward past whitespace and the closest following comment, if any.
1223 Return t if a comment was found, nil otherwise. In either case, the
1224 point is moved past the following whitespace. Line continuations,
1225 i.e. a backslashes followed by line breaks, are treated as whitespace.
1226 The line breaks that end line comments are considered to be the
1227 comment enders, so the point will be put on the beginning of the next
1228 line if it moved past a line comment.
1230 This function does not do any hidden buffer changes."
1232 (let ((start (point)))
1233 (when (looking-at "\\([ \t\n\r\f\v]\\|\\\\[\n\r]\\)+")
1234 (goto-char (match-end 0)))
1236 (when (forward-comment 1)
1238 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1242 ;; Emacs includes the ending newline in a b-style (c++)
1243 ;; comment, but XEmacs doesn't. We depend on the Emacs
1244 ;; behavior (which also is symmetric).
1245 (if (and (eolp) (elt (parse-partial-sexp start (point)) 7))
1246 (condition-case nil (forward-char 1)))
1250 (defsubst c-forward-comments ()
1251 "Move forward past all following whitespace and comments.
1252 Line continuations, i.e. a backslashes followed by line breaks, are
1253 treated as whitespace.
1255 Note that this function might do hidden buffer changes. See the
1256 comment at the start of cc-engine.el for more info."
1259 ;; If forward-comment in at least XEmacs 21 is given a large
1260 ;; positive value, it'll loop all the way through if it hits
1262 (and (forward-comment 5)
1263 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1267 (when (looking-at "\\\\[\n\r]")
1271 (defun c-backward-single-comment ()
1272 "Move backward past whitespace and the closest preceding comment, if any.
1273 Return t if a comment was found, nil otherwise. In either case, the
1274 point is moved past the preceding whitespace. Line continuations,
1275 i.e. a backslashes followed by line breaks, are treated as whitespace.
1276 The line breaks that end line comments are considered to be the
1277 comment enders, so the point cannot be at the end of the same line to
1278 move over a line comment.
1280 This function does not do any hidden buffer changes."
1282 (let ((start (point)))
1283 ;; When we got newline terminated comments, forward-comment in all
1284 ;; supported emacsen so far will stop at eol of each line not
1285 ;; ending with a comment when moving backwards. This corrects for
1286 ;; that, and at the same time handles line continuations.
1288 (skip-chars-backward " \t\n\r\f\v")
1289 (and (looking-at "[\n\r]")
1290 (eq (char-before) ?\\)))
1294 ;; Some emacsen (e.g. Emacs 19.34) return t when moving
1295 ;; backwards at bob.
1298 ;; Leave point after the closest following newline if we've
1299 ;; backed up over any above, since forward-comment won't move
1300 ;; backward over a line comment if point is at the end of the
1302 (re-search-forward "\\=\\s *[\n\r]" start t)
1304 (if (if (forward-comment -1)
1306 ;; If forward-comment above succeeded and we're at eol
1307 ;; then the newline we moved over above didn't end a
1308 ;; line comment, so we give it another go.
1309 (forward-comment -1)
1312 ;; Emacs <= 20 and XEmacs move back over the closer of a
1313 ;; block comment that lacks an opener.
1314 (if (looking-at "\\*/")
1315 (progn (forward-char 2) nil)
1318 (defsubst c-backward-comments ()
1319 "Move backward past all preceding whitespace and comments.
1320 Line continuations, i.e. a backslashes followed by line breaks, are
1321 treated as whitespace. The line breaks that end line comments are
1322 considered to be the comment enders, so the point cannot be at the end
1323 of the same line to move over a line comment. Unlike
1324 c-backward-syntactic-ws, this function doesn't move back over
1325 preprocessor directives.
1327 Note that this function might do hidden buffer changes. See the
1328 comment at the start of cc-engine.el for more info."
1330 (let ((start (point)))
1332 ;; `forward-comment' in some emacsen (e.g. XEmacs 21.4)
1333 ;; return t when moving backwards at bob.
1336 (if (forward-comment -1)
1337 (if (looking-at "\\*/")
1338 ;; Emacs <= 20 and XEmacs move back over the
1339 ;; closer of a block comment that lacks an opener.
1340 (progn (forward-char 2) nil)
1343 ;; XEmacs treats line continuations as whitespace but
1344 ;; only in the backward direction, which seems a bit
1345 ;; odd. Anyway, this is necessary for Emacs.
1346 (when (and (looking-at "[\n\r]")
1347 (eq (char-before) ?\\)
1353 ;; Tools for skipping over syntactic whitespace.
1355 ;; The following functions use text properties to cache searches over
1356 ;; large regions of syntactic whitespace. It works as follows:
1358 ;; o If a syntactic whitespace region contains anything but simple
1359 ;; whitespace (i.e. space, tab and line breaks), the text property
1360 ;; `c-in-sws' is put over it. At places where we have stopped
1361 ;; within that region there's also a `c-is-sws' text property.
1362 ;; That since there typically are nested whitespace inside that
1363 ;; must be handled separately, e.g. whitespace inside a comment or
1364 ;; cpp directive. Thus, from one point with `c-is-sws' it's safe
1365 ;; to jump to another point with that property within the same
1366 ;; `c-in-sws' region. It can be likened to a ladder where
1367 ;; `c-in-sws' marks the bars and `c-is-sws' the rungs.
1369 ;; o The `c-is-sws' property is put on the simple whitespace chars at
1370 ;; a "rung position" and also maybe on the first following char.
1371 ;; As many characters as can be conveniently found in this range
1372 ;; are marked, but no assumption can be made that the whole range
1373 ;; is marked (it could be clobbered by later changes, for
1376 ;; Note that some part of the beginning of a sequence of simple
1377 ;; whitespace might be part of the end of a preceding line comment
1378 ;; or cpp directive and must not be considered part of the "rung".
1379 ;; Such whitespace is some amount of horizontal whitespace followed
1380 ;; by a newline. In the case of cpp directives it could also be
1381 ;; two newlines with horizontal whitespace between them.
1383 ;; The reason to include the first following char is to cope with
1384 ;; "rung positions" that doesn't have any ordinary whitespace. If
1385 ;; `c-is-sws' is put on a token character it does not have
1386 ;; `c-in-sws' set simultaneously. That's the only case when that
1387 ;; can occur, and the reason for not extending the `c-in-sws'
1388 ;; region to cover it is that the `c-in-sws' region could then be
1389 ;; accidentally merged with a following one if the token is only
1390 ;; one character long.
1392 ;; o On buffer changes the `c-in-sws' and `c-is-sws' properties are
1393 ;; removed in the changed region. If the change was inside
1394 ;; syntactic whitespace that means that the "ladder" is broken, but
1395 ;; a later call to `c-forward-sws' or `c-backward-sws' will use the
1396 ;; parts on either side and use an ordinary search only to "repair"
1399 ;; Special care needs to be taken if a region is removed: If there
1400 ;; are `c-in-sws' on both sides of it which do not connect inside
1401 ;; the region then they can't be joined. If e.g. a marked macro is
1402 ;; broken, syntactic whitespace inside the new text might be
1403 ;; marked. If those marks would become connected with the old
1404 ;; `c-in-sws' range around the macro then we could get a ladder
1405 ;; with one end outside the macro and the other at some whitespace
1408 ;; The main motivation for this system is to increase the speed in
1409 ;; skipping over the large whitespace regions that can occur at the
1410 ;; top level in e.g. header files that contain a lot of comments and
1411 ;; cpp directives. For small comments inside code it's probably
1412 ;; slower than using `forward-comment' straightforwardly, but speed is
1413 ;; not a significant factor there anyway.
1415 ; (defface c-debug-is-sws-face
1416 ; '((t (:background "GreenYellow")))
1417 ; "Debug face to mark the `c-is-sws' property.")
1418 ; (defface c-debug-in-sws-face
1419 ; '((t (:underline t)))
1420 ; "Debug face to mark the `c-in-sws' property.")
1422 ; (defun c-debug-put-sws-faces ()
1423 ; ;; Put the sws debug faces on all the `c-is-sws' and `c-in-sws'
1424 ; ;; properties in the buffer.
1427 ; (c-save-buffer-state (in-face)
1428 ; (goto-char (point-min))
1429 ; (setq in-face (if (get-text-property (point) 'c-is-sws)
1432 ; (goto-char (next-single-property-change
1433 ; (point) 'c-is-sws nil (point-max)))
1436 ; (c-debug-add-face in-face (point) 'c-debug-is-sws-face)
1437 ; (setq in-face nil))
1438 ; (setq in-face (point)))
1440 ; (goto-char (point-min))
1441 ; (setq in-face (if (get-text-property (point) 'c-in-sws)
1444 ; (goto-char (next-single-property-change
1445 ; (point) 'c-in-sws nil (point-max)))
1448 ; (c-debug-add-face in-face (point) 'c-debug-in-sws-face)
1449 ; (setq in-face nil))
1450 ; (setq in-face (point)))
1453 (defmacro c-debug-sws-msg (&rest args)
1457 (defmacro c-put-is-sws (beg end)
1458 ;; This macro does a hidden buffer change.
1459 `(let ((beg ,beg) (end ,end))
1460 (put-text-property beg end 'c-is-sws t)
1461 ,@(when (facep 'c-debug-is-sws-face)
1462 `((c-debug-add-face beg end 'c-debug-is-sws-face)))))
1464 (defmacro c-put-in-sws (beg end)
1465 ;; This macro does a hidden buffer change.
1466 `(let ((beg ,beg) (end ,end))
1467 (put-text-property beg end 'c-in-sws t)
1468 ,@(when (facep 'c-debug-is-sws-face)
1469 `((c-debug-add-face beg end 'c-debug-in-sws-face)))))
1471 (defmacro c-remove-is-sws (beg end)
1472 ;; This macro does a hidden buffer change.
1473 `(let ((beg ,beg) (end ,end))
1474 (remove-text-properties beg end '(c-is-sws nil))
1475 ,@(when (facep 'c-debug-is-sws-face)
1476 `((c-debug-remove-face beg end 'c-debug-is-sws-face)))))
1478 (defmacro c-remove-in-sws (beg end)
1479 ;; This macro does a hidden buffer change.
1480 `(let ((beg ,beg) (end ,end))
1481 (remove-text-properties beg end '(c-in-sws nil))
1482 ,@(when (facep 'c-debug-is-sws-face)
1483 `((c-debug-remove-face beg end 'c-debug-in-sws-face)))))
1485 (defmacro c-remove-is-and-in-sws (beg end)
1486 ;; This macro does a hidden buffer change.
1487 `(let ((beg ,beg) (end ,end))
1488 (remove-text-properties beg end '(c-is-sws nil c-in-sws nil))
1489 ,@(when (facep 'c-debug-is-sws-face)
1490 `((c-debug-remove-face beg end 'c-debug-is-sws-face)
1491 (c-debug-remove-face beg end 'c-debug-in-sws-face)))))
1493 (defsubst c-invalidate-sws-region-after (beg end)
1494 ;; Called from `after-change-functions'. Note that if
1495 ;; `c-forward-sws' or `c-backward-sws' are used outside
1496 ;; `c-save-buffer-state' or similar then this will remove the cache
1497 ;; properties right after they're added.
1499 ;; This function does hidden buffer changes.
1502 ;; Adjust the end to remove the properties in any following simple
1503 ;; ws up to and including the next line break, if there is any
1504 ;; after the changed region. This is necessary e.g. when a rung
1505 ;; marked empty line is converted to a line comment by inserting
1506 ;; "//" before the line break. In that case the line break would
1507 ;; keep the rung mark which could make a later `c-backward-sws'
1508 ;; move into the line comment instead of over it.
1510 (skip-chars-forward " \t\f\v")
1511 (when (and (eolp) (not (eobp)))
1512 (setq end (1+ (point)))))
1514 (when (and (= beg end)
1515 (get-text-property beg 'c-in-sws)
1517 (get-text-property (1- beg) 'c-in-sws))
1518 ;; Ensure that an `c-in-sws' range gets broken. Note that it isn't
1519 ;; safe to keep a range that was continuous before the change. E.g:
1525 ;; There can be a "ladder" between "#" and "b". Now, if the newline
1526 ;; after "foo" is removed then "bar" will become part of the cpp
1527 ;; directive instead of a syntactically relevant token. In that
1528 ;; case there's no longer syntactic ws from "#" to "b".
1529 (setq beg (1- beg)))
1531 (c-debug-sws-msg "c-invalidate-sws-region-after [%s..%s]" beg end)
1532 (c-remove-is-and-in-sws beg end))
1534 (defun c-forward-sws ()
1535 ;; Used by `c-forward-syntactic-ws' to implement the unbounded search.
1537 ;; This function might do hidden buffer changes.
1539 (let (;; `rung-pos' is set to a position as early as possible in the
1540 ;; unmarked part of the simple ws region.
1541 (rung-pos (point)) next-rung-pos rung-end-pos last-put-in-sws-pos
1542 rung-is-marked next-rung-is-marked simple-ws-end
1543 ;; `safe-start' is set when it's safe to cache the start position.
1544 ;; It's not set if we've initially skipped over comments and line
1545 ;; continuations since we might have gone out through the end of a
1546 ;; macro then. This provision makes `c-forward-sws' not populate the
1547 ;; cache in the majority of cases, but otoh is `c-backward-sws' by far
1551 ;; Skip simple ws and do a quick check on the following character to see
1552 ;; if it's anything that can't start syntactic ws, so we can bail out
1553 ;; early in the majority of cases when there just are a few ws chars.
1554 (skip-chars-forward " \t\n\r\f\v")
1555 (when (looking-at c-syntactic-ws-start)
1557 (setq rung-end-pos (min (1+ (point)) (point-max)))
1558 (if (setq rung-is-marked (text-property-any rung-pos rung-end-pos
1560 ;; Find the last rung position to avoid setting properties in all
1561 ;; the cases when the marked rung is complete.
1562 ;; (`next-single-property-change' is certain to move at least one
1564 (setq rung-pos (1- (next-single-property-change
1565 rung-is-marked 'c-is-sws nil rung-end-pos)))
1566 ;; Got no marked rung here. Since the simple ws might have started
1567 ;; inside a line comment or cpp directive we must set `rung-pos' as
1568 ;; high as possible.
1569 (setq rung-pos (point)))
1574 (when (and rung-is-marked
1575 (get-text-property (point) 'c-in-sws))
1577 ;; The following search is the main reason that `c-in-sws'
1578 ;; and `c-is-sws' aren't combined to one property.
1579 (goto-char (next-single-property-change
1580 (point) 'c-in-sws nil (point-max)))
1581 (unless (get-text-property (point) 'c-is-sws)
1582 ;; If the `c-in-sws' region extended past the last
1583 ;; `c-is-sws' char we have to go back a bit.
1584 (or (get-text-property (1- (point)) 'c-is-sws)
1585 (goto-char (previous-single-property-change
1586 (point) 'c-is-sws)))
1590 "c-forward-sws cached move %s -> %s (max %s)"
1591 rung-pos (point) (point-max))
1593 (setq rung-pos (point))
1594 (and (> (skip-chars-forward " \t\n\r\f\v") 0)
1597 ;; We'll loop here if there is simple ws after the last rung.
1598 ;; That means that there's been some change in it and it's
1599 ;; possible that we've stepped into another ladder, so extend
1600 ;; the previous one to join with it if there is one, and try to
1601 ;; use the cache again.
1603 "c-forward-sws extending rung with [%s..%s] (max %s)"
1604 (1+ rung-pos) (1+ (point)) (point-max))
1605 (unless (get-text-property (point) 'c-is-sws)
1606 ;; Remove any `c-in-sws' property from the last char of
1607 ;; the rung before we mark it with `c-is-sws', so that we
1608 ;; won't connect with the remains of a broken "ladder".
1609 (c-remove-in-sws (point) (1+ (point))))
1610 (c-put-is-sws (1+ rung-pos)
1612 (c-put-in-sws rung-pos
1613 (setq rung-pos (point)
1614 last-put-in-sws-pos rung-pos)))
1616 (setq simple-ws-end (point))
1617 (c-forward-comments)
1620 ((/= (point) simple-ws-end)
1621 ;; Skipped over comments. Don't cache at eob in case the buffer
1626 (and c-opt-cpp-prefix
1627 (looking-at c-opt-cpp-start)
1628 (progn (skip-chars-backward " \t")
1631 (progn (backward-char)
1632 (not (eq (char-before) ?\\))))))
1633 ;; Skip a preprocessor directive.
1635 (while (and (eq (char-before) ?\\)
1636 (= (forward-line 1) 0))
1640 ;; Don't cache at eob in case the buffer is narrowed.
1643 ;; We've searched over a piece of non-white syntactic ws. See if this
1645 (setq next-rung-pos (point))
1646 (skip-chars-forward " \t\n\r\f\v")
1647 (setq rung-end-pos (min (1+ (point)) (point-max)))
1650 ;; Cache if we haven't skipped comments only, and if we started
1651 ;; either from a marked rung or from a completely uncached
1655 (not (get-text-property simple-ws-end 'c-in-sws))))
1657 ;; See if there's a marked rung in the encountered simple ws. If
1658 ;; so then we can cache, unless `safe-start' is nil. Even then
1659 ;; we need to do this to check if the cache can be used for the
1661 (and (setq next-rung-is-marked
1662 (text-property-any next-rung-pos rung-end-pos
1668 "c-forward-sws caching [%s..%s] - [%s..%s] (max %s)"
1669 rung-pos (1+ simple-ws-end) next-rung-pos rung-end-pos
1672 ;; Remove the properties for any nested ws that might be cached.
1673 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
1675 (c-remove-is-sws (1+ simple-ws-end) next-rung-pos)
1676 (unless (and rung-is-marked (= rung-pos simple-ws-end))
1677 (c-put-is-sws rung-pos
1679 (setq rung-is-marked t))
1680 (c-put-in-sws rung-pos
1681 (setq rung-pos (point)
1682 last-put-in-sws-pos rung-pos))
1683 (unless (get-text-property (1- rung-end-pos) 'c-is-sws)
1684 ;; Remove any `c-in-sws' property from the last char of
1685 ;; the rung before we mark it with `c-is-sws', so that we
1686 ;; won't connect with the remains of a broken "ladder".
1687 (c-remove-in-sws (1- rung-end-pos) rung-end-pos))
1688 (c-put-is-sws next-rung-pos
1692 "c-forward-sws not caching [%s..%s] - [%s..%s] (max %s)"
1693 rung-pos (1+ simple-ws-end) next-rung-pos rung-end-pos
1696 ;; Set `rung-pos' for the next rung. It's the same thing here as
1697 ;; initially, except that the rung position is set as early as
1698 ;; possible since we can't be in the ending ws of a line comment or
1699 ;; cpp directive now.
1700 (if (setq rung-is-marked next-rung-is-marked)
1701 (setq rung-pos (1- (next-single-property-change
1702 rung-is-marked 'c-is-sws nil rung-end-pos)))
1703 (setq rung-pos next-rung-pos))
1704 (setq safe-start t)))
1706 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
1707 ;; another one after the point (which might occur when editing inside a
1708 ;; comment or macro).
1709 (when (eq last-put-in-sws-pos (point))
1710 (cond ((< last-put-in-sws-pos (point-max))
1712 "c-forward-sws clearing at %s for cache separation"
1713 last-put-in-sws-pos)
1714 (c-remove-in-sws last-put-in-sws-pos
1715 (1+ last-put-in-sws-pos)))
1717 ;; If at eob we have to clear the last character before the end
1718 ;; instead since the buffer might be narrowed and there might
1719 ;; be a `c-in-sws' after (point-max). In this case it's
1720 ;; necessary to clear both properties.
1722 "c-forward-sws clearing thoroughly at %s for cache separation"
1723 (1- last-put-in-sws-pos))
1724 (c-remove-is-and-in-sws (1- last-put-in-sws-pos)
1725 last-put-in-sws-pos))))
1728 (defun c-backward-sws ()
1729 ;; Used by `c-backward-syntactic-ws' to implement the unbounded search.
1731 ;; This function might do hidden buffer changes.
1733 (let (;; `rung-pos' is set to a position as late as possible in the unmarked
1734 ;; part of the simple ws region.
1735 (rung-pos (point)) next-rung-pos last-put-in-sws-pos
1736 rung-is-marked simple-ws-beg cmt-skip-pos)
1738 ;; Skip simple horizontal ws and do a quick check on the preceding
1739 ;; character to see if it's anying that can't end syntactic ws, so we can
1740 ;; bail out early in the majority of cases when there just are a few ws
1741 ;; chars. Newlines are complicated in the backward direction, so we can't
1743 (skip-chars-backward " \t\f")
1744 (when (and (not (bobp))
1747 (looking-at c-syntactic-ws-end)))
1749 ;; Try to find a rung position in the simple ws preceding point, so that
1750 ;; we can get a cache hit even if the last bit of the simple ws has
1751 ;; changed recently.
1752 (setq simple-ws-beg (point))
1753 (skip-chars-backward " \t\n\r\f\v")
1754 (if (setq rung-is-marked (text-property-any
1755 (point) (min (1+ rung-pos) (point-max))
1757 ;; `rung-pos' will be the earliest marked position, which means that
1758 ;; there might be later unmarked parts in the simple ws region.
1759 ;; It's not worth the effort to fix that; the last part of the
1760 ;; simple ws is also typically edited often, so it could be wasted.
1761 (goto-char (setq rung-pos rung-is-marked))
1762 (goto-char simple-ws-beg))
1767 (when (and rung-is-marked
1769 (get-text-property (1- (point)) 'c-in-sws))
1771 ;; The following search is the main reason that `c-in-sws'
1772 ;; and `c-is-sws' aren't combined to one property.
1773 (goto-char (previous-single-property-change
1774 (point) 'c-in-sws nil (point-min)))
1775 (unless (get-text-property (point) 'c-is-sws)
1776 ;; If the `c-in-sws' region extended past the first
1777 ;; `c-is-sws' char we have to go forward a bit.
1778 (goto-char (next-single-property-change
1779 (point) 'c-is-sws)))
1782 "c-backward-sws cached move %s <- %s (min %s)"
1783 (point) rung-pos (point-min))
1785 (setq rung-pos (point))
1786 (if (and (< (min (skip-chars-backward " \t\f\v")
1788 (setq simple-ws-beg (point))
1789 (skip-chars-backward " \t\n\r\f\v")))
1791 (setq rung-is-marked
1792 (text-property-any (point) rung-pos
1795 (goto-char simple-ws-beg)
1798 ;; We'll loop here if there is simple ws before the first rung.
1799 ;; That means that there's been some change in it and it's
1800 ;; possible that we've stepped into another ladder, so extend
1801 ;; the previous one to join with it if there is one, and try to
1802 ;; use the cache again.
1804 "c-backward-sws extending rung with [%s..%s] (min %s)"
1805 rung-is-marked rung-pos (point-min))
1806 (unless (get-text-property (1- rung-pos) 'c-is-sws)
1807 ;; Remove any `c-in-sws' property from the last char of
1808 ;; the rung before we mark it with `c-is-sws', so that we
1809 ;; won't connect with the remains of a broken "ladder".
1810 (c-remove-in-sws (1- rung-pos) rung-pos))
1811 (c-put-is-sws rung-is-marked
1813 (c-put-in-sws rung-is-marked
1815 (setq rung-pos rung-is-marked
1816 last-put-in-sws-pos rung-pos))
1818 (c-backward-comments)
1819 (setq cmt-skip-pos (point))
1822 ((and c-opt-cpp-prefix
1823 (/= cmt-skip-pos simple-ws-beg)
1824 (c-beginning-of-macro))
1825 ;; Inside a cpp directive. See if it should be skipped over.
1826 (let ((cpp-beg (point)))
1828 ;; Move back over all line continuations in the region skipped
1829 ;; over by `c-backward-comments'. If we go past it then we
1830 ;; started inside the cpp directive.
1831 (goto-char simple-ws-beg)
1833 (while (and (> (point) cmt-skip-pos)
1834 (progn (backward-char)
1835 (eq (char-before) ?\\)))
1836 (beginning-of-line))
1838 (if (< (point) cmt-skip-pos)
1839 ;; Don't move past the cpp directive if we began inside
1840 ;; it. Note that the position at the end of the last line
1841 ;; of the macro is also considered to be within it.
1842 (progn (goto-char cmt-skip-pos)
1845 ;; It's worthwhile to spend a little bit of effort on finding
1846 ;; the end of the macro, to get a good `simple-ws-beg'
1847 ;; position for the cache. Note that `c-backward-comments'
1848 ;; could have stepped over some comments before going into
1849 ;; the macro, and then `simple-ws-beg' must be kept on the
1850 ;; same side of those comments.
1851 (goto-char simple-ws-beg)
1852 (skip-chars-backward " \t\n\r\f\v")
1853 (if (eq (char-before) ?\\)
1856 (if (< (point) simple-ws-beg)
1857 ;; Might happen if comments after the macro were skipped
1859 (setq simple-ws-beg (point)))
1864 ((/= (save-excursion
1865 (skip-chars-forward " \t\n\r\f\v" simple-ws-beg)
1866 (setq next-rung-pos (point)))
1868 ;; Skipped over comments. Must put point at the end of
1869 ;; the simple ws at point since we might be after a line
1870 ;; comment or cpp directive that's been partially
1871 ;; narrowed out, and we can't risk marking the simple ws
1872 ;; at the end of it.
1873 (goto-char next-rung-pos)
1876 ;; We've searched over a piece of non-white syntactic ws. See if this
1878 (setq next-rung-pos (point))
1879 (skip-chars-backward " \t\f\v")
1882 ;; Cache if we started either from a marked rung or from a
1883 ;; completely uncached position.
1885 (not (get-text-property (1- simple-ws-beg) 'c-in-sws))
1887 ;; Cache if there's a marked rung in the encountered simple ws.
1889 (skip-chars-backward " \t\n\r\f\v")
1890 (text-property-any (point) (min (1+ next-rung-pos) (point-max))
1895 "c-backward-sws caching [%s..%s] - [%s..%s] (min %s)"
1896 (point) (1+ next-rung-pos)
1897 simple-ws-beg (min (1+ rung-pos) (point-max))
1900 ;; Remove the properties for any nested ws that might be cached.
1901 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
1903 (c-remove-is-sws (1+ next-rung-pos) simple-ws-beg)
1904 (unless (and rung-is-marked (= simple-ws-beg rung-pos))
1905 (let ((rung-end-pos (min (1+ rung-pos) (point-max))))
1906 (unless (get-text-property (1- rung-end-pos) 'c-is-sws)
1907 ;; Remove any `c-in-sws' property from the last char of
1908 ;; the rung before we mark it with `c-is-sws', so that we
1909 ;; won't connect with the remains of a broken "ladder".
1910 (c-remove-in-sws (1- rung-end-pos) rung-end-pos))
1911 (c-put-is-sws simple-ws-beg
1913 (setq rung-is-marked t)))
1914 (c-put-in-sws (setq simple-ws-beg (point)
1915 last-put-in-sws-pos simple-ws-beg)
1917 (c-put-is-sws (setq rung-pos simple-ws-beg)
1918 (1+ next-rung-pos)))
1921 "c-backward-sws not caching [%s..%s] - [%s..%s] (min %s)"
1922 (point) (1+ next-rung-pos)
1923 simple-ws-beg (min (1+ rung-pos) (point-max))
1925 (setq rung-pos next-rung-pos
1926 simple-ws-beg (point))
1929 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
1930 ;; another one before the point (which might occur when editing inside a
1931 ;; comment or macro).
1932 (when (eq last-put-in-sws-pos (point))
1933 (cond ((< (point-min) last-put-in-sws-pos)
1935 "c-backward-sws clearing at %s for cache separation"
1936 (1- last-put-in-sws-pos))
1937 (c-remove-in-sws (1- last-put-in-sws-pos)
1938 last-put-in-sws-pos))
1940 ;; If at bob and the buffer is narrowed, we have to clear the
1941 ;; character we're standing on instead since there might be a
1942 ;; `c-in-sws' before (point-min). In this case it's necessary
1943 ;; to clear both properties.
1945 "c-backward-sws clearing thoroughly at %s for cache separation"
1946 last-put-in-sws-pos)
1947 (c-remove-is-and-in-sws last-put-in-sws-pos
1948 (1+ last-put-in-sws-pos)))))
1952 ;; Other whitespace tools
1953 (defun c-partial-ws-p (beg end)
1954 ;; Is the region (beg end) WS, and is there WS (or BOB/EOB) next to the
1955 ;; region? This is a "heuristic" function. .....
1957 ;; The motivation for the second bit is to check whether removing this
1958 ;; region would coalesce two symbols.
1960 ;; FIXME!!! This function doesn't check virtual semicolons in any way. Be
1961 ;; careful about using this function for, e.g. AWK. (2007/3/7)
1963 (let ((end+1 (min (1+ end) (point-max))))
1964 (or (progn (goto-char (max (point-min) (1- beg)))
1965 (c-skip-ws-forward end)
1967 (progn (goto-char beg)
1968 (c-skip-ws-forward end+1)
1969 (eq (point) end+1))))))
1971 ;; A system for finding noteworthy parens before the point.
1973 (defconst c-state-cache-too-far 5000)
1974 ;; A maximum comfortable scanning distance, e.g. between
1975 ;; `c-state-cache-good-pos' and "HERE" (where we call c-parse-state). When
1976 ;; this distance is exceeded, we take "emergency meausures", e.g. by clearing
1977 ;; the cache and starting again from point-min or a beginning of defun. This
1978 ;; value can be tuned for efficiency or set to a lower value for testing.
1980 (defvar c-state-cache nil)
1981 (make-variable-buffer-local 'c-state-cache)
1982 ;; The state cache used by `c-parse-state' to cut down the amount of
1983 ;; searching. It's the result from some earlier `c-parse-state' call. See
1984 ;; `c-parse-state''s doc string for details of its structure.
1986 ;; The use of the cached info is more effective if the next
1987 ;; `c-parse-state' call is on a line close by the one the cached state
1988 ;; was made at; the cache can actually slow down a little if the
1989 ;; cached state was made very far back in the buffer. The cache is
1990 ;; most effective if `c-parse-state' is used on each line while moving
1993 (defvar c-state-cache-good-pos 1)
1994 (make-variable-buffer-local 'c-state-cache-good-pos)
1995 ;; This is a position where `c-state-cache' is known to be correct, or
1996 ;; nil (see below). It's a position inside one of the recorded unclosed
1997 ;; parens or the top level, but not further nested inside any literal or
1998 ;; subparen that is closed before the last recorded position.
2000 ;; The exact position is chosen to try to be close to yet earlier than
2001 ;; the position where `c-state-cache' will be called next. Right now
2002 ;; the heuristic is to set it to the position after the last found
2003 ;; closing paren (of any type) before the line on which
2004 ;; `c-parse-state' was called. That is chosen primarily to work well
2005 ;; with refontification of the current line.
2007 ;; 2009-07-28: When `c-state-point-min' and the last position where
2008 ;; `c-parse-state' or for which `c-invalidate-state-cache' was called, are
2009 ;; both in the same literal, there is no such "good position", and
2010 ;; c-state-cache-good-pos is then nil. This is the ONLY circumstance in which
2011 ;; it can be nil. In this case, `c-state-point-min-literal' will be non-nil.
2013 ;; 2009-06-12: In a brace desert, c-state-cache-good-pos may also be in
2014 ;; the middle of the desert, as long as it is not within a brace pair
2015 ;; recorded in `c-state-cache' or a paren/bracket pair.
2018 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2019 ;; We maintain a simple cache of positions which aren't in a literal, so as to
2020 ;; speed up testing for non-literality.
2021 (defconst c-state-nonlit-pos-interval 10000)
2022 ;; The approximate interval between entries in `c-state-nonlit-pos-cache'.
2024 (defvar c-state-nonlit-pos-cache nil)
2025 (make-variable-buffer-local 'c-state-nonlit-pos-cache)
2026 ;; A list of buffer positions which are known not to be in a literal. This is
2027 ;; ordered with higher positions at the front of the list. Only those which
2028 ;; are less than `c-state-nonlit-pos-cache-limit' are valid.
2030 (defvar c-state-nonlit-pos-cache-limit 1)
2031 (make-variable-buffer-local 'c-state-nonlit-pos-cache-limit)
2032 ;; An upper limit on valid entries in `c-state-nonlit-pos-cache'. This is
2033 ;; reduced by buffer changes, and increased by invocations of
2034 ;; `c-state-literal-at'.
2036 (defsubst c-state-pp-to-literal (from to)
2037 ;; Do a parse-partial-sexp from FROM to TO, returning the bounds of any
2038 ;; literal at TO as a cons, otherwise NIL.
2039 ;; FROM must not be in a literal, and the buffer should already be wide
2042 (let ((s (parse-partial-sexp from to)))
2043 (when (or (nth 3 s) (nth 4 s)) ; in a string or comment
2044 (parse-partial-sexp (point) (point-max)
2048 'syntax-table) ; stop at end of literal
2049 (cons (nth 8 s) (point))))))
2051 (defun c-state-literal-at (here)
2052 ;; If position HERE is inside a literal, return (START . END), the
2053 ;; boundaries of the literal (which may be outside the accessible bit of the
2054 ;; buffer). Otherwise, return nil.
2056 ;; This function is almost the same as `c-literal-limits'. It differs in
2057 ;; that it is a lower level function, and that it rigourously follows the
2058 ;; syntax from BOB, whereas `c-literal-limits' uses a "local" safe position.
2062 (let ((c c-state-nonlit-pos-cache)
2064 ;; Trim the cache to take account of buffer changes.
2065 (while (and c (> (car c) c-state-nonlit-pos-cache-limit))
2067 (setq c-state-nonlit-pos-cache c)
2069 (while (and c (> (car c) here))
2071 (setq pos (or (car c) (point-min)))
2073 (while (<= (setq npos (+ pos c-state-nonlit-pos-interval))
2075 (setq lit (c-state-pp-to-literal pos npos))
2076 (setq pos (or (cdr lit) npos)) ; end of literal containing npos.
2077 (setq c-state-nonlit-pos-cache (cons pos c-state-nonlit-pos-cache)))
2079 (if (> pos c-state-nonlit-pos-cache-limit)
2080 (setq c-state-nonlit-pos-cache-limit pos))
2082 (setq lit (c-state-pp-to-literal pos here)))
2085 (defsubst c-state-lit-beg (pos)
2086 ;; Return the start of the literal containing POS, or POS itself.
2087 (or (car (c-state-literal-at pos))
2090 (defsubst c-state-cache-non-literal-place (pos state)
2091 ;; Return a position outside of a string/comment at or before POS.
2092 ;; STATE is the parse-partial-sexp state at POS.
2093 (if (or (nth 3 state) ; in a string?
2094 (nth 4 state)) ; in a comment?
2099 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2100 ;; Stuff to do with point-min, and coping with any literal there.
2101 (defvar c-state-point-min 1)
2102 (make-variable-buffer-local 'c-state-point-min)
2103 ;; This is (point-min) when `c-state-cache' was last calculated. A change of
2104 ;; narrowing is likely to affect the parens that are visible before the point.
2106 (defvar c-state-point-min-lit-type nil)
2107 (make-variable-buffer-local 'c-state-point-min-lit-type)
2108 (defvar c-state-point-min-lit-start nil)
2109 (make-variable-buffer-local 'c-state-point-min-lit-start)
2110 ;; These two variables define the literal, if any, containing point-min.
2111 ;; Their values are, respectively, 'string, c, or c++, and the start of the
2112 ;; literal. If there's no literal there, they're both nil.
2114 (defvar c-state-min-scan-pos 1)
2115 (make-variable-buffer-local 'c-state-min-scan-pos)
2116 ;; This is the earliest buffer-pos from which scanning can be done. It is
2117 ;; either the end of the literal containing point-min, or point-min itself.
2118 ;; It becomes nil if the buffer is changed earlier than this point.
2119 (defun c-state-get-min-scan-pos ()
2120 ;; Return the lowest valid scanning pos. This will be the end of the
2121 ;; literal enclosing point-min, or point-min itself.
2122 (or c-state-min-scan-pos
2126 (goto-char c-state-point-min-lit-start)
2127 (if (eq c-state-point-min-lit-type 'string)
2129 (forward-comment 1))
2130 (setq c-state-min-scan-pos (point))))))
2132 (defun c-state-mark-point-min-literal ()
2133 ;; Determine the properties of any literal containing POINT-MIN, setting the
2134 ;; variables `c-state-point-min-lit-type', `c-state-point-min-lit-start',
2135 ;; and `c-state-min-scan-pos' accordingly. The return value is meaningless.
2136 (let ((p-min (point-min))
2140 (setq lit (c-state-literal-at p-min))
2142 (setq c-state-point-min-lit-type
2144 (goto-char (car lit))
2146 ((looking-at c-block-comment-start-regexp) 'c)
2147 ((looking-at c-line-comment-starter) 'c++)
2149 c-state-point-min-lit-start (car lit)
2150 c-state-min-scan-pos (cdr lit))
2151 (setq c-state-point-min-lit-type nil
2152 c-state-point-min-lit-start nil
2153 c-state-min-scan-pos p-min)))))
2156 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2157 ;; A variable which signals a brace dessert - helpful for reducing the number
2158 ;; of fruitless backward scans.
2159 (defvar c-state-brace-pair-desert nil)
2160 (make-variable-buffer-local 'c-state-brace-pair-desert)
2161 ;; Used only in `c-append-lower-brace-pair-to-state-cache'. It is set when an
2162 ;; that defun has searched backwards for a brace pair and not found one. Its
2163 ;; value is either nil or a cons (PA . FROM), where PA is the position of the
2164 ;; enclosing opening paren/brace/bracket which bounds the backwards search (or
2165 ;; nil when at top level) and FROM is where the backward search started. It
2166 ;; is reset to nil in `c-invalidate-state-cache'.
2169 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2170 ;; Lowish level functions/macros which work directly on `c-state-cache', or a
2171 ;; list of like structure.
2172 (defmacro c-state-cache-top-lparen (&optional cache)
2173 ;; Return the address of the top left brace/bracket/paren recorded in CACHE
2174 ;; (default `c-state-cache') (or nil).
2175 (let ((cash (or cache 'c-state-cache)))
2176 `(if (consp (car ,cash))
2180 (defmacro c-state-cache-top-paren (&optional cache)
2181 ;; Return the address of the latest brace/bracket/paren (whether left or
2182 ;; right) recorded in CACHE (default `c-state-cache') or nil.
2183 (let ((cash (or cache 'c-state-cache)))
2184 `(if (consp (car ,cash))
2188 (defmacro c-state-cache-after-top-paren (&optional cache)
2189 ;; Return the position just after the latest brace/bracket/paren (whether
2190 ;; left or right) recorded in CACHE (default `c-state-cache') or nil.
2191 (let ((cash (or cache 'c-state-cache)))
2192 `(if (consp (car ,cash))
2195 (1+ (car ,cash))))))
2197 (defun c-get-cache-scan-pos (here)
2198 ;; From the state-cache, determine the buffer position from which we might
2199 ;; scan forward to HERE to update this cache. This position will be just
2200 ;; after a paren/brace/bracket recorded in the cache, if possible, otherwise
2201 ;; return the earliest position in the accessible region which isn't within
2202 ;; a literal. If the visible portion of the buffer is entirely within a
2203 ;; literal, return NIL.
2204 (let ((c c-state-cache) elt)
2205 ;(while (>= (or (c-state-cache-top-lparen c) 1) here)
2207 (>= (c-state-cache-top-lparen c) here))
2213 (if (> (cdr elt) here)
2217 ((<= (c-state-get-min-scan-pos) here)
2218 (c-state-get-min-scan-pos))
2221 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2222 ;; Variables which keep track of preprocessor constructs.
2223 (defvar c-state-old-cpp-beg nil)
2224 (make-variable-buffer-local 'c-state-old-cpp-beg)
2225 (defvar c-state-old-cpp-end nil)
2226 (make-variable-buffer-local 'c-state-old-cpp-end)
2227 ;; These are the limits of the macro containing point at the previous call of
2228 ;; `c-parse-state', or nil.
2230 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2231 ;; Defuns which analyse the buffer, yet don't change `c-state-cache'.
2232 (defun c-get-fallback-scan-pos (here)
2233 ;; Return a start position for building `c-state-cache' from
2234 ;; scratch. This will be at the top level, 2 defuns back.
2236 ;; Go back 2 bods, but ignore any bogus positions returned by
2237 ;; beginning-of-defun (i.e. open paren in column zero).
2240 (while (not (or (bobp) (zerop cnt)))
2241 (c-beginning-of-defun-1) ; Pure elisp BOD.
2242 (if (eq (char-after) ?\{)
2243 (setq cnt (1- cnt)))))
2246 (defun c-state-balance-parens-backwards (here- here+ top)
2247 ;; Return the position of the opening paren/brace/bracket before HERE- which
2248 ;; matches the outermost close p/b/b between HERE+ and TOP. Except when
2249 ;; there's a macro, HERE- and HERE+ are the same. Like this:
2251 ;; ............................................
2253 ;; ( [ ( .........#macro.. ) ( ) ] )
2256 ;; return HERE- HERE+ TOP
2258 ;; If there aren't enough opening paren/brace/brackets, return the position
2259 ;; of the outermost one found, or HERE- if there are none. If there are no
2260 ;; closeing p/b/bs between HERE+ and TOP, return HERE-. HERE-/+ and TOP
2261 ;; must not be inside literals. Only the accessible portion of the buffer
2264 ;; PART 1: scan from `here+' up to `top', accumulating ")"s which enclose
2265 ;; `here'. Go round the next loop each time we pass over such a ")". These
2266 ;; probably match "("s before `here-'.
2267 (let (pos pa ren+1 lonely-rens)
2270 (narrow-to-region (point-min) top) ; This can move point, sometimes.
2274 (setq ren+1 (scan-lists pos 1 1)) ; might signal
2275 (setq lonely-rens (cons ren+1 lonely-rens)
2278 ;; PART 2: Scan back before `here-' searching for the "("s
2279 ;; matching/mismatching the ")"s found above. We only need to direct the
2280 ;; caller to scan when we've encountered unmatched right parens.
2285 (and lonely-rens ; actual values aren't used.
2286 (setq pa (scan-lists pos -1 1)))
2288 (setq lonely-rens (cdr lonely-rens)))))
2291 (defun c-parse-state-get-strategy (here good-pos)
2292 ;; Determine the scanning strategy for adjusting `c-parse-state', attempting
2293 ;; to minimise the amount of scanning. HERE is the pertinent position in
2294 ;; the buffer, GOOD-POS is a position where `c-state-cache' (possibly with
2295 ;; its head trimmed) is known to be good, or nil if there is no such
2298 ;; The return value is a list, one of the following:
2300 ;; o - ('forward CACHE-POS START-POINT) - scan forward from START-POINT,
2301 ;; which is not less than CACHE-POS.
2302 ;; o - ('backward CACHE-POS nil) - scan backwards (from HERE).
2303 ;; o - ('BOD nil START-POINT) - scan forwards from START-POINT, which is at the
2305 ;; o - ('IN-LIT nil nil) - point is inside the literal containing point-min.
2306 ;; , where CACHE-POS is the highest position recorded in `c-state-cache' at
2308 (let ((cache-pos (c-get-cache-scan-pos here)) ; highest position below HERE in cache (or 1)
2309 BOD-pos ; position of 2nd BOD before HERE.
2310 strategy ; 'forward, 'backward, 'BOD, or 'IN-LIT.
2312 how-far) ; putative scanning distance.
2313 (setq good-pos (or good-pos (c-state-get-min-scan-pos)))
2315 ((< here (c-state-get-min-scan-pos))
2316 (setq strategy 'IN-LIT
2321 (setq strategy 'forward
2322 start-point (max good-pos cache-pos)
2323 how-far (- here start-point)))
2324 ((< (- good-pos here) (- here cache-pos)) ; FIXME!!! ; apply some sort of weighting.
2325 (setq strategy 'backward
2326 how-far (- good-pos here)))
2328 (setq strategy 'forward
2329 how-far (- here cache-pos)
2330 start-point cache-pos)))
2332 ;; Might we be better off starting from the top level, two defuns back,
2334 (when (> how-far c-state-cache-too-far)
2335 (setq BOD-pos (c-get-fallback-scan-pos here)) ; somewhat EXPENSIVE!!!
2336 (if (< (- here BOD-pos) how-far)
2338 start-point BOD-pos)))
2342 (and (memq strategy '(forward backward)) cache-pos)
2343 (and (memq strategy '(forward BOD)) start-point))))
2346 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2347 ;; Routines which change `c-state-cache' and associated values.
2348 (defun c-renarrow-state-cache ()
2349 ;; The region (more precisely, point-min) has changed since we
2350 ;; calculated `c-state-cache'. Amend `c-state-cache' accordingly.
2351 (if (< (point-min) c-state-point-min)
2352 ;; If point-min has MOVED BACKWARDS then we drop the state completely.
2353 ;; It would be possible to do a better job here and recalculate the top
2356 (c-state-mark-point-min-literal)
2357 (setq c-state-cache nil
2358 c-state-cache-good-pos c-state-min-scan-pos
2359 c-state-brace-pair-desert nil))
2361 ;; point-min has MOVED FORWARD.
2363 ;; Is the new point-min inside a (different) literal?
2364 (unless (and c-state-point-min-lit-start ; at prev. point-min
2365 (< (point-min) (c-state-get-min-scan-pos)))
2366 (c-state-mark-point-min-literal))
2368 ;; Cut off a bit of the tail from `c-state-cache'.
2369 (let ((ptr (cons nil c-state-cache))
2371 (while (and (setq pa (c-state-cache-top-lparen (cdr ptr)))
2372 (>= pa (point-min)))
2373 (setq ptr (cdr ptr)))
2376 (if (eq (cdr ptr) c-state-cache)
2377 (setq c-state-cache nil
2378 c-state-cache-good-pos c-state-min-scan-pos)
2380 (setq c-state-cache-good-pos (1+ (c-state-cache-top-lparen))))
2383 (setq c-state-point-min (point-min)))
2385 (defun c-append-lower-brace-pair-to-state-cache (from &optional upper-lim)
2386 ;; If there is a brace pair preceding FROM in the buffer (not necessarily
2387 ;; immediately preceding), push a cons onto `c-state-cache' to represent it.
2388 ;; FROM must not be inside a literal. If UPPER-LIM is non-nil, we append
2389 ;; the highest brace pair whose "}" is below UPPER-LIM.
2391 ;; Return non-nil when this has been done.
2393 ;; This routine should be fast. Since it can get called a LOT, we maintain
2394 ;; `c-state-brace-pair-desert', a small cache of "failures", such that we
2395 ;; reduce the time wasted in repeated fruitless searches in brace deserts.
2398 (let ((bra from) ce ; Positions of "{" and "}".
2400 (cache-pos (c-state-cache-top-lparen)) ; might be nil.
2401 (macro-start-or-from
2402 (progn (goto-char from)
2403 (c-beginning-of-macro)
2405 (or upper-lim (setq upper-lim from))
2407 ;; If we're essentially repeating a fruitless search, just give up.
2408 (unless (and c-state-brace-pair-desert
2409 (eq cache-pos (car c-state-brace-pair-desert))
2410 (<= from (cdr c-state-brace-pair-desert)))
2411 ;; Only search what we absolutely need to:
2412 (if (and c-state-brace-pair-desert
2413 (> from (cdr c-state-brace-pair-desert)))
2414 (narrow-to-region (cdr c-state-brace-pair-desert) (point-max)))
2416 ;; In the next pair of nested loops, the inner one moves back past a
2417 ;; pair of (mis-)matching parens or brackets; the outer one moves
2418 ;; back over a sequence of unmatched close brace/paren/bracket each
2424 (and (setq ce (scan-lists bra -1 -1)) ; back past )/]/}; might signal
2425 (setq bra (scan-lists ce -1 1)) ; back past (/[/{; might signal
2426 (or (> ce upper-lim)
2427 (not (eq (char-after bra) ?\{))
2428 (and (goto-char bra)
2429 (c-beginning-of-macro)
2430 (< (point) macro-start-or-from))))))
2431 (and ce (< ce bra)))
2432 (setq bra ce)) ; If we just backed over an unbalanced closing
2435 (if (and ce (< bra ce) (eq (char-after bra) ?\{))
2436 ;; We've found the desired brace-pair.
2438 (setq new-cons (cons bra (1+ ce)))
2440 ((consp (car c-state-cache))
2441 (setcar c-state-cache new-cons))
2442 ((and (numberp (car c-state-cache)) ; probably never happens
2443 (< ce (car c-state-cache)))
2444 (setcdr c-state-cache
2445 (cons new-cons (cdr c-state-cache))))
2446 (t (setq c-state-cache (cons new-cons c-state-cache)))))
2448 ;; We haven't found a brace pair. Record this.
2449 (setq c-state-brace-pair-desert (cons cache-pos from))))))))
2451 (defsubst c-state-push-any-brace-pair (bra+1 macro-start-or-here)
2452 ;; If BRA+1 is nil, do nothing. Otherwise, BRA+1 is the buffer position
2453 ;; following a {, and that brace has a (mis-)matching } (or ]), and we
2454 ;; "push" "a" brace pair onto `c-state-cache'.
2456 ;; Here "push" means overwrite the top element if it's itself a brace-pair,
2457 ;; otherwise push it normally.
2459 ;; The brace pair we push is normally the one surrounding BRA+1, but if the
2460 ;; latter is inside a macro, not being a macro containing
2461 ;; MACRO-START-OR-HERE, we scan backwards through the buffer for a non-macro
2462 ;; base pair. This latter case is assumed to be rare.
2464 ;; Note: POINT is not preserved in this routine.
2466 (if (or (> bra+1 macro-start-or-here)
2467 (progn (goto-char bra+1)
2468 (not (c-beginning-of-macro))))
2470 (cons (cons (1- bra+1)
2471 (scan-lists bra+1 1 1))
2472 (if (consp (car c-state-cache))
2475 ;; N.B. This defsubst codes one method for the simple, normal case,
2476 ;; and a more sophisticated, slower way for the general case. Don't
2477 ;; eliminate this defsubst - it's a speed optimisation.
2478 (c-append-lower-brace-pair-to-state-cache (1- bra+1)))))
2480 (defun c-append-to-state-cache (from)
2481 ;; Scan the buffer from FROM to (point-max), adding elements into
2482 ;; `c-state-cache' for braces etc. Return a candidate for
2483 ;; `c-state-cache-good-pos'.
2485 ;; FROM must be after the latest brace/paren/bracket in `c-state-cache', if
2486 ;; any. Typically, it is immediately after it. It must not be inside a
2488 (let ((here-bol (c-point 'bol (point-max)))
2489 (macro-start-or-here
2490 (save-excursion (goto-char (point-max))
2491 (if (c-beginning-of-macro)
2494 pa+1 ; pos just after an opening PAren (or brace).
2495 (ren+1 from) ; usually a pos just after an closing paREN etc.
2496 ; Is actually the pos. to scan for a (/{/[ from,
2497 ; which sometimes is after a silly )/}/].
2498 paren+1 ; Pos after some opening or closing paren.
2499 paren+1s ; A list of `paren+1's; used to determine a
2501 bra+1 ce+1 ; just after L/R bra-ces.
2502 bra+1s ; list of OLD values of bra+1.
2503 mstart) ; start of a macro.
2506 ;; Each time round the following loop, we enter a succesively deeper
2507 ;; level of brace/paren nesting. (Except sometimes we "continue at
2508 ;; the existing level".) `pa+1' is a pos inside an opening
2509 ;; brace/paren/bracket, usually just after it.
2512 ;; Each time round the next loop moves forward over an opening then
2513 ;; a closing brace/bracket/paren. This loop is white hot, so it
2514 ;; plays ugly tricks to go fast. DON'T PUT ANYTHING INTO THIS
2515 ;; LOOP WHICH ISN'T ABSOLUTELY NECESSARY!!! It terminates when a
2516 ;; call of `scan-lists' signals an error, which happens when there
2517 ;; are no more b/b/p's to scan.
2520 (setq pa+1 (scan-lists ren+1 1 -1) ; Into (/{/[; might signal
2521 paren+1s (cons pa+1 paren+1s))
2522 (setq ren+1 (scan-lists pa+1 1 1)) ; Out of )/}/]; might signal
2523 (if (and (eq (char-before pa+1) ?{)) ; Check for a macro later.
2525 (setcar paren+1s ren+1)))
2527 (if (and pa+1 (> pa+1 ren+1))
2528 ;; We've just entered a deeper nesting level.
2530 ;; Insert the brace pair (if present) and the single open
2531 ;; paren/brace/bracket into `c-state-cache' It cannot be
2532 ;; inside a macro, except one around point, because of what
2533 ;; `c-neutralize-syntax-in-CPP' has done.
2534 (c-state-push-any-brace-pair bra+1 macro-start-or-here)
2535 ;; Insert the opening brace/bracket/paren position.
2536 (setq c-state-cache (cons (1- pa+1) c-state-cache))
2537 ;; Clear admin stuff for the next more nested part of the scan.
2538 (setq ren+1 pa+1 pa+1 nil bra+1 nil bra+1s nil)
2539 t) ; Carry on the loop
2541 ;; All open p/b/b's at this nesting level, if any, have probably
2542 ;; been closed by matching/mismatching ones. We're probably
2543 ;; finished - we just need to check for having found an
2544 ;; unmatched )/}/], which we ignore. Such a )/}/] can't be in a
2545 ;; macro, due the action of `c-neutralize-syntax-in-CPP'.
2546 (c-safe (setq ren+1 (scan-lists ren+1 1 1)))))) ; acts as loop control.
2548 ;; Record the final, innermost, brace-pair if there is one.
2549 (c-state-push-any-brace-pair bra+1 macro-start-or-here)
2551 ;; Determine a good pos
2552 (while (and (setq paren+1 (car paren+1s))
2553 (> (if (> paren+1 macro-start-or-here)
2556 (setq mstart (and (c-beginning-of-macro)
2558 (or mstart paren+1))
2560 (setq paren+1s (cdr paren+1s)))
2562 ((and paren+1 mstart)
2563 (min paren+1 mstart))
2567 (defun c-remove-stale-state-cache (good-pos pps-point)
2568 ;; Remove stale entries from the `c-cache-state', i.e. those which will
2569 ;; not be in it when it is amended for position (point-max).
2570 ;; Additionally, the "outermost" open-brace entry before (point-max)
2571 ;; will be converted to a cons if the matching close-brace is scanned.
2573 ;; GOOD-POS is a "maximal" "safe position" - there must be no open
2574 ;; parens/braces/brackets between GOOD-POS and (point-max).
2576 ;; As a second thing, calculate the result of parse-partial-sexp at
2577 ;; PPS-POINT, w.r.t. GOOD-POS. The motivation here is that
2578 ;; `c-state-cache-good-pos' may become PPS-POINT, but the caller may need to
2579 ;; adjust it to get outside a string/comment. (Sorry about this! The code
2580 ;; needs to be FAST).
2582 ;; Return a list (GOOD-POS SCAN-BACK-POS PPS-STATE), where
2583 ;; o - GOOD-POS is a position where the new value `c-state-cache' is known
2584 ;; to be good (we aim for this to be as high as possible);
2585 ;; o - SCAN-BACK-POS, if not nil, indicates there may be a brace pair
2586 ;; preceding POS which needs to be recorded in `c-state-cache'. It is a
2587 ;; position to scan backwards from.
2588 ;; o - PPS-STATE is the parse-partial-sexp state at PPS-POINT.
2590 (narrow-to-region 1 (point-max))
2592 (let* ((in-macro-start ; start of macro containing (point-max) or nil.
2594 (goto-char (point-max))
2595 (and (c-beginning-of-macro)
2597 (good-pos-actual-macro-start ; Start of macro containing good-pos
2599 (and (< good-pos (point-max))
2601 (goto-char good-pos)
2602 (and (c-beginning-of-macro)
2604 (good-pos-actual-macro-end ; End of this macro, (maybe
2605 ; (point-max)), or nil.
2606 (and good-pos-actual-macro-start
2608 (goto-char good-pos-actual-macro-start)
2611 pps-state ; Will be 9 or 10 elements long.
2613 upper-lim ; ,beyond which `c-state-cache' entries are removed
2615 pair-beg pps-point-state target-depth)
2617 ;; Remove entries beyond (point-max). Also remove any entries inside
2618 ;; a macro, unless (point-max) is in the same macro.
2620 (if (or (null c-state-old-cpp-beg)
2621 (and (> (point-max) c-state-old-cpp-beg)
2622 (< (point-max) c-state-old-cpp-end)))
2624 (min (point-max) c-state-old-cpp-beg)))
2625 (while (and c-state-cache (>= (c-state-cache-top-lparen) upper-lim))
2626 (setq c-state-cache (cdr c-state-cache)))
2627 ;; If `upper-lim' is inside the last recorded brace pair, remove its
2628 ;; RBrace and indicate we'll need to search backwards for a previous
2630 (when (and c-state-cache
2631 (consp (car c-state-cache))
2632 (> (cdar c-state-cache) upper-lim))
2633 (setcar c-state-cache (caar c-state-cache))
2634 (setq scan-back-pos (car c-state-cache)))
2636 ;; The next loop jumps forward out of a nested level of parens each
2637 ;; time round; the corresponding elements in `c-state-cache' are
2638 ;; removed. `pos' is just after the brace-pair or the open paren at
2639 ;; (car c-state-cache). There can be no open parens/braces/brackets
2640 ;; between `good-pos'/`good-pos-actual-macro-start' and (point-max),
2641 ;; due to the interface spec to this function.
2642 (setq pos (if (and good-pos-actual-macro-end
2643 (not (eq good-pos-actual-macro-start
2645 (1+ good-pos-actual-macro-end) ; get outside the macro as
2646 ; marked by a `category' text property.
2649 (while (and c-state-cache
2650 (< (point) (point-max)))
2652 ((null pps-state) ; first time through
2653 (setq target-depth -1))
2654 ((eq (car pps-state) target-depth) ; found closing ),},]
2655 (setq target-depth (1- (car pps-state))))
2656 ;; Do nothing when we've merely reached pps-point.
2662 (point) (if (< (point) pps-point) pps-point (point-max))
2666 (if (= (point) pps-point)
2667 (setq pps-point-state pps-state))
2669 (when (eq (car pps-state) target-depth)
2670 (setq pos (point)) ; POS is now just after an R-paren/brace.
2672 ((and (consp (car c-state-cache))
2673 (eq (point) (cdar c-state-cache)))
2674 ;; We've just moved out of the paren pair containing the brace-pair
2675 ;; at (car c-state-cache). `pair-beg' is where the open paren is,
2676 ;; and is potentially where the open brace of a cons in
2677 ;; c-state-cache will be.
2678 (setq pair-beg (car-safe (cdr c-state-cache))
2679 c-state-cache (cdr-safe (cdr c-state-cache)))) ; remove {}pair + containing Lparen.
2680 ((numberp (car c-state-cache))
2681 (setq pair-beg (car c-state-cache)
2682 c-state-cache (cdr c-state-cache))) ; remove this
2684 ((numberp (cadr c-state-cache))
2685 (setq pair-beg (cadr c-state-cache)
2686 c-state-cache (cddr c-state-cache))) ; Remove a paren pair
2687 ; together with enclosed brace pair.
2688 ;; (t nil) ; Ignore an unmated Rparen.
2691 (if (< (point) pps-point)
2692 (setq pps-state (parse-partial-sexp (point) pps-point
2693 nil nil ; TARGETDEPTH, STOPBEFORE
2696 ;; If the last paren pair we moved out of was actually a brace pair,
2697 ;; insert it into `c-state-cache'.
2698 (when (and pair-beg (eq (char-after pair-beg) ?{))
2699 (if (consp (car-safe c-state-cache))
2700 (setq c-state-cache (cdr c-state-cache)))
2701 (setq c-state-cache (cons (cons pair-beg pos)
2704 (list pos scan-back-pos pps-state)))))
2706 (defun c-remove-stale-state-cache-backwards (here cache-pos)
2707 ;; Strip stale elements of `c-state-cache' by moving backwards through the
2708 ;; buffer, and inform the caller of the scenario detected.
2710 ;; HERE is the position we're setting `c-state-cache' for.
2711 ;; CACHE-POS is just after the latest recorded position in `c-state-cache'
2712 ;; before HERE, or a position at or near point-min which isn't in a
2715 ;; This function must only be called only when (> `c-state-cache-good-pos'
2716 ;; HERE). Usually the gap between CACHE-POS and HERE is large. It is thus
2717 ;; optimised to eliminate (or minimise) scanning between these two
2720 ;; Return a three element list (GOOD-POS SCAN-BACK-POS FWD-FLAG), where:
2721 ;; o - GOOD-POS is a "good position", where `c-state-cache' is valid, or
2722 ;; could become so after missing elements are inserted into
2723 ;; `c-state-cache'. This is JUST AFTER an opening or closing
2724 ;; brace/paren/bracket which is already in `c-state-cache' or just before
2725 ;; one otherwise. exceptionally (when there's no such b/p/b handy) the BOL
2726 ;; before `here''s line, or the start of the literal containing it.
2727 ;; o - SCAN-BACK-POS, if non-nil, indicates there may be a brace pair
2728 ;; preceding POS which isn't recorded in `c-state-cache'. It is a position
2729 ;; to scan backwards from.
2730 ;; o - FWD-FLAG, if non-nil, indicates there may be parens/braces between
2731 ;; POS and HERE which aren't recorded in `c-state-cache'.
2733 ;; The comments in this defun use "paren" to mean parenthesis or square
2734 ;; bracket (as contrasted with a brace), and "(" and ")" likewise.
2736 ;; . {..} (..) (..) ( .. { } ) (...) ( .... . ..)
2738 ;; CP E here D C good
2739 (let ((pos c-state-cache-good-pos)
2740 pa ren ; positions of "(" and ")"
2741 dropped-cons ; whether the last element dropped from `c-state-cache'
2742 ; was a cons (representing a brace-pair)
2743 good-pos ; see above.
2744 lit ; (START . END) of a literal containing some point.
2745 here-lit-start here-lit-end ; bounds of literal containing `here'
2747 here- here+ ; start/end of macro around HERE, or HERE
2748 (here-bol (c-point 'bol here))
2749 (too-far-back (max (- here c-state-cache-too-far) 1)))
2751 ;; Remove completely irrelevant entries from `c-state-cache'.
2752 (while (and c-state-cache
2753 (>= (setq pa (c-state-cache-top-lparen)) here))
2754 (setq dropped-cons (consp (car c-state-cache)))
2755 (setq c-state-cache (cdr c-state-cache))
2757 ;; At this stage, (> pos here);
2758 ;; (< (c-state-cache-top-lparen) here) (or is nil).
2761 ((and (consp (car c-state-cache))
2762 (> (cdar c-state-cache) here))
2763 ;; CASE 1: The top of the cache is a brace pair which now encloses
2764 ;; `here'. As good-pos, return the address. of the "{". Since we've no
2765 ;; knowledge of what's inside these braces, we have no alternative but
2766 ;; to direct the caller to scan the buffer from the opening brace.
2767 (setq pos (caar c-state-cache))
2768 (setcar c-state-cache pos)
2769 (list (1+ pos) pos t)) ; return value. We've just converted a brace pair
2770 ; entry into a { entry, so the caller needs to
2771 ; search for a brace pair before the {.
2773 ;; `here' might be inside a literal. Check for this.
2775 (setq lit (c-state-literal-at here)
2776 here-lit-start (or (car lit) here)
2777 here-lit-end (or (cdr lit) here))
2778 ;; Has `here' just "newly entered" a macro?
2780 (goto-char here-lit-start)
2781 (if (and (c-beginning-of-macro)
2782 (or (null c-state-old-cpp-beg)
2783 (not (= (point) c-state-old-cpp-beg))))
2785 (setq here- (point))
2787 (setq here+ (point)))
2788 (setq here- here-lit-start
2789 here+ here-lit-end)))
2791 ;; `here' might be nested inside any depth of parens (or brackets but
2792 ;; not braces). Scan backwards to find the outermost such opening
2793 ;; paren, if there is one. This will be the scan position to return.
2795 (narrow-to-region cache-pos (point-max))
2796 (setq pos (c-state-balance-parens-backwards here- here+ pos)))
2797 nil)) ; for the cond
2799 ((< pos here-lit-start)
2800 ;; CASE 2: Address of outermost ( or [ which now encloses `here', but
2801 ;; didn't enclose the (previous) `c-state-cache-good-pos'. If there is
2802 ;; a brace pair preceding this, it will already be in `c-state-cache',
2803 ;; unless there was a brace pair after it, i.e. there'll only be one to
2804 ;; scan for if we've just deleted one.
2805 (list pos (and dropped-cons pos) t)) ; Return value.
2807 ;; `here' isn't enclosed in a (previously unrecorded) bracket/paren.
2808 ;; Further forward scanning isn't needed, but we still need to find a
2809 ;; GOOD-POS. Step out of all enclosing "("s on HERE's line.
2812 (narrow-to-region here-bol (point-max))
2813 (setq pos here-lit-start)
2814 (c-safe (while (setq pa (scan-lists pos -1 1))
2815 (setq pos pa)))) ; might signal
2816 nil)) ; for the cond
2818 ((setq ren (c-safe-scan-lists pos -1 -1 too-far-back))
2819 ;; CASE 3: After a }/)/] before `here''s BOL.
2820 (list (1+ ren) (and dropped-cons pos) nil)) ; Return value
2823 ;; CASE 4; Best of a bad job: BOL before `here-bol', or beginning of
2824 ;; literal containing it.
2825 (setq good-pos (c-state-lit-beg (c-point 'bopl here-bol)))
2826 (list good-pos (and dropped-cons good-pos) nil)))))
2829 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2830 ;; Externally visible routines.
2832 (defun c-state-cache-init ()
2833 (setq c-state-cache nil
2834 c-state-cache-good-pos 1
2835 c-state-nonlit-pos-cache nil
2836 c-state-nonlit-pos-cache-limit 1
2837 c-state-brace-pair-desert nil
2839 c-state-point-min-lit-type nil
2840 c-state-point-min-lit-start nil
2841 c-state-min-scan-pos 1
2842 c-state-old-cpp-beg nil
2843 c-state-old-cpp-end nil)
2844 (c-state-mark-point-min-literal))
2846 (defun c-invalidate-state-cache-1 (here)
2847 ;; Invalidate all info on `c-state-cache' that applies to the buffer at HERE
2848 ;; or higher and set `c-state-cache-good-pos' accordingly. The cache is
2849 ;; left in a consistent state.
2851 ;; This is much like `c-whack-state-after', but it never changes a paren
2852 ;; pair element into an open paren element. Doing that would mean that the
2853 ;; new open paren wouldn't have the required preceding paren pair element.
2855 ;; This function is called from c-after-change.
2857 ;; The cache of non-literals:
2858 (if (< here c-state-nonlit-pos-cache-limit)
2859 (setq c-state-nonlit-pos-cache-limit here))
2862 ;; Case 1: if `here' is in a literal containing point-min, everything
2863 ;; becomes (or is already) nil.
2864 (if (or (null c-state-cache-good-pos)
2865 (< here (c-state-get-min-scan-pos)))
2866 (setq c-state-cache nil
2867 c-state-cache-good-pos nil
2868 c-state-min-scan-pos nil)
2870 ;;; Truncate `c-state-cache' and set `c-state-cache-good-pos' to a value below
2871 ;;; `here'. To maintain its consistency, we may need to insert a new brace
2873 (let ((here-bol (c-point 'bol here))
2874 too-high-pa ; recorded {/(/[ next above here, or nil.
2875 dropped-cons ; was the last removed element a brace pair?
2877 ;; The easy bit - knock over-the-top bits off `c-state-cache'.
2878 (while (and c-state-cache
2879 (>= (setq pa (c-state-cache-top-paren)) here))
2880 (setq dropped-cons (consp (car c-state-cache))
2881 too-high-pa (c-state-cache-top-lparen)
2882 c-state-cache (cdr c-state-cache)))
2884 ;; Do we need to add in an earlier brace pair, having lopped one off?
2885 (if (and dropped-cons
2886 (< too-high-pa (+ here c-state-cache-too-far)))
2887 (c-append-lower-brace-pair-to-state-cache too-high-pa here-bol))
2888 (setq c-state-cache-good-pos (or (c-state-cache-after-top-paren)
2889 (c-state-get-min-scan-pos)))))
2891 ;; The brace-pair desert marker:
2892 (when (car c-state-brace-pair-desert)
2893 (if (< here (car c-state-brace-pair-desert))
2894 (setq c-state-brace-pair-desert nil)
2895 (if (< here (cdr c-state-brace-pair-desert))
2896 (setcdr c-state-brace-pair-desert here)))))
2898 (defun c-parse-state-1 ()
2899 ;; Find and record all noteworthy parens between some good point earlier in
2900 ;; the file and point. That good point is at least the beginning of the
2901 ;; top-level construct we are in, or the beginning of the preceding
2902 ;; top-level construct if we aren't in one.
2904 ;; The returned value is a list of the noteworthy parens with the last one
2905 ;; first. If an element in the list is an integer, it's the position of an
2906 ;; open paren (of any type) which has not been closed before the point. If
2907 ;; an element is a cons, it gives the position of a closed BRACE paren
2908 ;; pair[*]; the car is the start brace position and the cdr is the position
2909 ;; following the closing brace. Only the last closed brace paren pair
2910 ;; before each open paren and before the point is recorded, and thus the
2911 ;; state never contains two cons elements in succession. When a close brace
2912 ;; has no matching open brace (e.g., the matching brace is outside the
2913 ;; visible region), it is not represented in the returned value.
2915 ;; [*] N.B. The close "brace" might be a mismatching close bracket or paren.
2916 ;; This defun explicitly treats mismatching parens/braces/brackets as
2917 ;; matching. It is the open brace which makes it a "brace" pair.
2919 ;; If POINT is within a macro, open parens and brace pairs within
2920 ;; THIS macro MIGHT be recorded. This depends on whether their
2921 ;; syntactic properties have been suppressed by
2922 ;; `c-neutralize-syntax-in-CPP'. This might need fixing (2008-12-11).
2924 ;; Currently no characters which are given paren syntax with the
2925 ;; syntax-table property are recorded, i.e. angle bracket arglist
2926 ;; parens are never present here. Note that this might change.
2928 ;; BUG: This function doesn't cope entirely well with unbalanced
2929 ;; parens in macros. (2008-12-11: this has probably been resolved
2930 ;; by the function `c-neutralize-syntax-in-CPP'.) E.g. in the
2931 ;; following case the brace before the macro isn't balanced with the
2938 ;; Note to maintainers: this function DOES get called with point
2939 ;; within comments and strings, so don't assume it doesn't!
2941 ;; This function might do hidden buffer changes.
2942 (let* ((here (point))
2943 (here-bopl (c-point 'bopl))
2944 strategy ; 'forward, 'backward etc..
2945 ;; Candidate positions to start scanning from:
2946 cache-pos ; highest position below HERE already existing in
2952 scan-backward-pos scan-forward-p) ; used for 'backward.
2953 ;; If POINT-MIN has changed, adjust the cache
2954 (unless (= (point-min) c-state-point-min)
2955 (c-renarrow-state-cache))
2958 (setq res (c-parse-state-get-strategy here c-state-cache-good-pos)
2960 cache-pos (cadr res)
2961 start-point (nth 2 res))
2963 (when (eq strategy 'BOD)
2964 (setq c-state-cache nil
2965 c-state-cache-good-pos start-point))
2970 ((memq strategy '(forward BOD))
2971 (narrow-to-region (point-min) here)
2972 (setq res (c-remove-stale-state-cache start-point here-bopl))
2973 (setq cache-pos (car res)
2974 scan-backward-pos (cadr res)
2975 bopl-state (car (cddr res))) ; will be nil if (< here-bopl
2977 (if scan-backward-pos
2978 (c-append-lower-brace-pair-to-state-cache scan-backward-pos))
2980 (c-append-to-state-cache cache-pos))
2981 (setq c-state-cache-good-pos
2983 (< good-pos (- here c-state-cache-too-far)))
2984 (c-state-cache-non-literal-place here-bopl bopl-state)
2987 ((eq strategy 'backward)
2988 (setq res (c-remove-stale-state-cache-backwards here cache-pos)
2990 scan-backward-pos (cadr res)
2991 scan-forward-p (car (cddr res)))
2992 (if scan-backward-pos
2993 (c-append-lower-brace-pair-to-state-cache
2995 (setq c-state-cache-good-pos
2997 (progn (narrow-to-region (point-min) here)
2998 (c-append-to-state-cache good-pos))
3000 (c-get-cache-scan-pos good-pos))))
3002 (t ; (eq strategy 'IN-LIT)
3003 (setq c-state-cache nil
3004 c-state-cache-good-pos nil)))))
3008 (defun c-invalidate-state-cache (here)
3009 ;; This is a wrapper over `c-invalidate-state-cache-1'.
3011 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3012 ;; of all parens in preprocessor constructs, except for any such construct
3013 ;; containing point. We can then call `c-invalidate-state-cache-1' without
3014 ;; worrying further about macros and template delimiters.
3015 (c-with-<->-as-parens-suppressed
3016 (if (and c-state-old-cpp-beg
3017 (< c-state-old-cpp-beg here))
3018 (c-with-all-but-one-cpps-commented-out
3020 (min c-state-old-cpp-end here)
3021 (c-invalidate-state-cache-1 here))
3022 (c-with-cpps-commented-out
3023 (c-invalidate-state-cache-1 here)))))
3025 (defun c-parse-state ()
3026 ;; This is a wrapper over `c-parse-state-1'. See that function for a
3027 ;; description of the functionality and return value.
3029 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3030 ;; of all parens in preprocessor constructs, except for any such construct
3031 ;; containing point. We can then call `c-parse-state-1' without worrying
3032 ;; further about macros and template delimiters.
3033 (let (here-cpp-beg here-cpp-end)
3035 (when (c-beginning-of-macro)
3036 (setq here-cpp-beg (point))
3038 (> (setq here-cpp-end (c-syntactic-end-of-macro))
3040 (setq here-cpp-beg nil here-cpp-end nil))))
3041 ;; FIXME!!! Put in a `condition-case' here to protect the integrity of the
3044 (c-with-<->-as-parens-suppressed
3045 (if (and here-cpp-beg (> here-cpp-end here-cpp-beg))
3046 (c-with-all-but-one-cpps-commented-out
3047 here-cpp-beg here-cpp-end
3049 (c-with-cpps-commented-out
3050 (c-parse-state-1))))
3051 (setq c-state-old-cpp-beg (and here-cpp-beg (copy-marker here-cpp-beg t))
3052 c-state-old-cpp-end (and here-cpp-end (copy-marker here-cpp-end t)))
3055 ;; Debug tool to catch cache inconsistencies. This is called from
3057 (defvar c-debug-parse-state nil)
3058 (unless (fboundp 'c-real-parse-state)
3059 (fset 'c-real-parse-state (symbol-function 'c-parse-state)))
3060 (cc-bytecomp-defun c-real-parse-state)
3061 (defun c-debug-parse-state ()
3062 (let ((here (point)) (res1 (c-real-parse-state)) res2)
3063 (let ((c-state-cache nil)
3064 (c-state-cache-good-pos 1)
3065 (c-state-nonlit-pos-cache nil)
3066 (c-state-nonlit-pos-cache-limit 1)
3067 (c-state-brace-pair-desert nil)
3068 (c-state-point-min 1)
3069 (c-state-point-min-lit-type nil)
3070 (c-state-point-min-lit-start nil)
3071 (c-state-min-scan-pos 1)
3072 (c-state-old-cpp-beg nil)
3073 (c-state-old-cpp-end nil))
3074 (setq res2 (c-real-parse-state)))
3075 (unless (equal res1 res2)
3076 ;; The cache can actually go further back due to the ad-hoc way
3077 ;; the first paren is found, so try to whack off a bit of its
3078 ;; start before complaining.
3080 (goto-char (or (c-least-enclosing-brace res2) (point)))
3081 (c-beginning-of-defun-1)
3082 (while (not (or (bobp) (eq (char-after) ?{)))
3083 (c-beginning-of-defun-1))
3084 (unless (equal (c-whack-state-before (point) res1) res2)
3085 (message (concat "c-parse-state inconsistency at %s: "
3086 "using cache: %s, from scratch: %s")
3090 (defun c-toggle-parse-state-debug (&optional arg)
3092 (setq c-debug-parse-state (c-calculate-state arg c-debug-parse-state))
3093 (fset 'c-parse-state (symbol-function (if c-debug-parse-state
3094 'c-debug-parse-state
3095 'c-real-parse-state)))
3096 (c-keep-region-active))
3097 (when c-debug-parse-state
3098 (c-toggle-parse-state-debug 1))
3101 (defun c-whack-state-before (bufpos paren-state)
3102 ;; Whack off any state information from PAREN-STATE which lies
3103 ;; before BUFPOS. Not destructive on PAREN-STATE.
3104 (let* ((newstate (list nil))
3108 (setq car (car paren-state)
3109 paren-state (cdr paren-state))
3110 (if (< (if (consp car) (car car) car) bufpos)
3111 (setq paren-state nil)
3112 (setcdr ptr (list car))
3113 (setq ptr (cdr ptr))))
3116 (defun c-whack-state-after (bufpos paren-state)
3117 ;; Whack off any state information from PAREN-STATE which lies at or
3118 ;; after BUFPOS. Not destructive on PAREN-STATE.
3121 (let ((car (car paren-state)))
3123 ;; just check the car, because in a balanced brace
3124 ;; expression, it must be impossible for the corresponding
3125 ;; close brace to be before point, but the open brace to
3127 (if (<= bufpos (car car))
3129 (if (< bufpos (cdr car))
3130 ;; its possible that the open brace is before
3131 ;; bufpos, but the close brace is after. In that
3132 ;; case, convert this to a non-cons element. The
3133 ;; rest of the state is before bufpos, so we're
3135 (throw 'done (cons (car car) (cdr paren-state)))
3136 ;; we know that both the open and close braces are
3137 ;; before bufpos, so we also know that everything else
3138 ;; on state is before bufpos.
3139 (throw 'done paren-state)))
3142 ;; it's before bufpos, so everything else should too.
3143 (throw 'done paren-state)))
3144 (setq paren-state (cdr paren-state)))
3147 (defun c-most-enclosing-brace (paren-state &optional bufpos)
3148 ;; Return the bufpos of the innermost enclosing open paren before
3149 ;; bufpos, or nil if none was found.
3151 (or bufpos (setq bufpos 134217727))
3153 (setq enclosingp (car paren-state)
3154 paren-state (cdr paren-state))
3155 (if (or (consp enclosingp)
3156 (>= enclosingp bufpos))
3157 (setq enclosingp nil)
3158 (setq paren-state nil)))
3161 (defun c-least-enclosing-brace (paren-state)
3162 ;; Return the bufpos of the outermost enclosing open paren, or nil
3163 ;; if none was found.
3166 (setq elem (car paren-state)
3167 paren-state (cdr paren-state))
3172 (defun c-safe-position (bufpos paren-state)
3173 ;; Return the closest "safe" position recorded on PAREN-STATE that
3174 ;; is higher up than BUFPOS. Return nil if PAREN-STATE doesn't
3175 ;; contain any. Return nil if BUFPOS is nil, which is useful to
3176 ;; find the closest limit before a given limit that might be nil.
3178 ;; A "safe" position is a position at or after a recorded open
3179 ;; paren, or after a recorded close paren. The returned position is
3180 ;; thus either the first position after a close brace, or the first
3181 ;; position after an enclosing paren, or at the enclosing paren in
3182 ;; case BUFPOS is immediately after it.
3187 (setq elem (car paren-state))
3189 (cond ((< (cdr elem) bufpos)
3190 (throw 'done (cdr elem)))
3191 ((< (car elem) bufpos)
3193 (throw 'done (min (1+ (car elem)) bufpos))))
3195 ;; elem is the position at and not after the opening paren, so
3196 ;; we can go forward one more step unless it's equal to
3197 ;; bufpos. This is useful in some cases avoid an extra paren
3198 ;; level between the safe position and bufpos.
3199 (throw 'done (min (1+ elem) bufpos))))
3200 (setq paren-state (cdr paren-state)))))))
3202 (defun c-beginning-of-syntax ()
3203 ;; This is used for `font-lock-beginning-of-syntax-function'. It
3204 ;; goes to the closest previous point that is known to be outside
3205 ;; any string literal or comment. `c-state-cache' is used if it has
3206 ;; a position in the vicinity.
3207 (let* ((paren-state c-state-cache)
3211 ;; Note: Similar code in `c-safe-position'. The
3212 ;; difference is that we accept a safe position at
3213 ;; the point and don't bother to go forward past open
3216 (setq elem (car paren-state))
3218 (cond ((<= (cdr elem) (point))
3219 (throw 'done (cdr elem)))
3220 ((<= (car elem) (point))
3221 (throw 'done (car elem))))
3222 (if (<= elem (point))
3223 (throw 'done elem)))
3224 (setq paren-state (cdr paren-state)))
3227 (if (> pos (- (point) 4000))
3229 ;; The position is far back. Try `c-beginning-of-defun-1'
3230 ;; (although we can't be entirely sure it will go to a position
3231 ;; outside a comment or string in current emacsen). FIXME:
3232 ;; Consult `syntax-ppss' here.
3233 (c-beginning-of-defun-1)
3238 ;; Tools for scanning identifiers and other tokens.
3240 (defun c-on-identifier ()
3241 "Return non-nil if the point is on or directly after an identifier.
3242 Keywords are recognized and not considered identifiers. If an
3243 identifier is detected, the returned value is its starting position.
3244 If an identifier ends at the point and another begins at it \(can only
3245 happen in Pike) then the point for the preceding one is returned.
3247 Note that this function might do hidden buffer changes. See the
3248 comment at the start of cc-engine.el for more info."
3250 ;; FIXME: Shouldn't this function handle "operator" in C++?
3253 (skip-syntax-backward "w_")
3257 ;; Check for a normal (non-keyword) identifier.
3258 (and (looking-at c-symbol-start)
3259 (not (looking-at c-keywords-regexp))
3262 (when (c-major-mode-is 'pike-mode)
3263 ;; Handle the `<operator> syntax in Pike.
3264 (let ((pos (point)))
3265 (skip-chars-backward "-!%&*+/<=>^|~[]()")
3266 (and (if (< (skip-chars-backward "`") 0)
3269 (eq (char-after) ?\`))
3270 (looking-at c-symbol-key)
3271 (>= (match-end 0) pos)
3274 ;; Handle the "operator +" syntax in C++.
3275 (when (and c-overloadable-operators-regexp
3276 (= (c-backward-token-2 0) 0))
3278 (cond ((and (looking-at c-overloadable-operators-regexp)
3279 (or (not c-opt-op-identifier-prefix)
3280 (and (= (c-backward-token-2 1) 0)
3281 (looking-at c-opt-op-identifier-prefix))))
3285 (and c-opt-op-identifier-prefix
3286 (looking-at c-opt-op-identifier-prefix)
3287 (= (c-forward-token-2 1) 0)
3288 (looking-at c-overloadable-operators-regexp)))
3293 (defsubst c-simple-skip-symbol-backward ()
3294 ;; If the point is at the end of a symbol then skip backward to the
3295 ;; beginning of it. Don't move otherwise. Return non-nil if point
3298 ;; This function might do hidden buffer changes.
3299 (or (< (skip-syntax-backward "w_") 0)
3300 (and (c-major-mode-is 'pike-mode)
3301 ;; Handle the `<operator> syntax in Pike.
3302 (let ((pos (point)))
3303 (if (and (< (skip-chars-backward "-!%&*+/<=>^|~[]()") 0)
3304 (< (skip-chars-backward "`") 0)
3305 (looking-at c-symbol-key)
3306 (>= (match-end 0) pos))
3311 (defun c-beginning-of-current-token (&optional back-limit)
3312 ;; Move to the beginning of the current token. Do not move if not
3313 ;; in the middle of one. BACK-LIMIT may be used to bound the
3314 ;; backward search; if given it's assumed to be at the boundary
3315 ;; between two tokens. Return non-nil if the point is moved, nil
3318 ;; This function might do hidden buffer changes.
3319 (let ((start (point)))
3320 (if (looking-at "\\w\\|\\s_")
3321 (skip-syntax-backward "w_" back-limit)
3322 (when (< (skip-syntax-backward ".()" back-limit) 0)
3323 (while (let ((pos (or (and (looking-at c-nonsymbol-token-regexp)
3325 ;; `c-nonsymbol-token-regexp' should always match
3326 ;; since we've skipped backward over punctuator
3327 ;; or paren syntax, but consume one char in case
3328 ;; it doesn't so that we don't leave point before
3329 ;; some earlier incorrect token.
3332 (goto-char pos))))))
3335 (defun c-end-of-current-token (&optional back-limit)
3336 ;; Move to the end of the current token. Do not move if not in the
3337 ;; middle of one. BACK-LIMIT may be used to bound the backward
3338 ;; search; if given it's assumed to be at the boundary between two
3339 ;; tokens. Return non-nil if the point is moved, nil otherwise.
3341 ;; This function might do hidden buffer changes.
3342 (let ((start (point)))
3343 (cond ((< (skip-syntax-backward "w_" (1- start)) 0)
3344 (skip-syntax-forward "w_"))
3345 ((< (skip-syntax-backward ".()" back-limit) 0)
3347 (if (looking-at c-nonsymbol-token-regexp)
3348 (goto-char (match-end 0))
3349 ;; `c-nonsymbol-token-regexp' should always match since
3350 ;; we've skipped backward over punctuator or paren
3351 ;; syntax, but move forward in case it doesn't so that
3352 ;; we don't leave point earlier than we started with.
3354 (< (point) start)))))
3357 (defconst c-jump-syntax-balanced
3358 (if (memq 'gen-string-delim c-emacs-features)
3359 "\\w\\|\\s_\\|\\s\(\\|\\s\)\\|\\s\"\\|\\s|"
3360 "\\w\\|\\s_\\|\\s\(\\|\\s\)\\|\\s\""))
3362 (defconst c-jump-syntax-unbalanced
3363 (if (memq 'gen-string-delim c-emacs-features)
3364 "\\w\\|\\s_\\|\\s\"\\|\\s|"
3365 "\\w\\|\\s_\\|\\s\""))
3367 (defun c-forward-token-2 (&optional count balanced limit)
3368 "Move forward by tokens.
3369 A token is defined as all symbols and identifiers which aren't
3370 syntactic whitespace \(note that multicharacter tokens like \"==\" are
3371 treated properly). Point is always either left at the beginning of a
3372 token or not moved at all. COUNT specifies the number of tokens to
3373 move; a negative COUNT moves in the opposite direction. A COUNT of 0
3374 moves to the next token beginning only if not already at one. If
3375 BALANCED is true, move over balanced parens, otherwise move into them.
3376 Also, if BALANCED is true, never move out of an enclosing paren.
3378 LIMIT sets the limit for the movement and defaults to the point limit.
3379 The case when LIMIT is set in the middle of a token, comment or macro
3380 is handled correctly, i.e. the point won't be left there.
3382 Return the number of tokens left to move \(positive or negative). If
3383 BALANCED is true, a move over a balanced paren counts as one. Note
3384 that if COUNT is 0 and no appropriate token beginning is found, 1 will
3385 be returned. Thus, a return value of 0 guarantees that point is at
3386 the requested position and a return value less \(without signs) than
3387 COUNT guarantees that point is at the beginning of some token.
3389 Note that this function might do hidden buffer changes. See the
3390 comment at the start of cc-engine.el for more info."
3392 (or count (setq count 1))
3394 (- (c-backward-token-2 (- count) balanced limit))
3396 (let ((jump-syntax (if balanced
3397 c-jump-syntax-balanced
3398 c-jump-syntax-unbalanced))
3403 ;; If count is zero we should jump if in the middle of a token.
3404 (c-end-of-current-token))
3407 (if limit (narrow-to-region (point-min) limit))
3409 (progn (c-forward-syntactic-ws) (point)))
3410 ;; Skip whitespace. Count this as a move if we did in
3412 (setq count (max (1- count) 0)))
3415 ;; Moved out of bounds. Make sure the returned count isn't zero.
3417 (if (zerop count) (setq count 1))
3420 ;; Use `condition-case' to avoid having the limit tests
3427 (cond ((looking-at jump-syntax)
3428 (goto-char (scan-sexps (point) 1))
3430 ((looking-at c-nonsymbol-token-regexp)
3431 (goto-char (match-end 0))
3433 ;; `c-nonsymbol-token-regexp' above should always
3434 ;; match if there are correct tokens. Try to
3435 ;; widen to see if the limit was set in the
3436 ;; middle of one, else fall back to treating
3437 ;; the offending thing as a one character token.
3441 (looking-at c-nonsymbol-token-regexp)))
3446 (c-forward-syntactic-ws)
3449 (error (goto-char last)))
3453 (setq count (1+ count)))))
3457 (defun c-backward-token-2 (&optional count balanced limit)
3458 "Move backward by tokens.
3459 See `c-forward-token-2' for details."
3461 (or count (setq count 1))
3463 (- (c-forward-token-2 (- count) balanced limit))
3465 (or limit (setq limit (point-min)))
3466 (let ((jump-syntax (if balanced
3467 c-jump-syntax-balanced
3468 c-jump-syntax-unbalanced))
3472 ;; The count is zero so try to skip to the beginning of the
3475 (progn (c-beginning-of-current-token) (point)))
3476 (if (< (point) limit)
3477 ;; The limit is inside the same token, so return 1.
3480 ;; We're not in the middle of a token. If there's
3481 ;; whitespace after the point then we must move backward,
3482 ;; so set count to 1 in that case.
3483 (and (looking-at c-syntactic-ws-start)
3484 ;; If we're looking at a '#' that might start a cpp
3485 ;; directive then we have to do a more elaborate check.
3486 (or (/= (char-after) ?#)
3487 (not c-opt-cpp-prefix)
3490 (progn (beginning-of-line)
3491 (looking-at "[ \t]*")
3494 (progn (backward-char)
3495 (not (eq (char-before) ?\\)))))))
3498 ;; Use `condition-case' to avoid having to check for buffer
3499 ;; limits in `backward-char', `scan-sexps' and `goto-char' below.
3504 (c-backward-syntactic-ws)
3506 (if (looking-at jump-syntax)
3507 (goto-char (scan-sexps (1+ (point)) -1))
3508 ;; This can be very inefficient if there's a long
3509 ;; sequence of operator tokens without any separation.
3510 ;; That doesn't happen in practice, anyway.
3511 (c-beginning-of-current-token))
3512 (>= (point) limit)))
3515 (error (goto-char last)))
3517 (if (< (point) limit)
3522 (defun c-forward-token-1 (&optional count balanced limit)
3523 "Like `c-forward-token-2' but doesn't treat multicharacter operator
3524 tokens like \"==\" as single tokens, i.e. all sequences of symbol
3525 characters are jumped over character by character. This function is
3526 for compatibility only; it's only a wrapper over `c-forward-token-2'."
3527 (let ((c-nonsymbol-token-regexp "\\s.\\|\\s\(\\|\\s\)"))
3528 (c-forward-token-2 count balanced limit)))
3530 (defun c-backward-token-1 (&optional count balanced limit)
3531 "Like `c-backward-token-2' but doesn't treat multicharacter operator
3532 tokens like \"==\" as single tokens, i.e. all sequences of symbol
3533 characters are jumped over character by character. This function is
3534 for compatibility only; it's only a wrapper over `c-backward-token-2'."
3535 (let ((c-nonsymbol-token-regexp "\\s.\\|\\s\(\\|\\s\)"))
3536 (c-backward-token-2 count balanced limit)))
3539 ;; Tools for doing searches restricted to syntactically relevant text.
3541 (defun c-syntactic-re-search-forward (regexp &optional bound noerror
3542 paren-level not-inside-token
3543 lookbehind-submatch)
3544 "Like `re-search-forward', but only report matches that are found
3545 in syntactically significant text. I.e. matches in comments, macros
3546 or string literals are ignored. The start point is assumed to be
3547 outside any comment, macro or string literal, or else the content of
3548 that region is taken as syntactically significant text.
3550 If PAREN-LEVEL is non-nil, an additional restriction is added to
3551 ignore matches in nested paren sexps. The search will also not go
3552 outside the current list sexp, which has the effect that if the point
3553 should be moved to BOUND when no match is found \(i.e. NOERROR is
3554 neither nil nor t), then it will be at the closing paren if the end of
3555 the current list sexp is encountered first.
3557 If NOT-INSIDE-TOKEN is non-nil, matches in the middle of tokens are
3558 ignored. Things like multicharacter operators and special symbols
3559 \(e.g. \"`()\" in Pike) are handled but currently not floating point
3562 If LOOKBEHIND-SUBMATCH is non-nil, it's taken as a number of a
3563 subexpression in REGEXP. The end of that submatch is used as the
3564 position to check for syntactic significance. If LOOKBEHIND-SUBMATCH
3565 isn't used or if that subexpression didn't match then the start
3566 position of the whole match is used instead. The \"look behind\"
3567 subexpression is never tested before the starting position, so it
3568 might be a good idea to include \\=\\= as a match alternative in it.
3570 Optimization note: Matches might be missed if the \"look behind\"
3571 subexpression can match the end of nonwhite syntactic whitespace,
3572 i.e. the end of comments or cpp directives. This since the function
3573 skips over such things before resuming the search. It's on the other
3574 hand not safe to assume that the \"look behind\" subexpression never
3575 matches syntactic whitespace.
3577 Bug: Unbalanced parens inside cpp directives are currently not handled
3578 correctly \(i.e. they don't get ignored as they should) when
3581 Note that this function might do hidden buffer changes. See the
3582 comment at the start of cc-engine.el for more info."
3584 (or bound (setq bound (point-max)))
3585 (if paren-level (setq paren-level -1))
3587 ;;(message "c-syntactic-re-search-forward %s %s %S" (point) bound regexp)
3589 (let ((start (point))
3591 ;; Start position for the last search.
3593 ;; The `parse-partial-sexp' state between the start position
3596 ;; The current position after the last state update. The next
3597 ;; `parse-partial-sexp' continues from here.
3599 ;; The position at which to check the state and the state
3600 ;; there. This is separate from `state-pos' since we might
3601 ;; need to back up before doing the next search round.
3602 check-pos check-state
3603 ;; Last position known to end a token.
3604 (last-token-end-pos (point-min))
3605 ;; Set when a valid match is found.
3612 (setq search-pos (point))
3613 (re-search-forward regexp bound noerror))
3616 (setq state (parse-partial-sexp
3617 state-pos (match-beginning 0) paren-level nil state)
3619 (if (setq check-pos (and lookbehind-submatch
3620 (or (not paren-level)
3622 (match-end lookbehind-submatch)))
3623 (setq check-state (parse-partial-sexp
3624 state-pos check-pos paren-level nil state))
3625 (setq check-pos state-pos
3628 ;; NOTE: If we got a look behind subexpression and get
3629 ;; an insignificant match in something that isn't
3630 ;; syntactic whitespace (i.e. strings or in nested
3631 ;; parentheses), then we can never skip more than a
3632 ;; single character from the match start position
3633 ;; (i.e. `state-pos' here) before continuing the
3634 ;; search. That since the look behind subexpression
3635 ;; might match the end of the insignificant region in
3639 ((elt check-state 7)
3640 ;; Match inside a line comment. Skip to eol. Use
3641 ;; `re-search-forward' instead of `skip-chars-forward' to get
3642 ;; the right bound behavior.
3643 (re-search-forward "[\n\r]" bound noerror))
3645 ((elt check-state 4)
3646 ;; Match inside a block comment. Skip to the '*/'.
3647 (search-forward "*/" bound noerror))
3649 ((and (not (elt check-state 5))
3650 (eq (char-before check-pos) ?/)
3651 (not (c-get-char-property (1- check-pos) 'syntax-table))
3652 (memq (char-after check-pos) '(?/ ?*)))
3653 ;; Match in the middle of the opener of a block or line
3655 (if (= (char-after check-pos) ?/)
3656 (re-search-forward "[\n\r]" bound noerror)
3657 (search-forward "*/" bound noerror)))
3659 ;; The last `parse-partial-sexp' above might have
3660 ;; stopped short of the real check position if the end
3661 ;; of the current sexp was encountered in paren-level
3662 ;; mode. The checks above are always false in that
3663 ;; case, and since they can do better skipping in
3664 ;; lookbehind-submatch mode, we do them before
3665 ;; checking the paren level.
3668 (/= (setq tmp (car check-state)) 0))
3669 ;; Check the paren level first since we're short of the
3670 ;; syntactic checking position if the end of the
3671 ;; current sexp was encountered by `parse-partial-sexp'.
3674 ;; Inside a nested paren sexp.
3675 (if lookbehind-submatch
3676 ;; See the NOTE above.
3677 (progn (goto-char state-pos) t)
3678 ;; Skip out of the paren quickly.
3679 (setq state (parse-partial-sexp state-pos bound 0 nil state)
3682 ;; Have exited the current paren sexp.
3685 ;; The last `parse-partial-sexp' call above
3686 ;; has left us just after the closing paren
3687 ;; in this case, so we can modify the bound
3688 ;; to leave the point at the right position
3690 (setq bound (1- (point)))
3692 (signal 'search-failed (list regexp)))))
3694 ((setq tmp (elt check-state 3))
3695 ;; Match inside a string.
3696 (if (or lookbehind-submatch
3697 (not (integerp tmp)))
3698 ;; See the NOTE above.
3699 (progn (goto-char state-pos) t)
3700 ;; Skip to the end of the string before continuing.
3701 (let ((ender (make-string 1 tmp)) (continue t))
3702 (while (if (search-forward ender bound noerror)
3704 (setq state (parse-partial-sexp
3705 state-pos (point) nil nil state)
3708 (setq continue nil)))
3713 (c-beginning-of-macro start)))
3714 ;; Match inside a macro. Skip to the end of it.
3716 (cond ((<= (point) bound) t)
3718 (t (signal 'search-failed (list regexp)))))
3720 ((and not-inside-token
3721 (or (< check-pos last-token-end-pos)
3724 (goto-char check-pos)
3726 (c-end-of-current-token last-token-end-pos))
3727 (setq last-token-end-pos (point))))))
3729 (if lookbehind-submatch
3730 ;; See the NOTE above.
3731 (goto-char state-pos)
3732 (goto-char (min last-token-end-pos bound))))
3739 ;; Should loop to search again, but take care to avoid
3740 ;; looping on the same spot.
3741 (or (/= search-pos (point))
3742 (if (= (point) bound)
3745 (signal 'search-failed (list regexp)))
3751 (signal (car err) (cdr err))))
3753 ;;(message "c-syntactic-re-search-forward done %s" (or (match-end 0) (point)))
3757 (goto-char (match-end 0))
3760 ;; Search failed. Set point as appropriate.
3766 (defvar safe-pos-list) ; bound in c-syntactic-skip-backward
3768 (defsubst c-ssb-lit-begin ()
3769 ;; Return the start of the literal point is in, or nil.
3770 ;; We read and write the variables `safe-pos', `safe-pos-list', `state'
3771 ;; bound in the caller.
3773 ;; Use `parse-partial-sexp' from a safe position down to the point to check
3774 ;; if it's outside comments and strings.
3776 (let ((pos (point)) safe-pos state pps-end-pos)
3777 ;; Pick a safe position as close to the point as possible.
3779 ;; FIXME: Consult `syntax-ppss' here if our cache doesn't give a good
3782 (while (and safe-pos-list
3783 (> (car safe-pos-list) (point)))
3784 (setq safe-pos-list (cdr safe-pos-list)))
3785 (unless (setq safe-pos (car-safe safe-pos-list))
3786 (setq safe-pos (max (or (c-safe-position
3787 (point) (or c-state-cache
3791 safe-pos-list (list safe-pos)))
3793 ;; Cache positions along the way to use if we have to back up more. We
3794 ;; cache every closing paren on the same level. If the paren cache is
3795 ;; relevant in this region then we're typically already on the same
3796 ;; level as the target position. Note that we might cache positions
3797 ;; after opening parens in case safe-pos is in a nested list. That's
3798 ;; both uncommon and harmless.
3800 (setq state (parse-partial-sexp
3803 (setq safe-pos (point)
3804 safe-pos-list (cons safe-pos safe-pos-list)))
3806 ;; If the state contains the start of the containing sexp we cache that
3807 ;; position too, so that parse-partial-sexp in the next run has a bigger
3808 ;; chance of starting at the same level as the target position and thus
3809 ;; will get more good safe positions into the list.
3811 (setq safe-pos (1+ (elt state 1))
3812 safe-pos-list (cons safe-pos safe-pos-list)))
3814 (if (or (elt state 3) (elt state 4))
3815 ;; Inside string or comment. Continue search at the
3819 (defun c-syntactic-skip-backward (skip-chars &optional limit paren-level)
3820 "Like `skip-chars-backward' but only look at syntactically relevant chars,
3821 i.e. don't stop at positions inside syntactic whitespace or string
3822 literals. Preprocessor directives are also ignored, with the exception
3823 of the one that the point starts within, if any. If LIMIT is given,
3824 it's assumed to be at a syntactically relevant position.
3826 If PAREN-LEVEL is non-nil, the function won't stop in nested paren
3827 sexps, and the search will also not go outside the current paren sexp.
3828 However, if LIMIT or the buffer limit is reached inside a nested paren
3829 then the point will be left at the limit.
3831 Non-nil is returned if the point moved, nil otherwise.
3833 Note that this function might do hidden buffer changes. See the
3834 comment at the start of cc-engine.el for more info."
3836 (let ((start (point))
3838 ;; A list of syntactically relevant positions in descending
3839 ;; order. It's used to avoid scanning repeatedly over
3840 ;; potentially large regions with `parse-partial-sexp' to verify
3841 ;; each position. Used in `c-ssb-lit-begin'
3843 ;; The result from `c-beginning-of-macro' at the start position or the
3844 ;; start position itself if it isn't within a macro. Evaluated on
3847 ;; The earliest position after the current one with the same paren
3848 ;; level. Used only when `paren-level' is set.
3850 (paren-level-pos (point)))
3854 ;; The next loop "tries" to find the end point each time round,
3855 ;; loops when it hasn't succeeded.
3858 (< (skip-chars-backward skip-chars limit) 0)
3860 (let ((pos (point)) state-2 pps-end-pos)
3863 ;; Don't stop inside a literal
3864 ((setq lit-beg (c-ssb-lit-begin))
3870 (setq state-2 (parse-partial-sexp
3871 pos paren-level-pos -1)
3872 pps-end-pos (point))
3873 (/= (car state-2) 0)))
3874 ;; Not at the right level.
3876 (if (and (< (car state-2) 0)
3877 ;; We stop above if we go out of a paren.
3878 ;; Now check whether it precedes or is
3879 ;; nested in the starting sexp.
3883 pps-end-pos paren-level-pos
3885 (< (car state-2) 0)))
3887 ;; We've stopped short of the starting position
3888 ;; so the hit was inside a nested list. Go up
3889 ;; until we are at the right level.
3892 (goto-char (scan-lists pos -1
3894 (setq paren-level-pos (point))
3895 (if (and limit (>= limit paren-level-pos))
3901 (goto-char (or limit (point-min)))
3904 ;; The hit was outside the list at the start
3905 ;; position. Go to the start of the list and exit.
3906 (goto-char (1+ (elt state-2 1)))
3909 ((c-beginning-of-macro limit)
3913 (setq start-macro-beg
3916 (c-beginning-of-macro limit)
3920 ;; It's inside the same macro we started in so it's
3921 ;; a relevant match.
3927 ;; Skip syntactic ws afterwards so that we don't stop at the
3928 ;; end of a comment if `skip-chars' is something like "^/".
3929 (c-backward-syntactic-ws)
3932 ;; We might want to extend this with more useful return values in
3934 (/= (point) start)))
3936 ;; The following is an alternative implementation of
3937 ;; `c-syntactic-skip-backward' that uses backward movement to keep
3938 ;; track of the syntactic context. It turned out to be generally
3939 ;; slower than the one above which uses forward checks from earlier
3942 ;;(defconst c-ssb-stop-re
3943 ;; ;; The regexp matching chars `c-syntactic-skip-backward' needs to
3944 ;; ;; stop at to avoid going into comments and literals.
3946 ;; ;; Match comment end syntax and string literal syntax. Also match
3947 ;; ;; '/' for block comment endings (not covered by comment end
3949 ;; "\\s>\\|/\\|\\s\""
3950 ;; (if (memq 'gen-string-delim c-emacs-features)
3953 ;; (if (memq 'gen-comment-delim c-emacs-features)
3957 ;;(defconst c-ssb-stop-paren-re
3958 ;; ;; Like `c-ssb-stop-re' but also stops at paren chars.
3959 ;; (concat c-ssb-stop-re "\\|\\s(\\|\\s)"))
3961 ;;(defconst c-ssb-sexp-end-re
3962 ;; ;; Regexp matching the ending syntax of a complex sexp.
3963 ;; (concat c-string-limit-regexp "\\|\\s)"))
3965 ;;(defun c-syntactic-skip-backward (skip-chars &optional limit paren-level)
3966 ;; "Like `skip-chars-backward' but only look at syntactically relevant chars,
3967 ;;i.e. don't stop at positions inside syntactic whitespace or string
3968 ;;literals. Preprocessor directives are also ignored. However, if the
3969 ;;point is within a comment, string literal or preprocessor directory to
3970 ;;begin with, its contents is treated as syntactically relevant chars.
3971 ;;If LIMIT is given, it limits the backward search and the point will be
3972 ;;left there if no earlier position is found.
3974 ;;If PAREN-LEVEL is non-nil, the function won't stop in nested paren
3975 ;;sexps, and the search will also not go outside the current paren sexp.
3976 ;;However, if LIMIT or the buffer limit is reached inside a nested paren
3977 ;;then the point will be left at the limit.
3979 ;;Non-nil is returned if the point moved, nil otherwise.
3981 ;;Note that this function might do hidden buffer changes. See the
3982 ;;comment at the start of cc-engine.el for more info."
3984 ;; (save-restriction
3986 ;; (narrow-to-region limit (point-max)))
3988 ;; (let ((start (point)))
3990 ;; (while (let ((last-pos (point))
3992 ;; (skip-chars-backward skip-chars)
3995 ;; ;; Skip back over the same region as
3996 ;; ;; `skip-chars-backward' above, but keep to
3997 ;; ;; syntactically relevant positions.
3998 ;; (goto-char last-pos)
4000 ;; ;; `re-search-backward' with a single char regexp
4001 ;; ;; should be fast.
4002 ;; (re-search-backward
4003 ;; (if paren-level c-ssb-stop-paren-re c-ssb-stop-re)
4008 ;; ((looking-at "\\s(")
4009 ;; ;; `paren-level' is set and we've found the
4010 ;; ;; start of the containing paren.
4014 ;; ((looking-at c-ssb-sexp-end-re)
4015 ;; ;; We're at the end of a string literal or paren
4016 ;; ;; sexp (if `paren-level' is set).
4018 ;; (condition-case nil
4019 ;; (c-backward-sexp)
4021 ;; (goto-char limit)
4022 ;; (throw 'done t))))
4026 ;; ;; At the end of some syntactic ws or possibly
4027 ;; ;; after a plain '/' operator.
4028 ;; (let ((pos (point)))
4029 ;; (c-backward-syntactic-ws)
4030 ;; (if (= pos (point))
4031 ;; ;; Was a plain '/' operator. Go past it.
4032 ;; (backward-char)))))
4034 ;; (> (point) stop-pos))))
4036 ;; ;; Now the point is either at `stop-pos' or at some
4037 ;; ;; position further back if `stop-pos' was at a
4038 ;; ;; syntactically irrelevant place.
4040 ;; ;; Skip additional syntactic ws so that we don't stop
4041 ;; ;; at the end of a comment if `skip-chars' is
4042 ;; ;; something like "^/".
4043 ;; (c-backward-syntactic-ws)
4045 ;; (< (point) stop-pos))))
4047 ;; ;; We might want to extend this with more useful return values
4048 ;; ;; in the future.
4049 ;; (/= (point) start))))
4052 ;; Tools for handling comments and string literals.
4054 (defun c-slow-in-literal (&optional lim detect-cpp)
4055 "Return the type of literal point is in, if any.
4056 The return value is `c' if in a C-style comment, `c++' if in a C++
4057 style comment, `string' if in a string literal, `pound' if DETECT-CPP
4058 is non-nil and in a preprocessor line, or nil if somewhere else.
4059 Optional LIM is used as the backward limit of the search. If omitted,
4060 or nil, `c-beginning-of-defun' is used.
4062 The last point calculated is cached if the cache is enabled, i.e. if
4063 `c-in-literal-cache' is bound to a two element vector.
4065 Note that this function might do hidden buffer changes. See the
4066 comment at the start of cc-engine.el for more info."
4068 (if (and (vectorp c-in-literal-cache)
4069 (= (point) (aref c-in-literal-cache 0)))
4070 (aref c-in-literal-cache 1)
4071 (let ((rtn (save-excursion
4072 (let* ((pos (point))
4074 (c-beginning-of-syntax)
4076 (state (parse-partial-sexp lim pos)))
4078 ((elt state 3) 'string)
4079 ((elt state 4) (if (elt state 7) 'c++ 'c))
4080 ((and detect-cpp (c-beginning-of-macro lim)) 'pound)
4082 ;; cache this result if the cache is enabled
4083 (if (not c-in-literal-cache)
4084 (setq c-in-literal-cache (vector (point) rtn)))
4087 ;; XEmacs has a built-in function that should make this much quicker.
4088 ;; I don't think we even need the cache, which makes our lives more
4089 ;; complicated anyway. In this case, lim is only used to detect
4092 ;; Note that there is a bug in Xemacs's buffer-syntactic-context when used in
4093 ;; conjunction with syntax-table-properties. The bug is present in, e.g.,
4094 ;; Xemacs 21.4.4. It manifested itself thus:
4096 ;; Starting with an empty AWK Mode buffer, type
4098 ;; Point gets wrongly left at column 0, rather than being indented to tab-width.
4100 ;; AWK Mode is designed such that when the first / is typed, it gets the
4101 ;; syntax-table property "string fence". When the second / is typed, BOTH /s
4102 ;; are given the s-t property "string". However, buffer-syntactic-context
4103 ;; fails to take account of the change of the s-t property on the opening / to
4104 ;; "string", and reports that the { is within a string started by the second /.
4106 ;; The workaround for this is for the AWK Mode initialisation to switch the
4107 ;; defalias for c-in-literal to c-slow-in-literal. This will slow down other
4108 ;; cc-modes in Xemacs whenever an awk-buffer has been initialised.
4110 ;; (Alan Mackenzie, 2003/4/30).
4112 (defun c-fast-in-literal (&optional lim detect-cpp)
4113 ;; This function might do hidden buffer changes.
4114 (let ((context (buffer-syntactic-context)))
4116 ((eq context 'string) 'string)
4117 ((eq context 'comment) 'c++)
4118 ((eq context 'block-comment) 'c)
4119 ((and detect-cpp (save-excursion (c-beginning-of-macro lim))) 'pound))))
4121 (defalias 'c-in-literal
4122 (if (fboundp 'buffer-syntactic-context)
4123 'c-fast-in-literal ; XEmacs
4124 'c-slow-in-literal)) ; GNU Emacs
4126 ;; The defalias above isn't enough to shut up the byte compiler.
4127 (cc-bytecomp-defun c-in-literal)
4129 (defun c-literal-limits (&optional lim near not-in-delimiter)
4130 "Return a cons of the beginning and end positions of the comment or
4131 string surrounding point (including both delimiters), or nil if point
4132 isn't in one. If LIM is non-nil, it's used as the \"safe\" position
4133 to start parsing from. If NEAR is non-nil, then the limits of any
4134 literal next to point is returned. \"Next to\" means there's only
4135 spaces and tabs between point and the literal. The search for such a
4136 literal is done first in forward direction. If NOT-IN-DELIMITER is
4137 non-nil, the case when point is inside a starting delimiter won't be
4138 recognized. This only has effect for comments which have starting
4139 delimiters with more than one character.
4141 Note that this function might do hidden buffer changes. See the
4142 comment at the start of cc-engine.el for more info."
4145 (let* ((pos (point))
4147 (c-beginning-of-syntax)
4149 (state (parse-partial-sexp lim pos)))
4151 (cond ((elt state 3) ; String.
4152 (goto-char (elt state 8))
4153 (cons (point) (or (c-safe (c-forward-sexp 1) (point))
4156 ((elt state 4) ; Comment.
4157 (goto-char (elt state 8))
4158 (cons (point) (progn (c-forward-single-comment) (point))))
4160 ((and (not not-in-delimiter)
4162 (eq (char-before) ?/)
4163 (looking-at "[/*]"))
4164 ;; We're standing in a comment starter.
4166 (cons (point) (progn (c-forward-single-comment) (point))))
4171 ;; Search forward for a literal.
4172 (skip-chars-forward " \t")
4175 ((looking-at c-string-limit-regexp) ; String.
4176 (cons (point) (or (c-safe (c-forward-sexp 1) (point))
4179 ((looking-at c-comment-start-regexp) ; Line or block comment.
4180 (cons (point) (progn (c-forward-single-comment) (point))))
4184 (skip-chars-backward " \t")
4186 (let ((end (point)) beg)
4189 (< (skip-syntax-backward c-string-syntax) 0)) ; String.
4190 (setq beg (c-safe (c-backward-sexp 1) (point))))
4192 ((and (c-safe (forward-char -2) t)
4194 ;; Block comment. Due to the nature of line
4195 ;; comments, they will always be covered by the
4196 ;; normal case above.
4198 (c-backward-single-comment)
4199 ;; If LIM is bogus, beg will be bogus.
4200 (setq beg (point))))
4202 (if beg (cons beg end))))))
4205 ;; In case external callers use this; it did have a docstring.
4206 (defalias 'c-literal-limits-fast 'c-literal-limits)
4208 (defun c-collect-line-comments (range)
4209 "If the argument is a cons of two buffer positions (such as returned by
4210 `c-literal-limits'), and that range contains a C++ style line comment,
4211 then an extended range is returned that contains all adjacent line
4212 comments (i.e. all comments that starts in the same column with no
4213 empty lines or non-whitespace characters between them). Otherwise the
4214 argument is returned.
4216 Note that this function might do hidden buffer changes. See the
4217 comment at the start of cc-engine.el for more info."
4221 (if (and (consp range) (progn
4222 (goto-char (car range))
4223 (looking-at c-line-comment-starter)))
4224 (let ((col (current-column))
4226 (bopl (c-point 'bopl))
4228 ;; Got to take care in the backward direction to handle
4229 ;; comments which are preceded by code.
4230 (while (and (c-backward-single-comment)
4232 (looking-at c-line-comment-starter)
4233 (= col (current-column)))
4235 bopl (c-point 'bopl)))
4237 (while (and (progn (skip-chars-forward " \t")
4238 (looking-at c-line-comment-starter))
4239 (= col (current-column))
4240 (prog1 (zerop (forward-line 1))
4241 (setq end (point)))))
4246 (defun c-literal-type (range)
4247 "Convenience function that given the result of `c-literal-limits',
4248 returns nil or the type of literal that the range surrounds, one
4249 of the symbols 'c, 'c++ or 'string. It's much faster than using
4250 `c-in-literal' and is intended to be used when you need both the
4251 type of a literal and its limits.
4253 Note that this function might do hidden buffer changes. See the
4254 comment at the start of cc-engine.el for more info."
4258 (goto-char (car range))
4259 (cond ((looking-at c-string-limit-regexp) 'string)
4260 ((or (looking-at "//") ; c++ line comment
4261 (and (looking-at "\\s<") ; comment starter
4262 (looking-at "#"))) ; awk comment.
4264 (t 'c))) ; Assuming the range is valid.
4268 ;; `c-find-decl-spots' and accompanying stuff.
4270 ;; Variables used in `c-find-decl-spots' to cache the search done for
4271 ;; the first declaration in the last call. When that function starts,
4272 ;; it needs to back up over syntactic whitespace to look at the last
4273 ;; token before the region being searched. That can sometimes cause
4274 ;; moves back and forth over a quite large region of comments and
4275 ;; macros, which would be repeated for each changed character when
4276 ;; we're called during fontification, since font-lock refontifies the
4277 ;; current line for each change. Thus it's worthwhile to cache the
4280 ;; `c-find-decl-syntactic-pos' is a syntactically relevant position in
4281 ;; the syntactic whitespace less or equal to some start position.
4282 ;; There's no cached value if it's nil.
4284 ;; `c-find-decl-match-pos' is the match position if
4285 ;; `c-find-decl-prefix-search' matched before the syntactic whitespace
4286 ;; at `c-find-decl-syntactic-pos', or nil if there's no such match.
4287 (defvar c-find-decl-syntactic-pos nil)
4288 (make-variable-buffer-local 'c-find-decl-syntactic-pos)
4289 (defvar c-find-decl-match-pos nil)
4290 (make-variable-buffer-local 'c-find-decl-match-pos)
4292 (defsubst c-invalidate-find-decl-cache (change-min-pos)
4293 (and c-find-decl-syntactic-pos
4294 (< change-min-pos c-find-decl-syntactic-pos)
4295 (setq c-find-decl-syntactic-pos nil)))
4297 ; (defface c-debug-decl-spot-face
4298 ; '((t (:background "Turquoise")))
4299 ; "Debug face to mark the spots where `c-find-decl-spots' stopped.")
4300 ; (defface c-debug-decl-sws-face
4301 ; '((t (:background "Khaki")))
4302 ; "Debug face to mark the syntactic whitespace between the declaration
4303 ; spots and the preceding token end.")
4305 (defmacro c-debug-put-decl-spot-faces (match-pos decl-pos)
4306 (when (facep 'c-debug-decl-spot-face)
4307 `(c-save-buffer-state ((match-pos ,match-pos) (decl-pos ,decl-pos))
4308 (c-debug-add-face (max match-pos (point-min)) decl-pos
4309 'c-debug-decl-sws-face)
4310 (c-debug-add-face decl-pos (min (1+ decl-pos) (point-max))
4311 'c-debug-decl-spot-face))))
4312 (defmacro c-debug-remove-decl-spot-faces (beg end)
4313 (when (facep 'c-debug-decl-spot-face)
4314 `(c-save-buffer-state ()
4315 (c-debug-remove-face ,beg ,end 'c-debug-decl-spot-face)
4316 (c-debug-remove-face ,beg ,end 'c-debug-decl-sws-face))))
4318 (defmacro c-find-decl-prefix-search ()
4319 ;; Macro used inside `c-find-decl-spots'. It ought to be a defun,
4320 ;; but it contains lots of free variables that refer to things
4321 ;; inside `c-find-decl-spots'. The point is left at `cfd-match-pos'
4322 ;; if there is a match, otherwise at `cfd-limit'.
4324 ;; This macro might do hidden buffer changes.
4327 ;; Find the next property match position if we haven't got one already.
4328 (unless cfd-prop-match
4331 (goto-char (next-single-property-change
4332 (point) 'c-type nil cfd-limit))
4333 (and (< (point) cfd-limit)
4334 (not (eq (c-get-char-property (1- (point)) 'c-type)
4336 (setq cfd-prop-match (point))))
4338 ;; Find the next `c-decl-prefix-or-start-re' match if we haven't
4340 (unless cfd-re-match
4342 (if (> cfd-re-match-end (point))
4343 (goto-char cfd-re-match-end))
4345 (while (if (setq cfd-re-match-end
4346 (re-search-forward c-decl-prefix-or-start-re
4349 ;; Match. Check if it's inside a comment or string literal.
4351 (if (setq cfd-re-match (match-end 1))
4352 ;; Matched the end of a token preceding a decl spot.
4354 (goto-char cfd-re-match)
4356 ;; Matched a token that start a decl spot.
4357 (goto-char (match-beginning 0))
4361 ;; No match. Finish up and exit the loop.
4362 (setq cfd-re-match cfd-limit)
4365 ;; Skip out of comments and string literals.
4367 (goto-char (next-single-property-change
4368 (point) 'face nil cfd-limit))
4369 (and (< (point) cfd-limit)
4370 (c-got-face-at (point) c-literal-faces)))))
4372 ;; If we matched at the decl start, we have to back up over the
4373 ;; preceding syntactic ws to set `cfd-match-pos' and to catch
4374 ;; any decl spots in the syntactic ws.
4375 (unless cfd-re-match
4376 (c-backward-syntactic-ws)
4377 (setq cfd-re-match (point))))
4379 ;; Choose whichever match is closer to the start.
4380 (if (< cfd-re-match cfd-prop-match)
4381 (setq cfd-match-pos cfd-re-match
4383 (setq cfd-match-pos cfd-prop-match
4384 cfd-prop-match nil))
4386 (goto-char cfd-match-pos)
4388 (when (< cfd-match-pos cfd-limit)
4389 ;; Skip forward past comments only so we don't skip macros.
4390 (c-forward-comments)
4391 ;; Set the position to continue at. We can avoid going over
4392 ;; the comments skipped above a second time, but it's possible
4393 ;; that the comment skipping has taken us past `cfd-prop-match'
4394 ;; since the property might be used inside comments.
4395 (setq cfd-continue-pos (if cfd-prop-match
4396 (min cfd-prop-match (point))
4399 (defun c-find-decl-spots (cfd-limit cfd-decl-re cfd-face-checklist cfd-fun)
4400 ;; Call CFD-FUN for each possible spot for a declaration, cast or
4401 ;; label from the point to CFD-LIMIT.
4403 ;; CFD-FUN is called with point at the start of the spot. It's
4404 ;; passed two arguments: The first is the end position of the token
4405 ;; preceding the spot, or 0 for the implicit match at bob. The
4406 ;; second is a flag that is t when the match is inside a macro. If
4407 ;; CFD-FUN adds `c-decl-end' properties somewhere below the current
4408 ;; spot, it should return non-nil to ensure that the next search
4412 ;; o The first token after bob.
4413 ;; o The first token after the end of submatch 1 in
4414 ;; `c-decl-prefix-or-start-re' when that submatch matches.
4415 ;; o The start of each `c-decl-prefix-or-start-re' match when
4416 ;; submatch 1 doesn't match.
4417 ;; o The first token after the end of each occurrence of the
4418 ;; `c-type' text property with the value `c-decl-end', provided
4419 ;; `c-type-decl-end-used' is set.
4421 ;; Only a spot that match CFD-DECL-RE and whose face is in the
4422 ;; CFD-FACE-CHECKLIST list causes CFD-FUN to be called. The face
4423 ;; check is disabled if CFD-FACE-CHECKLIST is nil.
4425 ;; If the match is inside a macro then the buffer is narrowed to the
4426 ;; end of it, so that CFD-FUN can investigate the following tokens
4427 ;; without matching something that begins inside a macro and ends
4428 ;; outside it. It's to avoid this work that the CFD-DECL-RE and
4429 ;; CFD-FACE-CHECKLIST checks exist.
4431 ;; The spots are visited approximately in order from top to bottom.
4432 ;; It's however the positions where `c-decl-prefix-or-start-re'
4433 ;; matches and where `c-decl-end' properties are found that are in
4434 ;; order. Since the spots often are at the following token, they
4435 ;; might be visited out of order insofar as more spots are reported
4436 ;; later on within the syntactic whitespace between the match
4437 ;; positions and their spots.
4439 ;; It's assumed that comments and strings are fontified in the
4442 ;; This is mainly used in fontification, and so has an elaborate
4443 ;; cache to handle repeated calls from the same start position; see
4444 ;; the variables above.
4446 ;; All variables in this function begin with `cfd-' to avoid name
4447 ;; collision with the (dynamically bound) variables used in CFD-FUN.
4449 ;; This function might do hidden buffer changes.
4451 (let ((cfd-start-pos (point))
4452 (cfd-buffer-end (point-max))
4453 ;; The end of the token preceding the decl spot last found
4454 ;; with `c-decl-prefix-or-start-re'. `cfd-limit' if there's
4457 ;; The end position of the last `c-decl-prefix-or-start-re'
4458 ;; match. If this is greater than `cfd-continue-pos', the
4459 ;; next regexp search is started here instead.
4460 (cfd-re-match-end (point-min))
4461 ;; The end of the last `c-decl-end' found by
4462 ;; `c-find-decl-prefix-search'. `cfd-limit' if there's no
4463 ;; match. If searching for the property isn't needed then we
4464 ;; disable it by setting it to `cfd-limit' directly.
4465 (cfd-prop-match (unless c-type-decl-end-used cfd-limit))
4466 ;; The end of the token preceding the decl spot last found by
4467 ;; `c-find-decl-prefix-search'. 0 for the implicit match at
4468 ;; bob. `cfd-limit' if there's no match. In other words,
4469 ;; this is the minimum of `cfd-re-match' and `cfd-prop-match'.
4470 (cfd-match-pos cfd-limit)
4471 ;; The position to continue searching at.
4473 ;; The position of the last "real" token we've stopped at.
4474 ;; This can be greater than `cfd-continue-pos' when we get
4475 ;; hits inside macros or at `c-decl-end' positions inside
4478 ;; The end position of the last entered macro.
4481 ;; Initialize by finding a syntactically relevant start position
4482 ;; before the point, and do the first `c-decl-prefix-or-start-re'
4483 ;; search unless we're at bob.
4485 (let (start-in-literal start-in-macro syntactic-pos)
4486 ;; Must back up a bit since we look for the end of the previous
4487 ;; statement or declaration, which is earlier than the first
4491 ;; First we need to move to a syntactically relevant position.
4492 ;; Begin by backing out of comment or string literals.
4494 (when (c-got-face-at (point) c-literal-faces)
4495 ;; Try to use the faces to back up to the start of the
4496 ;; literal. FIXME: What if the point is on a declaration
4497 ;; inside a comment?
4498 (while (and (not (bobp))
4499 (c-got-face-at (1- (point)) c-literal-faces))
4500 (goto-char (previous-single-property-change
4501 (point) 'face nil (point-min))))
4503 ;; XEmacs doesn't fontify the quotes surrounding string
4505 (and (featurep 'xemacs)
4506 (eq (get-text-property (point) 'face)
4507 'font-lock-string-face)
4509 (progn (backward-char)
4510 (not (looking-at c-string-limit-regexp)))
4513 ;; Don't trust the literal to contain only literal faces
4514 ;; (the font lock package might not have fontified the
4515 ;; start of it at all, for instance) so check that we have
4516 ;; arrived at something that looks like a start or else
4517 ;; resort to `c-literal-limits'.
4518 (unless (looking-at c-literal-start-regexp)
4519 (let ((range (c-literal-limits)))
4520 (if range (goto-char (car range)))))
4522 (setq start-in-literal (point)))
4524 ;; The start is in a literal. If the limit is in the same
4525 ;; one we don't have to find a syntactic position etc. We
4526 ;; only check that if the limit is at or before bonl to save
4527 ;; time; it covers the by far most common case when font-lock
4528 ;; refontifies the current line only.
4529 (<= cfd-limit (c-point 'bonl cfd-start-pos))
4531 (goto-char cfd-start-pos)
4533 (goto-char (next-single-property-change
4534 (point) 'face nil cfd-limit))
4535 (and (< (point) cfd-limit)
4536 (c-got-face-at (point) c-literal-faces))))
4537 (= (point) cfd-limit)))
4539 ;; Completely inside a literal. Set up variables to trig the
4540 ;; (< cfd-continue-pos cfd-start-pos) case below and it'll
4541 ;; find a suitable start position.
4542 (setq cfd-continue-pos start-in-literal))
4544 ;; Check if the region might be completely inside a macro, to
4545 ;; optimize that like the completely-inside-literal above.
4547 (and (= (forward-line 1) 0)
4548 (bolp) ; forward-line has funny behavior at eob.
4549 (>= (point) cfd-limit)
4550 (progn (backward-char)
4551 (eq (char-before) ?\\))))
4552 ;; (Maybe) completely inside a macro. Only need to trig the
4553 ;; (< cfd-continue-pos cfd-start-pos) case below to make it
4555 (setq cfd-continue-pos (1- cfd-start-pos)
4559 ;; Back out of any macro so we don't miss any declaration
4560 ;; that could follow after it.
4561 (when (c-beginning-of-macro)
4562 (setq start-in-macro t))
4564 ;; Now we're at a proper syntactically relevant position so we
4565 ;; can use the cache. But first clear it if it applied
4567 (c-invalidate-find-decl-cache cfd-start-pos)
4569 (setq syntactic-pos (point))
4570 (unless (eq syntactic-pos c-find-decl-syntactic-pos)
4571 ;; Don't have to do this if the cache is relevant here,
4572 ;; typically if the same line is refontified again. If
4573 ;; we're just some syntactic whitespace further down we can
4574 ;; still use the cache to limit the skipping.
4575 (c-backward-syntactic-ws c-find-decl-syntactic-pos))
4577 ;; If we hit `c-find-decl-syntactic-pos' and
4578 ;; `c-find-decl-match-pos' is set then we install the cached
4579 ;; values. If we hit `c-find-decl-syntactic-pos' and
4580 ;; `c-find-decl-match-pos' is nil then we know there's no decl
4581 ;; prefix in the whitespace before `c-find-decl-syntactic-pos'
4582 ;; and so we can continue the search from this point. If we
4583 ;; didn't hit `c-find-decl-syntactic-pos' then we're now in
4584 ;; the right spot to begin searching anyway.
4585 (if (and (eq (point) c-find-decl-syntactic-pos)
4586 c-find-decl-match-pos)
4587 (setq cfd-match-pos c-find-decl-match-pos
4588 cfd-continue-pos syntactic-pos)
4590 (setq c-find-decl-syntactic-pos syntactic-pos)
4593 ;; Always consider bob a match to get the first
4594 ;; declaration in the file. Do this separately instead of
4595 ;; letting `c-decl-prefix-or-start-re' match bob, so that
4596 ;; regexp always can consume at least one character to
4597 ;; ensure that we won't get stuck in an infinite loop.
4598 (setq cfd-re-match 0)
4600 (c-beginning-of-current-token)
4601 (< (point) cfd-limit))
4602 ;; Do an initial search now. In the bob case above it's
4603 ;; only done to search for a `c-decl-end' spot.
4604 (c-find-decl-prefix-search))
4606 (setq c-find-decl-match-pos (and (< cfd-match-pos cfd-start-pos)
4609 ;; Advance `cfd-continue-pos' if it's before the start position.
4610 ;; The closest continue position that might have effect at or
4611 ;; after the start depends on what we started in. This also
4612 ;; finds a suitable start position in the special cases when the
4613 ;; region is completely within a literal or macro.
4614 (when (and cfd-continue-pos (< cfd-continue-pos cfd-start-pos))
4618 ;; If we're in a macro then it's the closest preceding token
4619 ;; in the macro. Check this before `start-in-literal',
4620 ;; since if we're inside a literal in a macro, the preceding
4621 ;; token is earlier than any `c-decl-end' spot inside the
4622 ;; literal (comment).
4623 (goto-char (or start-in-literal cfd-start-pos))
4624 ;; The only syntactic ws in macros are comments.
4625 (c-backward-comments)
4627 (c-beginning-of-current-token))
4630 ;; If we're in a comment it can only be the closest
4631 ;; preceding `c-decl-end' position within that comment, if
4632 ;; any. Go back to the beginning of such a property so that
4633 ;; `c-find-decl-prefix-search' will find the end of it.
4634 ;; (Can't stop at the end and install it directly on
4635 ;; `cfd-prop-match' since that variable might be cleared
4636 ;; after `cfd-fun' below.)
4638 ;; Note that if the literal is a string then the property
4639 ;; search will simply skip to the beginning of it right
4641 (if (not c-type-decl-end-used)
4642 (goto-char start-in-literal)
4643 (goto-char cfd-start-pos)
4645 (goto-char (previous-single-property-change
4646 (point) 'c-type nil start-in-literal))
4647 (and (> (point) start-in-literal)
4648 (not (eq (c-get-char-property (point) 'c-type)
4651 (when (= (point) start-in-literal)
4652 ;; Didn't find any property inside the comment, so we can
4653 ;; skip it entirely. (This won't skip past a string, but
4654 ;; that'll be handled quickly by the next
4655 ;; `c-find-decl-prefix-search' anyway.)
4656 (c-forward-single-comment)
4657 (if (> (point) cfd-limit)
4658 (goto-char cfd-limit))))
4661 ;; If we started in normal code, the only match that might
4662 ;; apply before the start is what we already got in
4663 ;; `cfd-match-pos' so we can continue at the start position.
4664 ;; (Note that we don't get here if the first match is below
4666 (goto-char cfd-start-pos)))
4668 ;; Delete found matches if they are before our new continue
4669 ;; position, so that `c-find-decl-prefix-search' won't back up
4670 ;; to them later on.
4671 (setq cfd-continue-pos (point))
4672 (when (and cfd-re-match (< cfd-re-match cfd-continue-pos))
4673 (setq cfd-re-match nil))
4674 (when (and cfd-prop-match (< cfd-prop-match cfd-continue-pos))
4675 (setq cfd-prop-match nil)))
4678 ;; This is the normal case and we got a proper syntactic
4679 ;; position. If there's a match then it's always outside
4680 ;; macros and comments, so advance to the next token and set
4681 ;; `cfd-token-pos'. The loop below will later go back using
4682 ;; `cfd-continue-pos' to fix declarations inside the
4684 (when (and cfd-match-pos (< cfd-match-pos syntactic-pos))
4685 (goto-char syntactic-pos)
4686 (c-forward-syntactic-ws)
4687 (and cfd-continue-pos
4688 (< cfd-continue-pos (point))
4689 (setq cfd-token-pos (point))))
4691 ;; Have one of the special cases when the region is completely
4692 ;; within a literal or macro. `cfd-continue-pos' is set to a
4693 ;; good start position for the search, so do it.
4694 (c-find-decl-prefix-search)))
4696 ;; Now loop. Round what? (ACM, 2006/7/5). We already got the first match.
4700 (< cfd-match-pos cfd-limit)
4703 ;; Kludge to filter out matches on the "<" that
4704 ;; aren't open parens, for the sake of languages
4705 ;; that got `c-recognize-<>-arglists' set.
4706 (and (eq (char-before cfd-match-pos) ?<)
4707 (not (c-get-char-property (1- cfd-match-pos)
4710 ;; If `cfd-continue-pos' is less or equal to
4711 ;; `cfd-token-pos', we've got a hit inside a macro
4712 ;; that's in the syntactic whitespace before the last
4713 ;; "real" declaration we've checked. If they're equal
4714 ;; we've arrived at the declaration a second time, so
4715 ;; there's nothing to do.
4716 (= cfd-continue-pos cfd-token-pos)
4719 ;; If `cfd-continue-pos' is less than `cfd-token-pos'
4720 ;; we're still searching for declarations embedded in
4721 ;; the syntactic whitespace. In that case we need
4722 ;; only to skip comments and not macros, since they
4723 ;; can't be nested, and that's already been done in
4724 ;; `c-find-decl-prefix-search'.
4725 (when (> cfd-continue-pos cfd-token-pos)
4726 (c-forward-syntactic-ws)
4727 (setq cfd-token-pos (point)))
4729 ;; Continue if the following token fails the
4730 ;; CFD-DECL-RE and CFD-FACE-CHECKLIST checks.
4731 (when (or (>= (point) cfd-limit)
4732 (not (looking-at cfd-decl-re))
4733 (and cfd-face-checklist
4735 (point) cfd-face-checklist))))
4736 (goto-char cfd-continue-pos)
4739 (< (point) cfd-limit))
4740 (c-find-decl-prefix-search))
4742 (< (point) cfd-limit))
4745 (>= (point) cfd-start-pos)
4748 ;; Narrow to the end of the macro if we got a hit inside
4749 ;; one, to avoid recognizing things that start inside the
4750 ;; macro and end outside it.
4751 (when (> cfd-match-pos cfd-macro-end)
4752 ;; Not in the same macro as in the previous round.
4754 (goto-char cfd-match-pos)
4756 (if (save-excursion (and (c-beginning-of-macro)
4757 (< (point) cfd-match-pos)))
4758 (progn (c-end-of-macro)
4762 (if (zerop cfd-macro-end)
4764 (if (> cfd-macro-end (point))
4765 (progn (narrow-to-region (point-min) cfd-macro-end)
4767 ;; The matched token was the last thing in the macro,
4768 ;; so the whole match is bogus.
4769 (setq cfd-macro-end 0)
4772 (c-debug-put-decl-spot-faces cfd-match-pos (point))
4773 (if (funcall cfd-fun cfd-match-pos (/= cfd-macro-end 0))
4774 (setq cfd-prop-match nil))
4776 (when (/= cfd-macro-end 0)
4777 ;; Restore limits if we did macro narrowment above.
4778 (narrow-to-region (point-min) cfd-buffer-end)))
4780 (goto-char cfd-continue-pos)
4781 (if (= cfd-continue-pos cfd-limit)
4782 (setq cfd-match-pos cfd-limit)
4783 (c-find-decl-prefix-search)))))
4786 ;; A cache for found types.
4788 ;; Buffer local variable that contains an obarray with the types we've
4789 ;; found. If a declaration is recognized somewhere we record the
4790 ;; fully qualified identifier in it to recognize it as a type
4791 ;; elsewhere in the file too. This is not accurate since we do not
4792 ;; bother with the scoping rules of the languages, but in practice the
4793 ;; same name is seldom used as both a type and something else in a
4794 ;; file, and we only use this as a last resort in ambiguous cases (see
4795 ;; `c-forward-decl-or-cast-1').
4797 ;; Not every type need be in this cache. However, things which have
4798 ;; ceased to be types must be removed from it.
4800 ;; Template types in C++ are added here too but with the template
4801 ;; arglist replaced with "<>" in references or "<" for the one in the
4802 ;; primary type. E.g. the type "Foo<A,B>::Bar<C>" is stored as
4803 ;; "Foo<>::Bar<". This avoids storing very long strings (since C++
4804 ;; template specs can be fairly sized programs in themselves) and
4805 ;; improves the hit ratio (it's a type regardless of the template
4806 ;; args; it's just not the same type, but we're only interested in
4807 ;; recognizing types, not telling distinct types apart). Note that
4808 ;; template types in references are added here too; from the example
4809 ;; above there will also be an entry "Foo<".
4810 (defvar c-found-types nil)
4811 (make-variable-buffer-local 'c-found-types)
4813 (defsubst c-clear-found-types ()
4814 ;; Clears `c-found-types'.
4815 (setq c-found-types (make-vector 53 0)))
4817 (defun c-add-type (from to)
4818 ;; Add the given region as a type in `c-found-types'. If the region
4819 ;; doesn't match an existing type but there is a type which is equal
4820 ;; to the given one except that the last character is missing, then
4821 ;; the shorter type is removed. That's done to avoid adding all
4822 ;; prefixes of a type as it's being entered and font locked. This
4823 ;; doesn't cover cases like when characters are removed from a type
4824 ;; or added in the middle. We'd need the position of point when the
4825 ;; font locking is invoked to solve this well.
4827 ;; This function might do hidden buffer changes.
4828 (let ((type (c-syntactic-content from to c-recognize-<>-arglists)))
4829 (unless (intern-soft type c-found-types)
4830 (unintern (substring type 0 -1) c-found-types)
4831 (intern type c-found-types))))
4833 (defun c-unfind-type (name)
4834 ;; Remove the "NAME" from c-found-types, if present.
4835 (unintern name c-found-types))
4837 (defsubst c-check-type (from to)
4838 ;; Return non-nil if the given region contains a type in
4841 ;; This function might do hidden buffer changes.
4842 (intern-soft (c-syntactic-content from to c-recognize-<>-arglists)
4845 (defun c-list-found-types ()
4846 ;; Return all the types in `c-found-types' as a sorted list of
4849 (mapatoms (lambda (type)
4850 (setq type-list (cons (symbol-name type)
4853 (sort type-list 'string-lessp)))
4855 ;; Shut up the byte compiler.
4856 (defvar c-maybe-stale-found-type)
4858 (defun c-trim-found-types (beg end old-len)
4859 ;; An after change function which, in conjunction with the info in
4860 ;; c-maybe-stale-found-type (set in c-before-change), removes a type
4861 ;; from `c-found-types', should this type have become stale. For
4862 ;; example, this happens to "foo" when "foo \n bar();" becomes
4863 ;; "foo(); \n bar();". Such stale types, if not removed, foul up
4864 ;; the fontification.
4866 ;; Have we, perhaps, added non-ws characters to the front/back of a found
4870 (when (< end (point-max))
4872 (if (and (c-beginning-of-current-token) ; only moves when we started in the middle
4873 (progn (goto-char end)
4874 (c-end-of-current-token)))
4875 (c-unfind-type (buffer-substring-no-properties
4877 (when (> beg (point-min))
4879 (if (and (c-end-of-current-token) ; only moves when we started in the middle
4880 (progn (goto-char beg)
4881 (c-beginning-of-current-token)))
4882 (c-unfind-type (buffer-substring-no-properties
4885 (if c-maybe-stale-found-type ; e.g. (c-decl-id-start "foo" 97 107 " (* ooka) " "o")
4887 ;; Changing the amount of (already existing) whitespace - don't do anything.
4888 ((and (c-partial-ws-p beg end)
4889 (or (= beg end) ; removal of WS
4890 (string-match "^[ \t\n\r\f\v]*$" (nth 5 c-maybe-stale-found-type)))))
4892 ;; The syntactic relationship which defined a "found type" has been
4894 ((eq (car c-maybe-stale-found-type) 'c-decl-id-start)
4895 (c-unfind-type (cadr c-maybe-stale-found-type)))
4896 ;; ((eq (car c-maybe-stale-found-type) 'c-decl-type-start) FIXME!!!
4900 ;; Setting and removing syntax properties on < and > in languages (C++
4901 ;; and Java) where they can be template/generic delimiters as well as
4902 ;; their normal meaning of "less/greater than".
4904 ;; Normally, < and > have syntax 'punctuation'. When they are found to
4905 ;; be delimiters, they are marked as such with the category properties
4906 ;; c-<-as-paren-syntax, c->-as-paren-syntax respectively.
4910 ;; It is impossible to determine with certainty whether a <..> pair in
4911 ;; C++ is two comparison operators or is template delimiters, unless
4912 ;; one duplicates a lot of a C++ compiler. For example, the following
4915 ;; foo (a < b, c > d) ;
4917 ;; could be a function call with two integer parameters (each a
4918 ;; relational expression), or it could be a constructor for class foo
4919 ;; taking one parameter d of templated type "a < b, c >". They are
4920 ;; somewhat easier to distinguish in Java.
4922 ;; The strategy now (2010-01) adopted is to mark and unmark < and
4923 ;; > IN MATCHING PAIRS ONLY. [Previously, they were marked
4924 ;; individually when their context so indicated. This gave rise to
4925 ;; intractible problems when one of a matching pair was deleted, or
4926 ;; pulled into a literal.]
4928 ;; At each buffer change, the syntax-table properties are removed in a
4929 ;; before-change function and reapplied, when needed, in an
4930 ;; after-change function. It is far more important that the
4931 ;; properties get removed when they they are spurious than that they
4932 ;; be present when wanted.
4933 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4934 (defun c-clear-<-pair-props (&optional pos)
4935 ;; POS (default point) is at a < character. If it is marked with
4936 ;; open paren syntax-table text property, remove the property,
4937 ;; together with the close paren property on the matching > (if
4943 (when (equal (c-get-char-property (point) 'syntax-table)
4944 c-<-as-paren-syntax)
4945 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
4946 (c-go-list-forward))
4947 (when (equal (c-get-char-property (1- (point)) 'syntax-table)
4948 c->-as-paren-syntax) ; should always be true.
4949 (c-clear-char-property (1- (point)) 'category))
4950 (c-clear-char-property pos 'category))))
4952 (defun c-clear->-pair-props (&optional pos)
4953 ;; POS (default point) is at a > character. If it is marked with
4954 ;; close paren syntax-table property, remove the property, together
4955 ;; with the open paren property on the matching < (if any).
4960 (when (equal (c-get-char-property (point) 'syntax-table)
4961 c->-as-paren-syntax)
4962 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
4963 (c-go-up-list-backward))
4964 (when (equal (c-get-char-property (point) 'syntax-table)
4965 c-<-as-paren-syntax) ; should always be true.
4966 (c-clear-char-property (point) 'category))
4967 (c-clear-char-property pos 'category))))
4969 (defun c-clear-<>-pair-props (&optional pos)
4970 ;; POS (default point) is at a < or > character. If it has an
4971 ;; open/close paren syntax-table property, remove this property both
4972 ;; from the current character and its partner (which will also be
4975 ((eq (char-after) ?\<)
4976 (c-clear-<-pair-props pos))
4977 ((eq (char-after) ?\>)
4978 (c-clear->-pair-props pos))
4980 "c-clear-<>-pair-props called from wrong position"))))
4982 (defun c-clear-<-pair-props-if-match-after (lim &optional pos)
4983 ;; POS (default point) is at a < character. If it is both marked
4984 ;; with open/close paren syntax-table property, and has a matching >
4985 ;; (also marked) which is after LIM, remove the property both from
4986 ;; the current > and its partner. Return t when this happens, nil
4992 (when (equal (c-get-char-property (point) 'syntax-table)
4993 c-<-as-paren-syntax)
4994 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
4995 (c-go-list-forward))
4996 (when (and (>= (point) lim)
4997 (equal (c-get-char-property (1- (point)) 'syntax-table)
4998 c->-as-paren-syntax)) ; should always be true.
4999 (c-unmark-<->-as-paren (1- (point)))
5000 (c-unmark-<->-as-paren pos))
5003 (defun c-clear->-pair-props-if-match-before (lim &optional pos)
5004 ;; POS (default point) is at a > character. If it is both marked
5005 ;; with open/close paren syntax-table property, and has a matching <
5006 ;; (also marked) which is before LIM, remove the property both from
5007 ;; the current < and its partner. Return t when this happens, nil
5013 (when (equal (c-get-char-property (point) 'syntax-table)
5014 c->-as-paren-syntax)
5015 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5016 (c-go-up-list-backward))
5017 (when (and (<= (point) lim)
5018 (equal (c-get-char-property (point) 'syntax-table)
5019 c-<-as-paren-syntax)) ; should always be true.
5020 (c-unmark-<->-as-paren (point))
5021 (c-unmark-<->-as-paren pos))
5024 ;; Set by c-common-init in cc-mode.el.
5028 (defun c-before-change-check-<>-operators (beg end)
5029 ;; Unmark certain pairs of "< .... >" which are currently marked as
5030 ;; template/generic delimiters. (This marking is via syntax-table
5031 ;; text properties).
5033 ;; These pairs are those which are in the current "statement" (i.e.,
5034 ;; the region between the {, }, or ; before BEG and the one after
5035 ;; END), and which enclose any part of the interval (BEG END).
5037 ;; Note that in C++ (?and Java), template/generic parens cannot
5038 ;; enclose a brace or semicolon, so we use these as bounds on the
5039 ;; region we must work on.
5041 ;; This function is called from before-change-functions (via
5042 ;; c-get-state-before-change-functions). Thus the buffer is widened,
5043 ;; and point is undefined, both at entry and exit.
5045 ;; FIXME!!! This routine ignores the possibility of macros entirely.
5048 (let ((beg-lit-limits (progn (goto-char beg) (c-literal-limits)))
5049 (end-lit-limits (progn (goto-char end) (c-literal-limits)))
5050 new-beg new-end need-new-beg need-new-end)
5051 ;; Locate the barrier before the changed region
5052 (goto-char (if beg-lit-limits (car beg-lit-limits) beg))
5053 (c-syntactic-skip-backward "^;{}" (max (- beg 2048) (point-min)))
5054 (setq new-beg (point))
5056 ;; Remove the syntax-table properties from each pertinent <...> pair.
5057 ;; Firsly, the ones with the < before beg and > after beg.
5058 (while (c-search-forward-char-property 'category 'c-<-as-paren-syntax beg)
5059 (if (c-clear-<-pair-props-if-match-after beg (1- (point)))
5060 (setq need-new-beg t)))
5062 ;; Locate the barrier after END.
5063 (goto-char (if end-lit-limits (cdr end-lit-limits) end))
5064 (c-syntactic-re-search-forward "[;{}]"
5065 (min (+ end 2048) (point-max)) 'end)
5066 (setq new-end (point))
5068 ;; Remove syntax-table properties from the remaining pertinent <...>
5069 ;; pairs, those with a > after end and < before end.
5070 (while (c-search-backward-char-property 'category 'c->-as-paren-syntax end)
5071 (if (c-clear->-pair-props-if-match-before end)
5072 (setq need-new-end t)))
5074 ;; Extend the fontification region, if needed.
5077 (c-forward-syntactic-ws)
5078 (and (< (point) c-new-BEG) (setq c-new-BEG (point))))
5081 (and (> new-end c-new-END) (setq c-new-END new-end))))))
5085 (defun c-after-change-check-<>-operators (beg end)
5086 ;; This is called from `after-change-functions' when
5087 ;; c-recognize-<>-arglists' is set. It ensures that no "<" or ">"
5088 ;; chars with paren syntax become part of another operator like "<<"
5091 ;; This function might do hidden buffer changes.
5095 (when (or (looking-at "[<>]")
5096 (< (skip-chars-backward "<>") 0))
5099 (c-beginning-of-current-token)
5100 (when (and (< (point) beg)
5101 (looking-at c-<>-multichar-token-regexp)
5102 (< beg (setq beg (match-end 0))))
5103 (while (progn (skip-chars-forward "^<>" beg)
5105 (c-clear-<>-pair-props)
5110 (when (or (looking-at "[<>]")
5111 (< (skip-chars-backward "<>") 0))
5114 (c-beginning-of-current-token)
5115 (when (and (< (point) end)
5116 (looking-at c-<>-multichar-token-regexp)
5117 (< end (setq end (match-end 0))))
5118 (while (progn (skip-chars-forward "^<>" end)
5120 (c-clear-<>-pair-props)
5121 (forward-char)))))))
5125 ;; Handling of small scale constructs like types and names.
5127 ;; Dynamically bound variable that instructs `c-forward-type' to also
5128 ;; treat possible types (i.e. those that it normally returns 'maybe or
5129 ;; 'found for) as actual types (and always return 'found for them).
5130 ;; This means that it records them in `c-record-type-identifiers' if
5131 ;; that is set, and that it adds them to `c-found-types'.
5132 (defvar c-promote-possible-types nil)
5134 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5135 ;; mark up successfully parsed arglists with paren syntax properties on
5136 ;; the surrounding angle brackets and with `c-<>-arg-sep' in the
5137 ;; `c-type' property of each argument separating comma.
5139 ;; Setting this variable also makes `c-forward-<>-arglist' recurse into
5140 ;; all arglists for side effects (i.e. recording types), otherwise it
5141 ;; exploits any existing paren syntax properties to quickly jump to the
5142 ;; end of already parsed arglists.
5144 ;; Marking up the arglists is not the default since doing that correctly
5145 ;; depends on a proper value for `c-restricted-<>-arglists'.
5146 (defvar c-parse-and-markup-<>-arglists nil)
5148 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5149 ;; not accept arglists that contain binary operators.
5151 ;; This is primarily used to handle C++ template arglists. C++
5152 ;; disambiguates them by checking whether the preceding name is a
5153 ;; template or not. We can't do that, so we assume it is a template
5154 ;; if it can be parsed as one. That usually works well since
5155 ;; comparison expressions on the forms "a < b > c" or "a < b, c > d"
5156 ;; in almost all cases would be pointless.
5158 ;; However, in function arglists, e.g. in "foo (a < b, c > d)", we
5159 ;; should let the comma separate the function arguments instead. And
5160 ;; in a context where the value of the expression is taken, e.g. in
5161 ;; "if (a < b || c > d)", it's probably not a template.
5162 (defvar c-restricted-<>-arglists nil)
5164 ;; Dynamically bound variables that instructs
5165 ;; `c-forward-keyword-clause', `c-forward-<>-arglist',
5166 ;; `c-forward-name', `c-forward-type', `c-forward-decl-or-cast-1', and
5167 ;; `c-forward-label' to record the ranges of all the type and
5168 ;; reference identifiers they encounter. They will build lists on
5169 ;; these variables where each element is a cons of the buffer
5170 ;; positions surrounding each identifier. This recording is only
5171 ;; activated when `c-record-type-identifiers' is non-nil.
5173 ;; All known types that can't be identifiers are recorded, and also
5174 ;; other possible types if `c-promote-possible-types' is set.
5175 ;; Recording is however disabled inside angle bracket arglists that
5176 ;; are encountered inside names and other angle bracket arglists.
5177 ;; Such occurrences are taken care of by `c-font-lock-<>-arglists'
5180 ;; Only the names in C++ template style references (e.g. "tmpl" in
5181 ;; "tmpl<a,b>::foo") are recorded as references, other references
5182 ;; aren't handled here.
5184 ;; `c-forward-label' records the label identifier(s) on
5185 ;; `c-record-ref-identifiers'.
5186 (defvar c-record-type-identifiers nil)
5187 (defvar c-record-ref-identifiers nil)
5189 ;; This variable will receive a cons cell of the range of the last
5190 ;; single identifier symbol stepped over by `c-forward-name' if it's
5191 ;; successful. This is the range that should be put on one of the
5192 ;; record lists above by the caller. It's assigned nil if there's no
5193 ;; such symbol in the name.
5194 (defvar c-last-identifier-range nil)
5196 (defmacro c-record-type-id (range)
5197 (if (eq (car-safe range) 'cons)
5199 `(setq c-record-type-identifiers
5200 (cons ,range c-record-type-identifiers))
5201 `(let ((range ,range))
5203 (setq c-record-type-identifiers
5204 (cons range c-record-type-identifiers))))))
5206 (defmacro c-record-ref-id (range)
5207 (if (eq (car-safe range) 'cons)
5209 `(setq c-record-ref-identifiers
5210 (cons ,range c-record-ref-identifiers))
5211 `(let ((range ,range))
5213 (setq c-record-ref-identifiers
5214 (cons range c-record-ref-identifiers))))))
5216 ;; Dynamically bound variable that instructs `c-forward-type' to
5217 ;; record the ranges of types that only are found. Behaves otherwise
5218 ;; like `c-record-type-identifiers'.
5219 (defvar c-record-found-types nil)
5221 (defmacro c-forward-keyword-prefixed-id (type)
5222 ;; Used internally in `c-forward-keyword-clause' to move forward
5223 ;; over a type (if TYPE is 'type) or a name (otherwise) which
5224 ;; possibly is prefixed by keywords and their associated clauses.
5225 ;; Try with a type/name first to not trip up on those that begin
5226 ;; with a keyword. Return t if a known or found type is moved
5227 ;; over. The point is clobbered if nil is returned. If range
5228 ;; recording is enabled, the identifier is recorded on as a type
5229 ;; if TYPE is 'type or as a reference if TYPE is 'ref.
5231 ;; This macro might do hidden buffer changes.
5233 (while (if (setq res ,(if (eq type 'type)
5237 (and (looking-at c-keywords-regexp)
5238 (c-forward-keyword-clause 1))))
5239 (when (memq res '(t known found prefix))
5240 ,(when (eq type 'ref)
5241 `(when c-record-type-identifiers
5242 (c-record-ref-id c-last-identifier-range)))
5245 (defmacro c-forward-id-comma-list (type update-safe-pos)
5246 ;; Used internally in `c-forward-keyword-clause' to move forward
5247 ;; over a comma separated list of types or names using
5248 ;; `c-forward-keyword-prefixed-id'.
5250 ;; This macro might do hidden buffer changes.
5252 ,(when update-safe-pos
5253 `(setq safe-pos (point)))
5254 (eq (char-after) ?,))
5257 (c-forward-syntactic-ws)
5258 (c-forward-keyword-prefixed-id ,type)))))
5260 (defun c-forward-keyword-clause (match)
5261 ;; Submatch MATCH in the current match data is assumed to surround a
5262 ;; token. If it's a keyword, move over it and any immediately
5263 ;; following clauses associated with it, stopping at the start of
5264 ;; the next token. t is returned in that case, otherwise the point
5265 ;; stays and nil is returned. The kind of clauses that are
5266 ;; recognized are those specified by `c-type-list-kwds',
5267 ;; `c-ref-list-kwds', `c-colon-type-list-kwds',
5268 ;; `c-paren-nontype-kwds', `c-paren-type-kwds', `c-<>-type-kwds',
5269 ;; and `c-<>-arglist-kwds'.
5271 ;; This function records identifier ranges on
5272 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5273 ;; `c-record-type-identifiers' is non-nil.
5275 ;; Note that for `c-colon-type-list-kwds', which doesn't necessary
5276 ;; apply directly after the keyword, the type list is moved over
5277 ;; only when there is no unaccounted token before it (i.e. a token
5278 ;; that isn't moved over due to some other keyword list). The
5279 ;; identifier ranges in the list are still recorded if that should
5282 ;; This function might do hidden buffer changes.
5284 (let ((kwd-sym (c-keyword-sym (match-string match))) safe-pos pos
5285 ;; The call to `c-forward-<>-arglist' below is made after
5286 ;; `c-<>-sexp-kwds' keywords, so we're certain they actually
5287 ;; are angle bracket arglists and `c-restricted-<>-arglists'
5288 ;; should therefore be nil.
5289 (c-parse-and-markup-<>-arglists t)
5290 c-restricted-<>-arglists)
5293 (goto-char (match-end match))
5294 (c-forward-syntactic-ws)
5295 (setq safe-pos (point))
5298 ((and (c-keyword-member kwd-sym 'c-type-list-kwds)
5299 (c-forward-keyword-prefixed-id type))
5300 ;; There's a type directly after a keyword in `c-type-list-kwds'.
5301 (c-forward-id-comma-list type t))
5303 ((and (c-keyword-member kwd-sym 'c-ref-list-kwds)
5304 (c-forward-keyword-prefixed-id ref))
5305 ;; There's a name directly after a keyword in `c-ref-list-kwds'.
5306 (c-forward-id-comma-list ref t))
5308 ((and (c-keyword-member kwd-sym 'c-paren-any-kwds)
5309 (eq (char-after) ?\())
5310 ;; There's an open paren after a keyword in `c-paren-any-kwds'.
5313 (when (and (setq pos (c-up-list-forward))
5314 (eq (char-before pos) ?\)))
5315 (when (and c-record-type-identifiers
5316 (c-keyword-member kwd-sym 'c-paren-type-kwds))
5317 ;; Use `c-forward-type' on every identifier we can find
5318 ;; inside the paren, to record the types.
5319 (while (c-syntactic-re-search-forward c-symbol-start pos t)
5320 (goto-char (match-beginning 0))
5321 (unless (c-forward-type)
5322 (looking-at c-symbol-key) ; Always matches.
5323 (goto-char (match-end 0)))))
5326 (c-forward-syntactic-ws)
5327 (setq safe-pos (point))))
5329 ((and (c-keyword-member kwd-sym 'c-<>-sexp-kwds)
5330 (eq (char-after) ?<)
5331 (c-forward-<>-arglist (c-keyword-member kwd-sym 'c-<>-type-kwds)))
5332 (c-forward-syntactic-ws)
5333 (setq safe-pos (point)))
5335 ((and (c-keyword-member kwd-sym 'c-nonsymbol-sexp-kwds)
5336 (not (looking-at c-symbol-start))
5337 (c-safe (c-forward-sexp) t))
5338 (c-forward-syntactic-ws)
5339 (setq safe-pos (point))))
5341 (when (c-keyword-member kwd-sym 'c-colon-type-list-kwds)
5342 (if (eq (char-after) ?:)
5343 ;; If we are at the colon already, we move over the type
5347 (c-forward-syntactic-ws)
5348 (when (c-forward-keyword-prefixed-id type)
5349 (c-forward-id-comma-list type t)))
5350 ;; Not at the colon, so stop here. But the identifier
5351 ;; ranges in the type list later on should still be
5353 (and c-record-type-identifiers
5355 ;; If a keyword matched both one of the types above and
5356 ;; this one, we match `c-colon-type-list-re' after the
5357 ;; clause matched above.
5358 (goto-char safe-pos)
5359 (looking-at c-colon-type-list-re))
5361 (goto-char (match-end 0))
5362 (c-forward-syntactic-ws)
5363 (c-forward-keyword-prefixed-id type))
5364 ;; There's a type after the `c-colon-type-list-re' match
5365 ;; after a keyword in `c-colon-type-list-kwds'.
5366 (c-forward-id-comma-list type nil))))
5368 (goto-char safe-pos)
5371 ;; cc-mode requires cc-fonts.
5372 (declare-function c-fontify-recorded-types-and-refs "cc-fonts" ())
5374 (defun c-forward-<>-arglist (all-types)
5375 ;; The point is assumed to be at a "<". Try to treat it as the open
5376 ;; paren of an angle bracket arglist and move forward to the
5377 ;; corresponding ">". If successful, the point is left after the
5378 ;; ">" and t is returned, otherwise the point isn't moved and nil is
5379 ;; returned. If ALL-TYPES is t then all encountered arguments in
5380 ;; the arglist that might be types are treated as found types.
5382 ;; The variable `c-parse-and-markup-<>-arglists' controls how this
5383 ;; function handles text properties on the angle brackets and argument
5384 ;; separating commas.
5386 ;; `c-restricted-<>-arglists' controls how lenient the template
5387 ;; arglist recognition should be.
5389 ;; This function records identifier ranges on
5390 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5391 ;; `c-record-type-identifiers' is non-nil.
5393 ;; This function might do hidden buffer changes.
5395 (let ((start (point))
5396 ;; If `c-record-type-identifiers' is set then activate
5397 ;; recording of any found types that constitute an argument in
5399 (c-record-found-types (if c-record-type-identifiers t)))
5400 (if (catch 'angle-bracket-arglist-escape
5401 (setq c-record-found-types
5402 (c-forward-<>-arglist-recur all-types)))
5404 (when (consp c-record-found-types)
5405 (setq c-record-type-identifiers
5406 ;; `nconc' doesn't mind that the tail of
5407 ;; `c-record-found-types' is t.
5408 (nconc c-record-found-types c-record-type-identifiers)))
5409 (if (c-major-mode-is 'java-mode) (c-fontify-recorded-types-and-refs))
5415 (defun c-forward-<>-arglist-recur (all-types)
5416 ;; Recursive part of `c-forward-<>-arglist'.
5418 ;; This function might do hidden buffer changes.
5420 (let ((start (point)) res pos tmp
5421 ;; Cover this so that any recorded found type ranges are
5422 ;; automatically lost if it turns out to not be an angle
5423 ;; bracket arglist. It's propagated through the return value
5424 ;; on successful completion.
5425 (c-record-found-types c-record-found-types)
5426 ;; List that collects the positions after the argument
5427 ;; separating ',' in the arglist.
5429 ;; If the '<' has paren open syntax then we've marked it as an angle
5430 ;; bracket arglist before, so skip to the end.
5431 (if (and (not c-parse-and-markup-<>-arglists)
5432 (c-get-char-property (point) 'syntax-table))
5436 (if (and (c-go-up-list-forward)
5437 (eq (char-before) ?>))
5439 ;; Got unmatched paren angle brackets. We don't clear the paren
5440 ;; syntax properties and retry, on the basis that it's very
5441 ;; unlikely that paren angle brackets become operators by code
5442 ;; manipulation. It's far more likely that it doesn't match due
5443 ;; to narrowing or some temporary change.
5449 (unless (looking-at c-<-op-cont-regexp)
5452 (c-forward-syntactic-ws)
5453 (let ((orig-record-found-types c-record-found-types))
5454 (when (or (and c-record-type-identifiers all-types)
5455 (c-major-mode-is 'java-mode))
5456 ;; All encountered identifiers are types, so set the
5457 ;; promote flag and parse the type.
5459 (c-forward-syntactic-ws)
5460 (if (looking-at "\\?")
5462 (when (looking-at c-identifier-start)
5463 (let ((c-promote-possible-types t)
5464 (c-record-found-types t))
5467 (c-forward-syntactic-ws)
5469 (when (or (looking-at "extends")
5470 (looking-at "super"))
5472 (c-forward-syntactic-ws)
5473 (let ((c-promote-possible-types t)
5474 (c-record-found-types t))
5476 (c-forward-syntactic-ws))))))
5480 ;; Note: These regexps exploit the match order in \| so
5481 ;; that "<>" is matched by "<" rather than "[^>:-]>".
5482 (c-syntactic-re-search-forward
5483 ;; Stop on ',', '|', '&', '+' and '-' to catch
5484 ;; common binary operators that could be between
5485 ;; two comparison expressions "a<b" and "c>d".
5486 "[<;{},|+&-]\\|[>)]"
5490 ((eq (char-before) ?>)
5491 ;; Either an operator starting with '>' or the end of
5492 ;; the angle bracket arglist.
5494 (if (looking-at c->-op-cont-regexp)
5496 (goto-char (match-end 0))
5497 t) ; Continue the loop.
5499 ;; The angle bracket arglist is finished.
5500 (when c-parse-and-markup-<>-arglists
5501 (while arg-start-pos
5502 (c-put-c-type-property (1- (car arg-start-pos))
5504 (setq arg-start-pos (cdr arg-start-pos)))
5505 (c-mark-<-as-paren start)
5506 (c-mark->-as-paren (1- (point))))
5508 nil)) ; Exit the loop.
5510 ((eq (char-before) ?<)
5511 ;; Either an operator starting with '<' or a nested arglist.
5513 (let (id-start id-end subres keyword-match)
5514 (if (if (looking-at c-<-op-cont-regexp)
5515 (setq tmp (match-end 0))
5522 ;; There's always an identifier before an angle
5523 ;; bracket arglist, or a keyword in
5524 ;; `c-<>-type-kwds' or `c-<>-arglist-kwds'.
5525 (c-backward-syntactic-ws)
5526 (setq id-end (point))
5527 (c-simple-skip-symbol-backward)
5528 (when (or (setq keyword-match
5529 (looking-at c-opt-<>-sexp-key))
5530 (not (looking-at c-keywords-regexp)))
5531 (setq id-start (point))))
5534 (let ((c-promote-possible-types t)
5535 (c-record-found-types t))
5536 (c-forward-<>-arglist-recur
5539 (c-keyword-sym (match-string 1))
5540 'c-<>-type-kwds)))))
5543 ;; It was not an angle bracket arglist.
5546 ;; It was an angle bracket arglist.
5547 (setq c-record-found-types subres)
5549 ;; Record the identifier before the template as a type
5550 ;; or reference depending on whether the arglist is last
5551 ;; in a qualified identifier.
5552 (when (and c-record-type-identifiers
5553 (not keyword-match))
5554 (if (and c-opt-identifier-concat-key
5556 (c-forward-syntactic-ws)
5557 (looking-at c-opt-identifier-concat-key)))
5558 (c-record-ref-id (cons id-start id-end))
5559 (c-record-type-id (cons id-start id-end))))))
5562 ((and (not c-restricted-<>-arglists)
5563 (or (and (eq (char-before) ?&)
5564 (not (eq (char-after) ?&)))
5565 (eq (char-before) ?,)))
5566 ;; Just another argument. Record the position. The
5567 ;; type check stuff that made us stop at it is at
5568 ;; the top of the loop.
5569 (setq arg-start-pos (cons (point) arg-start-pos)))
5572 ;; Got a character that can't be in an angle bracket
5573 ;; arglist argument. Abort using `throw', since
5574 ;; it's useless to try to find a surrounding arglist
5576 (throw 'angle-bracket-arglist-escape nil))))))
5578 (or c-record-found-types t)))))
5580 (defun c-backward-<>-arglist (all-types &optional limit)
5581 ;; The point is assumed to be directly after a ">". Try to treat it
5582 ;; as the close paren of an angle bracket arglist and move back to
5583 ;; the corresponding "<". If successful, the point is left at
5584 ;; the "<" and t is returned, otherwise the point isn't moved and
5585 ;; nil is returned. ALL-TYPES is passed on to
5586 ;; `c-forward-<>-arglist'.
5588 ;; If the optional LIMIT is given, it bounds the backward search.
5589 ;; It's then assumed to be at a syntactically relevant position.
5591 ;; This is a wrapper around `c-forward-<>-arglist'. See that
5592 ;; function for more details.
5594 (let ((start (point)))
5596 (if (and (not c-parse-and-markup-<>-arglists)
5597 (c-get-char-property (point) 'syntax-table))
5599 (if (and (c-go-up-list-backward)
5600 (eq (char-after) ?<))
5602 ;; See corresponding note in `c-forward-<>-arglist'.
5607 (c-syntactic-skip-backward "^<;{}" limit t)
5610 (if (eq (char-before) ?<)
5612 ;; Stopped at bob or a char that isn't allowed in an
5613 ;; arglist, so we've failed.
5618 (progn (c-beginning-of-current-token)
5620 ;; If we moved then the "<" was part of some
5621 ;; multicharacter token.
5625 (let ((beg-pos (point)))
5626 (if (c-forward-<>-arglist all-types)
5627 (cond ((= (point) start)
5628 ;; Matched the arglist. Break the while.
5632 ;; We started from a non-paren ">" inside an
5637 ;; Matched a shorter arglist. Can be a nested
5638 ;; one so continue looking.
5643 (/= (point) start))))
5645 (defun c-forward-name ()
5646 ;; Move forward over a complete name if at the beginning of one,
5647 ;; stopping at the next following token. A keyword, as such,
5648 ;; doesn't count as a name. If the point is not at something that
5649 ;; is recognized as a name then it stays put.
5651 ;; A name could be something as simple as "foo" in C or something as
5652 ;; complex as "X<Y<class A<int>::B, BIT_MAX >> b>, ::operator<> ::
5653 ;; Z<(a>b)> :: operator const X<&foo>::T Q::G<unsigned short
5654 ;; int>::*volatile const" in C++ (this function is actually little
5655 ;; more than a `looking-at' call in all modes except those that,
5656 ;; like C++, have `c-recognize-<>-arglists' set).
5659 ;; o - nil if no name is found;
5660 ;; o - 'template if it's an identifier ending with an angle bracket
5662 ;; o - 'operator of it's an operator identifier;
5663 ;; o - t if it's some other kind of name.
5665 ;; This function records identifier ranges on
5666 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5667 ;; `c-record-type-identifiers' is non-nil.
5669 ;; This function might do hidden buffer changes.
5671 (let ((pos (point)) (start (point)) res id-start id-end
5672 ;; Turn off `c-promote-possible-types' here since we might
5673 ;; call `c-forward-<>-arglist' and we don't want it to promote
5674 ;; every suspect thing in the arglist to a type. We're
5675 ;; typically called from `c-forward-type' in this case, and
5676 ;; the caller only wants the top level type that it finds to
5678 c-promote-possible-types)
5681 (looking-at c-identifier-key)
5684 ;; Check for keyword. We go to the last symbol in
5685 ;; `c-identifier-key' first.
5686 (goto-char (setq id-end (match-end 0)))
5687 (c-simple-skip-symbol-backward)
5688 (setq id-start (point))
5690 (if (looking-at c-keywords-regexp)
5691 (when (and (c-major-mode-is 'c++-mode)
5693 (cc-eval-when-compile
5694 (concat "\\(operator\\|\\(template\\)\\)"
5695 "\\(" (c-lang-const c-nonsymbol-key c++)
5697 (if (match-beginning 2)
5698 ;; "template" is only valid inside an
5699 ;; identifier if preceded by "::".
5701 (c-backward-syntactic-ws)
5702 (and (c-safe (backward-char 2) t)
5706 ;; Handle a C++ operator or template identifier.
5708 (c-forward-syntactic-ws)
5709 (cond ((eq (char-before id-end) ?e)
5710 ;; Got "... ::template".
5711 (let ((subres (c-forward-name)))
5716 ((looking-at c-identifier-start)
5717 ;; Got a cast operator.
5718 (when (c-forward-type)
5721 ;; Now we should match a sequence of either
5722 ;; '*', '&' or a name followed by ":: *",
5723 ;; where each can be followed by a sequence
5724 ;; of `c-opt-type-modifier-key'.
5725 (while (cond ((looking-at "[*&]")
5726 (goto-char (match-end 0))
5728 ((looking-at c-identifier-start)
5729 (and (c-forward-name)
5732 (goto-char (match-end 0))
5733 (c-forward-syntactic-ws)
5734 (eq (char-after) ?*))
5739 (c-forward-syntactic-ws)
5741 (looking-at c-opt-type-modifier-key))
5742 (goto-char (match-end 1))))))
5744 ((looking-at c-overloadable-operators-regexp)
5745 ;; Got some other operator.
5746 (setq c-last-identifier-range
5747 (cons (point) (match-end 0)))
5748 (goto-char (match-end 0))
5749 (c-forward-syntactic-ws)
5755 ;; `id-start' is equal to `id-end' if we've jumped over
5756 ;; an identifier that doesn't end with a symbol token.
5757 ;; That can occur e.g. for Java import directives on the
5758 ;; form "foo.bar.*".
5759 (when (and id-start (/= id-start id-end))
5760 (setq c-last-identifier-range
5761 (cons id-start id-end)))
5763 (c-forward-syntactic-ws)
5769 (when (or c-opt-identifier-concat-key
5770 c-recognize-<>-arglists)
5773 ((and c-opt-identifier-concat-key
5774 (looking-at c-opt-identifier-concat-key))
5775 ;; Got a concatenated identifier. This handles the
5776 ;; cases with tricky syntactic whitespace that aren't
5777 ;; covered in `c-identifier-key'.
5778 (goto-char (match-end 0))
5779 (c-forward-syntactic-ws)
5782 ((and c-recognize-<>-arglists
5783 (eq (char-after) ?<))
5784 ;; Maybe an angle bracket arglist.
5785 (when (let ((c-record-type-identifiers t)
5786 (c-record-found-types t))
5787 (c-forward-<>-arglist nil))
5789 (c-add-type start (1+ pos))
5790 (c-forward-syntactic-ws)
5792 c-last-identifier-range nil)
5794 (if (and c-opt-identifier-concat-key
5795 (looking-at c-opt-identifier-concat-key))
5797 ;; Continue if there's an identifier concatenation
5798 ;; operator after the template argument.
5800 (when (and c-record-type-identifiers id-start)
5801 (c-record-ref-id (cons id-start id-end)))
5803 (c-forward-syntactic-ws)
5806 (when (and c-record-type-identifiers id-start)
5807 (c-record-type-id (cons id-start id-end)))
5808 (setq res 'template)
5815 (defun c-forward-type (&optional brace-block-too)
5816 ;; Move forward over a type spec if at the beginning of one,
5817 ;; stopping at the next following token. The keyword "typedef"
5818 ;; isn't part of a type spec here.
5820 ;; BRACE-BLOCK-TOO, when non-nil, means move over the brace block in
5821 ;; constructs like "struct foo {...} bar ;" or "struct {...} bar;".
5822 ;; The current (2009-03-10) intention is to convert all uses of
5823 ;; `c-forward-type' to call with this parameter set, then to
5827 ;; o - t if it's a known type that can't be a name or other
5829 ;; o - 'known if it's an otherwise known type (according to
5830 ;; `*-font-lock-extra-types');
5831 ;; o - 'prefix if it's a known prefix of a type;
5832 ;; o - 'found if it's a type that matches one in `c-found-types';
5833 ;; o - 'maybe if it's an identfier that might be a type; or
5834 ;; o - nil if it can't be a type (the point isn't moved then).
5836 ;; The point is assumed to be at the beginning of a token.
5838 ;; Note that this function doesn't skip past the brace definition
5839 ;; that might be considered part of the type, e.g.
5840 ;; "enum {a, b, c} foo".
5842 ;; This function records identifier ranges on
5843 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5844 ;; `c-record-type-identifiers' is non-nil.
5846 ;; This function might do hidden buffer changes.
5847 (when (and c-recognize-<>-arglists
5849 (c-forward-<>-arglist t)
5850 (c-forward-syntactic-ws))
5852 (let ((start (point)) pos res name-res id-start id-end id-range)
5854 ;; Skip leading type modifiers. If any are found we know it's a
5855 ;; prefix of a type.
5856 (when c-opt-type-modifier-key ; e.g. "const" "volatile", but NOT "typedef"
5857 (while (looking-at c-opt-type-modifier-key)
5858 (goto-char (match-end 1))
5859 (c-forward-syntactic-ws)
5860 (setq res 'prefix)))
5863 ((looking-at c-type-prefix-key) ; e.g. "struct", "class", but NOT
5865 (goto-char (match-end 1))
5866 (c-forward-syntactic-ws)
5869 (setq name-res (c-forward-name))
5870 (setq res (not (null name-res)))
5871 (when (eq name-res t)
5872 ;; In many languages the name can be used without the
5873 ;; prefix, so we add it to `c-found-types'.
5874 (c-add-type pos (point))
5875 (when (and c-record-type-identifiers
5876 c-last-identifier-range)
5877 (c-record-type-id c-last-identifier-range)))
5878 (when (and brace-block-too
5880 (eq (char-after) ?\{)
5883 (progn (c-forward-sexp)
5884 (c-forward-syntactic-ws)
5885 (setq pos (point))))))
5888 (unless res (goto-char start))) ; invalid syntax
5892 (if (looking-at c-identifier-start)
5894 (setq id-start (point)
5895 name-res (c-forward-name))
5897 (setq id-end (point)
5898 id-range c-last-identifier-range))))
5899 (and (cond ((looking-at c-primitive-type-key)
5901 ((c-with-syntax-table c-identifier-syntax-table
5902 (looking-at c-known-type-key))
5907 (goto-char (match-end 1))
5908 (c-forward-syntactic-ws)
5909 (setq pos (point))))
5912 ;; Looking at a primitive or known type identifier. We've
5913 ;; checked for a name first so that we don't go here if the
5914 ;; known type match only is a prefix of another name.
5916 (setq id-end (match-end 1))
5918 (when (and c-record-type-identifiers
5919 (or c-promote-possible-types (eq res t)))
5920 (c-record-type-id (cons (match-beginning 1) (match-end 1))))
5922 (if (and c-opt-type-component-key
5924 (looking-at c-opt-type-component-key)))
5925 ;; There might be more keywords for the type.
5927 (c-forward-keyword-clause 1)
5929 (setq safe-pos (point))
5930 (looking-at c-opt-type-component-key))
5931 (when (and c-record-type-identifiers
5932 (looking-at c-primitive-type-key))
5933 (c-record-type-id (cons (match-beginning 1)
5935 (c-forward-keyword-clause 1))
5936 (if (looking-at c-primitive-type-key)
5938 (when c-record-type-identifiers
5939 (c-record-type-id (cons (match-beginning 1)
5941 (c-forward-keyword-clause 1)
5943 (goto-char safe-pos)
5944 (setq res 'prefix)))
5945 (unless (save-match-data (c-forward-keyword-clause 1))
5948 (goto-char (match-end 1))
5949 (c-forward-syntactic-ws)))))
5952 (cond ((eq name-res t)
5953 ;; A normal identifier.
5955 (if (or res c-promote-possible-types)
5957 (c-add-type id-start id-end)
5958 (when (and c-record-type-identifiers id-range)
5959 (c-record-type-id id-range))
5962 (setq res (if (c-check-type id-start id-end)
5963 ;; It's an identifier that has been used as
5964 ;; a type somewhere else.
5966 ;; It's an identifier that might be a type.
5968 ((eq name-res 'template)
5969 ;; A template is a type.
5973 ;; Otherwise it's an operator identifier, which is not a type.
5978 ;; Skip trailing type modifiers. If any are found we know it's
5980 (when c-opt-type-modifier-key
5981 (while (looking-at c-opt-type-modifier-key) ; e.g. "const", "volatile"
5982 (goto-char (match-end 1))
5983 (c-forward-syntactic-ws)
5985 ;; Step over any type suffix operator. Do not let the existence
5986 ;; of these alter the classification of the found type, since
5987 ;; these operators typically are allowed in normal expressions
5989 (when c-opt-type-suffix-key
5990 (while (looking-at c-opt-type-suffix-key)
5991 (goto-char (match-end 1))
5992 (c-forward-syntactic-ws)))
5994 (when c-opt-type-concat-key ; Only/mainly for pike.
5995 ;; Look for a trailing operator that concatenates the type
5996 ;; with a following one, and if so step past that one through
5997 ;; a recursive call. Note that we don't record concatenated
5998 ;; types in `c-found-types' - it's the component types that
5999 ;; are recorded when appropriate.
6001 (let* ((c-promote-possible-types (or (memq res '(t known))
6002 c-promote-possible-types))
6003 ;; If we can't promote then set `c-record-found-types' so that
6004 ;; we can merge in the types from the second part afterwards if
6005 ;; it turns out to be a known type there.
6006 (c-record-found-types (and c-record-type-identifiers
6007 (not c-promote-possible-types)))
6009 (if (and (looking-at c-opt-type-concat-key)
6012 (goto-char (match-end 1))
6013 (c-forward-syntactic-ws)
6014 (setq subres (c-forward-type))))
6017 ;; If either operand certainly is a type then both are, but we
6018 ;; don't let the existence of the operator itself promote two
6019 ;; uncertain types to a certain one.
6022 (unless (eq name-res 'template)
6023 (c-add-type id-start id-end))
6024 (when (and c-record-type-identifiers id-range)
6025 (c-record-type-id id-range))
6036 (when (and (eq res t)
6037 (consp c-record-found-types))
6038 ;; Merge in the ranges of any types found by the second
6039 ;; `c-forward-type'.
6040 (setq c-record-type-identifiers
6041 ;; `nconc' doesn't mind that the tail of
6042 ;; `c-record-found-types' is t.
6043 (nconc c-record-found-types
6044 c-record-type-identifiers))))
6048 (when (and c-record-found-types (memq res '(known found)) id-range)
6049 (setq c-record-found-types
6050 (cons id-range c-record-found-types))))
6052 ;;(message "c-forward-type %s -> %s: %s" start (point) res)
6056 (defun c-forward-annotation ()
6057 ;; Used for Java code only at the moment. Assumes point is on the
6058 ;; @, moves forward an annotation. returns nil if there is no
6059 ;; annotation at point.
6060 (and (looking-at "@")
6061 (progn (forward-char) t)
6063 (progn (c-forward-syntactic-ws) t)
6064 (if (looking-at "(")
6069 ;; Handling of large scale constructs like statements and declarations.
6071 ;; Macro used inside `c-forward-decl-or-cast-1'. It ought to be a
6072 ;; defsubst or perhaps even a defun, but it contains lots of free
6073 ;; variables that refer to things inside `c-forward-decl-or-cast-1'.
6074 (defmacro c-fdoc-shift-type-backward (&optional short)
6075 ;; `c-forward-decl-or-cast-1' can consume an arbitrary length list
6076 ;; of types when parsing a declaration, which means that it
6077 ;; sometimes consumes the identifier in the declaration as a type.
6078 ;; This is used to "backtrack" and make the last type be treated as
6079 ;; an identifier instead.
6082 ;; These identifiers are bound only in the inner let.
6083 '(setq identifier-type at-type
6084 identifier-start type-start
6088 got-suffix-after-parens id-start
6091 (if (setq at-type (if (eq backup-at-type 'prefix)
6094 (setq type-start backup-type-start
6095 id-start backup-id-start)
6096 (setq type-start start-pos
6097 id-start start-pos))
6099 ;; When these flags already are set we've found specifiers that
6100 ;; unconditionally signal these attributes - backtracking doesn't
6101 ;; change that. So keep them set in that case.
6103 (setq at-type-decl backup-at-type-decl))
6105 (setq maybe-typeless backup-maybe-typeless))
6108 ;; This identifier is bound only in the inner let.
6109 '(setq start id-start))))
6111 (defun c-forward-decl-or-cast-1 (preceding-token-end context last-cast-end)
6112 ;; Move forward over a declaration or a cast if at the start of one.
6113 ;; The point is assumed to be at the start of some token. Nil is
6114 ;; returned if no declaration or cast is recognized, and the point
6115 ;; is clobbered in that case.
6117 ;; If a declaration is parsed:
6119 ;; The point is left at the first token after the first complete
6120 ;; declarator, if there is one. The return value is a cons where
6121 ;; the car is the position of the first token in the declarator. (See
6122 ;; below for the cdr.)
6125 ;; void foo (int a, char *b) stuff ...
6129 ;; unsigned int a = c_style_initializer, b;
6131 ;; unsigned int a (cplusplus_style_initializer), b;
6132 ;; car ^ ^ point (might change)
6133 ;; class Foo : public Bar {}
6135 ;; class PikeClass (int a, string b) stuff ...
6141 ;; void cplusplus_function (int x) throw (Bad);
6143 ;; Foo::Foo (int b) : Base (b) {}
6146 ;; The cdr of the return value is non-nil when a
6147 ;; `c-typedef-decl-kwds' specifier is found in the declaration.
6148 ;; Specifically it is a dotted pair (A . B) where B is t when a
6149 ;; `c-typedef-kwds' ("typedef") is present, and A is t when some
6150 ;; other `c-typedef-decl-kwds' (e.g. class, struct, enum)
6151 ;; specifier is present. I.e., (some of) the declared
6152 ;; identifier(s) are types.
6154 ;; If a cast is parsed:
6156 ;; The point is left at the first token after the closing paren of
6157 ;; the cast. The return value is `cast'. Note that the start
6158 ;; position must be at the first token inside the cast parenthesis
6161 ;; PRECEDING-TOKEN-END is the first position after the preceding
6162 ;; token, i.e. on the other side of the syntactic ws from the point.
6163 ;; Use a value less than or equal to (point-min) if the point is at
6164 ;; the first token in (the visible part of) the buffer.
6166 ;; CONTEXT is a symbol that describes the context at the point:
6167 ;; 'decl In a comma-separated declaration context (typically
6168 ;; inside a function declaration arglist).
6169 ;; '<> In an angle bracket arglist.
6170 ;; 'arglist Some other type of arglist.
6171 ;; nil Some other context or unknown context. Includes
6172 ;; within the parens of an if, for, ... construct.
6174 ;; LAST-CAST-END is the first token after the closing paren of a
6175 ;; preceding cast, or nil if none is known. If
6176 ;; `c-forward-decl-or-cast-1' is used in succession, it should be
6177 ;; the position after the closest preceding call where a cast was
6178 ;; matched. In that case it's used to discover chains of casts like
6181 ;; This function records identifier ranges on
6182 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6183 ;; `c-record-type-identifiers' is non-nil.
6185 ;; This function might do hidden buffer changes.
6187 (let (;; `start-pos' is used below to point to the start of the
6188 ;; first type, i.e. after any leading specifiers. It might
6189 ;; also point at the beginning of the preceding syntactic
6192 ;; Set to the result of `c-forward-type'.
6194 ;; The position of the first token in what we currently
6195 ;; believe is the type in the declaration or cast, after any
6196 ;; specifiers and their associated clauses.
6198 ;; The position of the first token in what we currently
6199 ;; believe is the declarator for the first identifier. Set
6200 ;; when the type is found, and moved forward over any
6201 ;; `c-decl-hangon-kwds' and their associated clauses that
6202 ;; occurs after the type.
6204 ;; These store `at-type', `type-start' and `id-start' of the
6205 ;; identifier before the one in those variables. The previous
6206 ;; identifier might turn out to be the real type in a
6207 ;; declaration if the last one has to be the declarator in it.
6208 ;; If `backup-at-type' is nil then the other variables have
6209 ;; undefined values.
6210 backup-at-type backup-type-start backup-id-start
6211 ;; Set if we've found a specifier (apart from "typedef") that makes
6212 ;; the defined identifier(s) types.
6214 ;; Set if we've a "typedef" keyword.
6216 ;; Set if we've found a specifier that can start a declaration
6217 ;; where there's no type.
6219 ;; If a specifier is found that also can be a type prefix,
6220 ;; these flags are set instead of those above. If we need to
6221 ;; back up an identifier, they are copied to the real flag
6222 ;; variables. Thus they only take effect if we fail to
6223 ;; interpret it as a type.
6224 backup-at-type-decl backup-maybe-typeless
6225 ;; Whether we've found a declaration or a cast. We might know
6226 ;; this before we've found the type in it. It's 'ids if we've
6227 ;; found two consecutive identifiers (usually a sure sign, but
6228 ;; we should allow that in labels too), and t if we've found a
6229 ;; specifier keyword (a 100% sure sign).
6231 ;; Set when we need to back up to parse this as a declaration
6232 ;; but not as a cast.
6234 ;; For casts, the return position.
6236 ;; Save `c-record-type-identifiers' and
6237 ;; `c-record-ref-identifiers' since ranges are recorded
6238 ;; speculatively and should be thrown away if it turns out
6239 ;; that it isn't a declaration or cast.
6240 (save-rec-type-ids c-record-type-identifiers)
6241 (save-rec-ref-ids c-record-ref-identifiers))
6243 (while (c-forward-annotation)
6244 (c-forward-syntactic-ws))
6246 ;; Check for a type. Unknown symbols are treated as possible
6247 ;; types, but they could also be specifiers disguised through
6248 ;; macros like __INLINE__, so we recognize both types and known
6249 ;; specifiers after them too.
6251 (let* ((start (point)) kwd-sym kwd-clause-end found-type)
6253 ;; Look for a specifier keyword clause.
6254 (when (looking-at c-prefix-spec-kwds-re)
6255 (if (looking-at c-typedef-key)
6256 (setq at-typedef t))
6257 (setq kwd-sym (c-keyword-sym (match-string 1)))
6259 (c-forward-keyword-clause 1)
6260 (setq kwd-clause-end (point))))
6262 (when (setq found-type (c-forward-type t)) ; brace-block-too
6263 ;; Found a known or possible type or a prefix of a known type.
6266 ;; Got two identifiers with nothing but whitespace
6267 ;; between them. That can only happen in declarations.
6268 (setq at-decl-or-cast 'ids)
6270 (when (eq at-type 'found)
6271 ;; If the previous identifier is a found type we
6272 ;; record it as a real one; it might be some sort of
6273 ;; alias for a prefix like "unsigned".
6275 (goto-char type-start)
6276 (let ((c-promote-possible-types t))
6277 (c-forward-type)))))
6279 (setq backup-at-type at-type
6280 backup-type-start type-start
6281 backup-id-start id-start
6285 ;; The previous ambiguous specifier/type turned out
6286 ;; to be a type since we've parsed another one after
6287 ;; it, so clear these backup flags.
6288 backup-at-type-decl nil
6289 backup-maybe-typeless nil))
6293 ;; Handle known specifier keywords and
6294 ;; `c-decl-hangon-kwds' which can occur after known
6297 (if (c-keyword-member kwd-sym 'c-decl-hangon-kwds)
6298 ;; It's a hang-on keyword that can occur anywhere.
6300 (setq at-decl-or-cast t)
6302 ;; Move the identifier start position if
6303 ;; we've passed a type.
6304 (setq id-start kwd-clause-end)
6305 ;; Otherwise treat this as a specifier and
6306 ;; move the fallback position.
6307 (setq start-pos kwd-clause-end))
6308 (goto-char kwd-clause-end))
6310 ;; It's an ordinary specifier so we know that
6311 ;; anything before this can't be the type.
6312 (setq backup-at-type nil
6313 start-pos kwd-clause-end)
6316 ;; It's ambiguous whether this keyword is a
6317 ;; specifier or a type prefix, so set the backup
6318 ;; flags. (It's assumed that `c-forward-type'
6319 ;; moved further than `c-forward-keyword-clause'.)
6321 (when (c-keyword-member kwd-sym 'c-typedef-decl-kwds)
6322 (setq backup-at-type-decl t))
6323 (when (c-keyword-member kwd-sym 'c-typeless-decl-kwds)
6324 (setq backup-maybe-typeless t)))
6326 (when (c-keyword-member kwd-sym 'c-typedef-decl-kwds)
6327 ;; This test only happens after we've scanned a type.
6328 ;; So, with valid syntax, kwd-sym can't be 'typedef.
6329 (setq at-type-decl t))
6330 (when (c-keyword-member kwd-sym 'c-typeless-decl-kwds)
6331 (setq maybe-typeless t))
6333 ;; Haven't matched a type so it's an umambiguous
6334 ;; specifier keyword and we know we're in a
6336 (setq at-decl-or-cast t)
6338 (goto-char kwd-clause-end))))
6340 ;; If the type isn't known we continue so that we'll jump
6341 ;; over all specifiers and type identifiers. The reason
6342 ;; to do this for a known type prefix is to make things
6343 ;; like "unsigned INT16" work.
6344 (and found-type (not (eq found-type t))))))
6348 ;; If a known type was found, we still need to skip over any
6349 ;; hangon keyword clauses after it. Otherwise it has already
6350 ;; been done in the loop above.
6351 (while (looking-at c-decl-hangon-key)
6352 (c-forward-keyword-clause 1))
6353 (setq id-start (point)))
6355 ((eq at-type 'prefix)
6356 ;; A prefix type is itself a primitive type when it's not
6357 ;; followed by another type.
6361 ;; Got no type but set things up to continue anyway to handle
6362 ;; the various cases when a declaration doesn't start with a
6364 (setq id-start start-pos))
6366 ((and (eq at-type 'maybe)
6367 (c-major-mode-is 'c++-mode))
6368 ;; If it's C++ then check if the last "type" ends on the form
6369 ;; "foo::foo" or "foo::~foo", i.e. if it's the name of a
6370 ;; (con|de)structor.
6372 (let (name end-2 end-1)
6373 (goto-char id-start)
6374 (c-backward-syntactic-ws)
6375 (setq end-2 (point))
6377 (c-simple-skip-symbol-backward)
6380 (buffer-substring-no-properties (point) end-2))
6381 ;; Cheating in the handling of syntactic ws below.
6382 (< (skip-chars-backward ":~ \t\n\r\v\f") 0))
6384 (setq end-1 (point))
6385 (c-simple-skip-symbol-backward))
6386 (>= (point) type-start)
6387 (equal (buffer-substring-no-properties (point) end-1)
6389 ;; It is a (con|de)structor name. In that case the
6390 ;; declaration is typeless so zap out any preceding
6391 ;; identifier(s) that we might have taken as types.
6392 (goto-char type-start)
6395 id-start type-start))))))
6397 ;; Check for and step over a type decl expression after the thing
6398 ;; that is or might be a type. This can't be skipped since we
6399 ;; need the correct end position of the declarator for
6400 ;; `max-type-decl-end-*'.
6401 (let ((start (point)) (paren-depth 0) pos
6402 ;; True if there's a non-open-paren match of
6403 ;; `c-type-decl-prefix-key'.
6405 ;; True if the declarator is surrounded by a parenthesis pair.
6407 ;; True if there is an identifier in the declarator.
6409 ;; True if there's a non-close-paren match of
6410 ;; `c-type-decl-suffix-key'.
6412 ;; True if there's a prefix match outside the outermost
6413 ;; paren pair that surrounds the declarator.
6414 got-prefix-before-parens
6415 ;; True if there's a suffix match outside the outermost
6416 ;; paren pair that surrounds the declarator. The value is
6417 ;; the position of the first suffix match.
6418 got-suffix-after-parens
6419 ;; True if we've parsed the type decl to a token that is
6420 ;; known to end declarations in this context.
6422 ;; The earlier values of `at-type' and `type-start' if we've
6423 ;; shifted the type backwards.
6424 identifier-type identifier-start
6425 ;; If `c-parse-and-markup-<>-arglists' is set we need to
6426 ;; turn it off during the name skipping below to avoid
6427 ;; getting `c-type' properties that might be bogus. That
6428 ;; can happen since we don't know if
6429 ;; `c-restricted-<>-arglists' will be correct inside the
6430 ;; arglist paren that gets entered.
6431 c-parse-and-markup-<>-arglists)
6433 (goto-char id-start)
6435 ;; Skip over type decl prefix operators. (Note similar code in
6436 ;; `c-font-lock-declarators'.)
6437 (while (and (looking-at c-type-decl-prefix-key)
6438 (if (and (c-major-mode-is 'c++-mode)
6439 (match-beginning 2))
6440 ;; If the second submatch matches in C++ then
6441 ;; we're looking at an identifier that's a
6442 ;; prefix only if it specifies a member pointer.
6443 (when (setq got-identifier (c-forward-name))
6444 (if (looking-at "\\(::\\)")
6445 ;; We only check for a trailing "::" and
6446 ;; let the "*" that should follow be
6447 ;; matched in the next round.
6448 (progn (setq got-identifier nil) t)
6449 ;; It turned out to be the real identifier,
6454 (if (eq (char-after) ?\()
6456 (setq paren-depth (1+ paren-depth))
6458 (unless got-prefix-before-parens
6459 (setq got-prefix-before-parens (= paren-depth 0)))
6461 (goto-char (match-end 1)))
6462 (c-forward-syntactic-ws))
6464 (setq got-parens (> paren-depth 0))
6466 ;; Skip over an identifier.
6468 (and (looking-at c-identifier-start)
6469 (setq got-identifier (c-forward-name))))
6471 ;; Skip over type decl suffix operators.
6472 (while (if (looking-at c-type-decl-suffix-key)
6474 (if (eq (char-after) ?\))
6475 (when (> paren-depth 0)
6476 (setq paren-depth (1- paren-depth))
6479 (when (if (save-match-data (looking-at "\\s\("))
6480 (c-safe (c-forward-sexp 1) t)
6481 (goto-char (match-end 1))
6483 (when (and (not got-suffix-after-parens)
6485 (setq got-suffix-after-parens (match-beginning 0)))
6486 (setq got-suffix t)))
6488 ;; No suffix matched. We might have matched the
6489 ;; identifier as a type and the open paren of a
6490 ;; function arglist as a type decl prefix. In that
6491 ;; case we should "backtrack": Reinterpret the last
6492 ;; type as the identifier, move out of the arglist and
6493 ;; continue searching for suffix operators.
6495 ;; Do this even if there's no preceding type, to cope
6496 ;; with old style function declarations in K&R C,
6497 ;; (con|de)structors in C++ and `c-typeless-decl-kwds'
6498 ;; style declarations. That isn't applicable in an
6499 ;; arglist context, though.
6500 (when (and (= paren-depth 1)
6501 (not got-prefix-before-parens)
6502 (not (eq at-type t))
6505 backup-maybe-typeless
6506 (when c-recognize-typeless-decls
6508 (setq pos (c-up-list-forward (point)))
6509 (eq (char-before pos) ?\)))
6510 (c-fdoc-shift-type-backward)
6514 (c-forward-syntactic-ws))
6516 (when (and (or maybe-typeless backup-maybe-typeless)
6517 (not got-identifier)
6520 ;; Have found no identifier but `c-typeless-decl-kwds' has
6521 ;; matched so we know we're inside a declaration. The
6522 ;; preceding type must be the identifier instead.
6523 (c-fdoc-shift-type-backward))
6527 (catch 'at-decl-or-cast
6530 (when (> paren-depth 0)
6531 ;; Encountered something inside parens that isn't matched by
6532 ;; the `c-type-decl-*' regexps, so it's not a type decl
6533 ;; expression. Try to skip out to the same paren depth to
6534 ;; not confuse the cast check below.
6535 (c-safe (goto-char (scan-lists (point) 1 paren-depth)))
6536 ;; If we've found a specifier keyword then it's a
6537 ;; declaration regardless.
6538 (throw 'at-decl-or-cast (eq at-decl-or-cast t)))
6541 (looking-at (cond ((eq context '<>) "[,>]")
6545 ;; Now we've collected info about various characteristics of
6546 ;; the construct we're looking at. Below follows a decision
6547 ;; tree based on that. It's ordered to check more certain
6548 ;; signs before less certain ones.
6554 (when (and (or at-type maybe-typeless)
6555 (not (or got-prefix got-parens)))
6556 ;; Got another identifier directly after the type, so it's a
6558 (throw 'at-decl-or-cast t))
6560 (when (and got-parens
6562 (not got-suffix-after-parens)
6565 backup-maybe-typeless))
6566 ;; Got a declaration of the form "foo bar (gnu);" where we've
6567 ;; recognized "bar" as the type and "gnu" as the declarator.
6568 ;; In this case it's however more likely that "bar" is the
6569 ;; declarator and "gnu" a function argument or initializer (if
6570 ;; `c-recognize-paren-inits' is set), since the parens around
6571 ;; "gnu" would be superfluous if it's a declarator. Shift the
6572 ;; type one step backward.
6573 (c-fdoc-shift-type-backward)))
6575 ;; Found no identifier.
6581 (when (= (point) start)
6582 ;; Got a plain list of identifiers. If a colon follows it's
6583 ;; a valid label. Otherwise the last one probably is the
6584 ;; declared identifier and we should back up to the previous
6585 ;; type, providing it isn't a cast.
6586 (if (and (eq (char-after) ?:)
6587 (not (c-major-mode-is 'java-mode)))
6588 ;; If we've found a specifier keyword then it's a
6589 ;; declaration regardless.
6590 (throw 'at-decl-or-cast (eq at-decl-or-cast t))
6591 (setq backup-if-not-cast t)
6592 (throw 'at-decl-or-cast t)))
6595 (when (and got-suffix
6598 ;; Got a plain list of identifiers followed by some suffix.
6599 ;; If this isn't a cast then the last identifier probably is
6600 ;; the declared one and we should back up to the previous
6602 (setq backup-if-not-cast t)
6603 (throw 'at-decl-or-cast t)))
6606 (when (eq at-type t)
6607 ;; If the type is known we know that there can't be any
6608 ;; identifier somewhere else, and it's only in declarations in
6609 ;; e.g. function prototypes and in casts that the identifier may
6611 (throw 'at-decl-or-cast t))
6613 (when (= (point) start)
6614 ;; Only got a single identifier (parsed as a type so far).
6617 ;; Check that the identifier isn't at the start of an
6622 ;; Inside an arglist that contains declarations. If K&R
6623 ;; style declarations and parenthesis style initializers
6624 ;; aren't allowed then the single identifier must be a
6625 ;; type, else we require that it's known or found
6626 ;; (primitive types are handled above).
6627 (or (and (not c-recognize-knr-p)
6628 (not c-recognize-paren-inits))
6629 (memq at-type '(known found))))
6631 ;; Inside a template arglist. Accept known and found
6632 ;; types; other identifiers could just as well be
6633 ;; constants in C++.
6634 (memq at-type '(known found)))))
6635 (throw 'at-decl-or-cast t)
6637 ;; Can't be a valid declaration or cast, but if we've found a
6638 ;; specifier it can't be anything else either, so treat it as
6639 ;; an invalid/unfinished declaration or cast.
6640 (throw 'at-decl-or-cast at-decl-or-cast))))
6645 (not (eq at-type t))
6648 backup-maybe-typeless
6649 (when c-recognize-typeless-decls
6650 (or (not got-suffix)
6652 c-after-suffixed-type-maybe-decl-key))))))
6653 ;; Got an empty paren pair and a preceding type that probably
6654 ;; really is the identifier. Shift the type backwards to make
6655 ;; the last one the identifier. This is analogous to the
6656 ;; "backtracking" done inside the `c-type-decl-suffix-key' loop
6659 ;; Exception: In addition to the conditions in that
6660 ;; "backtracking" code, do not shift backward if we're not
6661 ;; looking at either `c-after-suffixed-type-decl-key' or "[;,]".
6662 ;; Since there's no preceding type, the shift would mean that
6663 ;; the declaration is typeless. But if the regexp doesn't match
6664 ;; then we will simply fall through in the tests below and not
6665 ;; recognize it at all, so it's better to try it as an abstract
6666 ;; declarator instead.
6667 (c-fdoc-shift-type-backward)
6669 ;; Still no identifier.
6671 (when (and got-prefix (or got-parens got-suffix))
6672 ;; Require `got-prefix' together with either `got-parens' or
6673 ;; `got-suffix' to recognize it as an abstract declarator:
6674 ;; `got-parens' only is probably an empty function call.
6675 ;; `got-suffix' only can build an ordinary expression together
6676 ;; with the preceding identifier which we've taken as a type.
6677 ;; We could actually accept on `got-prefix' only, but that can
6678 ;; easily occur temporarily while writing an expression so we
6679 ;; avoid that case anyway. We could do a better job if we knew
6680 ;; the point when the fontification was invoked.
6681 (throw 'at-decl-or-cast t))
6687 got-suffix-after-parens
6688 (eq (char-after got-suffix-after-parens) ?\())
6689 ;; Got a type, no declarator but a paren suffix. I.e. it's a
6690 ;; normal function call afterall (or perhaps a C++ style object
6691 ;; instantiation expression).
6692 (throw 'at-decl-or-cast nil))))
6695 (when at-decl-or-cast
6696 ;; By now we've located the type in the declaration that we know
6698 (throw 'at-decl-or-cast t))
6701 (when (and got-identifier
6703 (looking-at c-after-suffixed-type-decl-key)
6707 (not (eq at-type t)))
6708 ;; Shift the type backward in the case that there's a
6709 ;; single identifier inside parens. That can only
6710 ;; occur in K&R style function declarations so it's
6711 ;; more likely that it really is a function call.
6712 ;; Therefore we only do this after
6713 ;; `c-after-suffixed-type-decl-key' has matched.
6714 (progn (c-fdoc-shift-type-backward) t)
6715 got-suffix-after-parens))
6716 ;; A declaration according to `c-after-suffixed-type-decl-key'.
6717 (throw 'at-decl-or-cast t))
6720 (when (and (or got-prefix (not got-parens))
6721 (memq at-type '(t known)))
6722 ;; It's a declaration if a known type precedes it and it can't be a
6724 (throw 'at-decl-or-cast t))
6726 ;; If we get here we can't tell if this is a type decl or a normal
6727 ;; expression by looking at it alone. (That's under the assumption
6728 ;; that normal expressions always can look like type decl expressions,
6729 ;; which isn't really true but the cases where it doesn't hold are so
6730 ;; uncommon (e.g. some placements of "const" in C++) it's not worth
6731 ;; the effort to look for them.)
6733 (unless (or at-decl-end (looking-at "=[^=]"))
6734 ;; If this is a declaration it should end here or its initializer(*)
6735 ;; should start here, so check for allowed separation tokens. Note
6736 ;; that this rule doesn't work e.g. with a K&R arglist after a
6739 ;; *) Don't check for C++ style initializers using parens
6740 ;; since those already have been matched as suffixes.
6742 ;; If `at-decl-or-cast' is then we've found some other sign that
6743 ;; it's a declaration or cast, so then it's probably an
6744 ;; invalid/unfinished one.
6745 (throw 'at-decl-or-cast at-decl-or-cast))
6747 ;; Below are tests that only should be applied when we're certain to
6748 ;; not have parsed halfway through an expression.
6751 (when (memq at-type '(t known))
6752 ;; The expression starts with a known type so treat it as a
6754 (throw 'at-decl-or-cast t))
6757 (when (and (c-major-mode-is 'c++-mode)
6758 ;; In C++ we check if the identifier is a known type, since
6759 ;; (con|de)structors use the class name as identifier.
6760 ;; We've always shifted over the identifier as a type and
6761 ;; then backed up again in this case.
6763 (or (memq identifier-type '(found known))
6764 (and (eq (char-after identifier-start) ?~)
6765 ;; `at-type' probably won't be 'found for
6766 ;; destructors since the "~" is then part of the
6767 ;; type name being checked against the list of
6768 ;; known types, so do a check without that
6771 (goto-char (1+ identifier-start))
6772 (c-forward-syntactic-ws)
6773 (c-with-syntax-table
6774 c-identifier-syntax-table
6775 (looking-at c-known-type-key)))
6777 (goto-char (1+ identifier-start))
6778 ;; We have already parsed the type earlier,
6779 ;; so it'd be possible to cache the end
6780 ;; position instead of redoing it here, but
6781 ;; then we'd need to keep track of another
6782 ;; position everywhere.
6783 (c-check-type (point)
6784 (progn (c-forward-type)
6786 (throw 'at-decl-or-cast t))
6791 (when (and got-prefix-before-parens
6793 (or at-decl-end (looking-at "=[^=]"))
6796 ;; Got something like "foo * bar;". Since we're not inside an
6797 ;; arglist it would be a meaningless expression because the
6798 ;; result isn't used. We therefore choose to recognize it as
6799 ;; a declaration. Do not allow a suffix since it could then
6800 ;; be a function call.
6801 (throw 'at-decl-or-cast t))
6804 (when (and (or got-suffix-after-parens
6805 (looking-at "=[^=]"))
6807 (not (eq context 'arglist)))
6808 ;; Got something like "a (*b) (c);" or "a (b) = c;". It could
6809 ;; be an odd expression or it could be a declaration. Treat
6810 ;; it as a declaration if "a" has been used as a type
6811 ;; somewhere else (if it's a known type we won't get here).
6812 (throw 'at-decl-or-cast t)))
6817 (and (eq context 'decl)
6818 (not c-recognize-paren-inits)
6819 (or got-parens got-suffix))))
6820 ;; Got a type followed by an abstract declarator. If `got-prefix'
6821 ;; is set it's something like "a *" without anything after it. If
6822 ;; `got-parens' or `got-suffix' is set it's "a()", "a[]", "a()[]",
6823 ;; or similar, which we accept only if the context rules out
6825 (throw 'at-decl-or-cast t)))
6827 ;; If we had a complete symbol table here (which rules out
6828 ;; `c-found-types') we should return t due to the disambiguation rule
6829 ;; (in at least C++) that anything that can be parsed as a declaration
6830 ;; is a declaration. Now we're being more defensive and prefer to
6831 ;; highlight things like "foo (bar);" as a declaration only if we're
6832 ;; inside an arglist that contains declarations.
6833 (eq context 'decl))))
6835 ;; The point is now after the type decl expression.
6838 ;; Check for a cast.
6843 ;; Should be the first type/identifier in a cast paren.
6844 (> preceding-token-end (point-min))
6845 (memq (char-before preceding-token-end) c-cast-parens)
6847 ;; The closing paren should follow.
6849 (c-forward-syntactic-ws)
6850 (looking-at "\\s\)"))
6852 ;; There should be a primary expression after it.
6855 (c-forward-syntactic-ws)
6856 (setq cast-end (point))
6857 (and (looking-at c-primary-expr-regexp)
6859 (setq pos (match-end 0))
6861 ;; Check if the expression begins with a prefix keyword.
6863 (if (match-beginning 1)
6864 ;; Expression begins with an ambiguous operator. Treat
6865 ;; it as a cast if it's a type decl or if we've
6866 ;; recognized the type somewhere else.
6868 (memq at-type '(t known found)))
6869 ;; Unless it's a keyword, it's the beginning of a primary
6871 (not (looking-at c-keywords-regexp)))))
6872 ;; If `c-primary-expr-regexp' matched a nonsymbol token, check
6873 ;; that it matched a whole one so that we don't e.g. confuse
6874 ;; the operator '-' with '->'. It's ok if it matches further,
6875 ;; though, since it e.g. can match the float '.5' while the
6876 ;; operator regexp only matches '.'.
6877 (or (not (looking-at c-nonsymbol-token-regexp))
6878 (<= (match-end 0) pos))))
6880 ;; There should either be a cast before it or something that isn't an
6881 ;; identifier or close paren.
6882 (> preceding-token-end (point-min))
6884 (goto-char (1- preceding-token-end))
6885 (or (eq (point) last-cast-end)
6887 (c-backward-syntactic-ws)
6888 (if (< (skip-syntax-backward "w_") 0)
6889 ;; It's a symbol. Accept it only if it's one of the
6890 ;; keywords that can precede an expression (without
6891 ;; surrounding parens).
6892 (looking-at c-simple-stmt-key)
6894 ;; Check that it isn't a close paren (block close is ok,
6896 (not (memq (char-before) '(?\) ?\])))
6897 ;; Check that it isn't a nonsymbol identifier.
6898 (not (c-on-identifier)))))))))
6901 (when (and c-record-type-identifiers at-type (not (eq at-type t)))
6902 (let ((c-promote-possible-types t))
6903 (goto-char type-start)
6906 (goto-char cast-end)
6910 ;; We're at a declaration. Highlight the type and the following
6913 (when backup-if-not-cast
6914 (c-fdoc-shift-type-backward t))
6916 (when (and (eq context 'decl) (looking-at ","))
6917 ;; Make sure to propagate the `c-decl-arg-start' property to
6918 ;; the next argument if it's set in this one, to cope with
6919 ;; interactive refontification.
6920 (c-put-c-type-property (point) 'c-decl-arg-start))
6922 (when (and c-record-type-identifiers at-type (not (eq at-type t)))
6923 (let ((c-promote-possible-types t))
6925 (goto-char type-start)
6929 (and (or at-type-decl at-typedef)
6930 (cons at-type-decl at-typedef))))
6933 ;; False alarm. Restore the recorded ranges.
6934 (setq c-record-type-identifiers save-rec-type-ids
6935 c-record-ref-identifiers save-rec-ref-ids)
6938 (defun c-forward-label (&optional assume-markup preceding-token-end limit)
6939 ;; Assuming that point is at the beginning of a token, check if it starts a
6940 ;; label and if so move over it and return non-nil (t in default situations,
6941 ;; specific symbols (see below) for interesting situations), otherwise don't
6942 ;; move and return nil. "Label" here means "most things with a colon".
6944 ;; More precisely, a "label" is regarded as one of:
6945 ;; (i) a goto target like "foo:" - returns the symbol `goto-target';
6946 ;; (ii) A case label - either the entire construct "case FOO:", or just the
6947 ;; bare "case", should the colon be missing. We return t;
6948 ;; (iii) a keyword which needs a colon, like "default:" or "private:"; We
6950 ;; (iv) One of QT's "extended" C++ variants of
6951 ;; "private:"/"protected:"/"public:"/"more:" looking like "public slots:".
6952 ;; Returns the symbol `qt-2kwds-colon'.
6953 ;; (v) QT's construct "signals:". Returns the symbol `qt-1kwd-colon'.
6954 ;; (vi) One of the keywords matched by `c-opt-extra-label-key' (without any
6955 ;; colon). Currently (2006-03), this applies only to Objective C's
6956 ;; keywords "@private", "@protected", and "@public". Returns t.
6958 ;; One of the things which will NOT be recognised as a label is a bit-field
6959 ;; element of a struct, something like "int foo:5".
6961 ;; The end of the label is taken to be just after the colon, or the end of
6962 ;; the first submatch in `c-opt-extra-label-key'. The point is directly
6963 ;; after the end on return. The terminating char gets marked with
6964 ;; `c-decl-end' to improve recognition of the following declaration or
6967 ;; If ASSUME-MARKUP is non-nil, it's assumed that the preceding
6968 ;; label, if any, has already been marked up like that.
6970 ;; If PRECEDING-TOKEN-END is given, it should be the first position
6971 ;; after the preceding token, i.e. on the other side of the
6972 ;; syntactic ws from the point. Use a value less than or equal to
6973 ;; (point-min) if the point is at the first token in (the visible
6974 ;; part of) the buffer.
6976 ;; The optional LIMIT limits the forward scan for the colon.
6978 ;; This function records the ranges of the label symbols on
6979 ;; `c-record-ref-identifiers' if `c-record-type-identifiers' (!) is
6982 ;; This function might do hidden buffer changes.
6984 (let ((start (point))
6987 macro-start ; if we're in one.
6991 ;; "case" or "default" (Doesn't apply to AWK).
6992 ((looking-at c-label-kwds-regexp)
6993 (let ((kwd-end (match-end 1)))
6994 ;; Record only the keyword itself for fontification, since in
6995 ;; case labels the following is a constant expression and not
6997 (when c-record-type-identifiers
6998 (c-record-ref-id (cons (match-beginning 1) kwd-end)))
7000 ;; Find the label end.
7003 (if (and (c-syntactic-re-search-forward
7004 ;; Stop on chars that aren't allowed in expressions,
7005 ;; and on operator chars that would be meaningless
7006 ;; there. FIXME: This doesn't cope with ?: operators.
7007 "[;{=,@]\\|\\(\\=\\|[^:]\\):\\([^:]\\|\\'\\)"
7009 (match-beginning 2))
7011 (progn ; there's a proper :
7012 (goto-char (match-beginning 2)) ; just after the :
7013 (c-put-c-type-property (1- (point)) 'c-decl-end)
7016 ;; It's an unfinished label. We consider the keyword enough
7017 ;; to recognize it as a label, so that it gets fontified.
7018 ;; Leave the point at the end of it, but don't put any
7019 ;; `c-decl-end' marker.
7023 ;; @private, @protected, @public, in Objective C, or similar.
7024 ((and c-opt-extra-label-key
7025 (looking-at c-opt-extra-label-key))
7026 ;; For a `c-opt-extra-label-key' match, we record the whole
7027 ;; thing for fontification. That's to get the leading '@' in
7028 ;; Objective-C protection labels fontified.
7029 (goto-char (match-end 1))
7030 (when c-record-type-identifiers
7031 (c-record-ref-id (cons (match-beginning 1) (point))))
7032 (c-put-c-type-property (1- (point)) 'c-decl-end)
7033 (setq label-type t))
7035 ;; All other cases of labels.
7036 ((and c-recognize-colon-labels ; nil for AWK and IDL, otherwise t.
7038 ;; A colon label must have something before the colon.
7039 (not (eq (char-after) ?:))
7041 ;; Check that we're not after a token that can't precede a label.
7043 ;; Trivially succeeds when there's no preceding token.
7044 (if preceding-token-end
7045 (<= preceding-token-end (point-min))
7047 (c-backward-syntactic-ws)
7048 (setq preceding-token-end (point))
7051 ;; Check if we're after a label, if we're after a closing
7052 ;; paren that belong to statement, and with
7053 ;; `c-label-prefix-re'. It's done in different order
7054 ;; depending on `assume-markup' since the checks have
7055 ;; different expensiveness.
7058 (eq (c-get-char-property (1- preceding-token-end) 'c-type)
7062 (goto-char (1- preceding-token-end))
7063 (c-beginning-of-current-token)
7064 (or (looking-at c-label-prefix-re)
7065 (looking-at c-block-stmt-1-key)))
7067 (and (eq (char-before preceding-token-end) ?\))
7068 (c-after-conditional)))
7072 (goto-char (1- preceding-token-end))
7073 (c-beginning-of-current-token)
7074 (or (looking-at c-label-prefix-re)
7075 (looking-at c-block-stmt-1-key)))
7078 ((eq (char-before preceding-token-end) ?\))
7079 (c-after-conditional))
7081 ((eq (char-before preceding-token-end) ?:)
7082 ;; Might be after another label, so check it recursively.
7085 (goto-char (1- preceding-token-end))
7086 ;; Essentially the same as the
7087 ;; `c-syntactic-re-search-forward' regexp below.
7089 (save-excursion (and (c-beginning-of-macro)
7091 (if macro-start (narrow-to-region macro-start (point-max)))
7092 (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+" nil t)
7093 ;; Note: the following should work instead of the
7094 ;; narrow-to-region above. Investigate why not,
7095 ;; sometime. ACM, 2006-03-31.
7096 ;; (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+"
7099 ;; If the caller turned on recording for us,
7100 ;; it shouldn't apply when we check the
7102 c-record-type-identifiers)
7103 ;; A label can't start at a cpp directive. Check for
7104 ;; this, since c-forward-syntactic-ws would foul up on it.
7105 (unless (and c-opt-cpp-prefix (looking-at c-opt-cpp-prefix))
7106 (c-forward-syntactic-ws)
7107 (c-forward-label nil pte start))))))))))
7109 ;; Point is still at the beginning of the possible label construct.
7111 ;; Check that the next nonsymbol token is ":", or that we're in one
7112 ;; of QT's "slots" declarations. Allow '(' for the sake of macro
7113 ;; arguments. FIXME: Should build this regexp from the language
7116 ;; public: protected: private:
7118 (c-major-mode-is 'c++-mode)
7119 (search-forward-regexp
7120 "\\=p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\>[^_]" nil t)
7121 (progn (backward-char)
7122 (c-forward-syntactic-ws limit)
7123 (looking-at ":\\([^:]\\|\\'\\)"))) ; A single colon.
7125 (setq label-type t))
7126 ;; QT double keyword like "protected slots:" or goto target.
7127 ((progn (goto-char start) nil))
7128 ((when (c-syntactic-re-search-forward
7129 "[ \t\n[:?;{=*/%&|,<>!@+-]" limit t t) ; not at EOB
7131 (setq label-end (point))
7133 (and (c-major-mode-is 'c++-mode)
7135 "\\(p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\|more\\)\\>"
7136 (buffer-substring start (point)))))
7137 (c-forward-syntactic-ws limit)
7139 ((looking-at ":\\([^:]\\|\\'\\)") ; A single colon.
7142 (if (or (string= "signals" ; Special QT macro
7143 (setq kwd (buffer-substring-no-properties start label-end)))
7144 (string= "Q_SIGNALS" kwd))
7148 (search-forward-regexp "\\=\\(slots\\|Q_SLOTS\\)\\>" limit t)
7149 (progn (c-forward-syntactic-ws limit)
7150 (looking-at ":\\([^:]\\|\\'\\)"))) ; A single colon
7152 (setq label-type 'qt-2kwds-colon)))))))
7155 (narrow-to-region start (point))
7157 ;; Check that `c-nonlabel-token-key' doesn't match anywhere.
7161 (when (looking-at c-nonlabel-token-key)
7163 (setq label-type nil)
7164 (throw 'check-label nil))
7165 (and (c-safe (c-forward-sexp)
7166 (c-forward-syntactic-ws)
7170 ;; Record the identifiers in the label for fontification, unless
7171 ;; it begins with `c-label-kwds' in which case the following
7172 ;; identifiers are part of a (constant) expression that
7173 ;; shouldn't be fontified.
7174 (when (and c-record-type-identifiers
7175 (progn (goto-char start)
7176 (not (looking-at c-label-kwds-regexp))))
7177 (while (c-syntactic-re-search-forward c-symbol-key nil t)
7178 (c-record-ref-id (cons (match-beginning 0)
7181 (c-put-c-type-property (1- (point-max)) 'c-decl-end)
7182 (goto-char (point-max)))))
7189 (defun c-forward-objc-directive ()
7190 ;; Assuming the point is at the beginning of a token, try to move
7191 ;; forward to the end of the Objective-C directive that starts
7192 ;; there. Return t if a directive was fully recognized, otherwise
7193 ;; the point is moved as far as one could be successfully parsed and
7196 ;; This function records identifier ranges on
7197 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
7198 ;; `c-record-type-identifiers' is non-nil.
7200 ;; This function might do hidden buffer changes.
7202 (let ((start (point))
7204 (c-promote-possible-types t)
7205 ;; Turn off recognition of angle bracket arglists while parsing
7206 ;; types here since the protocol reference list might then be
7207 ;; considered part of the preceding name or superclass-name.
7208 c-recognize-<>-arglists)
7213 (c-make-keywords-re t
7214 (append (c-lang-const c-protection-kwds objc)
7217 (goto-char (match-end 1))
7223 (c-make-keywords-re t
7224 '("@interface" "@implementation" "@protocol")
7227 ;; Handle the name of the class itself.
7229 ; (c-forward-token-2) ; 2006/1/13 This doesn't move if the token's
7231 (goto-char (match-end 0))
7236 ;; Look for ": superclass-name" or "( category-name )".
7237 (when (looking-at "[:\(]")
7238 (setq start-char (char-after))
7240 (c-forward-syntactic-ws)
7241 (unless (c-forward-type) (throw 'break nil))
7242 (when (eq start-char ?\()
7243 (unless (eq (char-after) ?\)) (throw 'break nil))
7245 (c-forward-syntactic-ws)))
7247 ;; Look for a protocol reference list.
7248 (if (eq (char-after) ?<)
7249 (let ((c-recognize-<>-arglists t)
7250 (c-parse-and-markup-<>-arglists t)
7251 c-restricted-<>-arglists)
7252 (c-forward-<>-arglist t))
7256 (c-backward-syntactic-ws)
7257 (c-clear-c-type-property start (1- (point)) 'c-decl-end)
7258 (c-put-c-type-property (1- (point)) 'c-decl-end)
7261 (c-clear-c-type-property start (point) 'c-decl-end)
7264 (defun c-beginning-of-inheritance-list (&optional lim)
7265 ;; Go to the first non-whitespace after the colon that starts a
7266 ;; multiple inheritance introduction. Optional LIM is the farthest
7267 ;; back we should search.
7269 ;; This function might do hidden buffer changes.
7270 (c-with-syntax-table c++-template-syntax-table
7271 (c-backward-token-2 0 t lim)
7272 (while (and (or (looking-at c-symbol-start)
7273 (looking-at "[<,]\\|::"))
7274 (zerop (c-backward-token-2 1 t lim))))))
7276 (defun c-in-method-def-p ()
7277 ;; Return nil if we aren't in a method definition, otherwise the
7278 ;; position of the initial [+-].
7280 ;; This function might do hidden buffer changes.
7283 (and c-opt-method-key
7284 (looking-at c-opt-method-key)
7288 ;; Contributed by Kevin Ryde <user42@zip.com.au>.
7289 (defun c-in-gcc-asm-p ()
7290 ;; Return non-nil if point is within a gcc \"asm\" block.
7292 ;; This should be called with point inside an argument list.
7294 ;; Only one level of enclosing parentheses is considered, so for
7295 ;; instance `nil' is returned when in a function call within an asm
7298 ;; This function might do hidden buffer changes.
7300 (and c-opt-asm-stmt-key
7303 (backward-up-list 1)
7304 (c-beginning-of-statement-1 (point-min) nil t)
7305 (looking-at c-opt-asm-stmt-key))))
7307 (defun c-at-toplevel-p ()
7308 "Return a determination as to whether point is \"at the top level\".
7309 Informally, \"at the top level\" is anywhere where you can write
7312 More precisely, being at the top-level means that point is either
7313 outside any enclosing block (such as a function definition), or
7314 directly inside a class, namespace or other block that contains
7315 another declaration level.
7317 If point is not at the top-level (e.g. it is inside a method
7318 definition), then nil is returned. Otherwise, if point is at a
7319 top-level not enclosed within a class definition, t is returned.
7320 Otherwise, a 2-vector is returned where the zeroth element is the
7321 buffer position of the start of the class declaration, and the first
7322 element is the buffer position of the enclosing class's opening
7325 Note that this function might do hidden buffer changes. See the
7326 comment at the start of cc-engine.el for more info."
7327 (let ((paren-state (c-parse-state)))
7328 (or (not (c-most-enclosing-brace paren-state))
7329 (c-search-uplist-for-classkey paren-state))))
7331 (defun c-just-after-func-arglist-p (&optional lim)
7332 ;; Return non-nil if the point is in the region after the argument
7333 ;; list of a function and its opening brace (or semicolon in case it
7334 ;; got no body). If there are K&R style argument declarations in
7335 ;; that region, the point has to be inside the first one for this
7336 ;; function to recognize it.
7338 ;; If successful, the point is moved to the first token after the
7339 ;; function header (see `c-forward-decl-or-cast-1' for details) and
7340 ;; the position of the opening paren of the function arglist is
7343 ;; The point is clobbered if not successful.
7345 ;; LIM is used as bound for backward buffer searches.
7347 ;; This function might do hidden buffer changes.
7349 (let ((beg (point)) end id-start)
7351 (eq (c-beginning-of-statement-1 lim) 'same)
7353 (not (or (c-major-mode-is 'objc-mode)
7354 (c-forward-objc-directive)))
7357 (car-safe (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil)))
7360 ;; There should not be a '=' or ',' between beg and the
7361 ;; start of the declaration since that means we were in the
7362 ;; "expression part" of the declaration.
7364 (not (looking-at "[=,]")))
7367 ;; Check that there's an arglist paren in the
7369 (goto-char id-start)
7370 (cond ((eq (char-after) ?\()
7371 ;; The declarator is a paren expression, so skip past it
7372 ;; so that we don't get stuck on that instead of the
7373 ;; function arglist.
7375 ((and c-opt-op-identifier-prefix
7376 (looking-at c-opt-op-identifier-prefix))
7377 ;; Don't trip up on "operator ()".
7378 (c-forward-token-2 2 t)))
7379 (and (< (point) beg)
7380 (c-syntactic-re-search-forward "(" beg t t)
7383 (defun c-in-knr-argdecl (&optional lim)
7384 ;; Return the position of the first argument declaration if point is
7385 ;; inside a K&R style argument declaration list, nil otherwise.
7386 ;; `c-recognize-knr-p' is not checked. If LIM is non-nil, it's a
7387 ;; position that bounds the backward search for the argument list.
7389 ;; Point must be within a possible K&R region, e.g. just before a top-level
7390 ;; "{". It must be outside of parens and brackets. The test can return
7391 ;; false positives otherwise.
7393 ;; This function might do hidden buffer changes.
7397 ;; If we're in a macro, our search range is restricted to it. Narrow to
7398 ;; the searchable range.
7399 (let* ((macro-start (c-query-macro-start))
7400 (lim (max (or lim (point-min)) (or macro-start (point-min))))
7401 before-lparen after-rparen
7402 (pp-count-out 20)) ; Max number of paren/brace constructs before we give up
7403 (narrow-to-region lim (c-point 'eol))
7405 ;; Search backwards for the defun's argument list. We give up if we
7406 ;; encounter a "}" (end of a previous defun) or BOB.
7408 ;; The criterion for a paren structure being the arg list is:
7409 ;; o - there is non-WS stuff after it but before any "{"; AND
7410 ;; o - the token after it isn't a ";" AND
7411 ;; o - it is preceded by either an identifier (the function name) or
7412 ;; a macro expansion like "DEFUN (...)"; AND
7413 ;; o - its content is a non-empty comma-separated list of identifiers
7414 ;; (an empty arg list won't have a knr region).
7416 ;; The following snippet illustrates these rules:
7417 ;; int foo (bar, baz, yuk)
7419 ;; int (*baz) (my_type) ;
7420 ;; int (*) (void) (*yuk) (void) ;
7424 (while (> pp-count-out 0) ; go back one paren/bracket pair each time.
7425 (setq pp-count-out (1- pp-count-out))
7426 (c-syntactic-skip-backward "^)]}")
7427 (cond ((eq (char-before) ?\))
7428 (setq after-rparen (point)))
7429 ((eq (char-before) ?\])
7430 (setq after-rparen nil))
7431 (t ; either } (hit previous defun) or no more parens/brackets
7435 ;; We're inside a paren. Could it be our argument list....?
7439 (goto-char after-rparen)
7440 (unless (c-go-list-backward) (throw 'knr nil)) ;
7441 ;; FIXME!!! What about macros between the parens? 2007/01/20
7442 (setq before-lparen (point)))
7444 ;; It can't be the arg list if next token is ; or {
7445 (progn (goto-char after-rparen)
7446 (c-forward-syntactic-ws)
7447 (not (memq (char-after) '(?\; ?\{))))
7449 ;; Is the thing preceding the list an identifier (the
7450 ;; function name), or a macro expansion?
7452 (goto-char before-lparen)
7453 (eq (c-backward-token-2) 0)
7454 (or (c-on-identifier)
7455 (and (eq (char-after) ?\))
7456 (c-go-up-list-backward)
7457 (eq (c-backward-token-2) 0)
7458 (c-on-identifier))))
7460 ;; Have we got a non-empty list of comma-separated
7463 (goto-char before-lparen)
7464 (c-forward-token-2) ; to first token inside parens
7469 (while (eq (char-after) ?\,)
7471 (unless (c-on-identifier) (throw 'id-list nil))
7472 (c-forward-token-2))
7473 (eq (char-after) ?\))))))
7475 ;; ...Yes. We've identified the function's argument list.
7477 (progn (goto-char after-rparen)
7478 (c-forward-syntactic-ws)
7481 ;; ...No. The current parens aren't the function's arg list.
7482 (goto-char before-lparen))
7484 (or (c-go-list-backward) ; backwards over [ .... ]
7485 (throw 'knr nil)))))))))
7487 (defun c-skip-conditional ()
7488 ;; skip forward over conditional at point, including any predicate
7489 ;; statements in parentheses. No error checking is performed.
7491 ;; This function might do hidden buffer changes.
7492 (c-forward-sexp (cond
7494 ((looking-at (concat "\\<else"
7495 "\\([ \t\n]\\|\\\\\n\\)+"
7496 "if\\>\\([^_]\\|$\\)"))
7498 ;; do, else, try, finally
7499 ((looking-at (concat "\\<\\("
7500 "do\\|else\\|try\\|finally"
7501 "\\)\\>\\([^_]\\|$\\)"))
7503 ;; for, if, while, switch, catch, synchronized, foreach
7506 (defun c-after-conditional (&optional lim)
7507 ;; If looking at the token after a conditional then return the
7508 ;; position of its start, otherwise return nil.
7510 ;; This function might do hidden buffer changes.
7512 (and (zerop (c-backward-token-2 1 t lim))
7513 (or (looking-at c-block-stmt-1-key)
7514 (and (eq (char-after) ?\()
7515 (zerop (c-backward-token-2 1 t lim))
7516 (looking-at c-block-stmt-2-key)))
7519 (defun c-after-special-operator-id (&optional lim)
7520 ;; If the point is after an operator identifier that isn't handled
7521 ;; like an ordinary symbol (i.e. like "operator =" in C++) then the
7522 ;; position of the start of that identifier is returned. nil is
7523 ;; returned otherwise. The point may be anywhere in the syntactic
7524 ;; whitespace after the last token of the operator identifier.
7526 ;; This function might do hidden buffer changes.
7528 (and c-overloadable-operators-regexp
7529 (zerop (c-backward-token-2 1 nil lim))
7530 (looking-at c-overloadable-operators-regexp)
7531 (or (not c-opt-op-identifier-prefix)
7533 (zerop (c-backward-token-2 1 nil lim))
7534 (looking-at c-opt-op-identifier-prefix)))
7537 (defsubst c-backward-to-block-anchor (&optional lim)
7538 ;; Assuming point is at a brace that opens a statement block of some
7539 ;; kind, move to the proper anchor point for that block. It might
7540 ;; need to be adjusted further by c-add-stmt-syntax, but the
7541 ;; position at return is suitable as start position for that
7544 ;; This function might do hidden buffer changes.
7545 (unless (= (point) (c-point 'boi))
7546 (let ((start (c-after-conditional lim)))
7548 (goto-char start)))))
7550 (defsubst c-backward-to-decl-anchor (&optional lim)
7551 ;; Assuming point is at a brace that opens the block of a top level
7552 ;; declaration of some kind, move to the proper anchor point for
7555 ;; This function might do hidden buffer changes.
7556 (unless (= (point) (c-point 'boi))
7557 (c-beginning-of-statement-1 lim)))
7559 (defun c-search-decl-header-end ()
7560 ;; Search forward for the end of the "header" of the current
7561 ;; declaration. That's the position where the definition body
7562 ;; starts, or the first variable initializer, or the ending
7563 ;; semicolon. I.e. search forward for the closest following
7564 ;; (syntactically relevant) '{', '=' or ';' token. Point is left
7565 ;; _after_ the first found token, or at point-max if none is found.
7567 ;; This function might do hidden buffer changes.
7569 (let ((base (point)))
7570 (if (c-major-mode-is 'c++-mode)
7572 ;; In C++ we need to take special care to handle operator
7573 ;; tokens and those pesky template brackets.
7575 (c-syntactic-re-search-forward "[;{<=]" nil 'move t t)
7577 (c-end-of-current-token base)
7578 ;; Handle operator identifiers, i.e. ignore any
7579 ;; operator token preceded by "operator".
7581 (and (c-safe (c-backward-sexp) t)
7582 (looking-at c-opt-op-identifier-prefix)))
7583 (and (eq (char-before) ?<)
7584 (c-with-syntax-table c++-template-syntax-table
7585 (if (c-safe (goto-char (c-up-list-forward (point))))
7587 (goto-char (point-max))
7589 (setq base (point)))
7592 (c-syntactic-re-search-forward "[;{=]" nil 'move t t)
7593 (c-end-of-current-token base))
7594 (setq base (point))))))
7596 (defun c-beginning-of-decl-1 (&optional lim)
7597 ;; Go to the beginning of the current declaration, or the beginning
7598 ;; of the previous one if already at the start of it. Point won't
7599 ;; be moved out of any surrounding paren. Return a cons cell of the
7600 ;; form (MOVE . KNR-POS). MOVE is like the return value from
7601 ;; `c-beginning-of-statement-1'. If point skipped over some K&R
7602 ;; style argument declarations (and they are to be recognized) then
7603 ;; KNR-POS is set to the start of the first such argument
7604 ;; declaration, otherwise KNR-POS is nil. If LIM is non-nil, it's a
7605 ;; position that bounds the backward search.
7607 ;; NB: Cases where the declaration continues after the block, as in
7608 ;; "struct foo { ... } bar;", are currently recognized as two
7609 ;; declarations, e.g. "struct foo { ... }" and "bar;" in this case.
7611 ;; This function might do hidden buffer changes.
7613 (let* ((start (point))
7614 (last-stmt-start (point))
7615 (move (c-beginning-of-statement-1 lim nil t)))
7617 ;; `c-beginning-of-statement-1' stops at a block start, but we
7618 ;; want to continue if the block doesn't begin a top level
7619 ;; construct, i.e. if it isn't preceded by ';', '}', ':', bob,
7620 ;; or an open paren.
7621 (let ((beg (point)) tentative-move)
7622 ;; Go back one "statement" each time round the loop until we're just
7623 ;; after a ;, }, or :, or at BOB or the start of a macro or start of
7624 ;; an ObjC method. This will move over a multiple declaration whose
7625 ;; components are comma separated.
7627 ;; Must check with c-opt-method-key in ObjC mode.
7628 (not (and c-opt-method-key
7629 (looking-at c-opt-method-key)))
7630 (/= last-stmt-start (point))
7632 (c-backward-syntactic-ws lim)
7633 (not (memq (char-before) '(?\; ?} ?: nil))))
7636 (not (looking-at "\\s(")))
7637 ;; Check that we don't move from the first thing in a
7638 ;; macro to its header.
7639 (not (eq (setq tentative-move
7640 (c-beginning-of-statement-1 lim nil t))
7642 (setq last-stmt-start beg
7644 move tentative-move))
7647 (when c-recognize-knr-p
7648 (let ((fallback-pos (point)) knr-argdecl-start)
7649 ;; Handle K&R argdecls. Back up after the "statement" jumped
7650 ;; over by `c-beginning-of-statement-1', unless it was the
7651 ;; function body, in which case we're sitting on the opening
7652 ;; brace now. Then test if we're in a K&R argdecl region and
7653 ;; that we started at the other side of the first argdecl in
7655 (unless (eq (char-after) ?{)
7656 (goto-char last-stmt-start))
7657 (if (and (setq knr-argdecl-start (c-in-knr-argdecl lim))
7658 (< knr-argdecl-start start)
7660 (goto-char knr-argdecl-start)
7661 (not (eq (c-beginning-of-statement-1 lim nil t) 'macro))))
7663 (cons (if (eq (char-after fallback-pos) ?{)
7667 (goto-char fallback-pos))))
7669 ;; `c-beginning-of-statement-1' counts each brace block as a separate
7670 ;; statement, so the result will be 'previous if we've moved over any.
7671 ;; So change our result back to 'same if necessary.
7673 ;; If they were brace list initializers we might not have moved over a
7674 ;; declaration boundary though, so change it to 'same if we've moved
7675 ;; past a '=' before '{', but not ';'. (This ought to be integrated
7676 ;; into `c-beginning-of-statement-1', so we avoid this extra pass which
7677 ;; potentially can search over a large amount of text.). Take special
7678 ;; pains not to get mislead by C++'s "operator=", and the like.
7679 (if (and (eq move 'previous)
7680 (c-with-syntax-table (if (c-major-mode-is 'c++-mode)
7681 c++-template-syntax-table
7686 (while ; keep going back to "[;={"s until we either find
7687 ; no more, or get to one which isn't an "operator ="
7688 (and (c-syntactic-re-search-forward "[;={]" start t t t)
7689 (eq (char-before) ?=)
7690 c-overloadable-operators-regexp
7691 c-opt-op-identifier-prefix
7693 (eq (c-backward-token-2) 0)
7694 (looking-at c-overloadable-operators-regexp)
7695 (eq (c-backward-token-2) 0)
7696 (looking-at c-opt-op-identifier-prefix))))
7697 (eq (char-before) ?=))
7698 (c-syntactic-re-search-forward "[;{]" start t t)
7699 (eq (char-before) ?{)
7700 (c-safe (goto-char (c-up-list-forward (point))) t)
7701 (not (c-syntactic-re-search-forward ";" start t t))))))
7705 (defun c-end-of-decl-1 ()
7706 ;; Assuming point is at the start of a declaration (as detected by
7707 ;; e.g. `c-beginning-of-decl-1'), go to the end of it. Unlike
7708 ;; `c-beginning-of-decl-1', this function handles the case when a
7709 ;; block is followed by identifiers in e.g. struct declarations in C
7710 ;; or C++. If a proper end was found then t is returned, otherwise
7711 ;; point is moved as far as possible within the current sexp and nil
7712 ;; is returned. This function doesn't handle macros; use
7713 ;; `c-end-of-macro' instead in those cases.
7715 ;; This function might do hidden buffer changes.
7716 (let ((start (point))
7717 (decl-syntax-table (if (c-major-mode-is 'c++-mode)
7718 c++-template-syntax-table
7721 (c-search-decl-header-end)
7723 (when (and c-recognize-knr-p
7724 (eq (char-before) ?\;)
7725 (c-in-knr-argdecl start))
7726 ;; Stopped at the ';' in a K&R argdecl section which is
7727 ;; detected using the same criteria as in
7728 ;; `c-beginning-of-decl-1'. Move to the following block
7730 (c-syntactic-re-search-forward "{" nil 'move t))
7732 (when (eq (char-before) ?{)
7733 ;; Encountered a block in the declaration. Jump over it.
7735 (goto-char (c-up-list-forward (point)))
7736 (error (goto-char (point-max))
7737 (throw 'return nil)))
7738 (if (or (not c-opt-block-decls-with-vars-key)
7740 (c-with-syntax-table decl-syntax-table
7741 (let ((lim (point)))
7744 ;; Check for `c-opt-block-decls-with-vars-key'
7745 ;; before the first paren.
7746 (c-syntactic-re-search-forward
7747 (concat "[;=\(\[{]\\|\\("
7748 c-opt-block-decls-with-vars-key
7752 (not (eq (char-before) ?_))
7753 ;; Check that the first following paren is
7755 (c-syntactic-re-search-forward "[;=\(\[{]"
7757 (eq (char-before) ?{)))))))
7758 ;; The declaration doesn't have any of the
7759 ;; `c-opt-block-decls-with-vars' keywords in the
7760 ;; beginning, so it ends here at the end of the block.
7763 (c-with-syntax-table decl-syntax-table
7765 (if (eq (char-before) ?\;)
7767 (c-syntactic-re-search-forward ";" nil 'move t))))
7770 (defun c-looking-at-decl-block (containing-sexp goto-start &optional limit)
7771 ;; Assuming the point is at an open brace, check if it starts a
7772 ;; block that contains another declaration level, i.e. that isn't a
7773 ;; statement block or a brace list, and if so return non-nil.
7775 ;; If the check is successful, the return value is the start of the
7776 ;; keyword that tells what kind of construct it is, i.e. typically
7777 ;; what `c-decl-block-key' matched. Also, if GOTO-START is set then
7778 ;; the point will be at the start of the construct, before any
7779 ;; leading specifiers, otherwise it's at the returned position.
7781 ;; The point is clobbered if the check is unsuccessful.
7783 ;; CONTAINING-SEXP is the position of the open of the surrounding
7784 ;; paren, or nil if none.
7786 ;; The optional LIMIT limits the backward search for the start of
7787 ;; the construct. It's assumed to be at a syntactically relevant
7790 ;; If any template arglists are found in the searched region before
7791 ;; the open brace, they get marked with paren syntax.
7793 ;; This function might do hidden buffer changes.
7795 (let ((open-brace (point)) kwd-start first-specifier-pos)
7796 (c-syntactic-skip-backward c-block-prefix-charset limit t)
7798 (when (and c-recognize-<>-arglists
7799 (eq (char-before) ?>))
7800 ;; Could be at the end of a template arglist.
7801 (let ((c-parse-and-markup-<>-arglists t)
7802 (c-disallow-comma-in-<>-arglists
7803 (and containing-sexp
7804 (not (eq (char-after containing-sexp) ?{)))))
7806 (c-backward-<>-arglist nil limit)
7808 (c-syntactic-skip-backward c-block-prefix-charset limit t)
7809 (eq (char-before) ?>))))))
7811 ;; Note: Can't get bogus hits inside template arglists below since they
7812 ;; have gotten paren syntax above.
7814 ;; If `goto-start' is set we begin by searching for the
7815 ;; first possible position of a leading specifier list.
7816 ;; The `c-decl-block-key' search continues from there since
7817 ;; we know it can't match earlier.
7819 (when (c-syntactic-re-search-forward c-symbol-start
7821 (goto-char (setq first-specifier-pos (match-beginning 0)))
7826 ((c-syntactic-re-search-forward c-decl-block-key open-brace t t t)
7827 (goto-char (setq kwd-start (match-beginning 0)))
7830 ;; Found a keyword that can't be a type?
7833 ;; Can be a type too, in which case it's the return type of a
7834 ;; function (under the assumption that no declaration level
7835 ;; block construct starts with a type).
7836 (not (c-forward-type))
7838 ;; Jumped over a type, but it could be a declaration keyword
7839 ;; followed by the declared identifier that we've jumped over
7840 ;; instead (e.g. in "class Foo {"). If it indeed is a type
7841 ;; then we should be at the declarator now, so check for a
7842 ;; valid declarator start.
7844 ;; Note: This doesn't cope with the case when a declared
7845 ;; identifier is followed by e.g. '(' in a language where '('
7846 ;; also might be part of a declarator expression. Currently
7847 ;; there's no such language.
7848 (not (or (looking-at c-symbol-start)
7849 (looking-at c-type-decl-prefix-key)))))
7851 ;; In Pike a list of modifiers may be followed by a brace
7852 ;; to make them apply to many identifiers. Note that the
7853 ;; match data will be empty on return in this case.
7854 ((and (c-major-mode-is 'pike-mode)
7856 (goto-char open-brace)
7857 (= (c-backward-token-2) 0))
7858 (looking-at c-specifier-key)
7859 ;; Use this variant to avoid yet another special regexp.
7860 (c-keyword-member (c-keyword-sym (match-string 1))
7862 (setq kwd-start (point))
7868 ;; Back up over any preceding specifiers and their clauses
7869 ;; by going forward from `first-specifier-pos', which is the
7870 ;; earliest possible position where the specifier list can
7873 (goto-char first-specifier-pos)
7875 (while (< (point) kwd-start)
7876 (if (looking-at c-symbol-key)
7877 ;; Accept any plain symbol token on the ground that
7878 ;; it's a specifier masked through a macro (just
7879 ;; like `c-forward-decl-or-cast-1' skip forward over
7882 ;; Could be more restrictive wrt invalid keywords,
7883 ;; but that'd only occur in invalid code so there's
7884 ;; no use spending effort on it.
7885 (let ((end (match-end 0)))
7886 (unless (c-forward-keyword-clause 0)
7888 (c-forward-syntactic-ws)))
7890 ;; Can't parse a declaration preamble and is still
7891 ;; before `kwd-start'. That means `first-specifier-pos'
7892 ;; was in some earlier construct. Search again.
7893 (if (c-syntactic-re-search-forward c-symbol-start
7895 (goto-char (setq first-specifier-pos (match-beginning 0)))
7896 ;; Got no preamble before the block declaration keyword.
7897 (setq first-specifier-pos kwd-start))))
7899 (goto-char first-specifier-pos))
7900 (goto-char kwd-start))
7904 (defun c-search-uplist-for-classkey (paren-state)
7905 ;; Check if the closest containing paren sexp is a declaration
7906 ;; block, returning a 2 element vector in that case. Aref 0
7907 ;; contains the bufpos at boi of the class key line, and aref 1
7908 ;; contains the bufpos of the open brace. This function is an
7909 ;; obsolete wrapper for `c-looking-at-decl-block'.
7911 ;; This function might do hidden buffer changes.
7912 (let ((open-paren-pos (c-most-enclosing-brace paren-state)))
7913 (when open-paren-pos
7915 (goto-char open-paren-pos)
7916 (when (and (eq (char-after) ?{)
7917 (c-looking-at-decl-block
7918 (c-safe-position open-paren-pos paren-state)
7920 (back-to-indentation)
7921 (vector (point) open-paren-pos))))))
7923 (defun c-inside-bracelist-p (containing-sexp paren-state)
7924 ;; return the buffer position of the beginning of the brace list
7925 ;; statement if we're inside a brace list, otherwise return nil.
7926 ;; CONTAINING-SEXP is the buffer pos of the innermost containing
7927 ;; paren. PAREN-STATE is the remainder of the state of enclosing
7930 ;; N.B.: This algorithm can potentially get confused by cpp macros
7931 ;; placed in inconvenient locations. It's a trade-off we make for
7934 ;; This function might do hidden buffer changes.
7936 ;; This will pick up brace list declarations.
7939 (goto-char containing-sexp)
7942 (if (and (or (looking-at c-brace-list-key)
7943 (progn (c-forward-sexp -1)
7944 (looking-at c-brace-list-key)))
7945 (setq bracepos (c-down-list-forward (point)))
7946 (not (c-crosses-statement-barrier-p (point)
7949 ;; this will pick up array/aggregate init lists, even if they are nested.
7952 ;; Pike can have class definitions anywhere, so we must
7953 ;; check for the class key here.
7954 (and (c-major-mode-is 'pike-mode)
7956 bufpos braceassignp lim next-containing)
7957 (while (and (not bufpos)
7960 (if (consp (car paren-state))
7961 (setq lim (cdr (car paren-state))
7962 paren-state (cdr paren-state))
7963 (setq lim (car paren-state)))
7965 (setq next-containing (car paren-state)
7966 paren-state (cdr paren-state))))
7967 (goto-char containing-sexp)
7968 (if (c-looking-at-inexpr-block next-containing next-containing)
7969 ;; We're in an in-expression block of some kind. Do not
7970 ;; check nesting. We deliberately set the limit to the
7971 ;; containing sexp, so that c-looking-at-inexpr-block
7972 ;; doesn't check for an identifier before it.
7973 (setq containing-sexp nil)
7974 ;; see if the open brace is preceded by = or [...] in
7975 ;; this statement, but watch out for operator=
7976 (setq braceassignp 'dontknow)
7977 (c-backward-token-2 1 t lim)
7978 ;; Checks to do only on the first sexp before the brace.
7979 (when (and c-opt-inexpr-brace-list-key
7980 (eq (char-after) ?\[))
7981 ;; In Java, an initialization brace list may follow
7982 ;; directly after "new Foo[]", so check for a "new"
7984 (while (eq braceassignp 'dontknow)
7986 (cond ((/= (c-backward-token-2 1 t lim) 0) nil)
7987 ((looking-at c-opt-inexpr-brace-list-key) t)
7988 ((looking-at "\\sw\\|\\s_\\|[.[]")
7989 ;; Carry on looking if this is an
7990 ;; identifier (may contain "." in Java)
7991 ;; or another "[]" sexp.
7994 ;; Checks to do on all sexps before the brace, up to the
7995 ;; beginning of the statement.
7996 (while (eq braceassignp 'dontknow)
7997 (cond ((eq (char-after) ?\;)
7998 (setq braceassignp nil))
8000 (looking-at class-key))
8001 (setq braceassignp nil))
8002 ((eq (char-after) ?=)
8003 ;; We've seen a =, but must check earlier tokens so
8004 ;; that it isn't something that should be ignored.
8005 (setq braceassignp 'maybe)
8006 (while (and (eq braceassignp 'maybe)
8007 (zerop (c-backward-token-2 1 t lim)))
8010 ;; Check for operator =
8011 ((and c-opt-op-identifier-prefix
8012 (looking-at c-opt-op-identifier-prefix))
8014 ;; Check for `<opchar>= in Pike.
8015 ((and (c-major-mode-is 'pike-mode)
8016 (or (eq (char-after) ?`)
8017 ;; Special case for Pikes
8018 ;; `[]=, since '[' is not in
8019 ;; the punctuation class.
8020 (and (eq (char-after) ?\[)
8021 (eq (char-before) ?`))))
8023 ((looking-at "\\s.") 'maybe)
8024 ;; make sure we're not in a C++ template
8025 ;; argument assignment
8027 (c-major-mode-is 'c++-mode)
8029 (let ((here (point))
8031 (skip-chars-backward "^<>")
8033 (and (eq (char-before) ?<)
8034 (not (c-crosses-statement-barrier-p
8036 (not (c-in-literal))
8040 (if (and (eq braceassignp 'dontknow)
8041 (/= (c-backward-token-2 1 t lim) 0))
8042 (setq braceassignp nil)))
8043 (if (not braceassignp)
8044 (if (eq (char-after) ?\;)
8045 ;; Brace lists can't contain a semicolon, so we're done.
8046 (setq containing-sexp nil)
8048 (setq containing-sexp next-containing
8050 next-containing nil))
8051 ;; we've hit the beginning of the aggregate list
8052 (c-beginning-of-statement-1
8053 (c-most-enclosing-brace paren-state))
8054 (setq bufpos (point))))
8059 (defun c-looking-at-special-brace-list (&optional lim)
8060 ;; If we're looking at the start of a pike-style list, ie `({Â })',
8061 ;; `([Â ])', `(<Â >)' etc, a cons of a cons of its starting and ending
8062 ;; positions and its entry in c-special-brace-lists is returned, nil
8063 ;; otherwise. The ending position is nil if the list is still open.
8064 ;; LIM is the limit for forward search. The point may either be at
8065 ;; the `(' or at the following paren character. Tries to check the
8066 ;; matching closer, but assumes it's correct if no balanced paren is
8067 ;; found (i.e. the case `({ ... } ... )' is detected as _not_ being
8068 ;; a special brace list).
8070 ;; This function might do hidden buffer changes.
8071 (if c-special-brace-lists
8076 (c-forward-syntactic-ws)
8077 (if (eq (char-after) ?\()
8080 (c-forward-syntactic-ws)
8081 (setq inner-beg (point))
8082 (setq type (assq (char-after) c-special-brace-lists)))
8083 (if (setq type (assq (char-after) c-special-brace-lists))
8085 (setq inner-beg (point))
8086 (c-backward-syntactic-ws)
8088 (setq beg (if (eq (char-after) ?\()
8096 (= (char-before) ?\)))
8098 (goto-char inner-beg)
8099 (if (looking-at "\\s(")
8100 ;; Check balancing of the inner paren
8105 ;; If the inner char isn't a paren then
8106 ;; we can't check balancing, so just
8107 ;; check the char before the outer
8111 (c-backward-syntactic-ws)
8112 (= (char-before) (cdr type)))))
8113 (if (or (/= (char-syntax (char-before)) ?\))
8115 (c-forward-syntactic-ws)
8118 (cons (cons beg end) type))
8119 (cons (list beg) type)))))
8122 (defun c-looking-at-bos (&optional lim)
8123 ;; Return non-nil if between two statements or declarations, assuming
8124 ;; point is not inside a literal or comment.
8126 ;; Obsolete - `c-at-statement-start-p' or `c-at-expression-start-p'
8127 ;; are recommended instead.
8129 ;; This function might do hidden buffer changes.
8130 (c-at-statement-start-p))
8131 (make-obsolete 'c-looking-at-bos 'c-at-statement-start-p "22.1")
8133 (defun c-looking-at-inexpr-block (lim containing-sexp &optional check-at-end)
8134 ;; Return non-nil if we're looking at the beginning of a block
8135 ;; inside an expression. The value returned is actually a cons of
8136 ;; either 'inlambda, 'inexpr-statement or 'inexpr-class and the
8137 ;; position of the beginning of the construct.
8139 ;; LIM limits the backward search. CONTAINING-SEXP is the start
8140 ;; position of the closest containing list. If it's nil, the
8141 ;; containing paren isn't used to decide whether we're inside an
8142 ;; expression or not. If both LIM and CONTAINING-SEXP are used, LIM
8143 ;; needs to be farther back.
8145 ;; If CHECK-AT-END is non-nil then extra checks at the end of the
8146 ;; brace block might be done. It should only be used when the
8147 ;; construct can be assumed to be complete, i.e. when the original
8148 ;; starting position was further down than that.
8150 ;; This function might do hidden buffer changes.
8153 (let ((res 'maybe) passed-paren
8154 (closest-lim (or containing-sexp lim (point-min)))
8155 ;; Look at the character after point only as a last resort
8156 ;; when we can't disambiguate.
8157 (block-follows (and (eq (char-after) ?{) (point))))
8159 (while (and (eq res 'maybe)
8160 (progn (c-backward-syntactic-ws)
8161 (> (point) closest-lim))
8163 (progn (backward-char)
8164 (looking-at "[\]\).]\\|\\w\\|\\s_"))
8165 (c-safe (forward-char)
8166 (goto-char (scan-sexps (point) -1))))
8169 (if (looking-at c-keywords-regexp)
8170 (let ((kw-sym (c-keyword-sym (match-string 1))))
8173 (c-keyword-member kw-sym 'c-inexpr-class-kwds))
8174 (and (not (eq passed-paren ?\[))
8175 (or (not (looking-at c-class-key))
8176 ;; If the class definition is at the start of
8177 ;; a statement, we don't consider it an
8178 ;; in-expression class.
8179 (let ((prev (point)))
8181 (= (c-backward-token-2 1 nil closest-lim) 0)
8182 (eq (char-syntax (char-after)) ?w))
8183 (setq prev (point)))
8185 (not (c-at-statement-start-p)))
8186 ;; Also, in Pike we treat it as an
8187 ;; in-expression class if it's used in an
8188 ;; object clone expression.
8191 (c-major-mode-is 'pike-mode)
8192 (progn (goto-char block-follows)
8193 (zerop (c-forward-token-2 1 t)))
8194 (eq (char-after) ?\())))
8195 (cons 'inexpr-class (point))))
8196 ((c-keyword-member kw-sym 'c-inexpr-block-kwds)
8197 (when (not passed-paren)
8198 (cons 'inexpr-statement (point))))
8199 ((c-keyword-member kw-sym 'c-lambda-kwds)
8200 (when (or (not passed-paren)
8201 (eq passed-paren ?\())
8202 (cons 'inlambda (point))))
8203 ((c-keyword-member kw-sym 'c-block-stmt-kwds)
8208 (if (looking-at "\\s(")
8210 (if (and (eq passed-paren ?\[)
8211 (eq (char-after) ?\[))
8212 ;; Accept several square bracket sexps for
8213 ;; Java array initializations.
8215 (setq passed-paren (char-after))
8220 (when (and c-recognize-paren-inexpr-blocks
8223 (eq (char-after containing-sexp) ?\())
8224 (goto-char containing-sexp)
8225 (if (or (save-excursion
8226 (c-backward-syntactic-ws lim)
8227 (and (> (point) (or lim (point-min)))
8229 (and c-special-brace-lists
8230 (c-looking-at-special-brace-list)))
8232 (cons 'inexpr-statement (point))))
8236 (defun c-looking-at-inexpr-block-backward (paren-state)
8237 ;; Returns non-nil if we're looking at the end of an in-expression
8238 ;; block, otherwise the same as `c-looking-at-inexpr-block'.
8239 ;; PAREN-STATE is the paren state relevant at the current position.
8241 ;; This function might do hidden buffer changes.
8243 ;; We currently only recognize a block.
8244 (let ((here (point))
8245 (elem (car-safe paren-state))
8247 (when (and (consp elem)
8248 (progn (goto-char (cdr elem))
8249 (c-forward-syntactic-ws here)
8251 (goto-char (car elem))
8252 (if (setq paren-state (cdr paren-state))
8253 (setq containing-sexp (car-safe paren-state)))
8254 (c-looking-at-inexpr-block (c-safe-position containing-sexp
8256 containing-sexp)))))
8259 ;; `c-guess-basic-syntax' and the functions that precedes it below
8260 ;; implements the main decision tree for determining the syntactic
8261 ;; analysis of the current line of code.
8263 ;; Dynamically bound to t when `c-guess-basic-syntax' is called during
8264 ;; auto newline analysis.
8265 (defvar c-auto-newline-analysis nil)
8267 (defun c-brace-anchor-point (bracepos)
8268 ;; BRACEPOS is the position of a brace in a construct like "namespace
8269 ;; Bar {". Return the anchor point in this construct; this is the
8270 ;; earliest symbol on the brace's line which isn't earlier than
8273 ;; Currently (2007-08-17), "like namespace" means "matches
8274 ;; c-other-block-decl-kwds". It doesn't work with "class" or "struct"
8275 ;; or anything like that.
8277 (let ((boi (c-point 'boi bracepos)))
8278 (goto-char bracepos)
8279 (while (and (> (point) boi)
8280 (not (looking-at c-other-decl-block-key)))
8281 (c-backward-token-2))
8282 (if (> (point) boi) (point) boi))))
8284 (defsubst c-add-syntax (symbol &rest args)
8285 ;; A simple function to prepend a new syntax element to
8286 ;; `c-syntactic-context'. Using `setq' on it is unsafe since it
8287 ;; should always be dynamically bound but since we read it first
8288 ;; we'll fail properly anyway if this function is misused.
8289 (setq c-syntactic-context (cons (cons symbol args)
8290 c-syntactic-context)))
8292 (defsubst c-append-syntax (symbol &rest args)
8293 ;; Like `c-add-syntax' but appends to the end of the syntax list.
8294 ;; (Normally not necessary.)
8295 (setq c-syntactic-context (nconc c-syntactic-context
8296 (list (cons symbol args)))))
8298 (defun c-add-stmt-syntax (syntax-symbol
8303 ;; Add the indicated SYNTAX-SYMBOL to `c-syntactic-context', extending it as
8304 ;; needed with further syntax elements of the types `substatement',
8305 ;; `inexpr-statement', `arglist-cont-nonempty', `statement-block-intro', and
8306 ;; `defun-block-intro'.
8308 ;; Do the generic processing to anchor the given syntax symbol on
8309 ;; the preceding statement: Skip over any labels and containing
8310 ;; statements on the same line, and then search backward until we
8311 ;; find a statement or block start that begins at boi without a
8312 ;; label or comment.
8314 ;; Point is assumed to be at the prospective anchor point for the
8315 ;; given SYNTAX-SYMBOL. More syntax entries are added if we need to
8316 ;; skip past open parens and containing statements. Most of the added
8317 ;; syntax elements will get the same anchor point - the exception is
8318 ;; for an anchor in a construct like "namespace"[*] - this is as early
8319 ;; as possible in the construct but on the same line as the {.
8321 ;; [*] i.e. with a keyword matching c-other-block-decl-kwds.
8323 ;; SYNTAX-EXTRA-ARGS are a list of the extra arguments for the
8324 ;; syntax symbol. They are appended after the anchor point.
8326 ;; If STOP-AT-BOI-ONLY is nil, we can stop in the middle of the line
8327 ;; if the current statement starts there.
8329 ;; Note: It's not a problem if PAREN-STATE "overshoots"
8330 ;; CONTAINING-SEXP, i.e. contains info about parens further down.
8332 ;; This function might do hidden buffer changes.
8334 (if (= (point) (c-point 'boi))
8335 ;; This is by far the most common case, so let's give it special
8337 (apply 'c-add-syntax syntax-symbol (point) syntax-extra-args)
8339 (let ((syntax-last c-syntactic-context)
8340 (boi (c-point 'boi))
8341 ;; Set when we're on a label, so that we don't stop there.
8342 ;; FIXME: To be complete we should check if we're on a label
8343 ;; now at the start.
8346 ;; Use point as the anchor point for "namespace", "extern", etc.
8347 (apply 'c-add-syntax syntax-symbol
8348 (if (rassq syntax-symbol c-other-decl-block-key-in-symbols-alist)
8352 ;; Loop while we have to back out of containing blocks.
8355 (catch 'back-up-block
8357 ;; Loop while we have to back up statements.
8358 (while (or (/= (point) boi)
8360 (looking-at c-comment-start-regexp))
8362 ;; Skip past any comments that stands between the
8363 ;; statement start and boi.
8364 (let ((savepos (point)))
8365 (while (and (/= savepos boi)
8366 (c-backward-single-comment))
8367 (setq savepos (point)
8368 boi (c-point 'boi)))
8369 (goto-char savepos))
8371 ;; Skip to the beginning of this statement or backward
8373 (let ((old-pos (point))
8375 (step-type (c-beginning-of-statement-1 containing-sexp)))
8376 (setq boi (c-point 'boi)
8377 on-label (eq step-type 'label))
8379 (cond ((= (point) old-pos)
8380 ;; If we didn't move we're at the start of a block and
8381 ;; have to continue outside it.
8382 (throw 'back-up-block t))
8384 ((and (eq step-type 'up)
8385 (>= (point) old-boi)
8386 (looking-at "else\\>[^_]")
8389 (looking-at "if\\>[^_]")))
8390 ;; Special case to avoid deeper and deeper indentation
8391 ;; of "else if" clauses.
8394 ((and (not stop-at-boi-only)
8395 (/= old-pos old-boi)
8396 (memq step-type '(up previous)))
8397 ;; If stop-at-boi-only is nil, we shouldn't back up
8398 ;; over previous or containing statements to try to
8399 ;; reach boi, so go back to the last position and
8402 (throw 'back-up-block nil))
8405 (if (and (not stop-at-boi-only)
8406 (memq step-type '(up previous beginning)))
8407 ;; If we've moved into another statement then we
8408 ;; should no longer try to stop in the middle of a
8410 (setq stop-at-boi-only t))
8412 ;; Record this as a substatement if we skipped up one
8414 (when (eq step-type 'up)
8415 (c-add-syntax 'substatement nil))))
8420 ;; Now we have to go out of this block.
8421 (goto-char containing-sexp)
8423 ;; Don't stop in the middle of a special brace list opener
8425 (when c-special-brace-lists
8426 (let ((special-list (c-looking-at-special-brace-list)))
8427 (when (and special-list
8428 (< (car (car special-list)) (point)))
8429 (setq containing-sexp (car (car special-list)))
8430 (goto-char containing-sexp))))
8432 (setq paren-state (c-whack-state-after containing-sexp paren-state)
8433 containing-sexp (c-most-enclosing-brace paren-state)
8436 ;; Analyze the construct in front of the block we've stepped out
8437 ;; from and add the right syntactic element for it.
8438 (let ((paren-pos (point))
8439 (paren-char (char-after))
8442 (if (eq paren-char ?\()
8443 ;; Stepped out of a parenthesis block, so we're in an
8446 (when (/= paren-pos boi)
8447 (if (and c-recognize-paren-inexpr-blocks
8449 (c-backward-syntactic-ws containing-sexp)
8450 (or (not (looking-at "\\>"))
8451 (not (c-on-identifier))))
8453 (goto-char (1+ paren-pos))
8454 (c-forward-syntactic-ws)
8455 (eq (char-after) ?{)))
8456 ;; Stepped out of an in-expression statement. This
8457 ;; syntactic element won't get an anchor pos.
8458 (c-add-syntax 'inexpr-statement)
8460 ;; A parenthesis normally belongs to an arglist.
8461 (c-add-syntax 'arglist-cont-nonempty nil paren-pos)))
8465 (1+ containing-sexp)
8467 (setq step-type 'same
8470 ;; Stepped out of a brace block.
8471 (setq step-type (c-beginning-of-statement-1 containing-sexp)
8472 on-label (eq step-type 'label))
8474 (if (and (eq step-type 'same)
8475 (/= paren-pos (point)))
8479 (goto-char paren-pos)
8480 (setq inexpr (c-looking-at-inexpr-block
8481 (c-safe-position containing-sexp paren-state)
8483 (c-add-syntax (if (eq (car inexpr) 'inlambda)
8485 'statement-block-intro)
8487 ((looking-at c-other-decl-block-key)
8489 (cdr (assoc (match-string 1)
8490 c-other-decl-block-key-in-symbols-alist))
8491 (max (c-point 'boi paren-pos) (point))))
8492 (t (c-add-syntax 'defun-block-intro nil))))
8494 (c-add-syntax 'statement-block-intro nil)))
8496 (if (= paren-pos boi)
8497 ;; Always done if the open brace was at boi. The
8498 ;; c-beginning-of-statement-1 call above is necessary
8499 ;; anyway, to decide the type of block-intro to add.
8500 (goto-char paren-pos)
8501 (setq boi (c-point 'boi)))
8504 ;; Fill in the current point as the anchor for all the symbols
8506 (let ((p c-syntactic-context) q)
8507 (while (not (eq p syntax-last))
8508 (setq q (cdr (car p))) ; e.g. (nil 28) [from (arglist-cont-nonempty nil 28)]
8516 (defun c-add-class-syntax (symbol
8517 containing-decl-open
8518 containing-decl-start
8521 ;; The inclass and class-close syntactic symbols are added in
8522 ;; several places and some work is needed to fix everything.
8523 ;; Therefore it's collected here.
8525 ;; This function might do hidden buffer changes.
8526 (goto-char containing-decl-open)
8527 (if (and (eq symbol 'inclass) (= (point) (c-point 'boi)))
8529 (c-add-syntax symbol containing-decl-open)
8530 containing-decl-open)
8531 (goto-char containing-decl-start)
8532 ;; Ought to use `c-add-stmt-syntax' instead of backing up to boi
8533 ;; here, but we have to do like this for compatibility.
8534 (back-to-indentation)
8535 (c-add-syntax symbol (point))
8536 (if (and (c-keyword-member containing-decl-kwd
8537 'c-inexpr-class-kwds)
8538 (/= containing-decl-start (c-point 'boi containing-decl-start)))
8539 (c-add-syntax 'inexpr-class))
8542 (defun c-guess-continued-construct (indent-point
8544 beg-of-same-or-containing-stmt
8547 ;; This function contains the decision tree reached through both
8548 ;; cases 18 and 10. It's a continued statement or top level
8549 ;; construct of some kind.
8551 ;; This function might do hidden buffer changes.
8553 (let (special-brace-list placeholder)
8554 (goto-char indent-point)
8555 (skip-chars-forward " \t")
8558 ;; (CASE A removed.)
8559 ;; CASE B: open braces for class or brace-lists
8560 ((setq special-brace-list
8561 (or (and c-special-brace-lists
8562 (c-looking-at-special-brace-list))
8563 (eq char-after-ip ?{)))
8566 ;; CASE B.1: class-open
8568 (and (eq (char-after) ?{)
8569 (c-looking-at-decl-block containing-sexp t)
8570 (setq beg-of-same-or-containing-stmt (point))))
8571 (c-add-syntax 'class-open beg-of-same-or-containing-stmt))
8573 ;; CASE B.2: brace-list-open
8574 ((or (consp special-brace-list)
8576 (goto-char beg-of-same-or-containing-stmt)
8577 (c-syntactic-re-search-forward "=\\([^=]\\|$\\)"
8578 indent-point t t t)))
8579 ;; The most semantically accurate symbol here is
8580 ;; brace-list-open, but we normally report it simply as a
8581 ;; statement-cont. The reason is that one normally adjusts
8582 ;; brace-list-open for brace lists as top-level constructs,
8583 ;; and brace lists inside statements is a completely different
8584 ;; context. C.f. case 5A.3.
8585 (c-beginning-of-statement-1 containing-sexp)
8586 (c-add-stmt-syntax (if c-auto-newline-analysis
8587 ;; Turn off the dwim above when we're
8588 ;; analyzing the nature of the brace
8589 ;; for the auto newline feature.
8593 containing-sexp paren-state))
8595 ;; CASE B.3: The body of a function declared inside a normal
8596 ;; block. Can occur e.g. in Pike and when using gcc
8597 ;; extensions, but watch out for macros followed by blocks.
8598 ;; C.f. cases E, 16F and 17G.
8599 ((and (not (c-at-statement-start-p))
8600 (eq (c-beginning-of-statement-1 containing-sexp nil nil t)
8603 (let ((c-recognize-typeless-decls nil))
8604 ;; Turn off recognition of constructs that lacks a
8605 ;; type in this case, since that's more likely to be
8606 ;; a macro followed by a block.
8607 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
8608 (c-add-stmt-syntax 'defun-open nil t
8609 containing-sexp paren-state))
8611 ;; CASE B.4: Continued statement with block open. The most
8612 ;; accurate analysis is perhaps `statement-cont' together with
8613 ;; `block-open' but we play DWIM and use `substatement-open'
8614 ;; instead. The rationaly is that this typically is a macro
8615 ;; followed by a block which makes it very similar to a
8616 ;; statement with a substatement block.
8618 (c-add-stmt-syntax 'substatement-open nil nil
8619 containing-sexp paren-state))
8622 ;; CASE C: iostream insertion or extraction operator
8623 ((and (looking-at "\\(<<\\|>>\\)\\([^=]\\|$\\)")
8625 (goto-char beg-of-same-or-containing-stmt)
8626 ;; If there is no preceding streamop in the statement
8627 ;; then indent this line as a normal statement-cont.
8628 (when (c-syntactic-re-search-forward
8629 "\\(<<\\|>>\\)\\([^=]\\|$\\)" indent-point 'move t t)
8630 (c-add-syntax 'stream-op (c-point 'boi))
8633 ;; CASE E: In the "K&R region" of a function declared inside a
8634 ;; normal block. C.f. case B.3.
8635 ((and (save-excursion
8636 ;; Check that the next token is a '{'. This works as
8637 ;; long as no language that allows nested function
8638 ;; definitions allows stuff like member init lists, K&R
8639 ;; declarations or throws clauses there.
8641 ;; Note that we do a forward search for something ahead
8642 ;; of the indentation line here. That's not good since
8643 ;; the user might not have typed it yet. Unfortunately
8644 ;; it's exceedingly tricky to recognize a function
8645 ;; prototype in a code block without resorting to this.
8646 (c-forward-syntactic-ws)
8647 (eq (char-after) ?{))
8648 (not (c-at-statement-start-p))
8649 (eq (c-beginning-of-statement-1 containing-sexp nil nil t)
8652 (let ((c-recognize-typeless-decls nil))
8653 ;; Turn off recognition of constructs that lacks a
8654 ;; type in this case, since that's more likely to be
8655 ;; a macro followed by a block.
8656 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
8657 (c-add-stmt-syntax 'func-decl-cont nil t
8658 containing-sexp paren-state))
8660 ;;CASE F: continued statement and the only preceding items are
8662 ((and (c-major-mode-is 'java-mode)
8663 (setq placeholder (point))
8664 (c-beginning-of-statement-1)
8666 (while (and (c-forward-annotation)
8667 (< (point) placeholder))
8668 (c-forward-syntactic-ws))
8671 (>= (point) placeholder)
8672 (goto-char placeholder)))
8673 (c-beginning-of-statement-1 containing-sexp)
8674 (c-add-syntax 'annotation-var-cont (point)))
8676 ;; CASE D: continued statement.
8678 (c-beginning-of-statement-1 containing-sexp)
8679 (c-add-stmt-syntax 'statement-cont nil nil
8680 containing-sexp paren-state))
8683 ;; The next autoload was added by RMS on 2005/8/9 - don't know why (ACM,
8686 (defun c-guess-basic-syntax ()
8687 "Return the syntactic context of the current line."
8690 (c-save-buffer-state
8691 ((indent-point (point))
8692 (case-fold-search nil)
8693 ;; A whole ugly bunch of various temporary variables. Have
8694 ;; to declare them here since it's not possible to declare
8695 ;; a variable with only the scope of a cond test and the
8696 ;; following result clauses, and most of this function is a
8697 ;; single gigantic cond. :P
8698 literal char-before-ip before-ws-ip char-after-ip macro-start
8699 in-macro-expr c-syntactic-context placeholder c-in-literal-cache
8700 step-type tmpsymbol keyword injava-inher special-brace-list tmp-pos
8702 ;; The following record some positions for the containing
8703 ;; declaration block if we're directly within one:
8704 ;; `containing-decl-open' is the position of the open
8705 ;; brace. `containing-decl-start' is the start of the
8706 ;; declaration. `containing-decl-kwd' is the keyword
8707 ;; symbol of the keyword that tells what kind of block it
8709 containing-decl-open
8710 containing-decl-start
8712 ;; The open paren of the closest surrounding sexp or nil if
8715 ;; The position after the closest preceding brace sexp
8716 ;; (nested sexps are ignored), or the position after
8717 ;; `containing-sexp' if there is none, or (point-min) if
8718 ;; `containing-sexp' is nil.
8720 ;; The paren state outside `containing-sexp', or at
8721 ;; `indent-point' if `containing-sexp' is nil.
8722 (paren-state (c-parse-state))
8723 ;; There's always at most one syntactic element which got
8724 ;; an anchor pos. It's stored in syntactic-relpos.
8726 (c-stmt-delim-chars c-stmt-delim-chars))
8728 ;; Check if we're directly inside an enclosing declaration
8730 (when (and (setq containing-sexp
8731 (c-most-enclosing-brace paren-state))
8733 (goto-char containing-sexp)
8734 (eq (char-after) ?{))
8736 (c-looking-at-decl-block
8737 (c-most-enclosing-brace paren-state
8740 (setq containing-decl-open containing-sexp
8741 containing-decl-start (point)
8742 containing-sexp nil)
8743 (goto-char placeholder)
8744 (setq containing-decl-kwd (and (looking-at c-keywords-regexp)
8745 (c-keyword-sym (match-string 1)))))
8747 ;; Init some position variables.
8750 (setq containing-sexp (car paren-state)
8751 paren-state (cdr paren-state))
8752 (if (consp containing-sexp)
8754 (setq lim (cdr containing-sexp))
8755 (if (cdr c-state-cache)
8756 ;; Ignore balanced paren. The next entry
8757 ;; can't be another one.
8758 (setq containing-sexp (car (cdr c-state-cache))
8759 paren-state (cdr paren-state))
8760 ;; If there is no surrounding open paren then
8761 ;; put the last balanced pair back on paren-state.
8762 (setq paren-state (cons containing-sexp paren-state)
8763 containing-sexp nil)))
8764 (setq lim (1+ containing-sexp))))
8765 (setq lim (point-min)))
8767 ;; If we're in a parenthesis list then ',' delimits the
8768 ;; "statements" rather than being an operator (with the
8769 ;; exception of the "for" clause). This difference is
8770 ;; typically only noticeable when statements are used in macro
8772 (when (and containing-sexp
8773 (eq (char-after containing-sexp) ?\())
8774 (setq c-stmt-delim-chars c-stmt-delim-chars-with-comma))
8775 ;; cache char before and after indent point, and move point to
8776 ;; the most likely position to perform the majority of tests
8777 (goto-char indent-point)
8778 (c-backward-syntactic-ws lim)
8779 (setq before-ws-ip (point)
8780 char-before-ip (char-before))
8781 (goto-char indent-point)
8782 (skip-chars-forward " \t")
8783 (setq char-after-ip (char-after))
8785 ;; are we in a literal?
8786 (setq literal (c-in-literal lim))
8788 ;; now figure out syntactic qualities of the current line
8791 ;; CASE 1: in a string.
8792 ((eq literal 'string)
8793 (c-add-syntax 'string (c-point 'bopl)))
8795 ;; CASE 2: in a C or C++ style comment.
8796 ((and (memq literal '(c c++))
8797 ;; This is a kludge for XEmacs where we use
8798 ;; `buffer-syntactic-context', which doesn't correctly
8799 ;; recognize "\*/" to end a block comment.
8800 ;; `parse-partial-sexp' which is used by
8801 ;; `c-literal-limits' will however do that in most
8802 ;; versions, which results in that we get nil from
8803 ;; `c-literal-limits' even when `c-in-literal' claims
8804 ;; we're inside a comment.
8805 (setq placeholder (c-literal-limits lim)))
8806 (c-add-syntax literal (car placeholder)))
8808 ;; CASE 3: in a cpp preprocessor macro continuation.
8809 ((and (save-excursion
8810 (when (c-beginning-of-macro)
8811 (setq macro-start (point))))
8812 (/= macro-start (c-point 'boi))
8814 (setq tmpsymbol 'cpp-macro-cont)
8815 (or (not c-syntactic-indentation-in-macros)
8817 (goto-char macro-start)
8818 ;; If at the beginning of the body of a #define
8819 ;; directive then analyze as cpp-define-intro
8820 ;; only. Go on with the syntactic analysis
8821 ;; otherwise. in-macro-expr is set if we're in a
8822 ;; cpp expression, i.e. before the #define body
8823 ;; or anywhere in a non-#define directive.
8824 (if (c-forward-to-cpp-define-body)
8825 (let ((indent-boi (c-point 'boi indent-point)))
8826 (setq in-macro-expr (> (point) indent-boi)
8827 tmpsymbol 'cpp-define-intro)
8828 (= (point) indent-boi))
8829 (setq in-macro-expr t)
8831 (c-add-syntax tmpsymbol macro-start)
8832 (setq macro-start nil))
8834 ;; CASE 11: an else clause?
8835 ((looking-at "else\\>[^_]")
8836 (c-beginning-of-statement-1 containing-sexp)
8837 (c-add-stmt-syntax 'else-clause nil t
8838 containing-sexp paren-state))
8840 ;; CASE 12: while closure of a do/while construct?
8841 ((and (looking-at "while\\>[^_]")
8843 (prog1 (eq (c-beginning-of-statement-1 containing-sexp)
8845 (setq placeholder (point)))))
8846 (goto-char placeholder)
8847 (c-add-stmt-syntax 'do-while-closure nil t
8848 containing-sexp paren-state))
8850 ;; CASE 13: A catch or finally clause? This case is simpler
8851 ;; than if-else and do-while, because a block is required
8852 ;; after every try, catch and finally.
8854 (and (cond ((c-major-mode-is 'c++-mode)
8855 (looking-at "catch\\>[^_]"))
8856 ((c-major-mode-is 'java-mode)
8857 (looking-at "\\(catch\\|finally\\)\\>[^_]")))
8858 (and (c-safe (c-backward-syntactic-ws)
8861 (eq (char-after) ?{)
8862 (c-safe (c-backward-syntactic-ws)
8865 (if (eq (char-after) ?\()
8866 (c-safe (c-backward-sexp) t)
8868 (looking-at "\\(try\\|catch\\)\\>[^_]")
8869 (setq placeholder (point))))
8870 (goto-char placeholder)
8871 (c-add-stmt-syntax 'catch-clause nil t
8872 containing-sexp paren-state))
8874 ;; CASE 18: A substatement we can recognize by keyword.
8876 (and c-opt-block-stmt-key
8877 (not (eq char-before-ip ?\;))
8878 (not (c-at-vsemi-p before-ws-ip))
8879 (not (memq char-after-ip '(?\) ?\] ?,)))
8880 (or (not (eq char-before-ip ?}))
8881 (c-looking-at-inexpr-block-backward c-state-cache))
8884 ;; Ought to cache the result from the
8885 ;; c-beginning-of-statement-1 calls here.
8886 (setq placeholder (point))
8887 (while (eq (setq step-type
8888 (c-beginning-of-statement-1 lim))
8890 (if (eq step-type 'previous)
8891 (goto-char placeholder)
8892 (setq placeholder (point))
8893 (if (and (eq step-type 'same)
8894 (not (looking-at c-opt-block-stmt-key)))
8895 ;; Step up to the containing statement if we
8896 ;; stayed in the same one.
8900 (c-beginning-of-statement-1 lim))
8903 (setq placeholder (point))
8904 ;; There was no containing statement afterall.
8905 (goto-char placeholder)))))
8907 (if (looking-at c-block-stmt-2-key)
8908 ;; Require a parenthesis after these keywords.
8909 ;; Necessary to catch e.g. synchronized in Java,
8910 ;; which can be used both as statement and
8912 (and (zerop (c-forward-token-2 1 nil))
8913 (eq (char-after) ?\())
8914 (looking-at c-opt-block-stmt-key))))
8916 (if (eq step-type 'up)
8917 ;; CASE 18A: Simple substatement.
8919 (goto-char placeholder)
8921 ((eq char-after-ip ?{)
8922 (c-add-stmt-syntax 'substatement-open nil nil
8923 containing-sexp paren-state))
8925 (goto-char indent-point)
8926 (back-to-indentation)
8928 (c-add-stmt-syntax 'substatement-label nil nil
8929 containing-sexp paren-state))
8931 (c-add-stmt-syntax 'substatement nil nil
8932 containing-sexp paren-state))))
8934 ;; CASE 18B: Some other substatement. This is shared
8936 (c-guess-continued-construct indent-point
8942 ;; CASE 14: A case or default label
8943 ((looking-at c-label-kwds-regexp)
8946 (goto-char containing-sexp)
8947 (setq lim (c-most-enclosing-brace c-state-cache
8949 (c-backward-to-block-anchor lim)
8950 (c-add-stmt-syntax 'case-label nil t lim paren-state))
8951 ;; Got a bogus label at the top level. In lack of better
8952 ;; alternatives, anchor it on (point-min).
8953 (c-add-syntax 'case-label (point-min))))
8955 ;; CASE 15: any other label
8957 (back-to-indentation)
8958 (and (not (looking-at c-syntactic-ws-start))
8960 (cond (containing-decl-open
8961 (setq placeholder (c-add-class-syntax 'inclass
8962 containing-decl-open
8963 containing-decl-start
8966 ;; Append access-label with the same anchor point as
8968 (c-append-syntax 'access-label placeholder))
8971 (goto-char containing-sexp)
8972 (setq lim (c-most-enclosing-brace c-state-cache
8976 (if (and (eq (c-beginning-of-statement-1 lim) 'up)
8977 (looking-at "switch\\>[^_]"))
8978 ;; If the surrounding statement is a switch then
8979 ;; let's analyze all labels as switch labels, so
8980 ;; that they get lined up consistently.
8983 (c-backward-to-block-anchor lim)
8984 (c-add-stmt-syntax tmpsymbol nil t lim paren-state))
8987 ;; A label on the top level. Treat it as a class
8988 ;; context. (point-min) is the closest we get to the
8989 ;; class open brace.
8990 (c-add-syntax 'access-label (point-min)))))
8992 ;; CASE 4: In-expression statement. C.f. cases 7B, 16A and
8994 ((setq placeholder (c-looking-at-inexpr-block
8995 (c-safe-position containing-sexp paren-state)
8997 ;; Have to turn on the heuristics after
8998 ;; the point even though it doesn't work
8999 ;; very well. C.f. test case class-16.pike.
9001 (setq tmpsymbol (assq (car placeholder)
9002 '((inexpr-class . class-open)
9003 (inexpr-statement . block-open))))
9005 ;; It's a statement block or an anonymous class.
9006 (setq tmpsymbol (cdr tmpsymbol))
9007 ;; It's a Pike lambda. Check whether we are between the
9008 ;; lambda keyword and the argument list or at the defun
9010 (setq tmpsymbol (if (eq char-after-ip ?{)
9012 'lambda-intro-cont)))
9013 (goto-char (cdr placeholder))
9014 (back-to-indentation)
9015 (c-add-stmt-syntax tmpsymbol nil t
9016 (c-most-enclosing-brace c-state-cache (point))
9018 (unless (eq (point) (cdr placeholder))
9019 (c-add-syntax (car placeholder))))
9021 ;; CASE 5: Line is inside a declaration level block or at top level.
9022 ((or containing-decl-open (null containing-sexp))
9025 ;; CASE 5A: we are looking at a defun, brace list, class,
9026 ;; or inline-inclass method opening brace
9027 ((setq special-brace-list
9028 (or (and c-special-brace-lists
9029 (c-looking-at-special-brace-list))
9030 (eq char-after-ip ?{)))
9033 ;; CASE 5A.1: Non-class declaration block open.
9036 (and (eq char-after-ip ?{)
9037 (setq tmp (c-looking-at-decl-block containing-sexp t))
9039 (setq placeholder (point))
9041 (looking-at c-symbol-key))
9043 (c-keyword-sym (setq keyword (match-string 0)))
9044 'c-other-block-decl-kwds))))
9045 (goto-char placeholder)
9047 (if (string-equal keyword "extern")
9048 ;; Special case for extern-lang-open.
9050 (intern (concat keyword "-open")))
9051 nil t containing-sexp paren-state))
9053 ;; CASE 5A.2: we are looking at a class opening brace
9055 (goto-char indent-point)
9056 (skip-chars-forward " \t")
9057 (and (eq (char-after) ?{)
9058 (c-looking-at-decl-block containing-sexp t)
9059 (setq placeholder (point))))
9060 (c-add-syntax 'class-open placeholder))
9062 ;; CASE 5A.3: brace list open
9064 (c-beginning-of-decl-1 lim)
9065 (while (looking-at c-specifier-key)
9066 (goto-char (match-end 1))
9067 (c-forward-syntactic-ws indent-point))
9068 (setq placeholder (c-point 'boi))
9069 (or (consp special-brace-list)
9070 (and (or (save-excursion
9071 (goto-char indent-point)
9072 (setq tmpsymbol nil)
9073 (while (and (> (point) placeholder)
9074 (zerop (c-backward-token-2 1 t))
9075 (/= (char-after) ?=))
9076 (and c-opt-inexpr-brace-list-key
9078 (looking-at c-opt-inexpr-brace-list-key)
9079 (setq tmpsymbol 'topmost-intro-cont)))
9080 (eq (char-after) ?=))
9081 (looking-at c-brace-list-key))
9083 (while (and (< (point) indent-point)
9084 (zerop (c-forward-token-2 1 t))
9085 (not (memq (char-after) '(?\; ?\()))))
9086 (not (memq (char-after) '(?\; ?\()))
9088 (if (and (not c-auto-newline-analysis)
9089 (c-major-mode-is 'java-mode)
9090 (eq tmpsymbol 'topmost-intro-cont))
9091 ;; We're in Java and have found that the open brace
9092 ;; belongs to a "new Foo[]" initialization list,
9093 ;; which means the brace list is part of an
9094 ;; expression and not a top level definition. We
9095 ;; therefore treat it as any topmost continuation
9096 ;; even though the semantically correct symbol still
9097 ;; is brace-list-open, on the same grounds as in
9100 (c-beginning-of-statement-1 lim)
9101 (c-add-syntax 'topmost-intro-cont (c-point 'boi)))
9102 (c-add-syntax 'brace-list-open placeholder)))
9104 ;; CASE 5A.4: inline defun open
9105 ((and containing-decl-open
9106 (not (c-keyword-member containing-decl-kwd
9107 'c-other-block-decl-kwds)))
9108 (c-add-syntax 'inline-open)
9109 (c-add-class-syntax 'inclass
9110 containing-decl-open
9111 containing-decl-start
9115 ;; CASE 5A.5: ordinary defun open
9118 (c-beginning-of-decl-1 lim)
9119 (while (looking-at c-specifier-key)
9120 (goto-char (match-end 1))
9121 (c-forward-syntactic-ws indent-point))
9122 (c-add-syntax 'defun-open (c-point 'boi))
9123 ;; Bogus to use bol here, but it's the legacy. (Resolved,
9127 ;; CASE 5B: After a function header but before the body (or
9128 ;; the ending semicolon if there's no body).
9130 (when (setq placeholder (c-just-after-func-arglist-p lim))
9131 (setq tmp-pos (point))))
9134 ;; CASE 5B.1: Member init list.
9135 ((eq (char-after tmp-pos) ?:)
9136 (if (or (> tmp-pos indent-point)
9137 (= (c-point 'bosws) (1+ tmp-pos)))
9139 ;; There is no preceding member init clause.
9140 ;; Indent relative to the beginning of indentation
9141 ;; for the topmost-intro line that contains the
9142 ;; prototype's open paren.
9143 (goto-char placeholder)
9144 (c-add-syntax 'member-init-intro (c-point 'boi)))
9145 ;; Indent relative to the first member init clause.
9146 (goto-char (1+ tmp-pos))
9147 (c-forward-syntactic-ws)
9148 (c-add-syntax 'member-init-cont (point))))
9150 ;; CASE 5B.2: K&R arg decl intro
9151 ((and c-recognize-knr-p
9152 (c-in-knr-argdecl lim))
9153 (c-beginning-of-statement-1 lim)
9154 (c-add-syntax 'knr-argdecl-intro (c-point 'boi))
9155 (if containing-decl-open
9156 (c-add-class-syntax 'inclass
9157 containing-decl-open
9158 containing-decl-start
9162 ;; CASE 5B.4: Nether region after a C++ or Java func
9163 ;; decl, which could include a `throws' declaration.
9165 (c-beginning-of-statement-1 lim)
9166 (c-add-syntax 'func-decl-cont (c-point 'boi))
9169 ;; CASE 5C: inheritance line. could be first inheritance
9170 ;; line, or continuation of a multiple inheritance
9171 ((or (and (c-major-mode-is 'c++-mode)
9173 (when (eq char-after-ip ?,)
9174 (skip-chars-forward " \t")
9176 (looking-at c-opt-postfix-decl-spec-key)))
9177 (and (or (eq char-before-ip ?:)
9178 ;; watch out for scope operator
9180 (and (eq char-after-ip ?:)
9181 (c-safe (forward-char 1) t)
9182 (not (eq (char-after) ?:))
9185 (c-backward-syntactic-ws lim)
9186 (if (eq char-before-ip ?:)
9189 (c-backward-syntactic-ws lim)))
9190 (back-to-indentation)
9191 (looking-at c-class-key)))
9193 (and (c-major-mode-is 'java-mode)
9194 (let ((fence (save-excursion
9195 (c-beginning-of-statement-1 lim)
9200 (cond ((looking-at c-opt-postfix-decl-spec-key)
9201 (setq injava-inher (cons cont (point))
9203 ((or (not (c-safe (c-forward-sexp -1) t))
9209 (not (c-crosses-statement-barrier-p (cdr injava-inher)
9214 ;; CASE 5C.1: non-hanging colon on an inher intro
9215 ((eq char-after-ip ?:)
9216 (c-beginning-of-statement-1 lim)
9217 (c-add-syntax 'inher-intro (c-point 'boi))
9218 ;; don't add inclass symbol since relative point already
9219 ;; contains any class offset
9222 ;; CASE 5C.2: hanging colon on an inher intro
9223 ((eq char-before-ip ?:)
9224 (c-beginning-of-statement-1 lim)
9225 (c-add-syntax 'inher-intro (c-point 'boi))
9226 (if containing-decl-open
9227 (c-add-class-syntax 'inclass
9228 containing-decl-open
9229 containing-decl-start
9233 ;; CASE 5C.3: in a Java implements/extends
9235 (let ((where (cdr injava-inher))
9236 (cont (car injava-inher)))
9238 (cond ((looking-at "throws\\>[^_]")
9239 (c-add-syntax 'func-decl-cont
9240 (progn (c-beginning-of-statement-1 lim)
9242 (cont (c-add-syntax 'inher-cont where))
9243 (t (c-add-syntax 'inher-intro
9244 (progn (goto-char (cdr injava-inher))
9245 (c-beginning-of-statement-1 lim)
9249 ;; CASE 5C.4: a continued inheritance line
9251 (c-beginning-of-inheritance-list lim)
9252 (c-add-syntax 'inher-cont (point))
9253 ;; don't add inclass symbol since relative point already
9254 ;; contains any class offset
9257 ;; CASE 5D: this could be a top-level initialization, a
9258 ;; member init list continuation, or a template argument
9259 ;; list continuation.
9261 ;; Note: We use the fact that lim is always after any
9262 ;; preceding brace sexp.
9263 (if c-recognize-<>-arglists
9266 (c-syntactic-skip-backward "^;,=<>" lim t)
9269 (when c-overloadable-operators-regexp
9270 (when (setq placeholder (c-after-special-operator-id lim))
9271 (goto-char placeholder)
9274 ((eq (char-before) ?>)
9275 (or (c-backward-<>-arglist nil lim)
9278 ((eq (char-before) ?<)
9281 (c-forward-<>-arglist nil))
9282 (progn (forward-char)
9286 ;; NB: No c-after-special-operator-id stuff in this
9287 ;; clause - we assume only C++ needs it.
9288 (c-syntactic-skip-backward "^;,=" lim t))
9289 (memq (char-before) '(?, ?= ?<)))
9292 ;; CASE 5D.3: perhaps a template list continuation?
9293 ((and (c-major-mode-is 'c++-mode)
9296 (c-with-syntax-table c++-template-syntax-table
9297 (goto-char indent-point)
9298 (setq placeholder (c-up-list-backward))
9300 (eq (char-after placeholder) ?<))))))
9301 (c-with-syntax-table c++-template-syntax-table
9302 (goto-char placeholder)
9303 (c-beginning-of-statement-1 lim t)
9305 (c-backward-syntactic-ws lim)
9306 (eq (char-before) ?<))
9307 ;; In a nested template arglist.
9309 (goto-char placeholder)
9310 (c-syntactic-skip-backward "^,;" lim t)
9311 (c-forward-syntactic-ws))
9312 (back-to-indentation)))
9313 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
9315 (c-add-syntax 'template-args-cont (point) placeholder))
9317 ;; CASE 5D.4: perhaps a multiple inheritance line?
9318 ((and (c-major-mode-is 'c++-mode)
9320 (c-beginning-of-statement-1 lim)
9321 (setq placeholder (point))
9322 (if (looking-at "static\\>[^_]")
9323 (c-forward-token-2 1 nil indent-point))
9324 (and (looking-at c-class-key)
9325 (zerop (c-forward-token-2 2 nil indent-point))
9326 (if (eq (char-after) ?<)
9327 (c-with-syntax-table c++-template-syntax-table
9328 (zerop (c-forward-token-2 1 t indent-point)))
9330 (eq (char-after) ?:))))
9331 (goto-char placeholder)
9332 (c-add-syntax 'inher-cont (c-point 'boi)))
9334 ;; CASE 5D.5: Continuation of the "expression part" of a
9335 ;; top level construct. Or, perhaps, an unrecognised construct.
9337 (while (and (setq placeholder (point))
9338 (eq (car (c-beginning-of-decl-1 containing-sexp))
9341 (c-backward-syntactic-ws)
9342 (eq (char-before) ?}))
9343 (< (point) placeholder)))
9346 ((eq (point) placeholder) 'statement) ; unrecognised construct
9347 ;; A preceding comma at the top level means that a
9348 ;; new variable declaration starts here. Use
9349 ;; topmost-intro-cont for it, for consistency with
9350 ;; the first variable declaration. C.f. case 5N.
9351 ((eq char-before-ip ?,) 'topmost-intro-cont)
9352 (t 'statement-cont))
9353 nil nil containing-sexp paren-state))
9356 ;; CASE 5F: Close of a non-class declaration level block.
9357 ((and (eq char-after-ip ?})
9358 (c-keyword-member containing-decl-kwd
9359 'c-other-block-decl-kwds))
9360 ;; This is inconsistent: Should use `containing-decl-open'
9361 ;; here if it's at boi, like in case 5J.
9362 (goto-char containing-decl-start)
9364 (if (string-equal (symbol-name containing-decl-kwd) "extern")
9365 ;; Special case for compatibility with the
9366 ;; extern-lang syntactic symbols.
9368 (intern (concat (symbol-name containing-decl-kwd)
9371 (c-most-enclosing-brace paren-state (point))
9374 ;; CASE 5G: we are looking at the brace which closes the
9375 ;; enclosing nested class decl
9376 ((and containing-sexp
9377 (eq char-after-ip ?})
9378 (eq containing-decl-open containing-sexp))
9379 (c-add-class-syntax 'class-close
9380 containing-decl-open
9381 containing-decl-start
9385 ;; CASE 5H: we could be looking at subsequent knr-argdecls
9386 ((and c-recognize-knr-p
9387 (not containing-sexp) ; can't be knr inside braces.
9388 (not (eq char-before-ip ?}))
9390 (setq placeholder (cdr (c-beginning-of-decl-1 lim)))
9392 ;; Do an extra check to avoid tripping up on
9393 ;; statements that occur in invalid contexts
9394 ;; (e.g. in macro bodies where we don't really
9395 ;; know the context of what we're looking at).
9396 (not (and c-opt-block-stmt-key
9397 (looking-at c-opt-block-stmt-key)))))
9398 (< placeholder indent-point))
9399 (goto-char placeholder)
9400 (c-add-syntax 'knr-argdecl (point)))
9402 ;; CASE 5I: ObjC method definition.
9403 ((and c-opt-method-key
9404 (looking-at c-opt-method-key))
9405 (c-beginning-of-statement-1 nil t)
9406 (if (= (point) indent-point)
9407 ;; Handle the case when it's the first (non-comment)
9408 ;; thing in the buffer. Can't look for a 'same return
9409 ;; value from cbos1 since ObjC directives currently
9410 ;; aren't recognized fully, so that we get 'same
9411 ;; instead of 'previous if it moved over a preceding
9413 (goto-char (point-min)))
9414 (c-add-syntax 'objc-method-intro (c-point 'boi)))
9416 ;; CASE 5P: AWK pattern or function or continuation
9418 ((c-major-mode-is 'awk-mode)
9419 (setq placeholder (point))
9421 (if (and (eq (c-beginning-of-statement-1) 'same)
9422 (/= (point) placeholder))
9426 containing-sexp paren-state))
9428 ;; CASE 5N: At a variable declaration that follows a class
9429 ;; definition or some other block declaration that doesn't
9430 ;; end at the closing '}'. C.f. case 5D.5.
9432 (c-backward-syntactic-ws lim)
9433 (and (eq (char-before) ?})
9435 (let ((start (point)))
9436 (if (and c-state-cache
9437 (consp (car c-state-cache))
9438 (eq (cdar c-state-cache) (point)))
9439 ;; Speed up the backward search a bit.
9440 (goto-char (caar c-state-cache)))
9441 (c-beginning-of-decl-1 containing-sexp)
9442 (setq placeholder (point))
9443 (if (= start (point))
9444 ;; The '}' is unbalanced.
9447 (>= (point) indent-point))))))
9448 (goto-char placeholder)
9449 (c-add-stmt-syntax 'topmost-intro-cont nil nil
9450 containing-sexp paren-state))
9452 ;; NOTE: The point is at the end of the previous token here.
9454 ;; CASE 5J: we are at the topmost level, make
9455 ;; sure we skip back past any access specifiers
9457 ;; A macro continuation line is never at top level.
9458 (not (and macro-start
9459 (> indent-point macro-start)))
9461 (setq placeholder (point))
9462 (or (memq char-before-ip '(?\; ?{ ?} nil))
9463 (c-at-vsemi-p before-ws-ip)
9464 (when (and (eq char-before-ip ?:)
9465 (eq (c-beginning-of-statement-1 lim)
9467 (c-backward-syntactic-ws lim)
9468 (setq placeholder (point)))
9469 (and (c-major-mode-is 'objc-mode)
9470 (catch 'not-in-directive
9471 (c-beginning-of-statement-1 lim)
9472 (setq placeholder (point))
9473 (while (and (c-forward-objc-directive)
9474 (< (point) indent-point))
9475 (c-forward-syntactic-ws)
9476 (if (>= (point) indent-point)
9477 (throw 'not-in-directive t))
9478 (setq placeholder (point)))
9480 ;; For historic reasons we anchor at bol of the last
9481 ;; line of the previous declaration. That's clearly
9482 ;; highly bogus and useless, and it makes our lives hard
9483 ;; to remain compatible. :P
9484 (goto-char placeholder)
9485 (c-add-syntax 'topmost-intro (c-point 'bol))
9486 (if containing-decl-open
9487 (if (c-keyword-member containing-decl-kwd
9488 'c-other-block-decl-kwds)
9490 (goto-char (c-brace-anchor-point containing-decl-open))
9492 (if (string-equal (symbol-name containing-decl-kwd)
9494 ;; Special case for compatibility with the
9495 ;; extern-lang syntactic symbols.
9497 (intern (concat "in"
9498 (symbol-name containing-decl-kwd))))
9500 (c-most-enclosing-brace paren-state (point))
9502 (c-add-class-syntax 'inclass
9503 containing-decl-open
9504 containing-decl-start
9507 (when (and c-syntactic-indentation-in-macros
9509 (/= macro-start (c-point 'boi indent-point)))
9510 (c-add-syntax 'cpp-define-intro)
9511 (setq macro-start nil)))
9513 ;; CASE 5K: we are at an ObjC method definition
9514 ;; continuation line.
9515 ((and c-opt-method-key
9517 (c-beginning-of-statement-1 lim)
9519 (when (looking-at c-opt-method-key)
9520 (setq placeholder (point)))))
9521 (c-add-syntax 'objc-method-args-cont placeholder))
9523 ;; CASE 5L: we are at the first argument of a template
9524 ;; arglist that begins on the previous line.
9525 ((and c-recognize-<>-arglists
9526 (eq (char-before) ?<)
9527 (not (and c-overloadable-operators-regexp
9528 (c-after-special-operator-id lim))))
9529 (c-beginning-of-statement-1 (c-safe-position (point) paren-state))
9530 (c-add-syntax 'template-args-cont (c-point 'boi)))
9532 ;; CASE 5Q: we are at a statement within a macro.
9534 (c-beginning-of-statement-1 containing-sexp)
9535 (c-add-stmt-syntax 'statement nil t containing-sexp paren-state))
9537 ;;CASE 5N: We are at a tompmost continuation line and the only
9538 ;;preceding items are annotations.
9539 ((and (c-major-mode-is 'java-mode)
9540 (setq placeholder (point))
9541 (c-beginning-of-statement-1)
9543 (while (and (c-forward-annotation))
9544 (c-forward-syntactic-ws))
9547 (>= (point) placeholder)
9548 (goto-char placeholder)))
9549 (c-add-syntax 'annotation-top-cont (c-point 'boi)))
9551 ;; CASE 5M: we are at a topmost continuation line
9553 (c-beginning-of-statement-1 (c-safe-position (point) paren-state))
9554 (when (c-major-mode-is 'objc-mode)
9555 (setq placeholder (point))
9556 (while (and (c-forward-objc-directive)
9557 (< (point) indent-point))
9558 (c-forward-syntactic-ws)
9559 (setq placeholder (point)))
9560 (goto-char placeholder))
9561 (c-add-syntax 'topmost-intro-cont (c-point 'boi)))
9565 ;; (CASE 6 has been removed.)
9567 ;; CASE 7: line is an expression, not a statement. Most
9568 ;; likely we are either in a function prototype or a function
9569 ;; call argument list
9570 ((not (or (and c-special-brace-lists
9572 (goto-char containing-sexp)
9573 (c-looking-at-special-brace-list)))
9574 (eq (char-after containing-sexp) ?{)))
9577 ;; CASE 7A: we are looking at the arglist closing paren.
9579 ((memq char-after-ip '(?\) ?\]))
9580 (goto-char containing-sexp)
9581 (setq placeholder (c-point 'boi))
9582 (if (and (c-safe (backward-up-list 1) t)
9583 (>= (point) placeholder))
9586 (skip-chars-forward " \t"))
9587 (goto-char placeholder))
9588 (c-add-stmt-syntax 'arglist-close (list containing-sexp) t
9589 (c-most-enclosing-brace paren-state (point))
9592 ;; CASE 19: line is an expression, not a statement, and is directly
9593 ;; contained by a template delimiter. Most likely, we are in a
9594 ;; template arglist within a statement. This case is based on CASE
9595 ;; 7. At some point in the future, we may wish to create more
9596 ;; syntactic symbols such as `template-intro',
9597 ;; `template-cont-nonempty', etc., and distinguish between them as we
9598 ;; do for `arglist-intro' etc. (2009-12-07).
9599 ((and c-recognize-<>-arglists
9600 (setq containing-< (c-up-list-backward indent-point containing-sexp))
9601 (eq (char-after containing-<) ?\<))
9602 (setq placeholder (c-point 'boi containing-<))
9603 (goto-char containing-sexp) ; Most nested Lbrace/Lparen (but not
9604 ; '<') before indent-point.
9605 (if (>= (point) placeholder)
9608 (skip-chars-forward " \t"))
9609 (goto-char placeholder))
9610 (c-add-stmt-syntax 'template-args-cont (list containing-<) t
9611 (c-most-enclosing-brace c-state-cache (point))
9614 ;; CASE 7B: Looking at the opening brace of an
9615 ;; in-expression block or brace list. C.f. cases 4, 16A
9617 ((and (eq char-after-ip ?{)
9619 (setq placeholder (c-inside-bracelist-p (point)
9622 (setq tmpsymbol '(brace-list-open . inexpr-class))
9623 (setq tmpsymbol '(block-open . inexpr-statement)
9625 (cdr-safe (c-looking-at-inexpr-block
9626 (c-safe-position containing-sexp
9629 ;; placeholder is nil if it's a block directly in
9630 ;; a function arglist. That makes us skip out of
9633 (goto-char placeholder)
9634 (back-to-indentation)
9635 (c-add-stmt-syntax (car tmpsymbol) nil t
9636 (c-most-enclosing-brace paren-state (point))
9638 (if (/= (point) placeholder)
9639 (c-add-syntax (cdr tmpsymbol))))
9641 ;; CASE 7C: we are looking at the first argument in an empty
9642 ;; argument list. Use arglist-close if we're actually
9643 ;; looking at a close paren or bracket.
9644 ((memq char-before-ip '(?\( ?\[))
9645 (goto-char containing-sexp)
9646 (setq placeholder (c-point 'boi))
9647 (if (and (c-safe (backward-up-list 1) t)
9648 (>= (point) placeholder))
9651 (skip-chars-forward " \t"))
9652 (goto-char placeholder))
9653 (c-add-stmt-syntax 'arglist-intro (list containing-sexp) t
9654 (c-most-enclosing-brace paren-state (point))
9657 ;; CASE 7D: we are inside a conditional test clause. treat
9658 ;; these things as statements
9660 (goto-char containing-sexp)
9661 (and (c-safe (c-forward-sexp -1) t)
9662 (looking-at "\\<for\\>[^_]")))
9663 (goto-char (1+ containing-sexp))
9664 (c-forward-syntactic-ws indent-point)
9665 (if (eq char-before-ip ?\;)
9666 (c-add-syntax 'statement (point))
9667 (c-add-syntax 'statement-cont (point))
9670 ;; CASE 7E: maybe a continued ObjC method call. This is the
9671 ;; case when we are inside a [] bracketed exp, and what
9672 ;; precede the opening bracket is not an identifier.
9673 ((and c-opt-method-key
9674 (eq (char-after containing-sexp) ?\[)
9676 (goto-char (1- containing-sexp))
9677 (c-backward-syntactic-ws (c-point 'bod))
9678 (if (not (looking-at c-symbol-key))
9679 (c-add-syntax 'objc-method-call-cont containing-sexp))
9682 ;; CASE 7F: we are looking at an arglist continuation line,
9683 ;; but the preceding argument is on the same line as the
9684 ;; opening paren. This case includes multi-line
9685 ;; mathematical paren groupings, but we could be on a
9686 ;; for-list continuation line. C.f. case 7A.
9688 (goto-char (1+ containing-sexp))
9690 (c-forward-syntactic-ws)
9693 (goto-char containing-sexp) ; paren opening the arglist
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-cont-nonempty (list containing-sexp) t
9702 (c-most-enclosing-brace c-state-cache (point))
9705 ;; CASE 7G: we are looking at just a normal arglist
9706 ;; continuation line
9707 (t (c-forward-syntactic-ws indent-point)
9708 (c-add-syntax 'arglist-cont (c-point 'boi)))
9711 ;; CASE 8: func-local multi-inheritance line
9712 ((and (c-major-mode-is 'c++-mode)
9714 (goto-char indent-point)
9715 (skip-chars-forward " \t")
9716 (looking-at c-opt-postfix-decl-spec-key)))
9717 (goto-char indent-point)
9718 (skip-chars-forward " \t")
9721 ;; CASE 8A: non-hanging colon on an inher intro
9722 ((eq char-after-ip ?:)
9723 (c-backward-syntactic-ws lim)
9724 (c-add-syntax 'inher-intro (c-point 'boi)))
9726 ;; CASE 8B: hanging colon on an inher intro
9727 ((eq char-before-ip ?:)
9728 (c-add-syntax 'inher-intro (c-point 'boi)))
9730 ;; CASE 8C: a continued inheritance line
9732 (c-beginning-of-inheritance-list lim)
9733 (c-add-syntax 'inher-cont (point))
9736 ;; CASE 9: we are inside a brace-list
9737 ((and (not (c-major-mode-is 'awk-mode)) ; Maybe this isn't needed (ACM, 2002/3/29)
9738 (setq special-brace-list
9739 (or (and c-special-brace-lists ;;;; ALWAYS NIL FOR AWK!!
9741 (goto-char containing-sexp)
9742 (c-looking-at-special-brace-list)))
9743 (c-inside-bracelist-p containing-sexp paren-state))))
9746 ;; CASE 9A: In the middle of a special brace list opener.
9747 ((and (consp special-brace-list)
9749 (goto-char containing-sexp)
9750 (eq (char-after) ?\())
9751 (eq char-after-ip (car (cdr special-brace-list))))
9752 (goto-char (car (car special-brace-list)))
9753 (skip-chars-backward " \t")
9755 (assoc 'statement-cont
9756 (setq placeholder (c-guess-basic-syntax))))
9757 (setq c-syntactic-context placeholder)
9758 (c-beginning-of-statement-1
9759 (c-safe-position (1- containing-sexp) paren-state))
9760 (c-forward-token-2 0)
9761 (while (looking-at c-specifier-key)
9762 (goto-char (match-end 1))
9763 (c-forward-syntactic-ws))
9764 (c-add-syntax 'brace-list-open (c-point 'boi))))
9766 ;; CASE 9B: brace-list-close brace
9767 ((if (consp special-brace-list)
9768 ;; Check special brace list closer.
9770 (goto-char (car (car special-brace-list)))
9772 (goto-char indent-point)
9773 (back-to-indentation)
9775 ;; We were between the special close char and the `)'.
9776 (and (eq (char-after) ?\))
9777 (eq (1+ (point)) (cdr (car special-brace-list))))
9778 ;; We were before the special close char.
9779 (and (eq (char-after) (cdr (cdr special-brace-list)))
9780 (zerop (c-forward-token-2))
9781 (eq (1+ (point)) (cdr (car special-brace-list)))))))
9782 ;; Normal brace list check.
9783 (and (eq char-after-ip ?})
9784 (c-safe (goto-char (c-up-list-backward (point))) t)
9785 (= (point) containing-sexp)))
9786 (if (eq (point) (c-point 'boi))
9787 (c-add-syntax 'brace-list-close (point))
9788 (setq lim (c-most-enclosing-brace c-state-cache (point)))
9789 (c-beginning-of-statement-1 lim)
9790 (c-add-stmt-syntax 'brace-list-close nil t lim paren-state)))
9793 ;; Prepare for the rest of the cases below by going to the
9794 ;; token following the opening brace
9795 (if (consp special-brace-list)
9797 (goto-char (car (car special-brace-list)))
9798 (c-forward-token-2 1 nil indent-point))
9799 (goto-char containing-sexp))
9801 (let ((start (point)))
9802 (c-forward-syntactic-ws indent-point)
9803 (goto-char (max start (c-point 'bol))))
9804 (c-skip-ws-forward indent-point)
9807 ;; CASE 9C: we're looking at the first line in a brace-list
9808 ((= (point) indent-point)
9809 (if (consp special-brace-list)
9810 (goto-char (car (car special-brace-list)))
9811 (goto-char containing-sexp))
9812 (if (eq (point) (c-point 'boi))
9813 (c-add-syntax 'brace-list-intro (point))
9814 (setq lim (c-most-enclosing-brace c-state-cache (point)))
9815 (c-beginning-of-statement-1 lim)
9816 (c-add-stmt-syntax 'brace-list-intro nil t lim paren-state)))
9818 ;; CASE 9D: this is just a later brace-list-entry or
9820 (t (if (or (eq char-after-ip ?{)
9821 (and c-special-brace-lists
9823 (goto-char indent-point)
9824 (c-forward-syntactic-ws (c-point 'eol))
9825 (c-looking-at-special-brace-list (point)))))
9826 (c-add-syntax 'brace-entry-open (point))
9827 (c-add-syntax 'brace-list-entry (point))
9831 ;; CASE 10: A continued statement or top level construct.
9832 ((and (not (memq char-before-ip '(?\; ?:)))
9833 (not (c-at-vsemi-p before-ws-ip))
9834 (or (not (eq char-before-ip ?}))
9835 (c-looking-at-inexpr-block-backward c-state-cache))
9838 (c-beginning-of-statement-1 containing-sexp)
9839 (setq placeholder (point))))
9840 (/= placeholder containing-sexp))
9841 ;; This is shared with case 18.
9842 (c-guess-continued-construct indent-point
9848 ;; CASE 16: block close brace, possibly closing the defun or
9850 ((eq char-after-ip ?})
9851 ;; From here on we have the next containing sexp in lim.
9852 (setq lim (c-most-enclosing-brace paren-state))
9853 (goto-char containing-sexp)
9856 ;; CASE 16E: Closing a statement block? This catches
9857 ;; cases where it's preceded by a statement keyword,
9858 ;; which works even when used in an "invalid" context,
9859 ;; e.g. a macro argument.
9860 ((c-after-conditional)
9861 (c-backward-to-block-anchor lim)
9862 (c-add-stmt-syntax 'block-close nil t lim paren-state))
9864 ;; CASE 16A: closing a lambda defun or an in-expression
9865 ;; block? C.f. cases 4, 7B and 17E.
9866 ((setq placeholder (c-looking-at-inexpr-block
9867 (c-safe-position containing-sexp paren-state)
9869 (setq tmpsymbol (if (eq (car placeholder) 'inlambda)
9872 (goto-char containing-sexp)
9873 (back-to-indentation)
9874 (if (= containing-sexp (point))
9875 (c-add-syntax tmpsymbol (point))
9876 (goto-char (cdr placeholder))
9877 (back-to-indentation)
9878 (c-add-stmt-syntax tmpsymbol nil t
9879 (c-most-enclosing-brace paren-state (point))
9881 (if (/= (point) (cdr placeholder))
9882 (c-add-syntax (car placeholder)))))
9884 ;; CASE 16B: does this close an inline or a function in
9885 ;; a non-class declaration level block?
9890 (c-looking-at-decl-block
9891 (c-most-enclosing-brace paren-state lim)
9893 (setq placeholder (point))))
9894 (c-backward-to-decl-anchor lim)
9895 (back-to-indentation)
9897 (goto-char placeholder)
9898 (looking-at c-other-decl-block-key))
9899 (c-add-syntax 'defun-close (point))
9900 (c-add-syntax 'inline-close (point))))
9902 ;; CASE 16F: Can be a defun-close of a function declared
9903 ;; in a statement block, e.g. in Pike or when using gcc
9904 ;; extensions, but watch out for macros followed by
9905 ;; blocks. Let it through to be handled below.
9906 ;; C.f. cases B.3 and 17G.
9908 (and (not (c-at-statement-start-p))
9909 (eq (c-beginning-of-statement-1 lim nil nil t) 'same)
9910 (setq placeholder (point))
9911 (let ((c-recognize-typeless-decls nil))
9912 ;; Turn off recognition of constructs that
9913 ;; lacks a type in this case, since that's more
9914 ;; likely to be a macro followed by a block.
9915 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
9916 (back-to-indentation)
9917 (if (/= (point) containing-sexp)
9918 (goto-char placeholder))
9919 (c-add-stmt-syntax 'defun-close nil t lim paren-state))
9921 ;; CASE 16C: If there is an enclosing brace then this is
9922 ;; a block close since defun closes inside declaration
9923 ;; level blocks have been handled above.
9925 ;; If the block is preceded by a case/switch label on
9926 ;; the same line, we anchor at the first preceding label
9927 ;; at boi. The default handling in c-add-stmt-syntax
9928 ;; really fixes it better, but we do like this to keep
9929 ;; the indentation compatible with version 5.28 and
9930 ;; earlier. C.f. case 17H.
9931 (while (and (/= (setq placeholder (point)) (c-point 'boi))
9932 (eq (c-beginning-of-statement-1 lim) 'label)))
9933 (goto-char placeholder)
9934 (if (looking-at c-label-kwds-regexp)
9935 (c-add-syntax 'block-close (point))
9936 (goto-char containing-sexp)
9937 ;; c-backward-to-block-anchor not necessary here; those
9938 ;; situations are handled in case 16E above.
9939 (c-add-stmt-syntax 'block-close nil t lim paren-state)))
9941 ;; CASE 16D: Only top level defun close left.
9943 (goto-char containing-sexp)
9944 (c-backward-to-decl-anchor lim)
9945 (c-add-stmt-syntax 'defun-close nil nil
9946 (c-most-enclosing-brace paren-state)
9950 ;; CASE 17: Statement or defun catchall.
9952 (goto-char indent-point)
9953 ;; Back up statements until we find one that starts at boi.
9954 (while (let* ((prev-point (point))
9955 (last-step-type (c-beginning-of-statement-1
9957 (if (= (point) prev-point)
9959 (setq step-type (or step-type last-step-type))
9961 (setq step-type last-step-type)
9962 (/= (point) (c-point 'boi)))))
9965 ;; CASE 17B: continued statement
9966 ((and (eq step-type 'same)
9967 (/= (point) indent-point))
9968 (c-add-stmt-syntax 'statement-cont nil nil
9969 containing-sexp paren-state))
9971 ;; CASE 17A: After a case/default label?
9973 (while (and (eq step-type 'label)
9974 (not (looking-at c-label-kwds-regexp)))
9976 (c-beginning-of-statement-1 containing-sexp)))
9977 (eq step-type 'label))
9978 (c-add-stmt-syntax (if (eq char-after-ip ?{)
9979 'statement-case-open
9980 'statement-case-intro)
9981 nil t containing-sexp paren-state))
9983 ;; CASE 17D: any old statement
9985 (while (eq step-type 'label)
9987 (c-beginning-of-statement-1 containing-sexp)))
9988 (eq step-type 'previous))
9989 (c-add-stmt-syntax 'statement nil t
9990 containing-sexp paren-state)
9991 (if (eq char-after-ip ?{)
9992 (c-add-syntax 'block-open)))
9994 ;; CASE 17I: Inside a substatement block.
9996 ;; The following tests are all based on containing-sexp.
9997 (goto-char containing-sexp)
9998 ;; From here on we have the next containing sexp in lim.
9999 (setq lim (c-most-enclosing-brace paren-state containing-sexp))
10000 (c-after-conditional))
10001 (c-backward-to-block-anchor lim)
10002 (c-add-stmt-syntax 'statement-block-intro nil t
10004 (if (eq char-after-ip ?{)
10005 (c-add-syntax 'block-open)))
10007 ;; CASE 17E: first statement in an in-expression block.
10008 ;; C.f. cases 4, 7B and 16A.
10009 ((setq placeholder (c-looking-at-inexpr-block
10010 (c-safe-position containing-sexp paren-state)
10012 (setq tmpsymbol (if (eq (car placeholder) 'inlambda)
10014 'statement-block-intro))
10015 (back-to-indentation)
10016 (if (= containing-sexp (point))
10017 (c-add-syntax tmpsymbol (point))
10018 (goto-char (cdr placeholder))
10019 (back-to-indentation)
10020 (c-add-stmt-syntax tmpsymbol nil t
10021 (c-most-enclosing-brace c-state-cache (point))
10023 (if (/= (point) (cdr placeholder))
10024 (c-add-syntax (car placeholder))))
10025 (if (eq char-after-ip ?{)
10026 (c-add-syntax 'block-open)))
10028 ;; CASE 17F: first statement in an inline, or first
10029 ;; statement in a top-level defun. we can tell this is it
10030 ;; if there are no enclosing braces that haven't been
10031 ;; narrowed out by a class (i.e. don't use bod here).
10033 (or (not (setq placeholder (c-most-enclosing-brace
10036 (goto-char placeholder)
10037 (eq (char-after) ?{))
10038 (c-looking-at-decl-block (c-most-enclosing-brace
10039 paren-state (point))
10041 (c-backward-to-decl-anchor lim)
10042 (back-to-indentation)
10043 (c-add-syntax 'defun-block-intro (point)))
10045 ;; CASE 17G: First statement in a function declared inside
10046 ;; a normal block. This can occur in Pike and with
10047 ;; e.g. the gcc extensions, but watch out for macros
10048 ;; followed by blocks. C.f. cases B.3 and 16F.
10050 (and (not (c-at-statement-start-p))
10051 (eq (c-beginning-of-statement-1 lim nil nil t) 'same)
10052 (setq placeholder (point))
10053 (let ((c-recognize-typeless-decls nil))
10054 ;; Turn off recognition of constructs that lacks
10055 ;; a type in this case, since that's more likely
10056 ;; to be a macro followed by a block.
10057 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
10058 (back-to-indentation)
10059 (if (/= (point) containing-sexp)
10060 (goto-char placeholder))
10061 (c-add-stmt-syntax 'defun-block-intro nil t
10064 ;; CASE 17H: First statement in a block.
10066 ;; If the block is preceded by a case/switch label on the
10067 ;; same line, we anchor at the first preceding label at
10068 ;; boi. The default handling in c-add-stmt-syntax is
10069 ;; really fixes it better, but we do like this to keep the
10070 ;; indentation compatible with version 5.28 and earlier.
10072 (while (and (/= (setq placeholder (point)) (c-point 'boi))
10073 (eq (c-beginning-of-statement-1 lim) 'label)))
10074 (goto-char placeholder)
10075 (if (looking-at c-label-kwds-regexp)
10076 (c-add-syntax 'statement-block-intro (point))
10077 (goto-char containing-sexp)
10078 ;; c-backward-to-block-anchor not necessary here; those
10079 ;; situations are handled in case 17I above.
10080 (c-add-stmt-syntax 'statement-block-intro nil t
10082 (if (eq char-after-ip ?{)
10083 (c-add-syntax 'block-open)))
10087 ;; now we need to look at any modifiers
10088 (goto-char indent-point)
10089 (skip-chars-forward " \t")
10091 ;; are we looking at a comment only line?
10092 (when (and (looking-at c-comment-start-regexp)
10093 (/= (c-forward-token-2 0 nil (c-point 'eol)) 0))
10094 (c-append-syntax 'comment-intro))
10096 ;; we might want to give additional offset to friends (in C++).
10097 (when (and c-opt-friend-key
10098 (looking-at c-opt-friend-key))
10099 (c-append-syntax 'friend))
10101 ;; Set syntactic-relpos.
10102 (let ((p c-syntactic-context))
10104 (if (integerp (c-langelem-pos (car p)))
10106 (setq syntactic-relpos (c-langelem-pos (car p)))
10111 ;; Start of or a continuation of a preprocessor directive?
10112 (if (and macro-start
10113 (eq macro-start (c-point 'boi))
10114 (not (and (c-major-mode-is 'pike-mode)
10115 (eq (char-after (1+ macro-start)) ?\"))))
10116 (c-append-syntax 'cpp-macro)
10117 (when (and c-syntactic-indentation-in-macros macro-start)
10120 (< syntactic-relpos macro-start)
10122 (assq 'arglist-intro c-syntactic-context)
10123 (assq 'arglist-cont c-syntactic-context)
10124 (assq 'arglist-cont-nonempty c-syntactic-context)
10125 (assq 'arglist-close c-syntactic-context))))
10126 ;; If inside a cpp expression, i.e. anywhere in a
10127 ;; cpp directive except a #define body, we only let
10128 ;; through the syntactic analysis that is internal
10129 ;; in the expression. That means the arglist
10130 ;; elements, if they are anchored inside the cpp
10132 (setq c-syntactic-context nil)
10133 (c-add-syntax 'cpp-macro-cont macro-start))
10134 (when (and (eq macro-start syntactic-relpos)
10135 (not (assq 'cpp-define-intro c-syntactic-context))
10137 (goto-char macro-start)
10138 (or (not (c-forward-to-cpp-define-body))
10139 (<= (point) (c-point 'boi indent-point)))))
10140 ;; Inside a #define body and the syntactic analysis is
10141 ;; anchored on the start of the #define. In this case
10142 ;; we add cpp-define-intro to get the extra
10143 ;; indentation of the #define body.
10144 (c-add-syntax 'cpp-define-intro)))))
10146 ;; return the syntax
10147 c-syntactic-context)))
10150 ;; Indentation calculation.
10152 (defun c-evaluate-offset (offset langelem symbol)
10153 ;; offset can be a number, a function, a variable, a list, or one of
10154 ;; the symbols + or -
10156 ;; This function might do hidden buffer changes.
10159 ((numberp offset) offset)
10160 ((vectorp offset) offset)
10161 ((null offset) nil)
10163 ((eq offset '+) c-basic-offset)
10164 ((eq offset '-) (- c-basic-offset))
10165 ((eq offset '++) (* 2 c-basic-offset))
10166 ((eq offset '--) (* 2 (- c-basic-offset)))
10167 ((eq offset '*) (/ c-basic-offset 2))
10168 ((eq offset '/) (/ (- c-basic-offset) 2))
10170 ((functionp offset)
10173 (cons (c-langelem-sym langelem)
10174 (c-langelem-pos langelem)))
10179 ((eq (car offset) 'quote)
10180 (c-benign-error "The offset %S for %s was mistakenly quoted"
10184 ((memq (car offset) '(min max))
10185 (let (res val (method (car offset)))
10186 (setq offset (cdr offset))
10188 (setq val (c-evaluate-offset (car offset) langelem symbol))
10196 Error evaluating offset %S for %s: \
10197 Cannot combine absolute offset %S with relative %S in `%s' method"
10198 (car offset) symbol res val method)
10199 (setq res (funcall method res val))))
10203 Error evaluating offset %S for %s: \
10204 Cannot combine relative offset %S with absolute %S in `%s' method"
10205 (car offset) symbol res val method)
10206 (setq res (vector (funcall method (aref res 0)
10208 (setq offset (cdr offset)))
10211 ((eq (car offset) 'add)
10213 (setq offset (cdr offset))
10215 (setq val (c-evaluate-offset (car offset) langelem symbol))
10222 (setq res (vector (+ (aref res 0) val)))
10223 (setq res (+ res val))))
10227 Error evaluating offset %S for %s: \
10228 Cannot combine absolute offsets %S and %S in `add' method"
10229 (car offset) symbol res val)
10230 (setq res val)))) ; Override.
10231 (setq offset (cdr offset)))
10236 (when (eq (car offset) 'first)
10237 (setq offset (cdr offset)))
10238 (while (and (not res) offset)
10239 (setq res (c-evaluate-offset (car offset) langelem symbol)
10240 offset (cdr offset)))
10243 ((and (symbolp offset) (boundp offset))
10244 (symbol-value offset))
10247 (c-benign-error "Unknown offset format %S for %s" offset symbol)
10250 (if (or (null res) (integerp res)
10251 (and (vectorp res) (= (length res) 1) (integerp (aref res 0))))
10253 (c-benign-error "Error evaluating offset %S for %s: Got invalid value %S"
10257 (defun c-calc-offset (langelem)
10258 ;; Get offset from LANGELEM which is a list beginning with the
10259 ;; syntactic symbol and followed by any analysis data it provides.
10260 ;; That data may be zero or more elements, but if at least one is
10261 ;; given then the first is the anchor position (or nil). The symbol
10262 ;; is matched against `c-offsets-alist' and the offset calculated
10263 ;; from that is returned.
10265 ;; This function might do hidden buffer changes.
10266 (let* ((symbol (c-langelem-sym langelem))
10267 (match (assq symbol c-offsets-alist))
10268 (offset (cdr-safe match)))
10270 (setq offset (c-evaluate-offset offset langelem symbol))
10271 (if c-strict-syntax-p
10272 (c-benign-error "No offset found for syntactic symbol %s" symbol))
10274 (if (vectorp offset)
10276 (or (and (numberp offset) offset)
10277 (and (symbolp offset) (symbol-value offset))
10281 (defun c-get-offset (langelem)
10282 ;; This is a compatibility wrapper for `c-calc-offset' in case
10283 ;; someone is calling it directly. It takes an old style syntactic
10284 ;; element on the form (SYMBOL . ANCHOR-POS) and converts it to the
10287 ;; This function might do hidden buffer changes.
10288 (if (c-langelem-pos langelem)
10289 (c-calc-offset (list (c-langelem-sym langelem)
10290 (c-langelem-pos langelem)))
10291 (c-calc-offset langelem)))
10293 (defun c-get-syntactic-indentation (langelems)
10294 ;; Calculate the syntactic indentation from a syntactic description
10295 ;; as returned by `c-guess-syntax'.
10297 ;; Note that topmost-intro always has an anchor position at bol, for
10298 ;; historical reasons. It's often used together with other symbols
10299 ;; that has more sane positions. Since we always use the first
10300 ;; found anchor position, we rely on that these other symbols always
10301 ;; precede topmost-intro in the LANGELEMS list.
10303 ;; This function might do hidden buffer changes.
10304 (let ((indent 0) anchor)
10307 (let* ((c-syntactic-element (car langelems))
10308 (res (c-calc-offset c-syntactic-element)))
10311 ;; Got an absolute column that overrides any indentation
10312 ;; we've collected so far, but not the relative
10313 ;; indentation we might get for the nested structures
10314 ;; further down the langelems list.
10315 (setq indent (elt res 0)
10316 anchor (point-min)) ; A position at column 0.
10318 ;; Got a relative change of the current calculated
10320 (setq indent (+ indent res))
10322 ;; Use the anchor position from the first syntactic
10323 ;; element with one.
10325 (setq anchor (c-langelem-pos (car langelems)))))
10327 (setq langelems (cdr langelems))))
10330 (+ indent (save-excursion
10336 (cc-provide 'cc-engine)
10338 ;;; cc-engine.el ends here