1 ;;; cc-engine.el --- core syntax guessing engine for CC mode -*- coding: utf-8 -*-
3 ;; Copyright (C) 1985, 1987, 1992-2014 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 (eval-when-compile (require 'cl))
153 ;; Make declarations for all the `c-lang-defvar' variables in cc-langs.
155 (defmacro c-declare-lang-variables ()
157 ,@(mapcan (lambda (init)
159 `(defvar ,(car init) nil ,(elt init 2))
160 `(defvar ,(car init) nil))
161 (make-variable-buffer-local ',(car init))))
162 (cdr c-lang-variable-inits))))
163 (c-declare-lang-variables)
166 ;;; Internal state variables.
168 ;; Internal state of hungry delete key feature
169 (defvar c-hungry-delete-key nil)
170 (make-variable-buffer-local 'c-hungry-delete-key)
172 ;; The electric flag (toggled by `c-toggle-electric-state').
173 ;; If t, electric actions (like automatic reindentation, and (if
174 ;; c-auto-newline is also set) auto newlining) will happen when an electric
175 ;; key like `{' is pressed (or an electric keyword like `else').
176 (defvar c-electric-flag t)
177 (make-variable-buffer-local 'c-electric-flag)
179 ;; Internal state of auto newline feature.
180 (defvar c-auto-newline nil)
181 (make-variable-buffer-local 'c-auto-newline)
183 ;; Included in the mode line to indicate the active submodes.
184 ;; (defvar c-submode-indicators nil)
185 ;; (make-variable-buffer-local 'c-submode-indicators)
187 (defun c-calculate-state (arg prevstate)
188 ;; Calculate the new state of PREVSTATE, t or nil, based on arg. If
189 ;; arg is nil or zero, toggle the state. If arg is negative, turn
190 ;; the state off, and if arg is positive, turn the state on
192 (zerop (setq arg (prefix-numeric-value arg))))
197 ;; Basic handling of preprocessor directives.
199 ;; This is a dynamically bound cache used together with
200 ;; `c-query-macro-start' and `c-query-and-set-macro-start'. It only
201 ;; works as long as point doesn't cross a macro boundary.
202 (defvar c-macro-start 'unknown)
204 (defsubst c-query-and-set-macro-start ()
205 (if (symbolp c-macro-start)
206 (setq c-macro-start (save-excursion
207 (c-save-buffer-state ()
208 (and (c-beginning-of-macro)
212 (defsubst c-query-macro-start ()
213 (if (symbolp c-macro-start)
215 (c-save-buffer-state ()
216 (and (c-beginning-of-macro)
220 ;; One element macro cache to cope with continual movement within very large
222 (defvar c-macro-cache nil)
223 (make-variable-buffer-local 'c-macro-cache)
224 ;; Nil or cons of the bounds of the most recent CPP form probed by
225 ;; `c-beginning-of-macro', `c-end-of-macro' or `c-syntactic-end-of-macro'.
226 ;; The cdr will be nil if we know only the start of the CPP form.
227 (defvar c-macro-cache-start-pos nil)
228 (make-variable-buffer-local 'c-macro-cache-start-pos)
229 ;; The starting position from where we determined `c-macro-cache'.
230 (defvar c-macro-cache-syntactic nil)
231 (make-variable-buffer-local 'c-macro-cache-syntactic)
232 ;; non-nil iff `c-macro-cache' has both elements set AND the cdr is at a
233 ;; syntactic end of macro, not merely an apparent one.
235 (defun c-invalidate-macro-cache (beg end)
236 ;; Called from a before-change function. If the change region is before or
237 ;; in the macro characterized by `c-macro-cache' etc., nullify it
238 ;; appropriately. BEG and END are the standard before-change-functions
239 ;; parameters. END isn't used.
241 ((null c-macro-cache))
242 ((< beg (car c-macro-cache))
243 (setq c-macro-cache nil
244 c-macro-cache-start-pos nil
245 c-macro-cache-syntactic nil))
246 ((and (cdr c-macro-cache)
247 (< beg (cdr c-macro-cache)))
248 (setcdr c-macro-cache nil)
249 (setq c-macro-cache-start-pos beg
250 c-macro-cache-syntactic nil))))
252 (defun c-beginning-of-macro (&optional lim)
253 "Go to the beginning of a preprocessor directive.
254 Leave point at the beginning of the directive and return t if in one,
255 otherwise return nil and leave point unchanged.
257 Note that this function might do hidden buffer changes. See the
258 comment at the start of cc-engine.el for more info."
259 (let ((here (point)))
260 (when c-opt-cpp-prefix
261 (if (and (car c-macro-cache)
262 (>= (point) (car c-macro-cache))
263 (or (and (cdr c-macro-cache)
264 (<= (point) (cdr c-macro-cache)))
265 (<= (point) c-macro-cache-start-pos)))
266 (unless (< (car c-macro-cache) (or lim (point-min)))
267 (progn (goto-char (max (or lim (point-min)) (car c-macro-cache)))
268 (setq c-macro-cache-start-pos
269 (max c-macro-cache-start-pos here))
271 (setq c-macro-cache nil
272 c-macro-cache-start-pos nil
273 c-macro-cache-syntactic nil)
276 (if lim (narrow-to-region lim (point-max)))
278 (while (eq (char-before (1- (point))) ?\\)
280 (back-to-indentation)
281 (if (and (<= (point) here)
282 (looking-at c-opt-cpp-start))
284 (setq c-macro-cache (cons (point) nil)
285 c-macro-cache-start-pos here)
290 (defun c-end-of-macro ()
291 "Go to the end of a preprocessor directive.
292 More accurately, move the point to the end of the closest following
293 line that doesn't end with a line continuation backslash - no check is
294 done that the point is inside a cpp directive to begin with.
296 Note that this function might do hidden buffer changes. See the
297 comment at the start of cc-engine.el for more info."
298 (if (and (cdr c-macro-cache)
299 (<= (point) (cdr c-macro-cache))
300 (>= (point) (car c-macro-cache)))
301 (goto-char (cdr c-macro-cache))
302 (unless (and (car c-macro-cache)
303 (<= (point) c-macro-cache-start-pos)
304 (>= (point) (car c-macro-cache)))
305 (setq c-macro-cache nil
306 c-macro-cache-start-pos nil
307 c-macro-cache-syntactic nil))
310 (when (and (eq (char-before) ?\\)
314 (when (car c-macro-cache)
315 (setcdr c-macro-cache (point)))))
317 (defun c-syntactic-end-of-macro ()
318 ;; Go to the end of a CPP directive, or a "safe" pos just before.
320 ;; This is normally the end of the next non-escaped line. A "safe"
321 ;; position is one not within a string or comment. (The EOL on a line
322 ;; comment is NOT "safe").
324 ;; This function must only be called from the beginning of a CPP construct.
326 ;; Note that this function might do hidden buffer changes. See the comment
327 ;; at the start of cc-engine.el for more info.
328 (let* ((here (point))
329 (there (progn (c-end-of-macro) (point)))
331 (unless c-macro-cache-syntactic
332 (setq s (parse-partial-sexp here there))
333 (while (and (or (nth 3 s) ; in a string
334 (nth 4 s)) ; in a comment (maybe at end of line comment)
335 (> there here)) ; No infinite loops, please.
336 (setq there (1- (nth 8 s)))
337 (setq s (parse-partial-sexp here there)))
338 (setq c-macro-cache-syntactic (car c-macro-cache)))
341 (defun c-forward-over-cpp-define-id ()
342 ;; Assuming point is at the "#" that introduces a preprocessor
343 ;; directive, it's moved forward to the end of the identifier which is
344 ;; "#define"d (or whatever c-opt-cpp-macro-define specifies). Non-nil
345 ;; is returned in this case, in all other cases nil is returned and
346 ;; point isn't moved.
348 ;; This function might do hidden buffer changes.
349 (when (and c-opt-cpp-macro-define-id
350 (looking-at c-opt-cpp-macro-define-id))
351 (goto-char (match-end 0))))
353 (defun c-forward-to-cpp-define-body ()
354 ;; Assuming point is at the "#" that introduces a preprocessor
355 ;; directive, it's moved forward to the start of the definition body
356 ;; if it's a "#define" (or whatever c-opt-cpp-macro-define
357 ;; specifies). Non-nil is returned in this case, in all other cases
358 ;; nil is returned and point isn't moved.
360 ;; This function might do hidden buffer changes.
361 (when (and c-opt-cpp-macro-define-start
362 (looking-at c-opt-cpp-macro-define-start)
363 (not (= (match-end 0) (c-point 'eol))))
364 (goto-char (match-end 0))))
367 ;;; Basic utility functions.
369 (defun c-syntactic-content (from to paren-level)
370 ;; Return the given region as a string where all syntactic
371 ;; whitespace is removed or, where necessary, replaced with a single
372 ;; space. If PAREN-LEVEL is given then all parens in the region are
373 ;; collapsed to "()", "[]" etc.
375 ;; This function might do hidden buffer changes.
379 (narrow-to-region from to)
381 (let* ((parts (list nil)) (tail parts) pos in-paren)
383 (while (re-search-forward c-syntactic-ws-start to t)
384 (goto-char (setq pos (match-beginning 0)))
385 (c-forward-syntactic-ws)
391 (setq in-paren (= (car (parse-partial-sexp from pos 1)) 1)
394 (if (and (> pos from)
396 (looking-at "\\w\\|\\s_")
399 (looking-at "\\w\\|\\s_")))
401 (setcdr tail (list (buffer-substring-no-properties from pos)
403 (setq tail (cddr tail)))
404 (setcdr tail (list (buffer-substring-no-properties from pos)))
405 (setq tail (cdr tail)))
408 (when (= (car (parse-partial-sexp pos to -1)) -1)
409 (setcdr tail (list (buffer-substring-no-properties
410 (1- (point)) (point))))
411 (setq tail (cdr tail))))
413 (setq from (point))))
415 (setcdr tail (list (buffer-substring-no-properties from to)))
416 (apply 'concat (cdr parts))))))
418 (defun c-shift-line-indentation (shift-amt)
419 ;; Shift the indentation of the current line with the specified
420 ;; amount (positive inwards). The buffer is modified only if
421 ;; SHIFT-AMT isn't equal to zero.
422 (let ((pos (- (point-max) (point)))
423 (c-macro-start c-macro-start)
425 (if (zerop shift-amt)
427 ;; If we're on an empty line inside a macro, we take the point
428 ;; to be at the current indentation and shift it to the
429 ;; appropriate column. This way we don't treat the extra
430 ;; whitespace out to the line continuation as indentation.
431 (when (and (c-query-and-set-macro-start)
432 (looking-at "[ \t]*\\\\$")
434 (skip-chars-backward " \t")
438 (setq tmp-char-inserted t))
440 (let ((col (current-indentation)))
441 (delete-region (c-point 'bol) (c-point 'boi))
443 (indent-to (+ col shift-amt)))
444 (when tmp-char-inserted
446 ;; If initial point was within line's indentation and we're not on
447 ;; a line with a line continuation in a macro, position after the
448 ;; indentation. Else stay at same point in text.
449 (if (and (< (point) (c-point 'boi))
450 (not tmp-char-inserted))
451 (back-to-indentation)
452 (if (> (- (point-max) pos) (point))
453 (goto-char (- (point-max) pos))))))
455 (defsubst c-keyword-sym (keyword)
456 ;; Return non-nil if the string KEYWORD is a known keyword. More
457 ;; precisely, the value is the symbol for the keyword in
458 ;; `c-keywords-obarray'.
459 (intern-soft keyword c-keywords-obarray))
461 (defsubst c-keyword-member (keyword-sym lang-constant)
462 ;; Return non-nil if the symbol KEYWORD-SYM, as returned by
463 ;; `c-keyword-sym', is a member of LANG-CONSTANT, which is the name
464 ;; of a language constant that ends with "-kwds". If KEYWORD-SYM is
465 ;; nil then the result is nil.
466 (get keyword-sym lang-constant))
468 ;; String syntax chars, suitable for skip-syntax-(forward|backward).
469 (defconst c-string-syntax (if (memq 'gen-string-delim c-emacs-features)
473 ;; Regexp matching string limit syntax.
474 (defconst c-string-limit-regexp (if (memq 'gen-string-delim c-emacs-features)
478 ;; Regexp matching WS followed by string limit syntax.
479 (defconst c-ws*-string-limit-regexp
480 (concat "[ \t]*\\(" c-string-limit-regexp "\\)"))
482 ;; Holds formatted error strings for the few cases where parse errors
484 (defvar c-parsing-error nil)
485 (make-variable-buffer-local 'c-parsing-error)
487 (defun c-echo-parsing-error (&optional quiet)
488 (when (and c-report-syntactic-errors c-parsing-error (not quiet))
489 (c-benign-error "%s" c-parsing-error))
492 ;; Faces given to comments and string literals. This is used in some
493 ;; situations to speed up recognition; it isn't mandatory that font
494 ;; locking is in use. This variable is extended with the face in
495 ;; `c-doc-face-name' when fontification is activated in cc-fonts.el.
496 (defvar c-literal-faces
497 (append '(font-lock-comment-face font-lock-string-face)
498 (when (facep 'font-lock-comment-delimiter-face)
500 '(font-lock-comment-delimiter-face))))
502 (defsubst c-put-c-type-property (pos value)
503 ;; Put a c-type property with the given value at POS.
504 (c-put-char-property pos 'c-type value))
506 (defun c-clear-c-type-property (from to value)
507 ;; Remove all occurrences of the c-type property that has the given
508 ;; value in the region between FROM and TO. VALUE is assumed to not
511 ;; Note: This assumes that c-type is put on single chars only; it's
512 ;; very inefficient if matching properties cover large regions.
516 (when (eq (get-text-property (point) 'c-type) value)
517 (c-clear-char-property (point) 'c-type))
518 (goto-char (next-single-property-change (point) 'c-type nil to))
522 ;; Some debug tools to visualize various special positions. This
523 ;; debug code isn't as portable as the rest of CC Mode.
525 (cc-bytecomp-defun overlays-in)
526 (cc-bytecomp-defun overlay-get)
527 (cc-bytecomp-defun overlay-start)
528 (cc-bytecomp-defun overlay-end)
529 (cc-bytecomp-defun delete-overlay)
530 (cc-bytecomp-defun overlay-put)
531 (cc-bytecomp-defun make-overlay)
533 (defun c-debug-add-face (beg end face)
534 (c-save-buffer-state ((overlays (overlays-in beg end)) overlay)
536 (setq overlay (car overlays)
537 overlays (cdr overlays))
538 (when (eq (overlay-get overlay 'face) face)
539 (setq beg (min beg (overlay-start overlay))
540 end (max end (overlay-end overlay)))
541 (delete-overlay overlay)))
542 (overlay-put (make-overlay beg end) 'face face)))
544 (defun c-debug-remove-face (beg end face)
545 (c-save-buffer-state ((overlays (overlays-in beg end)) overlay
546 (ol-beg beg) (ol-end end))
548 (setq overlay (car overlays)
549 overlays (cdr overlays))
550 (when (eq (overlay-get overlay 'face) face)
551 (setq ol-beg (min ol-beg (overlay-start overlay))
552 ol-end (max ol-end (overlay-end overlay)))
553 (delete-overlay overlay)))
555 (overlay-put (make-overlay ol-beg beg) 'face face))
557 (overlay-put (make-overlay end ol-end) 'face face))))
560 ;; `c-beginning-of-statement-1' and accompanying stuff.
562 ;; KLUDGE ALERT: c-maybe-labelp is used to pass information between
563 ;; c-crosses-statement-barrier-p and c-beginning-of-statement-1. A
564 ;; better way should be implemented, but this will at least shut up
565 ;; the byte compiler.
566 (defvar c-maybe-labelp)
568 ;; New awk-compatible version of c-beginning-of-statement-1, ACM 2002/6/22
570 ;; Macros used internally in c-beginning-of-statement-1 for the
571 ;; automaton actions.
572 (defmacro c-bos-push-state ()
573 '(setq stack (cons (cons state saved-pos)
575 (defmacro c-bos-pop-state (&optional do-if-done)
576 `(if (setq state (car (car stack))
577 saved-pos (cdr (car stack))
582 (defmacro c-bos-pop-state-and-retry ()
583 '(throw 'loop (setq state (car (car stack))
584 saved-pos (cdr (car stack))
585 ;; Throw nil if stack is empty, else throw non-nil.
587 (defmacro c-bos-save-pos ()
588 '(setq saved-pos (vector pos tok ptok pptok)))
589 (defmacro c-bos-restore-pos ()
590 '(unless (eq (elt saved-pos 0) start)
591 (setq pos (elt saved-pos 0)
592 tok (elt saved-pos 1)
593 ptok (elt saved-pos 2)
594 pptok (elt saved-pos 3))
597 (defmacro c-bos-save-error-info (missing got)
598 `(setq saved-pos (vector pos ,missing ,got)))
599 (defmacro c-bos-report-error ()
601 (setq c-parsing-error
602 (format "No matching `%s' found for `%s' on line %d"
605 (1+ (count-lines (point-min)
606 (c-point 'bol (elt saved-pos 0))))))))
608 (defun c-beginning-of-statement-1 (&optional lim ignore-labels
610 "Move to the start of the current statement or declaration, or to
611 the previous one if already at the beginning of one. Only
612 statements/declarations on the same level are considered, i.e. don't
613 move into or out of sexps (not even normal expression parentheses).
615 If point is already at the earliest statement within braces or parens,
616 this function doesn't move back into any whitespace preceding it; it
617 returns 'same in this case.
619 Stop at statement continuation tokens like \"else\", \"catch\",
620 \"finally\" and the \"while\" in \"do ... while\" if the start point
621 is within the continuation. If starting at such a token, move to the
622 corresponding statement start. If at the beginning of a statement,
623 move to the closest containing statement if there is any. This might
624 also stop at a continuation clause.
626 Labels are treated as part of the following statements if
627 IGNORE-LABELS is non-nil. (FIXME: Doesn't work if we stop at a known
628 statement start keyword.) Otherwise, each label is treated as a
631 Macros are ignored \(i.e. skipped over) unless point is within one, in
632 which case the content of the macro is treated as normal code. Aside
633 from any normal statement starts found in it, stop at the first token
634 of the content in the macro, i.e. the expression of an \"#if\" or the
635 start of the definition in a \"#define\". Also stop at start of
636 macros before leaving them.
639 'label if stopped at a label or \"case...:\" or \"default:\";
640 'same if stopped at the beginning of the current statement;
641 'up if stepped to a containing statement;
642 'previous if stepped to a preceding statement;
643 'beginning if stepped from a statement continuation clause to
645 'macro if stepped to a macro start.
646 Note that 'same and not 'label is returned if stopped at the same
647 label without crossing the colon character.
649 LIM may be given to limit the search. If the search hits the limit,
650 point will be left at the closest following token, or at the start
651 position if that is less ('same is returned in this case).
653 NOERROR turns off error logging to `c-parsing-error'.
655 Normally only ';' and virtual semicolons are considered to delimit
656 statements, but if COMMA-DELIM is non-nil then ',' is treated
659 Note that this function might do hidden buffer changes. See the
660 comment at the start of cc-engine.el for more info."
662 ;; The bulk of this function is a pushdown automaton that looks at statement
663 ;; boundaries and the tokens (such as "while") in c-opt-block-stmt-key. Its
664 ;; purpose is to keep track of nested statements, ensuring that such
665 ;; statements are skipped over in their entirety (somewhat akin to what C-M-p
666 ;; does with nested braces/brackets/parentheses).
668 ;; Note: The position of a boundary is the following token.
670 ;; Beginning with the current token (the one following point), move back one
671 ;; sexp at a time (where a sexp is, more or less, either a token or the
672 ;; entire contents of a brace/bracket/paren pair). Each time a statement
673 ;; boundary is crossed or a "while"-like token is found, update the state of
674 ;; the PDA. Stop at the beginning of a statement when the stack (holding
675 ;; nested statement info) is empty and the position has been moved.
677 ;; The following variables constitute the PDA:
679 ;; sym: This is either the "while"-like token (e.g. 'for) we've just
680 ;; scanned back over, 'boundary if we've just gone back over a
681 ;; statement boundary, or nil otherwise.
682 ;; state: takes one of the values (nil else else-boundary while
683 ;; while-boundary catch catch-boundary).
684 ;; nil means "no "while"-like token yet scanned".
685 ;; 'else, for example, means "just gone back over an else".
686 ;; 'else-boundary means "just gone back over a statement boundary
687 ;; immediately after having gone back over an else".
688 ;; saved-pos: A vector of either saved positions (tok ptok pptok, etc.) or
689 ;; of error reporting information.
690 ;; stack: The stack onto which the PDA pushes its state. Each entry
691 ;; consists of a saved value of state and saved-pos. An entry is
692 ;; pushed when we move back over a "continuation" token (e.g. else)
693 ;; and popped when we encounter the corresponding opening token
697 ;; The following diagram briefly outlines the PDA.
700 ;; "else": Push state, goto state `else'.
701 ;; "while": Push state, goto state `while'.
702 ;; "catch" or "finally": Push state, goto state `catch'.
703 ;; boundary: Pop state.
704 ;; other: Do nothing special.
707 ;; boundary: Goto state `else-boundary'.
708 ;; other: Error, pop state, retry token.
710 ;; State `else-boundary':
712 ;; boundary: Error, pop state.
713 ;; other: See common state.
716 ;; boundary: Save position, goto state `while-boundary'.
717 ;; other: Pop state, retry token.
719 ;; State `while-boundary':
721 ;; boundary: Restore position if it's not at start, pop state. [*see below]
722 ;; other: See common state.
725 ;; boundary: Goto state `catch-boundary'.
726 ;; other: Error, pop state, retry token.
728 ;; State `catch-boundary':
730 ;; "catch": Goto state `catch'.
731 ;; boundary: Error, pop state.
732 ;; other: See common state.
734 ;; [*] In the `while-boundary' state, we had pushed a 'while state, and were
735 ;; searching for a "do" which would have opened a do-while. If we didn't
736 ;; find it, we discard the analysis done since the "while", go back to this
737 ;; token in the buffer and restart the scanning there, this time WITHOUT
738 ;; pushing the 'while state onto the stack.
740 ;; In addition to the above there is some special handling of labels
743 (let ((case-fold-search nil)
746 (delims (if comma-delim '(?\; ?,) '(?\;)))
747 (c-stmt-delim-chars (if comma-delim
748 c-stmt-delim-chars-with-comma
750 c-in-literal-cache c-maybe-labelp after-case:-pos saved
753 ;; Position of last stmt boundary character (e.g. ;).
755 ;; The position of the last sexp or bound that follows the
756 ;; first found colon, i.e. the start of the nonlabel part of
757 ;; the statement. It's `start' if a colon is found just after
760 ;; Like `after-labels-pos', but the first such position inside
761 ;; a label, i.e. the start of the last label before the start
762 ;; of the nonlabel part of the statement.
764 ;; The last position where a label is possible provided the
765 ;; statement started there. It's nil as long as no invalid
766 ;; label content has been found (according to
767 ;; `c-nonlabel-token-key'). It's `start' if no valid label
768 ;; content was found in the label. Note that we might still
769 ;; regard it a label if it starts with `c-label-kwds'.
771 ;; Putative positions of the components of a bitfield declaration,
772 ;; e.g. "int foo : NUM_FOO_BITS ;"
773 bitfield-type-pos bitfield-id-pos bitfield-size-pos
774 ;; Symbol just scanned back over (e.g. 'while or 'boundary).
777 ;; Current state in the automaton. See above.
779 ;; Current saved positions. See above.
781 ;; Stack of conses (state . saved-pos).
783 ;; Regexp which matches "for", "if", etc.
784 (cond-key (or c-opt-block-stmt-key
785 "\\<\\>")) ; Matches nothing.
788 ;; Positions of the last three sexps or bounds we've stopped at.
792 (if lim (narrow-to-region lim (point-max)))
795 (and (c-beginning-of-macro)
797 (setq macro-start (point)))
799 ;; Try to skip back over unary operator characters, to register
803 (c-backward-syntactic-ws)
804 ;; Protect post-++/-- operators just before a virtual semicolon.
805 (and (not (c-at-vsemi-p))
806 (/= (skip-chars-backward "-+!*&~@`#") 0))))
808 ;; Skip back over any semicolon here. If it was a bare semicolon, we're
809 ;; done. Later on we ignore the boundaries for statements that don't
810 ;; contain any sexp. The only thing that is affected is that the error
811 ;; checking is a little less strict, and we really don't bother.
812 (if (and (memq (char-before) delims)
813 (progn (forward-char -1)
815 (c-backward-syntactic-ws)
816 (or (memq (char-before) delims)
817 (memq (char-before) '(?: nil))
818 (eq (char-syntax (char-before)) ?\()
823 ;; Begin at start and not pos to detect macros if we stand
824 ;; directly after the #.
826 (if (looking-at "\\<\\|\\W")
827 ;; Record this as the first token if not starting inside it.
830 ;; The following while loop goes back one sexp (balanced parens,
831 ;; etc. with contents, or symbol or suchlike) each iteration. This
832 ;; movement is accomplished with a call to c-backward-sexp approx 170
835 ;; The loop is exited only by throwing nil to the (catch 'loop ...):
836 ;; 1. On reaching the start of a macro;
837 ;; 2. On having passed a stmt boundary with the PDA stack empty;
838 ;; 3. On reaching the start of an Objective C method def;
839 ;; 4. From macro `c-bos-pop-state'; when the stack is empty;
840 ;; 5. From macro `c-bos-pop-state-and-retry' when the stack is empty.
842 (catch 'loop ;; Throw nil to break, non-nil to continue.
844 ;; Are we in a macro, just after the opening #?
846 (and macro-start ; Always NIL for AWK.
847 (progn (skip-chars-backward " \t")
848 (eq (char-before) ?#))
849 (progn (setq saved (1- (point)))
851 (not (eq (char-before (1- (point))) ?\\)))
852 (looking-at c-opt-cpp-start)
853 (progn (skip-chars-forward " \t")
854 (eq (point) saved))))
856 (if (and (c-forward-to-cpp-define-body)
857 (progn (c-forward-syntactic-ws start)
859 ;; Stop at the first token in the content of the macro.
861 ignore-labels t) ; Avoid the label check on exit.
865 (throw 'loop nil)) ; 1. Start of macro.
867 ;; Do a round through the automaton if we've just passed a
868 ;; statement boundary or passed a "while"-like token.
870 (and (looking-at cond-key)
871 (setq sym (intern (match-string 1)))))
873 (when (and (< pos start) (null stack))
874 (throw 'loop nil)) ; 2. Statement boundary.
876 ;; The PDA state handling.
878 ;; Refer to the description of the PDA in the opening
879 ;; comments. In the following OR form, the first leaf
880 ;; attempts to handles one of the specific actions detailed
881 ;; (e.g., finding token "if" whilst in state `else-boundary').
882 ;; We drop through to the second leaf (which handles common
883 ;; state) if no specific handler is found in the first cond.
884 ;; If a parsing error is detected (e.g. an "else" with no
885 ;; preceding "if"), we throw to the enclosing catch.
887 ;; Note that the (eq state 'else) means
888 ;; "we've just passed an else", NOT "we're looking for an
892 (if (eq sym 'boundary)
893 (setq state 'else-boundary)
895 (c-bos-pop-state-and-retry)))
897 ((eq state 'else-boundary)
899 (c-bos-pop-state (setq ret 'beginning)))
905 (if (and (eq sym 'boundary)
906 ;; Since this can cause backtracking we do a
907 ;; little more careful analysis to avoid it:
908 ;; If there's a label in front of the while
909 ;; it can't be part of a do-while.
910 (not after-labels-pos))
911 (progn (c-bos-save-pos)
912 (setq state 'while-boundary))
913 (c-bos-pop-state-and-retry))) ; Can't be a do-while
915 ((eq state 'while-boundary)
917 (c-bos-pop-state (setq ret 'beginning)))
918 ((eq sym 'boundary) ; isn't a do-while
919 (c-bos-restore-pos) ; the position of the while
920 (c-bos-pop-state)))) ; no longer searching for do.
923 (if (eq sym 'boundary)
924 (setq state 'catch-boundary)
926 (c-bos-pop-state-and-retry)))
928 ((eq state 'catch-boundary)
931 (c-bos-pop-state (setq ret 'beginning)))
936 (c-bos-pop-state)))))
938 ;; This is state common. We get here when the previous
939 ;; cond statement found no particular state handler.
940 (cond ((eq sym 'boundary)
941 ;; If we have a boundary at the start
942 ;; position we push a frame to go to the
943 ;; previous statement.
949 (c-bos-save-error-info 'if 'else)
952 ;; Is this a real while, or a do-while?
953 ;; The next `when' triggers unless we are SURE that
954 ;; the `while' is not the tail end of a `do-while'.
955 (when (or (not pptok)
956 (memq (char-after pptok) delims)
957 ;; The following kludge is to prevent
958 ;; infinite recursion when called from
959 ;; c-awk-after-if-for-while-condition-p,
961 (and (eq (point) start)
962 (c-vsemi-status-unknown-p))
963 (c-at-vsemi-p pptok))
964 ;; Since this can cause backtracking we do a
965 ;; little more careful analysis to avoid it: If
966 ;; the while isn't followed by a (possibly
967 ;; virtual) semicolon it can't be a do-while.
969 (setq state 'while)))
970 ((memq sym '(catch finally))
972 (c-bos-save-error-info 'try sym)
973 (setq state 'catch))))
976 ;; We're either past a statement boundary or at the
977 ;; start of a statement, so throw away any label data
978 ;; for the previous one.
979 (setq after-labels-pos nil
981 c-maybe-labelp nil))))
983 ;; Step to the previous sexp, but not if we crossed a
984 ;; boundary, since that doesn't consume an sexp.
985 (if (eq sym 'boundary)
988 ;; HERE IS THE SINGLE PLACE INSIDE THE PDA LOOP WHERE WE MOVE
989 ;; BACKWARDS THROUGH THE SOURCE.
991 (c-backward-syntactic-ws)
992 (let ((before-sws-pos (point))
993 ;; The end position of the area to search for statement
994 ;; barriers in this round.
995 (maybe-after-boundary-pos pos))
997 ;; Go back over exactly one logical sexp, taking proper
998 ;; account of macros and escaped EOLs.
1001 (unless (c-safe (c-backward-sexp) t)
1002 ;; Give up if we hit an unbalanced block. Since the
1003 ;; stack won't be empty the code below will report a
1007 ;; Have we moved into a macro?
1008 ((and (not macro-start)
1009 (c-beginning-of-macro))
1010 ;; Have we crossed a statement boundary? If not,
1011 ;; keep going back until we find one or a "real" sexp.
1015 (not (c-crosses-statement-barrier-p
1016 (point) maybe-after-boundary-pos)))
1017 (setq maybe-after-boundary-pos (point))))
1018 ;; Have we just gone back over an escaped NL? This
1019 ;; doesn't count as a sexp.
1020 ((looking-at "\\\\$")))))
1022 ;; Have we crossed a statement boundary?
1025 ;; Are we at a macro beginning?
1026 ((and (not macro-start)
1028 (looking-at c-opt-cpp-prefix))
1031 (c-crosses-statement-barrier-p
1032 (point) maybe-after-boundary-pos)))
1033 ;; Just gone back over a brace block?
1035 (eq (char-after) ?{)
1036 (not (c-looking-at-inexpr-block lim nil t))
1038 (c-backward-token-2 1 t nil)
1039 (not (looking-at "=\\([^=]\\|$\\)"))))
1041 (c-forward-sexp) (point)))
1042 ;; Just gone back over some paren block?
1043 ((looking-at "\\s\(")
1045 (goto-char (1+ (c-down-list-backward
1047 (c-crosses-statement-barrier-p
1048 (point) maybe-after-boundary-pos)))
1049 ;; Just gone back over an ordinary symbol of some sort?
1050 (t (c-crosses-statement-barrier-p
1051 (point) maybe-after-boundary-pos))))
1058 ;; Like a C "continue". Analyze the next sexp.
1062 (when (and c-opt-method-key
1063 (setq saved (c-in-method-def-p)))
1065 ignore-labels t) ; Avoid the label check on exit.
1066 (throw 'loop nil)) ; 3. ObjC method def.
1068 ;; Might we have a bitfield declaration, "<type> <id> : <size>"?
1071 ;; The : <size> and <id> fields?
1072 ((and (numberp c-maybe-labelp)
1073 (not bitfield-size-pos)
1075 (goto-char (or tok start))
1076 (not (looking-at c-keywords-regexp)))
1077 (not (looking-at c-keywords-regexp))
1078 (not (c-punctuation-in (point) c-maybe-labelp)))
1079 (setq bitfield-size-pos (or tok start)
1080 bitfield-id-pos (point)))
1081 ;; The <type> field?
1082 ((and bitfield-id-pos
1083 (not bitfield-type-pos))
1084 (if (and (looking-at c-symbol-key) ; Can only be an integer type. :-)
1085 (not (looking-at c-not-primitive-type-keywords-regexp))
1086 (not (c-punctuation-in (point) tok)))
1087 (setq bitfield-type-pos (point))
1088 (setq bitfield-size-pos nil
1089 bitfield-id-pos nil)))))
1092 (unless (eq ignore-labels t)
1093 (when (numberp c-maybe-labelp)
1094 ;; `c-crosses-statement-barrier-p' has found a colon, so we
1095 ;; might be in a label now. Have we got a real label
1096 ;; (including a case label) or something like C++'s "public:"?
1097 ;; A case label might use an expression rather than a token.
1098 (setq after-case:-pos (or tok start))
1099 (if (or (looking-at c-nonlabel-token-key) ; e.g. "while" or "'a'"
1100 ;; Catch C++'s inheritance construct "class foo : bar".
1103 (c-safe (c-backward-sexp) t)
1104 (looking-at c-nonlabel-token-2-key))))
1105 (setq c-maybe-labelp nil)
1106 (if after-labels-pos ; Have we already encountered a label?
1107 (if (not last-label-pos)
1108 (setq last-label-pos (or tok start)))
1109 (setq after-labels-pos (or tok start)))
1110 (setq c-maybe-labelp t
1111 label-good-pos nil))) ; bogus "label"
1113 (when (and (not label-good-pos) ; i.e. no invalid "label"'s yet
1115 (looking-at c-nonlabel-token-key)) ; e.g. "while :"
1116 ;; We're in a potential label and it's the first
1117 ;; time we've found something that isn't allowed in
1119 (setq label-good-pos (or tok start))))
1121 ;; We've moved back by a sexp, so update the token positions.
1126 pos tok) ; always non-nil
1127 ) ; end of (catch loop ....)
1128 ) ; end of sexp-at-a-time (while ....)
1130 ;; If the stack isn't empty there might be errors to report.
1132 (if (and (vectorp saved-pos) (eq (length saved-pos) 3))
1133 (c-bos-report-error))
1134 (setq saved-pos (cdr (car stack))
1137 (when (and (eq ret 'same)
1138 (not (memq sym '(boundary ignore nil))))
1139 ;; Need to investigate closer whether we've crossed
1140 ;; between a substatement and its containing statement.
1142 (cond ((and (looking-at c-block-stmt-1-2-key)
1143 (eq (char-after ptok) ?\())
1145 ((looking-at c-block-stmt-1-key)
1148 (cond ((> start saved) (setq pos saved))
1149 ((= start saved) (setq ret 'up)))))
1151 (when (and (not ignore-labels)
1152 (eq c-maybe-labelp t)
1153 (not (eq ret 'beginning))
1155 (not bitfield-type-pos) ; Bitfields take precedence over labels.
1156 (or (not label-good-pos)
1157 (<= label-good-pos pos)
1159 (goto-char (if (and last-label-pos
1160 (< last-label-pos start))
1163 (looking-at c-label-kwds-regexp))))
1164 ;; We're in a label. Maybe we should step to the statement
1166 (if (< after-labels-pos start)
1167 (setq pos after-labels-pos)
1169 (if (and last-label-pos (< last-label-pos start))
1170 ;; Might have jumped over several labels. Go to the last one.
1171 (setq pos last-label-pos)))))
1173 ;; Have we got "case <expression>:"?
1175 (when (and after-case:-pos
1176 (not (eq ret 'beginning))
1177 (looking-at c-case-kwds-regexp))
1178 (if (< after-case:-pos start)
1179 (setq pos after-case:-pos))
1183 ;; Skip over the unary operators that can start the statement.
1185 (c-backward-syntactic-ws)
1186 ;; protect AWK post-inc/decrement operators, etc.
1187 (and (not (c-at-vsemi-p (point)))
1188 (/= (skip-chars-backward "-+!*&~@`#") 0)))
1193 (defun c-punctuation-in (from to)
1194 "Return non-nil if there is a non-comment non-macro punctuation character
1195 between FROM and TO. FROM must not be in a string or comment. The returned
1196 value is the position of the first such character."
1199 (let ((pos (point)))
1200 (while (progn (skip-chars-forward c-symbol-chars to)
1201 (c-forward-syntactic-ws to)
1203 (setq pos (point))))
1204 (and (< (point) to) (point))))
1206 (defun c-crosses-statement-barrier-p (from to)
1207 "Return non-nil if buffer positions FROM to TO cross one or more
1208 statement or declaration boundaries. The returned value is actually
1209 the position of the earliest boundary char. FROM must not be within
1210 a string or comment.
1212 The variable `c-maybe-labelp' is set to the position of the first `:' that
1213 might start a label (i.e. not part of `::' and not preceded by `?'). If a
1214 single `?' is found, then `c-maybe-labelp' is cleared.
1216 For AWK, a statement which is terminated by an EOL (not a \; or a }) is
1217 regarded as having a \"virtual semicolon\" immediately after the last token on
1218 the line. If this virtual semicolon is _at_ from, the function recognizes it.
1220 Note that this function might do hidden buffer changes. See the
1221 comment at the start of cc-engine.el for more info."
1223 ;; If the current language has CPP macros, insert # into skip-chars.
1224 (if c-opt-cpp-symbol
1225 (concat (substring c-stmt-delim-chars 0 1) ; "^"
1226 c-opt-cpp-symbol ; usually "#"
1227 (substring c-stmt-delim-chars 1)) ; e.g. ";{}?:"
1228 c-stmt-delim-chars))
1230 (append (substring skip-chars 1) nil)) ; e.g. (?# ?\; ?{ ?} ?? ?:)
1231 lit-range vsemi-pos)
1237 (while (progn (skip-chars-forward
1239 (min to (c-point 'bonl)))
1242 ;; Virtual semicolon?
1246 (if (setq lit-range (c-literal-limits from)) ; Have we landed in a string/comment?
1247 (goto-char (car lit-range)))
1248 (c-backward-syntactic-ws) ; ? put a limit here, maybe?
1249 (setq vsemi-pos (point))
1251 (throw 'done vsemi-pos))
1252 ;; In a string/comment?
1253 ((setq lit-range (c-literal-limits from))
1254 (goto-char (cdr lit-range)))
1255 ((eq (char-after) ?:)
1257 (if (and (eq (char-after) ?:)
1259 ;; Ignore scope operators.
1261 (setq c-maybe-labelp (1- (point)))))
1262 ((eq (char-after) ??)
1263 ;; A question mark. Can't be a label, so stop
1264 ;; looking for more : and ?.
1265 (setq c-maybe-labelp nil
1266 skip-chars (substring c-stmt-delim-chars 0 -2)))
1267 ;; At a CPP construct or a "#" or "##" operator?
1268 ((and c-opt-cpp-symbol (looking-at c-opt-cpp-symbol))
1270 (skip-chars-backward " \t")
1273 (not (eq (char-before (1- (point))) ?\\)))))
1275 (skip-chars-forward c-opt-cpp-symbol)))
1276 ((memq (char-after) non-skip-list)
1277 (throw 'done (point)))))
1278 ;; In trailing space after an as yet undetected virtual semicolon?
1279 (c-backward-syntactic-ws from)
1280 (when (and (bolp) (not (bobp))) ; Can happen in AWK Mode with an
1281 ; unterminated string/regexp.
1283 (if (and (< (point) to)
1288 (defun c-at-statement-start-p ()
1289 "Return non-nil if the point is at the first token in a statement
1290 or somewhere in the syntactic whitespace before it.
1292 A \"statement\" here is not restricted to those inside code blocks.
1293 Any kind of declaration-like construct that occur outside function
1294 bodies is also considered a \"statement\".
1296 Note that this function might do hidden buffer changes. See the
1297 comment at the start of cc-engine.el for more info."
1302 (c-syntactic-skip-backward (substring c-stmt-delim-chars 1) nil t)
1304 (eq (char-before) ?})
1305 (and (eq (char-before) ?{)
1306 (not (and c-special-brace-lists
1307 (progn (backward-char)
1308 (c-looking-at-special-brace-list)))))
1309 (c-crosses-statement-barrier-p (point) end)))))
1311 (defun c-at-expression-start-p ()
1312 "Return non-nil if the point is at the first token in an expression or
1313 statement, or somewhere in the syntactic whitespace before it.
1315 An \"expression\" here is a bit different from the normal language
1316 grammar sense: It's any sequence of expression tokens except commas,
1317 unless they are enclosed inside parentheses of some kind. Also, an
1318 expression never continues past an enclosing parenthesis, but it might
1319 contain parenthesis pairs of any sort except braces.
1321 Since expressions never cross statement boundaries, this function also
1322 recognizes statement beginnings, just like `c-at-statement-start-p'.
1324 Note that this function might do hidden buffer changes. See the
1325 comment at the start of cc-engine.el for more info."
1329 (c-stmt-delim-chars c-stmt-delim-chars-with-comma)
1331 (c-syntactic-skip-backward (substring c-stmt-delim-chars 1) nil t)
1333 (memq (char-before) '(?{ ?}))
1334 (save-excursion (backward-char)
1335 (looking-at "\\s("))
1336 (c-crosses-statement-barrier-p (point) end)))))
1339 ;; A set of functions that covers various idiosyncrasies in
1340 ;; implementations of `forward-comment'.
1342 ;; Note: Some emacsen considers incorrectly that any line comment
1343 ;; ending with a backslash continues to the next line. I can't think
1344 ;; of any way to work around that in a reliable way without changing
1345 ;; the buffer, though. Suggestions welcome. ;) (No, temporarily
1346 ;; changing the syntax for backslash doesn't work since we must treat
1347 ;; escapes in string literals correctly.)
1349 (defun c-forward-single-comment ()
1350 "Move forward past whitespace and the closest following comment, if any.
1351 Return t if a comment was found, nil otherwise. In either case, the
1352 point is moved past the following whitespace. Line continuations,
1353 i.e. a backslashes followed by line breaks, are treated as whitespace.
1354 The line breaks that end line comments are considered to be the
1355 comment enders, so the point will be put on the beginning of the next
1356 line if it moved past a line comment.
1358 This function does not do any hidden buffer changes."
1360 (let ((start (point)))
1361 (when (looking-at "\\([ \t\n\r\f\v]\\|\\\\[\n\r]\\)+")
1362 (goto-char (match-end 0)))
1364 (when (forward-comment 1)
1366 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1370 ;; Emacs includes the ending newline in a b-style (c++)
1371 ;; comment, but XEmacs doesn't. We depend on the Emacs
1372 ;; behavior (which also is symmetric).
1373 (if (and (eolp) (elt (parse-partial-sexp start (point)) 7))
1374 (condition-case nil (forward-char 1)))
1378 (defsubst c-forward-comments ()
1379 "Move forward past all following whitespace and comments.
1380 Line continuations, i.e. a backslashes followed by line breaks, are
1381 treated as whitespace.
1383 Note that this function might do hidden buffer changes. See the
1384 comment at the start of cc-engine.el for more info."
1387 ;; If forward-comment in at least XEmacs 21 is given a large
1388 ;; positive value, it'll loop all the way through if it hits
1390 (and (forward-comment 5)
1391 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1395 (when (looking-at "\\\\[\n\r]")
1399 (defun c-backward-single-comment ()
1400 "Move backward past whitespace and the closest preceding comment, if any.
1401 Return t if a comment was found, nil otherwise. In either case, the
1402 point is moved past the preceding whitespace. Line continuations,
1403 i.e. a backslashes followed by line breaks, are treated as whitespace.
1404 The line breaks that end line comments are considered to be the
1405 comment enders, so the point cannot be at the end of the same line to
1406 move over a line comment.
1408 This function does not do any hidden buffer changes."
1410 (let ((start (point)))
1411 ;; When we got newline terminated comments, forward-comment in all
1412 ;; supported emacsen so far will stop at eol of each line not
1413 ;; ending with a comment when moving backwards. This corrects for
1414 ;; that, and at the same time handles line continuations.
1416 (skip-chars-backward " \t\n\r\f\v")
1417 (and (looking-at "[\n\r]")
1418 (eq (char-before) ?\\)))
1422 ;; Some emacsen (e.g. Emacs 19.34) return t when moving
1423 ;; backwards at bob.
1426 ;; Leave point after the closest following newline if we've
1427 ;; backed up over any above, since forward-comment won't move
1428 ;; backward over a line comment if point is at the end of the
1430 (re-search-forward "\\=\\s *[\n\r]" start t)
1432 (if (if (let (open-paren-in-column-0-is-defun-start) (forward-comment -1))
1434 ;; If forward-comment above succeeded and we're at eol
1435 ;; then the newline we moved over above didn't end a
1436 ;; line comment, so we give it another go.
1437 (let (open-paren-in-column-0-is-defun-start)
1438 (forward-comment -1))
1441 ;; Emacs <= 20 and XEmacs move back over the closer of a
1442 ;; block comment that lacks an opener.
1443 (if (looking-at "\\*/")
1444 (progn (forward-char 2) nil)
1447 (defsubst c-backward-comments ()
1448 "Move backward past all preceding whitespace and comments.
1449 Line continuations, i.e. a backslashes followed by line breaks, are
1450 treated as whitespace. The line breaks that end line comments are
1451 considered to be the comment enders, so the point cannot be at the end
1452 of the same line to move over a line comment. Unlike
1453 c-backward-syntactic-ws, this function doesn't move back over
1454 preprocessor directives.
1456 Note that this function might do hidden buffer changes. See the
1457 comment at the start of cc-engine.el for more info."
1459 (let ((start (point)))
1461 ;; `forward-comment' in some emacsen (e.g. XEmacs 21.4)
1462 ;; return t when moving backwards at bob.
1465 (if (let (open-paren-in-column-0-is-defun-start moved-comment)
1467 (and (not (setq moved-comment (forward-comment -1)))
1468 ;; Cope specifically with ^M^J here -
1469 ;; forward-comment sometimes gets stuck after ^Ms,
1470 ;; sometimes after ^M^J.
1472 (when (eq (char-before) ?\r)
1475 (when (and (eq (char-before) ?\n)
1476 (eq (char-before (1- (point))) ?\r))
1480 (if (looking-at "\\*/")
1481 ;; Emacs <= 20 and XEmacs move back over the
1482 ;; closer of a block comment that lacks an opener.
1483 (progn (forward-char 2) nil)
1486 ;; XEmacs treats line continuations as whitespace but
1487 ;; only in the backward direction, which seems a bit
1488 ;; odd. Anyway, this is necessary for Emacs.
1489 (when (and (looking-at "[\n\r]")
1490 (eq (char-before) ?\\)
1496 ;; Tools for skipping over syntactic whitespace.
1498 ;; The following functions use text properties to cache searches over
1499 ;; large regions of syntactic whitespace. It works as follows:
1501 ;; o If a syntactic whitespace region contains anything but simple
1502 ;; whitespace (i.e. space, tab and line breaks), the text property
1503 ;; `c-in-sws' is put over it. At places where we have stopped
1504 ;; within that region there's also a `c-is-sws' text property.
1505 ;; That since there typically are nested whitespace inside that
1506 ;; must be handled separately, e.g. whitespace inside a comment or
1507 ;; cpp directive. Thus, from one point with `c-is-sws' it's safe
1508 ;; to jump to another point with that property within the same
1509 ;; `c-in-sws' region. It can be likened to a ladder where
1510 ;; `c-in-sws' marks the bars and `c-is-sws' the rungs.
1512 ;; o The `c-is-sws' property is put on the simple whitespace chars at
1513 ;; a "rung position" and also maybe on the first following char.
1514 ;; As many characters as can be conveniently found in this range
1515 ;; are marked, but no assumption can be made that the whole range
1516 ;; is marked (it could be clobbered by later changes, for
1519 ;; Note that some part of the beginning of a sequence of simple
1520 ;; whitespace might be part of the end of a preceding line comment
1521 ;; or cpp directive and must not be considered part of the "rung".
1522 ;; Such whitespace is some amount of horizontal whitespace followed
1523 ;; by a newline. In the case of cpp directives it could also be
1524 ;; two newlines with horizontal whitespace between them.
1526 ;; The reason to include the first following char is to cope with
1527 ;; "rung positions" that doesn't have any ordinary whitespace. If
1528 ;; `c-is-sws' is put on a token character it does not have
1529 ;; `c-in-sws' set simultaneously. That's the only case when that
1530 ;; can occur, and the reason for not extending the `c-in-sws'
1531 ;; region to cover it is that the `c-in-sws' region could then be
1532 ;; accidentally merged with a following one if the token is only
1533 ;; one character long.
1535 ;; o On buffer changes the `c-in-sws' and `c-is-sws' properties are
1536 ;; removed in the changed region. If the change was inside
1537 ;; syntactic whitespace that means that the "ladder" is broken, but
1538 ;; a later call to `c-forward-sws' or `c-backward-sws' will use the
1539 ;; parts on either side and use an ordinary search only to "repair"
1542 ;; Special care needs to be taken if a region is removed: If there
1543 ;; are `c-in-sws' on both sides of it which do not connect inside
1544 ;; the region then they can't be joined. If e.g. a marked macro is
1545 ;; broken, syntactic whitespace inside the new text might be
1546 ;; marked. If those marks would become connected with the old
1547 ;; `c-in-sws' range around the macro then we could get a ladder
1548 ;; with one end outside the macro and the other at some whitespace
1551 ;; The main motivation for this system is to increase the speed in
1552 ;; skipping over the large whitespace regions that can occur at the
1553 ;; top level in e.g. header files that contain a lot of comments and
1554 ;; cpp directives. For small comments inside code it's probably
1555 ;; slower than using `forward-comment' straightforwardly, but speed is
1556 ;; not a significant factor there anyway.
1558 ; (defface c-debug-is-sws-face
1559 ; '((t (:background "GreenYellow")))
1560 ; "Debug face to mark the `c-is-sws' property.")
1561 ; (defface c-debug-in-sws-face
1562 ; '((t (:underline t)))
1563 ; "Debug face to mark the `c-in-sws' property.")
1565 ; (defun c-debug-put-sws-faces ()
1566 ; ;; Put the sws debug faces on all the `c-is-sws' and `c-in-sws'
1567 ; ;; properties in the buffer.
1570 ; (c-save-buffer-state (in-face)
1571 ; (goto-char (point-min))
1572 ; (setq in-face (if (get-text-property (point) 'c-is-sws)
1575 ; (goto-char (next-single-property-change
1576 ; (point) 'c-is-sws nil (point-max)))
1579 ; (c-debug-add-face in-face (point) 'c-debug-is-sws-face)
1580 ; (setq in-face nil))
1581 ; (setq in-face (point)))
1583 ; (goto-char (point-min))
1584 ; (setq in-face (if (get-text-property (point) 'c-in-sws)
1587 ; (goto-char (next-single-property-change
1588 ; (point) 'c-in-sws nil (point-max)))
1591 ; (c-debug-add-face in-face (point) 'c-debug-in-sws-face)
1592 ; (setq in-face nil))
1593 ; (setq in-face (point)))
1596 (defmacro c-debug-sws-msg (&rest args)
1600 (defmacro c-put-is-sws (beg end)
1601 ;; This macro does a hidden buffer change.
1602 `(let ((beg ,beg) (end ,end))
1603 (put-text-property beg end 'c-is-sws t)
1604 ,@(when (facep 'c-debug-is-sws-face)
1605 `((c-debug-add-face beg end 'c-debug-is-sws-face)))))
1607 (defmacro c-put-in-sws (beg end)
1608 ;; This macro does a hidden buffer change.
1609 `(let ((beg ,beg) (end ,end))
1610 (put-text-property beg end 'c-in-sws t)
1611 ,@(when (facep 'c-debug-is-sws-face)
1612 `((c-debug-add-face beg end 'c-debug-in-sws-face)))))
1614 (defmacro c-remove-is-sws (beg end)
1615 ;; This macro does a hidden buffer change.
1616 `(let ((beg ,beg) (end ,end))
1617 (remove-text-properties beg end '(c-is-sws nil))
1618 ,@(when (facep 'c-debug-is-sws-face)
1619 `((c-debug-remove-face beg end 'c-debug-is-sws-face)))))
1621 (defmacro c-remove-in-sws (beg end)
1622 ;; This macro does a hidden buffer change.
1623 `(let ((beg ,beg) (end ,end))
1624 (remove-text-properties beg end '(c-in-sws nil))
1625 ,@(when (facep 'c-debug-is-sws-face)
1626 `((c-debug-remove-face beg end 'c-debug-in-sws-face)))))
1628 (defmacro c-remove-is-and-in-sws (beg end)
1629 ;; This macro does a hidden buffer change.
1630 `(let ((beg ,beg) (end ,end))
1631 (remove-text-properties beg end '(c-is-sws nil c-in-sws nil))
1632 ,@(when (facep 'c-debug-is-sws-face)
1633 `((c-debug-remove-face beg end 'c-debug-is-sws-face)
1634 (c-debug-remove-face beg end 'c-debug-in-sws-face)))))
1636 (defsubst c-invalidate-sws-region-after (beg end)
1637 ;; Called from `after-change-functions'. Note that if
1638 ;; `c-forward-sws' or `c-backward-sws' are used outside
1639 ;; `c-save-buffer-state' or similar then this will remove the cache
1640 ;; properties right after they're added.
1642 ;; This function does hidden buffer changes.
1645 ;; Adjust the end to remove the properties in any following simple
1646 ;; ws up to and including the next line break, if there is any
1647 ;; after the changed region. This is necessary e.g. when a rung
1648 ;; marked empty line is converted to a line comment by inserting
1649 ;; "//" before the line break. In that case the line break would
1650 ;; keep the rung mark which could make a later `c-backward-sws'
1651 ;; move into the line comment instead of over it.
1653 (skip-chars-forward " \t\f\v")
1654 (when (and (eolp) (not (eobp)))
1655 (setq end (1+ (point)))))
1657 (when (and (= beg end)
1658 (get-text-property beg 'c-in-sws)
1660 (get-text-property (1- beg) 'c-in-sws))
1661 ;; Ensure that an `c-in-sws' range gets broken. Note that it isn't
1662 ;; safe to keep a range that was continuous before the change. E.g:
1668 ;; There can be a "ladder" between "#" and "b". Now, if the newline
1669 ;; after "foo" is removed then "bar" will become part of the cpp
1670 ;; directive instead of a syntactically relevant token. In that
1671 ;; case there's no longer syntactic ws from "#" to "b".
1672 (setq beg (1- beg)))
1674 (c-debug-sws-msg "c-invalidate-sws-region-after [%s..%s]" beg end)
1675 (c-remove-is-and-in-sws beg end))
1677 (defun c-forward-sws ()
1678 ;; Used by `c-forward-syntactic-ws' to implement the unbounded search.
1680 ;; This function might do hidden buffer changes.
1682 (let (;; `rung-pos' is set to a position as early as possible in the
1683 ;; unmarked part of the simple ws region.
1684 (rung-pos (point)) next-rung-pos rung-end-pos last-put-in-sws-pos
1685 rung-is-marked next-rung-is-marked simple-ws-end
1686 ;; `safe-start' is set when it's safe to cache the start position.
1687 ;; It's not set if we've initially skipped over comments and line
1688 ;; continuations since we might have gone out through the end of a
1689 ;; macro then. This provision makes `c-forward-sws' not populate the
1690 ;; cache in the majority of cases, but otoh is `c-backward-sws' by far
1694 ;; Skip simple ws and do a quick check on the following character to see
1695 ;; if it's anything that can't start syntactic ws, so we can bail out
1696 ;; early in the majority of cases when there just are a few ws chars.
1697 (skip-chars-forward " \t\n\r\f\v")
1698 (when (looking-at c-syntactic-ws-start)
1700 (setq rung-end-pos (min (1+ (point)) (point-max)))
1701 (if (setq rung-is-marked (text-property-any rung-pos rung-end-pos
1703 ;; Find the last rung position to avoid setting properties in all
1704 ;; the cases when the marked rung is complete.
1705 ;; (`next-single-property-change' is certain to move at least one
1707 (setq rung-pos (1- (next-single-property-change
1708 rung-is-marked 'c-is-sws nil rung-end-pos)))
1709 ;; Got no marked rung here. Since the simple ws might have started
1710 ;; inside a line comment or cpp directive we must set `rung-pos' as
1711 ;; high as possible.
1712 (setq rung-pos (point)))
1714 (with-silent-modifications
1718 (when (and rung-is-marked
1719 (get-text-property (point) 'c-in-sws))
1721 ;; The following search is the main reason that `c-in-sws'
1722 ;; and `c-is-sws' aren't combined to one property.
1723 (goto-char (next-single-property-change
1724 (point) 'c-in-sws nil (point-max)))
1725 (unless (get-text-property (point) 'c-is-sws)
1726 ;; If the `c-in-sws' region extended past the last
1727 ;; `c-is-sws' char we have to go back a bit.
1728 (or (get-text-property (1- (point)) 'c-is-sws)
1729 (goto-char (previous-single-property-change
1730 (point) 'c-is-sws)))
1734 "c-forward-sws cached move %s -> %s (max %s)"
1735 rung-pos (point) (point-max))
1737 (setq rung-pos (point))
1738 (and (> (skip-chars-forward " \t\n\r\f\v") 0)
1741 ;; We'll loop here if there is simple ws after the last rung.
1742 ;; That means that there's been some change in it and it's
1743 ;; possible that we've stepped into another ladder, so extend
1744 ;; the previous one to join with it if there is one, and try to
1745 ;; use the cache again.
1747 "c-forward-sws extending rung with [%s..%s] (max %s)"
1748 (1+ rung-pos) (1+ (point)) (point-max))
1749 (unless (get-text-property (point) 'c-is-sws)
1750 ;; Remove any `c-in-sws' property from the last char of
1751 ;; the rung before we mark it with `c-is-sws', so that we
1752 ;; won't connect with the remains of a broken "ladder".
1753 (c-remove-in-sws (point) (1+ (point))))
1754 (c-put-is-sws (1+ rung-pos)
1756 (c-put-in-sws rung-pos
1757 (setq rung-pos (point)
1758 last-put-in-sws-pos rung-pos)))
1760 (setq simple-ws-end (point))
1761 (c-forward-comments)
1764 ((/= (point) simple-ws-end)
1765 ;; Skipped over comments. Don't cache at eob in case the buffer
1770 (and c-opt-cpp-prefix
1771 (looking-at c-opt-cpp-start)
1772 (progn (skip-chars-backward " \t")
1775 (progn (backward-char)
1776 (not (eq (char-before) ?\\))))))
1777 ;; Skip a preprocessor directive.
1779 (while (and (eq (char-before) ?\\)
1780 (= (forward-line 1) 0))
1784 ;; Don't cache at eob in case the buffer is narrowed.
1787 ;; We've searched over a piece of non-white syntactic ws. See if this
1789 (setq next-rung-pos (point))
1790 (skip-chars-forward " \t\n\r\f\v")
1791 (setq rung-end-pos (min (1+ (point)) (point-max)))
1794 ;; Cache if we haven't skipped comments only, and if we started
1795 ;; either from a marked rung or from a completely uncached
1799 (not (get-text-property simple-ws-end 'c-in-sws))))
1801 ;; See if there's a marked rung in the encountered simple ws. If
1802 ;; so then we can cache, unless `safe-start' is nil. Even then
1803 ;; we need to do this to check if the cache can be used for the
1805 (and (setq next-rung-is-marked
1806 (text-property-any next-rung-pos rung-end-pos
1812 "c-forward-sws caching [%s..%s] - [%s..%s] (max %s)"
1813 rung-pos (1+ simple-ws-end) next-rung-pos rung-end-pos
1816 ;; Remove the properties for any nested ws that might be cached.
1817 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
1819 (c-remove-is-sws (1+ simple-ws-end) next-rung-pos)
1820 (unless (and rung-is-marked (= rung-pos simple-ws-end))
1821 (c-put-is-sws rung-pos
1823 (setq rung-is-marked t))
1824 (c-put-in-sws rung-pos
1825 (setq rung-pos (point)
1826 last-put-in-sws-pos rung-pos))
1827 (unless (get-text-property (1- rung-end-pos) 'c-is-sws)
1828 ;; Remove any `c-in-sws' property from the last char of
1829 ;; the rung before we mark it with `c-is-sws', so that we
1830 ;; won't connect with the remains of a broken "ladder".
1831 (c-remove-in-sws (1- rung-end-pos) rung-end-pos))
1832 (c-put-is-sws next-rung-pos
1836 "c-forward-sws not caching [%s..%s] - [%s..%s] (max %s)"
1837 rung-pos (1+ simple-ws-end) next-rung-pos rung-end-pos
1840 ;; Set `rung-pos' for the next rung. It's the same thing here as
1841 ;; initially, except that the rung position is set as early as
1842 ;; possible since we can't be in the ending ws of a line comment or
1843 ;; cpp directive now.
1844 (if (setq rung-is-marked next-rung-is-marked)
1845 (setq rung-pos (1- (next-single-property-change
1846 rung-is-marked 'c-is-sws nil rung-end-pos)))
1847 (setq rung-pos next-rung-pos))
1848 (setq safe-start t)))
1850 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
1851 ;; another one after the point (which might occur when editing inside a
1852 ;; comment or macro).
1853 (when (eq last-put-in-sws-pos (point))
1854 (cond ((< last-put-in-sws-pos (point-max))
1856 "c-forward-sws clearing at %s for cache separation"
1857 last-put-in-sws-pos)
1858 (c-remove-in-sws last-put-in-sws-pos
1859 (1+ last-put-in-sws-pos)))
1861 ;; If at eob we have to clear the last character before the end
1862 ;; instead since the buffer might be narrowed and there might
1863 ;; be a `c-in-sws' after (point-max). In this case it's
1864 ;; necessary to clear both properties.
1866 "c-forward-sws clearing thoroughly at %s for cache separation"
1867 (1- last-put-in-sws-pos))
1868 (c-remove-is-and-in-sws (1- last-put-in-sws-pos)
1869 last-put-in-sws-pos))))
1872 (defun c-backward-sws ()
1873 ;; Used by `c-backward-syntactic-ws' to implement the unbounded search.
1875 ;; This function might do hidden buffer changes.
1877 (let (;; `rung-pos' is set to a position as late as possible in the unmarked
1878 ;; part of the simple ws region.
1879 (rung-pos (point)) next-rung-pos last-put-in-sws-pos
1880 rung-is-marked simple-ws-beg cmt-skip-pos)
1882 ;; Skip simple horizontal ws and do a quick check on the preceding
1883 ;; character to see if it's anything that can't end syntactic ws, so we can
1884 ;; bail out early in the majority of cases when there just are a few ws
1885 ;; chars. Newlines are complicated in the backward direction, so we can't
1887 (skip-chars-backward " \t\f")
1888 (when (and (not (bobp))
1891 (looking-at c-syntactic-ws-end)))
1893 ;; Try to find a rung position in the simple ws preceding point, so that
1894 ;; we can get a cache hit even if the last bit of the simple ws has
1895 ;; changed recently.
1896 (setq simple-ws-beg (point))
1897 (skip-chars-backward " \t\n\r\f\v")
1898 (if (setq rung-is-marked (text-property-any
1899 (point) (min (1+ rung-pos) (point-max))
1901 ;; `rung-pos' will be the earliest marked position, which means that
1902 ;; there might be later unmarked parts in the simple ws region.
1903 ;; It's not worth the effort to fix that; the last part of the
1904 ;; simple ws is also typically edited often, so it could be wasted.
1905 (goto-char (setq rung-pos rung-is-marked))
1906 (goto-char simple-ws-beg))
1908 (with-silent-modifications
1912 (when (and rung-is-marked
1914 (get-text-property (1- (point)) 'c-in-sws))
1916 ;; The following search is the main reason that `c-in-sws'
1917 ;; and `c-is-sws' aren't combined to one property.
1918 (goto-char (previous-single-property-change
1919 (point) 'c-in-sws nil (point-min)))
1920 (unless (get-text-property (point) 'c-is-sws)
1921 ;; If the `c-in-sws' region extended past the first
1922 ;; `c-is-sws' char we have to go forward a bit.
1923 (goto-char (next-single-property-change
1924 (point) 'c-is-sws)))
1927 "c-backward-sws cached move %s <- %s (min %s)"
1928 (point) rung-pos (point-min))
1930 (setq rung-pos (point))
1931 (if (and (< (min (skip-chars-backward " \t\f\v")
1933 (setq simple-ws-beg (point))
1934 (skip-chars-backward " \t\n\r\f\v")))
1936 (setq rung-is-marked
1937 (text-property-any (point) rung-pos
1940 (goto-char simple-ws-beg)
1943 ;; We'll loop here if there is simple ws before the first rung.
1944 ;; That means that there's been some change in it and it's
1945 ;; possible that we've stepped into another ladder, so extend
1946 ;; the previous one to join with it if there is one, and try to
1947 ;; use the cache again.
1949 "c-backward-sws extending rung with [%s..%s] (min %s)"
1950 rung-is-marked rung-pos (point-min))
1951 (unless (get-text-property (1- rung-pos) 'c-is-sws)
1952 ;; Remove any `c-in-sws' property from the last char of
1953 ;; the rung before we mark it with `c-is-sws', so that we
1954 ;; won't connect with the remains of a broken "ladder".
1955 (c-remove-in-sws (1- rung-pos) rung-pos))
1956 (c-put-is-sws rung-is-marked
1958 (c-put-in-sws rung-is-marked
1960 (setq rung-pos rung-is-marked
1961 last-put-in-sws-pos rung-pos))
1963 (c-backward-comments)
1964 (setq cmt-skip-pos (point))
1967 ((and c-opt-cpp-prefix
1968 (/= cmt-skip-pos simple-ws-beg)
1969 (c-beginning-of-macro))
1970 ;; Inside a cpp directive. See if it should be skipped over.
1971 (let ((cpp-beg (point)))
1973 ;; Move back over all line continuations in the region skipped
1974 ;; over by `c-backward-comments'. If we go past it then we
1975 ;; started inside the cpp directive.
1976 (goto-char simple-ws-beg)
1978 (while (and (> (point) cmt-skip-pos)
1979 (progn (backward-char)
1980 (eq (char-before) ?\\)))
1981 (beginning-of-line))
1983 (if (< (point) cmt-skip-pos)
1984 ;; Don't move past the cpp directive if we began inside
1985 ;; it. Note that the position at the end of the last line
1986 ;; of the macro is also considered to be within it.
1987 (progn (goto-char cmt-skip-pos)
1990 ;; It's worthwhile to spend a little bit of effort on finding
1991 ;; the end of the macro, to get a good `simple-ws-beg'
1992 ;; position for the cache. Note that `c-backward-comments'
1993 ;; could have stepped over some comments before going into
1994 ;; the macro, and then `simple-ws-beg' must be kept on the
1995 ;; same side of those comments.
1996 (goto-char simple-ws-beg)
1997 (skip-chars-backward " \t\n\r\f\v")
1998 (if (eq (char-before) ?\\)
2001 (if (< (point) simple-ws-beg)
2002 ;; Might happen if comments after the macro were skipped
2004 (setq simple-ws-beg (point)))
2009 ((/= (save-excursion
2010 (skip-chars-forward " \t\n\r\f\v" simple-ws-beg)
2011 (setq next-rung-pos (point)))
2013 ;; Skipped over comments. Must put point at the end of
2014 ;; the simple ws at point since we might be after a line
2015 ;; comment or cpp directive that's been partially
2016 ;; narrowed out, and we can't risk marking the simple ws
2017 ;; at the end of it.
2018 (goto-char next-rung-pos)
2021 ;; We've searched over a piece of non-white syntactic ws. See if this
2023 (setq next-rung-pos (point))
2024 (skip-chars-backward " \t\f\v")
2027 ;; Cache if we started either from a marked rung or from a
2028 ;; completely uncached position.
2030 (not (get-text-property (1- simple-ws-beg) 'c-in-sws))
2032 ;; Cache if there's a marked rung in the encountered simple ws.
2034 (skip-chars-backward " \t\n\r\f\v")
2035 (text-property-any (point) (min (1+ next-rung-pos) (point-max))
2040 "c-backward-sws caching [%s..%s] - [%s..%s] (min %s)"
2041 (point) (1+ next-rung-pos)
2042 simple-ws-beg (min (1+ rung-pos) (point-max))
2045 ;; Remove the properties for any nested ws that might be cached.
2046 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
2048 (c-remove-is-sws (1+ next-rung-pos) simple-ws-beg)
2049 (unless (and rung-is-marked (= simple-ws-beg rung-pos))
2050 (let ((rung-end-pos (min (1+ rung-pos) (point-max))))
2051 (unless (get-text-property (1- rung-end-pos) 'c-is-sws)
2052 ;; Remove any `c-in-sws' property from the last char of
2053 ;; the rung before we mark it with `c-is-sws', so that we
2054 ;; won't connect with the remains of a broken "ladder".
2055 (c-remove-in-sws (1- rung-end-pos) rung-end-pos))
2056 (c-put-is-sws simple-ws-beg
2058 (setq rung-is-marked t)))
2059 (c-put-in-sws (setq simple-ws-beg (point)
2060 last-put-in-sws-pos simple-ws-beg)
2062 (c-put-is-sws (setq rung-pos simple-ws-beg)
2063 (1+ next-rung-pos)))
2066 "c-backward-sws not caching [%s..%s] - [%s..%s] (min %s)"
2067 (point) (1+ next-rung-pos)
2068 simple-ws-beg (min (1+ rung-pos) (point-max))
2070 (setq rung-pos next-rung-pos
2071 simple-ws-beg (point))
2074 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
2075 ;; another one before the point (which might occur when editing inside a
2076 ;; comment or macro).
2077 (when (eq last-put-in-sws-pos (point))
2078 (cond ((< (point-min) last-put-in-sws-pos)
2080 "c-backward-sws clearing at %s for cache separation"
2081 (1- last-put-in-sws-pos))
2082 (c-remove-in-sws (1- last-put-in-sws-pos)
2083 last-put-in-sws-pos))
2085 ;; If at bob and the buffer is narrowed, we have to clear the
2086 ;; character we're standing on instead since there might be a
2087 ;; `c-in-sws' before (point-min). In this case it's necessary
2088 ;; to clear both properties.
2090 "c-backward-sws clearing thoroughly at %s for cache separation"
2091 last-put-in-sws-pos)
2092 (c-remove-is-and-in-sws last-put-in-sws-pos
2093 (1+ last-put-in-sws-pos)))))
2097 ;; Other whitespace tools
2098 (defun c-partial-ws-p (beg end)
2099 ;; Is the region (beg end) WS, and is there WS (or BOB/EOB) next to the
2100 ;; region? This is a "heuristic" function. .....
2102 ;; The motivation for the second bit is to check whether removing this
2103 ;; region would coalesce two symbols.
2105 ;; FIXME!!! This function doesn't check virtual semicolons in any way. Be
2106 ;; careful about using this function for, e.g. AWK. (2007/3/7)
2108 (let ((end+1 (min (1+ end) (point-max))))
2109 (or (progn (goto-char (max (point-min) (1- beg)))
2110 (c-skip-ws-forward end)
2112 (progn (goto-char beg)
2113 (c-skip-ws-forward end+1)
2114 (eq (point) end+1))))))
2116 ;; A system for finding noteworthy parens before the point.
2118 (defconst c-state-cache-too-far 5000)
2119 ;; A maximum comfortable scanning distance, e.g. between
2120 ;; `c-state-cache-good-pos' and "HERE" (where we call c-parse-state). When
2121 ;; this distance is exceeded, we take "emergency measures", e.g. by clearing
2122 ;; the cache and starting again from point-min or a beginning of defun. This
2123 ;; value can be tuned for efficiency or set to a lower value for testing.
2125 (defvar c-state-cache nil)
2126 (make-variable-buffer-local 'c-state-cache)
2127 ;; The state cache used by `c-parse-state' to cut down the amount of
2128 ;; searching. It's the result from some earlier `c-parse-state' call. See
2129 ;; `c-parse-state''s doc string for details of its structure.
2131 ;; The use of the cached info is more effective if the next
2132 ;; `c-parse-state' call is on a line close by the one the cached state
2133 ;; was made at; the cache can actually slow down a little if the
2134 ;; cached state was made very far back in the buffer. The cache is
2135 ;; most effective if `c-parse-state' is used on each line while moving
2138 (defvar c-state-cache-good-pos 1)
2139 (make-variable-buffer-local 'c-state-cache-good-pos)
2140 ;; This is a position where `c-state-cache' is known to be correct, or
2141 ;; nil (see below). It's a position inside one of the recorded unclosed
2142 ;; parens or the top level, but not further nested inside any literal or
2143 ;; subparen that is closed before the last recorded position.
2145 ;; The exact position is chosen to try to be close to yet earlier than
2146 ;; the position where `c-state-cache' will be called next. Right now
2147 ;; the heuristic is to set it to the position after the last found
2148 ;; closing paren (of any type) before the line on which
2149 ;; `c-parse-state' was called. That is chosen primarily to work well
2150 ;; with refontification of the current line.
2152 ;; 2009-07-28: When `c-state-point-min' and the last position where
2153 ;; `c-parse-state' or for which `c-invalidate-state-cache' was called, are
2154 ;; both in the same literal, there is no such "good position", and
2155 ;; c-state-cache-good-pos is then nil. This is the ONLY circumstance in which
2156 ;; it can be nil. In this case, `c-state-point-min-literal' will be non-nil.
2158 ;; 2009-06-12: In a brace desert, c-state-cache-good-pos may also be in
2159 ;; the middle of the desert, as long as it is not within a brace pair
2160 ;; recorded in `c-state-cache' or a paren/bracket pair.
2162 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2163 ;; We maintain a simple cache of positions which aren't in a literal, so as to
2164 ;; speed up testing for non-literality.
2165 (defconst c-state-nonlit-pos-interval 3000)
2166 ;; The approximate interval between entries in `c-state-nonlit-pos-cache'.
2168 (defvar c-state-nonlit-pos-cache nil)
2169 (make-variable-buffer-local 'c-state-nonlit-pos-cache)
2170 ;; A list of buffer positions which are known not to be in a literal or a cpp
2171 ;; construct. This is ordered with higher positions at the front of the list.
2172 ;; Only those which are less than `c-state-nonlit-pos-cache-limit' are valid.
2174 (defvar c-state-nonlit-pos-cache-limit 1)
2175 (make-variable-buffer-local 'c-state-nonlit-pos-cache-limit)
2176 ;; An upper limit on valid entries in `c-state-nonlit-pos-cache'. This is
2177 ;; reduced by buffer changes, and increased by invocations of
2178 ;; `c-state-literal-at'.
2180 (defvar c-state-semi-nonlit-pos-cache nil)
2181 (make-variable-buffer-local 'c-state-semi-nonlit-pos-cache)
2182 ;; A list of buffer positions which are known not to be in a literal. This is
2183 ;; ordered with higher positions at the front of the list. Only those which
2184 ;; are less than `c-state-semi-nonlit-pos-cache-limit' are valid.
2186 (defvar c-state-semi-nonlit-pos-cache-limit 1)
2187 (make-variable-buffer-local 'c-state-semi-nonlit-pos-cache-limit)
2188 ;; An upper limit on valid entries in `c-state-semi-nonlit-pos-cache'. This is
2189 ;; reduced by buffer changes, and increased by invocations of
2190 ;; `c-state-literal-at'. FIXME!!!
2192 (defsubst c-state-pp-to-literal (from to &optional not-in-delimiter)
2193 ;; Do a parse-partial-sexp from FROM to TO, returning either
2194 ;; (STATE TYPE (BEG . END)) if TO is in a literal; or
2195 ;; (STATE) otherwise,
2196 ;; where STATE is the parsing state at TO, TYPE is the type of the literal
2197 ;; (one of 'c, 'c++, 'string) and (BEG . END) is the boundaries of the literal.
2199 ;; Unless NOT-IN-DELIMITER is non-nil, when TO is inside a two-character
2200 ;; comment opener, this is recognized as being in a comment literal.
2202 ;; Only elements 3 (in a string), 4 (in a comment), 5 (following a quote),
2203 ;; 7 (comment type) and 8 (start of comment/string) (and possibly 9) of
2206 (let ((s (parse-partial-sexp from to))
2209 ((or (nth 3 s) (nth 4 s)) ; in a string or comment
2214 (parse-partial-sexp (point) (point-max)
2218 'syntax-table) ; stop at end of literal
2219 `(,s ,ty (,(nth 8 s) . ,(point))))
2221 ((and (not not-in-delimiter) ; inside a comment starter
2223 (progn (backward-char)
2224 (and (not (and (memq 'category-properties c-emacs-features)
2225 (looking-at "\\s!")))
2226 (looking-at c-comment-start-regexp))))
2227 (setq ty (if (looking-at c-block-comment-start-regexp) 'c 'c++)
2230 `(,s ,ty (,co-st . ,(point))))
2234 (defun c-state-safe-place (here)
2235 ;; Return a buffer position before HERE which is "safe", i.e. outside any
2236 ;; string, comment, or macro.
2238 ;; NOTE: This function manipulates `c-state-nonlit-pos-cache'. This cache
2239 ;; MAY NOT contain any positions within macros, since macros are frequently
2240 ;; turned into comments by use of the `c-cpp-delimiter' category properties.
2241 ;; We cannot rely on this mechanism whilst determining a cache pos since
2242 ;; this function is also called from outwith `c-parse-state'.
2246 (let ((c c-state-nonlit-pos-cache)
2247 pos npos high-pos lit macro-beg macro-end)
2248 ;; Trim the cache to take account of buffer changes.
2249 (while (and c (> (car c) c-state-nonlit-pos-cache-limit))
2251 (setq c-state-nonlit-pos-cache c)
2253 (while (and c (> (car c) here))
2254 (setq high-pos (car c))
2256 (setq pos (or (car c) (point-min)))
2260 ;; Add an element to `c-state-nonlit-pos-cache' each iteration.
2262 (<= (setq npos (+ pos c-state-nonlit-pos-interval)) here)
2264 ;; Test for being in a literal. If so, go to after it.
2266 (setq lit (car (cddr (c-state-pp-to-literal pos npos))))
2268 (prog1 (<= (cdr lit) here)
2269 (setq npos (cdr lit)))))
2271 ;; Test for being in a macro. If so, go to after it.
2275 (and (c-beginning-of-macro) (/= (point) npos) (point)))
2277 (c-syntactic-end-of-macro)
2278 (or (eobp) (forward-char))
2279 (setq macro-end (point)))
2280 (or (null macro-beg)
2281 (prog1 (<= macro-end here)
2282 (setq npos macro-end)))))
2285 (setq c-state-nonlit-pos-cache (cons pos c-state-nonlit-pos-cache)))
2286 ;; Add one extra element above HERE so as to to avoid the previous
2287 ;; expensive calculation when the next call is close to the current
2288 ;; one. This is especially useful when inside a large macro.
2289 (setq c-state-nonlit-pos-cache (cons npos c-state-nonlit-pos-cache)))
2291 (if (> pos c-state-nonlit-pos-cache-limit)
2292 (setq c-state-nonlit-pos-cache-limit pos))
2295 (defun c-state-semi-safe-place (here)
2296 ;; Return a buffer position before HERE which is "safe", i.e. outside any
2297 ;; string or comment. It may be in a macro.
2301 (let ((c c-state-semi-nonlit-pos-cache)
2302 pos npos high-pos lit macro-beg macro-end)
2303 ;; Trim the cache to take account of buffer changes.
2304 (while (and c (> (car c) c-state-semi-nonlit-pos-cache-limit))
2306 (setq c-state-semi-nonlit-pos-cache c)
2308 (while (and c (> (car c) here))
2309 (setq high-pos (car c))
2311 (setq pos (or (car c) (point-min)))
2315 ;; Add an element to `c-state-semi-nonlit-pos-cache' each iteration.
2317 (<= (setq npos (+ pos c-state-nonlit-pos-interval)) here)
2319 ;; Test for being in a literal. If so, go to after it.
2321 (setq lit (car (cddr (c-state-pp-to-literal pos npos))))
2323 (prog1 (<= (cdr lit) here)
2324 (setq npos (cdr lit))))))
2327 (setq c-state-semi-nonlit-pos-cache
2328 (cons pos c-state-semi-nonlit-pos-cache))))
2330 (if (> pos c-state-semi-nonlit-pos-cache-limit)
2331 (setq c-state-semi-nonlit-pos-cache-limit pos))
2334 (defun c-state-literal-at (here)
2335 ;; If position HERE is inside a literal, return (START . END), the
2336 ;; boundaries of the literal (which may be outside the accessible bit of the
2337 ;; buffer). Otherwise, return nil.
2339 ;; This function is almost the same as `c-literal-limits'. Previously, it
2340 ;; differed in that it was a lower level function, and that it rigorously
2341 ;; followed the syntax from BOB. `c-literal-limits' is now (2011-12)
2342 ;; virtually identical to this function.
2346 (let ((pos (c-state-safe-place here)))
2347 (car (cddr (c-state-pp-to-literal pos here)))))))
2349 (defsubst c-state-lit-beg (pos)
2350 ;; Return the start of the literal containing POS, or POS itself.
2351 (or (car (c-state-literal-at pos))
2354 (defsubst c-state-cache-non-literal-place (pos state)
2355 ;; Return a position outside of a string/comment/macro at or before POS.
2356 ;; STATE is the parse-partial-sexp state at POS.
2357 (let ((res (if (or (nth 3 state) ; in a string?
2358 (nth 4 state)) ; in a comment?
2363 (if (c-beginning-of-macro)
2367 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2368 ;; Stuff to do with point-min, and coping with any literal there.
2369 (defvar c-state-point-min 1)
2370 (make-variable-buffer-local 'c-state-point-min)
2371 ;; This is (point-min) when `c-state-cache' was last calculated. A change of
2372 ;; narrowing is likely to affect the parens that are visible before the point.
2374 (defvar c-state-point-min-lit-type nil)
2375 (make-variable-buffer-local 'c-state-point-min-lit-type)
2376 (defvar c-state-point-min-lit-start nil)
2377 (make-variable-buffer-local 'c-state-point-min-lit-start)
2378 ;; These two variables define the literal, if any, containing point-min.
2379 ;; Their values are, respectively, 'string, c, or c++, and the start of the
2380 ;; literal. If there's no literal there, they're both nil.
2382 (defvar c-state-min-scan-pos 1)
2383 (make-variable-buffer-local 'c-state-min-scan-pos)
2384 ;; This is the earliest buffer-pos from which scanning can be done. It is
2385 ;; either the end of the literal containing point-min, or point-min itself.
2386 ;; It becomes nil if the buffer is changed earlier than this point.
2387 (defun c-state-get-min-scan-pos ()
2388 ;; Return the lowest valid scanning pos. This will be the end of the
2389 ;; literal enclosing point-min, or point-min itself.
2390 (or c-state-min-scan-pos
2394 (goto-char c-state-point-min-lit-start)
2395 (if (eq c-state-point-min-lit-type 'string)
2397 (forward-comment 1))
2398 (setq c-state-min-scan-pos (point))))))
2400 (defun c-state-mark-point-min-literal ()
2401 ;; Determine the properties of any literal containing POINT-MIN, setting the
2402 ;; variables `c-state-point-min-lit-type', `c-state-point-min-lit-start',
2403 ;; and `c-state-min-scan-pos' accordingly. The return value is meaningless.
2404 (let ((p-min (point-min))
2408 (setq lit (c-state-literal-at p-min))
2410 (setq c-state-point-min-lit-type
2412 (goto-char (car lit))
2414 ((looking-at c-block-comment-start-regexp) 'c)
2415 ((looking-at c-line-comment-starter) 'c++)
2417 c-state-point-min-lit-start (car lit)
2418 c-state-min-scan-pos (cdr lit))
2419 (setq c-state-point-min-lit-type nil
2420 c-state-point-min-lit-start nil
2421 c-state-min-scan-pos p-min)))))
2424 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2425 ;; A variable which signals a brace dessert - helpful for reducing the number
2426 ;; of fruitless backward scans.
2427 (defvar c-state-brace-pair-desert nil)
2428 (make-variable-buffer-local 'c-state-brace-pair-desert)
2429 ;; Used only in `c-append-lower-brace-pair-to-state-cache'. It is set when
2430 ;; that defun has searched backwards for a brace pair and not found one. Its
2431 ;; value is either nil or a cons (PA . FROM), where PA is the position of the
2432 ;; enclosing opening paren/brace/bracket which bounds the backwards search (or
2433 ;; nil when at top level) and FROM is where the backward search started. It
2434 ;; is reset to nil in `c-invalidate-state-cache'.
2437 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2438 ;; Lowish level functions/macros which work directly on `c-state-cache', or a
2439 ;; list of like structure.
2440 (defmacro c-state-cache-top-lparen (&optional cache)
2441 ;; Return the address of the top left brace/bracket/paren recorded in CACHE
2442 ;; (default `c-state-cache') (or nil).
2443 (let ((cash (or cache 'c-state-cache)))
2444 `(if (consp (car ,cash))
2448 (defmacro c-state-cache-top-paren (&optional cache)
2449 ;; Return the address of the latest brace/bracket/paren (whether left or
2450 ;; right) recorded in CACHE (default `c-state-cache') or nil.
2451 (let ((cash (or cache 'c-state-cache)))
2452 `(if (consp (car ,cash))
2456 (defmacro c-state-cache-after-top-paren (&optional cache)
2457 ;; Return the position just after the latest brace/bracket/paren (whether
2458 ;; left or right) recorded in CACHE (default `c-state-cache') or nil.
2459 (let ((cash (or cache 'c-state-cache)))
2460 `(if (consp (car ,cash))
2463 (1+ (car ,cash))))))
2465 (defun c-get-cache-scan-pos (here)
2466 ;; From the state-cache, determine the buffer position from which we might
2467 ;; scan forward to HERE to update this cache. This position will be just
2468 ;; after a paren/brace/bracket recorded in the cache, if possible, otherwise
2469 ;; return the earliest position in the accessible region which isn't within
2470 ;; a literal. If the visible portion of the buffer is entirely within a
2471 ;; literal, return NIL.
2472 (let ((c c-state-cache) elt)
2473 ;(while (>= (or (c-state-cache-top-lparen c) 1) here)
2475 (>= (c-state-cache-top-lparen c) here))
2481 (if (> (cdr elt) here)
2485 ((<= (c-state-get-min-scan-pos) here)
2486 (c-state-get-min-scan-pos))
2489 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2490 ;; Variables which keep track of preprocessor constructs.
2491 (defvar c-state-old-cpp-beg-marker nil)
2492 (make-variable-buffer-local 'c-state-old-cpp-beg-marker)
2493 (defvar c-state-old-cpp-beg nil)
2494 (make-variable-buffer-local 'c-state-old-cpp-beg)
2495 (defvar c-state-old-cpp-end-marker nil)
2496 (make-variable-buffer-local 'c-state-old-cpp-end-marker)
2497 (defvar c-state-old-cpp-end nil)
2498 (make-variable-buffer-local 'c-state-old-cpp-end)
2499 ;; These are the limits of the macro containing point at the previous call of
2500 ;; `c-parse-state', or nil.
2502 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2503 ;; Defuns which analyze the buffer, yet don't change `c-state-cache'.
2504 (defun c-state-balance-parens-backwards (here- here+ top)
2505 ;; Return the position of the opening paren/brace/bracket before HERE- which
2506 ;; matches the outermost close p/b/b between HERE+ and TOP. Except when
2507 ;; there's a macro, HERE- and HERE+ are the same. Like this:
2509 ;; ............................................
2511 ;; ( [ ( .........#macro.. ) ( ) ] )
2514 ;; return HERE- HERE+ TOP
2516 ;; If there aren't enough opening paren/brace/brackets, return the position
2517 ;; of the outermost one found, or HERE- if there are none. If there are no
2518 ;; closing p/b/bs between HERE+ and TOP, return HERE-. HERE-/+ and TOP
2519 ;; must not be inside literals. Only the accessible portion of the buffer
2522 ;; PART 1: scan from `here+' up to `top', accumulating ")"s which enclose
2523 ;; `here'. Go round the next loop each time we pass over such a ")". These
2524 ;; probably match "("s before `here-'.
2525 (let (pos pa ren+1 lonely-rens)
2528 (narrow-to-region (point-min) top) ; This can move point, sometimes.
2532 (setq ren+1 (scan-lists pos 1 1)) ; might signal
2533 (setq lonely-rens (cons ren+1 lonely-rens)
2536 ;; PART 2: Scan back before `here-' searching for the "("s
2537 ;; matching/mismatching the ")"s found above. We only need to direct the
2538 ;; caller to scan when we've encountered unmatched right parens.
2543 (and lonely-rens ; actual values aren't used.
2544 (setq pa (scan-lists pos -1 1)))
2546 (setq lonely-rens (cdr lonely-rens)))))
2549 (defun c-parse-state-get-strategy (here good-pos)
2550 ;; Determine the scanning strategy for adjusting `c-parse-state', attempting
2551 ;; to minimize the amount of scanning. HERE is the pertinent position in
2552 ;; the buffer, GOOD-POS is a position where `c-state-cache' (possibly with
2553 ;; its head trimmed) is known to be good, or nil if there is no such
2556 ;; The return value is a list, one of the following:
2558 ;; o - ('forward START-POINT) - scan forward from START-POINT,
2559 ;; which is not less than the highest position in `c-state-cache' below HERE,
2560 ;; which is after GOOD-POS.
2561 ;; o - ('backward nil) - scan backwards (from HERE).
2562 ;; o - ('back-and-forward START-POINT) - like 'forward, but when HERE is earlier
2564 ;; o - ('IN-LIT nil) - point is inside the literal containing point-min.
2565 (let ((cache-pos (c-get-cache-scan-pos here)) ; highest position below HERE in cache (or 1)
2566 strategy ; 'forward, 'backward, or 'IN-LIT.
2568 (setq good-pos (or good-pos (c-state-get-min-scan-pos)))
2570 ((< here (c-state-get-min-scan-pos))
2571 (setq strategy 'IN-LIT))
2573 (setq strategy 'forward
2574 start-point (max good-pos cache-pos)))
2575 ((< (- good-pos here) (- here cache-pos)) ; FIXME!!! ; apply some sort of weighting.
2576 (setq strategy 'backward))
2578 (setq strategy 'back-and-forward
2579 start-point cache-pos)))
2580 (list strategy start-point)))
2583 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2584 ;; Routines which change `c-state-cache' and associated values.
2585 (defun c-renarrow-state-cache ()
2586 ;; The region (more precisely, point-min) has changed since we
2587 ;; calculated `c-state-cache'. Amend `c-state-cache' accordingly.
2588 (if (< (point-min) c-state-point-min)
2589 ;; If point-min has MOVED BACKWARDS then we drop the state completely.
2590 ;; It would be possible to do a better job here and recalculate the top
2593 (c-state-mark-point-min-literal)
2594 (setq c-state-cache nil
2595 c-state-cache-good-pos c-state-min-scan-pos
2596 c-state-brace-pair-desert nil))
2598 ;; point-min has MOVED FORWARD.
2600 ;; Is the new point-min inside a (different) literal?
2601 (unless (and c-state-point-min-lit-start ; at prev. point-min
2602 (< (point-min) (c-state-get-min-scan-pos)))
2603 (c-state-mark-point-min-literal))
2605 ;; Cut off a bit of the tail from `c-state-cache'.
2606 (let ((ptr (cons nil c-state-cache))
2608 (while (and (setq pa (c-state-cache-top-lparen (cdr ptr)))
2609 (>= pa (point-min)))
2610 (setq ptr (cdr ptr)))
2613 (if (eq (cdr ptr) c-state-cache)
2614 (setq c-state-cache nil
2615 c-state-cache-good-pos c-state-min-scan-pos)
2617 (setq c-state-cache-good-pos (1+ (c-state-cache-top-lparen))))
2620 (setq c-state-point-min (point-min)))
2622 (defun c-append-lower-brace-pair-to-state-cache (from here &optional upper-lim)
2623 ;; If there is a brace pair preceding FROM in the buffer, at the same level
2624 ;; of nesting (not necessarily immediately preceding), push a cons onto
2625 ;; `c-state-cache' to represent it. FROM must not be inside a literal. If
2626 ;; UPPER-LIM is non-nil, we append the highest brace pair whose "}" is below
2629 ;; Return non-nil when this has been done.
2631 ;; The situation it copes with is this transformation:
2633 ;; OLD: { (.) {...........}
2637 ;; NEW: { {....} (.) {.........
2639 ;; LOWER BRACE PAIR HERE or HERE
2641 ;; This routine should be fast. Since it can get called a LOT, we maintain
2642 ;; `c-state-brace-pair-desert', a small cache of "failures", such that we
2643 ;; reduce the time wasted in repeated fruitless searches in brace deserts.
2647 (cache-pos (c-state-cache-top-lparen)) ; might be nil.
2648 (macro-start-or-from
2649 (progn (goto-char from)
2650 (c-beginning-of-macro)
2652 (bra ; Position of "{".
2653 ;; Don't start scanning in the middle of a CPP construct unless
2654 ;; it contains HERE - these constructs, in Emacs, are "commented
2655 ;; out" with category properties.
2656 (if (eq (c-get-char-property macro-start-or-from 'category)
2660 ce) ; Position of "}"
2661 (or upper-lim (setq upper-lim from))
2663 ;; If we're essentially repeating a fruitless search, just give up.
2664 (unless (and c-state-brace-pair-desert
2665 (eq cache-pos (car c-state-brace-pair-desert))
2666 (or (null (car c-state-brace-pair-desert))
2667 (> from (car c-state-brace-pair-desert)))
2668 (<= from (cdr c-state-brace-pair-desert)))
2669 ;; DESERT-LIM. Avoid repeated searching through the cached desert.
2671 (and c-state-brace-pair-desert
2672 (eq cache-pos (car c-state-brace-pair-desert))
2673 (>= from (cdr c-state-brace-pair-desert))
2674 (cdr c-state-brace-pair-desert)))
2675 ;; CACHE-LIM. This limit will be necessary when an opening
2676 ;; paren at `cache-pos' has just had its matching close paren
2677 ;; inserted into the buffer. `cache-pos' continues to be a
2678 ;; search bound, even though the algorithm below would skip
2679 ;; over the new paren pair.
2680 (cache-lim (and cache-pos (< cache-pos from) cache-pos)))
2683 ((and desert-lim cache-lim)
2684 (max desert-lim cache-lim))
2688 ;; The top limit is EOB to ensure that `bra' is inside the
2689 ;; accessible part of the buffer at the next scan operation.
2690 (1+ (buffer-size))))
2692 ;; In the next pair of nested loops, the inner one moves back past a
2693 ;; pair of (mis-)matching parens or brackets; the outer one moves
2694 ;; back over a sequence of unmatched close brace/paren/bracket each
2700 (and (setq ce (scan-lists bra -1 -1)) ; back past )/]/}; might signal
2701 (setq bra (scan-lists ce -1 1)) ; back past (/[/{; might signal
2702 (or (> bra here) ;(> ce here)
2705 (or (not (eq (char-after bra) ?\{))
2706 (and (goto-char bra)
2707 (c-beginning-of-macro)
2708 (< (point) macro-start-or-from))))))))
2709 (and ce (< ce bra)))
2710 (setq bra ce)) ; If we just backed over an unbalanced closing
2713 (if (and ce (< ce here) (< bra ce) (eq (char-after bra) ?\{))
2714 ;; We've found the desired brace-pair.
2716 (setq new-cons (cons bra (1+ ce)))
2718 ((consp (car c-state-cache))
2719 (setcar c-state-cache new-cons))
2720 ((and (numberp (car c-state-cache)) ; probably never happens
2721 (< ce (car c-state-cache)))
2722 (setcdr c-state-cache
2723 (cons new-cons (cdr c-state-cache))))
2724 (t (setq c-state-cache (cons new-cons c-state-cache)))))
2726 ;; We haven't found a brace pair. Record this in the cache.
2727 (setq c-state-brace-pair-desert
2728 (cons (if (and ce (< bra ce) (> ce here)) ; {..} straddling HERE?
2731 (min here from)))))))))
2733 (defsubst c-state-push-any-brace-pair (bra+1 macro-start-or-here)
2734 ;; If BRA+1 is nil, do nothing. Otherwise, BRA+1 is the buffer position
2735 ;; following a {, and that brace has a (mis-)matching } (or ]), and we
2736 ;; "push" "a" brace pair onto `c-state-cache'.
2738 ;; Here "push" means overwrite the top element if it's itself a brace-pair,
2739 ;; otherwise push it normally.
2741 ;; The brace pair we push is normally the one surrounding BRA+1, but if the
2742 ;; latter is inside a macro, not being a macro containing
2743 ;; MACRO-START-OR-HERE, we scan backwards through the buffer for a non-macro
2744 ;; base pair. This latter case is assumed to be rare.
2746 ;; Note: POINT is not preserved in this routine.
2748 (if (or (> bra+1 macro-start-or-here)
2749 (progn (goto-char bra+1)
2750 (not (c-beginning-of-macro))))
2752 (cons (cons (1- bra+1)
2753 (scan-lists bra+1 1 1))
2754 (if (consp (car c-state-cache))
2757 ;; N.B. This defsubst codes one method for the simple, normal case,
2758 ;; and a more sophisticated, slower way for the general case. Don't
2759 ;; eliminate this defsubst - it's a speed optimization.
2760 (c-append-lower-brace-pair-to-state-cache (1- bra+1) (point-max)))))
2762 (defun c-append-to-state-cache (from here)
2763 ;; Scan the buffer from FROM to HERE, adding elements into `c-state-cache'
2764 ;; for braces etc. Return a candidate for `c-state-cache-good-pos'.
2766 ;; FROM must be after the latest brace/paren/bracket in `c-state-cache', if
2767 ;; any. Typically, it is immediately after it. It must not be inside a
2769 (let ((here-bol (c-point 'bol here))
2770 (macro-start-or-here
2771 (save-excursion (goto-char here)
2772 (if (c-beginning-of-macro)
2775 pa+1 ; pos just after an opening PAren (or brace).
2776 (ren+1 from) ; usually a pos just after an closing paREN etc.
2777 ; Is actually the pos. to scan for a (/{/[ from,
2778 ; which sometimes is after a silly )/}/].
2779 paren+1 ; Pos after some opening or closing paren.
2780 paren+1s ; A list of `paren+1's; used to determine a
2782 bra+1 ; just after L bra-ce.
2783 bra+1s ; list of OLD values of bra+1.
2784 mstart) ; start of a macro.
2788 (narrow-to-region (point-min) here)
2789 ;; Each time round the following loop, we enter a successively deeper
2790 ;; level of brace/paren nesting. (Except sometimes we "continue at
2791 ;; the existing level".) `pa+1' is a pos inside an opening
2792 ;; brace/paren/bracket, usually just after it.
2795 ;; Each time round the next loop moves forward over an opening then
2796 ;; a closing brace/bracket/paren. This loop is white hot, so it
2797 ;; plays ugly tricks to go fast. DON'T PUT ANYTHING INTO THIS
2798 ;; LOOP WHICH ISN'T ABSOLUTELY NECESSARY!!! It terminates when a
2799 ;; call of `scan-lists' signals an error, which happens when there
2800 ;; are no more b/b/p's to scan.
2803 (setq pa+1 (scan-lists ren+1 1 -1) ; Into (/{/[; might signal
2804 paren+1s (cons pa+1 paren+1s))
2805 (setq ren+1 (scan-lists pa+1 1 1)) ; Out of )/}/]; might signal
2806 (if (and (eq (char-before pa+1) ?{)) ; Check for a macro later.
2808 (setcar paren+1s ren+1)))
2810 (if (and pa+1 (> pa+1 ren+1))
2811 ;; We've just entered a deeper nesting level.
2813 ;; Insert the brace pair (if present) and the single open
2814 ;; paren/brace/bracket into `c-state-cache' It cannot be
2815 ;; inside a macro, except one around point, because of what
2816 ;; `c-neutralize-syntax-in-CPP' has done.
2817 (c-state-push-any-brace-pair bra+1 macro-start-or-here)
2818 ;; Insert the opening brace/bracket/paren position.
2819 (setq c-state-cache (cons (1- pa+1) c-state-cache))
2820 ;; Clear admin stuff for the next more nested part of the scan.
2821 (setq ren+1 pa+1 pa+1 nil bra+1 nil bra+1s nil)
2822 t) ; Carry on the loop
2824 ;; All open p/b/b's at this nesting level, if any, have probably
2825 ;; been closed by matching/mismatching ones. We're probably
2826 ;; finished - we just need to check for having found an
2827 ;; unmatched )/}/], which we ignore. Such a )/}/] can't be in a
2828 ;; macro, due the action of `c-neutralize-syntax-in-CPP'.
2829 (c-safe (setq ren+1 (scan-lists ren+1 1 1)))))) ; acts as loop control.
2831 ;; Record the final, innermost, brace-pair if there is one.
2832 (c-state-push-any-brace-pair bra+1 macro-start-or-here)
2834 ;; Determine a good pos
2835 (while (and (setq paren+1 (car paren+1s))
2836 (> (if (> paren+1 macro-start-or-here)
2839 (setq mstart (and (c-beginning-of-macro)
2841 (or mstart paren+1))
2843 (setq paren+1s (cdr paren+1s)))
2845 ((and paren+1 mstart)
2846 (min paren+1 mstart))
2850 (defun c-remove-stale-state-cache (start-point here pps-point)
2851 ;; Remove stale entries from the `c-cache-state', i.e. those which will
2852 ;; not be in it when it is amended for position HERE. This may involve
2853 ;; replacing a CONS element for a brace pair containing HERE with its car.
2854 ;; Additionally, the "outermost" open-brace entry before HERE will be
2855 ;; converted to a cons if the matching close-brace is below HERE.
2857 ;; START-POINT is a "maximal" "safe position" - there must be no open
2858 ;; parens/braces/brackets between START-POINT and HERE.
2860 ;; As a second thing, calculate the result of parse-partial-sexp at
2861 ;; PPS-POINT, w.r.t. START-POINT. The motivation here is that
2862 ;; `c-state-cache-good-pos' may become PPS-POINT, but the caller may need to
2863 ;; adjust it to get outside a string/comment. (Sorry about this! The code
2864 ;; needs to be FAST).
2866 ;; Return a list (GOOD-POS SCAN-BACK-POS CONS-SEPARATED PPS-STATE), where
2867 ;; o - GOOD-POS is a position where the new value `c-state-cache' is known
2868 ;; to be good (we aim for this to be as high as possible);
2869 ;; o - SCAN-BACK-POS, if not nil, indicates there may be a brace pair
2870 ;; preceding POS which needs to be recorded in `c-state-cache'. It is a
2871 ;; position to scan backwards from. It is the position of the "{" of the
2872 ;; last element to be removed from `c-state-cache', when that elt is a
2873 ;; cons, otherwise nil.
2874 ;; o - CONS-SEPARATED is t when a cons element in `c-state-cache' has been
2875 ;; replaced by its car because HERE lies inside the brace pair represented
2877 ;; o - PPS-STATE is the parse-partial-sexp state at PPS-POINT.
2880 (narrow-to-region 1 (point-max))
2881 (let* ((in-macro-start ; start of macro containing HERE or nil.
2884 (and (c-beginning-of-macro)
2886 (start-point-actual-macro-start ; Start of macro containing
2887 ; start-point or nil
2888 (and (< start-point here)
2890 (goto-char start-point)
2891 (and (c-beginning-of-macro)
2893 (start-point-actual-macro-end ; End of this macro, (maybe
2895 (and start-point-actual-macro-start
2897 (goto-char start-point-actual-macro-start)
2900 pps-state ; Will be 9 or 10 elements long.
2902 upper-lim ; ,beyond which `c-state-cache' entries are removed
2905 pair-beg pps-point-state target-depth)
2907 ;; Remove entries beyond HERE. Also remove any entries inside
2908 ;; a macro, unless HERE is in the same macro.
2910 (if (or (null c-state-old-cpp-beg)
2911 (and (> here c-state-old-cpp-beg)
2912 (< here c-state-old-cpp-end)))
2914 (min here c-state-old-cpp-beg)))
2915 (while (and c-state-cache (>= (c-state-cache-top-lparen) upper-lim))
2916 (setq scan-back-pos (car-safe (car c-state-cache)))
2917 (setq c-state-cache (cdr c-state-cache)))
2919 ;; If `upper-lim' is inside the last recorded brace pair, remove its
2920 ;; RBrace and indicate we'll need to search backwards for a previous
2922 (when (and c-state-cache
2923 (consp (car c-state-cache))
2924 (> (cdar c-state-cache) upper-lim))
2925 (setcar c-state-cache (caar c-state-cache))
2926 (setq scan-back-pos (car c-state-cache)
2929 ;; The next loop jumps forward out of a nested level of parens each
2930 ;; time round; the corresponding elements in `c-state-cache' are
2931 ;; removed. `pos' is just after the brace-pair or the open paren at
2932 ;; (car c-state-cache). There can be no open parens/braces/brackets
2933 ;; between `start-point'/`start-point-actual-macro-start' and HERE,
2934 ;; due to the interface spec to this function.
2935 (setq pos (if (and start-point-actual-macro-end
2936 (not (eq start-point-actual-macro-start
2938 (1+ start-point-actual-macro-end) ; get outside the macro as
2939 ; marked by a `category' text property.
2942 (while (and c-state-cache
2943 (or (numberp (car c-state-cache)) ; Have we a { at all?
2944 (cdr c-state-cache))
2947 ((null pps-state) ; first time through
2948 (setq target-depth -1))
2949 ((eq (car pps-state) target-depth) ; found closing ),},]
2950 (setq target-depth (1- (car pps-state))))
2951 ;; Do nothing when we've merely reached pps-point.
2957 (point) (if (< (point) pps-point) pps-point here)
2961 (if (= (point) pps-point)
2962 (setq pps-point-state pps-state))
2964 (when (eq (car pps-state) target-depth)
2965 (setq pos (point)) ; POS is now just after an R-paren/brace.
2967 ((and (consp (car c-state-cache))
2968 (eq (point) (cdar c-state-cache)))
2969 ;; We've just moved out of the paren pair containing the brace-pair
2970 ;; at (car c-state-cache). `pair-beg' is where the open paren is,
2971 ;; and is potentially where the open brace of a cons in
2972 ;; c-state-cache will be.
2973 (setq pair-beg (car-safe (cdr c-state-cache))
2974 c-state-cache (cdr-safe (cdr c-state-cache)))) ; remove {}pair + containing Lparen.
2975 ((numberp (car c-state-cache))
2976 (setq pair-beg (car c-state-cache)
2977 c-state-cache (cdr c-state-cache))) ; remove this
2979 ((numberp (cadr c-state-cache))
2980 (setq pair-beg (cadr c-state-cache)
2981 c-state-cache (cddr c-state-cache))) ; Remove a paren pair
2982 ; together with enclosed brace pair.
2983 ;; (t nil) ; Ignore an unmated Rparen.
2986 (if (< (point) pps-point)
2987 (setq pps-state (parse-partial-sexp (point) pps-point
2988 nil nil ; TARGETDEPTH, STOPBEFORE
2991 ;; If the last paren pair we moved out of was actually a brace pair,
2992 ;; insert it into `c-state-cache'.
2993 (when (and pair-beg (eq (char-after pair-beg) ?{))
2994 (if (consp (car-safe c-state-cache))
2995 (setq c-state-cache (cdr c-state-cache)))
2996 (setq c-state-cache (cons (cons pair-beg pos)
2999 (list pos scan-back-pos cons-separated pps-state)))))
3001 (defun c-remove-stale-state-cache-backwards (here)
3002 ;; Strip stale elements of `c-state-cache' by moving backwards through the
3003 ;; buffer, and inform the caller of the scenario detected.
3005 ;; HERE is the position we're setting `c-state-cache' for.
3006 ;; CACHE-POS (a locally bound variable) is just after the latest recorded
3007 ;; position in `c-state-cache' before HERE, or a position at or near
3008 ;; point-min which isn't in a literal.
3010 ;; This function must only be called only when (> `c-state-cache-good-pos'
3011 ;; HERE). Usually the gap between CACHE-POS and HERE is large. It is thus
3012 ;; optimized to eliminate (or minimize) scanning between these two
3015 ;; Return a three element list (GOOD-POS SCAN-BACK-POS FWD-FLAG), where:
3016 ;; o - GOOD-POS is a "good position", where `c-state-cache' is valid, or
3017 ;; could become so after missing elements are inserted into
3018 ;; `c-state-cache'. This is JUST AFTER an opening or closing
3019 ;; brace/paren/bracket which is already in `c-state-cache' or just before
3020 ;; one otherwise. exceptionally (when there's no such b/p/b handy) the BOL
3021 ;; before `here''s line, or the start of the literal containing it.
3022 ;; o - SCAN-BACK-POS, if non-nil, indicates there may be a brace pair
3023 ;; preceding POS which isn't recorded in `c-state-cache'. It is a position
3024 ;; to scan backwards from.
3025 ;; o - FWD-FLAG, if non-nil, indicates there may be parens/braces between
3026 ;; POS and HERE which aren't recorded in `c-state-cache'.
3028 ;; The comments in this defun use "paren" to mean parenthesis or square
3029 ;; bracket (as contrasted with a brace), and "(" and ")" likewise.
3031 ;; . {..} (..) (..) ( .. { } ) (...) ( .... . ..)
3033 ;; CP E here D C good
3034 (let ((cache-pos (c-get-cache-scan-pos here)) ; highest position below HERE in cache (or 1)
3035 (pos c-state-cache-good-pos)
3036 pa ren ; positions of "(" and ")"
3037 dropped-cons ; whether the last element dropped from `c-state-cache'
3038 ; was a cons (representing a brace-pair)
3039 good-pos ; see above.
3040 lit ; (START . END) of a literal containing some point.
3041 here-lit-start here-lit-end ; bounds of literal containing `here'
3043 here- here+ ; start/end of macro around HERE, or HERE
3044 (here-bol (c-point 'bol here))
3045 (too-far-back (max (- here c-state-cache-too-far) (point-min))))
3047 ;; Remove completely irrelevant entries from `c-state-cache'.
3048 (while (and c-state-cache
3049 (>= (setq pa (c-state-cache-top-lparen)) here))
3050 (setq dropped-cons (consp (car c-state-cache)))
3051 (setq c-state-cache (cdr c-state-cache))
3053 ;; At this stage, (> pos here);
3054 ;; (< (c-state-cache-top-lparen) here) (or is nil).
3057 ((and (consp (car c-state-cache))
3058 (> (cdar c-state-cache) here))
3059 ;; CASE 1: The top of the cache is a brace pair which now encloses
3060 ;; `here'. As good-pos, return the address. of the "{". Since we've no
3061 ;; knowledge of what's inside these braces, we have no alternative but
3062 ;; to direct the caller to scan the buffer from the opening brace.
3063 (setq pos (caar c-state-cache))
3064 (setcar c-state-cache pos)
3065 (list (1+ pos) pos t)) ; return value. We've just converted a brace pair
3066 ; entry into a { entry, so the caller needs to
3067 ; search for a brace pair before the {.
3069 ;; `here' might be inside a literal. Check for this.
3071 (setq lit (c-state-literal-at here)
3072 here-lit-start (or (car lit) here)
3073 here-lit-end (or (cdr lit) here))
3074 ;; Has `here' just "newly entered" a macro?
3076 (goto-char here-lit-start)
3077 (if (and (c-beginning-of-macro)
3078 (or (null c-state-old-cpp-beg)
3079 (not (= (point) c-state-old-cpp-beg))))
3081 (setq here- (point))
3083 (setq here+ (point)))
3084 (setq here- here-lit-start
3085 here+ here-lit-end)))
3087 ;; `here' might be nested inside any depth of parens (or brackets but
3088 ;; not braces). Scan backwards to find the outermost such opening
3089 ;; paren, if there is one. This will be the scan position to return.
3091 (narrow-to-region cache-pos (point-max))
3092 (setq pos (c-state-balance-parens-backwards here- here+ pos)))
3093 nil)) ; for the cond
3095 ((< pos here-lit-start)
3096 ;; CASE 2: Address of outermost ( or [ which now encloses `here', but
3097 ;; didn't enclose the (previous) `c-state-cache-good-pos'. If there is
3098 ;; a brace pair preceding this, it will already be in `c-state-cache',
3099 ;; unless there was a brace pair after it, i.e. there'll only be one to
3100 ;; scan for if we've just deleted one.
3101 (list pos (and dropped-cons pos) t)) ; Return value.
3103 ;; `here' isn't enclosed in a (previously unrecorded) bracket/paren.
3104 ;; Further forward scanning isn't needed, but we still need to find a
3105 ;; GOOD-POS. Step out of all enclosing "("s on HERE's line.
3108 (narrow-to-region here-bol (point-max))
3109 (setq pos here-lit-start)
3110 (c-safe (while (setq pa (scan-lists pos -1 1))
3111 (setq pos pa)))) ; might signal
3112 nil)) ; for the cond
3114 ((setq ren (c-safe-scan-lists pos -1 -1 too-far-back))
3115 ;; CASE 3: After a }/)/] before `here''s BOL.
3116 (list (1+ ren) (and dropped-cons pos) nil)) ; Return value
3119 ;; CASE 4; Best of a bad job: BOL before `here-bol', or beginning of
3120 ;; literal containing it.
3121 (setq good-pos (c-state-lit-beg (c-point 'bopl here-bol)))
3122 (list good-pos (and dropped-cons good-pos) nil)))))
3125 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3126 ;; Externally visible routines.
3128 (defun c-state-cache-init ()
3129 (setq c-state-cache nil
3130 c-state-cache-good-pos 1
3131 c-state-nonlit-pos-cache nil
3132 c-state-nonlit-pos-cache-limit 1
3133 c-state-semi-nonlit-pos-cache nil
3134 c-state-semi-nonlit-pos-cache-limit 1
3135 c-state-brace-pair-desert nil
3137 c-state-point-min-lit-type nil
3138 c-state-point-min-lit-start nil
3139 c-state-min-scan-pos 1
3140 c-state-old-cpp-beg nil
3141 c-state-old-cpp-end nil)
3142 (c-state-mark-point-min-literal))
3144 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3145 ;; Debugging routines to dump `c-state-cache' in a "replayable" form.
3146 ;; (defmacro c-sc-de (elt) ; "c-state-cache-dump-element"
3147 ;; `(format ,(concat "(setq " (symbol-name elt) " %s) ") ,elt))
3148 ;; (defmacro c-sc-qde (elt) ; "c-state-cache-quote-dump-element"
3149 ;; `(format ,(concat "(setq " (symbol-name elt) " '%s) ") ,elt))
3150 ;; (defun c-state-dump ()
3151 ;; ;; For debugging.
3154 ;; (c-sc-qde c-state-cache)
3155 ;; (c-sc-de c-state-cache-good-pos)
3156 ;; (c-sc-qde c-state-nonlit-pos-cache)
3157 ;; (c-sc-de c-state-nonlit-pos-cache-limit)
3158 ;; (c-sc-qde c-state-brace-pair-desert)
3159 ;; (c-sc-de c-state-point-min)
3160 ;; (c-sc-de c-state-point-min-lit-type)
3161 ;; (c-sc-de c-state-point-min-lit-start)
3162 ;; (c-sc-de c-state-min-scan-pos)
3163 ;; (c-sc-de c-state-old-cpp-beg)
3164 ;; (c-sc-de c-state-old-cpp-end)))
3165 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3167 (defun c-invalidate-state-cache-1 (here)
3168 ;; Invalidate all info on `c-state-cache' that applies to the buffer at HERE
3169 ;; or higher and set `c-state-cache-good-pos' accordingly. The cache is
3170 ;; left in a consistent state.
3172 ;; This is much like `c-whack-state-after', but it never changes a paren
3173 ;; pair element into an open paren element. Doing that would mean that the
3174 ;; new open paren wouldn't have the required preceding paren pair element.
3176 ;; This function is called from c-after-change.
3178 ;; The caches of non-literals:
3179 ;; Note that we use "<=" for the possibility of the second char of a two-char
3180 ;; comment opener being typed; this would invalidate any cache position at
3182 (if (<= here c-state-nonlit-pos-cache-limit)
3183 (setq c-state-nonlit-pos-cache-limit (1- here)))
3184 (if (<= here c-state-semi-nonlit-pos-cache-limit)
3185 (setq c-state-semi-nonlit-pos-cache-limit (1- here)))
3188 ;; Case 1: if `here' is in a literal containing point-min, everything
3189 ;; becomes (or is already) nil.
3190 (if (or (null c-state-cache-good-pos)
3191 (< here (c-state-get-min-scan-pos)))
3192 (setq c-state-cache nil
3193 c-state-cache-good-pos nil
3194 c-state-min-scan-pos nil)
3196 ;; Truncate `c-state-cache' and set `c-state-cache-good-pos' to a value
3197 ;; below `here'. To maintain its consistency, we may need to insert a new
3199 (let (open-paren-in-column-0-is-defun-start
3200 (here-bol (c-point 'bol here))
3201 too-high-pa ; recorded {/(/[ next above here, or nil.
3202 dropped-cons ; was the last removed element a brace pair?
3204 ;; The easy bit - knock over-the-top bits off `c-state-cache'.
3205 (while (and c-state-cache
3206 (>= (setq pa (c-state-cache-top-paren)) here))
3207 (setq dropped-cons (consp (car c-state-cache))
3208 too-high-pa (c-state-cache-top-lparen)
3209 c-state-cache (cdr c-state-cache)))
3211 ;; Do we need to add in an earlier brace pair, having lopped one off?
3212 (if (and dropped-cons
3213 (< too-high-pa (+ here c-state-cache-too-far)))
3214 (c-append-lower-brace-pair-to-state-cache too-high-pa here here-bol))
3215 (setq c-state-cache-good-pos (or (c-state-cache-after-top-paren)
3216 (c-state-get-min-scan-pos)))))
3218 ;; The brace-pair desert marker:
3219 (when (car c-state-brace-pair-desert)
3220 (if (< here (car c-state-brace-pair-desert))
3221 (setq c-state-brace-pair-desert nil)
3222 (if (< here (cdr c-state-brace-pair-desert))
3223 (setcdr c-state-brace-pair-desert here)))))
3225 (defun c-parse-state-1 ()
3226 ;; Find and record all noteworthy parens between some good point earlier in
3227 ;; the file and point. That good point is at least the beginning of the
3228 ;; top-level construct we are in, or the beginning of the preceding
3229 ;; top-level construct if we aren't in one.
3231 ;; The returned value is a list of the noteworthy parens with the last one
3232 ;; first. If an element in the list is an integer, it's the position of an
3233 ;; open paren (of any type) which has not been closed before the point. If
3234 ;; an element is a cons, it gives the position of a closed BRACE paren
3235 ;; pair[*]; the car is the start brace position and the cdr is the position
3236 ;; following the closing brace. Only the last closed brace paren pair
3237 ;; before each open paren and before the point is recorded, and thus the
3238 ;; state never contains two cons elements in succession. When a close brace
3239 ;; has no matching open brace (e.g., the matching brace is outside the
3240 ;; visible region), it is not represented in the returned value.
3242 ;; [*] N.B. The close "brace" might be a mismatching close bracket or paren.
3243 ;; This defun explicitly treats mismatching parens/braces/brackets as
3244 ;; matching. It is the open brace which makes it a "brace" pair.
3246 ;; If POINT is within a macro, open parens and brace pairs within
3247 ;; THIS macro MIGHT be recorded. This depends on whether their
3248 ;; syntactic properties have been suppressed by
3249 ;; `c-neutralize-syntax-in-CPP'. This might need fixing (2008-12-11).
3251 ;; Currently no characters which are given paren syntax with the
3252 ;; syntax-table property are recorded, i.e. angle bracket arglist
3253 ;; parens are never present here. Note that this might change.
3255 ;; BUG: This function doesn't cope entirely well with unbalanced
3256 ;; parens in macros. (2008-12-11: this has probably been resolved
3257 ;; by the function `c-neutralize-syntax-in-CPP'.) E.g. in the
3258 ;; following case the brace before the macro isn't balanced with the
3265 ;; Note to maintainers: this function DOES get called with point
3266 ;; within comments and strings, so don't assume it doesn't!
3268 ;; This function might do hidden buffer changes.
3269 (let* ((here (point))
3270 (here-bopl (c-point 'bopl))
3271 open-paren-in-column-0-is-defun-start
3272 strategy ; 'forward, 'backward etc..
3273 ;; Candidate positions to start scanning from:
3274 cache-pos ; highest position below HERE already existing in
3277 start-point ; (when scanning forward) a place below HERE where there
3278 ; are no open parens/braces between it and HERE.
3282 scan-backward-pos scan-forward-p) ; used for 'backward.
3283 ;; If POINT-MIN has changed, adjust the cache
3284 (unless (= (point-min) c-state-point-min)
3285 (c-renarrow-state-cache))
3288 (setq res (c-parse-state-get-strategy here c-state-cache-good-pos)
3290 start-point (cadr res))
3294 ((memq strategy '(forward back-and-forward))
3295 (setq res (c-remove-stale-state-cache start-point here here-bopl))
3296 (setq cache-pos (car res)
3297 scan-backward-pos (cadr res)
3298 cons-separated (car (cddr res))
3299 bopl-state (cadr (cddr res))) ; will be nil if (< here-bopl
3301 (if (and scan-backward-pos
3302 (or cons-separated (eq strategy 'forward))) ;scan-backward-pos
3303 (c-append-lower-brace-pair-to-state-cache scan-backward-pos here))
3305 (c-append-to-state-cache cache-pos here))
3306 (setq c-state-cache-good-pos
3308 (< good-pos (- here c-state-cache-too-far)))
3309 (c-state-cache-non-literal-place here-bopl bopl-state)
3312 ((eq strategy 'backward)
3313 (setq res (c-remove-stale-state-cache-backwards here)
3315 scan-backward-pos (cadr res)
3316 scan-forward-p (car (cddr res)))
3317 (if scan-backward-pos
3318 (c-append-lower-brace-pair-to-state-cache scan-backward-pos here))
3319 (setq c-state-cache-good-pos
3321 (c-append-to-state-cache good-pos here)
3324 (t ; (eq strategy 'IN-LIT)
3325 (setq c-state-cache nil
3326 c-state-cache-good-pos nil))))
3330 (defun c-invalidate-state-cache (here)
3331 ;; This is a wrapper over `c-invalidate-state-cache-1'.
3333 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3334 ;; of all parens in preprocessor constructs, except for any such construct
3335 ;; containing point. We can then call `c-invalidate-state-cache-1' without
3336 ;; worrying further about macros and template delimiters.
3337 (c-with-<->-as-parens-suppressed
3338 (if (and c-state-old-cpp-beg
3339 (< c-state-old-cpp-beg here))
3340 (c-with-all-but-one-cpps-commented-out
3342 (min c-state-old-cpp-end here)
3343 (c-invalidate-state-cache-1 here))
3344 (c-with-cpps-commented-out
3345 (c-invalidate-state-cache-1 here)))))
3347 (defmacro c-state-maybe-marker (place marker)
3348 ;; If PLACE is non-nil, return a marker marking it, otherwise nil.
3349 ;; We (re)use MARKER.
3351 (or ,marker (setq ,marker (make-marker)))
3352 (set-marker ,marker ,place)))
3354 (defun c-parse-state ()
3355 ;; This is a wrapper over `c-parse-state-1'. See that function for a
3356 ;; description of the functionality and return value.
3358 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3359 ;; of all parens in preprocessor constructs, except for any such construct
3360 ;; containing point. We can then call `c-parse-state-1' without worrying
3361 ;; further about macros and template delimiters.
3362 (let (here-cpp-beg here-cpp-end)
3364 (when (c-beginning-of-macro)
3365 (setq here-cpp-beg (point))
3367 (> (setq here-cpp-end (c-syntactic-end-of-macro))
3369 (setq here-cpp-beg nil here-cpp-end nil))))
3370 ;; FIXME!!! Put in a `condition-case' here to protect the integrity of the
3373 (c-with-<->-as-parens-suppressed
3374 (if (and here-cpp-beg (> here-cpp-end here-cpp-beg))
3375 (c-with-all-but-one-cpps-commented-out
3376 here-cpp-beg here-cpp-end
3378 (c-with-cpps-commented-out
3379 (c-parse-state-1))))
3380 (setq c-state-old-cpp-beg
3381 (c-state-maybe-marker here-cpp-beg c-state-old-cpp-beg-marker)
3383 (c-state-maybe-marker here-cpp-end c-state-old-cpp-end-marker)))))
3385 ;; Debug tool to catch cache inconsistencies. This is called from
3387 (defvar c-debug-parse-state nil)
3388 (unless (fboundp 'c-real-parse-state)
3389 (fset 'c-real-parse-state (symbol-function 'c-parse-state)))
3390 (cc-bytecomp-defun c-real-parse-state)
3392 (defvar c-parse-state-point nil)
3393 (defvar c-parse-state-state nil)
3394 (make-variable-buffer-local 'c-parse-state-state)
3395 (defun c-record-parse-state-state ()
3396 (setq c-parse-state-point (point))
3397 (setq c-parse-state-state
3400 (let ((val (symbol-value arg)))
3406 c-state-cache-good-pos
3407 c-state-nonlit-pos-cache
3408 c-state-nonlit-pos-cache-limit
3409 c-state-semi-nonlit-pos-cache
3410 c-state-semi-nonlit-pos-cache-limit
3411 c-state-brace-pair-desert
3413 c-state-point-min-lit-type
3414 c-state-point-min-lit-start
3415 c-state-min-scan-pos
3418 c-parse-state-point))))
3419 (defun c-replay-parse-state-state ()
3424 (format "%s %s%s" (car arg) (if (atom (cdr arg)) "" "'") (cdr arg)))
3425 c-parse-state-state " ")
3428 (defun c-debug-parse-state-double-cons (state)
3429 (let (state-car conses-not-ok)
3431 (setq state-car (car state)
3433 (if (and (consp state-car)
3434 (consp (car state)))
3435 (setq conses-not-ok t)))
3438 (defun c-debug-parse-state ()
3439 (let ((here (point)) (res1 (c-real-parse-state)) res2)
3440 (let ((c-state-cache nil)
3441 (c-state-cache-good-pos 1)
3442 (c-state-nonlit-pos-cache nil)
3443 (c-state-nonlit-pos-cache-limit 1)
3444 (c-state-brace-pair-desert nil)
3445 (c-state-point-min 1)
3446 (c-state-point-min-lit-type nil)
3447 (c-state-point-min-lit-start nil)
3448 (c-state-min-scan-pos 1)
3449 (c-state-old-cpp-beg nil)
3450 (c-state-old-cpp-end nil))
3451 (setq res2 (c-real-parse-state)))
3452 (unless (equal res1 res2)
3453 ;; The cache can actually go further back due to the ad-hoc way
3454 ;; the first paren is found, so try to whack off a bit of its
3455 ;; start before complaining.
3457 ;; (goto-char (or (c-least-enclosing-brace res2) (point)))
3458 ;; (c-beginning-of-defun-1)
3459 ;; (while (not (or (bobp) (eq (char-after) ?{)))
3460 ;; (c-beginning-of-defun-1))
3461 ;; (unless (equal (c-whack-state-before (point) res1) res2)
3462 ;; (message (concat "c-parse-state inconsistency at %s: "
3463 ;; "using cache: %s, from scratch: %s")
3464 ;; here res1 res2)))
3465 (message (concat "c-parse-state inconsistency at %s: "
3466 "using cache: %s, from scratch: %s")
3468 (message "Old state:")
3469 (c-replay-parse-state-state))
3471 (when (c-debug-parse-state-double-cons res1)
3472 (message "c-parse-state INVALIDITY at %s: %s"
3474 (message "Old state:")
3475 (c-replay-parse-state-state))
3477 (c-record-parse-state-state)
3478 res2 ; res1 correct a cascading series of errors ASAP
3481 (defun c-toggle-parse-state-debug (&optional arg)
3483 (setq c-debug-parse-state (c-calculate-state arg c-debug-parse-state))
3484 (fset 'c-parse-state (symbol-function (if c-debug-parse-state
3485 'c-debug-parse-state
3486 'c-real-parse-state)))
3487 (c-keep-region-active)
3488 (message "c-debug-parse-state %sabled"
3489 (if c-debug-parse-state "en" "dis")))
3490 (when c-debug-parse-state
3491 (c-toggle-parse-state-debug 1))
3494 (defun c-whack-state-before (bufpos paren-state)
3495 ;; Whack off any state information from PAREN-STATE which lies
3496 ;; before BUFPOS. Not destructive on PAREN-STATE.
3497 (let* ((newstate (list nil))
3501 (setq car (car paren-state)
3502 paren-state (cdr paren-state))
3503 (if (< (if (consp car) (car car) car) bufpos)
3504 (setq paren-state nil)
3505 (setcdr ptr (list car))
3506 (setq ptr (cdr ptr))))
3509 (defun c-whack-state-after (bufpos paren-state)
3510 ;; Whack off any state information from PAREN-STATE which lies at or
3511 ;; after BUFPOS. Not destructive on PAREN-STATE.
3514 (let ((car (car paren-state)))
3516 ;; just check the car, because in a balanced brace
3517 ;; expression, it must be impossible for the corresponding
3518 ;; close brace to be before point, but the open brace to
3520 (if (<= bufpos (car car))
3522 (if (< bufpos (cdr car))
3523 ;; its possible that the open brace is before
3524 ;; bufpos, but the close brace is after. In that
3525 ;; case, convert this to a non-cons element. The
3526 ;; rest of the state is before bufpos, so we're
3528 (throw 'done (cons (car car) (cdr paren-state)))
3529 ;; we know that both the open and close braces are
3530 ;; before bufpos, so we also know that everything else
3531 ;; on state is before bufpos.
3532 (throw 'done paren-state)))
3535 ;; it's before bufpos, so everything else should too.
3536 (throw 'done paren-state)))
3537 (setq paren-state (cdr paren-state)))
3540 (defun c-most-enclosing-brace (paren-state &optional bufpos)
3541 ;; Return the bufpos of the innermost enclosing open paren before
3542 ;; bufpos, or nil if none was found.
3544 (or bufpos (setq bufpos 134217727))
3546 (setq enclosingp (car paren-state)
3547 paren-state (cdr paren-state))
3548 (if (or (consp enclosingp)
3549 (>= enclosingp bufpos))
3550 (setq enclosingp nil)
3551 (setq paren-state nil)))
3554 (defun c-least-enclosing-brace (paren-state)
3555 ;; Return the bufpos of the outermost enclosing open paren, or nil
3556 ;; if none was found.
3559 (setq elem (car paren-state)
3560 paren-state (cdr paren-state))
3565 (defun c-safe-position (bufpos paren-state)
3566 ;; Return the closest "safe" position recorded on PAREN-STATE that
3567 ;; is higher up than BUFPOS. Return nil if PAREN-STATE doesn't
3568 ;; contain any. Return nil if BUFPOS is nil, which is useful to
3569 ;; find the closest limit before a given limit that might be nil.
3571 ;; A "safe" position is a position at or after a recorded open
3572 ;; paren, or after a recorded close paren. The returned position is
3573 ;; thus either the first position after a close brace, or the first
3574 ;; position after an enclosing paren, or at the enclosing paren in
3575 ;; case BUFPOS is immediately after it.
3580 (setq elem (car paren-state))
3582 (cond ((< (cdr elem) bufpos)
3583 (throw 'done (cdr elem)))
3584 ((< (car elem) bufpos)
3586 (throw 'done (min (1+ (car elem)) bufpos))))
3588 ;; elem is the position at and not after the opening paren, so
3589 ;; we can go forward one more step unless it's equal to
3590 ;; bufpos. This is useful in some cases avoid an extra paren
3591 ;; level between the safe position and bufpos.
3592 (throw 'done (min (1+ elem) bufpos))))
3593 (setq paren-state (cdr paren-state)))))))
3595 (defun c-beginning-of-syntax ()
3596 ;; This is used for `font-lock-beginning-of-syntax-function'. It
3597 ;; goes to the closest previous point that is known to be outside
3598 ;; any string literal or comment. `c-state-cache' is used if it has
3599 ;; a position in the vicinity.
3600 (let* ((paren-state c-state-cache)
3604 ;; Note: Similar code in `c-safe-position'. The
3605 ;; difference is that we accept a safe position at
3606 ;; the point and don't bother to go forward past open
3609 (setq elem (car paren-state))
3611 (cond ((<= (cdr elem) (point))
3612 (throw 'done (cdr elem)))
3613 ((<= (car elem) (point))
3614 (throw 'done (car elem))))
3615 (if (<= elem (point))
3616 (throw 'done elem)))
3617 (setq paren-state (cdr paren-state)))
3620 (if (> pos (- (point) 4000))
3622 ;; The position is far back. Try `c-beginning-of-defun-1'
3623 ;; (although we can't be entirely sure it will go to a position
3624 ;; outside a comment or string in current emacsen). FIXME:
3625 ;; Consult `syntax-ppss' here.
3626 (c-beginning-of-defun-1)
3631 ;; Tools for scanning identifiers and other tokens.
3633 (defun c-on-identifier ()
3634 "Return non-nil if the point is on or directly after an identifier.
3635 Keywords are recognized and not considered identifiers. If an
3636 identifier is detected, the returned value is its starting position.
3637 If an identifier ends at the point and another begins at it \(can only
3638 happen in Pike) then the point for the preceding one is returned.
3640 Note that this function might do hidden buffer changes. See the
3641 comment at the start of cc-engine.el for more info."
3643 ;; FIXME: Shouldn't this function handle "operator" in C++?
3646 (skip-syntax-backward "w_")
3650 ;; Check for a normal (non-keyword) identifier.
3651 (and (looking-at c-symbol-start)
3652 (not (looking-at c-keywords-regexp))
3655 (when (c-major-mode-is 'pike-mode)
3656 ;; Handle the `<operator> syntax in Pike.
3657 (let ((pos (point)))
3658 (skip-chars-backward "-!%&*+/<=>^|~[]()")
3659 (and (if (< (skip-chars-backward "`") 0)
3662 (eq (char-after) ?\`))
3663 (looking-at c-symbol-key)
3664 (>= (match-end 0) pos)
3667 ;; Handle the "operator +" syntax in C++.
3668 (when (and c-overloadable-operators-regexp
3669 (= (c-backward-token-2 0) 0))
3671 (cond ((and (looking-at c-overloadable-operators-regexp)
3672 (or (not c-opt-op-identifier-prefix)
3673 (and (= (c-backward-token-2 1) 0)
3674 (looking-at c-opt-op-identifier-prefix))))
3678 (and c-opt-op-identifier-prefix
3679 (looking-at c-opt-op-identifier-prefix)
3680 (= (c-forward-token-2 1) 0)
3681 (looking-at c-overloadable-operators-regexp)))
3686 (defsubst c-simple-skip-symbol-backward ()
3687 ;; If the point is at the end of a symbol then skip backward to the
3688 ;; beginning of it. Don't move otherwise. Return non-nil if point
3691 ;; This function might do hidden buffer changes.
3692 (or (< (skip-syntax-backward "w_") 0)
3693 (and (c-major-mode-is 'pike-mode)
3694 ;; Handle the `<operator> syntax in Pike.
3695 (let ((pos (point)))
3696 (if (and (< (skip-chars-backward "-!%&*+/<=>^|~[]()") 0)
3697 (< (skip-chars-backward "`") 0)
3698 (looking-at c-symbol-key)
3699 (>= (match-end 0) pos))
3704 (defun c-beginning-of-current-token (&optional back-limit)
3705 ;; Move to the beginning of the current token. Do not move if not
3706 ;; in the middle of one. BACK-LIMIT may be used to bound the
3707 ;; backward search; if given it's assumed to be at the boundary
3708 ;; between two tokens. Return non-nil if the point is moved, nil
3711 ;; This function might do hidden buffer changes.
3712 (let ((start (point)))
3713 (if (looking-at "\\w\\|\\s_")
3714 (skip-syntax-backward "w_" back-limit)
3715 (when (< (skip-syntax-backward ".()" back-limit) 0)
3716 (while (let ((pos (or (and (looking-at c-nonsymbol-token-regexp)
3718 ;; `c-nonsymbol-token-regexp' should always match
3719 ;; since we've skipped backward over punctuation
3720 ;; or paren syntax, but consume one char in case
3721 ;; it doesn't so that we don't leave point before
3722 ;; some earlier incorrect token.
3725 (goto-char pos))))))
3728 (defun c-end-of-current-token (&optional back-limit)
3729 ;; Move to the end of the current token. Do not move if not in the
3730 ;; middle of one. BACK-LIMIT may be used to bound the backward
3731 ;; search; if given it's assumed to be at the boundary between two
3732 ;; tokens. Return non-nil if the point is moved, nil otherwise.
3734 ;; This function might do hidden buffer changes.
3735 (let ((start (point)))
3736 (cond ((< (skip-syntax-backward "w_" (1- start)) 0)
3737 (skip-syntax-forward "w_"))
3738 ((< (skip-syntax-backward ".()" back-limit) 0)
3740 (if (looking-at c-nonsymbol-token-regexp)
3741 (goto-char (match-end 0))
3742 ;; `c-nonsymbol-token-regexp' should always match since
3743 ;; we've skipped backward over punctuation or paren
3744 ;; syntax, but move forward in case it doesn't so that
3745 ;; we don't leave point earlier than we started with.
3747 (< (point) start)))))
3750 (defconst c-jump-syntax-balanced
3751 (if (memq 'gen-string-delim c-emacs-features)
3752 "\\w\\|\\s_\\|\\s\(\\|\\s\)\\|\\s\"\\|\\s|"
3753 "\\w\\|\\s_\\|\\s\(\\|\\s\)\\|\\s\""))
3755 (defconst c-jump-syntax-unbalanced
3756 (if (memq 'gen-string-delim c-emacs-features)
3757 "\\w\\|\\s_\\|\\s\"\\|\\s|"
3758 "\\w\\|\\s_\\|\\s\""))
3760 (defun c-forward-token-2 (&optional count balanced limit)
3761 "Move forward by tokens.
3762 A token is defined as all symbols and identifiers which aren't
3763 syntactic whitespace \(note that multicharacter tokens like \"==\" are
3764 treated properly). Point is always either left at the beginning of a
3765 token or not moved at all. COUNT specifies the number of tokens to
3766 move; a negative COUNT moves in the opposite direction. A COUNT of 0
3767 moves to the next token beginning only if not already at one. If
3768 BALANCED is true, move over balanced parens, otherwise move into them.
3769 Also, if BALANCED is true, never move out of an enclosing paren.
3771 LIMIT sets the limit for the movement and defaults to the point limit.
3772 The case when LIMIT is set in the middle of a token, comment or macro
3773 is handled correctly, i.e. the point won't be left there.
3775 Return the number of tokens left to move \(positive or negative). If
3776 BALANCED is true, a move over a balanced paren counts as one. Note
3777 that if COUNT is 0 and no appropriate token beginning is found, 1 will
3778 be returned. Thus, a return value of 0 guarantees that point is at
3779 the requested position and a return value less \(without signs) than
3780 COUNT guarantees that point is at the beginning of some token.
3782 Note that this function might do hidden buffer changes. See the
3783 comment at the start of cc-engine.el for more info."
3785 (or count (setq count 1))
3787 (- (c-backward-token-2 (- count) balanced limit))
3789 (let ((jump-syntax (if balanced
3790 c-jump-syntax-balanced
3791 c-jump-syntax-unbalanced))
3796 ;; If count is zero we should jump if in the middle of a token.
3797 (c-end-of-current-token))
3800 (if limit (narrow-to-region (point-min) limit))
3802 (progn (c-forward-syntactic-ws) (point)))
3803 ;; Skip whitespace. Count this as a move if we did in
3805 (setq count (max (1- count) 0)))
3808 ;; Moved out of bounds. Make sure the returned count isn't zero.
3810 (if (zerop count) (setq count 1))
3813 ;; Use `condition-case' to avoid having the limit tests
3820 (cond ((looking-at jump-syntax)
3821 (goto-char (scan-sexps (point) 1))
3823 ((looking-at c-nonsymbol-token-regexp)
3824 (goto-char (match-end 0))
3826 ;; `c-nonsymbol-token-regexp' above should always
3827 ;; match if there are correct tokens. Try to
3828 ;; widen to see if the limit was set in the
3829 ;; middle of one, else fall back to treating
3830 ;; the offending thing as a one character token.
3834 (looking-at c-nonsymbol-token-regexp)))
3839 (c-forward-syntactic-ws)
3842 (error (goto-char last)))
3846 (setq count (1+ count)))))
3850 (defun c-backward-token-2 (&optional count balanced limit)
3851 "Move backward by tokens.
3852 See `c-forward-token-2' for details."
3854 (or count (setq count 1))
3856 (- (c-forward-token-2 (- count) balanced limit))
3858 (or limit (setq limit (point-min)))
3859 (let ((jump-syntax (if balanced
3860 c-jump-syntax-balanced
3861 c-jump-syntax-unbalanced))
3865 ;; The count is zero so try to skip to the beginning of the
3868 (progn (c-beginning-of-current-token) (point)))
3869 (if (< (point) limit)
3870 ;; The limit is inside the same token, so return 1.
3873 ;; We're not in the middle of a token. If there's
3874 ;; whitespace after the point then we must move backward,
3875 ;; so set count to 1 in that case.
3876 (and (looking-at c-syntactic-ws-start)
3877 ;; If we're looking at a '#' that might start a cpp
3878 ;; directive then we have to do a more elaborate check.
3879 (or (/= (char-after) ?#)
3880 (not c-opt-cpp-prefix)
3883 (progn (beginning-of-line)
3884 (looking-at "[ \t]*")
3887 (progn (backward-char)
3888 (not (eq (char-before) ?\\)))))))
3891 ;; Use `condition-case' to avoid having to check for buffer
3892 ;; limits in `backward-char', `scan-sexps' and `goto-char' below.
3897 (c-backward-syntactic-ws)
3899 (if (looking-at jump-syntax)
3900 (goto-char (scan-sexps (1+ (point)) -1))
3901 ;; This can be very inefficient if there's a long
3902 ;; sequence of operator tokens without any separation.
3903 ;; That doesn't happen in practice, anyway.
3904 (c-beginning-of-current-token))
3905 (>= (point) limit)))
3908 (error (goto-char last)))
3910 (if (< (point) limit)
3915 (defun c-forward-token-1 (&optional count balanced limit)
3916 "Like `c-forward-token-2' but doesn't treat multicharacter operator
3917 tokens like \"==\" as single tokens, i.e. all sequences of symbol
3918 characters are jumped over character by character. This function is
3919 for compatibility only; it's only a wrapper over `c-forward-token-2'."
3920 (let ((c-nonsymbol-token-regexp "\\s.\\|\\s\(\\|\\s\)"))
3921 (c-forward-token-2 count balanced limit)))
3923 (defun c-backward-token-1 (&optional count balanced limit)
3924 "Like `c-backward-token-2' but doesn't treat multicharacter operator
3925 tokens like \"==\" as single tokens, i.e. all sequences of symbol
3926 characters are jumped over character by character. This function is
3927 for compatibility only; it's only a wrapper over `c-backward-token-2'."
3928 (let ((c-nonsymbol-token-regexp "\\s.\\|\\s\(\\|\\s\)"))
3929 (c-backward-token-2 count balanced limit)))
3932 ;; Tools for doing searches restricted to syntactically relevant text.
3934 (defun c-syntactic-re-search-forward (regexp &optional bound noerror
3935 paren-level not-inside-token
3936 lookbehind-submatch)
3937 "Like `re-search-forward', but only report matches that are found
3938 in syntactically significant text. I.e. matches in comments, macros
3939 or string literals are ignored. The start point is assumed to be
3940 outside any comment, macro or string literal, or else the content of
3941 that region is taken as syntactically significant text.
3943 If PAREN-LEVEL is non-nil, an additional restriction is added to
3944 ignore matches in nested paren sexps. The search will also not go
3945 outside the current list sexp, which has the effect that if the point
3946 should be moved to BOUND when no match is found \(i.e. NOERROR is
3947 neither nil nor t), then it will be at the closing paren if the end of
3948 the current list sexp is encountered first.
3950 If NOT-INSIDE-TOKEN is non-nil, matches in the middle of tokens are
3951 ignored. Things like multicharacter operators and special symbols
3952 \(e.g. \"`()\" in Pike) are handled but currently not floating point
3955 If LOOKBEHIND-SUBMATCH is non-nil, it's taken as a number of a
3956 subexpression in REGEXP. The end of that submatch is used as the
3957 position to check for syntactic significance. If LOOKBEHIND-SUBMATCH
3958 isn't used or if that subexpression didn't match then the start
3959 position of the whole match is used instead. The \"look behind\"
3960 subexpression is never tested before the starting position, so it
3961 might be a good idea to include \\=\\= as a match alternative in it.
3963 Optimization note: Matches might be missed if the \"look behind\"
3964 subexpression can match the end of nonwhite syntactic whitespace,
3965 i.e. the end of comments or cpp directives. This since the function
3966 skips over such things before resuming the search. It's on the other
3967 hand not safe to assume that the \"look behind\" subexpression never
3968 matches syntactic whitespace.
3970 Bug: Unbalanced parens inside cpp directives are currently not handled
3971 correctly \(i.e. they don't get ignored as they should) when
3974 Note that this function might do hidden buffer changes. See the
3975 comment at the start of cc-engine.el for more info."
3977 (or bound (setq bound (point-max)))
3978 (if paren-level (setq paren-level -1))
3980 ;;(message "c-syntactic-re-search-forward %s %s %S" (point) bound regexp)
3982 (let ((start (point))
3984 ;; Start position for the last search.
3986 ;; The `parse-partial-sexp' state between the start position
3989 ;; The current position after the last state update. The next
3990 ;; `parse-partial-sexp' continues from here.
3992 ;; The position at which to check the state and the state
3993 ;; there. This is separate from `state-pos' since we might
3994 ;; need to back up before doing the next search round.
3995 check-pos check-state
3996 ;; Last position known to end a token.
3997 (last-token-end-pos (point-min))
3998 ;; Set when a valid match is found.
4005 (setq search-pos (point))
4006 (re-search-forward regexp bound noerror))
4009 (setq state (parse-partial-sexp
4010 state-pos (match-beginning 0) paren-level nil state)
4012 (if (setq check-pos (and lookbehind-submatch
4013 (or (not paren-level)
4015 (match-end lookbehind-submatch)))
4016 (setq check-state (parse-partial-sexp
4017 state-pos check-pos paren-level nil state))
4018 (setq check-pos state-pos
4021 ;; NOTE: If we got a look behind subexpression and get
4022 ;; an insignificant match in something that isn't
4023 ;; syntactic whitespace (i.e. strings or in nested
4024 ;; parentheses), then we can never skip more than a
4025 ;; single character from the match start position
4026 ;; (i.e. `state-pos' here) before continuing the
4027 ;; search. That since the look behind subexpression
4028 ;; might match the end of the insignificant region in
4032 ((elt check-state 7)
4033 ;; Match inside a line comment. Skip to eol. Use
4034 ;; `re-search-forward' instead of `skip-chars-forward' to get
4035 ;; the right bound behavior.
4036 (re-search-forward "[\n\r]" bound noerror))
4038 ((elt check-state 4)
4039 ;; Match inside a block comment. Skip to the '*/'.
4040 (search-forward "*/" bound noerror))
4042 ((and (not (elt check-state 5))
4043 (eq (char-before check-pos) ?/)
4044 (not (c-get-char-property (1- check-pos) 'syntax-table))
4045 (memq (char-after check-pos) '(?/ ?*)))
4046 ;; Match in the middle of the opener of a block or line
4048 (if (= (char-after check-pos) ?/)
4049 (re-search-forward "[\n\r]" bound noerror)
4050 (search-forward "*/" bound noerror)))
4052 ;; The last `parse-partial-sexp' above might have
4053 ;; stopped short of the real check position if the end
4054 ;; of the current sexp was encountered in paren-level
4055 ;; mode. The checks above are always false in that
4056 ;; case, and since they can do better skipping in
4057 ;; lookbehind-submatch mode, we do them before
4058 ;; checking the paren level.
4061 (/= (setq tmp (car check-state)) 0))
4062 ;; Check the paren level first since we're short of the
4063 ;; syntactic checking position if the end of the
4064 ;; current sexp was encountered by `parse-partial-sexp'.
4067 ;; Inside a nested paren sexp.
4068 (if lookbehind-submatch
4069 ;; See the NOTE above.
4070 (progn (goto-char state-pos) t)
4071 ;; Skip out of the paren quickly.
4072 (setq state (parse-partial-sexp state-pos bound 0 nil state)
4075 ;; Have exited the current paren sexp.
4078 ;; The last `parse-partial-sexp' call above
4079 ;; has left us just after the closing paren
4080 ;; in this case, so we can modify the bound
4081 ;; to leave the point at the right position
4083 (setq bound (1- (point)))
4085 (signal 'search-failed (list regexp)))))
4087 ((setq tmp (elt check-state 3))
4088 ;; Match inside a string.
4089 (if (or lookbehind-submatch
4090 (not (integerp tmp)))
4091 ;; See the NOTE above.
4092 (progn (goto-char state-pos) t)
4093 ;; Skip to the end of the string before continuing.
4094 (let ((ender (make-string 1 tmp)) (continue t))
4095 (while (if (search-forward ender bound noerror)
4097 (setq state (parse-partial-sexp
4098 state-pos (point) nil nil state)
4101 (setq continue nil)))
4106 (c-beginning-of-macro start)))
4107 ;; Match inside a macro. Skip to the end of it.
4109 (cond ((<= (point) bound) t)
4111 (t (signal 'search-failed (list regexp)))))
4113 ((and not-inside-token
4114 (or (< check-pos last-token-end-pos)
4117 (goto-char check-pos)
4119 (c-end-of-current-token last-token-end-pos))
4120 (setq last-token-end-pos (point))))))
4122 (if lookbehind-submatch
4123 ;; See the NOTE above.
4124 (goto-char state-pos)
4125 (goto-char (min last-token-end-pos bound))))
4132 ;; Should loop to search again, but take care to avoid
4133 ;; looping on the same spot.
4134 (or (/= search-pos (point))
4135 (if (= (point) bound)
4138 (signal 'search-failed (list regexp)))
4144 (signal (car err) (cdr err))))
4146 ;;(message "c-syntactic-re-search-forward done %s" (or (match-end 0) (point)))
4150 (goto-char (match-end 0))
4153 ;; Search failed. Set point as appropriate.
4159 (defvar safe-pos-list) ; bound in c-syntactic-skip-backward
4161 (defsubst c-ssb-lit-begin ()
4162 ;; Return the start of the literal point is in, or nil.
4163 ;; We read and write the variables `safe-pos', `safe-pos-list', `state'
4164 ;; bound in the caller.
4166 ;; Use `parse-partial-sexp' from a safe position down to the point to check
4167 ;; if it's outside comments and strings.
4169 (let ((pos (point)) safe-pos state)
4170 ;; Pick a safe position as close to the point as possible.
4172 ;; FIXME: Consult `syntax-ppss' here if our cache doesn't give a good
4175 (while (and safe-pos-list
4176 (> (car safe-pos-list) (point)))
4177 (setq safe-pos-list (cdr safe-pos-list)))
4178 (unless (setq safe-pos (car-safe safe-pos-list))
4179 (setq safe-pos (max (or (c-safe-position
4180 (point) (or c-state-cache
4184 safe-pos-list (list safe-pos)))
4186 ;; Cache positions along the way to use if we have to back up more. We
4187 ;; cache every closing paren on the same level. If the paren cache is
4188 ;; relevant in this region then we're typically already on the same
4189 ;; level as the target position. Note that we might cache positions
4190 ;; after opening parens in case safe-pos is in a nested list. That's
4191 ;; both uncommon and harmless.
4193 (setq state (parse-partial-sexp
4196 (setq safe-pos (point)
4197 safe-pos-list (cons safe-pos safe-pos-list)))
4199 ;; If the state contains the start of the containing sexp we cache that
4200 ;; position too, so that parse-partial-sexp in the next run has a bigger
4201 ;; chance of starting at the same level as the target position and thus
4202 ;; will get more good safe positions into the list.
4204 (setq safe-pos (1+ (elt state 1))
4205 safe-pos-list (cons safe-pos safe-pos-list)))
4207 (if (or (elt state 3) (elt state 4))
4208 ;; Inside string or comment. Continue search at the
4212 (defun c-syntactic-skip-backward (skip-chars &optional limit paren-level)
4213 "Like `skip-chars-backward' but only look at syntactically relevant chars,
4214 i.e. don't stop at positions inside syntactic whitespace or string
4215 literals. Preprocessor directives are also ignored, with the exception
4216 of the one that the point starts within, if any. If LIMIT is given,
4217 it's assumed to be at a syntactically relevant position.
4219 If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4220 sexps, and the search will also not go outside the current paren sexp.
4221 However, if LIMIT or the buffer limit is reached inside a nested paren
4222 then the point will be left at the limit.
4224 Non-nil is returned if the point moved, nil otherwise.
4226 Note that this function might do hidden buffer changes. See the
4227 comment at the start of cc-engine.el for more info."
4229 (let ((start (point))
4231 ;; A list of syntactically relevant positions in descending
4232 ;; order. It's used to avoid scanning repeatedly over
4233 ;; potentially large regions with `parse-partial-sexp' to verify
4234 ;; each position. Used in `c-ssb-lit-begin'
4236 ;; The result from `c-beginning-of-macro' at the start position or the
4237 ;; start position itself if it isn't within a macro. Evaluated on
4240 ;; The earliest position after the current one with the same paren
4241 ;; level. Used only when `paren-level' is set.
4243 (paren-level-pos (point)))
4247 ;; The next loop "tries" to find the end point each time round,
4248 ;; loops when it hasn't succeeded.
4251 (let ((pos (point)))
4253 (< (skip-chars-backward skip-chars limit) 0)
4254 ;; Don't stop inside a literal.
4255 (when (setq lit-beg (c-ssb-lit-begin))
4260 (let ((pos (point)) state-2 pps-end-pos)
4265 (setq state-2 (parse-partial-sexp
4266 pos paren-level-pos -1)
4267 pps-end-pos (point))
4268 (/= (car state-2) 0)))
4269 ;; Not at the right level.
4271 (if (and (< (car state-2) 0)
4272 ;; We stop above if we go out of a paren.
4273 ;; Now check whether it precedes or is
4274 ;; nested in the starting sexp.
4278 pps-end-pos paren-level-pos
4280 (< (car state-2) 0)))
4282 ;; We've stopped short of the starting position
4283 ;; so the hit was inside a nested list. Go up
4284 ;; until we are at the right level.
4287 (goto-char (scan-lists pos -1
4289 (setq paren-level-pos (point))
4290 (if (and limit (>= limit paren-level-pos))
4296 (goto-char (or limit (point-min)))
4299 ;; The hit was outside the list at the start
4300 ;; position. Go to the start of the list and exit.
4301 (goto-char (1+ (elt state-2 1)))
4304 ((c-beginning-of-macro limit)
4308 (setq start-macro-beg
4311 (c-beginning-of-macro limit)
4315 ;; It's inside the same macro we started in so it's
4316 ;; a relevant match.
4322 ;; Skip syntactic ws afterwards so that we don't stop at the
4323 ;; end of a comment if `skip-chars' is something like "^/".
4324 (c-backward-syntactic-ws)
4327 ;; We might want to extend this with more useful return values in
4329 (/= (point) start)))
4331 ;; The following is an alternative implementation of
4332 ;; `c-syntactic-skip-backward' that uses backward movement to keep
4333 ;; track of the syntactic context. It turned out to be generally
4334 ;; slower than the one above which uses forward checks from earlier
4337 ;;(defconst c-ssb-stop-re
4338 ;; ;; The regexp matching chars `c-syntactic-skip-backward' needs to
4339 ;; ;; stop at to avoid going into comments and literals.
4341 ;; ;; Match comment end syntax and string literal syntax. Also match
4342 ;; ;; '/' for block comment endings (not covered by comment end
4344 ;; "\\s>\\|/\\|\\s\""
4345 ;; (if (memq 'gen-string-delim c-emacs-features)
4348 ;; (if (memq 'gen-comment-delim c-emacs-features)
4352 ;;(defconst c-ssb-stop-paren-re
4353 ;; ;; Like `c-ssb-stop-re' but also stops at paren chars.
4354 ;; (concat c-ssb-stop-re "\\|\\s(\\|\\s)"))
4356 ;;(defconst c-ssb-sexp-end-re
4357 ;; ;; Regexp matching the ending syntax of a complex sexp.
4358 ;; (concat c-string-limit-regexp "\\|\\s)"))
4360 ;;(defun c-syntactic-skip-backward (skip-chars &optional limit paren-level)
4361 ;; "Like `skip-chars-backward' but only look at syntactically relevant chars,
4362 ;;i.e. don't stop at positions inside syntactic whitespace or string
4363 ;;literals. Preprocessor directives are also ignored. However, if the
4364 ;;point is within a comment, string literal or preprocessor directory to
4365 ;;begin with, its contents is treated as syntactically relevant chars.
4366 ;;If LIMIT is given, it limits the backward search and the point will be
4367 ;;left there if no earlier position is found.
4369 ;;If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4370 ;;sexps, and the search will also not go outside the current paren sexp.
4371 ;;However, if LIMIT or the buffer limit is reached inside a nested paren
4372 ;;then the point will be left at the limit.
4374 ;;Non-nil is returned if the point moved, nil otherwise.
4376 ;;Note that this function might do hidden buffer changes. See the
4377 ;;comment at the start of cc-engine.el for more info."
4379 ;; (save-restriction
4381 ;; (narrow-to-region limit (point-max)))
4383 ;; (let ((start (point)))
4385 ;; (while (let ((last-pos (point))
4387 ;; (skip-chars-backward skip-chars)
4390 ;; ;; Skip back over the same region as
4391 ;; ;; `skip-chars-backward' above, but keep to
4392 ;; ;; syntactically relevant positions.
4393 ;; (goto-char last-pos)
4395 ;; ;; `re-search-backward' with a single char regexp
4396 ;; ;; should be fast.
4397 ;; (re-search-backward
4398 ;; (if paren-level c-ssb-stop-paren-re c-ssb-stop-re)
4403 ;; ((looking-at "\\s(")
4404 ;; ;; `paren-level' is set and we've found the
4405 ;; ;; start of the containing paren.
4409 ;; ((looking-at c-ssb-sexp-end-re)
4410 ;; ;; We're at the end of a string literal or paren
4411 ;; ;; sexp (if `paren-level' is set).
4413 ;; (condition-case nil
4414 ;; (c-backward-sexp)
4416 ;; (goto-char limit)
4417 ;; (throw 'done t))))
4421 ;; ;; At the end of some syntactic ws or possibly
4422 ;; ;; after a plain '/' operator.
4423 ;; (let ((pos (point)))
4424 ;; (c-backward-syntactic-ws)
4425 ;; (if (= pos (point))
4426 ;; ;; Was a plain '/' operator. Go past it.
4427 ;; (backward-char)))))
4429 ;; (> (point) stop-pos))))
4431 ;; ;; Now the point is either at `stop-pos' or at some
4432 ;; ;; position further back if `stop-pos' was at a
4433 ;; ;; syntactically irrelevant place.
4435 ;; ;; Skip additional syntactic ws so that we don't stop
4436 ;; ;; at the end of a comment if `skip-chars' is
4437 ;; ;; something like "^/".
4438 ;; (c-backward-syntactic-ws)
4440 ;; (< (point) stop-pos))))
4442 ;; ;; We might want to extend this with more useful return values
4443 ;; ;; in the future.
4444 ;; (/= (point) start))))
4447 ;; Tools for handling comments and string literals.
4449 (defun c-in-literal (&optional lim detect-cpp)
4450 "Return the type of literal point is in, if any.
4451 The return value is `c' if in a C-style comment, `c++' if in a C++
4452 style comment, `string' if in a string literal, `pound' if DETECT-CPP
4453 is non-nil and in a preprocessor line, or nil if somewhere else.
4454 Optional LIM is used as the backward limit of the search. If omitted,
4455 or nil, `c-beginning-of-defun' is used.
4457 The last point calculated is cached if the cache is enabled, i.e. if
4458 `c-in-literal-cache' is bound to a two element vector.
4460 Note that this function might do hidden buffer changes. See the
4461 comment at the start of cc-engine.el for more info."
4464 (let* ((safe-place (c-state-semi-safe-place (point)))
4465 (lit (c-state-pp-to-literal safe-place (point))))
4468 (save-excursion (c-beginning-of-macro))
4471 (defun c-literal-limits (&optional lim near not-in-delimiter)
4472 "Return a cons of the beginning and end positions of the comment or
4473 string surrounding point (including both delimiters), or nil if point
4474 isn't in one. If LIM is non-nil, it's used as the \"safe\" position
4475 to start parsing from. If NEAR is non-nil, then the limits of any
4476 literal next to point is returned. \"Next to\" means there's only
4477 spaces and tabs between point and the literal. The search for such a
4478 literal is done first in forward direction. If NOT-IN-DELIMITER is
4479 non-nil, the case when point is inside a starting delimiter won't be
4480 recognized. This only has effect for comments which have starting
4481 delimiters with more than one character.
4483 Note that this function might do hidden buffer changes. See the
4484 comment at the start of cc-engine.el for more info."
4487 (let* ((pos (point))
4488 (lim (or lim (c-state-semi-safe-place pos)))
4489 (pp-to-lit (save-restriction
4491 (c-state-pp-to-literal lim pos not-in-delimiter)))
4492 (state (car pp-to-lit))
4493 (lit-limits (car (cddr pp-to-lit))))
4500 ;; Search forward for a literal.
4501 (skip-chars-forward " \t")
4503 ((looking-at c-string-limit-regexp) ; String.
4504 (cons (point) (or (c-safe (c-forward-sexp 1) (point))
4507 ((looking-at c-comment-start-regexp) ; Line or block comment.
4508 (cons (point) (progn (c-forward-single-comment) (point))))
4512 (skip-chars-backward " \t")
4514 (let ((end (point)) beg)
4517 (< (skip-syntax-backward c-string-syntax) 0)) ; String.
4518 (setq beg (c-safe (c-backward-sexp 1) (point))))
4520 ((and (c-safe (forward-char -2) t)
4522 ;; Block comment. Due to the nature of line
4523 ;; comments, they will always be covered by the
4524 ;; normal case above.
4526 (c-backward-single-comment)
4527 ;; If LIM is bogus, beg will be bogus.
4528 (setq beg (point))))
4530 (if beg (cons beg end))))))
4533 ;; In case external callers use this; it did have a docstring.
4534 (defalias 'c-literal-limits-fast 'c-literal-limits)
4536 (defun c-collect-line-comments (range)
4537 "If the argument is a cons of two buffer positions (such as returned by
4538 `c-literal-limits'), and that range contains a C++ style line comment,
4539 then an extended range is returned that contains all adjacent line
4540 comments (i.e. all comments that starts in the same column with no
4541 empty lines or non-whitespace characters between them). Otherwise the
4542 argument is returned.
4544 Note that this function might do hidden buffer changes. See the
4545 comment at the start of cc-engine.el for more info."
4549 (if (and (consp range) (progn
4550 (goto-char (car range))
4551 (looking-at c-line-comment-starter)))
4552 (let ((col (current-column))
4554 (bopl (c-point 'bopl))
4556 ;; Got to take care in the backward direction to handle
4557 ;; comments which are preceded by code.
4558 (while (and (c-backward-single-comment)
4560 (looking-at c-line-comment-starter)
4561 (= col (current-column)))
4563 bopl (c-point 'bopl)))
4565 (while (and (progn (skip-chars-forward " \t")
4566 (looking-at c-line-comment-starter))
4567 (= col (current-column))
4568 (prog1 (zerop (forward-line 1))
4569 (setq end (point)))))
4574 (defun c-literal-type (range)
4575 "Convenience function that given the result of `c-literal-limits',
4576 returns nil or the type of literal that the range surrounds, one
4577 of the symbols 'c, 'c++ or 'string. It's much faster than using
4578 `c-in-literal' and is intended to be used when you need both the
4579 type of a literal and its limits.
4581 Note that this function might do hidden buffer changes. See the
4582 comment at the start of cc-engine.el for more info."
4586 (goto-char (car range))
4587 (cond ((looking-at c-string-limit-regexp) 'string)
4588 ((or (looking-at "//") ; c++ line comment
4589 (and (looking-at "\\s<") ; comment starter
4590 (looking-at "#"))) ; awk comment.
4592 (t 'c))) ; Assuming the range is valid.
4595 (defsubst c-determine-limit-get-base (start try-size)
4596 ;; Get a "safe place" approximately TRY-SIZE characters before START.
4597 ;; This doesn't preserve point.
4598 (let* ((pos (max (- start try-size) (point-min)))
4599 (base (c-state-semi-safe-place pos))
4600 (s (parse-partial-sexp base pos)))
4601 (if (or (nth 4 s) (nth 3 s)) ; comment or string
4605 (defun c-determine-limit (how-far-back &optional start try-size)
4606 ;; Return a buffer position HOW-FAR-BACK non-literal characters from START
4607 ;; (default point). This is done by going back further in the buffer then
4608 ;; searching forward for literals. The position found won't be in a
4609 ;; literal. We start searching for the sought position TRY-SIZE (default
4610 ;; twice HOW-FAR-BACK) bytes back from START. This function must be fast.
4613 (let* ((start (or start (point)))
4614 (try-size (or try-size (* 2 how-far-back)))
4615 (base (c-determine-limit-get-base start try-size))
4618 (s (parse-partial-sexp pos pos)) ; null state.
4621 (while (< pos start)
4622 ;; Move forward one literal each time round this loop.
4623 ;; Move forward to the start of a comment or string.
4624 (setq s (parse-partial-sexp
4630 'syntax-table)) ; stop-comment
4632 ;; Gather details of the non-literal-bit - starting pos and size.
4633 (setq size (- (if (or (nth 4 s) (nth 3 s))
4638 (setq stack (cons (cons pos size) stack)))
4640 ;; Move forward to the end of the comment/string.
4641 (if (or (nth 4 s) (nth 3 s))
4642 (setq s (parse-partial-sexp
4648 'syntax-table))) ; stop-comment
4651 ;; Now try and find enough non-literal characters recorded on the stack.
4652 ;; Go back one recorded literal each time round this loop.
4653 (while (and (< count how-far-back)
4655 (setq elt (car stack)
4657 (setq count (+ count (cdr elt))))
4659 ;; Have we found enough yet?
4661 ((>= count how-far-back)
4662 (+ (car elt) (- count how-far-back)))
4663 ((eq base (point-min))
4666 (c-determine-limit (- how-far-back count) base try-size))))))
4668 (defun c-determine-+ve-limit (how-far &optional start-pos)
4669 ;; Return a buffer position about HOW-FAR non-literal characters forward
4670 ;; from START-POS (default point), which must not be inside a literal.
4672 (let ((pos (or start-pos (point)))
4674 (s (parse-partial-sexp (point) (point)))) ; null state
4675 (while (and (not (eobp))
4677 ;; Scan over counted characters.
4678 (setq s (parse-partial-sexp
4680 (min (+ pos count) (point-max))
4684 'syntax-table)) ; stop-comment
4685 (setq count (- count (- (point) pos) 1)
4687 ;; Scan over literal characters.
4689 (setq s (parse-partial-sexp
4695 'syntax-table) ; stop-comment
4700 ;; `c-find-decl-spots' and accompanying stuff.
4702 ;; Variables used in `c-find-decl-spots' to cache the search done for
4703 ;; the first declaration in the last call. When that function starts,
4704 ;; it needs to back up over syntactic whitespace to look at the last
4705 ;; token before the region being searched. That can sometimes cause
4706 ;; moves back and forth over a quite large region of comments and
4707 ;; macros, which would be repeated for each changed character when
4708 ;; we're called during fontification, since font-lock refontifies the
4709 ;; current line for each change. Thus it's worthwhile to cache the
4712 ;; `c-find-decl-syntactic-pos' is a syntactically relevant position in
4713 ;; the syntactic whitespace less or equal to some start position.
4714 ;; There's no cached value if it's nil.
4716 ;; `c-find-decl-match-pos' is the match position if
4717 ;; `c-find-decl-prefix-search' matched before the syntactic whitespace
4718 ;; at `c-find-decl-syntactic-pos', or nil if there's no such match.
4719 (defvar c-find-decl-syntactic-pos nil)
4720 (make-variable-buffer-local 'c-find-decl-syntactic-pos)
4721 (defvar c-find-decl-match-pos nil)
4722 (make-variable-buffer-local 'c-find-decl-match-pos)
4724 (defsubst c-invalidate-find-decl-cache (change-min-pos)
4725 (and c-find-decl-syntactic-pos
4726 (< change-min-pos c-find-decl-syntactic-pos)
4727 (setq c-find-decl-syntactic-pos nil)))
4729 ; (defface c-debug-decl-spot-face
4730 ; '((t (:background "Turquoise")))
4731 ; "Debug face to mark the spots where `c-find-decl-spots' stopped.")
4732 ; (defface c-debug-decl-sws-face
4733 ; '((t (:background "Khaki")))
4734 ; "Debug face to mark the syntactic whitespace between the declaration
4735 ; spots and the preceding token end.")
4737 (defmacro c-debug-put-decl-spot-faces (match-pos decl-pos)
4738 (when (facep 'c-debug-decl-spot-face)
4739 `(c-save-buffer-state ((match-pos ,match-pos) (decl-pos ,decl-pos))
4740 (c-debug-add-face (max match-pos (point-min)) decl-pos
4741 'c-debug-decl-sws-face)
4742 (c-debug-add-face decl-pos (min (1+ decl-pos) (point-max))
4743 'c-debug-decl-spot-face))))
4744 (defmacro c-debug-remove-decl-spot-faces (beg end)
4745 (when (facep 'c-debug-decl-spot-face)
4746 `(c-save-buffer-state ()
4747 (c-debug-remove-face ,beg ,end 'c-debug-decl-spot-face)
4748 (c-debug-remove-face ,beg ,end 'c-debug-decl-sws-face))))
4750 (defmacro c-find-decl-prefix-search ()
4751 ;; Macro used inside `c-find-decl-spots'. It ought to be a defun,
4752 ;; but it contains lots of free variables that refer to things
4753 ;; inside `c-find-decl-spots'. The point is left at `cfd-match-pos'
4754 ;; if there is a match, otherwise at `cfd-limit'.
4756 ;; The macro moves point forward to the next putative start of a declaration
4757 ;; or cfd-limit. This decl start is the next token after a "declaration
4758 ;; prefix". The declaration prefix is the earlier of `cfd-prop-match' and
4759 ;; `cfd-re-match'. `cfd-match-pos' is set to the decl prefix.
4761 ;; This macro might do hidden buffer changes.
4764 ;; Find the next property match position if we haven't got one already.
4765 (unless cfd-prop-match
4768 (goto-char (next-single-property-change
4769 (point) 'c-type nil cfd-limit))
4770 (and (< (point) cfd-limit)
4771 (not (eq (c-get-char-property (1- (point)) 'c-type)
4773 (setq cfd-prop-match (point))))
4775 ;; Find the next `c-decl-prefix-or-start-re' match if we haven't
4777 (unless cfd-re-match
4779 (if (> cfd-re-match-end (point))
4780 (goto-char cfd-re-match-end))
4782 ;; Each time round, the next `while' moves forward over a pseudo match
4783 ;; of `c-decl-prefix-or-start-re' which is either inside a literal, or
4784 ;; is a ":" not preceded by "public", etc.. `cfd-re-match' and
4785 ;; `cfd-re-match-end' get set.
4788 (setq cfd-re-match-end (re-search-forward c-decl-prefix-or-start-re
4791 ((null cfd-re-match-end)
4792 ;; No match. Finish up and exit the loop.
4793 (setq cfd-re-match cfd-limit)
4796 (if (setq cfd-re-match (match-end 1))
4797 ;; Matched the end of a token preceding a decl spot.
4799 (goto-char cfd-re-match)
4801 ;; Matched a token that start a decl spot.
4802 (goto-char (match-beginning 0))
4805 ;; Pseudo match inside a comment or string literal. Skip out
4806 ;; of comments and string literals.
4808 (goto-char (next-single-property-change
4809 (point) 'face nil cfd-limit))
4810 (and (< (point) cfd-limit)
4811 (c-got-face-at (point) c-literal-faces))))
4812 t) ; Continue the loop over pseudo matches.
4813 ((and (match-string 1)
4814 (string= (match-string 1) ":")
4816 (or (/= (c-backward-token-2 2) 0) ; no search limit. :-(
4817 (not (looking-at c-decl-start-colon-kwd-re)))))
4818 ;; Found a ":" which isn't part of "public:", etc.
4820 (t nil)))) ;; Found a real match. Exit the pseudo-match loop.
4822 ;; If our match was at the decl start, we have to back up over the
4823 ;; preceding syntactic ws to set `cfd-match-pos' and to catch
4824 ;; any decl spots in the syntactic ws.
4825 (unless cfd-re-match
4826 (c-backward-syntactic-ws)
4827 (setq cfd-re-match (point))))
4829 ;; Choose whichever match is closer to the start.
4830 (if (< cfd-re-match cfd-prop-match)
4831 (setq cfd-match-pos cfd-re-match
4833 (setq cfd-match-pos cfd-prop-match
4834 cfd-prop-match nil))
4836 (goto-char cfd-match-pos)
4838 (when (< cfd-match-pos cfd-limit)
4839 ;; Skip forward past comments only so we don't skip macros.
4840 (c-forward-comments)
4841 ;; Set the position to continue at. We can avoid going over
4842 ;; the comments skipped above a second time, but it's possible
4843 ;; that the comment skipping has taken us past `cfd-prop-match'
4844 ;; since the property might be used inside comments.
4845 (setq cfd-continue-pos (if cfd-prop-match
4846 (min cfd-prop-match (point))
4849 (defun c-find-decl-spots (cfd-limit cfd-decl-re cfd-face-checklist cfd-fun)
4850 ;; Call CFD-FUN for each possible spot for a declaration, cast or
4851 ;; label from the point to CFD-LIMIT.
4853 ;; CFD-FUN is called with point at the start of the spot. It's passed two
4854 ;; arguments: The first is the end position of the token preceding the spot,
4855 ;; or 0 for the implicit match at bob. The second is a flag that is t when
4856 ;; the match is inside a macro. Point should be moved forward by at least
4859 ;; If CFD-FUN adds `c-decl-end' properties somewhere below the current spot,
4860 ;; it should return non-nil to ensure that the next search will find them.
4863 ;; o The first token after bob.
4864 ;; o The first token after the end of submatch 1 in
4865 ;; `c-decl-prefix-or-start-re' when that submatch matches. This
4866 ;; submatch is typically a (L or R) brace or paren, a ;, or a ,.
4867 ;; o The start of each `c-decl-prefix-or-start-re' match when
4868 ;; submatch 1 doesn't match. This is, for example, the keyword
4870 ;; o The start of a previously recognized declaration; "recognized"
4871 ;; means that the last char of the previous token has a `c-type'
4872 ;; text property with the value `c-decl-end'; this only holds
4873 ;; when `c-type-decl-end-used' is set.
4875 ;; Only a spot that match CFD-DECL-RE and whose face is in the
4876 ;; CFD-FACE-CHECKLIST list causes CFD-FUN to be called. The face
4877 ;; check is disabled if CFD-FACE-CHECKLIST is nil.
4879 ;; If the match is inside a macro then the buffer is narrowed to the
4880 ;; end of it, so that CFD-FUN can investigate the following tokens
4881 ;; without matching something that begins inside a macro and ends
4882 ;; outside it. It's to avoid this work that the CFD-DECL-RE and
4883 ;; CFD-FACE-CHECKLIST checks exist.
4885 ;; The spots are visited approximately in order from top to bottom.
4886 ;; It's however the positions where `c-decl-prefix-or-start-re'
4887 ;; matches and where `c-decl-end' properties are found that are in
4888 ;; order. Since the spots often are at the following token, they
4889 ;; might be visited out of order insofar as more spots are reported
4890 ;; later on within the syntactic whitespace between the match
4891 ;; positions and their spots.
4893 ;; It's assumed that comments and strings are fontified in the
4896 ;; This is mainly used in fontification, and so has an elaborate
4897 ;; cache to handle repeated calls from the same start position; see
4898 ;; the variables above.
4900 ;; All variables in this function begin with `cfd-' to avoid name
4901 ;; collision with the (dynamically bound) variables used in CFD-FUN.
4903 ;; This function might do hidden buffer changes.
4905 (let ((cfd-start-pos (point)) ; never changed
4906 (cfd-buffer-end (point-max))
4907 ;; The end of the token preceding the decl spot last found
4908 ;; with `c-decl-prefix-or-start-re'. `cfd-limit' if there's
4911 ;; The end position of the last `c-decl-prefix-or-start-re'
4912 ;; match. If this is greater than `cfd-continue-pos', the
4913 ;; next regexp search is started here instead.
4914 (cfd-re-match-end (point-min))
4915 ;; The end of the last `c-decl-end' found by
4916 ;; `c-find-decl-prefix-search'. `cfd-limit' if there's no
4917 ;; match. If searching for the property isn't needed then we
4918 ;; disable it by setting it to `cfd-limit' directly.
4919 (cfd-prop-match (unless c-type-decl-end-used cfd-limit))
4920 ;; The end of the token preceding the decl spot last found by
4921 ;; `c-find-decl-prefix-search'. 0 for the implicit match at
4922 ;; bob. `cfd-limit' if there's no match. In other words,
4923 ;; this is the minimum of `cfd-re-match' and `cfd-prop-match'.
4924 (cfd-match-pos cfd-limit)
4925 ;; The position to continue searching at.
4927 ;; The position of the last "real" token we've stopped at.
4928 ;; This can be greater than `cfd-continue-pos' when we get
4929 ;; hits inside macros or at `c-decl-end' positions inside
4932 ;; The end position of the last entered macro.
4935 ;; Initialize by finding a syntactically relevant start position
4936 ;; before the point, and do the first `c-decl-prefix-or-start-re'
4937 ;; search unless we're at bob.
4939 (let (start-in-literal start-in-macro syntactic-pos)
4940 ;; Must back up a bit since we look for the end of the previous
4941 ;; statement or declaration, which is earlier than the first
4944 ;; This `cond' moves back over any literals or macros. It has special
4945 ;; handling for when the region being searched is entirely within a
4946 ;; macro. It sets `cfd-continue-pos' (unless we've reached
4949 ;; First we need to move to a syntactically relevant position.
4950 ;; Begin by backing out of comment or string literals.
4952 ;; This arm of the cond actually triggers if we're in a literal,
4953 ;; and cfd-limit is at most at BONL.
4955 ;; This arm of the `and' moves backwards out of a literal when
4956 ;; the face at point is a literal face. In this case, its value
4957 ;; is always non-nil.
4958 (when (c-got-face-at (point) c-literal-faces)
4959 ;; Try to use the faces to back up to the start of the
4960 ;; literal. FIXME: What if the point is on a declaration
4961 ;; inside a comment?
4962 (while (and (not (bobp))
4963 (c-got-face-at (1- (point)) c-literal-faces))
4964 (goto-char (previous-single-property-change
4965 (point) 'face nil (point-min))))
4967 ;; XEmacs doesn't fontify the quotes surrounding string
4969 (and (featurep 'xemacs)
4970 (eq (get-text-property (point) 'face)
4971 'font-lock-string-face)
4973 (progn (backward-char)
4974 (not (looking-at c-string-limit-regexp)))
4977 ;; Don't trust the literal to contain only literal faces
4978 ;; (the font lock package might not have fontified the
4979 ;; start of it at all, for instance) so check that we have
4980 ;; arrived at something that looks like a start or else
4981 ;; resort to `c-literal-limits'.
4982 (unless (looking-at c-literal-start-regexp)
4983 (let ((range (c-literal-limits)))
4984 (if range (goto-char (car range)))))
4986 (setq start-in-literal (point))) ; end of `and' arm.
4988 ;; The start is in a literal. If the limit is in the same
4989 ;; one we don't have to find a syntactic position etc. We
4990 ;; only check that if the limit is at or before bonl to save
4991 ;; time; it covers the by far most common case when font-lock
4992 ;; refontifies the current line only.
4993 (<= cfd-limit (c-point 'bonl cfd-start-pos))
4995 (goto-char cfd-start-pos)
4997 (goto-char (next-single-property-change
4998 (point) 'face nil cfd-limit))
4999 (and (< (point) cfd-limit)
5000 (c-got-face-at (point) c-literal-faces))))
5001 (= (point) cfd-limit))) ; end of `cond' arm condition
5003 ;; Completely inside a literal. Set up variables to trig the
5004 ;; (< cfd-continue-pos cfd-start-pos) case below and it'll
5005 ;; find a suitable start position.
5006 (setq cfd-continue-pos start-in-literal)) ; end of `cond' arm
5008 ;; Check if the region might be completely inside a macro, to
5009 ;; optimize that like the completely-inside-literal above.
5011 (and (= (forward-line 1) 0)
5012 (bolp) ; forward-line has funny behavior at eob.
5013 (>= (point) cfd-limit)
5014 (progn (backward-char)
5015 (eq (char-before) ?\\))))
5016 ;; (Maybe) completely inside a macro. Only need to trig the
5017 ;; (< cfd-continue-pos cfd-start-pos) case below to make it
5019 (setq cfd-continue-pos (1- cfd-start-pos)
5022 ;; The default arm of the `cond' moves back over any macro we're in
5023 ;; and over any syntactic WS. It sets `c-find-decl-syntactic-pos'.
5025 ;; Back out of any macro so we don't miss any declaration
5026 ;; that could follow after it.
5027 (when (c-beginning-of-macro)
5028 (setq start-in-macro t))
5030 ;; Now we're at a proper syntactically relevant position so we
5031 ;; can use the cache. But first clear it if it applied
5033 (c-invalidate-find-decl-cache cfd-start-pos)
5035 (setq syntactic-pos (point))
5036 (unless (eq syntactic-pos c-find-decl-syntactic-pos)
5037 ;; Don't have to do this if the cache is relevant here,
5038 ;; typically if the same line is refontified again. If
5039 ;; we're just some syntactic whitespace further down we can
5040 ;; still use the cache to limit the skipping.
5041 (c-backward-syntactic-ws c-find-decl-syntactic-pos))
5043 ;; If we hit `c-find-decl-syntactic-pos' and
5044 ;; `c-find-decl-match-pos' is set then we install the cached
5045 ;; values. If we hit `c-find-decl-syntactic-pos' and
5046 ;; `c-find-decl-match-pos' is nil then we know there's no decl
5047 ;; prefix in the whitespace before `c-find-decl-syntactic-pos'
5048 ;; and so we can continue the search from this point. If we
5049 ;; didn't hit `c-find-decl-syntactic-pos' then we're now in
5050 ;; the right spot to begin searching anyway.
5051 (if (and (eq (point) c-find-decl-syntactic-pos)
5052 c-find-decl-match-pos)
5053 (setq cfd-match-pos c-find-decl-match-pos
5054 cfd-continue-pos syntactic-pos)
5056 (setq c-find-decl-syntactic-pos syntactic-pos)
5059 ;; Always consider bob a match to get the first
5060 ;; declaration in the file. Do this separately instead of
5061 ;; letting `c-decl-prefix-or-start-re' match bob, so that
5062 ;; regexp always can consume at least one character to
5063 ;; ensure that we won't get stuck in an infinite loop.
5064 (setq cfd-re-match 0)
5066 (c-beginning-of-current-token)
5067 (< (point) cfd-limit))
5068 ;; Do an initial search now. In the bob case above it's
5069 ;; only done to search for a `c-decl-end' spot.
5070 (c-find-decl-prefix-search)) ; sets cfd-continue-pos
5072 (setq c-find-decl-match-pos (and (< cfd-match-pos cfd-start-pos)
5073 cfd-match-pos))))) ; end of `cond'
5075 ;; Advance `cfd-continue-pos' if it's before the start position.
5076 ;; The closest continue position that might have effect at or
5077 ;; after the start depends on what we started in. This also
5078 ;; finds a suitable start position in the special cases when the
5079 ;; region is completely within a literal or macro.
5080 (when (and cfd-continue-pos (< cfd-continue-pos cfd-start-pos))
5084 ;; If we're in a macro then it's the closest preceding token
5085 ;; in the macro. Check this before `start-in-literal',
5086 ;; since if we're inside a literal in a macro, the preceding
5087 ;; token is earlier than any `c-decl-end' spot inside the
5088 ;; literal (comment).
5089 (goto-char (or start-in-literal cfd-start-pos))
5090 ;; The only syntactic ws in macros are comments.
5091 (c-backward-comments)
5093 (c-beginning-of-current-token))
5096 ;; If we're in a comment it can only be the closest
5097 ;; preceding `c-decl-end' position within that comment, if
5098 ;; any. Go back to the beginning of such a property so that
5099 ;; `c-find-decl-prefix-search' will find the end of it.
5100 ;; (Can't stop at the end and install it directly on
5101 ;; `cfd-prop-match' since that variable might be cleared
5102 ;; after `cfd-fun' below.)
5104 ;; Note that if the literal is a string then the property
5105 ;; search will simply skip to the beginning of it right
5107 (if (not c-type-decl-end-used)
5108 (goto-char start-in-literal)
5109 (goto-char cfd-start-pos)
5111 (goto-char (previous-single-property-change
5112 (point) 'c-type nil start-in-literal))
5113 (and (> (point) start-in-literal)
5114 (not (eq (c-get-char-property (point) 'c-type)
5117 (when (= (point) start-in-literal)
5118 ;; Didn't find any property inside the comment, so we can
5119 ;; skip it entirely. (This won't skip past a string, but
5120 ;; that'll be handled quickly by the next
5121 ;; `c-find-decl-prefix-search' anyway.)
5122 (c-forward-single-comment)
5123 (if (> (point) cfd-limit)
5124 (goto-char cfd-limit))))
5127 ;; If we started in normal code, the only match that might
5128 ;; apply before the start is what we already got in
5129 ;; `cfd-match-pos' so we can continue at the start position.
5130 ;; (Note that we don't get here if the first match is below
5132 (goto-char cfd-start-pos))) ; end of `cond'
5134 ;; Delete found matches if they are before our new continue
5135 ;; position, so that `c-find-decl-prefix-search' won't back up
5136 ;; to them later on.
5137 (setq cfd-continue-pos (point))
5138 (when (and cfd-re-match (< cfd-re-match cfd-continue-pos))
5139 (setq cfd-re-match nil))
5140 (when (and cfd-prop-match (< cfd-prop-match cfd-continue-pos))
5141 (setq cfd-prop-match nil))) ; end of `when'
5144 ;; This is the normal case and we got a proper syntactic
5145 ;; position. If there's a match then it's always outside
5146 ;; macros and comments, so advance to the next token and set
5147 ;; `cfd-token-pos'. The loop below will later go back using
5148 ;; `cfd-continue-pos' to fix declarations inside the
5150 (when (and cfd-match-pos (< cfd-match-pos syntactic-pos))
5151 (goto-char syntactic-pos)
5152 (c-forward-syntactic-ws)
5153 (and cfd-continue-pos
5154 (< cfd-continue-pos (point))
5155 (setq cfd-token-pos (point))))
5157 ;; Have one of the special cases when the region is completely
5158 ;; within a literal or macro. `cfd-continue-pos' is set to a
5159 ;; good start position for the search, so do it.
5160 (c-find-decl-prefix-search)))
5162 ;; Now loop, one decl spot per iteration. We already have the first
5163 ;; match in `cfd-match-pos'.
5165 ;; Go foward over "false matches", one per iteration.
5167 (< cfd-match-pos cfd-limit)
5170 ;; Kludge to filter out matches on the "<" that
5171 ;; aren't open parens, for the sake of languages
5172 ;; that got `c-recognize-<>-arglists' set.
5173 (and (eq (char-before cfd-match-pos) ?<)
5174 (not (c-get-char-property (1- cfd-match-pos)
5177 ;; If `cfd-continue-pos' is less or equal to
5178 ;; `cfd-token-pos', we've got a hit inside a macro
5179 ;; that's in the syntactic whitespace before the last
5180 ;; "real" declaration we've checked. If they're equal
5181 ;; we've arrived at the declaration a second time, so
5182 ;; there's nothing to do.
5183 (= cfd-continue-pos cfd-token-pos)
5186 ;; If `cfd-continue-pos' is less than `cfd-token-pos'
5187 ;; we're still searching for declarations embedded in
5188 ;; the syntactic whitespace. In that case we need
5189 ;; only to skip comments and not macros, since they
5190 ;; can't be nested, and that's already been done in
5191 ;; `c-find-decl-prefix-search'.
5192 (when (> cfd-continue-pos cfd-token-pos)
5193 (c-forward-syntactic-ws)
5194 (setq cfd-token-pos (point)))
5196 ;; Continue if the following token fails the
5197 ;; CFD-DECL-RE and CFD-FACE-CHECKLIST checks.
5198 (when (or (>= (point) cfd-limit)
5199 (not (looking-at cfd-decl-re))
5200 (and cfd-face-checklist
5202 (point) cfd-face-checklist))))
5203 (goto-char cfd-continue-pos)
5206 (< (point) cfd-limit)) ; end of "false matches" condition
5207 (c-find-decl-prefix-search)) ; end of "false matches" loop
5209 (< (point) cfd-limit)) ; end of condition for "decl-spot" while
5212 (>= (point) cfd-start-pos)
5215 ;; Narrow to the end of the macro if we got a hit inside
5216 ;; one, to avoid recognizing things that start inside the
5217 ;; macro and end outside it.
5218 (when (> cfd-match-pos cfd-macro-end)
5219 ;; Not in the same macro as in the previous round.
5221 (goto-char cfd-match-pos)
5223 (if (save-excursion (and (c-beginning-of-macro)
5224 (< (point) cfd-match-pos)))
5225 (progn (c-end-of-macro)
5229 (if (zerop cfd-macro-end)
5231 (if (> cfd-macro-end (point))
5232 (progn (narrow-to-region (point-min) cfd-macro-end)
5234 ;; The matched token was the last thing in the macro,
5235 ;; so the whole match is bogus.
5236 (setq cfd-macro-end 0)
5237 nil)))) ; end of when condition
5239 (c-debug-put-decl-spot-faces cfd-match-pos (point))
5240 (if (funcall cfd-fun cfd-match-pos (/= cfd-macro-end 0))
5241 (setq cfd-prop-match nil))
5243 (when (/= cfd-macro-end 0)
5244 ;; Restore limits if we did macro narrowing above.
5245 (narrow-to-region (point-min) cfd-buffer-end)))
5247 (goto-char cfd-continue-pos)
5248 (if (= cfd-continue-pos cfd-limit)
5249 (setq cfd-match-pos cfd-limit)
5250 (c-find-decl-prefix-search))))) ; Moves point, sets cfd-continue-pos,
5251 ; cfd-match-pos, etc.
5254 ;; A cache for found types.
5256 ;; Buffer local variable that contains an obarray with the types we've
5257 ;; found. If a declaration is recognized somewhere we record the
5258 ;; fully qualified identifier in it to recognize it as a type
5259 ;; elsewhere in the file too. This is not accurate since we do not
5260 ;; bother with the scoping rules of the languages, but in practice the
5261 ;; same name is seldom used as both a type and something else in a
5262 ;; file, and we only use this as a last resort in ambiguous cases (see
5263 ;; `c-forward-decl-or-cast-1').
5265 ;; Not every type need be in this cache. However, things which have
5266 ;; ceased to be types must be removed from it.
5268 ;; Template types in C++ are added here too but with the template
5269 ;; arglist replaced with "<>" in references or "<" for the one in the
5270 ;; primary type. E.g. the type "Foo<A,B>::Bar<C>" is stored as
5271 ;; "Foo<>::Bar<". This avoids storing very long strings (since C++
5272 ;; template specs can be fairly sized programs in themselves) and
5273 ;; improves the hit ratio (it's a type regardless of the template
5274 ;; args; it's just not the same type, but we're only interested in
5275 ;; recognizing types, not telling distinct types apart). Note that
5276 ;; template types in references are added here too; from the example
5277 ;; above there will also be an entry "Foo<".
5278 (defvar c-found-types nil)
5279 (make-variable-buffer-local 'c-found-types)
5281 (defsubst c-clear-found-types ()
5282 ;; Clears `c-found-types'.
5283 (setq c-found-types (make-vector 53 0)))
5285 (defun c-add-type (from to)
5286 ;; Add the given region as a type in `c-found-types'. If the region
5287 ;; doesn't match an existing type but there is a type which is equal
5288 ;; to the given one except that the last character is missing, then
5289 ;; the shorter type is removed. That's done to avoid adding all
5290 ;; prefixes of a type as it's being entered and font locked. This
5291 ;; doesn't cover cases like when characters are removed from a type
5292 ;; or added in the middle. We'd need the position of point when the
5293 ;; font locking is invoked to solve this well.
5295 ;; This function might do hidden buffer changes.
5296 (let ((type (c-syntactic-content from to c-recognize-<>-arglists)))
5297 (unless (intern-soft type c-found-types)
5298 (unintern (substring type 0 -1) c-found-types)
5299 (intern type c-found-types))))
5301 (defun c-unfind-type (name)
5302 ;; Remove the "NAME" from c-found-types, if present.
5303 (unintern name c-found-types))
5305 (defsubst c-check-type (from to)
5306 ;; Return non-nil if the given region contains a type in
5309 ;; This function might do hidden buffer changes.
5310 (intern-soft (c-syntactic-content from to c-recognize-<>-arglists)
5313 (defun c-list-found-types ()
5314 ;; Return all the types in `c-found-types' as a sorted list of
5317 (mapatoms (lambda (type)
5318 (setq type-list (cons (symbol-name type)
5321 (sort type-list 'string-lessp)))
5323 ;; Shut up the byte compiler.
5324 (defvar c-maybe-stale-found-type)
5326 (defun c-trim-found-types (beg end old-len)
5327 ;; An after change function which, in conjunction with the info in
5328 ;; c-maybe-stale-found-type (set in c-before-change), removes a type
5329 ;; from `c-found-types', should this type have become stale. For
5330 ;; example, this happens to "foo" when "foo \n bar();" becomes
5331 ;; "foo(); \n bar();". Such stale types, if not removed, foul up
5332 ;; the fontification.
5334 ;; Have we, perhaps, added non-ws characters to the front/back of a found
5338 (when (< end (point-max))
5340 (if (and (c-beginning-of-current-token) ; only moves when we started in the middle
5341 (progn (goto-char end)
5342 (c-end-of-current-token)))
5343 (c-unfind-type (buffer-substring-no-properties
5345 (when (> beg (point-min))
5347 (if (and (c-end-of-current-token) ; only moves when we started in the middle
5348 (progn (goto-char beg)
5349 (c-beginning-of-current-token)))
5350 (c-unfind-type (buffer-substring-no-properties
5353 (if c-maybe-stale-found-type ; e.g. (c-decl-id-start "foo" 97 107 " (* ooka) " "o")
5355 ;; Changing the amount of (already existing) whitespace - don't do anything.
5356 ((and (c-partial-ws-p beg end)
5357 (or (= beg end) ; removal of WS
5358 (string-match "^[ \t\n\r\f\v]*$" (nth 5 c-maybe-stale-found-type)))))
5360 ;; The syntactic relationship which defined a "found type" has been
5362 ((eq (car c-maybe-stale-found-type) 'c-decl-id-start)
5363 (c-unfind-type (cadr c-maybe-stale-found-type)))
5364 ;; ((eq (car c-maybe-stale-found-type) 'c-decl-type-start) FIXME!!!
5368 ;; Setting and removing syntax properties on < and > in languages (C++
5369 ;; and Java) where they can be template/generic delimiters as well as
5370 ;; their normal meaning of "less/greater than".
5372 ;; Normally, < and > have syntax 'punctuation'. When they are found to
5373 ;; be delimiters, they are marked as such with the category properties
5374 ;; c-<-as-paren-syntax, c->-as-paren-syntax respectively.
5378 ;; It is impossible to determine with certainty whether a <..> pair in
5379 ;; C++ is two comparison operators or is template delimiters, unless
5380 ;; one duplicates a lot of a C++ compiler. For example, the following
5383 ;; foo (a < b, c > d) ;
5385 ;; could be a function call with two integer parameters (each a
5386 ;; relational expression), or it could be a constructor for class foo
5387 ;; taking one parameter d of templated type "a < b, c >". They are
5388 ;; somewhat easier to distinguish in Java.
5390 ;; The strategy now (2010-01) adopted is to mark and unmark < and
5391 ;; > IN MATCHING PAIRS ONLY. [Previously, they were marked
5392 ;; individually when their context so indicated. This gave rise to
5393 ;; intractable problems when one of a matching pair was deleted, or
5394 ;; pulled into a literal.]
5396 ;; At each buffer change, the syntax-table properties are removed in a
5397 ;; before-change function and reapplied, when needed, in an
5398 ;; after-change function. It is far more important that the
5399 ;; properties get removed when they they are spurious than that they
5400 ;; be present when wanted.
5401 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
5402 (defun c-clear-<-pair-props (&optional pos)
5403 ;; POS (default point) is at a < character. If it is marked with
5404 ;; open paren syntax-table text property, remove the property,
5405 ;; together with the close paren property on the matching > (if
5411 (when (equal (c-get-char-property (point) 'syntax-table)
5412 c-<-as-paren-syntax)
5413 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5414 (c-go-list-forward))
5415 (when (equal (c-get-char-property (1- (point)) 'syntax-table)
5416 c->-as-paren-syntax) ; should always be true.
5417 (c-clear-char-property (1- (point)) 'category))
5418 (c-clear-char-property pos 'category))))
5420 (defun c-clear->-pair-props (&optional pos)
5421 ;; POS (default point) is at a > character. If it is marked with
5422 ;; close paren syntax-table property, remove the property, together
5423 ;; with the open paren property on the matching < (if any).
5428 (when (equal (c-get-char-property (point) 'syntax-table)
5429 c->-as-paren-syntax)
5430 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5431 (c-go-up-list-backward))
5432 (when (equal (c-get-char-property (point) 'syntax-table)
5433 c-<-as-paren-syntax) ; should always be true.
5434 (c-clear-char-property (point) 'category))
5435 (c-clear-char-property pos 'category))))
5437 (defun c-clear-<>-pair-props (&optional pos)
5438 ;; POS (default point) is at a < or > character. If it has an
5439 ;; open/close paren syntax-table property, remove this property both
5440 ;; from the current character and its partner (which will also be
5443 ((eq (char-after) ?\<)
5444 (c-clear-<-pair-props pos))
5445 ((eq (char-after) ?\>)
5446 (c-clear->-pair-props pos))
5448 "c-clear-<>-pair-props called from wrong position"))))
5450 (defun c-clear-<-pair-props-if-match-after (lim &optional pos)
5451 ;; POS (default point) is at a < character. If it is both marked
5452 ;; with open/close paren syntax-table property, and has a matching >
5453 ;; (also marked) which is after LIM, remove the property both from
5454 ;; the current > and its partner. Return t when this happens, nil
5460 (when (equal (c-get-char-property (point) 'syntax-table)
5461 c-<-as-paren-syntax)
5462 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5463 (c-go-list-forward))
5464 (when (and (>= (point) lim)
5465 (equal (c-get-char-property (1- (point)) 'syntax-table)
5466 c->-as-paren-syntax)) ; should always be true.
5467 (c-unmark-<->-as-paren (1- (point)))
5468 (c-unmark-<->-as-paren pos))
5471 (defun c-clear->-pair-props-if-match-before (lim &optional pos)
5472 ;; POS (default point) is at a > character. If it is both marked
5473 ;; with open/close paren syntax-table property, and has a matching <
5474 ;; (also marked) which is before LIM, remove the property both from
5475 ;; the current < and its partner. Return t when this happens, nil
5481 (when (equal (c-get-char-property (point) 'syntax-table)
5482 c->-as-paren-syntax)
5483 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5484 (c-go-up-list-backward))
5485 (when (and (<= (point) lim)
5486 (equal (c-get-char-property (point) 'syntax-table)
5487 c-<-as-paren-syntax)) ; should always be true.
5488 (c-unmark-<->-as-paren (point))
5489 (c-unmark-<->-as-paren pos))
5492 ;; Set by c-common-init in cc-mode.el.
5496 (defun c-before-change-check-<>-operators (beg end)
5497 ;; Unmark certain pairs of "< .... >" which are currently marked as
5498 ;; template/generic delimiters. (This marking is via syntax-table
5499 ;; text properties).
5501 ;; These pairs are those which are in the current "statement" (i.e.,
5502 ;; the region between the {, }, or ; before BEG and the one after
5503 ;; END), and which enclose any part of the interval (BEG END).
5505 ;; Note that in C++ (?and Java), template/generic parens cannot
5506 ;; enclose a brace or semicolon, so we use these as bounds on the
5507 ;; region we must work on.
5509 ;; This function is called from before-change-functions (via
5510 ;; c-get-state-before-change-functions). Thus the buffer is widened,
5511 ;; and point is undefined, both at entry and exit.
5513 ;; FIXME!!! This routine ignores the possibility of macros entirely.
5516 (let ((beg-lit-limits (progn (goto-char beg) (c-literal-limits)))
5517 (end-lit-limits (progn (goto-char end) (c-literal-limits)))
5518 new-beg new-end need-new-beg need-new-end)
5519 ;; Locate the barrier before the changed region
5520 (goto-char (if beg-lit-limits (car beg-lit-limits) beg))
5521 (c-syntactic-skip-backward "^;{}" (c-determine-limit 512))
5522 (setq new-beg (point))
5524 ;; Remove the syntax-table properties from each pertinent <...> pair.
5525 ;; Firsly, the ones with the < before beg and > after beg.
5526 (while (c-search-forward-char-property 'category 'c-<-as-paren-syntax beg)
5527 (if (c-clear-<-pair-props-if-match-after beg (1- (point)))
5528 (setq need-new-beg t)))
5530 ;; Locate the barrier after END.
5531 (goto-char (if end-lit-limits (cdr end-lit-limits) end))
5532 (c-syntactic-re-search-forward "[;{}]" (c-determine-+ve-limit 512) 'end)
5533 (setq new-end (point))
5535 ;; Remove syntax-table properties from the remaining pertinent <...>
5536 ;; pairs, those with a > after end and < before end.
5537 (while (c-search-backward-char-property 'category 'c->-as-paren-syntax end)
5538 (if (c-clear->-pair-props-if-match-before end)
5539 (setq need-new-end t)))
5541 ;; Extend the fontification region, if needed.
5544 (c-forward-syntactic-ws)
5545 (and (< (point) c-new-BEG) (setq c-new-BEG (point))))
5548 (and (> new-end c-new-END) (setq c-new-END new-end))))))
5550 (defun c-after-change-check-<>-operators (beg end)
5551 ;; This is called from `after-change-functions' when
5552 ;; c-recognize-<>-arglists' is set. It ensures that no "<" or ">"
5553 ;; chars with paren syntax become part of another operator like "<<"
5556 ;; This function might do hidden buffer changes.
5560 (when (or (looking-at "[<>]")
5561 (< (skip-chars-backward "<>") 0))
5564 (c-beginning-of-current-token)
5565 (when (and (< (point) beg)
5566 (looking-at c-<>-multichar-token-regexp)
5567 (< beg (setq beg (match-end 0))))
5568 (while (progn (skip-chars-forward "^<>" beg)
5570 (c-clear-<>-pair-props)
5575 (when (or (looking-at "[<>]")
5576 (< (skip-chars-backward "<>") 0))
5579 (c-beginning-of-current-token)
5580 (when (and (< (point) end)
5581 (looking-at c-<>-multichar-token-regexp)
5582 (< end (setq end (match-end 0))))
5583 (while (progn (skip-chars-forward "^<>" end)
5585 (c-clear-<>-pair-props)
5586 (forward-char)))))))
5590 ;; Handling of small scale constructs like types and names.
5592 ;; Dynamically bound variable that instructs `c-forward-type' to also
5593 ;; treat possible types (i.e. those that it normally returns 'maybe or
5594 ;; 'found for) as actual types (and always return 'found for them).
5595 ;; This means that it records them in `c-record-type-identifiers' if
5596 ;; that is set, and that it adds them to `c-found-types'.
5597 (defvar c-promote-possible-types nil)
5599 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5600 ;; mark up successfully parsed arglists with paren syntax properties on
5601 ;; the surrounding angle brackets and with `c-<>-arg-sep' in the
5602 ;; `c-type' property of each argument separating comma.
5604 ;; Setting this variable also makes `c-forward-<>-arglist' recurse into
5605 ;; all arglists for side effects (i.e. recording types), otherwise it
5606 ;; exploits any existing paren syntax properties to quickly jump to the
5607 ;; end of already parsed arglists.
5609 ;; Marking up the arglists is not the default since doing that correctly
5610 ;; depends on a proper value for `c-restricted-<>-arglists'.
5611 (defvar c-parse-and-markup-<>-arglists nil)
5613 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5614 ;; not accept arglists that contain binary operators.
5616 ;; This is primarily used to handle C++ template arglists. C++
5617 ;; disambiguates them by checking whether the preceding name is a
5618 ;; template or not. We can't do that, so we assume it is a template
5619 ;; if it can be parsed as one. That usually works well since
5620 ;; comparison expressions on the forms "a < b > c" or "a < b, c > d"
5621 ;; in almost all cases would be pointless.
5623 ;; However, in function arglists, e.g. in "foo (a < b, c > d)", we
5624 ;; should let the comma separate the function arguments instead. And
5625 ;; in a context where the value of the expression is taken, e.g. in
5626 ;; "if (a < b || c > d)", it's probably not a template.
5627 (defvar c-restricted-<>-arglists nil)
5629 ;; Dynamically bound variables that instructs
5630 ;; `c-forward-keyword-clause', `c-forward-<>-arglist',
5631 ;; `c-forward-name', `c-forward-type', `c-forward-decl-or-cast-1', and
5632 ;; `c-forward-label' to record the ranges of all the type and
5633 ;; reference identifiers they encounter. They will build lists on
5634 ;; these variables where each element is a cons of the buffer
5635 ;; positions surrounding each identifier. This recording is only
5636 ;; activated when `c-record-type-identifiers' is non-nil.
5638 ;; All known types that can't be identifiers are recorded, and also
5639 ;; other possible types if `c-promote-possible-types' is set.
5640 ;; Recording is however disabled inside angle bracket arglists that
5641 ;; are encountered inside names and other angle bracket arglists.
5642 ;; Such occurrences are taken care of by `c-font-lock-<>-arglists'
5645 ;; Only the names in C++ template style references (e.g. "tmpl" in
5646 ;; "tmpl<a,b>::foo") are recorded as references, other references
5647 ;; aren't handled here.
5649 ;; `c-forward-label' records the label identifier(s) on
5650 ;; `c-record-ref-identifiers'.
5651 (defvar c-record-type-identifiers nil)
5652 (defvar c-record-ref-identifiers nil)
5654 ;; This variable will receive a cons cell of the range of the last
5655 ;; single identifier symbol stepped over by `c-forward-name' if it's
5656 ;; successful. This is the range that should be put on one of the
5657 ;; record lists above by the caller. It's assigned nil if there's no
5658 ;; such symbol in the name.
5659 (defvar c-last-identifier-range nil)
5661 (defmacro c-record-type-id (range)
5662 (if (eq (car-safe range) 'cons)
5664 `(setq c-record-type-identifiers
5665 (cons ,range c-record-type-identifiers))
5666 `(let ((range ,range))
5668 (setq c-record-type-identifiers
5669 (cons range c-record-type-identifiers))))))
5671 (defmacro c-record-ref-id (range)
5672 (if (eq (car-safe range) 'cons)
5674 `(setq c-record-ref-identifiers
5675 (cons ,range c-record-ref-identifiers))
5676 `(let ((range ,range))
5678 (setq c-record-ref-identifiers
5679 (cons range c-record-ref-identifiers))))))
5681 ;; Dynamically bound variable that instructs `c-forward-type' to
5682 ;; record the ranges of types that only are found. Behaves otherwise
5683 ;; like `c-record-type-identifiers'.
5684 (defvar c-record-found-types nil)
5686 (defmacro c-forward-keyword-prefixed-id (type)
5687 ;; Used internally in `c-forward-keyword-clause' to move forward
5688 ;; over a type (if TYPE is 'type) or a name (otherwise) which
5689 ;; possibly is prefixed by keywords and their associated clauses.
5690 ;; Try with a type/name first to not trip up on those that begin
5691 ;; with a keyword. Return t if a known or found type is moved
5692 ;; over. The point is clobbered if nil is returned. If range
5693 ;; recording is enabled, the identifier is recorded on as a type
5694 ;; if TYPE is 'type or as a reference if TYPE is 'ref.
5696 ;; This macro might do hidden buffer changes.
5698 (while (if (setq res ,(if (eq type 'type)
5702 (and (looking-at c-keywords-regexp)
5703 (c-forward-keyword-clause 1))))
5704 (when (memq res '(t known found prefix))
5705 ,(when (eq type 'ref)
5706 `(when c-record-type-identifiers
5707 (c-record-ref-id c-last-identifier-range)))
5710 (defmacro c-forward-id-comma-list (type update-safe-pos)
5711 ;; Used internally in `c-forward-keyword-clause' to move forward
5712 ;; over a comma separated list of types or names using
5713 ;; `c-forward-keyword-prefixed-id'.
5715 ;; This macro might do hidden buffer changes.
5717 ,(when update-safe-pos
5718 `(setq safe-pos (point)))
5719 (eq (char-after) ?,))
5722 (c-forward-syntactic-ws)
5723 (c-forward-keyword-prefixed-id ,type)))))
5725 (defun c-forward-keyword-clause (match)
5726 ;; Submatch MATCH in the current match data is assumed to surround a
5727 ;; token. If it's a keyword, move over it and any immediately
5728 ;; following clauses associated with it, stopping at the start of
5729 ;; the next token. t is returned in that case, otherwise the point
5730 ;; stays and nil is returned. The kind of clauses that are
5731 ;; recognized are those specified by `c-type-list-kwds',
5732 ;; `c-ref-list-kwds', `c-colon-type-list-kwds',
5733 ;; `c-paren-nontype-kwds', `c-paren-type-kwds', `c-<>-type-kwds',
5734 ;; and `c-<>-arglist-kwds'.
5736 ;; This function records identifier ranges on
5737 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5738 ;; `c-record-type-identifiers' is non-nil.
5740 ;; Note that for `c-colon-type-list-kwds', which doesn't necessary
5741 ;; apply directly after the keyword, the type list is moved over
5742 ;; only when there is no unaccounted token before it (i.e. a token
5743 ;; that isn't moved over due to some other keyword list). The
5744 ;; identifier ranges in the list are still recorded if that should
5747 ;; This function might do hidden buffer changes.
5749 (let ((kwd-sym (c-keyword-sym (match-string match))) safe-pos pos
5750 ;; The call to `c-forward-<>-arglist' below is made after
5751 ;; `c-<>-sexp-kwds' keywords, so we're certain they actually
5752 ;; are angle bracket arglists and `c-restricted-<>-arglists'
5753 ;; should therefore be nil.
5754 (c-parse-and-markup-<>-arglists t)
5755 c-restricted-<>-arglists)
5758 (goto-char (match-end match))
5759 (c-forward-syntactic-ws)
5760 (setq safe-pos (point))
5763 ((and (c-keyword-member kwd-sym 'c-type-list-kwds)
5764 (c-forward-keyword-prefixed-id type))
5765 ;; There's a type directly after a keyword in `c-type-list-kwds'.
5766 (c-forward-id-comma-list type t))
5768 ((and (c-keyword-member kwd-sym 'c-ref-list-kwds)
5769 (c-forward-keyword-prefixed-id ref))
5770 ;; There's a name directly after a keyword in `c-ref-list-kwds'.
5771 (c-forward-id-comma-list ref t))
5773 ((and (c-keyword-member kwd-sym 'c-paren-any-kwds)
5774 (eq (char-after) ?\())
5775 ;; There's an open paren after a keyword in `c-paren-any-kwds'.
5778 (when (and (setq pos (c-up-list-forward))
5779 (eq (char-before pos) ?\)))
5780 (when (and c-record-type-identifiers
5781 (c-keyword-member kwd-sym 'c-paren-type-kwds))
5782 ;; Use `c-forward-type' on every identifier we can find
5783 ;; inside the paren, to record the types.
5784 (while (c-syntactic-re-search-forward c-symbol-start pos t)
5785 (goto-char (match-beginning 0))
5786 (unless (c-forward-type)
5787 (looking-at c-symbol-key) ; Always matches.
5788 (goto-char (match-end 0)))))
5791 (c-forward-syntactic-ws)
5792 (setq safe-pos (point))))
5794 ((and (c-keyword-member kwd-sym 'c-<>-sexp-kwds)
5795 (eq (char-after) ?<)
5796 (c-forward-<>-arglist (c-keyword-member kwd-sym 'c-<>-type-kwds)))
5797 (c-forward-syntactic-ws)
5798 (setq safe-pos (point)))
5800 ((and (c-keyword-member kwd-sym 'c-nonsymbol-sexp-kwds)
5801 (not (looking-at c-symbol-start))
5802 (c-safe (c-forward-sexp) t))
5803 (c-forward-syntactic-ws)
5804 (setq safe-pos (point))))
5806 (when (c-keyword-member kwd-sym 'c-colon-type-list-kwds)
5807 (if (eq (char-after) ?:)
5808 ;; If we are at the colon already, we move over the type
5812 (c-forward-syntactic-ws)
5813 (when (c-forward-keyword-prefixed-id type)
5814 (c-forward-id-comma-list type t)))
5815 ;; Not at the colon, so stop here. But the identifier
5816 ;; ranges in the type list later on should still be
5818 (and c-record-type-identifiers
5820 ;; If a keyword matched both one of the types above and
5821 ;; this one, we match `c-colon-type-list-re' after the
5822 ;; clause matched above.
5823 (goto-char safe-pos)
5824 (looking-at c-colon-type-list-re))
5826 (goto-char (match-end 0))
5827 (c-forward-syntactic-ws)
5828 (c-forward-keyword-prefixed-id type))
5829 ;; There's a type after the `c-colon-type-list-re' match
5830 ;; after a keyword in `c-colon-type-list-kwds'.
5831 (c-forward-id-comma-list type nil))))
5833 (goto-char safe-pos)
5836 ;; cc-mode requires cc-fonts.
5837 (declare-function c-fontify-recorded-types-and-refs "cc-fonts" ())
5839 (defun c-forward-<>-arglist (all-types)
5840 ;; The point is assumed to be at a "<". Try to treat it as the open
5841 ;; paren of an angle bracket arglist and move forward to the
5842 ;; corresponding ">". If successful, the point is left after the
5843 ;; ">" and t is returned, otherwise the point isn't moved and nil is
5844 ;; returned. If ALL-TYPES is t then all encountered arguments in
5845 ;; the arglist that might be types are treated as found types.
5847 ;; The variable `c-parse-and-markup-<>-arglists' controls how this
5848 ;; function handles text properties on the angle brackets and argument
5849 ;; separating commas.
5851 ;; `c-restricted-<>-arglists' controls how lenient the template
5852 ;; arglist recognition should be.
5854 ;; This function records identifier ranges on
5855 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5856 ;; `c-record-type-identifiers' is non-nil.
5858 ;; This function might do hidden buffer changes.
5860 (let ((start (point))
5861 ;; If `c-record-type-identifiers' is set then activate
5862 ;; recording of any found types that constitute an argument in
5864 (c-record-found-types (if c-record-type-identifiers t)))
5865 (if (catch 'angle-bracket-arglist-escape
5866 (setq c-record-found-types
5867 (c-forward-<>-arglist-recur all-types)))
5869 (when (consp c-record-found-types)
5870 (setq c-record-type-identifiers
5871 ;; `nconc' doesn't mind that the tail of
5872 ;; `c-record-found-types' is t.
5873 (nconc c-record-found-types c-record-type-identifiers)))
5874 (if (c-major-mode-is 'java-mode) (c-fontify-recorded-types-and-refs))
5880 (defun c-forward-<>-arglist-recur (all-types)
5881 ;; Recursive part of `c-forward-<>-arglist'.
5883 ;; This function might do hidden buffer changes.
5884 (let ((start (point)) res pos tmp
5885 ;; Cover this so that any recorded found type ranges are
5886 ;; automatically lost if it turns out to not be an angle
5887 ;; bracket arglist. It's propagated through the return value
5888 ;; on successful completion.
5889 (c-record-found-types c-record-found-types)
5890 ;; List that collects the positions after the argument
5891 ;; separating ',' in the arglist.
5893 ;; If the '<' has paren open syntax then we've marked it as an angle
5894 ;; bracket arglist before, so skip to the end.
5895 (if (and (not c-parse-and-markup-<>-arglists)
5896 (c-get-char-property (point) 'syntax-table))
5900 (if (and (c-go-up-list-forward)
5901 (eq (char-before) ?>))
5903 ;; Got unmatched paren angle brackets. We don't clear the paren
5904 ;; syntax properties and retry, on the basis that it's very
5905 ;; unlikely that paren angle brackets become operators by code
5906 ;; manipulation. It's far more likely that it doesn't match due
5907 ;; to narrowing or some temporary change.
5911 (forward-char) ; Forward over the opening '<'.
5913 (unless (looking-at c-<-op-cont-regexp)
5914 ;; go forward one non-alphanumeric character (group) per iteration of
5918 (c-forward-syntactic-ws)
5919 (let ((orig-record-found-types c-record-found-types))
5920 (when (or (and c-record-type-identifiers all-types)
5921 (c-major-mode-is 'java-mode))
5922 ;; All encountered identifiers are types, so set the
5923 ;; promote flag and parse the type.
5925 (c-forward-syntactic-ws)
5926 (if (looking-at "\\?")
5928 (when (looking-at c-identifier-start)
5929 (let ((c-promote-possible-types t)
5930 (c-record-found-types t))
5933 (c-forward-syntactic-ws)
5935 (when (or (looking-at "extends")
5936 (looking-at "super"))
5938 (c-forward-syntactic-ws)
5939 (let ((c-promote-possible-types t)
5940 (c-record-found-types t))
5942 (c-forward-syntactic-ws))))))
5944 (setq pos (point)) ; e.g. first token inside the '<'
5946 ;; Note: These regexps exploit the match order in \| so
5947 ;; that "<>" is matched by "<" rather than "[^>:-]>".
5948 (c-syntactic-re-search-forward
5949 ;; Stop on ',', '|', '&', '+' and '-' to catch
5950 ;; common binary operators that could be between
5951 ;; two comparison expressions "a<b" and "c>d".
5952 "[<;{},|+&-]\\|[>)]"
5956 ((eq (char-before) ?>)
5957 ;; Either an operator starting with '>' or the end of
5958 ;; the angle bracket arglist.
5960 (if (looking-at c->-op-without->-cont-regexp)
5962 (goto-char (match-end 0))
5963 t) ; Continue the loop.
5965 ;; The angle bracket arglist is finished.
5966 (when c-parse-and-markup-<>-arglists
5967 (while arg-start-pos
5968 (c-put-c-type-property (1- (car arg-start-pos))
5970 (setq arg-start-pos (cdr arg-start-pos)))
5971 (c-mark-<-as-paren start)
5972 (c-mark->-as-paren (1- (point))))
5974 nil)) ; Exit the loop.
5976 ((eq (char-before) ?<)
5977 ;; Either an operator starting with '<' or a nested arglist.
5979 (let (id-start id-end subres keyword-match)
5981 ;; The '<' begins a multi-char operator.
5982 ((looking-at c-<-op-cont-regexp)
5983 (setq tmp (match-end 0))
5984 (goto-char (match-end 0)))
5985 ;; We're at a nested <.....>
5988 (backward-char) ; to the '<'
5991 ;; There's always an identifier before an angle
5992 ;; bracket arglist, or a keyword in `c-<>-type-kwds'
5993 ;; or `c-<>-arglist-kwds'.
5994 (c-backward-syntactic-ws)
5995 (setq id-end (point))
5996 (c-simple-skip-symbol-backward)
5997 (when (or (setq keyword-match
5998 (looking-at c-opt-<>-sexp-key))
5999 (not (looking-at c-keywords-regexp)))
6000 (setq id-start (point))))
6002 (let ((c-promote-possible-types t)
6003 (c-record-found-types t))
6004 (c-forward-<>-arglist-recur
6007 (c-keyword-sym (match-string 1))
6008 'c-<>-type-kwds)))))))
6009 ;; It was an angle bracket arglist.
6010 (setq c-record-found-types subres)
6012 ;; Record the identifier before the template as a type
6013 ;; or reference depending on whether the arglist is last
6014 ;; in a qualified identifier.
6015 (when (and c-record-type-identifiers
6016 (not keyword-match))
6017 (if (and c-opt-identifier-concat-key
6019 (c-forward-syntactic-ws)
6020 (looking-at c-opt-identifier-concat-key)))
6021 (c-record-ref-id (cons id-start id-end))
6022 (c-record-type-id (cons id-start id-end)))))
6024 ;; At a "less than" operator.
6028 t) ; carry on looping.
6030 ((and (not c-restricted-<>-arglists)
6031 (or (and (eq (char-before) ?&)
6032 (not (eq (char-after) ?&)))
6033 (eq (char-before) ?,)))
6034 ;; Just another argument. Record the position. The
6035 ;; type check stuff that made us stop at it is at
6036 ;; the top of the loop.
6037 (setq arg-start-pos (cons (point) arg-start-pos)))
6040 ;; Got a character that can't be in an angle bracket
6041 ;; arglist argument. Abort using `throw', since
6042 ;; it's useless to try to find a surrounding arglist
6044 (throw 'angle-bracket-arglist-escape nil))))))
6046 (or c-record-found-types t)))))
6048 (defun c-backward-<>-arglist (all-types &optional limit)
6049 ;; The point is assumed to be directly after a ">". Try to treat it
6050 ;; as the close paren of an angle bracket arglist and move back to
6051 ;; the corresponding "<". If successful, the point is left at
6052 ;; the "<" and t is returned, otherwise the point isn't moved and
6053 ;; nil is returned. ALL-TYPES is passed on to
6054 ;; `c-forward-<>-arglist'.
6056 ;; If the optional LIMIT is given, it bounds the backward search.
6057 ;; It's then assumed to be at a syntactically relevant position.
6059 ;; This is a wrapper around `c-forward-<>-arglist'. See that
6060 ;; function for more details.
6062 (let ((start (point)))
6064 (if (and (not c-parse-and-markup-<>-arglists)
6065 (c-get-char-property (point) 'syntax-table))
6067 (if (and (c-go-up-list-backward)
6068 (eq (char-after) ?<))
6070 ;; See corresponding note in `c-forward-<>-arglist'.
6075 (c-syntactic-skip-backward "^<;{}" limit t)
6078 (if (eq (char-before) ?<)
6080 ;; Stopped at bob or a char that isn't allowed in an
6081 ;; arglist, so we've failed.
6086 (progn (c-beginning-of-current-token)
6088 ;; If we moved then the "<" was part of some
6089 ;; multicharacter token.
6093 (let ((beg-pos (point)))
6094 (if (c-forward-<>-arglist all-types)
6095 (cond ((= (point) start)
6096 ;; Matched the arglist. Break the while.
6100 ;; We started from a non-paren ">" inside an
6105 ;; Matched a shorter arglist. Can be a nested
6106 ;; one so continue looking.
6111 (/= (point) start))))
6113 (defun c-forward-name ()
6114 ;; Move forward over a complete name if at the beginning of one,
6115 ;; stopping at the next following token. A keyword, as such,
6116 ;; doesn't count as a name. If the point is not at something that
6117 ;; is recognized as a name then it stays put.
6119 ;; A name could be something as simple as "foo" in C or something as
6120 ;; complex as "X<Y<class A<int>::B, BIT_MAX >> b>, ::operator<> ::
6121 ;; Z<(a>b)> :: operator const X<&foo>::T Q::G<unsigned short
6122 ;; int>::*volatile const" in C++ (this function is actually little
6123 ;; more than a `looking-at' call in all modes except those that,
6124 ;; like C++, have `c-recognize-<>-arglists' set).
6127 ;; o - nil if no name is found;
6128 ;; o - 'template if it's an identifier ending with an angle bracket
6130 ;; o - 'operator of it's an operator identifier;
6131 ;; o - t if it's some other kind of name.
6133 ;; This function records identifier ranges on
6134 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6135 ;; `c-record-type-identifiers' is non-nil.
6137 ;; This function might do hidden buffer changes.
6139 (let ((pos (point)) (start (point)) res id-start id-end
6140 ;; Turn off `c-promote-possible-types' here since we might
6141 ;; call `c-forward-<>-arglist' and we don't want it to promote
6142 ;; every suspect thing in the arglist to a type. We're
6143 ;; typically called from `c-forward-type' in this case, and
6144 ;; the caller only wants the top level type that it finds to
6146 c-promote-possible-types)
6149 (looking-at c-identifier-key)
6152 ;; Check for keyword. We go to the last symbol in
6153 ;; `c-identifier-key' first.
6154 (goto-char (setq id-end (match-end 0)))
6155 (c-simple-skip-symbol-backward)
6156 (setq id-start (point))
6158 (if (looking-at c-keywords-regexp)
6159 (when (and (c-major-mode-is 'c++-mode)
6161 (cc-eval-when-compile
6162 (concat "\\(operator\\|\\(template\\)\\)"
6163 "\\(" (c-lang-const c-nonsymbol-key c++)
6165 (if (match-beginning 2)
6166 ;; "template" is only valid inside an
6167 ;; identifier if preceded by "::".
6169 (c-backward-syntactic-ws)
6170 (and (c-safe (backward-char 2) t)
6174 ;; Handle a C++ operator or template identifier.
6176 (c-forward-syntactic-ws)
6177 (cond ((eq (char-before id-end) ?e)
6178 ;; Got "... ::template".
6179 (let ((subres (c-forward-name)))
6184 ((looking-at c-identifier-start)
6185 ;; Got a cast operator.
6186 (when (c-forward-type)
6189 ;; Now we should match a sequence of either
6190 ;; '*', '&' or a name followed by ":: *",
6191 ;; where each can be followed by a sequence
6192 ;; of `c-opt-type-modifier-key'.
6193 (while (cond ((looking-at "[*&]")
6194 (goto-char (match-end 0))
6196 ((looking-at c-identifier-start)
6197 (and (c-forward-name)
6200 (goto-char (match-end 0))
6201 (c-forward-syntactic-ws)
6202 (eq (char-after) ?*))
6207 (c-forward-syntactic-ws)
6209 (looking-at c-opt-type-modifier-key))
6210 (goto-char (match-end 1))))))
6212 ((looking-at c-overloadable-operators-regexp)
6213 ;; Got some other operator.
6214 (setq c-last-identifier-range
6215 (cons (point) (match-end 0)))
6216 (goto-char (match-end 0))
6217 (c-forward-syntactic-ws)
6223 ;; `id-start' is equal to `id-end' if we've jumped over
6224 ;; an identifier that doesn't end with a symbol token.
6225 ;; That can occur e.g. for Java import directives on the
6226 ;; form "foo.bar.*".
6227 (when (and id-start (/= id-start id-end))
6228 (setq c-last-identifier-range
6229 (cons id-start id-end)))
6231 (c-forward-syntactic-ws)
6237 (when (or c-opt-identifier-concat-key
6238 c-recognize-<>-arglists)
6241 ((and c-opt-identifier-concat-key
6242 (looking-at c-opt-identifier-concat-key))
6243 ;; Got a concatenated identifier. This handles the
6244 ;; cases with tricky syntactic whitespace that aren't
6245 ;; covered in `c-identifier-key'.
6246 (goto-char (match-end 0))
6247 (c-forward-syntactic-ws)
6250 ((and c-recognize-<>-arglists
6251 (eq (char-after) ?<))
6252 ;; Maybe an angle bracket arglist.
6253 (when (let ((c-record-type-identifiers t)
6254 (c-record-found-types t))
6255 (c-forward-<>-arglist nil))
6257 (c-add-type start (1+ pos))
6258 (c-forward-syntactic-ws)
6260 c-last-identifier-range nil)
6262 (if (and c-opt-identifier-concat-key
6263 (looking-at c-opt-identifier-concat-key))
6265 ;; Continue if there's an identifier concatenation
6266 ;; operator after the template argument.
6268 (when (and c-record-type-identifiers id-start)
6269 (c-record-ref-id (cons id-start id-end)))
6271 (c-forward-syntactic-ws)
6274 (when (and c-record-type-identifiers id-start)
6275 (c-record-type-id (cons id-start id-end)))
6276 (setq res 'template)
6283 (defun c-forward-type (&optional brace-block-too)
6284 ;; Move forward over a type spec if at the beginning of one,
6285 ;; stopping at the next following token. The keyword "typedef"
6286 ;; isn't part of a type spec here.
6288 ;; BRACE-BLOCK-TOO, when non-nil, means move over the brace block in
6289 ;; constructs like "struct foo {...} bar ;" or "struct {...} bar;".
6290 ;; The current (2009-03-10) intention is to convert all uses of
6291 ;; `c-forward-type' to call with this parameter set, then to
6295 ;; o - t if it's a known type that can't be a name or other
6297 ;; o - 'known if it's an otherwise known type (according to
6298 ;; `*-font-lock-extra-types');
6299 ;; o - 'prefix if it's a known prefix of a type;
6300 ;; o - 'found if it's a type that matches one in `c-found-types';
6301 ;; o - 'maybe if it's an identifier that might be a type;
6302 ;; o - 'decltype if it's a decltype(variable) declaration; - or
6303 ;; o - nil if it can't be a type (the point isn't moved then).
6305 ;; The point is assumed to be at the beginning of a token.
6307 ;; Note that this function doesn't skip past the brace definition
6308 ;; that might be considered part of the type, e.g.
6309 ;; "enum {a, b, c} foo".
6311 ;; This function records identifier ranges on
6312 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6313 ;; `c-record-type-identifiers' is non-nil.
6315 ;; This function might do hidden buffer changes.
6316 (when (and c-recognize-<>-arglists
6318 (c-forward-<>-arglist t)
6319 (c-forward-syntactic-ws))
6321 (let ((start (point)) pos res name-res id-start id-end id-range)
6323 ;; Skip leading type modifiers. If any are found we know it's a
6324 ;; prefix of a type.
6325 (when c-opt-type-modifier-key ; e.g. "const" "volatile", but NOT "typedef"
6326 (while (looking-at c-opt-type-modifier-key)
6327 (goto-char (match-end 1))
6328 (c-forward-syntactic-ws)
6329 (setq res 'prefix)))
6332 ((looking-at c-typeof-key) ; e.g. C++'s "decltype".
6333 (goto-char (match-end 1))
6334 (c-forward-syntactic-ws)
6335 (setq res (and (eq (char-after) ?\()
6336 (c-safe (c-forward-sexp))
6339 (c-forward-syntactic-ws)
6342 ((looking-at c-type-prefix-key) ; e.g. "struct", "class", but NOT
6344 (goto-char (match-end 1))
6345 (c-forward-syntactic-ws)
6348 (setq name-res (c-forward-name))
6349 (setq res (not (null name-res)))
6350 (when (eq name-res t)
6351 ;; In many languages the name can be used without the
6352 ;; prefix, so we add it to `c-found-types'.
6353 (c-add-type pos (point))
6354 (when (and c-record-type-identifiers
6355 c-last-identifier-range)
6356 (c-record-type-id c-last-identifier-range)))
6357 (when (and brace-block-too
6359 (eq (char-after) ?\{)
6362 (progn (c-forward-sexp)
6363 (c-forward-syntactic-ws)
6364 (setq pos (point))))))
6367 (unless res (goto-char start))) ; invalid syntax
6371 (if (looking-at c-identifier-start)
6373 (setq id-start (point)
6374 name-res (c-forward-name))
6376 (setq id-end (point)
6377 id-range c-last-identifier-range))))
6378 (and (cond ((looking-at c-primitive-type-key)
6380 ((c-with-syntax-table c-identifier-syntax-table
6381 (looking-at c-known-type-key))
6386 (goto-char (match-end 1))
6387 (c-forward-syntactic-ws)
6388 (setq pos (point))))
6391 ;; Looking at a primitive or known type identifier. We've
6392 ;; checked for a name first so that we don't go here if the
6393 ;; known type match only is a prefix of another name.
6395 (setq id-end (match-end 1))
6397 (when (and c-record-type-identifiers
6398 (or c-promote-possible-types (eq res t)))
6399 (c-record-type-id (cons (match-beginning 1) (match-end 1))))
6401 (if (and c-opt-type-component-key
6403 (looking-at c-opt-type-component-key)))
6404 ;; There might be more keywords for the type.
6406 (c-forward-keyword-clause 1)
6408 (setq safe-pos (point))
6409 (looking-at c-opt-type-component-key))
6410 (when (and c-record-type-identifiers
6411 (looking-at c-primitive-type-key))
6412 (c-record-type-id (cons (match-beginning 1)
6414 (c-forward-keyword-clause 1))
6415 (if (looking-at c-primitive-type-key)
6417 (when c-record-type-identifiers
6418 (c-record-type-id (cons (match-beginning 1)
6420 (c-forward-keyword-clause 1)
6422 (goto-char safe-pos)
6423 (setq res 'prefix)))
6424 (unless (save-match-data (c-forward-keyword-clause 1))
6427 (goto-char (match-end 1))
6428 (c-forward-syntactic-ws)))))
6431 (cond ((eq name-res t)
6432 ;; A normal identifier.
6434 (if (or res c-promote-possible-types)
6436 (c-add-type id-start id-end)
6437 (when (and c-record-type-identifiers id-range)
6438 (c-record-type-id id-range))
6441 (setq res (if (c-check-type id-start id-end)
6442 ;; It's an identifier that has been used as
6443 ;; a type somewhere else.
6445 ;; It's an identifier that might be a type.
6447 ((eq name-res 'template)
6448 ;; A template is a type.
6452 ;; Otherwise it's an operator identifier, which is not a type.
6457 ;; Skip trailing type modifiers. If any are found we know it's
6459 (when c-opt-type-modifier-key
6460 (while (looking-at c-opt-type-modifier-key) ; e.g. "const", "volatile"
6461 (goto-char (match-end 1))
6462 (c-forward-syntactic-ws)
6464 ;; Step over any type suffix operator. Do not let the existence
6465 ;; of these alter the classification of the found type, since
6466 ;; these operators typically are allowed in normal expressions
6468 (when c-opt-type-suffix-key ; e.g. "..."
6469 (while (looking-at c-opt-type-suffix-key)
6470 (goto-char (match-end 1))
6471 (c-forward-syntactic-ws)))
6473 (when c-opt-type-concat-key ; Only/mainly for pike.
6474 ;; Look for a trailing operator that concatenates the type
6475 ;; with a following one, and if so step past that one through
6476 ;; a recursive call. Note that we don't record concatenated
6477 ;; types in `c-found-types' - it's the component types that
6478 ;; are recorded when appropriate.
6480 (let* ((c-promote-possible-types (or (memq res '(t known))
6481 c-promote-possible-types))
6482 ;; If we can't promote then set `c-record-found-types' so that
6483 ;; we can merge in the types from the second part afterwards if
6484 ;; it turns out to be a known type there.
6485 (c-record-found-types (and c-record-type-identifiers
6486 (not c-promote-possible-types)))
6488 (if (and (looking-at c-opt-type-concat-key)
6491 (goto-char (match-end 1))
6492 (c-forward-syntactic-ws)
6493 (setq subres (c-forward-type))))
6496 ;; If either operand certainly is a type then both are, but we
6497 ;; don't let the existence of the operator itself promote two
6498 ;; uncertain types to a certain one.
6501 (unless (eq name-res 'template)
6502 (c-add-type id-start id-end))
6503 (when (and c-record-type-identifiers id-range)
6504 (c-record-type-id id-range))
6515 (when (and (eq res t)
6516 (consp c-record-found-types))
6517 ;; Merge in the ranges of any types found by the second
6518 ;; `c-forward-type'.
6519 (setq c-record-type-identifiers
6520 ;; `nconc' doesn't mind that the tail of
6521 ;; `c-record-found-types' is t.
6522 (nconc c-record-found-types
6523 c-record-type-identifiers))))
6527 (when (and c-record-found-types (memq res '(known found)) id-range)
6528 (setq c-record-found-types
6529 (cons id-range c-record-found-types))))
6531 ;;(message "c-forward-type %s -> %s: %s" start (point) res)
6535 (defun c-forward-annotation ()
6536 ;; Used for Java code only at the moment. Assumes point is on the
6537 ;; @, moves forward an annotation. returns nil if there is no
6538 ;; annotation at point.
6539 (and (looking-at "@")
6540 (progn (forward-char) t)
6542 (progn (c-forward-syntactic-ws) t)
6543 (if (looking-at "(")
6547 (defmacro c-pull-open-brace (ps)
6548 ;; Pull the next open brace from PS (which has the form of paren-state),
6549 ;; skipping over any brace pairs. Returns NIL when PS is exhausted.
6551 (while (consp (car ,ps))
6552 (setq ,ps (cdr ,ps)))
6554 (setq ,ps (cdr ,ps)))))
6556 (defun c-back-over-member-initializers ()
6557 ;; Test whether we are in a C++ member initializer list, and if so, go back
6558 ;; to the introducing ":", returning the position of the opening paren of
6559 ;; the function's arglist. Otherwise return nil, leaving point unchanged.
6560 (let ((here (point))
6561 (paren-state (c-parse-state))
6566 (if (not (c-at-toplevel-p))
6568 (while (not (c-at-toplevel-p))
6569 (goto-char (c-pull-open-brace paren-state)))
6570 (c-backward-syntactic-ws)
6571 (when (not (c-simple-skip-symbol-backward))
6573 (c-backward-syntactic-ws))
6574 (c-backward-syntactic-ws)
6575 (when (memq (char-before) '(?\) ?}))
6576 (when (not (c-go-list-backward))
6578 (c-backward-syntactic-ws))
6579 (when (c-simple-skip-symbol-backward)
6580 (c-backward-syntactic-ws)))
6582 (while (eq (char-before) ?,)
6584 (c-backward-syntactic-ws)
6586 (when (not (memq (char-before) '(?\) ?})))
6588 (when (not (c-go-list-backward))
6590 (c-backward-syntactic-ws)
6591 (when (not (c-simple-skip-symbol-backward))
6593 (c-backward-syntactic-ws))
6596 (eq (char-before) ?:)
6597 (c-just-after-func-arglist-p))))
6599 (or res (goto-char here))
6603 ;; Handling of large scale constructs like statements and declarations.
6605 ;; Macro used inside `c-forward-decl-or-cast-1'. It ought to be a
6606 ;; defsubst or perhaps even a defun, but it contains lots of free
6607 ;; variables that refer to things inside `c-forward-decl-or-cast-1'.
6608 (defmacro c-fdoc-shift-type-backward (&optional short)
6609 ;; `c-forward-decl-or-cast-1' can consume an arbitrary length list
6610 ;; of types when parsing a declaration, which means that it
6611 ;; sometimes consumes the identifier in the declaration as a type.
6612 ;; This is used to "backtrack" and make the last type be treated as
6613 ;; an identifier instead.
6616 ;; These identifiers are bound only in the inner let.
6617 '(setq identifier-type at-type
6618 identifier-start type-start
6622 got-suffix-after-parens id-start
6625 (if (setq at-type (if (eq backup-at-type 'prefix)
6628 (setq type-start backup-type-start
6629 id-start backup-id-start)
6630 (setq type-start start-pos
6631 id-start start-pos))
6633 ;; When these flags already are set we've found specifiers that
6634 ;; unconditionally signal these attributes - backtracking doesn't
6635 ;; change that. So keep them set in that case.
6637 (setq at-type-decl backup-at-type-decl))
6639 (setq maybe-typeless backup-maybe-typeless))
6642 ;; This identifier is bound only in the inner let.
6643 '(setq start id-start))))
6645 (defun c-forward-decl-or-cast-1 (preceding-token-end context last-cast-end)
6646 ;; Move forward over a declaration or a cast if at the start of one.
6647 ;; The point is assumed to be at the start of some token. Nil is
6648 ;; returned if no declaration or cast is recognized, and the point
6649 ;; is clobbered in that case.
6651 ;; If a declaration is parsed:
6653 ;; The point is left at the first token after the first complete
6654 ;; declarator, if there is one. The return value is a cons where
6655 ;; the car is the position of the first token in the declarator. (See
6656 ;; below for the cdr.)
6659 ;; void foo (int a, char *b) stuff ...
6663 ;; unsigned int a = c_style_initializer, b;
6665 ;; unsigned int a (cplusplus_style_initializer), b;
6666 ;; car ^ ^ point (might change)
6667 ;; class Foo : public Bar {}
6669 ;; class PikeClass (int a, string b) stuff ...
6675 ;; void cplusplus_function (int x) throw (Bad);
6677 ;; Foo::Foo (int b) : Base (b) {}
6682 ;; auto cplusplus_11 (int a, char *b) -> decltype (bar):
6687 ;; The cdr of the return value is non-nil when a
6688 ;; `c-typedef-decl-kwds' specifier is found in the declaration.
6689 ;; Specifically it is a dotted pair (A . B) where B is t when a
6690 ;; `c-typedef-kwds' ("typedef") is present, and A is t when some
6691 ;; other `c-typedef-decl-kwds' (e.g. class, struct, enum)
6692 ;; specifier is present. I.e., (some of) the declared
6693 ;; identifier(s) are types.
6695 ;; If a cast is parsed:
6697 ;; The point is left at the first token after the closing paren of
6698 ;; the cast. The return value is `cast'. Note that the start
6699 ;; position must be at the first token inside the cast parenthesis
6702 ;; PRECEDING-TOKEN-END is the first position after the preceding
6703 ;; token, i.e. on the other side of the syntactic ws from the point.
6704 ;; Use a value less than or equal to (point-min) if the point is at
6705 ;; the first token in (the visible part of) the buffer.
6707 ;; CONTEXT is a symbol that describes the context at the point:
6708 ;; 'decl In a comma-separated declaration context (typically
6709 ;; inside a function declaration arglist).
6710 ;; '<> In an angle bracket arglist.
6711 ;; 'arglist Some other type of arglist.
6712 ;; nil Some other context or unknown context. Includes
6713 ;; within the parens of an if, for, ... construct.
6715 ;; LAST-CAST-END is the first token after the closing paren of a
6716 ;; preceding cast, or nil if none is known. If
6717 ;; `c-forward-decl-or-cast-1' is used in succession, it should be
6718 ;; the position after the closest preceding call where a cast was
6719 ;; matched. In that case it's used to discover chains of casts like
6722 ;; This function records identifier ranges on
6723 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6724 ;; `c-record-type-identifiers' is non-nil.
6726 ;; This function might do hidden buffer changes.
6728 (let (;; `start-pos' is used below to point to the start of the
6729 ;; first type, i.e. after any leading specifiers. It might
6730 ;; also point at the beginning of the preceding syntactic
6733 ;; Set to the result of `c-forward-type'.
6735 ;; The position of the first token in what we currently
6736 ;; believe is the type in the declaration or cast, after any
6737 ;; specifiers and their associated clauses.
6739 ;; The position of the first token in what we currently
6740 ;; believe is the declarator for the first identifier. Set
6741 ;; when the type is found, and moved forward over any
6742 ;; `c-decl-hangon-kwds' and their associated clauses that
6743 ;; occurs after the type.
6745 ;; These store `at-type', `type-start' and `id-start' of the
6746 ;; identifier before the one in those variables. The previous
6747 ;; identifier might turn out to be the real type in a
6748 ;; declaration if the last one has to be the declarator in it.
6749 ;; If `backup-at-type' is nil then the other variables have
6750 ;; undefined values.
6751 backup-at-type backup-type-start backup-id-start
6752 ;; This stores `kwd-sym' of the symbol before the current one.
6753 ;; This is needed to distinguish the C++11 version of "auto" from
6754 ;; the pre C++11 meaning.
6756 ;; Set if we've found a specifier (apart from "typedef") that makes
6757 ;; the defined identifier(s) types.
6759 ;; Set if we've a "typedef" keyword.
6761 ;; Set if we've found a specifier that can start a declaration
6762 ;; where there's no type.
6764 ;; Save the value of kwd-sym between loops of the "Check for a
6765 ;; type" loop. Needed to distinguish a C++11 "auto" from a pre
6768 ;; If a specifier is found that also can be a type prefix,
6769 ;; these flags are set instead of those above. If we need to
6770 ;; back up an identifier, they are copied to the real flag
6771 ;; variables. Thus they only take effect if we fail to
6772 ;; interpret it as a type.
6773 backup-at-type-decl backup-maybe-typeless
6774 ;; Whether we've found a declaration or a cast. We might know
6775 ;; this before we've found the type in it. It's 'ids if we've
6776 ;; found two consecutive identifiers (usually a sure sign, but
6777 ;; we should allow that in labels too), and t if we've found a
6778 ;; specifier keyword (a 100% sure sign).
6780 ;; Set when we need to back up to parse this as a declaration
6781 ;; but not as a cast.
6783 ;; For casts, the return position.
6785 ;; Have we got a new-style C++11 "auto"?
6787 ;; Save `c-record-type-identifiers' and
6788 ;; `c-record-ref-identifiers' since ranges are recorded
6789 ;; speculatively and should be thrown away if it turns out
6790 ;; that it isn't a declaration or cast.
6791 (save-rec-type-ids c-record-type-identifiers)
6792 (save-rec-ref-ids c-record-ref-identifiers))
6794 (while (c-forward-annotation)
6795 (c-forward-syntactic-ws))
6797 ;; Check for a type. Unknown symbols are treated as possible
6798 ;; types, but they could also be specifiers disguised through
6799 ;; macros like __INLINE__, so we recognize both types and known
6800 ;; specifiers after them too.
6802 (let* ((start (point)) kwd-sym kwd-clause-end found-type)
6804 ;; Look for a specifier keyword clause.
6805 (when (or (looking-at c-prefix-spec-kwds-re) ;FIXME!!! includes auto
6806 (and (c-major-mode-is 'java-mode)
6807 (looking-at "@[A-Za-z0-9]+")))
6809 (if (looking-at c-typedef-key)
6810 (setq at-typedef t)))
6811 (setq kwd-sym (c-keyword-sym (match-string 1)))
6813 (c-forward-keyword-clause 1)
6814 (setq kwd-clause-end (point))))
6816 (when (setq found-type (c-forward-type t)) ; brace-block-too
6817 ;; Found a known or possible type or a prefix of a known type.
6818 (when (and (c-major-mode-is 'c++-mode) ; C++11 style "auto"?
6819 (eq prev-kwd-sym (c-keyword-sym "auto"))
6820 (looking-at "[=(]")) ; FIXME!!! proper regexp.
6821 (setq new-style-auto t)
6822 (setq found-type nil)
6823 (goto-char start)) ; position of foo in "auto foo"
6826 ;; Got two identifiers with nothing but whitespace
6827 ;; between them. That can only happen in declarations.
6828 (setq at-decl-or-cast 'ids)
6830 (when (eq at-type 'found)
6831 ;; If the previous identifier is a found type we
6832 ;; record it as a real one; it might be some sort of
6833 ;; alias for a prefix like "unsigned".
6835 (goto-char type-start)
6836 (let ((c-promote-possible-types t))
6837 (c-forward-type)))))
6839 (setq backup-at-type at-type
6840 backup-type-start type-start
6841 backup-id-start id-start
6842 backup-kwd-sym kwd-sym
6846 ;; The previous ambiguous specifier/type turned out
6847 ;; to be a type since we've parsed another one after
6848 ;; it, so clear these backup flags.
6849 backup-at-type-decl nil
6850 backup-maybe-typeless nil))
6854 ;; Handle known specifier keywords and
6855 ;; `c-decl-hangon-kwds' which can occur after known
6858 (if (c-keyword-member kwd-sym 'c-decl-hangon-kwds)
6859 ;; It's a hang-on keyword that can occur anywhere.
6861 (setq at-decl-or-cast t)
6863 ;; Move the identifier start position if
6864 ;; we've passed a type.
6865 (setq id-start kwd-clause-end)
6866 ;; Otherwise treat this as a specifier and
6867 ;; move the fallback position.
6868 (setq start-pos kwd-clause-end))
6869 (goto-char kwd-clause-end))
6871 ;; It's an ordinary specifier so we know that
6872 ;; anything before this can't be the type.
6873 (setq backup-at-type nil
6874 start-pos kwd-clause-end)
6877 ;; It's ambiguous whether this keyword is a
6878 ;; specifier or a type prefix, so set the backup
6879 ;; flags. (It's assumed that `c-forward-type'
6880 ;; moved further than `c-forward-keyword-clause'.)
6882 (when (c-keyword-member kwd-sym 'c-typedef-decl-kwds)
6883 (setq backup-at-type-decl t))
6884 (when (c-keyword-member kwd-sym 'c-typeless-decl-kwds)
6885 (setq backup-maybe-typeless t)))
6887 (when (c-keyword-member kwd-sym 'c-typedef-decl-kwds)
6888 ;; This test only happens after we've scanned a type.
6889 ;; So, with valid syntax, kwd-sym can't be 'typedef.
6890 (setq at-type-decl t))
6891 (when (c-keyword-member kwd-sym 'c-typeless-decl-kwds)
6892 (setq maybe-typeless t))
6894 ;; Haven't matched a type so it's an unambiguous
6895 ;; specifier keyword and we know we're in a
6897 (setq at-decl-or-cast t)
6898 (setq prev-kwd-sym kwd-sym)
6900 (goto-char kwd-clause-end))))
6902 ;; If the type isn't known we continue so that we'll jump
6903 ;; over all specifiers and type identifiers. The reason
6904 ;; to do this for a known type prefix is to make things
6905 ;; like "unsigned INT16" work.
6906 (and found-type (not (eq found-type t))))))
6910 ;; If a known type was found, we still need to skip over any
6911 ;; hangon keyword clauses after it. Otherwise it has already
6912 ;; been done in the loop above.
6913 (while (looking-at c-decl-hangon-key)
6914 (c-forward-keyword-clause 1))
6915 (setq id-start (point)))
6917 ((eq at-type 'prefix)
6918 ;; A prefix type is itself a primitive type when it's not
6919 ;; followed by another type.
6923 ;; Got no type but set things up to continue anyway to handle
6924 ;; the various cases when a declaration doesn't start with a
6926 (setq id-start start-pos))
6928 ((and (eq at-type 'maybe)
6929 (c-major-mode-is 'c++-mode))
6930 ;; If it's C++ then check if the last "type" ends on the form
6931 ;; "foo::foo" or "foo::~foo", i.e. if it's the name of a
6932 ;; (con|de)structor.
6934 (let (name end-2 end-1)
6935 (goto-char id-start)
6936 (c-backward-syntactic-ws)
6937 (setq end-2 (point))
6939 (c-simple-skip-symbol-backward)
6942 (buffer-substring-no-properties (point) end-2))
6943 ;; Cheating in the handling of syntactic ws below.
6944 (< (skip-chars-backward ":~ \t\n\r\v\f") 0))
6946 (setq end-1 (point))
6947 (c-simple-skip-symbol-backward))
6948 (>= (point) type-start)
6949 (equal (buffer-substring-no-properties (point) end-1)
6951 ;; It is a (con|de)structor name. In that case the
6952 ;; declaration is typeless so zap out any preceding
6953 ;; identifier(s) that we might have taken as types.
6954 (goto-char type-start)
6957 id-start type-start))))))
6959 ;; Check for and step over a type decl expression after the thing
6960 ;; that is or might be a type. This can't be skipped since we
6961 ;; need the correct end position of the declarator for
6962 ;; `max-type-decl-end-*'.
6963 (let ((start (point)) (paren-depth 0) pos
6964 ;; True if there's a non-open-paren match of
6965 ;; `c-type-decl-prefix-key'.
6967 ;; True if the declarator is surrounded by a parenthesis pair.
6969 ;; True if there is an identifier in the declarator.
6971 ;; True if there's a non-close-paren match of
6972 ;; `c-type-decl-suffix-key'.
6974 ;; True if there's a prefix match outside the outermost
6975 ;; paren pair that surrounds the declarator.
6976 got-prefix-before-parens
6977 ;; True if there's a suffix match outside the outermost
6978 ;; paren pair that surrounds the declarator. The value is
6979 ;; the position of the first suffix match.
6980 got-suffix-after-parens
6981 ;; True if we've parsed the type decl to a token that is
6982 ;; known to end declarations in this context.
6984 ;; The earlier values of `at-type' and `type-start' if we've
6985 ;; shifted the type backwards.
6986 identifier-type identifier-start
6987 ;; If `c-parse-and-markup-<>-arglists' is set we need to
6988 ;; turn it off during the name skipping below to avoid
6989 ;; getting `c-type' properties that might be bogus. That
6990 ;; can happen since we don't know if
6991 ;; `c-restricted-<>-arglists' will be correct inside the
6992 ;; arglist paren that gets entered.
6993 c-parse-and-markup-<>-arglists
6994 ;; Start of the identifier for which `got-identifier' was set.
6997 (goto-char id-start)
6999 ;; Skip over type decl prefix operators. (Note similar code in
7000 ;; `c-font-lock-declarators'.)
7001 (if (and c-recognize-typeless-decls
7002 (equal c-type-decl-prefix-key "\\<\\>"))
7003 (when (eq (char-after) ?\()
7005 (setq paren-depth (1+ paren-depth))
7007 (while (and (looking-at c-type-decl-prefix-key)
7008 (if (and (c-major-mode-is 'c++-mode)
7009 (match-beginning 3))
7010 ;; If the third submatch matches in C++ then
7011 ;; we're looking at an identifier that's a
7012 ;; prefix only if it specifies a member pointer.
7013 (when (progn (setq pos (point))
7014 (setq got-identifier (c-forward-name)))
7015 (setq name-start pos)
7016 (if (looking-at "\\(::\\)")
7017 ;; We only check for a trailing "::" and
7018 ;; let the "*" that should follow be
7019 ;; matched in the next round.
7020 (progn (setq got-identifier nil) t)
7021 ;; It turned out to be the real identifier,
7026 (if (eq (char-after) ?\()
7028 (setq paren-depth (1+ paren-depth))
7030 (unless got-prefix-before-parens
7031 (setq got-prefix-before-parens (= paren-depth 0)))
7033 (goto-char (match-end 1)))
7034 (c-forward-syntactic-ws)))
7036 (setq got-parens (> paren-depth 0))
7038 ;; Skip over an identifier.
7040 (and (looking-at c-identifier-start)
7042 (setq got-identifier (c-forward-name))
7043 (setq name-start pos)))
7045 ;; Skip over type decl suffix operators.
7046 (while (if (looking-at c-type-decl-suffix-key)
7048 (if (eq (char-after) ?\))
7049 (when (> paren-depth 0)
7050 (setq paren-depth (1- paren-depth))
7053 (when (if (save-match-data (looking-at "\\s\("))
7054 (c-safe (c-forward-sexp 1) t)
7055 (goto-char (match-end 1))
7057 (when (and (not got-suffix-after-parens)
7059 (setq got-suffix-after-parens (match-beginning 0)))
7060 (setq got-suffix t)))
7062 ;; No suffix matched. We might have matched the
7063 ;; identifier as a type and the open paren of a
7064 ;; function arglist as a type decl prefix. In that
7065 ;; case we should "backtrack": Reinterpret the last
7066 ;; type as the identifier, move out of the arglist and
7067 ;; continue searching for suffix operators.
7069 ;; Do this even if there's no preceding type, to cope
7070 ;; with old style function declarations in K&R C,
7071 ;; (con|de)structors in C++ and `c-typeless-decl-kwds'
7072 ;; style declarations. That isn't applicable in an
7073 ;; arglist context, though.
7074 (when (and (= paren-depth 1)
7075 (not got-prefix-before-parens)
7076 (not (eq at-type t))
7079 backup-maybe-typeless
7080 (when c-recognize-typeless-decls
7082 (setq pos (c-up-list-forward (point)))
7083 (eq (char-before pos) ?\)))
7084 (c-fdoc-shift-type-backward)
7088 (c-forward-syntactic-ws))
7090 (when (or (and new-style-auto
7091 (looking-at c-auto-ops-re))
7092 (and (or maybe-typeless backup-maybe-typeless)
7093 (not got-identifier)
7096 ;; Have found no identifier but `c-typeless-decl-kwds' has
7097 ;; matched so we know we're inside a declaration. The
7098 ;; preceding type must be the identifier instead.
7099 (c-fdoc-shift-type-backward))
7101 ;; Prepare the "-> type;" for fontification later on.
7102 (when (and new-style-auto
7103 (looking-at c-haskell-op-re))
7105 (goto-char (match-end 0))
7106 (c-forward-syntactic-ws)
7107 (setq type-start (point))
7108 (setq at-type (c-forward-type))))
7112 (catch 'at-decl-or-cast
7115 (when (> paren-depth 0)
7116 ;; Encountered something inside parens that isn't matched by
7117 ;; the `c-type-decl-*' regexps, so it's not a type decl
7118 ;; expression. Try to skip out to the same paren depth to
7119 ;; not confuse the cast check below.
7120 (c-safe (goto-char (scan-lists (point) 1 paren-depth)))
7121 ;; If we've found a specifier keyword then it's a
7122 ;; declaration regardless.
7123 (throw 'at-decl-or-cast (eq at-decl-or-cast t)))
7126 (looking-at (cond ((eq context '<>) "[,>]")
7130 ;; Now we've collected info about various characteristics of
7131 ;; the construct we're looking at. Below follows a decision
7132 ;; tree based on that. It's ordered to check more certain
7133 ;; signs before less certain ones.
7139 (when (and (or at-type maybe-typeless)
7140 (not (or got-prefix got-parens)))
7141 ;; Got another identifier directly after the type, so it's a
7143 (throw 'at-decl-or-cast t))
7145 (when (and got-parens
7147 ;; (not got-suffix-after-parens)
7150 backup-maybe-typeless
7151 (eq at-decl-or-cast t)
7153 (goto-char name-start)
7154 (not (memq (c-forward-type) '(nil maybe))))))
7155 ;; Got a declaration of the form "foo bar (gnu);" or "bar
7156 ;; (gnu);" where we've recognized "bar" as the type and "gnu"
7157 ;; as the declarator. In this case it's however more likely
7158 ;; that "bar" is the declarator and "gnu" a function argument
7159 ;; or initializer (if `c-recognize-paren-inits' is set),
7160 ;; since the parens around "gnu" would be superfluous if it's
7161 ;; a declarator. Shift the type one step backward.
7162 (c-fdoc-shift-type-backward)))
7164 ;; Found no identifier.
7170 (when (= (point) start)
7171 ;; Got a plain list of identifiers. If a colon follows it's
7172 ;; a valid label, or maybe a bitfield. Otherwise the last
7173 ;; one probably is the declared identifier and we should
7174 ;; back up to the previous type, providing it isn't a cast.
7175 (if (and (eq (char-after) ?:)
7176 (not (c-major-mode-is 'java-mode)))
7178 ;; If we've found a specifier keyword then it's a
7179 ;; declaration regardless.
7180 ((eq at-decl-or-cast t)
7181 (throw 'at-decl-or-cast t))
7182 ((and c-has-bitfields
7183 (eq at-decl-or-cast 'ids)) ; bitfield.
7184 (setq backup-if-not-cast t)
7185 (throw 'at-decl-or-cast t)))
7187 (setq backup-if-not-cast t)
7188 (throw 'at-decl-or-cast t)))
7191 (when (and got-suffix
7194 ;; Got a plain list of identifiers followed by some suffix.
7195 ;; If this isn't a cast then the last identifier probably is
7196 ;; the declared one and we should back up to the previous
7198 (setq backup-if-not-cast t)
7199 (throw 'at-decl-or-cast t)))
7202 (when (eq at-type t)
7203 ;; If the type is known we know that there can't be any
7204 ;; identifier somewhere else, and it's only in declarations in
7205 ;; e.g. function prototypes and in casts that the identifier may
7207 (throw 'at-decl-or-cast t))
7209 (when (= (point) start)
7210 ;; Only got a single identifier (parsed as a type so far).
7213 ;; Check that the identifier isn't at the start of an
7218 ;; Inside an arglist that contains declarations. If K&R
7219 ;; style declarations and parenthesis style initializers
7220 ;; aren't allowed then the single identifier must be a
7221 ;; type, else we require that it's known or found
7222 ;; (primitive types are handled above).
7223 (or (and (not c-recognize-knr-p)
7224 (not c-recognize-paren-inits))
7225 (memq at-type '(known found))))
7227 ;; Inside a template arglist. Accept known and found
7228 ;; types; other identifiers could just as well be
7229 ;; constants in C++.
7230 (memq at-type '(known found)))))
7231 (throw 'at-decl-or-cast t)
7233 ;; Can't be a valid declaration or cast, but if we've found a
7234 ;; specifier it can't be anything else either, so treat it as
7235 ;; an invalid/unfinished declaration or cast.
7236 (throw 'at-decl-or-cast at-decl-or-cast))))
7241 (not (eq at-type t))
7244 backup-maybe-typeless
7245 (when c-recognize-typeless-decls
7246 (or (not got-suffix)
7248 c-after-suffixed-type-maybe-decl-key))))))
7249 ;; Got an empty paren pair and a preceding type that probably
7250 ;; really is the identifier. Shift the type backwards to make
7251 ;; the last one the identifier. This is analogous to the
7252 ;; "backtracking" done inside the `c-type-decl-suffix-key' loop
7255 ;; Exception: In addition to the conditions in that
7256 ;; "backtracking" code, do not shift backward if we're not
7257 ;; looking at either `c-after-suffixed-type-decl-key' or "[;,]".
7258 ;; Since there's no preceding type, the shift would mean that
7259 ;; the declaration is typeless. But if the regexp doesn't match
7260 ;; then we will simply fall through in the tests below and not
7261 ;; recognize it at all, so it's better to try it as an abstract
7262 ;; declarator instead.
7263 (c-fdoc-shift-type-backward)
7265 ;; Still no identifier.
7267 (when (and got-prefix (or got-parens got-suffix))
7268 ;; Require `got-prefix' together with either `got-parens' or
7269 ;; `got-suffix' to recognize it as an abstract declarator:
7270 ;; `got-parens' only is probably an empty function call.
7271 ;; `got-suffix' only can build an ordinary expression together
7272 ;; with the preceding identifier which we've taken as a type.
7273 ;; We could actually accept on `got-prefix' only, but that can
7274 ;; easily occur temporarily while writing an expression so we
7275 ;; avoid that case anyway. We could do a better job if we knew
7276 ;; the point when the fontification was invoked.
7277 (throw 'at-decl-or-cast t))
7283 got-suffix-after-parens
7284 (eq (char-after got-suffix-after-parens) ?\())
7285 ;; Got a type, no declarator but a paren suffix. I.e. it's a
7286 ;; normal function call after all (or perhaps a C++ style object
7287 ;; instantiation expression).
7288 (throw 'at-decl-or-cast nil))))
7291 (when at-decl-or-cast
7292 ;; By now we've located the type in the declaration that we know
7294 (throw 'at-decl-or-cast t))
7297 (when (and got-identifier
7299 (looking-at c-after-suffixed-type-decl-key)
7303 (not (eq at-type t)))
7304 ;; Shift the type backward in the case that there's a
7305 ;; single identifier inside parens. That can only
7306 ;; occur in K&R style function declarations so it's
7307 ;; more likely that it really is a function call.
7308 ;; Therefore we only do this after
7309 ;; `c-after-suffixed-type-decl-key' has matched.
7310 (progn (c-fdoc-shift-type-backward) t)
7311 got-suffix-after-parens))
7312 ;; A declaration according to `c-after-suffixed-type-decl-key'.
7313 (throw 'at-decl-or-cast t))
7316 (when (and (or got-prefix (not got-parens))
7317 (memq at-type '(t known)))
7318 ;; It's a declaration if a known type precedes it and it can't be a
7320 (throw 'at-decl-or-cast t))
7322 ;; If we get here we can't tell if this is a type decl or a normal
7323 ;; expression by looking at it alone. (That's under the assumption
7324 ;; that normal expressions always can look like type decl expressions,
7325 ;; which isn't really true but the cases where it doesn't hold are so
7326 ;; uncommon (e.g. some placements of "const" in C++) it's not worth
7327 ;; the effort to look for them.)
7329 ;;; 2008-04-16: commented out the next form, to allow the function to recognize
7330 ;;; "foo (int bar)" in CC (an implicit type (in class foo) without a semicolon)
7331 ;;; as a(n almost complete) declaration, enabling it to be fontified.
7333 ;; (unless (or at-decl-end (looking-at "=[^=]"))
7334 ;; If this is a declaration it should end here or its initializer(*)
7335 ;; should start here, so check for allowed separation tokens. Note
7336 ;; that this rule doesn't work e.g. with a K&R arglist after a
7339 ;; *) Don't check for C++ style initializers using parens
7340 ;; since those already have been matched as suffixes.
7342 ;; If `at-decl-or-cast' is then we've found some other sign that
7343 ;; it's a declaration or cast, so then it's probably an
7344 ;; invalid/unfinished one.
7345 ;; (throw 'at-decl-or-cast at-decl-or-cast))
7347 ;; Below are tests that only should be applied when we're certain to
7348 ;; not have parsed halfway through an expression.
7351 (when (memq at-type '(t known))
7352 ;; The expression starts with a known type so treat it as a
7354 (throw 'at-decl-or-cast t))
7357 (when (and (c-major-mode-is 'c++-mode)
7358 ;; In C++ we check if the identifier is a known type, since
7359 ;; (con|de)structors use the class name as identifier.
7360 ;; We've always shifted over the identifier as a type and
7361 ;; then backed up again in this case.
7363 (or (memq identifier-type '(found known))
7364 (and (eq (char-after identifier-start) ?~)
7365 ;; `at-type' probably won't be 'found for
7366 ;; destructors since the "~" is then part of the
7367 ;; type name being checked against the list of
7368 ;; known types, so do a check without that
7371 (goto-char (1+ identifier-start))
7372 (c-forward-syntactic-ws)
7373 (c-with-syntax-table
7374 c-identifier-syntax-table
7375 (looking-at c-known-type-key)))
7377 (goto-char (1+ identifier-start))
7378 ;; We have already parsed the type earlier,
7379 ;; so it'd be possible to cache the end
7380 ;; position instead of redoing it here, but
7381 ;; then we'd need to keep track of another
7382 ;; position everywhere.
7383 (c-check-type (point)
7384 (progn (c-forward-type)
7386 (throw 'at-decl-or-cast t))
7391 (when (and got-prefix-before-parens
7393 (or at-decl-end (looking-at "=[^=]"))
7396 ;; Got something like "foo * bar;". Since we're not inside an
7397 ;; arglist it would be a meaningless expression because the
7398 ;; result isn't used. We therefore choose to recognize it as
7399 ;; a declaration. Do not allow a suffix since it could then
7400 ;; be a function call.
7401 (throw 'at-decl-or-cast t))
7404 (when (and (or got-suffix-after-parens
7405 (looking-at "=[^=]"))
7407 (not (eq context 'arglist)))
7408 ;; Got something like "a (*b) (c);" or "a (b) = c;". It could
7409 ;; be an odd expression or it could be a declaration. Treat
7410 ;; it as a declaration if "a" has been used as a type
7411 ;; somewhere else (if it's a known type we won't get here).
7412 (throw 'at-decl-or-cast t)))
7417 (and (eq context 'decl)
7418 (not c-recognize-paren-inits)
7419 (or got-parens got-suffix))))
7420 ;; Got a type followed by an abstract declarator. If `got-prefix'
7421 ;; is set it's something like "a *" without anything after it. If
7422 ;; `got-parens' or `got-suffix' is set it's "a()", "a[]", "a()[]",
7423 ;; or similar, which we accept only if the context rules out
7425 (throw 'at-decl-or-cast t)))
7427 ;; If we had a complete symbol table here (which rules out
7428 ;; `c-found-types') we should return t due to the disambiguation rule
7429 ;; (in at least C++) that anything that can be parsed as a declaration
7430 ;; is a declaration. Now we're being more defensive and prefer to
7431 ;; highlight things like "foo (bar);" as a declaration only if we're
7432 ;; inside an arglist that contains declarations.
7434 (eq context 'decl))))
7436 ;; The point is now after the type decl expression.
7439 ;; Check for a cast.
7444 ;; Should be the first type/identifier in a cast paren.
7445 (> preceding-token-end (point-min))
7446 (memq (char-before preceding-token-end) c-cast-parens)
7448 ;; The closing paren should follow.
7450 (c-forward-syntactic-ws)
7451 (looking-at "\\s\)"))
7453 ;; There should be a primary expression after it.
7456 (c-forward-syntactic-ws)
7457 (setq cast-end (point))
7458 (and (looking-at c-primary-expr-regexp)
7460 (setq pos (match-end 0))
7462 ;; Check if the expression begins with a prefix keyword.
7464 (if (match-beginning 1)
7465 ;; Expression begins with an ambiguous operator. Treat
7466 ;; it as a cast if it's a type decl or if we've
7467 ;; recognized the type somewhere else.
7469 (memq at-type '(t known found)))
7470 ;; Unless it's a keyword, it's the beginning of a primary
7472 (not (looking-at c-keywords-regexp)))))
7473 ;; If `c-primary-expr-regexp' matched a nonsymbol token, check
7474 ;; that it matched a whole one so that we don't e.g. confuse
7475 ;; the operator '-' with '->'. It's ok if it matches further,
7476 ;; though, since it e.g. can match the float '.5' while the
7477 ;; operator regexp only matches '.'.
7478 (or (not (looking-at c-nonsymbol-token-regexp))
7479 (<= (match-end 0) pos))))
7481 ;; There should either be a cast before it or something that isn't an
7482 ;; identifier or close paren.
7483 (> preceding-token-end (point-min))
7485 (goto-char (1- preceding-token-end))
7486 (or (eq (point) last-cast-end)
7488 (c-backward-syntactic-ws)
7489 (if (< (skip-syntax-backward "w_") 0)
7490 ;; It's a symbol. Accept it only if it's one of the
7491 ;; keywords that can precede an expression (without
7492 ;; surrounding parens).
7493 (looking-at c-simple-stmt-key)
7495 ;; Check that it isn't a close paren (block close is ok,
7497 (not (memq (char-before) '(?\) ?\])))
7498 ;; Check that it isn't a nonsymbol identifier.
7499 (not (c-on-identifier)))))))))
7502 (when (and c-record-type-identifiers at-type (not (eq at-type t)))
7503 (let ((c-promote-possible-types t))
7504 (goto-char type-start)
7507 (goto-char cast-end)
7511 ;; We're at a declaration. Highlight the type and the following
7514 (when backup-if-not-cast
7515 (c-fdoc-shift-type-backward t))
7517 (when (and (eq context 'decl) (looking-at ","))
7518 ;; Make sure to propagate the `c-decl-arg-start' property to
7519 ;; the next argument if it's set in this one, to cope with
7520 ;; interactive refontification.
7521 (c-put-c-type-property (point) 'c-decl-arg-start))
7523 ;; Record the type's coordinates in `c-record-type-identifiers' for
7524 ;; later fontification.
7525 (when (and c-record-type-identifiers at-type ;; (not (eq at-type t))
7526 ;; There seems no reason to exclude a token from
7527 ;; fontification just because it's "a known type that can't
7528 ;; be a name or other expression". 2013-09-18.
7530 (let ((c-promote-possible-types t))
7532 (goto-char type-start)
7536 (and (or at-type-decl at-typedef)
7537 (cons at-type-decl at-typedef))))
7540 ;; False alarm. Restore the recorded ranges.
7541 (setq c-record-type-identifiers save-rec-type-ids
7542 c-record-ref-identifiers save-rec-ref-ids)
7545 (defun c-forward-label (&optional assume-markup preceding-token-end limit)
7546 ;; Assuming that point is at the beginning of a token, check if it starts a
7547 ;; label and if so move over it and return non-nil (t in default situations,
7548 ;; specific symbols (see below) for interesting situations), otherwise don't
7549 ;; move and return nil. "Label" here means "most things with a colon".
7551 ;; More precisely, a "label" is regarded as one of:
7552 ;; (i) a goto target like "foo:" - returns the symbol `goto-target';
7553 ;; (ii) A case label - either the entire construct "case FOO:", or just the
7554 ;; bare "case", should the colon be missing. We return t;
7555 ;; (iii) a keyword which needs a colon, like "default:" or "private:"; We
7557 ;; (iv) One of QT's "extended" C++ variants of
7558 ;; "private:"/"protected:"/"public:"/"more:" looking like "public slots:".
7559 ;; Returns the symbol `qt-2kwds-colon'.
7560 ;; (v) QT's construct "signals:". Returns the symbol `qt-1kwd-colon'.
7561 ;; (vi) One of the keywords matched by `c-opt-extra-label-key' (without any
7562 ;; colon). Currently (2006-03), this applies only to Objective C's
7563 ;; keywords "@private", "@protected", and "@public". Returns t.
7565 ;; One of the things which will NOT be recognized as a label is a bit-field
7566 ;; element of a struct, something like "int foo:5".
7568 ;; The end of the label is taken to be just after the colon, or the end of
7569 ;; the first submatch in `c-opt-extra-label-key'. The point is directly
7570 ;; after the end on return. The terminating char gets marked with
7571 ;; `c-decl-end' to improve recognition of the following declaration or
7574 ;; If ASSUME-MARKUP is non-nil, it's assumed that the preceding
7575 ;; label, if any, has already been marked up like that.
7577 ;; If PRECEDING-TOKEN-END is given, it should be the first position
7578 ;; after the preceding token, i.e. on the other side of the
7579 ;; syntactic ws from the point. Use a value less than or equal to
7580 ;; (point-min) if the point is at the first token in (the visible
7581 ;; part of) the buffer.
7583 ;; The optional LIMIT limits the forward scan for the colon.
7585 ;; This function records the ranges of the label symbols on
7586 ;; `c-record-ref-identifiers' if `c-record-type-identifiers' (!) is
7589 ;; This function might do hidden buffer changes.
7591 (let ((start (point))
7594 macro-start ; if we're in one.
7598 ;; "case" or "default" (Doesn't apply to AWK).
7599 ((looking-at c-label-kwds-regexp)
7600 (let ((kwd-end (match-end 1)))
7601 ;; Record only the keyword itself for fontification, since in
7602 ;; case labels the following is a constant expression and not
7604 (when c-record-type-identifiers
7605 (c-record-ref-id (cons (match-beginning 1) kwd-end)))
7607 ;; Find the label end.
7610 (if (and (c-syntactic-re-search-forward
7611 ;; Stop on chars that aren't allowed in expressions,
7612 ;; and on operator chars that would be meaningless
7613 ;; there. FIXME: This doesn't cope with ?: operators.
7614 "[;{=,@]\\|\\(\\=\\|[^:]\\):\\([^:]\\|\\'\\)"
7616 (match-beginning 2))
7618 (progn ; there's a proper :
7619 (goto-char (match-beginning 2)) ; just after the :
7620 (c-put-c-type-property (1- (point)) 'c-decl-end)
7623 ;; It's an unfinished label. We consider the keyword enough
7624 ;; to recognize it as a label, so that it gets fontified.
7625 ;; Leave the point at the end of it, but don't put any
7626 ;; `c-decl-end' marker.
7630 ;; @private, @protected, @public, in Objective C, or similar.
7631 ((and c-opt-extra-label-key
7632 (looking-at c-opt-extra-label-key))
7633 ;; For a `c-opt-extra-label-key' match, we record the whole
7634 ;; thing for fontification. That's to get the leading '@' in
7635 ;; Objective-C protection labels fontified.
7636 (goto-char (match-end 1))
7637 (when c-record-type-identifiers
7638 (c-record-ref-id (cons (match-beginning 1) (point))))
7639 (c-put-c-type-property (1- (point)) 'c-decl-end)
7640 (setq label-type t))
7642 ;; All other cases of labels.
7643 ((and c-recognize-colon-labels ; nil for AWK and IDL, otherwise t.
7645 ;; A colon label must have something before the colon.
7646 (not (eq (char-after) ?:))
7648 ;; Check that we're not after a token that can't precede a label.
7650 ;; Trivially succeeds when there's no preceding token.
7651 ;; Succeeds when we're at a virtual semicolon.
7652 (if preceding-token-end
7653 (<= preceding-token-end (point-min))
7655 (c-backward-syntactic-ws)
7656 (setq preceding-token-end (point))
7660 ;; Check if we're after a label, if we're after a closing
7661 ;; paren that belong to statement, and with
7662 ;; `c-label-prefix-re'. It's done in different order
7663 ;; depending on `assume-markup' since the checks have
7664 ;; different expensiveness.
7667 (eq (c-get-char-property (1- preceding-token-end) 'c-type)
7671 (goto-char (1- preceding-token-end))
7672 (c-beginning-of-current-token)
7673 (or (looking-at c-label-prefix-re)
7674 (looking-at c-block-stmt-1-key)))
7676 (and (eq (char-before preceding-token-end) ?\))
7677 (c-after-conditional)))
7681 (goto-char (1- preceding-token-end))
7682 (c-beginning-of-current-token)
7683 (or (looking-at c-label-prefix-re)
7684 (looking-at c-block-stmt-1-key)))
7687 ((eq (char-before preceding-token-end) ?\))
7688 (c-after-conditional))
7690 ((eq (char-before preceding-token-end) ?:)
7691 ;; Might be after another label, so check it recursively.
7694 (goto-char (1- preceding-token-end))
7695 ;; Essentially the same as the
7696 ;; `c-syntactic-re-search-forward' regexp below.
7698 (save-excursion (and (c-beginning-of-macro)
7700 (if macro-start (narrow-to-region macro-start (point-max)))
7701 (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+" nil t)
7702 ;; Note: the following should work instead of the
7703 ;; narrow-to-region above. Investigate why not,
7704 ;; sometime. ACM, 2006-03-31.
7705 ;; (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+"
7708 ;; If the caller turned on recording for us,
7709 ;; it shouldn't apply when we check the
7711 c-record-type-identifiers)
7712 ;; A label can't start at a cpp directive. Check for
7713 ;; this, since c-forward-syntactic-ws would foul up on it.
7714 (unless (and c-opt-cpp-prefix (looking-at c-opt-cpp-prefix))
7715 (c-forward-syntactic-ws)
7716 (c-forward-label nil pte start))))))))))
7718 ;; Point is still at the beginning of the possible label construct.
7720 ;; Check that the next nonsymbol token is ":", or that we're in one
7721 ;; of QT's "slots" declarations. Allow '(' for the sake of macro
7722 ;; arguments. FIXME: Should build this regexp from the language
7725 ;; public: protected: private:
7727 (c-major-mode-is 'c++-mode)
7728 (search-forward-regexp
7729 "\\=p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\>[^_]" nil t)
7730 (progn (backward-char)
7731 (c-forward-syntactic-ws limit)
7732 (looking-at ":\\([^:]\\|\\'\\)"))) ; A single colon.
7734 (setq label-type t))
7735 ;; QT double keyword like "protected slots:" or goto target.
7736 ((progn (goto-char start) nil))
7737 ((when (c-syntactic-re-search-forward
7738 "[ \t\n[:?;{=*/%&|,<>!@+-]" limit t t) ; not at EOB
7740 (setq label-end (point))
7742 (and (c-major-mode-is 'c++-mode)
7744 "\\(p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\|more\\)\\>"
7745 (buffer-substring start (point)))))
7746 (c-forward-syntactic-ws limit)
7748 ((looking-at ":\\([^:]\\|\\'\\)") ; A single colon.
7751 (if (or (string= "signals" ; Special QT macro
7752 (setq kwd (buffer-substring-no-properties start label-end)))
7753 (string= "Q_SIGNALS" kwd))
7757 (search-forward-regexp "\\=\\(slots\\|Q_SLOTS\\)\\>" limit t)
7758 (progn (c-forward-syntactic-ws limit)
7759 (looking-at ":\\([^:]\\|\\'\\)"))) ; A single colon
7761 (setq label-type 'qt-2kwds-colon)))))))
7764 (narrow-to-region start (point))
7766 ;; Check that `c-nonlabel-token-key' doesn't match anywhere.
7770 (when (looking-at c-nonlabel-token-key)
7772 (setq label-type nil)
7773 (throw 'check-label nil))
7774 (and (c-safe (c-forward-sexp)
7775 (c-forward-syntactic-ws)
7779 ;; Record the identifiers in the label for fontification, unless
7780 ;; it begins with `c-label-kwds' in which case the following
7781 ;; identifiers are part of a (constant) expression that
7782 ;; shouldn't be fontified.
7783 (when (and c-record-type-identifiers
7784 (progn (goto-char start)
7785 (not (looking-at c-label-kwds-regexp))))
7786 (while (c-syntactic-re-search-forward c-symbol-key nil t)
7787 (c-record-ref-id (cons (match-beginning 0)
7790 (c-put-c-type-property (1- (point-max)) 'c-decl-end)
7791 (goto-char (point-max)))))
7798 (defun c-forward-objc-directive ()
7799 ;; Assuming the point is at the beginning of a token, try to move
7800 ;; forward to the end of the Objective-C directive that starts
7801 ;; there. Return t if a directive was fully recognized, otherwise
7802 ;; the point is moved as far as one could be successfully parsed and
7805 ;; This function records identifier ranges on
7806 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
7807 ;; `c-record-type-identifiers' is non-nil.
7809 ;; This function might do hidden buffer changes.
7811 (let ((start (point))
7813 (c-promote-possible-types t)
7815 ;; Turn off recognition of angle bracket arglists while parsing
7816 ;; types here since the protocol reference list might then be
7817 ;; considered part of the preceding name or superclass-name.
7818 c-recognize-<>-arglists)
7823 (c-make-keywords-re t
7824 (append (c-lang-const c-protection-kwds objc)
7827 (goto-char (match-end 1))
7833 (c-make-keywords-re t
7834 '("@interface" "@implementation" "@protocol")
7837 ;; Handle the name of the class itself.
7839 ;; (c-forward-token-2) ; 2006/1/13 This doesn't move if the token's
7841 (goto-char (match-end 0))
7847 ;; Look for ": superclass-name" or "( category-name )".
7848 (when (looking-at "[:\(]")
7849 (setq start-char (char-after))
7851 (c-forward-syntactic-ws)
7852 (unless (c-forward-type) (throw 'break nil))
7853 (when (eq start-char ?\()
7854 (unless (eq (char-after) ?\)) (throw 'break nil))
7856 (c-forward-syntactic-ws)))
7858 ;; Look for a protocol reference list.
7859 (if (eq (char-after) ?<)
7860 (let ((c-recognize-<>-arglists t)
7861 (c-parse-and-markup-<>-arglists t)
7862 c-restricted-<>-arglists)
7863 (c-forward-<>-arglist t))
7867 (c-backward-syntactic-ws lim)
7868 (c-clear-c-type-property start (1- (point)) 'c-decl-end)
7869 (c-put-c-type-property (1- (point)) 'c-decl-end)
7872 (c-clear-c-type-property start (point) 'c-decl-end)
7875 (defun c-beginning-of-inheritance-list (&optional lim)
7876 ;; Go to the first non-whitespace after the colon that starts a
7877 ;; multiple inheritance introduction. Optional LIM is the farthest
7878 ;; back we should search.
7880 ;; This function might do hidden buffer changes.
7881 (c-with-syntax-table c++-template-syntax-table
7882 (c-backward-token-2 0 t lim)
7883 (while (and (or (looking-at c-symbol-start)
7884 (looking-at "[<,]\\|::"))
7885 (zerop (c-backward-token-2 1 t lim))))))
7887 (defun c-in-method-def-p ()
7888 ;; Return nil if we aren't in a method definition, otherwise the
7889 ;; position of the initial [+-].
7891 ;; This function might do hidden buffer changes.
7894 (and c-opt-method-key
7895 (looking-at c-opt-method-key)
7899 ;; Contributed by Kevin Ryde <user42@zip.com.au>.
7900 (defun c-in-gcc-asm-p ()
7901 ;; Return non-nil if point is within a gcc \"asm\" block.
7903 ;; This should be called with point inside an argument list.
7905 ;; Only one level of enclosing parentheses is considered, so for
7906 ;; instance `nil' is returned when in a function call within an asm
7909 ;; This function might do hidden buffer changes.
7911 (and c-opt-asm-stmt-key
7914 (backward-up-list 1)
7915 (c-beginning-of-statement-1 (point-min) nil t)
7916 (looking-at c-opt-asm-stmt-key))))
7918 (defun c-at-toplevel-p ()
7919 "Return a determination as to whether point is \"at the top level\".
7920 Informally, \"at the top level\" is anywhere where you can write
7923 More precisely, being at the top-level means that point is either
7924 outside any enclosing block (such as a function definition), or
7925 directly inside a class, namespace or other block that contains
7926 another declaration level.
7928 If point is not at the top-level (e.g. it is inside a method
7929 definition), then nil is returned. Otherwise, if point is at a
7930 top-level not enclosed within a class definition, t is returned.
7931 Otherwise, a 2-vector is returned where the zeroth element is the
7932 buffer position of the start of the class declaration, and the first
7933 element is the buffer position of the enclosing class's opening
7936 Note that this function might do hidden buffer changes. See the
7937 comment at the start of cc-engine.el for more info."
7938 (let ((paren-state (c-parse-state)))
7939 (or (not (c-most-enclosing-brace paren-state))
7940 (c-search-uplist-for-classkey paren-state))))
7942 (defun c-just-after-func-arglist-p (&optional lim)
7943 ;; Return non-nil if the point is in the region after the argument
7944 ;; list of a function and its opening brace (or semicolon in case it
7945 ;; got no body). If there are K&R style argument declarations in
7946 ;; that region, the point has to be inside the first one for this
7947 ;; function to recognize it.
7949 ;; If successful, the point is moved to the first token after the
7950 ;; function header (see `c-forward-decl-or-cast-1' for details) and
7951 ;; the position of the opening paren of the function arglist is
7954 ;; The point is clobbered if not successful.
7956 ;; LIM is used as bound for backward buffer searches.
7958 ;; This function might do hidden buffer changes.
7960 (let ((beg (point)) id-start)
7962 (eq (c-beginning-of-statement-1 lim) 'same)
7964 (not (and (c-major-mode-is 'objc-mode)
7965 (c-forward-objc-directive)))
7968 (car-safe (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil)))
7971 ;; There should not be a '=' or ',' between beg and the
7972 ;; start of the declaration since that means we were in the
7973 ;; "expression part" of the declaration.
7975 (not (looking-at "[=,]")))
7978 ;; Check that there's an arglist paren in the
7980 (goto-char id-start)
7981 (cond ((eq (char-after) ?\()
7982 ;; The declarator is a paren expression, so skip past it
7983 ;; so that we don't get stuck on that instead of the
7984 ;; function arglist.
7986 ((and c-opt-op-identifier-prefix
7987 (looking-at c-opt-op-identifier-prefix))
7988 ;; Don't trip up on "operator ()".
7989 (c-forward-token-2 2 t)))
7990 (and (< (point) beg)
7991 (c-syntactic-re-search-forward "(" beg t t)
7994 (defun c-in-knr-argdecl (&optional lim)
7995 ;; Return the position of the first argument declaration if point is
7996 ;; inside a K&R style argument declaration list, nil otherwise.
7997 ;; `c-recognize-knr-p' is not checked. If LIM is non-nil, it's a
7998 ;; position that bounds the backward search for the argument list.
8000 ;; Point must be within a possible K&R region, e.g. just before a top-level
8001 ;; "{". It must be outside of parens and brackets. The test can return
8002 ;; false positives otherwise.
8004 ;; This function might do hidden buffer changes.
8008 ;; If we're in a macro, our search range is restricted to it. Narrow to
8009 ;; the searchable range.
8010 (let* ((macro-start (save-excursion (and (c-beginning-of-macro) (point))))
8011 (macro-end (save-excursion (and macro-start (c-end-of-macro) (point))))
8012 (low-lim (max (or lim (point-min)) (or macro-start (point-min))))
8013 before-lparen after-rparen
8014 (pp-count-out 20)) ; Max number of paren/brace constructs before
8016 (narrow-to-region low-lim (or macro-end (point-max)))
8018 ;; Search backwards for the defun's argument list. We give up if we
8019 ;; encounter a "}" (end of a previous defun) an "=" (which can't be in
8020 ;; a knr region) or BOB.
8022 ;; The criterion for a paren structure being the arg list is:
8023 ;; o - there is non-WS stuff after it but before any "{"; AND
8024 ;; o - the token after it isn't a ";" AND
8025 ;; o - it is preceded by either an identifier (the function name) or
8026 ;; a macro expansion like "DEFUN (...)"; AND
8027 ;; o - its content is a non-empty comma-separated list of identifiers
8028 ;; (an empty arg list won't have a knr region).
8030 ;; The following snippet illustrates these rules:
8031 ;; int foo (bar, baz, yuk)
8033 ;; int (*baz) (my_type) ;
8034 ;; int (*) (void) (*yuk) (void) ;
8038 (while (> pp-count-out 0) ; go back one paren/bracket pair each time.
8039 (setq pp-count-out (1- pp-count-out))
8040 (c-syntactic-skip-backward "^)]}=")
8041 (cond ((eq (char-before) ?\))
8042 (setq after-rparen (point)))
8043 ((eq (char-before) ?\])
8044 (setq after-rparen nil))
8045 (t ; either } (hit previous defun) or = or no more
8050 ;; We're inside a paren. Could it be our argument list....?
8054 (goto-char after-rparen)
8055 (unless (c-go-list-backward) (throw 'knr nil)) ;
8056 ;; FIXME!!! What about macros between the parens? 2007/01/20
8057 (setq before-lparen (point)))
8059 ;; It can't be the arg list if next token is ; or {
8060 (progn (goto-char after-rparen)
8061 (c-forward-syntactic-ws)
8062 (not (memq (char-after) '(?\; ?\{ ?\=))))
8064 ;; Is the thing preceding the list an identifier (the
8065 ;; function name), or a macro expansion?
8067 (goto-char before-lparen)
8068 (eq (c-backward-token-2) 0)
8069 (or (eq (c-on-identifier) (point))
8070 (and (eq (char-after) ?\))
8071 (c-go-up-list-backward)
8072 (eq (c-backward-token-2) 0)
8073 (eq (c-on-identifier) (point)))))
8075 ;; Have we got a non-empty list of comma-separated
8078 (goto-char before-lparen)
8079 (c-forward-token-2) ; to first token inside parens
8084 (while (eq (char-after) ?\,)
8086 (unless (c-on-identifier) (throw 'id-list nil))
8087 (c-forward-token-2))
8088 (eq (char-after) ?\))))))
8090 ;; ...Yes. We've identified the function's argument list.
8092 (progn (goto-char after-rparen)
8093 (c-forward-syntactic-ws)
8096 ;; ...No. The current parens aren't the function's arg list.
8097 (goto-char before-lparen))
8099 (or (c-go-list-backward) ; backwards over [ .... ]
8100 (throw 'knr nil)))))))))
8102 (defun c-skip-conditional ()
8103 ;; skip forward over conditional at point, including any predicate
8104 ;; statements in parentheses. No error checking is performed.
8106 ;; This function might do hidden buffer changes.
8107 (c-forward-sexp (cond
8109 ((looking-at (concat "\\<else"
8110 "\\([ \t\n]\\|\\\\\n\\)+"
8111 "if\\>\\([^_]\\|$\\)"))
8113 ;; do, else, try, finally
8114 ((looking-at (concat "\\<\\("
8115 "do\\|else\\|try\\|finally"
8116 "\\)\\>\\([^_]\\|$\\)"))
8118 ;; for, if, while, switch, catch, synchronized, foreach
8121 (defun c-after-conditional (&optional lim)
8122 ;; If looking at the token after a conditional then return the
8123 ;; position of its start, otherwise return nil.
8125 ;; This function might do hidden buffer changes.
8127 (and (zerop (c-backward-token-2 1 t lim))
8128 (or (looking-at c-block-stmt-1-key)
8129 (and (eq (char-after) ?\()
8130 (zerop (c-backward-token-2 1 t lim))
8131 (or (looking-at c-block-stmt-2-key)
8132 (looking-at c-block-stmt-1-2-key))))
8135 (defun c-after-special-operator-id (&optional lim)
8136 ;; If the point is after an operator identifier that isn't handled
8137 ;; like an ordinary symbol (i.e. like "operator =" in C++) then the
8138 ;; position of the start of that identifier is returned. nil is
8139 ;; returned otherwise. The point may be anywhere in the syntactic
8140 ;; whitespace after the last token of the operator identifier.
8142 ;; This function might do hidden buffer changes.
8144 (and c-overloadable-operators-regexp
8145 (zerop (c-backward-token-2 1 nil lim))
8146 (looking-at c-overloadable-operators-regexp)
8147 (or (not c-opt-op-identifier-prefix)
8149 (zerop (c-backward-token-2 1 nil lim))
8150 (looking-at c-opt-op-identifier-prefix)))
8153 (defsubst c-backward-to-block-anchor (&optional lim)
8154 ;; Assuming point is at a brace that opens a statement block of some
8155 ;; kind, move to the proper anchor point for that block. It might
8156 ;; need to be adjusted further by c-add-stmt-syntax, but the
8157 ;; position at return is suitable as start position for that
8160 ;; This function might do hidden buffer changes.
8161 (unless (= (point) (c-point 'boi))
8162 (let ((start (c-after-conditional lim)))
8164 (goto-char start)))))
8166 (defsubst c-backward-to-decl-anchor (&optional lim)
8167 ;; Assuming point is at a brace that opens the block of a top level
8168 ;; declaration of some kind, move to the proper anchor point for
8171 ;; This function might do hidden buffer changes.
8172 (unless (= (point) (c-point 'boi))
8173 (c-beginning-of-statement-1 lim)))
8175 (defun c-search-decl-header-end ()
8176 ;; Search forward for the end of the "header" of the current
8177 ;; declaration. That's the position where the definition body
8178 ;; starts, or the first variable initializer, or the ending
8179 ;; semicolon. I.e. search forward for the closest following
8180 ;; (syntactically relevant) '{', '=' or ';' token. Point is left
8181 ;; _after_ the first found token, or at point-max if none is found.
8183 ;; This function might do hidden buffer changes.
8185 (let ((base (point)))
8186 (if (c-major-mode-is 'c++-mode)
8188 ;; In C++ we need to take special care to handle operator
8189 ;; tokens and those pesky template brackets.
8191 (c-syntactic-re-search-forward "[;{<=]" nil 'move t t)
8193 (c-end-of-current-token base)
8194 ;; Handle operator identifiers, i.e. ignore any
8195 ;; operator token preceded by "operator".
8197 (and (c-safe (c-backward-sexp) t)
8198 (looking-at c-opt-op-identifier-prefix)))
8199 (and (eq (char-before) ?<)
8200 (c-with-syntax-table c++-template-syntax-table
8201 (if (c-safe (goto-char (c-up-list-forward (point))))
8203 (goto-char (point-max))
8205 (setq base (point)))
8208 (c-syntactic-re-search-forward "[;{=]" nil 'move t t)
8209 (c-end-of-current-token base))
8210 (setq base (point))))))
8212 (defun c-beginning-of-decl-1 (&optional lim)
8213 ;; Go to the beginning of the current declaration, or the beginning
8214 ;; of the previous one if already at the start of it. Point won't
8215 ;; be moved out of any surrounding paren. Return a cons cell of the
8216 ;; form (MOVE . KNR-POS). MOVE is like the return value from
8217 ;; `c-beginning-of-statement-1'. If point skipped over some K&R
8218 ;; style argument declarations (and they are to be recognized) then
8219 ;; KNR-POS is set to the start of the first such argument
8220 ;; declaration, otherwise KNR-POS is nil. If LIM is non-nil, it's a
8221 ;; position that bounds the backward search.
8223 ;; NB: Cases where the declaration continues after the block, as in
8224 ;; "struct foo { ... } bar;", are currently recognized as two
8225 ;; declarations, e.g. "struct foo { ... }" and "bar;" in this case.
8227 ;; This function might do hidden buffer changes.
8229 (let* ((start (point))
8230 (last-stmt-start (point))
8231 (move (c-beginning-of-statement-1 lim nil t)))
8233 ;; `c-beginning-of-statement-1' stops at a block start, but we
8234 ;; want to continue if the block doesn't begin a top level
8235 ;; construct, i.e. if it isn't preceded by ';', '}', ':', bob,
8236 ;; or an open paren.
8237 (let ((beg (point)) tentative-move)
8238 ;; Go back one "statement" each time round the loop until we're just
8239 ;; after a ;, }, or :, or at BOB or the start of a macro or start of
8240 ;; an ObjC method. This will move over a multiple declaration whose
8241 ;; components are comma separated.
8243 ;; Must check with c-opt-method-key in ObjC mode.
8244 (not (and c-opt-method-key
8245 (looking-at c-opt-method-key)))
8246 (/= last-stmt-start (point))
8248 (c-backward-syntactic-ws lim)
8249 (not (memq (char-before) '(?\; ?} ?: nil))))
8252 (not (looking-at "\\s(")))
8253 ;; Check that we don't move from the first thing in a
8254 ;; macro to its header.
8255 (not (eq (setq tentative-move
8256 (c-beginning-of-statement-1 lim nil t))
8258 (setq last-stmt-start beg
8260 move tentative-move))
8263 (when c-recognize-knr-p
8264 (let ((fallback-pos (point)) knr-argdecl-start)
8265 ;; Handle K&R argdecls. Back up after the "statement" jumped
8266 ;; over by `c-beginning-of-statement-1', unless it was the
8267 ;; function body, in which case we're sitting on the opening
8268 ;; brace now. Then test if we're in a K&R argdecl region and
8269 ;; that we started at the other side of the first argdecl in
8271 (unless (eq (char-after) ?{)
8272 (goto-char last-stmt-start))
8273 (if (and (setq knr-argdecl-start (c-in-knr-argdecl lim))
8274 (< knr-argdecl-start start)
8276 (goto-char knr-argdecl-start)
8277 (not (eq (c-beginning-of-statement-1 lim nil t) 'macro))))
8279 (cons (if (eq (char-after fallback-pos) ?{)
8283 (goto-char fallback-pos))))
8285 ;; `c-beginning-of-statement-1' counts each brace block as a separate
8286 ;; statement, so the result will be 'previous if we've moved over any.
8287 ;; So change our result back to 'same if necessary.
8289 ;; If they were brace list initializers we might not have moved over a
8290 ;; declaration boundary though, so change it to 'same if we've moved
8291 ;; past a '=' before '{', but not ';'. (This ought to be integrated
8292 ;; into `c-beginning-of-statement-1', so we avoid this extra pass which
8293 ;; potentially can search over a large amount of text.). Take special
8294 ;; pains not to get mislead by C++'s "operator=", and the like.
8295 (if (and (eq move 'previous)
8296 (c-with-syntax-table (if (c-major-mode-is 'c++-mode)
8297 c++-template-syntax-table
8302 (while ; keep going back to "[;={"s until we either find
8303 ; no more, or get to one which isn't an "operator ="
8304 (and (c-syntactic-re-search-forward "[;={]" start t t t)
8305 (eq (char-before) ?=)
8306 c-overloadable-operators-regexp
8307 c-opt-op-identifier-prefix
8309 (eq (c-backward-token-2) 0)
8310 (looking-at c-overloadable-operators-regexp)
8311 (eq (c-backward-token-2) 0)
8312 (looking-at c-opt-op-identifier-prefix))))
8313 (eq (char-before) ?=))
8314 (c-syntactic-re-search-forward "[;{]" start t t)
8315 (eq (char-before) ?{)
8316 (c-safe (goto-char (c-up-list-forward (point))) t)
8317 (not (c-syntactic-re-search-forward ";" start t t))))))
8321 (defun c-end-of-decl-1 ()
8322 ;; Assuming point is at the start of a declaration (as detected by
8323 ;; e.g. `c-beginning-of-decl-1'), go to the end of it. Unlike
8324 ;; `c-beginning-of-decl-1', this function handles the case when a
8325 ;; block is followed by identifiers in e.g. struct declarations in C
8326 ;; or C++. If a proper end was found then t is returned, otherwise
8327 ;; point is moved as far as possible within the current sexp and nil
8328 ;; is returned. This function doesn't handle macros; use
8329 ;; `c-end-of-macro' instead in those cases.
8331 ;; This function might do hidden buffer changes.
8332 (let ((start (point))
8333 (decl-syntax-table (if (c-major-mode-is 'c++-mode)
8334 c++-template-syntax-table
8337 (c-search-decl-header-end)
8339 (when (and c-recognize-knr-p
8340 (eq (char-before) ?\;)
8341 (c-in-knr-argdecl start))
8342 ;; Stopped at the ';' in a K&R argdecl section which is
8343 ;; detected using the same criteria as in
8344 ;; `c-beginning-of-decl-1'. Move to the following block
8346 (c-syntactic-re-search-forward "{" nil 'move t))
8348 (when (eq (char-before) ?{)
8349 ;; Encountered a block in the declaration. Jump over it.
8351 (goto-char (c-up-list-forward (point)))
8352 (error (goto-char (point-max))
8353 (throw 'return nil)))
8354 (if (or (not c-opt-block-decls-with-vars-key)
8356 (c-with-syntax-table decl-syntax-table
8357 (let ((lim (point)))
8360 ;; Check for `c-opt-block-decls-with-vars-key'
8361 ;; before the first paren.
8362 (c-syntactic-re-search-forward
8363 (concat "[;=\(\[{]\\|\\("
8364 c-opt-block-decls-with-vars-key
8368 (not (eq (char-before) ?_))
8369 ;; Check that the first following paren is
8371 (c-syntactic-re-search-forward "[;=\(\[{]"
8373 (eq (char-before) ?{)))))))
8374 ;; The declaration doesn't have any of the
8375 ;; `c-opt-block-decls-with-vars' keywords in the
8376 ;; beginning, so it ends here at the end of the block.
8379 (c-with-syntax-table decl-syntax-table
8381 (if (eq (char-before) ?\;)
8383 (c-syntactic-re-search-forward ";" nil 'move t))))
8386 (defun c-looking-at-decl-block (containing-sexp goto-start &optional limit)
8387 ;; Assuming the point is at an open brace, check if it starts a
8388 ;; block that contains another declaration level, i.e. that isn't a
8389 ;; statement block or a brace list, and if so return non-nil.
8391 ;; If the check is successful, the return value is the start of the
8392 ;; keyword that tells what kind of construct it is, i.e. typically
8393 ;; what `c-decl-block-key' matched. Also, if GOTO-START is set then
8394 ;; the point will be at the start of the construct, before any
8395 ;; leading specifiers, otherwise it's at the returned position.
8397 ;; The point is clobbered if the check is unsuccessful.
8399 ;; CONTAINING-SEXP is the position of the open of the surrounding
8400 ;; paren, or nil if none.
8402 ;; The optional LIMIT limits the backward search for the start of
8403 ;; the construct. It's assumed to be at a syntactically relevant
8406 ;; If any template arglists are found in the searched region before
8407 ;; the open brace, they get marked with paren syntax.
8409 ;; This function might do hidden buffer changes.
8411 (let ((open-brace (point)) kwd-start first-specifier-pos)
8412 (c-syntactic-skip-backward c-block-prefix-charset limit t)
8414 (when (and c-recognize-<>-arglists
8415 (eq (char-before) ?>))
8416 ;; Could be at the end of a template arglist.
8417 (let ((c-parse-and-markup-<>-arglists t)
8418 (c-disallow-comma-in-<>-arglists
8419 (and containing-sexp
8420 (not (eq (char-after containing-sexp) ?{)))))
8422 (c-backward-<>-arglist nil limit)
8424 (c-syntactic-skip-backward c-block-prefix-charset limit t)
8425 (eq (char-before) ?>))))))
8427 ;; Note: Can't get bogus hits inside template arglists below since they
8428 ;; have gotten paren syntax above.
8430 ;; If `goto-start' is set we begin by searching for the
8431 ;; first possible position of a leading specifier list.
8432 ;; The `c-decl-block-key' search continues from there since
8433 ;; we know it can't match earlier.
8435 (when (c-syntactic-re-search-forward c-symbol-start
8437 (goto-char (setq first-specifier-pos (match-beginning 0)))
8442 ((c-syntactic-re-search-forward c-decl-block-key open-brace t t t)
8443 (goto-char (setq kwd-start (match-beginning 0)))
8446 ;; Found a keyword that can't be a type?
8449 ;; Can be a type too, in which case it's the return type of a
8450 ;; function (under the assumption that no declaration level
8451 ;; block construct starts with a type).
8452 (not (c-forward-type))
8454 ;; Jumped over a type, but it could be a declaration keyword
8455 ;; followed by the declared identifier that we've jumped over
8456 ;; instead (e.g. in "class Foo {"). If it indeed is a type
8457 ;; then we should be at the declarator now, so check for a
8458 ;; valid declarator start.
8460 ;; Note: This doesn't cope with the case when a declared
8461 ;; identifier is followed by e.g. '(' in a language where '('
8462 ;; also might be part of a declarator expression. Currently
8463 ;; there's no such language.
8464 (not (or (looking-at c-symbol-start)
8465 (looking-at c-type-decl-prefix-key)))))
8467 ;; In Pike a list of modifiers may be followed by a brace
8468 ;; to make them apply to many identifiers. Note that the
8469 ;; match data will be empty on return in this case.
8470 ((and (c-major-mode-is 'pike-mode)
8472 (goto-char open-brace)
8473 (= (c-backward-token-2) 0))
8474 (looking-at c-specifier-key)
8475 ;; Use this variant to avoid yet another special regexp.
8476 (c-keyword-member (c-keyword-sym (match-string 1))
8478 (setq kwd-start (point))
8484 ;; Back up over any preceding specifiers and their clauses
8485 ;; by going forward from `first-specifier-pos', which is the
8486 ;; earliest possible position where the specifier list can
8489 (goto-char first-specifier-pos)
8491 (while (< (point) kwd-start)
8492 (if (looking-at c-symbol-key)
8493 ;; Accept any plain symbol token on the ground that
8494 ;; it's a specifier masked through a macro (just
8495 ;; like `c-forward-decl-or-cast-1' skip forward over
8498 ;; Could be more restrictive wrt invalid keywords,
8499 ;; but that'd only occur in invalid code so there's
8500 ;; no use spending effort on it.
8501 (let ((end (match-end 0)))
8502 (unless (c-forward-keyword-clause 0)
8504 (c-forward-syntactic-ws)))
8506 ;; Can't parse a declaration preamble and is still
8507 ;; before `kwd-start'. That means `first-specifier-pos'
8508 ;; was in some earlier construct. Search again.
8509 (if (c-syntactic-re-search-forward c-symbol-start
8511 (goto-char (setq first-specifier-pos (match-beginning 0)))
8512 ;; Got no preamble before the block declaration keyword.
8513 (setq first-specifier-pos kwd-start))))
8515 (goto-char first-specifier-pos))
8516 (goto-char kwd-start))
8520 (defun c-search-uplist-for-classkey (paren-state)
8521 ;; Check if the closest containing paren sexp is a declaration
8522 ;; block, returning a 2 element vector in that case. Aref 0
8523 ;; contains the bufpos at boi of the class key line, and aref 1
8524 ;; contains the bufpos of the open brace. This function is an
8525 ;; obsolete wrapper for `c-looking-at-decl-block'.
8527 ;; This function might do hidden buffer changes.
8528 (let ((open-paren-pos (c-most-enclosing-brace paren-state)))
8529 (when open-paren-pos
8531 (goto-char open-paren-pos)
8532 (when (and (eq (char-after) ?{)
8533 (c-looking-at-decl-block
8534 (c-safe-position open-paren-pos paren-state)
8536 (back-to-indentation)
8537 (vector (point) open-paren-pos))))))
8539 (defun c-most-enclosing-decl-block (paren-state)
8540 ;; Return the buffer position of the most enclosing decl-block brace (in the
8541 ;; sense of c-looking-at-decl-block) in the PAREN-STATE structure, or nil if
8543 (let* ((open-brace (c-pull-open-brace paren-state))
8544 (next-open-brace (c-pull-open-brace paren-state)))
8545 (while (and open-brace
8547 (goto-char open-brace)
8548 (not (c-looking-at-decl-block next-open-brace nil))))
8549 (setq open-brace next-open-brace
8550 next-open-brace (c-pull-open-brace paren-state)))
8553 (defun c-cheap-inside-bracelist-p (paren-state)
8554 ;; Return the position of the L-brace if point is inside a brace list
8555 ;; initialization of an array, etc. This is an approximate function,
8556 ;; designed for speed over accuracy. It will not find every bracelist, but
8557 ;; a non-nil result is reliable. We simply search for "= {" (naturally with
8558 ;; syntactic whitespace allowed). PAREN-STATE is the normal thing that it
8559 ;; is everywhere else.
8563 (and (setq b-pos (c-pull-open-brace paren-state))
8564 (progn (goto-char b-pos)
8566 (c-backward-token-2)
8567 (not (looking-at "=")))))
8570 (defun c-backward-over-enum-header ()
8571 ;; We're at a "{". Move back to the enum-like keyword that starts this
8572 ;; declaration and return t, otherwise don't move and return nil.
8573 (let ((here (point))
8574 up-sexp-pos before-identifier)
8577 (eq (c-backward-token-2) 0)
8578 (or (not (looking-at "\\s)"))
8579 (c-go-up-list-backward))
8581 ((and (looking-at c-symbol-key) (c-on-identifier)
8582 (not before-identifier))
8583 (setq before-identifier t))
8584 ((and before-identifier
8585 (or (eq (char-after) ?,)
8586 (looking-at c-postfix-decl-spec-key)))
8587 (setq before-identifier nil)
8589 ((looking-at c-brace-list-key) nil)
8590 ((and c-recognize-<>-arglists
8591 (eq (char-after) ?<)
8592 (looking-at "\\s("))
8595 (or (looking-at c-brace-list-key)
8596 (progn (goto-char here) nil))))
8598 (defun c-inside-bracelist-p (containing-sexp paren-state)
8599 ;; return the buffer position of the beginning of the brace list
8600 ;; statement if we're inside a brace list, otherwise return nil.
8601 ;; CONTAINING-SEXP is the buffer pos of the innermost containing
8602 ;; paren. PAREN-STATE is the remainder of the state of enclosing
8605 ;; N.B.: This algorithm can potentially get confused by cpp macros
8606 ;; placed in inconvenient locations. It's a trade-off we make for
8609 ;; This function might do hidden buffer changes.
8611 ;; This will pick up brace list declarations.
8613 (goto-char containing-sexp)
8614 (c-backward-over-enum-header))
8615 ;; this will pick up array/aggregate init lists, even if they are nested.
8618 ;; Pike can have class definitions anywhere, so we must
8619 ;; check for the class key here.
8620 (and (c-major-mode-is 'pike-mode)
8622 bufpos braceassignp lim next-containing macro-start)
8623 (while (and (not bufpos)
8626 (if (consp (car paren-state))
8627 (setq lim (cdr (car paren-state))
8628 paren-state (cdr paren-state))
8629 (setq lim (car paren-state)))
8631 (setq next-containing (car paren-state)
8632 paren-state (cdr paren-state))))
8633 (goto-char containing-sexp)
8634 (if (c-looking-at-inexpr-block next-containing next-containing)
8635 ;; We're in an in-expression block of some kind. Do not
8636 ;; check nesting. We deliberately set the limit to the
8637 ;; containing sexp, so that c-looking-at-inexpr-block
8638 ;; doesn't check for an identifier before it.
8639 (setq containing-sexp nil)
8640 ;; see if the open brace is preceded by = or [...] in
8641 ;; this statement, but watch out for operator=
8642 (setq braceassignp 'dontknow)
8643 (c-backward-token-2 1 t lim)
8644 ;; Checks to do only on the first sexp before the brace.
8645 (when (and c-opt-inexpr-brace-list-key
8646 (eq (char-after) ?\[))
8647 ;; In Java, an initialization brace list may follow
8648 ;; directly after "new Foo[]", so check for a "new"
8650 (while (eq braceassignp 'dontknow)
8652 (cond ((/= (c-backward-token-2 1 t lim) 0) nil)
8653 ((looking-at c-opt-inexpr-brace-list-key) t)
8654 ((looking-at "\\sw\\|\\s_\\|[.[]")
8655 ;; Carry on looking if this is an
8656 ;; identifier (may contain "." in Java)
8657 ;; or another "[]" sexp.
8660 ;; Checks to do on all sexps before the brace, up to the
8661 ;; beginning of the statement.
8662 (while (eq braceassignp 'dontknow)
8663 (cond ((eq (char-after) ?\;)
8664 (setq braceassignp nil))
8666 (looking-at class-key))
8667 (setq braceassignp nil))
8668 ((eq (char-after) ?=)
8669 ;; We've seen a =, but must check earlier tokens so
8670 ;; that it isn't something that should be ignored.
8671 (setq braceassignp 'maybe)
8672 (while (and (eq braceassignp 'maybe)
8673 (zerop (c-backward-token-2 1 t lim)))
8676 ;; Check for operator =
8677 ((and c-opt-op-identifier-prefix
8678 (looking-at c-opt-op-identifier-prefix))
8680 ;; Check for `<opchar>= in Pike.
8681 ((and (c-major-mode-is 'pike-mode)
8682 (or (eq (char-after) ?`)
8683 ;; Special case for Pikes
8684 ;; `[]=, since '[' is not in
8685 ;; the punctuation class.
8686 (and (eq (char-after) ?\[)
8687 (eq (char-before) ?`))))
8689 ((looking-at "\\s.") 'maybe)
8690 ;; make sure we're not in a C++ template
8691 ;; argument assignment
8693 (c-major-mode-is 'c++-mode)
8695 (let ((here (point))
8697 (skip-chars-backward "^<>")
8699 (and (eq (char-before) ?<)
8700 (not (c-crosses-statement-barrier-p
8702 (not (c-in-literal))
8706 (if (and (eq braceassignp 'dontknow)
8707 (/= (c-backward-token-2 1 t lim) 0))
8708 (setq braceassignp nil)))
8711 ;; We've hit the beginning of the aggregate list.
8712 (c-beginning-of-statement-1
8713 (c-most-enclosing-brace paren-state))
8714 (setq bufpos (point)))
8715 ((eq (char-after) ?\;)
8716 ;; Brace lists can't contain a semicolon, so we're done.
8717 (setq containing-sexp nil))
8718 ((and (setq macro-start (point))
8719 (c-forward-to-cpp-define-body)
8720 (eq (point) containing-sexp))
8721 ;; We've a macro whose expansion starts with the '{'.
8722 ;; Heuristically, if we have a ';' in it we've not got a
8723 ;; brace list, otherwise we have.
8724 (let ((macro-end (progn (c-end-of-macro) (point))))
8725 (goto-char containing-sexp)
8727 (if (and (c-syntactic-re-search-forward "[;,]" macro-end t t)
8728 (eq (char-before) ?\;))
8730 containing-sexp nil)
8731 (setq bufpos macro-start))))
8734 (setq containing-sexp next-containing
8736 next-containing nil)))))
8741 (defun c-looking-at-special-brace-list (&optional lim)
8742 ;; If we're looking at the start of a pike-style list, i.e., `({Â })',
8743 ;; `([Â ])', `(<Â >)', etc., a cons of a cons of its starting and ending
8744 ;; positions and its entry in c-special-brace-lists is returned, nil
8745 ;; otherwise. The ending position is nil if the list is still open.
8746 ;; LIM is the limit for forward search. The point may either be at
8747 ;; the `(' or at the following paren character. Tries to check the
8748 ;; matching closer, but assumes it's correct if no balanced paren is
8749 ;; found (i.e. the case `({ ... } ... )' is detected as _not_ being
8750 ;; a special brace list).
8752 ;; This function might do hidden buffer changes.
8753 (if c-special-brace-lists
8758 (c-forward-syntactic-ws)
8759 (if (eq (char-after) ?\()
8762 (c-forward-syntactic-ws)
8763 (setq inner-beg (point))
8764 (setq type (assq (char-after) c-special-brace-lists)))
8765 (if (setq type (assq (char-after) c-special-brace-lists))
8767 (setq inner-beg (point))
8768 (c-backward-syntactic-ws)
8770 (setq beg (if (eq (char-after) ?\()
8778 (= (char-before) ?\)))
8780 (goto-char inner-beg)
8781 (if (looking-at "\\s(")
8782 ;; Check balancing of the inner paren
8787 ;; If the inner char isn't a paren then
8788 ;; we can't check balancing, so just
8789 ;; check the char before the outer
8793 (c-backward-syntactic-ws)
8794 (= (char-before) (cdr type)))))
8795 (if (or (/= (char-syntax (char-before)) ?\))
8797 (c-forward-syntactic-ws)
8800 (cons (cons beg end) type))
8801 (cons (list beg) type)))))
8804 (defun c-looking-at-bos (&optional lim)
8805 ;; Return non-nil if between two statements or declarations, assuming
8806 ;; point is not inside a literal or comment.
8808 ;; Obsolete - `c-at-statement-start-p' or `c-at-expression-start-p'
8809 ;; are recommended instead.
8811 ;; This function might do hidden buffer changes.
8812 (c-at-statement-start-p))
8813 (make-obsolete 'c-looking-at-bos 'c-at-statement-start-p "22.1")
8815 (defun c-looking-at-inexpr-block (lim containing-sexp &optional check-at-end)
8816 ;; Return non-nil if we're looking at the beginning of a block
8817 ;; inside an expression. The value returned is actually a cons of
8818 ;; either 'inlambda, 'inexpr-statement or 'inexpr-class and the
8819 ;; position of the beginning of the construct.
8821 ;; LIM limits the backward search. CONTAINING-SEXP is the start
8822 ;; position of the closest containing list. If it's nil, the
8823 ;; containing paren isn't used to decide whether we're inside an
8824 ;; expression or not. If both LIM and CONTAINING-SEXP are used, LIM
8825 ;; needs to be farther back.
8827 ;; If CHECK-AT-END is non-nil then extra checks at the end of the
8828 ;; brace block might be done. It should only be used when the
8829 ;; construct can be assumed to be complete, i.e. when the original
8830 ;; starting position was further down than that.
8832 ;; This function might do hidden buffer changes.
8835 (let ((res 'maybe) passed-paren
8836 (closest-lim (or containing-sexp lim (point-min)))
8837 ;; Look at the character after point only as a last resort
8838 ;; when we can't disambiguate.
8839 (block-follows (and (eq (char-after) ?{) (point))))
8841 (while (and (eq res 'maybe)
8842 (progn (c-backward-syntactic-ws)
8843 (> (point) closest-lim))
8845 (progn (backward-char)
8846 (looking-at "[\]\).]\\|\\w\\|\\s_"))
8847 (c-safe (forward-char)
8848 (goto-char (scan-sexps (point) -1))))
8851 (if (looking-at c-keywords-regexp)
8852 (let ((kw-sym (c-keyword-sym (match-string 1))))
8855 (c-keyword-member kw-sym 'c-inexpr-class-kwds))
8856 (and (not (eq passed-paren ?\[))
8857 (or (not (looking-at c-class-key))
8858 ;; If the class definition is at the start of
8859 ;; a statement, we don't consider it an
8860 ;; in-expression class.
8861 (let ((prev (point)))
8863 (= (c-backward-token-2 1 nil closest-lim) 0)
8864 (eq (char-syntax (char-after)) ?w))
8865 (setq prev (point)))
8867 (not (c-at-statement-start-p)))
8868 ;; Also, in Pike we treat it as an
8869 ;; in-expression class if it's used in an
8870 ;; object clone expression.
8873 (c-major-mode-is 'pike-mode)
8874 (progn (goto-char block-follows)
8875 (zerop (c-forward-token-2 1 t)))
8876 (eq (char-after) ?\())))
8877 (cons 'inexpr-class (point))))
8878 ((c-keyword-member kw-sym 'c-inexpr-block-kwds)
8879 (when (not passed-paren)
8880 (cons 'inexpr-statement (point))))
8881 ((c-keyword-member kw-sym 'c-lambda-kwds)
8882 (when (or (not passed-paren)
8883 (eq passed-paren ?\())
8884 (cons 'inlambda (point))))
8885 ((c-keyword-member kw-sym 'c-block-stmt-kwds)
8890 (if (looking-at "\\s(")
8892 (if (and (eq passed-paren ?\[)
8893 (eq (char-after) ?\[))
8894 ;; Accept several square bracket sexps for
8895 ;; Java array initializations.
8897 (setq passed-paren (char-after))
8902 (when (and c-recognize-paren-inexpr-blocks
8905 (eq (char-after containing-sexp) ?\())
8906 (goto-char containing-sexp)
8907 (if (or (save-excursion
8908 (c-backward-syntactic-ws lim)
8909 (and (> (point) (or lim (point-min)))
8911 (and c-special-brace-lists
8912 (c-looking-at-special-brace-list)))
8914 (cons 'inexpr-statement (point))))
8918 (defun c-looking-at-inexpr-block-backward (paren-state)
8919 ;; Returns non-nil if we're looking at the end of an in-expression
8920 ;; block, otherwise the same as `c-looking-at-inexpr-block'.
8921 ;; PAREN-STATE is the paren state relevant at the current position.
8923 ;; This function might do hidden buffer changes.
8925 ;; We currently only recognize a block.
8926 (let ((here (point))
8927 (elem (car-safe paren-state))
8929 (when (and (consp elem)
8930 (progn (goto-char (cdr elem))
8931 (c-forward-syntactic-ws here)
8933 (goto-char (car elem))
8934 (if (setq paren-state (cdr paren-state))
8935 (setq containing-sexp (car-safe paren-state)))
8936 (c-looking-at-inexpr-block (c-safe-position containing-sexp
8938 containing-sexp)))))
8940 (defun c-at-macro-vsemi-p (&optional pos)
8941 ;; Is there a "virtual semicolon" at POS or point?
8942 ;; (See cc-defs.el for full details of "virtual semicolons".)
8944 ;; This is true when point is at the last non syntactic WS position on the
8945 ;; line, there is a macro call last on the line, and this particular macro's
8946 ;; name is defined by the regexp `c-vs-macro-regexp' as not needing a
8955 c-macro-with-semi-re
8956 (eq (skip-chars-backward " \t") 0)
8958 ;; Check we've got nothing after this except comments and empty lines
8959 ;; joined by escaped EOLs.
8960 (skip-chars-forward " \t") ; always returns non-nil.
8962 (while ; go over 1 block comment per iteration.
8964 (looking-at "\\(\\\\[\n\r][ \t]*\\)*")
8965 (goto-char (match-end 0))
8967 ((looking-at c-block-comment-start-regexp)
8968 (and (forward-comment 1)
8969 (skip-chars-forward " \t"))) ; always returns non-nil
8970 ((looking-at c-line-comment-start-regexp)
8977 (progn (c-backward-syntactic-ws)
8980 ;; Check for one of the listed macros being before point.
8981 (or (not (eq (char-before) ?\)))
8982 (when (c-go-list-backward)
8983 (c-backward-syntactic-ws)
8985 (c-simple-skip-symbol-backward)
8986 (looking-at c-macro-with-semi-re)
8988 (not (c-in-literal)))))) ; The most expensive check last.
8990 (defun c-macro-vsemi-status-unknown-p () t) ; See cc-defs.el.
8993 ;; `c-guess-basic-syntax' and the functions that precedes it below
8994 ;; implements the main decision tree for determining the syntactic
8995 ;; analysis of the current line of code.
8997 ;; Dynamically bound to t when `c-guess-basic-syntax' is called during
8998 ;; auto newline analysis.
8999 (defvar c-auto-newline-analysis nil)
9001 (defun c-brace-anchor-point (bracepos)
9002 ;; BRACEPOS is the position of a brace in a construct like "namespace
9003 ;; Bar {". Return the anchor point in this construct; this is the
9004 ;; earliest symbol on the brace's line which isn't earlier than
9007 ;; Currently (2007-08-17), "like namespace" means "matches
9008 ;; c-other-block-decl-kwds". It doesn't work with "class" or "struct"
9009 ;; or anything like that.
9011 (let ((boi (c-point 'boi bracepos)))
9012 (goto-char bracepos)
9013 (while (and (> (point) boi)
9014 (not (looking-at c-other-decl-block-key)))
9015 (c-backward-token-2))
9016 (if (> (point) boi) (point) boi))))
9018 (defsubst c-add-syntax (symbol &rest args)
9019 ;; A simple function to prepend a new syntax element to
9020 ;; `c-syntactic-context'. Using `setq' on it is unsafe since it
9021 ;; should always be dynamically bound but since we read it first
9022 ;; we'll fail properly anyway if this function is misused.
9023 (setq c-syntactic-context (cons (cons symbol args)
9024 c-syntactic-context)))
9026 (defsubst c-append-syntax (symbol &rest args)
9027 ;; Like `c-add-syntax' but appends to the end of the syntax list.
9028 ;; (Normally not necessary.)
9029 (setq c-syntactic-context (nconc c-syntactic-context
9030 (list (cons symbol args)))))
9032 (defun c-add-stmt-syntax (syntax-symbol
9037 ;; Add the indicated SYNTAX-SYMBOL to `c-syntactic-context', extending it as
9038 ;; needed with further syntax elements of the types `substatement',
9039 ;; `inexpr-statement', `arglist-cont-nonempty', `statement-block-intro', and
9040 ;; `defun-block-intro'.
9042 ;; Do the generic processing to anchor the given syntax symbol on
9043 ;; the preceding statement: Skip over any labels and containing
9044 ;; statements on the same line, and then search backward until we
9045 ;; find a statement or block start that begins at boi without a
9046 ;; label or comment.
9048 ;; Point is assumed to be at the prospective anchor point for the
9049 ;; given SYNTAX-SYMBOL. More syntax entries are added if we need to
9050 ;; skip past open parens and containing statements. Most of the added
9051 ;; syntax elements will get the same anchor point - the exception is
9052 ;; for an anchor in a construct like "namespace"[*] - this is as early
9053 ;; as possible in the construct but on the same line as the {.
9055 ;; [*] i.e. with a keyword matching c-other-block-decl-kwds.
9057 ;; SYNTAX-EXTRA-ARGS are a list of the extra arguments for the
9058 ;; syntax symbol. They are appended after the anchor point.
9060 ;; If STOP-AT-BOI-ONLY is nil, we can stop in the middle of the line
9061 ;; if the current statement starts there.
9063 ;; Note: It's not a problem if PAREN-STATE "overshoots"
9064 ;; CONTAINING-SEXP, i.e. contains info about parens further down.
9066 ;; This function might do hidden buffer changes.
9068 (if (= (point) (c-point 'boi))
9069 ;; This is by far the most common case, so let's give it special
9071 (apply 'c-add-syntax syntax-symbol (point) syntax-extra-args)
9073 (let ((syntax-last c-syntactic-context)
9074 (boi (c-point 'boi))
9075 ;; Set when we're on a label, so that we don't stop there.
9076 ;; FIXME: To be complete we should check if we're on a label
9077 ;; now at the start.
9080 ;; Use point as the anchor point for "namespace", "extern", etc.
9081 (apply 'c-add-syntax syntax-symbol
9082 (if (rassq syntax-symbol c-other-decl-block-key-in-symbols-alist)
9086 ;; Loop while we have to back out of containing blocks.
9089 (catch 'back-up-block
9091 ;; Loop while we have to back up statements.
9092 (while (or (/= (point) boi)
9094 (looking-at c-comment-start-regexp))
9096 ;; Skip past any comments that stands between the
9097 ;; statement start and boi.
9098 (let ((savepos (point)))
9099 (while (and (/= savepos boi)
9100 (c-backward-single-comment))
9101 (setq savepos (point)
9102 boi (c-point 'boi)))
9103 (goto-char savepos))
9105 ;; Skip to the beginning of this statement or backward
9107 (let ((old-pos (point))
9109 (step-type (c-beginning-of-statement-1 containing-sexp)))
9110 (setq boi (c-point 'boi)
9111 on-label (eq step-type 'label))
9113 (cond ((= (point) old-pos)
9114 ;; If we didn't move we're at the start of a block and
9115 ;; have to continue outside it.
9116 (throw 'back-up-block t))
9118 ((and (eq step-type 'up)
9119 (>= (point) old-boi)
9120 (looking-at "else\\>[^_]")
9123 (looking-at "if\\>[^_]")))
9124 ;; Special case to avoid deeper and deeper indentation
9125 ;; of "else if" clauses.
9128 ((and (not stop-at-boi-only)
9129 (/= old-pos old-boi)
9130 (memq step-type '(up previous)))
9131 ;; If stop-at-boi-only is nil, we shouldn't back up
9132 ;; over previous or containing statements to try to
9133 ;; reach boi, so go back to the last position and
9136 (throw 'back-up-block nil))
9139 (if (and (not stop-at-boi-only)
9140 (memq step-type '(up previous beginning)))
9141 ;; If we've moved into another statement then we
9142 ;; should no longer try to stop in the middle of a
9144 (setq stop-at-boi-only t))
9146 ;; Record this as a substatement if we skipped up one
9148 (when (eq step-type 'up)
9149 (c-add-syntax 'substatement nil))))
9154 ;; Now we have to go out of this block.
9155 (goto-char containing-sexp)
9157 ;; Don't stop in the middle of a special brace list opener
9159 (when c-special-brace-lists
9160 (let ((special-list (c-looking-at-special-brace-list)))
9161 (when (and special-list
9162 (< (car (car special-list)) (point)))
9163 (setq containing-sexp (car (car special-list)))
9164 (goto-char containing-sexp))))
9166 (setq paren-state (c-whack-state-after containing-sexp paren-state)
9167 containing-sexp (c-most-enclosing-brace paren-state)
9170 ;; Analyze the construct in front of the block we've stepped out
9171 ;; from and add the right syntactic element for it.
9172 (let ((paren-pos (point))
9173 (paren-char (char-after))
9176 (if (eq paren-char ?\()
9177 ;; Stepped out of a parenthesis block, so we're in an
9180 (when (/= paren-pos boi)
9181 (if (and c-recognize-paren-inexpr-blocks
9183 (c-backward-syntactic-ws containing-sexp)
9184 (or (not (looking-at "\\>"))
9185 (not (c-on-identifier))))
9187 (goto-char (1+ paren-pos))
9188 (c-forward-syntactic-ws)
9189 (eq (char-after) ?{)))
9190 ;; Stepped out of an in-expression statement. This
9191 ;; syntactic element won't get an anchor pos.
9192 (c-add-syntax 'inexpr-statement)
9194 ;; A parenthesis normally belongs to an arglist.
9195 (c-add-syntax 'arglist-cont-nonempty nil paren-pos)))
9199 (1+ containing-sexp)
9201 (setq step-type 'same
9204 ;; Stepped out of a brace block.
9205 (setq step-type (c-beginning-of-statement-1 containing-sexp)
9206 on-label (eq step-type 'label))
9208 (if (and (eq step-type 'same)
9209 (/= paren-pos (point)))
9213 (goto-char paren-pos)
9214 (setq inexpr (c-looking-at-inexpr-block
9215 (c-safe-position containing-sexp paren-state)
9217 (c-add-syntax (if (eq (car inexpr) 'inlambda)
9219 'statement-block-intro)
9221 ((looking-at c-other-decl-block-key)
9223 (cdr (assoc (match-string 1)
9224 c-other-decl-block-key-in-symbols-alist))
9225 (max (c-point 'boi paren-pos) (point))))
9226 (t (c-add-syntax 'defun-block-intro nil))))
9228 (c-add-syntax 'statement-block-intro nil)))
9230 (if (= paren-pos boi)
9231 ;; Always done if the open brace was at boi. The
9232 ;; c-beginning-of-statement-1 call above is necessary
9233 ;; anyway, to decide the type of block-intro to add.
9234 (goto-char paren-pos)
9235 (setq boi (c-point 'boi)))
9238 ;; Fill in the current point as the anchor for all the symbols
9240 (let ((p c-syntactic-context) q)
9241 (while (not (eq p syntax-last))
9242 (setq q (cdr (car p))) ; e.g. (nil 28) [from (arglist-cont-nonempty nil 28)]
9250 (defun c-add-class-syntax (symbol
9251 containing-decl-open
9252 containing-decl-start
9255 ;; The inclass and class-close syntactic symbols are added in
9256 ;; several places and some work is needed to fix everything.
9257 ;; Therefore it's collected here.
9259 ;; This function might do hidden buffer changes.
9260 (goto-char containing-decl-open)
9261 (if (and (eq symbol 'inclass) (= (point) (c-point 'boi)))
9263 (c-add-syntax symbol containing-decl-open)
9264 containing-decl-open)
9265 (goto-char containing-decl-start)
9266 ;; Ought to use `c-add-stmt-syntax' instead of backing up to boi
9267 ;; here, but we have to do like this for compatibility.
9268 (back-to-indentation)
9269 (c-add-syntax symbol (point))
9270 (if (and (c-keyword-member containing-decl-kwd
9271 'c-inexpr-class-kwds)
9272 (/= containing-decl-start (c-point 'boi containing-decl-start)))
9273 (c-add-syntax 'inexpr-class))
9276 (defun c-guess-continued-construct (indent-point
9278 beg-of-same-or-containing-stmt
9281 ;; This function contains the decision tree reached through both
9282 ;; cases 18 and 10. It's a continued statement or top level
9283 ;; construct of some kind.
9285 ;; This function might do hidden buffer changes.
9287 (let (special-brace-list placeholder)
9288 (goto-char indent-point)
9289 (skip-chars-forward " \t")
9292 ;; (CASE A removed.)
9293 ;; CASE B: open braces for class or brace-lists
9294 ((setq special-brace-list
9295 (or (and c-special-brace-lists
9296 (c-looking-at-special-brace-list))
9297 (eq char-after-ip ?{)))
9300 ;; CASE B.1: class-open
9302 (and (eq (char-after) ?{)
9303 (c-looking-at-decl-block containing-sexp t)
9304 (setq beg-of-same-or-containing-stmt (point))))
9305 (c-add-syntax 'class-open beg-of-same-or-containing-stmt))
9307 ;; CASE B.2: brace-list-open
9308 ((or (consp special-brace-list)
9310 (goto-char beg-of-same-or-containing-stmt)
9311 (c-syntactic-re-search-forward "=\\([^=]\\|$\\)"
9312 indent-point t t t)))
9313 ;; The most semantically accurate symbol here is
9314 ;; brace-list-open, but we normally report it simply as a
9315 ;; statement-cont. The reason is that one normally adjusts
9316 ;; brace-list-open for brace lists as top-level constructs,
9317 ;; and brace lists inside statements is a completely different
9318 ;; context. C.f. case 5A.3.
9319 (c-beginning-of-statement-1 containing-sexp)
9320 (c-add-stmt-syntax (if c-auto-newline-analysis
9321 ;; Turn off the dwim above when we're
9322 ;; analyzing the nature of the brace
9323 ;; for the auto newline feature.
9327 containing-sexp paren-state))
9329 ;; CASE B.3: The body of a function declared inside a normal
9330 ;; block. Can occur e.g. in Pike and when using gcc
9331 ;; extensions, but watch out for macros followed by blocks.
9332 ;; C.f. cases E, 16F and 17G.
9333 ((and (not (c-at-statement-start-p))
9334 (eq (c-beginning-of-statement-1 containing-sexp nil nil t)
9337 (let ((c-recognize-typeless-decls nil))
9338 ;; Turn off recognition of constructs that lacks a
9339 ;; type in this case, since that's more likely to be
9340 ;; a macro followed by a block.
9341 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
9342 (c-add-stmt-syntax 'defun-open nil t
9343 containing-sexp paren-state))
9345 ;; CASE B.4: Continued statement with block open. The most
9346 ;; accurate analysis is perhaps `statement-cont' together with
9347 ;; `block-open' but we play DWIM and use `substatement-open'
9348 ;; instead. The rationale is that this typically is a macro
9349 ;; followed by a block which makes it very similar to a
9350 ;; statement with a substatement block.
9352 (c-add-stmt-syntax 'substatement-open nil nil
9353 containing-sexp paren-state))
9356 ;; CASE C: iostream insertion or extraction operator
9357 ((and (looking-at "\\(<<\\|>>\\)\\([^=]\\|$\\)")
9359 (goto-char beg-of-same-or-containing-stmt)
9360 ;; If there is no preceding streamop in the statement
9361 ;; then indent this line as a normal statement-cont.
9362 (when (c-syntactic-re-search-forward
9363 "\\(<<\\|>>\\)\\([^=]\\|$\\)" indent-point 'move t t)
9364 (c-add-syntax 'stream-op (c-point 'boi))
9367 ;; CASE E: In the "K&R region" of a function declared inside a
9368 ;; normal block. C.f. case B.3.
9369 ((and (save-excursion
9370 ;; Check that the next token is a '{'. This works as
9371 ;; long as no language that allows nested function
9372 ;; definitions allows stuff like member init lists, K&R
9373 ;; declarations or throws clauses there.
9375 ;; Note that we do a forward search for something ahead
9376 ;; of the indentation line here. That's not good since
9377 ;; the user might not have typed it yet. Unfortunately
9378 ;; it's exceedingly tricky to recognize a function
9379 ;; prototype in a code block without resorting to this.
9380 (c-forward-syntactic-ws)
9381 (eq (char-after) ?{))
9382 (not (c-at-statement-start-p))
9383 (eq (c-beginning-of-statement-1 containing-sexp nil nil t)
9386 (let ((c-recognize-typeless-decls nil))
9387 ;; Turn off recognition of constructs that lacks a
9388 ;; type in this case, since that's more likely to be
9389 ;; a macro followed by a block.
9390 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
9391 (c-add-stmt-syntax 'func-decl-cont nil t
9392 containing-sexp paren-state))
9394 ;;CASE F: continued statement and the only preceding items are
9396 ((and (c-major-mode-is 'java-mode)
9397 (setq placeholder (point))
9398 (c-beginning-of-statement-1)
9400 (while (and (c-forward-annotation)
9401 (< (point) placeholder))
9402 (c-forward-syntactic-ws))
9405 (>= (point) placeholder)
9406 (goto-char placeholder)))
9407 (c-beginning-of-statement-1 containing-sexp)
9408 (c-add-syntax 'annotation-var-cont (point)))
9410 ;; CASE G: a template list continuation?
9411 ;; Mostly a duplication of case 5D.3 to fix templates-19:
9412 ((and (c-major-mode-is 'c++-mode)
9414 (goto-char indent-point)
9415 (c-with-syntax-table c++-template-syntax-table
9416 (setq placeholder (c-up-list-backward)))
9418 (eq (char-after placeholder) ?<)
9419 (/= (char-before placeholder) ?<)
9421 (goto-char (1+ placeholder))
9422 (not (looking-at c-<-op-cont-regexp))))))
9423 (c-with-syntax-table c++-template-syntax-table
9424 (goto-char placeholder)
9425 (c-beginning-of-statement-1 containing-sexp t))
9427 (c-backward-syntactic-ws containing-sexp)
9428 (eq (char-before) ?<))
9429 ;; In a nested template arglist.
9431 (goto-char placeholder)
9432 (c-syntactic-skip-backward "^,;" containing-sexp t)
9433 (c-forward-syntactic-ws))
9434 (back-to-indentation))
9435 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
9437 (c-add-syntax 'template-args-cont (point) placeholder))
9439 ;; CASE D: continued statement.
9441 (c-beginning-of-statement-1 containing-sexp)
9442 (c-add-stmt-syntax 'statement-cont nil nil
9443 containing-sexp paren-state))
9446 ;; The next autoload was added by RMS on 2005/8/9 - don't know why (ACM,
9449 (defun c-guess-basic-syntax ()
9450 "Return the syntactic context of the current line."
9453 (c-save-buffer-state
9454 ((indent-point (point))
9455 (case-fold-search nil)
9456 open-paren-in-column-0-is-defun-start
9457 ;; A whole ugly bunch of various temporary variables. Have
9458 ;; to declare them here since it's not possible to declare
9459 ;; a variable with only the scope of a cond test and the
9460 ;; following result clauses, and most of this function is a
9461 ;; single gigantic cond. :P
9462 literal char-before-ip before-ws-ip char-after-ip macro-start
9463 in-macro-expr c-syntactic-context placeholder c-in-literal-cache
9464 step-type tmpsymbol keyword injava-inher special-brace-list tmp-pos
9466 ;; The following record some positions for the containing
9467 ;; declaration block if we're directly within one:
9468 ;; `containing-decl-open' is the position of the open
9469 ;; brace. `containing-decl-start' is the start of the
9470 ;; declaration. `containing-decl-kwd' is the keyword
9471 ;; symbol of the keyword that tells what kind of block it
9473 containing-decl-open
9474 containing-decl-start
9476 ;; The open paren of the closest surrounding sexp or nil if
9479 ;; The position after the closest preceding brace sexp
9480 ;; (nested sexps are ignored), or the position after
9481 ;; `containing-sexp' if there is none, or (point-min) if
9482 ;; `containing-sexp' is nil.
9484 ;; The paren state outside `containing-sexp', or at
9485 ;; `indent-point' if `containing-sexp' is nil.
9486 (paren-state (c-parse-state))
9487 ;; There's always at most one syntactic element which got
9488 ;; an anchor pos. It's stored in syntactic-relpos.
9490 (c-stmt-delim-chars c-stmt-delim-chars))
9492 ;; Check if we're directly inside an enclosing declaration
9494 (when (and (setq containing-sexp
9495 (c-most-enclosing-brace paren-state))
9497 (goto-char containing-sexp)
9498 (eq (char-after) ?{))
9500 (c-looking-at-decl-block
9501 (c-most-enclosing-brace paren-state
9504 (setq containing-decl-open containing-sexp
9505 containing-decl-start (point)
9506 containing-sexp nil)
9507 (goto-char placeholder)
9508 (setq containing-decl-kwd (and (looking-at c-keywords-regexp)
9509 (c-keyword-sym (match-string 1)))))
9511 ;; Init some position variables.
9514 (setq containing-sexp (car paren-state)
9515 paren-state (cdr paren-state))
9516 (if (consp containing-sexp)
9518 (setq lim (cdr containing-sexp))
9519 (if (cdr c-state-cache)
9520 ;; Ignore balanced paren. The next entry
9521 ;; can't be another one.
9522 (setq containing-sexp (car (cdr c-state-cache))
9523 paren-state (cdr paren-state))
9524 ;; If there is no surrounding open paren then
9525 ;; put the last balanced pair back on paren-state.
9526 (setq paren-state (cons containing-sexp paren-state)
9527 containing-sexp nil)))
9528 (setq lim (1+ containing-sexp))))
9529 (setq lim (point-min)))
9531 ;; If we're in a parenthesis list then ',' delimits the
9532 ;; "statements" rather than being an operator (with the
9533 ;; exception of the "for" clause). This difference is
9534 ;; typically only noticeable when statements are used in macro
9536 (when (and containing-sexp
9537 (eq (char-after containing-sexp) ?\())
9538 (setq c-stmt-delim-chars c-stmt-delim-chars-with-comma))
9539 ;; cache char before and after indent point, and move point to
9540 ;; the most likely position to perform the majority of tests
9541 (goto-char indent-point)
9542 (c-backward-syntactic-ws lim)
9543 (setq before-ws-ip (point)
9544 char-before-ip (char-before))
9545 (goto-char indent-point)
9546 (skip-chars-forward " \t")
9547 (setq char-after-ip (char-after))
9549 ;; are we in a literal?
9550 (setq literal (c-in-literal lim))
9552 ;; now figure out syntactic qualities of the current line
9555 ;; CASE 1: in a string.
9556 ((eq literal 'string)
9557 (c-add-syntax 'string (c-point 'bopl)))
9559 ;; CASE 2: in a C or C++ style comment.
9560 ((and (memq literal '(c c++))
9561 ;; This is a kludge for XEmacs where we use
9562 ;; `buffer-syntactic-context', which doesn't correctly
9563 ;; recognize "\*/" to end a block comment.
9564 ;; `parse-partial-sexp' which is used by
9565 ;; `c-literal-limits' will however do that in most
9566 ;; versions, which results in that we get nil from
9567 ;; `c-literal-limits' even when `c-in-literal' claims
9568 ;; we're inside a comment.
9569 (setq placeholder (c-literal-limits lim)))
9570 (c-add-syntax literal (car placeholder)))
9572 ;; CASE 3: in a cpp preprocessor macro continuation.
9573 ((and (save-excursion
9574 (when (c-beginning-of-macro)
9575 (setq macro-start (point))))
9576 (/= macro-start (c-point 'boi))
9578 (setq tmpsymbol 'cpp-macro-cont)
9579 (or (not c-syntactic-indentation-in-macros)
9581 (goto-char macro-start)
9582 ;; If at the beginning of the body of a #define
9583 ;; directive then analyze as cpp-define-intro
9584 ;; only. Go on with the syntactic analysis
9585 ;; otherwise. in-macro-expr is set if we're in a
9586 ;; cpp expression, i.e. before the #define body
9587 ;; or anywhere in a non-#define directive.
9588 (if (c-forward-to-cpp-define-body)
9589 (let ((indent-boi (c-point 'boi indent-point)))
9590 (setq in-macro-expr (> (point) indent-boi)
9591 tmpsymbol 'cpp-define-intro)
9592 (= (point) indent-boi))
9593 (setq in-macro-expr t)
9595 (c-add-syntax tmpsymbol macro-start)
9596 (setq macro-start nil))
9598 ;; CASE 11: an else clause?
9599 ((looking-at "else\\>[^_]")
9600 (c-beginning-of-statement-1 containing-sexp)
9601 (c-add-stmt-syntax 'else-clause nil t
9602 containing-sexp paren-state))
9604 ;; CASE 12: while closure of a do/while construct?
9605 ((and (looking-at "while\\>[^_]")
9607 (prog1 (eq (c-beginning-of-statement-1 containing-sexp)
9609 (setq placeholder (point)))))
9610 (goto-char placeholder)
9611 (c-add-stmt-syntax 'do-while-closure nil t
9612 containing-sexp paren-state))
9614 ;; CASE 13: A catch or finally clause? This case is simpler
9615 ;; than if-else and do-while, because a block is required
9616 ;; after every try, catch and finally.
9618 (and (cond ((c-major-mode-is 'c++-mode)
9619 (looking-at "catch\\>[^_]"))
9620 ((c-major-mode-is 'java-mode)
9621 (looking-at "\\(catch\\|finally\\)\\>[^_]")))
9622 (and (c-safe (c-backward-syntactic-ws)
9625 (eq (char-after) ?{)
9626 (c-safe (c-backward-syntactic-ws)
9629 (if (eq (char-after) ?\()
9630 (c-safe (c-backward-sexp) t)
9632 (looking-at "\\(try\\|catch\\)\\>[^_]")
9633 (setq placeholder (point))))
9634 (goto-char placeholder)
9635 (c-add-stmt-syntax 'catch-clause nil t
9636 containing-sexp paren-state))
9638 ;; CASE 18: A substatement we can recognize by keyword.
9640 (and c-opt-block-stmt-key
9641 (not (eq char-before-ip ?\;))
9642 (not (c-at-vsemi-p before-ws-ip))
9643 (not (memq char-after-ip '(?\) ?\] ?,)))
9644 (or (not (eq char-before-ip ?}))
9645 (c-looking-at-inexpr-block-backward c-state-cache))
9648 ;; Ought to cache the result from the
9649 ;; c-beginning-of-statement-1 calls here.
9650 (setq placeholder (point))
9651 (while (eq (setq step-type
9652 (c-beginning-of-statement-1 lim))
9654 (if (eq step-type 'previous)
9655 (goto-char placeholder)
9656 (setq placeholder (point))
9657 (if (and (eq step-type 'same)
9658 (not (looking-at c-opt-block-stmt-key)))
9659 ;; Step up to the containing statement if we
9660 ;; stayed in the same one.
9664 (c-beginning-of-statement-1 lim))
9667 (setq placeholder (point))
9668 ;; There was no containing statement after all.
9669 (goto-char placeholder)))))
9671 (if (looking-at c-block-stmt-2-key)
9672 ;; Require a parenthesis after these keywords.
9673 ;; Necessary to catch e.g. synchronized in Java,
9674 ;; which can be used both as statement and
9676 (and (zerop (c-forward-token-2 1 nil))
9677 (eq (char-after) ?\())
9678 (looking-at c-opt-block-stmt-key))))
9680 (if (eq step-type 'up)
9681 ;; CASE 18A: Simple substatement.
9683 (goto-char placeholder)
9685 ((eq char-after-ip ?{)
9686 (c-add-stmt-syntax 'substatement-open nil nil
9687 containing-sexp paren-state))
9689 (goto-char indent-point)
9690 (back-to-indentation)
9692 (c-add-stmt-syntax 'substatement-label nil nil
9693 containing-sexp paren-state))
9695 (c-add-stmt-syntax 'substatement nil nil
9696 containing-sexp paren-state))))
9698 ;; CASE 18B: Some other substatement. This is shared
9700 (c-guess-continued-construct indent-point
9706 ;; CASE 14: A case or default label
9707 ((looking-at c-label-kwds-regexp)
9710 (goto-char containing-sexp)
9711 (setq lim (c-most-enclosing-brace c-state-cache
9713 (c-backward-to-block-anchor lim)
9714 (c-add-stmt-syntax 'case-label nil t lim paren-state))
9715 ;; Got a bogus label at the top level. In lack of better
9716 ;; alternatives, anchor it on (point-min).
9717 (c-add-syntax 'case-label (point-min))))
9719 ;; CASE 15: any other label
9721 (back-to-indentation)
9722 (and (not (looking-at c-syntactic-ws-start))
9724 (cond (containing-decl-open
9725 (setq placeholder (c-add-class-syntax 'inclass
9726 containing-decl-open
9727 containing-decl-start
9730 ;; Append access-label with the same anchor point as
9732 (c-append-syntax 'access-label placeholder))
9735 (goto-char containing-sexp)
9736 (setq lim (c-most-enclosing-brace c-state-cache
9740 (if (and (eq (c-beginning-of-statement-1 lim) 'up)
9741 (looking-at "switch\\>[^_]"))
9742 ;; If the surrounding statement is a switch then
9743 ;; let's analyze all labels as switch labels, so
9744 ;; that they get lined up consistently.
9747 (c-backward-to-block-anchor lim)
9748 (c-add-stmt-syntax tmpsymbol nil t lim paren-state))
9751 ;; A label on the top level. Treat it as a class
9752 ;; context. (point-min) is the closest we get to the
9753 ;; class open brace.
9754 (c-add-syntax 'access-label (point-min)))))
9756 ;; CASE 4: In-expression statement. C.f. cases 7B, 16A and
9758 ((setq placeholder (c-looking-at-inexpr-block
9759 (c-safe-position containing-sexp paren-state)
9761 ;; Have to turn on the heuristics after
9762 ;; the point even though it doesn't work
9763 ;; very well. C.f. test case class-16.pike.
9765 (setq tmpsymbol (assq (car placeholder)
9766 '((inexpr-class . class-open)
9767 (inexpr-statement . block-open))))
9769 ;; It's a statement block or an anonymous class.
9770 (setq tmpsymbol (cdr tmpsymbol))
9771 ;; It's a Pike lambda. Check whether we are between the
9772 ;; lambda keyword and the argument list or at the defun
9774 (setq tmpsymbol (if (eq char-after-ip ?{)
9776 'lambda-intro-cont)))
9777 (goto-char (cdr placeholder))
9778 (back-to-indentation)
9779 (c-add-stmt-syntax tmpsymbol nil t
9780 (c-most-enclosing-brace c-state-cache (point))
9782 (unless (eq (point) (cdr placeholder))
9783 (c-add-syntax (car placeholder))))
9785 ;; CASE 5: Line is inside a declaration level block or at top level.
9786 ((or containing-decl-open (null containing-sexp))
9789 ;; CASE 5A: we are looking at a defun, brace list, class,
9790 ;; or inline-inclass method opening brace
9791 ((setq special-brace-list
9792 (or (and c-special-brace-lists
9793 (c-looking-at-special-brace-list))
9794 (eq char-after-ip ?{)))
9797 ;; CASE 5A.1: Non-class declaration block open.
9800 (and (eq char-after-ip ?{)
9801 (setq tmp (c-looking-at-decl-block containing-sexp t))
9803 (setq placeholder (point))
9805 (looking-at c-symbol-key))
9807 (c-keyword-sym (setq keyword (match-string 0)))
9808 'c-other-block-decl-kwds))))
9809 (goto-char placeholder)
9811 (if (string-equal keyword "extern")
9812 ;; Special case for extern-lang-open.
9814 (intern (concat keyword "-open")))
9815 nil t containing-sexp paren-state))
9817 ;; CASE 5A.2: we are looking at a class opening brace
9819 (goto-char indent-point)
9820 (skip-chars-forward " \t")
9821 (and (eq (char-after) ?{)
9822 (c-looking-at-decl-block containing-sexp t)
9823 (setq placeholder (point))))
9824 (c-add-syntax 'class-open placeholder))
9826 ;; CASE 5A.3: brace list open
9828 (c-beginning-of-decl-1 lim)
9829 (while (looking-at c-specifier-key)
9830 (goto-char (match-end 1))
9831 (c-forward-syntactic-ws indent-point))
9832 (setq placeholder (c-point 'boi))
9833 (or (consp special-brace-list)
9834 (and (or (save-excursion
9835 (goto-char indent-point)
9836 (setq tmpsymbol nil)
9837 (while (and (> (point) placeholder)
9838 (zerop (c-backward-token-2 1 t))
9839 (not (looking-at "=\\([^=]\\|$\\)")))
9840 (and c-opt-inexpr-brace-list-key
9842 (looking-at c-opt-inexpr-brace-list-key)
9843 (setq tmpsymbol 'topmost-intro-cont)))
9844 (looking-at "=\\([^=]\\|$\\)"))
9845 (looking-at c-brace-list-key))
9847 (while (and (< (point) indent-point)
9848 (zerop (c-forward-token-2 1 t))
9849 (not (memq (char-after) '(?\; ?\()))))
9850 (not (memq (char-after) '(?\; ?\()))
9852 (if (and (not c-auto-newline-analysis)
9853 (c-major-mode-is 'java-mode)
9854 (eq tmpsymbol 'topmost-intro-cont))
9855 ;; We're in Java and have found that the open brace
9856 ;; belongs to a "new Foo[]" initialization list,
9857 ;; which means the brace list is part of an
9858 ;; expression and not a top level definition. We
9859 ;; therefore treat it as any topmost continuation
9860 ;; even though the semantically correct symbol still
9861 ;; is brace-list-open, on the same grounds as in
9864 (c-beginning-of-statement-1 lim)
9865 (c-add-syntax 'topmost-intro-cont (c-point 'boi)))
9866 (c-add-syntax 'brace-list-open placeholder)))
9868 ;; CASE 5A.4: inline defun open
9869 ((and containing-decl-open
9870 (not (c-keyword-member containing-decl-kwd
9871 'c-other-block-decl-kwds)))
9872 (c-add-syntax 'inline-open)
9873 (c-add-class-syntax 'inclass
9874 containing-decl-open
9875 containing-decl-start
9879 ;; CASE 5A.5: ordinary defun open
9882 (c-beginning-of-decl-1 lim)
9883 (while (looking-at c-specifier-key)
9884 (goto-char (match-end 1))
9885 (c-forward-syntactic-ws indent-point))
9886 (c-add-syntax 'defun-open (c-point 'boi))
9887 ;; Bogus to use bol here, but it's the legacy. (Resolved,
9891 ;; CASE 5R: Member init list. (Used to be part of CASE 5B.1)
9892 ;; Note there is no limit on the backward search here, since member
9893 ;; init lists can, in practice, be very large.
9895 (when (setq placeholder (c-back-over-member-initializers))
9896 (setq tmp-pos (point))))
9897 (if (= (c-point 'bosws) (1+ tmp-pos))
9899 ;; There is no preceding member init clause.
9900 ;; Indent relative to the beginning of indentation
9901 ;; for the topmost-intro line that contains the
9902 ;; prototype's open paren.
9903 (goto-char placeholder)
9904 (c-add-syntax 'member-init-intro (c-point 'boi)))
9905 ;; Indent relative to the first member init clause.
9906 (goto-char (1+ tmp-pos))
9907 (c-forward-syntactic-ws)
9908 (c-add-syntax 'member-init-cont (point))))
9910 ;; CASE 5B: After a function header but before the body (or
9911 ;; the ending semicolon if there's no body).
9913 (when (setq placeholder (c-just-after-func-arglist-p
9914 (max lim (c-determine-limit 500))))
9915 (setq tmp-pos (point))))
9918 ;; CASE 5B.1: Member init list.
9919 ((eq (char-after tmp-pos) ?:)
9920 ;; There is no preceding member init clause.
9921 ;; Indent relative to the beginning of indentation
9922 ;; for the topmost-intro line that contains the
9923 ;; prototype's open paren.
9924 (goto-char placeholder)
9925 (c-add-syntax 'member-init-intro (c-point 'boi)))
9927 ;; CASE 5B.2: K&R arg decl intro
9928 ((and c-recognize-knr-p
9929 (c-in-knr-argdecl lim))
9930 (c-beginning-of-statement-1 lim)
9931 (c-add-syntax 'knr-argdecl-intro (c-point 'boi))
9932 (if containing-decl-open
9933 (c-add-class-syntax 'inclass
9934 containing-decl-open
9935 containing-decl-start
9939 ;; CASE 5B.4: Nether region after a C++ or Java func
9940 ;; decl, which could include a `throws' declaration.
9942 (c-beginning-of-statement-1 lim)
9943 (c-add-syntax 'func-decl-cont (c-point 'boi))
9946 ;; CASE 5C: inheritance line. could be first inheritance
9947 ;; line, or continuation of a multiple inheritance
9948 ((or (and (c-major-mode-is 'c++-mode)
9950 (when (eq char-after-ip ?,)
9951 (skip-chars-forward " \t")
9953 (looking-at c-opt-postfix-decl-spec-key)))
9954 (and (or (eq char-before-ip ?:)
9955 ;; watch out for scope operator
9957 (and (eq char-after-ip ?:)
9958 (c-safe (forward-char 1) t)
9959 (not (eq (char-after) ?:))
9962 (c-beginning-of-statement-1 lim)
9963 (when (looking-at c-opt-<>-sexp-key)
9964 (goto-char (match-end 1))
9965 (c-forward-syntactic-ws)
9966 (c-forward-<>-arglist nil)
9967 (c-forward-syntactic-ws))
9968 (looking-at c-class-key)))
9970 (and (c-major-mode-is 'java-mode)
9971 (let ((fence (save-excursion
9972 (c-beginning-of-statement-1 lim)
9977 (cond ((looking-at c-opt-postfix-decl-spec-key)
9978 (setq injava-inher (cons cont (point))
9980 ((or (not (c-safe (c-forward-sexp -1) t))
9986 (not (c-crosses-statement-barrier-p (cdr injava-inher)
9991 ;; CASE 5C.1: non-hanging colon on an inher intro
9992 ((eq char-after-ip ?:)
9993 (c-beginning-of-statement-1 lim)
9994 (c-add-syntax 'inher-intro (c-point 'boi))
9995 ;; don't add inclass symbol since relative point already
9996 ;; contains any class offset
9999 ;; CASE 5C.2: hanging colon on an inher intro
10000 ((eq char-before-ip ?:)
10001 (c-beginning-of-statement-1 lim)
10002 (c-add-syntax 'inher-intro (c-point 'boi))
10003 (if containing-decl-open
10004 (c-add-class-syntax 'inclass
10005 containing-decl-open
10006 containing-decl-start
10007 containing-decl-kwd
10010 ;; CASE 5C.3: in a Java implements/extends
10012 (let ((where (cdr injava-inher))
10013 (cont (car injava-inher)))
10015 (cond ((looking-at "throws\\>[^_]")
10016 (c-add-syntax 'func-decl-cont
10017 (progn (c-beginning-of-statement-1 lim)
10019 (cont (c-add-syntax 'inher-cont where))
10020 (t (c-add-syntax 'inher-intro
10021 (progn (goto-char (cdr injava-inher))
10022 (c-beginning-of-statement-1 lim)
10026 ;; CASE 5C.4: a continued inheritance line
10028 (c-beginning-of-inheritance-list lim)
10029 (c-add-syntax 'inher-cont (point))
10030 ;; don't add inclass symbol since relative point already
10031 ;; contains any class offset
10034 ;; CASE 5P: AWK pattern or function or continuation
10036 ((c-major-mode-is 'awk-mode)
10037 (setq placeholder (point))
10039 (if (and (eq (c-beginning-of-statement-1) 'same)
10040 (/= (point) placeholder))
10041 'topmost-intro-cont
10044 containing-sexp paren-state))
10046 ;; CASE 5D: this could be a top-level initialization, a
10047 ;; member init list continuation, or a template argument
10048 ;; list continuation.
10050 ;; Note: We use the fact that lim is always after any
10051 ;; preceding brace sexp.
10052 (if c-recognize-<>-arglists
10055 (c-syntactic-skip-backward "^;,=<>" lim t)
10058 (when c-overloadable-operators-regexp
10059 (when (setq placeholder (c-after-special-operator-id lim))
10060 (goto-char placeholder)
10063 ((eq (char-before) ?>)
10064 (or (c-backward-<>-arglist nil lim)
10067 ((eq (char-before) ?<)
10069 (if (save-excursion
10070 (c-forward-<>-arglist nil))
10071 (progn (forward-char)
10075 ;; NB: No c-after-special-operator-id stuff in this
10076 ;; clause - we assume only C++ needs it.
10077 (c-syntactic-skip-backward "^;,=" lim t))
10078 (memq (char-before) '(?, ?= ?<)))
10081 ;; CASE 5D.3: perhaps a template list continuation?
10082 ((and (c-major-mode-is 'c++-mode)
10085 (c-with-syntax-table c++-template-syntax-table
10086 (goto-char indent-point)
10087 (setq placeholder (c-up-list-backward))
10089 (eq (char-after placeholder) ?<))))))
10090 (c-with-syntax-table c++-template-syntax-table
10091 (goto-char placeholder)
10092 (c-beginning-of-statement-1 lim t))
10093 (if (save-excursion
10094 (c-backward-syntactic-ws lim)
10095 (eq (char-before) ?<))
10096 ;; In a nested template arglist.
10098 (goto-char placeholder)
10099 (c-syntactic-skip-backward "^,;" lim t)
10100 (c-forward-syntactic-ws))
10101 (back-to-indentation))
10102 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
10104 (c-add-syntax 'template-args-cont (point) placeholder))
10106 ;; CASE 5D.4: perhaps a multiple inheritance line?
10107 ((and (c-major-mode-is 'c++-mode)
10109 (c-beginning-of-statement-1 lim)
10110 (setq placeholder (point))
10111 (if (looking-at "static\\>[^_]")
10112 (c-forward-token-2 1 nil indent-point))
10113 (and (looking-at c-class-key)
10114 (zerop (c-forward-token-2 2 nil indent-point))
10115 (if (eq (char-after) ?<)
10116 (c-with-syntax-table c++-template-syntax-table
10117 (zerop (c-forward-token-2 1 t indent-point)))
10119 (eq (char-after) ?:))))
10120 (goto-char placeholder)
10121 (c-add-syntax 'inher-cont (c-point 'boi)))
10123 ;; CASE 5D.5: Continuation of the "expression part" of a
10124 ;; top level construct. Or, perhaps, an unrecognized construct.
10126 (while (and (setq placeholder (point))
10127 (eq (car (c-beginning-of-decl-1 containing-sexp)) ; Can't use `lim' here.
10130 (c-backward-syntactic-ws)
10131 (eq (char-before) ?}))
10132 (< (point) placeholder)))
10135 ((eq (point) placeholder) 'statement) ; unrecognized construct
10136 ;; A preceding comma at the top level means that a
10137 ;; new variable declaration starts here. Use
10138 ;; topmost-intro-cont for it, for consistency with
10139 ;; the first variable declaration. C.f. case 5N.
10140 ((eq char-before-ip ?,) 'topmost-intro-cont)
10141 (t 'statement-cont))
10142 nil nil containing-sexp paren-state))
10145 ;; CASE 5F: Close of a non-class declaration level block.
10146 ((and (eq char-after-ip ?})
10147 (c-keyword-member containing-decl-kwd
10148 'c-other-block-decl-kwds))
10149 ;; This is inconsistent: Should use `containing-decl-open'
10150 ;; here if it's at boi, like in case 5J.
10151 (goto-char containing-decl-start)
10153 (if (string-equal (symbol-name containing-decl-kwd) "extern")
10154 ;; Special case for compatibility with the
10155 ;; extern-lang syntactic symbols.
10157 (intern (concat (symbol-name containing-decl-kwd)
10160 (c-most-enclosing-brace paren-state (point))
10163 ;; CASE 5G: we are looking at the brace which closes the
10164 ;; enclosing nested class decl
10165 ((and containing-sexp
10166 (eq char-after-ip ?})
10167 (eq containing-decl-open containing-sexp))
10168 (c-add-class-syntax 'class-close
10169 containing-decl-open
10170 containing-decl-start
10171 containing-decl-kwd
10174 ;; CASE 5H: we could be looking at subsequent knr-argdecls
10175 ((and c-recognize-knr-p
10176 (not containing-sexp) ; can't be knr inside braces.
10177 (not (eq char-before-ip ?}))
10179 (setq placeholder (cdr (c-beginning-of-decl-1 lim)))
10181 ;; Do an extra check to avoid tripping up on
10182 ;; statements that occur in invalid contexts
10183 ;; (e.g. in macro bodies where we don't really
10184 ;; know the context of what we're looking at).
10185 (not (and c-opt-block-stmt-key
10186 (looking-at c-opt-block-stmt-key)))))
10187 (< placeholder indent-point))
10188 (goto-char placeholder)
10189 (c-add-syntax 'knr-argdecl (point)))
10191 ;; CASE 5I: ObjC method definition.
10192 ((and c-opt-method-key
10193 (looking-at c-opt-method-key))
10194 (c-beginning-of-statement-1 nil t)
10195 (if (= (point) indent-point)
10196 ;; Handle the case when it's the first (non-comment)
10197 ;; thing in the buffer. Can't look for a 'same return
10198 ;; value from cbos1 since ObjC directives currently
10199 ;; aren't recognized fully, so that we get 'same
10200 ;; instead of 'previous if it moved over a preceding
10202 (goto-char (point-min)))
10203 (c-add-syntax 'objc-method-intro (c-point 'boi)))
10205 ;; CASE 5N: At a variable declaration that follows a class
10206 ;; definition or some other block declaration that doesn't
10207 ;; end at the closing '}'. C.f. case 5D.5.
10209 (c-backward-syntactic-ws lim)
10210 (and (eq (char-before) ?})
10212 (let ((start (point)))
10213 (if (and c-state-cache
10214 (consp (car c-state-cache))
10215 (eq (cdar c-state-cache) (point)))
10216 ;; Speed up the backward search a bit.
10217 (goto-char (caar c-state-cache)))
10218 (c-beginning-of-decl-1 containing-sexp) ; Can't use `lim' here.
10219 (setq placeholder (point))
10220 (if (= start (point))
10221 ;; The '}' is unbalanced.
10224 (>= (point) indent-point))))))
10225 (goto-char placeholder)
10226 (c-add-stmt-syntax 'topmost-intro-cont nil nil
10227 containing-sexp paren-state))
10229 ;; NOTE: The point is at the end of the previous token here.
10231 ;; CASE 5J: we are at the topmost level, make
10232 ;; sure we skip back past any access specifiers
10234 ;; A macro continuation line is never at top level.
10235 (not (and macro-start
10236 (> indent-point macro-start)))
10238 (setq placeholder (point))
10239 (or (memq char-before-ip '(?\; ?{ ?} nil))
10240 (c-at-vsemi-p before-ws-ip)
10241 (when (and (eq char-before-ip ?:)
10242 (eq (c-beginning-of-statement-1 lim)
10244 (c-backward-syntactic-ws lim)
10245 (setq placeholder (point)))
10246 (and (c-major-mode-is 'objc-mode)
10247 (catch 'not-in-directive
10248 (c-beginning-of-statement-1 lim)
10249 (setq placeholder (point))
10250 (while (and (c-forward-objc-directive)
10251 (< (point) indent-point))
10252 (c-forward-syntactic-ws)
10253 (if (>= (point) indent-point)
10254 (throw 'not-in-directive t))
10255 (setq placeholder (point)))
10257 ;; For historic reasons we anchor at bol of the last
10258 ;; line of the previous declaration. That's clearly
10259 ;; highly bogus and useless, and it makes our lives hard
10260 ;; to remain compatible. :P
10261 (goto-char placeholder)
10262 (c-add-syntax 'topmost-intro (c-point 'bol))
10263 (if containing-decl-open
10264 (if (c-keyword-member containing-decl-kwd
10265 'c-other-block-decl-kwds)
10267 (goto-char (c-brace-anchor-point containing-decl-open))
10269 (if (string-equal (symbol-name containing-decl-kwd)
10271 ;; Special case for compatibility with the
10272 ;; extern-lang syntactic symbols.
10274 (intern (concat "in"
10275 (symbol-name containing-decl-kwd))))
10277 (c-most-enclosing-brace paren-state (point))
10279 (c-add-class-syntax 'inclass
10280 containing-decl-open
10281 containing-decl-start
10282 containing-decl-kwd
10284 (when (and c-syntactic-indentation-in-macros
10286 (/= macro-start (c-point 'boi indent-point)))
10287 (c-add-syntax 'cpp-define-intro)
10288 (setq macro-start nil)))
10290 ;; CASE 5K: we are at an ObjC method definition
10291 ;; continuation line.
10292 ((and c-opt-method-key
10294 (c-beginning-of-statement-1 lim)
10295 (beginning-of-line)
10296 (when (looking-at c-opt-method-key)
10297 (setq placeholder (point)))))
10298 (c-add-syntax 'objc-method-args-cont placeholder))
10300 ;; CASE 5L: we are at the first argument of a template
10301 ;; arglist that begins on the previous line.
10302 ((and c-recognize-<>-arglists
10303 (eq (char-before) ?<)
10304 (not (and c-overloadable-operators-regexp
10305 (c-after-special-operator-id lim))))
10306 (c-beginning-of-statement-1 (c-safe-position (point) paren-state))
10307 (c-add-syntax 'template-args-cont (c-point 'boi)))
10309 ;; CASE 5Q: we are at a statement within a macro.
10311 (c-beginning-of-statement-1 containing-sexp)
10312 (c-add-stmt-syntax 'statement nil t containing-sexp paren-state))
10314 ;;CASE 5N: We are at a topmost continuation line and the only
10315 ;;preceding items are annotations.
10316 ((and (c-major-mode-is 'java-mode)
10317 (setq placeholder (point))
10318 (c-beginning-of-statement-1)
10320 (while (and (c-forward-annotation))
10321 (c-forward-syntactic-ws))
10324 (>= (point) placeholder)
10325 (goto-char placeholder)))
10326 (c-add-syntax 'annotation-top-cont (c-point 'boi)))
10328 ;; CASE 5M: we are at a topmost continuation line
10330 (c-beginning-of-statement-1 (c-safe-position (point) paren-state))
10331 (when (c-major-mode-is 'objc-mode)
10332 (setq placeholder (point))
10333 (while (and (c-forward-objc-directive)
10334 (< (point) indent-point))
10335 (c-forward-syntactic-ws)
10336 (setq placeholder (point)))
10337 (goto-char placeholder))
10338 (c-add-syntax 'topmost-intro-cont (c-point 'boi)))
10341 ;; (CASE 6 has been removed.)
10343 ;; CASE 7: line is an expression, not a statement. Most
10344 ;; likely we are either in a function prototype or a function
10345 ;; call argument list
10346 ((not (or (and c-special-brace-lists
10348 (goto-char containing-sexp)
10349 (c-looking-at-special-brace-list)))
10350 (eq (char-after containing-sexp) ?{)))
10353 ;; CASE 7A: we are looking at the arglist closing paren.
10355 ((memq char-after-ip '(?\) ?\]))
10356 (goto-char containing-sexp)
10357 (setq placeholder (c-point 'boi))
10358 (if (and (c-safe (backward-up-list 1) t)
10359 (>= (point) placeholder))
10362 (skip-chars-forward " \t"))
10363 (goto-char placeholder))
10364 (c-add-stmt-syntax 'arglist-close (list containing-sexp) t
10365 (c-most-enclosing-brace paren-state (point))
10368 ;; CASE 7B: Looking at the opening brace of an
10369 ;; in-expression block or brace list. C.f. cases 4, 16A
10371 ((and (eq char-after-ip ?{)
10373 (setq placeholder (c-inside-bracelist-p (point)
10376 (setq tmpsymbol '(brace-list-open . inexpr-class))
10377 (setq tmpsymbol '(block-open . inexpr-statement)
10379 (cdr-safe (c-looking-at-inexpr-block
10380 (c-safe-position containing-sexp
10383 ;; placeholder is nil if it's a block directly in
10384 ;; a function arglist. That makes us skip out of
10387 (goto-char placeholder)
10388 (back-to-indentation)
10389 (c-add-stmt-syntax (car tmpsymbol) nil t
10390 (c-most-enclosing-brace paren-state (point))
10392 (if (/= (point) placeholder)
10393 (c-add-syntax (cdr tmpsymbol))))
10395 ;; CASE 7C: we are looking at the first argument in an empty
10396 ;; argument list. Use arglist-close if we're actually
10397 ;; looking at a close paren or bracket.
10398 ((memq char-before-ip '(?\( ?\[))
10399 (goto-char containing-sexp)
10400 (setq placeholder (c-point 'boi))
10401 (if (and (c-safe (backward-up-list 1) t)
10402 (>= (point) placeholder))
10405 (skip-chars-forward " \t"))
10406 (goto-char placeholder))
10407 (c-add-stmt-syntax 'arglist-intro (list containing-sexp) t
10408 (c-most-enclosing-brace paren-state (point))
10411 ;; CASE 7D: we are inside a conditional test clause. treat
10412 ;; these things as statements
10414 (goto-char containing-sexp)
10415 (and (c-safe (c-forward-sexp -1) t)
10416 (looking-at "\\<for\\>[^_]")))
10417 (goto-char (1+ containing-sexp))
10418 (c-forward-syntactic-ws indent-point)
10419 (if (eq char-before-ip ?\;)
10420 (c-add-syntax 'statement (point))
10421 (c-add-syntax 'statement-cont (point))
10424 ;; CASE 7E: maybe a continued ObjC method call. This is the
10425 ;; case when we are inside a [] bracketed exp, and what
10426 ;; precede the opening bracket is not an identifier.
10427 ((and c-opt-method-key
10428 (eq (char-after containing-sexp) ?\[)
10430 (goto-char (1- containing-sexp))
10431 (c-backward-syntactic-ws (c-point 'bod))
10432 (if (not (looking-at c-symbol-key))
10433 (c-add-syntax 'objc-method-call-cont containing-sexp))
10436 ;; CASE 7F: we are looking at an arglist continuation line,
10437 ;; but the preceding argument is on the same line as the
10438 ;; opening paren. This case includes multi-line
10439 ;; mathematical paren groupings, but we could be on a
10440 ;; for-list continuation line. C.f. case 7A.
10442 (goto-char (1+ containing-sexp))
10444 (c-forward-syntactic-ws)
10447 (goto-char containing-sexp) ; paren opening the arglist
10448 (setq placeholder (c-point 'boi))
10449 (if (and (c-safe (backward-up-list 1) t)
10450 (>= (point) placeholder))
10453 (skip-chars-forward " \t"))
10454 (goto-char placeholder))
10455 (c-add-stmt-syntax 'arglist-cont-nonempty (list containing-sexp) t
10456 (c-most-enclosing-brace c-state-cache (point))
10459 ;; CASE 7G: we are looking at just a normal arglist
10460 ;; continuation line
10461 (t (c-forward-syntactic-ws indent-point)
10462 (c-add-syntax 'arglist-cont (c-point 'boi)))
10465 ;; CASE 8: func-local multi-inheritance line
10466 ((and (c-major-mode-is 'c++-mode)
10468 (goto-char indent-point)
10469 (skip-chars-forward " \t")
10470 (looking-at c-opt-postfix-decl-spec-key)))
10471 (goto-char indent-point)
10472 (skip-chars-forward " \t")
10475 ;; CASE 8A: non-hanging colon on an inher intro
10476 ((eq char-after-ip ?:)
10477 (c-backward-syntactic-ws lim)
10478 (c-add-syntax 'inher-intro (c-point 'boi)))
10480 ;; CASE 8B: hanging colon on an inher intro
10481 ((eq char-before-ip ?:)
10482 (c-add-syntax 'inher-intro (c-point 'boi)))
10484 ;; CASE 8C: a continued inheritance line
10486 (c-beginning-of-inheritance-list lim)
10487 (c-add-syntax 'inher-cont (point))
10490 ;; CASE 9: we are inside a brace-list
10491 ((and (not (c-major-mode-is 'awk-mode)) ; Maybe this isn't needed (ACM, 2002/3/29)
10492 (setq special-brace-list
10493 (or (and c-special-brace-lists ;;;; ALWAYS NIL FOR AWK!!
10495 (goto-char containing-sexp)
10496 (c-looking-at-special-brace-list)))
10497 (c-inside-bracelist-p containing-sexp paren-state))))
10500 ;; CASE 9A: In the middle of a special brace list opener.
10501 ((and (consp special-brace-list)
10503 (goto-char containing-sexp)
10504 (eq (char-after) ?\())
10505 (eq char-after-ip (car (cdr special-brace-list))))
10506 (goto-char (car (car special-brace-list)))
10507 (skip-chars-backward " \t")
10509 (assoc 'statement-cont
10510 (setq placeholder (c-guess-basic-syntax))))
10511 (setq c-syntactic-context placeholder)
10512 (c-beginning-of-statement-1
10513 (c-safe-position (1- containing-sexp) paren-state))
10514 (c-forward-token-2 0)
10515 (while (looking-at c-specifier-key)
10516 (goto-char (match-end 1))
10517 (c-forward-syntactic-ws))
10518 (c-add-syntax 'brace-list-open (c-point 'boi))))
10520 ;; CASE 9B: brace-list-close brace
10521 ((if (consp special-brace-list)
10522 ;; Check special brace list closer.
10524 (goto-char (car (car special-brace-list)))
10526 (goto-char indent-point)
10527 (back-to-indentation)
10529 ;; We were between the special close char and the `)'.
10530 (and (eq (char-after) ?\))
10531 (eq (1+ (point)) (cdr (car special-brace-list))))
10532 ;; We were before the special close char.
10533 (and (eq (char-after) (cdr (cdr special-brace-list)))
10534 (zerop (c-forward-token-2))
10535 (eq (1+ (point)) (cdr (car special-brace-list)))))))
10536 ;; Normal brace list check.
10537 (and (eq char-after-ip ?})
10538 (c-safe (goto-char (c-up-list-backward (point))) t)
10539 (= (point) containing-sexp)))
10540 (if (eq (point) (c-point 'boi))
10541 (c-add-syntax 'brace-list-close (point))
10542 (setq lim (c-most-enclosing-brace c-state-cache (point)))
10543 (c-beginning-of-statement-1 lim nil nil t)
10544 (c-add-stmt-syntax 'brace-list-close nil t lim paren-state)))
10547 ;; Prepare for the rest of the cases below by going to the
10548 ;; token following the opening brace
10549 (if (consp special-brace-list)
10551 (goto-char (car (car special-brace-list)))
10552 (c-forward-token-2 1 nil indent-point))
10553 (goto-char containing-sexp))
10555 (let ((start (point)))
10556 (c-forward-syntactic-ws indent-point)
10557 (goto-char (max start (c-point 'bol))))
10558 (c-skip-ws-forward indent-point)
10561 ;; CASE 9C: we're looking at the first line in a brace-list
10562 ((= (point) indent-point)
10563 (if (consp special-brace-list)
10564 (goto-char (car (car special-brace-list)))
10565 (goto-char containing-sexp))
10566 (if (eq (point) (c-point 'boi))
10567 (c-add-syntax 'brace-list-intro (point))
10568 (setq lim (c-most-enclosing-brace c-state-cache (point)))
10569 (c-beginning-of-statement-1 lim)
10570 (c-add-stmt-syntax 'brace-list-intro nil t lim paren-state)))
10572 ;; CASE 9D: this is just a later brace-list-entry or
10573 ;; brace-entry-open
10574 (t (if (or (eq char-after-ip ?{)
10575 (and c-special-brace-lists
10577 (goto-char indent-point)
10578 (c-forward-syntactic-ws (c-point 'eol))
10579 (c-looking-at-special-brace-list (point)))))
10580 (c-add-syntax 'brace-entry-open (point))
10581 (c-add-syntax 'brace-list-entry (point))
10585 ;; CASE 10: A continued statement or top level construct.
10586 ((and (not (memq char-before-ip '(?\; ?:)))
10587 (not (c-at-vsemi-p before-ws-ip))
10588 (or (not (eq char-before-ip ?}))
10589 (c-looking-at-inexpr-block-backward c-state-cache))
10592 (c-beginning-of-statement-1 containing-sexp)
10593 (setq placeholder (point))))
10594 (/= placeholder containing-sexp))
10595 ;; This is shared with case 18.
10596 (c-guess-continued-construct indent-point
10602 ;; CASE 16: block close brace, possibly closing the defun or
10604 ((eq char-after-ip ?})
10605 ;; From here on we have the next containing sexp in lim.
10606 (setq lim (c-most-enclosing-brace paren-state))
10607 (goto-char containing-sexp)
10610 ;; CASE 16E: Closing a statement block? This catches
10611 ;; cases where it's preceded by a statement keyword,
10612 ;; which works even when used in an "invalid" context,
10613 ;; e.g. a macro argument.
10614 ((c-after-conditional)
10615 (c-backward-to-block-anchor lim)
10616 (c-add-stmt-syntax 'block-close nil t lim paren-state))
10618 ;; CASE 16A: closing a lambda defun or an in-expression
10619 ;; block? C.f. cases 4, 7B and 17E.
10620 ((setq placeholder (c-looking-at-inexpr-block
10621 (c-safe-position containing-sexp paren-state)
10623 (setq tmpsymbol (if (eq (car placeholder) 'inlambda)
10626 (goto-char containing-sexp)
10627 (back-to-indentation)
10628 (if (= containing-sexp (point))
10629 (c-add-syntax tmpsymbol (point))
10630 (goto-char (cdr placeholder))
10631 (back-to-indentation)
10632 (c-add-stmt-syntax tmpsymbol nil t
10633 (c-most-enclosing-brace paren-state (point))
10635 (if (/= (point) (cdr placeholder))
10636 (c-add-syntax (car placeholder)))))
10638 ;; CASE 16B: does this close an inline or a function in
10639 ;; a non-class declaration level block?
10644 (c-looking-at-decl-block
10645 (c-most-enclosing-brace paren-state lim)
10647 (setq placeholder (point))))
10648 (c-backward-to-decl-anchor lim)
10649 (back-to-indentation)
10650 (if (save-excursion
10651 (goto-char placeholder)
10652 (looking-at c-other-decl-block-key))
10653 (c-add-syntax 'defun-close (point))
10654 (c-add-syntax 'inline-close (point))))
10656 ;; CASE 16F: Can be a defun-close of a function declared
10657 ;; in a statement block, e.g. in Pike or when using gcc
10658 ;; extensions, but watch out for macros followed by
10659 ;; blocks. Let it through to be handled below.
10660 ;; C.f. cases B.3 and 17G.
10662 (and (not (c-at-statement-start-p))
10663 (eq (c-beginning-of-statement-1 lim nil nil t) 'same)
10664 (setq placeholder (point))
10665 (let ((c-recognize-typeless-decls nil))
10666 ;; Turn off recognition of constructs that
10667 ;; lacks a type in this case, since that's more
10668 ;; likely to be a macro followed by a block.
10669 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
10670 (back-to-indentation)
10671 (if (/= (point) containing-sexp)
10672 (goto-char placeholder))
10673 (c-add-stmt-syntax 'defun-close nil t lim paren-state))
10675 ;; CASE 16C: If there is an enclosing brace then this is
10676 ;; a block close since defun closes inside declaration
10677 ;; level blocks have been handled above.
10679 ;; If the block is preceded by a case/switch label on
10680 ;; the same line, we anchor at the first preceding label
10681 ;; at boi. The default handling in c-add-stmt-syntax
10682 ;; really fixes it better, but we do like this to keep
10683 ;; the indentation compatible with version 5.28 and
10684 ;; earlier. C.f. case 17H.
10685 (while (and (/= (setq placeholder (point)) (c-point 'boi))
10686 (eq (c-beginning-of-statement-1 lim) 'label)))
10687 (goto-char placeholder)
10688 (if (looking-at c-label-kwds-regexp)
10689 (c-add-syntax 'block-close (point))
10690 (goto-char containing-sexp)
10691 ;; c-backward-to-block-anchor not necessary here; those
10692 ;; situations are handled in case 16E above.
10693 (c-add-stmt-syntax 'block-close nil t lim paren-state)))
10695 ;; CASE 16D: Only top level defun close left.
10697 (goto-char containing-sexp)
10698 (c-backward-to-decl-anchor lim)
10699 (c-add-stmt-syntax 'defun-close nil nil
10700 (c-most-enclosing-brace paren-state)
10704 ;; CASE 19: line is an expression, not a statement, and is directly
10705 ;; contained by a template delimiter. Most likely, we are in a
10706 ;; template arglist within a statement. This case is based on CASE
10707 ;; 7. At some point in the future, we may wish to create more
10708 ;; syntactic symbols such as `template-intro',
10709 ;; `template-cont-nonempty', etc., and distinguish between them as we
10710 ;; do for `arglist-intro' etc. (2009-12-07).
10711 ((and c-recognize-<>-arglists
10712 (setq containing-< (c-up-list-backward indent-point containing-sexp))
10713 (eq (char-after containing-<) ?\<))
10714 (setq placeholder (c-point 'boi containing-<))
10715 (goto-char containing-sexp) ; Most nested Lbrace/Lparen (but not
10716 ; '<') before indent-point.
10717 (if (>= (point) placeholder)
10720 (skip-chars-forward " \t"))
10721 (goto-char placeholder))
10722 (c-add-stmt-syntax 'template-args-cont (list containing-<) t
10723 (c-most-enclosing-brace c-state-cache (point))
10726 ;; CASE 17: Statement or defun catchall.
10728 (goto-char indent-point)
10729 ;; Back up statements until we find one that starts at boi.
10730 (while (let* ((prev-point (point))
10731 (last-step-type (c-beginning-of-statement-1
10733 (if (= (point) prev-point)
10735 (setq step-type (or step-type last-step-type))
10737 (setq step-type last-step-type)
10738 (/= (point) (c-point 'boi)))))
10741 ;; CASE 17B: continued statement
10742 ((and (eq step-type 'same)
10743 (/= (point) indent-point))
10744 (c-add-stmt-syntax 'statement-cont nil nil
10745 containing-sexp paren-state))
10747 ;; CASE 17A: After a case/default label?
10749 (while (and (eq step-type 'label)
10750 (not (looking-at c-label-kwds-regexp)))
10752 (c-beginning-of-statement-1 containing-sexp)))
10753 (eq step-type 'label))
10754 (c-add-stmt-syntax (if (eq char-after-ip ?{)
10755 'statement-case-open
10756 'statement-case-intro)
10757 nil t containing-sexp paren-state))
10759 ;; CASE 17D: any old statement
10761 (while (eq step-type 'label)
10763 (c-beginning-of-statement-1 containing-sexp)))
10764 (eq step-type 'previous))
10765 (c-add-stmt-syntax 'statement nil t
10766 containing-sexp paren-state)
10767 (if (eq char-after-ip ?{)
10768 (c-add-syntax 'block-open)))
10770 ;; CASE 17I: Inside a substatement block.
10772 ;; The following tests are all based on containing-sexp.
10773 (goto-char containing-sexp)
10774 ;; From here on we have the next containing sexp in lim.
10775 (setq lim (c-most-enclosing-brace paren-state containing-sexp))
10776 (c-after-conditional))
10777 (c-backward-to-block-anchor lim)
10778 (c-add-stmt-syntax 'statement-block-intro nil t
10780 (if (eq char-after-ip ?{)
10781 (c-add-syntax 'block-open)))
10783 ;; CASE 17E: first statement in an in-expression block.
10784 ;; C.f. cases 4, 7B and 16A.
10785 ((setq placeholder (c-looking-at-inexpr-block
10786 (c-safe-position containing-sexp paren-state)
10788 (setq tmpsymbol (if (eq (car placeholder) 'inlambda)
10790 'statement-block-intro))
10791 (back-to-indentation)
10792 (if (= containing-sexp (point))
10793 (c-add-syntax tmpsymbol (point))
10794 (goto-char (cdr placeholder))
10795 (back-to-indentation)
10796 (c-add-stmt-syntax tmpsymbol nil t
10797 (c-most-enclosing-brace c-state-cache (point))
10799 (if (/= (point) (cdr placeholder))
10800 (c-add-syntax (car placeholder))))
10801 (if (eq char-after-ip ?{)
10802 (c-add-syntax 'block-open)))
10804 ;; CASE 17F: first statement in an inline, or first
10805 ;; statement in a top-level defun. we can tell this is it
10806 ;; if there are no enclosing braces that haven't been
10807 ;; narrowed out by a class (i.e. don't use bod here).
10809 (or (not (setq placeholder (c-most-enclosing-brace
10812 (goto-char placeholder)
10813 (eq (char-after) ?{))
10814 (c-looking-at-decl-block (c-most-enclosing-brace
10815 paren-state (point))
10817 (c-backward-to-decl-anchor lim)
10818 (back-to-indentation)
10819 (c-add-syntax 'defun-block-intro (point)))
10821 ;; CASE 17G: First statement in a function declared inside
10822 ;; a normal block. This can occur in Pike and with
10823 ;; e.g. the gcc extensions, but watch out for macros
10824 ;; followed by blocks. C.f. cases B.3 and 16F.
10826 (and (not (c-at-statement-start-p))
10827 (eq (c-beginning-of-statement-1 lim nil nil t) 'same)
10828 (setq placeholder (point))
10829 (let ((c-recognize-typeless-decls nil))
10830 ;; Turn off recognition of constructs that lacks
10831 ;; a type in this case, since that's more likely
10832 ;; to be a macro followed by a block.
10833 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
10834 (back-to-indentation)
10835 (if (/= (point) containing-sexp)
10836 (goto-char placeholder))
10837 (c-add-stmt-syntax 'defun-block-intro nil t
10840 ;; CASE 17H: First statement in a block.
10842 ;; If the block is preceded by a case/switch label on the
10843 ;; same line, we anchor at the first preceding label at
10844 ;; boi. The default handling in c-add-stmt-syntax is
10845 ;; really fixes it better, but we do like this to keep the
10846 ;; indentation compatible with version 5.28 and earlier.
10848 (while (and (/= (setq placeholder (point)) (c-point 'boi))
10849 (eq (c-beginning-of-statement-1 lim) 'label)))
10850 (goto-char placeholder)
10851 (if (looking-at c-label-kwds-regexp)
10852 (c-add-syntax 'statement-block-intro (point))
10853 (goto-char containing-sexp)
10854 ;; c-backward-to-block-anchor not necessary here; those
10855 ;; situations are handled in case 17I above.
10856 (c-add-stmt-syntax 'statement-block-intro nil t
10858 (if (eq char-after-ip ?{)
10859 (c-add-syntax 'block-open)))
10863 ;; now we need to look at any modifiers
10864 (goto-char indent-point)
10865 (skip-chars-forward " \t")
10867 ;; are we looking at a comment only line?
10868 (when (and (looking-at c-comment-start-regexp)
10869 (/= (c-forward-token-2 0 nil (c-point 'eol)) 0))
10870 (c-append-syntax 'comment-intro))
10872 ;; we might want to give additional offset to friends (in C++).
10873 (when (and c-opt-friend-key
10874 (looking-at c-opt-friend-key))
10875 (c-append-syntax 'friend))
10877 ;; Set syntactic-relpos.
10878 (let ((p c-syntactic-context))
10880 (if (integerp (c-langelem-pos (car p)))
10882 (setq syntactic-relpos (c-langelem-pos (car p)))
10887 ;; Start of or a continuation of a preprocessor directive?
10888 (if (and macro-start
10889 (eq macro-start (c-point 'boi))
10890 (not (and (c-major-mode-is 'pike-mode)
10891 (eq (char-after (1+ macro-start)) ?\"))))
10892 (c-append-syntax 'cpp-macro)
10893 (when (and c-syntactic-indentation-in-macros macro-start)
10896 (< syntactic-relpos macro-start)
10898 (assq 'arglist-intro c-syntactic-context)
10899 (assq 'arglist-cont c-syntactic-context)
10900 (assq 'arglist-cont-nonempty c-syntactic-context)
10901 (assq 'arglist-close c-syntactic-context))))
10902 ;; If inside a cpp expression, i.e. anywhere in a
10903 ;; cpp directive except a #define body, we only let
10904 ;; through the syntactic analysis that is internal
10905 ;; in the expression. That means the arglist
10906 ;; elements, if they are anchored inside the cpp
10908 (setq c-syntactic-context nil)
10909 (c-add-syntax 'cpp-macro-cont macro-start))
10910 (when (and (eq macro-start syntactic-relpos)
10911 (not (assq 'cpp-define-intro c-syntactic-context))
10913 (goto-char macro-start)
10914 (or (not (c-forward-to-cpp-define-body))
10915 (<= (point) (c-point 'boi indent-point)))))
10916 ;; Inside a #define body and the syntactic analysis is
10917 ;; anchored on the start of the #define. In this case
10918 ;; we add cpp-define-intro to get the extra
10919 ;; indentation of the #define body.
10920 (c-add-syntax 'cpp-define-intro)))))
10922 ;; return the syntax
10923 c-syntactic-context)))
10926 ;; Indentation calculation.
10928 (defun c-evaluate-offset (offset langelem symbol)
10929 ;; offset can be a number, a function, a variable, a list, or one of
10930 ;; the symbols + or -
10932 ;; This function might do hidden buffer changes.
10935 ((numberp offset) offset)
10936 ((vectorp offset) offset)
10937 ((null offset) nil)
10939 ((eq offset '+) c-basic-offset)
10940 ((eq offset '-) (- c-basic-offset))
10941 ((eq offset '++) (* 2 c-basic-offset))
10942 ((eq offset '--) (* 2 (- c-basic-offset)))
10943 ((eq offset '*) (/ c-basic-offset 2))
10944 ((eq offset '/) (/ (- c-basic-offset) 2))
10946 ((functionp offset)
10949 (cons (c-langelem-sym langelem)
10950 (c-langelem-pos langelem)))
10955 ((eq (car offset) 'quote)
10956 (c-benign-error "The offset %S for %s was mistakenly quoted"
10960 ((memq (car offset) '(min max))
10961 (let (res val (method (car offset)))
10962 (setq offset (cdr offset))
10964 (setq val (c-evaluate-offset (car offset) langelem symbol))
10972 Error evaluating offset %S for %s: \
10973 Cannot combine absolute offset %S with relative %S in `%s' method"
10974 (car offset) symbol res val method)
10975 (setq res (funcall method res val))))
10979 Error evaluating offset %S for %s: \
10980 Cannot combine relative offset %S with absolute %S in `%s' method"
10981 (car offset) symbol res val method)
10982 (setq res (vector (funcall method (aref res 0)
10984 (setq offset (cdr offset)))
10987 ((eq (car offset) 'add)
10989 (setq offset (cdr offset))
10991 (setq val (c-evaluate-offset (car offset) langelem symbol))
10998 (setq res (vector (+ (aref res 0) val)))
10999 (setq res (+ res val))))
11003 Error evaluating offset %S for %s: \
11004 Cannot combine absolute offsets %S and %S in `add' method"
11005 (car offset) symbol res val)
11006 (setq res val)))) ; Override.
11007 (setq offset (cdr offset)))
11012 (when (eq (car offset) 'first)
11013 (setq offset (cdr offset)))
11014 (while (and (not res) offset)
11015 (setq res (c-evaluate-offset (car offset) langelem symbol)
11016 offset (cdr offset)))
11019 ((and (symbolp offset) (boundp offset))
11020 (symbol-value offset))
11023 (c-benign-error "Unknown offset format %S for %s" offset symbol)
11026 (if (or (null res) (integerp res)
11027 (and (vectorp res) (= (length res) 1) (integerp (aref res 0))))
11029 (c-benign-error "Error evaluating offset %S for %s: Got invalid value %S"
11033 (defun c-calc-offset (langelem)
11034 ;; Get offset from LANGELEM which is a list beginning with the
11035 ;; syntactic symbol and followed by any analysis data it provides.
11036 ;; That data may be zero or more elements, but if at least one is
11037 ;; given then the first is the anchor position (or nil). The symbol
11038 ;; is matched against `c-offsets-alist' and the offset calculated
11039 ;; from that is returned.
11041 ;; This function might do hidden buffer changes.
11042 (let* ((symbol (c-langelem-sym langelem))
11043 (match (assq symbol c-offsets-alist))
11044 (offset (cdr-safe match)))
11046 (setq offset (c-evaluate-offset offset langelem symbol))
11047 (if c-strict-syntax-p
11048 (c-benign-error "No offset found for syntactic symbol %s" symbol))
11050 (if (vectorp offset)
11052 (or (and (numberp offset) offset)
11053 (and (symbolp offset) (symbol-value offset))
11057 (defun c-get-offset (langelem)
11058 ;; This is a compatibility wrapper for `c-calc-offset' in case
11059 ;; someone is calling it directly. It takes an old style syntactic
11060 ;; element on the form (SYMBOL . ANCHOR-POS) and converts it to the
11063 ;; This function might do hidden buffer changes.
11064 (if (c-langelem-pos langelem)
11065 (c-calc-offset (list (c-langelem-sym langelem)
11066 (c-langelem-pos langelem)))
11067 (c-calc-offset langelem)))
11069 (defun c-get-syntactic-indentation (langelems)
11070 ;; Calculate the syntactic indentation from a syntactic description
11071 ;; as returned by `c-guess-syntax'.
11073 ;; Note that topmost-intro always has an anchor position at bol, for
11074 ;; historical reasons. It's often used together with other symbols
11075 ;; that has more sane positions. Since we always use the first
11076 ;; found anchor position, we rely on that these other symbols always
11077 ;; precede topmost-intro in the LANGELEMS list.
11079 ;; This function might do hidden buffer changes.
11080 (let ((indent 0) anchor)
11083 (let* ((c-syntactic-element (car langelems))
11084 (res (c-calc-offset c-syntactic-element)))
11087 ;; Got an absolute column that overrides any indentation
11088 ;; we've collected so far, but not the relative
11089 ;; indentation we might get for the nested structures
11090 ;; further down the langelems list.
11091 (setq indent (elt res 0)
11092 anchor (point-min)) ; A position at column 0.
11094 ;; Got a relative change of the current calculated
11096 (setq indent (+ indent res))
11098 ;; Use the anchor position from the first syntactic
11099 ;; element with one.
11101 (setq anchor (c-langelem-pos (car langelems)))))
11103 (setq langelems (cdr langelems))))
11106 (+ indent (save-excursion
11112 (cc-provide 'cc-engine)
11114 ;;; cc-engine.el ends here