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 (setq c-parse-state-state
3507 (let ((val (symbol-value arg)))
3509 (cond ((consp val) (copy-tree val))
3510 ((markerp val) (copy-marker val))
3513 c-state-cache-good-pos
3514 c-state-nonlit-pos-cache
3515 c-state-nonlit-pos-cache-limit
3516 c-state-semi-nonlit-pos-cache
3517 c-state-semi-nonlit-pos-cache-limit
3518 c-state-brace-pair-desert
3520 c-state-point-min-lit-type
3521 c-state-point-min-lit-start
3522 c-state-min-scan-pos
3525 c-parse-state-point))))
3526 (defun c-replay-parse-state-state ()
3531 (format "%s %s%s" (car arg)
3532 (if (atom (cdr arg)) "" "'")
3533 (if (markerp (cdr arg))
3534 (format "(copy-marker %s)" (marker-position (cdr arg)))
3536 c-parse-state-state " ")
3539 (defun c-debug-parse-state-double-cons (state)
3540 (let (state-car conses-not-ok)
3542 (setq state-car (car state)
3544 (if (and (consp state-car)
3545 (consp (car state)))
3546 (setq conses-not-ok t)))
3549 (defun c-debug-parse-state ()
3550 (let ((here (point)) (res1 (c-real-parse-state)) res2)
3551 (let ((c-state-cache nil)
3552 (c-state-cache-good-pos 1)
3553 (c-state-nonlit-pos-cache nil)
3554 (c-state-nonlit-pos-cache-limit 1)
3555 (c-state-brace-pair-desert nil)
3556 (c-state-point-min 1)
3557 (c-state-point-min-lit-type nil)
3558 (c-state-point-min-lit-start nil)
3559 (c-state-min-scan-pos 1)
3560 (c-state-old-cpp-beg nil)
3561 (c-state-old-cpp-end nil))
3562 (setq res2 (c-real-parse-state)))
3563 (unless (equal res1 res2)
3564 ;; The cache can actually go further back due to the ad-hoc way
3565 ;; the first paren is found, so try to whack off a bit of its
3566 ;; start before complaining.
3568 ;; (goto-char (or (c-least-enclosing-brace res2) (point)))
3569 ;; (c-beginning-of-defun-1)
3570 ;; (while (not (or (bobp) (eq (char-after) ?{)))
3571 ;; (c-beginning-of-defun-1))
3572 ;; (unless (equal (c-whack-state-before (point) res1) res2)
3573 ;; (message (concat "c-parse-state inconsistency at %s: "
3574 ;; "using cache: %s, from scratch: %s")
3575 ;; here res1 res2)))
3576 (message (concat "c-parse-state inconsistency at %s: "
3577 "using cache: %s, from scratch: %s")
3579 (message "Old state:")
3580 (c-replay-parse-state-state))
3582 (when (c-debug-parse-state-double-cons res1)
3583 (message "c-parse-state INVALIDITY at %s: %s"
3585 (message "Old state:")
3586 (c-replay-parse-state-state))
3588 (c-record-parse-state-state)
3589 res2 ; res1 correct a cascading series of errors ASAP
3592 (defun c-toggle-parse-state-debug (&optional arg)
3594 (setq c-debug-parse-state (c-calculate-state arg c-debug-parse-state))
3595 (fset 'c-parse-state (symbol-function (if c-debug-parse-state
3596 'c-debug-parse-state
3597 'c-real-parse-state)))
3598 (c-keep-region-active)
3599 (message "c-debug-parse-state %sabled"
3600 (if c-debug-parse-state "en" "dis")))
3601 (when c-debug-parse-state
3602 (c-toggle-parse-state-debug 1))
3605 (defun c-whack-state-before (bufpos paren-state)
3606 ;; Whack off any state information from PAREN-STATE which lies
3607 ;; before BUFPOS. Not destructive on PAREN-STATE.
3608 (let* ((newstate (list nil))
3612 (setq car (car paren-state)
3613 paren-state (cdr paren-state))
3614 (if (< (if (consp car) (car car) car) bufpos)
3615 (setq paren-state nil)
3616 (setcdr ptr (list car))
3617 (setq ptr (cdr ptr))))
3620 (defun c-whack-state-after (bufpos paren-state)
3621 ;; Whack off any state information from PAREN-STATE which lies at or
3622 ;; after BUFPOS. Not destructive on PAREN-STATE.
3625 (let ((car (car paren-state)))
3627 ;; just check the car, because in a balanced brace
3628 ;; expression, it must be impossible for the corresponding
3629 ;; close brace to be before point, but the open brace to
3631 (if (<= bufpos (car car))
3633 (if (< bufpos (cdr car))
3634 ;; its possible that the open brace is before
3635 ;; bufpos, but the close brace is after. In that
3636 ;; case, convert this to a non-cons element. The
3637 ;; rest of the state is before bufpos, so we're
3639 (throw 'done (cons (car car) (cdr paren-state)))
3640 ;; we know that both the open and close braces are
3641 ;; before bufpos, so we also know that everything else
3642 ;; on state is before bufpos.
3643 (throw 'done paren-state)))
3646 ;; it's before bufpos, so everything else should too.
3647 (throw 'done paren-state)))
3648 (setq paren-state (cdr paren-state)))
3651 (defun c-most-enclosing-brace (paren-state &optional bufpos)
3652 ;; Return the bufpos of the innermost enclosing open paren before
3653 ;; bufpos, or nil if none was found.
3655 (or bufpos (setq bufpos 134217727))
3657 (setq enclosingp (car paren-state)
3658 paren-state (cdr paren-state))
3659 (if (or (consp enclosingp)
3660 (>= enclosingp bufpos))
3661 (setq enclosingp nil)
3662 (setq paren-state nil)))
3665 (defun c-least-enclosing-brace (paren-state)
3666 ;; Return the bufpos of the outermost enclosing open paren, or nil
3667 ;; if none was found.
3670 (setq elem (car paren-state)
3671 paren-state (cdr paren-state))
3676 (defun c-safe-position (bufpos paren-state)
3677 ;; Return the closest "safe" position recorded on PAREN-STATE that
3678 ;; is higher up than BUFPOS. Return nil if PAREN-STATE doesn't
3679 ;; contain any. Return nil if BUFPOS is nil, which is useful to
3680 ;; find the closest limit before a given limit that might be nil.
3682 ;; A "safe" position is a position at or after a recorded open
3683 ;; paren, or after a recorded close paren. The returned position is
3684 ;; thus either the first position after a close brace, or the first
3685 ;; position after an enclosing paren, or at the enclosing paren in
3686 ;; case BUFPOS is immediately after it.
3691 (setq elem (car paren-state))
3693 (cond ((< (cdr elem) bufpos)
3694 (throw 'done (cdr elem)))
3695 ((< (car elem) bufpos)
3697 (throw 'done (min (1+ (car elem)) bufpos))))
3699 ;; elem is the position at and not after the opening paren, so
3700 ;; we can go forward one more step unless it's equal to
3701 ;; bufpos. This is useful in some cases avoid an extra paren
3702 ;; level between the safe position and bufpos.
3703 (throw 'done (min (1+ elem) bufpos))))
3704 (setq paren-state (cdr paren-state)))))))
3706 (defun c-beginning-of-syntax ()
3707 ;; This is used for `font-lock-beginning-of-syntax-function'. It
3708 ;; goes to the closest previous point that is known to be outside
3709 ;; any string literal or comment. `c-state-cache' is used if it has
3710 ;; a position in the vicinity.
3711 (let* ((paren-state c-state-cache)
3715 ;; Note: Similar code in `c-safe-position'. The
3716 ;; difference is that we accept a safe position at
3717 ;; the point and don't bother to go forward past open
3720 (setq elem (car paren-state))
3722 (cond ((<= (cdr elem) (point))
3723 (throw 'done (cdr elem)))
3724 ((<= (car elem) (point))
3725 (throw 'done (car elem))))
3726 (if (<= elem (point))
3727 (throw 'done elem)))
3728 (setq paren-state (cdr paren-state)))
3731 (if (> pos (- (point) 4000))
3733 ;; The position is far back. Try `c-beginning-of-defun-1'
3734 ;; (although we can't be entirely sure it will go to a position
3735 ;; outside a comment or string in current emacsen). FIXME:
3736 ;; Consult `syntax-ppss' here.
3737 (c-beginning-of-defun-1)
3742 ;; Tools for scanning identifiers and other tokens.
3744 (defun c-on-identifier ()
3745 "Return non-nil if the point is on or directly after an identifier.
3746 Keywords are recognized and not considered identifiers. If an
3747 identifier is detected, the returned value is its starting position.
3748 If an identifier ends at the point and another begins at it \(can only
3749 happen in Pike) then the point for the preceding one is returned.
3751 Note that this function might do hidden buffer changes. See the
3752 comment at the start of cc-engine.el for more info."
3754 ;; FIXME: Shouldn't this function handle "operator" in C++?
3757 (skip-syntax-backward "w_")
3761 ;; Check for a normal (non-keyword) identifier.
3762 (and (looking-at c-symbol-start)
3763 (not (looking-at c-keywords-regexp))
3766 (when (c-major-mode-is 'pike-mode)
3767 ;; Handle the `<operator> syntax in Pike.
3768 (let ((pos (point)))
3769 (skip-chars-backward "-!%&*+/<=>^|~[]()")
3770 (and (if (< (skip-chars-backward "`") 0)
3773 (eq (char-after) ?\`))
3774 (looking-at c-symbol-key)
3775 (>= (match-end 0) pos)
3778 ;; Handle the "operator +" syntax in C++.
3779 (when (and c-overloadable-operators-regexp
3780 (= (c-backward-token-2 0) 0))
3782 (cond ((and (looking-at c-overloadable-operators-regexp)
3783 (or (not c-opt-op-identifier-prefix)
3784 (and (= (c-backward-token-2 1) 0)
3785 (looking-at c-opt-op-identifier-prefix))))
3789 (and c-opt-op-identifier-prefix
3790 (looking-at c-opt-op-identifier-prefix)
3791 (= (c-forward-token-2 1) 0)
3792 (looking-at c-overloadable-operators-regexp)))
3797 (defsubst c-simple-skip-symbol-backward ()
3798 ;; If the point is at the end of a symbol then skip backward to the
3799 ;; beginning of it. Don't move otherwise. Return non-nil if point
3802 ;; This function might do hidden buffer changes.
3803 (or (< (skip-syntax-backward "w_") 0)
3804 (and (c-major-mode-is 'pike-mode)
3805 ;; Handle the `<operator> syntax in Pike.
3806 (let ((pos (point)))
3807 (if (and (< (skip-chars-backward "-!%&*+/<=>^|~[]()") 0)
3808 (< (skip-chars-backward "`") 0)
3809 (looking-at c-symbol-key)
3810 (>= (match-end 0) pos))
3815 (defun c-beginning-of-current-token (&optional back-limit)
3816 ;; Move to the beginning of the current token. Do not move if not
3817 ;; in the middle of one. BACK-LIMIT may be used to bound the
3818 ;; backward search; if given it's assumed to be at the boundary
3819 ;; between two tokens. Return non-nil if the point is moved, nil
3822 ;; This function might do hidden buffer changes.
3823 (let ((start (point)))
3824 (if (looking-at "\\w\\|\\s_")
3825 (skip-syntax-backward "w_" back-limit)
3826 (when (< (skip-syntax-backward ".()" back-limit) 0)
3827 (while (let ((pos (or (and (looking-at c-nonsymbol-token-regexp)
3829 ;; `c-nonsymbol-token-regexp' should always match
3830 ;; since we've skipped backward over punctuation
3831 ;; or paren syntax, but consume one char in case
3832 ;; it doesn't so that we don't leave point before
3833 ;; some earlier incorrect token.
3836 (goto-char pos))))))
3839 (defun c-end-of-current-token (&optional back-limit)
3840 ;; Move to the end of the current token. Do not move if not in the
3841 ;; middle of one. BACK-LIMIT may be used to bound the backward
3842 ;; search; if given it's assumed to be at the boundary between two
3843 ;; tokens. Return non-nil if the point is moved, nil otherwise.
3845 ;; This function might do hidden buffer changes.
3846 (let ((start (point)))
3847 (cond ((< (skip-syntax-backward "w_" (1- start)) 0)
3848 (skip-syntax-forward "w_"))
3849 ((< (skip-syntax-backward ".()" back-limit) 0)
3851 (if (looking-at c-nonsymbol-token-regexp)
3852 (goto-char (match-end 0))
3853 ;; `c-nonsymbol-token-regexp' should always match since
3854 ;; we've skipped backward over punctuation or paren
3855 ;; syntax, but move forward in case it doesn't so that
3856 ;; we don't leave point earlier than we started with.
3858 (< (point) start)))))
3861 (defconst c-jump-syntax-balanced
3862 (if (memq 'gen-string-delim c-emacs-features)
3863 "\\w\\|\\s_\\|\\s(\\|\\s)\\|\\s\"\\|\\s|"
3864 "\\w\\|\\s_\\|\\s(\\|\\s)\\|\\s\""))
3866 (defconst c-jump-syntax-unbalanced
3867 (if (memq 'gen-string-delim c-emacs-features)
3868 "\\w\\|\\s_\\|\\s\"\\|\\s|"
3869 "\\w\\|\\s_\\|\\s\""))
3871 (defun c-forward-token-2 (&optional count balanced limit)
3872 "Move forward by tokens.
3873 A token is defined as all symbols and identifiers which aren't
3874 syntactic whitespace \(note that multicharacter tokens like \"==\" are
3875 treated properly). Point is always either left at the beginning of a
3876 token or not moved at all. COUNT specifies the number of tokens to
3877 move; a negative COUNT moves in the opposite direction. A COUNT of 0
3878 moves to the next token beginning only if not already at one. If
3879 BALANCED is true, move over balanced parens, otherwise move into them.
3880 Also, if BALANCED is true, never move out of an enclosing paren.
3882 LIMIT sets the limit for the movement and defaults to the point limit.
3883 The case when LIMIT is set in the middle of a token, comment or macro
3884 is handled correctly, i.e. the point won't be left there.
3886 Return the number of tokens left to move \(positive or negative). If
3887 BALANCED is true, a move over a balanced paren counts as one. Note
3888 that if COUNT is 0 and no appropriate token beginning is found, 1 will
3889 be returned. Thus, a return value of 0 guarantees that point is at
3890 the requested position and a return value less \(without signs) than
3891 COUNT guarantees that point is at the beginning of some token.
3893 Note that this function might do hidden buffer changes. See the
3894 comment at the start of cc-engine.el for more info."
3896 (or count (setq count 1))
3898 (- (c-backward-token-2 (- count) balanced limit))
3900 (let ((jump-syntax (if balanced
3901 c-jump-syntax-balanced
3902 c-jump-syntax-unbalanced))
3907 ;; If count is zero we should jump if in the middle of a token.
3908 (c-end-of-current-token))
3911 (if limit (narrow-to-region (point-min) limit))
3913 (progn (c-forward-syntactic-ws) (point)))
3914 ;; Skip whitespace. Count this as a move if we did in
3916 (setq count (max (1- count) 0)))
3919 ;; Moved out of bounds. Make sure the returned count isn't zero.
3921 (if (zerop count) (setq count 1))
3924 ;; Use `condition-case' to avoid having the limit tests
3931 (cond ((looking-at jump-syntax)
3932 (goto-char (scan-sexps (point) 1))
3934 ((looking-at c-nonsymbol-token-regexp)
3935 (goto-char (match-end 0))
3937 ;; `c-nonsymbol-token-regexp' above should always
3938 ;; match if there are correct tokens. Try to
3939 ;; widen to see if the limit was set in the
3940 ;; middle of one, else fall back to treating
3941 ;; the offending thing as a one character token.
3945 (looking-at c-nonsymbol-token-regexp)))
3950 (c-forward-syntactic-ws)
3953 (error (goto-char last)))
3957 (setq count (1+ count)))))
3961 (defun c-backward-token-2 (&optional count balanced limit)
3962 "Move backward by tokens.
3963 See `c-forward-token-2' for details."
3965 (or count (setq count 1))
3967 (- (c-forward-token-2 (- count) balanced limit))
3969 (or limit (setq limit (point-min)))
3970 (let ((jump-syntax (if balanced
3971 c-jump-syntax-balanced
3972 c-jump-syntax-unbalanced))
3976 ;; The count is zero so try to skip to the beginning of the
3979 (progn (c-beginning-of-current-token) (point)))
3980 (if (< (point) limit)
3981 ;; The limit is inside the same token, so return 1.
3984 ;; We're not in the middle of a token. If there's
3985 ;; whitespace after the point then we must move backward,
3986 ;; so set count to 1 in that case.
3987 (and (looking-at c-syntactic-ws-start)
3988 ;; If we're looking at a '#' that might start a cpp
3989 ;; directive then we have to do a more elaborate check.
3990 (or (/= (char-after) ?#)
3991 (not c-opt-cpp-prefix)
3994 (progn (beginning-of-line)
3995 (looking-at "[ \t]*")
3998 (progn (backward-char)
3999 (not (eq (char-before) ?\\)))))))
4002 ;; Use `condition-case' to avoid having to check for buffer
4003 ;; limits in `backward-char', `scan-sexps' and `goto-char' below.
4008 (c-backward-syntactic-ws)
4010 (if (looking-at jump-syntax)
4011 (goto-char (scan-sexps (1+ (point)) -1))
4012 ;; This can be very inefficient if there's a long
4013 ;; sequence of operator tokens without any separation.
4014 ;; That doesn't happen in practice, anyway.
4015 (c-beginning-of-current-token))
4016 (>= (point) limit)))
4019 (error (goto-char last)))
4021 (if (< (point) limit)
4026 (defun c-forward-token-1 (&optional count balanced limit)
4027 "Like `c-forward-token-2' but doesn't treat multicharacter operator
4028 tokens like \"==\" as single tokens, i.e. all sequences of symbol
4029 characters are jumped over character by character. This function is
4030 for compatibility only; it's only a wrapper over `c-forward-token-2'."
4031 (let ((c-nonsymbol-token-regexp "\\s."))
4032 (c-forward-token-2 count balanced limit)))
4034 (defun c-backward-token-1 (&optional count balanced limit)
4035 "Like `c-backward-token-2' but doesn't treat multicharacter operator
4036 tokens like \"==\" as single tokens, i.e. all sequences of symbol
4037 characters are jumped over character by character. This function is
4038 for compatibility only; it's only a wrapper over `c-backward-token-2'."
4039 (let ((c-nonsymbol-token-regexp "\\s."))
4040 (c-backward-token-2 count balanced limit)))
4043 ;; Tools for doing searches restricted to syntactically relevant text.
4045 (defun c-syntactic-re-search-forward (regexp &optional bound noerror
4046 paren-level not-inside-token
4047 lookbehind-submatch)
4048 "Like `re-search-forward', but only report matches that are found
4049 in syntactically significant text. I.e. matches in comments, macros
4050 or string literals are ignored. The start point is assumed to be
4051 outside any comment, macro or string literal, or else the content of
4052 that region is taken as syntactically significant text.
4054 If PAREN-LEVEL is non-nil, an additional restriction is added to
4055 ignore matches in nested paren sexps. The search will also not go
4056 outside the current list sexp, which has the effect that if the point
4057 should be moved to BOUND when no match is found \(i.e. NOERROR is
4058 neither nil nor t), then it will be at the closing paren if the end of
4059 the current list sexp is encountered first.
4061 If NOT-INSIDE-TOKEN is non-nil, matches in the middle of tokens are
4062 ignored. Things like multicharacter operators and special symbols
4063 \(e.g. \"`()\" in Pike) are handled but currently not floating point
4066 If LOOKBEHIND-SUBMATCH is non-nil, it's taken as a number of a
4067 subexpression in REGEXP. The end of that submatch is used as the
4068 position to check for syntactic significance. If LOOKBEHIND-SUBMATCH
4069 isn't used or if that subexpression didn't match then the start
4070 position of the whole match is used instead. The \"look behind\"
4071 subexpression is never tested before the starting position, so it
4072 might be a good idea to include \\=\\= as a match alternative in it.
4074 Optimization note: Matches might be missed if the \"look behind\"
4075 subexpression can match the end of nonwhite syntactic whitespace,
4076 i.e. the end of comments or cpp directives. This since the function
4077 skips over such things before resuming the search. It's on the other
4078 hand not safe to assume that the \"look behind\" subexpression never
4079 matches syntactic whitespace.
4081 Bug: Unbalanced parens inside cpp directives are currently not handled
4082 correctly \(i.e. they don't get ignored as they should) when
4085 Note that this function might do hidden buffer changes. See the
4086 comment at the start of cc-engine.el for more info."
4088 (or bound (setq bound (point-max)))
4089 (if paren-level (setq paren-level -1))
4091 ;;(message "c-syntactic-re-search-forward %s %s %S" (point) bound regexp)
4093 (let ((start (point))
4095 ;; Start position for the last search.
4097 ;; The `parse-partial-sexp' state between the start position
4100 ;; The current position after the last state update. The next
4101 ;; `parse-partial-sexp' continues from here.
4103 ;; The position at which to check the state and the state
4104 ;; there. This is separate from `state-pos' since we might
4105 ;; need to back up before doing the next search round.
4106 check-pos check-state
4107 ;; Last position known to end a token.
4108 (last-token-end-pos (point-min))
4109 ;; Set when a valid match is found.
4116 (setq search-pos (point))
4117 (re-search-forward regexp bound noerror))
4120 (setq state (parse-partial-sexp
4121 state-pos (match-beginning 0) paren-level nil state)
4123 (if (setq check-pos (and lookbehind-submatch
4124 (or (not paren-level)
4126 (match-end lookbehind-submatch)))
4127 (setq check-state (parse-partial-sexp
4128 state-pos check-pos paren-level nil state))
4129 (setq check-pos state-pos
4132 ;; NOTE: If we got a look behind subexpression and get
4133 ;; an insignificant match in something that isn't
4134 ;; syntactic whitespace (i.e. strings or in nested
4135 ;; parentheses), then we can never skip more than a
4136 ;; single character from the match start position
4137 ;; (i.e. `state-pos' here) before continuing the
4138 ;; search. That since the look behind subexpression
4139 ;; might match the end of the insignificant region in
4143 ((elt check-state 7)
4144 ;; Match inside a line comment. Skip to eol. Use
4145 ;; `re-search-forward' instead of `skip-chars-forward' to get
4146 ;; the right bound behavior.
4147 (re-search-forward "[\n\r]" bound noerror))
4149 ((elt check-state 4)
4150 ;; Match inside a block comment. Skip to the '*/'.
4151 (search-forward "*/" bound noerror))
4153 ((and (not (elt check-state 5))
4154 (eq (char-before check-pos) ?/)
4155 (not (c-get-char-property (1- check-pos) 'syntax-table))
4156 (memq (char-after check-pos) '(?/ ?*)))
4157 ;; Match in the middle of the opener of a block or line
4159 (if (= (char-after check-pos) ?/)
4160 (re-search-forward "[\n\r]" bound noerror)
4161 (search-forward "*/" bound noerror)))
4163 ;; The last `parse-partial-sexp' above might have
4164 ;; stopped short of the real check position if the end
4165 ;; of the current sexp was encountered in paren-level
4166 ;; mode. The checks above are always false in that
4167 ;; case, and since they can do better skipping in
4168 ;; lookbehind-submatch mode, we do them before
4169 ;; checking the paren level.
4172 (/= (setq tmp (car check-state)) 0))
4173 ;; Check the paren level first since we're short of the
4174 ;; syntactic checking position if the end of the
4175 ;; current sexp was encountered by `parse-partial-sexp'.
4178 ;; Inside a nested paren sexp.
4179 (if lookbehind-submatch
4180 ;; See the NOTE above.
4181 (progn (goto-char state-pos) t)
4182 ;; Skip out of the paren quickly.
4183 (setq state (parse-partial-sexp state-pos bound 0 nil state)
4186 ;; Have exited the current paren sexp.
4189 ;; The last `parse-partial-sexp' call above
4190 ;; has left us just after the closing paren
4191 ;; in this case, so we can modify the bound
4192 ;; to leave the point at the right position
4194 (setq bound (1- (point)))
4196 (signal 'search-failed (list regexp)))))
4198 ((setq tmp (elt check-state 3))
4199 ;; Match inside a string.
4200 (if (or lookbehind-submatch
4201 (not (integerp tmp)))
4202 ;; See the NOTE above.
4203 (progn (goto-char state-pos) t)
4204 ;; Skip to the end of the string before continuing.
4205 (let ((ender (make-string 1 tmp)) (continue t))
4206 (while (if (search-forward ender bound noerror)
4208 (setq state (parse-partial-sexp
4209 state-pos (point) nil nil state)
4212 (setq continue nil)))
4217 (c-beginning-of-macro start)))
4218 ;; Match inside a macro. Skip to the end of it.
4220 (cond ((<= (point) bound) t)
4222 (t (signal 'search-failed (list regexp)))))
4224 ((and not-inside-token
4225 (or (< check-pos last-token-end-pos)
4228 (goto-char check-pos)
4230 (c-end-of-current-token last-token-end-pos))
4231 (setq last-token-end-pos (point))))))
4233 (if lookbehind-submatch
4234 ;; See the NOTE above.
4235 (goto-char state-pos)
4236 (goto-char (min last-token-end-pos bound))))
4243 ;; Should loop to search again, but take care to avoid
4244 ;; looping on the same spot.
4245 (or (/= search-pos (point))
4246 (if (= (point) bound)
4249 (signal 'search-failed (list regexp)))
4255 (signal (car err) (cdr err))))
4257 ;;(message "c-syntactic-re-search-forward done %s" (or (match-end 0) (point)))
4261 (goto-char (match-end 0))
4264 ;; Search failed. Set point as appropriate.
4270 (defvar safe-pos-list) ; bound in c-syntactic-skip-backward
4272 (defsubst c-ssb-lit-begin ()
4273 ;; Return the start of the literal point is in, or nil.
4274 ;; We read and write the variables `safe-pos', `safe-pos-list', `state'
4275 ;; bound in the caller.
4277 ;; Use `parse-partial-sexp' from a safe position down to the point to check
4278 ;; if it's outside comments and strings.
4280 (let ((pos (point)) safe-pos state)
4281 ;; Pick a safe position as close to the point as possible.
4283 ;; FIXME: Consult `syntax-ppss' here if our cache doesn't give a good
4286 (while (and safe-pos-list
4287 (> (car safe-pos-list) (point)))
4288 (setq safe-pos-list (cdr safe-pos-list)))
4289 (unless (setq safe-pos (car-safe safe-pos-list))
4290 (setq safe-pos (max (or (c-safe-position
4291 (point) (or c-state-cache
4295 safe-pos-list (list safe-pos)))
4297 ;; Cache positions along the way to use if we have to back up more. We
4298 ;; cache every closing paren on the same level. If the paren cache is
4299 ;; relevant in this region then we're typically already on the same
4300 ;; level as the target position. Note that we might cache positions
4301 ;; after opening parens in case safe-pos is in a nested list. That's
4302 ;; both uncommon and harmless.
4304 (setq state (parse-partial-sexp
4307 (setq safe-pos (point)
4308 safe-pos-list (cons safe-pos safe-pos-list)))
4310 ;; If the state contains the start of the containing sexp we cache that
4311 ;; position too, so that parse-partial-sexp in the next run has a bigger
4312 ;; chance of starting at the same level as the target position and thus
4313 ;; will get more good safe positions into the list.
4315 (setq safe-pos (1+ (elt state 1))
4316 safe-pos-list (cons safe-pos safe-pos-list)))
4318 (if (or (elt state 3) (elt state 4))
4319 ;; Inside string or comment. Continue search at the
4323 (defun c-syntactic-skip-backward (skip-chars &optional limit paren-level)
4324 "Like `skip-chars-backward' but only look at syntactically relevant chars,
4325 i.e. don't stop at positions inside syntactic whitespace or string
4326 literals. Preprocessor directives are also ignored, with the exception
4327 of the one that the point starts within, if any. If LIMIT is given,
4328 it's assumed to be at a syntactically relevant position.
4330 If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4331 sexps, and the search will also not go outside the current paren sexp.
4332 However, if LIMIT or the buffer limit is reached inside a nested paren
4333 then the point will be left at the limit.
4335 Non-nil is returned if the point moved, nil otherwise.
4337 Note that this function might do hidden buffer changes. See the
4338 comment at the start of cc-engine.el for more info."
4340 (let ((start (point))
4342 ;; A list of syntactically relevant positions in descending
4343 ;; order. It's used to avoid scanning repeatedly over
4344 ;; potentially large regions with `parse-partial-sexp' to verify
4345 ;; each position. Used in `c-ssb-lit-begin'
4347 ;; The result from `c-beginning-of-macro' at the start position or the
4348 ;; start position itself if it isn't within a macro. Evaluated on
4351 ;; The earliest position after the current one with the same paren
4352 ;; level. Used only when `paren-level' is set.
4354 (paren-level-pos (point)))
4358 ;; The next loop "tries" to find the end point each time round,
4359 ;; loops when it hasn't succeeded.
4362 (let ((pos (point)))
4364 (< (skip-chars-backward skip-chars limit) 0)
4365 ;; Don't stop inside a literal.
4366 (when (setq lit-beg (c-ssb-lit-begin))
4371 (let ((pos (point)) state-2 pps-end-pos)
4376 (setq state-2 (parse-partial-sexp
4377 pos paren-level-pos -1)
4378 pps-end-pos (point))
4379 (/= (car state-2) 0)))
4380 ;; Not at the right level.
4382 (if (and (< (car state-2) 0)
4383 ;; We stop above if we go out of a paren.
4384 ;; Now check whether it precedes or is
4385 ;; nested in the starting sexp.
4389 pps-end-pos paren-level-pos
4391 (< (car state-2) 0)))
4393 ;; We've stopped short of the starting position
4394 ;; so the hit was inside a nested list. Go up
4395 ;; until we are at the right level.
4398 (goto-char (scan-lists pos -1
4400 (setq paren-level-pos (point))
4401 (if (and limit (>= limit paren-level-pos))
4407 (goto-char (or limit (point-min)))
4410 ;; The hit was outside the list at the start
4411 ;; position. Go to the start of the list and exit.
4412 (goto-char (1+ (elt state-2 1)))
4415 ((c-beginning-of-macro limit)
4419 (setq start-macro-beg
4422 (c-beginning-of-macro limit)
4426 ;; It's inside the same macro we started in so it's
4427 ;; a relevant match.
4433 ;; Skip syntactic ws afterwards so that we don't stop at the
4434 ;; end of a comment if `skip-chars' is something like "^/".
4435 (c-backward-syntactic-ws)
4438 ;; We might want to extend this with more useful return values in
4440 (/= (point) start)))
4442 ;; The following is an alternative implementation of
4443 ;; `c-syntactic-skip-backward' that uses backward movement to keep
4444 ;; track of the syntactic context. It turned out to be generally
4445 ;; slower than the one above which uses forward checks from earlier
4448 ;;(defconst c-ssb-stop-re
4449 ;; ;; The regexp matching chars `c-syntactic-skip-backward' needs to
4450 ;; ;; stop at to avoid going into comments and literals.
4452 ;; ;; Match comment end syntax and string literal syntax. Also match
4453 ;; ;; '/' for block comment endings (not covered by comment end
4455 ;; "\\s>\\|/\\|\\s\""
4456 ;; (if (memq 'gen-string-delim c-emacs-features)
4459 ;; (if (memq 'gen-comment-delim c-emacs-features)
4463 ;;(defconst c-ssb-stop-paren-re
4464 ;; ;; Like `c-ssb-stop-re' but also stops at paren chars.
4465 ;; (concat c-ssb-stop-re "\\|\\s(\\|\\s)"))
4467 ;;(defconst c-ssb-sexp-end-re
4468 ;; ;; Regexp matching the ending syntax of a complex sexp.
4469 ;; (concat c-string-limit-regexp "\\|\\s)"))
4471 ;;(defun c-syntactic-skip-backward (skip-chars &optional limit paren-level)
4472 ;; "Like `skip-chars-backward' but only look at syntactically relevant chars,
4473 ;;i.e. don't stop at positions inside syntactic whitespace or string
4474 ;;literals. Preprocessor directives are also ignored. However, if the
4475 ;;point is within a comment, string literal or preprocessor directory to
4476 ;;begin with, its contents is treated as syntactically relevant chars.
4477 ;;If LIMIT is given, it limits the backward search and the point will be
4478 ;;left there if no earlier position is found.
4480 ;;If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4481 ;;sexps, and the search will also not go outside the current paren sexp.
4482 ;;However, if LIMIT or the buffer limit is reached inside a nested paren
4483 ;;then the point will be left at the limit.
4485 ;;Non-nil is returned if the point moved, nil otherwise.
4487 ;;Note that this function might do hidden buffer changes. See the
4488 ;;comment at the start of cc-engine.el for more info."
4490 ;; (save-restriction
4492 ;; (narrow-to-region limit (point-max)))
4494 ;; (let ((start (point)))
4496 ;; (while (let ((last-pos (point))
4498 ;; (skip-chars-backward skip-chars)
4501 ;; ;; Skip back over the same region as
4502 ;; ;; `skip-chars-backward' above, but keep to
4503 ;; ;; syntactically relevant positions.
4504 ;; (goto-char last-pos)
4506 ;; ;; `re-search-backward' with a single char regexp
4507 ;; ;; should be fast.
4508 ;; (re-search-backward
4509 ;; (if paren-level c-ssb-stop-paren-re c-ssb-stop-re)
4514 ;; ((looking-at "\\s(")
4515 ;; ;; `paren-level' is set and we've found the
4516 ;; ;; start of the containing paren.
4520 ;; ((looking-at c-ssb-sexp-end-re)
4521 ;; ;; We're at the end of a string literal or paren
4522 ;; ;; sexp (if `paren-level' is set).
4524 ;; (condition-case nil
4525 ;; (c-backward-sexp)
4527 ;; (goto-char limit)
4528 ;; (throw 'done t))))
4532 ;; ;; At the end of some syntactic ws or possibly
4533 ;; ;; after a plain '/' operator.
4534 ;; (let ((pos (point)))
4535 ;; (c-backward-syntactic-ws)
4536 ;; (if (= pos (point))
4537 ;; ;; Was a plain '/' operator. Go past it.
4538 ;; (backward-char)))))
4540 ;; (> (point) stop-pos))))
4542 ;; ;; Now the point is either at `stop-pos' or at some
4543 ;; ;; position further back if `stop-pos' was at a
4544 ;; ;; syntactically irrelevant place.
4546 ;; ;; Skip additional syntactic ws so that we don't stop
4547 ;; ;; at the end of a comment if `skip-chars' is
4548 ;; ;; something like "^/".
4549 ;; (c-backward-syntactic-ws)
4551 ;; (< (point) stop-pos))))
4553 ;; ;; We might want to extend this with more useful return values
4554 ;; ;; in the future.
4555 ;; (/= (point) start))))
4558 ;; Tools for handling comments and string literals.
4560 (defun c-in-literal (&optional lim detect-cpp)
4561 "Return the type of literal point is in, if any.
4562 The return value is `c' if in a C-style comment, `c++' if in a C++
4563 style comment, `string' if in a string literal, `pound' if DETECT-CPP
4564 is non-nil and in a preprocessor line, or nil if somewhere else.
4565 Optional LIM is used as the backward limit of the search. If omitted,
4566 or nil, `c-beginning-of-defun' is used.
4568 The last point calculated is cached if the cache is enabled, i.e. if
4569 `c-in-literal-cache' is bound to a two element vector.
4571 Note that this function might do hidden buffer changes. See the
4572 comment at the start of cc-engine.el for more info."
4575 (let* ((safe-place (c-state-semi-safe-place (point)))
4576 (lit (c-state-pp-to-literal safe-place (point))))
4579 (save-excursion (c-beginning-of-macro))
4582 (defun c-literal-limits (&optional lim near not-in-delimiter)
4583 "Return a cons of the beginning and end positions of the comment or
4584 string surrounding point (including both delimiters), or nil if point
4585 isn't in one. If LIM is non-nil, it's used as the \"safe\" position
4586 to start parsing from. If NEAR is non-nil, then the limits of any
4587 literal next to point is returned. \"Next to\" means there's only
4588 spaces and tabs between point and the literal. The search for such a
4589 literal is done first in forward direction. If NOT-IN-DELIMITER is
4590 non-nil, the case when point is inside a starting delimiter won't be
4591 recognized. This only has effect for comments which have starting
4592 delimiters with more than one character.
4594 Note that this function might do hidden buffer changes. See the
4595 comment at the start of cc-engine.el for more info."
4598 (let* ((pos (point))
4599 (lim (or lim (c-state-semi-safe-place pos)))
4600 (pp-to-lit (save-restriction
4602 (c-state-pp-to-literal lim pos not-in-delimiter)))
4603 (state (car pp-to-lit))
4604 (lit-limits (car (cddr pp-to-lit))))
4611 ;; Search forward for a literal.
4612 (skip-chars-forward " \t")
4614 ((looking-at c-string-limit-regexp) ; String.
4615 (cons (point) (or (c-safe (c-forward-sexp 1) (point))
4618 ((looking-at c-comment-start-regexp) ; Line or block comment.
4619 (cons (point) (progn (c-forward-single-comment) (point))))
4623 (skip-chars-backward " \t")
4625 (let ((end (point)) beg)
4628 (< (skip-syntax-backward c-string-syntax) 0)) ; String.
4629 (setq beg (c-safe (c-backward-sexp 1) (point))))
4631 ((and (c-safe (forward-char -2) t)
4633 ;; Block comment. Due to the nature of line
4634 ;; comments, they will always be covered by the
4635 ;; normal case above.
4637 (c-backward-single-comment)
4638 ;; If LIM is bogus, beg will be bogus.
4639 (setq beg (point))))
4641 (if beg (cons beg end))))))
4644 ;; In case external callers use this; it did have a docstring.
4645 (defalias 'c-literal-limits-fast 'c-literal-limits)
4647 (defun c-collect-line-comments (range)
4648 "If the argument is a cons of two buffer positions (such as returned by
4649 `c-literal-limits'), and that range contains a C++ style line comment,
4650 then an extended range is returned that contains all adjacent line
4651 comments (i.e. all comments that starts in the same column with no
4652 empty lines or non-whitespace characters between them). Otherwise the
4653 argument is returned.
4655 Note that this function might do hidden buffer changes. See the
4656 comment at the start of cc-engine.el for more info."
4660 (if (and (consp range) (progn
4661 (goto-char (car range))
4662 (looking-at c-line-comment-starter)))
4663 (let ((col (current-column))
4665 (bopl (c-point 'bopl))
4667 ;; Got to take care in the backward direction to handle
4668 ;; comments which are preceded by code.
4669 (while (and (c-backward-single-comment)
4671 (looking-at c-line-comment-starter)
4672 (= col (current-column)))
4674 bopl (c-point 'bopl)))
4676 (while (and (progn (skip-chars-forward " \t")
4677 (looking-at c-line-comment-starter))
4678 (= col (current-column))
4679 (prog1 (zerop (forward-line 1))
4680 (setq end (point)))))
4685 (defun c-literal-type (range)
4686 "Convenience function that given the result of `c-literal-limits',
4687 returns nil or the type of literal that the range surrounds, one
4688 of the symbols `c', `c++' or `string'. It's much faster than using
4689 `c-in-literal' and is intended to be used when you need both the
4690 type of a literal and its limits.
4692 Note that this function might do hidden buffer changes. See the
4693 comment at the start of cc-engine.el for more info."
4697 (goto-char (car range))
4698 (cond ((looking-at c-string-limit-regexp) 'string)
4699 ((or (looking-at "//") ; c++ line comment
4700 (and (looking-at "\\s<") ; comment starter
4701 (looking-at "#"))) ; awk comment.
4703 (t 'c))) ; Assuming the range is valid.
4706 (defsubst c-determine-limit-get-base (start try-size)
4707 ;; Get a "safe place" approximately TRY-SIZE characters before START.
4708 ;; This doesn't preserve point.
4709 (let* ((pos (max (- start try-size) (point-min)))
4710 (base (c-state-semi-safe-place pos))
4711 (s (parse-partial-sexp base pos)))
4712 (if (or (nth 4 s) (nth 3 s)) ; comment or string
4716 (defun c-determine-limit (how-far-back &optional start try-size)
4717 ;; Return a buffer position HOW-FAR-BACK non-literal characters from START
4718 ;; (default point). This is done by going back further in the buffer then
4719 ;; searching forward for literals. The position found won't be in a
4720 ;; literal. We start searching for the sought position TRY-SIZE (default
4721 ;; twice HOW-FAR-BACK) bytes back from START. This function must be fast.
4724 (let* ((start (or start (point)))
4725 (try-size (or try-size (* 2 how-far-back)))
4726 (base (c-determine-limit-get-base start try-size))
4729 (s (parse-partial-sexp pos pos)) ; null state.
4732 (while (< pos start)
4733 ;; Move forward one literal each time round this loop.
4734 ;; Move forward to the start of a comment or string.
4735 (setq s (parse-partial-sexp
4741 'syntax-table)) ; stop-comment
4743 ;; Gather details of the non-literal-bit - starting pos and size.
4744 (setq size (- (if (or (nth 4 s) (nth 3 s))
4749 (setq stack (cons (cons pos size) stack)))
4751 ;; Move forward to the end of the comment/string.
4752 (if (or (nth 4 s) (nth 3 s))
4753 (setq s (parse-partial-sexp
4759 'syntax-table))) ; stop-comment
4762 ;; Now try and find enough non-literal characters recorded on the stack.
4763 ;; Go back one recorded literal each time round this loop.
4764 (while (and (< count how-far-back)
4766 (setq elt (car stack)
4768 (setq count (+ count (cdr elt))))
4770 ;; Have we found enough yet?
4772 ((>= count how-far-back)
4773 (+ (car elt) (- count how-far-back)))
4774 ((eq base (point-min))
4777 (c-determine-limit (- how-far-back count) base try-size))))))
4779 (defun c-determine-+ve-limit (how-far &optional start-pos)
4780 ;; Return a buffer position about HOW-FAR non-literal characters forward
4781 ;; from START-POS (default point), which must not be inside a literal.
4783 (let ((pos (or start-pos (point)))
4785 (s (parse-partial-sexp (point) (point)))) ; null state
4786 (while (and (not (eobp))
4788 ;; Scan over counted characters.
4789 (setq s (parse-partial-sexp
4791 (min (+ pos count) (point-max))
4795 'syntax-table)) ; stop-comment
4796 (setq count (- count (- (point) pos) 1)
4798 ;; Scan over literal characters.
4800 (setq s (parse-partial-sexp
4806 'syntax-table) ; stop-comment
4811 ;; `c-find-decl-spots' and accompanying stuff.
4813 ;; Variables used in `c-find-decl-spots' to cache the search done for
4814 ;; the first declaration in the last call. When that function starts,
4815 ;; it needs to back up over syntactic whitespace to look at the last
4816 ;; token before the region being searched. That can sometimes cause
4817 ;; moves back and forth over a quite large region of comments and
4818 ;; macros, which would be repeated for each changed character when
4819 ;; we're called during fontification, since font-lock refontifies the
4820 ;; current line for each change. Thus it's worthwhile to cache the
4823 ;; `c-find-decl-syntactic-pos' is a syntactically relevant position in
4824 ;; the syntactic whitespace less or equal to some start position.
4825 ;; There's no cached value if it's nil.
4827 ;; `c-find-decl-match-pos' is the match position if
4828 ;; `c-find-decl-prefix-search' matched before the syntactic whitespace
4829 ;; at `c-find-decl-syntactic-pos', or nil if there's no such match.
4830 (defvar c-find-decl-syntactic-pos nil)
4831 (make-variable-buffer-local 'c-find-decl-syntactic-pos)
4832 (defvar c-find-decl-match-pos nil)
4833 (make-variable-buffer-local 'c-find-decl-match-pos)
4835 (defsubst c-invalidate-find-decl-cache (change-min-pos)
4836 (and c-find-decl-syntactic-pos
4837 (< change-min-pos c-find-decl-syntactic-pos)
4838 (setq c-find-decl-syntactic-pos nil)))
4840 ; (defface c-debug-decl-spot-face
4841 ; '((t (:background "Turquoise")))
4842 ; "Debug face to mark the spots where `c-find-decl-spots' stopped.")
4843 ; (defface c-debug-decl-sws-face
4844 ; '((t (:background "Khaki")))
4845 ; "Debug face to mark the syntactic whitespace between the declaration
4846 ; spots and the preceding token end.")
4848 (defmacro c-debug-put-decl-spot-faces (match-pos decl-pos)
4849 (when (facep 'c-debug-decl-spot-face)
4850 `(c-save-buffer-state ((match-pos ,match-pos) (decl-pos ,decl-pos))
4851 (c-debug-add-face (max match-pos (point-min)) decl-pos
4852 'c-debug-decl-sws-face)
4853 (c-debug-add-face decl-pos (min (1+ decl-pos) (point-max))
4854 'c-debug-decl-spot-face))))
4855 (defmacro c-debug-remove-decl-spot-faces (beg end)
4856 (when (facep 'c-debug-decl-spot-face)
4857 `(c-save-buffer-state ()
4858 (c-debug-remove-face ,beg ,end 'c-debug-decl-spot-face)
4859 (c-debug-remove-face ,beg ,end 'c-debug-decl-sws-face))))
4861 (defmacro c-find-decl-prefix-search ()
4862 ;; Macro used inside `c-find-decl-spots'. It ought to be a defun,
4863 ;; but it contains lots of free variables that refer to things
4864 ;; inside `c-find-decl-spots'. The point is left at `cfd-match-pos'
4865 ;; if there is a match, otherwise at `cfd-limit'.
4867 ;; The macro moves point forward to the next putative start of a declaration
4868 ;; or cfd-limit. This decl start is the next token after a "declaration
4869 ;; prefix". The declaration prefix is the earlier of `cfd-prop-match' and
4870 ;; `cfd-re-match'. `cfd-match-pos' is set to the decl prefix.
4872 ;; This macro might do hidden buffer changes.
4875 ;; Find the next property match position if we haven't got one already.
4876 (unless cfd-prop-match
4879 (goto-char (c-next-single-property-change
4880 (point) 'c-type nil cfd-limit))
4881 (and (< (point) cfd-limit)
4882 (not (eq (c-get-char-property (1- (point)) 'c-type)
4884 (setq cfd-prop-match (point))))
4886 ;; Find the next `c-decl-prefix-or-start-re' match if we haven't
4888 (unless cfd-re-match
4890 (if (> cfd-re-match-end (point))
4891 (goto-char cfd-re-match-end))
4893 ;; Each time round, the next `while' moves forward over a pseudo match
4894 ;; of `c-decl-prefix-or-start-re' which is either inside a literal, or
4895 ;; is a ":" not preceded by "public", etc.. `cfd-re-match' and
4896 ;; `cfd-re-match-end' get set.
4899 (setq cfd-re-match-end (re-search-forward c-decl-prefix-or-start-re
4902 ((null cfd-re-match-end)
4903 ;; No match. Finish up and exit the loop.
4904 (setq cfd-re-match cfd-limit)
4907 (if (setq cfd-re-match (match-end 1))
4908 ;; Matched the end of a token preceding a decl spot.
4910 (goto-char cfd-re-match)
4912 ;; Matched a token that start a decl spot.
4913 (goto-char (match-beginning 0))
4916 ;; Pseudo match inside a comment or string literal. Skip out
4917 ;; of comments and string literals.
4919 (goto-char (c-next-single-property-change
4920 (point) 'face nil cfd-limit))
4921 (and (< (point) cfd-limit)
4922 (c-got-face-at (point) c-literal-faces))))
4923 t) ; Continue the loop over pseudo matches.
4924 ((and (match-string 1)
4925 (string= (match-string 1) ":")
4927 (or (/= (c-backward-token-2 2) 0) ; no search limit. :-(
4928 (not (looking-at c-decl-start-colon-kwd-re)))))
4929 ;; Found a ":" which isn't part of "public:", etc.
4931 (t nil)))) ;; Found a real match. Exit the pseudo-match loop.
4933 ;; If our match was at the decl start, we have to back up over the
4934 ;; preceding syntactic ws to set `cfd-match-pos' and to catch
4935 ;; any decl spots in the syntactic ws.
4936 (unless cfd-re-match
4937 (c-backward-syntactic-ws)
4938 (setq cfd-re-match (point))))
4940 ;; Choose whichever match is closer to the start.
4941 (if (< cfd-re-match cfd-prop-match)
4942 (setq cfd-match-pos cfd-re-match
4944 (setq cfd-match-pos cfd-prop-match
4945 cfd-prop-match nil))
4947 (goto-char cfd-match-pos)
4949 (when (< cfd-match-pos cfd-limit)
4950 ;; Skip forward past comments only so we don't skip macros.
4951 (c-forward-comments)
4952 ;; Set the position to continue at. We can avoid going over
4953 ;; the comments skipped above a second time, but it's possible
4954 ;; that the comment skipping has taken us past `cfd-prop-match'
4955 ;; since the property might be used inside comments.
4956 (setq cfd-continue-pos (if cfd-prop-match
4957 (min cfd-prop-match (point))
4960 (defun c-find-decl-spots (cfd-limit cfd-decl-re cfd-face-checklist cfd-fun)
4961 ;; Call CFD-FUN for each possible spot for a declaration, cast or
4962 ;; label from the point to CFD-LIMIT.
4964 ;; CFD-FUN is called with point at the start of the spot. It's passed two
4965 ;; arguments: The first is the end position of the token preceding the spot,
4966 ;; or 0 for the implicit match at bob. The second is a flag that is t when
4967 ;; the match is inside a macro. Point should be moved forward by at least
4970 ;; If CFD-FUN adds `c-decl-end' properties somewhere below the current spot,
4971 ;; it should return non-nil to ensure that the next search will find them.
4974 ;; o The first token after bob.
4975 ;; o The first token after the end of submatch 1 in
4976 ;; `c-decl-prefix-or-start-re' when that submatch matches. This
4977 ;; submatch is typically a (L or R) brace or paren, a ;, or a ,.
4978 ;; o The start of each `c-decl-prefix-or-start-re' match when
4979 ;; submatch 1 doesn't match. This is, for example, the keyword
4981 ;; o The start of a previously recognized declaration; "recognized"
4982 ;; means that the last char of the previous token has a `c-type'
4983 ;; text property with the value `c-decl-end'; this only holds
4984 ;; when `c-type-decl-end-used' is set.
4986 ;; Only a spot that match CFD-DECL-RE and whose face is in the
4987 ;; CFD-FACE-CHECKLIST list causes CFD-FUN to be called. The face
4988 ;; check is disabled if CFD-FACE-CHECKLIST is nil.
4990 ;; If the match is inside a macro then the buffer is narrowed to the
4991 ;; end of it, so that CFD-FUN can investigate the following tokens
4992 ;; without matching something that begins inside a macro and ends
4993 ;; outside it. It's to avoid this work that the CFD-DECL-RE and
4994 ;; CFD-FACE-CHECKLIST checks exist.
4996 ;; The spots are visited approximately in order from top to bottom.
4997 ;; It's however the positions where `c-decl-prefix-or-start-re'
4998 ;; matches and where `c-decl-end' properties are found that are in
4999 ;; order. Since the spots often are at the following token, they
5000 ;; might be visited out of order insofar as more spots are reported
5001 ;; later on within the syntactic whitespace between the match
5002 ;; positions and their spots.
5004 ;; It's assumed that comments and strings are fontified in the
5007 ;; This is mainly used in fontification, and so has an elaborate
5008 ;; cache to handle repeated calls from the same start position; see
5009 ;; the variables above.
5011 ;; All variables in this function begin with `cfd-' to avoid name
5012 ;; collision with the (dynamically bound) variables used in CFD-FUN.
5014 ;; This function might do hidden buffer changes.
5016 (let ((cfd-start-pos (point)) ; never changed
5017 (cfd-buffer-end (point-max))
5018 ;; The end of the token preceding the decl spot last found
5019 ;; with `c-decl-prefix-or-start-re'. `cfd-limit' if there's
5022 ;; The end position of the last `c-decl-prefix-or-start-re'
5023 ;; match. If this is greater than `cfd-continue-pos', the
5024 ;; next regexp search is started here instead.
5025 (cfd-re-match-end (point-min))
5026 ;; The end of the last `c-decl-end' found by
5027 ;; `c-find-decl-prefix-search'. `cfd-limit' if there's no
5028 ;; match. If searching for the property isn't needed then we
5029 ;; disable it by setting it to `cfd-limit' directly.
5030 (cfd-prop-match (unless c-type-decl-end-used cfd-limit))
5031 ;; The end of the token preceding the decl spot last found by
5032 ;; `c-find-decl-prefix-search'. 0 for the implicit match at
5033 ;; bob. `cfd-limit' if there's no match. In other words,
5034 ;; this is the minimum of `cfd-re-match' and `cfd-prop-match'.
5035 (cfd-match-pos cfd-limit)
5036 ;; The position to continue searching at.
5038 ;; The position of the last "real" token we've stopped at.
5039 ;; This can be greater than `cfd-continue-pos' when we get
5040 ;; hits inside macros or at `c-decl-end' positions inside
5043 ;; The end position of the last entered macro.
5046 ;; Initialize by finding a syntactically relevant start position
5047 ;; before the point, and do the first `c-decl-prefix-or-start-re'
5048 ;; search unless we're at bob.
5050 (let (start-in-literal start-in-macro syntactic-pos)
5051 ;; Must back up a bit since we look for the end of the previous
5052 ;; statement or declaration, which is earlier than the first
5055 ;; This `cond' moves back over any literals or macros. It has special
5056 ;; handling for when the region being searched is entirely within a
5057 ;; macro. It sets `cfd-continue-pos' (unless we've reached
5060 ;; First we need to move to a syntactically relevant position.
5061 ;; Begin by backing out of comment or string literals.
5063 ;; This arm of the cond actually triggers if we're in a literal,
5064 ;; and cfd-limit is at most at BONL.
5066 ;; This arm of the `and' moves backwards out of a literal when
5067 ;; the face at point is a literal face. In this case, its value
5068 ;; is always non-nil.
5069 (when (c-got-face-at (point) c-literal-faces)
5070 ;; Try to use the faces to back up to the start of the
5071 ;; literal. FIXME: What if the point is on a declaration
5072 ;; inside a comment?
5073 (while (and (not (bobp))
5074 (c-got-face-at (1- (point)) c-literal-faces))
5075 (goto-char (previous-single-property-change
5076 (point) 'face nil (point-min))))
5078 ;; XEmacs doesn't fontify the quotes surrounding string
5080 (and (featurep 'xemacs)
5081 (eq (get-text-property (point) 'face)
5082 'font-lock-string-face)
5084 (progn (backward-char)
5085 (not (looking-at c-string-limit-regexp)))
5088 ;; Don't trust the literal to contain only literal faces
5089 ;; (the font lock package might not have fontified the
5090 ;; start of it at all, for instance) so check that we have
5091 ;; arrived at something that looks like a start or else
5092 ;; resort to `c-literal-limits'.
5093 (unless (looking-at c-literal-start-regexp)
5094 (let ((range (c-literal-limits)))
5095 (if range (goto-char (car range)))))
5097 (setq start-in-literal (point))) ; end of `and' arm.
5099 ;; The start is in a literal. If the limit is in the same
5100 ;; one we don't have to find a syntactic position etc. We
5101 ;; only check that if the limit is at or before bonl to save
5102 ;; time; it covers the by far most common case when font-lock
5103 ;; refontifies the current line only.
5104 (<= cfd-limit (c-point 'bonl cfd-start-pos))
5106 (goto-char cfd-start-pos)
5108 (goto-char (c-next-single-property-change
5109 (point) 'face nil cfd-limit))
5110 (and (< (point) cfd-limit)
5111 (c-got-face-at (point) c-literal-faces))))
5112 (= (point) cfd-limit))) ; end of `cond' arm condition
5114 ;; Completely inside a literal. Set up variables to trig the
5115 ;; (< cfd-continue-pos cfd-start-pos) case below and it'll
5116 ;; find a suitable start position.
5117 (setq cfd-continue-pos start-in-literal)) ; end of `cond' arm
5119 ;; Check if the region might be completely inside a macro, to
5120 ;; optimize that like the completely-inside-literal above.
5122 (and (= (forward-line 1) 0)
5123 (bolp) ; forward-line has funny behavior at eob.
5124 (>= (point) cfd-limit)
5125 (progn (backward-char)
5126 (eq (char-before) ?\\))))
5127 ;; (Maybe) completely inside a macro. Only need to trig the
5128 ;; (< cfd-continue-pos cfd-start-pos) case below to make it
5130 (setq cfd-continue-pos (1- cfd-start-pos)
5133 ;; The default arm of the `cond' moves back over any macro we're in
5134 ;; and over any syntactic WS. It sets `c-find-decl-syntactic-pos'.
5136 ;; Back out of any macro so we don't miss any declaration
5137 ;; that could follow after it.
5138 (when (c-beginning-of-macro)
5139 (setq start-in-macro t))
5141 ;; Now we're at a proper syntactically relevant position so we
5142 ;; can use the cache. But first clear it if it applied
5144 (c-invalidate-find-decl-cache cfd-start-pos)
5146 (setq syntactic-pos (point))
5147 (unless (eq syntactic-pos c-find-decl-syntactic-pos)
5148 ;; Don't have to do this if the cache is relevant here,
5149 ;; typically if the same line is refontified again. If
5150 ;; we're just some syntactic whitespace further down we can
5151 ;; still use the cache to limit the skipping.
5152 (c-backward-syntactic-ws c-find-decl-syntactic-pos))
5154 ;; If we hit `c-find-decl-syntactic-pos' and
5155 ;; `c-find-decl-match-pos' is set then we install the cached
5156 ;; values. If we hit `c-find-decl-syntactic-pos' and
5157 ;; `c-find-decl-match-pos' is nil then we know there's no decl
5158 ;; prefix in the whitespace before `c-find-decl-syntactic-pos'
5159 ;; and so we can continue the search from this point. If we
5160 ;; didn't hit `c-find-decl-syntactic-pos' then we're now in
5161 ;; the right spot to begin searching anyway.
5162 (if (and (eq (point) c-find-decl-syntactic-pos)
5163 c-find-decl-match-pos)
5164 (setq cfd-match-pos c-find-decl-match-pos
5165 cfd-continue-pos syntactic-pos)
5167 (setq c-find-decl-syntactic-pos syntactic-pos)
5170 ;; Always consider bob a match to get the first
5171 ;; declaration in the file. Do this separately instead of
5172 ;; letting `c-decl-prefix-or-start-re' match bob, so that
5173 ;; regexp always can consume at least one character to
5174 ;; ensure that we won't get stuck in an infinite loop.
5175 (setq cfd-re-match 0)
5177 (c-beginning-of-current-token)
5178 (< (point) cfd-limit))
5179 ;; Do an initial search now. In the bob case above it's
5180 ;; only done to search for a `c-decl-end' spot.
5181 (c-find-decl-prefix-search)) ; sets cfd-continue-pos
5183 (setq c-find-decl-match-pos (and (< cfd-match-pos cfd-start-pos)
5184 cfd-match-pos))))) ; end of `cond'
5186 ;; Advance `cfd-continue-pos' if it's before the start position.
5187 ;; The closest continue position that might have effect at or
5188 ;; after the start depends on what we started in. This also
5189 ;; finds a suitable start position in the special cases when the
5190 ;; region is completely within a literal or macro.
5191 (when (and cfd-continue-pos (< cfd-continue-pos cfd-start-pos))
5195 ;; If we're in a macro then it's the closest preceding token
5196 ;; in the macro. Check this before `start-in-literal',
5197 ;; since if we're inside a literal in a macro, the preceding
5198 ;; token is earlier than any `c-decl-end' spot inside the
5199 ;; literal (comment).
5200 (goto-char (or start-in-literal cfd-start-pos))
5201 ;; The only syntactic ws in macros are comments.
5202 (c-backward-comments)
5204 (c-beginning-of-current-token))
5207 ;; If we're in a comment it can only be the closest
5208 ;; preceding `c-decl-end' position within that comment, if
5209 ;; any. Go back to the beginning of such a property so that
5210 ;; `c-find-decl-prefix-search' will find the end of it.
5211 ;; (Can't stop at the end and install it directly on
5212 ;; `cfd-prop-match' since that variable might be cleared
5213 ;; after `cfd-fun' below.)
5215 ;; Note that if the literal is a string then the property
5216 ;; search will simply skip to the beginning of it right
5218 (if (not c-type-decl-end-used)
5219 (goto-char start-in-literal)
5220 (goto-char cfd-start-pos)
5222 (goto-char (previous-single-property-change
5223 (point) 'c-type nil start-in-literal))
5224 (and (> (point) start-in-literal)
5225 (not (eq (c-get-char-property (point) 'c-type)
5228 (when (= (point) start-in-literal)
5229 ;; Didn't find any property inside the comment, so we can
5230 ;; skip it entirely. (This won't skip past a string, but
5231 ;; that'll be handled quickly by the next
5232 ;; `c-find-decl-prefix-search' anyway.)
5233 (c-forward-single-comment)
5234 (if (> (point) cfd-limit)
5235 (goto-char cfd-limit))))
5238 ;; If we started in normal code, the only match that might
5239 ;; apply before the start is what we already got in
5240 ;; `cfd-match-pos' so we can continue at the start position.
5241 ;; (Note that we don't get here if the first match is below
5243 (goto-char cfd-start-pos))) ; end of `cond'
5245 ;; Delete found matches if they are before our new continue
5246 ;; position, so that `c-find-decl-prefix-search' won't back up
5247 ;; to them later on.
5248 (setq cfd-continue-pos (point))
5249 (when (and cfd-re-match (< cfd-re-match cfd-continue-pos))
5250 (setq cfd-re-match nil))
5251 (when (and cfd-prop-match (< cfd-prop-match cfd-continue-pos))
5252 (setq cfd-prop-match nil))) ; end of `when'
5255 ;; This is the normal case and we got a proper syntactic
5256 ;; position. If there's a match then it's always outside
5257 ;; macros and comments, so advance to the next token and set
5258 ;; `cfd-token-pos'. The loop below will later go back using
5259 ;; `cfd-continue-pos' to fix declarations inside the
5261 (when (and cfd-match-pos (< cfd-match-pos syntactic-pos))
5262 (goto-char syntactic-pos)
5263 (c-forward-syntactic-ws)
5264 (and cfd-continue-pos
5265 (< cfd-continue-pos (point))
5266 (setq cfd-token-pos (point))))
5268 ;; Have one of the special cases when the region is completely
5269 ;; within a literal or macro. `cfd-continue-pos' is set to a
5270 ;; good start position for the search, so do it.
5271 (c-find-decl-prefix-search)))
5273 ;; Now loop, one decl spot per iteration. We already have the first
5274 ;; match in `cfd-match-pos'.
5276 ;; Go forward over "false matches", one per iteration.
5278 (< cfd-match-pos cfd-limit)
5281 ;; Kludge to filter out matches on the "<" that
5282 ;; aren't open parens, for the sake of languages
5283 ;; that got `c-recognize-<>-arglists' set.
5284 (and (eq (char-before cfd-match-pos) ?<)
5285 (not (c-get-char-property (1- cfd-match-pos)
5288 ;; If `cfd-continue-pos' is less or equal to
5289 ;; `cfd-token-pos', we've got a hit inside a macro
5290 ;; that's in the syntactic whitespace before the last
5291 ;; "real" declaration we've checked. If they're equal
5292 ;; we've arrived at the declaration a second time, so
5293 ;; there's nothing to do.
5294 (= cfd-continue-pos cfd-token-pos)
5297 ;; If `cfd-continue-pos' is less than `cfd-token-pos'
5298 ;; we're still searching for declarations embedded in
5299 ;; the syntactic whitespace. In that case we need
5300 ;; only to skip comments and not macros, since they
5301 ;; can't be nested, and that's already been done in
5302 ;; `c-find-decl-prefix-search'.
5303 (when (> cfd-continue-pos cfd-token-pos)
5304 (c-forward-syntactic-ws)
5305 (setq cfd-token-pos (point)))
5307 ;; Continue if the following token fails the
5308 ;; CFD-DECL-RE and CFD-FACE-CHECKLIST checks.
5309 (when (or (>= (point) cfd-limit)
5310 (not (looking-at cfd-decl-re))
5311 (and cfd-face-checklist
5313 (point) cfd-face-checklist))))
5314 (goto-char cfd-continue-pos)
5317 (< (point) cfd-limit)) ; end of "false matches" condition
5318 (c-find-decl-prefix-search)) ; end of "false matches" loop
5320 (< (point) cfd-limit)) ; end of condition for "decl-spot" while
5323 (>= (point) cfd-start-pos)
5326 ;; Narrow to the end of the macro if we got a hit inside
5327 ;; one, to avoid recognizing things that start inside the
5328 ;; macro and end outside it.
5329 (when (> cfd-match-pos cfd-macro-end)
5330 ;; Not in the same macro as in the previous round.
5332 (goto-char cfd-match-pos)
5334 (if (save-excursion (and (c-beginning-of-macro)
5335 (< (point) cfd-match-pos)))
5336 (progn (c-end-of-macro)
5340 (if (zerop cfd-macro-end)
5342 (if (> cfd-macro-end (point))
5343 (progn (narrow-to-region (point-min) cfd-macro-end)
5345 ;; The matched token was the last thing in the macro,
5346 ;; so the whole match is bogus.
5347 (setq cfd-macro-end 0)
5348 nil)))) ; end of when condition
5350 (c-debug-put-decl-spot-faces cfd-match-pos (point))
5351 (if (funcall cfd-fun cfd-match-pos (/= cfd-macro-end 0))
5352 (setq cfd-prop-match nil))
5354 (when (/= cfd-macro-end 0)
5355 ;; Restore limits if we did macro narrowing above.
5356 (narrow-to-region (point-min) cfd-buffer-end)))
5358 (goto-char cfd-continue-pos)
5359 (if (= cfd-continue-pos cfd-limit)
5360 (setq cfd-match-pos cfd-limit)
5361 (c-find-decl-prefix-search))))) ; Moves point, sets cfd-continue-pos,
5362 ; cfd-match-pos, etc.
5365 ;; A cache for found types.
5367 ;; Buffer local variable that contains an obarray with the types we've
5368 ;; found. If a declaration is recognized somewhere we record the
5369 ;; fully qualified identifier in it to recognize it as a type
5370 ;; elsewhere in the file too. This is not accurate since we do not
5371 ;; bother with the scoping rules of the languages, but in practice the
5372 ;; same name is seldom used as both a type and something else in a
5373 ;; file, and we only use this as a last resort in ambiguous cases (see
5374 ;; `c-forward-decl-or-cast-1').
5376 ;; Not every type need be in this cache. However, things which have
5377 ;; ceased to be types must be removed from it.
5379 ;; Template types in C++ are added here too but with the template
5380 ;; arglist replaced with "<>" in references or "<" for the one in the
5381 ;; primary type. E.g. the type "Foo<A,B>::Bar<C>" is stored as
5382 ;; "Foo<>::Bar<". This avoids storing very long strings (since C++
5383 ;; template specs can be fairly sized programs in themselves) and
5384 ;; improves the hit ratio (it's a type regardless of the template
5385 ;; args; it's just not the same type, but we're only interested in
5386 ;; recognizing types, not telling distinct types apart). Note that
5387 ;; template types in references are added here too; from the example
5388 ;; above there will also be an entry "Foo<".
5389 (defvar c-found-types nil)
5390 (make-variable-buffer-local 'c-found-types)
5392 (defsubst c-clear-found-types ()
5393 ;; Clears `c-found-types'.
5394 (setq c-found-types (make-vector 53 0)))
5396 (defun c-add-type (from to)
5397 ;; Add the given region as a type in `c-found-types'. If the region
5398 ;; doesn't match an existing type but there is a type which is equal
5399 ;; to the given one except that the last character is missing, then
5400 ;; the shorter type is removed. That's done to avoid adding all
5401 ;; prefixes of a type as it's being entered and font locked. This
5402 ;; doesn't cover cases like when characters are removed from a type
5403 ;; or added in the middle. We'd need the position of point when the
5404 ;; font locking is invoked to solve this well.
5406 ;; This function might do hidden buffer changes.
5407 (let ((type (c-syntactic-content from to c-recognize-<>-arglists)))
5408 (unless (intern-soft type c-found-types)
5409 (unintern (substring type 0 -1) c-found-types)
5410 (intern type c-found-types))))
5412 (defun c-unfind-type (name)
5413 ;; Remove the "NAME" from c-found-types, if present.
5414 (unintern name c-found-types))
5416 (defsubst c-check-type (from to)
5417 ;; Return non-nil if the given region contains a type in
5420 ;; This function might do hidden buffer changes.
5421 (intern-soft (c-syntactic-content from to c-recognize-<>-arglists)
5424 (defun c-list-found-types ()
5425 ;; Return all the types in `c-found-types' as a sorted list of
5428 (mapatoms (lambda (type)
5429 (setq type-list (cons (symbol-name type)
5432 (sort type-list 'string-lessp)))
5434 ;; Shut up the byte compiler.
5435 (defvar c-maybe-stale-found-type)
5437 (defun c-trim-found-types (beg end old-len)
5438 ;; An after change function which, in conjunction with the info in
5439 ;; c-maybe-stale-found-type (set in c-before-change), removes a type
5440 ;; from `c-found-types', should this type have become stale. For
5441 ;; example, this happens to "foo" when "foo \n bar();" becomes
5442 ;; "foo(); \n bar();". Such stale types, if not removed, foul up
5443 ;; the fontification.
5445 ;; Have we, perhaps, added non-ws characters to the front/back of a found
5449 (when (< end (point-max))
5451 (if (and (c-beginning-of-current-token) ; only moves when we started in the middle
5452 (progn (goto-char end)
5453 (c-end-of-current-token)))
5454 (c-unfind-type (buffer-substring-no-properties
5456 (when (> beg (point-min))
5458 (if (and (c-end-of-current-token) ; only moves when we started in the middle
5459 (progn (goto-char beg)
5460 (c-beginning-of-current-token)))
5461 (c-unfind-type (buffer-substring-no-properties
5464 (if c-maybe-stale-found-type ; e.g. (c-decl-id-start "foo" 97 107 " (* ooka) " "o")
5466 ;; Changing the amount of (already existing) whitespace - don't do anything.
5467 ((and (c-partial-ws-p beg end)
5468 (or (= beg end) ; removal of WS
5469 (string-match "^[ \t\n\r\f\v]*$" (nth 5 c-maybe-stale-found-type)))))
5471 ;; The syntactic relationship which defined a "found type" has been
5473 ((eq (car c-maybe-stale-found-type) 'c-decl-id-start)
5474 (c-unfind-type (cadr c-maybe-stale-found-type)))
5475 ;; ((eq (car c-maybe-stale-found-type) 'c-decl-type-start) FIXME!!!
5479 ;; Setting and removing syntax properties on < and > in languages (C++
5480 ;; and Java) where they can be template/generic delimiters as well as
5481 ;; their normal meaning of "less/greater than".
5483 ;; Normally, < and > have syntax 'punctuation'. When they are found to
5484 ;; be delimiters, they are marked as such with the category properties
5485 ;; c-<-as-paren-syntax, c->-as-paren-syntax respectively.
5489 ;; It is impossible to determine with certainty whether a <..> pair in
5490 ;; C++ is two comparison operators or is template delimiters, unless
5491 ;; one duplicates a lot of a C++ compiler. For example, the following
5494 ;; foo (a < b, c > d) ;
5496 ;; could be a function call with two integer parameters (each a
5497 ;; relational expression), or it could be a constructor for class foo
5498 ;; taking one parameter d of templated type "a < b, c >". They are
5499 ;; somewhat easier to distinguish in Java.
5501 ;; The strategy now (2010-01) adopted is to mark and unmark < and
5502 ;; > IN MATCHING PAIRS ONLY. [Previously, they were marked
5503 ;; individually when their context so indicated. This gave rise to
5504 ;; intractable problems when one of a matching pair was deleted, or
5505 ;; pulled into a literal.]
5507 ;; At each buffer change, the syntax-table properties are removed in a
5508 ;; before-change function and reapplied, when needed, in an
5509 ;; after-change function. It is far more important that the
5510 ;; properties get removed when they they are spurious than that they
5511 ;; be present when wanted.
5512 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
5513 (defun c-clear-<-pair-props (&optional pos)
5514 ;; POS (default point) is at a < character. If it is marked with
5515 ;; open paren syntax-table text property, remove the property,
5516 ;; together with the close paren property on the matching > (if
5522 (when (equal (c-get-char-property (point) 'syntax-table)
5523 c-<-as-paren-syntax)
5524 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5525 (c-go-list-forward))
5526 (when (equal (c-get-char-property (1- (point)) 'syntax-table)
5527 c->-as-paren-syntax) ; should always be true.
5528 (c-unmark-<->-as-paren (1- (point))))
5529 (c-unmark-<->-as-paren pos))))
5531 (defun c-clear->-pair-props (&optional pos)
5532 ;; POS (default point) is at a > character. If it is marked with
5533 ;; close paren syntax-table property, remove the property, together
5534 ;; with the open paren property on the matching < (if any).
5539 (when (equal (c-get-char-property (point) 'syntax-table)
5540 c->-as-paren-syntax)
5541 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5542 (c-go-up-list-backward))
5543 (when (equal (c-get-char-property (point) 'syntax-table)
5544 c-<-as-paren-syntax) ; should always be true.
5545 (c-unmark-<->-as-paren (point)))
5546 (c-unmark-<->-as-paren pos))))
5548 (defun c-clear-<>-pair-props (&optional pos)
5549 ;; POS (default point) is at a < or > character. If it has an
5550 ;; open/close paren syntax-table property, remove this property both
5551 ;; from the current character and its partner (which will also be
5554 ((eq (char-after) ?\<)
5555 (c-clear-<-pair-props pos))
5556 ((eq (char-after) ?\>)
5557 (c-clear->-pair-props pos))
5559 "c-clear-<>-pair-props called from wrong position"))))
5561 (defun c-clear-<-pair-props-if-match-after (lim &optional pos)
5562 ;; POS (default point) is at a < character. If it is both marked
5563 ;; with open/close paren syntax-table property, and has a matching >
5564 ;; (also marked) which is after LIM, remove the property both from
5565 ;; the current > and its partner. Return t when this happens, nil
5571 (when (equal (c-get-char-property (point) 'syntax-table)
5572 c-<-as-paren-syntax)
5573 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5574 (c-go-list-forward))
5575 (when (and (>= (point) lim)
5576 (equal (c-get-char-property (1- (point)) 'syntax-table)
5577 c->-as-paren-syntax)) ; should always be true.
5578 (c-unmark-<->-as-paren (1- (point)))
5579 (c-unmark-<->-as-paren pos))
5582 (defun c-clear->-pair-props-if-match-before (lim &optional pos)
5583 ;; POS (default point) is at a > character. If it is both marked
5584 ;; with open/close paren syntax-table property, and has a matching <
5585 ;; (also marked) which is before LIM, remove the property both from
5586 ;; the current < and its partner. Return t when this happens, nil
5592 (when (equal (c-get-char-property (point) 'syntax-table)
5593 c->-as-paren-syntax)
5594 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5595 (c-go-up-list-backward))
5596 (when (and (<= (point) lim)
5597 (equal (c-get-char-property (point) 'syntax-table)
5598 c-<-as-paren-syntax)) ; should always be true.
5599 (c-unmark-<->-as-paren (point))
5600 (c-unmark-<->-as-paren pos))
5603 ;; Set by c-common-init in cc-mode.el.
5607 (defun c-before-change-check-<>-operators (beg end)
5608 ;; Unmark certain pairs of "< .... >" which are currently marked as
5609 ;; template/generic delimiters. (This marking is via syntax-table text
5610 ;; properties), and expand the (c-new-BEG c-new-END) region to include all
5611 ;; unmarked < and > operators within the certain bounds (see below).
5613 ;; These pairs are those which are in the current "statement" (i.e.,
5614 ;; the region between the {, }, or ; before BEG and the one after
5615 ;; END), and which enclose any part of the interval (BEG END).
5617 ;; Note that in C++ (?and Java), template/generic parens cannot
5618 ;; enclose a brace or semicolon, so we use these as bounds on the
5619 ;; region we must work on.
5621 ;; This function is called from before-change-functions (via
5622 ;; c-get-state-before-change-functions). Thus the buffer is widened,
5623 ;; and point is undefined, both at entry and exit.
5625 ;; FIXME!!! This routine ignores the possibility of macros entirely.
5628 (c-save-buffer-state
5629 ((beg-lit-limits (progn (goto-char beg) (c-literal-limits)))
5630 (end-lit-limits (progn (goto-char end) (c-literal-limits)))
5631 new-beg new-end beg-limit end-limit)
5632 ;; Locate the earliest < after the barrier before the changed region,
5633 ;; which isn't already marked as a paren.
5634 (goto-char (if beg-lit-limits (car beg-lit-limits) beg))
5635 (setq beg-limit (c-determine-limit 512))
5637 ;; Remove the syntax-table/category properties from each pertinent <...>
5638 ;; pair. Firstly, the ones with the < before beg and > after beg....
5639 (while (progn (c-syntactic-skip-backward "^;{}<" beg-limit)
5640 (eq (char-before) ?<))
5641 (c-backward-token-2)
5642 (when (eq (char-after) ?<)
5643 (c-clear-<-pair-props-if-match-after beg)))
5644 (c-forward-syntactic-ws)
5645 (setq new-beg (point))
5647 ;; ...Then the ones with < before end and > after end.
5648 (goto-char (if end-lit-limits (cdr end-lit-limits) end))
5649 (setq end-limit (c-determine-+ve-limit 512))
5650 (while (and (c-syntactic-re-search-forward "[;{}>]" end-limit 'end)
5651 (eq (char-before) ?>))
5652 (c-end-of-current-token)
5653 (when (eq (char-before) ?>)
5654 (c-clear->-pair-props-if-match-before end (1- (point)))))
5655 (c-backward-syntactic-ws)
5656 (setq new-end (point))
5658 ;; Extend the fontification region, if needed.
5660 (< new-beg c-new-BEG)
5661 (setq c-new-BEG new-beg))
5663 (> new-end c-new-END)
5664 (setq c-new-END new-end)))))
5666 (defun c-after-change-check-<>-operators (beg end)
5667 ;; This is called from `after-change-functions' when
5668 ;; c-recognize-<>-arglists' is set. It ensures that no "<" or ">"
5669 ;; chars with paren syntax become part of another operator like "<<"
5672 ;; This function might do hidden buffer changes.
5676 (when (or (looking-at "[<>]")
5677 (< (skip-chars-backward "<>") 0))
5680 (c-beginning-of-current-token)
5681 (when (and (< (point) beg)
5682 (looking-at c-<>-multichar-token-regexp)
5683 (< beg (setq beg (match-end 0))))
5684 (while (progn (skip-chars-forward "^<>" beg)
5686 (c-clear-<>-pair-props)
5691 (when (or (looking-at "[<>]")
5692 (< (skip-chars-backward "<>") 0))
5695 (c-beginning-of-current-token)
5696 (when (and (< (point) end)
5697 (looking-at c-<>-multichar-token-regexp)
5698 (< end (setq end (match-end 0))))
5699 (while (progn (skip-chars-forward "^<>" end)
5701 (c-clear-<>-pair-props)
5702 (forward-char)))))))
5704 (defun c-restore-<>-properties (_beg _end _old-len)
5705 ;; This function is called as an after-change function. It restores the
5706 ;; category/syntax-table properties on template/generic <..> pairs between
5707 ;; c-new-BEG and c-new-END. It may do hidden buffer changes.
5708 (c-save-buffer-state ((c-parse-and-markup-<>-arglists t)
5709 c-restricted-<>-arglists lit-limits)
5710 (goto-char c-new-BEG)
5711 (if (setq lit-limits (c-literal-limits))
5712 (goto-char (cdr lit-limits)))
5713 (while (and (< (point) c-new-END)
5714 (c-syntactic-re-search-forward "<" c-new-END 'bound))
5717 (c-backward-token-2)
5718 (setq c-restricted-<>-arglists
5719 (and (not (looking-at c-opt-<>-sexp-key))
5720 (progn (c-backward-syntactic-ws) ; to ( or ,
5721 (and (memq (char-before) '(?\( ?,)) ; what about <?
5722 (not (eq (c-get-char-property (point) 'c-type)
5723 'c-decl-arg-start)))))))
5724 (or (c-forward-<>-arglist nil)
5727 ;; Handling of small scale constructs like types and names.
5729 ;; Dynamically bound variable that instructs `c-forward-type' to also
5730 ;; treat possible types (i.e. those that it normally returns 'maybe or
5731 ;; 'found for) as actual types (and always return 'found for them).
5732 ;; This means that it records them in `c-record-type-identifiers' if
5733 ;; that is set, and that it adds them to `c-found-types'.
5734 (defvar c-promote-possible-types nil)
5736 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5737 ;; mark up successfully parsed arglists with paren syntax properties on
5738 ;; the surrounding angle brackets and with `c-<>-arg-sep' in the
5739 ;; `c-type' property of each argument separating comma.
5741 ;; Setting this variable also makes `c-forward-<>-arglist' recurse into
5742 ;; all arglists for side effects (i.e. recording types), otherwise it
5743 ;; exploits any existing paren syntax properties to quickly jump to the
5744 ;; end of already parsed arglists.
5746 ;; Marking up the arglists is not the default since doing that correctly
5747 ;; depends on a proper value for `c-restricted-<>-arglists'.
5748 (defvar c-parse-and-markup-<>-arglists nil)
5750 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5751 ;; not accept arglists that contain binary operators.
5753 ;; This is primarily used to handle C++ template arglists. C++
5754 ;; disambiguates them by checking whether the preceding name is a
5755 ;; template or not. We can't do that, so we assume it is a template
5756 ;; if it can be parsed as one. That usually works well since
5757 ;; comparison expressions on the forms "a < b > c" or "a < b, c > d"
5758 ;; in almost all cases would be pointless.
5760 ;; However, in function arglists, e.g. in "foo (a < b, c > d)", we
5761 ;; should let the comma separate the function arguments instead. And
5762 ;; in a context where the value of the expression is taken, e.g. in
5763 ;; "if (a < b || c > d)", it's probably not a template.
5764 (defvar c-restricted-<>-arglists nil)
5766 ;; Dynamically bound variables that instructs
5767 ;; `c-forward-keyword-clause', `c-forward-<>-arglist',
5768 ;; `c-forward-name', `c-forward-type', `c-forward-decl-or-cast-1', and
5769 ;; `c-forward-label' to record the ranges of all the type and
5770 ;; reference identifiers they encounter. They will build lists on
5771 ;; these variables where each element is a cons of the buffer
5772 ;; positions surrounding each identifier. This recording is only
5773 ;; activated when `c-record-type-identifiers' is non-nil.
5775 ;; All known types that can't be identifiers are recorded, and also
5776 ;; other possible types if `c-promote-possible-types' is set.
5777 ;; Recording is however disabled inside angle bracket arglists that
5778 ;; are encountered inside names and other angle bracket arglists.
5779 ;; Such occurrences are taken care of by `c-font-lock-<>-arglists'
5782 ;; Only the names in C++ template style references (e.g. "tmpl" in
5783 ;; "tmpl<a,b>::foo") are recorded as references, other references
5784 ;; aren't handled here.
5786 ;; `c-forward-label' records the label identifier(s) on
5787 ;; `c-record-ref-identifiers'.
5788 (defvar c-record-type-identifiers nil)
5789 (defvar c-record-ref-identifiers nil)
5791 ;; This variable will receive a cons cell of the range of the last
5792 ;; single identifier symbol stepped over by `c-forward-name' if it's
5793 ;; successful. This is the range that should be put on one of the
5794 ;; record lists above by the caller. It's assigned nil if there's no
5795 ;; such symbol in the name.
5796 (defvar c-last-identifier-range nil)
5798 (defmacro c-record-type-id (range)
5799 (if (eq (car-safe range) 'cons)
5801 `(setq c-record-type-identifiers
5802 (cons ,range c-record-type-identifiers))
5803 `(let ((range ,range))
5805 (setq c-record-type-identifiers
5806 (cons range c-record-type-identifiers))))))
5808 (defmacro c-record-ref-id (range)
5809 (if (eq (car-safe range) 'cons)
5811 `(setq c-record-ref-identifiers
5812 (cons ,range c-record-ref-identifiers))
5813 `(let ((range ,range))
5815 (setq c-record-ref-identifiers
5816 (cons range c-record-ref-identifiers))))))
5818 ;; Dynamically bound variable that instructs `c-forward-type' to
5819 ;; record the ranges of types that only are found. Behaves otherwise
5820 ;; like `c-record-type-identifiers'.
5821 (defvar c-record-found-types nil)
5823 (defmacro c-forward-keyword-prefixed-id (type)
5824 ;; Used internally in `c-forward-keyword-clause' to move forward
5825 ;; over a type (if TYPE is 'type) or a name (otherwise) which
5826 ;; possibly is prefixed by keywords and their associated clauses.
5827 ;; Try with a type/name first to not trip up on those that begin
5828 ;; with a keyword. Return t if a known or found type is moved
5829 ;; over. The point is clobbered if nil is returned. If range
5830 ;; recording is enabled, the identifier is recorded on as a type
5831 ;; if TYPE is 'type or as a reference if TYPE is 'ref.
5833 ;; This macro might do hidden buffer changes.
5835 (while (if (setq res ,(if (eq type 'type)
5839 (cond ((looking-at c-keywords-regexp)
5840 (c-forward-keyword-clause 1))
5841 ((looking-at c-noise-macro-with-parens-name-re)
5842 (c-forward-noise-clause)))))
5843 (when (memq res '(t known found prefix))
5844 ,(when (eq type 'ref)
5845 `(when c-record-type-identifiers
5846 (c-record-ref-id c-last-identifier-range)))
5849 (defmacro c-forward-id-comma-list (type update-safe-pos)
5850 ;; Used internally in `c-forward-keyword-clause' to move forward
5851 ;; over a comma separated list of types or names using
5852 ;; `c-forward-keyword-prefixed-id'.
5854 ;; This macro might do hidden buffer changes.
5856 ,(when update-safe-pos
5857 `(setq safe-pos (point)))
5858 (eq (char-after) ?,))
5861 (c-forward-syntactic-ws)
5862 (c-forward-keyword-prefixed-id ,type)))))
5864 (defun c-forward-noise-clause ()
5865 ;; Point is at a c-noise-macro-with-parens-names macro identifier. Go
5866 ;; forward over this name, any parenthesis expression which follows it, and
5867 ;; any syntactic WS, ending up at the next token. If there is an unbalanced
5868 ;; paren expression, leave point at it. Always Return t.
5870 (if (and (eq (char-after) ?\()
5871 (c-go-list-forward))
5872 (c-forward-syntactic-ws))
5875 (defun c-forward-keyword-clause (match)
5876 ;; Submatch MATCH in the current match data is assumed to surround a
5877 ;; token. If it's a keyword, move over it and any immediately
5878 ;; following clauses associated with it, stopping at the start of
5879 ;; the next token. t is returned in that case, otherwise the point
5880 ;; stays and nil is returned. The kind of clauses that are
5881 ;; recognized are those specified by `c-type-list-kwds',
5882 ;; `c-ref-list-kwds', `c-colon-type-list-kwds',
5883 ;; `c-paren-nontype-kwds', `c-paren-type-kwds', `c-<>-type-kwds',
5884 ;; and `c-<>-arglist-kwds'.
5886 ;; This function records identifier ranges on
5887 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5888 ;; `c-record-type-identifiers' is non-nil.
5890 ;; Note that for `c-colon-type-list-kwds', which doesn't necessary
5891 ;; apply directly after the keyword, the type list is moved over
5892 ;; only when there is no unaccounted token before it (i.e. a token
5893 ;; that isn't moved over due to some other keyword list). The
5894 ;; identifier ranges in the list are still recorded if that should
5897 ;; This function might do hidden buffer changes.
5899 (let ((kwd-sym (c-keyword-sym (match-string match))) safe-pos pos
5900 ;; The call to `c-forward-<>-arglist' below is made after
5901 ;; `c-<>-sexp-kwds' keywords, so we're certain they actually
5902 ;; are angle bracket arglists and `c-restricted-<>-arglists'
5903 ;; should therefore be nil.
5904 (c-parse-and-markup-<>-arglists t)
5905 c-restricted-<>-arglists)
5908 (goto-char (match-end match))
5909 (c-forward-syntactic-ws)
5910 (setq safe-pos (point))
5913 ((and (c-keyword-member kwd-sym 'c-type-list-kwds)
5914 (c-forward-keyword-prefixed-id type))
5915 ;; There's a type directly after a keyword in `c-type-list-kwds'.
5916 (c-forward-id-comma-list type t))
5918 ((and (c-keyword-member kwd-sym 'c-ref-list-kwds)
5919 (c-forward-keyword-prefixed-id ref))
5920 ;; There's a name directly after a keyword in `c-ref-list-kwds'.
5921 (c-forward-id-comma-list ref t))
5923 ((and (c-keyword-member kwd-sym 'c-paren-any-kwds)
5924 (eq (char-after) ?\())
5925 ;; There's an open paren after a keyword in `c-paren-any-kwds'.
5928 (when (and (setq pos (c-up-list-forward))
5929 (eq (char-before pos) ?\)))
5930 (when (and c-record-type-identifiers
5931 (c-keyword-member kwd-sym 'c-paren-type-kwds))
5932 ;; Use `c-forward-type' on every identifier we can find
5933 ;; inside the paren, to record the types.
5934 (while (c-syntactic-re-search-forward c-symbol-start pos t)
5935 (goto-char (match-beginning 0))
5936 (unless (c-forward-type)
5937 (looking-at c-symbol-key) ; Always matches.
5938 (goto-char (match-end 0)))))
5941 (c-forward-syntactic-ws)
5942 (setq safe-pos (point))))
5944 ((and (c-keyword-member kwd-sym 'c-<>-sexp-kwds)
5945 (eq (char-after) ?<)
5946 (c-forward-<>-arglist (c-keyword-member kwd-sym 'c-<>-type-kwds)))
5947 (c-forward-syntactic-ws)
5948 (setq safe-pos (point)))
5950 ((and (c-keyword-member kwd-sym 'c-nonsymbol-sexp-kwds)
5951 (not (looking-at c-symbol-start))
5952 (c-safe (c-forward-sexp) t))
5953 (c-forward-syntactic-ws)
5954 (setq safe-pos (point))))
5956 (when (c-keyword-member kwd-sym 'c-colon-type-list-kwds)
5957 (if (eq (char-after) ?:)
5958 ;; If we are at the colon already, we move over the type
5962 (c-forward-syntactic-ws)
5963 (when (c-forward-keyword-prefixed-id type)
5964 (c-forward-id-comma-list type t)))
5965 ;; Not at the colon, so stop here. But the identifier
5966 ;; ranges in the type list later on should still be
5968 (and c-record-type-identifiers
5970 ;; If a keyword matched both one of the types above and
5971 ;; this one, we match `c-colon-type-list-re' after the
5972 ;; clause matched above.
5973 (goto-char safe-pos)
5974 (looking-at c-colon-type-list-re))
5976 (goto-char (match-end 0))
5977 (c-forward-syntactic-ws)
5978 (c-forward-keyword-prefixed-id type))
5979 ;; There's a type after the `c-colon-type-list-re' match
5980 ;; after a keyword in `c-colon-type-list-kwds'.
5981 (c-forward-id-comma-list type nil))))
5983 (goto-char safe-pos)
5986 ;; cc-mode requires cc-fonts.
5987 (declare-function c-fontify-recorded-types-and-refs "cc-fonts" ())
5989 (defun c-forward-<>-arglist (all-types)
5990 ;; The point is assumed to be at a "<". Try to treat it as the open
5991 ;; paren of an angle bracket arglist and move forward to the
5992 ;; corresponding ">". If successful, the point is left after the
5993 ;; ">" and t is returned, otherwise the point isn't moved and nil is
5994 ;; returned. If ALL-TYPES is t then all encountered arguments in
5995 ;; the arglist that might be types are treated as found types.
5997 ;; The variable `c-parse-and-markup-<>-arglists' controls how this
5998 ;; function handles text properties on the angle brackets and argument
5999 ;; separating commas.
6001 ;; `c-restricted-<>-arglists' controls how lenient the template
6002 ;; arglist recognition should be.
6004 ;; This function records identifier ranges on
6005 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6006 ;; `c-record-type-identifiers' is non-nil.
6008 ;; This function might do hidden buffer changes.
6010 (let ((start (point))
6011 ;; If `c-record-type-identifiers' is set then activate
6012 ;; recording of any found types that constitute an argument in
6014 (c-record-found-types (if c-record-type-identifiers t)))
6015 (if (catch 'angle-bracket-arglist-escape
6016 (setq c-record-found-types
6017 (c-forward-<>-arglist-recur all-types)))
6019 (when (consp c-record-found-types)
6020 (setq c-record-type-identifiers
6021 ;; `nconc' doesn't mind that the tail of
6022 ;; `c-record-found-types' is t.
6023 (nconc c-record-found-types c-record-type-identifiers)))
6024 (if (c-major-mode-is 'java-mode) (c-fontify-recorded-types-and-refs))
6030 (defun c-forward-<>-arglist-recur (all-types)
6031 ;; Recursive part of `c-forward-<>-arglist'.
6033 ;; This function might do hidden buffer changes.
6034 (let ((start (point)) res pos
6035 ;; Cover this so that any recorded found type ranges are
6036 ;; automatically lost if it turns out to not be an angle
6037 ;; bracket arglist. It's propagated through the return value
6038 ;; on successful completion.
6039 (c-record-found-types c-record-found-types)
6040 ;; List that collects the positions after the argument
6041 ;; separating ',' in the arglist.
6043 ;; If the '<' has paren open syntax then we've marked it as an angle
6044 ;; bracket arglist before, so skip to the end.
6045 (if (and (not c-parse-and-markup-<>-arglists)
6046 (c-get-char-property (point) 'syntax-table))
6050 (if (and (c-go-up-list-forward)
6051 (eq (char-before) ?>))
6053 ;; Got unmatched paren angle brackets. We don't clear the paren
6054 ;; syntax properties and retry, on the basis that it's very
6055 ;; unlikely that paren angle brackets become operators by code
6056 ;; manipulation. It's far more likely that it doesn't match due
6057 ;; to narrowing or some temporary change.
6061 (forward-char) ; Forward over the opening '<'.
6063 (unless (looking-at c-<-op-cont-regexp)
6064 ;; go forward one non-alphanumeric character (group) per iteration of
6068 (c-forward-syntactic-ws)
6069 (when (or (and c-record-type-identifiers all-types)
6070 (c-major-mode-is 'java-mode))
6071 ;; All encountered identifiers are types, so set the
6072 ;; promote flag and parse the type.
6074 (c-forward-syntactic-ws)
6075 (if (looking-at "\\?")
6077 (when (looking-at c-identifier-start)
6078 (let ((c-promote-possible-types t)
6079 (c-record-found-types t))
6082 (c-forward-syntactic-ws)
6084 (when (or (looking-at "extends")
6085 (looking-at "super"))
6087 (c-forward-syntactic-ws)
6088 (let ((c-promote-possible-types t)
6089 (c-record-found-types t))
6091 (c-forward-syntactic-ws)))))
6093 (setq pos (point)) ; e.g. first token inside the '<'
6095 ;; Note: These regexps exploit the match order in \| so
6096 ;; that "<>" is matched by "<" rather than "[^>:-]>".
6097 (c-syntactic-re-search-forward
6098 ;; Stop on ',', '|', '&', '+' and '-' to catch
6099 ;; common binary operators that could be between
6100 ;; two comparison expressions "a<b" and "c>d".
6101 ;; 2016-02-11: C++11 templates can now contain arithmetic
6102 ;; expressions, so template detection in C++ is now less
6103 ;; robust than it was.
6104 c-<>-notable-chars-re
6108 ((eq (char-before) ?>)
6109 ;; Either an operator starting with '>' or the end of
6110 ;; the angle bracket arglist.
6113 (c-backward-token-2)
6114 (looking-at c-multichar->-op-not->>-regexp))
6116 (goto-char (match-end 0))
6117 t) ; Continue the loop.
6119 ;; The angle bracket arglist is finished.
6120 (when c-parse-and-markup-<>-arglists
6121 (while arg-start-pos
6122 (c-put-c-type-property (1- (car arg-start-pos))
6124 (setq arg-start-pos (cdr arg-start-pos)))
6125 (c-mark-<-as-paren start)
6126 (c-mark->-as-paren (1- (point))))
6128 nil)) ; Exit the loop.
6130 ((eq (char-before) ?<)
6131 ;; Either an operator starting with '<' or a nested arglist.
6133 (let (id-start id-end subres keyword-match)
6135 ;; The '<' begins a multi-char operator.
6136 ((looking-at c-<-op-cont-regexp)
6137 (goto-char (match-end 0)))
6138 ;; We're at a nested <.....>
6140 (backward-char) ; to the '<'
6143 ;; There's always an identifier before an angle
6144 ;; bracket arglist, or a keyword in `c-<>-type-kwds'
6145 ;; or `c-<>-arglist-kwds'.
6146 (c-backward-syntactic-ws)
6147 (setq id-end (point))
6148 (c-simple-skip-symbol-backward)
6149 (when (or (setq keyword-match
6150 (looking-at c-opt-<>-sexp-key))
6151 (not (looking-at c-keywords-regexp)))
6152 (setq id-start (point))))
6154 (let ((c-promote-possible-types t)
6155 (c-record-found-types t))
6156 (c-forward-<>-arglist-recur
6159 (c-keyword-sym (match-string 1))
6160 'c-<>-type-kwds))))))
6161 (or subres (goto-char pos))
6163 ;; It was an angle bracket arglist.
6164 (setq c-record-found-types subres)
6166 ;; Record the identifier before the template as a type
6167 ;; or reference depending on whether the arglist is last
6168 ;; in a qualified identifier.
6169 (when (and c-record-type-identifiers
6170 (not keyword-match))
6171 (if (and c-opt-identifier-concat-key
6173 (c-forward-syntactic-ws)
6174 (looking-at c-opt-identifier-concat-key)))
6175 (c-record-ref-id (cons id-start id-end))
6176 (c-record-type-id (cons id-start id-end)))))
6178 ;; At a "less than" operator.
6180 ;; (forward-char) ; NO! We've already gone over the <.
6182 t) ; carry on looping.
6185 (eq (char-before) ?\()
6186 (c-go-up-list-forward)
6187 (eq (char-before) ?\))))
6189 ((and (not c-restricted-<>-arglists)
6190 (or (and (eq (char-before) ?&)
6191 (not (eq (char-after) ?&)))
6192 (eq (char-before) ?,)))
6193 ;; Just another argument. Record the position. The
6194 ;; type check stuff that made us stop at it is at
6195 ;; the top of the loop.
6196 (setq arg-start-pos (cons (point) arg-start-pos)))
6199 ;; Got a character that can't be in an angle bracket
6200 ;; arglist argument. Abort using `throw', since
6201 ;; it's useless to try to find a surrounding arglist
6203 (throw 'angle-bracket-arglist-escape nil))))))
6205 (or c-record-found-types t)))))
6207 (defun c-backward-<>-arglist (all-types &optional limit)
6208 ;; The point is assumed to be directly after a ">". Try to treat it
6209 ;; as the close paren of an angle bracket arglist and move back to
6210 ;; the corresponding "<". If successful, the point is left at
6211 ;; the "<" and t is returned, otherwise the point isn't moved and
6212 ;; nil is returned. ALL-TYPES is passed on to
6213 ;; `c-forward-<>-arglist'.
6215 ;; If the optional LIMIT is given, it bounds the backward search.
6216 ;; It's then assumed to be at a syntactically relevant position.
6218 ;; This is a wrapper around `c-forward-<>-arglist'. See that
6219 ;; function for more details.
6221 (let ((start (point)))
6223 (if (and (not c-parse-and-markup-<>-arglists)
6224 (c-get-char-property (point) 'syntax-table))
6226 (if (and (c-go-up-list-backward)
6227 (eq (char-after) ?<))
6229 ;; See corresponding note in `c-forward-<>-arglist'.
6234 (c-syntactic-skip-backward "^<;{}" limit t)
6237 (if (eq (char-before) ?<)
6239 ;; Stopped at bob or a char that isn't allowed in an
6240 ;; arglist, so we've failed.
6245 (progn (c-beginning-of-current-token)
6247 ;; If we moved then the "<" was part of some
6248 ;; multicharacter token.
6252 (let ((beg-pos (point)))
6253 (if (c-forward-<>-arglist all-types)
6254 (cond ((= (point) start)
6255 ;; Matched the arglist. Break the while.
6259 ;; We started from a non-paren ">" inside an
6264 ;; Matched a shorter arglist. Can be a nested
6265 ;; one so continue looking.
6270 (/= (point) start))))
6272 (defun c-forward-name ()
6273 ;; Move forward over a complete name if at the beginning of one,
6274 ;; stopping at the next following token. A keyword, as such,
6275 ;; doesn't count as a name. If the point is not at something that
6276 ;; is recognized as a name then it stays put.
6278 ;; A name could be something as simple as "foo" in C or something as
6279 ;; complex as "X<Y<class A<int>::B, BIT_MAX >> b>, ::operator<> ::
6280 ;; Z<(a>b)> :: operator const X<&foo>::T Q::G<unsigned short
6281 ;; int>::*volatile const" in C++ (this function is actually little
6282 ;; more than a `looking-at' call in all modes except those that,
6283 ;; like C++, have `c-recognize-<>-arglists' set).
6286 ;; o - nil if no name is found;
6287 ;; o - 'template if it's an identifier ending with an angle bracket
6289 ;; o - 'operator of it's an operator identifier;
6290 ;; o - t if it's some other kind of name.
6292 ;; This function records identifier ranges on
6293 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6294 ;; `c-record-type-identifiers' is non-nil.
6296 ;; This function might do hidden buffer changes.
6298 (let ((pos (point)) (start (point)) res id-start id-end
6299 ;; Turn off `c-promote-possible-types' here since we might
6300 ;; call `c-forward-<>-arglist' and we don't want it to promote
6301 ;; every suspect thing in the arglist to a type. We're
6302 ;; typically called from `c-forward-type' in this case, and
6303 ;; the caller only wants the top level type that it finds to
6305 c-promote-possible-types)
6308 (looking-at c-identifier-key)
6311 ;; Check for keyword. We go to the last symbol in
6312 ;; `c-identifier-key' first.
6313 (goto-char (setq id-end (match-end 0)))
6314 (c-simple-skip-symbol-backward)
6315 (setq id-start (point))
6317 (if (looking-at c-keywords-regexp)
6318 (when (and (c-major-mode-is 'c++-mode)
6320 (cc-eval-when-compile
6321 (concat "\\(operator\\|\\(template\\)\\)"
6322 "\\(" (c-lang-const c-nonsymbol-key c++)
6324 (if (match-beginning 2)
6325 ;; "template" is only valid inside an
6326 ;; identifier if preceded by "::".
6328 (c-backward-syntactic-ws)
6329 (and (c-safe (backward-char 2) t)
6333 ;; Handle a C++ operator or template identifier.
6335 (c-forward-syntactic-ws)
6336 (cond ((eq (char-before id-end) ?e)
6337 ;; Got "... ::template".
6338 (let ((subres (c-forward-name)))
6343 ((looking-at c-identifier-start)
6344 ;; Got a cast operator.
6345 (when (c-forward-type)
6348 ;; Now we should match a sequence of either
6349 ;; '*', '&' or a name followed by ":: *",
6350 ;; where each can be followed by a sequence
6351 ;; of `c-opt-type-modifier-key'.
6352 (while (cond ((looking-at "[*&]")
6353 (goto-char (match-end 0))
6355 ((looking-at c-identifier-start)
6356 (and (c-forward-name)
6359 (goto-char (match-end 0))
6360 (c-forward-syntactic-ws)
6361 (eq (char-after) ?*))
6366 (c-forward-syntactic-ws)
6368 (looking-at c-opt-type-modifier-key))
6369 (goto-char (match-end 1))))))
6371 ((looking-at c-overloadable-operators-regexp)
6372 ;; Got some other operator.
6373 (setq c-last-identifier-range
6374 (cons (point) (match-end 0)))
6375 (goto-char (match-end 0))
6376 (c-forward-syntactic-ws)
6382 ;; `id-start' is equal to `id-end' if we've jumped over
6383 ;; an identifier that doesn't end with a symbol token.
6384 ;; That can occur e.g. for Java import directives on the
6385 ;; form "foo.bar.*".
6386 (when (and id-start (/= id-start id-end))
6387 (setq c-last-identifier-range
6388 (cons id-start id-end)))
6390 (c-forward-syntactic-ws)
6396 (when (or c-opt-identifier-concat-key
6397 c-recognize-<>-arglists)
6400 ((and c-opt-identifier-concat-key
6401 (looking-at c-opt-identifier-concat-key))
6402 ;; Got a concatenated identifier. This handles the
6403 ;; cases with tricky syntactic whitespace that aren't
6404 ;; covered in `c-identifier-key'.
6405 (goto-char (match-end 0))
6406 (c-forward-syntactic-ws)
6409 ((and c-recognize-<>-arglists
6410 (eq (char-after) ?<))
6411 ;; Maybe an angle bracket arglist.
6412 (when (let ((c-record-type-identifiers t)
6413 (c-record-found-types t))
6414 (c-forward-<>-arglist nil))
6416 (c-add-type start (1+ pos))
6417 (c-forward-syntactic-ws)
6419 c-last-identifier-range nil)
6421 (if (and c-opt-identifier-concat-key
6422 (looking-at c-opt-identifier-concat-key))
6424 ;; Continue if there's an identifier concatenation
6425 ;; operator after the template argument.
6427 (when (and c-record-type-identifiers id-start)
6428 (c-record-ref-id (cons id-start id-end)))
6430 (c-forward-syntactic-ws)
6433 (when (and c-record-type-identifiers id-start)
6434 (c-record-type-id (cons id-start id-end)))
6435 (setq res 'template)
6442 (defun c-forward-type (&optional brace-block-too)
6443 ;; Move forward over a type spec if at the beginning of one,
6444 ;; stopping at the next following token. The keyword "typedef"
6445 ;; isn't part of a type spec here.
6447 ;; BRACE-BLOCK-TOO, when non-nil, means move over the brace block in
6448 ;; constructs like "struct foo {...} bar ;" or "struct {...} bar;".
6449 ;; The current (2009-03-10) intention is to convert all uses of
6450 ;; `c-forward-type' to call with this parameter set, then to
6454 ;; o - t if it's a known type that can't be a name or other
6456 ;; o - 'known if it's an otherwise known type (according to
6457 ;; `*-font-lock-extra-types');
6458 ;; o - 'prefix if it's a known prefix of a type;
6459 ;; o - 'found if it's a type that matches one in `c-found-types';
6460 ;; o - 'maybe if it's an identifier that might be a type;
6461 ;; o - 'decltype if it's a decltype(variable) declaration; - or
6462 ;; o - nil if it can't be a type (the point isn't moved then).
6464 ;; The point is assumed to be at the beginning of a token.
6466 ;; Note that this function doesn't skip past the brace definition
6467 ;; that might be considered part of the type, e.g.
6468 ;; "enum {a, b, c} foo".
6470 ;; This function records identifier ranges on
6471 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6472 ;; `c-record-type-identifiers' is non-nil.
6474 ;; This function might do hidden buffer changes.
6475 (when (and c-recognize-<>-arglists
6477 (c-forward-<>-arglist t)
6478 (c-forward-syntactic-ws))
6480 (let ((start (point)) pos res name-res id-start id-end id-range)
6482 ;; Skip leading type modifiers. If any are found we know it's a
6483 ;; prefix of a type.
6484 (when c-opt-type-modifier-key ; e.g. "const" "volatile", but NOT "typedef"
6485 (while (looking-at c-opt-type-modifier-key)
6486 (goto-char (match-end 1))
6487 (c-forward-syntactic-ws)
6488 (setq res 'prefix)))
6491 ((looking-at c-typeof-key) ; e.g. C++'s "decltype".
6492 (goto-char (match-end 1))
6493 (c-forward-syntactic-ws)
6494 (setq res (and (eq (char-after) ?\()
6495 (c-safe (c-forward-sexp))
6498 (c-forward-syntactic-ws)
6501 ((looking-at c-type-prefix-key) ; e.g. "struct", "class", but NOT
6503 (goto-char (match-end 1))
6504 (c-forward-syntactic-ws)
6507 ((looking-at c-decl-hangon-key)
6508 (c-forward-keyword-clause 1))
6509 ((looking-at c-noise-macro-with-parens-name-re)
6510 (c-forward-noise-clause))))
6514 (setq name-res (c-forward-name))
6515 (setq res (not (null name-res)))
6516 (when (eq name-res t)
6517 ;; In many languages the name can be used without the
6518 ;; prefix, so we add it to `c-found-types'.
6519 (c-add-type pos (point))
6520 (when (and c-record-type-identifiers
6521 c-last-identifier-range)
6522 (c-record-type-id c-last-identifier-range)))
6523 (when (and brace-block-too
6525 (eq (char-after) ?\{)
6528 (progn (c-forward-sexp)
6529 (c-forward-syntactic-ws)
6530 (setq pos (point))))))
6533 (unless res (goto-char start))) ; invalid syntax
6537 (if (looking-at c-identifier-start)
6539 (setq id-start (point)
6540 name-res (c-forward-name))
6542 (setq id-end (point)
6543 id-range c-last-identifier-range))))
6544 (and (cond ((looking-at c-primitive-type-key)
6546 ((c-with-syntax-table c-identifier-syntax-table
6547 (looking-at c-known-type-key))
6552 (goto-char (match-end 1))
6553 (c-forward-syntactic-ws)
6554 (setq pos (point))))
6557 ;; Looking at a primitive or known type identifier. We've
6558 ;; checked for a name first so that we don't go here if the
6559 ;; known type match only is a prefix of another name.
6561 (setq id-end (match-end 1))
6563 (when (and c-record-type-identifiers
6564 (or c-promote-possible-types (eq res t)))
6565 (c-record-type-id (cons (match-beginning 1) (match-end 1))))
6567 (if (and c-opt-type-component-key
6569 (looking-at c-opt-type-component-key)))
6570 ;; There might be more keywords for the type.
6572 (c-forward-keyword-clause 1)
6574 (setq safe-pos (point))
6575 (looking-at c-opt-type-component-key))
6576 (when (and c-record-type-identifiers
6577 (looking-at c-primitive-type-key))
6578 (c-record-type-id (cons (match-beginning 1)
6580 (c-forward-keyword-clause 1))
6581 (if (looking-at c-primitive-type-key)
6583 (when c-record-type-identifiers
6584 (c-record-type-id (cons (match-beginning 1)
6586 (c-forward-keyword-clause 1)
6588 (goto-char safe-pos)
6589 (setq res 'prefix)))
6590 (unless (save-match-data (c-forward-keyword-clause 1))
6593 (goto-char (match-end 1))
6594 (c-forward-syntactic-ws)))))
6597 (cond ((eq name-res t)
6598 ;; A normal identifier.
6600 (if (or res c-promote-possible-types)
6602 (c-add-type id-start id-end)
6603 (when (and c-record-type-identifiers id-range)
6604 (c-record-type-id id-range))
6607 (setq res (if (c-check-type id-start id-end)
6608 ;; It's an identifier that has been used as
6609 ;; a type somewhere else.
6611 ;; It's an identifier that might be a type.
6613 ((eq name-res 'template)
6614 ;; A template is a type.
6618 ;; Otherwise it's an operator identifier, which is not a type.
6623 ;; Skip trailing type modifiers. If any are found we know it's
6625 (when c-opt-type-modifier-key
6626 (while (looking-at c-opt-type-modifier-key) ; e.g. "const", "volatile"
6627 (goto-char (match-end 1))
6628 (c-forward-syntactic-ws)
6631 ;; Step over any type suffix operator. Do not let the existence
6632 ;; of these alter the classification of the found type, since
6633 ;; these operators typically are allowed in normal expressions
6635 (when c-opt-type-suffix-key ; e.g. "..."
6636 (while (looking-at c-opt-type-suffix-key)
6637 (goto-char (match-end 1))
6638 (c-forward-syntactic-ws)))
6640 (when c-opt-type-concat-key ; Only/mainly for pike.
6641 ;; Look for a trailing operator that concatenates the type
6642 ;; with a following one, and if so step past that one through
6643 ;; a recursive call. Note that we don't record concatenated
6644 ;; types in `c-found-types' - it's the component types that
6645 ;; are recorded when appropriate.
6647 (let* ((c-promote-possible-types (or (memq res '(t known))
6648 c-promote-possible-types))
6649 ;; If we can't promote then set `c-record-found-types' so that
6650 ;; we can merge in the types from the second part afterwards if
6651 ;; it turns out to be a known type there.
6652 (c-record-found-types (and c-record-type-identifiers
6653 (not c-promote-possible-types)))
6655 (if (and (looking-at c-opt-type-concat-key)
6658 (goto-char (match-end 1))
6659 (c-forward-syntactic-ws)
6660 (setq subres (c-forward-type))))
6663 ;; If either operand certainly is a type then both are, but we
6664 ;; don't let the existence of the operator itself promote two
6665 ;; uncertain types to a certain one.
6668 (unless (eq name-res 'template)
6669 (c-add-type id-start id-end))
6670 (when (and c-record-type-identifiers id-range)
6671 (c-record-type-id id-range))
6682 (when (and (eq res t)
6683 (consp c-record-found-types))
6684 ;; Merge in the ranges of any types found by the second
6685 ;; `c-forward-type'.
6686 (setq c-record-type-identifiers
6687 ;; `nconc' doesn't mind that the tail of
6688 ;; `c-record-found-types' is t.
6689 (nconc c-record-found-types
6690 c-record-type-identifiers))))
6694 (when (and c-record-found-types (memq res '(known found)) id-range)
6695 (setq c-record-found-types
6696 (cons id-range c-record-found-types))))
6698 ;;(message "c-forward-type %s -> %s: %s" start (point) res)
6702 (defun c-forward-annotation ()
6703 ;; Used for Java code only at the moment. Assumes point is on the @, moves
6704 ;; forward an annotation and returns t. Leaves point unmoved and returns
6705 ;; nil if there is no annotation at point.
6706 (let ((pos (point)))
6708 (and (looking-at "@")
6709 (not (looking-at c-keywords-regexp))
6710 (progn (forward-char) t)
6711 (looking-at c-symbol-key)
6712 (progn (goto-char (match-end 0))
6713 (c-forward-syntactic-ws)
6715 (if (looking-at "(")
6718 (progn (goto-char pos) nil))))
6720 (defmacro c-pull-open-brace (ps)
6721 ;; Pull the next open brace from PS (which has the form of paren-state),
6722 ;; skipping over any brace pairs. Returns NIL when PS is exhausted.
6724 (while (consp (car ,ps))
6725 (setq ,ps (cdr ,ps)))
6727 (setq ,ps (cdr ,ps)))))
6729 (defun c-back-over-member-initializer-braces ()
6730 ;; Point is just after a closing brace/parenthesis. Try to parse this as a
6731 ;; C++ member initializer list, going back to just after the introducing ":"
6732 ;; and returning t. Otherwise return nil, leaving point unchanged.
6733 (let ((here (point)) res)
6736 (when (not (c-go-list-backward))
6738 (c-backward-syntactic-ws)
6739 (when (not (c-simple-skip-symbol-backward))
6741 (c-backward-syntactic-ws)
6743 (while (eq (char-before) ?,)
6745 (c-backward-syntactic-ws)
6746 (when (not (memq (char-before) '(?\) ?})))
6748 (when (not (c-go-list-backward))
6750 (c-backward-syntactic-ws)
6751 (when (not (c-simple-skip-symbol-backward))
6753 (c-backward-syntactic-ws))
6755 (eq (char-before) ?:)))
6756 (or res (goto-char here))
6759 (defmacro c-back-over-list-of-member-inits ()
6760 ;; Go back over a list of elements, each looking like:
6761 ;; <symbol> (<expression>) ,
6762 ;; or <symbol> {<expression>} ,
6763 ;; when we are putatively immediately after a comma. Stop when we don't see
6764 ;; a comma. If either of <symbol> or bracketed <expression> is missing,
6765 ;; throw nil to 'level. If the terminating } or ) is unmatched, throw nil
6766 ;; to 'done. This is not a general purpose macro!
6767 `(while (eq (char-before) ?,)
6769 (c-backward-syntactic-ws)
6770 (when (not (memq (char-before) '(?\) ?})))
6772 (when (not (c-go-list-backward))
6774 (c-backward-syntactic-ws)
6775 (when (not (c-simple-skip-symbol-backward))
6777 (c-backward-syntactic-ws)))
6779 (defun c-back-over-member-initializers ()
6780 ;; Test whether we are in a C++ member initializer list, and if so, go back
6781 ;; to the introducing ":", returning the position of the opening paren of
6782 ;; the function's arglist. Otherwise return nil, leaving point unchanged.
6783 (let ((here (point))
6784 (paren-state (c-parse-state))
6785 pos level-plausible at-top-level res)
6786 ;; Assume tentatively that we're at the top level. Try to go back to the
6790 (setq level-plausible
6792 (c-backward-syntactic-ws)
6793 (when (memq (char-before) '(?\) ?}))
6794 (when (not (c-go-list-backward))
6796 (c-backward-syntactic-ws))
6797 (when (c-simple-skip-symbol-backward)
6798 (c-backward-syntactic-ws))
6799 (c-back-over-list-of-member-inits)
6800 (and (eq (char-before) ?:)
6801 (c-just-after-func-arglist-p))))
6803 (while (and (not (and level-plausible
6804 (setq at-top-level (c-at-toplevel-p))))
6805 (setq pos (c-pull-open-brace paren-state))) ; might be a paren.
6806 (setq level-plausible
6809 (c-backward-syntactic-ws)
6810 (when (not (c-simple-skip-symbol-backward))
6812 (c-backward-syntactic-ws)
6813 (c-back-over-list-of-member-inits)
6814 (and (eq (char-before) ?:)
6815 (c-just-after-func-arglist-p)))))
6817 (and at-top-level level-plausible)))
6818 (or res (goto-char here))
6822 ;; Handling of large scale constructs like statements and declarations.
6824 ;; Macro used inside `c-forward-decl-or-cast-1'. It ought to be a
6825 ;; defsubst or perhaps even a defun, but it contains lots of free
6826 ;; variables that refer to things inside `c-forward-decl-or-cast-1'.
6827 (defmacro c-fdoc-shift-type-backward (&optional short)
6828 ;; `c-forward-decl-or-cast-1' can consume an arbitrary length list
6829 ;; of types when parsing a declaration, which means that it
6830 ;; sometimes consumes the identifier in the declaration as a type.
6831 ;; This is used to "backtrack" and make the last type be treated as
6832 ;; an identifier instead.
6835 ;; These identifiers are bound only in the inner let.
6836 '(setq identifier-type at-type
6837 identifier-start type-start
6841 got-suffix-after-parens id-start
6844 (if (setq at-type (if (eq backup-at-type 'prefix)
6847 (setq type-start backup-type-start
6848 id-start backup-id-start)
6849 (setq type-start start-pos
6850 id-start start-pos))
6852 ;; When these flags already are set we've found specifiers that
6853 ;; unconditionally signal these attributes - backtracking doesn't
6854 ;; change that. So keep them set in that case.
6856 (setq at-type-decl backup-at-type-decl))
6858 (setq maybe-typeless backup-maybe-typeless))
6861 ;; This identifier is bound only in the inner let.
6862 '(setq start id-start))))
6864 (defun c-forward-declarator (&optional limit accept-anon)
6865 ;; Assuming point is at the start of a declarator, move forward over it,
6866 ;; leaving point at the next token after it (e.g. a ) or a ; or a ,).
6868 ;; Return a list (ID-START ID-END BRACKETS-AFTER-ID GOT-INIT), where ID-START and
6869 ;; ID-END are the bounds of the declarator's identifier, and
6870 ;; BRACKETS-AFTER-ID is non-nil if a [...] pair is present after the id.
6871 ;; GOT-INIT is non-nil when the declarator is followed by "=" or "(".
6873 ;; If ACCEPT-ANON is non-nil, move forward over any "anonymous declarator",
6874 ;; i.e. something like the (*) in int (*), such as might be found in a
6875 ;; declaration. In such a case ID-START and ID-END in the return value are
6876 ;; both set to nil. A "null" "anonymous declarator" gives a non-nil result.
6878 ;; If no declarator is found, leave point unmoved and return nil. LIMIT is
6879 ;; an optional limit for forward searching.
6881 ;; Note that the global variable `c-last-identifier-range' is written to, so
6882 ;; the caller should bind it if necessary.
6884 ;; Inside the following "condition form", we move forward over the
6885 ;; declarator's identifier up as far as any opening bracket (for array
6886 ;; size) or paren (for parameters of function-type) or brace (for
6887 ;; array/struct initialization) or "=" or terminating delimiter
6888 ;; (e.g. "," or ";" or "}").
6889 (let ((here (point))
6890 id-start id-end brackets-after-id paren-depth)
6891 (or limit (setq limit (point-max)))
6895 ;; The following form moves forward over the declarator's
6896 ;; identifier (and what precedes it), returning t. If there
6897 ;; wasn't one, it returns nil.
6898 (let (got-identifier)
6899 (setq paren-depth 0)
6900 ;; Skip over type decl prefix operators, one for each iteration
6901 ;; of the while. These are, e.g. "*" in "int *foo" or "(" and
6902 ;; "*" in "int (*foo) (void)" (Note similar code in
6903 ;; `c-forward-decl-or-cast-1'.)
6906 ((looking-at c-decl-hangon-key)
6907 (c-forward-keyword-clause 1))
6908 ((looking-at c-noise-macro-with-parens-name-re)
6909 (c-forward-noise-clause))
6910 ((and (looking-at c-type-decl-prefix-key)
6911 (if (and (c-major-mode-is 'c++-mode)
6912 (match-beginning 3))
6913 ;; If the third submatch matches in C++ then
6914 ;; we're looking at an identifier that's a
6915 ;; prefix only if it specifies a member pointer.
6917 (setq id-start (point))
6919 (if (looking-at "\\(::\\)")
6920 ;; We only check for a trailing "::" and
6921 ;; let the "*" that should follow be
6922 ;; matched in the next round.
6924 ;; It turned out to be the real identifier,
6925 ;; so flag that and stop.
6926 (setq got-identifier t)
6929 (if (eq (char-after) ?\()
6931 (setq paren-depth (1+ paren-depth))
6933 (goto-char (match-end 1)))
6934 (c-forward-syntactic-ws)
6937 ;; If we haven't passed the identifier already, do it now.
6938 (unless got-identifier
6939 (setq id-start (point)))
6944 (c-backward-syntactic-ws)
6945 (setq id-end (point))))
6947 (setq id-start nil id-end nil)
6949 (t (/= (point) here))))
6951 ;; Skip out of the parens surrounding the identifier. If closing
6952 ;; parens are missing, this form returns nil.
6953 (or (= paren-depth 0)
6954 (c-safe (goto-char (scan-lists (point) 1 paren-depth))))
6958 ;; Skip over any trailing bit, such as "__attribute__".
6961 ((looking-at c-decl-hangon-key)
6962 (c-forward-keyword-clause 1))
6963 ((looking-at c-noise-macro-with-parens-name-re)
6964 (c-forward-noise-clause))))
6967 ;; Search syntactically to the end of the declarator (";",
6968 ;; ",", a closing paren, eob etc) or to the beginning of an
6969 ;; initializer or function prototype ("=" or "\\s\(").
6970 ;; Note that square brackets are now not also treated as
6971 ;; initializers, since this broke when there were also
6972 ;; initializing brace lists.
6975 (and (setq found (c-syntactic-re-search-forward
6976 "[;,]\\|\\s)\\|\\'\\|\\(=\\|\\s(\\)" limit t t))
6977 (eq (char-before) ?\[)
6978 (c-go-up-list-forward))
6979 (setq brackets-after-id t))
6982 (list id-start id-end brackets-after-id (match-beginning 1))
6987 (defun c-forward-decl-or-cast-1 (preceding-token-end context last-cast-end)
6988 ;; Move forward over a declaration or a cast if at the start of one.
6989 ;; The point is assumed to be at the start of some token. Nil is
6990 ;; returned if no declaration or cast is recognized, and the point
6991 ;; is clobbered in that case.
6993 ;; If a declaration is parsed:
6995 ;; The point is left at the first token after the first complete
6996 ;; declarator, if there is one. The return value is a cons where
6997 ;; the car is the position of the first token in the declarator. (See
6998 ;; below for the cdr.)
7001 ;; void foo (int a, char *b) stuff ...
7005 ;; unsigned int a = c_style_initializer, b;
7007 ;; unsigned int a (cplusplus_style_initializer), b;
7008 ;; car ^ ^ point (might change)
7009 ;; class Foo : public Bar {}
7011 ;; class PikeClass (int a, string b) stuff ...
7017 ;; void cplusplus_function (int x) throw (Bad);
7019 ;; Foo::Foo (int b) : Base (b) {}
7024 ;; auto cplusplus_11 (int a, char *b) -> decltype (bar):
7029 ;; The cdr of the return value is non-nil when a
7030 ;; `c-typedef-decl-kwds' specifier is found in the declaration.
7031 ;; Specifically it is a dotted pair (A . B) where B is t when a
7032 ;; `c-typedef-kwds' ("typedef") is present, and A is t when some
7033 ;; other `c-typedef-decl-kwds' (e.g. class, struct, enum)
7034 ;; specifier is present. I.e., (some of) the declared
7035 ;; identifier(s) are types.
7037 ;; If a cast is parsed:
7039 ;; The point is left at the first token after the closing paren of
7040 ;; the cast. The return value is `cast'. Note that the start
7041 ;; position must be at the first token inside the cast parenthesis
7044 ;; PRECEDING-TOKEN-END is the first position after the preceding
7045 ;; token, i.e. on the other side of the syntactic ws from the point.
7046 ;; Use a value less than or equal to (point-min) if the point is at
7047 ;; the first token in (the visible part of) the buffer.
7049 ;; CONTEXT is a symbol that describes the context at the point:
7050 ;; 'decl In a comma-separated declaration context (typically
7051 ;; inside a function declaration arglist).
7052 ;; '<> In an angle bracket arglist.
7053 ;; 'arglist Some other type of arglist.
7054 ;; nil Some other context or unknown context. Includes
7055 ;; within the parens of an if, for, ... construct.
7057 ;; LAST-CAST-END is the first token after the closing paren of a
7058 ;; preceding cast, or nil if none is known. If
7059 ;; `c-forward-decl-or-cast-1' is used in succession, it should be
7060 ;; the position after the closest preceding call where a cast was
7061 ;; matched. In that case it's used to discover chains of casts like
7064 ;; This function records identifier ranges on
7065 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
7066 ;; `c-record-type-identifiers' is non-nil.
7068 ;; This function might do hidden buffer changes.
7070 (let (;; `start-pos' is used below to point to the start of the
7071 ;; first type, i.e. after any leading specifiers. It might
7072 ;; also point at the beginning of the preceding syntactic
7075 ;; Set to the result of `c-forward-type'.
7077 ;; The position of the first token in what we currently
7078 ;; believe is the type in the declaration or cast, after any
7079 ;; specifiers and their associated clauses.
7081 ;; The position of the first token in what we currently
7082 ;; believe is the declarator for the first identifier. Set
7083 ;; when the type is found, and moved forward over any
7084 ;; `c-decl-hangon-kwds' and their associated clauses that
7085 ;; occurs after the type.
7087 ;; These store `at-type', `type-start' and `id-start' of the
7088 ;; identifier before the one in those variables. The previous
7089 ;; identifier might turn out to be the real type in a
7090 ;; declaration if the last one has to be the declarator in it.
7091 ;; If `backup-at-type' is nil then the other variables have
7092 ;; undefined values.
7093 backup-at-type backup-type-start backup-id-start
7094 ;; This stores `kwd-sym' of the symbol before the current one.
7095 ;; This is needed to distinguish the C++11 version of "auto" from
7096 ;; the pre C++11 meaning.
7098 ;; Set if we've found a specifier (apart from "typedef") that makes
7099 ;; the defined identifier(s) types.
7101 ;; Set if we've a "typedef" keyword.
7103 ;; Set if we've found a specifier that can start a declaration
7104 ;; where there's no type.
7106 ;; Save the value of kwd-sym between loops of the "Check for a
7107 ;; type" loop. Needed to distinguish a C++11 "auto" from a pre
7110 ;; If a specifier is found that also can be a type prefix,
7111 ;; these flags are set instead of those above. If we need to
7112 ;; back up an identifier, they are copied to the real flag
7113 ;; variables. Thus they only take effect if we fail to
7114 ;; interpret it as a type.
7115 backup-at-type-decl backup-maybe-typeless
7116 ;; Whether we've found a declaration or a cast. We might know
7117 ;; this before we've found the type in it. It's 'ids if we've
7118 ;; found two consecutive identifiers (usually a sure sign, but
7119 ;; we should allow that in labels too), and t if we've found a
7120 ;; specifier keyword (a 100% sure sign).
7122 ;; Set when we need to back up to parse this as a declaration
7123 ;; but not as a cast.
7125 ;; For casts, the return position.
7127 ;; Have we got a new-style C++11 "auto"?
7129 ;; Save `c-record-type-identifiers' and
7130 ;; `c-record-ref-identifiers' since ranges are recorded
7131 ;; speculatively and should be thrown away if it turns out
7132 ;; that it isn't a declaration or cast.
7133 (save-rec-type-ids c-record-type-identifiers)
7134 (save-rec-ref-ids c-record-ref-identifiers))
7136 (while (c-forward-annotation)
7137 (c-forward-syntactic-ws))
7139 ;; Check for a type. Unknown symbols are treated as possible
7140 ;; types, but they could also be specifiers disguised through
7141 ;; macros like __INLINE__, so we recognize both types and known
7142 ;; specifiers after them too.
7144 (let* ((start (point)) kwd-sym kwd-clause-end found-type noise-start)
7147 ;; Look for a specifier keyword clause.
7148 ((or (looking-at c-prefix-spec-kwds-re)
7149 (and (c-major-mode-is 'java-mode)
7150 (looking-at "@[A-Za-z0-9]+")))
7152 (if (looking-at c-typedef-key)
7153 (setq at-typedef t)))
7154 (setq kwd-sym (c-keyword-sym (match-string 1)))
7156 (c-forward-keyword-clause 1)
7157 (setq kwd-clause-end (point))))
7158 ((looking-at c-noise-macro-with-parens-name-re)
7159 (setq noise-start (point))
7160 (c-forward-noise-clause)
7161 (setq kwd-clause-end (point))))
7163 (when (setq found-type (c-forward-type t)) ; brace-block-too
7164 ;; Found a known or possible type or a prefix of a known type.
7165 (when (and (c-major-mode-is 'c++-mode) ; C++11 style "auto"?
7166 (eq prev-kwd-sym (c-keyword-sym "auto"))
7167 (looking-at "[=(]")) ; FIXME!!! proper regexp.
7168 (setq new-style-auto t)
7169 (setq found-type nil)
7170 (goto-char start)) ; position of foo in "auto foo"
7173 ;; Got two identifiers with nothing but whitespace
7174 ;; between them. That can only happen in declarations.
7175 (setq at-decl-or-cast 'ids)
7177 (when (eq at-type 'found)
7178 ;; If the previous identifier is a found type we
7179 ;; record it as a real one; it might be some sort of
7180 ;; alias for a prefix like "unsigned".
7182 (goto-char type-start)
7183 (let ((c-promote-possible-types t))
7184 (c-forward-type)))))
7186 (setq backup-at-type at-type
7187 backup-type-start type-start
7188 backup-id-start id-start
7189 backup-kwd-sym kwd-sym
7193 ;; The previous ambiguous specifier/type turned out
7194 ;; to be a type since we've parsed another one after
7195 ;; it, so clear these backup flags.
7196 backup-at-type-decl nil
7197 backup-maybe-typeless nil))
7199 (if (or kwd-sym noise-start)
7201 ;; Handle known specifier keywords and
7202 ;; `c-decl-hangon-kwds' which can occur after known
7205 (if (or (c-keyword-member kwd-sym 'c-decl-hangon-kwds)
7207 ;; It's a hang-on keyword or noise clause that can occur
7211 ;; Move the identifier start position if
7212 ;; we've passed a type.
7213 (setq id-start kwd-clause-end)
7214 ;; Otherwise treat this as a specifier and
7215 ;; move the fallback position.
7216 (setq start-pos kwd-clause-end))
7217 (goto-char kwd-clause-end))
7219 ;; It's an ordinary specifier so we know that
7220 ;; anything before this can't be the type.
7221 (setq backup-at-type nil
7222 start-pos kwd-clause-end)
7225 ;; It's ambiguous whether this keyword is a
7226 ;; specifier or a type prefix, so set the backup
7227 ;; flags. (It's assumed that `c-forward-type'
7228 ;; moved further than `c-forward-keyword-clause'.)
7230 (when (c-keyword-member kwd-sym 'c-typedef-decl-kwds)
7231 (setq backup-at-type-decl t))
7232 (when (c-keyword-member kwd-sym 'c-typeless-decl-kwds)
7233 (setq backup-maybe-typeless t)))
7235 (when (c-keyword-member kwd-sym 'c-typedef-decl-kwds)
7236 ;; This test only happens after we've scanned a type.
7237 ;; So, with valid syntax, kwd-sym can't be 'typedef.
7238 (setq at-type-decl t))
7239 (when (c-keyword-member kwd-sym 'c-typeless-decl-kwds)
7240 (setq maybe-typeless t))
7242 ;; Haven't matched a type so it's an unambiguous
7243 ;; specifier keyword and we know we're in a
7245 (setq at-decl-or-cast t)
7246 (setq prev-kwd-sym kwd-sym)
7248 (goto-char kwd-clause-end))))
7250 ;; If the type isn't known we continue so that we'll jump
7251 ;; over all specifiers and type identifiers. The reason
7252 ;; to do this for a known type prefix is to make things
7253 ;; like "unsigned INT16" work.
7254 (and found-type (not (eq found-type t))))))
7258 ;; If a known type was found, we still need to skip over any
7259 ;; hangon keyword clauses after it. Otherwise it has already
7260 ;; been done in the loop above.
7262 (cond ((looking-at c-decl-hangon-key)
7263 (c-forward-keyword-clause 1))
7264 ((looking-at c-noise-macro-with-parens-name-re)
7265 (c-forward-noise-clause))))
7266 (setq id-start (point)))
7268 ((eq at-type 'prefix)
7269 ;; A prefix type is itself a primitive type when it's not
7270 ;; followed by another type.
7274 ;; Got no type but set things up to continue anyway to handle
7275 ;; the various cases when a declaration doesn't start with a
7277 (setq id-start start-pos))
7279 ((and (eq at-type 'maybe)
7280 (c-major-mode-is 'c++-mode))
7281 ;; If it's C++ then check if the last "type" ends on the form
7282 ;; "foo::foo" or "foo::~foo", i.e. if it's the name of a
7283 ;; (con|de)structor.
7285 (let (name end-2 end-1)
7286 (goto-char id-start)
7287 (c-backward-syntactic-ws)
7288 (setq end-2 (point))
7290 (c-simple-skip-symbol-backward)
7293 (buffer-substring-no-properties (point) end-2))
7294 ;; Cheating in the handling of syntactic ws below.
7295 (< (skip-chars-backward ":~ \t\n\r\v\f") 0))
7297 (setq end-1 (point))
7298 (c-simple-skip-symbol-backward))
7299 (>= (point) type-start)
7300 (equal (buffer-substring-no-properties (point) end-1)
7302 ;; It is a (con|de)structor name. In that case the
7303 ;; declaration is typeless so zap out any preceding
7304 ;; identifier(s) that we might have taken as types.
7305 (goto-char type-start)
7308 id-start type-start))))))
7310 ;; Check for and step over a type decl expression after the thing
7311 ;; that is or might be a type. This can't be skipped since we
7312 ;; need the correct end position of the declarator for
7313 ;; `max-type-decl-end-*'.
7314 (let ((start (point)) (paren-depth 0) pos
7315 ;; True if there's a non-open-paren match of
7316 ;; `c-type-decl-prefix-key'.
7318 ;; True if the declarator is surrounded by a parenthesis pair.
7320 ;; True if there is an identifier in the declarator.
7322 ;; True if there's a non-close-paren match of
7323 ;; `c-type-decl-suffix-key'.
7325 ;; True if there's a prefix match outside the outermost
7326 ;; paren pair that surrounds the declarator.
7327 got-prefix-before-parens
7328 ;; True if there's a suffix match outside the outermost
7329 ;; paren pair that surrounds the declarator. The value is
7330 ;; the position of the first suffix match.
7331 got-suffix-after-parens
7332 ;; True if we've parsed the type decl to a token that is
7333 ;; known to end declarations in this context.
7335 ;; The earlier values of `at-type' and `type-start' if we've
7336 ;; shifted the type backwards.
7337 identifier-type identifier-start
7338 ;; If `c-parse-and-markup-<>-arglists' is set we need to
7339 ;; turn it off during the name skipping below to avoid
7340 ;; getting `c-type' properties that might be bogus. That
7341 ;; can happen since we don't know if
7342 ;; `c-restricted-<>-arglists' will be correct inside the
7343 ;; arglist paren that gets entered.
7344 c-parse-and-markup-<>-arglists
7345 ;; Start of the identifier for which `got-identifier' was set.
7348 (goto-char id-start)
7350 ;; Skip over type decl prefix operators. (Note similar code in
7351 ;; `c-forward-declarator'.)
7352 (if (and c-recognize-typeless-decls
7353 (equal c-type-decl-prefix-key "\\<\\>"))
7354 (when (eq (char-after) ?\()
7356 (setq paren-depth (1+ paren-depth))
7358 (while (and (looking-at c-type-decl-prefix-key)
7359 (if (and (c-major-mode-is 'c++-mode)
7360 (match-beginning 3))
7361 ;; If the third submatch matches in C++ then
7362 ;; we're looking at an identifier that's a
7363 ;; prefix only if it specifies a member pointer.
7364 (when (progn (setq pos (point))
7365 (setq got-identifier (c-forward-name)))
7366 (setq name-start pos)
7367 (if (looking-at "\\(::\\)")
7368 ;; We only check for a trailing "::" and
7369 ;; let the "*" that should follow be
7370 ;; matched in the next round.
7371 (progn (setq got-identifier nil) t)
7372 ;; It turned out to be the real identifier,
7377 (if (eq (char-after) ?\()
7379 (setq paren-depth (1+ paren-depth))
7381 (unless got-prefix-before-parens
7382 (setq got-prefix-before-parens (= paren-depth 0)))
7384 (goto-char (match-end 1)))
7385 (c-forward-syntactic-ws)))
7387 (setq got-parens (> paren-depth 0))
7389 ;; Skip over an identifier.
7391 (and (looking-at c-identifier-start)
7393 (setq got-identifier (c-forward-name))
7394 (setq name-start pos)))
7396 ;; Skip over type decl suffix operators.
7397 (while (if (looking-at c-type-decl-suffix-key)
7399 (if (eq (char-after) ?\))
7400 (when (> paren-depth 0)
7401 (setq paren-depth (1- paren-depth))
7404 (when (if (save-match-data (looking-at "\\s("))
7405 (c-safe (c-forward-sexp 1) t)
7406 (goto-char (match-end 1))
7408 (when (and (not got-suffix-after-parens)
7410 (setq got-suffix-after-parens (match-beginning 0)))
7411 (setq got-suffix t)))
7413 ;; No suffix matched. We might have matched the
7414 ;; identifier as a type and the open paren of a
7415 ;; function arglist as a type decl prefix. In that
7416 ;; case we should "backtrack": Reinterpret the last
7417 ;; type as the identifier, move out of the arglist and
7418 ;; continue searching for suffix operators.
7420 ;; Do this even if there's no preceding type, to cope
7421 ;; with old style function declarations in K&R C,
7422 ;; (con|de)structors in C++ and `c-typeless-decl-kwds'
7423 ;; style declarations. That isn't applicable in an
7424 ;; arglist context, though.
7425 (when (and (= paren-depth 1)
7426 (not got-prefix-before-parens)
7427 (not (eq at-type t))
7430 backup-maybe-typeless
7431 (when c-recognize-typeless-decls
7433 (setq pos (c-up-list-forward (point)))
7434 (eq (char-before pos) ?\)))
7435 (c-fdoc-shift-type-backward)
7439 (c-forward-syntactic-ws))
7441 (when (or (and new-style-auto
7442 (looking-at c-auto-ops-re))
7443 (and (or maybe-typeless backup-maybe-typeless)
7444 (not got-identifier)
7447 ;; Have found no identifier but `c-typeless-decl-kwds' has
7448 ;; matched so we know we're inside a declaration. The
7449 ;; preceding type must be the identifier instead.
7450 (c-fdoc-shift-type-backward))
7452 ;; Prepare the "-> type;" for fontification later on.
7453 (when (and new-style-auto
7454 (looking-at c-haskell-op-re))
7456 (goto-char (match-end 0))
7457 (c-forward-syntactic-ws)
7458 (setq type-start (point))
7459 (setq at-type (c-forward-type))))
7463 (catch 'at-decl-or-cast
7466 (when (> paren-depth 0)
7467 ;; Encountered something inside parens that isn't matched by
7468 ;; the `c-type-decl-*' regexps, so it's not a type decl
7469 ;; expression. Try to skip out to the same paren depth to
7470 ;; not confuse the cast check below.
7471 (c-safe (goto-char (scan-lists (point) 1 paren-depth)))
7472 ;; If we've found a specifier keyword then it's a
7473 ;; declaration regardless.
7474 (throw 'at-decl-or-cast (eq at-decl-or-cast t)))
7477 (looking-at (cond ((eq context '<>) "[,>]")
7481 ;; Now we've collected info about various characteristics of
7482 ;; the construct we're looking at. Below follows a decision
7483 ;; tree based on that. It's ordered to check more certain
7484 ;; signs before less certain ones.
7490 (when (and (or at-type maybe-typeless)
7491 (not (or got-prefix got-parens)))
7492 ;; Got another identifier directly after the type, so it's a
7494 (throw 'at-decl-or-cast t))
7496 (when (and got-parens
7498 ;; (not got-suffix-after-parens)
7501 backup-maybe-typeless
7502 (eq at-decl-or-cast t)
7504 (goto-char name-start)
7505 (not (memq (c-forward-type) '(nil maybe))))))
7506 ;; Got a declaration of the form "foo bar (gnu);" or "bar
7507 ;; (gnu);" where we've recognized "bar" as the type and "gnu"
7508 ;; as the declarator. In this case it's however more likely
7509 ;; that "bar" is the declarator and "gnu" a function argument
7510 ;; or initializer (if `c-recognize-paren-inits' is set),
7511 ;; since the parens around "gnu" would be superfluous if it's
7512 ;; a declarator. Shift the type one step backward.
7513 (c-fdoc-shift-type-backward)))
7515 ;; Found no identifier.
7521 (when (= (point) start)
7522 ;; Got a plain list of identifiers. If a colon follows it's
7523 ;; a valid label, or maybe a bitfield. Otherwise the last
7524 ;; one probably is the declared identifier and we should
7525 ;; back up to the previous type, providing it isn't a cast.
7526 (if (and (eq (char-after) ?:)
7527 (not (c-major-mode-is 'java-mode)))
7529 ;; If we've found a specifier keyword then it's a
7530 ;; declaration regardless.
7531 ((eq at-decl-or-cast t)
7532 (throw 'at-decl-or-cast t))
7533 ((and c-has-bitfields
7534 (eq at-decl-or-cast 'ids)) ; bitfield.
7535 (setq backup-if-not-cast t)
7536 (throw 'at-decl-or-cast t)))
7538 (setq backup-if-not-cast t)
7539 (throw 'at-decl-or-cast t)))
7542 (when (and got-suffix
7545 ;; Got a plain list of identifiers followed by some suffix.
7546 ;; If this isn't a cast then the last identifier probably is
7547 ;; the declared one and we should back up to the previous
7549 (setq backup-if-not-cast t)
7550 (throw 'at-decl-or-cast t)))
7553 (when (eq at-type t)
7554 ;; If the type is known we know that there can't be any
7555 ;; identifier somewhere else, and it's only in declarations in
7556 ;; e.g. function prototypes and in casts that the identifier may
7558 (throw 'at-decl-or-cast t))
7560 (when (= (point) start)
7561 ;; Only got a single identifier (parsed as a type so far).
7564 ;; Check that the identifier isn't at the start of an
7569 ;; Inside an arglist that contains declarations. If K&R
7570 ;; style declarations and parenthesis style initializers
7571 ;; aren't allowed then the single identifier must be a
7572 ;; type, else we require that it's known or found
7573 ;; (primitive types are handled above).
7574 (or (and (not c-recognize-knr-p)
7575 (not c-recognize-paren-inits))
7576 (memq at-type '(known found))))
7578 ;; Inside a template arglist. Accept known and found
7579 ;; types; other identifiers could just as well be
7580 ;; constants in C++.
7581 (memq at-type '(known found)))))
7582 (throw 'at-decl-or-cast t)
7584 ;; Can't be a valid declaration or cast, but if we've found a
7585 ;; specifier it can't be anything else either, so treat it as
7586 ;; an invalid/unfinished declaration or cast.
7587 (throw 'at-decl-or-cast at-decl-or-cast))))
7592 (not (eq at-type t))
7595 backup-maybe-typeless
7596 (when c-recognize-typeless-decls
7597 (or (not got-suffix)
7599 c-after-suffixed-type-maybe-decl-key))))))
7600 ;; Got an empty paren pair and a preceding type that probably
7601 ;; really is the identifier. Shift the type backwards to make
7602 ;; the last one the identifier. This is analogous to the
7603 ;; "backtracking" done inside the `c-type-decl-suffix-key' loop
7606 ;; Exception: In addition to the conditions in that
7607 ;; "backtracking" code, do not shift backward if we're not
7608 ;; looking at either `c-after-suffixed-type-decl-key' or "[;,]".
7609 ;; Since there's no preceding type, the shift would mean that
7610 ;; the declaration is typeless. But if the regexp doesn't match
7611 ;; then we will simply fall through in the tests below and not
7612 ;; recognize it at all, so it's better to try it as an abstract
7613 ;; declarator instead.
7614 (c-fdoc-shift-type-backward)
7616 ;; Still no identifier.
7618 (when (and got-prefix (or got-parens got-suffix))
7619 ;; Require `got-prefix' together with either `got-parens' or
7620 ;; `got-suffix' to recognize it as an abstract declarator:
7621 ;; `got-parens' only is probably an empty function call.
7622 ;; `got-suffix' only can build an ordinary expression together
7623 ;; with the preceding identifier which we've taken as a type.
7624 ;; We could actually accept on `got-prefix' only, but that can
7625 ;; easily occur temporarily while writing an expression so we
7626 ;; avoid that case anyway. We could do a better job if we knew
7627 ;; the point when the fontification was invoked.
7628 (throw 'at-decl-or-cast t))
7634 got-suffix-after-parens
7635 (eq (char-after got-suffix-after-parens) ?\())
7636 ;; Got a type, no declarator but a paren suffix. I.e. it's a
7637 ;; normal function call after all (or perhaps a C++ style object
7638 ;; instantiation expression).
7639 (throw 'at-decl-or-cast nil))))
7642 (when at-decl-or-cast
7643 ;; By now we've located the type in the declaration that we know
7645 (throw 'at-decl-or-cast t))
7648 (when (and got-identifier
7650 (looking-at c-after-suffixed-type-decl-key)
7654 (not (eq at-type t)))
7655 ;; Shift the type backward in the case that there's a
7656 ;; single identifier inside parens. That can only
7657 ;; occur in K&R style function declarations so it's
7658 ;; more likely that it really is a function call.
7659 ;; Therefore we only do this after
7660 ;; `c-after-suffixed-type-decl-key' has matched.
7661 (progn (c-fdoc-shift-type-backward) t)
7662 got-suffix-after-parens))
7663 ;; A declaration according to `c-after-suffixed-type-decl-key'.
7664 (throw 'at-decl-or-cast t))
7667 (when (and (or got-prefix (not got-parens))
7668 (memq at-type '(t known)))
7669 ;; It's a declaration if a known type precedes it and it can't be a
7671 (throw 'at-decl-or-cast t))
7673 ;; If we get here we can't tell if this is a type decl or a normal
7674 ;; expression by looking at it alone. (That's under the assumption
7675 ;; that normal expressions always can look like type decl expressions,
7676 ;; which isn't really true but the cases where it doesn't hold are so
7677 ;; uncommon (e.g. some placements of "const" in C++) it's not worth
7678 ;; the effort to look for them.)
7680 ;;; 2008-04-16: commented out the next form, to allow the function to recognize
7681 ;;; "foo (int bar)" in CC (an implicit type (in class foo) without a semicolon)
7682 ;;; as a(n almost complete) declaration, enabling it to be fontified.
7684 ;; (unless (or at-decl-end (looking-at "=[^=]"))
7685 ;; If this is a declaration it should end here or its initializer(*)
7686 ;; should start here, so check for allowed separation tokens. Note
7687 ;; that this rule doesn't work e.g. with a K&R arglist after a
7690 ;; *) Don't check for C++ style initializers using parens
7691 ;; since those already have been matched as suffixes.
7693 ;; If `at-decl-or-cast' is then we've found some other sign that
7694 ;; it's a declaration or cast, so then it's probably an
7695 ;; invalid/unfinished one.
7696 ;; (throw 'at-decl-or-cast at-decl-or-cast))
7698 ;; Below are tests that only should be applied when we're certain to
7699 ;; not have parsed halfway through an expression.
7702 (when (memq at-type '(t known))
7703 ;; The expression starts with a known type so treat it as a
7705 (throw 'at-decl-or-cast t))
7708 (when (and (c-major-mode-is 'c++-mode)
7709 ;; In C++ we check if the identifier is a known type, since
7710 ;; (con|de)structors use the class name as identifier.
7711 ;; We've always shifted over the identifier as a type and
7712 ;; then backed up again in this case.
7714 (or (memq identifier-type '(found known))
7715 (and (eq (char-after identifier-start) ?~)
7716 ;; `at-type' probably won't be 'found for
7717 ;; destructors since the "~" is then part of the
7718 ;; type name being checked against the list of
7719 ;; known types, so do a check without that
7722 (goto-char (1+ identifier-start))
7723 (c-forward-syntactic-ws)
7724 (c-with-syntax-table
7725 c-identifier-syntax-table
7726 (looking-at c-known-type-key)))
7728 (goto-char (1+ identifier-start))
7729 ;; We have already parsed the type earlier,
7730 ;; so it'd be possible to cache the end
7731 ;; position instead of redoing it here, but
7732 ;; then we'd need to keep track of another
7733 ;; position everywhere.
7734 (c-check-type (point)
7735 (progn (c-forward-type)
7737 (throw 'at-decl-or-cast t))
7742 (when (and got-prefix-before-parens
7744 (or at-decl-end (looking-at "=[^=]"))
7747 ;; Got something like "foo * bar;". Since we're not inside an
7748 ;; arglist it would be a meaningless expression because the
7749 ;; result isn't used. We therefore choose to recognize it as
7750 ;; a declaration. Do not allow a suffix since it could then
7751 ;; be a function call.
7752 (throw 'at-decl-or-cast t))
7755 (when (and (or got-suffix-after-parens
7756 (looking-at "=[^=]"))
7758 (not (eq context 'arglist)))
7759 ;; Got something like "a (*b) (c);" or "a (b) = c;". It could
7760 ;; be an odd expression or it could be a declaration. Treat
7761 ;; it as a declaration if "a" has been used as a type
7762 ;; somewhere else (if it's a known type we won't get here).
7763 (throw 'at-decl-or-cast t)))
7768 (and (eq context 'decl)
7769 (not c-recognize-paren-inits)
7770 (or got-parens got-suffix))))
7771 ;; Got a type followed by an abstract declarator. If `got-prefix'
7772 ;; is set it's something like "a *" without anything after it. If
7773 ;; `got-parens' or `got-suffix' is set it's "a()", "a[]", "a()[]",
7774 ;; or similar, which we accept only if the context rules out
7776 (throw 'at-decl-or-cast t)))
7778 ;; If we had a complete symbol table here (which rules out
7779 ;; `c-found-types') we should return t due to the disambiguation rule
7780 ;; (in at least C++) that anything that can be parsed as a declaration
7781 ;; is a declaration. Now we're being more defensive and prefer to
7782 ;; highlight things like "foo (bar);" as a declaration only if we're
7783 ;; inside an arglist that contains declarations.
7785 (eq context 'decl))))
7787 ;; The point is now after the type decl expression.
7790 ;; Check for a cast.
7795 ;; Should be the first type/identifier in a cast paren.
7796 (> preceding-token-end (point-min))
7797 (memq (char-before preceding-token-end) c-cast-parens)
7799 ;; The closing paren should follow.
7801 (c-forward-syntactic-ws)
7802 (looking-at "\\s)"))
7804 ;; There should be a primary expression after it.
7807 (c-forward-syntactic-ws)
7808 (setq cast-end (point))
7809 (and (looking-at c-primary-expr-regexp)
7811 (setq pos (match-end 0))
7813 ;; Check if the expression begins with a prefix keyword.
7815 (if (match-beginning 1)
7816 ;; Expression begins with an ambiguous operator. Treat
7817 ;; it as a cast if it's a type decl or if we've
7818 ;; recognized the type somewhere else.
7820 (memq at-type '(t known found)))
7821 ;; Unless it's a keyword, it's the beginning of a primary
7823 (not (looking-at c-keywords-regexp)))))
7824 ;; If `c-primary-expr-regexp' matched a nonsymbol token, check
7825 ;; that it matched a whole one so that we don't e.g. confuse
7826 ;; the operator '-' with '->'. It's ok if it matches further,
7827 ;; though, since it e.g. can match the float '.5' while the
7828 ;; operator regexp only matches '.'.
7829 (or (not (looking-at c-nonsymbol-token-regexp))
7830 (<= (match-end 0) pos))))
7832 ;; There should either be a cast before it or something that isn't an
7833 ;; identifier or close paren.
7834 (> preceding-token-end (point-min))
7836 (goto-char (1- preceding-token-end))
7837 (or (eq (point) last-cast-end)
7839 (c-backward-syntactic-ws)
7840 (if (< (skip-syntax-backward "w_") 0)
7841 ;; It's a symbol. Accept it only if it's one of the
7842 ;; keywords that can precede an expression (without
7843 ;; surrounding parens).
7844 (looking-at c-simple-stmt-key)
7846 ;; Check that it isn't a close paren (block close is ok,
7848 (not (memq (char-before) '(?\) ?\])))
7849 ;; Check that it isn't a nonsymbol identifier.
7850 (not (c-on-identifier)))))))))
7853 (when (and c-record-type-identifiers at-type (not (eq at-type t)))
7854 (let ((c-promote-possible-types t))
7855 (goto-char type-start)
7858 (goto-char cast-end)
7862 ;; We're at a declaration. Highlight the type and the following
7865 (when backup-if-not-cast
7866 (c-fdoc-shift-type-backward t))
7868 (when (and (eq context 'decl) (looking-at ","))
7869 ;; Make sure to propagate the `c-decl-arg-start' property to
7870 ;; the next argument if it's set in this one, to cope with
7871 ;; interactive refontification.
7872 (c-put-c-type-property (point) 'c-decl-arg-start))
7874 ;; Record the type's coordinates in `c-record-type-identifiers' for
7875 ;; later fontification.
7876 (when (and c-record-type-identifiers at-type ;; (not (eq at-type t))
7877 ;; There seems no reason to exclude a token from
7878 ;; fontification just because it's "a known type that can't
7879 ;; be a name or other expression". 2013-09-18.
7881 (let ((c-promote-possible-types t))
7883 (goto-char type-start)
7887 (and (or at-type-decl at-typedef)
7888 (cons at-type-decl at-typedef))))
7891 ;; False alarm. Restore the recorded ranges.
7892 (setq c-record-type-identifiers save-rec-type-ids
7893 c-record-ref-identifiers save-rec-ref-ids)
7896 (defun c-forward-label (&optional assume-markup preceding-token-end limit)
7897 ;; Assuming that point is at the beginning of a token, check if it starts a
7898 ;; label and if so move over it and return non-nil (t in default situations,
7899 ;; specific symbols (see below) for interesting situations), otherwise don't
7900 ;; move and return nil. "Label" here means "most things with a colon".
7902 ;; More precisely, a "label" is regarded as one of:
7903 ;; (i) a goto target like "foo:" - returns the symbol `goto-target';
7904 ;; (ii) A case label - either the entire construct "case FOO:", or just the
7905 ;; bare "case", should the colon be missing. We return t;
7906 ;; (iii) a keyword which needs a colon, like "default:" or "private:"; We
7908 ;; (iv) One of QT's "extended" C++ variants of
7909 ;; "private:"/"protected:"/"public:"/"more:" looking like "public slots:".
7910 ;; Returns the symbol `qt-2kwds-colon'.
7911 ;; (v) QT's construct "signals:". Returns the symbol `qt-1kwd-colon'.
7912 ;; (vi) One of the keywords matched by `c-opt-extra-label-key' (without any
7913 ;; colon). Currently (2006-03), this applies only to Objective C's
7914 ;; keywords "@private", "@protected", and "@public". Returns t.
7916 ;; One of the things which will NOT be recognized as a label is a bit-field
7917 ;; element of a struct, something like "int foo:5".
7919 ;; The end of the label is taken to be just after the colon, or the end of
7920 ;; the first submatch in `c-opt-extra-label-key'. The point is directly
7921 ;; after the end on return. The terminating char gets marked with
7922 ;; `c-decl-end' to improve recognition of the following declaration or
7925 ;; If ASSUME-MARKUP is non-nil, it's assumed that the preceding
7926 ;; label, if any, has already been marked up like that.
7928 ;; If PRECEDING-TOKEN-END is given, it should be the first position
7929 ;; after the preceding token, i.e. on the other side of the
7930 ;; syntactic ws from the point. Use a value less than or equal to
7931 ;; (point-min) if the point is at the first token in (the visible
7932 ;; part of) the buffer.
7934 ;; The optional LIMIT limits the forward scan for the colon.
7936 ;; This function records the ranges of the label symbols on
7937 ;; `c-record-ref-identifiers' if `c-record-type-identifiers' (!) is
7940 ;; This function might do hidden buffer changes.
7942 (let ((start (point))
7945 macro-start ; if we're in one.
7949 ;; "case" or "default" (Doesn't apply to AWK).
7950 ((looking-at c-label-kwds-regexp)
7951 (let ((kwd-end (match-end 1)))
7952 ;; Record only the keyword itself for fontification, since in
7953 ;; case labels the following is a constant expression and not
7955 (when c-record-type-identifiers
7956 (c-record-ref-id (cons (match-beginning 1) kwd-end)))
7958 ;; Find the label end.
7961 (if (and (c-syntactic-re-search-forward
7962 ;; Stop on chars that aren't allowed in expressions,
7963 ;; and on operator chars that would be meaningless
7964 ;; there. FIXME: This doesn't cope with ?: operators.
7965 "[;{=,@]\\|\\(\\=\\|[^:]\\):\\([^:]\\|\\'\\)"
7967 (match-beginning 2))
7969 (progn ; there's a proper :
7970 (goto-char (match-beginning 2)) ; just after the :
7971 (c-put-c-type-property (1- (point)) 'c-decl-end)
7974 ;; It's an unfinished label. We consider the keyword enough
7975 ;; to recognize it as a label, so that it gets fontified.
7976 ;; Leave the point at the end of it, but don't put any
7977 ;; `c-decl-end' marker.
7981 ;; @private, @protected, @public, in Objective C, or similar.
7982 ((and c-opt-extra-label-key
7983 (looking-at c-opt-extra-label-key))
7984 ;; For a `c-opt-extra-label-key' match, we record the whole
7985 ;; thing for fontification. That's to get the leading '@' in
7986 ;; Objective-C protection labels fontified.
7987 (goto-char (match-end 1))
7988 (when c-record-type-identifiers
7989 (c-record-ref-id (cons (match-beginning 1) (point))))
7990 (c-put-c-type-property (1- (point)) 'c-decl-end)
7991 (setq label-type t))
7993 ;; All other cases of labels.
7994 ((and c-recognize-colon-labels ; nil for AWK and IDL, otherwise t.
7996 ;; A colon label must have something before the colon.
7997 (not (eq (char-after) ?:))
7999 ;; Check that we're not after a token that can't precede a label.
8001 ;; Trivially succeeds when there's no preceding token.
8002 ;; Succeeds when we're at a virtual semicolon.
8003 (if preceding-token-end
8004 (<= preceding-token-end (point-min))
8006 (c-backward-syntactic-ws)
8007 (setq preceding-token-end (point))
8011 ;; Check if we're after a label, if we're after a closing
8012 ;; paren that belong to statement, and with
8013 ;; `c-label-prefix-re'. It's done in different order
8014 ;; depending on `assume-markup' since the checks have
8015 ;; different expensiveness.
8018 (eq (c-get-char-property (1- preceding-token-end) 'c-type)
8022 (goto-char (1- preceding-token-end))
8023 (c-beginning-of-current-token)
8024 (or (looking-at c-label-prefix-re)
8025 (looking-at c-block-stmt-1-key)))
8027 (and (eq (char-before preceding-token-end) ?\))
8028 (c-after-conditional)))
8032 (goto-char (1- preceding-token-end))
8033 (c-beginning-of-current-token)
8034 (or (looking-at c-label-prefix-re)
8035 (looking-at c-block-stmt-1-key)))
8038 ((eq (char-before preceding-token-end) ?\))
8039 (c-after-conditional))
8041 ((eq (char-before preceding-token-end) ?:)
8042 ;; Might be after another label, so check it recursively.
8045 (goto-char (1- preceding-token-end))
8046 ;; Essentially the same as the
8047 ;; `c-syntactic-re-search-forward' regexp below.
8049 (save-excursion (and (c-beginning-of-macro)
8051 (if macro-start (narrow-to-region macro-start (point-max)))
8052 (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+" nil t)
8053 ;; Note: the following should work instead of the
8054 ;; narrow-to-region above. Investigate why not,
8055 ;; sometime. ACM, 2006-03-31.
8056 ;; (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+"
8059 ;; If the caller turned on recording for us,
8060 ;; it shouldn't apply when we check the
8062 c-record-type-identifiers)
8063 ;; A label can't start at a cpp directive. Check for
8064 ;; this, since c-forward-syntactic-ws would foul up on it.
8065 (unless (and c-opt-cpp-prefix (looking-at c-opt-cpp-prefix))
8066 (c-forward-syntactic-ws)
8067 (c-forward-label nil pte start))))))))))
8069 ;; Point is still at the beginning of the possible label construct.
8071 ;; Check that the next nonsymbol token is ":", or that we're in one
8072 ;; of QT's "slots" declarations. Allow '(' for the sake of macro
8073 ;; arguments. FIXME: Should build this regexp from the language
8076 ;; public: protected: private:
8078 (c-major-mode-is 'c++-mode)
8079 (search-forward-regexp
8080 "\\=p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\>[^_]" nil t)
8081 (progn (backward-char)
8082 (c-forward-syntactic-ws limit)
8083 (looking-at ":\\([^:]\\|\\'\\)"))) ; A single colon.
8085 (setq label-type t))
8086 ;; QT double keyword like "protected slots:" or goto target.
8087 ((progn (goto-char start) nil))
8088 ((when (c-syntactic-re-search-forward
8089 "[ \t\n[:?;{=*/%&|,<>!@+-]" limit t t) ; not at EOB
8091 (setq label-end (point))
8093 (and (c-major-mode-is 'c++-mode)
8095 "\\(p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\|more\\)\\>"
8096 (buffer-substring start (point)))))
8097 (c-forward-syntactic-ws limit)
8099 ((looking-at ":\\([^:]\\|\\'\\)") ; A single colon.
8102 (if (or (string= "signals" ; Special QT macro
8103 (setq kwd (buffer-substring-no-properties start label-end)))
8104 (string= "Q_SIGNALS" kwd))
8108 (search-forward-regexp "\\=\\(slots\\|Q_SLOTS\\)\\>" limit t)
8109 (progn (c-forward-syntactic-ws limit)
8110 (looking-at ":\\([^:]\\|\\'\\)"))) ; A single colon
8112 (setq label-type 'qt-2kwds-colon)))))))
8115 (narrow-to-region start (point))
8117 ;; Check that `c-nonlabel-token-key' doesn't match anywhere.
8121 (when (looking-at c-nonlabel-token-key)
8123 (setq label-type nil)
8124 (throw 'check-label nil))
8125 (and (c-safe (c-forward-sexp)
8126 (c-forward-syntactic-ws)
8130 ;; Record the identifiers in the label for fontification, unless
8131 ;; it begins with `c-label-kwds' in which case the following
8132 ;; identifiers are part of a (constant) expression that
8133 ;; shouldn't be fontified.
8134 (when (and c-record-type-identifiers
8135 (progn (goto-char start)
8136 (not (looking-at c-label-kwds-regexp))))
8137 (while (c-syntactic-re-search-forward c-symbol-key nil t)
8138 (c-record-ref-id (cons (match-beginning 0)
8141 (c-put-c-type-property (1- (point-max)) 'c-decl-end)
8142 (goto-char (point-max)))))
8149 (defun c-forward-objc-directive ()
8150 ;; Assuming the point is at the beginning of a token, try to move
8151 ;; forward to the end of the Objective-C directive that starts
8152 ;; there. Return t if a directive was fully recognized, otherwise
8153 ;; the point is moved as far as one could be successfully parsed and
8156 ;; This function records identifier ranges on
8157 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
8158 ;; `c-record-type-identifiers' is non-nil.
8160 ;; This function might do hidden buffer changes.
8162 (let ((start (point))
8164 (c-promote-possible-types t)
8166 ;; Turn off recognition of angle bracket arglists while parsing
8167 ;; types here since the protocol reference list might then be
8168 ;; considered part of the preceding name or superclass-name.
8169 c-recognize-<>-arglists)
8174 (c-make-keywords-re t
8175 (append (c-lang-const c-protection-kwds objc)
8178 (goto-char (match-end 1))
8184 (c-make-keywords-re t
8185 '("@interface" "@implementation" "@protocol")
8188 ;; Handle the name of the class itself.
8190 ;; (c-forward-token-2) ; 2006/1/13 This doesn't move if the token's
8192 (goto-char (match-end 0))
8198 ;; Look for ": superclass-name" or "( category-name )".
8199 (when (looking-at "[:(]")
8200 (setq start-char (char-after))
8202 (c-forward-syntactic-ws)
8203 (unless (c-forward-type) (throw 'break nil))
8204 (when (eq start-char ?\()
8205 (unless (eq (char-after) ?\)) (throw 'break nil))
8207 (c-forward-syntactic-ws)))
8209 ;; Look for a protocol reference list.
8210 (if (eq (char-after) ?<)
8211 (let ((c-recognize-<>-arglists t)
8212 (c-parse-and-markup-<>-arglists t)
8213 c-restricted-<>-arglists)
8214 (c-forward-<>-arglist t))
8218 (c-backward-syntactic-ws lim)
8219 (c-clear-c-type-property start (1- (point)) 'c-decl-end)
8220 (c-put-c-type-property (1- (point)) 'c-decl-end)
8223 (c-clear-c-type-property start (point) 'c-decl-end)
8226 (defun c-beginning-of-inheritance-list (&optional lim)
8227 ;; Go to the first non-whitespace after the colon that starts a
8228 ;; multiple inheritance introduction. Optional LIM is the farthest
8229 ;; back we should search.
8231 ;; This function might do hidden buffer changes.
8232 (c-with-syntax-table c++-template-syntax-table
8233 (c-backward-token-2 0 t lim)
8234 (while (and (or (looking-at c-symbol-start)
8235 (looking-at "[<,]\\|::"))
8236 (zerop (c-backward-token-2 1 t lim))))))
8238 (defun c-in-method-def-p ()
8239 ;; Return nil if we aren't in a method definition, otherwise the
8240 ;; position of the initial [+-].
8242 ;; This function might do hidden buffer changes.
8245 (and c-opt-method-key
8246 (looking-at c-opt-method-key)
8250 ;; Contributed by Kevin Ryde <user42@zip.com.au>.
8251 (defun c-in-gcc-asm-p ()
8252 ;; Return non-nil if point is within a gcc \"asm\" block.
8254 ;; This should be called with point inside an argument list.
8256 ;; Only one level of enclosing parentheses is considered, so for
8257 ;; instance nil is returned when in a function call within an asm
8260 ;; This function might do hidden buffer changes.
8262 (and c-opt-asm-stmt-key
8265 (backward-up-list 1)
8266 (c-beginning-of-statement-1 (point-min) nil t)
8267 (looking-at c-opt-asm-stmt-key))))
8269 (defun c-at-toplevel-p ()
8270 "Return a determination as to whether point is \"at the top level\".
8271 Informally, \"at the top level\" is anywhere where you can write
8274 More precisely, being at the top-level means that point is either
8275 outside any enclosing block (such as a function definition), or
8276 directly inside a class, namespace or other block that contains
8277 another declaration level.
8279 If point is not at the top-level (e.g. it is inside a method
8280 definition), then nil is returned. Otherwise, if point is at a
8281 top-level not enclosed within a class definition, t is returned.
8282 Otherwise, a 2-vector is returned where the zeroth element is the
8283 buffer position of the start of the class declaration, and the first
8284 element is the buffer position of the enclosing class's opening
8287 Note that this function might do hidden buffer changes. See the
8288 comment at the start of cc-engine.el for more info."
8289 ;; Note to maintainers: this function consumes a great mass of CPU cycles.
8290 ;; Its use should thus be minimized as far as possible.
8291 (let ((paren-state (c-parse-state)))
8292 (or (not (c-most-enclosing-brace paren-state))
8293 (c-search-uplist-for-classkey paren-state))))
8295 (defun c-just-after-func-arglist-p (&optional lim)
8296 ;; Return non-nil if the point is in the region after the argument
8297 ;; list of a function and its opening brace (or semicolon in case it
8298 ;; got no body). If there are K&R style argument declarations in
8299 ;; that region, the point has to be inside the first one for this
8300 ;; function to recognize it.
8302 ;; If successful, the point is moved to the first token after the
8303 ;; function header (see `c-forward-decl-or-cast-1' for details) and
8304 ;; the position of the opening paren of the function arglist is
8307 ;; The point is clobbered if not successful.
8309 ;; LIM is used as bound for backward buffer searches.
8311 ;; This function might do hidden buffer changes.
8313 (let ((beg (point)) id-start)
8315 (eq (c-beginning-of-statement-1 lim) 'same)
8317 (not (and (c-major-mode-is 'objc-mode)
8318 (c-forward-objc-directive)))
8321 (car-safe (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil)))
8324 ;; There should not be a '=' or ',' between beg and the
8325 ;; start of the declaration since that means we were in the
8326 ;; "expression part" of the declaration.
8328 (not (looking-at "[=,]")))
8331 ;; Check that there's an arglist paren in the
8333 (goto-char id-start)
8334 (cond ((eq (char-after) ?\()
8335 ;; The declarator is a paren expression, so skip past it
8336 ;; so that we don't get stuck on that instead of the
8337 ;; function arglist.
8339 ((and c-opt-op-identifier-prefix
8340 (looking-at c-opt-op-identifier-prefix))
8341 ;; Don't trip up on "operator ()".
8342 (c-forward-token-2 2 t)))
8343 (and (< (point) beg)
8344 (c-syntactic-re-search-forward "(" beg t t)
8347 (defun c-in-knr-argdecl (&optional lim)
8348 ;; Return the position of the first argument declaration if point is
8349 ;; inside a K&R style argument declaration list, nil otherwise.
8350 ;; `c-recognize-knr-p' is not checked. If LIM is non-nil, it's a
8351 ;; position that bounds the backward search for the argument list. This
8352 ;; function doesn't move point.
8354 ;; Point must be within a possible K&R region, e.g. just before a top-level
8355 ;; "{". It must be outside of parens and brackets. The test can return
8356 ;; false positives otherwise.
8358 ;; This function might do hidden buffer changes.
8361 ;; If we're in a macro, our search range is restricted to it. Narrow to
8362 ;; the searchable range.
8363 (let* ((macro-start (save-excursion (and (c-beginning-of-macro) (point))))
8364 (macro-end (save-excursion (and macro-start (c-end-of-macro) (point))))
8365 (low-lim (max (or lim (point-min)) (or macro-start (point-min))))
8366 before-lparen after-rparen
8368 (pp-count-out 20) ; Max number of paren/brace constructs before
8370 ids ; List of identifiers in the parenthesized list.
8371 id-start after-prec-token decl-or-cast decl-res
8372 c-last-identifier-range identifier-ok)
8373 (narrow-to-region low-lim (or macro-end (point-max)))
8375 ;; Search backwards for the defun's argument list. We give up if we
8376 ;; encounter a "}" (end of a previous defun) an "=" (which can't be in
8377 ;; a knr region) or BOB.
8379 ;; The criterion for a paren structure being the arg list is:
8380 ;; o - there is non-WS stuff after it but before any "{"; AND
8381 ;; o - the token after it isn't a ";" AND
8382 ;; o - it is preceded by either an identifier (the function name) or
8383 ;; a macro expansion like "DEFUN (...)"; AND
8384 ;; o - its content is a non-empty comma-separated list of identifiers
8385 ;; (an empty arg list won't have a knr region).
8387 ;; The following snippet illustrates these rules:
8388 ;; int foo (bar, baz, yuk)
8390 ;; int (*baz) (my_type) ;
8391 ;; int (*(* yuk) (void)) (void) ;
8394 ;; Additionally, for a knr list to be recognized:
8395 ;; o - The identifier of each declarator up to and including the
8396 ;; one "near" point must be contained in the arg list.
8399 (while (> pp-count-out 0) ; go back one paren/bracket pair each time.
8400 (setq pp-count-out (1- pp-count-out))
8401 (c-syntactic-skip-backward "^)]}=")
8402 (cond ((eq (char-before) ?\))
8403 (setq after-rparen (point)))
8404 ((eq (char-before) ?\])
8405 (setq after-rparen nil))
8406 (t ; either } (hit previous defun) or = or no more
8411 ;; We're inside a paren. Could it be our argument list....?
8415 (goto-char after-rparen)
8416 (unless (c-go-list-backward) (throw 'knr nil)) ;
8417 ;; FIXME!!! What about macros between the parens? 2007/01/20
8418 (setq before-lparen (point)))
8420 ;; It can't be the arg list if next token is ; or {
8421 (progn (goto-char after-rparen)
8422 (c-forward-syntactic-ws)
8423 (not (memq (char-after) '(?\; ?\{ ?\=))))
8425 ;; Is the thing preceding the list an identifier (the
8426 ;; function name), or a macro expansion?
8428 (goto-char before-lparen)
8429 (eq (c-backward-token-2) 0)
8430 (or (eq (c-on-identifier) (point))
8431 (and (eq (char-after) ?\))
8432 (c-go-up-list-backward)
8433 (eq (c-backward-token-2) 0)
8434 (eq (c-on-identifier) (point)))))
8436 ;; Have we got a non-empty list of comma-separated
8439 (goto-char before-lparen)
8440 (c-forward-token-2) ; to first token inside parens
8442 (setq id-start (c-on-identifier)) ; Must be at least one.
8447 (c-end-of-current-token)
8448 (push (buffer-substring-no-properties id-start
8451 (c-forward-syntactic-ws)
8452 (eq (char-after) ?\,))
8454 (unless (setq id-start (c-on-identifier))
8455 (throw 'id-list nil)))
8456 (eq (char-after) ?\)))))
8458 ;; Are all the identifiers in the k&r list up to the
8459 ;; current one also in the argument list?
8461 (forward-char) ; over the )
8462 (setq after-prec-token after-rparen)
8463 (c-forward-syntactic-ws)
8465 (or (consp (setq decl-or-cast
8466 (c-forward-decl-or-cast-1
8468 nil ; Or 'arglist ???
8471 (goto-char after-prec-token)
8472 (c-forward-syntactic-ws)
8473 (setq identifier-ok (eq (char-after) ?{))
8475 (eq (char-after) ?\;)
8476 (setq after-prec-token (1+ (point)))
8477 (goto-char (car decl-or-cast))
8478 (setq decl-res (c-forward-declarator))
8480 (member (buffer-substring-no-properties
8481 (car decl-res) (cadr decl-res))
8484 (goto-char after-prec-token)
8485 (prog1 (< (point) here)
8486 (c-forward-syntactic-ws))))
8487 (setq identifier-ok nil))
8489 ;; ...Yes. We've identified the function's argument list.
8491 (progn (goto-char after-rparen)
8492 (c-forward-syntactic-ws)
8494 ;; ...No. The current parens aren't the function's arg list.
8495 (goto-char before-lparen))
8497 (or (c-go-list-backward) ; backwards over [ .... ]
8498 (throw 'knr nil)))))))))
8500 (defun c-skip-conditional ()
8501 ;; skip forward over conditional at point, including any predicate
8502 ;; statements in parentheses. No error checking is performed.
8504 ;; This function might do hidden buffer changes.
8505 (c-forward-sexp (cond
8507 ((looking-at (concat "\\<else"
8508 "\\([ \t\n]\\|\\\\\n\\)+"
8509 "if\\>\\([^_]\\|$\\)"))
8511 ;; do, else, try, finally
8512 ((looking-at (concat "\\<\\("
8513 "do\\|else\\|try\\|finally"
8514 "\\)\\>\\([^_]\\|$\\)"))
8516 ;; for, if, while, switch, catch, synchronized, foreach
8519 (defun c-after-conditional (&optional lim)
8520 ;; If looking at the token after a conditional then return the
8521 ;; position of its start, otherwise return nil.
8523 ;; This function might do hidden buffer changes.
8525 (and (zerop (c-backward-token-2 1 t lim))
8526 (or (looking-at c-block-stmt-1-key)
8527 (and (eq (char-after) ?\()
8528 (zerop (c-backward-token-2 1 t lim))
8529 (or (looking-at c-block-stmt-2-key)
8530 (looking-at c-block-stmt-1-2-key))))
8533 (defun c-after-special-operator-id (&optional lim)
8534 ;; If the point is after an operator identifier that isn't handled
8535 ;; like an ordinary symbol (i.e. like "operator =" in C++) then the
8536 ;; position of the start of that identifier is returned. nil is
8537 ;; returned otherwise. The point may be anywhere in the syntactic
8538 ;; whitespace after the last token of the operator identifier.
8540 ;; This function might do hidden buffer changes.
8542 (and c-overloadable-operators-regexp
8543 (zerop (c-backward-token-2 1 nil lim))
8544 (looking-at c-overloadable-operators-regexp)
8545 (or (not c-opt-op-identifier-prefix)
8547 (zerop (c-backward-token-2 1 nil lim))
8548 (looking-at c-opt-op-identifier-prefix)))
8551 (defsubst c-backward-to-block-anchor (&optional lim)
8552 ;; Assuming point is at a brace that opens a statement block of some
8553 ;; kind, move to the proper anchor point for that block. It might
8554 ;; need to be adjusted further by c-add-stmt-syntax, but the
8555 ;; position at return is suitable as start position for that
8558 ;; This function might do hidden buffer changes.
8559 (unless (= (point) (c-point 'boi))
8560 (let ((start (c-after-conditional lim)))
8562 (goto-char start)))))
8564 (defsubst c-backward-to-decl-anchor (&optional lim)
8565 ;; Assuming point is at a brace that opens the block of a top level
8566 ;; declaration of some kind, move to the proper anchor point for
8569 ;; This function might do hidden buffer changes.
8570 (unless (= (point) (c-point 'boi))
8571 (c-beginning-of-statement-1 lim)))
8573 (defun c-search-decl-header-end ()
8574 ;; Search forward for the end of the "header" of the current
8575 ;; declaration. That's the position where the definition body
8576 ;; starts, or the first variable initializer, or the ending
8577 ;; semicolon. I.e. search forward for the closest following
8578 ;; (syntactically relevant) '{', '=' or ';' token. Point is left
8579 ;; _after_ the first found token, or at point-max if none is found.
8581 ;; This function might do hidden buffer changes.
8583 (let ((base (point)))
8584 (if (c-major-mode-is 'c++-mode)
8586 ;; In C++ we need to take special care to handle operator
8587 ;; tokens and those pesky template brackets.
8589 (c-syntactic-re-search-forward "[;{<=]" nil 'move t t)
8591 (c-end-of-current-token base)
8592 ;; Handle operator identifiers, i.e. ignore any
8593 ;; operator token preceded by "operator".
8595 (and (c-safe (c-backward-sexp) t)
8596 (looking-at c-opt-op-identifier-prefix)))
8597 (and (eq (char-before) ?<)
8598 (c-with-syntax-table c++-template-syntax-table
8599 (if (c-safe (goto-char (c-up-list-forward (point))))
8601 (goto-char (point-max))
8603 (setq base (point)))
8606 (c-syntactic-re-search-forward "[;{=]" nil 'move t t)
8607 (c-end-of-current-token base))
8608 (setq base (point))))))
8610 (defun c-beginning-of-decl-1 (&optional lim)
8611 ;; Go to the beginning of the current declaration, or the beginning
8612 ;; of the previous one if already at the start of it. Point won't
8613 ;; be moved out of any surrounding paren. Return a cons cell of the
8614 ;; form (MOVE . KNR-POS). MOVE is like the return value from
8615 ;; `c-beginning-of-statement-1'. If point skipped over some K&R
8616 ;; style argument declarations (and they are to be recognized) then
8617 ;; KNR-POS is set to the start of the first such argument
8618 ;; declaration, otherwise KNR-POS is nil. If LIM is non-nil, it's a
8619 ;; position that bounds the backward search.
8621 ;; NB: Cases where the declaration continues after the block, as in
8622 ;; "struct foo { ... } bar;", are currently recognized as two
8623 ;; declarations, e.g. "struct foo { ... }" and "bar;" in this case.
8625 ;; This function might do hidden buffer changes.
8627 (let* ((start (point))
8628 (last-stmt-start (point))
8629 (move (c-beginning-of-statement-1 lim nil t)))
8631 ;; `c-beginning-of-statement-1' stops at a block start, but we
8632 ;; want to continue if the block doesn't begin a top level
8633 ;; construct, i.e. if it isn't preceded by ';', '}', ':', bob,
8634 ;; or an open paren.
8635 (let ((beg (point)) tentative-move)
8636 ;; Go back one "statement" each time round the loop until we're just
8637 ;; after a ;, }, or :, or at BOB or the start of a macro or start of
8638 ;; an ObjC method. This will move over a multiple declaration whose
8639 ;; components are comma separated.
8641 ;; Must check with c-opt-method-key in ObjC mode.
8642 (not (and c-opt-method-key
8643 (looking-at c-opt-method-key)))
8644 (/= last-stmt-start (point))
8646 (c-backward-syntactic-ws lim)
8647 (not (memq (char-before) '(?\; ?} ?: nil))))
8650 (not (looking-at "\\s(")))
8651 ;; Check that we don't move from the first thing in a
8652 ;; macro to its header.
8653 (not (eq (setq tentative-move
8654 (c-beginning-of-statement-1 lim nil t))
8656 (setq last-stmt-start beg
8658 move tentative-move))
8661 (when c-recognize-knr-p
8662 (let ((fallback-pos (point)) knr-argdecl-start)
8663 ;; Handle K&R argdecls. Back up after the "statement" jumped
8664 ;; over by `c-beginning-of-statement-1', unless it was the
8665 ;; function body, in which case we're sitting on the opening
8666 ;; brace now. Then test if we're in a K&R argdecl region and
8667 ;; that we started at the other side of the first argdecl in
8669 (unless (eq (char-after) ?{)
8670 (goto-char last-stmt-start))
8671 (if (and (setq knr-argdecl-start (c-in-knr-argdecl lim))
8672 (< knr-argdecl-start start)
8674 (goto-char knr-argdecl-start)
8675 (not (eq (c-beginning-of-statement-1 lim nil t) 'macro))))
8677 (cons (if (eq (char-after fallback-pos) ?{)
8681 (goto-char fallback-pos))))
8683 ;; `c-beginning-of-statement-1' counts each brace block as a separate
8684 ;; statement, so the result will be 'previous if we've moved over any.
8685 ;; So change our result back to 'same if necessary.
8687 ;; If they were brace list initializers we might not have moved over a
8688 ;; declaration boundary though, so change it to 'same if we've moved
8689 ;; past a '=' before '{', but not ';'. (This ought to be integrated
8690 ;; into `c-beginning-of-statement-1', so we avoid this extra pass which
8691 ;; potentially can search over a large amount of text.). Take special
8692 ;; pains not to get mislead by C++'s "operator=", and the like.
8693 (if (and (eq move 'previous)
8694 (c-with-syntax-table (if (c-major-mode-is 'c++-mode)
8695 c++-template-syntax-table
8700 (while ; keep going back to "[;={"s until we either find
8701 ; no more, or get to one which isn't an "operator ="
8702 (and (c-syntactic-re-search-forward "[;={]" start t t t)
8703 (eq (char-before) ?=)
8704 c-overloadable-operators-regexp
8705 c-opt-op-identifier-prefix
8707 (eq (c-backward-token-2) 0)
8708 (looking-at c-overloadable-operators-regexp)
8709 (eq (c-backward-token-2) 0)
8710 (looking-at c-opt-op-identifier-prefix))))
8711 (eq (char-before) ?=))
8712 (c-syntactic-re-search-forward "[;{]" start t t)
8713 (eq (char-before) ?{)
8714 (c-safe (goto-char (c-up-list-forward (point))) t)
8715 (not (c-syntactic-re-search-forward ";" start t t))))))
8719 (defun c-end-of-decl-1 ()
8720 ;; Assuming point is at the start of a declaration (as detected by
8721 ;; e.g. `c-beginning-of-decl-1'), go to the end of it. Unlike
8722 ;; `c-beginning-of-decl-1', this function handles the case when a
8723 ;; block is followed by identifiers in e.g. struct declarations in C
8724 ;; or C++. If a proper end was found then t is returned, otherwise
8725 ;; point is moved as far as possible within the current sexp and nil
8726 ;; is returned. This function doesn't handle macros; use
8727 ;; `c-end-of-macro' instead in those cases.
8729 ;; This function might do hidden buffer changes.
8730 (let ((start (point))
8731 (decl-syntax-table (if (c-major-mode-is 'c++-mode)
8732 c++-template-syntax-table
8735 (c-search-decl-header-end)
8737 (when (and c-recognize-knr-p
8738 (eq (char-before) ?\;)
8739 (c-in-knr-argdecl start))
8740 ;; Stopped at the ';' in a K&R argdecl section which is
8741 ;; detected using the same criteria as in
8742 ;; `c-beginning-of-decl-1'. Move to the following block
8744 (c-syntactic-re-search-forward "{" nil 'move t))
8746 (when (eq (char-before) ?{)
8747 ;; Encountered a block in the declaration. Jump over it.
8749 (goto-char (c-up-list-forward (point)))
8750 (error (goto-char (point-max))
8751 (throw 'return nil)))
8752 (if (or (not c-opt-block-decls-with-vars-key)
8754 (c-with-syntax-table decl-syntax-table
8755 (let ((lim (point)))
8758 ;; Check for `c-opt-block-decls-with-vars-key'
8759 ;; before the first paren.
8760 (c-syntactic-re-search-forward
8761 (concat "[;=([{]\\|\\("
8762 c-opt-block-decls-with-vars-key
8766 (not (eq (char-before) ?_))
8767 ;; Check that the first following paren is
8769 (c-syntactic-re-search-forward "[;=([{]"
8771 (eq (char-before) ?{)))))))
8772 ;; The declaration doesn't have any of the
8773 ;; `c-opt-block-decls-with-vars' keywords in the
8774 ;; beginning, so it ends here at the end of the block.
8777 (c-with-syntax-table decl-syntax-table
8779 (if (eq (char-before) ?\;)
8781 (c-syntactic-re-search-forward ";" nil 'move t))))
8784 (defun c-looking-at-decl-block (containing-sexp goto-start &optional limit)
8785 ;; Assuming the point is at an open brace, check if it starts a
8786 ;; block that contains another declaration level, i.e. that isn't a
8787 ;; statement block or a brace list, and if so return non-nil.
8789 ;; If the check is successful, the return value is the start of the
8790 ;; keyword that tells what kind of construct it is, i.e. typically
8791 ;; what `c-decl-block-key' matched. Also, if GOTO-START is set then
8792 ;; the point will be at the start of the construct, before any
8793 ;; leading specifiers, otherwise it's at the returned position.
8795 ;; The point is clobbered if the check is unsuccessful.
8797 ;; CONTAINING-SEXP is the position of the open of the surrounding
8798 ;; paren, or nil if none.
8800 ;; The optional LIMIT limits the backward search for the start of
8801 ;; the construct. It's assumed to be at a syntactically relevant
8804 ;; If any template arglists are found in the searched region before
8805 ;; the open brace, they get marked with paren syntax.
8807 ;; This function might do hidden buffer changes.
8809 (let ((open-brace (point)) kwd-start first-specifier-pos)
8810 (c-syntactic-skip-backward c-block-prefix-charset limit t)
8812 (when (and c-recognize-<>-arglists
8813 (eq (char-before) ?>))
8814 ;; Could be at the end of a template arglist.
8815 (let ((c-parse-and-markup-<>-arglists t))
8817 (c-backward-<>-arglist nil limit)
8819 (c-syntactic-skip-backward c-block-prefix-charset limit t)
8820 (eq (char-before) ?>))))))
8822 ;; Note: Can't get bogus hits inside template arglists below since they
8823 ;; have gotten paren syntax above.
8825 ;; If `goto-start' is set we begin by searching for the
8826 ;; first possible position of a leading specifier list.
8827 ;; The `c-decl-block-key' search continues from there since
8828 ;; we know it can't match earlier.
8830 (when (c-syntactic-re-search-forward c-symbol-start
8832 (goto-char (setq first-specifier-pos (match-beginning 0)))
8837 ((c-syntactic-re-search-forward c-decl-block-key open-brace t t t)
8838 (goto-char (setq kwd-start (match-beginning 0)))
8840 ;; Exclude cases where we matched what would ordinarily
8841 ;; be a block declaration keyword, except where it's not
8842 ;; legal because it's part of a "compound keyword" like
8843 ;; "enum class". Of course, if c-after-brace-list-key
8844 ;; is nil, we can skip the test.
8845 (or (equal c-after-brace-list-key "\\<\\>")
8850 (looking-at c-after-brace-list-key)
8851 (= (c-backward-token-2 1 t) 0)
8852 (looking-at c-brace-list-key))))))
8854 ;; Found a keyword that can't be a type?
8857 ;; Can be a type too, in which case it's the return type of a
8858 ;; function (under the assumption that no declaration level
8859 ;; block construct starts with a type).
8860 (not (c-forward-type))
8862 ;; Jumped over a type, but it could be a declaration keyword
8863 ;; followed by the declared identifier that we've jumped over
8864 ;; instead (e.g. in "class Foo {"). If it indeed is a type
8865 ;; then we should be at the declarator now, so check for a
8866 ;; valid declarator start.
8868 ;; Note: This doesn't cope with the case when a declared
8869 ;; identifier is followed by e.g. '(' in a language where '('
8870 ;; also might be part of a declarator expression. Currently
8871 ;; there's no such language.
8872 (not (or (looking-at c-symbol-start)
8873 (looking-at c-type-decl-prefix-key))))))
8875 ;; In Pike a list of modifiers may be followed by a brace
8876 ;; to make them apply to many identifiers. Note that the
8877 ;; match data will be empty on return in this case.
8878 ((and (c-major-mode-is 'pike-mode)
8880 (goto-char open-brace)
8881 (= (c-backward-token-2) 0))
8882 (looking-at c-specifier-key)
8883 ;; Use this variant to avoid yet another special regexp.
8884 (c-keyword-member (c-keyword-sym (match-string 1))
8886 (setq kwd-start (point))
8892 ;; Back up over any preceding specifiers and their clauses
8893 ;; by going forward from `first-specifier-pos', which is the
8894 ;; earliest possible position where the specifier list can
8897 (goto-char first-specifier-pos)
8899 (while (< (point) kwd-start)
8900 (if (looking-at c-symbol-key)
8901 ;; Accept any plain symbol token on the ground that
8902 ;; it's a specifier masked through a macro (just
8903 ;; like `c-forward-decl-or-cast-1' skip forward over
8906 ;; Could be more restrictive wrt invalid keywords,
8907 ;; but that'd only occur in invalid code so there's
8908 ;; no use spending effort on it.
8909 (let ((end (match-end 0)))
8910 (unless (c-forward-keyword-clause 0)
8912 (c-forward-syntactic-ws)))
8914 ;; Can't parse a declaration preamble and is still
8915 ;; before `kwd-start'. That means `first-specifier-pos'
8916 ;; was in some earlier construct. Search again.
8917 (if (c-syntactic-re-search-forward c-symbol-start
8919 (goto-char (setq first-specifier-pos (match-beginning 0)))
8920 ;; Got no preamble before the block declaration keyword.
8921 (setq first-specifier-pos kwd-start))))
8923 (goto-char first-specifier-pos))
8924 (goto-char kwd-start))
8928 (defun c-search-uplist-for-classkey (paren-state)
8929 ;; Check if the closest containing paren sexp is a declaration
8930 ;; block, returning a 2 element vector in that case. Aref 0
8931 ;; contains the bufpos at boi of the class key line, and aref 1
8932 ;; contains the bufpos of the open brace. This function is an
8933 ;; obsolete wrapper for `c-looking-at-decl-block'.
8935 ;; This function might do hidden buffer changes.
8936 (let ((open-paren-pos (c-most-enclosing-brace paren-state)))
8937 (when open-paren-pos
8939 (goto-char open-paren-pos)
8940 (when (and (eq (char-after) ?{)
8941 (c-looking-at-decl-block
8942 (c-safe-position open-paren-pos paren-state)
8944 (back-to-indentation)
8945 (vector (point) open-paren-pos))))))
8947 (defun c-most-enclosing-decl-block (paren-state)
8948 ;; Return the buffer position of the most enclosing decl-block brace (in the
8949 ;; sense of c-looking-at-decl-block) in the PAREN-STATE structure, or nil if
8951 (let* ((open-brace (c-pull-open-brace paren-state))
8952 (next-open-brace (c-pull-open-brace paren-state)))
8953 (while (and open-brace
8955 (goto-char open-brace)
8956 (not (c-looking-at-decl-block next-open-brace nil))))
8957 (setq open-brace next-open-brace
8958 next-open-brace (c-pull-open-brace paren-state)))
8961 (defun c-cheap-inside-bracelist-p (paren-state)
8962 ;; Return the position of the L-brace if point is inside a brace list
8963 ;; initialization of an array, etc. This is an approximate function,
8964 ;; designed for speed over accuracy. It will not find every bracelist, but
8965 ;; a non-nil result is reliable. We simply search for "= {" (naturally with
8966 ;; syntactic whitespace allowed). PAREN-STATE is the normal thing that it
8967 ;; is everywhere else.
8971 (and (setq b-pos (c-pull-open-brace paren-state))
8972 (progn (goto-char b-pos)
8974 (c-backward-token-2)
8975 (not (looking-at "=")))))
8978 (defun c-backward-colon-prefixed-type ()
8979 ;; We're at the token after what might be a type prefixed with a colon. Try
8980 ;; moving backward over this type and the colon. On success, return t and
8981 ;; leave point before colon; on failure, leave point unchanged. Will clobber
8983 (let ((here (point))
8987 (and (eql (c-backward-token-2) 0)
8988 (or (not (looking-at "\\s)"))
8989 (c-go-up-list-backward))
8991 ((eql (char-after) ?:)
8992 (setq colon-pos (point))
8994 (c-forward-syntactic-ws)
8995 (or (and (c-forward-type)
8996 (progn (c-forward-syntactic-ws)
8998 (setq colon-pos nil))
9000 ((eql (char-after) ?\()
9002 ((looking-at c-symbol-key)
9006 (goto-char colon-pos)
9009 (defun c-backward-over-enum-header ()
9010 ;; We're at a "{". Move back to the enum-like keyword that starts this
9011 ;; declaration and return t, otherwise don't move and return nil.
9012 (let ((here (point))
9013 up-sexp-pos before-identifier)
9014 (when c-recognize-post-brace-list-type-p
9015 (c-backward-colon-prefixed-type))
9018 (eq (c-backward-token-2) 0)
9019 (or (not (looking-at "\\s)"))
9020 (c-go-up-list-backward))
9022 ((and (looking-at c-symbol-key) (c-on-identifier)
9023 (not before-identifier))
9024 (setq before-identifier t))
9025 ((and before-identifier
9026 (or (eql (char-after) ?,)
9027 (looking-at c-postfix-decl-spec-key)))
9028 (setq before-identifier nil)
9030 ((looking-at c-after-brace-list-key) t)
9031 ((looking-at c-brace-list-key) nil)
9032 ((eq (char-after) ?\()
9033 (and (eq (c-backward-token-2) 0)
9034 (or (looking-at c-decl-hangon-key)
9035 (looking-at c-noise-macro-with-parens-name-re))))
9037 ((and c-recognize-<>-arglists
9038 (eq (char-after) ?<)
9039 (looking-at "\\s("))
9042 (or (looking-at c-brace-list-key)
9043 (progn (goto-char here) nil))))
9045 (defun c-inside-bracelist-p (containing-sexp paren-state)
9046 ;; return the buffer position of the beginning of the brace list
9047 ;; statement if we're inside a brace list, otherwise return nil.
9048 ;; CONTAINING-SEXP is the buffer pos of the innermost containing
9049 ;; paren. PAREN-STATE is the remainder of the state of enclosing
9052 ;; N.B.: This algorithm can potentially get confused by cpp macros
9053 ;; placed in inconvenient locations. It's a trade-off we make for
9056 ;; This function might do hidden buffer changes.
9058 ;; This will pick up brace list declarations.
9060 (goto-char containing-sexp)
9061 (c-backward-over-enum-header))
9062 ;; this will pick up array/aggregate init lists, even if they are nested.
9065 ;; Pike can have class definitions anywhere, so we must
9066 ;; check for the class key here.
9067 (and (c-major-mode-is 'pike-mode)
9069 bufpos braceassignp lim next-containing macro-start)
9070 (while (and (not bufpos)
9073 (if (consp (car paren-state))
9074 (setq lim (cdr (car paren-state))
9075 paren-state (cdr paren-state))
9076 (setq lim (car paren-state)))
9078 (setq next-containing (car paren-state)
9079 paren-state (cdr paren-state))))
9080 (goto-char containing-sexp)
9081 (if (c-looking-at-inexpr-block next-containing next-containing)
9082 ;; We're in an in-expression block of some kind. Do not
9083 ;; check nesting. We deliberately set the limit to the
9084 ;; containing sexp, so that c-looking-at-inexpr-block
9085 ;; doesn't check for an identifier before it.
9086 (setq containing-sexp nil)
9087 ;; see if the open brace is preceded by = or [...] in
9088 ;; this statement, but watch out for operator=
9089 (setq braceassignp 'dontknow)
9090 (c-backward-token-2 1 t lim)
9091 ;; Checks to do only on the first sexp before the brace.
9092 (when (and c-opt-inexpr-brace-list-key
9093 (eq (char-after) ?\[))
9094 ;; In Java, an initialization brace list may follow
9095 ;; directly after "new Foo[]", so check for a "new"
9097 (while (eq braceassignp 'dontknow)
9099 (cond ((/= (c-backward-token-2 1 t lim) 0) nil)
9100 ((looking-at c-opt-inexpr-brace-list-key) t)
9101 ((looking-at "\\sw\\|\\s_\\|[.[]")
9102 ;; Carry on looking if this is an
9103 ;; identifier (may contain "." in Java)
9104 ;; or another "[]" sexp.
9107 ;; Checks to do on all sexps before the brace, up to the
9108 ;; beginning of the statement.
9109 (while (eq braceassignp 'dontknow)
9110 (cond ((eq (char-after) ?\;)
9111 (setq braceassignp nil))
9113 (looking-at class-key))
9114 (setq braceassignp nil))
9115 ((eq (char-after) ?=)
9116 ;; We've seen a =, but must check earlier tokens so
9117 ;; that it isn't something that should be ignored.
9118 (setq braceassignp 'maybe)
9119 (while (and (eq braceassignp 'maybe)
9120 (zerop (c-backward-token-2 1 t lim)))
9123 ;; Check for operator =
9124 ((and c-opt-op-identifier-prefix
9125 (looking-at c-opt-op-identifier-prefix))
9127 ;; Check for `<opchar>= in Pike.
9128 ((and (c-major-mode-is 'pike-mode)
9129 (or (eq (char-after) ?`)
9130 ;; Special case for Pikes
9131 ;; `[]=, since '[' is not in
9132 ;; the punctuation class.
9133 (and (eq (char-after) ?\[)
9134 (eq (char-before) ?`))))
9136 ((looking-at "\\s.") 'maybe)
9137 ;; make sure we're not in a C++ template
9138 ;; argument assignment
9140 (c-major-mode-is 'c++-mode)
9142 (let ((here (point))
9144 (skip-chars-backward "^<>")
9146 (and (eq (char-before) ?<)
9147 (not (c-crosses-statement-barrier-p
9149 (not (c-in-literal))
9153 (if (and (eq braceassignp 'dontknow)
9154 (/= (c-backward-token-2 1 t lim) 0))
9155 (setq braceassignp nil)))
9158 ;; We've hit the beginning of the aggregate list.
9159 (c-beginning-of-statement-1
9160 (c-most-enclosing-brace paren-state))
9161 (setq bufpos (point)))
9162 ((eq (char-after) ?\;)
9163 ;; Brace lists can't contain a semicolon, so we're done.
9164 (setq containing-sexp nil))
9165 ((and (setq macro-start (point))
9166 (c-forward-to-cpp-define-body)
9167 (eq (point) containing-sexp))
9168 ;; We've a macro whose expansion starts with the '{'.
9169 ;; Heuristically, if we have a ';' in it we've not got a
9170 ;; brace list, otherwise we have.
9171 (let ((macro-end (progn (c-end-of-macro) (point))))
9172 (goto-char containing-sexp)
9174 (if (and (c-syntactic-re-search-forward "[;,]" macro-end t t)
9175 (eq (char-before) ?\;))
9177 containing-sexp nil)
9178 (setq bufpos macro-start))))
9181 (setq containing-sexp next-containing
9183 next-containing nil)))))
9188 (defun c-looking-at-special-brace-list (&optional lim)
9189 ;; If we're looking at the start of a pike-style list, i.e., `({Â })',
9190 ;; `([Â ])', `(<Â >)', etc., a cons of a cons of its starting and ending
9191 ;; positions and its entry in c-special-brace-lists is returned, nil
9192 ;; otherwise. The ending position is nil if the list is still open.
9193 ;; LIM is the limit for forward search. The point may either be at
9194 ;; the `(' or at the following paren character. Tries to check the
9195 ;; matching closer, but assumes it's correct if no balanced paren is
9196 ;; found (i.e. the case `({ ... } ... )' is detected as _not_ being
9197 ;; a special brace list).
9199 ;; This function might do hidden buffer changes.
9200 (if c-special-brace-lists
9205 (c-forward-syntactic-ws)
9206 (if (eq (char-after) ?\()
9209 (c-forward-syntactic-ws)
9210 (setq inner-beg (point))
9211 (setq type (assq (char-after) c-special-brace-lists)))
9212 (if (setq type (assq (char-after) c-special-brace-lists))
9214 (setq inner-beg (point))
9215 (c-backward-syntactic-ws)
9217 (setq beg (if (eq (char-after) ?\()
9225 (= (char-before) ?\)))
9227 (goto-char inner-beg)
9228 (if (looking-at "\\s(")
9229 ;; Check balancing of the inner paren
9234 ;; If the inner char isn't a paren then
9235 ;; we can't check balancing, so just
9236 ;; check the char before the outer
9240 (c-backward-syntactic-ws)
9241 (= (char-before) (cdr type)))))
9242 (if (or (/= (char-syntax (char-before)) ?\))
9244 (c-forward-syntactic-ws)
9247 (cons (cons beg end) type))
9248 (cons (list beg) type)))))
9251 (defun c-looking-at-bos (&optional lim)
9252 ;; Return non-nil if between two statements or declarations, assuming
9253 ;; point is not inside a literal or comment.
9255 ;; Obsolete - `c-at-statement-start-p' or `c-at-expression-start-p'
9256 ;; are recommended instead.
9258 ;; This function might do hidden buffer changes.
9259 (c-at-statement-start-p))
9260 (make-obsolete 'c-looking-at-bos 'c-at-statement-start-p "22.1")
9262 (defun c-looking-at-inexpr-block (lim containing-sexp &optional check-at-end)
9263 ;; Return non-nil if we're looking at the beginning of a block
9264 ;; inside an expression. The value returned is actually a cons of
9265 ;; either 'inlambda, 'inexpr-statement or 'inexpr-class and the
9266 ;; position of the beginning of the construct.
9268 ;; LIM limits the backward search. CONTAINING-SEXP is the start
9269 ;; position of the closest containing list. If it's nil, the
9270 ;; containing paren isn't used to decide whether we're inside an
9271 ;; expression or not. If both LIM and CONTAINING-SEXP are used, LIM
9272 ;; needs to be farther back.
9274 ;; If CHECK-AT-END is non-nil then extra checks at the end of the
9275 ;; brace block might be done. It should only be used when the
9276 ;; construct can be assumed to be complete, i.e. when the original
9277 ;; starting position was further down than that.
9279 ;; This function might do hidden buffer changes.
9282 (let ((res 'maybe) passed-paren
9283 (closest-lim (or containing-sexp lim (point-min)))
9284 ;; Look at the character after point only as a last resort
9285 ;; when we can't disambiguate.
9286 (block-follows (and (eq (char-after) ?{) (point))))
9288 (while (and (eq res 'maybe)
9289 (progn (c-backward-syntactic-ws)
9290 (> (point) closest-lim))
9292 (progn (backward-char)
9293 (looking-at "[]).]\\|\\w\\|\\s_"))
9294 (c-safe (forward-char)
9295 (goto-char (scan-sexps (point) -1))))
9298 (if (looking-at c-keywords-regexp)
9299 (let ((kw-sym (c-keyword-sym (match-string 1))))
9302 (c-keyword-member kw-sym 'c-inexpr-class-kwds))
9303 (and (not (eq passed-paren ?\[))
9304 (or (not (looking-at c-class-key))
9305 ;; If the class definition is at the start of
9306 ;; a statement, we don't consider it an
9307 ;; in-expression class.
9308 (let ((prev (point)))
9310 (= (c-backward-token-2 1 nil closest-lim) 0)
9311 (eq (char-syntax (char-after)) ?w))
9312 (setq prev (point)))
9314 (not (c-at-statement-start-p)))
9315 ;; Also, in Pike we treat it as an
9316 ;; in-expression class if it's used in an
9317 ;; object clone expression.
9320 (c-major-mode-is 'pike-mode)
9321 (progn (goto-char block-follows)
9322 (zerop (c-forward-token-2 1 t)))
9323 (eq (char-after) ?\())))
9324 (cons 'inexpr-class (point))))
9325 ((c-keyword-member kw-sym 'c-inexpr-block-kwds)
9326 (when (not passed-paren)
9327 (cons 'inexpr-statement (point))))
9328 ((c-keyword-member kw-sym 'c-lambda-kwds)
9329 (when (or (not passed-paren)
9330 (eq passed-paren ?\())
9331 (cons 'inlambda (point))))
9332 ((c-keyword-member kw-sym 'c-block-stmt-kwds)
9337 (if (looking-at "\\s(")
9339 (if (and (eq passed-paren ?\[)
9340 (eq (char-after) ?\[))
9341 ;; Accept several square bracket sexps for
9342 ;; Java array initializations.
9344 (setq passed-paren (char-after))
9349 (when (and c-recognize-paren-inexpr-blocks
9352 (eq (char-after containing-sexp) ?\())
9353 (goto-char containing-sexp)
9354 (if (or (save-excursion
9355 (c-backward-syntactic-ws lim)
9356 (while (and (eq (char-before) ?>)
9357 (c-get-char-property (1- (point))
9359 (c-go-list-backward nil lim))
9360 (c-backward-syntactic-ws lim))
9361 (and (> (point) (or lim (point-min)))
9363 (and c-special-brace-lists
9364 (c-looking-at-special-brace-list)))
9366 (cons 'inexpr-statement (point))))
9370 (defun c-looking-at-inexpr-block-backward (paren-state)
9371 ;; Returns non-nil if we're looking at the end of an in-expression
9372 ;; block, otherwise the same as `c-looking-at-inexpr-block'.
9373 ;; PAREN-STATE is the paren state relevant at the current position.
9375 ;; This function might do hidden buffer changes.
9377 ;; We currently only recognize a block.
9378 (let ((here (point))
9379 (elem (car-safe paren-state))
9381 (when (and (consp elem)
9382 (progn (goto-char (cdr elem))
9383 (c-forward-syntactic-ws here)
9385 (goto-char (car elem))
9386 (if (setq paren-state (cdr paren-state))
9387 (setq containing-sexp (car-safe paren-state)))
9388 (c-looking-at-inexpr-block (c-safe-position containing-sexp
9390 containing-sexp)))))
9392 (defun c-at-macro-vsemi-p (&optional pos)
9393 ;; Is there a "virtual semicolon" at POS or point?
9394 ;; (See cc-defs.el for full details of "virtual semicolons".)
9396 ;; This is true when point is at the last non syntactic WS position on the
9397 ;; line, there is a macro call last on the line, and this particular macro's
9398 ;; name is defined by the regexp `c-vs-macro-regexp' as not needing a
9407 c-macro-with-semi-re
9408 (eq (skip-chars-backward " \t") 0)
9410 ;; Check we've got nothing after this except comments and empty lines
9411 ;; joined by escaped EOLs.
9412 (skip-chars-forward " \t") ; always returns non-nil.
9414 (while ; go over 1 block comment per iteration.
9416 (looking-at "\\(\\\\[\n\r][ \t]*\\)*")
9417 (goto-char (match-end 0))
9419 ((looking-at c-block-comment-start-regexp)
9420 (and (forward-comment 1)
9421 (skip-chars-forward " \t"))) ; always returns non-nil
9422 ((looking-at c-line-comment-start-regexp)
9429 (progn (c-backward-syntactic-ws)
9432 ;; Check for one of the listed macros being before point.
9433 (or (not (eq (char-before) ?\)))
9434 (when (c-go-list-backward)
9435 (c-backward-syntactic-ws)
9437 (c-simple-skip-symbol-backward)
9438 (looking-at c-macro-with-semi-re)
9440 (not (c-in-literal)))))) ; The most expensive check last.
9442 (defun c-macro-vsemi-status-unknown-p () t) ; See cc-defs.el.
9445 ;; `c-guess-basic-syntax' and the functions that precedes it below
9446 ;; implements the main decision tree for determining the syntactic
9447 ;; analysis of the current line of code.
9449 ;; Dynamically bound to t when `c-guess-basic-syntax' is called during
9450 ;; auto newline analysis.
9451 (defvar c-auto-newline-analysis nil)
9453 (defun c-brace-anchor-point (bracepos)
9454 ;; BRACEPOS is the position of a brace in a construct like "namespace
9455 ;; Bar {". Return the anchor point in this construct; this is the
9456 ;; earliest symbol on the brace's line which isn't earlier than
9459 ;; Currently (2007-08-17), "like namespace" means "matches
9460 ;; c-other-block-decl-kwds". It doesn't work with "class" or "struct"
9461 ;; or anything like that.
9463 (let ((boi (c-point 'boi bracepos)))
9464 (goto-char bracepos)
9465 (while (and (> (point) boi)
9466 (not (looking-at c-other-decl-block-key)))
9467 (c-backward-token-2))
9468 (if (> (point) boi) (point) boi))))
9470 (defsubst c-add-syntax (symbol &rest args)
9471 ;; A simple function to prepend a new syntax element to
9472 ;; `c-syntactic-context'. Using `setq' on it is unsafe since it
9473 ;; should always be dynamically bound but since we read it first
9474 ;; we'll fail properly anyway if this function is misused.
9475 (setq c-syntactic-context (cons (cons symbol args)
9476 c-syntactic-context)))
9478 (defsubst c-append-syntax (symbol &rest args)
9479 ;; Like `c-add-syntax' but appends to the end of the syntax list.
9480 ;; (Normally not necessary.)
9481 (setq c-syntactic-context (nconc c-syntactic-context
9482 (list (cons symbol args)))))
9484 (defun c-add-stmt-syntax (syntax-symbol
9489 ;; Add the indicated SYNTAX-SYMBOL to `c-syntactic-context', extending it as
9490 ;; needed with further syntax elements of the types `substatement',
9491 ;; `inexpr-statement', `arglist-cont-nonempty', `statement-block-intro', and
9492 ;; `defun-block-intro'.
9494 ;; Do the generic processing to anchor the given syntax symbol on
9495 ;; the preceding statement: Skip over any labels and containing
9496 ;; statements on the same line, and then search backward until we
9497 ;; find a statement or block start that begins at boi without a
9498 ;; label or comment.
9500 ;; Point is assumed to be at the prospective anchor point for the
9501 ;; given SYNTAX-SYMBOL. More syntax entries are added if we need to
9502 ;; skip past open parens and containing statements. Most of the added
9503 ;; syntax elements will get the same anchor point - the exception is
9504 ;; for an anchor in a construct like "namespace"[*] - this is as early
9505 ;; as possible in the construct but on the same line as the {.
9507 ;; [*] i.e. with a keyword matching c-other-block-decl-kwds.
9509 ;; SYNTAX-EXTRA-ARGS are a list of the extra arguments for the
9510 ;; syntax symbol. They are appended after the anchor point.
9512 ;; If STOP-AT-BOI-ONLY is nil, we can stop in the middle of the line
9513 ;; if the current statement starts there.
9515 ;; Note: It's not a problem if PAREN-STATE "overshoots"
9516 ;; CONTAINING-SEXP, i.e. contains info about parens further down.
9518 ;; This function might do hidden buffer changes.
9520 (if (= (point) (c-point 'boi))
9521 ;; This is by far the most common case, so let's give it special
9523 (apply 'c-add-syntax syntax-symbol (point) syntax-extra-args)
9525 (let ((syntax-last c-syntactic-context)
9526 (boi (c-point 'boi))
9527 ;; Set when we're on a label, so that we don't stop there.
9528 ;; FIXME: To be complete we should check if we're on a label
9529 ;; now at the start.
9532 ;; Use point as the anchor point for "namespace", "extern", etc.
9533 (apply 'c-add-syntax syntax-symbol
9534 (if (rassq syntax-symbol c-other-decl-block-key-in-symbols-alist)
9538 ;; Loop while we have to back out of containing blocks.
9541 (catch 'back-up-block
9543 ;; Loop while we have to back up statements.
9544 (while (or (/= (point) boi)
9546 (looking-at c-comment-start-regexp))
9548 ;; Skip past any comments that stands between the
9549 ;; statement start and boi.
9550 (let ((savepos (point)))
9551 (while (and (/= savepos boi)
9552 (c-backward-single-comment))
9553 (setq savepos (point)
9554 boi (c-point 'boi)))
9555 (goto-char savepos))
9557 ;; Skip to the beginning of this statement or backward
9559 (let ((old-pos (point))
9561 (step-type (c-beginning-of-statement-1 containing-sexp)))
9562 (setq boi (c-point 'boi)
9563 on-label (eq step-type 'label))
9565 (cond ((= (point) old-pos)
9566 ;; If we didn't move we're at the start of a block and
9567 ;; have to continue outside it.
9568 (throw 'back-up-block t))
9570 ((and (eq step-type 'up)
9571 (>= (point) old-boi)
9572 (looking-at "else\\>[^_]")
9575 (looking-at "if\\>[^_]")))
9576 ;; Special case to avoid deeper and deeper indentation
9577 ;; of "else if" clauses.
9580 ((and (not stop-at-boi-only)
9581 (/= old-pos old-boi)
9582 (memq step-type '(up previous)))
9583 ;; If stop-at-boi-only is nil, we shouldn't back up
9584 ;; over previous or containing statements to try to
9585 ;; reach boi, so go back to the last position and
9588 (throw 'back-up-block nil))
9591 (if (and (not stop-at-boi-only)
9592 (memq step-type '(up previous beginning)))
9593 ;; If we've moved into another statement then we
9594 ;; should no longer try to stop in the middle of a
9596 (setq stop-at-boi-only t))
9598 ;; Record this as a substatement if we skipped up one
9600 (when (eq step-type 'up)
9601 (c-add-syntax 'substatement nil))))
9606 ;; Now we have to go out of this block.
9607 (goto-char containing-sexp)
9609 ;; Don't stop in the middle of a special brace list opener
9611 (when c-special-brace-lists
9612 (let ((special-list (c-looking-at-special-brace-list)))
9613 (when (and special-list
9614 (< (car (car special-list)) (point)))
9615 (setq containing-sexp (car (car special-list)))
9616 (goto-char containing-sexp))))
9618 (setq paren-state (c-whack-state-after containing-sexp paren-state)
9619 containing-sexp (c-most-enclosing-brace paren-state)
9622 ;; Analyze the construct in front of the block we've stepped out
9623 ;; from and add the right syntactic element for it.
9624 (let ((paren-pos (point))
9625 (paren-char (char-after))
9628 (if (eq paren-char ?\()
9629 ;; Stepped out of a parenthesis block, so we're in an
9632 (when (/= paren-pos boi)
9633 (if (and c-recognize-paren-inexpr-blocks
9635 (c-backward-syntactic-ws containing-sexp)
9636 (or (not (looking-at "\\>"))
9637 (not (c-on-identifier))))
9639 (goto-char (1+ paren-pos))
9640 (c-forward-syntactic-ws)
9641 (eq (char-after) ?{)))
9642 ;; Stepped out of an in-expression statement. This
9643 ;; syntactic element won't get an anchor pos.
9644 (c-add-syntax 'inexpr-statement)
9646 ;; A parenthesis normally belongs to an arglist.
9647 (c-add-syntax 'arglist-cont-nonempty nil paren-pos)))
9651 (1+ containing-sexp)
9653 (setq step-type 'same
9656 ;; Stepped out of a brace block.
9657 (setq step-type (c-beginning-of-statement-1 containing-sexp)
9658 on-label (eq step-type 'label))
9660 (if (and (eq step-type 'same)
9661 (/= paren-pos (point)))
9665 (goto-char paren-pos)
9666 (setq inexpr (c-looking-at-inexpr-block
9667 (c-safe-position containing-sexp paren-state)
9669 (c-add-syntax (if (eq (car inexpr) 'inlambda)
9671 'statement-block-intro)
9673 ((looking-at c-other-decl-block-key)
9675 (cdr (assoc (match-string 1)
9676 c-other-decl-block-key-in-symbols-alist))
9677 (max (c-point 'boi paren-pos) (point))))
9678 (t (c-add-syntax 'defun-block-intro nil))))
9680 (c-add-syntax 'statement-block-intro nil)))
9682 (if (= paren-pos boi)
9683 ;; Always done if the open brace was at boi. The
9684 ;; c-beginning-of-statement-1 call above is necessary
9685 ;; anyway, to decide the type of block-intro to add.
9686 (goto-char paren-pos)
9687 (setq boi (c-point 'boi)))
9690 ;; Fill in the current point as the anchor for all the symbols
9692 (let ((p c-syntactic-context) q)
9693 (while (not (eq p syntax-last))
9694 (setq q (cdr (car p))) ; e.g. (nil 28) [from (arglist-cont-nonempty nil 28)]
9702 (defun c-add-class-syntax (symbol
9703 containing-decl-open
9704 containing-decl-start
9707 ;; The inclass and class-close syntactic symbols are added in
9708 ;; several places and some work is needed to fix everything.
9709 ;; Therefore it's collected here.
9711 ;; This function might do hidden buffer changes.
9712 (goto-char containing-decl-open)
9713 (if (and (eq symbol 'inclass) (= (point) (c-point 'boi)))
9715 (c-add-syntax symbol containing-decl-open)
9716 containing-decl-open)
9717 (goto-char containing-decl-start)
9718 ;; Ought to use `c-add-stmt-syntax' instead of backing up to boi
9719 ;; here, but we have to do like this for compatibility.
9720 (back-to-indentation)
9721 (c-add-syntax symbol (point))
9722 (if (and (c-keyword-member containing-decl-kwd
9723 'c-inexpr-class-kwds)
9724 (/= containing-decl-start (c-point 'boi containing-decl-start)))
9725 (c-add-syntax 'inexpr-class))
9728 (defun c-guess-continued-construct (indent-point
9730 beg-of-same-or-containing-stmt
9733 ;; This function contains the decision tree reached through both
9734 ;; cases 18 and 10. It's a continued statement or top level
9735 ;; construct of some kind.
9737 ;; This function might do hidden buffer changes.
9739 (let (special-brace-list placeholder)
9740 (goto-char indent-point)
9741 (skip-chars-forward " \t")
9744 ;; (CASE A removed.)
9745 ;; CASE B: open braces for class or brace-lists
9746 ((setq special-brace-list
9747 (or (and c-special-brace-lists
9748 (c-looking-at-special-brace-list))
9749 (eq char-after-ip ?{)))
9752 ;; CASE B.1: class-open
9754 (and (eq (char-after) ?{)
9755 (c-looking-at-decl-block containing-sexp t)
9756 (setq beg-of-same-or-containing-stmt (point))))
9757 (c-add-syntax 'class-open beg-of-same-or-containing-stmt))
9759 ;; CASE B.2: brace-list-open
9760 ((or (consp special-brace-list)
9762 (goto-char beg-of-same-or-containing-stmt)
9763 (c-syntactic-re-search-forward "=\\([^=]\\|$\\)"
9764 indent-point t t t)))
9765 ;; The most semantically accurate symbol here is
9766 ;; brace-list-open, but we normally report it simply as a
9767 ;; statement-cont. The reason is that one normally adjusts
9768 ;; brace-list-open for brace lists as top-level constructs,
9769 ;; and brace lists inside statements is a completely different
9770 ;; context. C.f. case 5A.3.
9771 (c-beginning-of-statement-1 containing-sexp)
9772 (c-add-stmt-syntax (if c-auto-newline-analysis
9773 ;; Turn off the dwim above when we're
9774 ;; analyzing the nature of the brace
9775 ;; for the auto newline feature.
9779 containing-sexp paren-state))
9781 ;; CASE B.3: The body of a function declared inside a normal
9782 ;; block. Can occur e.g. in Pike and when using gcc
9783 ;; extensions, but watch out for macros followed by blocks.
9784 ;; C.f. cases E, 16F and 17G.
9785 ((and (not (c-at-statement-start-p))
9786 (eq (c-beginning-of-statement-1 containing-sexp nil nil t)
9789 (let ((c-recognize-typeless-decls nil))
9790 ;; Turn off recognition of constructs that lacks a
9791 ;; type in this case, since that's more likely to be
9792 ;; a macro followed by a block.
9793 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
9794 (c-add-stmt-syntax 'defun-open nil t
9795 containing-sexp paren-state))
9797 ;; CASE B.4: Continued statement with block open. The most
9798 ;; accurate analysis is perhaps `statement-cont' together with
9799 ;; `block-open' but we play DWIM and use `substatement-open'
9800 ;; instead. The rationale is that this typically is a macro
9801 ;; followed by a block which makes it very similar to a
9802 ;; statement with a substatement block.
9804 (c-add-stmt-syntax 'substatement-open nil nil
9805 containing-sexp paren-state))
9808 ;; CASE C: iostream insertion or extraction operator
9809 ((and (looking-at "\\(<<\\|>>\\)\\([^=]\\|$\\)")
9811 (goto-char beg-of-same-or-containing-stmt)
9812 ;; If there is no preceding streamop in the statement
9813 ;; then indent this line as a normal statement-cont.
9814 (when (c-syntactic-re-search-forward
9815 "\\(<<\\|>>\\)\\([^=]\\|$\\)" indent-point 'move t t)
9816 (c-add-syntax 'stream-op (c-point 'boi))
9819 ;; CASE E: In the "K&R region" of a function declared inside a
9820 ;; normal block. C.f. case B.3.
9821 ((and (save-excursion
9822 ;; Check that the next token is a '{'. This works as
9823 ;; long as no language that allows nested function
9824 ;; definitions allows stuff like member init lists, K&R
9825 ;; declarations or throws clauses there.
9827 ;; Note that we do a forward search for something ahead
9828 ;; of the indentation line here. That's not good since
9829 ;; the user might not have typed it yet. Unfortunately
9830 ;; it's exceedingly tricky to recognize a function
9831 ;; prototype in a code block without resorting to this.
9832 (c-forward-syntactic-ws)
9833 (eq (char-after) ?{))
9834 (not (c-at-statement-start-p))
9835 (eq (c-beginning-of-statement-1 containing-sexp nil nil t)
9838 (let ((c-recognize-typeless-decls nil))
9839 ;; Turn off recognition of constructs that lacks a
9840 ;; type in this case, since that's more likely to be
9841 ;; a macro followed by a block.
9842 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
9843 (c-add-stmt-syntax 'func-decl-cont nil t
9844 containing-sexp paren-state))
9846 ;;CASE F: continued statement and the only preceding items are
9848 ((and (c-major-mode-is 'java-mode)
9849 (setq placeholder (point))
9850 (c-beginning-of-statement-1)
9852 (while (and (c-forward-annotation)
9853 (< (point) placeholder))
9854 (c-forward-syntactic-ws))
9857 (>= (point) placeholder)
9858 (goto-char placeholder)))
9859 (c-beginning-of-statement-1 containing-sexp)
9860 (c-add-syntax 'annotation-var-cont (point)))
9862 ;; CASE G: a template list continuation?
9863 ;; Mostly a duplication of case 5D.3 to fix templates-19:
9864 ((and (c-major-mode-is 'c++-mode)
9866 (goto-char indent-point)
9867 (c-with-syntax-table c++-template-syntax-table
9868 (setq placeholder (c-up-list-backward)))
9870 (eq (char-after placeholder) ?<)
9871 (/= (char-before placeholder) ?<)
9873 (goto-char (1+ placeholder))
9874 (not (looking-at c-<-op-cont-regexp))))))
9875 (c-with-syntax-table c++-template-syntax-table
9876 (goto-char placeholder)
9877 (c-beginning-of-statement-1 containing-sexp t))
9879 (c-backward-syntactic-ws containing-sexp)
9880 (eq (char-before) ?<))
9881 ;; In a nested template arglist.
9883 (goto-char placeholder)
9884 (c-syntactic-skip-backward "^,;" containing-sexp t)
9885 (c-forward-syntactic-ws))
9886 (back-to-indentation))
9887 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
9889 (c-add-syntax 'template-args-cont (point) placeholder))
9891 ;; CASE D: continued statement.
9893 (c-beginning-of-statement-1 containing-sexp)
9894 (c-add-stmt-syntax 'statement-cont nil nil
9895 containing-sexp paren-state))
9898 ;; The next autoload was added by RMS on 2005/8/9 - don't know why (ACM,
9901 (defun c-guess-basic-syntax ()
9902 "Return the syntactic context of the current line."
9905 (c-save-buffer-state
9906 ((indent-point (point))
9907 (case-fold-search nil)
9908 ;; A whole ugly bunch of various temporary variables. Have
9909 ;; to declare them here since it's not possible to declare
9910 ;; a variable with only the scope of a cond test and the
9911 ;; following result clauses, and most of this function is a
9912 ;; single gigantic cond. :P
9913 literal char-before-ip before-ws-ip char-after-ip macro-start
9914 in-macro-expr c-syntactic-context placeholder c-in-literal-cache
9915 step-type tmpsymbol keyword injava-inher special-brace-list tmp-pos
9917 ;; The following record some positions for the containing
9918 ;; declaration block if we're directly within one:
9919 ;; `containing-decl-open' is the position of the open
9920 ;; brace. `containing-decl-start' is the start of the
9921 ;; declaration. `containing-decl-kwd' is the keyword
9922 ;; symbol of the keyword that tells what kind of block it
9924 containing-decl-open
9925 containing-decl-start
9927 ;; The open paren of the closest surrounding sexp or nil if
9930 ;; The position after the closest preceding brace sexp
9931 ;; (nested sexps are ignored), or the position after
9932 ;; `containing-sexp' if there is none, or (point-min) if
9933 ;; `containing-sexp' is nil.
9935 ;; The paren state outside `containing-sexp', or at
9936 ;; `indent-point' if `containing-sexp' is nil.
9937 (paren-state (c-parse-state))
9938 ;; There's always at most one syntactic element which got
9939 ;; an anchor pos. It's stored in syntactic-relpos.
9941 (c-stmt-delim-chars c-stmt-delim-chars))
9943 ;; Check if we're directly inside an enclosing declaration
9945 (when (and (setq containing-sexp
9946 (c-most-enclosing-brace paren-state))
9948 (goto-char containing-sexp)
9949 (eq (char-after) ?{))
9951 (c-looking-at-decl-block
9952 (c-most-enclosing-brace paren-state
9955 (setq containing-decl-open containing-sexp
9956 containing-decl-start (point)
9957 containing-sexp nil)
9958 (goto-char placeholder)
9959 (setq containing-decl-kwd (and (looking-at c-keywords-regexp)
9960 (c-keyword-sym (match-string 1)))))
9962 ;; Init some position variables.
9965 (setq containing-sexp (car paren-state)
9966 paren-state (cdr paren-state))
9967 (if (consp containing-sexp)
9969 (goto-char (cdr containing-sexp))
9970 (if (and (c-major-mode-is 'c++-mode)
9971 (c-back-over-member-initializer-braces))
9972 (c-syntactic-skip-backward "^}" nil t))
9975 ;; Ignore balanced paren. The next entry
9976 ;; can't be another one.
9977 (setq containing-sexp (car paren-state)
9978 paren-state (cdr paren-state))
9979 ;; If there is no surrounding open paren then
9980 ;; put the last balanced pair back on paren-state.
9981 (setq paren-state (cons containing-sexp paren-state)
9982 containing-sexp nil)))
9983 (setq lim (1+ containing-sexp))))
9984 (setq lim (point-min)))
9986 ;; If we're in a parenthesis list then ',' delimits the
9987 ;; "statements" rather than being an operator (with the
9988 ;; exception of the "for" clause). This difference is
9989 ;; typically only noticeable when statements are used in macro
9991 (when (and containing-sexp
9992 (eq (char-after containing-sexp) ?\())
9993 (setq c-stmt-delim-chars c-stmt-delim-chars-with-comma))
9994 ;; cache char before and after indent point, and move point to
9995 ;; the most likely position to perform the majority of tests
9996 (goto-char indent-point)
9997 (c-backward-syntactic-ws lim)
9998 (setq before-ws-ip (point)
9999 char-before-ip (char-before))
10000 (goto-char indent-point)
10001 (skip-chars-forward " \t")
10002 (setq char-after-ip (char-after))
10004 ;; are we in a literal?
10005 (setq literal (c-in-literal lim))
10007 ;; now figure out syntactic qualities of the current line
10010 ;; CASE 1: in a string.
10011 ((eq literal 'string)
10012 (c-add-syntax 'string (c-point 'bopl)))
10014 ;; CASE 2: in a C or C++ style comment.
10015 ((and (memq literal '(c c++))
10016 ;; This is a kludge for XEmacs where we use
10017 ;; `buffer-syntactic-context', which doesn't correctly
10018 ;; recognize "\*/" to end a block comment.
10019 ;; `parse-partial-sexp' which is used by
10020 ;; `c-literal-limits' will however do that in most
10021 ;; versions, which results in that we get nil from
10022 ;; `c-literal-limits' even when `c-in-literal' claims
10023 ;; we're inside a comment.
10024 (setq placeholder (c-literal-limits lim)))
10025 (c-add-syntax literal (car placeholder)))
10027 ;; CASE 3: in a cpp preprocessor macro continuation.
10028 ((and (save-excursion
10029 (when (c-beginning-of-macro)
10030 (setq macro-start (point))))
10031 (/= macro-start (c-point 'boi))
10033 (setq tmpsymbol 'cpp-macro-cont)
10034 (or (not c-syntactic-indentation-in-macros)
10036 (goto-char macro-start)
10037 ;; If at the beginning of the body of a #define
10038 ;; directive then analyze as cpp-define-intro
10039 ;; only. Go on with the syntactic analysis
10040 ;; otherwise. in-macro-expr is set if we're in a
10041 ;; cpp expression, i.e. before the #define body
10042 ;; or anywhere in a non-#define directive.
10043 (if (c-forward-to-cpp-define-body)
10044 (let ((indent-boi (c-point 'boi indent-point)))
10045 (setq in-macro-expr (> (point) indent-boi)
10046 tmpsymbol 'cpp-define-intro)
10047 (= (point) indent-boi))
10048 (setq in-macro-expr t)
10050 (c-add-syntax tmpsymbol macro-start)
10051 (setq macro-start nil))
10053 ;; CASE 11: an else clause?
10054 ((looking-at "else\\>[^_]")
10055 (c-beginning-of-statement-1 containing-sexp)
10056 (c-add-stmt-syntax 'else-clause nil t
10057 containing-sexp paren-state))
10059 ;; CASE 12: while closure of a do/while construct?
10060 ((and (looking-at "while\\>[^_]")
10062 (prog1 (eq (c-beginning-of-statement-1 containing-sexp)
10064 (setq placeholder (point)))))
10065 (goto-char placeholder)
10066 (c-add-stmt-syntax 'do-while-closure nil t
10067 containing-sexp paren-state))
10069 ;; CASE 13: A catch or finally clause? This case is simpler
10070 ;; than if-else and do-while, because a block is required
10071 ;; after every try, catch and finally.
10073 (and (cond ((c-major-mode-is 'c++-mode)
10074 (looking-at "catch\\>[^_]"))
10075 ((c-major-mode-is 'java-mode)
10076 (looking-at "\\(catch\\|finally\\)\\>[^_]")))
10077 (and (c-safe (c-backward-syntactic-ws)
10080 (eq (char-after) ?{)
10081 (c-safe (c-backward-syntactic-ws)
10084 (if (eq (char-after) ?\()
10085 (c-safe (c-backward-sexp) t)
10087 (looking-at "\\(try\\|catch\\)\\>[^_]")
10088 (setq placeholder (point))))
10089 (goto-char placeholder)
10090 (c-add-stmt-syntax 'catch-clause nil t
10091 containing-sexp paren-state))
10093 ;; CASE 18: A substatement we can recognize by keyword.
10095 (and c-opt-block-stmt-key
10096 (not (eq char-before-ip ?\;))
10097 (not (c-at-vsemi-p before-ws-ip))
10098 (not (memq char-after-ip '(?\) ?\] ?,)))
10099 (or (not (eq char-before-ip ?}))
10100 (c-looking-at-inexpr-block-backward c-state-cache))
10103 ;; Ought to cache the result from the
10104 ;; c-beginning-of-statement-1 calls here.
10105 (setq placeholder (point))
10106 (while (eq (setq step-type
10107 (c-beginning-of-statement-1 lim))
10109 (if (eq step-type 'previous)
10110 (goto-char placeholder)
10111 (setq placeholder (point))
10112 (if (and (eq step-type 'same)
10113 (not (looking-at c-opt-block-stmt-key)))
10114 ;; Step up to the containing statement if we
10115 ;; stayed in the same one.
10119 (c-beginning-of-statement-1 lim))
10122 (setq placeholder (point))
10123 ;; There was no containing statement after all.
10124 (goto-char placeholder)))))
10126 (if (looking-at c-block-stmt-2-key)
10127 ;; Require a parenthesis after these keywords.
10128 ;; Necessary to catch e.g. synchronized in Java,
10129 ;; which can be used both as statement and
10131 (and (zerop (c-forward-token-2 1 nil))
10132 (eq (char-after) ?\())
10133 (looking-at c-opt-block-stmt-key))))
10135 (if (eq step-type 'up)
10136 ;; CASE 18A: Simple substatement.
10138 (goto-char placeholder)
10140 ((eq char-after-ip ?{)
10141 (c-add-stmt-syntax 'substatement-open nil nil
10142 containing-sexp paren-state))
10144 (goto-char indent-point)
10145 (back-to-indentation)
10147 (c-add-stmt-syntax 'substatement-label nil nil
10148 containing-sexp paren-state))
10150 (c-add-stmt-syntax 'substatement nil nil
10151 containing-sexp paren-state))))
10153 ;; CASE 18B: Some other substatement. This is shared
10155 (c-guess-continued-construct indent-point
10161 ;; CASE 14: A case or default label
10163 (and (looking-at c-label-kwds-regexp)
10164 (or (c-major-mode-is 'idl-mode)
10167 (goto-char containing-sexp)
10168 (eq (char-after) ?{)
10169 (progn (c-backward-syntactic-ws) t)
10170 (eq (char-before) ?\))
10171 (c-go-list-backward)
10172 (progn (c-backward-syntactic-ws) t)
10173 (c-simple-skip-symbol-backward)
10174 (looking-at c-block-stmt-2-key)))))
10175 (if containing-sexp
10177 (goto-char containing-sexp)
10178 (setq lim (c-most-enclosing-brace c-state-cache
10180 (c-backward-to-block-anchor lim)
10181 (c-add-stmt-syntax 'case-label nil t lim paren-state))
10182 ;; Got a bogus label at the top level. In lack of better
10183 ;; alternatives, anchor it on (point-min).
10184 (c-add-syntax 'case-label (point-min))))
10186 ;; CASE 15: any other label
10188 (back-to-indentation)
10189 (and (not (looking-at c-syntactic-ws-start))
10190 (not (looking-at c-label-kwds-regexp))
10191 (c-forward-label)))
10192 (cond (containing-decl-open
10193 (setq placeholder (c-add-class-syntax 'inclass
10194 containing-decl-open
10195 containing-decl-start
10196 containing-decl-kwd
10198 ;; Append access-label with the same anchor point as
10200 (c-append-syntax 'access-label placeholder))
10203 (goto-char containing-sexp)
10204 (setq lim (c-most-enclosing-brace c-state-cache
10208 (if (and (eq (c-beginning-of-statement-1 lim) 'up)
10209 (looking-at "switch\\>[^_]"))
10210 ;; If the surrounding statement is a switch then
10211 ;; let's analyze all labels as switch labels, so
10212 ;; that they get lined up consistently.
10215 (c-backward-to-block-anchor lim)
10216 (c-add-stmt-syntax tmpsymbol nil t lim paren-state))
10219 ;; A label on the top level. Treat it as a class
10220 ;; context. (point-min) is the closest we get to the
10221 ;; class open brace.
10222 (c-add-syntax 'access-label (point-min)))))
10224 ;; CASE 4: In-expression statement. C.f. cases 7B, 16A and
10226 ((setq placeholder (c-looking-at-inexpr-block
10227 (c-safe-position containing-sexp paren-state)
10229 ;; Have to turn on the heuristics after
10230 ;; the point even though it doesn't work
10231 ;; very well. C.f. test case class-16.pike.
10233 (setq tmpsymbol (assq (car placeholder)
10234 '((inexpr-class . class-open)
10235 (inexpr-statement . block-open))))
10237 ;; It's a statement block or an anonymous class.
10238 (setq tmpsymbol (cdr tmpsymbol))
10239 ;; It's a Pike lambda. Check whether we are between the
10240 ;; lambda keyword and the argument list or at the defun
10242 (setq tmpsymbol (if (eq char-after-ip ?{)
10244 'lambda-intro-cont)))
10245 (goto-char (cdr placeholder))
10246 (back-to-indentation)
10247 (c-add-stmt-syntax tmpsymbol nil t
10248 (c-most-enclosing-brace c-state-cache (point))
10250 (unless (eq (point) (cdr placeholder))
10251 (c-add-syntax (car placeholder))))
10253 ;; CASE 5: Line is inside a declaration level block or at top level.
10254 ((or containing-decl-open (null containing-sexp))
10257 ;; CASE 5A: we are looking at a defun, brace list, class,
10258 ;; or inline-inclass method opening brace
10259 ((setq special-brace-list
10260 (or (and c-special-brace-lists
10261 (c-looking-at-special-brace-list))
10262 (eq char-after-ip ?{)))
10265 ;; CASE 5A.1: Non-class declaration block open.
10268 (and (eq char-after-ip ?{)
10269 (setq tmp (c-looking-at-decl-block containing-sexp t))
10271 (setq placeholder (point))
10273 (looking-at c-symbol-key))
10275 (c-keyword-sym (setq keyword (match-string 0)))
10276 'c-other-block-decl-kwds))))
10277 (goto-char placeholder)
10279 (if (string-equal keyword "extern")
10280 ;; Special case for extern-lang-open.
10282 (intern (concat keyword "-open")))
10283 nil t containing-sexp paren-state))
10285 ;; CASE 5A.2: we are looking at a class opening brace
10287 (goto-char indent-point)
10288 (skip-chars-forward " \t")
10289 (and (eq (char-after) ?{)
10290 (c-looking-at-decl-block containing-sexp t)
10291 (setq placeholder (point))))
10292 (c-add-syntax 'class-open placeholder))
10294 ;; CASE 5A.3: brace list open
10296 (c-beginning-of-decl-1 lim)
10298 ((looking-at c-specifier-key)
10299 (c-forward-keyword-clause 1))
10300 ((looking-at c-noise-macro-with-parens-name-re)
10301 (c-forward-noise-clause))))
10302 (setq placeholder (c-point 'boi))
10303 (or (consp special-brace-list)
10304 (and (or (save-excursion
10305 (goto-char indent-point)
10306 (setq tmpsymbol nil)
10307 (while (and (> (point) placeholder)
10308 (zerop (c-backward-token-2 1 t))
10309 (not (looking-at "=\\([^=]\\|$\\)")))
10310 (and c-opt-inexpr-brace-list-key
10312 (looking-at c-opt-inexpr-brace-list-key)
10313 (setq tmpsymbol 'topmost-intro-cont)))
10314 (looking-at "=\\([^=]\\|$\\)"))
10315 (looking-at c-brace-list-key))
10317 (while (and (< (point) indent-point)
10318 (zerop (c-forward-token-2 1 t))
10319 (not (memq (char-after) '(?\; ?\()))))
10320 (not (memq (char-after) '(?\; ?\()))
10322 (if (and (not c-auto-newline-analysis)
10323 (c-major-mode-is 'java-mode)
10324 (eq tmpsymbol 'topmost-intro-cont))
10325 ;; We're in Java and have found that the open brace
10326 ;; belongs to a "new Foo[]" initialization list,
10327 ;; which means the brace list is part of an
10328 ;; expression and not a top level definition. We
10329 ;; therefore treat it as any topmost continuation
10330 ;; even though the semantically correct symbol still
10331 ;; is brace-list-open, on the same grounds as in
10334 (c-beginning-of-statement-1 lim)
10335 (c-add-syntax 'topmost-intro-cont (c-point 'boi)))
10336 (c-add-syntax 'brace-list-open placeholder)))
10338 ;; CASE 5A.4: inline defun open
10339 ((and containing-decl-open
10340 (not (c-keyword-member containing-decl-kwd
10341 'c-other-block-decl-kwds)))
10342 (c-add-syntax 'inline-open)
10343 (c-add-class-syntax 'inclass
10344 containing-decl-open
10345 containing-decl-start
10346 containing-decl-kwd
10349 ;; CASE 5A.5: ordinary defun open
10352 (c-beginning-of-decl-1 lim)
10354 ((looking-at c-specifier-key)
10355 (c-forward-keyword-clause 1))
10356 ((looking-at c-noise-macro-with-parens-name-re)
10357 (c-forward-noise-clause))))
10358 (c-add-syntax 'defun-open (c-point 'boi))
10359 ;; Bogus to use bol here, but it's the legacy. (Resolved,
10363 ;; CASE 5R: Member init list. (Used to be part of CASE 5B.1)
10364 ;; Note there is no limit on the backward search here, since member
10365 ;; init lists can, in practice, be very large.
10367 (when (and (c-major-mode-is 'c++-mode)
10368 (setq placeholder (c-back-over-member-initializers)))
10369 (setq tmp-pos (point))))
10370 (if (= (c-point 'bosws) (1+ tmp-pos))
10372 ;; There is no preceding member init clause.
10373 ;; Indent relative to the beginning of indentation
10374 ;; for the topmost-intro line that contains the
10375 ;; prototype's open paren.
10376 (goto-char placeholder)
10377 (c-add-syntax 'member-init-intro (c-point 'boi)))
10378 ;; Indent relative to the first member init clause.
10379 (goto-char (1+ tmp-pos))
10380 (c-forward-syntactic-ws)
10381 (c-add-syntax 'member-init-cont (point))))
10383 ;; CASE 5B: After a function header but before the body (or
10384 ;; the ending semicolon if there's no body).
10386 (when (setq placeholder (c-just-after-func-arglist-p
10387 (max lim (c-determine-limit 500))))
10388 (setq tmp-pos (point))))
10391 ;; CASE 5B.1: Member init list.
10392 ((eq (char-after tmp-pos) ?:)
10393 ;; There is no preceding member init clause.
10394 ;; Indent relative to the beginning of indentation
10395 ;; for the topmost-intro line that contains the
10396 ;; prototype's open paren.
10397 (goto-char placeholder)
10398 (c-add-syntax 'member-init-intro (c-point 'boi)))
10400 ;; CASE 5B.2: K&R arg decl intro
10401 ((and c-recognize-knr-p
10402 (c-in-knr-argdecl lim))
10403 (c-beginning-of-statement-1 lim)
10404 (c-add-syntax 'knr-argdecl-intro (c-point 'boi))
10405 (if containing-decl-open
10406 (c-add-class-syntax 'inclass
10407 containing-decl-open
10408 containing-decl-start
10409 containing-decl-kwd
10412 ;; CASE 5B.4: Nether region after a C++ or Java func
10413 ;; decl, which could include a `throws' declaration.
10415 (c-beginning-of-statement-1 lim)
10416 (c-add-syntax 'func-decl-cont (c-point 'boi))
10419 ;; CASE 5C: inheritance line. could be first inheritance
10420 ;; line, or continuation of a multiple inheritance
10421 ((or (and (c-major-mode-is 'c++-mode)
10423 (when (eq char-after-ip ?,)
10424 (skip-chars-forward " \t")
10426 (looking-at c-opt-postfix-decl-spec-key)))
10427 (and (or (eq char-before-ip ?:)
10428 ;; watch out for scope operator
10430 (and (eq char-after-ip ?:)
10431 (c-safe (forward-char 1) t)
10432 (not (eq (char-after) ?:))
10435 (c-beginning-of-statement-1 lim)
10436 (when (looking-at c-opt-<>-sexp-key)
10437 (goto-char (match-end 1))
10438 (c-forward-syntactic-ws)
10439 (c-forward-<>-arglist nil)
10440 (c-forward-syntactic-ws))
10441 (looking-at c-class-key)))
10443 (and (c-major-mode-is 'java-mode)
10444 (let ((fence (save-excursion
10445 (c-beginning-of-statement-1 lim)
10450 (cond ((looking-at c-opt-postfix-decl-spec-key)
10451 (setq injava-inher (cons cont (point))
10453 ((or (not (c-safe (c-forward-sexp -1) t))
10454 (<= (point) fence))
10459 (not (c-crosses-statement-barrier-p (cdr injava-inher)
10464 ;; CASE 5C.1: non-hanging colon on an inher intro
10465 ((eq char-after-ip ?:)
10466 (c-beginning-of-statement-1 lim)
10467 (c-add-syntax 'inher-intro (c-point 'boi))
10468 ;; don't add inclass symbol since relative point already
10469 ;; contains any class offset
10472 ;; CASE 5C.2: hanging colon on an inher intro
10473 ((eq char-before-ip ?:)
10474 (c-beginning-of-statement-1 lim)
10475 (c-add-syntax 'inher-intro (c-point 'boi))
10476 (if containing-decl-open
10477 (c-add-class-syntax 'inclass
10478 containing-decl-open
10479 containing-decl-start
10480 containing-decl-kwd
10483 ;; CASE 5C.3: in a Java implements/extends
10485 (let ((where (cdr injava-inher))
10486 (cont (car injava-inher)))
10488 (cond ((looking-at "throws\\>[^_]")
10489 (c-add-syntax 'func-decl-cont
10490 (progn (c-beginning-of-statement-1 lim)
10492 (cont (c-add-syntax 'inher-cont where))
10493 (t (c-add-syntax 'inher-intro
10494 (progn (goto-char (cdr injava-inher))
10495 (c-beginning-of-statement-1 lim)
10499 ;; CASE 5C.4: a continued inheritance line
10501 (c-beginning-of-inheritance-list lim)
10502 (c-add-syntax 'inher-cont (point))
10503 ;; don't add inclass symbol since relative point already
10504 ;; contains any class offset
10507 ;; CASE 5P: AWK pattern or function or continuation
10509 ((c-major-mode-is 'awk-mode)
10510 (setq placeholder (point))
10512 (if (and (eq (c-beginning-of-statement-1) 'same)
10513 (/= (point) placeholder))
10514 'topmost-intro-cont
10517 containing-sexp paren-state))
10519 ;; CASE 5D: this could be a top-level initialization, a
10520 ;; member init list continuation, or a template argument
10521 ;; list continuation.
10523 ;; Note: We use the fact that lim is always after any
10524 ;; preceding brace sexp.
10525 (if c-recognize-<>-arglists
10528 (c-syntactic-skip-backward "^;,=<>" lim t)
10531 (when c-overloadable-operators-regexp
10532 (when (setq placeholder (c-after-special-operator-id lim))
10533 (goto-char placeholder)
10536 ((eq (char-before) ?>)
10537 (or (c-backward-<>-arglist nil lim)
10540 ((eq (char-before) ?<)
10542 (if (save-excursion
10543 (c-forward-<>-arglist nil))
10544 (progn (forward-char)
10548 ;; NB: No c-after-special-operator-id stuff in this
10549 ;; clause - we assume only C++ needs it.
10550 (c-syntactic-skip-backward "^;,=" lim t))
10551 (memq (char-before) '(?, ?= ?<)))
10554 ;; CASE 5D.3: perhaps a template list continuation?
10555 ((and (c-major-mode-is 'c++-mode)
10558 (c-with-syntax-table c++-template-syntax-table
10559 (goto-char indent-point)
10560 (setq placeholder (c-up-list-backward))
10562 (eq (char-after placeholder) ?<))))))
10563 (c-with-syntax-table c++-template-syntax-table
10564 (goto-char placeholder)
10565 (c-beginning-of-statement-1 lim t))
10566 (if (save-excursion
10567 (c-backward-syntactic-ws lim)
10568 (eq (char-before) ?<))
10569 ;; In a nested template arglist.
10571 (goto-char placeholder)
10572 (c-syntactic-skip-backward "^,;" lim t)
10573 (c-forward-syntactic-ws))
10574 (back-to-indentation))
10575 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
10577 (c-add-syntax 'template-args-cont (point) placeholder))
10579 ;; CASE 5D.4: perhaps a multiple inheritance line?
10580 ((and (c-major-mode-is 'c++-mode)
10582 (c-beginning-of-statement-1 lim)
10583 (setq placeholder (point))
10584 (if (looking-at "static\\>[^_]")
10585 (c-forward-token-2 1 nil indent-point))
10586 (and (looking-at c-class-key)
10587 (zerop (c-forward-token-2 2 nil indent-point))
10588 (if (eq (char-after) ?<)
10589 (c-with-syntax-table c++-template-syntax-table
10590 (zerop (c-forward-token-2 1 t indent-point)))
10592 (eq (char-after) ?:))))
10593 (goto-char placeholder)
10594 (c-add-syntax 'inher-cont (c-point 'boi)))
10596 ;; CASE 5D.5: Continuation of the "expression part" of a
10597 ;; top level construct. Or, perhaps, an unrecognized construct.
10599 (while (and (setq placeholder (point))
10600 (eq (car (c-beginning-of-decl-1 containing-sexp)) ; Can't use `lim' here.
10603 (c-backward-syntactic-ws)
10604 (eq (char-before) ?}))
10605 (< (point) placeholder)))
10608 ((eq (point) placeholder) 'statement) ; unrecognized construct
10609 ;; A preceding comma at the top level means that a
10610 ;; new variable declaration starts here. Use
10611 ;; topmost-intro-cont for it, for consistency with
10612 ;; the first variable declaration. C.f. case 5N.
10613 ((eq char-before-ip ?,) 'topmost-intro-cont)
10614 (t 'statement-cont))
10615 nil nil containing-sexp paren-state))
10618 ;; CASE 5F: Close of a non-class declaration level block.
10619 ((and (eq char-after-ip ?})
10620 (c-keyword-member containing-decl-kwd
10621 'c-other-block-decl-kwds))
10622 ;; This is inconsistent: Should use `containing-decl-open'
10623 ;; here if it's at boi, like in case 5J.
10624 (goto-char containing-decl-start)
10626 (if (string-equal (symbol-name containing-decl-kwd) "extern")
10627 ;; Special case for compatibility with the
10628 ;; extern-lang syntactic symbols.
10630 (intern (concat (symbol-name containing-decl-kwd)
10633 (c-most-enclosing-brace paren-state (point))
10636 ;; CASE 5G: we are looking at the brace which closes the
10637 ;; enclosing nested class decl
10638 ((and containing-sexp
10639 (eq char-after-ip ?})
10640 (eq containing-decl-open containing-sexp))
10641 (c-add-class-syntax 'class-close
10642 containing-decl-open
10643 containing-decl-start
10644 containing-decl-kwd
10647 ;; CASE 5H: we could be looking at subsequent knr-argdecls
10648 ((and c-recognize-knr-p
10649 (not containing-sexp) ; can't be knr inside braces.
10650 (not (eq char-before-ip ?}))
10652 (setq placeholder (cdr (c-beginning-of-decl-1 lim)))
10654 ;; Do an extra check to avoid tripping up on
10655 ;; statements that occur in invalid contexts
10656 ;; (e.g. in macro bodies where we don't really
10657 ;; know the context of what we're looking at).
10658 (not (and c-opt-block-stmt-key
10659 (looking-at c-opt-block-stmt-key)))))
10660 (< placeholder indent-point))
10661 (goto-char placeholder)
10662 (c-add-syntax 'knr-argdecl (point)))
10664 ;; CASE 5I: ObjC method definition.
10665 ((and c-opt-method-key
10666 (looking-at c-opt-method-key))
10667 (c-beginning-of-statement-1 nil t)
10668 (if (= (point) indent-point)
10669 ;; Handle the case when it's the first (non-comment)
10670 ;; thing in the buffer. Can't look for a 'same return
10671 ;; value from cbos1 since ObjC directives currently
10672 ;; aren't recognized fully, so that we get 'same
10673 ;; instead of 'previous if it moved over a preceding
10675 (goto-char (point-min)))
10676 (c-add-syntax 'objc-method-intro (c-point 'boi)))
10678 ;; CASE 5N: At a variable declaration that follows a class
10679 ;; definition or some other block declaration that doesn't
10680 ;; end at the closing '}'. C.f. case 5D.5.
10682 (c-backward-syntactic-ws lim)
10683 (and (eq (char-before) ?})
10685 (let ((start (point)))
10686 (if (and c-state-cache
10687 (consp (car c-state-cache))
10688 (eq (cdar c-state-cache) (point)))
10689 ;; Speed up the backward search a bit.
10690 (goto-char (caar c-state-cache)))
10691 (c-beginning-of-decl-1 containing-sexp) ; Can't use `lim' here.
10692 (setq placeholder (point))
10693 (if (= start (point))
10694 ;; The '}' is unbalanced.
10697 (>= (point) indent-point))))))
10698 (goto-char placeholder)
10699 (c-add-stmt-syntax 'topmost-intro-cont nil nil
10700 containing-sexp paren-state))
10702 ;; NOTE: The point is at the end of the previous token here.
10704 ;; CASE 5J: we are at the topmost level, make
10705 ;; sure we skip back past any access specifiers
10707 ;; A macro continuation line is never at top level.
10708 (not (and macro-start
10709 (> indent-point macro-start)))
10711 (setq placeholder (point))
10712 (or (memq char-before-ip '(?\; ?{ ?} nil))
10713 (c-at-vsemi-p before-ws-ip)
10714 (when (and (eq char-before-ip ?:)
10715 (eq (c-beginning-of-statement-1 lim)
10717 (c-backward-syntactic-ws lim)
10718 (setq placeholder (point)))
10719 (and (c-major-mode-is 'objc-mode)
10720 (catch 'not-in-directive
10721 (c-beginning-of-statement-1 lim)
10722 (setq placeholder (point))
10723 (while (and (c-forward-objc-directive)
10724 (< (point) indent-point))
10725 (c-forward-syntactic-ws)
10726 (if (>= (point) indent-point)
10727 (throw 'not-in-directive t))
10728 (setq placeholder (point)))
10730 ;; For historic reasons we anchor at bol of the last
10731 ;; line of the previous declaration. That's clearly
10732 ;; highly bogus and useless, and it makes our lives hard
10733 ;; to remain compatible. :P
10734 (goto-char placeholder)
10735 (c-add-syntax 'topmost-intro (c-point 'bol))
10736 (if containing-decl-open
10737 (if (c-keyword-member containing-decl-kwd
10738 'c-other-block-decl-kwds)
10740 (goto-char (c-brace-anchor-point containing-decl-open))
10742 (if (string-equal (symbol-name containing-decl-kwd)
10744 ;; Special case for compatibility with the
10745 ;; extern-lang syntactic symbols.
10747 (intern (concat "in"
10748 (symbol-name containing-decl-kwd))))
10750 (c-most-enclosing-brace paren-state (point))
10752 (c-add-class-syntax 'inclass
10753 containing-decl-open
10754 containing-decl-start
10755 containing-decl-kwd
10757 (when (and c-syntactic-indentation-in-macros
10759 (/= macro-start (c-point 'boi indent-point)))
10760 (c-add-syntax 'cpp-define-intro)
10761 (setq macro-start nil)))
10763 ;; CASE 5K: we are at an ObjC method definition
10764 ;; continuation line.
10765 ((and c-opt-method-key
10767 (c-beginning-of-statement-1 lim)
10768 (beginning-of-line)
10769 (when (looking-at c-opt-method-key)
10770 (setq placeholder (point)))))
10771 (c-add-syntax 'objc-method-args-cont placeholder))
10773 ;; CASE 5L: we are at the first argument of a template
10774 ;; arglist that begins on the previous line.
10775 ((and c-recognize-<>-arglists
10776 (eq (char-before) ?<)
10777 (not (and c-overloadable-operators-regexp
10778 (c-after-special-operator-id lim))))
10779 (c-beginning-of-statement-1 (c-safe-position (point) paren-state))
10780 (c-add-syntax 'template-args-cont (c-point 'boi)))
10782 ;; CASE 5Q: we are at a statement within a macro.
10784 (c-beginning-of-statement-1 containing-sexp)
10785 (c-add-stmt-syntax 'statement nil t containing-sexp paren-state))
10787 ;;CASE 5N: We are at a topmost continuation line and the only
10788 ;;preceding items are annotations.
10789 ((and (c-major-mode-is 'java-mode)
10790 (setq placeholder (point))
10791 (c-beginning-of-statement-1)
10793 (while (and (c-forward-annotation))
10794 (c-forward-syntactic-ws))
10797 (>= (point) placeholder)
10798 (goto-char placeholder)))
10799 (c-add-syntax 'annotation-top-cont (c-point 'boi)))
10801 ;; CASE 5M: we are at a topmost continuation line
10803 (c-beginning-of-statement-1 (c-safe-position (point) paren-state))
10804 (when (c-major-mode-is 'objc-mode)
10805 (setq placeholder (point))
10806 (while (and (c-forward-objc-directive)
10807 (< (point) indent-point))
10808 (c-forward-syntactic-ws)
10809 (setq placeholder (point)))
10810 (goto-char placeholder))
10811 (c-add-syntax 'topmost-intro-cont (c-point 'boi)))
10814 ;; (CASE 6 has been removed.)
10816 ;; CASE 7: line is an expression, not a statement. Most
10817 ;; likely we are either in a function prototype or a function
10818 ;; call argument list
10819 ((not (or (and c-special-brace-lists
10821 (goto-char containing-sexp)
10822 (c-looking-at-special-brace-list)))
10823 (eq (char-after containing-sexp) ?{)))
10826 ;; CASE 7A: we are looking at the arglist closing paren.
10828 ((memq char-after-ip '(?\) ?\]))
10829 (goto-char containing-sexp)
10830 (setq placeholder (c-point 'boi))
10831 (if (and (c-safe (backward-up-list 1) t)
10832 (>= (point) placeholder))
10835 (skip-chars-forward " \t"))
10836 (goto-char placeholder))
10837 (c-add-stmt-syntax 'arglist-close (list containing-sexp) t
10838 (c-most-enclosing-brace paren-state (point))
10841 ;; CASE 7B: Looking at the opening brace of an
10842 ;; in-expression block or brace list. C.f. cases 4, 16A
10844 ((and (eq char-after-ip ?{)
10846 (setq placeholder (c-inside-bracelist-p (point)
10849 (setq tmpsymbol '(brace-list-open . inexpr-class))
10850 (setq tmpsymbol '(block-open . inexpr-statement)
10852 (cdr-safe (c-looking-at-inexpr-block
10853 (c-safe-position containing-sexp
10856 ;; placeholder is nil if it's a block directly in
10857 ;; a function arglist. That makes us skip out of
10860 (goto-char placeholder)
10861 (back-to-indentation)
10862 (c-add-stmt-syntax (car tmpsymbol) nil t
10863 (c-most-enclosing-brace paren-state (point))
10865 (if (/= (point) placeholder)
10866 (c-add-syntax (cdr tmpsymbol))))
10868 ;; CASE 7C: we are looking at the first argument in an empty
10869 ;; argument list. Use arglist-close if we're actually
10870 ;; looking at a close paren or bracket.
10871 ((memq char-before-ip '(?\( ?\[))
10872 (goto-char containing-sexp)
10873 (setq placeholder (c-point 'boi))
10874 (if (and (c-safe (backward-up-list 1) t)
10875 (>= (point) placeholder))
10878 (skip-chars-forward " \t"))
10879 (goto-char placeholder))
10880 (c-add-stmt-syntax 'arglist-intro (list containing-sexp) t
10881 (c-most-enclosing-brace paren-state (point))
10884 ;; CASE 7D: we are inside a conditional test clause. treat
10885 ;; these things as statements
10887 (goto-char containing-sexp)
10888 (and (c-safe (c-forward-sexp -1) t)
10889 (looking-at "\\<for\\>[^_]")))
10890 (goto-char (1+ containing-sexp))
10891 (c-forward-syntactic-ws indent-point)
10892 (if (eq char-before-ip ?\;)
10893 (c-add-syntax 'statement (point))
10894 (c-add-syntax 'statement-cont (point))
10897 ;; CASE 7E: maybe a continued ObjC method call. This is the
10898 ;; case when we are inside a [] bracketed exp, and what
10899 ;; precede the opening bracket is not an identifier.
10900 ((and c-opt-method-key
10901 (eq (char-after containing-sexp) ?\[)
10903 (goto-char (1- containing-sexp))
10904 (c-backward-syntactic-ws (c-point 'bod))
10905 (if (not (looking-at c-symbol-key))
10906 (c-add-syntax 'objc-method-call-cont containing-sexp))
10909 ;; CASE 7F: we are looking at an arglist continuation line,
10910 ;; but the preceding argument is on the same line as the
10911 ;; opening paren. This case includes multi-line
10912 ;; mathematical paren groupings, but we could be on a
10913 ;; for-list continuation line. C.f. case 7A.
10915 (goto-char (1+ containing-sexp))
10917 (c-forward-syntactic-ws)
10920 (goto-char containing-sexp) ; paren opening the arglist
10921 (setq placeholder (c-point 'boi))
10922 (if (and (c-safe (backward-up-list 1) t)
10923 (>= (point) placeholder))
10926 (skip-chars-forward " \t"))
10927 (goto-char placeholder))
10928 (c-add-stmt-syntax 'arglist-cont-nonempty (list containing-sexp) t
10929 (c-most-enclosing-brace c-state-cache (point))
10932 ;; CASE 7G: we are looking at just a normal arglist
10933 ;; continuation line
10934 (t (c-forward-syntactic-ws indent-point)
10935 (c-add-syntax 'arglist-cont (c-point 'boi)))
10938 ;; CASE 8: func-local multi-inheritance line
10939 ((and (c-major-mode-is 'c++-mode)
10941 (goto-char indent-point)
10942 (skip-chars-forward " \t")
10943 (looking-at c-opt-postfix-decl-spec-key)))
10944 (goto-char indent-point)
10945 (skip-chars-forward " \t")
10948 ;; CASE 8A: non-hanging colon on an inher intro
10949 ((eq char-after-ip ?:)
10950 (c-backward-syntactic-ws lim)
10951 (c-add-syntax 'inher-intro (c-point 'boi)))
10953 ;; CASE 8B: hanging colon on an inher intro
10954 ((eq char-before-ip ?:)
10955 (c-add-syntax 'inher-intro (c-point 'boi)))
10957 ;; CASE 8C: a continued inheritance line
10959 (c-beginning-of-inheritance-list lim)
10960 (c-add-syntax 'inher-cont (point))
10963 ;; CASE 9: we are inside a brace-list
10964 ((and (not (c-major-mode-is 'awk-mode)) ; Maybe this isn't needed (ACM, 2002/3/29)
10965 (setq special-brace-list
10966 (or (and c-special-brace-lists ;;;; ALWAYS NIL FOR AWK!!
10968 (goto-char containing-sexp)
10969 (c-looking-at-special-brace-list)))
10970 (c-inside-bracelist-p containing-sexp paren-state))))
10973 ;; CASE 9A: In the middle of a special brace list opener.
10974 ((and (consp special-brace-list)
10976 (goto-char containing-sexp)
10977 (eq (char-after) ?\())
10978 (eq char-after-ip (car (cdr special-brace-list))))
10979 (goto-char (car (car special-brace-list)))
10980 (skip-chars-backward " \t")
10982 (assoc 'statement-cont
10983 (setq placeholder (c-guess-basic-syntax))))
10984 (setq c-syntactic-context placeholder)
10985 (c-beginning-of-statement-1
10986 (c-safe-position (1- containing-sexp) paren-state))
10987 (c-forward-token-2 0)
10989 ((looking-at c-specifier-key)
10990 (c-forward-keyword-clause 1))
10991 ((looking-at c-noise-macro-with-parens-name-re)
10992 (c-forward-noise-clause))))
10993 (c-add-syntax 'brace-list-open (c-point 'boi))))
10995 ;; CASE 9B: brace-list-close brace
10996 ((if (consp special-brace-list)
10997 ;; Check special brace list closer.
10999 (goto-char (car (car special-brace-list)))
11001 (goto-char indent-point)
11002 (back-to-indentation)
11004 ;; We were between the special close char and the `)'.
11005 (and (eq (char-after) ?\))
11006 (eq (1+ (point)) (cdr (car special-brace-list))))
11007 ;; We were before the special close char.
11008 (and (eq (char-after) (cdr (cdr special-brace-list)))
11009 (zerop (c-forward-token-2))
11010 (eq (1+ (point)) (cdr (car special-brace-list)))))))
11011 ;; Normal brace list check.
11012 (and (eq char-after-ip ?})
11013 (c-safe (goto-char (c-up-list-backward (point))) t)
11014 (= (point) containing-sexp)))
11015 (if (eq (point) (c-point 'boi))
11016 (c-add-syntax 'brace-list-close (point))
11017 (setq lim (c-most-enclosing-brace c-state-cache (point)))
11018 (c-beginning-of-statement-1 lim nil nil t)
11019 (c-add-stmt-syntax 'brace-list-close nil t lim paren-state)))
11022 ;; Prepare for the rest of the cases below by going to the
11023 ;; token following the opening brace
11024 (if (consp special-brace-list)
11026 (goto-char (car (car special-brace-list)))
11027 (c-forward-token-2 1 nil indent-point))
11028 (goto-char containing-sexp))
11030 (let ((start (point)))
11031 (c-forward-syntactic-ws indent-point)
11032 (goto-char (max start (c-point 'bol))))
11033 (c-skip-ws-forward indent-point)
11036 ;; CASE 9C: we're looking at the first line in a brace-list
11037 ((= (point) indent-point)
11038 (if (consp special-brace-list)
11039 (goto-char (car (car special-brace-list)))
11040 (goto-char containing-sexp))
11041 (if (eq (point) (c-point 'boi))
11042 (c-add-syntax 'brace-list-intro (point))
11043 (setq lim (c-most-enclosing-brace c-state-cache (point)))
11044 (c-beginning-of-statement-1 lim)
11045 (c-add-stmt-syntax 'brace-list-intro nil t lim paren-state)))
11047 ;; CASE 9D: this is just a later brace-list-entry or
11048 ;; brace-entry-open
11049 (t (if (or (eq char-after-ip ?{)
11050 (and c-special-brace-lists
11052 (goto-char indent-point)
11053 (c-forward-syntactic-ws (c-point 'eol))
11054 (c-looking-at-special-brace-list (point)))))
11055 (c-add-syntax 'brace-entry-open (point))
11056 (c-add-syntax 'brace-list-entry (point))
11060 ;; CASE 10: A continued statement or top level construct.
11061 ((and (not (memq char-before-ip '(?\; ?:)))
11062 (not (c-at-vsemi-p before-ws-ip))
11063 (or (not (eq char-before-ip ?}))
11064 (c-looking-at-inexpr-block-backward c-state-cache))
11067 (c-beginning-of-statement-1 containing-sexp)
11068 (setq placeholder (point))))
11069 (/= placeholder containing-sexp))
11070 ;; This is shared with case 18.
11071 (c-guess-continued-construct indent-point
11077 ;; CASE 16: block close brace, possibly closing the defun or
11079 ((eq char-after-ip ?})
11080 ;; From here on we have the next containing sexp in lim.
11081 (setq lim (c-most-enclosing-brace paren-state))
11082 (goto-char containing-sexp)
11085 ;; CASE 16E: Closing a statement block? This catches
11086 ;; cases where it's preceded by a statement keyword,
11087 ;; which works even when used in an "invalid" context,
11088 ;; e.g. a macro argument.
11089 ((c-after-conditional)
11090 (c-backward-to-block-anchor lim)
11091 (c-add-stmt-syntax 'block-close nil t lim paren-state))
11093 ;; CASE 16A: closing a lambda defun or an in-expression
11094 ;; block? C.f. cases 4, 7B and 17E.
11095 ((setq placeholder (c-looking-at-inexpr-block
11096 (c-safe-position containing-sexp paren-state)
11098 (setq tmpsymbol (if (eq (car placeholder) 'inlambda)
11101 (goto-char containing-sexp)
11102 (back-to-indentation)
11103 (if (= containing-sexp (point))
11104 (c-add-syntax tmpsymbol (point))
11105 (goto-char (cdr placeholder))
11106 (back-to-indentation)
11107 (c-add-stmt-syntax tmpsymbol nil t
11108 (c-most-enclosing-brace paren-state (point))
11110 (if (/= (point) (cdr placeholder))
11111 (c-add-syntax (car placeholder)))))
11113 ;; CASE 16B: does this close an inline or a function in
11114 ;; a non-class declaration level block?
11119 (c-looking-at-decl-block
11120 (c-most-enclosing-brace paren-state lim)
11122 (setq placeholder (point))))
11123 (c-backward-to-decl-anchor lim)
11124 (back-to-indentation)
11125 (if (save-excursion
11126 (goto-char placeholder)
11127 (looking-at c-other-decl-block-key))
11128 (c-add-syntax 'defun-close (point))
11129 (c-add-syntax 'inline-close (point))))
11131 ;; CASE 16F: Can be a defun-close of a function declared
11132 ;; in a statement block, e.g. in Pike or when using gcc
11133 ;; extensions, but watch out for macros followed by
11134 ;; blocks. Let it through to be handled below.
11135 ;; C.f. cases B.3 and 17G.
11137 (and (not (c-at-statement-start-p))
11138 (eq (c-beginning-of-statement-1 lim nil nil t) 'same)
11139 (setq placeholder (point))
11140 (let ((c-recognize-typeless-decls nil))
11141 ;; Turn off recognition of constructs that
11142 ;; lacks a type in this case, since that's more
11143 ;; likely to be a macro followed by a block.
11144 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
11145 (back-to-indentation)
11146 (if (/= (point) containing-sexp)
11147 (goto-char placeholder))
11148 (c-add-stmt-syntax 'defun-close nil t lim paren-state))
11150 ;; CASE 16C: If there is an enclosing brace then this is
11151 ;; a block close since defun closes inside declaration
11152 ;; level blocks have been handled above.
11154 ;; If the block is preceded by a case/switch label on
11155 ;; the same line, we anchor at the first preceding label
11156 ;; at boi. The default handling in c-add-stmt-syntax
11157 ;; really fixes it better, but we do like this to keep
11158 ;; the indentation compatible with version 5.28 and
11159 ;; earlier. C.f. case 17H.
11160 (while (and (/= (setq placeholder (point)) (c-point 'boi))
11161 (eq (c-beginning-of-statement-1 lim) 'label)))
11162 (goto-char placeholder)
11163 (if (looking-at c-label-kwds-regexp)
11164 (c-add-syntax 'block-close (point))
11165 (goto-char containing-sexp)
11166 ;; c-backward-to-block-anchor not necessary here; those
11167 ;; situations are handled in case 16E above.
11168 (c-add-stmt-syntax 'block-close nil t lim paren-state)))
11170 ;; CASE 16D: Only top level defun close left.
11172 (goto-char containing-sexp)
11173 (c-backward-to-decl-anchor lim)
11174 (c-add-stmt-syntax 'defun-close nil nil
11175 (c-most-enclosing-brace paren-state)
11179 ;; CASE 19: line is an expression, not a statement, and is directly
11180 ;; contained by a template delimiter. Most likely, we are in a
11181 ;; template arglist within a statement. This case is based on CASE
11182 ;; 7. At some point in the future, we may wish to create more
11183 ;; syntactic symbols such as `template-intro',
11184 ;; `template-cont-nonempty', etc., and distinguish between them as we
11185 ;; do for `arglist-intro' etc. (2009-12-07).
11186 ((and c-recognize-<>-arglists
11187 (setq containing-< (c-up-list-backward indent-point containing-sexp))
11188 (eq (char-after containing-<) ?\<))
11189 (setq placeholder (c-point 'boi containing-<))
11190 (goto-char containing-sexp) ; Most nested Lbrace/Lparen (but not
11191 ; '<') before indent-point.
11192 (if (>= (point) placeholder)
11195 (skip-chars-forward " \t"))
11196 (goto-char placeholder))
11197 (c-add-stmt-syntax 'template-args-cont (list containing-<) t
11198 (c-most-enclosing-brace c-state-cache (point))
11201 ;; CASE 17: Statement or defun catchall.
11203 (goto-char indent-point)
11204 ;; Back up statements until we find one that starts at boi.
11205 (while (let* ((prev-point (point))
11206 (last-step-type (c-beginning-of-statement-1
11208 (if (= (point) prev-point)
11210 (setq step-type (or step-type last-step-type))
11212 (setq step-type last-step-type)
11213 (/= (point) (c-point 'boi)))))
11216 ;; CASE 17B: continued statement
11217 ((and (eq step-type 'same)
11218 (/= (point) indent-point))
11219 (c-add-stmt-syntax 'statement-cont nil nil
11220 containing-sexp paren-state))
11222 ;; CASE 17A: After a case/default label?
11224 (while (and (eq step-type 'label)
11225 (not (looking-at c-label-kwds-regexp)))
11227 (c-beginning-of-statement-1 containing-sexp)))
11228 (eq step-type 'label))
11229 (c-add-stmt-syntax (if (eq char-after-ip ?{)
11230 'statement-case-open
11231 'statement-case-intro)
11232 nil t containing-sexp paren-state))
11234 ;; CASE 17D: any old statement
11236 (while (eq step-type 'label)
11238 (c-beginning-of-statement-1 containing-sexp)))
11239 (eq step-type 'previous))
11240 (c-add-stmt-syntax 'statement nil t
11241 containing-sexp paren-state)
11242 (if (eq char-after-ip ?{)
11243 (c-add-syntax 'block-open)))
11245 ;; CASE 17I: Inside a substatement block.
11247 ;; The following tests are all based on containing-sexp.
11248 (goto-char containing-sexp)
11249 ;; From here on we have the next containing sexp in lim.
11250 (setq lim (c-most-enclosing-brace paren-state containing-sexp))
11251 (c-after-conditional))
11252 (c-backward-to-block-anchor lim)
11253 (c-add-stmt-syntax 'statement-block-intro nil t
11255 (if (eq char-after-ip ?{)
11256 (c-add-syntax 'block-open)))
11258 ;; CASE 17E: first statement in an in-expression block.
11259 ;; C.f. cases 4, 7B and 16A.
11260 ((setq placeholder (c-looking-at-inexpr-block
11261 (c-safe-position containing-sexp paren-state)
11263 (setq tmpsymbol (if (eq (car placeholder) 'inlambda)
11265 'statement-block-intro))
11266 (back-to-indentation)
11267 (if (= containing-sexp (point))
11268 (c-add-syntax tmpsymbol (point))
11269 (goto-char (cdr placeholder))
11270 (back-to-indentation)
11271 (c-add-stmt-syntax tmpsymbol nil t
11272 (c-most-enclosing-brace c-state-cache (point))
11274 (if (/= (point) (cdr placeholder))
11275 (c-add-syntax (car placeholder))))
11276 (if (eq char-after-ip ?{)
11277 (c-add-syntax 'block-open)))
11279 ;; CASE 17F: first statement in an inline, or first
11280 ;; statement in a top-level defun. we can tell this is it
11281 ;; if there are no enclosing braces that haven't been
11282 ;; narrowed out by a class (i.e. don't use bod here).
11284 (or (not (setq placeholder (c-most-enclosing-brace
11287 (goto-char placeholder)
11288 (eq (char-after) ?{))
11289 (c-looking-at-decl-block (c-most-enclosing-brace
11290 paren-state (point))
11292 (c-backward-to-decl-anchor lim)
11293 (back-to-indentation)
11294 (c-add-syntax 'defun-block-intro (point)))
11296 ;; CASE 17G: First statement in a function declared inside
11297 ;; a normal block. This can occur in Pike and with
11298 ;; e.g. the gcc extensions, but watch out for macros
11299 ;; followed by blocks. C.f. cases B.3 and 16F.
11301 (and (not (c-at-statement-start-p))
11302 (eq (c-beginning-of-statement-1 lim nil nil t) 'same)
11303 (setq placeholder (point))
11304 (let ((c-recognize-typeless-decls nil))
11305 ;; Turn off recognition of constructs that lacks
11306 ;; a type in this case, since that's more likely
11307 ;; to be a macro followed by a block.
11308 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
11309 (back-to-indentation)
11310 (if (/= (point) containing-sexp)
11311 (goto-char placeholder))
11312 (c-add-stmt-syntax 'defun-block-intro nil t
11315 ;; CASE 17H: First statement in a block.
11317 ;; If the block is preceded by a case/switch label on the
11318 ;; same line, we anchor at the first preceding label at
11319 ;; boi. The default handling in c-add-stmt-syntax is
11320 ;; really fixes it better, but we do like this to keep the
11321 ;; indentation compatible with version 5.28 and earlier.
11323 (while (and (/= (setq placeholder (point)) (c-point 'boi))
11324 (eq (c-beginning-of-statement-1 lim) 'label)))
11325 (goto-char placeholder)
11326 (if (looking-at c-label-kwds-regexp)
11327 (c-add-syntax 'statement-block-intro (point))
11328 (goto-char containing-sexp)
11329 ;; c-backward-to-block-anchor not necessary here; those
11330 ;; situations are handled in case 17I above.
11331 (c-add-stmt-syntax 'statement-block-intro nil t
11333 (if (eq char-after-ip ?{)
11334 (c-add-syntax 'block-open)))
11338 ;; now we need to look at any modifiers
11339 (goto-char indent-point)
11340 (skip-chars-forward " \t")
11342 ;; are we looking at a comment only line?
11343 (when (and (looking-at c-comment-start-regexp)
11344 (/= (c-forward-token-2 0 nil (c-point 'eol)) 0))
11345 (c-append-syntax 'comment-intro))
11347 ;; we might want to give additional offset to friends (in C++).
11348 (when (and c-opt-friend-key
11349 (looking-at c-opt-friend-key))
11350 (c-append-syntax 'friend))
11352 ;; Set syntactic-relpos.
11353 (let ((p c-syntactic-context))
11355 (if (integerp (c-langelem-pos (car p)))
11357 (setq syntactic-relpos (c-langelem-pos (car p)))
11362 ;; Start of or a continuation of a preprocessor directive?
11363 (if (and macro-start
11364 (eq macro-start (c-point 'boi))
11365 (not (and (c-major-mode-is 'pike-mode)
11366 (eq (char-after (1+ macro-start)) ?\"))))
11367 (c-append-syntax 'cpp-macro)
11368 (when (and c-syntactic-indentation-in-macros macro-start)
11371 (< syntactic-relpos macro-start)
11373 (assq 'arglist-intro c-syntactic-context)
11374 (assq 'arglist-cont c-syntactic-context)
11375 (assq 'arglist-cont-nonempty c-syntactic-context)
11376 (assq 'arglist-close c-syntactic-context))))
11377 ;; If inside a cpp expression, i.e. anywhere in a
11378 ;; cpp directive except a #define body, we only let
11379 ;; through the syntactic analysis that is internal
11380 ;; in the expression. That means the arglist
11381 ;; elements, if they are anchored inside the cpp
11383 (setq c-syntactic-context nil)
11384 (c-add-syntax 'cpp-macro-cont macro-start))
11385 (when (and (eq macro-start syntactic-relpos)
11386 (not (assq 'cpp-define-intro c-syntactic-context))
11388 (goto-char macro-start)
11389 (or (not (c-forward-to-cpp-define-body))
11390 (<= (point) (c-point 'boi indent-point)))))
11391 ;; Inside a #define body and the syntactic analysis is
11392 ;; anchored on the start of the #define. In this case
11393 ;; we add cpp-define-intro to get the extra
11394 ;; indentation of the #define body.
11395 (c-add-syntax 'cpp-define-intro)))))
11397 ;; return the syntax
11398 c-syntactic-context)))
11401 ;; Indentation calculation.
11403 (defun c-evaluate-offset (offset langelem symbol)
11404 ;; offset can be a number, a function, a variable, a list, or one of
11405 ;; the symbols + or -
11407 ;; This function might do hidden buffer changes.
11410 ((numberp offset) offset)
11411 ((vectorp offset) offset)
11412 ((null offset) nil)
11414 ((eq offset '+) c-basic-offset)
11415 ((eq offset '-) (- c-basic-offset))
11416 ((eq offset '++) (* 2 c-basic-offset))
11417 ((eq offset '--) (* 2 (- c-basic-offset)))
11418 ((eq offset '*) (/ c-basic-offset 2))
11419 ((eq offset '/) (/ (- c-basic-offset) 2))
11421 ((functionp offset)
11424 (cons (c-langelem-sym langelem)
11425 (c-langelem-pos langelem)))
11430 ((eq (car offset) 'quote)
11431 (c-benign-error "The offset %S for %s was mistakenly quoted"
11435 ((memq (car offset) '(min max))
11436 (let (res val (method (car offset)))
11437 (setq offset (cdr offset))
11439 (setq val (c-evaluate-offset (car offset) langelem symbol))
11447 Error evaluating offset %S for %s: \
11448 Cannot combine absolute offset %S with relative %S in `%s' method"
11449 (car offset) symbol res val method)
11450 (setq res (funcall method res val))))
11454 Error evaluating offset %S for %s: \
11455 Cannot combine relative offset %S with absolute %S in `%s' method"
11456 (car offset) symbol res val method)
11457 (setq res (vector (funcall method (aref res 0)
11459 (setq offset (cdr offset)))
11462 ((eq (car offset) 'add)
11464 (setq offset (cdr offset))
11466 (setq val (c-evaluate-offset (car offset) langelem symbol))
11473 (setq res (vector (+ (aref res 0) val)))
11474 (setq res (+ res val))))
11478 Error evaluating offset %S for %s: \
11479 Cannot combine absolute offsets %S and %S in `add' method"
11480 (car offset) symbol res val)
11481 (setq res val)))) ; Override.
11482 (setq offset (cdr offset)))
11487 (when (eq (car offset) 'first)
11488 (setq offset (cdr offset)))
11489 (while (and (not res) offset)
11490 (setq res (c-evaluate-offset (car offset) langelem symbol)
11491 offset (cdr offset)))
11494 ((and (symbolp offset) (boundp offset))
11495 (symbol-value offset))
11498 (c-benign-error "Unknown offset format %S for %s" offset symbol)
11501 (if (or (null res) (integerp res)
11502 (and (vectorp res) (= (length res) 1) (integerp (aref res 0))))
11504 (c-benign-error "Error evaluating offset %S for %s: Got invalid value %S"
11508 (defun c-calc-offset (langelem)
11509 ;; Get offset from LANGELEM which is a list beginning with the
11510 ;; syntactic symbol and followed by any analysis data it provides.
11511 ;; That data may be zero or more elements, but if at least one is
11512 ;; given then the first is the anchor position (or nil). The symbol
11513 ;; is matched against `c-offsets-alist' and the offset calculated
11514 ;; from that is returned.
11516 ;; This function might do hidden buffer changes.
11517 (let* ((symbol (c-langelem-sym langelem))
11518 (match (assq symbol c-offsets-alist))
11519 (offset (cdr-safe match)))
11521 (setq offset (c-evaluate-offset offset langelem symbol))
11522 (if c-strict-syntax-p
11523 (c-benign-error "No offset found for syntactic symbol %s" symbol))
11525 (if (vectorp offset)
11527 (or (and (numberp offset) offset)
11528 (and (symbolp offset) (symbol-value offset))
11532 (defun c-get-offset (langelem)
11533 ;; This is a compatibility wrapper for `c-calc-offset' in case
11534 ;; someone is calling it directly. It takes an old style syntactic
11535 ;; element on the form (SYMBOL . ANCHOR-POS) and converts it to the
11538 ;; This function might do hidden buffer changes.
11539 (if (c-langelem-pos langelem)
11540 (c-calc-offset (list (c-langelem-sym langelem)
11541 (c-langelem-pos langelem)))
11542 (c-calc-offset langelem)))
11544 (defun c-get-syntactic-indentation (langelems)
11545 ;; Calculate the syntactic indentation from a syntactic description
11546 ;; as returned by `c-guess-syntax'.
11548 ;; Note that topmost-intro always has an anchor position at bol, for
11549 ;; historical reasons. It's often used together with other symbols
11550 ;; that has more sane positions. Since we always use the first
11551 ;; found anchor position, we rely on that these other symbols always
11552 ;; precede topmost-intro in the LANGELEMS list.
11554 ;; This function might do hidden buffer changes.
11555 (let ((indent 0) anchor)
11558 (let* ((c-syntactic-element (car langelems))
11559 (res (c-calc-offset c-syntactic-element)))
11562 ;; Got an absolute column that overrides any indentation
11563 ;; we've collected so far, but not the relative
11564 ;; indentation we might get for the nested structures
11565 ;; further down the langelems list.
11566 (setq indent (elt res 0)
11567 anchor (point-min)) ; A position at column 0.
11569 ;; Got a relative change of the current calculated
11571 (setq indent (+ indent res))
11573 ;; Use the anchor position from the first syntactic
11574 ;; element with one.
11576 (setq anchor (c-langelem-pos (car langelems)))))
11578 (setq langelems (cdr langelems))))
11581 (+ indent (save-excursion
11587 (cc-provide 'cc-engine)
11589 ;; Local Variables:
11590 ;; indent-tabs-mode: t
11593 ;;; cc-engine.el ends here