1 ;;; cc-engine.el --- core syntax guessing engine for CC mode -*- coding: utf-8 -*-
3 ;; Copyright (C) 1985, 1987, 1992-2016 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 ,@(c--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-macro-is-genuine-p ()
253 ;; Check that the ostensible CPP construct at point is a real one. In
254 ;; particular, if point is on the first line of a narrowed buffer, make sure
255 ;; that the "#" isn't, say, the second character of a "##" operator. Return
256 ;; t when the macro is real, nil otherwise.
257 (let ((here (point)))
260 (if (and (eq (point) (point-min))
265 (and (looking-at c-anchored-cpp-prefix)
266 (eq (match-beginning 1) here)))
270 (defun c-beginning-of-macro (&optional lim)
271 "Go to the beginning of a preprocessor directive.
272 Leave point at the beginning of the directive and return t if in one,
273 otherwise return nil and leave point unchanged.
275 Note that this function might do hidden buffer changes. See the
276 comment at the start of cc-engine.el for more info."
277 (let ((here (point)))
278 (when c-opt-cpp-prefix
279 (if (and (car c-macro-cache)
280 (>= (point) (car c-macro-cache))
281 (or (and (cdr c-macro-cache)
282 (<= (point) (cdr c-macro-cache)))
283 (<= (point) c-macro-cache-start-pos)))
284 (unless (< (car c-macro-cache) (or lim (point-min)))
285 (progn (goto-char (max (or lim (point-min)) (car c-macro-cache)))
286 (setq c-macro-cache-start-pos
287 (max c-macro-cache-start-pos here))
289 (setq c-macro-cache nil
290 c-macro-cache-start-pos nil
291 c-macro-cache-syntactic nil)
294 (if lim (narrow-to-region lim (point-max)))
296 (while (eq (char-before (1- (point))) ?\\)
298 (back-to-indentation)
299 (if (and (<= (point) here)
300 (looking-at c-opt-cpp-start)
301 (c-macro-is-genuine-p))
303 (setq c-macro-cache (cons (point) nil)
304 c-macro-cache-start-pos here)
309 (defun c-end-of-macro ()
310 "Go to the end of a preprocessor directive.
311 More accurately, move the point to the end of the closest following
312 line that doesn't end with a line continuation backslash - no check is
313 done that the point is inside a cpp directive to begin with.
315 Note that this function might do hidden buffer changes. See the
316 comment at the start of cc-engine.el for more info."
317 (if (and (cdr c-macro-cache)
318 (<= (point) (cdr c-macro-cache))
319 (>= (point) (car c-macro-cache)))
320 (goto-char (cdr c-macro-cache))
321 (unless (and (car c-macro-cache)
322 (<= (point) c-macro-cache-start-pos)
323 (>= (point) (car c-macro-cache)))
324 (setq c-macro-cache nil
325 c-macro-cache-start-pos nil
326 c-macro-cache-syntactic nil))
329 (when (and (eq (char-before) ?\\)
333 (when (car c-macro-cache)
334 (setcdr c-macro-cache (point)))))
336 (defun c-syntactic-end-of-macro ()
337 ;; Go to the end of a CPP directive, or a "safe" pos just before.
339 ;; This is normally the end of the next non-escaped line. A "safe"
340 ;; position is one not within a string or comment. (The EOL on a line
341 ;; comment is NOT "safe").
343 ;; This function must only be called from the beginning of a CPP construct.
345 ;; Note that this function might do hidden buffer changes. See the comment
346 ;; at the start of cc-engine.el for more info.
347 (let* ((here (point))
348 (there (progn (c-end-of-macro) (point)))
350 (unless c-macro-cache-syntactic
351 (setq s (parse-partial-sexp here there))
352 (while (and (or (nth 3 s) ; in a string
353 (nth 4 s)) ; in a comment (maybe at end of line comment)
354 (> there here)) ; No infinite loops, please.
355 (setq there (1- (nth 8 s)))
356 (setq s (parse-partial-sexp here there)))
357 (setq c-macro-cache-syntactic (car c-macro-cache)))
360 (defun c-forward-over-cpp-define-id ()
361 ;; Assuming point is at the "#" that introduces a preprocessor
362 ;; directive, it's moved forward to the end of the identifier which is
363 ;; "#define"d (or whatever c-opt-cpp-macro-define specifies). Non-nil
364 ;; is returned in this case, in all other cases nil is returned and
365 ;; point isn't moved.
367 ;; This function might do hidden buffer changes.
368 (when (and c-opt-cpp-macro-define-id
369 (looking-at c-opt-cpp-macro-define-id))
370 (goto-char (match-end 0))))
372 (defun c-forward-to-cpp-define-body ()
373 ;; Assuming point is at the "#" that introduces a preprocessor
374 ;; directive, it's moved forward to the start of the definition body
375 ;; if it's a "#define" (or whatever c-opt-cpp-macro-define
376 ;; specifies). Non-nil is returned in this case, in all other cases
377 ;; nil is returned and point isn't moved.
379 ;; This function might do hidden buffer changes.
380 (when (and c-opt-cpp-macro-define-start
381 (looking-at c-opt-cpp-macro-define-start)
382 (not (= (match-end 0) (c-point 'eol))))
383 (goto-char (match-end 0))))
386 ;;; Basic utility functions.
388 (defun c-syntactic-content (from to paren-level)
389 ;; Return the given region as a string where all syntactic
390 ;; whitespace is removed or, where necessary, replaced with a single
391 ;; space. If PAREN-LEVEL is given then all parens in the region are
392 ;; collapsed to "()", "[]" etc.
394 ;; This function might do hidden buffer changes.
398 (narrow-to-region from to)
400 (let* ((parts (list nil)) (tail parts) pos in-paren)
402 (while (re-search-forward c-syntactic-ws-start to t)
403 (goto-char (setq pos (match-beginning 0)))
404 (c-forward-syntactic-ws)
410 (setq in-paren (= (car (parse-partial-sexp from pos 1)) 1)
413 (if (and (> pos from)
415 (looking-at "\\w\\|\\s_")
418 (looking-at "\\w\\|\\s_")))
420 (setcdr tail (list (buffer-substring-no-properties from pos)
422 (setq tail (cddr tail)))
423 (setcdr tail (list (buffer-substring-no-properties from pos)))
424 (setq tail (cdr tail)))
427 (when (= (car (parse-partial-sexp pos to -1)) -1)
428 (setcdr tail (list (buffer-substring-no-properties
429 (1- (point)) (point))))
430 (setq tail (cdr tail))))
432 (setq from (point))))
434 (setcdr tail (list (buffer-substring-no-properties from to)))
435 (apply 'concat (cdr parts))))))
437 (defun c-shift-line-indentation (shift-amt)
438 ;; Shift the indentation of the current line with the specified
439 ;; amount (positive inwards). The buffer is modified only if
440 ;; SHIFT-AMT isn't equal to zero.
441 (let ((pos (- (point-max) (point)))
442 (c-macro-start c-macro-start)
444 (if (zerop shift-amt)
446 ;; If we're on an empty line inside a macro, we take the point
447 ;; to be at the current indentation and shift it to the
448 ;; appropriate column. This way we don't treat the extra
449 ;; whitespace out to the line continuation as indentation.
450 (when (and (c-query-and-set-macro-start)
451 (looking-at "[ \t]*\\\\$")
453 (skip-chars-backward " \t")
457 (setq tmp-char-inserted t))
459 (let ((col (current-indentation)))
460 (delete-region (c-point 'bol) (c-point 'boi))
462 (indent-to (+ col shift-amt)))
463 (when tmp-char-inserted
465 ;; If initial point was within line's indentation and we're not on
466 ;; a line with a line continuation in a macro, position after the
467 ;; indentation. Else stay at same point in text.
468 (if (and (< (point) (c-point 'boi))
469 (not tmp-char-inserted))
470 (back-to-indentation)
471 (if (> (- (point-max) pos) (point))
472 (goto-char (- (point-max) pos))))))
474 (defsubst c-keyword-sym (keyword)
475 ;; Return non-nil if the string KEYWORD is a known keyword. More
476 ;; precisely, the value is the symbol for the keyword in
477 ;; `c-keywords-obarray'.
478 (intern-soft keyword c-keywords-obarray))
480 (defsubst c-keyword-member (keyword-sym lang-constant)
481 ;; Return non-nil if the symbol KEYWORD-SYM, as returned by
482 ;; `c-keyword-sym', is a member of LANG-CONSTANT, which is the name
483 ;; of a language constant that ends with "-kwds". If KEYWORD-SYM is
484 ;; nil then the result is nil.
485 (get keyword-sym lang-constant))
487 ;; String syntax chars, suitable for skip-syntax-(forward|backward).
488 (defconst c-string-syntax (if (memq 'gen-string-delim c-emacs-features)
492 ;; Regexp matching string limit syntax.
493 (defconst c-string-limit-regexp (if (memq 'gen-string-delim c-emacs-features)
497 ;; Regexp matching WS followed by string limit syntax.
498 (defconst c-ws*-string-limit-regexp
499 (concat "[ \t]*\\(" c-string-limit-regexp "\\)"))
501 ;; Holds formatted error strings for the few cases where parse errors
503 (defvar c-parsing-error nil)
504 (make-variable-buffer-local 'c-parsing-error)
506 (defun c-echo-parsing-error (&optional quiet)
507 (when (and c-report-syntactic-errors c-parsing-error (not quiet))
508 (c-benign-error "%s" c-parsing-error))
511 ;; Faces given to comments and string literals. This is used in some
512 ;; situations to speed up recognition; it isn't mandatory that font
513 ;; locking is in use. This variable is extended with the face in
514 ;; `c-doc-face-name' when fontification is activated in cc-fonts.el.
515 (defvar c-literal-faces
516 (append '(font-lock-comment-face font-lock-string-face)
517 (when (facep 'font-lock-comment-delimiter-face)
519 '(font-lock-comment-delimiter-face))))
521 (defsubst c-put-c-type-property (pos value)
522 ;; Put a c-type property with the given value at POS.
523 (c-put-char-property pos 'c-type value))
525 (defun c-clear-c-type-property (from to value)
526 ;; Remove all occurrences of the c-type property that has the given
527 ;; value in the region between FROM and TO. VALUE is assumed to not
530 ;; Note: This assumes that c-type is put on single chars only; it's
531 ;; very inefficient if matching properties cover large regions.
535 (when (eq (get-text-property (point) 'c-type) value)
536 (c-clear-char-property (point) 'c-type))
537 (goto-char (c-next-single-property-change (point) 'c-type nil to))
541 ;; Some debug tools to visualize various special positions. This
542 ;; debug code isn't as portable as the rest of CC Mode.
544 (cc-bytecomp-defun overlays-in)
545 (cc-bytecomp-defun overlay-get)
546 (cc-bytecomp-defun overlay-start)
547 (cc-bytecomp-defun overlay-end)
548 (cc-bytecomp-defun delete-overlay)
549 (cc-bytecomp-defun overlay-put)
550 (cc-bytecomp-defun make-overlay)
552 (defun c-debug-add-face (beg end face)
553 (c-save-buffer-state ((overlays (overlays-in beg end)) overlay)
555 (setq overlay (car overlays)
556 overlays (cdr overlays))
557 (when (eq (overlay-get overlay 'face) face)
558 (setq beg (min beg (overlay-start overlay))
559 end (max end (overlay-end overlay)))
560 (delete-overlay overlay)))
561 (overlay-put (make-overlay beg end) 'face face)))
563 (defun c-debug-remove-face (beg end face)
564 (c-save-buffer-state ((overlays (overlays-in beg end)) overlay
565 (ol-beg beg) (ol-end end))
567 (setq overlay (car overlays)
568 overlays (cdr overlays))
569 (when (eq (overlay-get overlay 'face) face)
570 (setq ol-beg (min ol-beg (overlay-start overlay))
571 ol-end (max ol-end (overlay-end overlay)))
572 (delete-overlay overlay)))
574 (overlay-put (make-overlay ol-beg beg) 'face face))
576 (overlay-put (make-overlay end ol-end) 'face face))))
579 ;; `c-beginning-of-statement-1' and accompanying stuff.
581 ;; KLUDGE ALERT: c-maybe-labelp is used to pass information between
582 ;; c-crosses-statement-barrier-p and c-beginning-of-statement-1. A
583 ;; better way should be implemented, but this will at least shut up
584 ;; the byte compiler.
585 (defvar c-maybe-labelp)
587 ;; New awk-compatible version of c-beginning-of-statement-1, ACM 2002/6/22
589 ;; Macros used internally in c-beginning-of-statement-1 for the
590 ;; automaton actions.
591 (defmacro c-bos-push-state ()
592 '(setq stack (cons (cons state saved-pos)
594 (defmacro c-bos-pop-state (&optional do-if-done)
595 `(if (setq state (car (car stack))
596 saved-pos (cdr (car stack))
601 (defmacro c-bos-pop-state-and-retry ()
602 '(throw 'loop (setq state (car (car stack))
603 saved-pos (cdr (car stack))
604 ;; Throw nil if stack is empty, else throw non-nil.
606 (defmacro c-bos-save-pos ()
607 '(setq saved-pos (vector pos tok ptok pptok)))
608 (defmacro c-bos-restore-pos ()
609 '(unless (eq (elt saved-pos 0) start)
610 (setq pos (elt saved-pos 0)
611 tok (elt saved-pos 1)
612 ptok (elt saved-pos 2)
613 pptok (elt saved-pos 3))
616 (defmacro c-bos-save-error-info (missing got)
617 `(setq saved-pos (vector pos ,missing ,got)))
618 (defmacro c-bos-report-error ()
620 (setq c-parsing-error
622 "No matching `%s' found for `%s' on line %d"
625 (1+ (count-lines (point-min)
626 (c-point 'bol (elt saved-pos 0))))))))
628 (defun c-beginning-of-statement-1 (&optional lim ignore-labels
630 "Move to the start of the current statement or declaration, or to
631 the previous one if already at the beginning of one. Only
632 statements/declarations on the same level are considered, i.e. don't
633 move into or out of sexps (not even normal expression parentheses).
635 If point is already at the earliest statement within braces or parens,
636 this function doesn't move back into any whitespace preceding it; it
637 returns `same' in this case.
639 Stop at statement continuation tokens like \"else\", \"catch\",
640 \"finally\" and the \"while\" in \"do ... while\" if the start point
641 is within the continuation. If starting at such a token, move to the
642 corresponding statement start. If at the beginning of a statement,
643 move to the closest containing statement if there is any. This might
644 also stop at a continuation clause.
646 Labels are treated as part of the following statements if
647 IGNORE-LABELS is non-nil. (FIXME: Doesn't work if we stop at a known
648 statement start keyword.) Otherwise, each label is treated as a
651 Macros are ignored \(i.e. skipped over) unless point is within one, in
652 which case the content of the macro is treated as normal code. Aside
653 from any normal statement starts found in it, stop at the first token
654 of the content in the macro, i.e. the expression of an \"#if\" or the
655 start of the definition in a \"#define\". Also stop at start of
656 macros before leaving them.
659 `label' if stopped at a label or \"case...:\" or \"default:\";
660 `same' if stopped at the beginning of the current statement;
661 `up' if stepped to a containing statement;
662 `previous' if stepped to a preceding statement;
663 `beginning' if stepped from a statement continuation clause to
665 `macro' if stepped to a macro start.
666 Note that `same' and not `label' is returned if stopped at the same
667 label without crossing the colon character.
669 LIM may be given to limit the search. If the search hits the limit,
670 point will be left at the closest following token, or at the start
671 position if that is less (`same' is returned in this case).
673 NOERROR turns off error logging to `c-parsing-error'.
675 Normally only `;' and virtual semicolons are considered to delimit
676 statements, but if COMMA-DELIM is non-nil then `,' is treated
679 Note that this function might do hidden buffer changes. See the
680 comment at the start of cc-engine.el for more info."
682 ;; The bulk of this function is a pushdown automaton that looks at statement
683 ;; boundaries and the tokens (such as "while") in c-opt-block-stmt-key. Its
684 ;; purpose is to keep track of nested statements, ensuring that such
685 ;; statements are skipped over in their entirety (somewhat akin to what C-M-p
686 ;; does with nested braces/brackets/parentheses).
688 ;; Note: The position of a boundary is the following token.
690 ;; Beginning with the current token (the one following point), move back one
691 ;; sexp at a time (where a sexp is, more or less, either a token or the
692 ;; entire contents of a brace/bracket/paren pair). Each time a statement
693 ;; boundary is crossed or a "while"-like token is found, update the state of
694 ;; the PDA. Stop at the beginning of a statement when the stack (holding
695 ;; nested statement info) is empty and the position has been moved.
697 ;; The following variables constitute the PDA:
699 ;; sym: This is either the "while"-like token (e.g. 'for) we've just
700 ;; scanned back over, 'boundary if we've just gone back over a
701 ;; statement boundary, or nil otherwise.
702 ;; state: takes one of the values (nil else else-boundary while
703 ;; while-boundary catch catch-boundary).
704 ;; nil means "no "while"-like token yet scanned".
705 ;; 'else, for example, means "just gone back over an else".
706 ;; 'else-boundary means "just gone back over a statement boundary
707 ;; immediately after having gone back over an else".
708 ;; saved-pos: A vector of either saved positions (tok ptok pptok, etc.) or
709 ;; of error reporting information.
710 ;; stack: The stack onto which the PDA pushes its state. Each entry
711 ;; consists of a saved value of state and saved-pos. An entry is
712 ;; pushed when we move back over a "continuation" token (e.g. else)
713 ;; and popped when we encounter the corresponding opening token
717 ;; The following diagram briefly outlines the PDA.
720 ;; "else": Push state, goto state `else'.
721 ;; "while": Push state, goto state `while'.
722 ;; "catch" or "finally": Push state, goto state `catch'.
723 ;; boundary: Pop state.
724 ;; other: Do nothing special.
727 ;; boundary: Goto state `else-boundary'.
728 ;; other: Error, pop state, retry token.
730 ;; State `else-boundary':
732 ;; boundary: Error, pop state.
733 ;; other: See common state.
736 ;; boundary: Save position, goto state `while-boundary'.
737 ;; other: Pop state, retry token.
739 ;; State `while-boundary':
741 ;; boundary: Restore position if it's not at start, pop state. [*see below]
742 ;; other: See common state.
745 ;; boundary: Goto state `catch-boundary'.
746 ;; other: Error, pop state, retry token.
748 ;; State `catch-boundary':
750 ;; "catch": Goto state `catch'.
751 ;; boundary: Error, pop state.
752 ;; other: See common state.
754 ;; [*] In the `while-boundary' state, we had pushed a 'while state, and were
755 ;; searching for a "do" which would have opened a do-while. If we didn't
756 ;; find it, we discard the analysis done since the "while", go back to this
757 ;; token in the buffer and restart the scanning there, this time WITHOUT
758 ;; pushing the 'while state onto the stack.
760 ;; In addition to the above there is some special handling of labels
763 (let ((case-fold-search nil)
766 (delims (if comma-delim '(?\; ?,) '(?\;)))
767 (c-stmt-delim-chars (if comma-delim
768 c-stmt-delim-chars-with-comma
770 c-in-literal-cache c-maybe-labelp after-case:-pos saved
773 ;; Position of last stmt boundary character (e.g. ;).
775 ;; The position of the last sexp or bound that follows the
776 ;; first found colon, i.e. the start of the nonlabel part of
777 ;; the statement. It's `start' if a colon is found just after
780 ;; Like `after-labels-pos', but the first such position inside
781 ;; a label, i.e. the start of the last label before the start
782 ;; of the nonlabel part of the statement.
784 ;; The last position where a label is possible provided the
785 ;; statement started there. It's nil as long as no invalid
786 ;; label content has been found (according to
787 ;; `c-nonlabel-token-key'). It's `start' if no valid label
788 ;; content was found in the label. Note that we might still
789 ;; regard it a label if it starts with `c-label-kwds'.
791 ;; Putative positions of the components of a bitfield declaration,
792 ;; e.g. "int foo : NUM_FOO_BITS ;"
793 bitfield-type-pos bitfield-id-pos bitfield-size-pos
794 ;; Symbol just scanned back over (e.g. 'while or 'boundary).
797 ;; Current state in the automaton. See above.
799 ;; Current saved positions. See above.
801 ;; Stack of conses (state . saved-pos).
803 ;; Regexp which matches "for", "if", etc.
804 (cond-key (or c-opt-block-stmt-key
805 "\\<\\>")) ; Matches nothing.
808 ;; Positions of the last three sexps or bounds we've stopped at.
812 (if lim (narrow-to-region lim (point-max)))
815 (and (c-beginning-of-macro)
817 (setq macro-start (point)))
819 ;; Try to skip back over unary operator characters, to register
823 (c-backward-syntactic-ws)
824 ;; Protect post-++/-- operators just before a virtual semicolon.
825 (and (not (c-at-vsemi-p))
826 (/= (skip-chars-backward "-+!*&~@`#") 0))))
828 ;; Skip back over any semicolon here. If it was a bare semicolon, we're
829 ;; done. Later on we ignore the boundaries for statements that don't
830 ;; contain any sexp. The only thing that is affected is that the error
831 ;; checking is a little less strict, and we really don't bother.
832 (if (and (memq (char-before) delims)
833 (progn (forward-char -1)
835 (c-backward-syntactic-ws)
836 (or (memq (char-before) delims)
837 (memq (char-before) '(?: nil))
838 (eq (char-syntax (char-before)) ?\()
843 ;; Begin at start and not pos to detect macros if we stand
844 ;; directly after the #.
846 (if (looking-at "\\<\\|\\W")
847 ;; Record this as the first token if not starting inside it.
850 ;; The following while loop goes back one sexp (balanced parens,
851 ;; etc. with contents, or symbol or suchlike) each iteration. This
852 ;; movement is accomplished with a call to c-backward-sexp approx 170
855 ;; The loop is exited only by throwing nil to the (catch 'loop ...):
856 ;; 1. On reaching the start of a macro;
857 ;; 2. On having passed a stmt boundary with the PDA stack empty;
858 ;; 3. On reaching the start of an Objective C method def;
859 ;; 4. From macro `c-bos-pop-state'; when the stack is empty;
860 ;; 5. From macro `c-bos-pop-state-and-retry' when the stack is empty.
862 (catch 'loop ;; Throw nil to break, non-nil to continue.
864 ;; Are we in a macro, just after the opening #?
866 (and macro-start ; Always NIL for AWK.
867 (progn (skip-chars-backward " \t")
868 (eq (char-before) ?#))
869 (progn (setq saved (1- (point)))
871 (not (eq (char-before (1- (point))) ?\\)))
872 (looking-at c-opt-cpp-start)
873 (progn (skip-chars-forward " \t")
874 (eq (point) saved))))
876 (if (and (c-forward-to-cpp-define-body)
877 (progn (c-forward-syntactic-ws start)
879 ;; Stop at the first token in the content of the macro.
881 ignore-labels t) ; Avoid the label check on exit.
885 (throw 'loop nil)) ; 1. Start of macro.
887 ;; Do a round through the automaton if we've just passed a
888 ;; statement boundary or passed a "while"-like token.
890 (and (looking-at cond-key)
891 (setq sym (intern (match-string 1)))))
893 (when (and (< pos start) (null stack))
894 (throw 'loop nil)) ; 2. Statement boundary.
896 ;; The PDA state handling.
898 ;; Refer to the description of the PDA in the opening
899 ;; comments. In the following OR form, the first leaf
900 ;; attempts to handles one of the specific actions detailed
901 ;; (e.g., finding token "if" whilst in state `else-boundary').
902 ;; We drop through to the second leaf (which handles common
903 ;; state) if no specific handler is found in the first cond.
904 ;; If a parsing error is detected (e.g. an "else" with no
905 ;; preceding "if"), we throw to the enclosing catch.
907 ;; Note that the (eq state 'else) means
908 ;; "we've just passed an else", NOT "we're looking for an
912 (if (eq sym 'boundary)
913 (setq state 'else-boundary)
915 (c-bos-pop-state-and-retry)))
917 ((eq state 'else-boundary)
919 (c-bos-pop-state (setq ret 'beginning)))
925 (if (and (eq sym 'boundary)
926 ;; Since this can cause backtracking we do a
927 ;; little more careful analysis to avoid it:
928 ;; If there's a label in front of the while
929 ;; it can't be part of a do-while.
930 (not after-labels-pos))
931 (progn (c-bos-save-pos)
932 (setq state 'while-boundary))
933 (c-bos-pop-state-and-retry))) ; Can't be a do-while
935 ((eq state 'while-boundary)
937 (c-bos-pop-state (setq ret 'beginning)))
938 ((eq sym 'boundary) ; isn't a do-while
939 (c-bos-restore-pos) ; the position of the while
940 (c-bos-pop-state)))) ; no longer searching for do.
943 (if (eq sym 'boundary)
944 (setq state 'catch-boundary)
946 (c-bos-pop-state-and-retry)))
948 ((eq state 'catch-boundary)
951 (c-bos-pop-state (setq ret 'beginning)))
956 (c-bos-pop-state)))))
958 ;; This is state common. We get here when the previous
959 ;; cond statement found no particular state handler.
960 (cond ((eq sym 'boundary)
961 ;; If we have a boundary at the start
962 ;; position we push a frame to go to the
963 ;; previous statement.
969 (c-bos-save-error-info 'if 'else)
972 ;; Is this a real while, or a do-while?
973 ;; The next `when' triggers unless we are SURE that
974 ;; the `while' is not the tail end of a `do-while'.
975 (when (or (not pptok)
976 (memq (char-after pptok) delims)
977 ;; The following kludge is to prevent
978 ;; infinite recursion when called from
979 ;; c-awk-after-if-for-while-condition-p,
981 (and (eq (point) start)
982 (c-vsemi-status-unknown-p))
983 (c-at-vsemi-p pptok))
984 ;; Since this can cause backtracking we do a
985 ;; little more careful analysis to avoid it: If
986 ;; the while isn't followed by a (possibly
987 ;; virtual) semicolon it can't be a do-while.
989 (setq state 'while)))
990 ((memq sym '(catch finally))
992 (c-bos-save-error-info 'try sym)
993 (setq state 'catch))))
996 ;; We're either past a statement boundary or at the
997 ;; start of a statement, so throw away any label data
998 ;; for the previous one.
999 (setq after-labels-pos nil
1001 c-maybe-labelp nil))))
1003 ;; Step to the previous sexp, but not if we crossed a
1004 ;; boundary, since that doesn't consume an sexp.
1005 (if (eq sym 'boundary)
1006 (setq ret 'previous)
1008 ;; HERE IS THE SINGLE PLACE INSIDE THE PDA LOOP WHERE WE MOVE
1009 ;; BACKWARDS THROUGH THE SOURCE.
1011 (c-backward-syntactic-ws)
1012 (let ((before-sws-pos (point))
1013 ;; The end position of the area to search for statement
1014 ;; barriers in this round.
1015 (maybe-after-boundary-pos pos))
1017 ;; Go back over exactly one logical sexp, taking proper
1018 ;; account of macros and escaped EOLs.
1021 (unless (c-safe (c-backward-sexp) t)
1022 ;; Give up if we hit an unbalanced block. Since the
1023 ;; stack won't be empty the code below will report a
1027 ;; Have we moved into a macro?
1028 ((and (not macro-start)
1029 (c-beginning-of-macro))
1030 ;; Have we crossed a statement boundary? If not,
1031 ;; keep going back until we find one or a "real" sexp.
1035 (not (c-crosses-statement-barrier-p
1036 (point) maybe-after-boundary-pos)))
1037 (setq maybe-after-boundary-pos (point))))
1038 ;; Have we just gone back over an escaped NL? This
1039 ;; doesn't count as a sexp.
1040 ((looking-at "\\\\$")))))
1042 ;; Have we crossed a statement boundary?
1045 ;; Are we at a macro beginning?
1046 ((and (not macro-start)
1048 (looking-at c-opt-cpp-prefix))
1051 (c-crosses-statement-barrier-p
1052 (point) maybe-after-boundary-pos)))
1053 ;; Just gone back over a brace block?
1055 (eq (char-after) ?{)
1056 (not (c-looking-at-inexpr-block lim nil t))
1058 (c-backward-token-2 1 t nil)
1059 (not (looking-at "=\\([^=]\\|$\\)"))))
1061 (c-forward-sexp) (point)))
1062 ;; Just gone back over some paren block?
1063 ((looking-at "\\s(")
1065 (goto-char (1+ (c-down-list-backward
1067 (c-crosses-statement-barrier-p
1068 (point) maybe-after-boundary-pos)))
1069 ;; Just gone back over an ordinary symbol of some sort?
1070 (t (c-crosses-statement-barrier-p
1071 (point) maybe-after-boundary-pos))))
1078 ;; Like a C "continue". Analyze the next sexp.
1082 (when (and c-opt-method-key
1083 (setq saved (c-in-method-def-p)))
1085 ignore-labels t) ; Avoid the label check on exit.
1086 (throw 'loop nil)) ; 3. ObjC method def.
1088 ;; Might we have a bitfield declaration, "<type> <id> : <size>"?
1091 ;; The : <size> and <id> fields?
1092 ((and (numberp c-maybe-labelp)
1093 (not bitfield-size-pos)
1095 (goto-char (or tok start))
1096 (not (looking-at c-keywords-regexp)))
1097 (not (looking-at c-keywords-regexp))
1098 (not (c-punctuation-in (point) c-maybe-labelp)))
1099 (setq bitfield-size-pos (or tok start)
1100 bitfield-id-pos (point)))
1101 ;; The <type> field?
1102 ((and bitfield-id-pos
1103 (not bitfield-type-pos))
1104 (if (and (looking-at c-symbol-key) ; Can only be an integer type. :-)
1105 (not (looking-at c-not-primitive-type-keywords-regexp))
1106 (not (c-punctuation-in (point) tok)))
1107 (setq bitfield-type-pos (point))
1108 (setq bitfield-size-pos nil
1109 bitfield-id-pos nil)))))
1112 (unless (eq ignore-labels t)
1113 (when (numberp c-maybe-labelp)
1114 ;; `c-crosses-statement-barrier-p' has found a colon, so we
1115 ;; might be in a label now. Have we got a real label
1116 ;; (including a case label) or something like C++'s "public:"?
1117 ;; A case label might use an expression rather than a token.
1118 (setq after-case:-pos (or tok start))
1119 (if (or (looking-at c-nonlabel-token-key) ; e.g. "while" or "'a'"
1120 ;; Catch C++'s inheritance construct "class foo : bar".
1123 (c-safe (c-backward-sexp) t)
1124 (looking-at c-nonlabel-token-2-key))))
1125 (setq c-maybe-labelp nil)
1126 (if after-labels-pos ; Have we already encountered a label?
1127 (if (not last-label-pos)
1128 (setq last-label-pos (or tok start)))
1129 (setq after-labels-pos (or tok start)))
1130 (setq c-maybe-labelp t
1131 label-good-pos nil))) ; bogus "label"
1133 (when (and (not label-good-pos) ; i.e. no invalid "label"'s yet
1135 (looking-at c-nonlabel-token-key)) ; e.g. "while :"
1136 ;; We're in a potential label and it's the first
1137 ;; time we've found something that isn't allowed in
1139 (setq label-good-pos (or tok start))))
1141 ;; We've moved back by a sexp, so update the token positions.
1146 pos tok) ; always non-nil
1147 ) ; end of (catch loop ....)
1148 ) ; end of sexp-at-a-time (while ....)
1150 ;; If the stack isn't empty there might be errors to report.
1152 (if (and (vectorp saved-pos) (eq (length saved-pos) 3))
1153 (c-bos-report-error))
1154 (setq saved-pos (cdr (car stack))
1157 (when (and (eq ret 'same)
1158 (not (memq sym '(boundary ignore nil))))
1159 ;; Need to investigate closer whether we've crossed
1160 ;; between a substatement and its containing statement.
1162 (cond ((and (looking-at c-block-stmt-1-2-key)
1163 (eq (char-after ptok) ?\())
1165 ((looking-at c-block-stmt-1-key)
1168 (cond ((> start saved) (setq pos saved))
1169 ((= start saved) (setq ret 'up)))))
1171 (when (and (not ignore-labels)
1172 (eq c-maybe-labelp t)
1173 (not (eq ret 'beginning))
1175 (not bitfield-type-pos) ; Bitfields take precedence over labels.
1176 (or (not label-good-pos)
1177 (<= label-good-pos pos)
1179 (goto-char (if (and last-label-pos
1180 (< last-label-pos start))
1183 (looking-at c-label-kwds-regexp))))
1184 ;; We're in a label. Maybe we should step to the statement
1186 (if (< after-labels-pos start)
1187 (setq pos after-labels-pos)
1189 (if (and last-label-pos (< last-label-pos start))
1190 ;; Might have jumped over several labels. Go to the last one.
1191 (setq pos last-label-pos)))))
1193 ;; Have we got "case <expression>:"?
1195 (when (and after-case:-pos
1196 (not (eq ret 'beginning))
1197 (looking-at c-case-kwds-regexp))
1198 (if (< after-case:-pos start)
1199 (setq pos after-case:-pos))
1203 ;; Skip over the unary operators that can start the statement.
1205 (c-backward-syntactic-ws)
1206 ;; protect AWK post-inc/decrement operators, etc.
1207 (and (not (c-at-vsemi-p (point)))
1208 (/= (skip-chars-backward "-+!*&~@`#") 0)))
1213 (defun c-punctuation-in (from to)
1214 "Return non-nil if there is a non-comment non-macro punctuation character
1215 between FROM and TO. FROM must not be in a string or comment. The returned
1216 value is the position of the first such character."
1219 (let ((pos (point)))
1220 (while (progn (skip-chars-forward c-symbol-chars to)
1221 (c-forward-syntactic-ws to)
1223 (setq pos (point))))
1224 (and (< (point) to) (point))))
1226 (defun c-crosses-statement-barrier-p (from to)
1227 "Return non-nil if buffer positions FROM to TO cross one or more
1228 statement or declaration boundaries. The returned value is actually
1229 the position of the earliest boundary char. FROM must not be within
1230 a string or comment.
1232 The variable `c-maybe-labelp' is set to the position of the first `:' that
1233 might start a label (i.e. not part of `::' and not preceded by `?'). If a
1234 single `?' is found, then `c-maybe-labelp' is cleared.
1236 For AWK, a statement which is terminated by an EOL (not a ; or a }) is
1237 regarded as having a \"virtual semicolon\" immediately after the last token on
1238 the line. If this virtual semicolon is _at_ from, the function recognizes it.
1240 Note that this function might do hidden buffer changes. See the
1241 comment at the start of cc-engine.el for more info."
1243 ;; If the current language has CPP macros, insert # into skip-chars.
1244 (if c-opt-cpp-symbol
1245 (concat (substring c-stmt-delim-chars 0 1) ; "^"
1246 c-opt-cpp-symbol ; usually "#"
1247 (substring c-stmt-delim-chars 1)) ; e.g. ";{}?:"
1248 c-stmt-delim-chars))
1250 (append (substring skip-chars 1) nil)) ; e.g. (?# ?\; ?{ ?} ?? ?:)
1251 lit-range vsemi-pos)
1257 (while (progn (skip-chars-forward
1259 (min to (c-point 'bonl)))
1262 ;; Virtual semicolon?
1266 (if (setq lit-range (c-literal-limits from)) ; Have we landed in a string/comment?
1267 (goto-char (car lit-range)))
1268 (c-backward-syntactic-ws) ; ? put a limit here, maybe?
1269 (setq vsemi-pos (point))
1271 (throw 'done vsemi-pos))
1272 ;; In a string/comment?
1273 ((setq lit-range (c-literal-limits from))
1274 (goto-char (cdr lit-range)))
1275 ((eq (char-after) ?:)
1277 (if (and (eq (char-after) ?:)
1279 ;; Ignore scope operators.
1281 (setq c-maybe-labelp (1- (point)))))
1282 ((eq (char-after) ??)
1283 ;; A question mark. Can't be a label, so stop
1284 ;; looking for more : and ?.
1285 (setq c-maybe-labelp nil
1286 skip-chars (substring c-stmt-delim-chars 0 -2)))
1287 ;; At a CPP construct or a "#" or "##" operator?
1288 ((and c-opt-cpp-symbol (looking-at c-opt-cpp-symbol))
1290 (skip-chars-backward " \t")
1293 (not (eq (char-before (1- (point))) ?\\)))))
1295 (skip-chars-forward c-opt-cpp-symbol)))
1296 ((memq (char-after) non-skip-list)
1297 (throw 'done (point)))))
1298 ;; In trailing space after an as yet undetected virtual semicolon?
1299 (c-backward-syntactic-ws from)
1300 (when (and (bolp) (not (bobp))) ; Can happen in AWK Mode with an
1301 ; unterminated string/regexp.
1303 (if (and (< (point) to)
1308 (defun c-at-statement-start-p ()
1309 "Return non-nil if the point is at the first token in a statement
1310 or somewhere in the syntactic whitespace before it.
1312 A \"statement\" here is not restricted to those inside code blocks.
1313 Any kind of declaration-like construct that occur outside function
1314 bodies is also considered a \"statement\".
1316 Note that this function might do hidden buffer changes. See the
1317 comment at the start of cc-engine.el for more info."
1322 (c-syntactic-skip-backward (substring c-stmt-delim-chars 1) nil t)
1324 (eq (char-before) ?})
1325 (and (eq (char-before) ?{)
1326 (not (and c-special-brace-lists
1327 (progn (backward-char)
1328 (c-looking-at-special-brace-list)))))
1329 (c-crosses-statement-barrier-p (point) end)))))
1331 (defun c-at-expression-start-p ()
1332 "Return non-nil if the point is at the first token in an expression or
1333 statement, or somewhere in the syntactic whitespace before it.
1335 An \"expression\" here is a bit different from the normal language
1336 grammar sense: It's any sequence of expression tokens except commas,
1337 unless they are enclosed inside parentheses of some kind. Also, an
1338 expression never continues past an enclosing parenthesis, but it might
1339 contain parenthesis pairs of any sort except braces.
1341 Since expressions never cross statement boundaries, this function also
1342 recognizes statement beginnings, just like `c-at-statement-start-p'.
1344 Note that this function might do hidden buffer changes. See the
1345 comment at the start of cc-engine.el for more info."
1349 (c-stmt-delim-chars c-stmt-delim-chars-with-comma)
1351 (c-syntactic-skip-backward (substring c-stmt-delim-chars 1) nil t)
1353 (memq (char-before) '(?{ ?}))
1354 (save-excursion (backward-char)
1355 (looking-at "\\s("))
1356 (c-crosses-statement-barrier-p (point) end)))))
1359 ;; A set of functions that covers various idiosyncrasies in
1360 ;; implementations of `forward-comment'.
1362 ;; Note: Some emacsen considers incorrectly that any line comment
1363 ;; ending with a backslash continues to the next line. I can't think
1364 ;; of any way to work around that in a reliable way without changing
1365 ;; the buffer, though. Suggestions welcome. ;) (No, temporarily
1366 ;; changing the syntax for backslash doesn't work since we must treat
1367 ;; escapes in string literals correctly.)
1369 (defun c-forward-single-comment ()
1370 "Move forward past whitespace and the closest following comment, if any.
1371 Return t if a comment was found, nil otherwise. In either case, the
1372 point is moved past the following whitespace. Line continuations,
1373 i.e. a backslashes followed by line breaks, are treated as whitespace.
1374 The line breaks that end line comments are considered to be the
1375 comment enders, so the point will be put on the beginning of the next
1376 line if it moved past a line comment.
1378 This function does not do any hidden buffer changes."
1380 (let ((start (point)))
1381 (when (looking-at "\\([ \t\n\r\f\v]\\|\\\\[\n\r]\\)+")
1382 (goto-char (match-end 0)))
1384 (when (forward-comment 1)
1386 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1390 ;; Emacs includes the ending newline in a b-style (c++)
1391 ;; comment, but XEmacs doesn't. We depend on the Emacs
1392 ;; behavior (which also is symmetric).
1393 (if (and (eolp) (elt (parse-partial-sexp start (point)) 7))
1394 (condition-case nil (forward-char 1)))
1398 (defsubst c-forward-comments ()
1399 "Move forward past all following whitespace and comments.
1400 Line continuations, i.e. a backslashes followed by line breaks, are
1401 treated as whitespace.
1403 Note that this function might do hidden buffer changes. See the
1404 comment at the start of cc-engine.el for more info."
1407 ;; If forward-comment in at least XEmacs 21 is given a large
1408 ;; positive value, it'll loop all the way through if it hits
1410 (and (forward-comment 5)
1411 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1415 (when (looking-at "\\\\[\n\r]")
1419 (defun c-backward-single-comment ()
1420 "Move backward past whitespace and the closest preceding comment, if any.
1421 Return t if a comment was found, nil otherwise. In either case, the
1422 point is moved past the preceding whitespace. Line continuations,
1423 i.e. a backslashes followed by line breaks, are treated as whitespace.
1424 The line breaks that end line comments are considered to be the
1425 comment enders, so the point cannot be at the end of the same line to
1426 move over a line comment.
1428 This function does not do any hidden buffer changes."
1430 (let ((start (point)))
1431 ;; When we got newline terminated comments, forward-comment in all
1432 ;; supported emacsen so far will stop at eol of each line not
1433 ;; ending with a comment when moving backwards. This corrects for
1434 ;; that, and at the same time handles line continuations.
1436 (skip-chars-backward " \t\n\r\f\v")
1437 (and (looking-at "[\n\r]")
1438 (eq (char-before) ?\\)))
1442 ;; Some emacsen (e.g. Emacs 19.34) return t when moving
1443 ;; backwards at bob.
1446 ;; Leave point after the closest following newline if we've
1447 ;; backed up over any above, since forward-comment won't move
1448 ;; backward over a line comment if point is at the end of the
1450 (re-search-forward "\\=\\s *[\n\r]" start t)
1452 (if (if (forward-comment -1)
1454 ;; If forward-comment above succeeded and we're at eol
1455 ;; then the newline we moved over above didn't end a
1456 ;; line comment, so we give it another go.
1457 (forward-comment -1)
1460 ;; Emacs <= 20 and XEmacs move back over the closer of a
1461 ;; block comment that lacks an opener.
1462 (if (looking-at "\\*/")
1463 (progn (forward-char 2) nil)
1466 (defsubst c-backward-comments ()
1467 "Move backward past all preceding whitespace and comments.
1468 Line continuations, i.e. a backslashes followed by line breaks, are
1469 treated as whitespace. The line breaks that end line comments are
1470 considered to be the comment enders, so the point cannot be at the end
1471 of the same line to move over a line comment. Unlike
1472 c-backward-syntactic-ws, this function doesn't move back over
1473 preprocessor directives.
1475 Note that this function might do hidden buffer changes. See the
1476 comment at the start of cc-engine.el for more info."
1478 (let ((start (point)))
1480 ;; `forward-comment' in some emacsen (e.g. XEmacs 21.4)
1481 ;; return t when moving backwards at bob.
1484 (if (let (moved-comment)
1486 (and (not (setq moved-comment (forward-comment -1)))
1487 ;; Cope specifically with ^M^J here -
1488 ;; forward-comment sometimes gets stuck after ^Ms,
1489 ;; sometimes after ^M^J.
1491 (when (eq (char-before) ?\r)
1494 (when (and (eq (char-before) ?\n)
1495 (eq (char-before (1- (point))) ?\r))
1499 (if (looking-at "\\*/")
1500 ;; Emacs <= 20 and XEmacs move back over the
1501 ;; closer of a block comment that lacks an opener.
1502 (progn (forward-char 2) nil)
1505 ;; XEmacs treats line continuations as whitespace but
1506 ;; only in the backward direction, which seems a bit
1507 ;; odd. Anyway, this is necessary for Emacs.
1508 (when (and (looking-at "[\n\r]")
1509 (eq (char-before) ?\\)
1515 ;; Tools for skipping over syntactic whitespace.
1517 ;; The following functions use text properties to cache searches over
1518 ;; large regions of syntactic whitespace. It works as follows:
1520 ;; o If a syntactic whitespace region contains anything but simple
1521 ;; whitespace (i.e. space, tab and line breaks), the text property
1522 ;; `c-in-sws' is put over it. At places where we have stopped
1523 ;; within that region there's also a `c-is-sws' text property.
1524 ;; That since there typically are nested whitespace inside that
1525 ;; must be handled separately, e.g. whitespace inside a comment or
1526 ;; cpp directive. Thus, from one point with `c-is-sws' it's safe
1527 ;; to jump to another point with that property within the same
1528 ;; `c-in-sws' region. It can be likened to a ladder where
1529 ;; `c-in-sws' marks the bars and `c-is-sws' the rungs.
1531 ;; o The `c-is-sws' property is put on the simple whitespace chars at
1532 ;; a "rung position" and also maybe on the first following char.
1533 ;; As many characters as can be conveniently found in this range
1534 ;; are marked, but no assumption can be made that the whole range
1535 ;; is marked (it could be clobbered by later changes, for
1538 ;; Note that some part of the beginning of a sequence of simple
1539 ;; whitespace might be part of the end of a preceding line comment
1540 ;; or cpp directive and must not be considered part of the "rung".
1541 ;; Such whitespace is some amount of horizontal whitespace followed
1542 ;; by a newline. In the case of cpp directives it could also be
1543 ;; two newlines with horizontal whitespace between them.
1545 ;; The reason to include the first following char is to cope with
1546 ;; "rung positions" that don't have any ordinary whitespace. If
1547 ;; `c-is-sws' is put on a token character it does not have
1548 ;; `c-in-sws' set simultaneously. That's the only case when that
1549 ;; can occur, and the reason for not extending the `c-in-sws'
1550 ;; region to cover it is that the `c-in-sws' region could then be
1551 ;; accidentally merged with a following one if the token is only
1552 ;; one character long.
1554 ;; o On buffer changes the `c-in-sws' and `c-is-sws' properties are
1555 ;; removed in the changed region. If the change was inside
1556 ;; syntactic whitespace that means that the "ladder" is broken, but
1557 ;; a later call to `c-forward-sws' or `c-backward-sws' will use the
1558 ;; parts on either side and use an ordinary search only to "repair"
1561 ;; Special care needs to be taken if a region is removed: If there
1562 ;; are `c-in-sws' on both sides of it which do not connect inside
1563 ;; the region then they can't be joined. If e.g. a marked macro is
1564 ;; broken, syntactic whitespace inside the new text might be
1565 ;; marked. If those marks would become connected with the old
1566 ;; `c-in-sws' range around the macro then we could get a ladder
1567 ;; with one end outside the macro and the other at some whitespace
1570 ;; The main motivation for this system is to increase the speed in
1571 ;; skipping over the large whitespace regions that can occur at the
1572 ;; top level in e.g. header files that contain a lot of comments and
1573 ;; cpp directives. For small comments inside code it's probably
1574 ;; slower than using `forward-comment' straightforwardly, but speed is
1575 ;; not a significant factor there anyway.
1577 ; (defface c-debug-is-sws-face
1578 ; '((t (:background "GreenYellow")))
1579 ; "Debug face to mark the `c-is-sws' property.")
1580 ; (defface c-debug-in-sws-face
1581 ; '((t (:underline t)))
1582 ; "Debug face to mark the `c-in-sws' property.")
1584 ; (defun c-debug-put-sws-faces ()
1585 ; ;; Put the sws debug faces on all the `c-is-sws' and `c-in-sws'
1586 ; ;; properties in the buffer.
1589 ; (c-save-buffer-state (in-face)
1590 ; (goto-char (point-min))
1591 ; (setq in-face (if (get-text-property (point) 'c-is-sws)
1594 ; (goto-char (next-single-property-change
1595 ; (point) 'c-is-sws nil (point-max)))
1598 ; (c-debug-add-face in-face (point) 'c-debug-is-sws-face)
1599 ; (setq in-face nil))
1600 ; (setq in-face (point)))
1602 ; (goto-char (point-min))
1603 ; (setq in-face (if (get-text-property (point) 'c-in-sws)
1606 ; (goto-char (next-single-property-change
1607 ; (point) 'c-in-sws nil (point-max)))
1610 ; (c-debug-add-face in-face (point) 'c-debug-in-sws-face)
1611 ; (setq in-face nil))
1612 ; (setq in-face (point)))
1615 (defmacro c-debug-sws-msg (&rest args)
1619 (defmacro c-put-is-sws (beg end)
1620 ;; This macro does a hidden buffer change.
1621 `(let ((beg ,beg) (end ,end))
1622 (put-text-property beg end 'c-is-sws t)
1623 ,@(when (facep 'c-debug-is-sws-face)
1624 `((c-debug-add-face beg end 'c-debug-is-sws-face)))))
1626 (defmacro c-put-in-sws (beg end)
1627 ;; This macro does a hidden buffer change.
1628 `(let ((beg ,beg) (end ,end))
1629 (put-text-property beg end 'c-in-sws t)
1630 ,@(when (facep 'c-debug-is-sws-face)
1631 `((c-debug-add-face beg end 'c-debug-in-sws-face)))))
1633 (defmacro c-remove-is-sws (beg end)
1634 ;; This macro does a hidden buffer change.
1635 `(let ((beg ,beg) (end ,end))
1636 (remove-text-properties beg end '(c-is-sws nil))
1637 ,@(when (facep 'c-debug-is-sws-face)
1638 `((c-debug-remove-face beg end 'c-debug-is-sws-face)))))
1640 (defmacro c-remove-in-sws (beg end)
1641 ;; This macro does a hidden buffer change.
1642 `(let ((beg ,beg) (end ,end))
1643 (remove-text-properties beg end '(c-in-sws nil))
1644 ,@(when (facep 'c-debug-is-sws-face)
1645 `((c-debug-remove-face beg end 'c-debug-in-sws-face)))))
1647 (defmacro c-remove-is-and-in-sws (beg end)
1648 ;; This macro does a hidden buffer change.
1649 `(let ((beg ,beg) (end ,end))
1650 (remove-text-properties beg end '(c-is-sws nil c-in-sws nil))
1651 ,@(when (facep 'c-debug-is-sws-face)
1652 `((c-debug-remove-face beg end 'c-debug-is-sws-face)
1653 (c-debug-remove-face beg end 'c-debug-in-sws-face)))))
1655 (defsubst c-invalidate-sws-region-after (beg end)
1656 ;; Called from `after-change-functions'. Note that if
1657 ;; `c-forward-sws' or `c-backward-sws' are used outside
1658 ;; `c-save-buffer-state' or similar then this will remove the cache
1659 ;; properties right after they're added.
1661 ;; This function does hidden buffer changes.
1664 ;; Adjust the end to remove the properties in any following simple
1665 ;; ws up to and including the next line break, if there is any
1666 ;; after the changed region. This is necessary e.g. when a rung
1667 ;; marked empty line is converted to a line comment by inserting
1668 ;; "//" before the line break. In that case the line break would
1669 ;; keep the rung mark which could make a later `c-backward-sws'
1670 ;; move into the line comment instead of over it.
1672 (skip-chars-forward " \t\f\v")
1673 (when (and (eolp) (not (eobp)))
1674 (setq end (1+ (point)))))
1676 (when (and (= beg end)
1677 (get-text-property beg 'c-in-sws)
1679 (get-text-property (1- beg) 'c-in-sws))
1680 ;; Ensure that an `c-in-sws' range gets broken. Note that it isn't
1681 ;; safe to keep a range that was continuous before the change. E.g:
1687 ;; There can be a "ladder" between "#" and "b". Now, if the newline
1688 ;; after "foo" is removed then "bar" will become part of the cpp
1689 ;; directive instead of a syntactically relevant token. In that
1690 ;; case there's no longer syntactic ws from "#" to "b".
1691 (setq beg (1- beg)))
1693 (c-debug-sws-msg "c-invalidate-sws-region-after [%s..%s]" beg end)
1694 (c-remove-is-and-in-sws beg end))
1696 (defun c-forward-sws ()
1697 ;; Used by `c-forward-syntactic-ws' to implement the unbounded search.
1699 ;; This function might do hidden buffer changes.
1701 (let (;; `rung-pos' is set to a position as early as possible in the
1702 ;; unmarked part of the simple ws region.
1703 (rung-pos (point)) next-rung-pos rung-end-pos last-put-in-sws-pos
1704 rung-is-marked next-rung-is-marked simple-ws-end
1705 ;; `safe-start' is set when it's safe to cache the start position.
1706 ;; It's not set if we've initially skipped over comments and line
1707 ;; continuations since we might have gone out through the end of a
1708 ;; macro then. This provision makes `c-forward-sws' not populate the
1709 ;; cache in the majority of cases, but otoh is `c-backward-sws' by far
1713 ;; Skip simple ws and do a quick check on the following character to see
1714 ;; if it's anything that can't start syntactic ws, so we can bail out
1715 ;; early in the majority of cases when there just are a few ws chars.
1716 (skip-chars-forward " \t\n\r\f\v")
1717 (when (or (looking-at c-syntactic-ws-start)
1718 (and c-opt-cpp-prefix
1719 (looking-at c-noise-macro-name-re)))
1721 (setq rung-end-pos (min (1+ (point)) (point-max)))
1722 (if (setq rung-is-marked (text-property-any rung-pos rung-end-pos
1724 ;; Find the last rung position to avoid setting properties in all
1725 ;; the cases when the marked rung is complete.
1726 ;; (`next-single-property-change' is certain to move at least one
1728 (setq rung-pos (1- (c-next-single-property-change
1729 rung-is-marked 'c-is-sws nil rung-end-pos)))
1730 ;; Got no marked rung here. Since the simple ws might have started
1731 ;; inside a line comment or cpp directive we must set `rung-pos' as
1732 ;; high as possible.
1733 (setq rung-pos (point)))
1735 (with-silent-modifications
1738 ;; In the following while form, we move over a "ladder" and
1739 ;; following simple WS each time round the loop, appending the WS
1740 ;; onto the ladder, joining adjacent ladders, and terminating when
1741 ;; there is no more WS or we reach EOB.
1743 (when (and rung-is-marked
1744 (get-text-property (point) 'c-in-sws))
1746 ;; The following search is the main reason that `c-in-sws'
1747 ;; and `c-is-sws' aren't combined to one property.
1748 (goto-char (c-next-single-property-change
1749 (point) 'c-in-sws nil (point-max)))
1750 (unless (get-text-property (point) 'c-is-sws)
1751 ;; If the `c-in-sws' region extended past the last
1752 ;; `c-is-sws' char we have to go back a bit.
1753 (or (get-text-property (1- (point)) 'c-is-sws)
1754 (goto-char (previous-single-property-change
1755 (point) 'c-is-sws)))
1759 "c-forward-sws cached move %s -> %s (max %s)"
1760 rung-pos (point) (point-max))
1762 (setq rung-pos (point))
1763 (and (> (skip-chars-forward " \t\n\r\f\v") 0)
1766 ;; We'll loop here if there is simple ws after the last rung.
1767 ;; That means that there's been some change in it and it's
1768 ;; possible that we've stepped into another ladder, so extend
1769 ;; the previous one to join with it if there is one, and try to
1770 ;; use the cache again.
1772 "c-forward-sws extending rung with [%s..%s] (max %s)"
1773 (1+ rung-pos) (1+ (point)) (point-max))
1774 (unless (get-text-property (point) 'c-is-sws)
1775 ;; Remove any `c-in-sws' property from the last char of
1776 ;; the rung before we mark it with `c-is-sws', so that we
1777 ;; won't connect with the remains of a broken "ladder".
1778 (c-remove-in-sws (point) (1+ (point))))
1779 (c-put-is-sws (1+ rung-pos)
1781 (c-put-in-sws rung-pos
1782 (setq rung-pos (point)
1783 last-put-in-sws-pos rung-pos)))
1785 ;; Now move over any comments (x)or a CPP construct.
1786 (setq simple-ws-end (point))
1787 (c-forward-comments)
1790 ((/= (point) simple-ws-end)
1791 ;; Skipped over comments. Don't cache at eob in case the buffer
1796 (and c-opt-cpp-prefix
1797 (looking-at c-opt-cpp-start)
1798 (progn (skip-chars-backward " \t")
1801 (progn (backward-char)
1802 (not (eq (char-before) ?\\))))))
1803 ;; Skip a preprocessor directive.
1805 (while (and (eq (char-before) ?\\)
1806 (= (forward-line 1) 0))
1810 ;; Don't cache at eob in case the buffer is narrowed.
1813 ((and c-opt-cpp-prefix
1814 (looking-at c-noise-macro-name-re))
1815 ;; Skip over a noise macro.
1816 (goto-char (match-end 1))
1820 ;; We've searched over a piece of non-white syntactic ws. See if this
1822 (setq next-rung-pos (point))
1823 (skip-chars-forward " \t\n\r\f\v")
1824 (setq rung-end-pos (min (1+ (point)) (point-max)))
1827 ;; Cache if we haven't skipped comments only, and if we started
1828 ;; either from a marked rung or from a completely uncached
1832 (not (get-text-property simple-ws-end 'c-in-sws))))
1834 ;; See if there's a marked rung in the encountered simple ws. If
1835 ;; so then we can cache, unless `safe-start' is nil. Even then
1836 ;; we need to do this to check if the cache can be used for the
1838 (and (setq next-rung-is-marked
1839 (text-property-any next-rung-pos rung-end-pos
1845 "c-forward-sws caching [%s..%s] - [%s..%s] (max %s)"
1846 rung-pos (1+ simple-ws-end) next-rung-pos rung-end-pos
1849 ;; Remove the properties for any nested ws that might be cached.
1850 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
1852 (c-remove-is-sws (1+ simple-ws-end) next-rung-pos)
1853 (unless (and rung-is-marked (= rung-pos simple-ws-end))
1854 (c-put-is-sws rung-pos
1856 (setq rung-is-marked t))
1857 (c-put-in-sws rung-pos
1858 (setq rung-pos (point)
1859 last-put-in-sws-pos rung-pos))
1860 (unless (get-text-property (1- rung-end-pos) 'c-is-sws)
1861 ;; Remove any `c-in-sws' property from the last char of
1862 ;; the rung before we mark it with `c-is-sws', so that we
1863 ;; won't connect with the remains of a broken "ladder".
1864 (c-remove-in-sws (1- rung-end-pos) rung-end-pos))
1865 (c-put-is-sws next-rung-pos
1869 "c-forward-sws not caching [%s..%s] - [%s..%s] (max %s)"
1870 rung-pos (1+ simple-ws-end) next-rung-pos rung-end-pos
1873 ;; Set `rung-pos' for the next rung. It's the same thing here as
1874 ;; initially, except that the rung position is set as early as
1875 ;; possible since we can't be in the ending ws of a line comment or
1876 ;; cpp directive now.
1877 (if (setq rung-is-marked next-rung-is-marked)
1878 (setq rung-pos (1- (c-next-single-property-change
1879 rung-is-marked 'c-is-sws nil rung-end-pos)))
1880 (setq rung-pos next-rung-pos))
1881 (setq safe-start t)))
1883 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
1884 ;; another one after the point (which might occur when editing inside a
1885 ;; comment or macro).
1886 (when (eq last-put-in-sws-pos (point))
1887 (cond ((< last-put-in-sws-pos (point-max))
1889 "c-forward-sws clearing at %s for cache separation"
1890 last-put-in-sws-pos)
1891 (c-remove-in-sws last-put-in-sws-pos
1892 (1+ last-put-in-sws-pos)))
1894 ;; If at eob we have to clear the last character before the end
1895 ;; instead since the buffer might be narrowed and there might
1896 ;; be a `c-in-sws' after (point-max). In this case it's
1897 ;; necessary to clear both properties.
1899 "c-forward-sws clearing thoroughly at %s for cache separation"
1900 (1- last-put-in-sws-pos))
1901 (c-remove-is-and-in-sws (1- last-put-in-sws-pos)
1902 last-put-in-sws-pos))))
1905 (defun c-backward-sws ()
1906 ;; Used by `c-backward-syntactic-ws' to implement the unbounded search.
1908 ;; This function might do hidden buffer changes.
1910 (let (;; `rung-pos' is set to a position as late as possible in the unmarked
1911 ;; part of the simple ws region.
1912 (rung-pos (point)) next-rung-pos last-put-in-sws-pos
1913 rung-is-marked simple-ws-beg cmt-skip-pos)
1915 ;; Skip simple horizontal ws and do a quick check on the preceding
1916 ;; character to see if it's anything that can't end syntactic ws, so we can
1917 ;; bail out early in the majority of cases when there just are a few ws
1918 ;; chars. Newlines are complicated in the backward direction, so we can't
1920 (skip-chars-backward " \t\f")
1921 (when (and (not (bobp))
1924 (or (looking-at c-syntactic-ws-end)
1925 (and c-opt-cpp-prefix
1926 (looking-at c-symbol-char-key)
1927 (progn (c-beginning-of-current-token)
1928 (looking-at c-noise-macro-name-re))))))
1929 ;; Try to find a rung position in the simple ws preceding point, so that
1930 ;; we can get a cache hit even if the last bit of the simple ws has
1931 ;; changed recently.
1932 (setq simple-ws-beg (point))
1933 (skip-chars-backward " \t\n\r\f\v")
1934 (if (setq rung-is-marked (text-property-any
1935 (point) (min (1+ rung-pos) (point-max))
1937 ;; `rung-pos' will be the earliest marked position, which means that
1938 ;; there might be later unmarked parts in the simple ws region.
1939 ;; It's not worth the effort to fix that; the last part of the
1940 ;; simple ws is also typically edited often, so it could be wasted.
1941 (goto-char (setq rung-pos rung-is-marked))
1942 (goto-char simple-ws-beg))
1944 (with-silent-modifications
1947 ;; Each time round the next while form, we move back over a ladder
1948 ;; and append any simple WS preceding it, if possible joining with
1949 ;; the previous ladder.
1951 (when (and rung-is-marked
1953 (get-text-property (1- (point)) 'c-in-sws))
1955 ;; The following search is the main reason that `c-in-sws'
1956 ;; and `c-is-sws' aren't combined to one property.
1957 (goto-char (previous-single-property-change
1958 (point) 'c-in-sws nil (point-min)))
1959 (unless (get-text-property (point) 'c-is-sws)
1960 ;; If the `c-in-sws' region extended past the first
1961 ;; `c-is-sws' char we have to go forward a bit.
1962 (goto-char (c-next-single-property-change
1963 (point) 'c-is-sws)))
1966 "c-backward-sws cached move %s <- %s (min %s)"
1967 (point) rung-pos (point-min))
1969 (setq rung-pos (point))
1970 (if (and (< (min (skip-chars-backward " \t\f\v")
1972 (setq simple-ws-beg (point))
1973 (skip-chars-backward " \t\n\r\f\v")))
1975 (setq rung-is-marked
1976 (text-property-any (point) rung-pos
1979 (goto-char simple-ws-beg)
1982 ;; We'll loop here if there is simple ws before the first rung.
1983 ;; That means that there's been some change in it and it's
1984 ;; possible that we've stepped into another ladder, so extend
1985 ;; the previous one to join with it if there is one, and try to
1986 ;; use the cache again.
1988 "c-backward-sws extending rung with [%s..%s] (min %s)"
1989 rung-is-marked rung-pos (point-min))
1990 (unless (get-text-property (1- rung-pos) 'c-is-sws)
1991 ;; Remove any `c-in-sws' property from the last char of
1992 ;; the rung before we mark it with `c-is-sws', so that we
1993 ;; won't connect with the remains of a broken "ladder".
1994 (c-remove-in-sws (1- rung-pos) rung-pos))
1995 (c-put-is-sws rung-is-marked
1997 (c-put-in-sws rung-is-marked
1999 (setq rung-pos rung-is-marked
2000 last-put-in-sws-pos rung-pos))
2002 (c-backward-comments)
2003 (setq cmt-skip-pos (point))
2006 ((and c-opt-cpp-prefix
2007 (/= cmt-skip-pos simple-ws-beg)
2008 (c-beginning-of-macro))
2009 ;; Inside a cpp directive. See if it should be skipped over.
2010 (let ((cpp-beg (point)))
2012 ;; Move back over all line continuations in the region skipped
2013 ;; over by `c-backward-comments'. If we go past it then we
2014 ;; started inside the cpp directive.
2015 (goto-char simple-ws-beg)
2017 (while (and (> (point) cmt-skip-pos)
2018 (progn (backward-char)
2019 (eq (char-before) ?\\)))
2020 (beginning-of-line))
2022 (if (< (point) cmt-skip-pos)
2023 ;; Don't move past the cpp directive if we began inside
2024 ;; it. Note that the position at the end of the last line
2025 ;; of the macro is also considered to be within it.
2026 (progn (goto-char cmt-skip-pos)
2029 ;; It's worthwhile to spend a little bit of effort on finding
2030 ;; the end of the macro, to get a good `simple-ws-beg'
2031 ;; position for the cache. Note that `c-backward-comments'
2032 ;; could have stepped over some comments before going into
2033 ;; the macro, and then `simple-ws-beg' must be kept on the
2034 ;; same side of those comments.
2035 (goto-char simple-ws-beg)
2036 (skip-chars-backward " \t\n\r\f\v")
2037 (if (eq (char-before) ?\\)
2040 (if (< (point) simple-ws-beg)
2041 ;; Might happen if comments after the macro were skipped
2043 (setq simple-ws-beg (point)))
2048 ((/= (save-excursion
2049 (skip-chars-forward " \t\n\r\f\v" simple-ws-beg)
2050 (setq next-rung-pos (point)))
2052 ;; Skipped over comments. Must put point at the end of
2053 ;; the simple ws at point since we might be after a line
2054 ;; comment or cpp directive that's been partially
2055 ;; narrowed out, and we can't risk marking the simple ws
2056 ;; at the end of it.
2057 (goto-char next-rung-pos)
2060 ((and c-opt-cpp-prefix
2062 (and (< (skip-syntax-backward "w_") 0)
2063 (progn (setq next-rung-pos (point))
2064 (looking-at c-noise-macro-name-re)))))
2065 ;; Skipped over a noise macro
2066 (goto-char next-rung-pos)
2069 ;; We've searched over a piece of non-white syntactic ws. See if this
2071 (setq next-rung-pos (point))
2072 (skip-chars-backward " \t\f\v")
2075 ;; Cache if we started either from a marked rung or from a
2076 ;; completely uncached position.
2078 (not (get-text-property (1- simple-ws-beg) 'c-in-sws))
2080 ;; Cache if there's a marked rung in the encountered simple ws.
2082 (skip-chars-backward " \t\n\r\f\v")
2083 (text-property-any (point) (min (1+ next-rung-pos) (point-max))
2088 "c-backward-sws caching [%s..%s] - [%s..%s] (min %s)"
2089 (point) (1+ next-rung-pos)
2090 simple-ws-beg (min (1+ rung-pos) (point-max))
2093 ;; Remove the properties for any nested ws that might be cached.
2094 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
2096 (c-remove-is-sws (1+ next-rung-pos) simple-ws-beg)
2097 (unless (and rung-is-marked (= simple-ws-beg rung-pos))
2098 (let ((rung-end-pos (min (1+ rung-pos) (point-max))))
2099 (unless (get-text-property (1- rung-end-pos) 'c-is-sws)
2100 ;; Remove any `c-in-sws' property from the last char of
2101 ;; the rung before we mark it with `c-is-sws', so that we
2102 ;; won't connect with the remains of a broken "ladder".
2103 (c-remove-in-sws (1- rung-end-pos) rung-end-pos))
2104 (c-put-is-sws simple-ws-beg
2106 (setq rung-is-marked t)))
2107 (c-put-in-sws (setq simple-ws-beg (point)
2108 last-put-in-sws-pos simple-ws-beg)
2110 (c-put-is-sws (setq rung-pos simple-ws-beg)
2111 (1+ next-rung-pos)))
2114 "c-backward-sws not caching [%s..%s] - [%s..%s] (min %s)"
2115 (point) (1+ next-rung-pos)
2116 simple-ws-beg (min (1+ rung-pos) (point-max))
2118 (setq rung-pos next-rung-pos
2119 simple-ws-beg (point))
2122 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
2123 ;; another one before the point (which might occur when editing inside a
2124 ;; comment or macro).
2125 (when (eq last-put-in-sws-pos (point))
2126 (cond ((< (point-min) last-put-in-sws-pos)
2128 "c-backward-sws clearing at %s for cache separation"
2129 (1- last-put-in-sws-pos))
2130 (c-remove-in-sws (1- last-put-in-sws-pos)
2131 last-put-in-sws-pos))
2133 ;; If at bob and the buffer is narrowed, we have to clear the
2134 ;; character we're standing on instead since there might be a
2135 ;; `c-in-sws' before (point-min). In this case it's necessary
2136 ;; to clear both properties.
2138 "c-backward-sws clearing thoroughly at %s for cache separation"
2139 last-put-in-sws-pos)
2140 (c-remove-is-and-in-sws last-put-in-sws-pos
2141 (1+ last-put-in-sws-pos)))))
2145 ;; Other whitespace tools
2146 (defun c-partial-ws-p (beg end)
2147 ;; Is the region (beg end) WS, and is there WS (or BOB/EOB) next to the
2148 ;; region? This is a "heuristic" function. .....
2150 ;; The motivation for the second bit is to check whether removing this
2151 ;; region would coalesce two symbols.
2153 ;; FIXME!!! This function doesn't check virtual semicolons in any way. Be
2154 ;; careful about using this function for, e.g. AWK. (2007/3/7)
2156 (let ((end+1 (min (1+ end) (point-max))))
2157 (or (progn (goto-char (max (point-min) (1- beg)))
2158 (c-skip-ws-forward end)
2160 (progn (goto-char beg)
2161 (c-skip-ws-forward end+1)
2162 (eq (point) end+1))))))
2164 ;; A system for finding noteworthy parens before the point.
2166 (defconst c-state-cache-too-far 5000)
2167 ;; A maximum comfortable scanning distance, e.g. between
2168 ;; `c-state-cache-good-pos' and "HERE" (where we call c-parse-state). When
2169 ;; this distance is exceeded, we take "emergency measures", e.g. by clearing
2170 ;; the cache and starting again from point-min or a beginning of defun. This
2171 ;; value can be tuned for efficiency or set to a lower value for testing.
2173 (defvar c-state-cache nil)
2174 (make-variable-buffer-local 'c-state-cache)
2175 ;; The state cache used by `c-parse-state' to cut down the amount of
2176 ;; searching. It's the result from some earlier `c-parse-state' call. See
2177 ;; `c-parse-state''s doc string for details of its structure.
2179 ;; The use of the cached info is more effective if the next
2180 ;; `c-parse-state' call is on a line close by the one the cached state
2181 ;; was made at; the cache can actually slow down a little if the
2182 ;; cached state was made very far back in the buffer. The cache is
2183 ;; most effective if `c-parse-state' is used on each line while moving
2186 (defvar c-state-cache-good-pos 1)
2187 (make-variable-buffer-local 'c-state-cache-good-pos)
2188 ;; This is a position where `c-state-cache' is known to be correct, or
2189 ;; nil (see below). It's a position inside one of the recorded unclosed
2190 ;; parens or the top level, but not further nested inside any literal or
2191 ;; subparen that is closed before the last recorded position.
2193 ;; The exact position is chosen to try to be close to yet earlier than
2194 ;; the position where `c-state-cache' will be called next. Right now
2195 ;; the heuristic is to set it to the position after the last found
2196 ;; closing paren (of any type) before the line on which
2197 ;; `c-parse-state' was called. That is chosen primarily to work well
2198 ;; with refontification of the current line.
2200 ;; 2009-07-28: When `c-state-point-min' and the last position where
2201 ;; `c-parse-state' or for which `c-invalidate-state-cache' was called, are
2202 ;; both in the same literal, there is no such "good position", and
2203 ;; c-state-cache-good-pos is then nil. This is the ONLY circumstance in which
2204 ;; it can be nil. In this case, `c-state-point-min-literal' will be non-nil.
2206 ;; 2009-06-12: In a brace desert, c-state-cache-good-pos may also be in
2207 ;; the middle of the desert, as long as it is not within a brace pair
2208 ;; recorded in `c-state-cache' or a paren/bracket pair.
2210 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2211 ;; We maintain a simple cache of positions which aren't in a literal, so as to
2212 ;; speed up testing for non-literality.
2213 (defconst c-state-nonlit-pos-interval 3000)
2214 ;; The approximate interval between entries in `c-state-nonlit-pos-cache'.
2216 (defvar c-state-nonlit-pos-cache nil)
2217 (make-variable-buffer-local 'c-state-nonlit-pos-cache)
2218 ;; A list of buffer positions which are known not to be in a literal or a cpp
2219 ;; construct. This is ordered with higher positions at the front of the list.
2220 ;; Only those which are less than `c-state-nonlit-pos-cache-limit' are valid.
2222 (defvar c-state-nonlit-pos-cache-limit 1)
2223 (make-variable-buffer-local 'c-state-nonlit-pos-cache-limit)
2224 ;; An upper limit on valid entries in `c-state-nonlit-pos-cache'. This is
2225 ;; reduced by buffer changes, and increased by invocations of
2226 ;; `c-state-literal-at'.
2228 (defvar c-state-semi-nonlit-pos-cache nil)
2229 (make-variable-buffer-local 'c-state-semi-nonlit-pos-cache)
2230 ;; A list of buffer positions which are known not to be in a literal. This is
2231 ;; ordered with higher positions at the front of the list. Only those which
2232 ;; are less than `c-state-semi-nonlit-pos-cache-limit' are valid.
2234 (defvar c-state-semi-nonlit-pos-cache-limit 1)
2235 (make-variable-buffer-local 'c-state-semi-nonlit-pos-cache-limit)
2236 ;; An upper limit on valid entries in `c-state-semi-nonlit-pos-cache'. This is
2237 ;; reduced by buffer changes, and increased by invocations of
2238 ;; `c-state-literal-at'. FIXME!!!
2240 (defsubst c-state-pp-to-literal (from to &optional not-in-delimiter)
2241 ;; Do a parse-partial-sexp from FROM to TO, returning either
2242 ;; (STATE TYPE (BEG . END)) if TO is in a literal; or
2243 ;; (STATE) otherwise,
2244 ;; where STATE is the parsing state at TO, TYPE is the type of the literal
2245 ;; (one of 'c, 'c++, 'string) and (BEG . END) is the boundaries of the literal.
2247 ;; Unless NOT-IN-DELIMITER is non-nil, when TO is inside a two-character
2248 ;; comment opener, this is recognized as being in a comment literal.
2250 ;; Only elements 3 (in a string), 4 (in a comment), 5 (following a quote),
2251 ;; 7 (comment type) and 8 (start of comment/string) (and possibly 9) of
2254 (let ((s (parse-partial-sexp from to))
2257 ((or (nth 3 s) (nth 4 s)) ; in a string or comment
2262 (parse-partial-sexp (point) (point-max)
2266 'syntax-table) ; stop at end of literal
2267 `(,s ,ty (,(nth 8 s) . ,(point))))
2269 ((and (not not-in-delimiter) ; inside a comment starter
2271 (progn (backward-char)
2272 (and (not (looking-at "\\s!"))
2273 (looking-at c-comment-start-regexp))))
2274 (setq ty (if (looking-at c-block-comment-start-regexp) 'c 'c++)
2277 `(,s ,ty (,co-st . ,(point))))
2281 (defun c-state-safe-place (here)
2282 ;; Return a buffer position before HERE which is "safe", i.e. outside any
2283 ;; string, comment, or macro.
2285 ;; NOTE: This function manipulates `c-state-nonlit-pos-cache'. This cache
2286 ;; MAY NOT contain any positions within macros, since macros are frequently
2287 ;; turned into comments by use of the `c-cpp-delimiter' category properties.
2288 ;; We cannot rely on this mechanism whilst determining a cache pos since
2289 ;; this function is also called from outwith `c-parse-state'.
2293 (let ((c c-state-nonlit-pos-cache)
2294 pos npos high-pos lit macro-beg macro-end)
2295 ;; Trim the cache to take account of buffer changes.
2296 (while (and c (> (car c) c-state-nonlit-pos-cache-limit))
2298 (setq c-state-nonlit-pos-cache c)
2300 (while (and c (> (car c) here))
2301 (setq high-pos (car c))
2303 (setq pos (or (car c) (point-min)))
2307 ;; Add an element to `c-state-nonlit-pos-cache' each iteration.
2310 (when (<= (+ pos c-state-nonlit-pos-interval) here)
2311 (+ pos c-state-nonlit-pos-interval)))
2313 ;; Test for being in a literal. If so, go to after it.
2315 (setq lit (car (cddr (c-state-pp-to-literal pos npos))))
2317 (prog1 (<= (cdr lit) here)
2318 (setq npos (cdr lit)))))
2320 ;; Test for being in a macro. If so, go to after it.
2324 (and (c-beginning-of-macro) (/= (point) npos) (point)))
2326 (c-syntactic-end-of-macro)
2327 (or (eobp) (forward-char))
2328 (setq macro-end (point)))
2329 (or (null macro-beg)
2330 (prog1 (<= macro-end here)
2331 (setq npos macro-end)))))
2334 (setq c-state-nonlit-pos-cache (cons pos c-state-nonlit-pos-cache)))
2335 ;; Add one extra element above HERE so as to to avoid the previous
2336 ;; expensive calculation when the next call is close to the current
2337 ;; one. This is especially useful when inside a large macro.
2339 (setq c-state-nonlit-pos-cache
2340 (cons npos c-state-nonlit-pos-cache))))
2342 (if (> pos c-state-nonlit-pos-cache-limit)
2343 (setq c-state-nonlit-pos-cache-limit pos))
2346 (defun c-state-semi-safe-place (here)
2347 ;; Return a buffer position before HERE which is "safe", i.e. outside any
2348 ;; string or comment. It may be in a macro.
2352 (let ((c c-state-semi-nonlit-pos-cache)
2353 pos npos high-pos lit macro-beg macro-end)
2354 ;; Trim the cache to take account of buffer changes.
2355 (while (and c (> (car c) c-state-semi-nonlit-pos-cache-limit))
2357 (setq c-state-semi-nonlit-pos-cache c)
2359 (while (and c (> (car c) here))
2360 (setq high-pos (car c))
2362 (setq pos (or (car c) (point-min)))
2366 ;; Add an element to `c-state-semi-nonlit-pos-cache' each iteration.
2368 (<= (setq npos (+ pos c-state-nonlit-pos-interval)) here)
2370 ;; Test for being in a literal. If so, go to after it.
2372 (setq lit (car (cddr (c-state-pp-to-literal pos npos))))
2374 (prog1 (<= (cdr lit) here)
2375 (setq npos (cdr lit))))))
2378 (setq c-state-semi-nonlit-pos-cache
2379 (cons pos c-state-semi-nonlit-pos-cache))))
2381 (if (> pos c-state-semi-nonlit-pos-cache-limit)
2382 (setq c-state-semi-nonlit-pos-cache-limit pos))
2385 (defun c-state-literal-at (here)
2386 ;; If position HERE is inside a literal, return (START . END), the
2387 ;; boundaries of the literal (which may be outside the accessible bit of the
2388 ;; buffer). Otherwise, return nil.
2390 ;; This function is almost the same as `c-literal-limits'. Previously, it
2391 ;; differed in that it was a lower level function, and that it rigorously
2392 ;; followed the syntax from BOB. `c-literal-limits' is now (2011-12)
2393 ;; virtually identical to this function.
2397 (let ((pos (c-state-safe-place here)))
2398 (car (cddr (c-state-pp-to-literal pos here)))))))
2400 (defsubst c-state-lit-beg (pos)
2401 ;; Return the start of the literal containing POS, or POS itself.
2402 (or (car (c-state-literal-at pos))
2405 (defsubst c-state-cache-non-literal-place (pos state)
2406 ;; Return a position outside of a string/comment/macro at or before POS.
2407 ;; STATE is the parse-partial-sexp state at POS.
2408 (let ((res (if (or (nth 3 state) ; in a string?
2409 (nth 4 state)) ; in a comment?
2414 (if (c-beginning-of-macro)
2418 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2419 ;; Stuff to do with point-min, and coping with any literal there.
2420 (defvar c-state-point-min 1)
2421 (make-variable-buffer-local 'c-state-point-min)
2422 ;; This is (point-min) when `c-state-cache' was last calculated. A change of
2423 ;; narrowing is likely to affect the parens that are visible before the point.
2425 (defvar c-state-point-min-lit-type nil)
2426 (make-variable-buffer-local 'c-state-point-min-lit-type)
2427 (defvar c-state-point-min-lit-start nil)
2428 (make-variable-buffer-local 'c-state-point-min-lit-start)
2429 ;; These two variables define the literal, if any, containing point-min.
2430 ;; Their values are, respectively, 'string, c, or c++, and the start of the
2431 ;; literal. If there's no literal there, they're both nil.
2433 (defvar c-state-min-scan-pos 1)
2434 (make-variable-buffer-local 'c-state-min-scan-pos)
2435 ;; This is the earliest buffer-pos from which scanning can be done. It is
2436 ;; either the end of the literal containing point-min, or point-min itself.
2437 ;; It becomes nil if the buffer is changed earlier than this point.
2438 (defun c-state-get-min-scan-pos ()
2439 ;; Return the lowest valid scanning pos. This will be the end of the
2440 ;; literal enclosing point-min, or point-min itself.
2441 (or c-state-min-scan-pos
2445 (goto-char c-state-point-min-lit-start)
2446 (if (eq c-state-point-min-lit-type 'string)
2448 (forward-comment 1))
2449 (setq c-state-min-scan-pos (point))))))
2451 (defun c-state-mark-point-min-literal ()
2452 ;; Determine the properties of any literal containing POINT-MIN, setting the
2453 ;; variables `c-state-point-min-lit-type', `c-state-point-min-lit-start',
2454 ;; and `c-state-min-scan-pos' accordingly. The return value is meaningless.
2455 (let ((p-min (point-min))
2459 (setq lit (c-state-literal-at p-min))
2461 (setq c-state-point-min-lit-type
2463 (goto-char (car lit))
2465 ((looking-at c-block-comment-start-regexp) 'c)
2466 ((looking-at c-line-comment-starter) 'c++)
2468 c-state-point-min-lit-start (car lit)
2469 c-state-min-scan-pos (cdr lit))
2470 (setq c-state-point-min-lit-type nil
2471 c-state-point-min-lit-start nil
2472 c-state-min-scan-pos p-min)))))
2475 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2476 ;; A variable which signals a brace dessert - helpful for reducing the number
2477 ;; of fruitless backward scans.
2478 (defvar c-state-brace-pair-desert nil)
2479 (make-variable-buffer-local 'c-state-brace-pair-desert)
2480 ;; Used only in `c-append-lower-brace-pair-to-state-cache'. It is set when
2481 ;; that defun has searched backwards for a brace pair and not found one. Its
2482 ;; value is either nil or a cons (PA . FROM), where PA is the position of the
2483 ;; enclosing opening paren/brace/bracket which bounds the backwards search (or
2484 ;; nil when at top level) and FROM is where the backward search started. It
2485 ;; is reset to nil in `c-invalidate-state-cache'.
2488 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2489 ;; Lowish level functions/macros which work directly on `c-state-cache', or a
2490 ;; list of like structure.
2491 (defmacro c-state-cache-top-lparen (&optional cache)
2492 ;; Return the address of the top left brace/bracket/paren recorded in CACHE
2493 ;; (default `c-state-cache') (or nil).
2494 (let ((cash (or cache 'c-state-cache)))
2495 `(if (consp (car ,cash))
2499 (defmacro c-state-cache-top-paren (&optional cache)
2500 ;; Return the address of the latest brace/bracket/paren (whether left or
2501 ;; right) recorded in CACHE (default `c-state-cache') or nil.
2502 (let ((cash (or cache 'c-state-cache)))
2503 `(if (consp (car ,cash))
2507 (defmacro c-state-cache-after-top-paren (&optional cache)
2508 ;; Return the position just after the latest brace/bracket/paren (whether
2509 ;; left or right) recorded in CACHE (default `c-state-cache') or nil.
2510 (let ((cash (or cache 'c-state-cache)))
2511 `(if (consp (car ,cash))
2514 (1+ (car ,cash))))))
2516 (defun c-get-cache-scan-pos (here)
2517 ;; From the state-cache, determine the buffer position from which we might
2518 ;; scan forward to HERE to update this cache. This position will be just
2519 ;; after a paren/brace/bracket recorded in the cache, if possible, otherwise
2520 ;; return the earliest position in the accessible region which isn't within
2521 ;; a literal. If the visible portion of the buffer is entirely within a
2522 ;; literal, return NIL.
2523 (let ((c c-state-cache) elt)
2524 ;(while (>= (or (c-state-cache-top-lparen c) 1) here)
2526 (>= (c-state-cache-top-lparen c) here))
2532 (if (> (cdr elt) here)
2536 ((<= (c-state-get-min-scan-pos) here)
2537 (c-state-get-min-scan-pos))
2540 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2541 ;; Variables which keep track of preprocessor constructs.
2542 (defvar c-state-old-cpp-beg-marker nil)
2543 (make-variable-buffer-local 'c-state-old-cpp-beg-marker)
2544 (defvar c-state-old-cpp-beg nil)
2545 (make-variable-buffer-local 'c-state-old-cpp-beg)
2546 (defvar c-state-old-cpp-end-marker nil)
2547 (make-variable-buffer-local 'c-state-old-cpp-end-marker)
2548 (defvar c-state-old-cpp-end nil)
2549 (make-variable-buffer-local 'c-state-old-cpp-end)
2550 ;; These are the limits of the macro containing point at the previous call of
2551 ;; `c-parse-state', or nil.
2553 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2554 ;; Defuns which analyze the buffer, yet don't change `c-state-cache'.
2555 (defun c-get-fallback-scan-pos (here)
2556 ;; Return a start position for building `c-state-cache' from
2557 ;; scratch. This will be at the top level, 2 defuns back.
2559 ;; Go back 2 bods, but ignore any bogus positions returned by
2560 ;; beginning-of-defun (i.e. open paren in column zero).
2563 (while (not (or (bobp) (zerop cnt)))
2564 (c-beginning-of-defun-1) ; Pure elisp BOD.
2565 (if (eq (char-after) ?\{)
2566 (setq cnt (1- cnt)))))
2569 (defun c-state-balance-parens-backwards (here- here+ top)
2570 ;; Return the position of the opening paren/brace/bracket before HERE- which
2571 ;; matches the outermost close p/b/b between HERE+ and TOP. Except when
2572 ;; there's a macro, HERE- and HERE+ are the same. Like this:
2574 ;; ............................................
2576 ;; ( [ ( .........#macro.. ) ( ) ] )
2579 ;; return HERE- HERE+ TOP
2581 ;; If there aren't enough opening paren/brace/brackets, return the position
2582 ;; of the outermost one found, or HERE- if there are none. If there are no
2583 ;; closing p/b/bs between HERE+ and TOP, return HERE-. HERE-/+ and TOP
2584 ;; must not be inside literals. Only the accessible portion of the buffer
2587 ;; PART 1: scan from `here+' up to `top', accumulating ")"s which enclose
2588 ;; `here'. Go round the next loop each time we pass over such a ")". These
2589 ;; probably match "("s before `here-'.
2590 (let (pos pa ren+1 lonely-rens)
2593 (narrow-to-region (point-min) top) ; This can move point, sometimes.
2597 (setq ren+1 (c-sc-scan-lists pos 1 1)) ; might signal
2598 (setq lonely-rens (cons ren+1 lonely-rens)
2601 ;; PART 2: Scan back before `here-' searching for the "("s
2602 ;; matching/mismatching the ")"s found above. We only need to direct the
2603 ;; caller to scan when we've encountered unmatched right parens.
2608 (and lonely-rens ; actual values aren't used.
2609 (setq pa (c-sc-scan-lists pos -1 1)))
2611 (setq lonely-rens (cdr lonely-rens)))))
2614 (defun c-parse-state-get-strategy (here good-pos)
2615 ;; Determine the scanning strategy for adjusting `c-parse-state', attempting
2616 ;; to minimize the amount of scanning. HERE is the pertinent position in
2617 ;; the buffer, GOOD-POS is a position where `c-state-cache' (possibly with
2618 ;; its head trimmed) is known to be good, or nil if there is no such
2621 ;; The return value is a list, one of the following:
2623 ;; o - ('forward START-POINT) - scan forward from START-POINT,
2624 ;; which is not less than the highest position in `c-state-cache' below HERE,
2625 ;; which is after GOOD-POS.
2626 ;; o - ('backward nil) - scan backwards (from HERE).
2627 ;; o - ('back-and-forward START-POINT) - like 'forward, but when HERE is earlier
2629 ;; o - ('BOD START-POINT) - scan forwards from START-POINT, which is at the
2631 ;; o - ('IN-LIT nil) - point is inside the literal containing point-min.
2632 (let ((cache-pos (c-get-cache-scan-pos here)) ; highest position below HERE in cache (or 1)
2633 BOD-pos ; position of 2nd BOD before HERE.
2634 strategy ; 'forward, 'backward, 'BOD, or 'IN-LIT.
2636 how-far) ; putative scanning distance.
2637 (setq good-pos (or good-pos (c-state-get-min-scan-pos)))
2639 ((< here (c-state-get-min-scan-pos))
2640 (setq strategy 'IN-LIT
2645 (setq strategy 'forward
2646 start-point (max good-pos cache-pos)
2647 how-far (- here start-point)))
2648 ((< (- good-pos here) (- here cache-pos)) ; FIXME!!! ; apply some sort of weighting.
2649 (setq strategy 'backward
2650 how-far (- good-pos here)))
2652 (setq strategy 'back-and-forward
2653 start-point cache-pos
2654 how-far (- here start-point))))
2656 ;; Might we be better off starting from the top level, two defuns back,
2657 ;; instead? This heuristic no longer works well in C++, where
2658 ;; declarations inside namespace brace blocks are frequently placed at
2659 ;; column zero. (2015-11-10): Remove the condition on C++ Mode.
2660 (when (and (or (not (memq 'col-0-paren c-emacs-features))
2661 open-paren-in-column-0-is-defun-start)
2662 ;; (not (c-major-mode-is 'c++-mode))
2663 (> how-far c-state-cache-too-far))
2664 (setq BOD-pos (c-get-fallback-scan-pos here)) ; somewhat EXPENSIVE!!!
2665 (if (< (- here BOD-pos) how-far)
2667 start-point BOD-pos)))
2669 (list strategy start-point)))
2672 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2673 ;; Routines which change `c-state-cache' and associated values.
2674 (defun c-renarrow-state-cache ()
2675 ;; The region (more precisely, point-min) has changed since we
2676 ;; calculated `c-state-cache'. Amend `c-state-cache' accordingly.
2677 (if (< (point-min) c-state-point-min)
2678 ;; If point-min has MOVED BACKWARDS then we drop the state completely.
2679 ;; It would be possible to do a better job here and recalculate the top
2682 (c-state-mark-point-min-literal)
2683 (setq c-state-cache nil
2684 c-state-cache-good-pos c-state-min-scan-pos
2685 c-state-brace-pair-desert nil))
2687 ;; point-min has MOVED FORWARD.
2689 ;; Is the new point-min inside a (different) literal?
2690 (unless (and c-state-point-min-lit-start ; at prev. point-min
2691 (< (point-min) (c-state-get-min-scan-pos)))
2692 (c-state-mark-point-min-literal))
2694 ;; Cut off a bit of the tail from `c-state-cache'.
2695 (let ((ptr (cons nil c-state-cache))
2697 (while (and (setq pa (c-state-cache-top-lparen (cdr ptr)))
2698 (>= pa (point-min)))
2699 (setq ptr (cdr ptr)))
2702 (if (eq (cdr ptr) c-state-cache)
2703 (setq c-state-cache nil
2704 c-state-cache-good-pos c-state-min-scan-pos)
2706 (setq c-state-cache-good-pos (1+ (c-state-cache-top-lparen))))
2709 (setq c-state-point-min (point-min)))
2711 (defun c-append-lower-brace-pair-to-state-cache (from here &optional upper-lim)
2712 ;; If there is a brace pair preceding FROM in the buffer, at the same level
2713 ;; of nesting (not necessarily immediately preceding), push a cons onto
2714 ;; `c-state-cache' to represent it. FROM must not be inside a literal. If
2715 ;; UPPER-LIM is non-nil, we append the highest brace pair whose "}" is below
2718 ;; Return non-nil when this has been done.
2720 ;; The situation it copes with is this transformation:
2722 ;; OLD: { (.) {...........}
2726 ;; NEW: { {....} (.) {.........
2728 ;; LOWER BRACE PAIR HERE or HERE
2730 ;; This routine should be fast. Since it can get called a LOT, we maintain
2731 ;; `c-state-brace-pair-desert', a small cache of "failures", such that we
2732 ;; reduce the time wasted in repeated fruitless searches in brace deserts.
2736 (cache-pos (c-state-cache-top-lparen)) ; might be nil.
2737 (macro-start-or-from
2738 (progn (goto-char from)
2739 (c-beginning-of-macro)
2741 (bra ; Position of "{".
2742 ;; Don't start scanning in the middle of a CPP construct unless
2743 ;; it contains HERE - these constructs, in Emacs, are "commented
2744 ;; out" with category properties.
2745 (if (eq (c-get-char-property macro-start-or-from 'category)
2749 ce) ; Position of "}"
2750 (or upper-lim (setq upper-lim from))
2752 ;; If we're essentially repeating a fruitless search, just give up.
2753 (unless (and c-state-brace-pair-desert
2754 (eq cache-pos (car c-state-brace-pair-desert))
2755 (or (null (car c-state-brace-pair-desert))
2756 (> from (car c-state-brace-pair-desert)))
2757 (<= from (cdr c-state-brace-pair-desert)))
2758 ;; DESERT-LIM. Avoid repeated searching through the cached desert.
2760 (and c-state-brace-pair-desert
2761 (eq cache-pos (car c-state-brace-pair-desert))
2762 (>= from (cdr c-state-brace-pair-desert))
2763 (cdr c-state-brace-pair-desert)))
2764 ;; CACHE-LIM. This limit will be necessary when an opening
2765 ;; paren at `cache-pos' has just had its matching close paren
2766 ;; inserted into the buffer. `cache-pos' continues to be a
2767 ;; search bound, even though the algorithm below would skip
2768 ;; over the new paren pair.
2769 (cache-lim (and cache-pos (< cache-pos from) cache-pos)))
2772 ((and desert-lim cache-lim)
2773 (max desert-lim cache-lim))
2777 ;; The top limit is EOB to ensure that `bra' is inside the
2778 ;; accessible part of the buffer at the next scan operation.
2779 (1+ (buffer-size))))
2781 ;; In the next pair of nested loops, the inner one moves back past a
2782 ;; pair of (mis-)matching parens or brackets; the outer one moves
2783 ;; back over a sequence of unmatched close brace/paren/bracket each
2789 (and (setq ce (c-sc-scan-lists bra -1 -1)) ; back past )/]/}; might signal
2790 (setq bra (c-sc-scan-lists ce -1 1)) ; back past (/[/{; might signal
2791 (or (> bra here) ;(> ce here)
2794 (or (not (eq (char-after bra) ?\{))
2795 (and (goto-char bra)
2796 (c-beginning-of-macro)
2797 (< (point) macro-start-or-from))))))))
2798 (and ce (< ce bra)))
2799 (setq bra ce)) ; If we just backed over an unbalanced closing
2802 (if (and ce (< ce here) (< bra ce) (eq (char-after bra) ?\{))
2803 ;; We've found the desired brace-pair.
2805 (setq new-cons (cons bra (1+ ce)))
2807 ((consp (car c-state-cache))
2808 (setcar c-state-cache new-cons))
2809 ((and (numberp (car c-state-cache)) ; probably never happens
2810 (< ce (car c-state-cache)))
2811 (setcdr c-state-cache
2812 (cons new-cons (cdr c-state-cache))))
2813 (t (setq c-state-cache (cons new-cons c-state-cache)))))
2815 ;; We haven't found a brace pair. Record this in the cache.
2816 (setq c-state-brace-pair-desert
2817 (cons (if (and ce (< bra ce) (> ce here)) ; {..} straddling HERE?
2820 (min here from)))))))))
2822 (defsubst c-state-push-any-brace-pair (bra+1 macro-start-or-here)
2823 ;; If BRA+1 is nil, do nothing. Otherwise, BRA+1 is the buffer position
2824 ;; following a {, and that brace has a (mis-)matching } (or ]), and we
2825 ;; "push" "a" brace pair onto `c-state-cache'.
2827 ;; Here "push" means overwrite the top element if it's itself a brace-pair,
2828 ;; otherwise push it normally.
2830 ;; The brace pair we push is normally the one surrounding BRA+1, but if the
2831 ;; latter is inside a macro, not being a macro containing
2832 ;; MACRO-START-OR-HERE, we scan backwards through the buffer for a non-macro
2833 ;; base pair. This latter case is assumed to be rare.
2835 ;; Note: POINT is not preserved in this routine.
2837 (if (or (> bra+1 macro-start-or-here)
2838 (progn (goto-char bra+1)
2839 (not (c-beginning-of-macro))))
2841 (cons (cons (1- bra+1)
2842 (c-sc-scan-lists bra+1 1 1))
2843 (if (consp (car c-state-cache))
2846 ;; N.B. This defsubst codes one method for the simple, normal case,
2847 ;; and a more sophisticated, slower way for the general case. Don't
2848 ;; eliminate this defsubst - it's a speed optimization.
2849 (c-append-lower-brace-pair-to-state-cache (1- bra+1) (point-max)))))
2851 (defun c-append-to-state-cache (from here)
2852 ;; Scan the buffer from FROM to HERE, adding elements into `c-state-cache'
2853 ;; for braces etc. Return a candidate for `c-state-cache-good-pos'.
2855 ;; FROM must be after the latest brace/paren/bracket in `c-state-cache', if
2856 ;; any. Typically, it is immediately after it. It must not be inside a
2858 (let ((here-bol (c-point 'bol here))
2859 (macro-start-or-here
2860 (save-excursion (goto-char here)
2861 (if (c-beginning-of-macro)
2864 pa+1 ; pos just after an opening PAren (or brace).
2865 (ren+1 from) ; usually a pos just after an closing paREN etc.
2866 ; Is actually the pos. to scan for a (/{/[ from,
2867 ; which sometimes is after a silly )/}/].
2868 paren+1 ; Pos after some opening or closing paren.
2869 paren+1s ; A list of `paren+1's; used to determine a
2871 bra+1 ; just after L bra-ce.
2872 bra+1s ; list of OLD values of bra+1.
2873 mstart) ; start of a macro.
2877 (narrow-to-region (point-min) here)
2878 ;; Each time round the following loop, we enter a successively deeper
2879 ;; level of brace/paren nesting. (Except sometimes we "continue at
2880 ;; the existing level".) `pa+1' is a pos inside an opening
2881 ;; brace/paren/bracket, usually just after it.
2884 ;; Each time round the next loop moves forward over an opening then
2885 ;; a closing brace/bracket/paren. This loop is white hot, so it
2886 ;; plays ugly tricks to go fast. DON'T PUT ANYTHING INTO THIS
2887 ;; LOOP WHICH ISN'T ABSOLUTELY NECESSARY!!! It terminates when a
2888 ;; call of `scan-lists' signals an error, which happens when there
2889 ;; are no more b/b/p's to scan.
2892 (setq pa+1 (c-sc-scan-lists ren+1 1 -1) ; Into (/{/[; might signal
2893 paren+1s (cons pa+1 paren+1s))
2894 (setq ren+1 (c-sc-scan-lists pa+1 1 1)) ; Out of )/}/]; might signal
2895 (if (and (eq (char-before pa+1) ?{)) ; Check for a macro later.
2897 (setcar paren+1s ren+1)))
2899 (if (and pa+1 (> pa+1 ren+1))
2900 ;; We've just entered a deeper nesting level.
2902 ;; Insert the brace pair (if present) and the single open
2903 ;; paren/brace/bracket into `c-state-cache' It cannot be
2904 ;; inside a macro, except one around point, because of what
2905 ;; `c-neutralize-syntax-in-CPP' has done.
2906 (c-state-push-any-brace-pair bra+1 macro-start-or-here)
2907 ;; Insert the opening brace/bracket/paren position.
2908 (setq c-state-cache (cons (1- pa+1) c-state-cache))
2909 ;; Clear admin stuff for the next more nested part of the scan.
2910 (setq ren+1 pa+1 pa+1 nil bra+1 nil bra+1s nil)
2911 t) ; Carry on the loop
2913 ;; All open p/b/b's at this nesting level, if any, have probably
2914 ;; been closed by matching/mismatching ones. We're probably
2915 ;; finished - we just need to check for having found an
2916 ;; unmatched )/}/], which we ignore. Such a )/}/] can't be in a
2917 ;; macro, due the action of `c-neutralize-syntax-in-CPP'.
2918 (c-safe (setq ren+1 (c-sc-scan-lists ren+1 1 1)))))) ; acts as loop control.
2920 ;; Record the final, innermost, brace-pair if there is one.
2921 (c-state-push-any-brace-pair bra+1 macro-start-or-here)
2923 ;; Determine a good pos
2924 (while (and (setq paren+1 (car paren+1s))
2925 (> (if (> paren+1 macro-start-or-here)
2928 (setq mstart (and (c-beginning-of-macro)
2930 (or mstart paren+1))
2932 (setq paren+1s (cdr paren+1s)))
2934 ((and paren+1 mstart)
2935 (min paren+1 mstart))
2939 (defun c-remove-stale-state-cache (start-point here pps-point)
2940 ;; Remove stale entries from the `c-cache-state', i.e. those which will
2941 ;; not be in it when it is amended for position HERE. This may involve
2942 ;; replacing a CONS element for a brace pair containing HERE with its car.
2943 ;; Additionally, the "outermost" open-brace entry before HERE will be
2944 ;; converted to a cons if the matching close-brace is below HERE.
2946 ;; START-POINT is a "maximal" "safe position" - there must be no open
2947 ;; parens/braces/brackets between START-POINT and HERE.
2949 ;; As a second thing, calculate the result of parse-partial-sexp at
2950 ;; PPS-POINT, w.r.t. START-POINT. The motivation here is that
2951 ;; `c-state-cache-good-pos' may become PPS-POINT, but the caller may need to
2952 ;; adjust it to get outside a string/comment. (Sorry about this! The code
2953 ;; needs to be FAST).
2955 ;; Return a list (GOOD-POS SCAN-BACK-POS CONS-SEPARATED PPS-STATE), where
2956 ;; o - GOOD-POS is a position where the new value `c-state-cache' is known
2957 ;; to be good (we aim for this to be as high as possible);
2958 ;; o - SCAN-BACK-POS, if not nil, indicates there may be a brace pair
2959 ;; preceding POS which needs to be recorded in `c-state-cache'. It is a
2960 ;; position to scan backwards from. It is the position of the "{" of the
2961 ;; last element to be removed from `c-state-cache', when that elt is a
2962 ;; cons, otherwise nil.
2963 ;; o - CONS-SEPARATED is t when a cons element in `c-state-cache' has been
2964 ;; replaced by its car because HERE lies inside the brace pair represented
2966 ;; o - PPS-STATE is the parse-partial-sexp state at PPS-POINT.
2969 (narrow-to-region 1 (point-max))
2970 (let* ((in-macro-start ; start of macro containing HERE or nil.
2973 (and (c-beginning-of-macro)
2975 (start-point-actual-macro-start ; Start of macro containing
2976 ; start-point or nil
2977 (and (< start-point here)
2979 (goto-char start-point)
2980 (and (c-beginning-of-macro)
2982 (start-point-actual-macro-end ; End of this macro, (maybe
2984 (and start-point-actual-macro-start
2986 (goto-char start-point-actual-macro-start)
2989 pps-state ; Will be 9 or 10 elements long.
2991 upper-lim ; ,beyond which `c-state-cache' entries are removed
2994 pair-beg pps-point-state target-depth)
2996 ;; Remove entries beyond HERE. Also remove any entries inside
2997 ;; a macro, unless HERE is in the same macro.
2999 (if (or (null c-state-old-cpp-beg)
3000 (and (> here c-state-old-cpp-beg)
3001 (< here c-state-old-cpp-end)))
3003 (min here c-state-old-cpp-beg)))
3004 (while (and c-state-cache (>= (c-state-cache-top-lparen) upper-lim))
3005 (setq scan-back-pos (car-safe (car c-state-cache)))
3006 (setq c-state-cache (cdr c-state-cache)))
3008 ;; If `upper-lim' is inside the last recorded brace pair, remove its
3009 ;; RBrace and indicate we'll need to search backwards for a previous
3011 (when (and c-state-cache
3012 (consp (car c-state-cache))
3013 (> (cdar c-state-cache) upper-lim))
3014 (setcar c-state-cache (caar c-state-cache))
3015 (setq scan-back-pos (car c-state-cache)
3018 ;; The next loop jumps forward out of a nested level of parens each
3019 ;; time round; the corresponding elements in `c-state-cache' are
3020 ;; removed. `pos' is just after the brace-pair or the open paren at
3021 ;; (car c-state-cache). There can be no open parens/braces/brackets
3022 ;; between `start-point'/`start-point-actual-macro-start' and HERE,
3023 ;; due to the interface spec to this function.
3024 (setq pos (if (and start-point-actual-macro-end
3025 (not (eq start-point-actual-macro-start
3027 (1+ start-point-actual-macro-end) ; get outside the macro as
3028 ; marked by a `category' text property.
3031 (while (and c-state-cache
3032 (or (numberp (car c-state-cache)) ; Have we a { at all?
3033 (cdr c-state-cache))
3036 ((null pps-state) ; first time through
3037 (setq target-depth -1))
3038 ((eq (car pps-state) target-depth) ; found closing ),},]
3039 (setq target-depth (1- (car pps-state))))
3040 ;; Do nothing when we've merely reached pps-point.
3045 (c-sc-parse-partial-sexp
3046 (point) (if (< (point) pps-point) pps-point here)
3050 (if (= (point) pps-point)
3051 (setq pps-point-state pps-state))
3053 (when (eq (car pps-state) target-depth)
3054 (setq pos (point)) ; POS is now just after an R-paren/brace.
3056 ((and (consp (car c-state-cache))
3057 (eq (point) (cdar c-state-cache)))
3058 ;; We've just moved out of the paren pair containing the brace-pair
3059 ;; at (car c-state-cache). `pair-beg' is where the open paren is,
3060 ;; and is potentially where the open brace of a cons in
3061 ;; c-state-cache will be.
3062 (setq pair-beg (car-safe (cdr c-state-cache))
3063 c-state-cache (cdr-safe (cdr c-state-cache)))) ; remove {}pair + containing Lparen.
3064 ((numberp (car c-state-cache))
3065 (setq pair-beg (car c-state-cache)
3066 c-state-cache (cdr c-state-cache))) ; remove this
3068 ((numberp (cadr c-state-cache))
3069 (setq pair-beg (cadr c-state-cache)
3070 c-state-cache (cddr c-state-cache))) ; Remove a paren pair
3071 ; together with enclosed brace pair.
3072 ;; (t nil) ; Ignore an unmated Rparen.
3075 (if (< (point) pps-point)
3076 (setq pps-state (c-sc-parse-partial-sexp
3078 nil nil ; TARGETDEPTH, STOPBEFORE
3081 ;; If the last paren pair we moved out of was actually a brace pair,
3082 ;; insert it into `c-state-cache'.
3083 (when (and pair-beg (eq (char-after pair-beg) ?{))
3084 (if (consp (car-safe c-state-cache))
3085 (setq c-state-cache (cdr c-state-cache)))
3086 (setq c-state-cache (cons (cons pair-beg pos)
3089 (list pos scan-back-pos cons-separated pps-state)))))
3091 (defun c-remove-stale-state-cache-backwards (here)
3092 ;; Strip stale elements of `c-state-cache' by moving backwards through the
3093 ;; buffer, and inform the caller of the scenario detected.
3095 ;; HERE is the position we're setting `c-state-cache' for.
3096 ;; CACHE-POS (a locally bound variable) is just after the latest recorded
3097 ;; position in `c-state-cache' before HERE, or a position at or near
3098 ;; point-min which isn't in a literal.
3100 ;; This function must only be called only when (> `c-state-cache-good-pos'
3101 ;; HERE). Usually the gap between CACHE-POS and HERE is large. It is thus
3102 ;; optimized to eliminate (or minimize) scanning between these two
3105 ;; Return a three element list (GOOD-POS SCAN-BACK-POS FWD-FLAG), where:
3106 ;; o - GOOD-POS is a "good position", where `c-state-cache' is valid, or
3107 ;; could become so after missing elements are inserted into
3108 ;; `c-state-cache'. This is JUST AFTER an opening or closing
3109 ;; brace/paren/bracket which is already in `c-state-cache' or just before
3110 ;; one otherwise. exceptionally (when there's no such b/p/b handy) the BOL
3111 ;; before `here''s line, or the start of the literal containing it.
3112 ;; o - SCAN-BACK-POS, if non-nil, indicates there may be a brace pair
3113 ;; preceding POS which isn't recorded in `c-state-cache'. It is a position
3114 ;; to scan backwards from.
3115 ;; o - FWD-FLAG, if non-nil, indicates there may be parens/braces between
3116 ;; POS and HERE which aren't recorded in `c-state-cache'.
3118 ;; The comments in this defun use "paren" to mean parenthesis or square
3119 ;; bracket (as contrasted with a brace), and "(" and ")" likewise.
3121 ;; . {..} (..) (..) ( .. { } ) (...) ( .... . ..)
3123 ;; CP E here D C good
3124 (let ((cache-pos (c-get-cache-scan-pos here)) ; highest position below HERE in cache (or 1)
3125 (pos c-state-cache-good-pos)
3126 pa ren ; positions of "(" and ")"
3127 dropped-cons ; whether the last element dropped from `c-state-cache'
3128 ; was a cons (representing a brace-pair)
3129 good-pos ; see above.
3130 lit ; (START . END) of a literal containing some point.
3131 here-lit-start here-lit-end ; bounds of literal containing `here'
3133 here- here+ ; start/end of macro around HERE, or HERE
3134 (here-bol (c-point 'bol here))
3135 (too-far-back (max (- here c-state-cache-too-far) (point-min))))
3137 ;; Remove completely irrelevant entries from `c-state-cache'.
3138 (while (and c-state-cache
3139 (>= (setq pa (c-state-cache-top-lparen)) here))
3140 (setq dropped-cons (consp (car c-state-cache)))
3141 (setq c-state-cache (cdr c-state-cache))
3143 ;; At this stage, (>= pos here);
3144 ;; (< (c-state-cache-top-lparen) here) (or is nil).
3147 ((and (consp (car c-state-cache))
3148 (> (cdar c-state-cache) here))
3149 ;; CASE 1: The top of the cache is a brace pair which now encloses
3150 ;; `here'. As good-pos, return the address. of the "{". Since we've no
3151 ;; knowledge of what's inside these braces, we have no alternative but
3152 ;; to direct the caller to scan the buffer from the opening brace.
3153 (setq pos (caar c-state-cache))
3154 (setcar c-state-cache pos)
3155 (list (1+ pos) pos t)) ; return value. We've just converted a brace pair
3156 ; entry into a { entry, so the caller needs to
3157 ; search for a brace pair before the {.
3159 ;; `here' might be inside a literal. Check for this.
3161 (setq lit (c-state-literal-at here)
3162 here-lit-start (or (car lit) here)
3163 here-lit-end (or (cdr lit) here))
3164 ;; Has `here' just "newly entered" a macro?
3166 (goto-char here-lit-start)
3167 (if (and (c-beginning-of-macro)
3168 (or (null c-state-old-cpp-beg)
3169 (not (= (point) c-state-old-cpp-beg))))
3171 (setq here- (point))
3173 (setq here+ (point)))
3174 (setq here- here-lit-start
3175 here+ here-lit-end)))
3177 ;; `here' might be nested inside any depth of parens (or brackets but
3178 ;; not braces). Scan backwards to find the outermost such opening
3179 ;; paren, if there is one. This will be the scan position to return.
3181 (narrow-to-region cache-pos (point-max))
3182 (setq pos (c-state-balance-parens-backwards here- here+ pos)))
3183 nil)) ; for the cond
3185 ((< pos here-lit-start)
3186 ;; CASE 2: Address of outermost ( or [ which now encloses `here', but
3187 ;; didn't enclose the (previous) `c-state-cache-good-pos'. If there is
3188 ;; a brace pair preceding this, it will already be in `c-state-cache',
3189 ;; unless there was a brace pair after it, i.e. there'll only be one to
3190 ;; scan for if we've just deleted one.
3191 (list pos (and dropped-cons pos) t)) ; Return value.
3193 ;; `here' isn't enclosed in a (previously unrecorded) bracket/paren.
3194 ;; Further forward scanning isn't needed, but we still need to find a
3195 ;; GOOD-POS. Step out of all enclosing "("s on HERE's line.
3198 (narrow-to-region here-bol (point-max))
3199 (setq pos here-lit-start)
3200 (c-safe (while (setq pa (c-sc-scan-lists pos -1 1))
3201 (setq pos pa)))) ; might signal
3202 nil)) ; for the cond
3205 (narrow-to-region too-far-back (point-max))
3206 (setq ren (c-safe (c-sc-scan-lists pos -1 -1))))
3207 ;; CASE 3: After a }/)/] before `here''s BOL.
3208 (list (1+ ren) (and dropped-cons pos) nil)) ; Return value
3210 ((progn (setq good-pos (c-state-lit-beg (c-point 'bopl here-bol)))
3211 (>= cache-pos good-pos))
3212 ;; CASE 3.5: Just after an existing entry in `c-state-cache' on `here''s
3213 ;; line or the previous line.
3214 (list cache-pos nil nil))
3217 ;; CASE 4; Best of a bad job: BOL before `here-bol', or beginning of
3218 ;; literal containing it.
3219 (list good-pos (and dropped-cons good-pos) nil)))))
3222 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3223 ;; Externally visible routines.
3225 (defun c-state-cache-init ()
3226 (setq c-state-cache nil
3227 c-state-cache-good-pos 1
3228 c-state-nonlit-pos-cache nil
3229 c-state-nonlit-pos-cache-limit 1
3230 c-state-semi-nonlit-pos-cache nil
3231 c-state-semi-nonlit-pos-cache-limit 1
3232 c-state-brace-pair-desert nil
3234 c-state-point-min-lit-type nil
3235 c-state-point-min-lit-start nil
3236 c-state-min-scan-pos 1
3237 c-state-old-cpp-beg nil
3238 c-state-old-cpp-end nil)
3239 (c-state-mark-point-min-literal))
3241 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3242 ;; Debugging routines to dump `c-state-cache' in a "replayable" form.
3243 ;; (defmacro c-sc-de (elt) ; "c-state-cache-dump-element"
3244 ;; `(format ,(concat "(setq " (symbol-name elt) " %s) ") ,elt))
3245 ;; (defmacro c-sc-qde (elt) ; "c-state-cache-quote-dump-element"
3246 ;; `(format ,(concat "(setq " (symbol-name elt) " '%s) ") ,elt))
3247 ;; (defun c-state-dump ()
3248 ;; ;; For debugging.
3251 ;; (c-sc-qde c-state-cache)
3252 ;; (c-sc-de c-state-cache-good-pos)
3253 ;; (c-sc-qde c-state-nonlit-pos-cache)
3254 ;; (c-sc-de c-state-nonlit-pos-cache-limit)
3255 ;; (c-sc-qde c-state-brace-pair-desert)
3256 ;; (c-sc-de c-state-point-min)
3257 ;; (c-sc-de c-state-point-min-lit-type)
3258 ;; (c-sc-de c-state-point-min-lit-start)
3259 ;; (c-sc-de c-state-min-scan-pos)
3260 ;; (c-sc-de c-state-old-cpp-beg)
3261 ;; (c-sc-de c-state-old-cpp-end)))
3262 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3264 (defun c-invalidate-state-cache-1 (here)
3265 ;; Invalidate all info on `c-state-cache' that applies to the buffer at HERE
3266 ;; or higher and set `c-state-cache-good-pos' accordingly. The cache is
3267 ;; left in a consistent state.
3269 ;; This is much like `c-whack-state-after', but it never changes a paren
3270 ;; pair element into an open paren element. Doing that would mean that the
3271 ;; new open paren wouldn't have the required preceding paren pair element.
3273 ;; This function is called from c-before-change.
3275 ;; The caches of non-literals:
3276 ;; Note that we use "<=" for the possibility of the second char of a two-char
3277 ;; comment opener being typed; this would invalidate any cache position at
3279 (if (<= here c-state-nonlit-pos-cache-limit)
3280 (setq c-state-nonlit-pos-cache-limit (1- here)))
3281 (if (<= here c-state-semi-nonlit-pos-cache-limit)
3282 (setq c-state-semi-nonlit-pos-cache-limit (1- here)))
3285 ;; Case 1: if `here' is in a literal containing point-min, everything
3286 ;; becomes (or is already) nil.
3287 (if (or (null c-state-cache-good-pos)
3288 (< here (c-state-get-min-scan-pos)))
3289 (setq c-state-cache nil
3290 c-state-cache-good-pos nil
3291 c-state-min-scan-pos nil)
3293 ;; Truncate `c-state-cache' and set `c-state-cache-good-pos' to a value
3294 ;; below `here'. To maintain its consistency, we may need to insert a new
3296 (let ((here-bol (c-point 'bol here))
3297 too-high-pa ; recorded {/(/[ next above or just below here, or nil.
3298 dropped-cons ; was the last removed element a brace pair?
3300 ;; The easy bit - knock over-the-top bits off `c-state-cache'.
3301 (while (and c-state-cache
3302 (>= (setq pa (c-state-cache-top-paren)) here))
3303 (setq dropped-cons (consp (car c-state-cache))
3304 too-high-pa (c-state-cache-top-lparen)
3305 c-state-cache (cdr c-state-cache)))
3307 ;; Do we need to add in an earlier brace pair, having lopped one off?
3308 (if (and dropped-cons
3309 (<= too-high-pa here))
3310 (c-append-lower-brace-pair-to-state-cache too-high-pa here here-bol))
3311 (setq c-state-cache-good-pos (or (c-state-cache-after-top-paren)
3312 (c-state-get-min-scan-pos)))))
3314 ;; The brace-pair desert marker:
3315 (when (car c-state-brace-pair-desert)
3316 (if (< here (car c-state-brace-pair-desert))
3317 (setq c-state-brace-pair-desert nil)
3318 (if (< here (cdr c-state-brace-pair-desert))
3319 (setcdr c-state-brace-pair-desert here)))))
3321 (defun c-parse-state-1 ()
3322 ;; Find and record all noteworthy parens between some good point earlier in
3323 ;; the file and point. That good point is at least the beginning of the
3324 ;; top-level construct we are in, or the beginning of the preceding
3325 ;; top-level construct if we aren't in one.
3327 ;; The returned value is a list of the noteworthy parens with the last one
3328 ;; first. If an element in the list is an integer, it's the position of an
3329 ;; open paren (of any type) which has not been closed before the point. If
3330 ;; an element is a cons, it gives the position of a closed BRACE paren
3331 ;; pair[*]; the car is the start brace position and the cdr is the position
3332 ;; following the closing brace. Only the last closed brace paren pair
3333 ;; before each open paren and before the point is recorded, and thus the
3334 ;; state never contains two cons elements in succession. When a close brace
3335 ;; has no matching open brace (e.g., the matching brace is outside the
3336 ;; visible region), it is not represented in the returned value.
3338 ;; [*] N.B. The close "brace" might be a mismatching close bracket or paren.
3339 ;; This defun explicitly treats mismatching parens/braces/brackets as
3340 ;; matching. It is the open brace which makes it a "brace" pair.
3342 ;; If POINT is within a macro, open parens and brace pairs within
3343 ;; THIS macro MIGHT be recorded. This depends on whether their
3344 ;; syntactic properties have been suppressed by
3345 ;; `c-neutralize-syntax-in-CPP'. This might need fixing (2008-12-11).
3347 ;; Currently no characters which are given paren syntax with the
3348 ;; syntax-table property are recorded, i.e. angle bracket arglist
3349 ;; parens are never present here. Note that this might change.
3351 ;; BUG: This function doesn't cope entirely well with unbalanced
3352 ;; parens in macros. (2008-12-11: this has probably been resolved
3353 ;; by the function `c-neutralize-syntax-in-CPP'.) E.g. in the
3354 ;; following case the brace before the macro isn't balanced with the
3361 ;; Note to maintainers: this function DOES get called with point
3362 ;; within comments and strings, so don't assume it doesn't!
3364 ;; This function might do hidden buffer changes.
3365 (let* ((here (point))
3366 (here-bopl (c-point 'bopl))
3367 strategy ; 'forward, 'backward etc..
3368 ;; Candidate positions to start scanning from:
3369 cache-pos ; highest position below HERE already existing in
3372 start-point ; (when scanning forward) a place below HERE where there
3373 ; are no open parens/braces between it and HERE.
3377 scan-backward-pos scan-forward-p) ; used for 'backward.
3378 ;; If POINT-MIN has changed, adjust the cache
3379 (unless (= (point-min) c-state-point-min)
3380 (c-renarrow-state-cache))
3383 (setq res (c-parse-state-get-strategy here c-state-cache-good-pos)
3385 start-point (cadr res))
3387 (when (eq strategy 'BOD)
3388 (setq c-state-cache nil
3389 c-state-cache-good-pos start-point))
3393 ((memq strategy '(forward back-and-forward BOD))
3394 (setq res (c-remove-stale-state-cache start-point here here-bopl))
3395 (setq cache-pos (car res)
3396 scan-backward-pos (cadr res)
3397 cons-separated (car (cddr res))
3398 bopl-state (cadr (cddr res))) ; will be nil if (< here-bopl
3400 (if (and scan-backward-pos
3401 (or cons-separated (eq strategy 'forward))) ;scan-backward-pos
3402 (c-append-lower-brace-pair-to-state-cache scan-backward-pos here))
3404 (c-append-to-state-cache cache-pos here))
3405 (setq c-state-cache-good-pos
3407 (< good-pos (- here c-state-cache-too-far)))
3408 (c-state-cache-non-literal-place here-bopl bopl-state)
3411 ((eq strategy 'backward)
3412 (setq res (c-remove-stale-state-cache-backwards here)
3414 scan-backward-pos (cadr res)
3415 scan-forward-p (car (cddr res)))
3416 (if scan-backward-pos
3417 (c-append-lower-brace-pair-to-state-cache scan-backward-pos here))
3418 (setq c-state-cache-good-pos
3420 (c-append-to-state-cache good-pos here)
3423 (t ; (eq strategy 'IN-LIT)
3424 (setq c-state-cache nil
3425 c-state-cache-good-pos nil))))
3429 (defun c-invalidate-state-cache (here)
3430 ;; This is a wrapper over `c-invalidate-state-cache-1'.
3432 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3433 ;; of all parens in preprocessor constructs, except for any such construct
3434 ;; containing point. We can then call `c-invalidate-state-cache-1' without
3435 ;; worrying further about macros and template delimiters.
3436 (if (eval-when-compile (memq 'category-properties c-emacs-features))
3438 (c-with-<->-as-parens-suppressed
3439 (if (and c-state-old-cpp-beg
3440 (< c-state-old-cpp-beg here))
3441 (c-with-all-but-one-cpps-commented-out
3443 (min c-state-old-cpp-end here)
3444 (c-invalidate-state-cache-1 here))
3445 (c-with-cpps-commented-out
3446 (c-invalidate-state-cache-1 here))))
3448 (c-invalidate-state-cache-1 here)))
3450 (defmacro c-state-maybe-marker (place marker)
3451 ;; If PLACE is non-nil, return a marker marking it, otherwise nil.
3452 ;; We (re)use MARKER.
3454 (or ,marker (setq ,marker (make-marker)))
3455 (set-marker ,marker ,place)))
3457 (defun c-parse-state ()
3458 ;; This is a wrapper over `c-parse-state-1'. See that function for a
3459 ;; description of the functionality and return value.
3461 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3462 ;; of all parens in preprocessor constructs, except for any such construct
3463 ;; containing point. We can then call `c-parse-state-1' without worrying
3464 ;; further about macros and template delimiters.
3465 (let (here-cpp-beg here-cpp-end)
3467 (when (c-beginning-of-macro)
3468 (setq here-cpp-beg (point))
3470 (> (setq here-cpp-end (c-syntactic-end-of-macro))
3472 (setq here-cpp-beg nil here-cpp-end nil))))
3473 ;; FIXME!!! Put in a `condition-case' here to protect the integrity of the
3476 (if (eval-when-compile (memq 'category-properties c-emacs-features))
3478 (c-with-<->-as-parens-suppressed
3479 (if (and here-cpp-beg (> here-cpp-end here-cpp-beg))
3480 (c-with-all-but-one-cpps-commented-out
3481 here-cpp-beg here-cpp-end
3483 (c-with-cpps-commented-out
3484 (c-parse-state-1))))
3487 (setq c-state-old-cpp-beg
3488 (c-state-maybe-marker here-cpp-beg c-state-old-cpp-beg-marker)
3490 (c-state-maybe-marker here-cpp-end c-state-old-cpp-end-marker)))))
3492 ;; Debug tool to catch cache inconsistencies. This is called from
3494 (defvar c-debug-parse-state nil)
3495 (unless (fboundp 'c-real-parse-state)
3496 (fset 'c-real-parse-state (symbol-function 'c-parse-state)))
3497 (cc-bytecomp-defun c-real-parse-state)
3499 (defvar c-parse-state-point nil)
3500 (defvar c-parse-state-state nil)
3501 (make-variable-buffer-local 'c-parse-state-state)
3502 (defun c-record-parse-state-state ()
3503 (setq c-parse-state-point (point))
3504 (when (markerp (cdr (assq 'c-state-old-cpp-beg c-parse-state-state)))
3505 (move-marker (cdr (assq 'c-state-old-cpp-beg c-parse-state-state)) nil)
3506 (move-marker (cdr (assq 'c-state-old-cpp-end c-parse-state-state)) nil))
3507 (setq c-parse-state-state
3510 (let ((val (symbol-value arg)))
3512 (cond ((consp val) (copy-tree val))
3513 ((markerp val) (copy-marker val))
3516 c-state-cache-good-pos
3517 c-state-nonlit-pos-cache
3518 c-state-nonlit-pos-cache-limit
3519 c-state-semi-nonlit-pos-cache
3520 c-state-semi-nonlit-pos-cache-limit
3521 c-state-brace-pair-desert
3523 c-state-point-min-lit-type
3524 c-state-point-min-lit-start
3525 c-state-min-scan-pos
3528 c-parse-state-point))))
3529 (defun c-replay-parse-state-state ()
3534 (format "%s %s%s" (car arg)
3535 (if (atom (cdr arg)) "" "'")
3536 (if (markerp (cdr arg))
3537 (format "(copy-marker %s)" (marker-position (cdr arg)))
3539 c-parse-state-state " ")
3542 (defun c-debug-parse-state-double-cons (state)
3543 (let (state-car conses-not-ok)
3545 (setq state-car (car state)
3547 (if (and (consp state-car)
3548 (consp (car state)))
3549 (setq conses-not-ok t)))
3552 (defun c-debug-parse-state ()
3553 (let ((here (point)) (res1 (c-real-parse-state)) res2)
3554 (let ((c-state-cache nil)
3555 (c-state-cache-good-pos 1)
3556 (c-state-nonlit-pos-cache nil)
3557 (c-state-nonlit-pos-cache-limit 1)
3558 (c-state-brace-pair-desert nil)
3559 (c-state-point-min 1)
3560 (c-state-point-min-lit-type nil)
3561 (c-state-point-min-lit-start nil)
3562 (c-state-min-scan-pos 1)
3563 (c-state-old-cpp-beg nil)
3564 (c-state-old-cpp-end nil))
3565 (setq res2 (c-real-parse-state)))
3566 (unless (equal res1 res2)
3567 ;; The cache can actually go further back due to the ad-hoc way
3568 ;; the first paren is found, so try to whack off a bit of its
3569 ;; start before complaining.
3571 ;; (goto-char (or (c-least-enclosing-brace res2) (point)))
3572 ;; (c-beginning-of-defun-1)
3573 ;; (while (not (or (bobp) (eq (char-after) ?{)))
3574 ;; (c-beginning-of-defun-1))
3575 ;; (unless (equal (c-whack-state-before (point) res1) res2)
3576 ;; (message (concat "c-parse-state inconsistency at %s: "
3577 ;; "using cache: %s, from scratch: %s")
3578 ;; here res1 res2)))
3579 (message (concat "c-parse-state inconsistency at %s: "
3580 "using cache: %s, from scratch: %s")
3582 (message "Old state:")
3583 (c-replay-parse-state-state))
3585 (when (c-debug-parse-state-double-cons res1)
3586 (message "c-parse-state INVALIDITY at %s: %s"
3588 (message "Old state:")
3589 (c-replay-parse-state-state))
3591 (c-record-parse-state-state)
3592 res2 ; res1 correct a cascading series of errors ASAP
3595 (defun c-toggle-parse-state-debug (&optional arg)
3597 (setq c-debug-parse-state (c-calculate-state arg c-debug-parse-state))
3598 (fset 'c-parse-state (symbol-function (if c-debug-parse-state
3599 'c-debug-parse-state
3600 'c-real-parse-state)))
3601 (c-keep-region-active)
3602 (message "c-debug-parse-state %sabled"
3603 (if c-debug-parse-state "en" "dis")))
3604 (when c-debug-parse-state
3605 (c-toggle-parse-state-debug 1))
3608 (defun c-whack-state-before (bufpos paren-state)
3609 ;; Whack off any state information from PAREN-STATE which lies
3610 ;; before BUFPOS. Not destructive on PAREN-STATE.
3611 (let* ((newstate (list nil))
3615 (setq car (car paren-state)
3616 paren-state (cdr paren-state))
3617 (if (< (if (consp car) (car car) car) bufpos)
3618 (setq paren-state nil)
3619 (setcdr ptr (list car))
3620 (setq ptr (cdr ptr))))
3623 (defun c-whack-state-after (bufpos paren-state)
3624 ;; Whack off any state information from PAREN-STATE which lies at or
3625 ;; after BUFPOS. Not destructive on PAREN-STATE.
3628 (let ((car (car paren-state)))
3630 ;; just check the car, because in a balanced brace
3631 ;; expression, it must be impossible for the corresponding
3632 ;; close brace to be before point, but the open brace to
3634 (if (<= bufpos (car car))
3636 (if (< bufpos (cdr car))
3637 ;; its possible that the open brace is before
3638 ;; bufpos, but the close brace is after. In that
3639 ;; case, convert this to a non-cons element. The
3640 ;; rest of the state is before bufpos, so we're
3642 (throw 'done (cons (car car) (cdr paren-state)))
3643 ;; we know that both the open and close braces are
3644 ;; before bufpos, so we also know that everything else
3645 ;; on state is before bufpos.
3646 (throw 'done paren-state)))
3649 ;; it's before bufpos, so everything else should too.
3650 (throw 'done paren-state)))
3651 (setq paren-state (cdr paren-state)))
3654 (defun c-most-enclosing-brace (paren-state &optional bufpos)
3655 ;; Return the bufpos of the innermost enclosing open paren before
3656 ;; bufpos, or nil if none was found.
3658 (or bufpos (setq bufpos 134217727))
3660 (setq enclosingp (car paren-state)
3661 paren-state (cdr paren-state))
3662 (if (or (consp enclosingp)
3663 (>= enclosingp bufpos))
3664 (setq enclosingp nil)
3665 (setq paren-state nil)))
3668 (defun c-least-enclosing-brace (paren-state)
3669 ;; Return the bufpos of the outermost enclosing open paren, or nil
3670 ;; if none was found.
3673 (setq elem (car paren-state)
3674 paren-state (cdr paren-state))
3679 (defun c-safe-position (bufpos paren-state)
3680 ;; Return the closest "safe" position recorded on PAREN-STATE that
3681 ;; is higher up than BUFPOS. Return nil if PAREN-STATE doesn't
3682 ;; contain any. Return nil if BUFPOS is nil, which is useful to
3683 ;; find the closest limit before a given limit that might be nil.
3685 ;; A "safe" position is a position at or after a recorded open
3686 ;; paren, or after a recorded close paren. The returned position is
3687 ;; thus either the first position after a close brace, or the first
3688 ;; position after an enclosing paren, or at the enclosing paren in
3689 ;; case BUFPOS is immediately after it.
3694 (setq elem (car paren-state))
3696 (cond ((< (cdr elem) bufpos)
3697 (throw 'done (cdr elem)))
3698 ((< (car elem) bufpos)
3700 (throw 'done (min (1+ (car elem)) bufpos))))
3702 ;; elem is the position at and not after the opening paren, so
3703 ;; we can go forward one more step unless it's equal to
3704 ;; bufpos. This is useful in some cases avoid an extra paren
3705 ;; level between the safe position and bufpos.
3706 (throw 'done (min (1+ elem) bufpos))))
3707 (setq paren-state (cdr paren-state)))))))
3709 (defun c-beginning-of-syntax ()
3710 ;; This is used for `font-lock-beginning-of-syntax-function'. It
3711 ;; goes to the closest previous point that is known to be outside
3712 ;; any string literal or comment. `c-state-cache' is used if it has
3713 ;; a position in the vicinity.
3714 (let* ((paren-state c-state-cache)
3718 ;; Note: Similar code in `c-safe-position'. The
3719 ;; difference is that we accept a safe position at
3720 ;; the point and don't bother to go forward past open
3723 (setq elem (car paren-state))
3725 (cond ((<= (cdr elem) (point))
3726 (throw 'done (cdr elem)))
3727 ((<= (car elem) (point))
3728 (throw 'done (car elem))))
3729 (if (<= elem (point))
3730 (throw 'done elem)))
3731 (setq paren-state (cdr paren-state)))
3734 (if (> pos (- (point) 4000))
3736 ;; The position is far back. Try `c-beginning-of-defun-1'
3737 ;; (although we can't be entirely sure it will go to a position
3738 ;; outside a comment or string in current emacsen). FIXME:
3739 ;; Consult `syntax-ppss' here.
3740 (c-beginning-of-defun-1)
3745 ;; Tools for scanning identifiers and other tokens.
3747 (defun c-on-identifier ()
3748 "Return non-nil if the point is on or directly after an identifier.
3749 Keywords are recognized and not considered identifiers. If an
3750 identifier is detected, the returned value is its starting position.
3751 If an identifier ends at the point and another begins at it \(can only
3752 happen in Pike) then the point for the preceding one is returned.
3754 Note that this function might do hidden buffer changes. See the
3755 comment at the start of cc-engine.el for more info."
3757 ;; FIXME: Shouldn't this function handle "operator" in C++?
3760 (skip-syntax-backward "w_")
3764 ;; Check for a normal (non-keyword) identifier.
3765 (and (looking-at c-symbol-start)
3766 (not (looking-at c-keywords-regexp))
3769 (when (c-major-mode-is 'pike-mode)
3770 ;; Handle the `<operator> syntax in Pike.
3771 (let ((pos (point)))
3772 (skip-chars-backward "-!%&*+/<=>^|~[]()")
3773 (and (if (< (skip-chars-backward "`") 0)
3776 (eq (char-after) ?\`))
3777 (looking-at c-symbol-key)
3778 (>= (match-end 0) pos)
3781 ;; Handle the "operator +" syntax in C++.
3782 (when (and c-overloadable-operators-regexp
3783 (= (c-backward-token-2 0) 0))
3785 (cond ((and (looking-at c-overloadable-operators-regexp)
3786 (or (not c-opt-op-identifier-prefix)
3787 (and (= (c-backward-token-2 1) 0)
3788 (looking-at c-opt-op-identifier-prefix))))
3792 (and c-opt-op-identifier-prefix
3793 (looking-at c-opt-op-identifier-prefix)
3794 (= (c-forward-token-2 1) 0)
3795 (looking-at c-overloadable-operators-regexp)))
3800 (defsubst c-simple-skip-symbol-backward ()
3801 ;; If the point is at the end of a symbol then skip backward to the
3802 ;; beginning of it. Don't move otherwise. Return non-nil if point
3805 ;; This function might do hidden buffer changes.
3806 (or (< (skip-syntax-backward "w_") 0)
3807 (and (c-major-mode-is 'pike-mode)
3808 ;; Handle the `<operator> syntax in Pike.
3809 (let ((pos (point)))
3810 (if (and (< (skip-chars-backward "-!%&*+/<=>^|~[]()") 0)
3811 (< (skip-chars-backward "`") 0)
3812 (looking-at c-symbol-key)
3813 (>= (match-end 0) pos))
3818 (defun c-beginning-of-current-token (&optional back-limit)
3819 ;; Move to the beginning of the current token. Do not move if not
3820 ;; in the middle of one. BACK-LIMIT may be used to bound the
3821 ;; backward search; if given it's assumed to be at the boundary
3822 ;; between two tokens. Return non-nil if the point is moved, nil
3825 ;; This function might do hidden buffer changes.
3826 (let ((start (point)))
3827 (if (looking-at "\\w\\|\\s_")
3828 (skip-syntax-backward "w_" back-limit)
3829 (when (< (skip-syntax-backward ".()" back-limit) 0)
3830 (while (let ((pos (or (and (looking-at c-nonsymbol-token-regexp)
3832 ;; `c-nonsymbol-token-regexp' should always match
3833 ;; since we've skipped backward over punctuation
3834 ;; or paren syntax, but consume one char in case
3835 ;; it doesn't so that we don't leave point before
3836 ;; some earlier incorrect token.
3839 (goto-char pos))))))
3842 (defun c-end-of-current-token (&optional back-limit)
3843 ;; Move to the end of the current token. Do not move if not in the
3844 ;; middle of one. BACK-LIMIT may be used to bound the backward
3845 ;; search; if given it's assumed to be at the boundary between two
3846 ;; tokens. Return non-nil if the point is moved, nil otherwise.
3848 ;; This function might do hidden buffer changes.
3849 (let ((start (point)))
3850 (cond ((< (skip-syntax-backward "w_" (1- start)) 0)
3851 (skip-syntax-forward "w_"))
3852 ((< (skip-syntax-backward ".()" back-limit) 0)
3854 (if (looking-at c-nonsymbol-token-regexp)
3855 (goto-char (match-end 0))
3856 ;; `c-nonsymbol-token-regexp' should always match since
3857 ;; we've skipped backward over punctuation or paren
3858 ;; syntax, but move forward in case it doesn't so that
3859 ;; we don't leave point earlier than we started with.
3861 (< (point) start)))))
3864 (defconst c-jump-syntax-balanced
3865 (if (memq 'gen-string-delim c-emacs-features)
3866 "\\w\\|\\s_\\|\\s(\\|\\s)\\|\\s\"\\|\\s|"
3867 "\\w\\|\\s_\\|\\s(\\|\\s)\\|\\s\""))
3869 (defconst c-jump-syntax-unbalanced
3870 (if (memq 'gen-string-delim c-emacs-features)
3871 "\\w\\|\\s_\\|\\s\"\\|\\s|"
3872 "\\w\\|\\s_\\|\\s\""))
3874 (defun c-forward-token-2 (&optional count balanced limit)
3875 "Move forward by tokens.
3876 A token is defined as all symbols and identifiers which aren't
3877 syntactic whitespace \(note that multicharacter tokens like \"==\" are
3878 treated properly). Point is always either left at the beginning of a
3879 token or not moved at all. COUNT specifies the number of tokens to
3880 move; a negative COUNT moves in the opposite direction. A COUNT of 0
3881 moves to the next token beginning only if not already at one. If
3882 BALANCED is true, move over balanced parens, otherwise move into them.
3883 Also, if BALANCED is true, never move out of an enclosing paren.
3885 LIMIT sets the limit for the movement and defaults to the point limit.
3886 The case when LIMIT is set in the middle of a token, comment or macro
3887 is handled correctly, i.e. the point won't be left there.
3889 Return the number of tokens left to move \(positive or negative). If
3890 BALANCED is true, a move over a balanced paren counts as one. Note
3891 that if COUNT is 0 and no appropriate token beginning is found, 1 will
3892 be returned. Thus, a return value of 0 guarantees that point is at
3893 the requested position and a return value less \(without signs) than
3894 COUNT guarantees that point is at the beginning of some token.
3896 Note that this function might do hidden buffer changes. See the
3897 comment at the start of cc-engine.el for more info."
3899 (or count (setq count 1))
3901 (- (c-backward-token-2 (- count) balanced limit))
3903 (let ((jump-syntax (if balanced
3904 c-jump-syntax-balanced
3905 c-jump-syntax-unbalanced))
3910 ;; If count is zero we should jump if in the middle of a token.
3911 (c-end-of-current-token))
3914 (if limit (narrow-to-region (point-min) limit))
3916 (progn (c-forward-syntactic-ws) (point)))
3917 ;; Skip whitespace. Count this as a move if we did in
3919 (setq count (max (1- count) 0)))
3922 ;; Moved out of bounds. Make sure the returned count isn't zero.
3924 (if (zerop count) (setq count 1))
3927 ;; Use `condition-case' to avoid having the limit tests
3934 (cond ((looking-at jump-syntax)
3935 (goto-char (scan-sexps (point) 1))
3937 ((looking-at c-nonsymbol-token-regexp)
3938 (goto-char (match-end 0))
3940 ;; `c-nonsymbol-token-regexp' above should always
3941 ;; match if there are correct tokens. Try to
3942 ;; widen to see if the limit was set in the
3943 ;; middle of one, else fall back to treating
3944 ;; the offending thing as a one character token.
3948 (looking-at c-nonsymbol-token-regexp)))
3953 (c-forward-syntactic-ws)
3956 (error (goto-char last)))
3960 (setq count (1+ count)))))
3964 (defun c-backward-token-2 (&optional count balanced limit)
3965 "Move backward by tokens.
3966 See `c-forward-token-2' for details."
3968 (or count (setq count 1))
3970 (- (c-forward-token-2 (- count) balanced limit))
3972 (or limit (setq limit (point-min)))
3973 (let ((jump-syntax (if balanced
3974 c-jump-syntax-balanced
3975 c-jump-syntax-unbalanced))
3979 ;; The count is zero so try to skip to the beginning of the
3982 (progn (c-beginning-of-current-token) (point)))
3983 (if (< (point) limit)
3984 ;; The limit is inside the same token, so return 1.
3987 ;; We're not in the middle of a token. If there's
3988 ;; whitespace after the point then we must move backward,
3989 ;; so set count to 1 in that case.
3990 (and (looking-at c-syntactic-ws-start)
3991 ;; If we're looking at a '#' that might start a cpp
3992 ;; directive then we have to do a more elaborate check.
3993 (or (/= (char-after) ?#)
3994 (not c-opt-cpp-prefix)
3997 (progn (beginning-of-line)
3998 (looking-at "[ \t]*")
4001 (progn (backward-char)
4002 (not (eq (char-before) ?\\)))))))
4005 ;; Use `condition-case' to avoid having to check for buffer
4006 ;; limits in `backward-char', `scan-sexps' and `goto-char' below.
4011 (c-backward-syntactic-ws)
4013 (if (looking-at jump-syntax)
4014 (goto-char (scan-sexps (1+ (point)) -1))
4015 ;; This can be very inefficient if there's a long
4016 ;; sequence of operator tokens without any separation.
4017 ;; That doesn't happen in practice, anyway.
4018 (c-beginning-of-current-token))
4019 (>= (point) limit)))
4022 (error (goto-char last)))
4024 (if (< (point) limit)
4029 (defun c-forward-token-1 (&optional count balanced limit)
4030 "Like `c-forward-token-2' but doesn't treat multicharacter operator
4031 tokens like \"==\" as single tokens, i.e. all sequences of symbol
4032 characters are jumped over character by character. This function is
4033 for compatibility only; it's only a wrapper over `c-forward-token-2'."
4034 (let ((c-nonsymbol-token-regexp "\\s."))
4035 (c-forward-token-2 count balanced limit)))
4037 (defun c-backward-token-1 (&optional count balanced limit)
4038 "Like `c-backward-token-2' but doesn't treat multicharacter operator
4039 tokens like \"==\" as single tokens, i.e. all sequences of symbol
4040 characters are jumped over character by character. This function is
4041 for compatibility only; it's only a wrapper over `c-backward-token-2'."
4042 (let ((c-nonsymbol-token-regexp "\\s."))
4043 (c-backward-token-2 count balanced limit)))
4046 ;; Tools for doing searches restricted to syntactically relevant text.
4048 (defun c-syntactic-re-search-forward (regexp &optional bound noerror
4049 paren-level not-inside-token
4050 lookbehind-submatch)
4051 "Like `re-search-forward', but only report matches that are found
4052 in syntactically significant text. I.e. matches in comments, macros
4053 or string literals are ignored. The start point is assumed to be
4054 outside any comment, macro or string literal, or else the content of
4055 that region is taken as syntactically significant text.
4057 If PAREN-LEVEL is non-nil, an additional restriction is added to
4058 ignore matches in nested paren sexps. The search will also not go
4059 outside the current list sexp, which has the effect that if the point
4060 should be moved to BOUND when no match is found \(i.e. NOERROR is
4061 neither nil nor t), then it will be at the closing paren if the end of
4062 the current list sexp is encountered first.
4064 If NOT-INSIDE-TOKEN is non-nil, matches in the middle of tokens are
4065 ignored. Things like multicharacter operators and special symbols
4066 \(e.g. \"`()\" in Pike) are handled but currently not floating point
4069 If LOOKBEHIND-SUBMATCH is non-nil, it's taken as a number of a
4070 subexpression in REGEXP. The end of that submatch is used as the
4071 position to check for syntactic significance. If LOOKBEHIND-SUBMATCH
4072 isn't used or if that subexpression didn't match then the start
4073 position of the whole match is used instead. The \"look behind\"
4074 subexpression is never tested before the starting position, so it
4075 might be a good idea to include \\=\\= as a match alternative in it.
4077 Optimization note: Matches might be missed if the \"look behind\"
4078 subexpression can match the end of nonwhite syntactic whitespace,
4079 i.e. the end of comments or cpp directives. This since the function
4080 skips over such things before resuming the search. It's on the other
4081 hand not safe to assume that the \"look behind\" subexpression never
4082 matches syntactic whitespace.
4084 Bug: Unbalanced parens inside cpp directives are currently not handled
4085 correctly \(i.e. they don't get ignored as they should) when
4088 Note that this function might do hidden buffer changes. See the
4089 comment at the start of cc-engine.el for more info."
4091 (or bound (setq bound (point-max)))
4092 (if paren-level (setq paren-level -1))
4094 ;;(message "c-syntactic-re-search-forward %s %s %S" (point) bound regexp)
4096 (let ((start (point))
4098 ;; Start position for the last search.
4100 ;; The `parse-partial-sexp' state between the start position
4103 ;; The current position after the last state update. The next
4104 ;; `parse-partial-sexp' continues from here.
4106 ;; The position at which to check the state and the state
4107 ;; there. This is separate from `state-pos' since we might
4108 ;; need to back up before doing the next search round.
4109 check-pos check-state
4110 ;; Last position known to end a token.
4111 (last-token-end-pos (point-min))
4112 ;; Set when a valid match is found.
4119 (setq search-pos (point))
4120 (re-search-forward regexp bound noerror))
4123 (setq state (parse-partial-sexp
4124 state-pos (match-beginning 0) paren-level nil state)
4126 (if (setq check-pos (and lookbehind-submatch
4127 (or (not paren-level)
4129 (match-end lookbehind-submatch)))
4130 (setq check-state (parse-partial-sexp
4131 state-pos check-pos paren-level nil state))
4132 (setq check-pos state-pos
4135 ;; NOTE: If we got a look behind subexpression and get
4136 ;; an insignificant match in something that isn't
4137 ;; syntactic whitespace (i.e. strings or in nested
4138 ;; parentheses), then we can never skip more than a
4139 ;; single character from the match start position
4140 ;; (i.e. `state-pos' here) before continuing the
4141 ;; search. That since the look behind subexpression
4142 ;; might match the end of the insignificant region in
4146 ((elt check-state 7)
4147 ;; Match inside a line comment. Skip to eol. Use
4148 ;; `re-search-forward' instead of `skip-chars-forward' to get
4149 ;; the right bound behavior.
4150 (re-search-forward "[\n\r]" bound noerror))
4152 ((elt check-state 4)
4153 ;; Match inside a block comment. Skip to the '*/'.
4154 (search-forward "*/" bound noerror))
4156 ((and (not (elt check-state 5))
4157 (eq (char-before check-pos) ?/)
4158 (not (c-get-char-property (1- check-pos) 'syntax-table))
4159 (memq (char-after check-pos) '(?/ ?*)))
4160 ;; Match in the middle of the opener of a block or line
4162 (if (= (char-after check-pos) ?/)
4163 (re-search-forward "[\n\r]" bound noerror)
4164 (search-forward "*/" bound noerror)))
4166 ;; The last `parse-partial-sexp' above might have
4167 ;; stopped short of the real check position if the end
4168 ;; of the current sexp was encountered in paren-level
4169 ;; mode. The checks above are always false in that
4170 ;; case, and since they can do better skipping in
4171 ;; lookbehind-submatch mode, we do them before
4172 ;; checking the paren level.
4175 (/= (setq tmp (car check-state)) 0))
4176 ;; Check the paren level first since we're short of the
4177 ;; syntactic checking position if the end of the
4178 ;; current sexp was encountered by `parse-partial-sexp'.
4181 ;; Inside a nested paren sexp.
4182 (if lookbehind-submatch
4183 ;; See the NOTE above.
4184 (progn (goto-char state-pos) t)
4185 ;; Skip out of the paren quickly.
4186 (setq state (parse-partial-sexp state-pos bound 0 nil state)
4189 ;; Have exited the current paren sexp.
4192 ;; The last `parse-partial-sexp' call above
4193 ;; has left us just after the closing paren
4194 ;; in this case, so we can modify the bound
4195 ;; to leave the point at the right position
4197 (setq bound (1- (point)))
4199 (signal 'search-failed (list regexp)))))
4201 ((setq tmp (elt check-state 3))
4202 ;; Match inside a string.
4203 (if (or lookbehind-submatch
4204 (not (integerp tmp)))
4205 ;; See the NOTE above.
4206 (progn (goto-char state-pos) t)
4207 ;; Skip to the end of the string before continuing.
4208 (let ((ender (make-string 1 tmp)) (continue t))
4209 (while (if (search-forward ender bound noerror)
4211 (setq state (parse-partial-sexp
4212 state-pos (point) nil nil state)
4215 (setq continue nil)))
4220 (c-beginning-of-macro start)))
4221 ;; Match inside a macro. Skip to the end of it.
4223 (cond ((<= (point) bound) t)
4225 (t (signal 'search-failed (list regexp)))))
4227 ((and not-inside-token
4228 (or (< check-pos last-token-end-pos)
4231 (goto-char check-pos)
4233 (c-end-of-current-token last-token-end-pos))
4234 (setq last-token-end-pos (point))))))
4236 (if lookbehind-submatch
4237 ;; See the NOTE above.
4238 (goto-char state-pos)
4239 (goto-char (min last-token-end-pos bound))))
4246 ;; Should loop to search again, but take care to avoid
4247 ;; looping on the same spot.
4248 (or (/= search-pos (point))
4249 (if (= (point) bound)
4252 (signal 'search-failed (list regexp)))
4258 (signal (car err) (cdr err))))
4260 ;;(message "c-syntactic-re-search-forward done %s" (or (match-end 0) (point)))
4264 (goto-char (match-end 0))
4267 ;; Search failed. Set point as appropriate.
4273 (defvar safe-pos-list) ; bound in c-syntactic-skip-backward
4275 (defsubst c-ssb-lit-begin ()
4276 ;; Return the start of the literal point is in, or nil.
4277 ;; We read and write the variables `safe-pos', `safe-pos-list', `state'
4278 ;; bound in the caller.
4280 ;; Use `parse-partial-sexp' from a safe position down to the point to check
4281 ;; if it's outside comments and strings.
4283 (let ((pos (point)) safe-pos state)
4284 ;; Pick a safe position as close to the point as possible.
4286 ;; FIXME: Consult `syntax-ppss' here if our cache doesn't give a good
4289 (while (and safe-pos-list
4290 (> (car safe-pos-list) (point)))
4291 (setq safe-pos-list (cdr safe-pos-list)))
4292 (unless (setq safe-pos (car-safe safe-pos-list))
4293 (setq safe-pos (max (or (c-safe-position
4294 (point) (c-parse-state))
4297 safe-pos-list (list safe-pos)))
4299 ;; Cache positions along the way to use if we have to back up more. We
4300 ;; cache every closing paren on the same level. If the paren cache is
4301 ;; relevant in this region then we're typically already on the same
4302 ;; level as the target position. Note that we might cache positions
4303 ;; after opening parens in case safe-pos is in a nested list. That's
4304 ;; both uncommon and harmless.
4306 (setq state (parse-partial-sexp
4309 (setq safe-pos (point)
4310 safe-pos-list (cons safe-pos safe-pos-list)))
4312 ;; If the state contains the start of the containing sexp we cache that
4313 ;; position too, so that parse-partial-sexp in the next run has a bigger
4314 ;; chance of starting at the same level as the target position and thus
4315 ;; will get more good safe positions into the list.
4317 (setq safe-pos (1+ (elt state 1))
4318 safe-pos-list (cons safe-pos safe-pos-list)))
4320 (if (or (elt state 3) (elt state 4))
4321 ;; Inside string or comment. Continue search at the
4325 (defun c-syntactic-skip-backward (skip-chars &optional limit paren-level)
4326 "Like `skip-chars-backward' but only look at syntactically relevant chars,
4327 i.e. don't stop at positions inside syntactic whitespace or string
4328 literals. Preprocessor directives are also ignored, with the exception
4329 of the one that the point starts within, if any. If LIMIT is given,
4330 it's assumed to be at a syntactically relevant position.
4332 If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4333 sexps, and the search will also not go outside the current paren sexp.
4334 However, if LIMIT or the buffer limit is reached inside a nested paren
4335 then the point will be left at the limit.
4337 Non-nil is returned if the point moved, nil otherwise.
4339 Note that this function might do hidden buffer changes. See the
4340 comment at the start of cc-engine.el for more info."
4342 (c-self-bind-state-cache
4343 (let ((start (point))
4345 ;; A list of syntactically relevant positions in descending
4346 ;; order. It's used to avoid scanning repeatedly over
4347 ;; potentially large regions with `parse-partial-sexp' to verify
4348 ;; each position. Used in `c-ssb-lit-begin'
4350 ;; The result from `c-beginning-of-macro' at the start position or the
4351 ;; start position itself if it isn't within a macro. Evaluated on
4354 ;; The earliest position after the current one with the same paren
4355 ;; level. Used only when `paren-level' is set.
4357 (paren-level-pos (point)))
4361 ;; The next loop "tries" to find the end point each time round,
4362 ;; loops when it hasn't succeeded.
4365 (let ((pos (point)))
4367 (< (skip-chars-backward skip-chars limit) 0)
4368 ;; Don't stop inside a literal.
4369 (when (setq lit-beg (c-ssb-lit-begin))
4374 (let ((pos (point)) state-2 pps-end-pos)
4379 (setq state-2 (parse-partial-sexp
4380 pos paren-level-pos -1)
4381 pps-end-pos (point))
4382 (/= (car state-2) 0)))
4383 ;; Not at the right level.
4385 (if (and (< (car state-2) 0)
4386 ;; We stop above if we go out of a paren.
4387 ;; Now check whether it precedes or is
4388 ;; nested in the starting sexp.
4392 pps-end-pos paren-level-pos
4394 (< (car state-2) 0)))
4396 ;; We've stopped short of the starting position
4397 ;; so the hit was inside a nested list. Go up
4398 ;; until we are at the right level.
4401 (goto-char (scan-lists pos -1
4403 (setq paren-level-pos (point))
4404 (if (and limit (>= limit paren-level-pos))
4410 (goto-char (or limit (point-min)))
4413 ;; The hit was outside the list at the start
4414 ;; position. Go to the start of the list and exit.
4415 (goto-char (1+ (elt state-2 1)))
4418 ((c-beginning-of-macro limit)
4422 (setq start-macro-beg
4425 (c-beginning-of-macro limit)
4429 ;; It's inside the same macro we started in so it's
4430 ;; a relevant match.
4436 ;; Skip syntactic ws afterwards so that we don't stop at the
4437 ;; end of a comment if `skip-chars' is something like "^/".
4438 (c-backward-syntactic-ws)
4441 ;; We might want to extend this with more useful return values in
4443 (/= (point) start))))
4445 ;; The following is an alternative implementation of
4446 ;; `c-syntactic-skip-backward' that uses backward movement to keep
4447 ;; track of the syntactic context. It turned out to be generally
4448 ;; slower than the one above which uses forward checks from earlier
4451 ;;(defconst c-ssb-stop-re
4452 ;; ;; The regexp matching chars `c-syntactic-skip-backward' needs to
4453 ;; ;; stop at to avoid going into comments and literals.
4455 ;; ;; Match comment end syntax and string literal syntax. Also match
4456 ;; ;; '/' for block comment endings (not covered by comment end
4458 ;; "\\s>\\|/\\|\\s\""
4459 ;; (if (memq 'gen-string-delim c-emacs-features)
4462 ;; (if (memq 'gen-comment-delim c-emacs-features)
4466 ;;(defconst c-ssb-stop-paren-re
4467 ;; ;; Like `c-ssb-stop-re' but also stops at paren chars.
4468 ;; (concat c-ssb-stop-re "\\|\\s(\\|\\s)"))
4470 ;;(defconst c-ssb-sexp-end-re
4471 ;; ;; Regexp matching the ending syntax of a complex sexp.
4472 ;; (concat c-string-limit-regexp "\\|\\s)"))
4474 ;;(defun c-syntactic-skip-backward (skip-chars &optional limit paren-level)
4475 ;; "Like `skip-chars-backward' but only look at syntactically relevant chars,
4476 ;;i.e. don't stop at positions inside syntactic whitespace or string
4477 ;;literals. Preprocessor directives are also ignored. However, if the
4478 ;;point is within a comment, string literal or preprocessor directory to
4479 ;;begin with, its contents is treated as syntactically relevant chars.
4480 ;;If LIMIT is given, it limits the backward search and the point will be
4481 ;;left there if no earlier position is found.
4483 ;;If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4484 ;;sexps, and the search will also not go outside the current paren sexp.
4485 ;;However, if LIMIT or the buffer limit is reached inside a nested paren
4486 ;;then the point will be left at the limit.
4488 ;;Non-nil is returned if the point moved, nil otherwise.
4490 ;;Note that this function might do hidden buffer changes. See the
4491 ;;comment at the start of cc-engine.el for more info."
4493 ;; (save-restriction
4495 ;; (narrow-to-region limit (point-max)))
4497 ;; (let ((start (point)))
4499 ;; (while (let ((last-pos (point))
4501 ;; (skip-chars-backward skip-chars)
4504 ;; ;; Skip back over the same region as
4505 ;; ;; `skip-chars-backward' above, but keep to
4506 ;; ;; syntactically relevant positions.
4507 ;; (goto-char last-pos)
4509 ;; ;; `re-search-backward' with a single char regexp
4510 ;; ;; should be fast.
4511 ;; (re-search-backward
4512 ;; (if paren-level c-ssb-stop-paren-re c-ssb-stop-re)
4517 ;; ((looking-at "\\s(")
4518 ;; ;; `paren-level' is set and we've found the
4519 ;; ;; start of the containing paren.
4523 ;; ((looking-at c-ssb-sexp-end-re)
4524 ;; ;; We're at the end of a string literal or paren
4525 ;; ;; sexp (if `paren-level' is set).
4527 ;; (condition-case nil
4528 ;; (c-backward-sexp)
4530 ;; (goto-char limit)
4531 ;; (throw 'done t))))
4535 ;; ;; At the end of some syntactic ws or possibly
4536 ;; ;; after a plain '/' operator.
4537 ;; (let ((pos (point)))
4538 ;; (c-backward-syntactic-ws)
4539 ;; (if (= pos (point))
4540 ;; ;; Was a plain '/' operator. Go past it.
4541 ;; (backward-char)))))
4543 ;; (> (point) stop-pos))))
4545 ;; ;; Now the point is either at `stop-pos' or at some
4546 ;; ;; position further back if `stop-pos' was at a
4547 ;; ;; syntactically irrelevant place.
4549 ;; ;; Skip additional syntactic ws so that we don't stop
4550 ;; ;; at the end of a comment if `skip-chars' is
4551 ;; ;; something like "^/".
4552 ;; (c-backward-syntactic-ws)
4554 ;; (< (point) stop-pos))))
4556 ;; ;; We might want to extend this with more useful return values
4557 ;; ;; in the future.
4558 ;; (/= (point) start))))
4561 ;; Tools for handling comments and string literals.
4563 (defun c-in-literal (&optional lim detect-cpp)
4564 "Return the type of literal point is in, if any.
4565 The return value is `c' if in a C-style comment, `c++' if in a C++
4566 style comment, `string' if in a string literal, `pound' if DETECT-CPP
4567 is non-nil and in a preprocessor line, or nil if somewhere else.
4568 Optional LIM is used as the backward limit of the search. If omitted,
4569 or nil, `c-beginning-of-defun' is used.
4571 The last point calculated is cached if the cache is enabled, i.e. if
4572 `c-in-literal-cache' is bound to a two element vector.
4574 Note that this function might do hidden buffer changes. See the
4575 comment at the start of cc-engine.el for more info."
4578 (let* ((safe-place (c-state-semi-safe-place (point)))
4579 (lit (c-state-pp-to-literal safe-place (point))))
4582 (save-excursion (c-beginning-of-macro))
4585 (defun c-literal-limits (&optional lim near not-in-delimiter)
4586 "Return a cons of the beginning and end positions of the comment or
4587 string surrounding point (including both delimiters), or nil if point
4588 isn't in one. If LIM is non-nil, it's used as the \"safe\" position
4589 to start parsing from. If NEAR is non-nil, then the limits of any
4590 literal next to point is returned. \"Next to\" means there's only
4591 spaces and tabs between point and the literal. The search for such a
4592 literal is done first in forward direction. If NOT-IN-DELIMITER is
4593 non-nil, the case when point is inside a starting delimiter won't be
4594 recognized. This only has effect for comments which have starting
4595 delimiters with more than one character.
4597 Note that this function might do hidden buffer changes. See the
4598 comment at the start of cc-engine.el for more info."
4601 (let* ((pos (point))
4602 (lim (or lim (c-state-semi-safe-place pos)))
4603 (pp-to-lit (save-restriction
4605 (c-state-pp-to-literal lim pos not-in-delimiter)))
4606 (state (car pp-to-lit))
4607 (lit-limits (car (cddr pp-to-lit))))
4614 ;; Search forward for a literal.
4615 (skip-chars-forward " \t")
4617 ((looking-at c-string-limit-regexp) ; String.
4618 (cons (point) (or (c-safe (c-forward-sexp 1) (point))
4621 ((looking-at c-comment-start-regexp) ; Line or block comment.
4622 (cons (point) (progn (c-forward-single-comment) (point))))
4626 (skip-chars-backward " \t")
4628 (let ((end (point)) beg)
4631 (< (skip-syntax-backward c-string-syntax) 0)) ; String.
4632 (setq beg (c-safe (c-backward-sexp 1) (point))))
4634 ((and (c-safe (forward-char -2) t)
4636 ;; Block comment. Due to the nature of line
4637 ;; comments, they will always be covered by the
4638 ;; normal case above.
4640 (c-backward-single-comment)
4641 ;; If LIM is bogus, beg will be bogus.
4642 (setq beg (point))))
4644 (if beg (cons beg end))))))
4647 ;; In case external callers use this; it did have a docstring.
4648 (defalias 'c-literal-limits-fast 'c-literal-limits)
4650 (defun c-collect-line-comments (range)
4651 "If the argument is a cons of two buffer positions (such as returned by
4652 `c-literal-limits'), and that range contains a C++ style line comment,
4653 then an extended range is returned that contains all adjacent line
4654 comments (i.e. all comments that starts in the same column with no
4655 empty lines or non-whitespace characters between them). Otherwise the
4656 argument is returned.
4658 Note that this function might do hidden buffer changes. See the
4659 comment at the start of cc-engine.el for more info."
4663 (if (and (consp range) (progn
4664 (goto-char (car range))
4665 (looking-at c-line-comment-starter)))
4666 (let ((col (current-column))
4668 (bopl (c-point 'bopl))
4670 ;; Got to take care in the backward direction to handle
4671 ;; comments which are preceded by code.
4672 (while (and (c-backward-single-comment)
4674 (looking-at c-line-comment-starter)
4675 (= col (current-column)))
4677 bopl (c-point 'bopl)))
4679 (while (and (progn (skip-chars-forward " \t")
4680 (looking-at c-line-comment-starter))
4681 (= col (current-column))
4682 (prog1 (zerop (forward-line 1))
4683 (setq end (point)))))
4688 (defun c-literal-type (range)
4689 "Convenience function that given the result of `c-literal-limits',
4690 returns nil or the type of literal that the range surrounds, one
4691 of the symbols `c', `c++' or `string'. It's much faster than using
4692 `c-in-literal' and is intended to be used when you need both the
4693 type of a literal and its limits.
4695 Note that this function might do hidden buffer changes. See the
4696 comment at the start of cc-engine.el for more info."
4700 (goto-char (car range))
4701 (cond ((looking-at c-string-limit-regexp) 'string)
4702 ((or (looking-at "//") ; c++ line comment
4703 (and (looking-at "\\s<") ; comment starter
4704 (looking-at "#"))) ; awk comment.
4706 (t 'c))) ; Assuming the range is valid.
4709 (defsubst c-determine-limit-get-base (start try-size)
4710 ;; Get a "safe place" approximately TRY-SIZE characters before START.
4711 ;; This doesn't preserve point.
4712 (let* ((pos (max (- start try-size) (point-min)))
4713 (base (c-state-semi-safe-place pos))
4714 (s (parse-partial-sexp base pos)))
4715 (if (or (nth 4 s) (nth 3 s)) ; comment or string
4719 (defun c-determine-limit (how-far-back &optional start try-size)
4720 ;; Return a buffer position HOW-FAR-BACK non-literal characters from START
4721 ;; (default point). This is done by going back further in the buffer then
4722 ;; searching forward for literals. The position found won't be in a
4723 ;; literal. We start searching for the sought position TRY-SIZE (default
4724 ;; twice HOW-FAR-BACK) bytes back from START. This function must be fast.
4727 (let* ((start (or start (point)))
4728 (try-size (or try-size (* 2 how-far-back)))
4729 (base (c-determine-limit-get-base start try-size))
4732 (s (parse-partial-sexp pos pos)) ; null state.
4735 (while (< pos start)
4736 ;; Move forward one literal each time round this loop.
4737 ;; Move forward to the start of a comment or string.
4738 (setq s (parse-partial-sexp
4744 'syntax-table)) ; stop-comment
4746 ;; Gather details of the non-literal-bit - starting pos and size.
4747 (setq size (- (if (or (nth 4 s) (nth 3 s))
4752 (setq stack (cons (cons pos size) stack)))
4754 ;; Move forward to the end of the comment/string.
4755 (if (or (nth 4 s) (nth 3 s))
4756 (setq s (parse-partial-sexp
4762 'syntax-table))) ; stop-comment
4765 ;; Now try and find enough non-literal characters recorded on the stack.
4766 ;; Go back one recorded literal each time round this loop.
4767 (while (and (< count how-far-back)
4769 (setq elt (car stack)
4771 (setq count (+ count (cdr elt))))
4773 ;; Have we found enough yet?
4775 ((>= count how-far-back)
4776 (+ (car elt) (- count how-far-back)))
4777 ((eq base (point-min))
4780 (c-determine-limit (- how-far-back count) base try-size))))))
4782 (defun c-determine-+ve-limit (how-far &optional start-pos)
4783 ;; Return a buffer position about HOW-FAR non-literal characters forward
4784 ;; from START-POS (default point), which must not be inside a literal.
4786 (let ((pos (or start-pos (point)))
4788 (s (parse-partial-sexp (point) (point)))) ; null state
4789 (while (and (not (eobp))
4791 ;; Scan over counted characters.
4792 (setq s (parse-partial-sexp
4794 (min (+ pos count) (point-max))
4798 'syntax-table)) ; stop-comment
4799 (setq count (- count (- (point) pos) 1)
4801 ;; Scan over literal characters.
4803 (setq s (parse-partial-sexp
4809 'syntax-table) ; stop-comment
4814 ;; `c-find-decl-spots' and accompanying stuff.
4816 ;; Variables used in `c-find-decl-spots' to cache the search done for
4817 ;; the first declaration in the last call. When that function starts,
4818 ;; it needs to back up over syntactic whitespace to look at the last
4819 ;; token before the region being searched. That can sometimes cause
4820 ;; moves back and forth over a quite large region of comments and
4821 ;; macros, which would be repeated for each changed character when
4822 ;; we're called during fontification, since font-lock refontifies the
4823 ;; current line for each change. Thus it's worthwhile to cache the
4826 ;; `c-find-decl-syntactic-pos' is a syntactically relevant position in
4827 ;; the syntactic whitespace less or equal to some start position.
4828 ;; There's no cached value if it's nil.
4830 ;; `c-find-decl-match-pos' is the match position if
4831 ;; `c-find-decl-prefix-search' matched before the syntactic whitespace
4832 ;; at `c-find-decl-syntactic-pos', or nil if there's no such match.
4833 (defvar c-find-decl-syntactic-pos nil)
4834 (make-variable-buffer-local 'c-find-decl-syntactic-pos)
4835 (defvar c-find-decl-match-pos nil)
4836 (make-variable-buffer-local 'c-find-decl-match-pos)
4838 (defsubst c-invalidate-find-decl-cache (change-min-pos)
4839 (and c-find-decl-syntactic-pos
4840 (< change-min-pos c-find-decl-syntactic-pos)
4841 (setq c-find-decl-syntactic-pos nil)))
4843 ; (defface c-debug-decl-spot-face
4844 ; '((t (:background "Turquoise")))
4845 ; "Debug face to mark the spots where `c-find-decl-spots' stopped.")
4846 ; (defface c-debug-decl-sws-face
4847 ; '((t (:background "Khaki")))
4848 ; "Debug face to mark the syntactic whitespace between the declaration
4849 ; spots and the preceding token end.")
4851 (defmacro c-debug-put-decl-spot-faces (match-pos decl-pos)
4852 (when (facep 'c-debug-decl-spot-face)
4853 `(c-save-buffer-state ((match-pos ,match-pos) (decl-pos ,decl-pos))
4854 (c-debug-add-face (max match-pos (point-min)) decl-pos
4855 'c-debug-decl-sws-face)
4856 (c-debug-add-face decl-pos (min (1+ decl-pos) (point-max))
4857 'c-debug-decl-spot-face))))
4858 (defmacro c-debug-remove-decl-spot-faces (beg end)
4859 (when (facep 'c-debug-decl-spot-face)
4860 `(c-save-buffer-state ()
4861 (c-debug-remove-face ,beg ,end 'c-debug-decl-spot-face)
4862 (c-debug-remove-face ,beg ,end 'c-debug-decl-sws-face))))
4864 (defmacro c-find-decl-prefix-search ()
4865 ;; Macro used inside `c-find-decl-spots'. It ought to be a defun,
4866 ;; but it contains lots of free variables that refer to things
4867 ;; inside `c-find-decl-spots'. The point is left at `cfd-match-pos'
4868 ;; if there is a match, otherwise at `cfd-limit'.
4870 ;; The macro moves point forward to the next putative start of a declaration
4871 ;; or cfd-limit. This decl start is the next token after a "declaration
4872 ;; prefix". The declaration prefix is the earlier of `cfd-prop-match' and
4873 ;; `cfd-re-match'. `cfd-match-pos' is set to the decl prefix.
4875 ;; This macro might do hidden buffer changes.
4878 ;; Find the next property match position if we haven't got one already.
4879 (unless cfd-prop-match
4882 (goto-char (c-next-single-property-change
4883 (point) 'c-type nil cfd-limit))
4884 (and (< (point) cfd-limit)
4885 (not (eq (c-get-char-property (1- (point)) 'c-type)
4887 (setq cfd-prop-match (point))))
4889 ;; Find the next `c-decl-prefix-or-start-re' match if we haven't
4891 (unless cfd-re-match
4893 (if (> cfd-re-match-end (point))
4894 (goto-char cfd-re-match-end))
4896 ;; Each time round, the next `while' moves forward over a pseudo match
4897 ;; of `c-decl-prefix-or-start-re' which is either inside a literal, or
4898 ;; is a ":" not preceded by "public", etc.. `cfd-re-match' and
4899 ;; `cfd-re-match-end' get set.
4902 (setq cfd-re-match-end (re-search-forward c-decl-prefix-or-start-re
4905 ((null cfd-re-match-end)
4906 ;; No match. Finish up and exit the loop.
4907 (setq cfd-re-match cfd-limit)
4910 (if (setq cfd-re-match (match-end 1))
4911 ;; Matched the end of a token preceding a decl spot.
4913 (goto-char cfd-re-match)
4915 ;; Matched a token that start a decl spot.
4916 (goto-char (match-beginning 0))
4919 ;; Pseudo match inside a comment or string literal. Skip out
4920 ;; of comments and string literals.
4922 (goto-char (c-next-single-property-change
4923 (point) 'face nil cfd-limit))
4924 (and (< (point) cfd-limit)
4925 (c-got-face-at (point) c-literal-faces))))
4926 t) ; Continue the loop over pseudo matches.
4927 ((and (match-string 1)
4928 (string= (match-string 1) ":")
4930 (or (/= (c-backward-token-2 2) 0) ; no search limit. :-(
4931 (not (looking-at c-decl-start-colon-kwd-re)))))
4932 ;; Found a ":" which isn't part of "public:", etc.
4934 (t nil)))) ;; Found a real match. Exit the pseudo-match loop.
4936 ;; If our match was at the decl start, we have to back up over the
4937 ;; preceding syntactic ws to set `cfd-match-pos' and to catch
4938 ;; any decl spots in the syntactic ws.
4939 (unless cfd-re-match
4940 (c-backward-syntactic-ws)
4941 (setq cfd-re-match (point))))
4943 ;; Choose whichever match is closer to the start.
4944 (if (< cfd-re-match cfd-prop-match)
4945 (setq cfd-match-pos cfd-re-match
4947 (setq cfd-match-pos cfd-prop-match
4948 cfd-prop-match nil))
4950 (goto-char cfd-match-pos)
4952 (when (< cfd-match-pos cfd-limit)
4953 ;; Skip forward past comments only so we don't skip macros.
4954 (c-forward-comments)
4955 ;; Set the position to continue at. We can avoid going over
4956 ;; the comments skipped above a second time, but it's possible
4957 ;; that the comment skipping has taken us past `cfd-prop-match'
4958 ;; since the property might be used inside comments.
4959 (setq cfd-continue-pos (if cfd-prop-match
4960 (min cfd-prop-match (point))
4963 (defun c-find-decl-spots (cfd-limit cfd-decl-re cfd-face-checklist cfd-fun)
4964 ;; Call CFD-FUN for each possible spot for a declaration, cast or
4965 ;; label from the point to CFD-LIMIT.
4967 ;; CFD-FUN is called with point at the start of the spot. It's passed two
4968 ;; arguments: The first is the end position of the token preceding the spot,
4969 ;; or 0 for the implicit match at bob. The second is a flag that is t when
4970 ;; the match is inside a macro. Point should be moved forward by at least
4973 ;; If CFD-FUN adds `c-decl-end' properties somewhere below the current spot,
4974 ;; it should return non-nil to ensure that the next search will find them.
4977 ;; o The first token after bob.
4978 ;; o The first token after the end of submatch 1 in
4979 ;; `c-decl-prefix-or-start-re' when that submatch matches. This
4980 ;; submatch is typically a (L or R) brace or paren, a ;, or a ,.
4981 ;; o The start of each `c-decl-prefix-or-start-re' match when
4982 ;; submatch 1 doesn't match. This is, for example, the keyword
4984 ;; o The start of a previously recognized declaration; "recognized"
4985 ;; means that the last char of the previous token has a `c-type'
4986 ;; text property with the value `c-decl-end'; this only holds
4987 ;; when `c-type-decl-end-used' is set.
4989 ;; Only a spot that match CFD-DECL-RE and whose face is in the
4990 ;; CFD-FACE-CHECKLIST list causes CFD-FUN to be called. The face
4991 ;; check is disabled if CFD-FACE-CHECKLIST is nil.
4993 ;; If the match is inside a macro then the buffer is narrowed to the
4994 ;; end of it, so that CFD-FUN can investigate the following tokens
4995 ;; without matching something that begins inside a macro and ends
4996 ;; outside it. It's to avoid this work that the CFD-DECL-RE and
4997 ;; CFD-FACE-CHECKLIST checks exist.
4999 ;; The spots are visited approximately in order from top to bottom.
5000 ;; It's however the positions where `c-decl-prefix-or-start-re'
5001 ;; matches and where `c-decl-end' properties are found that are in
5002 ;; order. Since the spots often are at the following token, they
5003 ;; might be visited out of order insofar as more spots are reported
5004 ;; later on within the syntactic whitespace between the match
5005 ;; positions and their spots.
5007 ;; It's assumed that comments and strings are fontified in the
5010 ;; This is mainly used in fontification, and so has an elaborate
5011 ;; cache to handle repeated calls from the same start position; see
5012 ;; the variables above.
5014 ;; All variables in this function begin with `cfd-' to avoid name
5015 ;; collision with the (dynamically bound) variables used in CFD-FUN.
5017 ;; This function might do hidden buffer changes.
5019 (let ((cfd-start-pos (point)) ; never changed
5020 (cfd-buffer-end (point-max))
5021 ;; The end of the token preceding the decl spot last found
5022 ;; with `c-decl-prefix-or-start-re'. `cfd-limit' if there's
5025 ;; The end position of the last `c-decl-prefix-or-start-re'
5026 ;; match. If this is greater than `cfd-continue-pos', the
5027 ;; next regexp search is started here instead.
5028 (cfd-re-match-end (point-min))
5029 ;; The end of the last `c-decl-end' found by
5030 ;; `c-find-decl-prefix-search'. `cfd-limit' if there's no
5031 ;; match. If searching for the property isn't needed then we
5032 ;; disable it by setting it to `cfd-limit' directly.
5033 (cfd-prop-match (unless c-type-decl-end-used cfd-limit))
5034 ;; The end of the token preceding the decl spot last found by
5035 ;; `c-find-decl-prefix-search'. 0 for the implicit match at
5036 ;; bob. `cfd-limit' if there's no match. In other words,
5037 ;; this is the minimum of `cfd-re-match' and `cfd-prop-match'.
5038 (cfd-match-pos cfd-limit)
5039 ;; The position to continue searching at.
5041 ;; The position of the last "real" token we've stopped at.
5042 ;; This can be greater than `cfd-continue-pos' when we get
5043 ;; hits inside macros or at `c-decl-end' positions inside
5046 ;; The end position of the last entered macro.
5049 ;; Initialize by finding a syntactically relevant start position
5050 ;; before the point, and do the first `c-decl-prefix-or-start-re'
5051 ;; search unless we're at bob.
5053 (let (start-in-literal start-in-macro syntactic-pos)
5054 ;; Must back up a bit since we look for the end of the previous
5055 ;; statement or declaration, which is earlier than the first
5058 ;; This `cond' moves back over any literals or macros. It has special
5059 ;; handling for when the region being searched is entirely within a
5060 ;; macro. It sets `cfd-continue-pos' (unless we've reached
5063 ;; First we need to move to a syntactically relevant position.
5064 ;; Begin by backing out of comment or string literals.
5066 ;; This arm of the cond actually triggers if we're in a literal,
5067 ;; and cfd-limit is at most at BONL.
5069 ;; This arm of the `and' moves backwards out of a literal when
5070 ;; the face at point is a literal face. In this case, its value
5071 ;; is always non-nil.
5072 (when (c-got-face-at (point) c-literal-faces)
5073 ;; Try to use the faces to back up to the start of the
5074 ;; literal. FIXME: What if the point is on a declaration
5075 ;; inside a comment?
5076 (while (and (not (bobp))
5077 (c-got-face-at (1- (point)) c-literal-faces))
5078 (goto-char (previous-single-property-change
5079 (point) 'face nil (point-min))))
5081 ;; XEmacs doesn't fontify the quotes surrounding string
5083 (and (featurep 'xemacs)
5084 (eq (get-text-property (point) 'face)
5085 'font-lock-string-face)
5087 (progn (backward-char)
5088 (not (looking-at c-string-limit-regexp)))
5091 ;; Don't trust the literal to contain only literal faces
5092 ;; (the font lock package might not have fontified the
5093 ;; start of it at all, for instance) so check that we have
5094 ;; arrived at something that looks like a start or else
5095 ;; resort to `c-literal-limits'.
5096 (unless (looking-at c-literal-start-regexp)
5097 (let ((range (c-literal-limits)))
5098 (if range (goto-char (car range)))))
5100 (setq start-in-literal (point))) ; end of `and' arm.
5102 ;; The start is in a literal. If the limit is in the same
5103 ;; one we don't have to find a syntactic position etc. We
5104 ;; only check that if the limit is at or before bonl to save
5105 ;; time; it covers the by far most common case when font-lock
5106 ;; refontifies the current line only.
5107 (<= cfd-limit (c-point 'bonl cfd-start-pos))
5109 (goto-char cfd-start-pos)
5111 (goto-char (c-next-single-property-change
5112 (point) 'face nil cfd-limit))
5113 (and (< (point) cfd-limit)
5114 (c-got-face-at (point) c-literal-faces))))
5115 (= (point) cfd-limit))) ; end of `cond' arm condition
5117 ;; Completely inside a literal. Set up variables to trig the
5118 ;; (< cfd-continue-pos cfd-start-pos) case below and it'll
5119 ;; find a suitable start position.
5120 (setq cfd-continue-pos start-in-literal)) ; end of `cond' arm
5122 ;; Check if the region might be completely inside a macro, to
5123 ;; optimize that like the completely-inside-literal above.
5125 (and (= (forward-line 1) 0)
5126 (bolp) ; forward-line has funny behavior at eob.
5127 (>= (point) cfd-limit)
5128 (progn (backward-char)
5129 (eq (char-before) ?\\))))
5130 ;; (Maybe) completely inside a macro. Only need to trig the
5131 ;; (< cfd-continue-pos cfd-start-pos) case below to make it
5133 (setq cfd-continue-pos (1- cfd-start-pos)
5136 ;; The default arm of the `cond' moves back over any macro we're in
5137 ;; and over any syntactic WS. It sets `c-find-decl-syntactic-pos'.
5139 ;; Back out of any macro so we don't miss any declaration
5140 ;; that could follow after it.
5141 (when (c-beginning-of-macro)
5142 (setq start-in-macro t))
5144 ;; Now we're at a proper syntactically relevant position so we
5145 ;; can use the cache. But first clear it if it applied
5147 (c-invalidate-find-decl-cache cfd-start-pos)
5149 (setq syntactic-pos (point))
5150 (unless (eq syntactic-pos c-find-decl-syntactic-pos)
5151 ;; Don't have to do this if the cache is relevant here,
5152 ;; typically if the same line is refontified again. If
5153 ;; we're just some syntactic whitespace further down we can
5154 ;; still use the cache to limit the skipping.
5155 (c-backward-syntactic-ws c-find-decl-syntactic-pos))
5157 ;; If we hit `c-find-decl-syntactic-pos' and
5158 ;; `c-find-decl-match-pos' is set then we install the cached
5159 ;; values. If we hit `c-find-decl-syntactic-pos' and
5160 ;; `c-find-decl-match-pos' is nil then we know there's no decl
5161 ;; prefix in the whitespace before `c-find-decl-syntactic-pos'
5162 ;; and so we can continue the search from this point. If we
5163 ;; didn't hit `c-find-decl-syntactic-pos' then we're now in
5164 ;; the right spot to begin searching anyway.
5165 (if (and (eq (point) c-find-decl-syntactic-pos)
5166 c-find-decl-match-pos)
5167 (setq cfd-match-pos c-find-decl-match-pos
5168 cfd-continue-pos syntactic-pos)
5170 (setq c-find-decl-syntactic-pos syntactic-pos)
5173 ;; Always consider bob a match to get the first
5174 ;; declaration in the file. Do this separately instead of
5175 ;; letting `c-decl-prefix-or-start-re' match bob, so that
5176 ;; regexp always can consume at least one character to
5177 ;; ensure that we won't get stuck in an infinite loop.
5178 (setq cfd-re-match 0)
5180 (c-beginning-of-current-token)
5181 (< (point) cfd-limit))
5182 ;; Do an initial search now. In the bob case above it's
5183 ;; only done to search for a `c-decl-end' spot.
5184 (c-find-decl-prefix-search)) ; sets cfd-continue-pos
5186 (setq c-find-decl-match-pos (and (< cfd-match-pos cfd-start-pos)
5187 cfd-match-pos))))) ; end of `cond'
5189 ;; Advance `cfd-continue-pos' if it's before the start position.
5190 ;; The closest continue position that might have effect at or
5191 ;; after the start depends on what we started in. This also
5192 ;; finds a suitable start position in the special cases when the
5193 ;; region is completely within a literal or macro.
5194 (when (and cfd-continue-pos (< cfd-continue-pos cfd-start-pos))
5198 ;; If we're in a macro then it's the closest preceding token
5199 ;; in the macro. Check this before `start-in-literal',
5200 ;; since if we're inside a literal in a macro, the preceding
5201 ;; token is earlier than any `c-decl-end' spot inside the
5202 ;; literal (comment).
5203 (goto-char (or start-in-literal cfd-start-pos))
5204 ;; The only syntactic ws in macros are comments.
5205 (c-backward-comments)
5207 (c-beginning-of-current-token))
5210 ;; If we're in a comment it can only be the closest
5211 ;; preceding `c-decl-end' position within that comment, if
5212 ;; any. Go back to the beginning of such a property so that
5213 ;; `c-find-decl-prefix-search' will find the end of it.
5214 ;; (Can't stop at the end and install it directly on
5215 ;; `cfd-prop-match' since that variable might be cleared
5216 ;; after `cfd-fun' below.)
5218 ;; Note that if the literal is a string then the property
5219 ;; search will simply skip to the beginning of it right
5221 (if (not c-type-decl-end-used)
5222 (goto-char start-in-literal)
5223 (goto-char cfd-start-pos)
5225 (goto-char (previous-single-property-change
5226 (point) 'c-type nil start-in-literal))
5227 (and (> (point) start-in-literal)
5228 (not (eq (c-get-char-property (point) 'c-type)
5231 (when (= (point) start-in-literal)
5232 ;; Didn't find any property inside the comment, so we can
5233 ;; skip it entirely. (This won't skip past a string, but
5234 ;; that'll be handled quickly by the next
5235 ;; `c-find-decl-prefix-search' anyway.)
5236 (c-forward-single-comment)
5237 (if (> (point) cfd-limit)
5238 (goto-char cfd-limit))))
5241 ;; If we started in normal code, the only match that might
5242 ;; apply before the start is what we already got in
5243 ;; `cfd-match-pos' so we can continue at the start position.
5244 ;; (Note that we don't get here if the first match is below
5246 (goto-char cfd-start-pos))) ; end of `cond'
5248 ;; Delete found matches if they are before our new continue
5249 ;; position, so that `c-find-decl-prefix-search' won't back up
5250 ;; to them later on.
5251 (setq cfd-continue-pos (point))
5252 (when (and cfd-re-match (< cfd-re-match cfd-continue-pos))
5253 (setq cfd-re-match nil))
5254 (when (and cfd-prop-match (< cfd-prop-match cfd-continue-pos))
5255 (setq cfd-prop-match nil))) ; end of `when'
5258 ;; This is the normal case and we got a proper syntactic
5259 ;; position. If there's a match then it's always outside
5260 ;; macros and comments, so advance to the next token and set
5261 ;; `cfd-token-pos'. The loop below will later go back using
5262 ;; `cfd-continue-pos' to fix declarations inside the
5264 (when (and cfd-match-pos (< cfd-match-pos syntactic-pos))
5265 (goto-char syntactic-pos)
5266 (c-forward-syntactic-ws)
5267 (and cfd-continue-pos
5268 (< cfd-continue-pos (point))
5269 (setq cfd-token-pos (point))))
5271 ;; Have one of the special cases when the region is completely
5272 ;; within a literal or macro. `cfd-continue-pos' is set to a
5273 ;; good start position for the search, so do it.
5274 (c-find-decl-prefix-search)))
5276 ;; Now loop, one decl spot per iteration. We already have the first
5277 ;; match in `cfd-match-pos'.
5279 ;; Go forward over "false matches", one per iteration.
5281 (< cfd-match-pos cfd-limit)
5284 ;; Kludge to filter out matches on the "<" that
5285 ;; aren't open parens, for the sake of languages
5286 ;; that got `c-recognize-<>-arglists' set.
5287 (and (eq (char-before cfd-match-pos) ?<)
5288 (not (c-get-char-property (1- cfd-match-pos)
5291 ;; If `cfd-continue-pos' is less or equal to
5292 ;; `cfd-token-pos', we've got a hit inside a macro
5293 ;; that's in the syntactic whitespace before the last
5294 ;; "real" declaration we've checked. If they're equal
5295 ;; we've arrived at the declaration a second time, so
5296 ;; there's nothing to do.
5297 (= cfd-continue-pos cfd-token-pos)
5300 ;; If `cfd-continue-pos' is less than `cfd-token-pos'
5301 ;; we're still searching for declarations embedded in
5302 ;; the syntactic whitespace. In that case we need
5303 ;; only to skip comments and not macros, since they
5304 ;; can't be nested, and that's already been done in
5305 ;; `c-find-decl-prefix-search'.
5306 (when (> cfd-continue-pos cfd-token-pos)
5307 (c-forward-syntactic-ws)
5308 (setq cfd-token-pos (point)))
5310 ;; Continue if the following token fails the
5311 ;; CFD-DECL-RE and CFD-FACE-CHECKLIST checks.
5312 (when (or (>= (point) cfd-limit)
5313 (not (looking-at cfd-decl-re))
5314 (and cfd-face-checklist
5316 (point) cfd-face-checklist))))
5317 (goto-char cfd-continue-pos)
5320 (< (point) cfd-limit)) ; end of "false matches" condition
5321 (c-find-decl-prefix-search)) ; end of "false matches" loop
5323 (< (point) cfd-limit)) ; end of condition for "decl-spot" while
5326 (>= (point) cfd-start-pos)
5329 ;; Narrow to the end of the macro if we got a hit inside
5330 ;; one, to avoid recognizing things that start inside the
5331 ;; macro and end outside it.
5332 (when (> cfd-match-pos cfd-macro-end)
5333 ;; Not in the same macro as in the previous round.
5335 (goto-char cfd-match-pos)
5337 (if (save-excursion (and (c-beginning-of-macro)
5338 (< (point) cfd-match-pos)))
5339 (progn (c-end-of-macro)
5343 (if (zerop cfd-macro-end)
5345 (if (> cfd-macro-end (point))
5346 (progn (narrow-to-region (point-min) cfd-macro-end)
5348 ;; The matched token was the last thing in the macro,
5349 ;; so the whole match is bogus.
5350 (setq cfd-macro-end 0)
5351 nil)))) ; end of when condition
5353 (c-debug-put-decl-spot-faces cfd-match-pos (point))
5354 (if (funcall cfd-fun cfd-match-pos (/= cfd-macro-end 0))
5355 (setq cfd-prop-match nil))
5357 (when (/= cfd-macro-end 0)
5358 ;; Restore limits if we did macro narrowing above.
5359 (narrow-to-region (point-min) cfd-buffer-end)))
5361 (goto-char cfd-continue-pos)
5362 (if (= cfd-continue-pos cfd-limit)
5363 (setq cfd-match-pos cfd-limit)
5364 (c-find-decl-prefix-search))))) ; Moves point, sets cfd-continue-pos,
5365 ; cfd-match-pos, etc.
5368 ;; A cache for found types.
5370 ;; Buffer local variable that contains an obarray with the types we've
5371 ;; found. If a declaration is recognized somewhere we record the
5372 ;; fully qualified identifier in it to recognize it as a type
5373 ;; elsewhere in the file too. This is not accurate since we do not
5374 ;; bother with the scoping rules of the languages, but in practice the
5375 ;; same name is seldom used as both a type and something else in a
5376 ;; file, and we only use this as a last resort in ambiguous cases (see
5377 ;; `c-forward-decl-or-cast-1').
5379 ;; Not every type need be in this cache. However, things which have
5380 ;; ceased to be types must be removed from it.
5382 ;; Template types in C++ are added here too but with the template
5383 ;; arglist replaced with "<>" in references or "<" for the one in the
5384 ;; primary type. E.g. the type "Foo<A,B>::Bar<C>" is stored as
5385 ;; "Foo<>::Bar<". This avoids storing very long strings (since C++
5386 ;; template specs can be fairly sized programs in themselves) and
5387 ;; improves the hit ratio (it's a type regardless of the template
5388 ;; args; it's just not the same type, but we're only interested in
5389 ;; recognizing types, not telling distinct types apart). Note that
5390 ;; template types in references are added here too; from the example
5391 ;; above there will also be an entry "Foo<".
5392 (defvar c-found-types nil)
5393 (make-variable-buffer-local 'c-found-types)
5395 (defsubst c-clear-found-types ()
5396 ;; Clears `c-found-types'.
5397 (setq c-found-types (make-vector 53 0)))
5399 (defun c-add-type (from to)
5400 ;; Add the given region as a type in `c-found-types'. If the region
5401 ;; doesn't match an existing type but there is a type which is equal
5402 ;; to the given one except that the last character is missing, then
5403 ;; the shorter type is removed. That's done to avoid adding all
5404 ;; prefixes of a type as it's being entered and font locked. This
5405 ;; doesn't cover cases like when characters are removed from a type
5406 ;; or added in the middle. We'd need the position of point when the
5407 ;; font locking is invoked to solve this well.
5409 ;; This function might do hidden buffer changes.
5410 (let ((type (c-syntactic-content from to c-recognize-<>-arglists)))
5411 (unless (intern-soft type c-found-types)
5412 (unintern (substring type 0 -1) c-found-types)
5413 (intern type c-found-types))))
5415 (defun c-unfind-type (name)
5416 ;; Remove the "NAME" from c-found-types, if present.
5417 (unintern name c-found-types))
5419 (defsubst c-check-type (from to)
5420 ;; Return non-nil if the given region contains a type in
5423 ;; This function might do hidden buffer changes.
5424 (intern-soft (c-syntactic-content from to c-recognize-<>-arglists)
5427 (defun c-list-found-types ()
5428 ;; Return all the types in `c-found-types' as a sorted list of
5431 (mapatoms (lambda (type)
5432 (setq type-list (cons (symbol-name type)
5435 (sort type-list 'string-lessp)))
5437 ;; Shut up the byte compiler.
5438 (defvar c-maybe-stale-found-type)
5440 (defun c-trim-found-types (beg end old-len)
5441 ;; An after change function which, in conjunction with the info in
5442 ;; c-maybe-stale-found-type (set in c-before-change), removes a type
5443 ;; from `c-found-types', should this type have become stale. For
5444 ;; example, this happens to "foo" when "foo \n bar();" becomes
5445 ;; "foo(); \n bar();". Such stale types, if not removed, foul up
5446 ;; the fontification.
5448 ;; Have we, perhaps, added non-ws characters to the front/back of a found
5452 (when (< end (point-max))
5454 (if (and (c-beginning-of-current-token) ; only moves when we started in the middle
5455 (progn (goto-char end)
5456 (c-end-of-current-token)))
5457 (c-unfind-type (buffer-substring-no-properties
5459 (when (> beg (point-min))
5461 (if (and (c-end-of-current-token) ; only moves when we started in the middle
5462 (progn (goto-char beg)
5463 (c-beginning-of-current-token)))
5464 (c-unfind-type (buffer-substring-no-properties
5467 (if c-maybe-stale-found-type ; e.g. (c-decl-id-start "foo" 97 107 " (* ooka) " "o")
5469 ;; Changing the amount of (already existing) whitespace - don't do anything.
5470 ((and (c-partial-ws-p beg end)
5471 (or (= beg end) ; removal of WS
5472 (string-match "^[ \t\n\r\f\v]*$" (nth 5 c-maybe-stale-found-type)))))
5474 ;; The syntactic relationship which defined a "found type" has been
5476 ((eq (car c-maybe-stale-found-type) 'c-decl-id-start)
5477 (c-unfind-type (cadr c-maybe-stale-found-type)))
5478 ;; ((eq (car c-maybe-stale-found-type) 'c-decl-type-start) FIXME!!!
5482 ;; Setting and removing syntax properties on < and > in languages (C++
5483 ;; and Java) where they can be template/generic delimiters as well as
5484 ;; their normal meaning of "less/greater than".
5486 ;; Normally, < and > have syntax 'punctuation'. When they are found to
5487 ;; be delimiters, they are marked as such with the category properties
5488 ;; c-<-as-paren-syntax, c->-as-paren-syntax respectively.
5492 ;; It is impossible to determine with certainty whether a <..> pair in
5493 ;; C++ is two comparison operators or is template delimiters, unless
5494 ;; one duplicates a lot of a C++ compiler. For example, the following
5497 ;; foo (a < b, c > d) ;
5499 ;; could be a function call with two integer parameters (each a
5500 ;; relational expression), or it could be a constructor for class foo
5501 ;; taking one parameter d of templated type "a < b, c >". They are
5502 ;; somewhat easier to distinguish in Java.
5504 ;; The strategy now (2010-01) adopted is to mark and unmark < and
5505 ;; > IN MATCHING PAIRS ONLY. [Previously, they were marked
5506 ;; individually when their context so indicated. This gave rise to
5507 ;; intractable problems when one of a matching pair was deleted, or
5508 ;; pulled into a literal.]
5510 ;; At each buffer change, the syntax-table properties are removed in a
5511 ;; before-change function and reapplied, when needed, in an
5512 ;; after-change function. It is far more important that the
5513 ;; properties get removed when they they are spurious than that they
5514 ;; be present when wanted.
5515 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
5516 (defun c-clear-<-pair-props (&optional pos)
5517 ;; POS (default point) is at a < character. If it is marked with
5518 ;; open paren syntax-table text property, remove the property,
5519 ;; together with the close paren property on the matching > (if
5525 (when (equal (c-get-char-property (point) 'syntax-table)
5526 c-<-as-paren-syntax)
5527 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5528 (c-go-list-forward))
5529 (when (equal (c-get-char-property (1- (point)) 'syntax-table)
5530 c->-as-paren-syntax) ; should always be true.
5531 (c-unmark-<->-as-paren (1- (point))))
5532 (c-unmark-<->-as-paren pos))))
5534 (defun c-clear->-pair-props (&optional pos)
5535 ;; POS (default point) is at a > character. If it is marked with
5536 ;; close paren syntax-table property, remove the property, together
5537 ;; with the open paren property on the matching < (if any).
5542 (when (equal (c-get-char-property (point) 'syntax-table)
5543 c->-as-paren-syntax)
5544 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5545 (c-go-up-list-backward))
5546 (when (equal (c-get-char-property (point) 'syntax-table)
5547 c-<-as-paren-syntax) ; should always be true.
5548 (c-unmark-<->-as-paren (point)))
5549 (c-unmark-<->-as-paren pos))))
5551 (defun c-clear-<>-pair-props (&optional pos)
5552 ;; POS (default point) is at a < or > character. If it has an
5553 ;; open/close paren syntax-table property, remove this property both
5554 ;; from the current character and its partner (which will also be
5557 ((eq (char-after) ?\<)
5558 (c-clear-<-pair-props pos))
5559 ((eq (char-after) ?\>)
5560 (c-clear->-pair-props pos))
5562 "c-clear-<>-pair-props called from wrong position"))))
5564 (defun c-clear-<-pair-props-if-match-after (lim &optional pos)
5565 ;; POS (default point) is at a < character. If it is both marked
5566 ;; with open/close paren syntax-table property, and has a matching >
5567 ;; (also marked) which is after LIM, remove the property both from
5568 ;; the current > and its partner. Return t when this happens, nil
5574 (when (equal (c-get-char-property (point) 'syntax-table)
5575 c-<-as-paren-syntax)
5576 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5577 (c-go-list-forward))
5578 (when (and (>= (point) lim)
5579 (equal (c-get-char-property (1- (point)) 'syntax-table)
5580 c->-as-paren-syntax)) ; should always be true.
5581 (c-unmark-<->-as-paren (1- (point)))
5582 (c-unmark-<->-as-paren pos))
5585 (defun c-clear->-pair-props-if-match-before (lim &optional pos)
5586 ;; POS (default point) is at a > character. If it is both marked
5587 ;; with open/close paren syntax-table property, and has a matching <
5588 ;; (also marked) which is before LIM, remove the property both from
5589 ;; the current < and its partner. Return t when this happens, nil
5595 (when (equal (c-get-char-property (point) 'syntax-table)
5596 c->-as-paren-syntax)
5597 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5598 (c-go-up-list-backward))
5599 (when (and (<= (point) lim)
5600 (equal (c-get-char-property (point) 'syntax-table)
5601 c-<-as-paren-syntax)) ; should always be true.
5602 (c-unmark-<->-as-paren (point))
5603 (c-unmark-<->-as-paren pos))
5606 ;; Set by c-common-init in cc-mode.el.
5610 (defun c-before-change-check-<>-operators (beg end)
5611 ;; Unmark certain pairs of "< .... >" which are currently marked as
5612 ;; template/generic delimiters. (This marking is via syntax-table text
5613 ;; properties), and expand the (c-new-BEG c-new-END) region to include all
5614 ;; unmarked < and > operators within the certain bounds (see below).
5616 ;; These pairs are those which are in the current "statement" (i.e.,
5617 ;; the region between the {, }, or ; before BEG and the one after
5618 ;; END), and which enclose any part of the interval (BEG END).
5620 ;; Note that in C++ (?and Java), template/generic parens cannot
5621 ;; enclose a brace or semicolon, so we use these as bounds on the
5622 ;; region we must work on.
5624 ;; This function is called from before-change-functions (via
5625 ;; c-get-state-before-change-functions). Thus the buffer is widened,
5626 ;; and point is undefined, both at entry and exit.
5628 ;; FIXME!!! This routine ignores the possibility of macros entirely.
5631 (c-save-buffer-state
5632 ((beg-lit-limits (progn (goto-char beg) (c-literal-limits)))
5633 (end-lit-limits (progn (goto-char end) (c-literal-limits)))
5634 new-beg new-end beg-limit end-limit)
5635 ;; Locate the earliest < after the barrier before the changed region,
5636 ;; which isn't already marked as a paren.
5637 (goto-char (if beg-lit-limits (car beg-lit-limits) beg))
5638 (setq beg-limit (c-determine-limit 512))
5640 ;; Remove the syntax-table/category properties from each pertinent <...>
5641 ;; pair. Firstly, the ones with the < before beg and > after beg....
5642 (while (progn (c-syntactic-skip-backward "^;{}<" beg-limit)
5643 (eq (char-before) ?<))
5644 (c-backward-token-2)
5645 (when (eq (char-after) ?<)
5646 (c-clear-<-pair-props-if-match-after beg)))
5647 (c-forward-syntactic-ws)
5648 (setq new-beg (point))
5650 ;; ...Then the ones with < before end and > after end.
5651 (goto-char (if end-lit-limits (cdr end-lit-limits) end))
5652 (setq end-limit (c-determine-+ve-limit 512))
5653 (while (and (c-syntactic-re-search-forward "[;{}>]" end-limit 'end)
5654 (eq (char-before) ?>))
5655 (c-end-of-current-token)
5656 (when (eq (char-before) ?>)
5657 (c-clear->-pair-props-if-match-before end (1- (point)))))
5658 (c-backward-syntactic-ws)
5659 (setq new-end (point))
5661 ;; Extend the fontification region, if needed.
5663 (< new-beg c-new-BEG)
5664 (setq c-new-BEG new-beg))
5666 (> new-end c-new-END)
5667 (setq c-new-END new-end)))))
5669 (defun c-after-change-check-<>-operators (beg end)
5670 ;; This is called from `after-change-functions' when
5671 ;; c-recognize-<>-arglists' is set. It ensures that no "<" or ">"
5672 ;; chars with paren syntax become part of another operator like "<<"
5675 ;; This function might do hidden buffer changes.
5679 (when (or (looking-at "[<>]")
5680 (< (skip-chars-backward "<>") 0))
5683 (c-beginning-of-current-token)
5684 (when (and (< (point) beg)
5685 (looking-at c-<>-multichar-token-regexp)
5686 (< beg (setq beg (match-end 0))))
5687 (while (progn (skip-chars-forward "^<>" beg)
5689 (c-clear-<>-pair-props)
5694 (when (or (looking-at "[<>]")
5695 (< (skip-chars-backward "<>") 0))
5698 (c-beginning-of-current-token)
5699 (when (and (< (point) end)
5700 (looking-at c-<>-multichar-token-regexp)
5701 (< end (setq end (match-end 0))))
5702 (while (progn (skip-chars-forward "^<>" end)
5704 (c-clear-<>-pair-props)
5705 (forward-char)))))))
5707 (defun c-restore-<>-properties (_beg _end _old-len)
5708 ;; This function is called as an after-change function. It restores the
5709 ;; category/syntax-table properties on template/generic <..> pairs between
5710 ;; c-new-BEG and c-new-END. It may do hidden buffer changes.
5711 (c-save-buffer-state ((c-parse-and-markup-<>-arglists t)
5712 c-restricted-<>-arglists lit-limits)
5713 (goto-char c-new-BEG)
5714 (if (setq lit-limits (c-literal-limits))
5715 (goto-char (cdr lit-limits)))
5716 (while (and (< (point) c-new-END)
5717 (c-syntactic-re-search-forward "<" c-new-END 'bound))
5720 (c-backward-token-2)
5721 (setq c-restricted-<>-arglists
5722 (and (not (looking-at c-opt-<>-sexp-key))
5723 (progn (c-backward-syntactic-ws) ; to ( or ,
5724 (and (memq (char-before) '(?\( ?,)) ; what about <?
5725 (not (eq (c-get-char-property (point) 'c-type)
5726 'c-decl-arg-start)))))))
5727 (or (c-forward-<>-arglist nil)
5730 ;; Handling of small scale constructs like types and names.
5732 ;; Dynamically bound variable that instructs `c-forward-type' to also
5733 ;; treat possible types (i.e. those that it normally returns 'maybe or
5734 ;; 'found for) as actual types (and always return 'found for them).
5735 ;; This means that it records them in `c-record-type-identifiers' if
5736 ;; that is set, and that it adds them to `c-found-types'.
5737 (defvar c-promote-possible-types nil)
5739 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5740 ;; mark up successfully parsed arglists with paren syntax properties on
5741 ;; the surrounding angle brackets and with `c-<>-arg-sep' in the
5742 ;; `c-type' property of each argument separating comma.
5744 ;; Setting this variable also makes `c-forward-<>-arglist' recurse into
5745 ;; all arglists for side effects (i.e. recording types), otherwise it
5746 ;; exploits any existing paren syntax properties to quickly jump to the
5747 ;; end of already parsed arglists.
5749 ;; Marking up the arglists is not the default since doing that correctly
5750 ;; depends on a proper value for `c-restricted-<>-arglists'.
5751 (defvar c-parse-and-markup-<>-arglists nil)
5753 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5754 ;; not accept arglists that contain binary operators.
5756 ;; This is primarily used to handle C++ template arglists. C++
5757 ;; disambiguates them by checking whether the preceding name is a
5758 ;; template or not. We can't do that, so we assume it is a template
5759 ;; if it can be parsed as one. That usually works well since
5760 ;; comparison expressions on the forms "a < b > c" or "a < b, c > d"
5761 ;; in almost all cases would be pointless.
5763 ;; However, in function arglists, e.g. in "foo (a < b, c > d)", we
5764 ;; should let the comma separate the function arguments instead. And
5765 ;; in a context where the value of the expression is taken, e.g. in
5766 ;; "if (a < b || c > d)", it's probably not a template.
5767 (defvar c-restricted-<>-arglists nil)
5769 ;; Dynamically bound variables that instructs
5770 ;; `c-forward-keyword-clause', `c-forward-<>-arglist',
5771 ;; `c-forward-name', `c-forward-type', `c-forward-decl-or-cast-1', and
5772 ;; `c-forward-label' to record the ranges of all the type and
5773 ;; reference identifiers they encounter. They will build lists on
5774 ;; these variables where each element is a cons of the buffer
5775 ;; positions surrounding each identifier. This recording is only
5776 ;; activated when `c-record-type-identifiers' is non-nil.
5778 ;; All known types that can't be identifiers are recorded, and also
5779 ;; other possible types if `c-promote-possible-types' is set.
5780 ;; Recording is however disabled inside angle bracket arglists that
5781 ;; are encountered inside names and other angle bracket arglists.
5782 ;; Such occurrences are taken care of by `c-font-lock-<>-arglists'
5785 ;; Only the names in C++ template style references (e.g. "tmpl" in
5786 ;; "tmpl<a,b>::foo") are recorded as references, other references
5787 ;; aren't handled here.
5789 ;; `c-forward-label' records the label identifier(s) on
5790 ;; `c-record-ref-identifiers'.
5791 (defvar c-record-type-identifiers nil)
5792 (defvar c-record-ref-identifiers nil)
5794 ;; This variable will receive a cons cell of the range of the last
5795 ;; single identifier symbol stepped over by `c-forward-name' if it's
5796 ;; successful. This is the range that should be put on one of the
5797 ;; record lists above by the caller. It's assigned nil if there's no
5798 ;; such symbol in the name.
5799 (defvar c-last-identifier-range nil)
5801 (defmacro c-record-type-id (range)
5802 (if (eq (car-safe range) 'cons)
5804 `(setq c-record-type-identifiers
5805 (cons ,range c-record-type-identifiers))
5806 `(let ((range ,range))
5808 (setq c-record-type-identifiers
5809 (cons range c-record-type-identifiers))))))
5811 (defmacro c-record-ref-id (range)
5812 (if (eq (car-safe range) 'cons)
5814 `(setq c-record-ref-identifiers
5815 (cons ,range c-record-ref-identifiers))
5816 `(let ((range ,range))
5818 (setq c-record-ref-identifiers
5819 (cons range c-record-ref-identifiers))))))
5821 ;; Dynamically bound variable that instructs `c-forward-type' to
5822 ;; record the ranges of types that only are found. Behaves otherwise
5823 ;; like `c-record-type-identifiers'.
5824 (defvar c-record-found-types nil)
5826 (defmacro c-forward-keyword-prefixed-id (type)
5827 ;; Used internally in `c-forward-keyword-clause' to move forward
5828 ;; over a type (if TYPE is 'type) or a name (otherwise) which
5829 ;; possibly is prefixed by keywords and their associated clauses.
5830 ;; Try with a type/name first to not trip up on those that begin
5831 ;; with a keyword. Return t if a known or found type is moved
5832 ;; over. The point is clobbered if nil is returned. If range
5833 ;; recording is enabled, the identifier is recorded on as a type
5834 ;; if TYPE is 'type or as a reference if TYPE is 'ref.
5836 ;; This macro might do hidden buffer changes.
5838 (while (if (setq res ,(if (eq type 'type)
5842 (cond ((looking-at c-keywords-regexp)
5843 (c-forward-keyword-clause 1))
5844 ((and c-opt-cpp-prefix
5845 (looking-at c-noise-macro-with-parens-name-re))
5846 (c-forward-noise-clause)))))
5847 (when (memq res '(t known found prefix maybe))
5848 (when c-record-type-identifiers
5849 ,(if (eq type 'type)
5850 `(c-record-type-id c-last-identifier-range)
5851 `(c-record-ref-id c-last-identifier-range)))
5854 (defmacro c-forward-id-comma-list (type update-safe-pos)
5855 ;; Used internally in `c-forward-keyword-clause' to move forward
5856 ;; over a comma separated list of types or names using
5857 ;; `c-forward-keyword-prefixed-id'.
5859 ;; This macro might do hidden buffer changes.
5861 ,(when update-safe-pos
5862 `(setq safe-pos (point)))
5863 (eq (char-after) ?,))
5866 (c-forward-syntactic-ws)
5867 (c-forward-keyword-prefixed-id ,type)))))
5869 (defun c-forward-noise-clause ()
5870 ;; Point is at a c-noise-macro-with-parens-names macro identifier. Go
5871 ;; forward over this name, any parenthesis expression which follows it, and
5872 ;; any syntactic WS, ending up at the next token. If there is an unbalanced
5873 ;; paren expression, leave point at it. Always Return t.
5875 (if (and (eq (char-after) ?\()
5876 (c-go-list-forward))
5877 (c-forward-syntactic-ws))
5880 (defun c-forward-keyword-clause (match)
5881 ;; Submatch MATCH in the current match data is assumed to surround a
5882 ;; token. If it's a keyword, move over it and any immediately
5883 ;; following clauses associated with it, stopping at the start of
5884 ;; the next token. t is returned in that case, otherwise the point
5885 ;; stays and nil is returned. The kind of clauses that are
5886 ;; recognized are those specified by `c-type-list-kwds',
5887 ;; `c-ref-list-kwds', `c-colon-type-list-kwds',
5888 ;; `c-paren-nontype-kwds', `c-paren-type-kwds', `c-<>-type-kwds',
5889 ;; and `c-<>-arglist-kwds'.
5891 ;; This function records identifier ranges on
5892 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5893 ;; `c-record-type-identifiers' is non-nil.
5895 ;; Note that for `c-colon-type-list-kwds', which doesn't necessary
5896 ;; apply directly after the keyword, the type list is moved over
5897 ;; only when there is no unaccounted token before it (i.e. a token
5898 ;; that isn't moved over due to some other keyword list). The
5899 ;; identifier ranges in the list are still recorded if that should
5902 ;; This function might do hidden buffer changes.
5904 (let ((kwd-sym (c-keyword-sym (match-string match))) safe-pos pos
5905 ;; The call to `c-forward-<>-arglist' below is made after
5906 ;; `c-<>-sexp-kwds' keywords, so we're certain they actually
5907 ;; are angle bracket arglists and `c-restricted-<>-arglists'
5908 ;; should therefore be nil.
5909 (c-parse-and-markup-<>-arglists t)
5910 c-restricted-<>-arglists)
5913 (goto-char (match-end match))
5914 (c-forward-syntactic-ws)
5915 (setq safe-pos (point))
5918 ((and (c-keyword-member kwd-sym 'c-type-list-kwds)
5919 (c-forward-keyword-prefixed-id type))
5920 ;; There's a type directly after a keyword in `c-type-list-kwds'.
5921 (c-forward-id-comma-list type t))
5923 ((and (c-keyword-member kwd-sym 'c-ref-list-kwds)
5924 (c-forward-keyword-prefixed-id ref))
5925 ;; There's a name directly after a keyword in `c-ref-list-kwds'.
5926 (c-forward-id-comma-list ref t))
5928 ((and (c-keyword-member kwd-sym 'c-paren-any-kwds)
5929 (eq (char-after) ?\())
5930 ;; There's an open paren after a keyword in `c-paren-any-kwds'.
5933 (when (and (setq pos (c-up-list-forward))
5934 (eq (char-before pos) ?\)))
5935 (when (and c-record-type-identifiers
5936 (c-keyword-member kwd-sym 'c-paren-type-kwds))
5937 ;; Use `c-forward-type' on every identifier we can find
5938 ;; inside the paren, to record the types.
5939 (while (c-syntactic-re-search-forward c-symbol-start pos t)
5940 (goto-char (match-beginning 0))
5941 (unless (c-forward-type)
5942 (looking-at c-symbol-key) ; Always matches.
5943 (goto-char (match-end 0)))))
5946 (c-forward-syntactic-ws)
5947 (setq safe-pos (point))))
5949 ((and (c-keyword-member kwd-sym 'c-<>-sexp-kwds)
5950 (eq (char-after) ?<)
5951 (c-forward-<>-arglist (c-keyword-member kwd-sym 'c-<>-type-kwds)))
5952 (c-forward-syntactic-ws)
5953 (setq safe-pos (point)))
5955 ((and (c-keyword-member kwd-sym 'c-nonsymbol-sexp-kwds)
5956 (not (looking-at c-symbol-start))
5957 (c-safe (c-forward-sexp) t))
5958 (c-forward-syntactic-ws)
5959 (setq safe-pos (point))))
5961 (when (c-keyword-member kwd-sym 'c-colon-type-list-kwds)
5962 (if (eq (char-after) ?:)
5963 ;; If we are at the colon already, we move over the type
5967 (c-forward-syntactic-ws)
5968 (when (c-forward-keyword-prefixed-id type)
5969 (c-forward-id-comma-list type t)))
5970 ;; Not at the colon, so stop here. But the identifier
5971 ;; ranges in the type list later on should still be
5973 (and c-record-type-identifiers
5975 ;; If a keyword matched both one of the types above and
5976 ;; this one, we match `c-colon-type-list-re' after the
5977 ;; clause matched above.
5978 (goto-char safe-pos)
5979 (looking-at c-colon-type-list-re))
5981 (goto-char (match-end 0))
5982 (c-forward-syntactic-ws)
5983 (c-forward-keyword-prefixed-id type))
5984 ;; There's a type after the `c-colon-type-list-re' match
5985 ;; after a keyword in `c-colon-type-list-kwds'.
5986 (c-forward-id-comma-list type nil))))
5988 (goto-char safe-pos)
5991 ;; cc-mode requires cc-fonts.
5992 (declare-function c-fontify-recorded-types-and-refs "cc-fonts" ())
5994 (defun c-forward-<>-arglist (all-types)
5995 ;; The point is assumed to be at a "<". Try to treat it as the open
5996 ;; paren of an angle bracket arglist and move forward to the
5997 ;; corresponding ">". If successful, the point is left after the
5998 ;; ">" and t is returned, otherwise the point isn't moved and nil is
5999 ;; returned. If ALL-TYPES is t then all encountered arguments in
6000 ;; the arglist that might be types are treated as found types.
6002 ;; The variable `c-parse-and-markup-<>-arglists' controls how this
6003 ;; function handles text properties on the angle brackets and argument
6004 ;; separating commas.
6006 ;; `c-restricted-<>-arglists' controls how lenient the template
6007 ;; arglist recognition should be.
6009 ;; This function records identifier ranges on
6010 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6011 ;; `c-record-type-identifiers' is non-nil.
6013 ;; This function might do hidden buffer changes.
6015 (let ((start (point))
6016 ;; If `c-record-type-identifiers' is set then activate
6017 ;; recording of any found types that constitute an argument in
6019 (c-record-found-types (if c-record-type-identifiers t)))
6020 (if (catch 'angle-bracket-arglist-escape
6021 (setq c-record-found-types
6022 (c-forward-<>-arglist-recur all-types)))
6024 (when (consp c-record-found-types)
6025 (setq c-record-type-identifiers
6026 ;; `nconc' doesn't mind that the tail of
6027 ;; `c-record-found-types' is t.
6028 (nconc c-record-found-types c-record-type-identifiers)))
6034 (defun c-forward-<>-arglist-recur (all-types)
6035 ;; Recursive part of `c-forward-<>-arglist'.
6037 ;; This function might do hidden buffer changes.
6038 (let ((start (point)) res pos
6039 ;; Cover this so that any recorded found type ranges are
6040 ;; automatically lost if it turns out to not be an angle
6041 ;; bracket arglist. It's propagated through the return value
6042 ;; on successful completion.
6043 (c-record-found-types c-record-found-types)
6044 ;; List that collects the positions after the argument
6045 ;; separating ',' in the arglist.
6047 ;; If the '<' has paren open syntax then we've marked it as an angle
6048 ;; bracket arglist before, so skip to the end.
6049 (if (and (not c-parse-and-markup-<>-arglists)
6050 (c-get-char-property (point) 'syntax-table))
6054 (if (and (c-go-up-list-forward)
6055 (eq (char-before) ?>))
6057 ;; Got unmatched paren angle brackets. We don't clear the paren
6058 ;; syntax properties and retry, on the basis that it's very
6059 ;; unlikely that paren angle brackets become operators by code
6060 ;; manipulation. It's far more likely that it doesn't match due
6061 ;; to narrowing or some temporary change.
6065 (forward-char) ; Forward over the opening '<'.
6067 (unless (looking-at c-<-op-cont-regexp)
6068 ;; go forward one non-alphanumeric character (group) per iteration of
6072 (c-forward-syntactic-ws)
6073 (when (or (and c-record-type-identifiers all-types)
6074 (not (equal c-inside-<>-type-key "\\(\\<\\>\\)")))
6075 (c-forward-syntactic-ws)
6077 ((eq (char-after) ??)
6079 ((and (looking-at c-identifier-start)
6080 (not (looking-at c-keywords-regexp)))
6081 (if (or (and all-types c-record-type-identifiers)
6082 (c-major-mode-is 'java-mode))
6083 ;; All encountered identifiers are types, so set the
6084 ;; promote flag and parse the type.
6085 (let ((c-promote-possible-types t)
6086 (c-record-found-types t))
6088 (c-forward-token-2))))
6090 (c-forward-syntactic-ws)
6092 (when (looking-at c-inside-<>-type-key)
6093 (goto-char (match-end 1))
6094 (c-forward-syntactic-ws)
6095 (let ((c-promote-possible-types t)
6096 (c-record-found-types t))
6098 (c-forward-syntactic-ws)))
6100 (setq pos (point)) ; e.g. first token inside the '<'
6102 ;; Note: These regexps exploit the match order in \| so
6103 ;; that "<>" is matched by "<" rather than "[^>:-]>".
6104 (c-syntactic-re-search-forward
6105 ;; Stop on ',', '|', '&', '+' and '-' to catch
6106 ;; common binary operators that could be between
6107 ;; two comparison expressions "a<b" and "c>d".
6108 ;; 2016-02-11: C++11 templates can now contain arithmetic
6109 ;; expressions, so template detection in C++ is now less
6110 ;; robust than it was.
6111 c-<>-notable-chars-re
6115 ((eq (char-before) ?>)
6116 ;; Either an operator starting with '>' or the end of
6117 ;; the angle bracket arglist.
6120 (c-backward-token-2)
6121 (looking-at c-multichar->-op-not->>-regexp))
6123 (goto-char (match-end 0))
6124 t) ; Continue the loop.
6126 ;; The angle bracket arglist is finished.
6127 (when c-parse-and-markup-<>-arglists
6128 (while arg-start-pos
6129 (c-put-c-type-property (1- (car arg-start-pos))
6131 (setq arg-start-pos (cdr arg-start-pos)))
6132 (c-mark-<-as-paren start)
6133 (c-mark->-as-paren (1- (point))))
6135 nil)) ; Exit the loop.
6137 ((eq (char-before) ?<)
6138 ;; Either an operator starting with '<' or a nested arglist.
6140 (let (id-start id-end subres keyword-match)
6142 ;; The '<' begins a multi-char operator.
6143 ((looking-at c-<-op-cont-regexp)
6144 (goto-char (match-end 0)))
6145 ;; We're at a nested <.....>
6147 (backward-char) ; to the '<'
6150 ;; There's always an identifier before an angle
6151 ;; bracket arglist, or a keyword in `c-<>-type-kwds'
6152 ;; or `c-<>-arglist-kwds'.
6153 (c-backward-syntactic-ws)
6154 (setq id-end (point))
6155 (c-simple-skip-symbol-backward)
6156 (when (or (setq keyword-match
6157 (looking-at c-opt-<>-sexp-key))
6158 (not (looking-at c-keywords-regexp)))
6159 (setq id-start (point))))
6161 (let ((c-promote-possible-types t)
6162 (c-record-found-types t))
6163 (c-forward-<>-arglist-recur
6166 (c-keyword-sym (match-string 1))
6167 'c-<>-type-kwds))))))
6168 (or subres (goto-char pos))
6170 ;; It was an angle bracket arglist.
6171 (setq c-record-found-types subres)
6173 ;; Record the identifier before the template as a type
6174 ;; or reference depending on whether the arglist is last
6175 ;; in a qualified identifier.
6176 (when (and c-record-type-identifiers
6177 (not keyword-match))
6178 (if (and c-opt-identifier-concat-key
6180 (c-forward-syntactic-ws)
6181 (looking-at c-opt-identifier-concat-key)))
6182 (c-record-ref-id (cons id-start id-end))
6183 (c-record-type-id (cons id-start id-end)))))
6185 ;; At a "less than" operator.
6187 ;; (forward-char) ; NO! We've already gone over the <.
6189 t) ; carry on looping.
6192 (eq (char-before) ?\()
6193 (c-go-up-list-forward)
6194 (eq (char-before) ?\))))
6196 ((and (not c-restricted-<>-arglists)
6197 (or (and (eq (char-before) ?&)
6198 (not (eq (char-after) ?&)))
6199 (eq (char-before) ?,)))
6200 ;; Just another argument. Record the position. The
6201 ;; type check stuff that made us stop at it is at
6202 ;; the top of the loop.
6203 (setq arg-start-pos (cons (point) arg-start-pos)))
6206 ;; Got a character that can't be in an angle bracket
6207 ;; arglist argument. Abort using `throw', since
6208 ;; it's useless to try to find a surrounding arglist
6210 (throw 'angle-bracket-arglist-escape nil))))))
6212 (or c-record-found-types t)))))
6214 (defun c-backward-<>-arglist (all-types &optional limit)
6215 ;; The point is assumed to be directly after a ">". Try to treat it
6216 ;; as the close paren of an angle bracket arglist and move back to
6217 ;; the corresponding "<". If successful, the point is left at
6218 ;; the "<" and t is returned, otherwise the point isn't moved and
6219 ;; nil is returned. ALL-TYPES is passed on to
6220 ;; `c-forward-<>-arglist'.
6222 ;; If the optional LIMIT is given, it bounds the backward search.
6223 ;; It's then assumed to be at a syntactically relevant position.
6225 ;; This is a wrapper around `c-forward-<>-arglist'. See that
6226 ;; function for more details.
6228 (let ((start (point)))
6230 (if (and (not c-parse-and-markup-<>-arglists)
6231 (c-get-char-property (point) 'syntax-table))
6233 (if (and (c-go-up-list-backward)
6234 (eq (char-after) ?<))
6236 ;; See corresponding note in `c-forward-<>-arglist'.
6241 (c-syntactic-skip-backward "^<;{}" limit t)
6244 (if (eq (char-before) ?<)
6246 ;; Stopped at bob or a char that isn't allowed in an
6247 ;; arglist, so we've failed.
6252 (progn (c-beginning-of-current-token)
6254 ;; If we moved then the "<" was part of some
6255 ;; multicharacter token.
6259 (let ((beg-pos (point)))
6260 (if (c-forward-<>-arglist all-types)
6261 (cond ((= (point) start)
6262 ;; Matched the arglist. Break the while.
6266 ;; We started from a non-paren ">" inside an
6271 ;; Matched a shorter arglist. Can be a nested
6272 ;; one so continue looking.
6277 (/= (point) start))))
6279 (defun c-forward-name ()
6280 ;; Move forward over a complete name if at the beginning of one,
6281 ;; stopping at the next following token. A keyword, as such,
6282 ;; doesn't count as a name. If the point is not at something that
6283 ;; is recognized as a name then it stays put.
6285 ;; A name could be something as simple as "foo" in C or something as
6286 ;; complex as "X<Y<class A<int>::B, BIT_MAX >> b>, ::operator<> ::
6287 ;; Z<(a>b)> :: operator const X<&foo>::T Q::G<unsigned short
6288 ;; int>::*volatile const" in C++ (this function is actually little
6289 ;; more than a `looking-at' call in all modes except those that,
6290 ;; like C++, have `c-recognize-<>-arglists' set).
6293 ;; o - nil if no name is found;
6294 ;; o - 'template if it's an identifier ending with an angle bracket
6296 ;; o - 'operator of it's an operator identifier;
6297 ;; o - t if it's some other kind of name.
6299 ;; This function records identifier ranges on
6300 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6301 ;; `c-record-type-identifiers' is non-nil.
6303 ;; This function might do hidden buffer changes.
6305 (let ((pos (point)) (start (point)) res id-start id-end
6306 ;; Turn off `c-promote-possible-types' here since we might
6307 ;; call `c-forward-<>-arglist' and we don't want it to promote
6308 ;; every suspect thing in the arglist to a type. We're
6309 ;; typically called from `c-forward-type' in this case, and
6310 ;; the caller only wants the top level type that it finds to
6312 c-promote-possible-types)
6315 (looking-at c-identifier-key)
6318 ;; Check for keyword. We go to the last symbol in
6319 ;; `c-identifier-key' first.
6320 (goto-char (setq id-end (match-end 0)))
6321 (c-simple-skip-symbol-backward)
6322 (setq id-start (point))
6324 (if (looking-at c-keywords-regexp)
6325 (when (and (c-major-mode-is 'c++-mode)
6327 (cc-eval-when-compile
6328 (concat "\\(operator\\|\\(template\\)\\)"
6329 "\\(" (c-lang-const c-nonsymbol-key c++)
6331 (if (match-beginning 2)
6332 ;; "template" is only valid inside an
6333 ;; identifier if preceded by "::".
6335 (c-backward-syntactic-ws)
6336 (and (c-safe (backward-char 2) t)
6340 ;; Handle a C++ operator or template identifier.
6342 (c-forward-syntactic-ws)
6343 (cond ((eq (char-before id-end) ?e)
6344 ;; Got "... ::template".
6345 (let ((subres (c-forward-name)))
6350 ((looking-at c-identifier-start)
6351 ;; Got a cast operator.
6352 (when (c-forward-type)
6355 ;; Now we should match a sequence of either
6356 ;; '*', '&' or a name followed by ":: *",
6357 ;; where each can be followed by a sequence
6358 ;; of `c-opt-type-modifier-key'.
6359 (while (cond ((looking-at "[*&]")
6360 (goto-char (match-end 0))
6362 ((looking-at c-identifier-start)
6363 (and (c-forward-name)
6366 (goto-char (match-end 0))
6367 (c-forward-syntactic-ws)
6368 (eq (char-after) ?*))
6373 (c-forward-syntactic-ws)
6375 (looking-at c-opt-type-modifier-key))
6376 (goto-char (match-end 1))))))
6378 ((looking-at c-overloadable-operators-regexp)
6379 ;; Got some other operator.
6380 (setq c-last-identifier-range
6381 (cons (point) (match-end 0)))
6382 (goto-char (match-end 0))
6383 (c-forward-syntactic-ws)
6389 ;; `id-start' is equal to `id-end' if we've jumped over
6390 ;; an identifier that doesn't end with a symbol token.
6391 ;; That can occur e.g. for Java import directives on the
6392 ;; form "foo.bar.*".
6393 (when (and id-start (/= id-start id-end))
6394 (setq c-last-identifier-range
6395 (cons id-start id-end)))
6397 (c-forward-syntactic-ws)
6403 (when (or c-opt-identifier-concat-key
6404 c-recognize-<>-arglists)
6407 ((and c-opt-identifier-concat-key
6408 (looking-at c-opt-identifier-concat-key))
6409 ;; Got a concatenated identifier. This handles the
6410 ;; cases with tricky syntactic whitespace that aren't
6411 ;; covered in `c-identifier-key'.
6412 (goto-char (match-end 0))
6413 (c-forward-syntactic-ws)
6416 ((and c-recognize-<>-arglists
6417 (eq (char-after) ?<))
6418 ;; Maybe an angle bracket arglist.
6419 (when (let (c-last-identifier-range)
6420 (c-forward-<>-arglist nil))
6422 (c-forward-syntactic-ws)
6423 (unless (eq (char-after) ?\()
6424 (setq c-last-identifier-range nil)
6425 (c-add-type start (1+ pos)))
6428 (if (and c-opt-identifier-concat-key
6429 (looking-at c-opt-identifier-concat-key))
6431 ;; Continue if there's an identifier concatenation
6432 ;; operator after the template argument.
6434 (when (and c-record-type-identifiers id-start)
6435 (c-record-ref-id (cons id-start id-end)))
6437 (c-forward-syntactic-ws)
6440 (when (and c-record-type-identifiers id-start
6441 (not (eq (char-after) ?\()))
6442 (c-record-type-id (cons id-start id-end)))
6443 (setq res 'template)
6450 (defun c-forward-type (&optional brace-block-too)
6451 ;; Move forward over a type spec if at the beginning of one,
6452 ;; stopping at the next following token. The keyword "typedef"
6453 ;; isn't part of a type spec here.
6455 ;; BRACE-BLOCK-TOO, when non-nil, means move over the brace block in
6456 ;; constructs like "struct foo {...} bar ;" or "struct {...} bar;".
6457 ;; The current (2009-03-10) intention is to convert all uses of
6458 ;; `c-forward-type' to call with this parameter set, then to
6462 ;; o - t if it's a known type that can't be a name or other
6464 ;; o - 'known if it's an otherwise known type (according to
6465 ;; `*-font-lock-extra-types');
6466 ;; o - 'prefix if it's a known prefix of a type;
6467 ;; o - 'found if it's a type that matches one in `c-found-types';
6468 ;; o - 'maybe if it's an identifier that might be a type;
6469 ;; o - 'decltype if it's a decltype(variable) declaration; - or
6470 ;; o - nil if it can't be a type (the point isn't moved then).
6472 ;; The point is assumed to be at the beginning of a token.
6474 ;; Note that this function doesn't skip past the brace definition
6475 ;; that might be considered part of the type, e.g.
6476 ;; "enum {a, b, c} foo".
6478 ;; This function records identifier ranges on
6479 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6480 ;; `c-record-type-identifiers' is non-nil.
6482 ;; This function might do hidden buffer changes.
6483 (when (and c-recognize-<>-arglists
6485 (c-forward-<>-arglist t)
6486 (c-forward-syntactic-ws))
6488 (let ((start (point)) pos res name-res id-start id-end id-range)
6490 ;; Skip leading type modifiers. If any are found we know it's a
6491 ;; prefix of a type.
6492 (when c-opt-type-modifier-key ; e.g. "const" "volatile", but NOT "typedef"
6493 (while (looking-at c-opt-type-modifier-key)
6494 (goto-char (match-end 1))
6495 (c-forward-syntactic-ws)
6496 (setq res 'prefix)))
6499 ((looking-at c-typeof-key) ; e.g. C++'s "decltype".
6500 (goto-char (match-end 1))
6501 (c-forward-syntactic-ws)
6502 (setq res (and (eq (char-after) ?\()
6503 (c-safe (c-forward-sexp))
6506 (c-forward-syntactic-ws)
6509 ((looking-at c-type-prefix-key) ; e.g. "struct", "class", but NOT
6511 (goto-char (match-end 1))
6512 (c-forward-syntactic-ws)
6515 ((looking-at c-decl-hangon-key)
6516 (c-forward-keyword-clause 1))
6517 ((and c-opt-cpp-prefix
6518 (looking-at c-noise-macro-with-parens-name-re))
6519 (c-forward-noise-clause))))
6523 (setq name-res (c-forward-name))
6524 (setq res (not (null name-res)))
6525 (when (eq name-res t)
6526 ;; In many languages the name can be used without the
6527 ;; prefix, so we add it to `c-found-types'.
6528 (c-add-type pos (point))
6529 (when (and c-record-type-identifiers
6530 c-last-identifier-range)
6531 (c-record-type-id c-last-identifier-range)))
6532 (when (and brace-block-too
6534 (eq (char-after) ?\{)
6537 (progn (c-forward-sexp)
6538 (c-forward-syntactic-ws)
6539 (setq pos (point))))))
6542 (unless res (goto-char start))) ; invalid syntax
6546 (if (looking-at c-identifier-start)
6548 (setq id-start (point)
6549 name-res (c-forward-name))
6551 (setq id-end (point)
6552 id-range c-last-identifier-range))))
6553 (and (cond ((looking-at c-primitive-type-key)
6555 ((c-with-syntax-table c-identifier-syntax-table
6556 (looking-at c-known-type-key))
6561 (goto-char (match-end 1))
6562 (c-forward-syntactic-ws)
6563 (setq pos (point))))
6566 ;; Looking at a primitive or known type identifier. We've
6567 ;; checked for a name first so that we don't go here if the
6568 ;; known type match only is a prefix of another name.
6570 (setq id-end (match-end 1))
6572 (when (and c-record-type-identifiers
6573 (or c-promote-possible-types (eq res t)))
6574 (c-record-type-id (cons (match-beginning 1) (match-end 1))))
6576 (if (and c-opt-type-component-key
6578 (looking-at c-opt-type-component-key)))
6579 ;; There might be more keywords for the type.
6581 (c-forward-keyword-clause 1)
6583 (setq safe-pos (point))
6584 (looking-at c-opt-type-component-key))
6585 (when (and c-record-type-identifiers
6586 (looking-at c-primitive-type-key))
6587 (c-record-type-id (cons (match-beginning 1)
6589 (c-forward-keyword-clause 1))
6590 (if (looking-at c-primitive-type-key)
6592 (when c-record-type-identifiers
6593 (c-record-type-id (cons (match-beginning 1)
6595 (c-forward-keyword-clause 1)
6597 (goto-char safe-pos)
6598 (setq res 'prefix)))
6599 (unless (save-match-data (c-forward-keyword-clause 1))
6602 (goto-char (match-end 1))
6603 (c-forward-syntactic-ws)))))
6606 (cond ((eq name-res t)
6607 ;; A normal identifier.
6609 (if (or res c-promote-possible-types)
6611 (c-add-type id-start id-end)
6612 (when (and c-record-type-identifiers id-range)
6613 (c-record-type-id id-range))
6616 (setq res (if (c-check-type id-start id-end)
6617 ;; It's an identifier that has been used as
6618 ;; a type somewhere else.
6620 ;; It's an identifier that might be a type.
6622 ((eq name-res 'template)
6623 ;; A template is sometimes a type.
6625 (c-forward-syntactic-ws)
6627 (if (eq (char-after) ?\()
6628 (if (c-check-type id-start id-end)
6629 ;; It's an identifier that has been used as
6630 ;; a type somewhere else.
6632 ;; It's an identifier that might be a type.
6636 ;; Otherwise it's an operator identifier, which is not a type.
6641 ;; Skip trailing type modifiers. If any are found we know it's
6643 (when c-opt-type-modifier-key
6644 (while (looking-at c-opt-type-modifier-key) ; e.g. "const", "volatile"
6645 (goto-char (match-end 1))
6646 (c-forward-syntactic-ws)
6649 ;; Step over any type suffix operator. Do not let the existence
6650 ;; of these alter the classification of the found type, since
6651 ;; these operators typically are allowed in normal expressions
6653 (when c-opt-type-suffix-key ; e.g. "..."
6654 (while (looking-at c-opt-type-suffix-key)
6655 (goto-char (match-end 1))
6656 (c-forward-syntactic-ws)))
6658 (when c-opt-type-concat-key ; Only/mainly for pike.
6659 ;; Look for a trailing operator that concatenates the type
6660 ;; with a following one, and if so step past that one through
6661 ;; a recursive call. Note that we don't record concatenated
6662 ;; types in `c-found-types' - it's the component types that
6663 ;; are recorded when appropriate.
6665 (let* ((c-promote-possible-types (or (memq res '(t known))
6666 c-promote-possible-types))
6667 ;; If we can't promote then set `c-record-found-types' so that
6668 ;; we can merge in the types from the second part afterwards if
6669 ;; it turns out to be a known type there.
6670 (c-record-found-types (and c-record-type-identifiers
6671 (not c-promote-possible-types)))
6673 (if (and (looking-at c-opt-type-concat-key)
6676 (goto-char (match-end 1))
6677 (c-forward-syntactic-ws)
6678 (setq subres (c-forward-type))))
6681 ;; If either operand certainly is a type then both are, but we
6682 ;; don't let the existence of the operator itself promote two
6683 ;; uncertain types to a certain one.
6686 (unless (eq name-res 'template)
6687 (c-add-type id-start id-end))
6688 (when (and c-record-type-identifiers id-range)
6689 (c-record-type-id id-range))
6700 (when (and (eq res t)
6701 (consp c-record-found-types))
6702 ;; Merge in the ranges of any types found by the second
6703 ;; `c-forward-type'.
6704 (setq c-record-type-identifiers
6705 ;; `nconc' doesn't mind that the tail of
6706 ;; `c-record-found-types' is t.
6707 (nconc c-record-found-types
6708 c-record-type-identifiers))))
6712 (when (and c-record-found-types (memq res '(known found)) id-range)
6713 (setq c-record-found-types
6714 (cons id-range c-record-found-types))))
6716 ;;(message "c-forward-type %s -> %s: %s" start (point) res)
6720 (defun c-forward-annotation ()
6721 ;; Used for Java code only at the moment. Assumes point is on the @, moves
6722 ;; forward an annotation and returns t. Leaves point unmoved and returns
6723 ;; nil if there is no annotation at point.
6724 (let ((pos (point)))
6726 (and (looking-at "@")
6727 (not (looking-at c-keywords-regexp))
6728 (progn (forward-char) t)
6729 (looking-at c-symbol-key)
6730 (progn (goto-char (match-end 0))
6731 (c-forward-syntactic-ws)
6733 (if (looking-at "(")
6736 (progn (goto-char pos) nil))))
6738 (defmacro c-pull-open-brace (ps)
6739 ;; Pull the next open brace from PS (which has the form of paren-state),
6740 ;; skipping over any brace pairs. Returns NIL when PS is exhausted.
6742 (while (consp (car ,ps))
6743 (setq ,ps (cdr ,ps)))
6745 (setq ,ps (cdr ,ps)))))
6747 (defun c-back-over-member-initializer-braces ()
6748 ;; Point is just after a closing brace/parenthesis. Try to parse this as a
6749 ;; C++ member initializer list, going back to just after the introducing ":"
6750 ;; and returning t. Otherwise return nil, leaving point unchanged.
6751 (let ((here (point)) res)
6754 (when (not (c-go-list-backward))
6756 (c-backward-syntactic-ws)
6757 (when (not (c-simple-skip-symbol-backward))
6759 (c-backward-syntactic-ws)
6761 (while (eq (char-before) ?,)
6763 (c-backward-syntactic-ws)
6764 (when (not (memq (char-before) '(?\) ?})))
6766 (when (not (c-go-list-backward))
6768 (c-backward-syntactic-ws)
6769 (when (not (c-simple-skip-symbol-backward))
6771 (c-backward-syntactic-ws))
6773 (eq (char-before) ?:)))
6774 (or res (goto-char here))
6777 (defmacro c-back-over-list-of-member-inits ()
6778 ;; Go back over a list of elements, each looking like:
6779 ;; <symbol> (<expression>) ,
6780 ;; or <symbol> {<expression>} ,
6781 ;; when we are putatively immediately after a comma. Stop when we don't see
6782 ;; a comma. If either of <symbol> or bracketed <expression> is missing,
6783 ;; throw nil to 'level. If the terminating } or ) is unmatched, throw nil
6784 ;; to 'done. This is not a general purpose macro!
6785 `(while (eq (char-before) ?,)
6787 (c-backward-syntactic-ws)
6788 (when (not (memq (char-before) '(?\) ?})))
6790 (when (not (c-go-list-backward))
6792 (c-backward-syntactic-ws)
6793 (when (not (c-simple-skip-symbol-backward))
6795 (c-backward-syntactic-ws)))
6797 (defun c-back-over-member-initializers ()
6798 ;; Test whether we are in a C++ member initializer list, and if so, go back
6799 ;; to the introducing ":", returning the position of the opening paren of
6800 ;; the function's arglist. Otherwise return nil, leaving point unchanged.
6801 (let ((here (point))
6802 (paren-state (c-parse-state))
6803 pos level-plausible at-top-level res)
6804 ;; Assume tentatively that we're at the top level. Try to go back to the
6808 (setq level-plausible
6810 (c-backward-syntactic-ws)
6811 (when (memq (char-before) '(?\) ?}))
6812 (when (not (c-go-list-backward))
6814 (c-backward-syntactic-ws))
6815 (when (c-simple-skip-symbol-backward)
6816 (c-backward-syntactic-ws))
6817 (c-back-over-list-of-member-inits)
6818 (and (eq (char-before) ?:)
6820 (c-backward-token-2)
6821 (not (looking-at c-:$-multichar-token-regexp)))
6822 (c-just-after-func-arglist-p))))
6824 (while (and (not (and level-plausible
6825 (setq at-top-level (c-at-toplevel-p))))
6826 (setq pos (c-pull-open-brace paren-state))) ; might be a paren.
6827 (setq level-plausible
6830 (c-backward-syntactic-ws)
6831 (when (not (c-simple-skip-symbol-backward))
6833 (c-backward-syntactic-ws)
6834 (c-back-over-list-of-member-inits)
6835 (and (eq (char-before) ?:)
6837 (c-backward-token-2)
6838 (not (looking-at c-:$-multichar-token-regexp)))
6839 (c-just-after-func-arglist-p)))))
6841 (and at-top-level level-plausible)))
6842 (or res (goto-char here))
6846 ;; Handling of large scale constructs like statements and declarations.
6848 ;; Macro used inside `c-forward-decl-or-cast-1'. It ought to be a
6849 ;; defsubst or perhaps even a defun, but it contains lots of free
6850 ;; variables that refer to things inside `c-forward-decl-or-cast-1'.
6851 (defmacro c-fdoc-shift-type-backward (&optional short)
6852 ;; `c-forward-decl-or-cast-1' can consume an arbitrary length list
6853 ;; of types when parsing a declaration, which means that it
6854 ;; sometimes consumes the identifier in the declaration as a type.
6855 ;; This is used to "backtrack" and make the last type be treated as
6856 ;; an identifier instead.
6859 ;; These identifiers are bound only in the inner let.
6860 '(setq identifier-type at-type
6861 identifier-start type-start
6865 got-suffix-after-parens id-start
6868 (if (setq at-type (if (eq backup-at-type 'prefix)
6871 (setq type-start backup-type-start
6872 id-start backup-id-start)
6873 (setq type-start start-pos
6874 id-start start-pos))
6876 ;; When these flags already are set we've found specifiers that
6877 ;; unconditionally signal these attributes - backtracking doesn't
6878 ;; change that. So keep them set in that case.
6880 (setq at-type-decl backup-at-type-decl))
6882 (setq maybe-typeless backup-maybe-typeless))
6885 ;; This identifier is bound only in the inner let.
6886 '(setq start id-start))))
6888 (defun c-forward-declarator (&optional limit accept-anon)
6889 ;; Assuming point is at the start of a declarator, move forward over it,
6890 ;; leaving point at the next token after it (e.g. a ) or a ; or a ,).
6892 ;; Return a list (ID-START ID-END BRACKETS-AFTER-ID GOT-INIT), where ID-START and
6893 ;; ID-END are the bounds of the declarator's identifier, and
6894 ;; BRACKETS-AFTER-ID is non-nil if a [...] pair is present after the id.
6895 ;; GOT-INIT is non-nil when the declarator is followed by "=" or "(".
6897 ;; If ACCEPT-ANON is non-nil, move forward over any "anonymous declarator",
6898 ;; i.e. something like the (*) in int (*), such as might be found in a
6899 ;; declaration. In such a case ID-START and ID-END in the return value are
6900 ;; both set to nil. A "null" "anonymous declarator" gives a non-nil result.
6902 ;; If no declarator is found, leave point unmoved and return nil. LIMIT is
6903 ;; an optional limit for forward searching.
6905 ;; Note that the global variable `c-last-identifier-range' is written to, so
6906 ;; the caller should bind it if necessary.
6908 ;; Inside the following "condition form", we move forward over the
6909 ;; declarator's identifier up as far as any opening bracket (for array
6910 ;; size) or paren (for parameters of function-type) or brace (for
6911 ;; array/struct initialization) or "=" or terminating delimiter
6912 ;; (e.g. "," or ";" or "}").
6913 (let ((here (point))
6914 id-start id-end brackets-after-id paren-depth)
6915 (or limit (setq limit (point-max)))
6919 ;; The following form moves forward over the declarator's
6920 ;; identifier (and what precedes it), returning t. If there
6921 ;; wasn't one, it returns nil.
6922 (let (got-identifier)
6923 (setq paren-depth 0)
6924 ;; Skip over type decl prefix operators, one for each iteration
6925 ;; of the while. These are, e.g. "*" in "int *foo" or "(" and
6926 ;; "*" in "int (*foo) (void)" (Note similar code in
6927 ;; `c-forward-decl-or-cast-1'.)
6930 ((looking-at c-decl-hangon-key)
6931 (c-forward-keyword-clause 1))
6932 ((and c-opt-cpp-prefix
6933 (looking-at c-noise-macro-with-parens-name-re))
6934 (c-forward-noise-clause))
6935 ((and (looking-at c-type-decl-prefix-key)
6936 (if (and (c-major-mode-is 'c++-mode)
6937 (match-beginning 3))
6938 ;; If the third submatch matches in C++ then
6939 ;; we're looking at an identifier that's a
6940 ;; prefix only if it specifies a member pointer.
6942 (setq id-start (point))
6944 (if (looking-at "\\(::\\)")
6945 ;; We only check for a trailing "::" and
6946 ;; let the "*" that should follow be
6947 ;; matched in the next round.
6949 ;; It turned out to be the real identifier,
6950 ;; so flag that and stop.
6951 (setq got-identifier t)
6954 (if (eq (char-after) ?\()
6956 (setq paren-depth (1+ paren-depth))
6958 (goto-char (match-end 1)))
6959 (c-forward-syntactic-ws)
6962 ;; If we haven't passed the identifier already, do it now.
6963 (unless got-identifier
6964 (setq id-start (point)))
6969 (c-backward-syntactic-ws)
6970 (setq id-end (point))))
6972 (setq id-start nil id-end nil)
6974 (t (/= (point) here))))
6976 ;; Skip out of the parens surrounding the identifier. If closing
6977 ;; parens are missing, this form returns nil.
6978 (or (= paren-depth 0)
6979 (c-safe (goto-char (scan-lists (point) 1 paren-depth))))
6983 ;; Skip over any trailing bit, such as "__attribute__".
6986 ((looking-at c-decl-hangon-key)
6987 (c-forward-keyword-clause 1))
6988 ((and c-opt-cpp-prefix
6989 (looking-at c-noise-macro-with-parens-name-re))
6990 (c-forward-noise-clause))))
6993 ;; Search syntactically to the end of the declarator (";",
6994 ;; ",", a closing paren, eob etc) or to the beginning of an
6995 ;; initializer or function prototype ("=" or "\\s\(").
6996 ;; Note that square brackets are now not also treated as
6997 ;; initializers, since this broke when there were also
6998 ;; initializing brace lists.
7001 (and (setq found (c-syntactic-re-search-forward
7002 "[;,]\\|\\s)\\|\\'\\|\\(=\\|\\s(\\)" limit t t))
7003 (eq (char-before) ?\[)
7004 (c-go-up-list-forward))
7005 (setq brackets-after-id t))
7008 (list id-start id-end brackets-after-id (match-beginning 1))
7013 (defun c-forward-decl-or-cast-1 (preceding-token-end context last-cast-end)
7014 ;; Move forward over a declaration or a cast if at the start of one.
7015 ;; The point is assumed to be at the start of some token. Nil is
7016 ;; returned if no declaration or cast is recognized, and the point
7017 ;; is clobbered in that case.
7019 ;; If a declaration is parsed:
7021 ;; The point is left at the first token after the first complete
7022 ;; declarator, if there is one. The return value is a cons where
7023 ;; the car is the position of the first token in the declarator. (See
7024 ;; below for the cdr.)
7027 ;; void foo (int a, char *b) stuff ...
7031 ;; unsigned int a = c_style_initializer, b;
7033 ;; unsigned int a (cplusplus_style_initializer), b;
7034 ;; car ^ ^ point (might change)
7035 ;; class Foo : public Bar {}
7037 ;; class PikeClass (int a, string b) stuff ...
7043 ;; void cplusplus_function (int x) throw (Bad);
7045 ;; Foo::Foo (int b) : Base (b) {}
7050 ;; auto cplusplus_11 (int a, char *b) -> decltype (bar):
7055 ;; The cdr of the return value is non-nil when a
7056 ;; `c-typedef-decl-kwds' specifier is found in the declaration.
7057 ;; Specifically it is a dotted pair (A . B) where B is t when a
7058 ;; `c-typedef-kwds' ("typedef") is present, and A is t when some
7059 ;; other `c-typedef-decl-kwds' (e.g. class, struct, enum)
7060 ;; specifier is present. I.e., (some of) the declared
7061 ;; identifier(s) are types.
7063 ;; If a cast is parsed:
7065 ;; The point is left at the first token after the closing paren of
7066 ;; the cast. The return value is `cast'. Note that the start
7067 ;; position must be at the first token inside the cast parenthesis
7070 ;; PRECEDING-TOKEN-END is the first position after the preceding
7071 ;; token, i.e. on the other side of the syntactic ws from the point.
7072 ;; Use a value less than or equal to (point-min) if the point is at
7073 ;; the first token in (the visible part of) the buffer.
7075 ;; CONTEXT is a symbol that describes the context at the point:
7076 ;; 'decl In a comma-separated declaration context (typically
7077 ;; inside a function declaration arglist).
7078 ;; '<> In an angle bracket arglist.
7079 ;; 'arglist Some other type of arglist.
7080 ;; nil Some other context or unknown context. Includes
7081 ;; within the parens of an if, for, ... construct.
7083 ;; LAST-CAST-END is the first token after the closing paren of a
7084 ;; preceding cast, or nil if none is known. If
7085 ;; `c-forward-decl-or-cast-1' is used in succession, it should be
7086 ;; the position after the closest preceding call where a cast was
7087 ;; matched. In that case it's used to discover chains of casts like
7090 ;; This function records identifier ranges on
7091 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
7092 ;; `c-record-type-identifiers' is non-nil.
7094 ;; This function might do hidden buffer changes.
7096 (let (;; `start-pos' is used below to point to the start of the
7097 ;; first type, i.e. after any leading specifiers. It might
7098 ;; also point at the beginning of the preceding syntactic
7101 ;; Set to the result of `c-forward-type'.
7103 ;; The position of the first token in what we currently
7104 ;; believe is the type in the declaration or cast, after any
7105 ;; specifiers and their associated clauses.
7107 ;; The position of the first token in what we currently
7108 ;; believe is the declarator for the first identifier. Set
7109 ;; when the type is found, and moved forward over any
7110 ;; `c-decl-hangon-kwds' and their associated clauses that
7111 ;; occurs after the type.
7113 ;; These store `at-type', `type-start' and `id-start' of the
7114 ;; identifier before the one in those variables. The previous
7115 ;; identifier might turn out to be the real type in a
7116 ;; declaration if the last one has to be the declarator in it.
7117 ;; If `backup-at-type' is nil then the other variables have
7118 ;; undefined values.
7119 backup-at-type backup-type-start backup-id-start
7120 ;; This stores `kwd-sym' of the symbol before the current one.
7121 ;; This is needed to distinguish the C++11 version of "auto" from
7122 ;; the pre C++11 meaning.
7124 ;; Set if we've found a specifier (apart from "typedef") that makes
7125 ;; the defined identifier(s) types.
7127 ;; Set if we've a "typedef" keyword.
7129 ;; Set if we've found a specifier that can start a declaration
7130 ;; where there's no type.
7132 ;; Save the value of kwd-sym between loops of the "Check for a
7133 ;; type" loop. Needed to distinguish a C++11 "auto" from a pre
7136 ;; If a specifier is found that also can be a type prefix,
7137 ;; these flags are set instead of those above. If we need to
7138 ;; back up an identifier, they are copied to the real flag
7139 ;; variables. Thus they only take effect if we fail to
7140 ;; interpret it as a type.
7141 backup-at-type-decl backup-maybe-typeless
7142 ;; Whether we've found a declaration or a cast. We might know
7143 ;; this before we've found the type in it. It's 'ids if we've
7144 ;; found two consecutive identifiers (usually a sure sign, but
7145 ;; we should allow that in labels too), and t if we've found a
7146 ;; specifier keyword (a 100% sure sign).
7148 ;; Set when we need to back up to parse this as a declaration
7149 ;; but not as a cast.
7151 ;; For casts, the return position.
7153 ;; Have we got a new-style C++11 "auto"?
7155 ;; Set when the symbol before `preceding-token-end' is known to
7156 ;; terminate the previous construct, or when we're at point-min.
7158 ;; Save `c-record-type-identifiers' and
7159 ;; `c-record-ref-identifiers' since ranges are recorded
7160 ;; speculatively and should be thrown away if it turns out
7161 ;; that it isn't a declaration or cast.
7162 (save-rec-type-ids c-record-type-identifiers)
7163 (save-rec-ref-ids c-record-ref-identifiers))
7166 (goto-char preceding-token-end)
7169 (let ((tok-end (point)))
7170 (c-backward-token-2)
7171 (member (buffer-substring-no-properties (point) tok-end)
7172 c-pre-start-tokens)))))
7174 (while (c-forward-annotation)
7175 (c-forward-syntactic-ws))
7177 ;; Check for a type. Unknown symbols are treated as possible
7178 ;; types, but they could also be specifiers disguised through
7179 ;; macros like __INLINE__, so we recognize both types and known
7180 ;; specifiers after them too.
7182 (let* ((start (point)) kwd-sym kwd-clause-end found-type noise-start)
7185 ;; Look for a specifier keyword clause.
7186 ((or (looking-at c-prefix-spec-kwds-re)
7187 (and (c-major-mode-is 'java-mode)
7188 (looking-at "@[A-Za-z0-9]+")))
7190 (if (looking-at c-typedef-key)
7191 (setq at-typedef t)))
7192 (setq kwd-sym (c-keyword-sym (match-string 1)))
7194 (c-forward-keyword-clause 1)
7195 (setq kwd-clause-end (point))))
7196 ((and c-opt-cpp-prefix
7197 (looking-at c-noise-macro-with-parens-name-re))
7198 (setq noise-start (point))
7199 (c-forward-noise-clause)
7200 (setq kwd-clause-end (point))))
7202 (when (setq found-type (c-forward-type t)) ; brace-block-too
7203 ;; Found a known or possible type or a prefix of a known type.
7204 (when (and (c-major-mode-is 'c++-mode) ; C++11 style "auto"?
7205 (eq prev-kwd-sym (c-keyword-sym "auto"))
7206 (looking-at "[=(]")) ; FIXME!!! proper regexp.
7207 (setq new-style-auto t)
7208 (setq found-type nil)
7209 (goto-char start)) ; position of foo in "auto foo"
7212 ;; Got two identifiers with nothing but whitespace
7213 ;; between them. That can only happen in declarations.
7214 (setq at-decl-or-cast 'ids)
7216 (when (eq at-type 'found)
7217 ;; If the previous identifier is a found type we
7218 ;; record it as a real one; it might be some sort of
7219 ;; alias for a prefix like "unsigned".
7221 (goto-char type-start)
7222 (let ((c-promote-possible-types t))
7223 (c-forward-type)))))
7225 (setq backup-at-type at-type
7226 backup-type-start type-start
7227 backup-id-start id-start
7228 backup-kwd-sym kwd-sym
7232 ;; The previous ambiguous specifier/type turned out
7233 ;; to be a type since we've parsed another one after
7234 ;; it, so clear these backup flags.
7235 backup-at-type-decl nil
7236 backup-maybe-typeless nil))
7238 (if (or kwd-sym noise-start)
7240 ;; Handle known specifier keywords and
7241 ;; `c-decl-hangon-kwds' which can occur after known
7244 (if (or (c-keyword-member kwd-sym 'c-decl-hangon-kwds)
7246 ;; It's a hang-on keyword or noise clause that can occur
7250 ;; Move the identifier start position if
7251 ;; we've passed a type.
7252 (setq id-start kwd-clause-end)
7253 ;; Otherwise treat this as a specifier and
7254 ;; move the fallback position.
7255 (setq start-pos kwd-clause-end))
7256 (goto-char kwd-clause-end))
7258 ;; It's an ordinary specifier so we know that
7259 ;; anything before this can't be the type.
7260 (setq backup-at-type nil
7261 start-pos kwd-clause-end)
7264 ;; It's ambiguous whether this keyword is a
7265 ;; specifier or a type prefix, so set the backup
7266 ;; flags. (It's assumed that `c-forward-type'
7267 ;; moved further than `c-forward-keyword-clause'.)
7269 (when (c-keyword-member kwd-sym 'c-typedef-decl-kwds)
7270 (setq backup-at-type-decl t))
7271 (when (c-keyword-member kwd-sym 'c-typeless-decl-kwds)
7272 (setq backup-maybe-typeless t)))
7274 (when (c-keyword-member kwd-sym 'c-typedef-decl-kwds)
7275 ;; This test only happens after we've scanned a type.
7276 ;; So, with valid syntax, kwd-sym can't be 'typedef.
7277 (setq at-type-decl t))
7278 (when (c-keyword-member kwd-sym 'c-typeless-decl-kwds)
7279 (setq maybe-typeless t))
7281 ;; Haven't matched a type so it's an unambiguous
7282 ;; specifier keyword and we know we're in a
7284 (setq at-decl-or-cast t)
7285 (setq prev-kwd-sym kwd-sym)
7287 (goto-char kwd-clause-end))))
7289 ;; If the type isn't known we continue so that we'll jump
7290 ;; over all specifiers and type identifiers. The reason
7291 ;; to do this for a known type prefix is to make things
7292 ;; like "unsigned INT16" work.
7293 (and found-type (not (eq found-type t))))))
7297 ;; If a known type was found, we still need to skip over any
7298 ;; hangon keyword clauses after it. Otherwise it has already
7299 ;; been done in the loop above.
7301 (cond ((looking-at c-decl-hangon-key)
7302 (c-forward-keyword-clause 1))
7303 ((and c-opt-cpp-prefix
7304 (looking-at c-noise-macro-with-parens-name-re))
7305 (c-forward-noise-clause))))
7306 (setq id-start (point)))
7308 ((eq at-type 'prefix)
7309 ;; A prefix type is itself a primitive type when it's not
7310 ;; followed by another type.
7314 ;; Got no type but set things up to continue anyway to handle
7315 ;; the various cases when a declaration doesn't start with a
7317 (setq id-start start-pos))
7319 ((and (eq at-type 'maybe)
7320 (c-major-mode-is 'c++-mode))
7321 ;; If it's C++ then check if the last "type" ends on the form
7322 ;; "foo::foo" or "foo::~foo", i.e. if it's the name of a
7323 ;; (con|de)structor.
7325 (let (name end-2 end-1)
7326 (goto-char id-start)
7327 (c-backward-syntactic-ws)
7328 (setq end-2 (point))
7330 (c-simple-skip-symbol-backward)
7333 (buffer-substring-no-properties (point) end-2))
7334 ;; Cheating in the handling of syntactic ws below.
7335 (< (skip-chars-backward ":~ \t\n\r\v\f") 0))
7337 (setq end-1 (point))
7338 (c-simple-skip-symbol-backward))
7339 (>= (point) type-start)
7340 (equal (buffer-substring-no-properties (point) end-1)
7342 ;; It is a (con|de)structor name. In that case the
7343 ;; declaration is typeless so zap out any preceding
7344 ;; identifier(s) that we might have taken as types.
7345 (goto-char type-start)
7348 id-start type-start))))))
7350 ;; Check for and step over a type decl expression after the thing
7351 ;; that is or might be a type. This can't be skipped since we
7352 ;; need the correct end position of the declarator for
7353 ;; `max-type-decl-end-*'.
7354 (let ((start (point)) (paren-depth 0) pos
7355 ;; True if there's a non-open-paren match of
7356 ;; `c-type-decl-prefix-key'.
7358 ;; True if the declarator is surrounded by a parenthesis pair.
7360 ;; True if there is an identifier in the declarator.
7362 ;; True if there's a non-close-paren match of
7363 ;; `c-type-decl-suffix-key'.
7365 ;; True if there's a prefix match outside the outermost
7366 ;; paren pair that surrounds the declarator.
7367 got-prefix-before-parens
7368 ;; True if there's a suffix match outside the outermost
7369 ;; paren pair that surrounds the declarator. The value is
7370 ;; the position of the first suffix match.
7371 got-suffix-after-parens
7372 ;; True if we've parsed the type decl to a token that is
7373 ;; known to end declarations in this context.
7375 ;; The earlier values of `at-type' and `type-start' if we've
7376 ;; shifted the type backwards.
7377 identifier-type identifier-start
7378 ;; If `c-parse-and-markup-<>-arglists' is set we need to
7379 ;; turn it off during the name skipping below to avoid
7380 ;; getting `c-type' properties that might be bogus. That
7381 ;; can happen since we don't know if
7382 ;; `c-restricted-<>-arglists' will be correct inside the
7383 ;; arglist paren that gets entered.
7384 c-parse-and-markup-<>-arglists
7385 ;; Start of the identifier for which `got-identifier' was set.
7388 (goto-char id-start)
7390 ;; Skip over type decl prefix operators. (Note similar code in
7391 ;; `c-forward-declarator'.)
7392 (if (and c-recognize-typeless-decls
7393 (equal c-type-decl-prefix-key "\\<\\>"))
7394 (when (eq (char-after) ?\()
7396 (setq paren-depth (1+ paren-depth))
7398 (while (and (looking-at c-type-decl-prefix-key)
7399 (if (and (c-major-mode-is 'c++-mode)
7400 (match-beginning 3))
7401 ;; If the third submatch matches in C++ then
7402 ;; we're looking at an identifier that's a
7403 ;; prefix only if it specifies a member pointer.
7404 (when (progn (setq pos (point))
7405 (setq got-identifier (c-forward-name)))
7406 (setq name-start pos)
7407 (if (looking-at "\\(::\\)")
7408 ;; We only check for a trailing "::" and
7409 ;; let the "*" that should follow be
7410 ;; matched in the next round.
7411 (progn (setq got-identifier nil) t)
7412 ;; It turned out to be the real identifier,
7417 (if (eq (char-after) ?\()
7419 (setq paren-depth (1+ paren-depth))
7421 (unless got-prefix-before-parens
7422 (setq got-prefix-before-parens (= paren-depth 0)))
7424 (goto-char (match-end 1)))
7425 (c-forward-syntactic-ws)))
7427 (setq got-parens (> paren-depth 0))
7429 ;; Skip over an identifier.
7431 (and (looking-at c-identifier-start)
7433 (setq got-identifier (c-forward-name))
7434 (setq name-start pos)))
7436 ;; Skip over type decl suffix operators and trailing noise macros.
7439 ((and c-opt-cpp-prefix
7440 (looking-at c-noise-macro-with-parens-name-re))
7441 (c-forward-noise-clause))
7443 ((looking-at c-type-decl-suffix-key)
7444 (if (eq (char-after) ?\))
7445 (when (> paren-depth 0)
7446 (setq paren-depth (1- paren-depth))
7449 (when (if (save-match-data (looking-at "\\s("))
7450 (c-safe (c-forward-sexp 1) t)
7451 (goto-char (match-end 1))
7453 (when (and (not got-suffix-after-parens)
7455 (setq got-suffix-after-parens (match-beginning 0)))
7456 (setq got-suffix t))))
7459 ;; No suffix matched. We might have matched the
7460 ;; identifier as a type and the open paren of a
7461 ;; function arglist as a type decl prefix. In that
7462 ;; case we should "backtrack": Reinterpret the last
7463 ;; type as the identifier, move out of the arglist and
7464 ;; continue searching for suffix operators.
7466 ;; Do this even if there's no preceding type, to cope
7467 ;; with old style function declarations in K&R C,
7468 ;; (con|de)structors in C++ and `c-typeless-decl-kwds'
7469 ;; style declarations. That isn't applicable in an
7470 ;; arglist context, though.
7471 (when (and (= paren-depth 1)
7472 (not got-prefix-before-parens)
7473 (not (eq at-type t))
7476 backup-maybe-typeless
7477 (when c-recognize-typeless-decls
7479 (setq pos (c-up-list-forward (point)))
7480 (eq (char-before pos) ?\)))
7481 (c-fdoc-shift-type-backward)
7485 (c-forward-syntactic-ws))
7487 (when (or (and new-style-auto
7488 (looking-at c-auto-ops-re))
7489 (and (or maybe-typeless backup-maybe-typeless)
7490 (not got-identifier)
7493 ;; Have found no identifier but `c-typeless-decl-kwds' has
7494 ;; matched so we know we're inside a declaration. The
7495 ;; preceding type must be the identifier instead.
7496 (c-fdoc-shift-type-backward))
7498 ;; Prepare the "-> type;" for fontification later on.
7499 (when (and new-style-auto
7500 (looking-at c-haskell-op-re))
7502 (goto-char (match-end 0))
7503 (c-forward-syntactic-ws)
7504 (setq type-start (point))
7505 (setq at-type (c-forward-type))))
7509 (catch 'at-decl-or-cast
7512 (when (> paren-depth 0)
7513 ;; Encountered something inside parens that isn't matched by
7514 ;; the `c-type-decl-*' regexps, so it's not a type decl
7515 ;; expression. Try to skip out to the same paren depth to
7516 ;; not confuse the cast check below.
7517 (c-safe (goto-char (scan-lists (point) 1 paren-depth)))
7518 ;; If we've found a specifier keyword then it's a
7519 ;; declaration regardless.
7520 (throw 'at-decl-or-cast (eq at-decl-or-cast t)))
7523 (looking-at (cond ((eq context '<>) "[,>]")
7527 ;; Now we've collected info about various characteristics of
7528 ;; the construct we're looking at. Below follows a decision
7529 ;; tree based on that. It's ordered to check more certain
7530 ;; signs before less certain ones.
7536 (when (and (or at-type maybe-typeless)
7537 (not (or got-prefix got-parens)))
7538 ;; Got another identifier directly after the type, so it's a
7540 (throw 'at-decl-or-cast t))
7542 (when (and got-parens
7544 ;; (not got-suffix-after-parens)
7547 backup-maybe-typeless
7548 (eq at-decl-or-cast t)
7550 (goto-char name-start)
7551 (not (memq (c-forward-type) '(nil maybe))))))
7552 ;; Got a declaration of the form "foo bar (gnu);" or "bar
7553 ;; (gnu);" where we've recognized "bar" as the type and "gnu"
7554 ;; as the declarator. In this case it's however more likely
7555 ;; that "bar" is the declarator and "gnu" a function argument
7556 ;; or initializer (if `c-recognize-paren-inits' is set),
7557 ;; since the parens around "gnu" would be superfluous if it's
7558 ;; a declarator. Shift the type one step backward.
7559 (c-fdoc-shift-type-backward)))
7561 ;; Found no identifier.
7567 (when (= (point) start)
7568 ;; Got a plain list of identifiers. If a colon follows it's
7569 ;; a valid label, or maybe a bitfield. Otherwise the last
7570 ;; one probably is the declared identifier and we should
7571 ;; back up to the previous type, providing it isn't a cast.
7572 (if (and (eq (char-after) ?:)
7573 (not (c-major-mode-is 'java-mode)))
7575 ;; If we've found a specifier keyword then it's a
7576 ;; declaration regardless.
7577 ((eq at-decl-or-cast t)
7578 (throw 'at-decl-or-cast t))
7579 ((and c-has-bitfields
7580 (eq at-decl-or-cast 'ids)) ; bitfield.
7581 (setq backup-if-not-cast t)
7582 (throw 'at-decl-or-cast t)))
7584 (setq backup-if-not-cast t)
7585 (throw 'at-decl-or-cast t)))
7588 (when (and got-suffix
7591 ;; Got a plain list of identifiers followed by some suffix.
7592 ;; If this isn't a cast then the last identifier probably is
7593 ;; the declared one and we should back up to the previous
7595 (setq backup-if-not-cast t)
7596 (throw 'at-decl-or-cast t)))
7599 (when (eq at-type t)
7600 ;; If the type is known we know that there can't be any
7601 ;; identifier somewhere else, and it's only in declarations in
7602 ;; e.g. function prototypes and in casts that the identifier may
7604 (throw 'at-decl-or-cast t))
7606 (when (= (point) start)
7607 ;; Only got a single identifier (parsed as a type so far).
7610 ;; Check that the identifier isn't at the start of an
7615 ;; Inside an arglist that contains declarations. If K&R
7616 ;; style declarations and parenthesis style initializers
7617 ;; aren't allowed then the single identifier must be a
7618 ;; type, else we require that it's known or found
7619 ;; (primitive types are handled above).
7620 (or (and (not c-recognize-knr-p)
7621 (not c-recognize-paren-inits))
7622 (memq at-type '(known found))))
7624 ;; Inside a template arglist. Accept known and found
7625 ;; types; other identifiers could just as well be
7626 ;; constants in C++.
7627 (memq at-type '(known found)))))
7628 (throw 'at-decl-or-cast t)
7630 ;; Can't be a valid declaration or cast, but if we've found a
7631 ;; specifier it can't be anything else either, so treat it as
7632 ;; an invalid/unfinished declaration or cast.
7633 (throw 'at-decl-or-cast at-decl-or-cast))))
7638 (not (eq at-type t))
7641 backup-maybe-typeless
7642 (when c-recognize-typeless-decls
7643 (or (not got-suffix)
7645 c-after-suffixed-type-maybe-decl-key))))))
7646 ;; Got an empty paren pair and a preceding type that probably
7647 ;; really is the identifier. Shift the type backwards to make
7648 ;; the last one the identifier. This is analogous to the
7649 ;; "backtracking" done inside the `c-type-decl-suffix-key' loop
7652 ;; Exception: In addition to the conditions in that
7653 ;; "backtracking" code, do not shift backward if we're not
7654 ;; looking at either `c-after-suffixed-type-decl-key' or "[;,]".
7655 ;; Since there's no preceding type, the shift would mean that
7656 ;; the declaration is typeless. But if the regexp doesn't match
7657 ;; then we will simply fall through in the tests below and not
7658 ;; recognize it at all, so it's better to try it as an abstract
7659 ;; declarator instead.
7660 (c-fdoc-shift-type-backward)
7662 ;; Still no identifier.
7664 (when (and got-prefix (or got-parens got-suffix))
7665 ;; Require `got-prefix' together with either `got-parens' or
7666 ;; `got-suffix' to recognize it as an abstract declarator:
7667 ;; `got-parens' only is probably an empty function call.
7668 ;; `got-suffix' only can build an ordinary expression together
7669 ;; with the preceding identifier which we've taken as a type.
7670 ;; We could actually accept on `got-prefix' only, but that can
7671 ;; easily occur temporarily while writing an expression so we
7672 ;; avoid that case anyway. We could do a better job if we knew
7673 ;; the point when the fontification was invoked.
7674 (throw 'at-decl-or-cast t))
7680 got-suffix-after-parens
7681 (eq (char-after got-suffix-after-parens) ?\())
7682 ;; Got a type, no declarator but a paren suffix. I.e. it's a
7683 ;; normal function call after all (or perhaps a C++ style object
7684 ;; instantiation expression).
7685 (throw 'at-decl-or-cast nil))))
7688 (when at-decl-or-cast
7689 ;; By now we've located the type in the declaration that we know
7691 (throw 'at-decl-or-cast t))
7694 (when (and got-identifier
7696 (looking-at c-after-suffixed-type-decl-key)
7700 (not (eq at-type t)))
7701 ;; Shift the type backward in the case that there's a
7702 ;; single identifier inside parens. That can only
7703 ;; occur in K&R style function declarations so it's
7704 ;; more likely that it really is a function call.
7705 ;; Therefore we only do this after
7706 ;; `c-after-suffixed-type-decl-key' has matched.
7707 (progn (c-fdoc-shift-type-backward) t)
7708 got-suffix-after-parens))
7709 ;; A declaration according to `c-after-suffixed-type-decl-key'.
7710 (throw 'at-decl-or-cast t))
7713 (when (and (or got-prefix (not got-parens))
7714 (memq at-type '(t known)))
7715 ;; It's a declaration if a known type precedes it and it can't be a
7717 (throw 'at-decl-or-cast t))
7719 ;; If we get here we can't tell if this is a type decl or a normal
7720 ;; expression by looking at it alone. (That's under the assumption
7721 ;; that normal expressions always can look like type decl expressions,
7722 ;; which isn't really true but the cases where it doesn't hold are so
7723 ;; uncommon (e.g. some placements of "const" in C++) it's not worth
7724 ;; the effort to look for them.)
7726 ;;; 2008-04-16: commented out the next form, to allow the function to recognize
7727 ;;; "foo (int bar)" in CC (an implicit type (in class foo) without a semicolon)
7728 ;;; as a(n almost complete) declaration, enabling it to be fontified.
7730 ;; (unless (or at-decl-end (looking-at "=[^=]"))
7731 ;; If this is a declaration it should end here or its initializer(*)
7732 ;; should start here, so check for allowed separation tokens. Note
7733 ;; that this rule doesn't work e.g. with a K&R arglist after a
7736 ;; *) Don't check for C++ style initializers using parens
7737 ;; since those already have been matched as suffixes.
7739 ;; If `at-decl-or-cast' is then we've found some other sign that
7740 ;; it's a declaration or cast, so then it's probably an
7741 ;; invalid/unfinished one.
7742 ;; (throw 'at-decl-or-cast at-decl-or-cast))
7744 ;; Below are tests that only should be applied when we're certain to
7745 ;; not have parsed halfway through an expression.
7748 (when (memq at-type '(t known))
7749 ;; The expression starts with a known type so treat it as a
7751 (throw 'at-decl-or-cast t))
7754 (when (and (c-major-mode-is 'c++-mode)
7755 ;; In C++ we check if the identifier is a known type, since
7756 ;; (con|de)structors use the class name as identifier.
7757 ;; We've always shifted over the identifier as a type and
7758 ;; then backed up again in this case.
7760 (or (memq identifier-type '(found known))
7761 (and (eq (char-after identifier-start) ?~)
7762 ;; `at-type' probably won't be 'found for
7763 ;; destructors since the "~" is then part of the
7764 ;; type name being checked against the list of
7765 ;; known types, so do a check without that
7768 (goto-char (1+ identifier-start))
7769 (c-forward-syntactic-ws)
7770 (c-with-syntax-table
7771 c-identifier-syntax-table
7772 (looking-at c-known-type-key)))
7774 (goto-char (1+ identifier-start))
7775 ;; We have already parsed the type earlier,
7776 ;; so it'd be possible to cache the end
7777 ;; position instead of redoing it here, but
7778 ;; then we'd need to keep track of another
7779 ;; position everywhere.
7780 (c-check-type (point)
7781 (progn (c-forward-type)
7783 (throw 'at-decl-or-cast t))
7788 (when (and got-prefix-before-parens
7790 (or at-decl-end (looking-at "=[^=]"))
7792 (or (not got-suffix)
7794 ;; Got something like "foo * bar;". Since we're not inside
7795 ;; an arglist it would be a meaningless expression because
7796 ;; the result isn't used. We therefore choose to recognize
7797 ;; it as a declaration. We only allow a suffix (which makes
7798 ;; the construct look like a function call) when
7799 ;; `at-decl-start' provides additional evidence that we do
7800 ;; have a declaration.
7801 (throw 'at-decl-or-cast t))
7804 (when (and (or got-suffix-after-parens
7805 (looking-at "=[^=]"))
7807 (not (eq context 'arglist)))
7808 ;; Got something like "a (*b) (c);" or "a (b) = c;". It could
7809 ;; be an odd expression or it could be a declaration. Treat
7810 ;; it as a declaration if "a" has been used as a type
7811 ;; somewhere else (if it's a known type we won't get here).
7812 (throw 'at-decl-or-cast t)))
7817 (and (eq context 'decl)
7818 (not c-recognize-paren-inits)
7819 (or got-parens got-suffix))))
7820 ;; Got a type followed by an abstract declarator. If `got-prefix'
7821 ;; is set it's something like "a *" without anything after it. If
7822 ;; `got-parens' or `got-suffix' is set it's "a()", "a[]", "a()[]",
7823 ;; or similar, which we accept only if the context rules out
7825 (throw 'at-decl-or-cast t)))
7827 ;; If we had a complete symbol table here (which rules out
7828 ;; `c-found-types') we should return t due to the disambiguation rule
7829 ;; (in at least C++) that anything that can be parsed as a declaration
7830 ;; is a declaration. Now we're being more defensive and prefer to
7831 ;; highlight things like "foo (bar);" as a declaration only if we're
7832 ;; inside an arglist that contains declarations.
7834 (eq context 'decl))))
7836 ;; The point is now after the type decl expression.
7839 ;; Check for a cast.
7844 ;; Should be the first type/identifier in a cast paren.
7845 (> preceding-token-end (point-min))
7846 (memq (char-before preceding-token-end) c-cast-parens)
7848 ;; The closing paren should follow.
7850 (c-forward-syntactic-ws)
7851 (looking-at "\\s)"))
7853 ;; There should be a primary expression after it.
7856 (c-forward-syntactic-ws)
7857 (setq cast-end (point))
7858 (and (looking-at c-primary-expr-regexp)
7860 (setq pos (match-end 0))
7862 ;; Check if the expression begins with a prefix keyword.
7864 (if (match-beginning 1)
7865 ;; Expression begins with an ambiguous operator. Treat
7866 ;; it as a cast if it's a type decl or if we've
7867 ;; recognized the type somewhere else.
7869 (memq at-type '(t known found)))
7870 ;; Unless it's a keyword, it's the beginning of a primary
7872 (not (looking-at c-keywords-regexp)))))
7873 ;; If `c-primary-expr-regexp' matched a nonsymbol token, check
7874 ;; that it matched a whole one so that we don't e.g. confuse
7875 ;; the operator '-' with '->'. It's ok if it matches further,
7876 ;; though, since it e.g. can match the float '.5' while the
7877 ;; operator regexp only matches '.'.
7878 (or (not (looking-at c-nonsymbol-token-regexp))
7879 (<= (match-end 0) pos))))
7881 ;; There should either be a cast before it or something that isn't an
7882 ;; identifier or close paren.
7883 (> preceding-token-end (point-min))
7885 (goto-char (1- preceding-token-end))
7886 (or (eq (point) last-cast-end)
7888 (c-backward-syntactic-ws)
7889 (if (< (skip-syntax-backward "w_") 0)
7890 ;; It's a symbol. Accept it only if it's one of the
7891 ;; keywords that can precede an expression (without
7892 ;; surrounding parens).
7893 (looking-at c-simple-stmt-key)
7895 ;; Check that it isn't a close paren (block close is ok,
7897 (not (memq (char-before) '(?\) ?\])))
7898 ;; Check that it isn't a nonsymbol identifier.
7899 (not (c-on-identifier)))))))))
7902 (when (and c-record-type-identifiers at-type (not (eq at-type t)))
7903 (let ((c-promote-possible-types t))
7904 (goto-char type-start)
7907 (goto-char cast-end)
7911 ;; We're at a declaration. Highlight the type and the following
7914 (when backup-if-not-cast
7915 (c-fdoc-shift-type-backward t))
7917 (when (and (eq context 'decl) (looking-at ","))
7918 ;; Make sure to propagate the `c-decl-arg-start' property to
7919 ;; the next argument if it's set in this one, to cope with
7920 ;; interactive refontification.
7921 (c-put-c-type-property (point) 'c-decl-arg-start))
7923 ;; Record the type's coordinates in `c-record-type-identifiers' for
7924 ;; later fontification.
7925 (when (and c-record-type-identifiers at-type ;; (not (eq at-type t))
7926 ;; There seems no reason to exclude a token from
7927 ;; fontification just because it's "a known type that can't
7928 ;; be a name or other expression". 2013-09-18.
7930 (let ((c-promote-possible-types t))
7932 (goto-char type-start)
7936 (and (or at-type-decl at-typedef)
7937 (cons at-type-decl at-typedef))))
7940 ;; False alarm. Restore the recorded ranges.
7941 (setq c-record-type-identifiers save-rec-type-ids
7942 c-record-ref-identifiers save-rec-ref-ids)
7945 (defun c-forward-label (&optional assume-markup preceding-token-end limit)
7946 ;; Assuming that point is at the beginning of a token, check if it starts a
7947 ;; label and if so move over it and return non-nil (t in default situations,
7948 ;; specific symbols (see below) for interesting situations), otherwise don't
7949 ;; move and return nil. "Label" here means "most things with a colon".
7951 ;; More precisely, a "label" is regarded as one of:
7952 ;; (i) a goto target like "foo:" - returns the symbol `goto-target';
7953 ;; (ii) A case label - either the entire construct "case FOO:", or just the
7954 ;; bare "case", should the colon be missing. We return t;
7955 ;; (iii) a keyword which needs a colon, like "default:" or "private:"; We
7957 ;; (iv) One of QT's "extended" C++ variants of
7958 ;; "private:"/"protected:"/"public:"/"more:" looking like "public slots:".
7959 ;; Returns the symbol `qt-2kwds-colon'.
7960 ;; (v) QT's construct "signals:". Returns the symbol `qt-1kwd-colon'.
7961 ;; (vi) One of the keywords matched by `c-opt-extra-label-key' (without any
7962 ;; colon). Currently (2006-03), this applies only to Objective C's
7963 ;; keywords "@private", "@protected", and "@public". Returns t.
7965 ;; One of the things which will NOT be recognized as a label is a bit-field
7966 ;; element of a struct, something like "int foo:5".
7968 ;; The end of the label is taken to be just after the colon, or the end of
7969 ;; the first submatch in `c-opt-extra-label-key'. The point is directly
7970 ;; after the end on return. The terminating char gets marked with
7971 ;; `c-decl-end' to improve recognition of the following declaration or
7974 ;; If ASSUME-MARKUP is non-nil, it's assumed that the preceding
7975 ;; label, if any, has already been marked up like that.
7977 ;; If PRECEDING-TOKEN-END is given, it should be the first position
7978 ;; after the preceding token, i.e. on the other side of the
7979 ;; syntactic ws from the point. Use a value less than or equal to
7980 ;; (point-min) if the point is at the first token in (the visible
7981 ;; part of) the buffer.
7983 ;; The optional LIMIT limits the forward scan for the colon.
7985 ;; This function records the ranges of the label symbols on
7986 ;; `c-record-ref-identifiers' if `c-record-type-identifiers' (!) is
7989 ;; This function might do hidden buffer changes.
7991 (let ((start (point))
7994 macro-start ; if we're in one.
7998 ;; "case" or "default" (Doesn't apply to AWK).
7999 ((looking-at c-label-kwds-regexp)
8000 (let ((kwd-end (match-end 1)))
8001 ;; Record only the keyword itself for fontification, since in
8002 ;; case labels the following is a constant expression and not
8004 (when c-record-type-identifiers
8005 (c-record-ref-id (cons (match-beginning 1) kwd-end)))
8007 ;; Find the label end.
8010 (if (and (c-syntactic-re-search-forward
8011 ;; Stop on chars that aren't allowed in expressions,
8012 ;; and on operator chars that would be meaningless
8013 ;; there. FIXME: This doesn't cope with ?: operators.
8014 "[;{=,@]\\|\\(\\=\\|[^:]\\):\\([^:]\\|\\'\\)"
8016 (match-beginning 2))
8018 (progn ; there's a proper :
8019 (goto-char (match-beginning 2)) ; just after the :
8020 (c-put-c-type-property (1- (point)) 'c-decl-end)
8023 ;; It's an unfinished label. We consider the keyword enough
8024 ;; to recognize it as a label, so that it gets fontified.
8025 ;; Leave the point at the end of it, but don't put any
8026 ;; `c-decl-end' marker.
8030 ;; @private, @protected, @public, in Objective C, or similar.
8031 ((and c-opt-extra-label-key
8032 (looking-at c-opt-extra-label-key))
8033 ;; For a `c-opt-extra-label-key' match, we record the whole
8034 ;; thing for fontification. That's to get the leading '@' in
8035 ;; Objective-C protection labels fontified.
8036 (goto-char (match-end 1))
8037 (when c-record-type-identifiers
8038 (c-record-ref-id (cons (match-beginning 1) (point))))
8039 (c-put-c-type-property (1- (point)) 'c-decl-end)
8040 (setq label-type t))
8042 ;; All other cases of labels.
8043 ((and c-recognize-colon-labels ; nil for AWK and IDL, otherwise t.
8045 ;; A colon label must have something before the colon.
8046 (not (eq (char-after) ?:))
8048 ;; Check that we're not after a token that can't precede a label.
8050 ;; Trivially succeeds when there's no preceding token.
8051 ;; Succeeds when we're at a virtual semicolon.
8052 (if preceding-token-end
8053 (<= preceding-token-end (point-min))
8055 (c-backward-syntactic-ws)
8056 (setq preceding-token-end (point))
8060 ;; Check if we're after a label, if we're after a closing
8061 ;; paren that belong to statement, and with
8062 ;; `c-label-prefix-re'. It's done in different order
8063 ;; depending on `assume-markup' since the checks have
8064 ;; different expensiveness.
8067 (eq (c-get-char-property (1- preceding-token-end) 'c-type)
8071 (goto-char (1- preceding-token-end))
8072 (c-beginning-of-current-token)
8073 (or (looking-at c-label-prefix-re)
8074 (looking-at c-block-stmt-1-key)))
8076 (and (eq (char-before preceding-token-end) ?\))
8077 (c-after-conditional)))
8081 (goto-char (1- preceding-token-end))
8082 (c-beginning-of-current-token)
8083 (or (looking-at c-label-prefix-re)
8084 (looking-at c-block-stmt-1-key)))
8087 ((eq (char-before preceding-token-end) ?\))
8088 (c-after-conditional))
8090 ((eq (char-before preceding-token-end) ?:)
8091 ;; Might be after another label, so check it recursively.
8094 (goto-char (1- preceding-token-end))
8095 ;; Essentially the same as the
8096 ;; `c-syntactic-re-search-forward' regexp below.
8098 (save-excursion (and (c-beginning-of-macro)
8100 (if macro-start (narrow-to-region macro-start (point-max)))
8101 (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+" nil t)
8102 ;; Note: the following should work instead of the
8103 ;; narrow-to-region above. Investigate why not,
8104 ;; sometime. ACM, 2006-03-31.
8105 ;; (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+"
8108 ;; If the caller turned on recording for us,
8109 ;; it shouldn't apply when we check the
8111 c-record-type-identifiers)
8112 ;; A label can't start at a cpp directive. Check for
8113 ;; this, since c-forward-syntactic-ws would foul up on it.
8114 (unless (and c-opt-cpp-prefix (looking-at c-opt-cpp-prefix))
8115 (c-forward-syntactic-ws)
8116 (c-forward-label nil pte start))))))))))
8118 ;; Point is still at the beginning of the possible label construct.
8120 ;; Check that the next nonsymbol token is ":", or that we're in one
8121 ;; of QT's "slots" declarations. Allow '(' for the sake of macro
8122 ;; arguments. FIXME: Should build this regexp from the language
8125 ;; public: protected: private:
8127 (c-major-mode-is 'c++-mode)
8128 (search-forward-regexp
8129 "\\=p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\>[^_]" nil t)
8130 (progn (backward-char)
8131 (c-forward-syntactic-ws limit)
8132 (looking-at ":\\([^:]\\|\\'\\)"))) ; A single colon.
8134 (setq label-type t))
8135 ;; QT double keyword like "protected slots:" or goto target.
8136 ((progn (goto-char start) nil))
8137 ((when (c-syntactic-re-search-forward
8138 "[ \t\n[:?;{=*/%&|,<>!@+-]" limit t t) ; not at EOB
8140 (setq label-end (point))
8142 (and (c-major-mode-is 'c++-mode)
8144 "\\(p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\|more\\)\\>"
8145 (buffer-substring start (point)))))
8146 (c-forward-syntactic-ws limit)
8148 ((looking-at ":\\([^:]\\|\\'\\)") ; A single colon.
8151 (if (or (string= "signals" ; Special QT macro
8152 (setq kwd (buffer-substring-no-properties start label-end)))
8153 (string= "Q_SIGNALS" kwd))
8157 (search-forward-regexp "\\=\\(slots\\|Q_SLOTS\\)\\>" limit t)
8158 (progn (c-forward-syntactic-ws limit)
8159 (looking-at ":\\([^:]\\|\\'\\)"))) ; A single colon
8161 (setq label-type 'qt-2kwds-colon)))))))
8164 (narrow-to-region start (point))
8166 ;; Check that `c-nonlabel-token-key' doesn't match anywhere.
8170 (when (looking-at c-nonlabel-token-key)
8172 (setq label-type nil)
8173 (throw 'check-label nil))
8174 (and (c-safe (c-forward-sexp)
8175 (c-forward-syntactic-ws)
8179 ;; Record the identifiers in the label for fontification, unless
8180 ;; it begins with `c-label-kwds' in which case the following
8181 ;; identifiers are part of a (constant) expression that
8182 ;; shouldn't be fontified.
8183 (when (and c-record-type-identifiers
8184 (progn (goto-char start)
8185 (not (looking-at c-label-kwds-regexp))))
8186 (while (c-syntactic-re-search-forward c-symbol-key nil t)
8187 (c-record-ref-id (cons (match-beginning 0)
8190 (c-put-c-type-property (1- (point-max)) 'c-decl-end)
8191 (goto-char (point-max)))))
8198 (defun c-forward-objc-directive ()
8199 ;; Assuming the point is at the beginning of a token, try to move
8200 ;; forward to the end of the Objective-C directive that starts
8201 ;; there. Return t if a directive was fully recognized, otherwise
8202 ;; the point is moved as far as one could be successfully parsed and
8205 ;; This function records identifier ranges on
8206 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
8207 ;; `c-record-type-identifiers' is non-nil.
8209 ;; This function might do hidden buffer changes.
8211 (let ((start (point))
8213 (c-promote-possible-types t)
8215 ;; Turn off recognition of angle bracket arglists while parsing
8216 ;; types here since the protocol reference list might then be
8217 ;; considered part of the preceding name or superclass-name.
8218 c-recognize-<>-arglists)
8223 (c-make-keywords-re t
8224 (append (c-lang-const c-protection-kwds objc)
8227 (goto-char (match-end 1))
8233 (c-make-keywords-re t
8234 '("@interface" "@implementation" "@protocol")
8237 ;; Handle the name of the class itself.
8239 ;; (c-forward-token-2) ; 2006/1/13 This doesn't move if the token's
8241 (goto-char (match-end 0))
8247 ;; Look for ": superclass-name" or "( category-name )".
8248 (when (looking-at "[:(]")
8249 (setq start-char (char-after))
8251 (c-forward-syntactic-ws)
8252 (unless (c-forward-type) (throw 'break nil))
8253 (when (eq start-char ?\()
8254 (unless (eq (char-after) ?\)) (throw 'break nil))
8256 (c-forward-syntactic-ws)))
8258 ;; Look for a protocol reference list.
8259 (if (eq (char-after) ?<)
8260 (let ((c-recognize-<>-arglists t)
8261 (c-parse-and-markup-<>-arglists t)
8262 c-restricted-<>-arglists)
8263 (c-forward-<>-arglist t))
8267 (c-backward-syntactic-ws lim)
8268 (c-clear-c-type-property start (1- (point)) 'c-decl-end)
8269 (c-put-c-type-property (1- (point)) 'c-decl-end)
8272 (c-clear-c-type-property start (point) 'c-decl-end)
8275 (defun c-beginning-of-inheritance-list (&optional lim)
8276 ;; Go to the first non-whitespace after the colon that starts a
8277 ;; multiple inheritance introduction. Optional LIM is the farthest
8278 ;; back we should search.
8280 ;; This function might do hidden buffer changes.
8281 (c-with-syntax-table c++-template-syntax-table
8282 (c-backward-token-2 0 t lim)
8283 (while (and (or (looking-at c-symbol-start)
8284 (looking-at "[<,]\\|::"))
8285 (zerop (c-backward-token-2 1 t lim))))))
8287 (defun c-in-method-def-p ()
8288 ;; Return nil if we aren't in a method definition, otherwise the
8289 ;; position of the initial [+-].
8291 ;; This function might do hidden buffer changes.
8294 (and c-opt-method-key
8295 (looking-at c-opt-method-key)
8299 ;; Contributed by Kevin Ryde <user42@zip.com.au>.
8300 (defun c-in-gcc-asm-p ()
8301 ;; Return non-nil if point is within a gcc \"asm\" block.
8303 ;; This should be called with point inside an argument list.
8305 ;; Only one level of enclosing parentheses is considered, so for
8306 ;; instance nil is returned when in a function call within an asm
8309 ;; This function might do hidden buffer changes.
8311 (and c-opt-asm-stmt-key
8314 (backward-up-list 1)
8315 (c-beginning-of-statement-1 (point-min) nil t)
8316 (looking-at c-opt-asm-stmt-key))))
8318 (defun c-at-toplevel-p ()
8319 "Return a determination as to whether point is \"at the top level\".
8320 Informally, \"at the top level\" is anywhere where you can write
8323 More precisely, being at the top-level means that point is either
8324 outside any enclosing block (such as a function definition), or
8325 directly inside a class, namespace or other block that contains
8326 another declaration level.
8328 If point is not at the top-level (e.g. it is inside a method
8329 definition), then nil is returned. Otherwise, if point is at a
8330 top-level not enclosed within a class definition, t is returned.
8331 Otherwise, a 2-vector is returned where the zeroth element is the
8332 buffer position of the start of the class declaration, and the first
8333 element is the buffer position of the enclosing class's opening
8336 Note that this function might do hidden buffer changes. See the
8337 comment at the start of cc-engine.el for more info."
8338 ;; Note to maintainers: this function consumes a great mass of CPU cycles.
8339 ;; Its use should thus be minimized as far as possible.
8340 (let ((paren-state (c-parse-state)))
8341 (or (not (c-most-enclosing-brace paren-state))
8342 (c-search-uplist-for-classkey paren-state))))
8344 (defun c-just-after-func-arglist-p (&optional lim)
8345 ;; Return non-nil if the point is in the region after the argument
8346 ;; list of a function and its opening brace (or semicolon in case it
8347 ;; got no body). If there are K&R style argument declarations in
8348 ;; that region, the point has to be inside the first one for this
8349 ;; function to recognize it.
8351 ;; If successful, the point is moved to the first token after the
8352 ;; function header (see `c-forward-decl-or-cast-1' for details) and
8353 ;; the position of the opening paren of the function arglist is
8356 ;; The point is clobbered if not successful.
8358 ;; LIM is used as bound for backward buffer searches.
8360 ;; This function might do hidden buffer changes.
8362 (let ((beg (point)) id-start)
8364 (eq (c-beginning-of-statement-1 lim) 'same)
8366 (not (and (c-major-mode-is 'objc-mode)
8367 (c-forward-objc-directive)))
8370 (car-safe (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil)))
8373 ;; There should not be a '=' or ',' between beg and the
8374 ;; start of the declaration since that means we were in the
8375 ;; "expression part" of the declaration.
8377 (not (looking-at "[=,]")))
8380 ;; Check that there's an arglist paren in the
8382 (goto-char id-start)
8383 (cond ((eq (char-after) ?\()
8384 ;; The declarator is a paren expression, so skip past it
8385 ;; so that we don't get stuck on that instead of the
8386 ;; function arglist.
8388 ((and c-opt-op-identifier-prefix
8389 (looking-at c-opt-op-identifier-prefix))
8390 ;; Don't trip up on "operator ()".
8391 (c-forward-token-2 2 t)))
8392 (and (< (point) beg)
8393 (c-syntactic-re-search-forward "(" beg t t)
8396 (defun c-in-knr-argdecl (&optional lim)
8397 ;; Return the position of the first argument declaration if point is
8398 ;; inside a K&R style argument declaration list, nil otherwise.
8399 ;; `c-recognize-knr-p' is not checked. If LIM is non-nil, it's a
8400 ;; position that bounds the backward search for the argument list. This
8401 ;; function doesn't move point.
8403 ;; Point must be within a possible K&R region, e.g. just before a top-level
8404 ;; "{". It must be outside of parens and brackets. The test can return
8405 ;; false positives otherwise.
8407 ;; This function might do hidden buffer changes.
8410 ;; If we're in a macro, our search range is restricted to it. Narrow to
8411 ;; the searchable range.
8412 (let* ((macro-start (save-excursion (and (c-beginning-of-macro) (point))))
8413 (macro-end (save-excursion (and macro-start (c-end-of-macro) (point))))
8414 (low-lim (max (or lim (point-min)) (or macro-start (point-min))))
8415 before-lparen after-rparen
8417 (pp-count-out 20) ; Max number of paren/brace constructs before
8419 ids ; List of identifiers in the parenthesized list.
8420 id-start after-prec-token decl-or-cast decl-res
8421 c-last-identifier-range identifier-ok)
8422 (narrow-to-region low-lim (or macro-end (point-max)))
8424 ;; Search backwards for the defun's argument list. We give up if we
8425 ;; encounter a "}" (end of a previous defun) an "=" (which can't be in
8426 ;; a knr region) or BOB.
8428 ;; The criterion for a paren structure being the arg list is:
8429 ;; o - there is non-WS stuff after it but before any "{"; AND
8430 ;; o - the token after it isn't a ";" AND
8431 ;; o - it is preceded by either an identifier (the function name) or
8432 ;; a macro expansion like "DEFUN (...)"; AND
8433 ;; o - its content is a non-empty comma-separated list of identifiers
8434 ;; (an empty arg list won't have a knr region).
8436 ;; The following snippet illustrates these rules:
8437 ;; int foo (bar, baz, yuk)
8439 ;; int (*baz) (my_type) ;
8440 ;; int (*(* yuk) (void)) (void) ;
8443 ;; Additionally, for a knr list to be recognized:
8444 ;; o - The identifier of each declarator up to and including the
8445 ;; one "near" point must be contained in the arg list.
8448 (while (> pp-count-out 0) ; go back one paren/bracket pair each time.
8449 (setq pp-count-out (1- pp-count-out))
8450 (c-syntactic-skip-backward "^)]}=")
8451 (cond ((eq (char-before) ?\))
8452 (setq after-rparen (point)))
8453 ((eq (char-before) ?\])
8454 (setq after-rparen nil))
8455 (t ; either } (hit previous defun) or = or no more
8460 ;; We're inside a paren. Could it be our argument list....?
8464 (goto-char after-rparen)
8465 (unless (c-go-list-backward) (throw 'knr nil)) ;
8466 ;; FIXME!!! What about macros between the parens? 2007/01/20
8467 (setq before-lparen (point)))
8469 ;; It can't be the arg list if next token is ; or {
8470 (progn (goto-char after-rparen)
8471 (c-forward-syntactic-ws)
8472 (not (memq (char-after) '(?\; ?\{ ?\=))))
8474 ;; Is the thing preceding the list an identifier (the
8475 ;; function name), or a macro expansion?
8477 (goto-char before-lparen)
8478 (eq (c-backward-token-2) 0)
8479 (or (eq (c-on-identifier) (point))
8480 (and (eq (char-after) ?\))
8481 (c-go-up-list-backward)
8482 (eq (c-backward-token-2) 0)
8483 (eq (c-on-identifier) (point)))))
8485 ;; Have we got a non-empty list of comma-separated
8488 (goto-char before-lparen)
8489 (c-forward-token-2) ; to first token inside parens
8491 (setq id-start (c-on-identifier)) ; Must be at least one.
8496 (c-end-of-current-token)
8497 (push (buffer-substring-no-properties id-start
8500 (c-forward-syntactic-ws)
8501 (eq (char-after) ?\,))
8503 (unless (setq id-start (c-on-identifier))
8504 (throw 'id-list nil)))
8505 (eq (char-after) ?\)))))
8507 ;; Are all the identifiers in the k&r list up to the
8508 ;; current one also in the argument list?
8510 (forward-char) ; over the )
8511 (setq after-prec-token after-rparen)
8512 (c-forward-syntactic-ws)
8514 (or (consp (setq decl-or-cast
8515 (c-forward-decl-or-cast-1
8517 nil ; Or 'arglist ???
8520 (goto-char after-prec-token)
8521 (c-forward-syntactic-ws)
8522 (setq identifier-ok (eq (char-after) ?{))
8524 (eq (char-after) ?\;)
8525 (setq after-prec-token (1+ (point)))
8526 (goto-char (car decl-or-cast))
8527 (setq decl-res (c-forward-declarator))
8529 (member (buffer-substring-no-properties
8530 (car decl-res) (cadr decl-res))
8533 (goto-char after-prec-token)
8534 (prog1 (< (point) here)
8535 (c-forward-syntactic-ws))))
8536 (setq identifier-ok nil))
8538 ;; ...Yes. We've identified the function's argument list.
8540 (progn (goto-char after-rparen)
8541 (c-forward-syntactic-ws)
8543 ;; ...No. The current parens aren't the function's arg list.
8544 (goto-char before-lparen))
8546 (or (c-go-list-backward) ; backwards over [ .... ]
8547 (throw 'knr nil)))))))))
8549 (defun c-skip-conditional ()
8550 ;; skip forward over conditional at point, including any predicate
8551 ;; statements in parentheses. No error checking is performed.
8553 ;; This function might do hidden buffer changes.
8554 (c-forward-sexp (cond
8556 ((looking-at (concat "\\<else"
8557 "\\([ \t\n]\\|\\\\\n\\)+"
8558 "if\\>\\([^_]\\|$\\)"))
8560 ;; do, else, try, finally
8561 ((looking-at (concat "\\<\\("
8562 "do\\|else\\|try\\|finally"
8563 "\\)\\>\\([^_]\\|$\\)"))
8565 ;; for, if, while, switch, catch, synchronized, foreach
8568 (defun c-after-conditional (&optional lim)
8569 ;; If looking at the token after a conditional then return the
8570 ;; position of its start, otherwise return nil.
8572 ;; This function might do hidden buffer changes.
8574 (and (zerop (c-backward-token-2 1 t lim))
8575 (or (looking-at c-block-stmt-1-key)
8576 (and (eq (char-after) ?\()
8577 (zerop (c-backward-token-2 1 t lim))
8578 (or (looking-at c-block-stmt-2-key)
8579 (looking-at c-block-stmt-1-2-key))))
8582 (defun c-after-special-operator-id (&optional lim)
8583 ;; If the point is after an operator identifier that isn't handled
8584 ;; like an ordinary symbol (i.e. like "operator =" in C++) then the
8585 ;; position of the start of that identifier is returned. nil is
8586 ;; returned otherwise. The point may be anywhere in the syntactic
8587 ;; whitespace after the last token of the operator identifier.
8589 ;; This function might do hidden buffer changes.
8591 (and c-overloadable-operators-regexp
8592 (zerop (c-backward-token-2 1 nil lim))
8593 (looking-at c-overloadable-operators-regexp)
8594 (or (not c-opt-op-identifier-prefix)
8596 (zerop (c-backward-token-2 1 nil lim))
8597 (looking-at c-opt-op-identifier-prefix)))
8600 (defsubst c-backward-to-block-anchor (&optional lim)
8601 ;; Assuming point is at a brace that opens a statement block of some
8602 ;; kind, move to the proper anchor point for that block. It might
8603 ;; need to be adjusted further by c-add-stmt-syntax, but the
8604 ;; position at return is suitable as start position for that
8607 ;; This function might do hidden buffer changes.
8608 (unless (= (point) (c-point 'boi))
8609 (let ((start (c-after-conditional lim)))
8611 (goto-char start)))))
8613 (defsubst c-backward-to-decl-anchor (&optional lim)
8614 ;; Assuming point is at a brace that opens the block of a top level
8615 ;; declaration of some kind, move to the proper anchor point for
8618 ;; This function might do hidden buffer changes.
8619 (unless (= (point) (c-point 'boi))
8620 (c-beginning-of-statement-1 lim)))
8622 (defun c-search-decl-header-end ()
8623 ;; Search forward for the end of the "header" of the current
8624 ;; declaration. That's the position where the definition body
8625 ;; starts, or the first variable initializer, or the ending
8626 ;; semicolon. I.e. search forward for the closest following
8627 ;; (syntactically relevant) '{', '=' or ';' token. Point is left
8628 ;; _after_ the first found token, or at point-max if none is found.
8630 ;; This function might do hidden buffer changes.
8632 (let ((base (point)))
8633 (if (c-major-mode-is 'c++-mode)
8635 ;; In C++ we need to take special care to handle operator
8636 ;; tokens and those pesky template brackets.
8638 (c-syntactic-re-search-forward "[;{<=]" nil 'move t t)
8640 (c-end-of-current-token base)
8641 ;; Handle operator identifiers, i.e. ignore any
8642 ;; operator token preceded by "operator".
8644 (and (c-safe (c-backward-sexp) t)
8645 (looking-at c-opt-op-identifier-prefix)))
8646 (and (eq (char-before) ?<)
8647 (c-with-syntax-table c++-template-syntax-table
8648 (if (c-safe (goto-char (c-up-list-forward (point))))
8650 (goto-char (point-max))
8652 (setq base (point)))
8655 (c-syntactic-re-search-forward "[;{=]" nil 'move t t)
8656 (c-end-of-current-token base))
8657 (setq base (point))))))
8659 (defun c-beginning-of-decl-1 (&optional lim)
8660 ;; Go to the beginning of the current declaration, or the beginning
8661 ;; of the previous one if already at the start of it. Point won't
8662 ;; be moved out of any surrounding paren. Return a cons cell of the
8663 ;; form (MOVE . KNR-POS). MOVE is like the return value from
8664 ;; `c-beginning-of-statement-1'. If point skipped over some K&R
8665 ;; style argument declarations (and they are to be recognized) then
8666 ;; KNR-POS is set to the start of the first such argument
8667 ;; declaration, otherwise KNR-POS is nil. If LIM is non-nil, it's a
8668 ;; position that bounds the backward search.
8670 ;; NB: Cases where the declaration continues after the block, as in
8671 ;; "struct foo { ... } bar;", are currently recognized as two
8672 ;; declarations, e.g. "struct foo { ... }" and "bar;" in this case.
8674 ;; This function might do hidden buffer changes.
8676 (let* ((start (point))
8677 (last-stmt-start (point))
8678 (move (c-beginning-of-statement-1 lim nil t)))
8680 ;; `c-beginning-of-statement-1' stops at a block start, but we
8681 ;; want to continue if the block doesn't begin a top level
8682 ;; construct, i.e. if it isn't preceded by ';', '}', ':', bob,
8683 ;; or an open paren.
8684 (let ((beg (point)) tentative-move)
8685 ;; Go back one "statement" each time round the loop until we're just
8686 ;; after a ;, }, or :, or at BOB or the start of a macro or start of
8687 ;; an ObjC method. This will move over a multiple declaration whose
8688 ;; components are comma separated.
8690 ;; Must check with c-opt-method-key in ObjC mode.
8691 (not (and c-opt-method-key
8692 (looking-at c-opt-method-key)))
8693 (/= last-stmt-start (point))
8695 (c-backward-syntactic-ws lim)
8696 (not (memq (char-before) '(?\; ?} ?: nil))))
8699 (not (looking-at "\\s(")))
8700 ;; Check that we don't move from the first thing in a
8701 ;; macro to its header.
8702 (not (eq (setq tentative-move
8703 (c-beginning-of-statement-1 lim nil t))
8705 (setq last-stmt-start beg
8707 move tentative-move))
8710 (when c-recognize-knr-p
8711 (let ((fallback-pos (point)) knr-argdecl-start)
8712 ;; Handle K&R argdecls. Back up after the "statement" jumped
8713 ;; over by `c-beginning-of-statement-1', unless it was the
8714 ;; function body, in which case we're sitting on the opening
8715 ;; brace now. Then test if we're in a K&R argdecl region and
8716 ;; that we started at the other side of the first argdecl in
8718 (unless (eq (char-after) ?{)
8719 (goto-char last-stmt-start))
8720 (if (and (setq knr-argdecl-start (c-in-knr-argdecl lim))
8721 (< knr-argdecl-start start)
8723 (goto-char knr-argdecl-start)
8724 (not (eq (c-beginning-of-statement-1 lim nil t) 'macro))))
8726 (cons (if (eq (char-after fallback-pos) ?{)
8730 (goto-char fallback-pos))))
8732 ;; `c-beginning-of-statement-1' counts each brace block as a separate
8733 ;; statement, so the result will be 'previous if we've moved over any.
8734 ;; So change our result back to 'same if necessary.
8736 ;; If they were brace list initializers we might not have moved over a
8737 ;; declaration boundary though, so change it to 'same if we've moved
8738 ;; past a '=' before '{', but not ';'. (This ought to be integrated
8739 ;; into `c-beginning-of-statement-1', so we avoid this extra pass which
8740 ;; potentially can search over a large amount of text.). Take special
8741 ;; pains not to get mislead by C++'s "operator=", and the like.
8742 (if (and (eq move 'previous)
8743 (c-with-syntax-table (if (c-major-mode-is 'c++-mode)
8744 c++-template-syntax-table
8749 (while ; keep going back to "[;={"s until we either find
8750 ; no more, or get to one which isn't an "operator ="
8751 (and (c-syntactic-re-search-forward "[;={]" start t t t)
8752 (eq (char-before) ?=)
8753 c-overloadable-operators-regexp
8754 c-opt-op-identifier-prefix
8756 (eq (c-backward-token-2) 0)
8757 (looking-at c-overloadable-operators-regexp)
8758 (eq (c-backward-token-2) 0)
8759 (looking-at c-opt-op-identifier-prefix))))
8760 (eq (char-before) ?=))
8761 (c-syntactic-re-search-forward "[;{]" start t t)
8762 (eq (char-before) ?{)
8763 (c-safe (goto-char (c-up-list-forward (point))) t)
8764 (not (c-syntactic-re-search-forward ";" start t t))))))
8768 (defun c-end-of-decl-1 ()
8769 ;; Assuming point is at the start of a declaration (as detected by
8770 ;; e.g. `c-beginning-of-decl-1'), go to the end of it. Unlike
8771 ;; `c-beginning-of-decl-1', this function handles the case when a
8772 ;; block is followed by identifiers in e.g. struct declarations in C
8773 ;; or C++. If a proper end was found then t is returned, otherwise
8774 ;; point is moved as far as possible within the current sexp and nil
8775 ;; is returned. This function doesn't handle macros; use
8776 ;; `c-end-of-macro' instead in those cases.
8778 ;; This function might do hidden buffer changes.
8779 (let ((start (point))
8780 (decl-syntax-table (if (c-major-mode-is 'c++-mode)
8781 c++-template-syntax-table
8784 (c-search-decl-header-end)
8786 (when (and c-recognize-knr-p
8787 (eq (char-before) ?\;)
8788 (c-in-knr-argdecl start))
8789 ;; Stopped at the ';' in a K&R argdecl section which is
8790 ;; detected using the same criteria as in
8791 ;; `c-beginning-of-decl-1'. Move to the following block
8793 (c-syntactic-re-search-forward "{" nil 'move t))
8795 (when (eq (char-before) ?{)
8796 ;; Encountered a block in the declaration. Jump over it.
8798 (goto-char (c-up-list-forward (point)))
8799 (error (goto-char (point-max))
8800 (throw 'return nil)))
8801 (if (or (not c-opt-block-decls-with-vars-key)
8803 (c-with-syntax-table decl-syntax-table
8804 (let ((lim (point)))
8807 ;; Check for `c-opt-block-decls-with-vars-key'
8808 ;; before the first paren.
8809 (c-syntactic-re-search-forward
8810 (concat "[;=([{]\\|\\("
8811 c-opt-block-decls-with-vars-key
8815 (not (eq (char-before) ?_))
8816 ;; Check that the first following paren is
8818 (c-syntactic-re-search-forward "[;=([{]"
8820 (eq (char-before) ?{)))))))
8821 ;; The declaration doesn't have any of the
8822 ;; `c-opt-block-decls-with-vars' keywords in the
8823 ;; beginning, so it ends here at the end of the block.
8826 (c-with-syntax-table decl-syntax-table
8828 (if (eq (char-before) ?\;)
8830 (c-syntactic-re-search-forward ";" nil 'move t))))
8833 (defun c-looking-at-decl-block (containing-sexp goto-start &optional limit)
8834 ;; Assuming the point is at an open brace, check if it starts a
8835 ;; block that contains another declaration level, i.e. that isn't a
8836 ;; statement block or a brace list, and if so return non-nil.
8838 ;; If the check is successful, the return value is the start of the
8839 ;; keyword that tells what kind of construct it is, i.e. typically
8840 ;; what `c-decl-block-key' matched. Also, if GOTO-START is set then
8841 ;; the point will be at the start of the construct, before any
8842 ;; leading specifiers, otherwise it's at the returned position.
8844 ;; The point is clobbered if the check is unsuccessful.
8846 ;; CONTAINING-SEXP is the position of the open of the surrounding
8847 ;; paren, or nil if none.
8849 ;; The optional LIMIT limits the backward search for the start of
8850 ;; the construct. It's assumed to be at a syntactically relevant
8853 ;; If any template arglists are found in the searched region before
8854 ;; the open brace, they get marked with paren syntax.
8856 ;; This function might do hidden buffer changes.
8858 (let ((open-brace (point)) kwd-start first-specifier-pos)
8859 (c-syntactic-skip-backward c-block-prefix-charset limit t)
8861 (when (and c-recognize-<>-arglists
8862 (eq (char-before) ?>))
8863 ;; Could be at the end of a template arglist.
8864 (let ((c-parse-and-markup-<>-arglists t))
8866 (c-backward-<>-arglist nil limit)
8868 (c-syntactic-skip-backward c-block-prefix-charset limit t)
8869 (eq (char-before) ?>))))))
8871 ;; Note: Can't get bogus hits inside template arglists below since they
8872 ;; have gotten paren syntax above.
8874 ;; If `goto-start' is set we begin by searching for the
8875 ;; first possible position of a leading specifier list.
8876 ;; The `c-decl-block-key' search continues from there since
8877 ;; we know it can't match earlier.
8879 (when (c-syntactic-re-search-forward c-symbol-start
8881 (goto-char (setq first-specifier-pos (match-beginning 0)))
8886 ((c-syntactic-re-search-forward c-decl-block-key open-brace t t t)
8887 (goto-char (setq kwd-start (match-beginning 0)))
8889 ;; Exclude cases where we matched what would ordinarily
8890 ;; be a block declaration keyword, except where it's not
8891 ;; legal because it's part of a "compound keyword" like
8892 ;; "enum class". Of course, if c-after-brace-list-key
8893 ;; is nil, we can skip the test.
8894 (or (equal c-after-brace-list-key "\\<\\>")
8899 (looking-at c-after-brace-list-key)
8900 (= (c-backward-token-2 1 t) 0)
8901 (looking-at c-brace-list-key))))))
8903 ;; Found a keyword that can't be a type?
8906 ;; Can be a type too, in which case it's the return type of a
8907 ;; function (under the assumption that no declaration level
8908 ;; block construct starts with a type).
8909 (not (c-forward-type))
8911 ;; Jumped over a type, but it could be a declaration keyword
8912 ;; followed by the declared identifier that we've jumped over
8913 ;; instead (e.g. in "class Foo {"). If it indeed is a type
8914 ;; then we should be at the declarator now, so check for a
8915 ;; valid declarator start.
8917 ;; Note: This doesn't cope with the case when a declared
8918 ;; identifier is followed by e.g. '(' in a language where '('
8919 ;; also might be part of a declarator expression. Currently
8920 ;; there's no such language.
8921 (not (or (looking-at c-symbol-start)
8922 (looking-at c-type-decl-prefix-key))))))
8924 ;; In Pike a list of modifiers may be followed by a brace
8925 ;; to make them apply to many identifiers. Note that the
8926 ;; match data will be empty on return in this case.
8927 ((and (c-major-mode-is 'pike-mode)
8929 (goto-char open-brace)
8930 (= (c-backward-token-2) 0))
8931 (looking-at c-specifier-key)
8932 ;; Use this variant to avoid yet another special regexp.
8933 (c-keyword-member (c-keyword-sym (match-string 1))
8935 (setq kwd-start (point))
8941 ;; Back up over any preceding specifiers and their clauses
8942 ;; by going forward from `first-specifier-pos', which is the
8943 ;; earliest possible position where the specifier list can
8946 (goto-char first-specifier-pos)
8948 (while (< (point) kwd-start)
8949 (if (looking-at c-symbol-key)
8950 ;; Accept any plain symbol token on the ground that
8951 ;; it's a specifier masked through a macro (just
8952 ;; like `c-forward-decl-or-cast-1' skip forward over
8955 ;; Could be more restrictive wrt invalid keywords,
8956 ;; but that'd only occur in invalid code so there's
8957 ;; no use spending effort on it.
8958 (let ((end (match-end 0)))
8959 (unless (c-forward-keyword-clause 0)
8961 (c-forward-syntactic-ws)))
8963 ;; Can't parse a declaration preamble and is still
8964 ;; before `kwd-start'. That means `first-specifier-pos'
8965 ;; was in some earlier construct. Search again.
8966 (if (c-syntactic-re-search-forward c-symbol-start
8968 (goto-char (setq first-specifier-pos (match-beginning 0)))
8969 ;; Got no preamble before the block declaration keyword.
8970 (setq first-specifier-pos kwd-start))))
8972 (goto-char first-specifier-pos))
8973 (goto-char kwd-start))
8977 (defun c-search-uplist-for-classkey (paren-state)
8978 ;; Check if the closest containing paren sexp is a declaration
8979 ;; block, returning a 2 element vector in that case. Aref 0
8980 ;; contains the bufpos at boi of the class key line, and aref 1
8981 ;; contains the bufpos of the open brace. This function is an
8982 ;; obsolete wrapper for `c-looking-at-decl-block'.
8984 ;; This function might do hidden buffer changes.
8985 (let ((open-paren-pos (c-most-enclosing-brace paren-state)))
8986 (when open-paren-pos
8988 (goto-char open-paren-pos)
8989 (when (and (eq (char-after) ?{)
8990 (c-looking-at-decl-block
8991 (c-safe-position open-paren-pos paren-state)
8993 (back-to-indentation)
8994 (vector (point) open-paren-pos))))))
8996 (defun c-most-enclosing-decl-block (paren-state)
8997 ;; Return the buffer position of the most enclosing decl-block brace (in the
8998 ;; sense of c-looking-at-decl-block) in the PAREN-STATE structure, or nil if
9000 (let* ((open-brace (c-pull-open-brace paren-state))
9001 (next-open-brace (c-pull-open-brace paren-state)))
9002 (while (and open-brace
9004 (goto-char open-brace)
9005 (not (c-looking-at-decl-block next-open-brace nil))))
9006 (setq open-brace next-open-brace
9007 next-open-brace (c-pull-open-brace paren-state)))
9010 (defun c-cheap-inside-bracelist-p (paren-state)
9011 ;; Return the position of the L-brace if point is inside a brace list
9012 ;; initialization of an array, etc. This is an approximate function,
9013 ;; designed for speed over accuracy. It will not find every bracelist, but
9014 ;; a non-nil result is reliable. We simply search for "= {" (naturally with
9015 ;; syntactic whitespace allowed). PAREN-STATE is the normal thing that it
9016 ;; is everywhere else.
9020 (and (setq b-pos (c-pull-open-brace paren-state))
9021 (progn (goto-char b-pos)
9023 (c-backward-token-2)
9024 (not (looking-at "=")))))
9027 (defun c-backward-colon-prefixed-type ()
9028 ;; We're at the token after what might be a type prefixed with a colon. Try
9029 ;; moving backward over this type and the colon. On success, return t and
9030 ;; leave point before colon; on failure, leave point unchanged. Will clobber
9032 (let ((here (point))
9036 (and (eql (c-backward-token-2) 0)
9037 (or (not (looking-at "\\s)"))
9038 (c-go-up-list-backward))
9040 ((eql (char-after) ?:)
9041 (setq colon-pos (point))
9043 (c-forward-syntactic-ws)
9044 (or (and (c-forward-type)
9045 (progn (c-forward-syntactic-ws)
9047 (setq colon-pos nil))
9049 ((eql (char-after) ?\()
9051 ((looking-at c-symbol-key)
9055 (goto-char colon-pos)
9058 (defun c-backward-over-enum-header ()
9059 ;; We're at a "{". Move back to the enum-like keyword that starts this
9060 ;; declaration and return t, otherwise don't move and return nil.
9061 (let ((here (point))
9062 up-sexp-pos before-identifier)
9063 (when c-recognize-post-brace-list-type-p
9064 (c-backward-colon-prefixed-type))
9067 (eq (c-backward-token-2) 0)
9068 (or (not (looking-at "\\s)"))
9069 (c-go-up-list-backward))
9071 ((and (looking-at c-symbol-key) (c-on-identifier)
9072 (not before-identifier))
9073 (setq before-identifier t))
9074 ((and before-identifier
9075 (or (eql (char-after) ?,)
9076 (looking-at c-postfix-decl-spec-key)))
9077 (setq before-identifier nil)
9079 ((looking-at c-after-brace-list-key) t)
9080 ((looking-at c-brace-list-key) nil)
9081 ((eq (char-after) ?\()
9082 (and (eq (c-backward-token-2) 0)
9083 (or (looking-at c-decl-hangon-key)
9084 (and c-opt-cpp-prefix
9085 (looking-at c-noise-macro-with-parens-name-re)))))
9087 ((and c-recognize-<>-arglists
9088 (eq (char-after) ?<)
9089 (looking-at "\\s("))
9092 (or (looking-at c-brace-list-key)
9093 (progn (goto-char here) nil))))
9095 (defun c-inside-bracelist-p (containing-sexp paren-state)
9096 ;; return the buffer position of the beginning of the brace list
9097 ;; statement if we're inside a brace list, otherwise return nil.
9098 ;; CONTAINING-SEXP is the buffer pos of the innermost containing
9099 ;; paren. PAREN-STATE is the remainder of the state of enclosing
9102 ;; N.B.: This algorithm can potentially get confused by cpp macros
9103 ;; placed in inconvenient locations. It's a trade-off we make for
9106 ;; This function might do hidden buffer changes.
9108 ;; This will pick up brace list declarations.
9110 (goto-char containing-sexp)
9111 (c-backward-over-enum-header))
9112 ;; this will pick up array/aggregate init lists, even if they are nested.
9115 ;; Pike can have class definitions anywhere, so we must
9116 ;; check for the class key here.
9117 (and (c-major-mode-is 'pike-mode)
9119 bufpos braceassignp lim next-containing macro-start)
9120 (while (and (not bufpos)
9123 (if (consp (car paren-state))
9124 (setq lim (cdr (car paren-state))
9125 paren-state (cdr paren-state))
9126 (setq lim (car paren-state)))
9128 (setq next-containing (car paren-state)
9129 paren-state (cdr paren-state))))
9130 (goto-char containing-sexp)
9131 (if (c-looking-at-inexpr-block next-containing next-containing)
9132 ;; We're in an in-expression block of some kind. Do not
9133 ;; check nesting. We deliberately set the limit to the
9134 ;; containing sexp, so that c-looking-at-inexpr-block
9135 ;; doesn't check for an identifier before it.
9136 (setq containing-sexp nil)
9137 ;; see if the open brace is preceded by = or [...] in
9138 ;; this statement, but watch out for operator=
9139 (setq braceassignp 'dontknow)
9140 (c-backward-token-2 1 t lim)
9141 ;; Checks to do only on the first sexp before the brace.
9142 (when (and c-opt-inexpr-brace-list-key
9143 (eq (char-after) ?\[))
9144 ;; In Java, an initialization brace list may follow
9145 ;; directly after "new Foo[]", so check for a "new"
9147 (while (eq braceassignp 'dontknow)
9149 (cond ((/= (c-backward-token-2 1 t lim) 0) nil)
9150 ((looking-at c-opt-inexpr-brace-list-key) t)
9151 ((looking-at "\\sw\\|\\s_\\|[.[]")
9152 ;; Carry on looking if this is an
9153 ;; identifier (may contain "." in Java)
9154 ;; or another "[]" sexp.
9157 ;; Checks to do on all sexps before the brace, up to the
9158 ;; beginning of the statement.
9159 (while (eq braceassignp 'dontknow)
9160 (cond ((eq (char-after) ?\;)
9161 (setq braceassignp nil))
9163 (looking-at class-key))
9164 (setq braceassignp nil))
9165 ((eq (char-after) ?=)
9166 ;; We've seen a =, but must check earlier tokens so
9167 ;; that it isn't something that should be ignored.
9168 (setq braceassignp 'maybe)
9169 (while (and (eq braceassignp 'maybe)
9170 (zerop (c-backward-token-2 1 t lim)))
9173 ;; Check for operator =
9174 ((and c-opt-op-identifier-prefix
9175 (looking-at c-opt-op-identifier-prefix))
9177 ;; Check for `<opchar>= in Pike.
9178 ((and (c-major-mode-is 'pike-mode)
9179 (or (eq (char-after) ?`)
9180 ;; Special case for Pikes
9181 ;; `[]=, since '[' is not in
9182 ;; the punctuation class.
9183 (and (eq (char-after) ?\[)
9184 (eq (char-before) ?`))))
9186 ((looking-at "\\s.") 'maybe)
9187 ;; make sure we're not in a C++ template
9188 ;; argument assignment
9190 (c-major-mode-is 'c++-mode)
9192 (let ((here (point))
9194 (skip-chars-backward "^<>")
9196 (and (eq (char-before) ?<)
9197 (not (c-crosses-statement-barrier-p
9199 (not (c-in-literal))
9203 (if (and (eq braceassignp 'dontknow)
9204 (/= (c-backward-token-2 1 t lim) 0))
9205 (setq braceassignp nil)))
9208 ;; We've hit the beginning of the aggregate list.
9209 (c-beginning-of-statement-1
9210 (c-most-enclosing-brace paren-state))
9211 (setq bufpos (point)))
9212 ((eq (char-after) ?\;)
9213 ;; Brace lists can't contain a semicolon, so we're done.
9214 (setq containing-sexp nil))
9215 ((and (setq macro-start (point))
9216 (c-forward-to-cpp-define-body)
9217 (eq (point) containing-sexp))
9218 ;; We've a macro whose expansion starts with the '{'.
9219 ;; Heuristically, if we have a ';' in it we've not got a
9220 ;; brace list, otherwise we have.
9221 (let ((macro-end (progn (c-end-of-macro) (point))))
9222 (goto-char containing-sexp)
9224 (if (and (c-syntactic-re-search-forward "[;,]" macro-end t t)
9225 (eq (char-before) ?\;))
9227 containing-sexp nil)
9228 (setq bufpos macro-start))))
9231 (setq containing-sexp next-containing
9233 next-containing nil)))))
9238 (defun c-looking-at-special-brace-list (&optional lim)
9239 ;; If we're looking at the start of a pike-style list, i.e., `({Â })',
9240 ;; `([Â ])', `(<Â >)', etc., a cons of a cons of its starting and ending
9241 ;; positions and its entry in c-special-brace-lists is returned, nil
9242 ;; otherwise. The ending position is nil if the list is still open.
9243 ;; LIM is the limit for forward search. The point may either be at
9244 ;; the `(' or at the following paren character. Tries to check the
9245 ;; matching closer, but assumes it's correct if no balanced paren is
9246 ;; found (i.e. the case `({ ... } ... )' is detected as _not_ being
9247 ;; a special brace list).
9249 ;; This function might do hidden buffer changes.
9250 (if c-special-brace-lists
9255 (c-forward-syntactic-ws)
9256 (if (eq (char-after) ?\()
9259 (c-forward-syntactic-ws)
9260 (setq inner-beg (point))
9261 (setq type (assq (char-after) c-special-brace-lists)))
9262 (if (setq type (assq (char-after) c-special-brace-lists))
9264 (setq inner-beg (point))
9265 (c-backward-syntactic-ws)
9267 (setq beg (if (eq (char-after) ?\()
9275 (= (char-before) ?\)))
9277 (goto-char inner-beg)
9278 (if (looking-at "\\s(")
9279 ;; Check balancing of the inner paren
9284 ;; If the inner char isn't a paren then
9285 ;; we can't check balancing, so just
9286 ;; check the char before the outer
9290 (c-backward-syntactic-ws)
9291 (= (char-before) (cdr type)))))
9292 (if (or (/= (char-syntax (char-before)) ?\))
9294 (c-forward-syntactic-ws)
9297 (cons (cons beg end) type))
9298 (cons (list beg) type)))))
9301 (defun c-looking-at-bos (&optional lim)
9302 ;; Return non-nil if between two statements or declarations, assuming
9303 ;; point is not inside a literal or comment.
9305 ;; Obsolete - `c-at-statement-start-p' or `c-at-expression-start-p'
9306 ;; are recommended instead.
9308 ;; This function might do hidden buffer changes.
9309 (c-at-statement-start-p))
9310 (make-obsolete 'c-looking-at-bos 'c-at-statement-start-p "22.1")
9312 (defun c-looking-at-inexpr-block (lim containing-sexp &optional check-at-end)
9313 ;; Return non-nil if we're looking at the beginning of a block
9314 ;; inside an expression. The value returned is actually a cons of
9315 ;; either 'inlambda, 'inexpr-statement or 'inexpr-class and the
9316 ;; position of the beginning of the construct.
9318 ;; LIM limits the backward search. CONTAINING-SEXP is the start
9319 ;; position of the closest containing list. If it's nil, the
9320 ;; containing paren isn't used to decide whether we're inside an
9321 ;; expression or not. If both LIM and CONTAINING-SEXP are used, LIM
9322 ;; needs to be farther back.
9324 ;; If CHECK-AT-END is non-nil then extra checks at the end of the
9325 ;; brace block might be done. It should only be used when the
9326 ;; construct can be assumed to be complete, i.e. when the original
9327 ;; starting position was further down than that.
9329 ;; This function might do hidden buffer changes.
9332 (let ((res 'maybe) passed-paren
9333 (closest-lim (or containing-sexp lim (point-min)))
9334 ;; Look at the character after point only as a last resort
9335 ;; when we can't disambiguate.
9336 (block-follows (and (eq (char-after) ?{) (point))))
9338 (while (and (eq res 'maybe)
9339 (progn (c-backward-syntactic-ws)
9340 (> (point) closest-lim))
9342 (progn (backward-char)
9343 (looking-at "[]).]\\|\\w\\|\\s_"))
9344 (c-safe (forward-char)
9345 (goto-char (scan-sexps (point) -1))))
9348 (if (looking-at c-keywords-regexp)
9349 (let ((kw-sym (c-keyword-sym (match-string 1))))
9352 (c-keyword-member kw-sym 'c-inexpr-class-kwds))
9353 (and (not (eq passed-paren ?\[))
9354 (or (not (looking-at c-class-key))
9355 ;; If the class definition is at the start of
9356 ;; a statement, we don't consider it an
9357 ;; in-expression class.
9358 (let ((prev (point)))
9360 (= (c-backward-token-2 1 nil closest-lim) 0)
9361 (eq (char-syntax (char-after)) ?w))
9362 (setq prev (point)))
9364 (not (c-at-statement-start-p)))
9365 ;; Also, in Pike we treat it as an
9366 ;; in-expression class if it's used in an
9367 ;; object clone expression.
9370 (c-major-mode-is 'pike-mode)
9371 (progn (goto-char block-follows)
9372 (zerop (c-forward-token-2 1 t)))
9373 (eq (char-after) ?\())))
9374 (cons 'inexpr-class (point))))
9375 ((c-keyword-member kw-sym 'c-inexpr-block-kwds)
9376 (when (not passed-paren)
9377 (cons 'inexpr-statement (point))))
9378 ((c-keyword-member kw-sym 'c-lambda-kwds)
9379 (when (or (not passed-paren)
9380 (eq passed-paren ?\())
9381 (cons 'inlambda (point))))
9382 ((c-keyword-member kw-sym 'c-block-stmt-kwds)
9387 (if (looking-at "\\s(")
9389 (if (and (eq passed-paren ?\[)
9390 (eq (char-after) ?\[))
9391 ;; Accept several square bracket sexps for
9392 ;; Java array initializations.
9394 (setq passed-paren (char-after))
9399 (when (and c-recognize-paren-inexpr-blocks
9402 (eq (char-after containing-sexp) ?\())
9403 (goto-char containing-sexp)
9404 (if (or (save-excursion
9405 (c-backward-syntactic-ws lim)
9406 (while (and (eq (char-before) ?>)
9407 (c-get-char-property (1- (point))
9409 (c-go-list-backward nil lim))
9410 (c-backward-syntactic-ws lim))
9411 (and (> (point) (or lim (point-min)))
9413 (and c-special-brace-lists
9414 (c-looking-at-special-brace-list)))
9416 (cons 'inexpr-statement (point))))
9420 (defun c-looking-at-inexpr-block-backward (paren-state)
9421 ;; Returns non-nil if we're looking at the end of an in-expression
9422 ;; block, otherwise the same as `c-looking-at-inexpr-block'.
9423 ;; PAREN-STATE is the paren state relevant at the current position.
9425 ;; This function might do hidden buffer changes.
9427 ;; We currently only recognize a block.
9428 (let ((here (point))
9429 (elem (car-safe paren-state))
9431 (when (and (consp elem)
9432 (progn (goto-char (cdr elem))
9433 (c-forward-syntactic-ws here)
9435 (goto-char (car elem))
9436 (if (setq paren-state (cdr paren-state))
9437 (setq containing-sexp (car-safe paren-state)))
9438 (c-looking-at-inexpr-block (c-safe-position containing-sexp
9440 containing-sexp)))))
9442 (defun c-at-macro-vsemi-p (&optional pos)
9443 ;; Is there a "virtual semicolon" at POS or point?
9444 ;; (See cc-defs.el for full details of "virtual semicolons".)
9446 ;; This is true when point is at the last non syntactic WS position on the
9447 ;; line, there is a macro call last on the line, and this particular macro's
9448 ;; name is defined by the regexp `c-vs-macro-regexp' as not needing a
9457 c-macro-with-semi-re
9458 (eq (skip-chars-backward " \t") 0)
9460 ;; Check we've got nothing after this except comments and empty lines
9461 ;; joined by escaped EOLs.
9462 (skip-chars-forward " \t") ; always returns non-nil.
9464 (while ; go over 1 block comment per iteration.
9466 (looking-at "\\(\\\\[\n\r][ \t]*\\)*")
9467 (goto-char (match-end 0))
9469 ((looking-at c-block-comment-start-regexp)
9470 (and (forward-comment 1)
9471 (skip-chars-forward " \t"))) ; always returns non-nil
9472 ((looking-at c-line-comment-start-regexp)
9479 (progn (c-backward-syntactic-ws)
9482 ;; Check for one of the listed macros being before point.
9483 (or (not (eq (char-before) ?\)))
9484 (when (c-go-list-backward)
9485 (c-backward-syntactic-ws)
9487 (c-simple-skip-symbol-backward)
9488 (looking-at c-macro-with-semi-re)
9490 (not (c-in-literal)))))) ; The most expensive check last.
9492 (defun c-macro-vsemi-status-unknown-p () t) ; See cc-defs.el.
9495 ;; `c-guess-basic-syntax' and the functions that precedes it below
9496 ;; implements the main decision tree for determining the syntactic
9497 ;; analysis of the current line of code.
9499 ;; Dynamically bound to t when `c-guess-basic-syntax' is called during
9500 ;; auto newline analysis.
9501 (defvar c-auto-newline-analysis nil)
9503 (defun c-brace-anchor-point (bracepos)
9504 ;; BRACEPOS is the position of a brace in a construct like "namespace
9505 ;; Bar {". Return the anchor point in this construct; this is the
9506 ;; earliest symbol on the brace's line which isn't earlier than
9509 ;; Currently (2007-08-17), "like namespace" means "matches
9510 ;; c-other-block-decl-kwds". It doesn't work with "class" or "struct"
9511 ;; or anything like that.
9513 (let ((boi (c-point 'boi bracepos)))
9514 (goto-char bracepos)
9515 (while (and (> (point) boi)
9516 (not (looking-at c-other-decl-block-key)))
9517 (c-backward-token-2))
9518 (if (> (point) boi) (point) boi))))
9520 (defsubst c-add-syntax (symbol &rest args)
9521 ;; A simple function to prepend a new syntax element to
9522 ;; `c-syntactic-context'. Using `setq' on it is unsafe since it
9523 ;; should always be dynamically bound but since we read it first
9524 ;; we'll fail properly anyway if this function is misused.
9525 (setq c-syntactic-context (cons (cons symbol args)
9526 c-syntactic-context)))
9528 (defsubst c-append-syntax (symbol &rest args)
9529 ;; Like `c-add-syntax' but appends to the end of the syntax list.
9530 ;; (Normally not necessary.)
9531 (setq c-syntactic-context (nconc c-syntactic-context
9532 (list (cons symbol args)))))
9534 (defun c-add-stmt-syntax (syntax-symbol
9539 ;; Add the indicated SYNTAX-SYMBOL to `c-syntactic-context', extending it as
9540 ;; needed with further syntax elements of the types `substatement',
9541 ;; `inexpr-statement', `arglist-cont-nonempty', `statement-block-intro', and
9542 ;; `defun-block-intro'.
9544 ;; Do the generic processing to anchor the given syntax symbol on
9545 ;; the preceding statement: Skip over any labels and containing
9546 ;; statements on the same line, and then search backward until we
9547 ;; find a statement or block start that begins at boi without a
9548 ;; label or comment.
9550 ;; Point is assumed to be at the prospective anchor point for the
9551 ;; given SYNTAX-SYMBOL. More syntax entries are added if we need to
9552 ;; skip past open parens and containing statements. Most of the added
9553 ;; syntax elements will get the same anchor point - the exception is
9554 ;; for an anchor in a construct like "namespace"[*] - this is as early
9555 ;; as possible in the construct but on the same line as the {.
9557 ;; [*] i.e. with a keyword matching c-other-block-decl-kwds.
9559 ;; SYNTAX-EXTRA-ARGS are a list of the extra arguments for the
9560 ;; syntax symbol. They are appended after the anchor point.
9562 ;; If STOP-AT-BOI-ONLY is nil, we can stop in the middle of the line
9563 ;; if the current statement starts there.
9565 ;; Note: It's not a problem if PAREN-STATE "overshoots"
9566 ;; CONTAINING-SEXP, i.e. contains info about parens further down.
9568 ;; This function might do hidden buffer changes.
9570 (if (= (point) (c-point 'boi))
9571 ;; This is by far the most common case, so let's give it special
9573 (apply 'c-add-syntax syntax-symbol (point) syntax-extra-args)
9575 (let ((syntax-last c-syntactic-context)
9576 (boi (c-point 'boi))
9577 ;; Set when we're on a label, so that we don't stop there.
9578 ;; FIXME: To be complete we should check if we're on a label
9579 ;; now at the start.
9582 ;; Use point as the anchor point for "namespace", "extern", etc.
9583 (apply 'c-add-syntax syntax-symbol
9584 (if (rassq syntax-symbol c-other-decl-block-key-in-symbols-alist)
9588 ;; Loop while we have to back out of containing blocks.
9591 (catch 'back-up-block
9593 ;; Loop while we have to back up statements.
9594 (while (or (/= (point) boi)
9596 (looking-at c-comment-start-regexp))
9598 ;; Skip past any comments that stands between the
9599 ;; statement start and boi.
9600 (let ((savepos (point)))
9601 (while (and (/= savepos boi)
9602 (c-backward-single-comment))
9603 (setq savepos (point)
9604 boi (c-point 'boi)))
9605 (goto-char savepos))
9607 ;; Skip to the beginning of this statement or backward
9609 (let ((old-pos (point))
9611 (step-type (c-beginning-of-statement-1 containing-sexp)))
9612 (setq boi (c-point 'boi)
9613 on-label (eq step-type 'label))
9615 (cond ((= (point) old-pos)
9616 ;; If we didn't move we're at the start of a block and
9617 ;; have to continue outside it.
9618 (throw 'back-up-block t))
9620 ((and (eq step-type 'up)
9621 (>= (point) old-boi)
9622 (looking-at "else\\>[^_]")
9625 (looking-at "if\\>[^_]")))
9626 ;; Special case to avoid deeper and deeper indentation
9627 ;; of "else if" clauses.
9630 ((and (not stop-at-boi-only)
9631 (/= old-pos old-boi)
9632 (memq step-type '(up previous)))
9633 ;; If stop-at-boi-only is nil, we shouldn't back up
9634 ;; over previous or containing statements to try to
9635 ;; reach boi, so go back to the last position and
9638 (throw 'back-up-block nil))
9641 (if (and (not stop-at-boi-only)
9642 (memq step-type '(up previous beginning)))
9643 ;; If we've moved into another statement then we
9644 ;; should no longer try to stop in the middle of a
9646 (setq stop-at-boi-only t))
9648 ;; Record this as a substatement if we skipped up one
9650 (when (eq step-type 'up)
9651 (c-add-syntax 'substatement nil))))
9656 ;; Now we have to go out of this block.
9657 (goto-char containing-sexp)
9659 ;; Don't stop in the middle of a special brace list opener
9661 (when c-special-brace-lists
9662 (let ((special-list (c-looking-at-special-brace-list)))
9663 (when (and special-list
9664 (< (car (car special-list)) (point)))
9665 (setq containing-sexp (car (car special-list)))
9666 (goto-char containing-sexp))))
9668 (setq paren-state (c-whack-state-after containing-sexp paren-state)
9669 containing-sexp (c-most-enclosing-brace paren-state)
9672 ;; Analyze the construct in front of the block we've stepped out
9673 ;; from and add the right syntactic element for it.
9674 (let ((paren-pos (point))
9675 (paren-char (char-after))
9678 (if (eq paren-char ?\()
9679 ;; Stepped out of a parenthesis block, so we're in an
9682 (when (/= paren-pos boi)
9683 (if (and c-recognize-paren-inexpr-blocks
9685 (c-backward-syntactic-ws containing-sexp)
9686 (or (not (looking-at "\\>"))
9687 (not (c-on-identifier))))
9689 (goto-char (1+ paren-pos))
9690 (c-forward-syntactic-ws)
9691 (eq (char-after) ?{)))
9692 ;; Stepped out of an in-expression statement. This
9693 ;; syntactic element won't get an anchor pos.
9694 (c-add-syntax 'inexpr-statement)
9696 ;; A parenthesis normally belongs to an arglist.
9697 (c-add-syntax 'arglist-cont-nonempty nil paren-pos)))
9701 (1+ containing-sexp)
9703 (setq step-type 'same
9706 ;; Stepped out of a brace block.
9707 (setq step-type (c-beginning-of-statement-1 containing-sexp)
9708 on-label (eq step-type 'label))
9710 (if (and (eq step-type 'same)
9711 (/= paren-pos (point)))
9715 (goto-char paren-pos)
9716 (setq inexpr (c-looking-at-inexpr-block
9717 (c-safe-position containing-sexp paren-state)
9719 (c-add-syntax (if (eq (car inexpr) 'inlambda)
9721 'statement-block-intro)
9723 ((looking-at c-other-decl-block-key)
9725 (cdr (assoc (match-string 1)
9726 c-other-decl-block-key-in-symbols-alist))
9727 (max (c-point 'boi paren-pos) (point))))
9728 (t (c-add-syntax 'defun-block-intro nil))))
9730 (c-add-syntax 'statement-block-intro nil)))
9732 (if (= paren-pos boi)
9733 ;; Always done if the open brace was at boi. The
9734 ;; c-beginning-of-statement-1 call above is necessary
9735 ;; anyway, to decide the type of block-intro to add.
9736 (goto-char paren-pos)
9737 (setq boi (c-point 'boi)))
9740 ;; Fill in the current point as the anchor for all the symbols
9742 (let ((p c-syntactic-context) q)
9743 (while (not (eq p syntax-last))
9744 (setq q (cdr (car p))) ; e.g. (nil 28) [from (arglist-cont-nonempty nil 28)]
9752 (defun c-add-class-syntax (symbol
9753 containing-decl-open
9754 containing-decl-start
9757 ;; The inclass and class-close syntactic symbols are added in
9758 ;; several places and some work is needed to fix everything.
9759 ;; Therefore it's collected here.
9761 ;; This function might do hidden buffer changes.
9762 (goto-char containing-decl-open)
9763 (if (and (eq symbol 'inclass) (= (point) (c-point 'boi)))
9765 (c-add-syntax symbol containing-decl-open)
9766 containing-decl-open)
9767 (goto-char containing-decl-start)
9768 ;; Ought to use `c-add-stmt-syntax' instead of backing up to boi
9769 ;; here, but we have to do like this for compatibility.
9770 (back-to-indentation)
9771 (c-add-syntax symbol (point))
9772 (if (and (c-keyword-member containing-decl-kwd
9773 'c-inexpr-class-kwds)
9774 (/= containing-decl-start (c-point 'boi containing-decl-start)))
9775 (c-add-syntax 'inexpr-class))
9778 (defun c-guess-continued-construct (indent-point
9780 beg-of-same-or-containing-stmt
9783 ;; This function contains the decision tree reached through both
9784 ;; cases 18 and 10. It's a continued statement or top level
9785 ;; construct of some kind.
9787 ;; This function might do hidden buffer changes.
9789 (let (special-brace-list placeholder)
9790 (goto-char indent-point)
9791 (skip-chars-forward " \t")
9794 ;; (CASE A removed.)
9795 ;; CASE B: open braces for class or brace-lists
9796 ((setq special-brace-list
9797 (or (and c-special-brace-lists
9798 (c-looking-at-special-brace-list))
9799 (eq char-after-ip ?{)))
9802 ;; CASE B.1: class-open
9804 (and (eq (char-after) ?{)
9805 (c-looking-at-decl-block containing-sexp t)
9806 (setq beg-of-same-or-containing-stmt (point))))
9807 (c-add-syntax 'class-open beg-of-same-or-containing-stmt))
9809 ;; CASE B.2: brace-list-open
9810 ((or (consp special-brace-list)
9812 (goto-char beg-of-same-or-containing-stmt)
9813 (c-syntactic-re-search-forward "=\\([^=]\\|$\\)"
9814 indent-point t t t)))
9815 ;; The most semantically accurate symbol here is
9816 ;; brace-list-open, but we normally report it simply as a
9817 ;; statement-cont. The reason is that one normally adjusts
9818 ;; brace-list-open for brace lists as top-level constructs,
9819 ;; and brace lists inside statements is a completely different
9820 ;; context. C.f. case 5A.3.
9821 (c-beginning-of-statement-1 containing-sexp)
9822 (c-add-stmt-syntax (if c-auto-newline-analysis
9823 ;; Turn off the dwim above when we're
9824 ;; analyzing the nature of the brace
9825 ;; for the auto newline feature.
9829 containing-sexp paren-state))
9831 ;; CASE B.3: The body of a function declared inside a normal
9832 ;; block. Can occur e.g. in Pike and when using gcc
9833 ;; extensions, but watch out for macros followed by blocks.
9834 ;; C.f. cases E, 16F and 17G.
9835 ((and (not (c-at-statement-start-p))
9836 (eq (c-beginning-of-statement-1 containing-sexp nil nil t)
9839 (let ((c-recognize-typeless-decls nil))
9840 ;; Turn off recognition of constructs that lacks a
9841 ;; type in this case, since that's more likely to be
9842 ;; a macro followed by a block.
9843 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
9844 (c-add-stmt-syntax 'defun-open nil t
9845 containing-sexp paren-state))
9847 ;; CASE B.4: Continued statement with block open. The most
9848 ;; accurate analysis is perhaps `statement-cont' together with
9849 ;; `block-open' but we play DWIM and use `substatement-open'
9850 ;; instead. The rationale is that this typically is a macro
9851 ;; followed by a block which makes it very similar to a
9852 ;; statement with a substatement block.
9854 (c-add-stmt-syntax 'substatement-open nil nil
9855 containing-sexp paren-state))
9858 ;; CASE C: iostream insertion or extraction operator
9859 ((and (looking-at "\\(<<\\|>>\\)\\([^=]\\|$\\)")
9861 (goto-char beg-of-same-or-containing-stmt)
9862 ;; If there is no preceding streamop in the statement
9863 ;; then indent this line as a normal statement-cont.
9864 (when (c-syntactic-re-search-forward
9865 "\\(<<\\|>>\\)\\([^=]\\|$\\)" indent-point 'move t t)
9866 (c-add-syntax 'stream-op (c-point 'boi))
9869 ;; CASE E: In the "K&R region" of a function declared inside a
9870 ;; normal block. C.f. case B.3.
9871 ((and (save-excursion
9872 ;; Check that the next token is a '{'. This works as
9873 ;; long as no language that allows nested function
9874 ;; definitions allows stuff like member init lists, K&R
9875 ;; declarations or throws clauses there.
9877 ;; Note that we do a forward search for something ahead
9878 ;; of the indentation line here. That's not good since
9879 ;; the user might not have typed it yet. Unfortunately
9880 ;; it's exceedingly tricky to recognize a function
9881 ;; prototype in a code block without resorting to this.
9882 (c-forward-syntactic-ws)
9883 (eq (char-after) ?{))
9884 (not (c-at-statement-start-p))
9885 (eq (c-beginning-of-statement-1 containing-sexp nil nil t)
9888 (let ((c-recognize-typeless-decls nil))
9889 ;; Turn off recognition of constructs that lacks a
9890 ;; type in this case, since that's more likely to be
9891 ;; a macro followed by a block.
9892 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
9893 (c-add-stmt-syntax 'func-decl-cont nil t
9894 containing-sexp paren-state))
9896 ;;CASE F: continued statement and the only preceding items are
9898 ((and (c-major-mode-is 'java-mode)
9899 (setq placeholder (point))
9900 (c-beginning-of-statement-1)
9902 (while (and (c-forward-annotation)
9903 (< (point) placeholder))
9904 (c-forward-syntactic-ws))
9907 (>= (point) placeholder)
9908 (goto-char placeholder)))
9909 (c-beginning-of-statement-1 containing-sexp)
9910 (c-add-syntax 'annotation-var-cont (point)))
9912 ;; CASE G: a template list continuation?
9913 ;; Mostly a duplication of case 5D.3 to fix templates-19:
9914 ((and (c-major-mode-is 'c++-mode)
9916 (goto-char indent-point)
9917 (c-with-syntax-table c++-template-syntax-table
9918 (setq placeholder (c-up-list-backward)))
9920 (eq (char-after placeholder) ?<)
9921 (/= (char-before placeholder) ?<)
9923 (goto-char (1+ placeholder))
9924 (not (looking-at c-<-op-cont-regexp))))))
9925 (c-with-syntax-table c++-template-syntax-table
9926 (goto-char placeholder)
9927 (c-beginning-of-statement-1 containing-sexp t))
9929 (c-backward-syntactic-ws containing-sexp)
9930 (eq (char-before) ?<))
9931 ;; In a nested template arglist.
9933 (goto-char placeholder)
9934 (c-syntactic-skip-backward "^,;" containing-sexp t)
9935 (c-forward-syntactic-ws))
9936 (back-to-indentation))
9937 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
9939 (c-add-syntax 'template-args-cont (point) placeholder))
9941 ;; CASE D: continued statement.
9943 (c-beginning-of-statement-1 containing-sexp)
9944 (c-add-stmt-syntax 'statement-cont nil nil
9945 containing-sexp paren-state))
9948 ;; The next autoload was added by RMS on 2005/8/9 - don't know why (ACM,
9951 (defun c-guess-basic-syntax ()
9952 "Return the syntactic context of the current line."
9955 (c-save-buffer-state
9956 ((indent-point (point))
9957 (case-fold-search nil)
9958 ;; A whole ugly bunch of various temporary variables. Have
9959 ;; to declare them here since it's not possible to declare
9960 ;; a variable with only the scope of a cond test and the
9961 ;; following result clauses, and most of this function is a
9962 ;; single gigantic cond. :P
9963 literal char-before-ip before-ws-ip char-after-ip macro-start
9964 in-macro-expr c-syntactic-context placeholder c-in-literal-cache
9965 step-type tmpsymbol keyword injava-inher special-brace-list tmp-pos
9967 ;; The following record some positions for the containing
9968 ;; declaration block if we're directly within one:
9969 ;; `containing-decl-open' is the position of the open
9970 ;; brace. `containing-decl-start' is the start of the
9971 ;; declaration. `containing-decl-kwd' is the keyword
9972 ;; symbol of the keyword that tells what kind of block it
9974 containing-decl-open
9975 containing-decl-start
9977 ;; The open paren of the closest surrounding sexp or nil if
9980 ;; The position after the closest preceding brace sexp
9981 ;; (nested sexps are ignored), or the position after
9982 ;; `containing-sexp' if there is none, or (point-min) if
9983 ;; `containing-sexp' is nil.
9985 ;; The paren state outside `containing-sexp', or at
9986 ;; `indent-point' if `containing-sexp' is nil.
9987 (paren-state (c-parse-state))
9988 ;; There's always at most one syntactic element which got
9989 ;; an anchor pos. It's stored in syntactic-relpos.
9991 (c-stmt-delim-chars c-stmt-delim-chars))
9993 ;; Check if we're directly inside an enclosing declaration
9995 (when (and (setq containing-sexp
9996 (c-most-enclosing-brace paren-state))
9998 (goto-char containing-sexp)
9999 (eq (char-after) ?{))
10001 (c-looking-at-decl-block
10002 (c-most-enclosing-brace paren-state
10005 (setq containing-decl-open containing-sexp
10006 containing-decl-start (point)
10007 containing-sexp nil)
10008 (goto-char placeholder)
10009 (setq containing-decl-kwd (and (looking-at c-keywords-regexp)
10010 (c-keyword-sym (match-string 1)))))
10012 ;; Init some position variables.
10015 (setq containing-sexp (car paren-state)
10016 paren-state (cdr paren-state))
10017 (if (consp containing-sexp)
10019 (goto-char (cdr containing-sexp))
10020 (if (and (c-major-mode-is 'c++-mode)
10021 (c-back-over-member-initializer-braces))
10022 (c-syntactic-skip-backward "^}" nil t))
10025 ;; Ignore balanced paren. The next entry
10026 ;; can't be another one.
10027 (setq containing-sexp (car paren-state)
10028 paren-state (cdr paren-state))
10029 ;; If there is no surrounding open paren then
10030 ;; put the last balanced pair back on paren-state.
10031 (setq paren-state (cons containing-sexp paren-state)
10032 containing-sexp nil)))
10033 (setq lim (1+ containing-sexp))))
10034 (setq lim (point-min)))
10036 ;; If we're in a parenthesis list then ',' delimits the
10037 ;; "statements" rather than being an operator (with the
10038 ;; exception of the "for" clause). This difference is
10039 ;; typically only noticeable when statements are used in macro
10041 (when (and containing-sexp
10042 (eq (char-after containing-sexp) ?\())
10043 (setq c-stmt-delim-chars c-stmt-delim-chars-with-comma))
10044 ;; cache char before and after indent point, and move point to
10045 ;; the most likely position to perform the majority of tests
10046 (goto-char indent-point)
10047 (c-backward-syntactic-ws lim)
10048 (setq before-ws-ip (point)
10049 char-before-ip (char-before))
10050 (goto-char indent-point)
10051 (skip-chars-forward " \t")
10052 (setq char-after-ip (char-after))
10054 ;; are we in a literal?
10055 (setq literal (c-in-literal lim))
10057 ;; now figure out syntactic qualities of the current line
10060 ;; CASE 1: in a string.
10061 ((eq literal 'string)
10062 (c-add-syntax 'string (c-point 'bopl)))
10064 ;; CASE 2: in a C or C++ style comment.
10065 ((and (memq literal '(c c++))
10066 ;; This is a kludge for XEmacs where we use
10067 ;; `buffer-syntactic-context', which doesn't correctly
10068 ;; recognize "\*/" to end a block comment.
10069 ;; `parse-partial-sexp' which is used by
10070 ;; `c-literal-limits' will however do that in most
10071 ;; versions, which results in that we get nil from
10072 ;; `c-literal-limits' even when `c-in-literal' claims
10073 ;; we're inside a comment.
10074 (setq placeholder (c-literal-limits lim)))
10075 (c-add-syntax literal (car placeholder)))
10077 ;; CASE 3: in a cpp preprocessor macro continuation.
10078 ((and (save-excursion
10079 (when (c-beginning-of-macro)
10080 (setq macro-start (point))))
10081 (/= macro-start (c-point 'boi))
10083 (setq tmpsymbol 'cpp-macro-cont)
10084 (or (not c-syntactic-indentation-in-macros)
10086 (goto-char macro-start)
10087 ;; If at the beginning of the body of a #define
10088 ;; directive then analyze as cpp-define-intro
10089 ;; only. Go on with the syntactic analysis
10090 ;; otherwise. in-macro-expr is set if we're in a
10091 ;; cpp expression, i.e. before the #define body
10092 ;; or anywhere in a non-#define directive.
10093 (if (c-forward-to-cpp-define-body)
10094 (let ((indent-boi (c-point 'boi indent-point)))
10095 (setq in-macro-expr (> (point) indent-boi)
10096 tmpsymbol 'cpp-define-intro)
10097 (= (point) indent-boi))
10098 (setq in-macro-expr t)
10100 (c-add-syntax tmpsymbol macro-start)
10101 (setq macro-start nil))
10103 ;; CASE 11: an else clause?
10104 ((looking-at "else\\>[^_]")
10105 (c-beginning-of-statement-1 containing-sexp)
10106 (c-add-stmt-syntax 'else-clause nil t
10107 containing-sexp paren-state))
10109 ;; CASE 12: while closure of a do/while construct?
10110 ((and (looking-at "while\\>[^_]")
10112 (prog1 (eq (c-beginning-of-statement-1 containing-sexp)
10114 (setq placeholder (point)))))
10115 (goto-char placeholder)
10116 (c-add-stmt-syntax 'do-while-closure nil t
10117 containing-sexp paren-state))
10119 ;; CASE 13: A catch or finally clause? This case is simpler
10120 ;; than if-else and do-while, because a block is required
10121 ;; after every try, catch and finally.
10123 (and (cond ((c-major-mode-is 'c++-mode)
10124 (looking-at "catch\\>[^_]"))
10125 ((c-major-mode-is 'java-mode)
10126 (looking-at "\\(catch\\|finally\\)\\>[^_]")))
10127 (and (c-safe (c-backward-syntactic-ws)
10130 (eq (char-after) ?{)
10131 (c-safe (c-backward-syntactic-ws)
10134 (if (eq (char-after) ?\()
10135 (c-safe (c-backward-sexp) t)
10137 (looking-at "\\(try\\|catch\\)\\>[^_]")
10138 (setq placeholder (point))))
10139 (goto-char placeholder)
10140 (c-add-stmt-syntax 'catch-clause nil t
10141 containing-sexp paren-state))
10143 ;; CASE 18: A substatement we can recognize by keyword.
10145 (and c-opt-block-stmt-key
10146 (not (eq char-before-ip ?\;))
10147 (not (c-at-vsemi-p before-ws-ip))
10148 (not (memq char-after-ip '(?\) ?\] ?,)))
10149 (or (not (eq char-before-ip ?}))
10150 (c-looking-at-inexpr-block-backward c-state-cache))
10153 ;; Ought to cache the result from the
10154 ;; c-beginning-of-statement-1 calls here.
10155 (setq placeholder (point))
10156 (while (eq (setq step-type
10157 (c-beginning-of-statement-1 lim))
10159 (if (eq step-type 'previous)
10160 (goto-char placeholder)
10161 (setq placeholder (point))
10162 (if (and (eq step-type 'same)
10163 (not (looking-at c-opt-block-stmt-key)))
10164 ;; Step up to the containing statement if we
10165 ;; stayed in the same one.
10169 (c-beginning-of-statement-1 lim))
10172 (setq placeholder (point))
10173 ;; There was no containing statement after all.
10174 (goto-char placeholder)))))
10176 (if (looking-at c-block-stmt-2-key)
10177 ;; Require a parenthesis after these keywords.
10178 ;; Necessary to catch e.g. synchronized in Java,
10179 ;; which can be used both as statement and
10181 (and (zerop (c-forward-token-2 1 nil))
10182 (eq (char-after) ?\())
10183 (looking-at c-opt-block-stmt-key))))
10185 (if (eq step-type 'up)
10186 ;; CASE 18A: Simple substatement.
10188 (goto-char placeholder)
10190 ((eq char-after-ip ?{)
10191 (c-add-stmt-syntax 'substatement-open nil nil
10192 containing-sexp paren-state))
10194 (goto-char indent-point)
10195 (back-to-indentation)
10197 (c-add-stmt-syntax 'substatement-label nil nil
10198 containing-sexp paren-state))
10200 (c-add-stmt-syntax 'substatement nil nil
10201 containing-sexp paren-state))))
10203 ;; CASE 18B: Some other substatement. This is shared
10205 (c-guess-continued-construct indent-point
10211 ;; CASE 14: A case or default label
10213 (and (looking-at c-label-kwds-regexp)
10214 (or (c-major-mode-is 'idl-mode)
10217 (goto-char containing-sexp)
10218 (eq (char-after) ?{)
10219 (progn (c-backward-syntactic-ws) t)
10220 (eq (char-before) ?\))
10221 (c-go-list-backward)
10222 (progn (c-backward-syntactic-ws) t)
10223 (c-simple-skip-symbol-backward)
10224 (looking-at c-block-stmt-2-key)))))
10225 (if containing-sexp
10227 (goto-char containing-sexp)
10228 (setq lim (c-most-enclosing-brace c-state-cache
10230 (c-backward-to-block-anchor lim)
10231 (c-add-stmt-syntax 'case-label nil t lim paren-state))
10232 ;; Got a bogus label at the top level. In lack of better
10233 ;; alternatives, anchor it on (point-min).
10234 (c-add-syntax 'case-label (point-min))))
10236 ;; CASE 15: any other label
10238 (back-to-indentation)
10239 (and (not (looking-at c-syntactic-ws-start))
10240 (not (looking-at c-label-kwds-regexp))
10241 (c-forward-label)))
10242 (cond (containing-decl-open
10243 (setq placeholder (c-add-class-syntax 'inclass
10244 containing-decl-open
10245 containing-decl-start
10246 containing-decl-kwd
10248 ;; Append access-label with the same anchor point as
10250 (c-append-syntax 'access-label placeholder))
10253 (goto-char containing-sexp)
10254 (setq lim (c-most-enclosing-brace c-state-cache
10258 (if (and (eq (c-beginning-of-statement-1 lim) 'up)
10259 (looking-at "switch\\>[^_]"))
10260 ;; If the surrounding statement is a switch then
10261 ;; let's analyze all labels as switch labels, so
10262 ;; that they get lined up consistently.
10265 (c-backward-to-block-anchor lim)
10266 (c-add-stmt-syntax tmpsymbol nil t lim paren-state))
10269 ;; A label on the top level. Treat it as a class
10270 ;; context. (point-min) is the closest we get to the
10271 ;; class open brace.
10272 (c-add-syntax 'access-label (point-min)))))
10274 ;; CASE 4: In-expression statement. C.f. cases 7B, 16A and
10276 ((setq placeholder (c-looking-at-inexpr-block
10277 (c-safe-position containing-sexp paren-state)
10279 ;; Have to turn on the heuristics after
10280 ;; the point even though it doesn't work
10281 ;; very well. C.f. test case class-16.pike.
10283 (setq tmpsymbol (assq (car placeholder)
10284 '((inexpr-class . class-open)
10285 (inexpr-statement . block-open))))
10287 ;; It's a statement block or an anonymous class.
10288 (setq tmpsymbol (cdr tmpsymbol))
10289 ;; It's a Pike lambda. Check whether we are between the
10290 ;; lambda keyword and the argument list or at the defun
10292 (setq tmpsymbol (if (eq char-after-ip ?{)
10294 'lambda-intro-cont)))
10295 (goto-char (cdr placeholder))
10296 (back-to-indentation)
10297 (c-add-stmt-syntax tmpsymbol nil t
10298 (c-most-enclosing-brace c-state-cache (point))
10300 (unless (eq (point) (cdr placeholder))
10301 (c-add-syntax (car placeholder))))
10303 ;; CASE 5: Line is inside a declaration level block or at top level.
10304 ((or containing-decl-open (null containing-sexp))
10307 ;; CASE 5A: we are looking at a defun, brace list, class,
10308 ;; or inline-inclass method opening brace
10309 ((setq special-brace-list
10310 (or (and c-special-brace-lists
10311 (c-looking-at-special-brace-list))
10312 (eq char-after-ip ?{)))
10315 ;; CASE 5A.1: Non-class declaration block open.
10318 (and (eq char-after-ip ?{)
10319 (setq tmp (c-looking-at-decl-block containing-sexp t))
10321 (setq placeholder (point))
10323 (looking-at c-symbol-key))
10325 (c-keyword-sym (setq keyword (match-string 0)))
10326 'c-other-block-decl-kwds))))
10327 (goto-char placeholder)
10329 (if (string-equal keyword "extern")
10330 ;; Special case for extern-lang-open.
10332 (intern (concat keyword "-open")))
10333 nil t containing-sexp paren-state))
10335 ;; CASE 5A.2: we are looking at a class opening brace
10337 (goto-char indent-point)
10338 (skip-chars-forward " \t")
10339 (and (eq (char-after) ?{)
10340 (c-looking-at-decl-block containing-sexp t)
10341 (setq placeholder (point))))
10342 (c-add-syntax 'class-open placeholder))
10344 ;; CASE 5A.3: brace list open
10346 (c-beginning-of-decl-1 lim)
10348 ((looking-at c-specifier-key)
10349 (c-forward-keyword-clause 1))
10350 ((and c-opt-cpp-prefix
10351 (looking-at c-noise-macro-with-parens-name-re))
10352 (c-forward-noise-clause))))
10353 (setq placeholder (c-point 'boi))
10354 (or (consp special-brace-list)
10355 (and (or (save-excursion
10356 (goto-char indent-point)
10357 (setq tmpsymbol nil)
10358 (while (and (> (point) placeholder)
10359 (zerop (c-backward-token-2 1 t))
10360 (not (looking-at "=\\([^=]\\|$\\)")))
10361 (and c-opt-inexpr-brace-list-key
10363 (looking-at c-opt-inexpr-brace-list-key)
10364 (setq tmpsymbol 'topmost-intro-cont)))
10365 (looking-at "=\\([^=]\\|$\\)"))
10366 (looking-at c-brace-list-key))
10368 (while (and (< (point) indent-point)
10369 (zerop (c-forward-token-2 1 t))
10370 (not (memq (char-after) '(?\; ?\()))))
10371 (not (memq (char-after) '(?\; ?\()))
10373 (if (and (not c-auto-newline-analysis)
10374 (c-major-mode-is 'java-mode)
10375 (eq tmpsymbol 'topmost-intro-cont))
10376 ;; We're in Java and have found that the open brace
10377 ;; belongs to a "new Foo[]" initialization list,
10378 ;; which means the brace list is part of an
10379 ;; expression and not a top level definition. We
10380 ;; therefore treat it as any topmost continuation
10381 ;; even though the semantically correct symbol still
10382 ;; is brace-list-open, on the same grounds as in
10385 (c-beginning-of-statement-1 lim)
10386 (c-add-syntax 'topmost-intro-cont (c-point 'boi)))
10387 (c-add-syntax 'brace-list-open placeholder)))
10389 ;; CASE 5A.4: inline defun open
10390 ((and containing-decl-open
10391 (not (c-keyword-member containing-decl-kwd
10392 'c-other-block-decl-kwds)))
10393 (c-add-syntax 'inline-open)
10394 (c-add-class-syntax 'inclass
10395 containing-decl-open
10396 containing-decl-start
10397 containing-decl-kwd
10400 ;; CASE 5A.5: ordinary defun open
10403 (c-beginning-of-decl-1 lim)
10405 ((looking-at c-specifier-key)
10406 (c-forward-keyword-clause 1))
10407 ((and c-opt-cpp-prefix
10408 (looking-at c-noise-macro-with-parens-name-re))
10409 (c-forward-noise-clause))))
10410 (c-add-syntax 'defun-open (c-point 'boi))
10411 ;; Bogus to use bol here, but it's the legacy. (Resolved,
10415 ;; CASE 5R: Member init list. (Used to be part of CASE 5B.1)
10416 ;; Note there is no limit on the backward search here, since member
10417 ;; init lists can, in practice, be very large.
10419 (when (and (c-major-mode-is 'c++-mode)
10420 (setq placeholder (c-back-over-member-initializers)))
10421 (setq tmp-pos (point))))
10422 (if (= (c-point 'bosws) (1+ tmp-pos))
10424 ;; There is no preceding member init clause.
10425 ;; Indent relative to the beginning of indentation
10426 ;; for the topmost-intro line that contains the
10427 ;; prototype's open paren.
10428 (goto-char placeholder)
10429 (c-add-syntax 'member-init-intro (c-point 'boi)))
10430 ;; Indent relative to the first member init clause.
10431 (goto-char (1+ tmp-pos))
10432 (c-forward-syntactic-ws)
10433 (c-add-syntax 'member-init-cont (point))))
10435 ;; CASE 5B: After a function header but before the body (or
10436 ;; the ending semicolon if there's no body).
10438 (when (setq placeholder (c-just-after-func-arglist-p
10439 (max lim (c-determine-limit 500))))
10440 (setq tmp-pos (point))))
10443 ;; CASE 5B.1: Member init list.
10444 ((eq (char-after tmp-pos) ?:)
10445 ;; There is no preceding member init clause.
10446 ;; Indent relative to the beginning of indentation
10447 ;; for the topmost-intro line that contains the
10448 ;; prototype's open paren.
10449 (goto-char placeholder)
10450 (c-add-syntax 'member-init-intro (c-point 'boi)))
10452 ;; CASE 5B.2: K&R arg decl intro
10453 ((and c-recognize-knr-p
10454 (c-in-knr-argdecl lim))
10455 (c-beginning-of-statement-1 lim)
10456 (c-add-syntax 'knr-argdecl-intro (c-point 'boi))
10457 (if containing-decl-open
10458 (c-add-class-syntax 'inclass
10459 containing-decl-open
10460 containing-decl-start
10461 containing-decl-kwd
10464 ;; CASE 5B.4: Nether region after a C++ or Java func
10465 ;; decl, which could include a `throws' declaration.
10467 (c-beginning-of-statement-1 lim)
10468 (c-add-syntax 'func-decl-cont (c-point 'boi))
10471 ;; CASE 5C: inheritance line. could be first inheritance
10472 ;; line, or continuation of a multiple inheritance
10473 ((or (and (c-major-mode-is 'c++-mode)
10475 (when (eq char-after-ip ?,)
10476 (skip-chars-forward " \t")
10478 (looking-at c-opt-postfix-decl-spec-key)))
10479 (and (or (eq char-before-ip ?:)
10480 ;; watch out for scope operator
10482 (and (eq char-after-ip ?:)
10483 (c-safe (forward-char 1) t)
10484 (not (eq (char-after) ?:))
10487 (c-beginning-of-statement-1 lim)
10488 (when (looking-at c-opt-<>-sexp-key)
10489 (goto-char (match-end 1))
10490 (c-forward-syntactic-ws)
10491 (c-forward-<>-arglist nil)
10492 (c-forward-syntactic-ws))
10493 (looking-at c-class-key)))
10495 (and (c-major-mode-is 'java-mode)
10496 (let ((fence (save-excursion
10497 (c-beginning-of-statement-1 lim)
10502 (cond ((looking-at c-opt-postfix-decl-spec-key)
10503 (setq injava-inher (cons cont (point))
10505 ((or (not (c-safe (c-forward-sexp -1) t))
10506 (<= (point) fence))
10511 (not (c-crosses-statement-barrier-p (cdr injava-inher)
10516 ;; CASE 5C.1: non-hanging colon on an inher intro
10517 ((eq char-after-ip ?:)
10518 (c-beginning-of-statement-1 lim)
10519 (c-add-syntax 'inher-intro (c-point 'boi))
10520 ;; don't add inclass symbol since relative point already
10521 ;; contains any class offset
10524 ;; CASE 5C.2: hanging colon on an inher intro
10525 ((eq char-before-ip ?:)
10526 (c-beginning-of-statement-1 lim)
10527 (c-add-syntax 'inher-intro (c-point 'boi))
10528 (if containing-decl-open
10529 (c-add-class-syntax 'inclass
10530 containing-decl-open
10531 containing-decl-start
10532 containing-decl-kwd
10535 ;; CASE 5C.3: in a Java implements/extends
10537 (let ((where (cdr injava-inher))
10538 (cont (car injava-inher)))
10540 (cond ((looking-at "throws\\>[^_]")
10541 (c-add-syntax 'func-decl-cont
10542 (progn (c-beginning-of-statement-1 lim)
10544 (cont (c-add-syntax 'inher-cont where))
10545 (t (c-add-syntax 'inher-intro
10546 (progn (goto-char (cdr injava-inher))
10547 (c-beginning-of-statement-1 lim)
10551 ;; CASE 5C.4: a continued inheritance line
10553 (c-beginning-of-inheritance-list lim)
10554 (c-add-syntax 'inher-cont (point))
10555 ;; don't add inclass symbol since relative point already
10556 ;; contains any class offset
10559 ;; CASE 5P: AWK pattern or function or continuation
10561 ((c-major-mode-is 'awk-mode)
10562 (setq placeholder (point))
10564 (if (and (eq (c-beginning-of-statement-1) 'same)
10565 (/= (point) placeholder))
10566 'topmost-intro-cont
10569 containing-sexp paren-state))
10571 ;; CASE 5D: this could be a top-level initialization, a
10572 ;; member init list continuation, or a template argument
10573 ;; list continuation.
10575 ;; Note: We use the fact that lim is always after any
10576 ;; preceding brace sexp.
10577 (if c-recognize-<>-arglists
10580 (c-syntactic-skip-backward "^;,=<>" lim t)
10583 (when c-overloadable-operators-regexp
10584 (when (setq placeholder (c-after-special-operator-id lim))
10585 (goto-char placeholder)
10588 ((eq (char-before) ?>)
10589 (or (c-backward-<>-arglist nil lim)
10592 ((eq (char-before) ?<)
10594 (if (save-excursion
10595 (c-forward-<>-arglist nil))
10596 (progn (forward-char)
10600 ;; NB: No c-after-special-operator-id stuff in this
10601 ;; clause - we assume only C++ needs it.
10602 (c-syntactic-skip-backward "^;,=" lim t))
10603 (memq (char-before) '(?, ?= ?<)))
10606 ;; CASE 5D.3: perhaps a template list continuation?
10607 ((and (c-major-mode-is 'c++-mode)
10610 (c-with-syntax-table c++-template-syntax-table
10611 (goto-char indent-point)
10612 (setq placeholder (c-up-list-backward))
10614 (eq (char-after placeholder) ?<))))))
10615 (c-with-syntax-table c++-template-syntax-table
10616 (goto-char placeholder)
10617 (c-beginning-of-statement-1 lim t))
10618 (if (save-excursion
10619 (c-backward-syntactic-ws lim)
10620 (eq (char-before) ?<))
10621 ;; In a nested template arglist.
10623 (goto-char placeholder)
10624 (c-syntactic-skip-backward "^,;" lim t)
10625 (c-forward-syntactic-ws))
10626 (back-to-indentation))
10627 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
10629 (c-add-syntax 'template-args-cont (point) placeholder))
10631 ;; CASE 5D.4: perhaps a multiple inheritance line?
10632 ((and (c-major-mode-is 'c++-mode)
10634 (c-beginning-of-statement-1 lim)
10635 (setq placeholder (point))
10636 (if (looking-at "static\\>[^_]")
10637 (c-forward-token-2 1 nil indent-point))
10638 (and (looking-at c-class-key)
10639 (zerop (c-forward-token-2 2 nil indent-point))
10640 (if (eq (char-after) ?<)
10641 (c-with-syntax-table c++-template-syntax-table
10642 (zerop (c-forward-token-2 1 t indent-point)))
10644 (eq (char-after) ?:))))
10645 (goto-char placeholder)
10646 (c-add-syntax 'inher-cont (c-point 'boi)))
10648 ;; CASE 5D.5: Continuation of the "expression part" of a
10649 ;; top level construct. Or, perhaps, an unrecognized construct.
10651 (while (and (setq placeholder (point))
10652 (eq (car (c-beginning-of-decl-1 containing-sexp)) ; Can't use `lim' here.
10655 (c-backward-syntactic-ws)
10656 (eq (char-before) ?}))
10657 (< (point) placeholder)))
10660 ((eq (point) placeholder) 'statement) ; unrecognized construct
10661 ;; A preceding comma at the top level means that a
10662 ;; new variable declaration starts here. Use
10663 ;; topmost-intro-cont for it, for consistency with
10664 ;; the first variable declaration. C.f. case 5N.
10665 ((eq char-before-ip ?,) 'topmost-intro-cont)
10666 (t 'statement-cont))
10667 nil nil containing-sexp paren-state))
10670 ;; CASE 5F: Close of a non-class declaration level block.
10671 ((and (eq char-after-ip ?})
10672 (c-keyword-member containing-decl-kwd
10673 'c-other-block-decl-kwds))
10674 ;; This is inconsistent: Should use `containing-decl-open'
10675 ;; here if it's at boi, like in case 5J.
10676 (goto-char containing-decl-start)
10678 (if (string-equal (symbol-name containing-decl-kwd) "extern")
10679 ;; Special case for compatibility with the
10680 ;; extern-lang syntactic symbols.
10682 (intern (concat (symbol-name containing-decl-kwd)
10685 (c-most-enclosing-brace paren-state (point))
10688 ;; CASE 5G: we are looking at the brace which closes the
10689 ;; enclosing nested class decl
10690 ((and containing-sexp
10691 (eq char-after-ip ?})
10692 (eq containing-decl-open containing-sexp))
10693 (c-add-class-syntax 'class-close
10694 containing-decl-open
10695 containing-decl-start
10696 containing-decl-kwd
10699 ;; CASE 5H: we could be looking at subsequent knr-argdecls
10700 ((and c-recognize-knr-p
10701 (not containing-sexp) ; can't be knr inside braces.
10702 (not (eq char-before-ip ?}))
10704 (setq placeholder (cdr (c-beginning-of-decl-1 lim)))
10706 ;; Do an extra check to avoid tripping up on
10707 ;; statements that occur in invalid contexts
10708 ;; (e.g. in macro bodies where we don't really
10709 ;; know the context of what we're looking at).
10710 (not (and c-opt-block-stmt-key
10711 (looking-at c-opt-block-stmt-key)))))
10712 (< placeholder indent-point))
10713 (goto-char placeholder)
10714 (c-add-syntax 'knr-argdecl (point)))
10716 ;; CASE 5I: ObjC method definition.
10717 ((and c-opt-method-key
10718 (looking-at c-opt-method-key))
10719 (c-beginning-of-statement-1 nil t)
10720 (if (= (point) indent-point)
10721 ;; Handle the case when it's the first (non-comment)
10722 ;; thing in the buffer. Can't look for a 'same return
10723 ;; value from cbos1 since ObjC directives currently
10724 ;; aren't recognized fully, so that we get 'same
10725 ;; instead of 'previous if it moved over a preceding
10727 (goto-char (point-min)))
10728 (c-add-syntax 'objc-method-intro (c-point 'boi)))
10730 ;; CASE 5N: At a variable declaration that follows a class
10731 ;; definition or some other block declaration that doesn't
10732 ;; end at the closing '}'. C.f. case 5D.5.
10734 (c-backward-syntactic-ws lim)
10735 (and (eq (char-before) ?})
10737 (let ((start (point)))
10738 (if (and c-state-cache
10739 (consp (car c-state-cache))
10740 (eq (cdar c-state-cache) (point)))
10741 ;; Speed up the backward search a bit.
10742 (goto-char (caar c-state-cache)))
10743 (c-beginning-of-decl-1 containing-sexp) ; Can't use `lim' here.
10744 (setq placeholder (point))
10745 (if (= start (point))
10746 ;; The '}' is unbalanced.
10749 (>= (point) indent-point))))))
10750 (goto-char placeholder)
10751 (c-add-stmt-syntax 'topmost-intro-cont nil nil
10752 containing-sexp paren-state))
10754 ;; NOTE: The point is at the end of the previous token here.
10756 ;; CASE 5J: we are at the topmost level, make
10757 ;; sure we skip back past any access specifiers
10759 ;; A macro continuation line is never at top level.
10760 (not (and macro-start
10761 (> indent-point macro-start)))
10763 (setq placeholder (point))
10764 (or (memq char-before-ip '(?\; ?{ ?} nil))
10765 (c-at-vsemi-p before-ws-ip)
10766 (when (and (eq char-before-ip ?:)
10767 (eq (c-beginning-of-statement-1 lim)
10769 (c-backward-syntactic-ws lim)
10770 (setq placeholder (point)))
10771 (and (c-major-mode-is 'objc-mode)
10772 (catch 'not-in-directive
10773 (c-beginning-of-statement-1 lim)
10774 (setq placeholder (point))
10775 (while (and (c-forward-objc-directive)
10776 (< (point) indent-point))
10777 (c-forward-syntactic-ws)
10778 (if (>= (point) indent-point)
10779 (throw 'not-in-directive t))
10780 (setq placeholder (point)))
10782 ;; For historic reasons we anchor at bol of the last
10783 ;; line of the previous declaration. That's clearly
10784 ;; highly bogus and useless, and it makes our lives hard
10785 ;; to remain compatible. :P
10786 (goto-char placeholder)
10787 (c-add-syntax 'topmost-intro (c-point 'bol))
10788 (if containing-decl-open
10789 (if (c-keyword-member containing-decl-kwd
10790 'c-other-block-decl-kwds)
10792 (goto-char (c-brace-anchor-point containing-decl-open))
10794 (if (string-equal (symbol-name containing-decl-kwd)
10796 ;; Special case for compatibility with the
10797 ;; extern-lang syntactic symbols.
10799 (intern (concat "in"
10800 (symbol-name containing-decl-kwd))))
10802 (c-most-enclosing-brace paren-state (point))
10804 (c-add-class-syntax 'inclass
10805 containing-decl-open
10806 containing-decl-start
10807 containing-decl-kwd
10809 (when (and c-syntactic-indentation-in-macros
10811 (/= macro-start (c-point 'boi indent-point)))
10812 (c-add-syntax 'cpp-define-intro)
10813 (setq macro-start nil)))
10815 ;; CASE 5K: we are at an ObjC method definition
10816 ;; continuation line.
10817 ((and c-opt-method-key
10819 (c-beginning-of-statement-1 lim)
10820 (beginning-of-line)
10821 (when (looking-at c-opt-method-key)
10822 (setq placeholder (point)))))
10823 (c-add-syntax 'objc-method-args-cont placeholder))
10825 ;; CASE 5L: we are at the first argument of a template
10826 ;; arglist that begins on the previous line.
10827 ((and c-recognize-<>-arglists
10828 (eq (char-before) ?<)
10829 (not (and c-overloadable-operators-regexp
10830 (c-after-special-operator-id lim))))
10831 (c-beginning-of-statement-1 (c-safe-position (point) paren-state))
10832 (c-add-syntax 'template-args-cont (c-point 'boi)))
10834 ;; CASE 5Q: we are at a statement within a macro.
10836 (c-beginning-of-statement-1 containing-sexp)
10837 (c-add-stmt-syntax 'statement nil t containing-sexp paren-state))
10839 ;;CASE 5N: We are at a topmost continuation line and the only
10840 ;;preceding items are annotations.
10841 ((and (c-major-mode-is 'java-mode)
10842 (setq placeholder (point))
10843 (c-beginning-of-statement-1)
10845 (while (and (c-forward-annotation))
10846 (c-forward-syntactic-ws))
10849 (>= (point) placeholder)
10850 (goto-char placeholder)))
10851 (c-add-syntax 'annotation-top-cont (c-point 'boi)))
10853 ;; CASE 5M: we are at a topmost continuation line
10855 (c-beginning-of-statement-1 (c-safe-position (point) paren-state))
10856 (when (c-major-mode-is 'objc-mode)
10857 (setq placeholder (point))
10858 (while (and (c-forward-objc-directive)
10859 (< (point) indent-point))
10860 (c-forward-syntactic-ws)
10861 (setq placeholder (point)))
10862 (goto-char placeholder))
10863 (c-add-syntax 'topmost-intro-cont (c-point 'boi)))
10866 ;; (CASE 6 has been removed.)
10868 ;; CASE 7: line is an expression, not a statement. Most
10869 ;; likely we are either in a function prototype or a function
10870 ;; call argument list
10871 ((not (or (and c-special-brace-lists
10873 (goto-char containing-sexp)
10874 (c-looking-at-special-brace-list)))
10875 (eq (char-after containing-sexp) ?{)))
10878 ;; CASE 7A: we are looking at the arglist closing paren.
10880 ((memq char-after-ip '(?\) ?\]))
10881 (goto-char containing-sexp)
10882 (setq placeholder (c-point 'boi))
10883 (if (and (c-safe (backward-up-list 1) t)
10884 (>= (point) placeholder))
10887 (skip-chars-forward " \t"))
10888 (goto-char placeholder))
10889 (c-add-stmt-syntax 'arglist-close (list containing-sexp) t
10890 (c-most-enclosing-brace paren-state (point))
10893 ;; CASE 7B: Looking at the opening brace of an
10894 ;; in-expression block or brace list. C.f. cases 4, 16A
10896 ((and (eq char-after-ip ?{)
10898 (setq placeholder (c-inside-bracelist-p (point)
10901 (setq tmpsymbol '(brace-list-open . inexpr-class))
10902 (setq tmpsymbol '(block-open . inexpr-statement)
10904 (cdr-safe (c-looking-at-inexpr-block
10905 (c-safe-position containing-sexp
10908 ;; placeholder is nil if it's a block directly in
10909 ;; a function arglist. That makes us skip out of
10912 (goto-char placeholder)
10913 (back-to-indentation)
10914 (c-add-stmt-syntax (car tmpsymbol) nil t
10915 (c-most-enclosing-brace paren-state (point))
10917 (if (/= (point) placeholder)
10918 (c-add-syntax (cdr tmpsymbol))))
10920 ;; CASE 7C: we are looking at the first argument in an empty
10921 ;; argument list. Use arglist-close if we're actually
10922 ;; looking at a close paren or bracket.
10923 ((memq char-before-ip '(?\( ?\[))
10924 (goto-char containing-sexp)
10925 (setq placeholder (c-point 'boi))
10926 (if (and (c-safe (backward-up-list 1) t)
10927 (>= (point) placeholder))
10930 (skip-chars-forward " \t"))
10931 (goto-char placeholder))
10932 (c-add-stmt-syntax 'arglist-intro (list containing-sexp) t
10933 (c-most-enclosing-brace paren-state (point))
10936 ;; CASE 7D: we are inside a conditional test clause. treat
10937 ;; these things as statements
10939 (goto-char containing-sexp)
10940 (and (c-safe (c-forward-sexp -1) t)
10941 (looking-at "\\<for\\>[^_]")))
10942 (goto-char (1+ containing-sexp))
10943 (c-forward-syntactic-ws indent-point)
10944 (if (eq char-before-ip ?\;)
10945 (c-add-syntax 'statement (point))
10946 (c-add-syntax 'statement-cont (point))
10949 ;; CASE 7E: maybe a continued ObjC method call. This is the
10950 ;; case when we are inside a [] bracketed exp, and what
10951 ;; precede the opening bracket is not an identifier.
10952 ((and c-opt-method-key
10953 (eq (char-after containing-sexp) ?\[)
10955 (goto-char (1- containing-sexp))
10956 (c-backward-syntactic-ws (c-point 'bod))
10957 (if (not (looking-at c-symbol-key))
10958 (c-add-syntax 'objc-method-call-cont containing-sexp))
10961 ;; CASE 7F: we are looking at an arglist continuation line,
10962 ;; but the preceding argument is on the same line as the
10963 ;; opening paren. This case includes multi-line
10964 ;; mathematical paren groupings, but we could be on a
10965 ;; for-list continuation line. C.f. case 7A.
10967 (goto-char (1+ containing-sexp))
10969 (c-forward-syntactic-ws)
10972 (goto-char containing-sexp) ; paren opening the arglist
10973 (setq placeholder (c-point 'boi))
10974 (if (and (c-safe (backward-up-list 1) t)
10975 (>= (point) placeholder))
10978 (skip-chars-forward " \t"))
10979 (goto-char placeholder))
10980 (c-add-stmt-syntax 'arglist-cont-nonempty (list containing-sexp) t
10981 (c-most-enclosing-brace c-state-cache (point))
10984 ;; CASE 7G: we are looking at just a normal arglist
10985 ;; continuation line
10986 (t (c-forward-syntactic-ws indent-point)
10987 (c-add-syntax 'arglist-cont (c-point 'boi)))
10990 ;; CASE 8: func-local multi-inheritance line
10991 ((and (c-major-mode-is 'c++-mode)
10993 (goto-char indent-point)
10994 (skip-chars-forward " \t")
10995 (looking-at c-opt-postfix-decl-spec-key)))
10996 (goto-char indent-point)
10997 (skip-chars-forward " \t")
11000 ;; CASE 8A: non-hanging colon on an inher intro
11001 ((eq char-after-ip ?:)
11002 (c-backward-syntactic-ws lim)
11003 (c-add-syntax 'inher-intro (c-point 'boi)))
11005 ;; CASE 8B: hanging colon on an inher intro
11006 ((eq char-before-ip ?:)
11007 (c-add-syntax 'inher-intro (c-point 'boi)))
11009 ;; CASE 8C: a continued inheritance line
11011 (c-beginning-of-inheritance-list lim)
11012 (c-add-syntax 'inher-cont (point))
11015 ;; CASE 9: we are inside a brace-list
11016 ((and (not (c-major-mode-is 'awk-mode)) ; Maybe this isn't needed (ACM, 2002/3/29)
11017 (setq special-brace-list
11018 (or (and c-special-brace-lists ;;;; ALWAYS NIL FOR AWK!!
11020 (goto-char containing-sexp)
11021 (c-looking-at-special-brace-list)))
11022 (c-inside-bracelist-p containing-sexp paren-state))))
11025 ;; CASE 9A: In the middle of a special brace list opener.
11026 ((and (consp special-brace-list)
11028 (goto-char containing-sexp)
11029 (eq (char-after) ?\())
11030 (eq char-after-ip (car (cdr special-brace-list))))
11031 (goto-char (car (car special-brace-list)))
11032 (skip-chars-backward " \t")
11034 (assoc 'statement-cont
11035 (setq placeholder (c-guess-basic-syntax))))
11036 (setq c-syntactic-context placeholder)
11037 (c-beginning-of-statement-1
11038 (c-safe-position (1- containing-sexp) paren-state))
11039 (c-forward-token-2 0)
11041 ((looking-at c-specifier-key)
11042 (c-forward-keyword-clause 1))
11043 ((and c-opt-cpp-prefix
11044 (looking-at c-noise-macro-with-parens-name-re))
11045 (c-forward-noise-clause))))
11046 (c-add-syntax 'brace-list-open (c-point 'boi))))
11048 ;; CASE 9B: brace-list-close brace
11049 ((if (consp special-brace-list)
11050 ;; Check special brace list closer.
11052 (goto-char (car (car special-brace-list)))
11054 (goto-char indent-point)
11055 (back-to-indentation)
11057 ;; We were between the special close char and the `)'.
11058 (and (eq (char-after) ?\))
11059 (eq (1+ (point)) (cdr (car special-brace-list))))
11060 ;; We were before the special close char.
11061 (and (eq (char-after) (cdr (cdr special-brace-list)))
11062 (zerop (c-forward-token-2))
11063 (eq (1+ (point)) (cdr (car special-brace-list)))))))
11064 ;; Normal brace list check.
11065 (and (eq char-after-ip ?})
11066 (c-safe (goto-char (c-up-list-backward (point))) t)
11067 (= (point) containing-sexp)))
11068 (if (eq (point) (c-point 'boi))
11069 (c-add-syntax 'brace-list-close (point))
11070 (setq lim (c-most-enclosing-brace c-state-cache (point)))
11071 (c-beginning-of-statement-1 lim nil nil t)
11072 (c-add-stmt-syntax 'brace-list-close nil t lim paren-state)))
11075 ;; Prepare for the rest of the cases below by going to the
11076 ;; token following the opening brace
11077 (if (consp special-brace-list)
11079 (goto-char (car (car special-brace-list)))
11080 (c-forward-token-2 1 nil indent-point))
11081 (goto-char containing-sexp))
11083 (let ((start (point)))
11084 (c-forward-syntactic-ws indent-point)
11085 (goto-char (max start (c-point 'bol))))
11086 (c-skip-ws-forward indent-point)
11089 ;; CASE 9C: we're looking at the first line in a brace-list
11090 ((= (point) indent-point)
11091 (if (consp special-brace-list)
11092 (goto-char (car (car special-brace-list)))
11093 (goto-char containing-sexp))
11094 (if (eq (point) (c-point 'boi))
11095 (c-add-syntax 'brace-list-intro (point))
11096 (setq lim (c-most-enclosing-brace c-state-cache (point)))
11097 (c-beginning-of-statement-1 lim)
11098 (c-add-stmt-syntax 'brace-list-intro nil t lim paren-state)))
11100 ;; CASE 9D: this is just a later brace-list-entry or
11101 ;; brace-entry-open
11102 (t (if (or (eq char-after-ip ?{)
11103 (and c-special-brace-lists
11105 (goto-char indent-point)
11106 (c-forward-syntactic-ws (c-point 'eol))
11107 (c-looking-at-special-brace-list (point)))))
11108 (c-add-syntax 'brace-entry-open (point))
11109 (c-add-syntax 'brace-list-entry (point))
11113 ;; CASE 10: A continued statement or top level construct.
11114 ((and (not (memq char-before-ip '(?\; ?:)))
11115 (not (c-at-vsemi-p before-ws-ip))
11116 (or (not (eq char-before-ip ?}))
11117 (c-looking-at-inexpr-block-backward c-state-cache))
11120 (c-beginning-of-statement-1 containing-sexp)
11121 (setq placeholder (point))))
11122 (/= placeholder containing-sexp))
11123 ;; This is shared with case 18.
11124 (c-guess-continued-construct indent-point
11130 ;; CASE 16: block close brace, possibly closing the defun or
11132 ((eq char-after-ip ?})
11133 ;; From here on we have the next containing sexp in lim.
11134 (setq lim (c-most-enclosing-brace paren-state))
11135 (goto-char containing-sexp)
11138 ;; CASE 16E: Closing a statement block? This catches
11139 ;; cases where it's preceded by a statement keyword,
11140 ;; which works even when used in an "invalid" context,
11141 ;; e.g. a macro argument.
11142 ((c-after-conditional)
11143 (c-backward-to-block-anchor lim)
11144 (c-add-stmt-syntax 'block-close nil t lim paren-state))
11146 ;; CASE 16A: closing a lambda defun or an in-expression
11147 ;; block? C.f. cases 4, 7B and 17E.
11148 ((setq placeholder (c-looking-at-inexpr-block
11149 (c-safe-position containing-sexp paren-state)
11151 (setq tmpsymbol (if (eq (car placeholder) 'inlambda)
11154 (goto-char containing-sexp)
11155 (back-to-indentation)
11156 (if (= containing-sexp (point))
11157 (c-add-syntax tmpsymbol (point))
11158 (goto-char (cdr placeholder))
11159 (back-to-indentation)
11160 (c-add-stmt-syntax tmpsymbol nil t
11161 (c-most-enclosing-brace paren-state (point))
11163 (if (/= (point) (cdr placeholder))
11164 (c-add-syntax (car placeholder)))))
11166 ;; CASE 16B: does this close an inline or a function in
11167 ;; a non-class declaration level block?
11172 (c-looking-at-decl-block
11173 (c-most-enclosing-brace paren-state lim)
11175 (setq placeholder (point))))
11176 (c-backward-to-decl-anchor lim)
11177 (back-to-indentation)
11178 (if (save-excursion
11179 (goto-char placeholder)
11180 (looking-at c-other-decl-block-key))
11181 (c-add-syntax 'defun-close (point))
11182 (c-add-syntax 'inline-close (point))))
11184 ;; CASE 16F: Can be a defun-close of a function declared
11185 ;; in a statement block, e.g. in Pike or when using gcc
11186 ;; extensions, but watch out for macros followed by
11187 ;; blocks. Let it through to be handled below.
11188 ;; C.f. cases B.3 and 17G.
11190 (and (not (c-at-statement-start-p))
11191 (eq (c-beginning-of-statement-1 lim nil nil t) 'same)
11192 (setq placeholder (point))
11193 (let ((c-recognize-typeless-decls nil))
11194 ;; Turn off recognition of constructs that
11195 ;; lacks a type in this case, since that's more
11196 ;; likely to be a macro followed by a block.
11197 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
11198 (back-to-indentation)
11199 (if (/= (point) containing-sexp)
11200 (goto-char placeholder))
11201 (c-add-stmt-syntax 'defun-close nil t lim paren-state))
11203 ;; CASE 16C: If there is an enclosing brace then this is
11204 ;; a block close since defun closes inside declaration
11205 ;; level blocks have been handled above.
11207 ;; If the block is preceded by a case/switch label on
11208 ;; the same line, we anchor at the first preceding label
11209 ;; at boi. The default handling in c-add-stmt-syntax
11210 ;; really fixes it better, but we do like this to keep
11211 ;; the indentation compatible with version 5.28 and
11212 ;; earlier. C.f. case 17H.
11213 (while (and (/= (setq placeholder (point)) (c-point 'boi))
11214 (eq (c-beginning-of-statement-1 lim) 'label)))
11215 (goto-char placeholder)
11216 (if (looking-at c-label-kwds-regexp)
11217 (c-add-syntax 'block-close (point))
11218 (goto-char containing-sexp)
11219 ;; c-backward-to-block-anchor not necessary here; those
11220 ;; situations are handled in case 16E above.
11221 (c-add-stmt-syntax 'block-close nil t lim paren-state)))
11223 ;; CASE 16D: Only top level defun close left.
11225 (goto-char containing-sexp)
11226 (c-backward-to-decl-anchor lim)
11227 (c-add-stmt-syntax 'defun-close nil nil
11228 (c-most-enclosing-brace paren-state)
11232 ;; CASE 19: line is an expression, not a statement, and is directly
11233 ;; contained by a template delimiter. Most likely, we are in a
11234 ;; template arglist within a statement. This case is based on CASE
11235 ;; 7. At some point in the future, we may wish to create more
11236 ;; syntactic symbols such as `template-intro',
11237 ;; `template-cont-nonempty', etc., and distinguish between them as we
11238 ;; do for `arglist-intro' etc. (2009-12-07).
11239 ((and c-recognize-<>-arglists
11240 (setq containing-< (c-up-list-backward indent-point containing-sexp))
11241 (eq (char-after containing-<) ?\<))
11242 (setq placeholder (c-point 'boi containing-<))
11243 (goto-char containing-sexp) ; Most nested Lbrace/Lparen (but not
11244 ; '<') before indent-point.
11245 (if (>= (point) placeholder)
11248 (skip-chars-forward " \t"))
11249 (goto-char placeholder))
11250 (c-add-stmt-syntax 'template-args-cont (list containing-<) t
11251 (c-most-enclosing-brace c-state-cache (point))
11254 ;; CASE 17: Statement or defun catchall.
11256 (goto-char indent-point)
11257 ;; Back up statements until we find one that starts at boi.
11258 (while (let* ((prev-point (point))
11259 (last-step-type (c-beginning-of-statement-1
11261 (if (= (point) prev-point)
11263 (setq step-type (or step-type last-step-type))
11265 (setq step-type last-step-type)
11266 (/= (point) (c-point 'boi)))))
11269 ;; CASE 17B: continued statement
11270 ((and (eq step-type 'same)
11271 (/= (point) indent-point))
11272 (c-add-stmt-syntax 'statement-cont nil nil
11273 containing-sexp paren-state))
11275 ;; CASE 17A: After a case/default label?
11277 (while (and (eq step-type 'label)
11278 (not (looking-at c-label-kwds-regexp)))
11280 (c-beginning-of-statement-1 containing-sexp)))
11281 (eq step-type 'label))
11282 (c-add-stmt-syntax (if (eq char-after-ip ?{)
11283 'statement-case-open
11284 'statement-case-intro)
11285 nil t containing-sexp paren-state))
11287 ;; CASE 17D: any old statement
11289 (while (eq step-type 'label)
11291 (c-beginning-of-statement-1 containing-sexp)))
11292 (eq step-type 'previous))
11293 (c-add-stmt-syntax 'statement nil t
11294 containing-sexp paren-state)
11295 (if (eq char-after-ip ?{)
11296 (c-add-syntax 'block-open)))
11298 ;; CASE 17I: Inside a substatement block.
11300 ;; The following tests are all based on containing-sexp.
11301 (goto-char containing-sexp)
11302 ;; From here on we have the next containing sexp in lim.
11303 (setq lim (c-most-enclosing-brace paren-state containing-sexp))
11304 (c-after-conditional))
11305 (c-backward-to-block-anchor lim)
11306 (c-add-stmt-syntax 'statement-block-intro nil t
11308 (if (eq char-after-ip ?{)
11309 (c-add-syntax 'block-open)))
11311 ;; CASE 17E: first statement in an in-expression block.
11312 ;; C.f. cases 4, 7B and 16A.
11313 ((setq placeholder (c-looking-at-inexpr-block
11314 (c-safe-position containing-sexp paren-state)
11316 (setq tmpsymbol (if (eq (car placeholder) 'inlambda)
11318 'statement-block-intro))
11319 (back-to-indentation)
11320 (if (= containing-sexp (point))
11321 (c-add-syntax tmpsymbol (point))
11322 (goto-char (cdr placeholder))
11323 (back-to-indentation)
11324 (c-add-stmt-syntax tmpsymbol nil t
11325 (c-most-enclosing-brace c-state-cache (point))
11327 (if (/= (point) (cdr placeholder))
11328 (c-add-syntax (car placeholder))))
11329 (if (eq char-after-ip ?{)
11330 (c-add-syntax 'block-open)))
11332 ;; CASE 17F: first statement in an inline, or first
11333 ;; statement in a top-level defun. we can tell this is it
11334 ;; if there are no enclosing braces that haven't been
11335 ;; narrowed out by a class (i.e. don't use bod here).
11337 (or (not (setq placeholder (c-most-enclosing-brace
11340 (goto-char placeholder)
11341 (eq (char-after) ?{))
11342 (c-looking-at-decl-block (c-most-enclosing-brace
11343 paren-state (point))
11345 (c-backward-to-decl-anchor lim)
11346 (back-to-indentation)
11347 (c-add-syntax 'defun-block-intro (point)))
11349 ;; CASE 17G: First statement in a function declared inside
11350 ;; a normal block. This can occur in Pike and with
11351 ;; e.g. the gcc extensions, but watch out for macros
11352 ;; followed by blocks. C.f. cases B.3 and 16F.
11354 (and (not (c-at-statement-start-p))
11355 (eq (c-beginning-of-statement-1 lim nil nil t) 'same)
11356 (setq placeholder (point))
11357 (let ((c-recognize-typeless-decls nil))
11358 ;; Turn off recognition of constructs that lacks
11359 ;; a type in this case, since that's more likely
11360 ;; to be a macro followed by a block.
11361 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
11362 (back-to-indentation)
11363 (if (/= (point) containing-sexp)
11364 (goto-char placeholder))
11365 (c-add-stmt-syntax 'defun-block-intro nil t
11368 ;; CASE 17H: First statement in a block.
11370 ;; If the block is preceded by a case/switch label on the
11371 ;; same line, we anchor at the first preceding label at
11372 ;; boi. The default handling in c-add-stmt-syntax is
11373 ;; really fixes it better, but we do like this to keep the
11374 ;; indentation compatible with version 5.28 and earlier.
11376 (while (and (/= (setq placeholder (point)) (c-point 'boi))
11377 (eq (c-beginning-of-statement-1 lim) 'label)))
11378 (goto-char placeholder)
11379 (if (looking-at c-label-kwds-regexp)
11380 (c-add-syntax 'statement-block-intro (point))
11381 (goto-char containing-sexp)
11382 ;; c-backward-to-block-anchor not necessary here; those
11383 ;; situations are handled in case 17I above.
11384 (c-add-stmt-syntax 'statement-block-intro nil t
11386 (if (eq char-after-ip ?{)
11387 (c-add-syntax 'block-open)))
11391 ;; now we need to look at any modifiers
11392 (goto-char indent-point)
11393 (skip-chars-forward " \t")
11395 ;; are we looking at a comment only line?
11396 (when (and (looking-at c-comment-start-regexp)
11397 (/= (c-forward-token-2 0 nil (c-point 'eol)) 0))
11398 (c-append-syntax 'comment-intro))
11400 ;; we might want to give additional offset to friends (in C++).
11401 (when (and c-opt-friend-key
11402 (looking-at c-opt-friend-key))
11403 (c-append-syntax 'friend))
11405 ;; Set syntactic-relpos.
11406 (let ((p c-syntactic-context))
11408 (if (integerp (c-langelem-pos (car p)))
11410 (setq syntactic-relpos (c-langelem-pos (car p)))
11415 ;; Start of or a continuation of a preprocessor directive?
11416 (if (and macro-start
11417 (eq macro-start (c-point 'boi))
11418 (not (and (c-major-mode-is 'pike-mode)
11419 (eq (char-after (1+ macro-start)) ?\"))))
11420 (c-append-syntax 'cpp-macro)
11421 (when (and c-syntactic-indentation-in-macros macro-start)
11424 (< syntactic-relpos macro-start)
11426 (assq 'arglist-intro c-syntactic-context)
11427 (assq 'arglist-cont c-syntactic-context)
11428 (assq 'arglist-cont-nonempty c-syntactic-context)
11429 (assq 'arglist-close c-syntactic-context))))
11430 ;; If inside a cpp expression, i.e. anywhere in a
11431 ;; cpp directive except a #define body, we only let
11432 ;; through the syntactic analysis that is internal
11433 ;; in the expression. That means the arglist
11434 ;; elements, if they are anchored inside the cpp
11436 (setq c-syntactic-context nil)
11437 (c-add-syntax 'cpp-macro-cont macro-start))
11438 (when (and (eq macro-start syntactic-relpos)
11439 (not (assq 'cpp-define-intro c-syntactic-context))
11441 (goto-char macro-start)
11442 (or (not (c-forward-to-cpp-define-body))
11443 (<= (point) (c-point 'boi indent-point)))))
11444 ;; Inside a #define body and the syntactic analysis is
11445 ;; anchored on the start of the #define. In this case
11446 ;; we add cpp-define-intro to get the extra
11447 ;; indentation of the #define body.
11448 (c-add-syntax 'cpp-define-intro)))))
11450 ;; return the syntax
11451 c-syntactic-context)))
11454 ;; Indentation calculation.
11456 (defun c-evaluate-offset (offset langelem symbol)
11457 ;; offset can be a number, a function, a variable, a list, or one of
11458 ;; the symbols + or -
11460 ;; This function might do hidden buffer changes.
11463 ((numberp offset) offset)
11464 ((vectorp offset) offset)
11465 ((null offset) nil)
11467 ((eq offset '+) c-basic-offset)
11468 ((eq offset '-) (- c-basic-offset))
11469 ((eq offset '++) (* 2 c-basic-offset))
11470 ((eq offset '--) (* 2 (- c-basic-offset)))
11471 ((eq offset '*) (/ c-basic-offset 2))
11472 ((eq offset '/) (/ (- c-basic-offset) 2))
11474 ((functionp offset)
11477 (cons (c-langelem-sym langelem)
11478 (c-langelem-pos langelem)))
11483 ((eq (car offset) 'quote)
11484 (c-benign-error "The offset %S for %s was mistakenly quoted"
11488 ((memq (car offset) '(min max))
11489 (let (res val (method (car offset)))
11490 (setq offset (cdr offset))
11492 (setq val (c-evaluate-offset (car offset) langelem symbol))
11500 Error evaluating offset %S for %s: \
11501 Cannot combine absolute offset %S with relative %S in `%s' method"
11502 (car offset) symbol res val method)
11503 (setq res (funcall method res val))))
11507 Error evaluating offset %S for %s: \
11508 Cannot combine relative offset %S with absolute %S in `%s' method"
11509 (car offset) symbol res val method)
11510 (setq res (vector (funcall method (aref res 0)
11512 (setq offset (cdr offset)))
11515 ((eq (car offset) 'add)
11517 (setq offset (cdr offset))
11519 (setq val (c-evaluate-offset (car offset) langelem symbol))
11526 (setq res (vector (+ (aref res 0) val)))
11527 (setq res (+ res val))))
11531 Error evaluating offset %S for %s: \
11532 Cannot combine absolute offsets %S and %S in `add' method"
11533 (car offset) symbol res val)
11534 (setq res val)))) ; Override.
11535 (setq offset (cdr offset)))
11540 (when (eq (car offset) 'first)
11541 (setq offset (cdr offset)))
11542 (while (and (not res) offset)
11543 (setq res (c-evaluate-offset (car offset) langelem symbol)
11544 offset (cdr offset)))
11547 ((and (symbolp offset) (boundp offset))
11548 (symbol-value offset))
11551 (c-benign-error "Unknown offset format %S for %s" offset symbol)
11554 (if (or (null res) (integerp res)
11555 (and (vectorp res) (= (length res) 1) (integerp (aref res 0))))
11557 (c-benign-error "Error evaluating offset %S for %s: Got invalid value %S"
11561 (defun c-calc-offset (langelem)
11562 ;; Get offset from LANGELEM which is a list beginning with the
11563 ;; syntactic symbol and followed by any analysis data it provides.
11564 ;; That data may be zero or more elements, but if at least one is
11565 ;; given then the first is the anchor position (or nil). The symbol
11566 ;; is matched against `c-offsets-alist' and the offset calculated
11567 ;; from that is returned.
11569 ;; This function might do hidden buffer changes.
11570 (let* ((symbol (c-langelem-sym langelem))
11571 (match (assq symbol c-offsets-alist))
11572 (offset (cdr-safe match)))
11574 (setq offset (c-evaluate-offset offset langelem symbol))
11575 (if c-strict-syntax-p
11576 (c-benign-error "No offset found for syntactic symbol %s" symbol))
11578 (if (vectorp offset)
11580 (or (and (numberp offset) offset)
11581 (and (symbolp offset) (symbol-value offset))
11585 (defun c-get-offset (langelem)
11586 ;; This is a compatibility wrapper for `c-calc-offset' in case
11587 ;; someone is calling it directly. It takes an old style syntactic
11588 ;; element on the form (SYMBOL . ANCHOR-POS) and converts it to the
11591 ;; This function might do hidden buffer changes.
11592 (if (c-langelem-pos langelem)
11593 (c-calc-offset (list (c-langelem-sym langelem)
11594 (c-langelem-pos langelem)))
11595 (c-calc-offset langelem)))
11597 (defun c-get-syntactic-indentation (langelems)
11598 ;; Calculate the syntactic indentation from a syntactic description
11599 ;; as returned by `c-guess-syntax'.
11601 ;; Note that topmost-intro always has an anchor position at bol, for
11602 ;; historical reasons. It's often used together with other symbols
11603 ;; that has more sane positions. Since we always use the first
11604 ;; found anchor position, we rely on that these other symbols always
11605 ;; precede topmost-intro in the LANGELEMS list.
11607 ;; This function might do hidden buffer changes.
11608 (let ((indent 0) anchor)
11611 (let* ((c-syntactic-element (car langelems))
11612 (res (c-calc-offset c-syntactic-element)))
11615 ;; Got an absolute column that overrides any indentation
11616 ;; we've collected so far, but not the relative
11617 ;; indentation we might get for the nested structures
11618 ;; further down the langelems list.
11619 (setq indent (elt res 0)
11620 anchor (point-min)) ; A position at column 0.
11622 ;; Got a relative change of the current calculated
11624 (setq indent (+ indent res))
11626 ;; Use the anchor position from the first syntactic
11627 ;; element with one.
11629 (setq anchor (c-langelem-pos (car langelems)))))
11631 (setq langelems (cdr langelems))))
11634 (+ indent (save-excursion
11640 (cc-provide 'cc-engine)
11642 ;; Local Variables:
11643 ;; indent-tabs-mode: t
11646 ;;; cc-engine.el ends here