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 doesn'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 (looking-at c-syntactic-ws-start)
1719 (setq rung-end-pos (min (1+ (point)) (point-max)))
1720 (if (setq rung-is-marked (text-property-any rung-pos rung-end-pos
1722 ;; Find the last rung position to avoid setting properties in all
1723 ;; the cases when the marked rung is complete.
1724 ;; (`next-single-property-change' is certain to move at least one
1726 (setq rung-pos (1- (c-next-single-property-change
1727 rung-is-marked 'c-is-sws nil rung-end-pos)))
1728 ;; Got no marked rung here. Since the simple ws might have started
1729 ;; inside a line comment or cpp directive we must set `rung-pos' as
1730 ;; high as possible.
1731 (setq rung-pos (point)))
1733 (with-silent-modifications
1737 (when (and rung-is-marked
1738 (get-text-property (point) 'c-in-sws))
1740 ;; The following search is the main reason that `c-in-sws'
1741 ;; and `c-is-sws' aren't combined to one property.
1742 (goto-char (c-next-single-property-change
1743 (point) 'c-in-sws nil (point-max)))
1744 (unless (get-text-property (point) 'c-is-sws)
1745 ;; If the `c-in-sws' region extended past the last
1746 ;; `c-is-sws' char we have to go back a bit.
1747 (or (get-text-property (1- (point)) 'c-is-sws)
1748 (goto-char (previous-single-property-change
1749 (point) 'c-is-sws)))
1753 "c-forward-sws cached move %s -> %s (max %s)"
1754 rung-pos (point) (point-max))
1756 (setq rung-pos (point))
1757 (and (> (skip-chars-forward " \t\n\r\f\v") 0)
1760 ;; We'll loop here if there is simple ws after the last rung.
1761 ;; That means that there's been some change in it and it's
1762 ;; possible that we've stepped into another ladder, so extend
1763 ;; the previous one to join with it if there is one, and try to
1764 ;; use the cache again.
1766 "c-forward-sws extending rung with [%s..%s] (max %s)"
1767 (1+ rung-pos) (1+ (point)) (point-max))
1768 (unless (get-text-property (point) 'c-is-sws)
1769 ;; Remove any `c-in-sws' property from the last char of
1770 ;; the rung before we mark it with `c-is-sws', so that we
1771 ;; won't connect with the remains of a broken "ladder".
1772 (c-remove-in-sws (point) (1+ (point))))
1773 (c-put-is-sws (1+ rung-pos)
1775 (c-put-in-sws rung-pos
1776 (setq rung-pos (point)
1777 last-put-in-sws-pos rung-pos)))
1779 (setq simple-ws-end (point))
1780 (c-forward-comments)
1783 ((/= (point) simple-ws-end)
1784 ;; Skipped over comments. Don't cache at eob in case the buffer
1789 (and c-opt-cpp-prefix
1790 (looking-at c-opt-cpp-start)
1791 (progn (skip-chars-backward " \t")
1794 (progn (backward-char)
1795 (not (eq (char-before) ?\\))))))
1796 ;; Skip a preprocessor directive.
1798 (while (and (eq (char-before) ?\\)
1799 (= (forward-line 1) 0))
1803 ;; Don't cache at eob in case the buffer is narrowed.
1806 ;; We've searched over a piece of non-white syntactic ws. See if this
1808 (setq next-rung-pos (point))
1809 (skip-chars-forward " \t\n\r\f\v")
1810 (setq rung-end-pos (min (1+ (point)) (point-max)))
1813 ;; Cache if we haven't skipped comments only, and if we started
1814 ;; either from a marked rung or from a completely uncached
1818 (not (get-text-property simple-ws-end 'c-in-sws))))
1820 ;; See if there's a marked rung in the encountered simple ws. If
1821 ;; so then we can cache, unless `safe-start' is nil. Even then
1822 ;; we need to do this to check if the cache can be used for the
1824 (and (setq next-rung-is-marked
1825 (text-property-any next-rung-pos rung-end-pos
1831 "c-forward-sws caching [%s..%s] - [%s..%s] (max %s)"
1832 rung-pos (1+ simple-ws-end) next-rung-pos rung-end-pos
1835 ;; Remove the properties for any nested ws that might be cached.
1836 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
1838 (c-remove-is-sws (1+ simple-ws-end) next-rung-pos)
1839 (unless (and rung-is-marked (= rung-pos simple-ws-end))
1840 (c-put-is-sws rung-pos
1842 (setq rung-is-marked t))
1843 (c-put-in-sws rung-pos
1844 (setq rung-pos (point)
1845 last-put-in-sws-pos rung-pos))
1846 (unless (get-text-property (1- rung-end-pos) 'c-is-sws)
1847 ;; Remove any `c-in-sws' property from the last char of
1848 ;; the rung before we mark it with `c-is-sws', so that we
1849 ;; won't connect with the remains of a broken "ladder".
1850 (c-remove-in-sws (1- rung-end-pos) rung-end-pos))
1851 (c-put-is-sws next-rung-pos
1855 "c-forward-sws not caching [%s..%s] - [%s..%s] (max %s)"
1856 rung-pos (1+ simple-ws-end) next-rung-pos rung-end-pos
1859 ;; Set `rung-pos' for the next rung. It's the same thing here as
1860 ;; initially, except that the rung position is set as early as
1861 ;; possible since we can't be in the ending ws of a line comment or
1862 ;; cpp directive now.
1863 (if (setq rung-is-marked next-rung-is-marked)
1864 (setq rung-pos (1- (c-next-single-property-change
1865 rung-is-marked 'c-is-sws nil rung-end-pos)))
1866 (setq rung-pos next-rung-pos))
1867 (setq safe-start t)))
1869 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
1870 ;; another one after the point (which might occur when editing inside a
1871 ;; comment or macro).
1872 (when (eq last-put-in-sws-pos (point))
1873 (cond ((< last-put-in-sws-pos (point-max))
1875 "c-forward-sws clearing at %s for cache separation"
1876 last-put-in-sws-pos)
1877 (c-remove-in-sws last-put-in-sws-pos
1878 (1+ last-put-in-sws-pos)))
1880 ;; If at eob we have to clear the last character before the end
1881 ;; instead since the buffer might be narrowed and there might
1882 ;; be a `c-in-sws' after (point-max). In this case it's
1883 ;; necessary to clear both properties.
1885 "c-forward-sws clearing thoroughly at %s for cache separation"
1886 (1- last-put-in-sws-pos))
1887 (c-remove-is-and-in-sws (1- last-put-in-sws-pos)
1888 last-put-in-sws-pos))))
1891 (defun c-backward-sws ()
1892 ;; Used by `c-backward-syntactic-ws' to implement the unbounded search.
1894 ;; This function might do hidden buffer changes.
1896 (let (;; `rung-pos' is set to a position as late as possible in the unmarked
1897 ;; part of the simple ws region.
1898 (rung-pos (point)) next-rung-pos last-put-in-sws-pos
1899 rung-is-marked simple-ws-beg cmt-skip-pos)
1901 ;; Skip simple horizontal ws and do a quick check on the preceding
1902 ;; character to see if it's anything that can't end syntactic ws, so we can
1903 ;; bail out early in the majority of cases when there just are a few ws
1904 ;; chars. Newlines are complicated in the backward direction, so we can't
1906 (skip-chars-backward " \t\f")
1907 (when (and (not (bobp))
1910 (looking-at c-syntactic-ws-end)))
1912 ;; Try to find a rung position in the simple ws preceding point, so that
1913 ;; we can get a cache hit even if the last bit of the simple ws has
1914 ;; changed recently.
1915 (setq simple-ws-beg (point))
1916 (skip-chars-backward " \t\n\r\f\v")
1917 (if (setq rung-is-marked (text-property-any
1918 (point) (min (1+ rung-pos) (point-max))
1920 ;; `rung-pos' will be the earliest marked position, which means that
1921 ;; there might be later unmarked parts in the simple ws region.
1922 ;; It's not worth the effort to fix that; the last part of the
1923 ;; simple ws is also typically edited often, so it could be wasted.
1924 (goto-char (setq rung-pos rung-is-marked))
1925 (goto-char simple-ws-beg))
1927 (with-silent-modifications
1931 (when (and rung-is-marked
1933 (get-text-property (1- (point)) 'c-in-sws))
1935 ;; The following search is the main reason that `c-in-sws'
1936 ;; and `c-is-sws' aren't combined to one property.
1937 (goto-char (previous-single-property-change
1938 (point) 'c-in-sws nil (point-min)))
1939 (unless (get-text-property (point) 'c-is-sws)
1940 ;; If the `c-in-sws' region extended past the first
1941 ;; `c-is-sws' char we have to go forward a bit.
1942 (goto-char (c-next-single-property-change
1943 (point) 'c-is-sws)))
1946 "c-backward-sws cached move %s <- %s (min %s)"
1947 (point) rung-pos (point-min))
1949 (setq rung-pos (point))
1950 (if (and (< (min (skip-chars-backward " \t\f\v")
1952 (setq simple-ws-beg (point))
1953 (skip-chars-backward " \t\n\r\f\v")))
1955 (setq rung-is-marked
1956 (text-property-any (point) rung-pos
1959 (goto-char simple-ws-beg)
1962 ;; We'll loop here if there is simple ws before the first rung.
1963 ;; That means that there's been some change in it and it's
1964 ;; possible that we've stepped into another ladder, so extend
1965 ;; the previous one to join with it if there is one, and try to
1966 ;; use the cache again.
1968 "c-backward-sws extending rung with [%s..%s] (min %s)"
1969 rung-is-marked rung-pos (point-min))
1970 (unless (get-text-property (1- rung-pos) 'c-is-sws)
1971 ;; Remove any `c-in-sws' property from the last char of
1972 ;; the rung before we mark it with `c-is-sws', so that we
1973 ;; won't connect with the remains of a broken "ladder".
1974 (c-remove-in-sws (1- rung-pos) rung-pos))
1975 (c-put-is-sws rung-is-marked
1977 (c-put-in-sws rung-is-marked
1979 (setq rung-pos rung-is-marked
1980 last-put-in-sws-pos rung-pos))
1982 (c-backward-comments)
1983 (setq cmt-skip-pos (point))
1986 ((and c-opt-cpp-prefix
1987 (/= cmt-skip-pos simple-ws-beg)
1988 (c-beginning-of-macro))
1989 ;; Inside a cpp directive. See if it should be skipped over.
1990 (let ((cpp-beg (point)))
1992 ;; Move back over all line continuations in the region skipped
1993 ;; over by `c-backward-comments'. If we go past it then we
1994 ;; started inside the cpp directive.
1995 (goto-char simple-ws-beg)
1997 (while (and (> (point) cmt-skip-pos)
1998 (progn (backward-char)
1999 (eq (char-before) ?\\)))
2000 (beginning-of-line))
2002 (if (< (point) cmt-skip-pos)
2003 ;; Don't move past the cpp directive if we began inside
2004 ;; it. Note that the position at the end of the last line
2005 ;; of the macro is also considered to be within it.
2006 (progn (goto-char cmt-skip-pos)
2009 ;; It's worthwhile to spend a little bit of effort on finding
2010 ;; the end of the macro, to get a good `simple-ws-beg'
2011 ;; position for the cache. Note that `c-backward-comments'
2012 ;; could have stepped over some comments before going into
2013 ;; the macro, and then `simple-ws-beg' must be kept on the
2014 ;; same side of those comments.
2015 (goto-char simple-ws-beg)
2016 (skip-chars-backward " \t\n\r\f\v")
2017 (if (eq (char-before) ?\\)
2020 (if (< (point) simple-ws-beg)
2021 ;; Might happen if comments after the macro were skipped
2023 (setq simple-ws-beg (point)))
2028 ((/= (save-excursion
2029 (skip-chars-forward " \t\n\r\f\v" simple-ws-beg)
2030 (setq next-rung-pos (point)))
2032 ;; Skipped over comments. Must put point at the end of
2033 ;; the simple ws at point since we might be after a line
2034 ;; comment or cpp directive that's been partially
2035 ;; narrowed out, and we can't risk marking the simple ws
2036 ;; at the end of it.
2037 (goto-char next-rung-pos)
2040 ;; We've searched over a piece of non-white syntactic ws. See if this
2042 (setq next-rung-pos (point))
2043 (skip-chars-backward " \t\f\v")
2046 ;; Cache if we started either from a marked rung or from a
2047 ;; completely uncached position.
2049 (not (get-text-property (1- simple-ws-beg) 'c-in-sws))
2051 ;; Cache if there's a marked rung in the encountered simple ws.
2053 (skip-chars-backward " \t\n\r\f\v")
2054 (text-property-any (point) (min (1+ next-rung-pos) (point-max))
2059 "c-backward-sws caching [%s..%s] - [%s..%s] (min %s)"
2060 (point) (1+ next-rung-pos)
2061 simple-ws-beg (min (1+ rung-pos) (point-max))
2064 ;; Remove the properties for any nested ws that might be cached.
2065 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
2067 (c-remove-is-sws (1+ next-rung-pos) simple-ws-beg)
2068 (unless (and rung-is-marked (= simple-ws-beg rung-pos))
2069 (let ((rung-end-pos (min (1+ rung-pos) (point-max))))
2070 (unless (get-text-property (1- rung-end-pos) 'c-is-sws)
2071 ;; Remove any `c-in-sws' property from the last char of
2072 ;; the rung before we mark it with `c-is-sws', so that we
2073 ;; won't connect with the remains of a broken "ladder".
2074 (c-remove-in-sws (1- rung-end-pos) rung-end-pos))
2075 (c-put-is-sws simple-ws-beg
2077 (setq rung-is-marked t)))
2078 (c-put-in-sws (setq simple-ws-beg (point)
2079 last-put-in-sws-pos simple-ws-beg)
2081 (c-put-is-sws (setq rung-pos simple-ws-beg)
2082 (1+ next-rung-pos)))
2085 "c-backward-sws not caching [%s..%s] - [%s..%s] (min %s)"
2086 (point) (1+ next-rung-pos)
2087 simple-ws-beg (min (1+ rung-pos) (point-max))
2089 (setq rung-pos next-rung-pos
2090 simple-ws-beg (point))
2093 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
2094 ;; another one before the point (which might occur when editing inside a
2095 ;; comment or macro).
2096 (when (eq last-put-in-sws-pos (point))
2097 (cond ((< (point-min) last-put-in-sws-pos)
2099 "c-backward-sws clearing at %s for cache separation"
2100 (1- last-put-in-sws-pos))
2101 (c-remove-in-sws (1- last-put-in-sws-pos)
2102 last-put-in-sws-pos))
2104 ;; If at bob and the buffer is narrowed, we have to clear the
2105 ;; character we're standing on instead since there might be a
2106 ;; `c-in-sws' before (point-min). In this case it's necessary
2107 ;; to clear both properties.
2109 "c-backward-sws clearing thoroughly at %s for cache separation"
2110 last-put-in-sws-pos)
2111 (c-remove-is-and-in-sws last-put-in-sws-pos
2112 (1+ last-put-in-sws-pos)))))
2116 ;; Other whitespace tools
2117 (defun c-partial-ws-p (beg end)
2118 ;; Is the region (beg end) WS, and is there WS (or BOB/EOB) next to the
2119 ;; region? This is a "heuristic" function. .....
2121 ;; The motivation for the second bit is to check whether removing this
2122 ;; region would coalesce two symbols.
2124 ;; FIXME!!! This function doesn't check virtual semicolons in any way. Be
2125 ;; careful about using this function for, e.g. AWK. (2007/3/7)
2127 (let ((end+1 (min (1+ end) (point-max))))
2128 (or (progn (goto-char (max (point-min) (1- beg)))
2129 (c-skip-ws-forward end)
2131 (progn (goto-char beg)
2132 (c-skip-ws-forward end+1)
2133 (eq (point) end+1))))))
2135 ;; A system for finding noteworthy parens before the point.
2137 (defconst c-state-cache-too-far 5000)
2138 ;; A maximum comfortable scanning distance, e.g. between
2139 ;; `c-state-cache-good-pos' and "HERE" (where we call c-parse-state). When
2140 ;; this distance is exceeded, we take "emergency measures", e.g. by clearing
2141 ;; the cache and starting again from point-min or a beginning of defun. This
2142 ;; value can be tuned for efficiency or set to a lower value for testing.
2144 (defvar c-state-cache nil)
2145 (make-variable-buffer-local 'c-state-cache)
2146 ;; The state cache used by `c-parse-state' to cut down the amount of
2147 ;; searching. It's the result from some earlier `c-parse-state' call. See
2148 ;; `c-parse-state''s doc string for details of its structure.
2150 ;; The use of the cached info is more effective if the next
2151 ;; `c-parse-state' call is on a line close by the one the cached state
2152 ;; was made at; the cache can actually slow down a little if the
2153 ;; cached state was made very far back in the buffer. The cache is
2154 ;; most effective if `c-parse-state' is used on each line while moving
2157 (defvar c-state-cache-good-pos 1)
2158 (make-variable-buffer-local 'c-state-cache-good-pos)
2159 ;; This is a position where `c-state-cache' is known to be correct, or
2160 ;; nil (see below). It's a position inside one of the recorded unclosed
2161 ;; parens or the top level, but not further nested inside any literal or
2162 ;; subparen that is closed before the last recorded position.
2164 ;; The exact position is chosen to try to be close to yet earlier than
2165 ;; the position where `c-state-cache' will be called next. Right now
2166 ;; the heuristic is to set it to the position after the last found
2167 ;; closing paren (of any type) before the line on which
2168 ;; `c-parse-state' was called. That is chosen primarily to work well
2169 ;; with refontification of the current line.
2171 ;; 2009-07-28: When `c-state-point-min' and the last position where
2172 ;; `c-parse-state' or for which `c-invalidate-state-cache' was called, are
2173 ;; both in the same literal, there is no such "good position", and
2174 ;; c-state-cache-good-pos is then nil. This is the ONLY circumstance in which
2175 ;; it can be nil. In this case, `c-state-point-min-literal' will be non-nil.
2177 ;; 2009-06-12: In a brace desert, c-state-cache-good-pos may also be in
2178 ;; the middle of the desert, as long as it is not within a brace pair
2179 ;; recorded in `c-state-cache' or a paren/bracket pair.
2181 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2182 ;; We maintain a simple cache of positions which aren't in a literal, so as to
2183 ;; speed up testing for non-literality.
2184 (defconst c-state-nonlit-pos-interval 3000)
2185 ;; The approximate interval between entries in `c-state-nonlit-pos-cache'.
2187 (defvar c-state-nonlit-pos-cache nil)
2188 (make-variable-buffer-local 'c-state-nonlit-pos-cache)
2189 ;; A list of buffer positions which are known not to be in a literal or a cpp
2190 ;; construct. This is ordered with higher positions at the front of the list.
2191 ;; Only those which are less than `c-state-nonlit-pos-cache-limit' are valid.
2193 (defvar c-state-nonlit-pos-cache-limit 1)
2194 (make-variable-buffer-local 'c-state-nonlit-pos-cache-limit)
2195 ;; An upper limit on valid entries in `c-state-nonlit-pos-cache'. This is
2196 ;; reduced by buffer changes, and increased by invocations of
2197 ;; `c-state-literal-at'.
2199 (defvar c-state-semi-nonlit-pos-cache nil)
2200 (make-variable-buffer-local 'c-state-semi-nonlit-pos-cache)
2201 ;; A list of buffer positions which are known not to be in a literal. This is
2202 ;; ordered with higher positions at the front of the list. Only those which
2203 ;; are less than `c-state-semi-nonlit-pos-cache-limit' are valid.
2205 (defvar c-state-semi-nonlit-pos-cache-limit 1)
2206 (make-variable-buffer-local 'c-state-semi-nonlit-pos-cache-limit)
2207 ;; An upper limit on valid entries in `c-state-semi-nonlit-pos-cache'. This is
2208 ;; reduced by buffer changes, and increased by invocations of
2209 ;; `c-state-literal-at'. FIXME!!!
2211 (defsubst c-state-pp-to-literal (from to &optional not-in-delimiter)
2212 ;; Do a parse-partial-sexp from FROM to TO, returning either
2213 ;; (STATE TYPE (BEG . END)) if TO is in a literal; or
2214 ;; (STATE) otherwise,
2215 ;; where STATE is the parsing state at TO, TYPE is the type of the literal
2216 ;; (one of 'c, 'c++, 'string) and (BEG . END) is the boundaries of the literal.
2218 ;; Unless NOT-IN-DELIMITER is non-nil, when TO is inside a two-character
2219 ;; comment opener, this is recognized as being in a comment literal.
2221 ;; Only elements 3 (in a string), 4 (in a comment), 5 (following a quote),
2222 ;; 7 (comment type) and 8 (start of comment/string) (and possibly 9) of
2225 (let ((s (parse-partial-sexp from to))
2228 ((or (nth 3 s) (nth 4 s)) ; in a string or comment
2233 (parse-partial-sexp (point) (point-max)
2237 'syntax-table) ; stop at end of literal
2238 `(,s ,ty (,(nth 8 s) . ,(point))))
2240 ((and (not not-in-delimiter) ; inside a comment starter
2242 (progn (backward-char)
2243 (and (not (looking-at "\\s!"))
2244 (looking-at c-comment-start-regexp))))
2245 (setq ty (if (looking-at c-block-comment-start-regexp) 'c 'c++)
2248 `(,s ,ty (,co-st . ,(point))))
2252 (defun c-state-safe-place (here)
2253 ;; Return a buffer position before HERE which is "safe", i.e. outside any
2254 ;; string, comment, or macro.
2256 ;; NOTE: This function manipulates `c-state-nonlit-pos-cache'. This cache
2257 ;; MAY NOT contain any positions within macros, since macros are frequently
2258 ;; turned into comments by use of the `c-cpp-delimiter' category properties.
2259 ;; We cannot rely on this mechanism whilst determining a cache pos since
2260 ;; this function is also called from outwith `c-parse-state'.
2264 (let ((c c-state-nonlit-pos-cache)
2265 pos npos high-pos lit macro-beg macro-end)
2266 ;; Trim the cache to take account of buffer changes.
2267 (while (and c (> (car c) c-state-nonlit-pos-cache-limit))
2269 (setq c-state-nonlit-pos-cache c)
2271 (while (and c (> (car c) here))
2272 (setq high-pos (car c))
2274 (setq pos (or (car c) (point-min)))
2278 ;; Add an element to `c-state-nonlit-pos-cache' each iteration.
2281 (when (<= (+ pos c-state-nonlit-pos-interval) here)
2282 (+ pos c-state-nonlit-pos-interval)))
2284 ;; Test for being in a literal. If so, go to after it.
2286 (setq lit (car (cddr (c-state-pp-to-literal pos npos))))
2288 (prog1 (<= (cdr lit) here)
2289 (setq npos (cdr lit)))))
2291 ;; Test for being in a macro. If so, go to after it.
2295 (and (c-beginning-of-macro) (/= (point) npos) (point)))
2297 (c-syntactic-end-of-macro)
2298 (or (eobp) (forward-char))
2299 (setq macro-end (point)))
2300 (or (null macro-beg)
2301 (prog1 (<= macro-end here)
2302 (setq npos macro-end)))))
2305 (setq c-state-nonlit-pos-cache (cons pos c-state-nonlit-pos-cache)))
2306 ;; Add one extra element above HERE so as to to avoid the previous
2307 ;; expensive calculation when the next call is close to the current
2308 ;; one. This is especially useful when inside a large macro.
2310 (setq c-state-nonlit-pos-cache
2311 (cons npos c-state-nonlit-pos-cache))))
2313 (if (> pos c-state-nonlit-pos-cache-limit)
2314 (setq c-state-nonlit-pos-cache-limit pos))
2317 (defun c-state-semi-safe-place (here)
2318 ;; Return a buffer position before HERE which is "safe", i.e. outside any
2319 ;; string or comment. It may be in a macro.
2323 (let ((c c-state-semi-nonlit-pos-cache)
2324 pos npos high-pos lit macro-beg macro-end)
2325 ;; Trim the cache to take account of buffer changes.
2326 (while (and c (> (car c) c-state-semi-nonlit-pos-cache-limit))
2328 (setq c-state-semi-nonlit-pos-cache c)
2330 (while (and c (> (car c) here))
2331 (setq high-pos (car c))
2333 (setq pos (or (car c) (point-min)))
2337 ;; Add an element to `c-state-semi-nonlit-pos-cache' each iteration.
2339 (<= (setq npos (+ pos c-state-nonlit-pos-interval)) here)
2341 ;; Test for being in a literal. If so, go to after it.
2343 (setq lit (car (cddr (c-state-pp-to-literal pos npos))))
2345 (prog1 (<= (cdr lit) here)
2346 (setq npos (cdr lit))))))
2349 (setq c-state-semi-nonlit-pos-cache
2350 (cons pos c-state-semi-nonlit-pos-cache))))
2352 (if (> pos c-state-semi-nonlit-pos-cache-limit)
2353 (setq c-state-semi-nonlit-pos-cache-limit pos))
2356 (defun c-state-literal-at (here)
2357 ;; If position HERE is inside a literal, return (START . END), the
2358 ;; boundaries of the literal (which may be outside the accessible bit of the
2359 ;; buffer). Otherwise, return nil.
2361 ;; This function is almost the same as `c-literal-limits'. Previously, it
2362 ;; differed in that it was a lower level function, and that it rigorously
2363 ;; followed the syntax from BOB. `c-literal-limits' is now (2011-12)
2364 ;; virtually identical to this function.
2368 (let ((pos (c-state-safe-place here)))
2369 (car (cddr (c-state-pp-to-literal pos here)))))))
2371 (defsubst c-state-lit-beg (pos)
2372 ;; Return the start of the literal containing POS, or POS itself.
2373 (or (car (c-state-literal-at pos))
2376 (defsubst c-state-cache-non-literal-place (pos state)
2377 ;; Return a position outside of a string/comment/macro at or before POS.
2378 ;; STATE is the parse-partial-sexp state at POS.
2379 (let ((res (if (or (nth 3 state) ; in a string?
2380 (nth 4 state)) ; in a comment?
2385 (if (c-beginning-of-macro)
2389 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2390 ;; Stuff to do with point-min, and coping with any literal there.
2391 (defvar c-state-point-min 1)
2392 (make-variable-buffer-local 'c-state-point-min)
2393 ;; This is (point-min) when `c-state-cache' was last calculated. A change of
2394 ;; narrowing is likely to affect the parens that are visible before the point.
2396 (defvar c-state-point-min-lit-type nil)
2397 (make-variable-buffer-local 'c-state-point-min-lit-type)
2398 (defvar c-state-point-min-lit-start nil)
2399 (make-variable-buffer-local 'c-state-point-min-lit-start)
2400 ;; These two variables define the literal, if any, containing point-min.
2401 ;; Their values are, respectively, 'string, c, or c++, and the start of the
2402 ;; literal. If there's no literal there, they're both nil.
2404 (defvar c-state-min-scan-pos 1)
2405 (make-variable-buffer-local 'c-state-min-scan-pos)
2406 ;; This is the earliest buffer-pos from which scanning can be done. It is
2407 ;; either the end of the literal containing point-min, or point-min itself.
2408 ;; It becomes nil if the buffer is changed earlier than this point.
2409 (defun c-state-get-min-scan-pos ()
2410 ;; Return the lowest valid scanning pos. This will be the end of the
2411 ;; literal enclosing point-min, or point-min itself.
2412 (or c-state-min-scan-pos
2416 (goto-char c-state-point-min-lit-start)
2417 (if (eq c-state-point-min-lit-type 'string)
2419 (forward-comment 1))
2420 (setq c-state-min-scan-pos (point))))))
2422 (defun c-state-mark-point-min-literal ()
2423 ;; Determine the properties of any literal containing POINT-MIN, setting the
2424 ;; variables `c-state-point-min-lit-type', `c-state-point-min-lit-start',
2425 ;; and `c-state-min-scan-pos' accordingly. The return value is meaningless.
2426 (let ((p-min (point-min))
2430 (setq lit (c-state-literal-at p-min))
2432 (setq c-state-point-min-lit-type
2434 (goto-char (car lit))
2436 ((looking-at c-block-comment-start-regexp) 'c)
2437 ((looking-at c-line-comment-starter) 'c++)
2439 c-state-point-min-lit-start (car lit)
2440 c-state-min-scan-pos (cdr lit))
2441 (setq c-state-point-min-lit-type nil
2442 c-state-point-min-lit-start nil
2443 c-state-min-scan-pos p-min)))))
2446 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2447 ;; A variable which signals a brace dessert - helpful for reducing the number
2448 ;; of fruitless backward scans.
2449 (defvar c-state-brace-pair-desert nil)
2450 (make-variable-buffer-local 'c-state-brace-pair-desert)
2451 ;; Used only in `c-append-lower-brace-pair-to-state-cache'. It is set when
2452 ;; that defun has searched backwards for a brace pair and not found one. Its
2453 ;; value is either nil or a cons (PA . FROM), where PA is the position of the
2454 ;; enclosing opening paren/brace/bracket which bounds the backwards search (or
2455 ;; nil when at top level) and FROM is where the backward search started. It
2456 ;; is reset to nil in `c-invalidate-state-cache'.
2459 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2460 ;; Lowish level functions/macros which work directly on `c-state-cache', or a
2461 ;; list of like structure.
2462 (defmacro c-state-cache-top-lparen (&optional cache)
2463 ;; Return the address of the top left brace/bracket/paren recorded in CACHE
2464 ;; (default `c-state-cache') (or nil).
2465 (let ((cash (or cache 'c-state-cache)))
2466 `(if (consp (car ,cash))
2470 (defmacro c-state-cache-top-paren (&optional cache)
2471 ;; Return the address of the latest brace/bracket/paren (whether left or
2472 ;; right) recorded in CACHE (default `c-state-cache') or nil.
2473 (let ((cash (or cache 'c-state-cache)))
2474 `(if (consp (car ,cash))
2478 (defmacro c-state-cache-after-top-paren (&optional cache)
2479 ;; Return the position just after the latest brace/bracket/paren (whether
2480 ;; left or right) recorded in CACHE (default `c-state-cache') or nil.
2481 (let ((cash (or cache 'c-state-cache)))
2482 `(if (consp (car ,cash))
2485 (1+ (car ,cash))))))
2487 (defun c-get-cache-scan-pos (here)
2488 ;; From the state-cache, determine the buffer position from which we might
2489 ;; scan forward to HERE to update this cache. This position will be just
2490 ;; after a paren/brace/bracket recorded in the cache, if possible, otherwise
2491 ;; return the earliest position in the accessible region which isn't within
2492 ;; a literal. If the visible portion of the buffer is entirely within a
2493 ;; literal, return NIL.
2494 (let ((c c-state-cache) elt)
2495 ;(while (>= (or (c-state-cache-top-lparen c) 1) here)
2497 (>= (c-state-cache-top-lparen c) here))
2503 (if (> (cdr elt) here)
2507 ((<= (c-state-get-min-scan-pos) here)
2508 (c-state-get-min-scan-pos))
2511 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2512 ;; Variables which keep track of preprocessor constructs.
2513 (defvar c-state-old-cpp-beg-marker nil)
2514 (make-variable-buffer-local 'c-state-old-cpp-beg-marker)
2515 (defvar c-state-old-cpp-beg nil)
2516 (make-variable-buffer-local 'c-state-old-cpp-beg)
2517 (defvar c-state-old-cpp-end-marker nil)
2518 (make-variable-buffer-local 'c-state-old-cpp-end-marker)
2519 (defvar c-state-old-cpp-end nil)
2520 (make-variable-buffer-local 'c-state-old-cpp-end)
2521 ;; These are the limits of the macro containing point at the previous call of
2522 ;; `c-parse-state', or nil.
2524 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2525 ;; Defuns which analyze the buffer, yet don't change `c-state-cache'.
2526 (defun c-get-fallback-scan-pos (here)
2527 ;; Return a start position for building `c-state-cache' from
2528 ;; scratch. This will be at the top level, 2 defuns back.
2530 ;; Go back 2 bods, but ignore any bogus positions returned by
2531 ;; beginning-of-defun (i.e. open paren in column zero).
2534 (while (not (or (bobp) (zerop cnt)))
2535 (c-beginning-of-defun-1) ; Pure elisp BOD.
2536 (if (eq (char-after) ?\{)
2537 (setq cnt (1- cnt)))))
2540 (defun c-state-balance-parens-backwards (here- here+ top)
2541 ;; Return the position of the opening paren/brace/bracket before HERE- which
2542 ;; matches the outermost close p/b/b between HERE+ and TOP. Except when
2543 ;; there's a macro, HERE- and HERE+ are the same. Like this:
2545 ;; ............................................
2547 ;; ( [ ( .........#macro.. ) ( ) ] )
2550 ;; return HERE- HERE+ TOP
2552 ;; If there aren't enough opening paren/brace/brackets, return the position
2553 ;; of the outermost one found, or HERE- if there are none. If there are no
2554 ;; closing p/b/bs between HERE+ and TOP, return HERE-. HERE-/+ and TOP
2555 ;; must not be inside literals. Only the accessible portion of the buffer
2558 ;; PART 1: scan from `here+' up to `top', accumulating ")"s which enclose
2559 ;; `here'. Go round the next loop each time we pass over such a ")". These
2560 ;; probably match "("s before `here-'.
2561 (let (pos pa ren+1 lonely-rens)
2564 (narrow-to-region (point-min) top) ; This can move point, sometimes.
2568 (setq ren+1 (c-sc-scan-lists pos 1 1)) ; might signal
2569 (setq lonely-rens (cons ren+1 lonely-rens)
2572 ;; PART 2: Scan back before `here-' searching for the "("s
2573 ;; matching/mismatching the ")"s found above. We only need to direct the
2574 ;; caller to scan when we've encountered unmatched right parens.
2579 (and lonely-rens ; actual values aren't used.
2580 (setq pa (c-sc-scan-lists pos -1 1)))
2582 (setq lonely-rens (cdr lonely-rens)))))
2585 (defun c-parse-state-get-strategy (here good-pos)
2586 ;; Determine the scanning strategy for adjusting `c-parse-state', attempting
2587 ;; to minimize the amount of scanning. HERE is the pertinent position in
2588 ;; the buffer, GOOD-POS is a position where `c-state-cache' (possibly with
2589 ;; its head trimmed) is known to be good, or nil if there is no such
2592 ;; The return value is a list, one of the following:
2594 ;; o - ('forward START-POINT) - scan forward from START-POINT,
2595 ;; which is not less than the highest position in `c-state-cache' below HERE,
2596 ;; which is after GOOD-POS.
2597 ;; o - ('backward nil) - scan backwards (from HERE).
2598 ;; o - ('back-and-forward START-POINT) - like 'forward, but when HERE is earlier
2600 ;; o - ('BOD START-POINT) - scan forwards from START-POINT, which is at the
2602 ;; o - ('IN-LIT nil) - point is inside the literal containing point-min.
2603 (let ((cache-pos (c-get-cache-scan-pos here)) ; highest position below HERE in cache (or 1)
2604 BOD-pos ; position of 2nd BOD before HERE.
2605 strategy ; 'forward, 'backward, 'BOD, or 'IN-LIT.
2607 how-far) ; putative scanning distance.
2608 (setq good-pos (or good-pos (c-state-get-min-scan-pos)))
2610 ((< here (c-state-get-min-scan-pos))
2611 (setq strategy 'IN-LIT
2616 (setq strategy 'forward
2617 start-point (max good-pos cache-pos)
2618 how-far (- here start-point)))
2619 ((< (- good-pos here) (- here cache-pos)) ; FIXME!!! ; apply some sort of weighting.
2620 (setq strategy 'backward
2621 how-far (- good-pos here)))
2623 (setq strategy 'back-and-forward
2624 start-point cache-pos
2625 how-far (- here start-point))))
2627 ;; Might we be better off starting from the top level, two defuns back,
2628 ;; instead? This heuristic no longer works well in C++, where
2629 ;; declarations inside namespace brace blocks are frequently placed at
2630 ;; column zero. (2015-11-10): Remove the condition on C++ Mode.
2631 (when (and (or (not (memq 'col-0-paren c-emacs-features))
2632 open-paren-in-column-0-is-defun-start)
2633 ;; (not (c-major-mode-is 'c++-mode))
2634 (> how-far c-state-cache-too-far))
2635 (setq BOD-pos (c-get-fallback-scan-pos here)) ; somewhat EXPENSIVE!!!
2636 (if (< (- here BOD-pos) how-far)
2638 start-point BOD-pos)))
2640 (list strategy start-point)))
2643 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2644 ;; Routines which change `c-state-cache' and associated values.
2645 (defun c-renarrow-state-cache ()
2646 ;; The region (more precisely, point-min) has changed since we
2647 ;; calculated `c-state-cache'. Amend `c-state-cache' accordingly.
2648 (if (< (point-min) c-state-point-min)
2649 ;; If point-min has MOVED BACKWARDS then we drop the state completely.
2650 ;; It would be possible to do a better job here and recalculate the top
2653 (c-state-mark-point-min-literal)
2654 (setq c-state-cache nil
2655 c-state-cache-good-pos c-state-min-scan-pos
2656 c-state-brace-pair-desert nil))
2658 ;; point-min has MOVED FORWARD.
2660 ;; Is the new point-min inside a (different) literal?
2661 (unless (and c-state-point-min-lit-start ; at prev. point-min
2662 (< (point-min) (c-state-get-min-scan-pos)))
2663 (c-state-mark-point-min-literal))
2665 ;; Cut off a bit of the tail from `c-state-cache'.
2666 (let ((ptr (cons nil c-state-cache))
2668 (while (and (setq pa (c-state-cache-top-lparen (cdr ptr)))
2669 (>= pa (point-min)))
2670 (setq ptr (cdr ptr)))
2673 (if (eq (cdr ptr) c-state-cache)
2674 (setq c-state-cache nil
2675 c-state-cache-good-pos c-state-min-scan-pos)
2677 (setq c-state-cache-good-pos (1+ (c-state-cache-top-lparen))))
2680 (setq c-state-point-min (point-min)))
2682 (defun c-append-lower-brace-pair-to-state-cache (from here &optional upper-lim)
2683 ;; If there is a brace pair preceding FROM in the buffer, at the same level
2684 ;; of nesting (not necessarily immediately preceding), push a cons onto
2685 ;; `c-state-cache' to represent it. FROM must not be inside a literal. If
2686 ;; UPPER-LIM is non-nil, we append the highest brace pair whose "}" is below
2689 ;; Return non-nil when this has been done.
2691 ;; The situation it copes with is this transformation:
2693 ;; OLD: { (.) {...........}
2697 ;; NEW: { {....} (.) {.........
2699 ;; LOWER BRACE PAIR HERE or HERE
2701 ;; This routine should be fast. Since it can get called a LOT, we maintain
2702 ;; `c-state-brace-pair-desert', a small cache of "failures", such that we
2703 ;; reduce the time wasted in repeated fruitless searches in brace deserts.
2707 (cache-pos (c-state-cache-top-lparen)) ; might be nil.
2708 (macro-start-or-from
2709 (progn (goto-char from)
2710 (c-beginning-of-macro)
2712 (bra ; Position of "{".
2713 ;; Don't start scanning in the middle of a CPP construct unless
2714 ;; it contains HERE - these constructs, in Emacs, are "commented
2715 ;; out" with category properties.
2716 (if (eq (c-get-char-property macro-start-or-from 'category)
2720 ce) ; Position of "}"
2721 (or upper-lim (setq upper-lim from))
2723 ;; If we're essentially repeating a fruitless search, just give up.
2724 (unless (and c-state-brace-pair-desert
2725 (eq cache-pos (car c-state-brace-pair-desert))
2726 (or (null (car c-state-brace-pair-desert))
2727 (> from (car c-state-brace-pair-desert)))
2728 (<= from (cdr c-state-brace-pair-desert)))
2729 ;; DESERT-LIM. Avoid repeated searching through the cached desert.
2731 (and c-state-brace-pair-desert
2732 (eq cache-pos (car c-state-brace-pair-desert))
2733 (>= from (cdr c-state-brace-pair-desert))
2734 (cdr c-state-brace-pair-desert)))
2735 ;; CACHE-LIM. This limit will be necessary when an opening
2736 ;; paren at `cache-pos' has just had its matching close paren
2737 ;; inserted into the buffer. `cache-pos' continues to be a
2738 ;; search bound, even though the algorithm below would skip
2739 ;; over the new paren pair.
2740 (cache-lim (and cache-pos (< cache-pos from) cache-pos)))
2743 ((and desert-lim cache-lim)
2744 (max desert-lim cache-lim))
2748 ;; The top limit is EOB to ensure that `bra' is inside the
2749 ;; accessible part of the buffer at the next scan operation.
2750 (1+ (buffer-size))))
2752 ;; In the next pair of nested loops, the inner one moves back past a
2753 ;; pair of (mis-)matching parens or brackets; the outer one moves
2754 ;; back over a sequence of unmatched close brace/paren/bracket each
2760 (and (setq ce (c-sc-scan-lists bra -1 -1)) ; back past )/]/}; might signal
2761 (setq bra (c-sc-scan-lists ce -1 1)) ; back past (/[/{; might signal
2762 (or (> bra here) ;(> ce here)
2765 (or (not (eq (char-after bra) ?\{))
2766 (and (goto-char bra)
2767 (c-beginning-of-macro)
2768 (< (point) macro-start-or-from))))))))
2769 (and ce (< ce bra)))
2770 (setq bra ce)) ; If we just backed over an unbalanced closing
2773 (if (and ce (< ce here) (< bra ce) (eq (char-after bra) ?\{))
2774 ;; We've found the desired brace-pair.
2776 (setq new-cons (cons bra (1+ ce)))
2778 ((consp (car c-state-cache))
2779 (setcar c-state-cache new-cons))
2780 ((and (numberp (car c-state-cache)) ; probably never happens
2781 (< ce (car c-state-cache)))
2782 (setcdr c-state-cache
2783 (cons new-cons (cdr c-state-cache))))
2784 (t (setq c-state-cache (cons new-cons c-state-cache)))))
2786 ;; We haven't found a brace pair. Record this in the cache.
2787 (setq c-state-brace-pair-desert
2788 (cons (if (and ce (< bra ce) (> ce here)) ; {..} straddling HERE?
2791 (min here from)))))))))
2793 (defsubst c-state-push-any-brace-pair (bra+1 macro-start-or-here)
2794 ;; If BRA+1 is nil, do nothing. Otherwise, BRA+1 is the buffer position
2795 ;; following a {, and that brace has a (mis-)matching } (or ]), and we
2796 ;; "push" "a" brace pair onto `c-state-cache'.
2798 ;; Here "push" means overwrite the top element if it's itself a brace-pair,
2799 ;; otherwise push it normally.
2801 ;; The brace pair we push is normally the one surrounding BRA+1, but if the
2802 ;; latter is inside a macro, not being a macro containing
2803 ;; MACRO-START-OR-HERE, we scan backwards through the buffer for a non-macro
2804 ;; base pair. This latter case is assumed to be rare.
2806 ;; Note: POINT is not preserved in this routine.
2808 (if (or (> bra+1 macro-start-or-here)
2809 (progn (goto-char bra+1)
2810 (not (c-beginning-of-macro))))
2812 (cons (cons (1- bra+1)
2813 (c-sc-scan-lists bra+1 1 1))
2814 (if (consp (car c-state-cache))
2817 ;; N.B. This defsubst codes one method for the simple, normal case,
2818 ;; and a more sophisticated, slower way for the general case. Don't
2819 ;; eliminate this defsubst - it's a speed optimization.
2820 (c-append-lower-brace-pair-to-state-cache (1- bra+1) (point-max)))))
2822 (defun c-append-to-state-cache (from here)
2823 ;; Scan the buffer from FROM to HERE, adding elements into `c-state-cache'
2824 ;; for braces etc. Return a candidate for `c-state-cache-good-pos'.
2826 ;; FROM must be after the latest brace/paren/bracket in `c-state-cache', if
2827 ;; any. Typically, it is immediately after it. It must not be inside a
2829 (let ((here-bol (c-point 'bol here))
2830 (macro-start-or-here
2831 (save-excursion (goto-char here)
2832 (if (c-beginning-of-macro)
2835 pa+1 ; pos just after an opening PAren (or brace).
2836 (ren+1 from) ; usually a pos just after an closing paREN etc.
2837 ; Is actually the pos. to scan for a (/{/[ from,
2838 ; which sometimes is after a silly )/}/].
2839 paren+1 ; Pos after some opening or closing paren.
2840 paren+1s ; A list of `paren+1's; used to determine a
2842 bra+1 ; just after L bra-ce.
2843 bra+1s ; list of OLD values of bra+1.
2844 mstart) ; start of a macro.
2848 (narrow-to-region (point-min) here)
2849 ;; Each time round the following loop, we enter a successively deeper
2850 ;; level of brace/paren nesting. (Except sometimes we "continue at
2851 ;; the existing level".) `pa+1' is a pos inside an opening
2852 ;; brace/paren/bracket, usually just after it.
2855 ;; Each time round the next loop moves forward over an opening then
2856 ;; a closing brace/bracket/paren. This loop is white hot, so it
2857 ;; plays ugly tricks to go fast. DON'T PUT ANYTHING INTO THIS
2858 ;; LOOP WHICH ISN'T ABSOLUTELY NECESSARY!!! It terminates when a
2859 ;; call of `scan-lists' signals an error, which happens when there
2860 ;; are no more b/b/p's to scan.
2863 (setq pa+1 (c-sc-scan-lists ren+1 1 -1) ; Into (/{/[; might signal
2864 paren+1s (cons pa+1 paren+1s))
2865 (setq ren+1 (c-sc-scan-lists pa+1 1 1)) ; Out of )/}/]; might signal
2866 (if (and (eq (char-before pa+1) ?{)) ; Check for a macro later.
2868 (setcar paren+1s ren+1)))
2870 (if (and pa+1 (> pa+1 ren+1))
2871 ;; We've just entered a deeper nesting level.
2873 ;; Insert the brace pair (if present) and the single open
2874 ;; paren/brace/bracket into `c-state-cache' It cannot be
2875 ;; inside a macro, except one around point, because of what
2876 ;; `c-neutralize-syntax-in-CPP' has done.
2877 (c-state-push-any-brace-pair bra+1 macro-start-or-here)
2878 ;; Insert the opening brace/bracket/paren position.
2879 (setq c-state-cache (cons (1- pa+1) c-state-cache))
2880 ;; Clear admin stuff for the next more nested part of the scan.
2881 (setq ren+1 pa+1 pa+1 nil bra+1 nil bra+1s nil)
2882 t) ; Carry on the loop
2884 ;; All open p/b/b's at this nesting level, if any, have probably
2885 ;; been closed by matching/mismatching ones. We're probably
2886 ;; finished - we just need to check for having found an
2887 ;; unmatched )/}/], which we ignore. Such a )/}/] can't be in a
2888 ;; macro, due the action of `c-neutralize-syntax-in-CPP'.
2889 (c-safe (setq ren+1 (c-sc-scan-lists ren+1 1 1)))))) ; acts as loop control.
2891 ;; Record the final, innermost, brace-pair if there is one.
2892 (c-state-push-any-brace-pair bra+1 macro-start-or-here)
2894 ;; Determine a good pos
2895 (while (and (setq paren+1 (car paren+1s))
2896 (> (if (> paren+1 macro-start-or-here)
2899 (setq mstart (and (c-beginning-of-macro)
2901 (or mstart paren+1))
2903 (setq paren+1s (cdr paren+1s)))
2905 ((and paren+1 mstart)
2906 (min paren+1 mstart))
2910 (defun c-remove-stale-state-cache (start-point here pps-point)
2911 ;; Remove stale entries from the `c-cache-state', i.e. those which will
2912 ;; not be in it when it is amended for position HERE. This may involve
2913 ;; replacing a CONS element for a brace pair containing HERE with its car.
2914 ;; Additionally, the "outermost" open-brace entry before HERE will be
2915 ;; converted to a cons if the matching close-brace is below HERE.
2917 ;; START-POINT is a "maximal" "safe position" - there must be no open
2918 ;; parens/braces/brackets between START-POINT and HERE.
2920 ;; As a second thing, calculate the result of parse-partial-sexp at
2921 ;; PPS-POINT, w.r.t. START-POINT. The motivation here is that
2922 ;; `c-state-cache-good-pos' may become PPS-POINT, but the caller may need to
2923 ;; adjust it to get outside a string/comment. (Sorry about this! The code
2924 ;; needs to be FAST).
2926 ;; Return a list (GOOD-POS SCAN-BACK-POS CONS-SEPARATED PPS-STATE), where
2927 ;; o - GOOD-POS is a position where the new value `c-state-cache' is known
2928 ;; to be good (we aim for this to be as high as possible);
2929 ;; o - SCAN-BACK-POS, if not nil, indicates there may be a brace pair
2930 ;; preceding POS which needs to be recorded in `c-state-cache'. It is a
2931 ;; position to scan backwards from. It is the position of the "{" of the
2932 ;; last element to be removed from `c-state-cache', when that elt is a
2933 ;; cons, otherwise nil.
2934 ;; o - CONS-SEPARATED is t when a cons element in `c-state-cache' has been
2935 ;; replaced by its car because HERE lies inside the brace pair represented
2937 ;; o - PPS-STATE is the parse-partial-sexp state at PPS-POINT.
2940 (narrow-to-region 1 (point-max))
2941 (let* ((in-macro-start ; start of macro containing HERE or nil.
2944 (and (c-beginning-of-macro)
2946 (start-point-actual-macro-start ; Start of macro containing
2947 ; start-point or nil
2948 (and (< start-point here)
2950 (goto-char start-point)
2951 (and (c-beginning-of-macro)
2953 (start-point-actual-macro-end ; End of this macro, (maybe
2955 (and start-point-actual-macro-start
2957 (goto-char start-point-actual-macro-start)
2960 pps-state ; Will be 9 or 10 elements long.
2962 upper-lim ; ,beyond which `c-state-cache' entries are removed
2965 pair-beg pps-point-state target-depth)
2967 ;; Remove entries beyond HERE. Also remove any entries inside
2968 ;; a macro, unless HERE is in the same macro.
2970 (if (or (null c-state-old-cpp-beg)
2971 (and (> here c-state-old-cpp-beg)
2972 (< here c-state-old-cpp-end)))
2974 (min here c-state-old-cpp-beg)))
2975 (while (and c-state-cache (>= (c-state-cache-top-lparen) upper-lim))
2976 (setq scan-back-pos (car-safe (car c-state-cache)))
2977 (setq c-state-cache (cdr c-state-cache)))
2979 ;; If `upper-lim' is inside the last recorded brace pair, remove its
2980 ;; RBrace and indicate we'll need to search backwards for a previous
2982 (when (and c-state-cache
2983 (consp (car c-state-cache))
2984 (> (cdar c-state-cache) upper-lim))
2985 (setcar c-state-cache (caar c-state-cache))
2986 (setq scan-back-pos (car c-state-cache)
2989 ;; The next loop jumps forward out of a nested level of parens each
2990 ;; time round; the corresponding elements in `c-state-cache' are
2991 ;; removed. `pos' is just after the brace-pair or the open paren at
2992 ;; (car c-state-cache). There can be no open parens/braces/brackets
2993 ;; between `start-point'/`start-point-actual-macro-start' and HERE,
2994 ;; due to the interface spec to this function.
2995 (setq pos (if (and start-point-actual-macro-end
2996 (not (eq start-point-actual-macro-start
2998 (1+ start-point-actual-macro-end) ; get outside the macro as
2999 ; marked by a `category' text property.
3002 (while (and c-state-cache
3003 (or (numberp (car c-state-cache)) ; Have we a { at all?
3004 (cdr c-state-cache))
3007 ((null pps-state) ; first time through
3008 (setq target-depth -1))
3009 ((eq (car pps-state) target-depth) ; found closing ),},]
3010 (setq target-depth (1- (car pps-state))))
3011 ;; Do nothing when we've merely reached pps-point.
3016 (c-sc-parse-partial-sexp
3017 (point) (if (< (point) pps-point) pps-point here)
3021 (if (= (point) pps-point)
3022 (setq pps-point-state pps-state))
3024 (when (eq (car pps-state) target-depth)
3025 (setq pos (point)) ; POS is now just after an R-paren/brace.
3027 ((and (consp (car c-state-cache))
3028 (eq (point) (cdar c-state-cache)))
3029 ;; We've just moved out of the paren pair containing the brace-pair
3030 ;; at (car c-state-cache). `pair-beg' is where the open paren is,
3031 ;; and is potentially where the open brace of a cons in
3032 ;; c-state-cache will be.
3033 (setq pair-beg (car-safe (cdr c-state-cache))
3034 c-state-cache (cdr-safe (cdr c-state-cache)))) ; remove {}pair + containing Lparen.
3035 ((numberp (car c-state-cache))
3036 (setq pair-beg (car c-state-cache)
3037 c-state-cache (cdr c-state-cache))) ; remove this
3039 ((numberp (cadr c-state-cache))
3040 (setq pair-beg (cadr c-state-cache)
3041 c-state-cache (cddr c-state-cache))) ; Remove a paren pair
3042 ; together with enclosed brace pair.
3043 ;; (t nil) ; Ignore an unmated Rparen.
3046 (if (< (point) pps-point)
3047 (setq pps-state (c-sc-parse-partial-sexp
3049 nil nil ; TARGETDEPTH, STOPBEFORE
3052 ;; If the last paren pair we moved out of was actually a brace pair,
3053 ;; insert it into `c-state-cache'.
3054 (when (and pair-beg (eq (char-after pair-beg) ?{))
3055 (if (consp (car-safe c-state-cache))
3056 (setq c-state-cache (cdr c-state-cache)))
3057 (setq c-state-cache (cons (cons pair-beg pos)
3060 (list pos scan-back-pos cons-separated pps-state)))))
3062 (defun c-remove-stale-state-cache-backwards (here)
3063 ;; Strip stale elements of `c-state-cache' by moving backwards through the
3064 ;; buffer, and inform the caller of the scenario detected.
3066 ;; HERE is the position we're setting `c-state-cache' for.
3067 ;; CACHE-POS (a locally bound variable) is just after the latest recorded
3068 ;; position in `c-state-cache' before HERE, or a position at or near
3069 ;; point-min which isn't in a literal.
3071 ;; This function must only be called only when (> `c-state-cache-good-pos'
3072 ;; HERE). Usually the gap between CACHE-POS and HERE is large. It is thus
3073 ;; optimized to eliminate (or minimize) scanning between these two
3076 ;; Return a three element list (GOOD-POS SCAN-BACK-POS FWD-FLAG), where:
3077 ;; o - GOOD-POS is a "good position", where `c-state-cache' is valid, or
3078 ;; could become so after missing elements are inserted into
3079 ;; `c-state-cache'. This is JUST AFTER an opening or closing
3080 ;; brace/paren/bracket which is already in `c-state-cache' or just before
3081 ;; one otherwise. exceptionally (when there's no such b/p/b handy) the BOL
3082 ;; before `here''s line, or the start of the literal containing it.
3083 ;; o - SCAN-BACK-POS, if non-nil, indicates there may be a brace pair
3084 ;; preceding POS which isn't recorded in `c-state-cache'. It is a position
3085 ;; to scan backwards from.
3086 ;; o - FWD-FLAG, if non-nil, indicates there may be parens/braces between
3087 ;; POS and HERE which aren't recorded in `c-state-cache'.
3089 ;; The comments in this defun use "paren" to mean parenthesis or square
3090 ;; bracket (as contrasted with a brace), and "(" and ")" likewise.
3092 ;; . {..} (..) (..) ( .. { } ) (...) ( .... . ..)
3094 ;; CP E here D C good
3095 (let ((cache-pos (c-get-cache-scan-pos here)) ; highest position below HERE in cache (or 1)
3096 (pos c-state-cache-good-pos)
3097 pa ren ; positions of "(" and ")"
3098 dropped-cons ; whether the last element dropped from `c-state-cache'
3099 ; was a cons (representing a brace-pair)
3100 good-pos ; see above.
3101 lit ; (START . END) of a literal containing some point.
3102 here-lit-start here-lit-end ; bounds of literal containing `here'
3104 here- here+ ; start/end of macro around HERE, or HERE
3105 (here-bol (c-point 'bol here))
3106 (too-far-back (max (- here c-state-cache-too-far) (point-min))))
3108 ;; Remove completely irrelevant entries from `c-state-cache'.
3109 (while (and c-state-cache
3110 (>= (setq pa (c-state-cache-top-lparen)) here))
3111 (setq dropped-cons (consp (car c-state-cache)))
3112 (setq c-state-cache (cdr c-state-cache))
3114 ;; At this stage, (>= pos here);
3115 ;; (< (c-state-cache-top-lparen) here) (or is nil).
3118 ((and (consp (car c-state-cache))
3119 (> (cdar c-state-cache) here))
3120 ;; CASE 1: The top of the cache is a brace pair which now encloses
3121 ;; `here'. As good-pos, return the address. of the "{". Since we've no
3122 ;; knowledge of what's inside these braces, we have no alternative but
3123 ;; to direct the caller to scan the buffer from the opening brace.
3124 (setq pos (caar c-state-cache))
3125 (setcar c-state-cache pos)
3126 (list (1+ pos) pos t)) ; return value. We've just converted a brace pair
3127 ; entry into a { entry, so the caller needs to
3128 ; search for a brace pair before the {.
3130 ;; `here' might be inside a literal. Check for this.
3132 (setq lit (c-state-literal-at here)
3133 here-lit-start (or (car lit) here)
3134 here-lit-end (or (cdr lit) here))
3135 ;; Has `here' just "newly entered" a macro?
3137 (goto-char here-lit-start)
3138 (if (and (c-beginning-of-macro)
3139 (or (null c-state-old-cpp-beg)
3140 (not (= (point) c-state-old-cpp-beg))))
3142 (setq here- (point))
3144 (setq here+ (point)))
3145 (setq here- here-lit-start
3146 here+ here-lit-end)))
3148 ;; `here' might be nested inside any depth of parens (or brackets but
3149 ;; not braces). Scan backwards to find the outermost such opening
3150 ;; paren, if there is one. This will be the scan position to return.
3152 (narrow-to-region cache-pos (point-max))
3153 (setq pos (c-state-balance-parens-backwards here- here+ pos)))
3154 nil)) ; for the cond
3156 ((< pos here-lit-start)
3157 ;; CASE 2: Address of outermost ( or [ which now encloses `here', but
3158 ;; didn't enclose the (previous) `c-state-cache-good-pos'. If there is
3159 ;; a brace pair preceding this, it will already be in `c-state-cache',
3160 ;; unless there was a brace pair after it, i.e. there'll only be one to
3161 ;; scan for if we've just deleted one.
3162 (list pos (and dropped-cons pos) t)) ; Return value.
3164 ;; `here' isn't enclosed in a (previously unrecorded) bracket/paren.
3165 ;; Further forward scanning isn't needed, but we still need to find a
3166 ;; GOOD-POS. Step out of all enclosing "("s on HERE's line.
3169 (narrow-to-region here-bol (point-max))
3170 (setq pos here-lit-start)
3171 (c-safe (while (setq pa (c-sc-scan-lists pos -1 1))
3172 (setq pos pa)))) ; might signal
3173 nil)) ; for the cond
3176 (narrow-to-region too-far-back (point-max))
3177 (setq ren (c-safe (c-sc-scan-lists pos -1 -1))))
3178 ;; CASE 3: After a }/)/] before `here''s BOL.
3179 (list (1+ ren) (and dropped-cons pos) nil)) ; Return value
3181 ((progn (setq good-pos (c-state-lit-beg (c-point 'bopl here-bol)))
3182 (>= cache-pos good-pos))
3183 ;; CASE 3.5: Just after an existing entry in `c-state-cache' on `here''s
3184 ;; line or the previous line.
3185 (list cache-pos nil nil))
3188 ;; CASE 4; Best of a bad job: BOL before `here-bol', or beginning of
3189 ;; literal containing it.
3190 (list good-pos (and dropped-cons good-pos) nil)))))
3193 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3194 ;; Externally visible routines.
3196 (defun c-state-cache-init ()
3197 (setq c-state-cache nil
3198 c-state-cache-good-pos 1
3199 c-state-nonlit-pos-cache nil
3200 c-state-nonlit-pos-cache-limit 1
3201 c-state-semi-nonlit-pos-cache nil
3202 c-state-semi-nonlit-pos-cache-limit 1
3203 c-state-brace-pair-desert nil
3205 c-state-point-min-lit-type nil
3206 c-state-point-min-lit-start nil
3207 c-state-min-scan-pos 1
3208 c-state-old-cpp-beg nil
3209 c-state-old-cpp-end nil)
3210 (c-state-mark-point-min-literal))
3212 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3213 ;; Debugging routines to dump `c-state-cache' in a "replayable" form.
3214 ;; (defmacro c-sc-de (elt) ; "c-state-cache-dump-element"
3215 ;; `(format ,(concat "(setq " (symbol-name elt) " %s) ") ,elt))
3216 ;; (defmacro c-sc-qde (elt) ; "c-state-cache-quote-dump-element"
3217 ;; `(format ,(concat "(setq " (symbol-name elt) " '%s) ") ,elt))
3218 ;; (defun c-state-dump ()
3219 ;; ;; For debugging.
3222 ;; (c-sc-qde c-state-cache)
3223 ;; (c-sc-de c-state-cache-good-pos)
3224 ;; (c-sc-qde c-state-nonlit-pos-cache)
3225 ;; (c-sc-de c-state-nonlit-pos-cache-limit)
3226 ;; (c-sc-qde c-state-brace-pair-desert)
3227 ;; (c-sc-de c-state-point-min)
3228 ;; (c-sc-de c-state-point-min-lit-type)
3229 ;; (c-sc-de c-state-point-min-lit-start)
3230 ;; (c-sc-de c-state-min-scan-pos)
3231 ;; (c-sc-de c-state-old-cpp-beg)
3232 ;; (c-sc-de c-state-old-cpp-end)))
3233 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3235 (defun c-invalidate-state-cache-1 (here)
3236 ;; Invalidate all info on `c-state-cache' that applies to the buffer at HERE
3237 ;; or higher and set `c-state-cache-good-pos' accordingly. The cache is
3238 ;; left in a consistent state.
3240 ;; This is much like `c-whack-state-after', but it never changes a paren
3241 ;; pair element into an open paren element. Doing that would mean that the
3242 ;; new open paren wouldn't have the required preceding paren pair element.
3244 ;; This function is called from c-before-change.
3246 ;; The caches of non-literals:
3247 ;; Note that we use "<=" for the possibility of the second char of a two-char
3248 ;; comment opener being typed; this would invalidate any cache position at
3250 (if (<= here c-state-nonlit-pos-cache-limit)
3251 (setq c-state-nonlit-pos-cache-limit (1- here)))
3252 (if (<= here c-state-semi-nonlit-pos-cache-limit)
3253 (setq c-state-semi-nonlit-pos-cache-limit (1- here)))
3256 ;; Case 1: if `here' is in a literal containing point-min, everything
3257 ;; becomes (or is already) nil.
3258 (if (or (null c-state-cache-good-pos)
3259 (< here (c-state-get-min-scan-pos)))
3260 (setq c-state-cache nil
3261 c-state-cache-good-pos nil
3262 c-state-min-scan-pos nil)
3264 ;; Truncate `c-state-cache' and set `c-state-cache-good-pos' to a value
3265 ;; below `here'. To maintain its consistency, we may need to insert a new
3267 (let ((here-bol (c-point 'bol here))
3268 too-high-pa ; recorded {/(/[ next above or just below here, or nil.
3269 dropped-cons ; was the last removed element a brace pair?
3271 ;; The easy bit - knock over-the-top bits off `c-state-cache'.
3272 (while (and c-state-cache
3273 (>= (setq pa (c-state-cache-top-paren)) here))
3274 (setq dropped-cons (consp (car c-state-cache))
3275 too-high-pa (c-state-cache-top-lparen)
3276 c-state-cache (cdr c-state-cache)))
3278 ;; Do we need to add in an earlier brace pair, having lopped one off?
3279 (if (and dropped-cons
3280 (<= too-high-pa here))
3281 (c-append-lower-brace-pair-to-state-cache too-high-pa here here-bol))
3282 (setq c-state-cache-good-pos (or (c-state-cache-after-top-paren)
3283 (c-state-get-min-scan-pos)))))
3285 ;; The brace-pair desert marker:
3286 (when (car c-state-brace-pair-desert)
3287 (if (< here (car c-state-brace-pair-desert))
3288 (setq c-state-brace-pair-desert nil)
3289 (if (< here (cdr c-state-brace-pair-desert))
3290 (setcdr c-state-brace-pair-desert here)))))
3292 (defun c-parse-state-1 ()
3293 ;; Find and record all noteworthy parens between some good point earlier in
3294 ;; the file and point. That good point is at least the beginning of the
3295 ;; top-level construct we are in, or the beginning of the preceding
3296 ;; top-level construct if we aren't in one.
3298 ;; The returned value is a list of the noteworthy parens with the last one
3299 ;; first. If an element in the list is an integer, it's the position of an
3300 ;; open paren (of any type) which has not been closed before the point. If
3301 ;; an element is a cons, it gives the position of a closed BRACE paren
3302 ;; pair[*]; the car is the start brace position and the cdr is the position
3303 ;; following the closing brace. Only the last closed brace paren pair
3304 ;; before each open paren and before the point is recorded, and thus the
3305 ;; state never contains two cons elements in succession. When a close brace
3306 ;; has no matching open brace (e.g., the matching brace is outside the
3307 ;; visible region), it is not represented in the returned value.
3309 ;; [*] N.B. The close "brace" might be a mismatching close bracket or paren.
3310 ;; This defun explicitly treats mismatching parens/braces/brackets as
3311 ;; matching. It is the open brace which makes it a "brace" pair.
3313 ;; If POINT is within a macro, open parens and brace pairs within
3314 ;; THIS macro MIGHT be recorded. This depends on whether their
3315 ;; syntactic properties have been suppressed by
3316 ;; `c-neutralize-syntax-in-CPP'. This might need fixing (2008-12-11).
3318 ;; Currently no characters which are given paren syntax with the
3319 ;; syntax-table property are recorded, i.e. angle bracket arglist
3320 ;; parens are never present here. Note that this might change.
3322 ;; BUG: This function doesn't cope entirely well with unbalanced
3323 ;; parens in macros. (2008-12-11: this has probably been resolved
3324 ;; by the function `c-neutralize-syntax-in-CPP'.) E.g. in the
3325 ;; following case the brace before the macro isn't balanced with the
3332 ;; Note to maintainers: this function DOES get called with point
3333 ;; within comments and strings, so don't assume it doesn't!
3335 ;; This function might do hidden buffer changes.
3336 (let* ((here (point))
3337 (here-bopl (c-point 'bopl))
3338 strategy ; 'forward, 'backward etc..
3339 ;; Candidate positions to start scanning from:
3340 cache-pos ; highest position below HERE already existing in
3343 start-point ; (when scanning forward) a place below HERE where there
3344 ; are no open parens/braces between it and HERE.
3348 scan-backward-pos scan-forward-p) ; used for 'backward.
3349 ;; If POINT-MIN has changed, adjust the cache
3350 (unless (= (point-min) c-state-point-min)
3351 (c-renarrow-state-cache))
3354 (setq res (c-parse-state-get-strategy here c-state-cache-good-pos)
3356 start-point (cadr res))
3358 (when (eq strategy 'BOD)
3359 (setq c-state-cache nil
3360 c-state-cache-good-pos start-point))
3364 ((memq strategy '(forward back-and-forward BOD))
3365 (setq res (c-remove-stale-state-cache start-point here here-bopl))
3366 (setq cache-pos (car res)
3367 scan-backward-pos (cadr res)
3368 cons-separated (car (cddr res))
3369 bopl-state (cadr (cddr res))) ; will be nil if (< here-bopl
3371 (if (and scan-backward-pos
3372 (or cons-separated (eq strategy 'forward))) ;scan-backward-pos
3373 (c-append-lower-brace-pair-to-state-cache scan-backward-pos here))
3375 (c-append-to-state-cache cache-pos here))
3376 (setq c-state-cache-good-pos
3378 (< good-pos (- here c-state-cache-too-far)))
3379 (c-state-cache-non-literal-place here-bopl bopl-state)
3382 ((eq strategy 'backward)
3383 (setq res (c-remove-stale-state-cache-backwards here)
3385 scan-backward-pos (cadr res)
3386 scan-forward-p (car (cddr res)))
3387 (if scan-backward-pos
3388 (c-append-lower-brace-pair-to-state-cache scan-backward-pos here))
3389 (setq c-state-cache-good-pos
3391 (c-append-to-state-cache good-pos here)
3394 (t ; (eq strategy 'IN-LIT)
3395 (setq c-state-cache nil
3396 c-state-cache-good-pos nil))))
3400 (defun c-invalidate-state-cache (here)
3401 ;; This is a wrapper over `c-invalidate-state-cache-1'.
3403 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3404 ;; of all parens in preprocessor constructs, except for any such construct
3405 ;; containing point. We can then call `c-invalidate-state-cache-1' without
3406 ;; worrying further about macros and template delimiters.
3407 (if (eval-when-compile (memq 'category-properties c-emacs-features))
3409 (c-with-<->-as-parens-suppressed
3410 (if (and c-state-old-cpp-beg
3411 (< c-state-old-cpp-beg here))
3412 (c-with-all-but-one-cpps-commented-out
3414 (min c-state-old-cpp-end here)
3415 (c-invalidate-state-cache-1 here))
3416 (c-with-cpps-commented-out
3417 (c-invalidate-state-cache-1 here))))
3419 (c-invalidate-state-cache-1 here)))
3421 (defmacro c-state-maybe-marker (place marker)
3422 ;; If PLACE is non-nil, return a marker marking it, otherwise nil.
3423 ;; We (re)use MARKER.
3425 (or ,marker (setq ,marker (make-marker)))
3426 (set-marker ,marker ,place)))
3428 (defun c-parse-state ()
3429 ;; This is a wrapper over `c-parse-state-1'. See that function for a
3430 ;; description of the functionality and return value.
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-parse-state-1' without worrying
3435 ;; further about macros and template delimiters.
3436 (let (here-cpp-beg here-cpp-end)
3438 (when (c-beginning-of-macro)
3439 (setq here-cpp-beg (point))
3441 (> (setq here-cpp-end (c-syntactic-end-of-macro))
3443 (setq here-cpp-beg nil here-cpp-end nil))))
3444 ;; FIXME!!! Put in a `condition-case' here to protect the integrity of the
3447 (if (eval-when-compile (memq 'category-properties c-emacs-features))
3449 (c-with-<->-as-parens-suppressed
3450 (if (and here-cpp-beg (> here-cpp-end here-cpp-beg))
3451 (c-with-all-but-one-cpps-commented-out
3452 here-cpp-beg here-cpp-end
3454 (c-with-cpps-commented-out
3455 (c-parse-state-1))))
3458 (setq c-state-old-cpp-beg
3459 (c-state-maybe-marker here-cpp-beg c-state-old-cpp-beg-marker)
3461 (c-state-maybe-marker here-cpp-end c-state-old-cpp-end-marker)))))
3463 ;; Debug tool to catch cache inconsistencies. This is called from
3465 (defvar c-debug-parse-state nil)
3466 (unless (fboundp 'c-real-parse-state)
3467 (fset 'c-real-parse-state (symbol-function 'c-parse-state)))
3468 (cc-bytecomp-defun c-real-parse-state)
3470 (defvar c-parse-state-point nil)
3471 (defvar c-parse-state-state nil)
3472 (make-variable-buffer-local 'c-parse-state-state)
3473 (defun c-record-parse-state-state ()
3474 (setq c-parse-state-point (point))
3475 (setq c-parse-state-state
3478 (let ((val (symbol-value arg)))
3480 (cond ((consp val) (copy-tree val))
3481 ((markerp val) (copy-marker val))
3484 c-state-cache-good-pos
3485 c-state-nonlit-pos-cache
3486 c-state-nonlit-pos-cache-limit
3487 c-state-semi-nonlit-pos-cache
3488 c-state-semi-nonlit-pos-cache-limit
3489 c-state-brace-pair-desert
3491 c-state-point-min-lit-type
3492 c-state-point-min-lit-start
3493 c-state-min-scan-pos
3496 c-parse-state-point))))
3497 (defun c-replay-parse-state-state ()
3502 (format "%s %s%s" (car arg)
3503 (if (atom (cdr arg)) "" "'")
3504 (if (markerp (cdr arg))
3505 (format "(copy-marker %s)" (marker-position (cdr arg)))
3507 c-parse-state-state " ")
3510 (defun c-debug-parse-state-double-cons (state)
3511 (let (state-car conses-not-ok)
3513 (setq state-car (car state)
3515 (if (and (consp state-car)
3516 (consp (car state)))
3517 (setq conses-not-ok t)))
3520 (defun c-debug-parse-state ()
3521 (let ((here (point)) (res1 (c-real-parse-state)) res2)
3522 (let ((c-state-cache nil)
3523 (c-state-cache-good-pos 1)
3524 (c-state-nonlit-pos-cache nil)
3525 (c-state-nonlit-pos-cache-limit 1)
3526 (c-state-brace-pair-desert nil)
3527 (c-state-point-min 1)
3528 (c-state-point-min-lit-type nil)
3529 (c-state-point-min-lit-start nil)
3530 (c-state-min-scan-pos 1)
3531 (c-state-old-cpp-beg nil)
3532 (c-state-old-cpp-end nil))
3533 (setq res2 (c-real-parse-state)))
3534 (unless (equal res1 res2)
3535 ;; The cache can actually go further back due to the ad-hoc way
3536 ;; the first paren is found, so try to whack off a bit of its
3537 ;; start before complaining.
3539 ;; (goto-char (or (c-least-enclosing-brace res2) (point)))
3540 ;; (c-beginning-of-defun-1)
3541 ;; (while (not (or (bobp) (eq (char-after) ?{)))
3542 ;; (c-beginning-of-defun-1))
3543 ;; (unless (equal (c-whack-state-before (point) res1) res2)
3544 ;; (message (concat "c-parse-state inconsistency at %s: "
3545 ;; "using cache: %s, from scratch: %s")
3546 ;; here res1 res2)))
3547 (message (concat "c-parse-state inconsistency at %s: "
3548 "using cache: %s, from scratch: %s")
3550 (message "Old state:")
3551 (c-replay-parse-state-state))
3553 (when (c-debug-parse-state-double-cons res1)
3554 (message "c-parse-state INVALIDITY at %s: %s"
3556 (message "Old state:")
3557 (c-replay-parse-state-state))
3559 (c-record-parse-state-state)
3560 res2 ; res1 correct a cascading series of errors ASAP
3563 (defun c-toggle-parse-state-debug (&optional arg)
3565 (setq c-debug-parse-state (c-calculate-state arg c-debug-parse-state))
3566 (fset 'c-parse-state (symbol-function (if c-debug-parse-state
3567 'c-debug-parse-state
3568 'c-real-parse-state)))
3569 (c-keep-region-active)
3570 (message "c-debug-parse-state %sabled"
3571 (if c-debug-parse-state "en" "dis")))
3572 (when c-debug-parse-state
3573 (c-toggle-parse-state-debug 1))
3576 (defun c-whack-state-before (bufpos paren-state)
3577 ;; Whack off any state information from PAREN-STATE which lies
3578 ;; before BUFPOS. Not destructive on PAREN-STATE.
3579 (let* ((newstate (list nil))
3583 (setq car (car paren-state)
3584 paren-state (cdr paren-state))
3585 (if (< (if (consp car) (car car) car) bufpos)
3586 (setq paren-state nil)
3587 (setcdr ptr (list car))
3588 (setq ptr (cdr ptr))))
3591 (defun c-whack-state-after (bufpos paren-state)
3592 ;; Whack off any state information from PAREN-STATE which lies at or
3593 ;; after BUFPOS. Not destructive on PAREN-STATE.
3596 (let ((car (car paren-state)))
3598 ;; just check the car, because in a balanced brace
3599 ;; expression, it must be impossible for the corresponding
3600 ;; close brace to be before point, but the open brace to
3602 (if (<= bufpos (car car))
3604 (if (< bufpos (cdr car))
3605 ;; its possible that the open brace is before
3606 ;; bufpos, but the close brace is after. In that
3607 ;; case, convert this to a non-cons element. The
3608 ;; rest of the state is before bufpos, so we're
3610 (throw 'done (cons (car car) (cdr paren-state)))
3611 ;; we know that both the open and close braces are
3612 ;; before bufpos, so we also know that everything else
3613 ;; on state is before bufpos.
3614 (throw 'done paren-state)))
3617 ;; it's before bufpos, so everything else should too.
3618 (throw 'done paren-state)))
3619 (setq paren-state (cdr paren-state)))
3622 (defun c-most-enclosing-brace (paren-state &optional bufpos)
3623 ;; Return the bufpos of the innermost enclosing open paren before
3624 ;; bufpos, or nil if none was found.
3626 (or bufpos (setq bufpos 134217727))
3628 (setq enclosingp (car paren-state)
3629 paren-state (cdr paren-state))
3630 (if (or (consp enclosingp)
3631 (>= enclosingp bufpos))
3632 (setq enclosingp nil)
3633 (setq paren-state nil)))
3636 (defun c-least-enclosing-brace (paren-state)
3637 ;; Return the bufpos of the outermost enclosing open paren, or nil
3638 ;; if none was found.
3641 (setq elem (car paren-state)
3642 paren-state (cdr paren-state))
3647 (defun c-safe-position (bufpos paren-state)
3648 ;; Return the closest "safe" position recorded on PAREN-STATE that
3649 ;; is higher up than BUFPOS. Return nil if PAREN-STATE doesn't
3650 ;; contain any. Return nil if BUFPOS is nil, which is useful to
3651 ;; find the closest limit before a given limit that might be nil.
3653 ;; A "safe" position is a position at or after a recorded open
3654 ;; paren, or after a recorded close paren. The returned position is
3655 ;; thus either the first position after a close brace, or the first
3656 ;; position after an enclosing paren, or at the enclosing paren in
3657 ;; case BUFPOS is immediately after it.
3662 (setq elem (car paren-state))
3664 (cond ((< (cdr elem) bufpos)
3665 (throw 'done (cdr elem)))
3666 ((< (car elem) bufpos)
3668 (throw 'done (min (1+ (car elem)) bufpos))))
3670 ;; elem is the position at and not after the opening paren, so
3671 ;; we can go forward one more step unless it's equal to
3672 ;; bufpos. This is useful in some cases avoid an extra paren
3673 ;; level between the safe position and bufpos.
3674 (throw 'done (min (1+ elem) bufpos))))
3675 (setq paren-state (cdr paren-state)))))))
3677 (defun c-beginning-of-syntax ()
3678 ;; This is used for `font-lock-beginning-of-syntax-function'. It
3679 ;; goes to the closest previous point that is known to be outside
3680 ;; any string literal or comment. `c-state-cache' is used if it has
3681 ;; a position in the vicinity.
3682 (let* ((paren-state c-state-cache)
3686 ;; Note: Similar code in `c-safe-position'. The
3687 ;; difference is that we accept a safe position at
3688 ;; the point and don't bother to go forward past open
3691 (setq elem (car paren-state))
3693 (cond ((<= (cdr elem) (point))
3694 (throw 'done (cdr elem)))
3695 ((<= (car elem) (point))
3696 (throw 'done (car elem))))
3697 (if (<= elem (point))
3698 (throw 'done elem)))
3699 (setq paren-state (cdr paren-state)))
3702 (if (> pos (- (point) 4000))
3704 ;; The position is far back. Try `c-beginning-of-defun-1'
3705 ;; (although we can't be entirely sure it will go to a position
3706 ;; outside a comment or string in current emacsen). FIXME:
3707 ;; Consult `syntax-ppss' here.
3708 (c-beginning-of-defun-1)
3713 ;; Tools for scanning identifiers and other tokens.
3715 (defun c-on-identifier ()
3716 "Return non-nil if the point is on or directly after an identifier.
3717 Keywords are recognized and not considered identifiers. If an
3718 identifier is detected, the returned value is its starting position.
3719 If an identifier ends at the point and another begins at it \(can only
3720 happen in Pike) then the point for the preceding one is returned.
3722 Note that this function might do hidden buffer changes. See the
3723 comment at the start of cc-engine.el for more info."
3725 ;; FIXME: Shouldn't this function handle "operator" in C++?
3728 (skip-syntax-backward "w_")
3732 ;; Check for a normal (non-keyword) identifier.
3733 (and (looking-at c-symbol-start)
3734 (not (looking-at c-keywords-regexp))
3737 (when (c-major-mode-is 'pike-mode)
3738 ;; Handle the `<operator> syntax in Pike.
3739 (let ((pos (point)))
3740 (skip-chars-backward "-!%&*+/<=>^|~[]()")
3741 (and (if (< (skip-chars-backward "`") 0)
3744 (eq (char-after) ?\`))
3745 (looking-at c-symbol-key)
3746 (>= (match-end 0) pos)
3749 ;; Handle the "operator +" syntax in C++.
3750 (when (and c-overloadable-operators-regexp
3751 (= (c-backward-token-2 0) 0))
3753 (cond ((and (looking-at c-overloadable-operators-regexp)
3754 (or (not c-opt-op-identifier-prefix)
3755 (and (= (c-backward-token-2 1) 0)
3756 (looking-at c-opt-op-identifier-prefix))))
3760 (and c-opt-op-identifier-prefix
3761 (looking-at c-opt-op-identifier-prefix)
3762 (= (c-forward-token-2 1) 0)
3763 (looking-at c-overloadable-operators-regexp)))
3768 (defsubst c-simple-skip-symbol-backward ()
3769 ;; If the point is at the end of a symbol then skip backward to the
3770 ;; beginning of it. Don't move otherwise. Return non-nil if point
3773 ;; This function might do hidden buffer changes.
3774 (or (< (skip-syntax-backward "w_") 0)
3775 (and (c-major-mode-is 'pike-mode)
3776 ;; Handle the `<operator> syntax in Pike.
3777 (let ((pos (point)))
3778 (if (and (< (skip-chars-backward "-!%&*+/<=>^|~[]()") 0)
3779 (< (skip-chars-backward "`") 0)
3780 (looking-at c-symbol-key)
3781 (>= (match-end 0) pos))
3786 (defun c-beginning-of-current-token (&optional back-limit)
3787 ;; Move to the beginning of the current token. Do not move if not
3788 ;; in the middle of one. BACK-LIMIT may be used to bound the
3789 ;; backward search; if given it's assumed to be at the boundary
3790 ;; between two tokens. Return non-nil if the point is moved, nil
3793 ;; This function might do hidden buffer changes.
3794 (let ((start (point)))
3795 (if (looking-at "\\w\\|\\s_")
3796 (skip-syntax-backward "w_" back-limit)
3797 (when (< (skip-syntax-backward ".()" back-limit) 0)
3798 (while (let ((pos (or (and (looking-at c-nonsymbol-token-regexp)
3800 ;; `c-nonsymbol-token-regexp' should always match
3801 ;; since we've skipped backward over punctuation
3802 ;; or paren syntax, but consume one char in case
3803 ;; it doesn't so that we don't leave point before
3804 ;; some earlier incorrect token.
3807 (goto-char pos))))))
3810 (defun c-end-of-current-token (&optional back-limit)
3811 ;; Move to the end of the current token. Do not move if not in the
3812 ;; middle of one. BACK-LIMIT may be used to bound the backward
3813 ;; search; if given it's assumed to be at the boundary between two
3814 ;; tokens. Return non-nil if the point is moved, nil otherwise.
3816 ;; This function might do hidden buffer changes.
3817 (let ((start (point)))
3818 (cond ((< (skip-syntax-backward "w_" (1- start)) 0)
3819 (skip-syntax-forward "w_"))
3820 ((< (skip-syntax-backward ".()" back-limit) 0)
3822 (if (looking-at c-nonsymbol-token-regexp)
3823 (goto-char (match-end 0))
3824 ;; `c-nonsymbol-token-regexp' should always match since
3825 ;; we've skipped backward over punctuation or paren
3826 ;; syntax, but move forward in case it doesn't so that
3827 ;; we don't leave point earlier than we started with.
3829 (< (point) start)))))
3832 (defconst c-jump-syntax-balanced
3833 (if (memq 'gen-string-delim c-emacs-features)
3834 "\\w\\|\\s_\\|\\s(\\|\\s)\\|\\s\"\\|\\s|"
3835 "\\w\\|\\s_\\|\\s(\\|\\s)\\|\\s\""))
3837 (defconst c-jump-syntax-unbalanced
3838 (if (memq 'gen-string-delim c-emacs-features)
3839 "\\w\\|\\s_\\|\\s\"\\|\\s|"
3840 "\\w\\|\\s_\\|\\s\""))
3842 (defun c-forward-token-2 (&optional count balanced limit)
3843 "Move forward by tokens.
3844 A token is defined as all symbols and identifiers which aren't
3845 syntactic whitespace \(note that multicharacter tokens like \"==\" are
3846 treated properly). Point is always either left at the beginning of a
3847 token or not moved at all. COUNT specifies the number of tokens to
3848 move; a negative COUNT moves in the opposite direction. A COUNT of 0
3849 moves to the next token beginning only if not already at one. If
3850 BALANCED is true, move over balanced parens, otherwise move into them.
3851 Also, if BALANCED is true, never move out of an enclosing paren.
3853 LIMIT sets the limit for the movement and defaults to the point limit.
3854 The case when LIMIT is set in the middle of a token, comment or macro
3855 is handled correctly, i.e. the point won't be left there.
3857 Return the number of tokens left to move \(positive or negative). If
3858 BALANCED is true, a move over a balanced paren counts as one. Note
3859 that if COUNT is 0 and no appropriate token beginning is found, 1 will
3860 be returned. Thus, a return value of 0 guarantees that point is at
3861 the requested position and a return value less \(without signs) than
3862 COUNT guarantees that point is at the beginning of some token.
3864 Note that this function might do hidden buffer changes. See the
3865 comment at the start of cc-engine.el for more info."
3867 (or count (setq count 1))
3869 (- (c-backward-token-2 (- count) balanced limit))
3871 (let ((jump-syntax (if balanced
3872 c-jump-syntax-balanced
3873 c-jump-syntax-unbalanced))
3878 ;; If count is zero we should jump if in the middle of a token.
3879 (c-end-of-current-token))
3882 (if limit (narrow-to-region (point-min) limit))
3884 (progn (c-forward-syntactic-ws) (point)))
3885 ;; Skip whitespace. Count this as a move if we did in
3887 (setq count (max (1- count) 0)))
3890 ;; Moved out of bounds. Make sure the returned count isn't zero.
3892 (if (zerop count) (setq count 1))
3895 ;; Use `condition-case' to avoid having the limit tests
3902 (cond ((looking-at jump-syntax)
3903 (goto-char (scan-sexps (point) 1))
3905 ((looking-at c-nonsymbol-token-regexp)
3906 (goto-char (match-end 0))
3908 ;; `c-nonsymbol-token-regexp' above should always
3909 ;; match if there are correct tokens. Try to
3910 ;; widen to see if the limit was set in the
3911 ;; middle of one, else fall back to treating
3912 ;; the offending thing as a one character token.
3916 (looking-at c-nonsymbol-token-regexp)))
3921 (c-forward-syntactic-ws)
3924 (error (goto-char last)))
3928 (setq count (1+ count)))))
3932 (defun c-backward-token-2 (&optional count balanced limit)
3933 "Move backward by tokens.
3934 See `c-forward-token-2' for details."
3936 (or count (setq count 1))
3938 (- (c-forward-token-2 (- count) balanced limit))
3940 (or limit (setq limit (point-min)))
3941 (let ((jump-syntax (if balanced
3942 c-jump-syntax-balanced
3943 c-jump-syntax-unbalanced))
3947 ;; The count is zero so try to skip to the beginning of the
3950 (progn (c-beginning-of-current-token) (point)))
3951 (if (< (point) limit)
3952 ;; The limit is inside the same token, so return 1.
3955 ;; We're not in the middle of a token. If there's
3956 ;; whitespace after the point then we must move backward,
3957 ;; so set count to 1 in that case.
3958 (and (looking-at c-syntactic-ws-start)
3959 ;; If we're looking at a '#' that might start a cpp
3960 ;; directive then we have to do a more elaborate check.
3961 (or (/= (char-after) ?#)
3962 (not c-opt-cpp-prefix)
3965 (progn (beginning-of-line)
3966 (looking-at "[ \t]*")
3969 (progn (backward-char)
3970 (not (eq (char-before) ?\\)))))))
3973 ;; Use `condition-case' to avoid having to check for buffer
3974 ;; limits in `backward-char', `scan-sexps' and `goto-char' below.
3979 (c-backward-syntactic-ws)
3981 (if (looking-at jump-syntax)
3982 (goto-char (scan-sexps (1+ (point)) -1))
3983 ;; This can be very inefficient if there's a long
3984 ;; sequence of operator tokens without any separation.
3985 ;; That doesn't happen in practice, anyway.
3986 (c-beginning-of-current-token))
3987 (>= (point) limit)))
3990 (error (goto-char last)))
3992 (if (< (point) limit)
3997 (defun c-forward-token-1 (&optional count balanced limit)
3998 "Like `c-forward-token-2' but doesn't treat multicharacter operator
3999 tokens like \"==\" as single tokens, i.e. all sequences of symbol
4000 characters are jumped over character by character. This function is
4001 for compatibility only; it's only a wrapper over `c-forward-token-2'."
4002 (let ((c-nonsymbol-token-regexp "\\s."))
4003 (c-forward-token-2 count balanced limit)))
4005 (defun c-backward-token-1 (&optional count balanced limit)
4006 "Like `c-backward-token-2' but doesn't treat multicharacter operator
4007 tokens like \"==\" as single tokens, i.e. all sequences of symbol
4008 characters are jumped over character by character. This function is
4009 for compatibility only; it's only a wrapper over `c-backward-token-2'."
4010 (let ((c-nonsymbol-token-regexp "\\s."))
4011 (c-backward-token-2 count balanced limit)))
4014 ;; Tools for doing searches restricted to syntactically relevant text.
4016 (defun c-syntactic-re-search-forward (regexp &optional bound noerror
4017 paren-level not-inside-token
4018 lookbehind-submatch)
4019 "Like `re-search-forward', but only report matches that are found
4020 in syntactically significant text. I.e. matches in comments, macros
4021 or string literals are ignored. The start point is assumed to be
4022 outside any comment, macro or string literal, or else the content of
4023 that region is taken as syntactically significant text.
4025 If PAREN-LEVEL is non-nil, an additional restriction is added to
4026 ignore matches in nested paren sexps. The search will also not go
4027 outside the current list sexp, which has the effect that if the point
4028 should be moved to BOUND when no match is found \(i.e. NOERROR is
4029 neither nil nor t), then it will be at the closing paren if the end of
4030 the current list sexp is encountered first.
4032 If NOT-INSIDE-TOKEN is non-nil, matches in the middle of tokens are
4033 ignored. Things like multicharacter operators and special symbols
4034 \(e.g. \"`()\" in Pike) are handled but currently not floating point
4037 If LOOKBEHIND-SUBMATCH is non-nil, it's taken as a number of a
4038 subexpression in REGEXP. The end of that submatch is used as the
4039 position to check for syntactic significance. If LOOKBEHIND-SUBMATCH
4040 isn't used or if that subexpression didn't match then the start
4041 position of the whole match is used instead. The \"look behind\"
4042 subexpression is never tested before the starting position, so it
4043 might be a good idea to include \\=\\= as a match alternative in it.
4045 Optimization note: Matches might be missed if the \"look behind\"
4046 subexpression can match the end of nonwhite syntactic whitespace,
4047 i.e. the end of comments or cpp directives. This since the function
4048 skips over such things before resuming the search. It's on the other
4049 hand not safe to assume that the \"look behind\" subexpression never
4050 matches syntactic whitespace.
4052 Bug: Unbalanced parens inside cpp directives are currently not handled
4053 correctly \(i.e. they don't get ignored as they should) when
4056 Note that this function might do hidden buffer changes. See the
4057 comment at the start of cc-engine.el for more info."
4059 (or bound (setq bound (point-max)))
4060 (if paren-level (setq paren-level -1))
4062 ;;(message "c-syntactic-re-search-forward %s %s %S" (point) bound regexp)
4064 (let ((start (point))
4066 ;; Start position for the last search.
4068 ;; The `parse-partial-sexp' state between the start position
4071 ;; The current position after the last state update. The next
4072 ;; `parse-partial-sexp' continues from here.
4074 ;; The position at which to check the state and the state
4075 ;; there. This is separate from `state-pos' since we might
4076 ;; need to back up before doing the next search round.
4077 check-pos check-state
4078 ;; Last position known to end a token.
4079 (last-token-end-pos (point-min))
4080 ;; Set when a valid match is found.
4087 (setq search-pos (point))
4088 (re-search-forward regexp bound noerror))
4091 (setq state (parse-partial-sexp
4092 state-pos (match-beginning 0) paren-level nil state)
4094 (if (setq check-pos (and lookbehind-submatch
4095 (or (not paren-level)
4097 (match-end lookbehind-submatch)))
4098 (setq check-state (parse-partial-sexp
4099 state-pos check-pos paren-level nil state))
4100 (setq check-pos state-pos
4103 ;; NOTE: If we got a look behind subexpression and get
4104 ;; an insignificant match in something that isn't
4105 ;; syntactic whitespace (i.e. strings or in nested
4106 ;; parentheses), then we can never skip more than a
4107 ;; single character from the match start position
4108 ;; (i.e. `state-pos' here) before continuing the
4109 ;; search. That since the look behind subexpression
4110 ;; might match the end of the insignificant region in
4114 ((elt check-state 7)
4115 ;; Match inside a line comment. Skip to eol. Use
4116 ;; `re-search-forward' instead of `skip-chars-forward' to get
4117 ;; the right bound behavior.
4118 (re-search-forward "[\n\r]" bound noerror))
4120 ((elt check-state 4)
4121 ;; Match inside a block comment. Skip to the '*/'.
4122 (search-forward "*/" bound noerror))
4124 ((and (not (elt check-state 5))
4125 (eq (char-before check-pos) ?/)
4126 (not (c-get-char-property (1- check-pos) 'syntax-table))
4127 (memq (char-after check-pos) '(?/ ?*)))
4128 ;; Match in the middle of the opener of a block or line
4130 (if (= (char-after check-pos) ?/)
4131 (re-search-forward "[\n\r]" bound noerror)
4132 (search-forward "*/" bound noerror)))
4134 ;; The last `parse-partial-sexp' above might have
4135 ;; stopped short of the real check position if the end
4136 ;; of the current sexp was encountered in paren-level
4137 ;; mode. The checks above are always false in that
4138 ;; case, and since they can do better skipping in
4139 ;; lookbehind-submatch mode, we do them before
4140 ;; checking the paren level.
4143 (/= (setq tmp (car check-state)) 0))
4144 ;; Check the paren level first since we're short of the
4145 ;; syntactic checking position if the end of the
4146 ;; current sexp was encountered by `parse-partial-sexp'.
4149 ;; Inside a nested paren sexp.
4150 (if lookbehind-submatch
4151 ;; See the NOTE above.
4152 (progn (goto-char state-pos) t)
4153 ;; Skip out of the paren quickly.
4154 (setq state (parse-partial-sexp state-pos bound 0 nil state)
4157 ;; Have exited the current paren sexp.
4160 ;; The last `parse-partial-sexp' call above
4161 ;; has left us just after the closing paren
4162 ;; in this case, so we can modify the bound
4163 ;; to leave the point at the right position
4165 (setq bound (1- (point)))
4167 (signal 'search-failed (list regexp)))))
4169 ((setq tmp (elt check-state 3))
4170 ;; Match inside a string.
4171 (if (or lookbehind-submatch
4172 (not (integerp tmp)))
4173 ;; See the NOTE above.
4174 (progn (goto-char state-pos) t)
4175 ;; Skip to the end of the string before continuing.
4176 (let ((ender (make-string 1 tmp)) (continue t))
4177 (while (if (search-forward ender bound noerror)
4179 (setq state (parse-partial-sexp
4180 state-pos (point) nil nil state)
4183 (setq continue nil)))
4188 (c-beginning-of-macro start)))
4189 ;; Match inside a macro. Skip to the end of it.
4191 (cond ((<= (point) bound) t)
4193 (t (signal 'search-failed (list regexp)))))
4195 ((and not-inside-token
4196 (or (< check-pos last-token-end-pos)
4199 (goto-char check-pos)
4201 (c-end-of-current-token last-token-end-pos))
4202 (setq last-token-end-pos (point))))))
4204 (if lookbehind-submatch
4205 ;; See the NOTE above.
4206 (goto-char state-pos)
4207 (goto-char (min last-token-end-pos bound))))
4214 ;; Should loop to search again, but take care to avoid
4215 ;; looping on the same spot.
4216 (or (/= search-pos (point))
4217 (if (= (point) bound)
4220 (signal 'search-failed (list regexp)))
4226 (signal (car err) (cdr err))))
4228 ;;(message "c-syntactic-re-search-forward done %s" (or (match-end 0) (point)))
4232 (goto-char (match-end 0))
4235 ;; Search failed. Set point as appropriate.
4241 (defvar safe-pos-list) ; bound in c-syntactic-skip-backward
4243 (defsubst c-ssb-lit-begin ()
4244 ;; Return the start of the literal point is in, or nil.
4245 ;; We read and write the variables `safe-pos', `safe-pos-list', `state'
4246 ;; bound in the caller.
4248 ;; Use `parse-partial-sexp' from a safe position down to the point to check
4249 ;; if it's outside comments and strings.
4251 (let ((pos (point)) safe-pos state)
4252 ;; Pick a safe position as close to the point as possible.
4254 ;; FIXME: Consult `syntax-ppss' here if our cache doesn't give a good
4257 (while (and safe-pos-list
4258 (> (car safe-pos-list) (point)))
4259 (setq safe-pos-list (cdr safe-pos-list)))
4260 (unless (setq safe-pos (car-safe safe-pos-list))
4261 (setq safe-pos (max (or (c-safe-position
4262 (point) (or c-state-cache
4266 safe-pos-list (list safe-pos)))
4268 ;; Cache positions along the way to use if we have to back up more. We
4269 ;; cache every closing paren on the same level. If the paren cache is
4270 ;; relevant in this region then we're typically already on the same
4271 ;; level as the target position. Note that we might cache positions
4272 ;; after opening parens in case safe-pos is in a nested list. That's
4273 ;; both uncommon and harmless.
4275 (setq state (parse-partial-sexp
4278 (setq safe-pos (point)
4279 safe-pos-list (cons safe-pos safe-pos-list)))
4281 ;; If the state contains the start of the containing sexp we cache that
4282 ;; position too, so that parse-partial-sexp in the next run has a bigger
4283 ;; chance of starting at the same level as the target position and thus
4284 ;; will get more good safe positions into the list.
4286 (setq safe-pos (1+ (elt state 1))
4287 safe-pos-list (cons safe-pos safe-pos-list)))
4289 (if (or (elt state 3) (elt state 4))
4290 ;; Inside string or comment. Continue search at the
4294 (defun c-syntactic-skip-backward (skip-chars &optional limit paren-level)
4295 "Like `skip-chars-backward' but only look at syntactically relevant chars,
4296 i.e. don't stop at positions inside syntactic whitespace or string
4297 literals. Preprocessor directives are also ignored, with the exception
4298 of the one that the point starts within, if any. If LIMIT is given,
4299 it's assumed to be at a syntactically relevant position.
4301 If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4302 sexps, and the search will also not go outside the current paren sexp.
4303 However, if LIMIT or the buffer limit is reached inside a nested paren
4304 then the point will be left at the limit.
4306 Non-nil is returned if the point moved, nil otherwise.
4308 Note that this function might do hidden buffer changes. See the
4309 comment at the start of cc-engine.el for more info."
4311 (let ((start (point))
4313 ;; A list of syntactically relevant positions in descending
4314 ;; order. It's used to avoid scanning repeatedly over
4315 ;; potentially large regions with `parse-partial-sexp' to verify
4316 ;; each position. Used in `c-ssb-lit-begin'
4318 ;; The result from `c-beginning-of-macro' at the start position or the
4319 ;; start position itself if it isn't within a macro. Evaluated on
4322 ;; The earliest position after the current one with the same paren
4323 ;; level. Used only when `paren-level' is set.
4325 (paren-level-pos (point)))
4329 ;; The next loop "tries" to find the end point each time round,
4330 ;; loops when it hasn't succeeded.
4333 (let ((pos (point)))
4335 (< (skip-chars-backward skip-chars limit) 0)
4336 ;; Don't stop inside a literal.
4337 (when (setq lit-beg (c-ssb-lit-begin))
4342 (let ((pos (point)) state-2 pps-end-pos)
4347 (setq state-2 (parse-partial-sexp
4348 pos paren-level-pos -1)
4349 pps-end-pos (point))
4350 (/= (car state-2) 0)))
4351 ;; Not at the right level.
4353 (if (and (< (car state-2) 0)
4354 ;; We stop above if we go out of a paren.
4355 ;; Now check whether it precedes or is
4356 ;; nested in the starting sexp.
4360 pps-end-pos paren-level-pos
4362 (< (car state-2) 0)))
4364 ;; We've stopped short of the starting position
4365 ;; so the hit was inside a nested list. Go up
4366 ;; until we are at the right level.
4369 (goto-char (scan-lists pos -1
4371 (setq paren-level-pos (point))
4372 (if (and limit (>= limit paren-level-pos))
4378 (goto-char (or limit (point-min)))
4381 ;; The hit was outside the list at the start
4382 ;; position. Go to the start of the list and exit.
4383 (goto-char (1+ (elt state-2 1)))
4386 ((c-beginning-of-macro limit)
4390 (setq start-macro-beg
4393 (c-beginning-of-macro limit)
4397 ;; It's inside the same macro we started in so it's
4398 ;; a relevant match.
4404 ;; Skip syntactic ws afterwards so that we don't stop at the
4405 ;; end of a comment if `skip-chars' is something like "^/".
4406 (c-backward-syntactic-ws)
4409 ;; We might want to extend this with more useful return values in
4411 (/= (point) start)))
4413 ;; The following is an alternative implementation of
4414 ;; `c-syntactic-skip-backward' that uses backward movement to keep
4415 ;; track of the syntactic context. It turned out to be generally
4416 ;; slower than the one above which uses forward checks from earlier
4419 ;;(defconst c-ssb-stop-re
4420 ;; ;; The regexp matching chars `c-syntactic-skip-backward' needs to
4421 ;; ;; stop at to avoid going into comments and literals.
4423 ;; ;; Match comment end syntax and string literal syntax. Also match
4424 ;; ;; '/' for block comment endings (not covered by comment end
4426 ;; "\\s>\\|/\\|\\s\""
4427 ;; (if (memq 'gen-string-delim c-emacs-features)
4430 ;; (if (memq 'gen-comment-delim c-emacs-features)
4434 ;;(defconst c-ssb-stop-paren-re
4435 ;; ;; Like `c-ssb-stop-re' but also stops at paren chars.
4436 ;; (concat c-ssb-stop-re "\\|\\s(\\|\\s)"))
4438 ;;(defconst c-ssb-sexp-end-re
4439 ;; ;; Regexp matching the ending syntax of a complex sexp.
4440 ;; (concat c-string-limit-regexp "\\|\\s)"))
4442 ;;(defun c-syntactic-skip-backward (skip-chars &optional limit paren-level)
4443 ;; "Like `skip-chars-backward' but only look at syntactically relevant chars,
4444 ;;i.e. don't stop at positions inside syntactic whitespace or string
4445 ;;literals. Preprocessor directives are also ignored. However, if the
4446 ;;point is within a comment, string literal or preprocessor directory to
4447 ;;begin with, its contents is treated as syntactically relevant chars.
4448 ;;If LIMIT is given, it limits the backward search and the point will be
4449 ;;left there if no earlier position is found.
4451 ;;If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4452 ;;sexps, and the search will also not go outside the current paren sexp.
4453 ;;However, if LIMIT or the buffer limit is reached inside a nested paren
4454 ;;then the point will be left at the limit.
4456 ;;Non-nil is returned if the point moved, nil otherwise.
4458 ;;Note that this function might do hidden buffer changes. See the
4459 ;;comment at the start of cc-engine.el for more info."
4461 ;; (save-restriction
4463 ;; (narrow-to-region limit (point-max)))
4465 ;; (let ((start (point)))
4467 ;; (while (let ((last-pos (point))
4469 ;; (skip-chars-backward skip-chars)
4472 ;; ;; Skip back over the same region as
4473 ;; ;; `skip-chars-backward' above, but keep to
4474 ;; ;; syntactically relevant positions.
4475 ;; (goto-char last-pos)
4477 ;; ;; `re-search-backward' with a single char regexp
4478 ;; ;; should be fast.
4479 ;; (re-search-backward
4480 ;; (if paren-level c-ssb-stop-paren-re c-ssb-stop-re)
4485 ;; ((looking-at "\\s(")
4486 ;; ;; `paren-level' is set and we've found the
4487 ;; ;; start of the containing paren.
4491 ;; ((looking-at c-ssb-sexp-end-re)
4492 ;; ;; We're at the end of a string literal or paren
4493 ;; ;; sexp (if `paren-level' is set).
4495 ;; (condition-case nil
4496 ;; (c-backward-sexp)
4498 ;; (goto-char limit)
4499 ;; (throw 'done t))))
4503 ;; ;; At the end of some syntactic ws or possibly
4504 ;; ;; after a plain '/' operator.
4505 ;; (let ((pos (point)))
4506 ;; (c-backward-syntactic-ws)
4507 ;; (if (= pos (point))
4508 ;; ;; Was a plain '/' operator. Go past it.
4509 ;; (backward-char)))))
4511 ;; (> (point) stop-pos))))
4513 ;; ;; Now the point is either at `stop-pos' or at some
4514 ;; ;; position further back if `stop-pos' was at a
4515 ;; ;; syntactically irrelevant place.
4517 ;; ;; Skip additional syntactic ws so that we don't stop
4518 ;; ;; at the end of a comment if `skip-chars' is
4519 ;; ;; something like "^/".
4520 ;; (c-backward-syntactic-ws)
4522 ;; (< (point) stop-pos))))
4524 ;; ;; We might want to extend this with more useful return values
4525 ;; ;; in the future.
4526 ;; (/= (point) start))))
4529 ;; Tools for handling comments and string literals.
4531 (defun c-in-literal (&optional lim detect-cpp)
4532 "Return the type of literal point is in, if any.
4533 The return value is `c' if in a C-style comment, `c++' if in a C++
4534 style comment, `string' if in a string literal, `pound' if DETECT-CPP
4535 is non-nil and in a preprocessor line, or nil if somewhere else.
4536 Optional LIM is used as the backward limit of the search. If omitted,
4537 or nil, `c-beginning-of-defun' is used.
4539 The last point calculated is cached if the cache is enabled, i.e. if
4540 `c-in-literal-cache' is bound to a two element vector.
4542 Note that this function might do hidden buffer changes. See the
4543 comment at the start of cc-engine.el for more info."
4546 (let* ((safe-place (c-state-semi-safe-place (point)))
4547 (lit (c-state-pp-to-literal safe-place (point))))
4550 (save-excursion (c-beginning-of-macro))
4553 (defun c-literal-limits (&optional lim near not-in-delimiter)
4554 "Return a cons of the beginning and end positions of the comment or
4555 string surrounding point (including both delimiters), or nil if point
4556 isn't in one. If LIM is non-nil, it's used as the \"safe\" position
4557 to start parsing from. If NEAR is non-nil, then the limits of any
4558 literal next to point is returned. \"Next to\" means there's only
4559 spaces and tabs between point and the literal. The search for such a
4560 literal is done first in forward direction. If NOT-IN-DELIMITER is
4561 non-nil, the case when point is inside a starting delimiter won't be
4562 recognized. This only has effect for comments which have starting
4563 delimiters with more than one character.
4565 Note that this function might do hidden buffer changes. See the
4566 comment at the start of cc-engine.el for more info."
4569 (let* ((pos (point))
4570 (lim (or lim (c-state-semi-safe-place pos)))
4571 (pp-to-lit (save-restriction
4573 (c-state-pp-to-literal lim pos not-in-delimiter)))
4574 (state (car pp-to-lit))
4575 (lit-limits (car (cddr pp-to-lit))))
4582 ;; Search forward for a literal.
4583 (skip-chars-forward " \t")
4585 ((looking-at c-string-limit-regexp) ; String.
4586 (cons (point) (or (c-safe (c-forward-sexp 1) (point))
4589 ((looking-at c-comment-start-regexp) ; Line or block comment.
4590 (cons (point) (progn (c-forward-single-comment) (point))))
4594 (skip-chars-backward " \t")
4596 (let ((end (point)) beg)
4599 (< (skip-syntax-backward c-string-syntax) 0)) ; String.
4600 (setq beg (c-safe (c-backward-sexp 1) (point))))
4602 ((and (c-safe (forward-char -2) t)
4604 ;; Block comment. Due to the nature of line
4605 ;; comments, they will always be covered by the
4606 ;; normal case above.
4608 (c-backward-single-comment)
4609 ;; If LIM is bogus, beg will be bogus.
4610 (setq beg (point))))
4612 (if beg (cons beg end))))))
4615 ;; In case external callers use this; it did have a docstring.
4616 (defalias 'c-literal-limits-fast 'c-literal-limits)
4618 (defun c-collect-line-comments (range)
4619 "If the argument is a cons of two buffer positions (such as returned by
4620 `c-literal-limits'), and that range contains a C++ style line comment,
4621 then an extended range is returned that contains all adjacent line
4622 comments (i.e. all comments that starts in the same column with no
4623 empty lines or non-whitespace characters between them). Otherwise the
4624 argument is returned.
4626 Note that this function might do hidden buffer changes. See the
4627 comment at the start of cc-engine.el for more info."
4631 (if (and (consp range) (progn
4632 (goto-char (car range))
4633 (looking-at c-line-comment-starter)))
4634 (let ((col (current-column))
4636 (bopl (c-point 'bopl))
4638 ;; Got to take care in the backward direction to handle
4639 ;; comments which are preceded by code.
4640 (while (and (c-backward-single-comment)
4642 (looking-at c-line-comment-starter)
4643 (= col (current-column)))
4645 bopl (c-point 'bopl)))
4647 (while (and (progn (skip-chars-forward " \t")
4648 (looking-at c-line-comment-starter))
4649 (= col (current-column))
4650 (prog1 (zerop (forward-line 1))
4651 (setq end (point)))))
4656 (defun c-literal-type (range)
4657 "Convenience function that given the result of `c-literal-limits',
4658 returns nil or the type of literal that the range surrounds, one
4659 of the symbols `c', `c++' or `string'. It's much faster than using
4660 `c-in-literal' and is intended to be used when you need both the
4661 type of a literal and its limits.
4663 Note that this function might do hidden buffer changes. See the
4664 comment at the start of cc-engine.el for more info."
4668 (goto-char (car range))
4669 (cond ((looking-at c-string-limit-regexp) 'string)
4670 ((or (looking-at "//") ; c++ line comment
4671 (and (looking-at "\\s<") ; comment starter
4672 (looking-at "#"))) ; awk comment.
4674 (t 'c))) ; Assuming the range is valid.
4677 (defsubst c-determine-limit-get-base (start try-size)
4678 ;; Get a "safe place" approximately TRY-SIZE characters before START.
4679 ;; This doesn't preserve point.
4680 (let* ((pos (max (- start try-size) (point-min)))
4681 (base (c-state-semi-safe-place pos))
4682 (s (parse-partial-sexp base pos)))
4683 (if (or (nth 4 s) (nth 3 s)) ; comment or string
4687 (defun c-determine-limit (how-far-back &optional start try-size)
4688 ;; Return a buffer position HOW-FAR-BACK non-literal characters from START
4689 ;; (default point). This is done by going back further in the buffer then
4690 ;; searching forward for literals. The position found won't be in a
4691 ;; literal. We start searching for the sought position TRY-SIZE (default
4692 ;; twice HOW-FAR-BACK) bytes back from START. This function must be fast.
4695 (let* ((start (or start (point)))
4696 (try-size (or try-size (* 2 how-far-back)))
4697 (base (c-determine-limit-get-base start try-size))
4700 (s (parse-partial-sexp pos pos)) ; null state.
4703 (while (< pos start)
4704 ;; Move forward one literal each time round this loop.
4705 ;; Move forward to the start of a comment or string.
4706 (setq s (parse-partial-sexp
4712 'syntax-table)) ; stop-comment
4714 ;; Gather details of the non-literal-bit - starting pos and size.
4715 (setq size (- (if (or (nth 4 s) (nth 3 s))
4720 (setq stack (cons (cons pos size) stack)))
4722 ;; Move forward to the end of the comment/string.
4723 (if (or (nth 4 s) (nth 3 s))
4724 (setq s (parse-partial-sexp
4730 'syntax-table))) ; stop-comment
4733 ;; Now try and find enough non-literal characters recorded on the stack.
4734 ;; Go back one recorded literal each time round this loop.
4735 (while (and (< count how-far-back)
4737 (setq elt (car stack)
4739 (setq count (+ count (cdr elt))))
4741 ;; Have we found enough yet?
4743 ((>= count how-far-back)
4744 (+ (car elt) (- count how-far-back)))
4745 ((eq base (point-min))
4748 (c-determine-limit (- how-far-back count) base try-size))))))
4750 (defun c-determine-+ve-limit (how-far &optional start-pos)
4751 ;; Return a buffer position about HOW-FAR non-literal characters forward
4752 ;; from START-POS (default point), which must not be inside a literal.
4754 (let ((pos (or start-pos (point)))
4756 (s (parse-partial-sexp (point) (point)))) ; null state
4757 (while (and (not (eobp))
4759 ;; Scan over counted characters.
4760 (setq s (parse-partial-sexp
4762 (min (+ pos count) (point-max))
4766 'syntax-table)) ; stop-comment
4767 (setq count (- count (- (point) pos) 1)
4769 ;; Scan over literal characters.
4771 (setq s (parse-partial-sexp
4777 'syntax-table) ; stop-comment
4782 ;; `c-find-decl-spots' and accompanying stuff.
4784 ;; Variables used in `c-find-decl-spots' to cache the search done for
4785 ;; the first declaration in the last call. When that function starts,
4786 ;; it needs to back up over syntactic whitespace to look at the last
4787 ;; token before the region being searched. That can sometimes cause
4788 ;; moves back and forth over a quite large region of comments and
4789 ;; macros, which would be repeated for each changed character when
4790 ;; we're called during fontification, since font-lock refontifies the
4791 ;; current line for each change. Thus it's worthwhile to cache the
4794 ;; `c-find-decl-syntactic-pos' is a syntactically relevant position in
4795 ;; the syntactic whitespace less or equal to some start position.
4796 ;; There's no cached value if it's nil.
4798 ;; `c-find-decl-match-pos' is the match position if
4799 ;; `c-find-decl-prefix-search' matched before the syntactic whitespace
4800 ;; at `c-find-decl-syntactic-pos', or nil if there's no such match.
4801 (defvar c-find-decl-syntactic-pos nil)
4802 (make-variable-buffer-local 'c-find-decl-syntactic-pos)
4803 (defvar c-find-decl-match-pos nil)
4804 (make-variable-buffer-local 'c-find-decl-match-pos)
4806 (defsubst c-invalidate-find-decl-cache (change-min-pos)
4807 (and c-find-decl-syntactic-pos
4808 (< change-min-pos c-find-decl-syntactic-pos)
4809 (setq c-find-decl-syntactic-pos nil)))
4811 ; (defface c-debug-decl-spot-face
4812 ; '((t (:background "Turquoise")))
4813 ; "Debug face to mark the spots where `c-find-decl-spots' stopped.")
4814 ; (defface c-debug-decl-sws-face
4815 ; '((t (:background "Khaki")))
4816 ; "Debug face to mark the syntactic whitespace between the declaration
4817 ; spots and the preceding token end.")
4819 (defmacro c-debug-put-decl-spot-faces (match-pos decl-pos)
4820 (when (facep 'c-debug-decl-spot-face)
4821 `(c-save-buffer-state ((match-pos ,match-pos) (decl-pos ,decl-pos))
4822 (c-debug-add-face (max match-pos (point-min)) decl-pos
4823 'c-debug-decl-sws-face)
4824 (c-debug-add-face decl-pos (min (1+ decl-pos) (point-max))
4825 'c-debug-decl-spot-face))))
4826 (defmacro c-debug-remove-decl-spot-faces (beg end)
4827 (when (facep 'c-debug-decl-spot-face)
4828 `(c-save-buffer-state ()
4829 (c-debug-remove-face ,beg ,end 'c-debug-decl-spot-face)
4830 (c-debug-remove-face ,beg ,end 'c-debug-decl-sws-face))))
4832 (defmacro c-find-decl-prefix-search ()
4833 ;; Macro used inside `c-find-decl-spots'. It ought to be a defun,
4834 ;; but it contains lots of free variables that refer to things
4835 ;; inside `c-find-decl-spots'. The point is left at `cfd-match-pos'
4836 ;; if there is a match, otherwise at `cfd-limit'.
4838 ;; The macro moves point forward to the next putative start of a declaration
4839 ;; or cfd-limit. This decl start is the next token after a "declaration
4840 ;; prefix". The declaration prefix is the earlier of `cfd-prop-match' and
4841 ;; `cfd-re-match'. `cfd-match-pos' is set to the decl prefix.
4843 ;; This macro might do hidden buffer changes.
4846 ;; Find the next property match position if we haven't got one already.
4847 (unless cfd-prop-match
4850 (goto-char (c-next-single-property-change
4851 (point) 'c-type nil cfd-limit))
4852 (and (< (point) cfd-limit)
4853 (not (eq (c-get-char-property (1- (point)) 'c-type)
4855 (setq cfd-prop-match (point))))
4857 ;; Find the next `c-decl-prefix-or-start-re' match if we haven't
4859 (unless cfd-re-match
4861 (if (> cfd-re-match-end (point))
4862 (goto-char cfd-re-match-end))
4864 ;; Each time round, the next `while' moves forward over a pseudo match
4865 ;; of `c-decl-prefix-or-start-re' which is either inside a literal, or
4866 ;; is a ":" not preceded by "public", etc.. `cfd-re-match' and
4867 ;; `cfd-re-match-end' get set.
4870 (setq cfd-re-match-end (re-search-forward c-decl-prefix-or-start-re
4873 ((null cfd-re-match-end)
4874 ;; No match. Finish up and exit the loop.
4875 (setq cfd-re-match cfd-limit)
4878 (if (setq cfd-re-match (match-end 1))
4879 ;; Matched the end of a token preceding a decl spot.
4881 (goto-char cfd-re-match)
4883 ;; Matched a token that start a decl spot.
4884 (goto-char (match-beginning 0))
4887 ;; Pseudo match inside a comment or string literal. Skip out
4888 ;; of comments and string literals.
4890 (goto-char (c-next-single-property-change
4891 (point) 'face nil cfd-limit))
4892 (and (< (point) cfd-limit)
4893 (c-got-face-at (point) c-literal-faces))))
4894 t) ; Continue the loop over pseudo matches.
4895 ((and (match-string 1)
4896 (string= (match-string 1) ":")
4898 (or (/= (c-backward-token-2 2) 0) ; no search limit. :-(
4899 (not (looking-at c-decl-start-colon-kwd-re)))))
4900 ;; Found a ":" which isn't part of "public:", etc.
4902 (t nil)))) ;; Found a real match. Exit the pseudo-match loop.
4904 ;; If our match was at the decl start, we have to back up over the
4905 ;; preceding syntactic ws to set `cfd-match-pos' and to catch
4906 ;; any decl spots in the syntactic ws.
4907 (unless cfd-re-match
4908 (c-backward-syntactic-ws)
4909 (setq cfd-re-match (point))))
4911 ;; Choose whichever match is closer to the start.
4912 (if (< cfd-re-match cfd-prop-match)
4913 (setq cfd-match-pos cfd-re-match
4915 (setq cfd-match-pos cfd-prop-match
4916 cfd-prop-match nil))
4918 (goto-char cfd-match-pos)
4920 (when (< cfd-match-pos cfd-limit)
4921 ;; Skip forward past comments only so we don't skip macros.
4922 (c-forward-comments)
4923 ;; Set the position to continue at. We can avoid going over
4924 ;; the comments skipped above a second time, but it's possible
4925 ;; that the comment skipping has taken us past `cfd-prop-match'
4926 ;; since the property might be used inside comments.
4927 (setq cfd-continue-pos (if cfd-prop-match
4928 (min cfd-prop-match (point))
4931 (defun c-find-decl-spots (cfd-limit cfd-decl-re cfd-face-checklist cfd-fun)
4932 ;; Call CFD-FUN for each possible spot for a declaration, cast or
4933 ;; label from the point to CFD-LIMIT.
4935 ;; CFD-FUN is called with point at the start of the spot. It's passed two
4936 ;; arguments: The first is the end position of the token preceding the spot,
4937 ;; or 0 for the implicit match at bob. The second is a flag that is t when
4938 ;; the match is inside a macro. Point should be moved forward by at least
4941 ;; If CFD-FUN adds `c-decl-end' properties somewhere below the current spot,
4942 ;; it should return non-nil to ensure that the next search will find them.
4945 ;; o The first token after bob.
4946 ;; o The first token after the end of submatch 1 in
4947 ;; `c-decl-prefix-or-start-re' when that submatch matches. This
4948 ;; submatch is typically a (L or R) brace or paren, a ;, or a ,.
4949 ;; o The start of each `c-decl-prefix-or-start-re' match when
4950 ;; submatch 1 doesn't match. This is, for example, the keyword
4952 ;; o The start of a previously recognized declaration; "recognized"
4953 ;; means that the last char of the previous token has a `c-type'
4954 ;; text property with the value `c-decl-end'; this only holds
4955 ;; when `c-type-decl-end-used' is set.
4957 ;; Only a spot that match CFD-DECL-RE and whose face is in the
4958 ;; CFD-FACE-CHECKLIST list causes CFD-FUN to be called. The face
4959 ;; check is disabled if CFD-FACE-CHECKLIST is nil.
4961 ;; If the match is inside a macro then the buffer is narrowed to the
4962 ;; end of it, so that CFD-FUN can investigate the following tokens
4963 ;; without matching something that begins inside a macro and ends
4964 ;; outside it. It's to avoid this work that the CFD-DECL-RE and
4965 ;; CFD-FACE-CHECKLIST checks exist.
4967 ;; The spots are visited approximately in order from top to bottom.
4968 ;; It's however the positions where `c-decl-prefix-or-start-re'
4969 ;; matches and where `c-decl-end' properties are found that are in
4970 ;; order. Since the spots often are at the following token, they
4971 ;; might be visited out of order insofar as more spots are reported
4972 ;; later on within the syntactic whitespace between the match
4973 ;; positions and their spots.
4975 ;; It's assumed that comments and strings are fontified in the
4978 ;; This is mainly used in fontification, and so has an elaborate
4979 ;; cache to handle repeated calls from the same start position; see
4980 ;; the variables above.
4982 ;; All variables in this function begin with `cfd-' to avoid name
4983 ;; collision with the (dynamically bound) variables used in CFD-FUN.
4985 ;; This function might do hidden buffer changes.
4987 (let ((cfd-start-pos (point)) ; never changed
4988 (cfd-buffer-end (point-max))
4989 ;; The end of the token preceding the decl spot last found
4990 ;; with `c-decl-prefix-or-start-re'. `cfd-limit' if there's
4993 ;; The end position of the last `c-decl-prefix-or-start-re'
4994 ;; match. If this is greater than `cfd-continue-pos', the
4995 ;; next regexp search is started here instead.
4996 (cfd-re-match-end (point-min))
4997 ;; The end of the last `c-decl-end' found by
4998 ;; `c-find-decl-prefix-search'. `cfd-limit' if there's no
4999 ;; match. If searching for the property isn't needed then we
5000 ;; disable it by setting it to `cfd-limit' directly.
5001 (cfd-prop-match (unless c-type-decl-end-used cfd-limit))
5002 ;; The end of the token preceding the decl spot last found by
5003 ;; `c-find-decl-prefix-search'. 0 for the implicit match at
5004 ;; bob. `cfd-limit' if there's no match. In other words,
5005 ;; this is the minimum of `cfd-re-match' and `cfd-prop-match'.
5006 (cfd-match-pos cfd-limit)
5007 ;; The position to continue searching at.
5009 ;; The position of the last "real" token we've stopped at.
5010 ;; This can be greater than `cfd-continue-pos' when we get
5011 ;; hits inside macros or at `c-decl-end' positions inside
5014 ;; The end position of the last entered macro.
5017 ;; Initialize by finding a syntactically relevant start position
5018 ;; before the point, and do the first `c-decl-prefix-or-start-re'
5019 ;; search unless we're at bob.
5021 (let (start-in-literal start-in-macro syntactic-pos)
5022 ;; Must back up a bit since we look for the end of the previous
5023 ;; statement or declaration, which is earlier than the first
5026 ;; This `cond' moves back over any literals or macros. It has special
5027 ;; handling for when the region being searched is entirely within a
5028 ;; macro. It sets `cfd-continue-pos' (unless we've reached
5031 ;; First we need to move to a syntactically relevant position.
5032 ;; Begin by backing out of comment or string literals.
5034 ;; This arm of the cond actually triggers if we're in a literal,
5035 ;; and cfd-limit is at most at BONL.
5037 ;; This arm of the `and' moves backwards out of a literal when
5038 ;; the face at point is a literal face. In this case, its value
5039 ;; is always non-nil.
5040 (when (c-got-face-at (point) c-literal-faces)
5041 ;; Try to use the faces to back up to the start of the
5042 ;; literal. FIXME: What if the point is on a declaration
5043 ;; inside a comment?
5044 (while (and (not (bobp))
5045 (c-got-face-at (1- (point)) c-literal-faces))
5046 (goto-char (previous-single-property-change
5047 (point) 'face nil (point-min))))
5049 ;; XEmacs doesn't fontify the quotes surrounding string
5051 (and (featurep 'xemacs)
5052 (eq (get-text-property (point) 'face)
5053 'font-lock-string-face)
5055 (progn (backward-char)
5056 (not (looking-at c-string-limit-regexp)))
5059 ;; Don't trust the literal to contain only literal faces
5060 ;; (the font lock package might not have fontified the
5061 ;; start of it at all, for instance) so check that we have
5062 ;; arrived at something that looks like a start or else
5063 ;; resort to `c-literal-limits'.
5064 (unless (looking-at c-literal-start-regexp)
5065 (let ((range (c-literal-limits)))
5066 (if range (goto-char (car range)))))
5068 (setq start-in-literal (point))) ; end of `and' arm.
5070 ;; The start is in a literal. If the limit is in the same
5071 ;; one we don't have to find a syntactic position etc. We
5072 ;; only check that if the limit is at or before bonl to save
5073 ;; time; it covers the by far most common case when font-lock
5074 ;; refontifies the current line only.
5075 (<= cfd-limit (c-point 'bonl cfd-start-pos))
5077 (goto-char cfd-start-pos)
5079 (goto-char (c-next-single-property-change
5080 (point) 'face nil cfd-limit))
5081 (and (< (point) cfd-limit)
5082 (c-got-face-at (point) c-literal-faces))))
5083 (= (point) cfd-limit))) ; end of `cond' arm condition
5085 ;; Completely inside a literal. Set up variables to trig the
5086 ;; (< cfd-continue-pos cfd-start-pos) case below and it'll
5087 ;; find a suitable start position.
5088 (setq cfd-continue-pos start-in-literal)) ; end of `cond' arm
5090 ;; Check if the region might be completely inside a macro, to
5091 ;; optimize that like the completely-inside-literal above.
5093 (and (= (forward-line 1) 0)
5094 (bolp) ; forward-line has funny behavior at eob.
5095 (>= (point) cfd-limit)
5096 (progn (backward-char)
5097 (eq (char-before) ?\\))))
5098 ;; (Maybe) completely inside a macro. Only need to trig the
5099 ;; (< cfd-continue-pos cfd-start-pos) case below to make it
5101 (setq cfd-continue-pos (1- cfd-start-pos)
5104 ;; The default arm of the `cond' moves back over any macro we're in
5105 ;; and over any syntactic WS. It sets `c-find-decl-syntactic-pos'.
5107 ;; Back out of any macro so we don't miss any declaration
5108 ;; that could follow after it.
5109 (when (c-beginning-of-macro)
5110 (setq start-in-macro t))
5112 ;; Now we're at a proper syntactically relevant position so we
5113 ;; can use the cache. But first clear it if it applied
5115 (c-invalidate-find-decl-cache cfd-start-pos)
5117 (setq syntactic-pos (point))
5118 (unless (eq syntactic-pos c-find-decl-syntactic-pos)
5119 ;; Don't have to do this if the cache is relevant here,
5120 ;; typically if the same line is refontified again. If
5121 ;; we're just some syntactic whitespace further down we can
5122 ;; still use the cache to limit the skipping.
5123 (c-backward-syntactic-ws c-find-decl-syntactic-pos))
5125 ;; If we hit `c-find-decl-syntactic-pos' and
5126 ;; `c-find-decl-match-pos' is set then we install the cached
5127 ;; values. If we hit `c-find-decl-syntactic-pos' and
5128 ;; `c-find-decl-match-pos' is nil then we know there's no decl
5129 ;; prefix in the whitespace before `c-find-decl-syntactic-pos'
5130 ;; and so we can continue the search from this point. If we
5131 ;; didn't hit `c-find-decl-syntactic-pos' then we're now in
5132 ;; the right spot to begin searching anyway.
5133 (if (and (eq (point) c-find-decl-syntactic-pos)
5134 c-find-decl-match-pos)
5135 (setq cfd-match-pos c-find-decl-match-pos
5136 cfd-continue-pos syntactic-pos)
5138 (setq c-find-decl-syntactic-pos syntactic-pos)
5141 ;; Always consider bob a match to get the first
5142 ;; declaration in the file. Do this separately instead of
5143 ;; letting `c-decl-prefix-or-start-re' match bob, so that
5144 ;; regexp always can consume at least one character to
5145 ;; ensure that we won't get stuck in an infinite loop.
5146 (setq cfd-re-match 0)
5148 (c-beginning-of-current-token)
5149 (< (point) cfd-limit))
5150 ;; Do an initial search now. In the bob case above it's
5151 ;; only done to search for a `c-decl-end' spot.
5152 (c-find-decl-prefix-search)) ; sets cfd-continue-pos
5154 (setq c-find-decl-match-pos (and (< cfd-match-pos cfd-start-pos)
5155 cfd-match-pos))))) ; end of `cond'
5157 ;; Advance `cfd-continue-pos' if it's before the start position.
5158 ;; The closest continue position that might have effect at or
5159 ;; after the start depends on what we started in. This also
5160 ;; finds a suitable start position in the special cases when the
5161 ;; region is completely within a literal or macro.
5162 (when (and cfd-continue-pos (< cfd-continue-pos cfd-start-pos))
5166 ;; If we're in a macro then it's the closest preceding token
5167 ;; in the macro. Check this before `start-in-literal',
5168 ;; since if we're inside a literal in a macro, the preceding
5169 ;; token is earlier than any `c-decl-end' spot inside the
5170 ;; literal (comment).
5171 (goto-char (or start-in-literal cfd-start-pos))
5172 ;; The only syntactic ws in macros are comments.
5173 (c-backward-comments)
5175 (c-beginning-of-current-token))
5178 ;; If we're in a comment it can only be the closest
5179 ;; preceding `c-decl-end' position within that comment, if
5180 ;; any. Go back to the beginning of such a property so that
5181 ;; `c-find-decl-prefix-search' will find the end of it.
5182 ;; (Can't stop at the end and install it directly on
5183 ;; `cfd-prop-match' since that variable might be cleared
5184 ;; after `cfd-fun' below.)
5186 ;; Note that if the literal is a string then the property
5187 ;; search will simply skip to the beginning of it right
5189 (if (not c-type-decl-end-used)
5190 (goto-char start-in-literal)
5191 (goto-char cfd-start-pos)
5193 (goto-char (previous-single-property-change
5194 (point) 'c-type nil start-in-literal))
5195 (and (> (point) start-in-literal)
5196 (not (eq (c-get-char-property (point) 'c-type)
5199 (when (= (point) start-in-literal)
5200 ;; Didn't find any property inside the comment, so we can
5201 ;; skip it entirely. (This won't skip past a string, but
5202 ;; that'll be handled quickly by the next
5203 ;; `c-find-decl-prefix-search' anyway.)
5204 (c-forward-single-comment)
5205 (if (> (point) cfd-limit)
5206 (goto-char cfd-limit))))
5209 ;; If we started in normal code, the only match that might
5210 ;; apply before the start is what we already got in
5211 ;; `cfd-match-pos' so we can continue at the start position.
5212 ;; (Note that we don't get here if the first match is below
5214 (goto-char cfd-start-pos))) ; end of `cond'
5216 ;; Delete found matches if they are before our new continue
5217 ;; position, so that `c-find-decl-prefix-search' won't back up
5218 ;; to them later on.
5219 (setq cfd-continue-pos (point))
5220 (when (and cfd-re-match (< cfd-re-match cfd-continue-pos))
5221 (setq cfd-re-match nil))
5222 (when (and cfd-prop-match (< cfd-prop-match cfd-continue-pos))
5223 (setq cfd-prop-match nil))) ; end of `when'
5226 ;; This is the normal case and we got a proper syntactic
5227 ;; position. If there's a match then it's always outside
5228 ;; macros and comments, so advance to the next token and set
5229 ;; `cfd-token-pos'. The loop below will later go back using
5230 ;; `cfd-continue-pos' to fix declarations inside the
5232 (when (and cfd-match-pos (< cfd-match-pos syntactic-pos))
5233 (goto-char syntactic-pos)
5234 (c-forward-syntactic-ws)
5235 (and cfd-continue-pos
5236 (< cfd-continue-pos (point))
5237 (setq cfd-token-pos (point))))
5239 ;; Have one of the special cases when the region is completely
5240 ;; within a literal or macro. `cfd-continue-pos' is set to a
5241 ;; good start position for the search, so do it.
5242 (c-find-decl-prefix-search)))
5244 ;; Now loop, one decl spot per iteration. We already have the first
5245 ;; match in `cfd-match-pos'.
5247 ;; Go forward over "false matches", one per iteration.
5249 (< cfd-match-pos cfd-limit)
5252 ;; Kludge to filter out matches on the "<" that
5253 ;; aren't open parens, for the sake of languages
5254 ;; that got `c-recognize-<>-arglists' set.
5255 (and (eq (char-before cfd-match-pos) ?<)
5256 (not (c-get-char-property (1- cfd-match-pos)
5259 ;; If `cfd-continue-pos' is less or equal to
5260 ;; `cfd-token-pos', we've got a hit inside a macro
5261 ;; that's in the syntactic whitespace before the last
5262 ;; "real" declaration we've checked. If they're equal
5263 ;; we've arrived at the declaration a second time, so
5264 ;; there's nothing to do.
5265 (= cfd-continue-pos cfd-token-pos)
5268 ;; If `cfd-continue-pos' is less than `cfd-token-pos'
5269 ;; we're still searching for declarations embedded in
5270 ;; the syntactic whitespace. In that case we need
5271 ;; only to skip comments and not macros, since they
5272 ;; can't be nested, and that's already been done in
5273 ;; `c-find-decl-prefix-search'.
5274 (when (> cfd-continue-pos cfd-token-pos)
5275 (c-forward-syntactic-ws)
5276 (setq cfd-token-pos (point)))
5278 ;; Continue if the following token fails the
5279 ;; CFD-DECL-RE and CFD-FACE-CHECKLIST checks.
5280 (when (or (>= (point) cfd-limit)
5281 (not (looking-at cfd-decl-re))
5282 (and cfd-face-checklist
5284 (point) cfd-face-checklist))))
5285 (goto-char cfd-continue-pos)
5288 (< (point) cfd-limit)) ; end of "false matches" condition
5289 (c-find-decl-prefix-search)) ; end of "false matches" loop
5291 (< (point) cfd-limit)) ; end of condition for "decl-spot" while
5294 (>= (point) cfd-start-pos)
5297 ;; Narrow to the end of the macro if we got a hit inside
5298 ;; one, to avoid recognizing things that start inside the
5299 ;; macro and end outside it.
5300 (when (> cfd-match-pos cfd-macro-end)
5301 ;; Not in the same macro as in the previous round.
5303 (goto-char cfd-match-pos)
5305 (if (save-excursion (and (c-beginning-of-macro)
5306 (< (point) cfd-match-pos)))
5307 (progn (c-end-of-macro)
5311 (if (zerop cfd-macro-end)
5313 (if (> cfd-macro-end (point))
5314 (progn (narrow-to-region (point-min) cfd-macro-end)
5316 ;; The matched token was the last thing in the macro,
5317 ;; so the whole match is bogus.
5318 (setq cfd-macro-end 0)
5319 nil)))) ; end of when condition
5321 (c-debug-put-decl-spot-faces cfd-match-pos (point))
5322 (if (funcall cfd-fun cfd-match-pos (/= cfd-macro-end 0))
5323 (setq cfd-prop-match nil))
5325 (when (/= cfd-macro-end 0)
5326 ;; Restore limits if we did macro narrowing above.
5327 (narrow-to-region (point-min) cfd-buffer-end)))
5329 (goto-char cfd-continue-pos)
5330 (if (= cfd-continue-pos cfd-limit)
5331 (setq cfd-match-pos cfd-limit)
5332 (c-find-decl-prefix-search))))) ; Moves point, sets cfd-continue-pos,
5333 ; cfd-match-pos, etc.
5336 ;; A cache for found types.
5338 ;; Buffer local variable that contains an obarray with the types we've
5339 ;; found. If a declaration is recognized somewhere we record the
5340 ;; fully qualified identifier in it to recognize it as a type
5341 ;; elsewhere in the file too. This is not accurate since we do not
5342 ;; bother with the scoping rules of the languages, but in practice the
5343 ;; same name is seldom used as both a type and something else in a
5344 ;; file, and we only use this as a last resort in ambiguous cases (see
5345 ;; `c-forward-decl-or-cast-1').
5347 ;; Not every type need be in this cache. However, things which have
5348 ;; ceased to be types must be removed from it.
5350 ;; Template types in C++ are added here too but with the template
5351 ;; arglist replaced with "<>" in references or "<" for the one in the
5352 ;; primary type. E.g. the type "Foo<A,B>::Bar<C>" is stored as
5353 ;; "Foo<>::Bar<". This avoids storing very long strings (since C++
5354 ;; template specs can be fairly sized programs in themselves) and
5355 ;; improves the hit ratio (it's a type regardless of the template
5356 ;; args; it's just not the same type, but we're only interested in
5357 ;; recognizing types, not telling distinct types apart). Note that
5358 ;; template types in references are added here too; from the example
5359 ;; above there will also be an entry "Foo<".
5360 (defvar c-found-types nil)
5361 (make-variable-buffer-local 'c-found-types)
5363 (defsubst c-clear-found-types ()
5364 ;; Clears `c-found-types'.
5365 (setq c-found-types (make-vector 53 0)))
5367 (defun c-add-type (from to)
5368 ;; Add the given region as a type in `c-found-types'. If the region
5369 ;; doesn't match an existing type but there is a type which is equal
5370 ;; to the given one except that the last character is missing, then
5371 ;; the shorter type is removed. That's done to avoid adding all
5372 ;; prefixes of a type as it's being entered and font locked. This
5373 ;; doesn't cover cases like when characters are removed from a type
5374 ;; or added in the middle. We'd need the position of point when the
5375 ;; font locking is invoked to solve this well.
5377 ;; This function might do hidden buffer changes.
5378 (let ((type (c-syntactic-content from to c-recognize-<>-arglists)))
5379 (unless (intern-soft type c-found-types)
5380 (unintern (substring type 0 -1) c-found-types)
5381 (intern type c-found-types))))
5383 (defun c-unfind-type (name)
5384 ;; Remove the "NAME" from c-found-types, if present.
5385 (unintern name c-found-types))
5387 (defsubst c-check-type (from to)
5388 ;; Return non-nil if the given region contains a type in
5391 ;; This function might do hidden buffer changes.
5392 (intern-soft (c-syntactic-content from to c-recognize-<>-arglists)
5395 (defun c-list-found-types ()
5396 ;; Return all the types in `c-found-types' as a sorted list of
5399 (mapatoms (lambda (type)
5400 (setq type-list (cons (symbol-name type)
5403 (sort type-list 'string-lessp)))
5405 ;; Shut up the byte compiler.
5406 (defvar c-maybe-stale-found-type)
5408 (defun c-trim-found-types (beg end old-len)
5409 ;; An after change function which, in conjunction with the info in
5410 ;; c-maybe-stale-found-type (set in c-before-change), removes a type
5411 ;; from `c-found-types', should this type have become stale. For
5412 ;; example, this happens to "foo" when "foo \n bar();" becomes
5413 ;; "foo(); \n bar();". Such stale types, if not removed, foul up
5414 ;; the fontification.
5416 ;; Have we, perhaps, added non-ws characters to the front/back of a found
5420 (when (< end (point-max))
5422 (if (and (c-beginning-of-current-token) ; only moves when we started in the middle
5423 (progn (goto-char end)
5424 (c-end-of-current-token)))
5425 (c-unfind-type (buffer-substring-no-properties
5427 (when (> beg (point-min))
5429 (if (and (c-end-of-current-token) ; only moves when we started in the middle
5430 (progn (goto-char beg)
5431 (c-beginning-of-current-token)))
5432 (c-unfind-type (buffer-substring-no-properties
5435 (if c-maybe-stale-found-type ; e.g. (c-decl-id-start "foo" 97 107 " (* ooka) " "o")
5437 ;; Changing the amount of (already existing) whitespace - don't do anything.
5438 ((and (c-partial-ws-p beg end)
5439 (or (= beg end) ; removal of WS
5440 (string-match "^[ \t\n\r\f\v]*$" (nth 5 c-maybe-stale-found-type)))))
5442 ;; The syntactic relationship which defined a "found type" has been
5444 ((eq (car c-maybe-stale-found-type) 'c-decl-id-start)
5445 (c-unfind-type (cadr c-maybe-stale-found-type)))
5446 ;; ((eq (car c-maybe-stale-found-type) 'c-decl-type-start) FIXME!!!
5450 ;; Setting and removing syntax properties on < and > in languages (C++
5451 ;; and Java) where they can be template/generic delimiters as well as
5452 ;; their normal meaning of "less/greater than".
5454 ;; Normally, < and > have syntax 'punctuation'. When they are found to
5455 ;; be delimiters, they are marked as such with the category properties
5456 ;; c-<-as-paren-syntax, c->-as-paren-syntax respectively.
5460 ;; It is impossible to determine with certainty whether a <..> pair in
5461 ;; C++ is two comparison operators or is template delimiters, unless
5462 ;; one duplicates a lot of a C++ compiler. For example, the following
5465 ;; foo (a < b, c > d) ;
5467 ;; could be a function call with two integer parameters (each a
5468 ;; relational expression), or it could be a constructor for class foo
5469 ;; taking one parameter d of templated type "a < b, c >". They are
5470 ;; somewhat easier to distinguish in Java.
5472 ;; The strategy now (2010-01) adopted is to mark and unmark < and
5473 ;; > IN MATCHING PAIRS ONLY. [Previously, they were marked
5474 ;; individually when their context so indicated. This gave rise to
5475 ;; intractable problems when one of a matching pair was deleted, or
5476 ;; pulled into a literal.]
5478 ;; At each buffer change, the syntax-table properties are removed in a
5479 ;; before-change function and reapplied, when needed, in an
5480 ;; after-change function. It is far more important that the
5481 ;; properties get removed when they they are spurious than that they
5482 ;; be present when wanted.
5483 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
5484 (defun c-clear-<-pair-props (&optional pos)
5485 ;; POS (default point) is at a < character. If it is marked with
5486 ;; open paren syntax-table text property, remove the property,
5487 ;; together with the close paren property on the matching > (if
5493 (when (equal (c-get-char-property (point) 'syntax-table)
5494 c-<-as-paren-syntax)
5495 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5496 (c-go-list-forward))
5497 (when (equal (c-get-char-property (1- (point)) 'syntax-table)
5498 c->-as-paren-syntax) ; should always be true.
5499 (c-unmark-<->-as-paren (1- (point))))
5500 (c-unmark-<->-as-paren pos))))
5502 (defun c-clear->-pair-props (&optional pos)
5503 ;; POS (default point) is at a > character. If it is marked with
5504 ;; close paren syntax-table property, remove the property, together
5505 ;; with the open paren property on the matching < (if any).
5510 (when (equal (c-get-char-property (point) 'syntax-table)
5511 c->-as-paren-syntax)
5512 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5513 (c-go-up-list-backward))
5514 (when (equal (c-get-char-property (point) 'syntax-table)
5515 c-<-as-paren-syntax) ; should always be true.
5516 (c-unmark-<->-as-paren (point)))
5517 (c-unmark-<->-as-paren pos))))
5519 (defun c-clear-<>-pair-props (&optional pos)
5520 ;; POS (default point) is at a < or > character. If it has an
5521 ;; open/close paren syntax-table property, remove this property both
5522 ;; from the current character and its partner (which will also be
5525 ((eq (char-after) ?\<)
5526 (c-clear-<-pair-props pos))
5527 ((eq (char-after) ?\>)
5528 (c-clear->-pair-props pos))
5530 "c-clear-<>-pair-props called from wrong position"))))
5532 (defun c-clear-<-pair-props-if-match-after (lim &optional pos)
5533 ;; POS (default point) is at a < character. If it is both marked
5534 ;; with open/close paren syntax-table property, and has a matching >
5535 ;; (also marked) which is after LIM, remove the property both from
5536 ;; the current > and its partner. Return t when this happens, nil
5542 (when (equal (c-get-char-property (point) 'syntax-table)
5543 c-<-as-paren-syntax)
5544 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5545 (c-go-list-forward))
5546 (when (and (>= (point) lim)
5547 (equal (c-get-char-property (1- (point)) 'syntax-table)
5548 c->-as-paren-syntax)) ; should always be true.
5549 (c-unmark-<->-as-paren (1- (point)))
5550 (c-unmark-<->-as-paren pos))
5553 (defun c-clear->-pair-props-if-match-before (lim &optional pos)
5554 ;; POS (default point) is at a > character. If it is both marked
5555 ;; with open/close paren syntax-table property, and has a matching <
5556 ;; (also marked) which is before LIM, remove the property both from
5557 ;; the current < and its partner. Return t when this happens, nil
5563 (when (equal (c-get-char-property (point) 'syntax-table)
5564 c->-as-paren-syntax)
5565 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5566 (c-go-up-list-backward))
5567 (when (and (<= (point) lim)
5568 (equal (c-get-char-property (point) 'syntax-table)
5569 c-<-as-paren-syntax)) ; should always be true.
5570 (c-unmark-<->-as-paren (point))
5571 (c-unmark-<->-as-paren pos))
5574 ;; Set by c-common-init in cc-mode.el.
5578 (defun c-before-change-check-<>-operators (beg end)
5579 ;; Unmark certain pairs of "< .... >" which are currently marked as
5580 ;; template/generic delimiters. (This marking is via syntax-table text
5581 ;; properties), and expand the (c-new-BEG c-new-END) region to include all
5582 ;; unmarked < and > operators within the certain bounds (see below).
5584 ;; These pairs are those which are in the current "statement" (i.e.,
5585 ;; the region between the {, }, or ; before BEG and the one after
5586 ;; END), and which enclose any part of the interval (BEG END).
5588 ;; Note that in C++ (?and Java), template/generic parens cannot
5589 ;; enclose a brace or semicolon, so we use these as bounds on the
5590 ;; region we must work on.
5592 ;; This function is called from before-change-functions (via
5593 ;; c-get-state-before-change-functions). Thus the buffer is widened,
5594 ;; and point is undefined, both at entry and exit.
5596 ;; FIXME!!! This routine ignores the possibility of macros entirely.
5599 (c-save-buffer-state
5600 ((beg-lit-limits (progn (goto-char beg) (c-literal-limits)))
5601 (end-lit-limits (progn (goto-char end) (c-literal-limits)))
5602 new-beg new-end beg-limit end-limit)
5603 ;; Locate the earliest < after the barrier before the changed region,
5604 ;; which isn't already marked as a paren.
5605 (goto-char (if beg-lit-limits (car beg-lit-limits) beg))
5606 (setq beg-limit (c-determine-limit 512))
5608 ;; Remove the syntax-table/category properties from each pertinent <...>
5609 ;; pair. Firstly, the ones with the < before beg and > after beg....
5610 (while (progn (c-syntactic-skip-backward "^;{}<" beg-limit)
5611 (eq (char-before) ?<))
5612 (c-backward-token-2)
5613 (when (eq (char-after) ?<)
5614 (c-clear-<-pair-props-if-match-after beg)))
5615 (c-forward-syntactic-ws)
5616 (setq new-beg (point))
5618 ;; ...Then the ones with < before end and > after end.
5619 (goto-char (if end-lit-limits (cdr end-lit-limits) end))
5620 (setq end-limit (c-determine-+ve-limit 512))
5621 (while (and (c-syntactic-re-search-forward "[;{}>]" end-limit 'end)
5622 (eq (char-before) ?>))
5623 (c-end-of-current-token)
5624 (when (eq (char-before) ?>)
5625 (c-clear->-pair-props-if-match-before end (1- (point)))))
5626 (c-backward-syntactic-ws)
5627 (setq new-end (point))
5629 ;; Extend the fontification region, if needed.
5631 (< new-beg c-new-BEG)
5632 (setq c-new-BEG new-beg))
5634 (> new-end c-new-END)
5635 (setq c-new-END new-end)))))
5637 (defun c-after-change-check-<>-operators (beg end)
5638 ;; This is called from `after-change-functions' when
5639 ;; c-recognize-<>-arglists' is set. It ensures that no "<" or ">"
5640 ;; chars with paren syntax become part of another operator like "<<"
5643 ;; This function might do hidden buffer changes.
5647 (when (or (looking-at "[<>]")
5648 (< (skip-chars-backward "<>") 0))
5651 (c-beginning-of-current-token)
5652 (when (and (< (point) beg)
5653 (looking-at c-<>-multichar-token-regexp)
5654 (< beg (setq beg (match-end 0))))
5655 (while (progn (skip-chars-forward "^<>" beg)
5657 (c-clear-<>-pair-props)
5662 (when (or (looking-at "[<>]")
5663 (< (skip-chars-backward "<>") 0))
5666 (c-beginning-of-current-token)
5667 (when (and (< (point) end)
5668 (looking-at c-<>-multichar-token-regexp)
5669 (< end (setq end (match-end 0))))
5670 (while (progn (skip-chars-forward "^<>" end)
5672 (c-clear-<>-pair-props)
5673 (forward-char)))))))
5675 (defun c-restore-<>-properties (_beg _end _old-len)
5676 ;; This function is called as an after-change function. It restores the
5677 ;; category/syntax-table properties on template/generic <..> pairs between
5678 ;; c-new-BEG and c-new-END. It may do hidden buffer changes.
5679 (c-save-buffer-state ((c-parse-and-markup-<>-arglists t)
5680 c-restricted-<>-arglists lit-limits)
5681 (goto-char c-new-BEG)
5682 (if (setq lit-limits (c-literal-limits))
5683 (goto-char (cdr lit-limits)))
5684 (while (and (< (point) c-new-END)
5685 (c-syntactic-re-search-forward "<" c-new-END 'bound))
5688 (c-backward-token-2)
5689 (setq c-restricted-<>-arglists
5690 (and (not (looking-at c-opt-<>-sexp-key))
5691 (progn (c-backward-syntactic-ws) ; to ( or ,
5692 (and (memq (char-before) '(?\( ?,)) ; what about <?
5693 (not (eq (c-get-char-property (point) 'c-type)
5694 'c-decl-arg-start)))))))
5695 (or (c-forward-<>-arglist nil)
5698 ;; Handling of small scale constructs like types and names.
5700 ;; Dynamically bound variable that instructs `c-forward-type' to also
5701 ;; treat possible types (i.e. those that it normally returns 'maybe or
5702 ;; 'found for) as actual types (and always return 'found for them).
5703 ;; This means that it records them in `c-record-type-identifiers' if
5704 ;; that is set, and that it adds them to `c-found-types'.
5705 (defvar c-promote-possible-types nil)
5707 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5708 ;; mark up successfully parsed arglists with paren syntax properties on
5709 ;; the surrounding angle brackets and with `c-<>-arg-sep' in the
5710 ;; `c-type' property of each argument separating comma.
5712 ;; Setting this variable also makes `c-forward-<>-arglist' recurse into
5713 ;; all arglists for side effects (i.e. recording types), otherwise it
5714 ;; exploits any existing paren syntax properties to quickly jump to the
5715 ;; end of already parsed arglists.
5717 ;; Marking up the arglists is not the default since doing that correctly
5718 ;; depends on a proper value for `c-restricted-<>-arglists'.
5719 (defvar c-parse-and-markup-<>-arglists nil)
5721 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5722 ;; not accept arglists that contain binary operators.
5724 ;; This is primarily used to handle C++ template arglists. C++
5725 ;; disambiguates them by checking whether the preceding name is a
5726 ;; template or not. We can't do that, so we assume it is a template
5727 ;; if it can be parsed as one. That usually works well since
5728 ;; comparison expressions on the forms "a < b > c" or "a < b, c > d"
5729 ;; in almost all cases would be pointless.
5731 ;; However, in function arglists, e.g. in "foo (a < b, c > d)", we
5732 ;; should let the comma separate the function arguments instead. And
5733 ;; in a context where the value of the expression is taken, e.g. in
5734 ;; "if (a < b || c > d)", it's probably not a template.
5735 (defvar c-restricted-<>-arglists nil)
5737 ;; Dynamically bound variables that instructs
5738 ;; `c-forward-keyword-clause', `c-forward-<>-arglist',
5739 ;; `c-forward-name', `c-forward-type', `c-forward-decl-or-cast-1', and
5740 ;; `c-forward-label' to record the ranges of all the type and
5741 ;; reference identifiers they encounter. They will build lists on
5742 ;; these variables where each element is a cons of the buffer
5743 ;; positions surrounding each identifier. This recording is only
5744 ;; activated when `c-record-type-identifiers' is non-nil.
5746 ;; All known types that can't be identifiers are recorded, and also
5747 ;; other possible types if `c-promote-possible-types' is set.
5748 ;; Recording is however disabled inside angle bracket arglists that
5749 ;; are encountered inside names and other angle bracket arglists.
5750 ;; Such occurrences are taken care of by `c-font-lock-<>-arglists'
5753 ;; Only the names in C++ template style references (e.g. "tmpl" in
5754 ;; "tmpl<a,b>::foo") are recorded as references, other references
5755 ;; aren't handled here.
5757 ;; `c-forward-label' records the label identifier(s) on
5758 ;; `c-record-ref-identifiers'.
5759 (defvar c-record-type-identifiers nil)
5760 (defvar c-record-ref-identifiers nil)
5762 ;; This variable will receive a cons cell of the range of the last
5763 ;; single identifier symbol stepped over by `c-forward-name' if it's
5764 ;; successful. This is the range that should be put on one of the
5765 ;; record lists above by the caller. It's assigned nil if there's no
5766 ;; such symbol in the name.
5767 (defvar c-last-identifier-range nil)
5769 (defmacro c-record-type-id (range)
5770 (if (eq (car-safe range) 'cons)
5772 `(setq c-record-type-identifiers
5773 (cons ,range c-record-type-identifiers))
5774 `(let ((range ,range))
5776 (setq c-record-type-identifiers
5777 (cons range c-record-type-identifiers))))))
5779 (defmacro c-record-ref-id (range)
5780 (if (eq (car-safe range) 'cons)
5782 `(setq c-record-ref-identifiers
5783 (cons ,range c-record-ref-identifiers))
5784 `(let ((range ,range))
5786 (setq c-record-ref-identifiers
5787 (cons range c-record-ref-identifiers))))))
5789 ;; Dynamically bound variable that instructs `c-forward-type' to
5790 ;; record the ranges of types that only are found. Behaves otherwise
5791 ;; like `c-record-type-identifiers'.
5792 (defvar c-record-found-types nil)
5794 (defmacro c-forward-keyword-prefixed-id (type)
5795 ;; Used internally in `c-forward-keyword-clause' to move forward
5796 ;; over a type (if TYPE is 'type) or a name (otherwise) which
5797 ;; possibly is prefixed by keywords and their associated clauses.
5798 ;; Try with a type/name first to not trip up on those that begin
5799 ;; with a keyword. Return t if a known or found type is moved
5800 ;; over. The point is clobbered if nil is returned. If range
5801 ;; recording is enabled, the identifier is recorded on as a type
5802 ;; if TYPE is 'type or as a reference if TYPE is 'ref.
5804 ;; This macro might do hidden buffer changes.
5806 (while (if (setq res ,(if (eq type 'type)
5810 (and (looking-at c-keywords-regexp)
5811 (c-forward-keyword-clause 1))))
5812 (when (memq res '(t known found prefix))
5813 ,(when (eq type 'ref)
5814 `(when c-record-type-identifiers
5815 (c-record-ref-id c-last-identifier-range)))
5818 (defmacro c-forward-id-comma-list (type update-safe-pos)
5819 ;; Used internally in `c-forward-keyword-clause' to move forward
5820 ;; over a comma separated list of types or names using
5821 ;; `c-forward-keyword-prefixed-id'.
5823 ;; This macro might do hidden buffer changes.
5825 ,(when update-safe-pos
5826 `(setq safe-pos (point)))
5827 (eq (char-after) ?,))
5830 (c-forward-syntactic-ws)
5831 (c-forward-keyword-prefixed-id ,type)))))
5833 (defun c-forward-keyword-clause (match)
5834 ;; Submatch MATCH in the current match data is assumed to surround a
5835 ;; token. If it's a keyword, move over it and any immediately
5836 ;; following clauses associated with it, stopping at the start of
5837 ;; the next token. t is returned in that case, otherwise the point
5838 ;; stays and nil is returned. The kind of clauses that are
5839 ;; recognized are those specified by `c-type-list-kwds',
5840 ;; `c-ref-list-kwds', `c-colon-type-list-kwds',
5841 ;; `c-paren-nontype-kwds', `c-paren-type-kwds', `c-<>-type-kwds',
5842 ;; and `c-<>-arglist-kwds'.
5844 ;; This function records identifier ranges on
5845 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5846 ;; `c-record-type-identifiers' is non-nil.
5848 ;; Note that for `c-colon-type-list-kwds', which doesn't necessary
5849 ;; apply directly after the keyword, the type list is moved over
5850 ;; only when there is no unaccounted token before it (i.e. a token
5851 ;; that isn't moved over due to some other keyword list). The
5852 ;; identifier ranges in the list are still recorded if that should
5855 ;; This function might do hidden buffer changes.
5857 (let ((kwd-sym (c-keyword-sym (match-string match))) safe-pos pos
5858 ;; The call to `c-forward-<>-arglist' below is made after
5859 ;; `c-<>-sexp-kwds' keywords, so we're certain they actually
5860 ;; are angle bracket arglists and `c-restricted-<>-arglists'
5861 ;; should therefore be nil.
5862 (c-parse-and-markup-<>-arglists t)
5863 c-restricted-<>-arglists)
5866 (goto-char (match-end match))
5867 (c-forward-syntactic-ws)
5868 (setq safe-pos (point))
5871 ((and (c-keyword-member kwd-sym 'c-type-list-kwds)
5872 (c-forward-keyword-prefixed-id type))
5873 ;; There's a type directly after a keyword in `c-type-list-kwds'.
5874 (c-forward-id-comma-list type t))
5876 ((and (c-keyword-member kwd-sym 'c-ref-list-kwds)
5877 (c-forward-keyword-prefixed-id ref))
5878 ;; There's a name directly after a keyword in `c-ref-list-kwds'.
5879 (c-forward-id-comma-list ref t))
5881 ((and (c-keyword-member kwd-sym 'c-paren-any-kwds)
5882 (eq (char-after) ?\())
5883 ;; There's an open paren after a keyword in `c-paren-any-kwds'.
5886 (when (and (setq pos (c-up-list-forward))
5887 (eq (char-before pos) ?\)))
5888 (when (and c-record-type-identifiers
5889 (c-keyword-member kwd-sym 'c-paren-type-kwds))
5890 ;; Use `c-forward-type' on every identifier we can find
5891 ;; inside the paren, to record the types.
5892 (while (c-syntactic-re-search-forward c-symbol-start pos t)
5893 (goto-char (match-beginning 0))
5894 (unless (c-forward-type)
5895 (looking-at c-symbol-key) ; Always matches.
5896 (goto-char (match-end 0)))))
5899 (c-forward-syntactic-ws)
5900 (setq safe-pos (point))))
5902 ((and (c-keyword-member kwd-sym 'c-<>-sexp-kwds)
5903 (eq (char-after) ?<)
5904 (c-forward-<>-arglist (c-keyword-member kwd-sym 'c-<>-type-kwds)))
5905 (c-forward-syntactic-ws)
5906 (setq safe-pos (point)))
5908 ((and (c-keyword-member kwd-sym 'c-nonsymbol-sexp-kwds)
5909 (not (looking-at c-symbol-start))
5910 (c-safe (c-forward-sexp) t))
5911 (c-forward-syntactic-ws)
5912 (setq safe-pos (point))))
5914 (when (c-keyword-member kwd-sym 'c-colon-type-list-kwds)
5915 (if (eq (char-after) ?:)
5916 ;; If we are at the colon already, we move over the type
5920 (c-forward-syntactic-ws)
5921 (when (c-forward-keyword-prefixed-id type)
5922 (c-forward-id-comma-list type t)))
5923 ;; Not at the colon, so stop here. But the identifier
5924 ;; ranges in the type list later on should still be
5926 (and c-record-type-identifiers
5928 ;; If a keyword matched both one of the types above and
5929 ;; this one, we match `c-colon-type-list-re' after the
5930 ;; clause matched above.
5931 (goto-char safe-pos)
5932 (looking-at c-colon-type-list-re))
5934 (goto-char (match-end 0))
5935 (c-forward-syntactic-ws)
5936 (c-forward-keyword-prefixed-id type))
5937 ;; There's a type after the `c-colon-type-list-re' match
5938 ;; after a keyword in `c-colon-type-list-kwds'.
5939 (c-forward-id-comma-list type nil))))
5941 (goto-char safe-pos)
5944 ;; cc-mode requires cc-fonts.
5945 (declare-function c-fontify-recorded-types-and-refs "cc-fonts" ())
5947 (defun c-forward-<>-arglist (all-types)
5948 ;; The point is assumed to be at a "<". Try to treat it as the open
5949 ;; paren of an angle bracket arglist and move forward to the
5950 ;; corresponding ">". If successful, the point is left after the
5951 ;; ">" and t is returned, otherwise the point isn't moved and nil is
5952 ;; returned. If ALL-TYPES is t then all encountered arguments in
5953 ;; the arglist that might be types are treated as found types.
5955 ;; The variable `c-parse-and-markup-<>-arglists' controls how this
5956 ;; function handles text properties on the angle brackets and argument
5957 ;; separating commas.
5959 ;; `c-restricted-<>-arglists' controls how lenient the template
5960 ;; arglist recognition should be.
5962 ;; This function records identifier ranges on
5963 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5964 ;; `c-record-type-identifiers' is non-nil.
5966 ;; This function might do hidden buffer changes.
5968 (let ((start (point))
5969 ;; If `c-record-type-identifiers' is set then activate
5970 ;; recording of any found types that constitute an argument in
5972 (c-record-found-types (if c-record-type-identifiers t)))
5973 (if (catch 'angle-bracket-arglist-escape
5974 (setq c-record-found-types
5975 (c-forward-<>-arglist-recur all-types)))
5977 (when (consp c-record-found-types)
5978 (setq c-record-type-identifiers
5979 ;; `nconc' doesn't mind that the tail of
5980 ;; `c-record-found-types' is t.
5981 (nconc c-record-found-types c-record-type-identifiers)))
5982 (if (c-major-mode-is 'java-mode) (c-fontify-recorded-types-and-refs))
5988 (defun c-forward-<>-arglist-recur (all-types)
5989 ;; Recursive part of `c-forward-<>-arglist'.
5991 ;; This function might do hidden buffer changes.
5992 (let ((start (point)) res pos
5993 ;; Cover this so that any recorded found type ranges are
5994 ;; automatically lost if it turns out to not be an angle
5995 ;; bracket arglist. It's propagated through the return value
5996 ;; on successful completion.
5997 (c-record-found-types c-record-found-types)
5998 ;; List that collects the positions after the argument
5999 ;; separating ',' in the arglist.
6001 ;; If the '<' has paren open syntax then we've marked it as an angle
6002 ;; bracket arglist before, so skip to the end.
6003 (if (and (not c-parse-and-markup-<>-arglists)
6004 (c-get-char-property (point) 'syntax-table))
6008 (if (and (c-go-up-list-forward)
6009 (eq (char-before) ?>))
6011 ;; Got unmatched paren angle brackets. We don't clear the paren
6012 ;; syntax properties and retry, on the basis that it's very
6013 ;; unlikely that paren angle brackets become operators by code
6014 ;; manipulation. It's far more likely that it doesn't match due
6015 ;; to narrowing or some temporary change.
6019 (forward-char) ; Forward over the opening '<'.
6021 (unless (looking-at c-<-op-cont-regexp)
6022 ;; go forward one non-alphanumeric character (group) per iteration of
6026 (c-forward-syntactic-ws)
6027 (when (or (and c-record-type-identifiers all-types)
6028 (c-major-mode-is 'java-mode))
6029 ;; All encountered identifiers are types, so set the
6030 ;; promote flag and parse the type.
6032 (c-forward-syntactic-ws)
6033 (if (looking-at "\\?")
6035 (when (looking-at c-identifier-start)
6036 (let ((c-promote-possible-types t)
6037 (c-record-found-types t))
6040 (c-forward-syntactic-ws)
6042 (when (or (looking-at "extends")
6043 (looking-at "super"))
6045 (c-forward-syntactic-ws)
6046 (let ((c-promote-possible-types t)
6047 (c-record-found-types t))
6049 (c-forward-syntactic-ws)))))
6051 (setq pos (point)) ; e.g. first token inside the '<'
6053 ;; Note: These regexps exploit the match order in \| so
6054 ;; that "<>" is matched by "<" rather than "[^>:-]>".
6055 (c-syntactic-re-search-forward
6056 ;; Stop on ',', '|', '&', '+' and '-' to catch
6057 ;; common binary operators that could be between
6058 ;; two comparison expressions "a<b" and "c>d".
6059 ;; 2016-02-11: C++11 templates can now contain arithmetic
6060 ;; expressions, so template detection in C++ is now less
6061 ;; robust than it was.
6062 c-<>-notable-chars-re
6066 ((eq (char-before) ?>)
6067 ;; Either an operator starting with '>' or the end of
6068 ;; the angle bracket arglist.
6071 (c-backward-token-2)
6072 (looking-at c-multichar->-op-not->>-regexp))
6074 (goto-char (match-end 0))
6075 t) ; Continue the loop.
6077 ;; The angle bracket arglist is finished.
6078 (when c-parse-and-markup-<>-arglists
6079 (while arg-start-pos
6080 (c-put-c-type-property (1- (car arg-start-pos))
6082 (setq arg-start-pos (cdr arg-start-pos)))
6083 (c-mark-<-as-paren start)
6084 (c-mark->-as-paren (1- (point))))
6086 nil)) ; Exit the loop.
6088 ((eq (char-before) ?<)
6089 ;; Either an operator starting with '<' or a nested arglist.
6091 (let (id-start id-end subres keyword-match)
6093 ;; The '<' begins a multi-char operator.
6094 ((looking-at c-<-op-cont-regexp)
6095 (goto-char (match-end 0)))
6096 ;; We're at a nested <.....>
6098 (backward-char) ; to the '<'
6101 ;; There's always an identifier before an angle
6102 ;; bracket arglist, or a keyword in `c-<>-type-kwds'
6103 ;; or `c-<>-arglist-kwds'.
6104 (c-backward-syntactic-ws)
6105 (setq id-end (point))
6106 (c-simple-skip-symbol-backward)
6107 (when (or (setq keyword-match
6108 (looking-at c-opt-<>-sexp-key))
6109 (not (looking-at c-keywords-regexp)))
6110 (setq id-start (point))))
6112 (let ((c-promote-possible-types t)
6113 (c-record-found-types t))
6114 (c-forward-<>-arglist-recur
6117 (c-keyword-sym (match-string 1))
6118 'c-<>-type-kwds))))))
6119 (or subres (goto-char pos))
6121 ;; It was an angle bracket arglist.
6122 (setq c-record-found-types subres)
6124 ;; Record the identifier before the template as a type
6125 ;; or reference depending on whether the arglist is last
6126 ;; in a qualified identifier.
6127 (when (and c-record-type-identifiers
6128 (not keyword-match))
6129 (if (and c-opt-identifier-concat-key
6131 (c-forward-syntactic-ws)
6132 (looking-at c-opt-identifier-concat-key)))
6133 (c-record-ref-id (cons id-start id-end))
6134 (c-record-type-id (cons id-start id-end)))))
6136 ;; At a "less than" operator.
6138 ;; (forward-char) ; NO! We've already gone over the <.
6140 t) ; carry on looping.
6143 (eq (char-before) ?\()
6144 (c-go-up-list-forward)
6145 (eq (char-before) ?\))))
6147 ((and (not c-restricted-<>-arglists)
6148 (or (and (eq (char-before) ?&)
6149 (not (eq (char-after) ?&)))
6150 (eq (char-before) ?,)))
6151 ;; Just another argument. Record the position. The
6152 ;; type check stuff that made us stop at it is at
6153 ;; the top of the loop.
6154 (setq arg-start-pos (cons (point) arg-start-pos)))
6157 ;; Got a character that can't be in an angle bracket
6158 ;; arglist argument. Abort using `throw', since
6159 ;; it's useless to try to find a surrounding arglist
6161 (throw 'angle-bracket-arglist-escape nil))))))
6163 (or c-record-found-types t)))))
6165 (defun c-backward-<>-arglist (all-types &optional limit)
6166 ;; The point is assumed to be directly after a ">". Try to treat it
6167 ;; as the close paren of an angle bracket arglist and move back to
6168 ;; the corresponding "<". If successful, the point is left at
6169 ;; the "<" and t is returned, otherwise the point isn't moved and
6170 ;; nil is returned. ALL-TYPES is passed on to
6171 ;; `c-forward-<>-arglist'.
6173 ;; If the optional LIMIT is given, it bounds the backward search.
6174 ;; It's then assumed to be at a syntactically relevant position.
6176 ;; This is a wrapper around `c-forward-<>-arglist'. See that
6177 ;; function for more details.
6179 (let ((start (point)))
6181 (if (and (not c-parse-and-markup-<>-arglists)
6182 (c-get-char-property (point) 'syntax-table))
6184 (if (and (c-go-up-list-backward)
6185 (eq (char-after) ?<))
6187 ;; See corresponding note in `c-forward-<>-arglist'.
6192 (c-syntactic-skip-backward "^<;{}" limit t)
6195 (if (eq (char-before) ?<)
6197 ;; Stopped at bob or a char that isn't allowed in an
6198 ;; arglist, so we've failed.
6203 (progn (c-beginning-of-current-token)
6205 ;; If we moved then the "<" was part of some
6206 ;; multicharacter token.
6210 (let ((beg-pos (point)))
6211 (if (c-forward-<>-arglist all-types)
6212 (cond ((= (point) start)
6213 ;; Matched the arglist. Break the while.
6217 ;; We started from a non-paren ">" inside an
6222 ;; Matched a shorter arglist. Can be a nested
6223 ;; one so continue looking.
6228 (/= (point) start))))
6230 (defun c-forward-name ()
6231 ;; Move forward over a complete name if at the beginning of one,
6232 ;; stopping at the next following token. A keyword, as such,
6233 ;; doesn't count as a name. If the point is not at something that
6234 ;; is recognized as a name then it stays put.
6236 ;; A name could be something as simple as "foo" in C or something as
6237 ;; complex as "X<Y<class A<int>::B, BIT_MAX >> b>, ::operator<> ::
6238 ;; Z<(a>b)> :: operator const X<&foo>::T Q::G<unsigned short
6239 ;; int>::*volatile const" in C++ (this function is actually little
6240 ;; more than a `looking-at' call in all modes except those that,
6241 ;; like C++, have `c-recognize-<>-arglists' set).
6244 ;; o - nil if no name is found;
6245 ;; o - 'template if it's an identifier ending with an angle bracket
6247 ;; o - 'operator of it's an operator identifier;
6248 ;; o - t if it's some other kind of name.
6250 ;; This function records identifier ranges on
6251 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6252 ;; `c-record-type-identifiers' is non-nil.
6254 ;; This function might do hidden buffer changes.
6256 (let ((pos (point)) (start (point)) res id-start id-end
6257 ;; Turn off `c-promote-possible-types' here since we might
6258 ;; call `c-forward-<>-arglist' and we don't want it to promote
6259 ;; every suspect thing in the arglist to a type. We're
6260 ;; typically called from `c-forward-type' in this case, and
6261 ;; the caller only wants the top level type that it finds to
6263 c-promote-possible-types)
6266 (looking-at c-identifier-key)
6269 ;; Check for keyword. We go to the last symbol in
6270 ;; `c-identifier-key' first.
6271 (goto-char (setq id-end (match-end 0)))
6272 (c-simple-skip-symbol-backward)
6273 (setq id-start (point))
6275 (if (looking-at c-keywords-regexp)
6276 (when (and (c-major-mode-is 'c++-mode)
6278 (cc-eval-when-compile
6279 (concat "\\(operator\\|\\(template\\)\\)"
6280 "\\(" (c-lang-const c-nonsymbol-key c++)
6282 (if (match-beginning 2)
6283 ;; "template" is only valid inside an
6284 ;; identifier if preceded by "::".
6286 (c-backward-syntactic-ws)
6287 (and (c-safe (backward-char 2) t)
6291 ;; Handle a C++ operator or template identifier.
6293 (c-forward-syntactic-ws)
6294 (cond ((eq (char-before id-end) ?e)
6295 ;; Got "... ::template".
6296 (let ((subres (c-forward-name)))
6301 ((looking-at c-identifier-start)
6302 ;; Got a cast operator.
6303 (when (c-forward-type)
6306 ;; Now we should match a sequence of either
6307 ;; '*', '&' or a name followed by ":: *",
6308 ;; where each can be followed by a sequence
6309 ;; of `c-opt-type-modifier-key'.
6310 (while (cond ((looking-at "[*&]")
6311 (goto-char (match-end 0))
6313 ((looking-at c-identifier-start)
6314 (and (c-forward-name)
6317 (goto-char (match-end 0))
6318 (c-forward-syntactic-ws)
6319 (eq (char-after) ?*))
6324 (c-forward-syntactic-ws)
6326 (looking-at c-opt-type-modifier-key))
6327 (goto-char (match-end 1))))))
6329 ((looking-at c-overloadable-operators-regexp)
6330 ;; Got some other operator.
6331 (setq c-last-identifier-range
6332 (cons (point) (match-end 0)))
6333 (goto-char (match-end 0))
6334 (c-forward-syntactic-ws)
6340 ;; `id-start' is equal to `id-end' if we've jumped over
6341 ;; an identifier that doesn't end with a symbol token.
6342 ;; That can occur e.g. for Java import directives on the
6343 ;; form "foo.bar.*".
6344 (when (and id-start (/= id-start id-end))
6345 (setq c-last-identifier-range
6346 (cons id-start id-end)))
6348 (c-forward-syntactic-ws)
6354 (when (or c-opt-identifier-concat-key
6355 c-recognize-<>-arglists)
6358 ((and c-opt-identifier-concat-key
6359 (looking-at c-opt-identifier-concat-key))
6360 ;; Got a concatenated identifier. This handles the
6361 ;; cases with tricky syntactic whitespace that aren't
6362 ;; covered in `c-identifier-key'.
6363 (goto-char (match-end 0))
6364 (c-forward-syntactic-ws)
6367 ((and c-recognize-<>-arglists
6368 (eq (char-after) ?<))
6369 ;; Maybe an angle bracket arglist.
6370 (when (let ((c-record-type-identifiers t)
6371 (c-record-found-types t))
6372 (c-forward-<>-arglist nil))
6374 (c-add-type start (1+ pos))
6375 (c-forward-syntactic-ws)
6377 c-last-identifier-range nil)
6379 (if (and c-opt-identifier-concat-key
6380 (looking-at c-opt-identifier-concat-key))
6382 ;; Continue if there's an identifier concatenation
6383 ;; operator after the template argument.
6385 (when (and c-record-type-identifiers id-start)
6386 (c-record-ref-id (cons id-start id-end)))
6388 (c-forward-syntactic-ws)
6391 (when (and c-record-type-identifiers id-start)
6392 (c-record-type-id (cons id-start id-end)))
6393 (setq res 'template)
6400 (defun c-forward-type (&optional brace-block-too)
6401 ;; Move forward over a type spec if at the beginning of one,
6402 ;; stopping at the next following token. The keyword "typedef"
6403 ;; isn't part of a type spec here.
6405 ;; BRACE-BLOCK-TOO, when non-nil, means move over the brace block in
6406 ;; constructs like "struct foo {...} bar ;" or "struct {...} bar;".
6407 ;; The current (2009-03-10) intention is to convert all uses of
6408 ;; `c-forward-type' to call with this parameter set, then to
6412 ;; o - t if it's a known type that can't be a name or other
6414 ;; o - 'known if it's an otherwise known type (according to
6415 ;; `*-font-lock-extra-types');
6416 ;; o - 'prefix if it's a known prefix of a type;
6417 ;; o - 'found if it's a type that matches one in `c-found-types';
6418 ;; o - 'maybe if it's an identifier that might be a type;
6419 ;; o - 'decltype if it's a decltype(variable) declaration; - or
6420 ;; o - nil if it can't be a type (the point isn't moved then).
6422 ;; The point is assumed to be at the beginning of a token.
6424 ;; Note that this function doesn't skip past the brace definition
6425 ;; that might be considered part of the type, e.g.
6426 ;; "enum {a, b, c} foo".
6428 ;; This function records identifier ranges on
6429 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6430 ;; `c-record-type-identifiers' is non-nil.
6432 ;; This function might do hidden buffer changes.
6433 (when (and c-recognize-<>-arglists
6435 (c-forward-<>-arglist t)
6436 (c-forward-syntactic-ws))
6438 (let ((start (point)) pos res name-res id-start id-end id-range)
6440 ;; Skip leading type modifiers. If any are found we know it's a
6441 ;; prefix of a type.
6442 (when c-opt-type-modifier-key ; e.g. "const" "volatile", but NOT "typedef"
6443 (while (looking-at c-opt-type-modifier-key)
6444 (goto-char (match-end 1))
6445 (c-forward-syntactic-ws)
6446 (setq res 'prefix)))
6449 ((looking-at c-typeof-key) ; e.g. C++'s "decltype".
6450 (goto-char (match-end 1))
6451 (c-forward-syntactic-ws)
6452 (setq res (and (eq (char-after) ?\()
6453 (c-safe (c-forward-sexp))
6456 (c-forward-syntactic-ws)
6459 ((looking-at c-type-prefix-key) ; e.g. "struct", "class", but NOT
6461 (goto-char (match-end 1))
6462 (c-forward-syntactic-ws)
6465 (setq name-res (c-forward-name))
6466 (setq res (not (null name-res)))
6467 (when (eq name-res t)
6468 ;; In many languages the name can be used without the
6469 ;; prefix, so we add it to `c-found-types'.
6470 (c-add-type pos (point))
6471 (when (and c-record-type-identifiers
6472 c-last-identifier-range)
6473 (c-record-type-id c-last-identifier-range)))
6474 (when (and brace-block-too
6476 (eq (char-after) ?\{)
6479 (progn (c-forward-sexp)
6480 (c-forward-syntactic-ws)
6481 (setq pos (point))))))
6484 (unless res (goto-char start))) ; invalid syntax
6488 (if (looking-at c-identifier-start)
6490 (setq id-start (point)
6491 name-res (c-forward-name))
6493 (setq id-end (point)
6494 id-range c-last-identifier-range))))
6495 (and (cond ((looking-at c-primitive-type-key)
6497 ((c-with-syntax-table c-identifier-syntax-table
6498 (looking-at c-known-type-key))
6503 (goto-char (match-end 1))
6504 (c-forward-syntactic-ws)
6505 (setq pos (point))))
6508 ;; Looking at a primitive or known type identifier. We've
6509 ;; checked for a name first so that we don't go here if the
6510 ;; known type match only is a prefix of another name.
6512 (setq id-end (match-end 1))
6514 (when (and c-record-type-identifiers
6515 (or c-promote-possible-types (eq res t)))
6516 (c-record-type-id (cons (match-beginning 1) (match-end 1))))
6518 (if (and c-opt-type-component-key
6520 (looking-at c-opt-type-component-key)))
6521 ;; There might be more keywords for the type.
6523 (c-forward-keyword-clause 1)
6525 (setq safe-pos (point))
6526 (looking-at c-opt-type-component-key))
6527 (when (and c-record-type-identifiers
6528 (looking-at c-primitive-type-key))
6529 (c-record-type-id (cons (match-beginning 1)
6531 (c-forward-keyword-clause 1))
6532 (if (looking-at c-primitive-type-key)
6534 (when c-record-type-identifiers
6535 (c-record-type-id (cons (match-beginning 1)
6537 (c-forward-keyword-clause 1)
6539 (goto-char safe-pos)
6540 (setq res 'prefix)))
6541 (unless (save-match-data (c-forward-keyword-clause 1))
6544 (goto-char (match-end 1))
6545 (c-forward-syntactic-ws)))))
6548 (cond ((eq name-res t)
6549 ;; A normal identifier.
6551 (if (or res c-promote-possible-types)
6553 (c-add-type id-start id-end)
6554 (when (and c-record-type-identifiers id-range)
6555 (c-record-type-id id-range))
6558 (setq res (if (c-check-type id-start id-end)
6559 ;; It's an identifier that has been used as
6560 ;; a type somewhere else.
6562 ;; It's an identifier that might be a type.
6564 ((eq name-res 'template)
6565 ;; A template is a type.
6569 ;; Otherwise it's an operator identifier, which is not a type.
6574 ;; Skip trailing type modifiers. If any are found we know it's
6576 (when c-opt-type-modifier-key
6577 (while (looking-at c-opt-type-modifier-key) ; e.g. "const", "volatile"
6578 (goto-char (match-end 1))
6579 (c-forward-syntactic-ws)
6582 ;; Step over any type suffix operator. Do not let the existence
6583 ;; of these alter the classification of the found type, since
6584 ;; these operators typically are allowed in normal expressions
6586 (when c-opt-type-suffix-key ; e.g. "..."
6587 (while (looking-at c-opt-type-suffix-key)
6588 (goto-char (match-end 1))
6589 (c-forward-syntactic-ws)))
6591 (when c-opt-type-concat-key ; Only/mainly for pike.
6592 ;; Look for a trailing operator that concatenates the type
6593 ;; with a following one, and if so step past that one through
6594 ;; a recursive call. Note that we don't record concatenated
6595 ;; types in `c-found-types' - it's the component types that
6596 ;; are recorded when appropriate.
6598 (let* ((c-promote-possible-types (or (memq res '(t known))
6599 c-promote-possible-types))
6600 ;; If we can't promote then set `c-record-found-types' so that
6601 ;; we can merge in the types from the second part afterwards if
6602 ;; it turns out to be a known type there.
6603 (c-record-found-types (and c-record-type-identifiers
6604 (not c-promote-possible-types)))
6606 (if (and (looking-at c-opt-type-concat-key)
6609 (goto-char (match-end 1))
6610 (c-forward-syntactic-ws)
6611 (setq subres (c-forward-type))))
6614 ;; If either operand certainly is a type then both are, but we
6615 ;; don't let the existence of the operator itself promote two
6616 ;; uncertain types to a certain one.
6619 (unless (eq name-res 'template)
6620 (c-add-type id-start id-end))
6621 (when (and c-record-type-identifiers id-range)
6622 (c-record-type-id id-range))
6633 (when (and (eq res t)
6634 (consp c-record-found-types))
6635 ;; Merge in the ranges of any types found by the second
6636 ;; `c-forward-type'.
6637 (setq c-record-type-identifiers
6638 ;; `nconc' doesn't mind that the tail of
6639 ;; `c-record-found-types' is t.
6640 (nconc c-record-found-types
6641 c-record-type-identifiers))))
6645 (when (and c-record-found-types (memq res '(known found)) id-range)
6646 (setq c-record-found-types
6647 (cons id-range c-record-found-types))))
6649 ;;(message "c-forward-type %s -> %s: %s" start (point) res)
6653 (defun c-forward-annotation ()
6654 ;; Used for Java code only at the moment. Assumes point is on the @, moves
6655 ;; forward an annotation and returns t. Leaves point unmoved and returns
6656 ;; nil if there is no annotation at point.
6657 (let ((pos (point)))
6659 (and (looking-at "@")
6660 (not (looking-at c-keywords-regexp))
6661 (progn (forward-char) t)
6662 (looking-at c-symbol-key)
6663 (progn (goto-char (match-end 0))
6664 (c-forward-syntactic-ws)
6666 (if (looking-at "(")
6669 (progn (goto-char pos) nil))))
6671 (defmacro c-pull-open-brace (ps)
6672 ;; Pull the next open brace from PS (which has the form of paren-state),
6673 ;; skipping over any brace pairs. Returns NIL when PS is exhausted.
6675 (while (consp (car ,ps))
6676 (setq ,ps (cdr ,ps)))
6678 (setq ,ps (cdr ,ps)))))
6680 (defun c-back-over-member-initializer-braces ()
6681 ;; Point is just after a closing brace/parenthesis. Try to parse this as a
6682 ;; C++ member initializer list, going back to just after the introducing ":"
6683 ;; and returning t. Otherwise return nil, leaving point unchanged.
6684 (let ((here (point)) res)
6687 (when (not (c-go-list-backward))
6689 (c-backward-syntactic-ws)
6690 (when (not (c-simple-skip-symbol-backward))
6692 (c-backward-syntactic-ws)
6694 (while (eq (char-before) ?,)
6696 (c-backward-syntactic-ws)
6697 (when (not (memq (char-before) '(?\) ?})))
6699 (when (not (c-go-list-backward))
6701 (c-backward-syntactic-ws)
6702 (when (not (c-simple-skip-symbol-backward))
6704 (c-backward-syntactic-ws))
6706 (eq (char-before) ?:)))
6707 (or res (goto-char here))
6710 (defmacro c-back-over-list-of-member-inits ()
6711 ;; Go back over a list of elements, each looking like:
6712 ;; <symbol> (<expression>) ,
6713 ;; or <symbol> {<expression>} ,
6714 ;; when we are putatively immediately after a comma. Stop when we don't see
6715 ;; a comma. If either of <symbol> or bracketed <expression> is missing,
6716 ;; throw nil to 'level. If the terminating } or ) is unmatched, throw nil
6717 ;; to 'done. This is not a general purpose macro!
6718 `(while (eq (char-before) ?,)
6720 (c-backward-syntactic-ws)
6721 (when (not (memq (char-before) '(?\) ?})))
6723 (when (not (c-go-list-backward))
6725 (c-backward-syntactic-ws)
6726 (when (not (c-simple-skip-symbol-backward))
6728 (c-backward-syntactic-ws)))
6730 (defun c-back-over-member-initializers ()
6731 ;; Test whether we are in a C++ member initializer list, and if so, go back
6732 ;; to the introducing ":", returning the position of the opening paren of
6733 ;; the function's arglist. Otherwise return nil, leaving point unchanged.
6734 (let ((here (point))
6735 (paren-state (c-parse-state))
6736 pos level-plausible at-top-level res)
6737 ;; Assume tentatively that we're at the top level. Try to go back to the
6741 (setq level-plausible
6743 (c-backward-syntactic-ws)
6744 (when (memq (char-before) '(?\) ?}))
6745 (when (not (c-go-list-backward))
6747 (c-backward-syntactic-ws))
6748 (when (c-simple-skip-symbol-backward)
6749 (c-backward-syntactic-ws))
6750 (c-back-over-list-of-member-inits)
6751 (and (eq (char-before) ?:)
6752 (c-just-after-func-arglist-p))))
6754 (while (and (not (and level-plausible
6755 (setq at-top-level (c-at-toplevel-p))))
6756 (setq pos (c-pull-open-brace paren-state))) ; might be a paren.
6757 (setq level-plausible
6760 (c-backward-syntactic-ws)
6761 (when (not (c-simple-skip-symbol-backward))
6763 (c-backward-syntactic-ws)
6764 (c-back-over-list-of-member-inits)
6765 (and (eq (char-before) ?:)
6766 (c-just-after-func-arglist-p)))))
6768 (and at-top-level level-plausible)))
6769 (or res (goto-char here))
6773 ;; Handling of large scale constructs like statements and declarations.
6775 ;; Macro used inside `c-forward-decl-or-cast-1'. It ought to be a
6776 ;; defsubst or perhaps even a defun, but it contains lots of free
6777 ;; variables that refer to things inside `c-forward-decl-or-cast-1'.
6778 (defmacro c-fdoc-shift-type-backward (&optional short)
6779 ;; `c-forward-decl-or-cast-1' can consume an arbitrary length list
6780 ;; of types when parsing a declaration, which means that it
6781 ;; sometimes consumes the identifier in the declaration as a type.
6782 ;; This is used to "backtrack" and make the last type be treated as
6783 ;; an identifier instead.
6786 ;; These identifiers are bound only in the inner let.
6787 '(setq identifier-type at-type
6788 identifier-start type-start
6792 got-suffix-after-parens id-start
6795 (if (setq at-type (if (eq backup-at-type 'prefix)
6798 (setq type-start backup-type-start
6799 id-start backup-id-start)
6800 (setq type-start start-pos
6801 id-start start-pos))
6803 ;; When these flags already are set we've found specifiers that
6804 ;; unconditionally signal these attributes - backtracking doesn't
6805 ;; change that. So keep them set in that case.
6807 (setq at-type-decl backup-at-type-decl))
6809 (setq maybe-typeless backup-maybe-typeless))
6812 ;; This identifier is bound only in the inner let.
6813 '(setq start id-start))))
6815 (defun c-forward-declarator (&optional limit accept-anon)
6816 ;; Assuming point is at the start of a declarator, move forward over it,
6817 ;; leaving point at the next token after it (e.g. a ) or a ; or a ,).
6819 ;; Return a list (ID-START ID-END BRACKETS-AFTER-ID GOT-INIT), where ID-START and
6820 ;; ID-END are the bounds of the declarator's identifier, and
6821 ;; BRACKETS-AFTER-ID is non-nil if a [...] pair is present after the id.
6822 ;; GOT-INIT is non-nil when the declarator is followed by "=" or "(".
6824 ;; If ACCEPT-ANON is non-nil, move forward over any "anonymous declarator",
6825 ;; i.e. something like the (*) in int (*), such as might be found in a
6826 ;; declaration. In such a case ID-START and ID-END in the return value are
6827 ;; both set to nil. A "null" "anonymous declarator" gives a non-nil result.
6829 ;; If no declarator is found, leave point unmoved and return nil. LIMIT is
6830 ;; an optional limit for forward searching.
6832 ;; Note that the global variable `c-last-identifier-range' is written to, so
6833 ;; the caller should bind it if necessary.
6835 ;; Inside the following "condition form", we move forward over the
6836 ;; declarator's identifier up as far as any opening bracket (for array
6837 ;; size) or paren (for parameters of function-type) or brace (for
6838 ;; array/struct initialization) or "=" or terminating delimiter
6839 ;; (e.g. "," or ";" or "}").
6840 (let ((here (point))
6841 id-start id-end brackets-after-id paren-depth)
6842 (or limit (setq limit (point-max)))
6846 ;; The following form moves forward over the declarator's
6847 ;; identifier (and what precedes it), returning t. If there
6848 ;; wasn't one, it returns nil.
6849 (let (got-identifier)
6850 (setq paren-depth 0)
6851 ;; Skip over type decl prefix operators, one for each iteration
6852 ;; of the while. These are, e.g. "*" in "int *foo" or "(" and
6853 ;; "*" in "int (*foo) (void)" (Note similar code in
6854 ;; `c-forward-decl-or-cast-1'.)
6855 (while (and (looking-at c-type-decl-prefix-key)
6856 (if (and (c-major-mode-is 'c++-mode)
6857 (match-beginning 3))
6858 ;; If the third submatch matches in C++ then
6859 ;; we're looking at an identifier that's a
6860 ;; prefix only if it specifies a member pointer.
6862 (setq id-start (point))
6864 (if (looking-at "\\(::\\)")
6865 ;; We only check for a trailing "::" and
6866 ;; let the "*" that should follow be
6867 ;; matched in the next round.
6869 ;; It turned out to be the real identifier,
6870 ;; so flag that and stop.
6871 (setq got-identifier t)
6874 (if (eq (char-after) ?\()
6876 (setq paren-depth (1+ paren-depth))
6878 (goto-char (match-end 1)))
6879 (c-forward-syntactic-ws))
6881 ;; If we haven't passed the identifier already, do it now.
6882 (unless got-identifier
6883 (setq id-start (point)))
6888 (c-backward-syntactic-ws)
6889 (setq id-end (point))))
6891 (setq id-start nil id-end nil)
6893 (t (/= (point) here))))
6895 ;; Skip out of the parens surrounding the identifier. If closing
6896 ;; parens are missing, this form returns nil.
6897 (or (= paren-depth 0)
6898 (c-safe (goto-char (scan-lists (point) 1 paren-depth))))
6902 ;; Skip over any trailing bit, such as "__attribute__".
6904 (when (looking-at c-decl-hangon-key)
6905 (c-forward-keyword-clause 1))
6908 ;; Search syntactically to the end of the declarator (";",
6909 ;; ",", a closing paren, eob etc) or to the beginning of an
6910 ;; initializer or function prototype ("=" or "\\s\(").
6911 ;; Note that square brackets are now not also treated as
6912 ;; initializers, since this broke when there were also
6913 ;; initializing brace lists.
6916 (and (setq found (c-syntactic-re-search-forward
6917 "[;,]\\|\\s)\\|\\'\\|\\(=\\|\\s(\\)" limit t t))
6918 (eq (char-before) ?\[)
6919 (c-go-up-list-forward))
6920 (setq brackets-after-id t))
6923 (list id-start id-end brackets-after-id (match-beginning 1))
6928 (defun c-forward-decl-or-cast-1 (preceding-token-end context last-cast-end)
6929 ;; Move forward over a declaration or a cast if at the start of one.
6930 ;; The point is assumed to be at the start of some token. Nil is
6931 ;; returned if no declaration or cast is recognized, and the point
6932 ;; is clobbered in that case.
6934 ;; If a declaration is parsed:
6936 ;; The point is left at the first token after the first complete
6937 ;; declarator, if there is one. The return value is a cons where
6938 ;; the car is the position of the first token in the declarator. (See
6939 ;; below for the cdr.)
6942 ;; void foo (int a, char *b) stuff ...
6946 ;; unsigned int a = c_style_initializer, b;
6948 ;; unsigned int a (cplusplus_style_initializer), b;
6949 ;; car ^ ^ point (might change)
6950 ;; class Foo : public Bar {}
6952 ;; class PikeClass (int a, string b) stuff ...
6958 ;; void cplusplus_function (int x) throw (Bad);
6960 ;; Foo::Foo (int b) : Base (b) {}
6965 ;; auto cplusplus_11 (int a, char *b) -> decltype (bar):
6970 ;; The cdr of the return value is non-nil when a
6971 ;; `c-typedef-decl-kwds' specifier is found in the declaration.
6972 ;; Specifically it is a dotted pair (A . B) where B is t when a
6973 ;; `c-typedef-kwds' ("typedef") is present, and A is t when some
6974 ;; other `c-typedef-decl-kwds' (e.g. class, struct, enum)
6975 ;; specifier is present. I.e., (some of) the declared
6976 ;; identifier(s) are types.
6978 ;; If a cast is parsed:
6980 ;; The point is left at the first token after the closing paren of
6981 ;; the cast. The return value is `cast'. Note that the start
6982 ;; position must be at the first token inside the cast parenthesis
6985 ;; PRECEDING-TOKEN-END is the first position after the preceding
6986 ;; token, i.e. on the other side of the syntactic ws from the point.
6987 ;; Use a value less than or equal to (point-min) if the point is at
6988 ;; the first token in (the visible part of) the buffer.
6990 ;; CONTEXT is a symbol that describes the context at the point:
6991 ;; 'decl In a comma-separated declaration context (typically
6992 ;; inside a function declaration arglist).
6993 ;; '<> In an angle bracket arglist.
6994 ;; 'arglist Some other type of arglist.
6995 ;; nil Some other context or unknown context. Includes
6996 ;; within the parens of an if, for, ... construct.
6998 ;; LAST-CAST-END is the first token after the closing paren of a
6999 ;; preceding cast, or nil if none is known. If
7000 ;; `c-forward-decl-or-cast-1' is used in succession, it should be
7001 ;; the position after the closest preceding call where a cast was
7002 ;; matched. In that case it's used to discover chains of casts like
7005 ;; This function records identifier ranges on
7006 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
7007 ;; `c-record-type-identifiers' is non-nil.
7009 ;; This function might do hidden buffer changes.
7011 (let (;; `start-pos' is used below to point to the start of the
7012 ;; first type, i.e. after any leading specifiers. It might
7013 ;; also point at the beginning of the preceding syntactic
7016 ;; Set to the result of `c-forward-type'.
7018 ;; The position of the first token in what we currently
7019 ;; believe is the type in the declaration or cast, after any
7020 ;; specifiers and their associated clauses.
7022 ;; The position of the first token in what we currently
7023 ;; believe is the declarator for the first identifier. Set
7024 ;; when the type is found, and moved forward over any
7025 ;; `c-decl-hangon-kwds' and their associated clauses that
7026 ;; occurs after the type.
7028 ;; These store `at-type', `type-start' and `id-start' of the
7029 ;; identifier before the one in those variables. The previous
7030 ;; identifier might turn out to be the real type in a
7031 ;; declaration if the last one has to be the declarator in it.
7032 ;; If `backup-at-type' is nil then the other variables have
7033 ;; undefined values.
7034 backup-at-type backup-type-start backup-id-start
7035 ;; This stores `kwd-sym' of the symbol before the current one.
7036 ;; This is needed to distinguish the C++11 version of "auto" from
7037 ;; the pre C++11 meaning.
7039 ;; Set if we've found a specifier (apart from "typedef") that makes
7040 ;; the defined identifier(s) types.
7042 ;; Set if we've a "typedef" keyword.
7044 ;; Set if we've found a specifier that can start a declaration
7045 ;; where there's no type.
7047 ;; Save the value of kwd-sym between loops of the "Check for a
7048 ;; type" loop. Needed to distinguish a C++11 "auto" from a pre
7051 ;; If a specifier is found that also can be a type prefix,
7052 ;; these flags are set instead of those above. If we need to
7053 ;; back up an identifier, they are copied to the real flag
7054 ;; variables. Thus they only take effect if we fail to
7055 ;; interpret it as a type.
7056 backup-at-type-decl backup-maybe-typeless
7057 ;; Whether we've found a declaration or a cast. We might know
7058 ;; this before we've found the type in it. It's 'ids if we've
7059 ;; found two consecutive identifiers (usually a sure sign, but
7060 ;; we should allow that in labels too), and t if we've found a
7061 ;; specifier keyword (a 100% sure sign).
7063 ;; Set when we need to back up to parse this as a declaration
7064 ;; but not as a cast.
7066 ;; For casts, the return position.
7068 ;; Have we got a new-style C++11 "auto"?
7070 ;; Save `c-record-type-identifiers' and
7071 ;; `c-record-ref-identifiers' since ranges are recorded
7072 ;; speculatively and should be thrown away if it turns out
7073 ;; that it isn't a declaration or cast.
7074 (save-rec-type-ids c-record-type-identifiers)
7075 (save-rec-ref-ids c-record-ref-identifiers))
7077 (while (c-forward-annotation)
7078 (c-forward-syntactic-ws))
7080 ;; Check for a type. Unknown symbols are treated as possible
7081 ;; types, but they could also be specifiers disguised through
7082 ;; macros like __INLINE__, so we recognize both types and known
7083 ;; specifiers after them too.
7085 (let* ((start (point)) kwd-sym kwd-clause-end found-type)
7087 ;; Look for a specifier keyword clause.
7088 (when (or (looking-at c-prefix-spec-kwds-re) ;FIXME!!! includes auto
7089 (and (c-major-mode-is 'java-mode)
7090 (looking-at "@[A-Za-z0-9]+")))
7091 (if (save-match-data (looking-at c-typedef-key))
7092 (setq at-typedef t))
7093 (setq kwd-sym (c-keyword-sym (match-string 1)))
7095 (c-forward-keyword-clause 1)
7096 (setq kwd-clause-end (point))))
7098 (when (setq found-type (c-forward-type t)) ; brace-block-too
7099 ;; Found a known or possible type or a prefix of a known type.
7100 (when (and (c-major-mode-is 'c++-mode) ; C++11 style "auto"?
7101 (eq prev-kwd-sym (c-keyword-sym "auto"))
7102 (looking-at "[=(]")) ; FIXME!!! proper regexp.
7103 (setq new-style-auto t)
7104 (setq found-type nil)
7105 (goto-char start)) ; position of foo in "auto foo"
7108 ;; Got two identifiers with nothing but whitespace
7109 ;; between them. That can only happen in declarations.
7110 (setq at-decl-or-cast 'ids)
7112 (when (eq at-type 'found)
7113 ;; If the previous identifier is a found type we
7114 ;; record it as a real one; it might be some sort of
7115 ;; alias for a prefix like "unsigned".
7117 (goto-char type-start)
7118 (let ((c-promote-possible-types t))
7119 (c-forward-type)))))
7121 (setq backup-at-type at-type
7122 backup-type-start type-start
7123 backup-id-start id-start
7124 backup-kwd-sym kwd-sym
7128 ;; The previous ambiguous specifier/type turned out
7129 ;; to be a type since we've parsed another one after
7130 ;; it, so clear these backup flags.
7131 backup-at-type-decl nil
7132 backup-maybe-typeless nil))
7136 ;; Handle known specifier keywords and
7137 ;; `c-decl-hangon-kwds' which can occur after known
7140 (if (c-keyword-member kwd-sym 'c-decl-hangon-kwds)
7141 ;; It's a hang-on keyword that can occur anywhere.
7143 (setq at-decl-or-cast t)
7145 ;; Move the identifier start position if
7146 ;; we've passed a type.
7147 (setq id-start kwd-clause-end)
7148 ;; Otherwise treat this as a specifier and
7149 ;; move the fallback position.
7150 (setq start-pos kwd-clause-end))
7151 (goto-char kwd-clause-end))
7153 ;; It's an ordinary specifier so we know that
7154 ;; anything before this can't be the type.
7155 (setq backup-at-type nil
7156 start-pos kwd-clause-end)
7159 ;; It's ambiguous whether this keyword is a
7160 ;; specifier or a type prefix, so set the backup
7161 ;; flags. (It's assumed that `c-forward-type'
7162 ;; moved further than `c-forward-keyword-clause'.)
7164 (when (c-keyword-member kwd-sym 'c-typedef-decl-kwds)
7165 (setq backup-at-type-decl t))
7166 (when (c-keyword-member kwd-sym 'c-typeless-decl-kwds)
7167 (setq backup-maybe-typeless t)))
7169 (when (c-keyword-member kwd-sym 'c-typedef-decl-kwds)
7170 ;; This test only happens after we've scanned a type.
7171 ;; So, with valid syntax, kwd-sym can't be 'typedef.
7172 (setq at-type-decl t))
7173 (when (c-keyword-member kwd-sym 'c-typeless-decl-kwds)
7174 (setq maybe-typeless t))
7176 ;; Haven't matched a type so it's an unambiguous
7177 ;; specifier keyword and we know we're in a
7179 (setq at-decl-or-cast t)
7180 (setq prev-kwd-sym kwd-sym)
7182 (goto-char kwd-clause-end))))
7184 ;; If the type isn't known we continue so that we'll jump
7185 ;; over all specifiers and type identifiers. The reason
7186 ;; to do this for a known type prefix is to make things
7187 ;; like "unsigned INT16" work.
7188 (and found-type (not (eq found-type t))))))
7192 ;; If a known type was found, we still need to skip over any
7193 ;; hangon keyword clauses after it. Otherwise it has already
7194 ;; been done in the loop above.
7195 (while (looking-at c-decl-hangon-key)
7196 (c-forward-keyword-clause 1))
7197 (setq id-start (point)))
7199 ((eq at-type 'prefix)
7200 ;; A prefix type is itself a primitive type when it's not
7201 ;; followed by another type.
7205 ;; Got no type but set things up to continue anyway to handle
7206 ;; the various cases when a declaration doesn't start with a
7208 (setq id-start start-pos))
7210 ((and (eq at-type 'maybe)
7211 (c-major-mode-is 'c++-mode))
7212 ;; If it's C++ then check if the last "type" ends on the form
7213 ;; "foo::foo" or "foo::~foo", i.e. if it's the name of a
7214 ;; (con|de)structor.
7216 (let (name end-2 end-1)
7217 (goto-char id-start)
7218 (c-backward-syntactic-ws)
7219 (setq end-2 (point))
7221 (c-simple-skip-symbol-backward)
7224 (buffer-substring-no-properties (point) end-2))
7225 ;; Cheating in the handling of syntactic ws below.
7226 (< (skip-chars-backward ":~ \t\n\r\v\f") 0))
7228 (setq end-1 (point))
7229 (c-simple-skip-symbol-backward))
7230 (>= (point) type-start)
7231 (equal (buffer-substring-no-properties (point) end-1)
7233 ;; It is a (con|de)structor name. In that case the
7234 ;; declaration is typeless so zap out any preceding
7235 ;; identifier(s) that we might have taken as types.
7236 (goto-char type-start)
7239 id-start type-start))))))
7241 ;; Check for and step over a type decl expression after the thing
7242 ;; that is or might be a type. This can't be skipped since we
7243 ;; need the correct end position of the declarator for
7244 ;; `max-type-decl-end-*'.
7245 (let ((start (point)) (paren-depth 0) pos
7246 ;; True if there's a non-open-paren match of
7247 ;; `c-type-decl-prefix-key'.
7249 ;; True if the declarator is surrounded by a parenthesis pair.
7251 ;; True if there is an identifier in the declarator.
7253 ;; True if there's a non-close-paren match of
7254 ;; `c-type-decl-suffix-key'.
7256 ;; True if there's a prefix match outside the outermost
7257 ;; paren pair that surrounds the declarator.
7258 got-prefix-before-parens
7259 ;; True if there's a suffix match outside the outermost
7260 ;; paren pair that surrounds the declarator. The value is
7261 ;; the position of the first suffix match.
7262 got-suffix-after-parens
7263 ;; True if we've parsed the type decl to a token that is
7264 ;; known to end declarations in this context.
7266 ;; The earlier values of `at-type' and `type-start' if we've
7267 ;; shifted the type backwards.
7268 identifier-type identifier-start
7269 ;; If `c-parse-and-markup-<>-arglists' is set we need to
7270 ;; turn it off during the name skipping below to avoid
7271 ;; getting `c-type' properties that might be bogus. That
7272 ;; can happen since we don't know if
7273 ;; `c-restricted-<>-arglists' will be correct inside the
7274 ;; arglist paren that gets entered.
7275 c-parse-and-markup-<>-arglists
7276 ;; Start of the identifier for which `got-identifier' was set.
7279 (goto-char id-start)
7281 ;; Skip over type decl prefix operators. (Note similar code in
7282 ;; `c-forward-declarator'.)
7283 (if (and c-recognize-typeless-decls
7284 (equal c-type-decl-prefix-key "\\<\\>"))
7285 (when (eq (char-after) ?\()
7287 (setq paren-depth (1+ paren-depth))
7289 (while (and (looking-at c-type-decl-prefix-key)
7290 (if (and (c-major-mode-is 'c++-mode)
7291 (match-beginning 3))
7292 ;; If the third submatch matches in C++ then
7293 ;; we're looking at an identifier that's a
7294 ;; prefix only if it specifies a member pointer.
7295 (when (progn (setq pos (point))
7296 (setq got-identifier (c-forward-name)))
7297 (setq name-start pos)
7298 (if (looking-at "\\(::\\)")
7299 ;; We only check for a trailing "::" and
7300 ;; let the "*" that should follow be
7301 ;; matched in the next round.
7302 (progn (setq got-identifier nil) t)
7303 ;; It turned out to be the real identifier,
7308 (if (eq (char-after) ?\()
7310 (setq paren-depth (1+ paren-depth))
7312 (unless got-prefix-before-parens
7313 (setq got-prefix-before-parens (= paren-depth 0)))
7315 (goto-char (match-end 1)))
7316 (c-forward-syntactic-ws)))
7318 (setq got-parens (> paren-depth 0))
7320 ;; Skip over an identifier.
7322 (and (looking-at c-identifier-start)
7324 (setq got-identifier (c-forward-name))
7325 (setq name-start pos)))
7327 ;; Skip over type decl suffix operators.
7328 (while (if (looking-at c-type-decl-suffix-key)
7330 (if (eq (char-after) ?\))
7331 (when (> paren-depth 0)
7332 (setq paren-depth (1- paren-depth))
7335 (when (if (save-match-data (looking-at "\\s("))
7336 (c-safe (c-forward-sexp 1) t)
7337 (goto-char (match-end 1))
7339 (when (and (not got-suffix-after-parens)
7341 (setq got-suffix-after-parens (match-beginning 0)))
7342 (setq got-suffix t)))
7344 ;; No suffix matched. We might have matched the
7345 ;; identifier as a type and the open paren of a
7346 ;; function arglist as a type decl prefix. In that
7347 ;; case we should "backtrack": Reinterpret the last
7348 ;; type as the identifier, move out of the arglist and
7349 ;; continue searching for suffix operators.
7351 ;; Do this even if there's no preceding type, to cope
7352 ;; with old style function declarations in K&R C,
7353 ;; (con|de)structors in C++ and `c-typeless-decl-kwds'
7354 ;; style declarations. That isn't applicable in an
7355 ;; arglist context, though.
7356 (when (and (= paren-depth 1)
7357 (not got-prefix-before-parens)
7358 (not (eq at-type t))
7361 backup-maybe-typeless
7362 (when c-recognize-typeless-decls
7364 (setq pos (c-up-list-forward (point)))
7365 (eq (char-before pos) ?\)))
7366 (c-fdoc-shift-type-backward)
7370 (c-forward-syntactic-ws))
7372 (when (or (and new-style-auto
7373 (looking-at c-auto-ops-re))
7374 (and (or maybe-typeless backup-maybe-typeless)
7375 (not got-identifier)
7378 ;; Have found no identifier but `c-typeless-decl-kwds' has
7379 ;; matched so we know we're inside a declaration. The
7380 ;; preceding type must be the identifier instead.
7381 (c-fdoc-shift-type-backward))
7383 ;; Prepare the "-> type;" for fontification later on.
7384 (when (and new-style-auto
7385 (looking-at c-haskell-op-re))
7387 (goto-char (match-end 0))
7388 (c-forward-syntactic-ws)
7389 (setq type-start (point))
7390 (setq at-type (c-forward-type))))
7394 (catch 'at-decl-or-cast
7397 (when (> paren-depth 0)
7398 ;; Encountered something inside parens that isn't matched by
7399 ;; the `c-type-decl-*' regexps, so it's not a type decl
7400 ;; expression. Try to skip out to the same paren depth to
7401 ;; not confuse the cast check below.
7402 (c-safe (goto-char (scan-lists (point) 1 paren-depth)))
7403 ;; If we've found a specifier keyword then it's a
7404 ;; declaration regardless.
7405 (throw 'at-decl-or-cast (eq at-decl-or-cast t)))
7408 (looking-at (cond ((eq context '<>) "[,>]")
7412 ;; Now we've collected info about various characteristics of
7413 ;; the construct we're looking at. Below follows a decision
7414 ;; tree based on that. It's ordered to check more certain
7415 ;; signs before less certain ones.
7421 (when (and (or at-type maybe-typeless)
7422 (not (or got-prefix got-parens)))
7423 ;; Got another identifier directly after the type, so it's a
7425 (throw 'at-decl-or-cast t))
7427 (when (and got-parens
7429 ;; (not got-suffix-after-parens)
7432 backup-maybe-typeless
7433 (eq at-decl-or-cast t)
7435 (goto-char name-start)
7436 (not (memq (c-forward-type) '(nil maybe))))))
7437 ;; Got a declaration of the form "foo bar (gnu);" or "bar
7438 ;; (gnu);" where we've recognized "bar" as the type and "gnu"
7439 ;; as the declarator. In this case it's however more likely
7440 ;; that "bar" is the declarator and "gnu" a function argument
7441 ;; or initializer (if `c-recognize-paren-inits' is set),
7442 ;; since the parens around "gnu" would be superfluous if it's
7443 ;; a declarator. Shift the type one step backward.
7444 (c-fdoc-shift-type-backward)))
7446 ;; Found no identifier.
7452 (when (= (point) start)
7453 ;; Got a plain list of identifiers. If a colon follows it's
7454 ;; a valid label, or maybe a bitfield. Otherwise the last
7455 ;; one probably is the declared identifier and we should
7456 ;; back up to the previous type, providing it isn't a cast.
7457 (if (and (eq (char-after) ?:)
7458 (not (c-major-mode-is 'java-mode)))
7460 ;; If we've found a specifier keyword then it's a
7461 ;; declaration regardless.
7462 ((eq at-decl-or-cast t)
7463 (throw 'at-decl-or-cast t))
7464 ((and c-has-bitfields
7465 (eq at-decl-or-cast 'ids)) ; bitfield.
7466 (setq backup-if-not-cast t)
7467 (throw 'at-decl-or-cast t)))
7469 (setq backup-if-not-cast t)
7470 (throw 'at-decl-or-cast t)))
7473 (when (and got-suffix
7476 ;; Got a plain list of identifiers followed by some suffix.
7477 ;; If this isn't a cast then the last identifier probably is
7478 ;; the declared one and we should back up to the previous
7480 (setq backup-if-not-cast t)
7481 (throw 'at-decl-or-cast t)))
7484 (when (eq at-type t)
7485 ;; If the type is known we know that there can't be any
7486 ;; identifier somewhere else, and it's only in declarations in
7487 ;; e.g. function prototypes and in casts that the identifier may
7489 (throw 'at-decl-or-cast t))
7491 (when (= (point) start)
7492 ;; Only got a single identifier (parsed as a type so far).
7495 ;; Check that the identifier isn't at the start of an
7500 ;; Inside an arglist that contains declarations. If K&R
7501 ;; style declarations and parenthesis style initializers
7502 ;; aren't allowed then the single identifier must be a
7503 ;; type, else we require that it's known or found
7504 ;; (primitive types are handled above).
7505 (or (and (not c-recognize-knr-p)
7506 (not c-recognize-paren-inits))
7507 (memq at-type '(known found))))
7509 ;; Inside a template arglist. Accept known and found
7510 ;; types; other identifiers could just as well be
7511 ;; constants in C++.
7512 (memq at-type '(known found)))))
7513 (throw 'at-decl-or-cast t)
7515 ;; Can't be a valid declaration or cast, but if we've found a
7516 ;; specifier it can't be anything else either, so treat it as
7517 ;; an invalid/unfinished declaration or cast.
7518 (throw 'at-decl-or-cast at-decl-or-cast))))
7523 (not (eq at-type t))
7526 backup-maybe-typeless
7527 (when c-recognize-typeless-decls
7528 (or (not got-suffix)
7530 c-after-suffixed-type-maybe-decl-key))))))
7531 ;; Got an empty paren pair and a preceding type that probably
7532 ;; really is the identifier. Shift the type backwards to make
7533 ;; the last one the identifier. This is analogous to the
7534 ;; "backtracking" done inside the `c-type-decl-suffix-key' loop
7537 ;; Exception: In addition to the conditions in that
7538 ;; "backtracking" code, do not shift backward if we're not
7539 ;; looking at either `c-after-suffixed-type-decl-key' or "[;,]".
7540 ;; Since there's no preceding type, the shift would mean that
7541 ;; the declaration is typeless. But if the regexp doesn't match
7542 ;; then we will simply fall through in the tests below and not
7543 ;; recognize it at all, so it's better to try it as an abstract
7544 ;; declarator instead.
7545 (c-fdoc-shift-type-backward)
7547 ;; Still no identifier.
7549 (when (and got-prefix (or got-parens got-suffix))
7550 ;; Require `got-prefix' together with either `got-parens' or
7551 ;; `got-suffix' to recognize it as an abstract declarator:
7552 ;; `got-parens' only is probably an empty function call.
7553 ;; `got-suffix' only can build an ordinary expression together
7554 ;; with the preceding identifier which we've taken as a type.
7555 ;; We could actually accept on `got-prefix' only, but that can
7556 ;; easily occur temporarily while writing an expression so we
7557 ;; avoid that case anyway. We could do a better job if we knew
7558 ;; the point when the fontification was invoked.
7559 (throw 'at-decl-or-cast t))
7565 got-suffix-after-parens
7566 (eq (char-after got-suffix-after-parens) ?\())
7567 ;; Got a type, no declarator but a paren suffix. I.e. it's a
7568 ;; normal function call after all (or perhaps a C++ style object
7569 ;; instantiation expression).
7570 (throw 'at-decl-or-cast nil))))
7573 (when at-decl-or-cast
7574 ;; By now we've located the type in the declaration that we know
7576 (throw 'at-decl-or-cast t))
7579 (when (and got-identifier
7581 (looking-at c-after-suffixed-type-decl-key)
7585 (not (eq at-type t)))
7586 ;; Shift the type backward in the case that there's a
7587 ;; single identifier inside parens. That can only
7588 ;; occur in K&R style function declarations so it's
7589 ;; more likely that it really is a function call.
7590 ;; Therefore we only do this after
7591 ;; `c-after-suffixed-type-decl-key' has matched.
7592 (progn (c-fdoc-shift-type-backward) t)
7593 got-suffix-after-parens))
7594 ;; A declaration according to `c-after-suffixed-type-decl-key'.
7595 (throw 'at-decl-or-cast t))
7598 (when (and (or got-prefix (not got-parens))
7599 (memq at-type '(t known)))
7600 ;; It's a declaration if a known type precedes it and it can't be a
7602 (throw 'at-decl-or-cast t))
7604 ;; If we get here we can't tell if this is a type decl or a normal
7605 ;; expression by looking at it alone. (That's under the assumption
7606 ;; that normal expressions always can look like type decl expressions,
7607 ;; which isn't really true but the cases where it doesn't hold are so
7608 ;; uncommon (e.g. some placements of "const" in C++) it's not worth
7609 ;; the effort to look for them.)
7611 ;;; 2008-04-16: commented out the next form, to allow the function to recognize
7612 ;;; "foo (int bar)" in CC (an implicit type (in class foo) without a semicolon)
7613 ;;; as a(n almost complete) declaration, enabling it to be fontified.
7615 ;; (unless (or at-decl-end (looking-at "=[^=]"))
7616 ;; If this is a declaration it should end here or its initializer(*)
7617 ;; should start here, so check for allowed separation tokens. Note
7618 ;; that this rule doesn't work e.g. with a K&R arglist after a
7621 ;; *) Don't check for C++ style initializers using parens
7622 ;; since those already have been matched as suffixes.
7624 ;; If `at-decl-or-cast' is then we've found some other sign that
7625 ;; it's a declaration or cast, so then it's probably an
7626 ;; invalid/unfinished one.
7627 ;; (throw 'at-decl-or-cast at-decl-or-cast))
7629 ;; Below are tests that only should be applied when we're certain to
7630 ;; not have parsed halfway through an expression.
7633 (when (memq at-type '(t known))
7634 ;; The expression starts with a known type so treat it as a
7636 (throw 'at-decl-or-cast t))
7639 (when (and (c-major-mode-is 'c++-mode)
7640 ;; In C++ we check if the identifier is a known type, since
7641 ;; (con|de)structors use the class name as identifier.
7642 ;; We've always shifted over the identifier as a type and
7643 ;; then backed up again in this case.
7645 (or (memq identifier-type '(found known))
7646 (and (eq (char-after identifier-start) ?~)
7647 ;; `at-type' probably won't be 'found for
7648 ;; destructors since the "~" is then part of the
7649 ;; type name being checked against the list of
7650 ;; known types, so do a check without that
7653 (goto-char (1+ identifier-start))
7654 (c-forward-syntactic-ws)
7655 (c-with-syntax-table
7656 c-identifier-syntax-table
7657 (looking-at c-known-type-key)))
7659 (goto-char (1+ identifier-start))
7660 ;; We have already parsed the type earlier,
7661 ;; so it'd be possible to cache the end
7662 ;; position instead of redoing it here, but
7663 ;; then we'd need to keep track of another
7664 ;; position everywhere.
7665 (c-check-type (point)
7666 (progn (c-forward-type)
7668 (throw 'at-decl-or-cast t))
7673 (when (and got-prefix-before-parens
7675 (or at-decl-end (looking-at "=[^=]"))
7678 ;; Got something like "foo * bar;". Since we're not inside an
7679 ;; arglist it would be a meaningless expression because the
7680 ;; result isn't used. We therefore choose to recognize it as
7681 ;; a declaration. Do not allow a suffix since it could then
7682 ;; be a function call.
7683 (throw 'at-decl-or-cast t))
7686 (when (and (or got-suffix-after-parens
7687 (looking-at "=[^=]"))
7689 (not (eq context 'arglist)))
7690 ;; Got something like "a (*b) (c);" or "a (b) = c;". It could
7691 ;; be an odd expression or it could be a declaration. Treat
7692 ;; it as a declaration if "a" has been used as a type
7693 ;; somewhere else (if it's a known type we won't get here).
7694 (throw 'at-decl-or-cast t)))
7699 (and (eq context 'decl)
7700 (not c-recognize-paren-inits)
7701 (or got-parens got-suffix))))
7702 ;; Got a type followed by an abstract declarator. If `got-prefix'
7703 ;; is set it's something like "a *" without anything after it. If
7704 ;; `got-parens' or `got-suffix' is set it's "a()", "a[]", "a()[]",
7705 ;; or similar, which we accept only if the context rules out
7707 (throw 'at-decl-or-cast t)))
7709 ;; If we had a complete symbol table here (which rules out
7710 ;; `c-found-types') we should return t due to the disambiguation rule
7711 ;; (in at least C++) that anything that can be parsed as a declaration
7712 ;; is a declaration. Now we're being more defensive and prefer to
7713 ;; highlight things like "foo (bar);" as a declaration only if we're
7714 ;; inside an arglist that contains declarations.
7716 (eq context 'decl))))
7718 ;; The point is now after the type decl expression.
7721 ;; Check for a cast.
7726 ;; Should be the first type/identifier in a cast paren.
7727 (> preceding-token-end (point-min))
7728 (memq (char-before preceding-token-end) c-cast-parens)
7730 ;; The closing paren should follow.
7732 (c-forward-syntactic-ws)
7733 (looking-at "\\s)"))
7735 ;; There should be a primary expression after it.
7738 (c-forward-syntactic-ws)
7739 (setq cast-end (point))
7740 (and (looking-at c-primary-expr-regexp)
7742 (setq pos (match-end 0))
7744 ;; Check if the expression begins with a prefix keyword.
7746 (if (match-beginning 1)
7747 ;; Expression begins with an ambiguous operator. Treat
7748 ;; it as a cast if it's a type decl or if we've
7749 ;; recognized the type somewhere else.
7751 (memq at-type '(t known found)))
7752 ;; Unless it's a keyword, it's the beginning of a primary
7754 (not (looking-at c-keywords-regexp)))))
7755 ;; If `c-primary-expr-regexp' matched a nonsymbol token, check
7756 ;; that it matched a whole one so that we don't e.g. confuse
7757 ;; the operator '-' with '->'. It's ok if it matches further,
7758 ;; though, since it e.g. can match the float '.5' while the
7759 ;; operator regexp only matches '.'.
7760 (or (not (looking-at c-nonsymbol-token-regexp))
7761 (<= (match-end 0) pos))))
7763 ;; There should either be a cast before it or something that isn't an
7764 ;; identifier or close paren.
7765 (> preceding-token-end (point-min))
7767 (goto-char (1- preceding-token-end))
7768 (or (eq (point) last-cast-end)
7770 (c-backward-syntactic-ws)
7771 (if (< (skip-syntax-backward "w_") 0)
7772 ;; It's a symbol. Accept it only if it's one of the
7773 ;; keywords that can precede an expression (without
7774 ;; surrounding parens).
7775 (looking-at c-simple-stmt-key)
7777 ;; Check that it isn't a close paren (block close is ok,
7779 (not (memq (char-before) '(?\) ?\])))
7780 ;; Check that it isn't a nonsymbol identifier.
7781 (not (c-on-identifier)))))))))
7784 (when (and c-record-type-identifiers at-type (not (eq at-type t)))
7785 (let ((c-promote-possible-types t))
7786 (goto-char type-start)
7789 (goto-char cast-end)
7793 ;; We're at a declaration. Highlight the type and the following
7796 (when backup-if-not-cast
7797 (c-fdoc-shift-type-backward t))
7799 (when (and (eq context 'decl) (looking-at ","))
7800 ;; Make sure to propagate the `c-decl-arg-start' property to
7801 ;; the next argument if it's set in this one, to cope with
7802 ;; interactive refontification.
7803 (c-put-c-type-property (point) 'c-decl-arg-start))
7805 ;; Record the type's coordinates in `c-record-type-identifiers' for
7806 ;; later fontification.
7807 (when (and c-record-type-identifiers at-type ;; (not (eq at-type t))
7808 ;; There seems no reason to exclude a token from
7809 ;; fontification just because it's "a known type that can't
7810 ;; be a name or other expression". 2013-09-18.
7812 (let ((c-promote-possible-types t))
7814 (goto-char type-start)
7818 (and (or at-type-decl at-typedef)
7819 (cons at-type-decl at-typedef))))
7822 ;; False alarm. Restore the recorded ranges.
7823 (setq c-record-type-identifiers save-rec-type-ids
7824 c-record-ref-identifiers save-rec-ref-ids)
7827 (defun c-forward-label (&optional assume-markup preceding-token-end limit)
7828 ;; Assuming that point is at the beginning of a token, check if it starts a
7829 ;; label and if so move over it and return non-nil (t in default situations,
7830 ;; specific symbols (see below) for interesting situations), otherwise don't
7831 ;; move and return nil. "Label" here means "most things with a colon".
7833 ;; More precisely, a "label" is regarded as one of:
7834 ;; (i) a goto target like "foo:" - returns the symbol `goto-target';
7835 ;; (ii) A case label - either the entire construct "case FOO:", or just the
7836 ;; bare "case", should the colon be missing. We return t;
7837 ;; (iii) a keyword which needs a colon, like "default:" or "private:"; We
7839 ;; (iv) One of QT's "extended" C++ variants of
7840 ;; "private:"/"protected:"/"public:"/"more:" looking like "public slots:".
7841 ;; Returns the symbol `qt-2kwds-colon'.
7842 ;; (v) QT's construct "signals:". Returns the symbol `qt-1kwd-colon'.
7843 ;; (vi) One of the keywords matched by `c-opt-extra-label-key' (without any
7844 ;; colon). Currently (2006-03), this applies only to Objective C's
7845 ;; keywords "@private", "@protected", and "@public". Returns t.
7847 ;; One of the things which will NOT be recognized as a label is a bit-field
7848 ;; element of a struct, something like "int foo:5".
7850 ;; The end of the label is taken to be just after the colon, or the end of
7851 ;; the first submatch in `c-opt-extra-label-key'. The point is directly
7852 ;; after the end on return. The terminating char gets marked with
7853 ;; `c-decl-end' to improve recognition of the following declaration or
7856 ;; If ASSUME-MARKUP is non-nil, it's assumed that the preceding
7857 ;; label, if any, has already been marked up like that.
7859 ;; If PRECEDING-TOKEN-END is given, it should be the first position
7860 ;; after the preceding token, i.e. on the other side of the
7861 ;; syntactic ws from the point. Use a value less than or equal to
7862 ;; (point-min) if the point is at the first token in (the visible
7863 ;; part of) the buffer.
7865 ;; The optional LIMIT limits the forward scan for the colon.
7867 ;; This function records the ranges of the label symbols on
7868 ;; `c-record-ref-identifiers' if `c-record-type-identifiers' (!) is
7871 ;; This function might do hidden buffer changes.
7873 (let ((start (point))
7876 macro-start ; if we're in one.
7880 ;; "case" or "default" (Doesn't apply to AWK).
7881 ((looking-at c-label-kwds-regexp)
7882 (let ((kwd-end (match-end 1)))
7883 ;; Record only the keyword itself for fontification, since in
7884 ;; case labels the following is a constant expression and not
7886 (when c-record-type-identifiers
7887 (c-record-ref-id (cons (match-beginning 1) kwd-end)))
7889 ;; Find the label end.
7892 (if (and (c-syntactic-re-search-forward
7893 ;; Stop on chars that aren't allowed in expressions,
7894 ;; and on operator chars that would be meaningless
7895 ;; there. FIXME: This doesn't cope with ?: operators.
7896 "[;{=,@]\\|\\(\\=\\|[^:]\\):\\([^:]\\|\\'\\)"
7898 (match-beginning 2))
7900 (progn ; there's a proper :
7901 (goto-char (match-beginning 2)) ; just after the :
7902 (c-put-c-type-property (1- (point)) 'c-decl-end)
7905 ;; It's an unfinished label. We consider the keyword enough
7906 ;; to recognize it as a label, so that it gets fontified.
7907 ;; Leave the point at the end of it, but don't put any
7908 ;; `c-decl-end' marker.
7912 ;; @private, @protected, @public, in Objective C, or similar.
7913 ((and c-opt-extra-label-key
7914 (looking-at c-opt-extra-label-key))
7915 ;; For a `c-opt-extra-label-key' match, we record the whole
7916 ;; thing for fontification. That's to get the leading '@' in
7917 ;; Objective-C protection labels fontified.
7918 (goto-char (match-end 1))
7919 (when c-record-type-identifiers
7920 (c-record-ref-id (cons (match-beginning 1) (point))))
7921 (c-put-c-type-property (1- (point)) 'c-decl-end)
7922 (setq label-type t))
7924 ;; All other cases of labels.
7925 ((and c-recognize-colon-labels ; nil for AWK and IDL, otherwise t.
7927 ;; A colon label must have something before the colon.
7928 (not (eq (char-after) ?:))
7930 ;; Check that we're not after a token that can't precede a label.
7932 ;; Trivially succeeds when there's no preceding token.
7933 ;; Succeeds when we're at a virtual semicolon.
7934 (if preceding-token-end
7935 (<= preceding-token-end (point-min))
7937 (c-backward-syntactic-ws)
7938 (setq preceding-token-end (point))
7942 ;; Check if we're after a label, if we're after a closing
7943 ;; paren that belong to statement, and with
7944 ;; `c-label-prefix-re'. It's done in different order
7945 ;; depending on `assume-markup' since the checks have
7946 ;; different expensiveness.
7949 (eq (c-get-char-property (1- preceding-token-end) 'c-type)
7953 (goto-char (1- preceding-token-end))
7954 (c-beginning-of-current-token)
7955 (or (looking-at c-label-prefix-re)
7956 (looking-at c-block-stmt-1-key)))
7958 (and (eq (char-before preceding-token-end) ?\))
7959 (c-after-conditional)))
7963 (goto-char (1- preceding-token-end))
7964 (c-beginning-of-current-token)
7965 (or (looking-at c-label-prefix-re)
7966 (looking-at c-block-stmt-1-key)))
7969 ((eq (char-before preceding-token-end) ?\))
7970 (c-after-conditional))
7972 ((eq (char-before preceding-token-end) ?:)
7973 ;; Might be after another label, so check it recursively.
7976 (goto-char (1- preceding-token-end))
7977 ;; Essentially the same as the
7978 ;; `c-syntactic-re-search-forward' regexp below.
7980 (save-excursion (and (c-beginning-of-macro)
7982 (if macro-start (narrow-to-region macro-start (point-max)))
7983 (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+" nil t)
7984 ;; Note: the following should work instead of the
7985 ;; narrow-to-region above. Investigate why not,
7986 ;; sometime. ACM, 2006-03-31.
7987 ;; (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+"
7990 ;; If the caller turned on recording for us,
7991 ;; it shouldn't apply when we check the
7993 c-record-type-identifiers)
7994 ;; A label can't start at a cpp directive. Check for
7995 ;; this, since c-forward-syntactic-ws would foul up on it.
7996 (unless (and c-opt-cpp-prefix (looking-at c-opt-cpp-prefix))
7997 (c-forward-syntactic-ws)
7998 (c-forward-label nil pte start))))))))))
8000 ;; Point is still at the beginning of the possible label construct.
8002 ;; Check that the next nonsymbol token is ":", or that we're in one
8003 ;; of QT's "slots" declarations. Allow '(' for the sake of macro
8004 ;; arguments. FIXME: Should build this regexp from the language
8007 ;; public: protected: private:
8009 (c-major-mode-is 'c++-mode)
8010 (search-forward-regexp
8011 "\\=p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\>[^_]" nil t)
8012 (progn (backward-char)
8013 (c-forward-syntactic-ws limit)
8014 (looking-at ":\\([^:]\\|\\'\\)"))) ; A single colon.
8016 (setq label-type t))
8017 ;; QT double keyword like "protected slots:" or goto target.
8018 ((progn (goto-char start) nil))
8019 ((when (c-syntactic-re-search-forward
8020 "[ \t\n[:?;{=*/%&|,<>!@+-]" limit t t) ; not at EOB
8022 (setq label-end (point))
8024 (and (c-major-mode-is 'c++-mode)
8026 "\\(p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\|more\\)\\>"
8027 (buffer-substring start (point)))))
8028 (c-forward-syntactic-ws limit)
8030 ((looking-at ":\\([^:]\\|\\'\\)") ; A single colon.
8033 (if (or (string= "signals" ; Special QT macro
8034 (setq kwd (buffer-substring-no-properties start label-end)))
8035 (string= "Q_SIGNALS" kwd))
8039 (search-forward-regexp "\\=\\(slots\\|Q_SLOTS\\)\\>" limit t)
8040 (progn (c-forward-syntactic-ws limit)
8041 (looking-at ":\\([^:]\\|\\'\\)"))) ; A single colon
8043 (setq label-type 'qt-2kwds-colon)))))))
8046 (narrow-to-region start (point))
8048 ;; Check that `c-nonlabel-token-key' doesn't match anywhere.
8052 (when (looking-at c-nonlabel-token-key)
8054 (setq label-type nil)
8055 (throw 'check-label nil))
8056 (and (c-safe (c-forward-sexp)
8057 (c-forward-syntactic-ws)
8061 ;; Record the identifiers in the label for fontification, unless
8062 ;; it begins with `c-label-kwds' in which case the following
8063 ;; identifiers are part of a (constant) expression that
8064 ;; shouldn't be fontified.
8065 (when (and c-record-type-identifiers
8066 (progn (goto-char start)
8067 (not (looking-at c-label-kwds-regexp))))
8068 (while (c-syntactic-re-search-forward c-symbol-key nil t)
8069 (c-record-ref-id (cons (match-beginning 0)
8072 (c-put-c-type-property (1- (point-max)) 'c-decl-end)
8073 (goto-char (point-max)))))
8080 (defun c-forward-objc-directive ()
8081 ;; Assuming the point is at the beginning of a token, try to move
8082 ;; forward to the end of the Objective-C directive that starts
8083 ;; there. Return t if a directive was fully recognized, otherwise
8084 ;; the point is moved as far as one could be successfully parsed and
8087 ;; This function records identifier ranges on
8088 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
8089 ;; `c-record-type-identifiers' is non-nil.
8091 ;; This function might do hidden buffer changes.
8093 (let ((start (point))
8095 (c-promote-possible-types t)
8097 ;; Turn off recognition of angle bracket arglists while parsing
8098 ;; types here since the protocol reference list might then be
8099 ;; considered part of the preceding name or superclass-name.
8100 c-recognize-<>-arglists)
8105 (c-make-keywords-re t
8106 (append (c-lang-const c-protection-kwds objc)
8109 (goto-char (match-end 1))
8115 (c-make-keywords-re t
8116 '("@interface" "@implementation" "@protocol")
8119 ;; Handle the name of the class itself.
8121 ;; (c-forward-token-2) ; 2006/1/13 This doesn't move if the token's
8123 (goto-char (match-end 0))
8129 ;; Look for ": superclass-name" or "( category-name )".
8130 (when (looking-at "[:(]")
8131 (setq start-char (char-after))
8133 (c-forward-syntactic-ws)
8134 (unless (c-forward-type) (throw 'break nil))
8135 (when (eq start-char ?\()
8136 (unless (eq (char-after) ?\)) (throw 'break nil))
8138 (c-forward-syntactic-ws)))
8140 ;; Look for a protocol reference list.
8141 (if (eq (char-after) ?<)
8142 (let ((c-recognize-<>-arglists t)
8143 (c-parse-and-markup-<>-arglists t)
8144 c-restricted-<>-arglists)
8145 (c-forward-<>-arglist t))
8149 (c-backward-syntactic-ws lim)
8150 (c-clear-c-type-property start (1- (point)) 'c-decl-end)
8151 (c-put-c-type-property (1- (point)) 'c-decl-end)
8154 (c-clear-c-type-property start (point) 'c-decl-end)
8157 (defun c-beginning-of-inheritance-list (&optional lim)
8158 ;; Go to the first non-whitespace after the colon that starts a
8159 ;; multiple inheritance introduction. Optional LIM is the farthest
8160 ;; back we should search.
8162 ;; This function might do hidden buffer changes.
8163 (c-with-syntax-table c++-template-syntax-table
8164 (c-backward-token-2 0 t lim)
8165 (while (and (or (looking-at c-symbol-start)
8166 (looking-at "[<,]\\|::"))
8167 (zerop (c-backward-token-2 1 t lim))))))
8169 (defun c-in-method-def-p ()
8170 ;; Return nil if we aren't in a method definition, otherwise the
8171 ;; position of the initial [+-].
8173 ;; This function might do hidden buffer changes.
8176 (and c-opt-method-key
8177 (looking-at c-opt-method-key)
8181 ;; Contributed by Kevin Ryde <user42@zip.com.au>.
8182 (defun c-in-gcc-asm-p ()
8183 ;; Return non-nil if point is within a gcc \"asm\" block.
8185 ;; This should be called with point inside an argument list.
8187 ;; Only one level of enclosing parentheses is considered, so for
8188 ;; instance nil is returned when in a function call within an asm
8191 ;; This function might do hidden buffer changes.
8193 (and c-opt-asm-stmt-key
8196 (backward-up-list 1)
8197 (c-beginning-of-statement-1 (point-min) nil t)
8198 (looking-at c-opt-asm-stmt-key))))
8200 (defun c-at-toplevel-p ()
8201 "Return a determination as to whether point is \"at the top level\".
8202 Informally, \"at the top level\" is anywhere where you can write
8205 More precisely, being at the top-level means that point is either
8206 outside any enclosing block (such as a function definition), or
8207 directly inside a class, namespace or other block that contains
8208 another declaration level.
8210 If point is not at the top-level (e.g. it is inside a method
8211 definition), then nil is returned. Otherwise, if point is at a
8212 top-level not enclosed within a class definition, t is returned.
8213 Otherwise, a 2-vector is returned where the zeroth element is the
8214 buffer position of the start of the class declaration, and the first
8215 element is the buffer position of the enclosing class's opening
8218 Note that this function might do hidden buffer changes. See the
8219 comment at the start of cc-engine.el for more info."
8220 ;; Note to maintainers: this function consumes a great mass of CPU cycles.
8221 ;; Its use should thus be minimized as far as possible.
8222 (let ((paren-state (c-parse-state)))
8223 (or (not (c-most-enclosing-brace paren-state))
8224 (c-search-uplist-for-classkey paren-state))))
8226 (defun c-just-after-func-arglist-p (&optional lim)
8227 ;; Return non-nil if the point is in the region after the argument
8228 ;; list of a function and its opening brace (or semicolon in case it
8229 ;; got no body). If there are K&R style argument declarations in
8230 ;; that region, the point has to be inside the first one for this
8231 ;; function to recognize it.
8233 ;; If successful, the point is moved to the first token after the
8234 ;; function header (see `c-forward-decl-or-cast-1' for details) and
8235 ;; the position of the opening paren of the function arglist is
8238 ;; The point is clobbered if not successful.
8240 ;; LIM is used as bound for backward buffer searches.
8242 ;; This function might do hidden buffer changes.
8244 (let ((beg (point)) id-start)
8246 (eq (c-beginning-of-statement-1 lim) 'same)
8248 (not (and (c-major-mode-is 'objc-mode)
8249 (c-forward-objc-directive)))
8252 (car-safe (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil)))
8255 ;; There should not be a '=' or ',' between beg and the
8256 ;; start of the declaration since that means we were in the
8257 ;; "expression part" of the declaration.
8259 (not (looking-at "[=,]")))
8262 ;; Check that there's an arglist paren in the
8264 (goto-char id-start)
8265 (cond ((eq (char-after) ?\()
8266 ;; The declarator is a paren expression, so skip past it
8267 ;; so that we don't get stuck on that instead of the
8268 ;; function arglist.
8270 ((and c-opt-op-identifier-prefix
8271 (looking-at c-opt-op-identifier-prefix))
8272 ;; Don't trip up on "operator ()".
8273 (c-forward-token-2 2 t)))
8274 (and (< (point) beg)
8275 (c-syntactic-re-search-forward "(" beg t t)
8278 (defun c-in-knr-argdecl (&optional lim)
8279 ;; Return the position of the first argument declaration if point is
8280 ;; inside a K&R style argument declaration list, nil otherwise.
8281 ;; `c-recognize-knr-p' is not checked. If LIM is non-nil, it's a
8282 ;; position that bounds the backward search for the argument list. This
8283 ;; function doesn't move point.
8285 ;; Point must be within a possible K&R region, e.g. just before a top-level
8286 ;; "{". It must be outside of parens and brackets. The test can return
8287 ;; false positives otherwise.
8289 ;; This function might do hidden buffer changes.
8292 ;; If we're in a macro, our search range is restricted to it. Narrow to
8293 ;; the searchable range.
8294 (let* ((macro-start (save-excursion (and (c-beginning-of-macro) (point))))
8295 (macro-end (save-excursion (and macro-start (c-end-of-macro) (point))))
8296 (low-lim (max (or lim (point-min)) (or macro-start (point-min))))
8297 before-lparen after-rparen
8299 (pp-count-out 20) ; Max number of paren/brace constructs before
8301 ids ; List of identifiers in the parenthesized list.
8302 id-start after-prec-token decl-or-cast decl-res
8303 c-last-identifier-range identifier-ok)
8304 (narrow-to-region low-lim (or macro-end (point-max)))
8306 ;; Search backwards for the defun's argument list. We give up if we
8307 ;; encounter a "}" (end of a previous defun) an "=" (which can't be in
8308 ;; a knr region) or BOB.
8310 ;; The criterion for a paren structure being the arg list is:
8311 ;; o - there is non-WS stuff after it but before any "{"; AND
8312 ;; o - the token after it isn't a ";" AND
8313 ;; o - it is preceded by either an identifier (the function name) or
8314 ;; a macro expansion like "DEFUN (...)"; AND
8315 ;; o - its content is a non-empty comma-separated list of identifiers
8316 ;; (an empty arg list won't have a knr region).
8318 ;; The following snippet illustrates these rules:
8319 ;; int foo (bar, baz, yuk)
8321 ;; int (*baz) (my_type) ;
8322 ;; int (*(* yuk) (void)) (void) ;
8325 ;; Additionally, for a knr list to be recognized:
8326 ;; o - The identifier of each declarator up to and including the
8327 ;; one "near" point must be contained in the arg list.
8330 (while (> pp-count-out 0) ; go back one paren/bracket pair each time.
8331 (setq pp-count-out (1- pp-count-out))
8332 (c-syntactic-skip-backward "^)]}=")
8333 (cond ((eq (char-before) ?\))
8334 (setq after-rparen (point)))
8335 ((eq (char-before) ?\])
8336 (setq after-rparen nil))
8337 (t ; either } (hit previous defun) or = or no more
8342 ;; We're inside a paren. Could it be our argument list....?
8346 (goto-char after-rparen)
8347 (unless (c-go-list-backward) (throw 'knr nil)) ;
8348 ;; FIXME!!! What about macros between the parens? 2007/01/20
8349 (setq before-lparen (point)))
8351 ;; It can't be the arg list if next token is ; or {
8352 (progn (goto-char after-rparen)
8353 (c-forward-syntactic-ws)
8354 (not (memq (char-after) '(?\; ?\{ ?\=))))
8356 ;; Is the thing preceding the list an identifier (the
8357 ;; function name), or a macro expansion?
8359 (goto-char before-lparen)
8360 (eq (c-backward-token-2) 0)
8361 (or (eq (c-on-identifier) (point))
8362 (and (eq (char-after) ?\))
8363 (c-go-up-list-backward)
8364 (eq (c-backward-token-2) 0)
8365 (eq (c-on-identifier) (point)))))
8367 ;; Have we got a non-empty list of comma-separated
8370 (goto-char before-lparen)
8371 (c-forward-token-2) ; to first token inside parens
8373 (setq id-start (c-on-identifier)) ; Must be at least one.
8378 (c-end-of-current-token)
8379 (push (buffer-substring-no-properties id-start
8382 (c-forward-syntactic-ws)
8383 (eq (char-after) ?\,))
8385 (unless (setq id-start (c-on-identifier))
8386 (throw 'id-list nil)))
8387 (eq (char-after) ?\)))))
8389 ;; Are all the identifiers in the k&r list up to the
8390 ;; current one also in the argument list?
8392 (forward-char) ; over the )
8393 (setq after-prec-token after-rparen)
8394 (c-forward-syntactic-ws)
8396 (or (consp (setq decl-or-cast
8397 (c-forward-decl-or-cast-1
8399 nil ; Or 'arglist ???
8402 (goto-char after-prec-token)
8403 (c-forward-syntactic-ws)
8404 (setq identifier-ok (eq (char-after) ?{))
8406 (eq (char-after) ?\;)
8407 (setq after-prec-token (1+ (point)))
8408 (goto-char (car decl-or-cast))
8409 (setq decl-res (c-forward-declarator))
8411 (member (buffer-substring-no-properties
8412 (car decl-res) (cadr decl-res))
8415 (goto-char after-prec-token)
8416 (prog1 (< (point) here)
8417 (c-forward-syntactic-ws))))
8418 (setq identifier-ok nil))
8420 ;; ...Yes. We've identified the function's argument list.
8422 (progn (goto-char after-rparen)
8423 (c-forward-syntactic-ws)
8425 ;; ...No. The current parens aren't the function's arg list.
8426 (goto-char before-lparen))
8428 (or (c-go-list-backward) ; backwards over [ .... ]
8429 (throw 'knr nil)))))))))
8431 (defun c-skip-conditional ()
8432 ;; skip forward over conditional at point, including any predicate
8433 ;; statements in parentheses. No error checking is performed.
8435 ;; This function might do hidden buffer changes.
8436 (c-forward-sexp (cond
8438 ((looking-at (concat "\\<else"
8439 "\\([ \t\n]\\|\\\\\n\\)+"
8440 "if\\>\\([^_]\\|$\\)"))
8442 ;; do, else, try, finally
8443 ((looking-at (concat "\\<\\("
8444 "do\\|else\\|try\\|finally"
8445 "\\)\\>\\([^_]\\|$\\)"))
8447 ;; for, if, while, switch, catch, synchronized, foreach
8450 (defun c-after-conditional (&optional lim)
8451 ;; If looking at the token after a conditional then return the
8452 ;; position of its start, otherwise return nil.
8454 ;; This function might do hidden buffer changes.
8456 (and (zerop (c-backward-token-2 1 t lim))
8457 (or (looking-at c-block-stmt-1-key)
8458 (and (eq (char-after) ?\()
8459 (zerop (c-backward-token-2 1 t lim))
8460 (or (looking-at c-block-stmt-2-key)
8461 (looking-at c-block-stmt-1-2-key))))
8464 (defun c-after-special-operator-id (&optional lim)
8465 ;; If the point is after an operator identifier that isn't handled
8466 ;; like an ordinary symbol (i.e. like "operator =" in C++) then the
8467 ;; position of the start of that identifier is returned. nil is
8468 ;; returned otherwise. The point may be anywhere in the syntactic
8469 ;; whitespace after the last token of the operator identifier.
8471 ;; This function might do hidden buffer changes.
8473 (and c-overloadable-operators-regexp
8474 (zerop (c-backward-token-2 1 nil lim))
8475 (looking-at c-overloadable-operators-regexp)
8476 (or (not c-opt-op-identifier-prefix)
8478 (zerop (c-backward-token-2 1 nil lim))
8479 (looking-at c-opt-op-identifier-prefix)))
8482 (defsubst c-backward-to-block-anchor (&optional lim)
8483 ;; Assuming point is at a brace that opens a statement block of some
8484 ;; kind, move to the proper anchor point for that block. It might
8485 ;; need to be adjusted further by c-add-stmt-syntax, but the
8486 ;; position at return is suitable as start position for that
8489 ;; This function might do hidden buffer changes.
8490 (unless (= (point) (c-point 'boi))
8491 (let ((start (c-after-conditional lim)))
8493 (goto-char start)))))
8495 (defsubst c-backward-to-decl-anchor (&optional lim)
8496 ;; Assuming point is at a brace that opens the block of a top level
8497 ;; declaration of some kind, move to the proper anchor point for
8500 ;; This function might do hidden buffer changes.
8501 (unless (= (point) (c-point 'boi))
8502 (c-beginning-of-statement-1 lim)))
8504 (defun c-search-decl-header-end ()
8505 ;; Search forward for the end of the "header" of the current
8506 ;; declaration. That's the position where the definition body
8507 ;; starts, or the first variable initializer, or the ending
8508 ;; semicolon. I.e. search forward for the closest following
8509 ;; (syntactically relevant) '{', '=' or ';' token. Point is left
8510 ;; _after_ the first found token, or at point-max if none is found.
8512 ;; This function might do hidden buffer changes.
8514 (let ((base (point)))
8515 (if (c-major-mode-is 'c++-mode)
8517 ;; In C++ we need to take special care to handle operator
8518 ;; tokens and those pesky template brackets.
8520 (c-syntactic-re-search-forward "[;{<=]" nil 'move t t)
8522 (c-end-of-current-token base)
8523 ;; Handle operator identifiers, i.e. ignore any
8524 ;; operator token preceded by "operator".
8526 (and (c-safe (c-backward-sexp) t)
8527 (looking-at c-opt-op-identifier-prefix)))
8528 (and (eq (char-before) ?<)
8529 (c-with-syntax-table c++-template-syntax-table
8530 (if (c-safe (goto-char (c-up-list-forward (point))))
8532 (goto-char (point-max))
8534 (setq base (point)))
8537 (c-syntactic-re-search-forward "[;{=]" nil 'move t t)
8538 (c-end-of-current-token base))
8539 (setq base (point))))))
8541 (defun c-beginning-of-decl-1 (&optional lim)
8542 ;; Go to the beginning of the current declaration, or the beginning
8543 ;; of the previous one if already at the start of it. Point won't
8544 ;; be moved out of any surrounding paren. Return a cons cell of the
8545 ;; form (MOVE . KNR-POS). MOVE is like the return value from
8546 ;; `c-beginning-of-statement-1'. If point skipped over some K&R
8547 ;; style argument declarations (and they are to be recognized) then
8548 ;; KNR-POS is set to the start of the first such argument
8549 ;; declaration, otherwise KNR-POS is nil. If LIM is non-nil, it's a
8550 ;; position that bounds the backward search.
8552 ;; NB: Cases where the declaration continues after the block, as in
8553 ;; "struct foo { ... } bar;", are currently recognized as two
8554 ;; declarations, e.g. "struct foo { ... }" and "bar;" in this case.
8556 ;; This function might do hidden buffer changes.
8558 (let* ((start (point))
8559 (last-stmt-start (point))
8560 (move (c-beginning-of-statement-1 lim nil t)))
8562 ;; `c-beginning-of-statement-1' stops at a block start, but we
8563 ;; want to continue if the block doesn't begin a top level
8564 ;; construct, i.e. if it isn't preceded by ';', '}', ':', bob,
8565 ;; or an open paren.
8566 (let ((beg (point)) tentative-move)
8567 ;; Go back one "statement" each time round the loop until we're just
8568 ;; after a ;, }, or :, or at BOB or the start of a macro or start of
8569 ;; an ObjC method. This will move over a multiple declaration whose
8570 ;; components are comma separated.
8572 ;; Must check with c-opt-method-key in ObjC mode.
8573 (not (and c-opt-method-key
8574 (looking-at c-opt-method-key)))
8575 (/= last-stmt-start (point))
8577 (c-backward-syntactic-ws lim)
8578 (not (memq (char-before) '(?\; ?} ?: nil))))
8581 (not (looking-at "\\s(")))
8582 ;; Check that we don't move from the first thing in a
8583 ;; macro to its header.
8584 (not (eq (setq tentative-move
8585 (c-beginning-of-statement-1 lim nil t))
8587 (setq last-stmt-start beg
8589 move tentative-move))
8592 (when c-recognize-knr-p
8593 (let ((fallback-pos (point)) knr-argdecl-start)
8594 ;; Handle K&R argdecls. Back up after the "statement" jumped
8595 ;; over by `c-beginning-of-statement-1', unless it was the
8596 ;; function body, in which case we're sitting on the opening
8597 ;; brace now. Then test if we're in a K&R argdecl region and
8598 ;; that we started at the other side of the first argdecl in
8600 (unless (eq (char-after) ?{)
8601 (goto-char last-stmt-start))
8602 (if (and (setq knr-argdecl-start (c-in-knr-argdecl lim))
8603 (< knr-argdecl-start start)
8605 (goto-char knr-argdecl-start)
8606 (not (eq (c-beginning-of-statement-1 lim nil t) 'macro))))
8608 (cons (if (eq (char-after fallback-pos) ?{)
8612 (goto-char fallback-pos))))
8614 ;; `c-beginning-of-statement-1' counts each brace block as a separate
8615 ;; statement, so the result will be 'previous if we've moved over any.
8616 ;; So change our result back to 'same if necessary.
8618 ;; If they were brace list initializers we might not have moved over a
8619 ;; declaration boundary though, so change it to 'same if we've moved
8620 ;; past a '=' before '{', but not ';'. (This ought to be integrated
8621 ;; into `c-beginning-of-statement-1', so we avoid this extra pass which
8622 ;; potentially can search over a large amount of text.). Take special
8623 ;; pains not to get mislead by C++'s "operator=", and the like.
8624 (if (and (eq move 'previous)
8625 (c-with-syntax-table (if (c-major-mode-is 'c++-mode)
8626 c++-template-syntax-table
8631 (while ; keep going back to "[;={"s until we either find
8632 ; no more, or get to one which isn't an "operator ="
8633 (and (c-syntactic-re-search-forward "[;={]" start t t t)
8634 (eq (char-before) ?=)
8635 c-overloadable-operators-regexp
8636 c-opt-op-identifier-prefix
8638 (eq (c-backward-token-2) 0)
8639 (looking-at c-overloadable-operators-regexp)
8640 (eq (c-backward-token-2) 0)
8641 (looking-at c-opt-op-identifier-prefix))))
8642 (eq (char-before) ?=))
8643 (c-syntactic-re-search-forward "[;{]" start t t)
8644 (eq (char-before) ?{)
8645 (c-safe (goto-char (c-up-list-forward (point))) t)
8646 (not (c-syntactic-re-search-forward ";" start t t))))))
8650 (defun c-end-of-decl-1 ()
8651 ;; Assuming point is at the start of a declaration (as detected by
8652 ;; e.g. `c-beginning-of-decl-1'), go to the end of it. Unlike
8653 ;; `c-beginning-of-decl-1', this function handles the case when a
8654 ;; block is followed by identifiers in e.g. struct declarations in C
8655 ;; or C++. If a proper end was found then t is returned, otherwise
8656 ;; point is moved as far as possible within the current sexp and nil
8657 ;; is returned. This function doesn't handle macros; use
8658 ;; `c-end-of-macro' instead in those cases.
8660 ;; This function might do hidden buffer changes.
8661 (let ((start (point))
8662 (decl-syntax-table (if (c-major-mode-is 'c++-mode)
8663 c++-template-syntax-table
8666 (c-search-decl-header-end)
8668 (when (and c-recognize-knr-p
8669 (eq (char-before) ?\;)
8670 (c-in-knr-argdecl start))
8671 ;; Stopped at the ';' in a K&R argdecl section which is
8672 ;; detected using the same criteria as in
8673 ;; `c-beginning-of-decl-1'. Move to the following block
8675 (c-syntactic-re-search-forward "{" nil 'move t))
8677 (when (eq (char-before) ?{)
8678 ;; Encountered a block in the declaration. Jump over it.
8680 (goto-char (c-up-list-forward (point)))
8681 (error (goto-char (point-max))
8682 (throw 'return nil)))
8683 (if (or (not c-opt-block-decls-with-vars-key)
8685 (c-with-syntax-table decl-syntax-table
8686 (let ((lim (point)))
8689 ;; Check for `c-opt-block-decls-with-vars-key'
8690 ;; before the first paren.
8691 (c-syntactic-re-search-forward
8692 (concat "[;=([{]\\|\\("
8693 c-opt-block-decls-with-vars-key
8697 (not (eq (char-before) ?_))
8698 ;; Check that the first following paren is
8700 (c-syntactic-re-search-forward "[;=([{]"
8702 (eq (char-before) ?{)))))))
8703 ;; The declaration doesn't have any of the
8704 ;; `c-opt-block-decls-with-vars' keywords in the
8705 ;; beginning, so it ends here at the end of the block.
8708 (c-with-syntax-table decl-syntax-table
8710 (if (eq (char-before) ?\;)
8712 (c-syntactic-re-search-forward ";" nil 'move t))))
8715 (defun c-looking-at-decl-block (containing-sexp goto-start &optional limit)
8716 ;; Assuming the point is at an open brace, check if it starts a
8717 ;; block that contains another declaration level, i.e. that isn't a
8718 ;; statement block or a brace list, and if so return non-nil.
8720 ;; If the check is successful, the return value is the start of the
8721 ;; keyword that tells what kind of construct it is, i.e. typically
8722 ;; what `c-decl-block-key' matched. Also, if GOTO-START is set then
8723 ;; the point will be at the start of the construct, before any
8724 ;; leading specifiers, otherwise it's at the returned position.
8726 ;; The point is clobbered if the check is unsuccessful.
8728 ;; CONTAINING-SEXP is the position of the open of the surrounding
8729 ;; paren, or nil if none.
8731 ;; The optional LIMIT limits the backward search for the start of
8732 ;; the construct. It's assumed to be at a syntactically relevant
8735 ;; If any template arglists are found in the searched region before
8736 ;; the open brace, they get marked with paren syntax.
8738 ;; This function might do hidden buffer changes.
8740 (let ((open-brace (point)) kwd-start first-specifier-pos)
8741 (c-syntactic-skip-backward c-block-prefix-charset limit t)
8743 (when (and c-recognize-<>-arglists
8744 (eq (char-before) ?>))
8745 ;; Could be at the end of a template arglist.
8746 (let ((c-parse-and-markup-<>-arglists t))
8748 (c-backward-<>-arglist nil limit)
8750 (c-syntactic-skip-backward c-block-prefix-charset limit t)
8751 (eq (char-before) ?>))))))
8753 ;; Note: Can't get bogus hits inside template arglists below since they
8754 ;; have gotten paren syntax above.
8756 ;; If `goto-start' is set we begin by searching for the
8757 ;; first possible position of a leading specifier list.
8758 ;; The `c-decl-block-key' search continues from there since
8759 ;; we know it can't match earlier.
8761 (when (c-syntactic-re-search-forward c-symbol-start
8763 (goto-char (setq first-specifier-pos (match-beginning 0)))
8768 ((c-syntactic-re-search-forward c-decl-block-key open-brace t t t)
8769 (goto-char (setq kwd-start (match-beginning 0)))
8771 ;; Exclude cases where we matched what would ordinarily
8772 ;; be a block declaration keyword, except where it's not
8773 ;; legal because it's part of a "compound keyword" like
8774 ;; "enum class". Of course, if c-after-brace-list-key
8775 ;; is nil, we can skip the test.
8776 (or (equal c-after-brace-list-key "\\<\\>")
8781 (looking-at c-after-brace-list-key)
8782 (= (c-backward-token-2 1 t) 0)
8783 (looking-at c-brace-list-key))))))
8785 ;; Found a keyword that can't be a type?
8788 ;; Can be a type too, in which case it's the return type of a
8789 ;; function (under the assumption that no declaration level
8790 ;; block construct starts with a type).
8791 (not (c-forward-type))
8793 ;; Jumped over a type, but it could be a declaration keyword
8794 ;; followed by the declared identifier that we've jumped over
8795 ;; instead (e.g. in "class Foo {"). If it indeed is a type
8796 ;; then we should be at the declarator now, so check for a
8797 ;; valid declarator start.
8799 ;; Note: This doesn't cope with the case when a declared
8800 ;; identifier is followed by e.g. '(' in a language where '('
8801 ;; also might be part of a declarator expression. Currently
8802 ;; there's no such language.
8803 (not (or (looking-at c-symbol-start)
8804 (looking-at c-type-decl-prefix-key))))))
8806 ;; In Pike a list of modifiers may be followed by a brace
8807 ;; to make them apply to many identifiers. Note that the
8808 ;; match data will be empty on return in this case.
8809 ((and (c-major-mode-is 'pike-mode)
8811 (goto-char open-brace)
8812 (= (c-backward-token-2) 0))
8813 (looking-at c-specifier-key)
8814 ;; Use this variant to avoid yet another special regexp.
8815 (c-keyword-member (c-keyword-sym (match-string 1))
8817 (setq kwd-start (point))
8823 ;; Back up over any preceding specifiers and their clauses
8824 ;; by going forward from `first-specifier-pos', which is the
8825 ;; earliest possible position where the specifier list can
8828 (goto-char first-specifier-pos)
8830 (while (< (point) kwd-start)
8831 (if (looking-at c-symbol-key)
8832 ;; Accept any plain symbol token on the ground that
8833 ;; it's a specifier masked through a macro (just
8834 ;; like `c-forward-decl-or-cast-1' skip forward over
8837 ;; Could be more restrictive wrt invalid keywords,
8838 ;; but that'd only occur in invalid code so there's
8839 ;; no use spending effort on it.
8840 (let ((end (match-end 0)))
8841 (unless (c-forward-keyword-clause 0)
8843 (c-forward-syntactic-ws)))
8845 ;; Can't parse a declaration preamble and is still
8846 ;; before `kwd-start'. That means `first-specifier-pos'
8847 ;; was in some earlier construct. Search again.
8848 (if (c-syntactic-re-search-forward c-symbol-start
8850 (goto-char (setq first-specifier-pos (match-beginning 0)))
8851 ;; Got no preamble before the block declaration keyword.
8852 (setq first-specifier-pos kwd-start))))
8854 (goto-char first-specifier-pos))
8855 (goto-char kwd-start))
8859 (defun c-search-uplist-for-classkey (paren-state)
8860 ;; Check if the closest containing paren sexp is a declaration
8861 ;; block, returning a 2 element vector in that case. Aref 0
8862 ;; contains the bufpos at boi of the class key line, and aref 1
8863 ;; contains the bufpos of the open brace. This function is an
8864 ;; obsolete wrapper for `c-looking-at-decl-block'.
8866 ;; This function might do hidden buffer changes.
8867 (let ((open-paren-pos (c-most-enclosing-brace paren-state)))
8868 (when open-paren-pos
8870 (goto-char open-paren-pos)
8871 (when (and (eq (char-after) ?{)
8872 (c-looking-at-decl-block
8873 (c-safe-position open-paren-pos paren-state)
8875 (back-to-indentation)
8876 (vector (point) open-paren-pos))))))
8878 (defun c-most-enclosing-decl-block (paren-state)
8879 ;; Return the buffer position of the most enclosing decl-block brace (in the
8880 ;; sense of c-looking-at-decl-block) in the PAREN-STATE structure, or nil if
8882 (let* ((open-brace (c-pull-open-brace paren-state))
8883 (next-open-brace (c-pull-open-brace paren-state)))
8884 (while (and open-brace
8886 (goto-char open-brace)
8887 (not (c-looking-at-decl-block next-open-brace nil))))
8888 (setq open-brace next-open-brace
8889 next-open-brace (c-pull-open-brace paren-state)))
8892 (defun c-cheap-inside-bracelist-p (paren-state)
8893 ;; Return the position of the L-brace if point is inside a brace list
8894 ;; initialization of an array, etc. This is an approximate function,
8895 ;; designed for speed over accuracy. It will not find every bracelist, but
8896 ;; a non-nil result is reliable. We simply search for "= {" (naturally with
8897 ;; syntactic whitespace allowed). PAREN-STATE is the normal thing that it
8898 ;; is everywhere else.
8902 (and (setq b-pos (c-pull-open-brace paren-state))
8903 (progn (goto-char b-pos)
8905 (c-backward-token-2)
8906 (not (looking-at "=")))))
8909 (defun c-backward-colon-prefixed-type ()
8910 ;; We're at the token after what might be a type prefixed with a colon. Try
8911 ;; moving backward over this type and the colon. On success, return t and
8912 ;; leave point before colon; on failure, leave point unchanged. Will clobber
8914 (let ((here (point))
8918 (and (eql (c-backward-token-2) 0)
8919 (or (not (looking-at "\\s)"))
8920 (c-go-up-list-backward))
8922 ((eql (char-after) ?:)
8923 (setq colon-pos (point))
8925 (c-forward-syntactic-ws)
8926 (or (and (c-forward-type)
8927 (progn (c-forward-syntactic-ws)
8929 (setq colon-pos nil))
8931 ((eql (char-after) ?\()
8933 ((looking-at c-symbol-key)
8937 (goto-char colon-pos)
8940 (defun c-backward-over-enum-header ()
8941 ;; We're at a "{". Move back to the enum-like keyword that starts this
8942 ;; declaration and return t, otherwise don't move and return nil.
8943 (let ((here (point))
8944 up-sexp-pos before-identifier)
8945 (when c-recognize-post-brace-list-type-p
8946 (c-backward-colon-prefixed-type))
8949 (eq (c-backward-token-2) 0)
8950 (or (not (looking-at "\\s)"))
8951 (c-go-up-list-backward))
8953 ((and (looking-at c-symbol-key) (c-on-identifier)
8954 (not before-identifier))
8955 (setq before-identifier t))
8956 ((and before-identifier
8957 (or (eql (char-after) ?,)
8958 (looking-at c-postfix-decl-spec-key)))
8959 (setq before-identifier nil)
8961 ((looking-at c-after-brace-list-key) t)
8962 ((looking-at c-brace-list-key) nil)
8963 ((and c-recognize-<>-arglists
8964 (eq (char-after) ?<)
8965 (looking-at "\\s("))
8968 (or (looking-at c-brace-list-key)
8969 (progn (goto-char here) nil))))
8971 (defun c-inside-bracelist-p (containing-sexp paren-state)
8972 ;; return the buffer position of the beginning of the brace list
8973 ;; statement if we're inside a brace list, otherwise return nil.
8974 ;; CONTAINING-SEXP is the buffer pos of the innermost containing
8975 ;; paren. PAREN-STATE is the remainder of the state of enclosing
8978 ;; N.B.: This algorithm can potentially get confused by cpp macros
8979 ;; placed in inconvenient locations. It's a trade-off we make for
8982 ;; This function might do hidden buffer changes.
8984 ;; This will pick up brace list declarations.
8986 (goto-char containing-sexp)
8987 (c-backward-over-enum-header))
8988 ;; this will pick up array/aggregate init lists, even if they are nested.
8991 ;; Pike can have class definitions anywhere, so we must
8992 ;; check for the class key here.
8993 (and (c-major-mode-is 'pike-mode)
8995 bufpos braceassignp lim next-containing macro-start)
8996 (while (and (not bufpos)
8999 (if (consp (car paren-state))
9000 (setq lim (cdr (car paren-state))
9001 paren-state (cdr paren-state))
9002 (setq lim (car paren-state)))
9004 (setq next-containing (car paren-state)
9005 paren-state (cdr paren-state))))
9006 (goto-char containing-sexp)
9007 (if (c-looking-at-inexpr-block next-containing next-containing)
9008 ;; We're in an in-expression block of some kind. Do not
9009 ;; check nesting. We deliberately set the limit to the
9010 ;; containing sexp, so that c-looking-at-inexpr-block
9011 ;; doesn't check for an identifier before it.
9012 (setq containing-sexp nil)
9013 ;; see if the open brace is preceded by = or [...] in
9014 ;; this statement, but watch out for operator=
9015 (setq braceassignp 'dontknow)
9016 (c-backward-token-2 1 t lim)
9017 ;; Checks to do only on the first sexp before the brace.
9018 (when (and c-opt-inexpr-brace-list-key
9019 (eq (char-after) ?\[))
9020 ;; In Java, an initialization brace list may follow
9021 ;; directly after "new Foo[]", so check for a "new"
9023 (while (eq braceassignp 'dontknow)
9025 (cond ((/= (c-backward-token-2 1 t lim) 0) nil)
9026 ((looking-at c-opt-inexpr-brace-list-key) t)
9027 ((looking-at "\\sw\\|\\s_\\|[.[]")
9028 ;; Carry on looking if this is an
9029 ;; identifier (may contain "." in Java)
9030 ;; or another "[]" sexp.
9033 ;; Checks to do on all sexps before the brace, up to the
9034 ;; beginning of the statement.
9035 (while (eq braceassignp 'dontknow)
9036 (cond ((eq (char-after) ?\;)
9037 (setq braceassignp nil))
9039 (looking-at class-key))
9040 (setq braceassignp nil))
9041 ((eq (char-after) ?=)
9042 ;; We've seen a =, but must check earlier tokens so
9043 ;; that it isn't something that should be ignored.
9044 (setq braceassignp 'maybe)
9045 (while (and (eq braceassignp 'maybe)
9046 (zerop (c-backward-token-2 1 t lim)))
9049 ;; Check for operator =
9050 ((and c-opt-op-identifier-prefix
9051 (looking-at c-opt-op-identifier-prefix))
9053 ;; Check for `<opchar>= in Pike.
9054 ((and (c-major-mode-is 'pike-mode)
9055 (or (eq (char-after) ?`)
9056 ;; Special case for Pikes
9057 ;; `[]=, since '[' is not in
9058 ;; the punctuation class.
9059 (and (eq (char-after) ?\[)
9060 (eq (char-before) ?`))))
9062 ((looking-at "\\s.") 'maybe)
9063 ;; make sure we're not in a C++ template
9064 ;; argument assignment
9066 (c-major-mode-is 'c++-mode)
9068 (let ((here (point))
9070 (skip-chars-backward "^<>")
9072 (and (eq (char-before) ?<)
9073 (not (c-crosses-statement-barrier-p
9075 (not (c-in-literal))
9079 (if (and (eq braceassignp 'dontknow)
9080 (/= (c-backward-token-2 1 t lim) 0))
9081 (setq braceassignp nil)))
9084 ;; We've hit the beginning of the aggregate list.
9085 (c-beginning-of-statement-1
9086 (c-most-enclosing-brace paren-state))
9087 (setq bufpos (point)))
9088 ((eq (char-after) ?\;)
9089 ;; Brace lists can't contain a semicolon, so we're done.
9090 (setq containing-sexp nil))
9091 ((and (setq macro-start (point))
9092 (c-forward-to-cpp-define-body)
9093 (eq (point) containing-sexp))
9094 ;; We've a macro whose expansion starts with the '{'.
9095 ;; Heuristically, if we have a ';' in it we've not got a
9096 ;; brace list, otherwise we have.
9097 (let ((macro-end (progn (c-end-of-macro) (point))))
9098 (goto-char containing-sexp)
9100 (if (and (c-syntactic-re-search-forward "[;,]" macro-end t t)
9101 (eq (char-before) ?\;))
9103 containing-sexp nil)
9104 (setq bufpos macro-start))))
9107 (setq containing-sexp next-containing
9109 next-containing nil)))))
9114 (defun c-looking-at-special-brace-list (&optional lim)
9115 ;; If we're looking at the start of a pike-style list, i.e., `({Â })',
9116 ;; `([Â ])', `(<Â >)', etc., a cons of a cons of its starting and ending
9117 ;; positions and its entry in c-special-brace-lists is returned, nil
9118 ;; otherwise. The ending position is nil if the list is still open.
9119 ;; LIM is the limit for forward search. The point may either be at
9120 ;; the `(' or at the following paren character. Tries to check the
9121 ;; matching closer, but assumes it's correct if no balanced paren is
9122 ;; found (i.e. the case `({ ... } ... )' is detected as _not_ being
9123 ;; a special brace list).
9125 ;; This function might do hidden buffer changes.
9126 (if c-special-brace-lists
9131 (c-forward-syntactic-ws)
9132 (if (eq (char-after) ?\()
9135 (c-forward-syntactic-ws)
9136 (setq inner-beg (point))
9137 (setq type (assq (char-after) c-special-brace-lists)))
9138 (if (setq type (assq (char-after) c-special-brace-lists))
9140 (setq inner-beg (point))
9141 (c-backward-syntactic-ws)
9143 (setq beg (if (eq (char-after) ?\()
9151 (= (char-before) ?\)))
9153 (goto-char inner-beg)
9154 (if (looking-at "\\s(")
9155 ;; Check balancing of the inner paren
9160 ;; If the inner char isn't a paren then
9161 ;; we can't check balancing, so just
9162 ;; check the char before the outer
9166 (c-backward-syntactic-ws)
9167 (= (char-before) (cdr type)))))
9168 (if (or (/= (char-syntax (char-before)) ?\))
9170 (c-forward-syntactic-ws)
9173 (cons (cons beg end) type))
9174 (cons (list beg) type)))))
9177 (defun c-looking-at-bos (&optional lim)
9178 ;; Return non-nil if between two statements or declarations, assuming
9179 ;; point is not inside a literal or comment.
9181 ;; Obsolete - `c-at-statement-start-p' or `c-at-expression-start-p'
9182 ;; are recommended instead.
9184 ;; This function might do hidden buffer changes.
9185 (c-at-statement-start-p))
9186 (make-obsolete 'c-looking-at-bos 'c-at-statement-start-p "22.1")
9188 (defun c-looking-at-inexpr-block (lim containing-sexp &optional check-at-end)
9189 ;; Return non-nil if we're looking at the beginning of a block
9190 ;; inside an expression. The value returned is actually a cons of
9191 ;; either 'inlambda, 'inexpr-statement or 'inexpr-class and the
9192 ;; position of the beginning of the construct.
9194 ;; LIM limits the backward search. CONTAINING-SEXP is the start
9195 ;; position of the closest containing list. If it's nil, the
9196 ;; containing paren isn't used to decide whether we're inside an
9197 ;; expression or not. If both LIM and CONTAINING-SEXP are used, LIM
9198 ;; needs to be farther back.
9200 ;; If CHECK-AT-END is non-nil then extra checks at the end of the
9201 ;; brace block might be done. It should only be used when the
9202 ;; construct can be assumed to be complete, i.e. when the original
9203 ;; starting position was further down than that.
9205 ;; This function might do hidden buffer changes.
9208 (let ((res 'maybe) passed-paren
9209 (closest-lim (or containing-sexp lim (point-min)))
9210 ;; Look at the character after point only as a last resort
9211 ;; when we can't disambiguate.
9212 (block-follows (and (eq (char-after) ?{) (point))))
9214 (while (and (eq res 'maybe)
9215 (progn (c-backward-syntactic-ws)
9216 (> (point) closest-lim))
9218 (progn (backward-char)
9219 (looking-at "[]).]\\|\\w\\|\\s_"))
9220 (c-safe (forward-char)
9221 (goto-char (scan-sexps (point) -1))))
9224 (if (looking-at c-keywords-regexp)
9225 (let ((kw-sym (c-keyword-sym (match-string 1))))
9228 (c-keyword-member kw-sym 'c-inexpr-class-kwds))
9229 (and (not (eq passed-paren ?\[))
9230 (or (not (looking-at c-class-key))
9231 ;; If the class definition is at the start of
9232 ;; a statement, we don't consider it an
9233 ;; in-expression class.
9234 (let ((prev (point)))
9236 (= (c-backward-token-2 1 nil closest-lim) 0)
9237 (eq (char-syntax (char-after)) ?w))
9238 (setq prev (point)))
9240 (not (c-at-statement-start-p)))
9241 ;; Also, in Pike we treat it as an
9242 ;; in-expression class if it's used in an
9243 ;; object clone expression.
9246 (c-major-mode-is 'pike-mode)
9247 (progn (goto-char block-follows)
9248 (zerop (c-forward-token-2 1 t)))
9249 (eq (char-after) ?\())))
9250 (cons 'inexpr-class (point))))
9251 ((c-keyword-member kw-sym 'c-inexpr-block-kwds)
9252 (when (not passed-paren)
9253 (cons 'inexpr-statement (point))))
9254 ((c-keyword-member kw-sym 'c-lambda-kwds)
9255 (when (or (not passed-paren)
9256 (eq passed-paren ?\())
9257 (cons 'inlambda (point))))
9258 ((c-keyword-member kw-sym 'c-block-stmt-kwds)
9263 (if (looking-at "\\s(")
9265 (if (and (eq passed-paren ?\[)
9266 (eq (char-after) ?\[))
9267 ;; Accept several square bracket sexps for
9268 ;; Java array initializations.
9270 (setq passed-paren (char-after))
9275 (when (and c-recognize-paren-inexpr-blocks
9278 (eq (char-after containing-sexp) ?\())
9279 (goto-char containing-sexp)
9280 (if (or (save-excursion
9281 (c-backward-syntactic-ws lim)
9282 (while (and (eq (char-before) ?>)
9283 (c-get-char-property (1- (point))
9285 (c-go-list-backward nil lim))
9286 (c-backward-syntactic-ws lim))
9287 (and (> (point) (or lim (point-min)))
9289 (and c-special-brace-lists
9290 (c-looking-at-special-brace-list)))
9292 (cons 'inexpr-statement (point))))
9296 (defun c-looking-at-inexpr-block-backward (paren-state)
9297 ;; Returns non-nil if we're looking at the end of an in-expression
9298 ;; block, otherwise the same as `c-looking-at-inexpr-block'.
9299 ;; PAREN-STATE is the paren state relevant at the current position.
9301 ;; This function might do hidden buffer changes.
9303 ;; We currently only recognize a block.
9304 (let ((here (point))
9305 (elem (car-safe paren-state))
9307 (when (and (consp elem)
9308 (progn (goto-char (cdr elem))
9309 (c-forward-syntactic-ws here)
9311 (goto-char (car elem))
9312 (if (setq paren-state (cdr paren-state))
9313 (setq containing-sexp (car-safe paren-state)))
9314 (c-looking-at-inexpr-block (c-safe-position containing-sexp
9316 containing-sexp)))))
9318 (defun c-at-macro-vsemi-p (&optional pos)
9319 ;; Is there a "virtual semicolon" at POS or point?
9320 ;; (See cc-defs.el for full details of "virtual semicolons".)
9322 ;; This is true when point is at the last non syntactic WS position on the
9323 ;; line, there is a macro call last on the line, and this particular macro's
9324 ;; name is defined by the regexp `c-vs-macro-regexp' as not needing a
9333 c-macro-with-semi-re
9334 (eq (skip-chars-backward " \t") 0)
9336 ;; Check we've got nothing after this except comments and empty lines
9337 ;; joined by escaped EOLs.
9338 (skip-chars-forward " \t") ; always returns non-nil.
9340 (while ; go over 1 block comment per iteration.
9342 (looking-at "\\(\\\\[\n\r][ \t]*\\)*")
9343 (goto-char (match-end 0))
9345 ((looking-at c-block-comment-start-regexp)
9346 (and (forward-comment 1)
9347 (skip-chars-forward " \t"))) ; always returns non-nil
9348 ((looking-at c-line-comment-start-regexp)
9355 (progn (c-backward-syntactic-ws)
9358 ;; Check for one of the listed macros being before point.
9359 (or (not (eq (char-before) ?\)))
9360 (when (c-go-list-backward)
9361 (c-backward-syntactic-ws)
9363 (c-simple-skip-symbol-backward)
9364 (looking-at c-macro-with-semi-re)
9366 (not (c-in-literal)))))) ; The most expensive check last.
9368 (defun c-macro-vsemi-status-unknown-p () t) ; See cc-defs.el.
9371 ;; `c-guess-basic-syntax' and the functions that precedes it below
9372 ;; implements the main decision tree for determining the syntactic
9373 ;; analysis of the current line of code.
9375 ;; Dynamically bound to t when `c-guess-basic-syntax' is called during
9376 ;; auto newline analysis.
9377 (defvar c-auto-newline-analysis nil)
9379 (defun c-brace-anchor-point (bracepos)
9380 ;; BRACEPOS is the position of a brace in a construct like "namespace
9381 ;; Bar {". Return the anchor point in this construct; this is the
9382 ;; earliest symbol on the brace's line which isn't earlier than
9385 ;; Currently (2007-08-17), "like namespace" means "matches
9386 ;; c-other-block-decl-kwds". It doesn't work with "class" or "struct"
9387 ;; or anything like that.
9389 (let ((boi (c-point 'boi bracepos)))
9390 (goto-char bracepos)
9391 (while (and (> (point) boi)
9392 (not (looking-at c-other-decl-block-key)))
9393 (c-backward-token-2))
9394 (if (> (point) boi) (point) boi))))
9396 (defsubst c-add-syntax (symbol &rest args)
9397 ;; A simple function to prepend a new syntax element to
9398 ;; `c-syntactic-context'. Using `setq' on it is unsafe since it
9399 ;; should always be dynamically bound but since we read it first
9400 ;; we'll fail properly anyway if this function is misused.
9401 (setq c-syntactic-context (cons (cons symbol args)
9402 c-syntactic-context)))
9404 (defsubst c-append-syntax (symbol &rest args)
9405 ;; Like `c-add-syntax' but appends to the end of the syntax list.
9406 ;; (Normally not necessary.)
9407 (setq c-syntactic-context (nconc c-syntactic-context
9408 (list (cons symbol args)))))
9410 (defun c-add-stmt-syntax (syntax-symbol
9415 ;; Add the indicated SYNTAX-SYMBOL to `c-syntactic-context', extending it as
9416 ;; needed with further syntax elements of the types `substatement',
9417 ;; `inexpr-statement', `arglist-cont-nonempty', `statement-block-intro', and
9418 ;; `defun-block-intro'.
9420 ;; Do the generic processing to anchor the given syntax symbol on
9421 ;; the preceding statement: Skip over any labels and containing
9422 ;; statements on the same line, and then search backward until we
9423 ;; find a statement or block start that begins at boi without a
9424 ;; label or comment.
9426 ;; Point is assumed to be at the prospective anchor point for the
9427 ;; given SYNTAX-SYMBOL. More syntax entries are added if we need to
9428 ;; skip past open parens and containing statements. Most of the added
9429 ;; syntax elements will get the same anchor point - the exception is
9430 ;; for an anchor in a construct like "namespace"[*] - this is as early
9431 ;; as possible in the construct but on the same line as the {.
9433 ;; [*] i.e. with a keyword matching c-other-block-decl-kwds.
9435 ;; SYNTAX-EXTRA-ARGS are a list of the extra arguments for the
9436 ;; syntax symbol. They are appended after the anchor point.
9438 ;; If STOP-AT-BOI-ONLY is nil, we can stop in the middle of the line
9439 ;; if the current statement starts there.
9441 ;; Note: It's not a problem if PAREN-STATE "overshoots"
9442 ;; CONTAINING-SEXP, i.e. contains info about parens further down.
9444 ;; This function might do hidden buffer changes.
9446 (if (= (point) (c-point 'boi))
9447 ;; This is by far the most common case, so let's give it special
9449 (apply 'c-add-syntax syntax-symbol (point) syntax-extra-args)
9451 (let ((syntax-last c-syntactic-context)
9452 (boi (c-point 'boi))
9453 ;; Set when we're on a label, so that we don't stop there.
9454 ;; FIXME: To be complete we should check if we're on a label
9455 ;; now at the start.
9458 ;; Use point as the anchor point for "namespace", "extern", etc.
9459 (apply 'c-add-syntax syntax-symbol
9460 (if (rassq syntax-symbol c-other-decl-block-key-in-symbols-alist)
9464 ;; Loop while we have to back out of containing blocks.
9467 (catch 'back-up-block
9469 ;; Loop while we have to back up statements.
9470 (while (or (/= (point) boi)
9472 (looking-at c-comment-start-regexp))
9474 ;; Skip past any comments that stands between the
9475 ;; statement start and boi.
9476 (let ((savepos (point)))
9477 (while (and (/= savepos boi)
9478 (c-backward-single-comment))
9479 (setq savepos (point)
9480 boi (c-point 'boi)))
9481 (goto-char savepos))
9483 ;; Skip to the beginning of this statement or backward
9485 (let ((old-pos (point))
9487 (step-type (c-beginning-of-statement-1 containing-sexp)))
9488 (setq boi (c-point 'boi)
9489 on-label (eq step-type 'label))
9491 (cond ((= (point) old-pos)
9492 ;; If we didn't move we're at the start of a block and
9493 ;; have to continue outside it.
9494 (throw 'back-up-block t))
9496 ((and (eq step-type 'up)
9497 (>= (point) old-boi)
9498 (looking-at "else\\>[^_]")
9501 (looking-at "if\\>[^_]")))
9502 ;; Special case to avoid deeper and deeper indentation
9503 ;; of "else if" clauses.
9506 ((and (not stop-at-boi-only)
9507 (/= old-pos old-boi)
9508 (memq step-type '(up previous)))
9509 ;; If stop-at-boi-only is nil, we shouldn't back up
9510 ;; over previous or containing statements to try to
9511 ;; reach boi, so go back to the last position and
9514 (throw 'back-up-block nil))
9517 (if (and (not stop-at-boi-only)
9518 (memq step-type '(up previous beginning)))
9519 ;; If we've moved into another statement then we
9520 ;; should no longer try to stop in the middle of a
9522 (setq stop-at-boi-only t))
9524 ;; Record this as a substatement if we skipped up one
9526 (when (eq step-type 'up)
9527 (c-add-syntax 'substatement nil))))
9532 ;; Now we have to go out of this block.
9533 (goto-char containing-sexp)
9535 ;; Don't stop in the middle of a special brace list opener
9537 (when c-special-brace-lists
9538 (let ((special-list (c-looking-at-special-brace-list)))
9539 (when (and special-list
9540 (< (car (car special-list)) (point)))
9541 (setq containing-sexp (car (car special-list)))
9542 (goto-char containing-sexp))))
9544 (setq paren-state (c-whack-state-after containing-sexp paren-state)
9545 containing-sexp (c-most-enclosing-brace paren-state)
9548 ;; Analyze the construct in front of the block we've stepped out
9549 ;; from and add the right syntactic element for it.
9550 (let ((paren-pos (point))
9551 (paren-char (char-after))
9554 (if (eq paren-char ?\()
9555 ;; Stepped out of a parenthesis block, so we're in an
9558 (when (/= paren-pos boi)
9559 (if (and c-recognize-paren-inexpr-blocks
9561 (c-backward-syntactic-ws containing-sexp)
9562 (or (not (looking-at "\\>"))
9563 (not (c-on-identifier))))
9565 (goto-char (1+ paren-pos))
9566 (c-forward-syntactic-ws)
9567 (eq (char-after) ?{)))
9568 ;; Stepped out of an in-expression statement. This
9569 ;; syntactic element won't get an anchor pos.
9570 (c-add-syntax 'inexpr-statement)
9572 ;; A parenthesis normally belongs to an arglist.
9573 (c-add-syntax 'arglist-cont-nonempty nil paren-pos)))
9577 (1+ containing-sexp)
9579 (setq step-type 'same
9582 ;; Stepped out of a brace block.
9583 (setq step-type (c-beginning-of-statement-1 containing-sexp)
9584 on-label (eq step-type 'label))
9586 (if (and (eq step-type 'same)
9587 (/= paren-pos (point)))
9591 (goto-char paren-pos)
9592 (setq inexpr (c-looking-at-inexpr-block
9593 (c-safe-position containing-sexp paren-state)
9595 (c-add-syntax (if (eq (car inexpr) 'inlambda)
9597 'statement-block-intro)
9599 ((looking-at c-other-decl-block-key)
9601 (cdr (assoc (match-string 1)
9602 c-other-decl-block-key-in-symbols-alist))
9603 (max (c-point 'boi paren-pos) (point))))
9604 (t (c-add-syntax 'defun-block-intro nil))))
9606 (c-add-syntax 'statement-block-intro nil)))
9608 (if (= paren-pos boi)
9609 ;; Always done if the open brace was at boi. The
9610 ;; c-beginning-of-statement-1 call above is necessary
9611 ;; anyway, to decide the type of block-intro to add.
9612 (goto-char paren-pos)
9613 (setq boi (c-point 'boi)))
9616 ;; Fill in the current point as the anchor for all the symbols
9618 (let ((p c-syntactic-context) q)
9619 (while (not (eq p syntax-last))
9620 (setq q (cdr (car p))) ; e.g. (nil 28) [from (arglist-cont-nonempty nil 28)]
9628 (defun c-add-class-syntax (symbol
9629 containing-decl-open
9630 containing-decl-start
9633 ;; The inclass and class-close syntactic symbols are added in
9634 ;; several places and some work is needed to fix everything.
9635 ;; Therefore it's collected here.
9637 ;; This function might do hidden buffer changes.
9638 (goto-char containing-decl-open)
9639 (if (and (eq symbol 'inclass) (= (point) (c-point 'boi)))
9641 (c-add-syntax symbol containing-decl-open)
9642 containing-decl-open)
9643 (goto-char containing-decl-start)
9644 ;; Ought to use `c-add-stmt-syntax' instead of backing up to boi
9645 ;; here, but we have to do like this for compatibility.
9646 (back-to-indentation)
9647 (c-add-syntax symbol (point))
9648 (if (and (c-keyword-member containing-decl-kwd
9649 'c-inexpr-class-kwds)
9650 (/= containing-decl-start (c-point 'boi containing-decl-start)))
9651 (c-add-syntax 'inexpr-class))
9654 (defun c-guess-continued-construct (indent-point
9656 beg-of-same-or-containing-stmt
9659 ;; This function contains the decision tree reached through both
9660 ;; cases 18 and 10. It's a continued statement or top level
9661 ;; construct of some kind.
9663 ;; This function might do hidden buffer changes.
9665 (let (special-brace-list placeholder)
9666 (goto-char indent-point)
9667 (skip-chars-forward " \t")
9670 ;; (CASE A removed.)
9671 ;; CASE B: open braces for class or brace-lists
9672 ((setq special-brace-list
9673 (or (and c-special-brace-lists
9674 (c-looking-at-special-brace-list))
9675 (eq char-after-ip ?{)))
9678 ;; CASE B.1: class-open
9680 (and (eq (char-after) ?{)
9681 (c-looking-at-decl-block containing-sexp t)
9682 (setq beg-of-same-or-containing-stmt (point))))
9683 (c-add-syntax 'class-open beg-of-same-or-containing-stmt))
9685 ;; CASE B.2: brace-list-open
9686 ((or (consp special-brace-list)
9688 (goto-char beg-of-same-or-containing-stmt)
9689 (c-syntactic-re-search-forward "=\\([^=]\\|$\\)"
9690 indent-point t t t)))
9691 ;; The most semantically accurate symbol here is
9692 ;; brace-list-open, but we normally report it simply as a
9693 ;; statement-cont. The reason is that one normally adjusts
9694 ;; brace-list-open for brace lists as top-level constructs,
9695 ;; and brace lists inside statements is a completely different
9696 ;; context. C.f. case 5A.3.
9697 (c-beginning-of-statement-1 containing-sexp)
9698 (c-add-stmt-syntax (if c-auto-newline-analysis
9699 ;; Turn off the dwim above when we're
9700 ;; analyzing the nature of the brace
9701 ;; for the auto newline feature.
9705 containing-sexp paren-state))
9707 ;; CASE B.3: The body of a function declared inside a normal
9708 ;; block. Can occur e.g. in Pike and when using gcc
9709 ;; extensions, but watch out for macros followed by blocks.
9710 ;; C.f. cases E, 16F and 17G.
9711 ((and (not (c-at-statement-start-p))
9712 (eq (c-beginning-of-statement-1 containing-sexp nil nil t)
9715 (let ((c-recognize-typeless-decls nil))
9716 ;; Turn off recognition of constructs that lacks a
9717 ;; type in this case, since that's more likely to be
9718 ;; a macro followed by a block.
9719 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
9720 (c-add-stmt-syntax 'defun-open nil t
9721 containing-sexp paren-state))
9723 ;; CASE B.4: Continued statement with block open. The most
9724 ;; accurate analysis is perhaps `statement-cont' together with
9725 ;; `block-open' but we play DWIM and use `substatement-open'
9726 ;; instead. The rationale is that this typically is a macro
9727 ;; followed by a block which makes it very similar to a
9728 ;; statement with a substatement block.
9730 (c-add-stmt-syntax 'substatement-open nil nil
9731 containing-sexp paren-state))
9734 ;; CASE C: iostream insertion or extraction operator
9735 ((and (looking-at "\\(<<\\|>>\\)\\([^=]\\|$\\)")
9737 (goto-char beg-of-same-or-containing-stmt)
9738 ;; If there is no preceding streamop in the statement
9739 ;; then indent this line as a normal statement-cont.
9740 (when (c-syntactic-re-search-forward
9741 "\\(<<\\|>>\\)\\([^=]\\|$\\)" indent-point 'move t t)
9742 (c-add-syntax 'stream-op (c-point 'boi))
9745 ;; CASE E: In the "K&R region" of a function declared inside a
9746 ;; normal block. C.f. case B.3.
9747 ((and (save-excursion
9748 ;; Check that the next token is a '{'. This works as
9749 ;; long as no language that allows nested function
9750 ;; definitions allows stuff like member init lists, K&R
9751 ;; declarations or throws clauses there.
9753 ;; Note that we do a forward search for something ahead
9754 ;; of the indentation line here. That's not good since
9755 ;; the user might not have typed it yet. Unfortunately
9756 ;; it's exceedingly tricky to recognize a function
9757 ;; prototype in a code block without resorting to this.
9758 (c-forward-syntactic-ws)
9759 (eq (char-after) ?{))
9760 (not (c-at-statement-start-p))
9761 (eq (c-beginning-of-statement-1 containing-sexp nil nil t)
9764 (let ((c-recognize-typeless-decls nil))
9765 ;; Turn off recognition of constructs that lacks a
9766 ;; type in this case, since that's more likely to be
9767 ;; a macro followed by a block.
9768 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
9769 (c-add-stmt-syntax 'func-decl-cont nil t
9770 containing-sexp paren-state))
9772 ;;CASE F: continued statement and the only preceding items are
9774 ((and (c-major-mode-is 'java-mode)
9775 (setq placeholder (point))
9776 (c-beginning-of-statement-1)
9778 (while (and (c-forward-annotation)
9779 (< (point) placeholder))
9780 (c-forward-syntactic-ws))
9783 (>= (point) placeholder)
9784 (goto-char placeholder)))
9785 (c-beginning-of-statement-1 containing-sexp)
9786 (c-add-syntax 'annotation-var-cont (point)))
9788 ;; CASE G: a template list continuation?
9789 ;; Mostly a duplication of case 5D.3 to fix templates-19:
9790 ((and (c-major-mode-is 'c++-mode)
9792 (goto-char indent-point)
9793 (c-with-syntax-table c++-template-syntax-table
9794 (setq placeholder (c-up-list-backward)))
9796 (eq (char-after placeholder) ?<)
9797 (/= (char-before placeholder) ?<)
9799 (goto-char (1+ placeholder))
9800 (not (looking-at c-<-op-cont-regexp))))))
9801 (c-with-syntax-table c++-template-syntax-table
9802 (goto-char placeholder)
9803 (c-beginning-of-statement-1 containing-sexp t))
9805 (c-backward-syntactic-ws containing-sexp)
9806 (eq (char-before) ?<))
9807 ;; In a nested template arglist.
9809 (goto-char placeholder)
9810 (c-syntactic-skip-backward "^,;" containing-sexp t)
9811 (c-forward-syntactic-ws))
9812 (back-to-indentation))
9813 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
9815 (c-add-syntax 'template-args-cont (point) placeholder))
9817 ;; CASE D: continued statement.
9819 (c-beginning-of-statement-1 containing-sexp)
9820 (c-add-stmt-syntax 'statement-cont nil nil
9821 containing-sexp paren-state))
9824 ;; The next autoload was added by RMS on 2005/8/9 - don't know why (ACM,
9827 (defun c-guess-basic-syntax ()
9828 "Return the syntactic context of the current line."
9831 (c-save-buffer-state
9832 ((indent-point (point))
9833 (case-fold-search nil)
9834 ;; A whole ugly bunch of various temporary variables. Have
9835 ;; to declare them here since it's not possible to declare
9836 ;; a variable with only the scope of a cond test and the
9837 ;; following result clauses, and most of this function is a
9838 ;; single gigantic cond. :P
9839 literal char-before-ip before-ws-ip char-after-ip macro-start
9840 in-macro-expr c-syntactic-context placeholder c-in-literal-cache
9841 step-type tmpsymbol keyword injava-inher special-brace-list tmp-pos
9843 ;; The following record some positions for the containing
9844 ;; declaration block if we're directly within one:
9845 ;; `containing-decl-open' is the position of the open
9846 ;; brace. `containing-decl-start' is the start of the
9847 ;; declaration. `containing-decl-kwd' is the keyword
9848 ;; symbol of the keyword that tells what kind of block it
9850 containing-decl-open
9851 containing-decl-start
9853 ;; The open paren of the closest surrounding sexp or nil if
9856 ;; The position after the closest preceding brace sexp
9857 ;; (nested sexps are ignored), or the position after
9858 ;; `containing-sexp' if there is none, or (point-min) if
9859 ;; `containing-sexp' is nil.
9861 ;; The paren state outside `containing-sexp', or at
9862 ;; `indent-point' if `containing-sexp' is nil.
9863 (paren-state (c-parse-state))
9864 ;; There's always at most one syntactic element which got
9865 ;; an anchor pos. It's stored in syntactic-relpos.
9867 (c-stmt-delim-chars c-stmt-delim-chars))
9869 ;; Check if we're directly inside an enclosing declaration
9871 (when (and (setq containing-sexp
9872 (c-most-enclosing-brace paren-state))
9874 (goto-char containing-sexp)
9875 (eq (char-after) ?{))
9877 (c-looking-at-decl-block
9878 (c-most-enclosing-brace paren-state
9881 (setq containing-decl-open containing-sexp
9882 containing-decl-start (point)
9883 containing-sexp nil)
9884 (goto-char placeholder)
9885 (setq containing-decl-kwd (and (looking-at c-keywords-regexp)
9886 (c-keyword-sym (match-string 1)))))
9888 ;; Init some position variables.
9891 (setq containing-sexp (car paren-state)
9892 paren-state (cdr paren-state))
9893 (if (consp containing-sexp)
9895 (goto-char (cdr containing-sexp))
9896 (if (and (c-major-mode-is 'c++-mode)
9897 (c-back-over-member-initializer-braces))
9898 (c-syntactic-skip-backward "^}" nil t))
9901 ;; Ignore balanced paren. The next entry
9902 ;; can't be another one.
9903 (setq containing-sexp (car paren-state)
9904 paren-state (cdr paren-state))
9905 ;; If there is no surrounding open paren then
9906 ;; put the last balanced pair back on paren-state.
9907 (setq paren-state (cons containing-sexp paren-state)
9908 containing-sexp nil)))
9909 (setq lim (1+ containing-sexp))))
9910 (setq lim (point-min)))
9912 ;; If we're in a parenthesis list then ',' delimits the
9913 ;; "statements" rather than being an operator (with the
9914 ;; exception of the "for" clause). This difference is
9915 ;; typically only noticeable when statements are used in macro
9917 (when (and containing-sexp
9918 (eq (char-after containing-sexp) ?\())
9919 (setq c-stmt-delim-chars c-stmt-delim-chars-with-comma))
9920 ;; cache char before and after indent point, and move point to
9921 ;; the most likely position to perform the majority of tests
9922 (goto-char indent-point)
9923 (c-backward-syntactic-ws lim)
9924 (setq before-ws-ip (point)
9925 char-before-ip (char-before))
9926 (goto-char indent-point)
9927 (skip-chars-forward " \t")
9928 (setq char-after-ip (char-after))
9930 ;; are we in a literal?
9931 (setq literal (c-in-literal lim))
9933 ;; now figure out syntactic qualities of the current line
9936 ;; CASE 1: in a string.
9937 ((eq literal 'string)
9938 (c-add-syntax 'string (c-point 'bopl)))
9940 ;; CASE 2: in a C or C++ style comment.
9941 ((and (memq literal '(c c++))
9942 ;; This is a kludge for XEmacs where we use
9943 ;; `buffer-syntactic-context', which doesn't correctly
9944 ;; recognize "\*/" to end a block comment.
9945 ;; `parse-partial-sexp' which is used by
9946 ;; `c-literal-limits' will however do that in most
9947 ;; versions, which results in that we get nil from
9948 ;; `c-literal-limits' even when `c-in-literal' claims
9949 ;; we're inside a comment.
9950 (setq placeholder (c-literal-limits lim)))
9951 (c-add-syntax literal (car placeholder)))
9953 ;; CASE 3: in a cpp preprocessor macro continuation.
9954 ((and (save-excursion
9955 (when (c-beginning-of-macro)
9956 (setq macro-start (point))))
9957 (/= macro-start (c-point 'boi))
9959 (setq tmpsymbol 'cpp-macro-cont)
9960 (or (not c-syntactic-indentation-in-macros)
9962 (goto-char macro-start)
9963 ;; If at the beginning of the body of a #define
9964 ;; directive then analyze as cpp-define-intro
9965 ;; only. Go on with the syntactic analysis
9966 ;; otherwise. in-macro-expr is set if we're in a
9967 ;; cpp expression, i.e. before the #define body
9968 ;; or anywhere in a non-#define directive.
9969 (if (c-forward-to-cpp-define-body)
9970 (let ((indent-boi (c-point 'boi indent-point)))
9971 (setq in-macro-expr (> (point) indent-boi)
9972 tmpsymbol 'cpp-define-intro)
9973 (= (point) indent-boi))
9974 (setq in-macro-expr t)
9976 (c-add-syntax tmpsymbol macro-start)
9977 (setq macro-start nil))
9979 ;; CASE 11: an else clause?
9980 ((looking-at "else\\>[^_]")
9981 (c-beginning-of-statement-1 containing-sexp)
9982 (c-add-stmt-syntax 'else-clause nil t
9983 containing-sexp paren-state))
9985 ;; CASE 12: while closure of a do/while construct?
9986 ((and (looking-at "while\\>[^_]")
9988 (prog1 (eq (c-beginning-of-statement-1 containing-sexp)
9990 (setq placeholder (point)))))
9991 (goto-char placeholder)
9992 (c-add-stmt-syntax 'do-while-closure nil t
9993 containing-sexp paren-state))
9995 ;; CASE 13: A catch or finally clause? This case is simpler
9996 ;; than if-else and do-while, because a block is required
9997 ;; after every try, catch and finally.
9999 (and (cond ((c-major-mode-is 'c++-mode)
10000 (looking-at "catch\\>[^_]"))
10001 ((c-major-mode-is 'java-mode)
10002 (looking-at "\\(catch\\|finally\\)\\>[^_]")))
10003 (and (c-safe (c-backward-syntactic-ws)
10006 (eq (char-after) ?{)
10007 (c-safe (c-backward-syntactic-ws)
10010 (if (eq (char-after) ?\()
10011 (c-safe (c-backward-sexp) t)
10013 (looking-at "\\(try\\|catch\\)\\>[^_]")
10014 (setq placeholder (point))))
10015 (goto-char placeholder)
10016 (c-add-stmt-syntax 'catch-clause nil t
10017 containing-sexp paren-state))
10019 ;; CASE 18: A substatement we can recognize by keyword.
10021 (and c-opt-block-stmt-key
10022 (not (eq char-before-ip ?\;))
10023 (not (c-at-vsemi-p before-ws-ip))
10024 (not (memq char-after-ip '(?\) ?\] ?,)))
10025 (or (not (eq char-before-ip ?}))
10026 (c-looking-at-inexpr-block-backward c-state-cache))
10029 ;; Ought to cache the result from the
10030 ;; c-beginning-of-statement-1 calls here.
10031 (setq placeholder (point))
10032 (while (eq (setq step-type
10033 (c-beginning-of-statement-1 lim))
10035 (if (eq step-type 'previous)
10036 (goto-char placeholder)
10037 (setq placeholder (point))
10038 (if (and (eq step-type 'same)
10039 (not (looking-at c-opt-block-stmt-key)))
10040 ;; Step up to the containing statement if we
10041 ;; stayed in the same one.
10045 (c-beginning-of-statement-1 lim))
10048 (setq placeholder (point))
10049 ;; There was no containing statement after all.
10050 (goto-char placeholder)))))
10052 (if (looking-at c-block-stmt-2-key)
10053 ;; Require a parenthesis after these keywords.
10054 ;; Necessary to catch e.g. synchronized in Java,
10055 ;; which can be used both as statement and
10057 (and (zerop (c-forward-token-2 1 nil))
10058 (eq (char-after) ?\())
10059 (looking-at c-opt-block-stmt-key))))
10061 (if (eq step-type 'up)
10062 ;; CASE 18A: Simple substatement.
10064 (goto-char placeholder)
10066 ((eq char-after-ip ?{)
10067 (c-add-stmt-syntax 'substatement-open nil nil
10068 containing-sexp paren-state))
10070 (goto-char indent-point)
10071 (back-to-indentation)
10073 (c-add-stmt-syntax 'substatement-label nil nil
10074 containing-sexp paren-state))
10076 (c-add-stmt-syntax 'substatement nil nil
10077 containing-sexp paren-state))))
10079 ;; CASE 18B: Some other substatement. This is shared
10081 (c-guess-continued-construct indent-point
10087 ;; CASE 14: A case or default label
10089 (and (looking-at c-label-kwds-regexp)
10090 (or (c-major-mode-is 'idl-mode)
10093 (goto-char containing-sexp)
10094 (eq (char-after) ?{)
10095 (progn (c-backward-syntactic-ws) t)
10096 (eq (char-before) ?\))
10097 (c-go-list-backward)
10098 (progn (c-backward-syntactic-ws) t)
10099 (c-simple-skip-symbol-backward)
10100 (looking-at c-block-stmt-2-key)))))
10101 (if containing-sexp
10103 (goto-char containing-sexp)
10104 (setq lim (c-most-enclosing-brace c-state-cache
10106 (c-backward-to-block-anchor lim)
10107 (c-add-stmt-syntax 'case-label nil t lim paren-state))
10108 ;; Got a bogus label at the top level. In lack of better
10109 ;; alternatives, anchor it on (point-min).
10110 (c-add-syntax 'case-label (point-min))))
10112 ;; CASE 15: any other label
10114 (back-to-indentation)
10115 (and (not (looking-at c-syntactic-ws-start))
10116 (not (looking-at c-label-kwds-regexp))
10117 (c-forward-label)))
10118 (cond (containing-decl-open
10119 (setq placeholder (c-add-class-syntax 'inclass
10120 containing-decl-open
10121 containing-decl-start
10122 containing-decl-kwd
10124 ;; Append access-label with the same anchor point as
10126 (c-append-syntax 'access-label placeholder))
10129 (goto-char containing-sexp)
10130 (setq lim (c-most-enclosing-brace c-state-cache
10134 (if (and (eq (c-beginning-of-statement-1 lim) 'up)
10135 (looking-at "switch\\>[^_]"))
10136 ;; If the surrounding statement is a switch then
10137 ;; let's analyze all labels as switch labels, so
10138 ;; that they get lined up consistently.
10141 (c-backward-to-block-anchor lim)
10142 (c-add-stmt-syntax tmpsymbol nil t lim paren-state))
10145 ;; A label on the top level. Treat it as a class
10146 ;; context. (point-min) is the closest we get to the
10147 ;; class open brace.
10148 (c-add-syntax 'access-label (point-min)))))
10150 ;; CASE 4: In-expression statement. C.f. cases 7B, 16A and
10152 ((setq placeholder (c-looking-at-inexpr-block
10153 (c-safe-position containing-sexp paren-state)
10155 ;; Have to turn on the heuristics after
10156 ;; the point even though it doesn't work
10157 ;; very well. C.f. test case class-16.pike.
10159 (setq tmpsymbol (assq (car placeholder)
10160 '((inexpr-class . class-open)
10161 (inexpr-statement . block-open))))
10163 ;; It's a statement block or an anonymous class.
10164 (setq tmpsymbol (cdr tmpsymbol))
10165 ;; It's a Pike lambda. Check whether we are between the
10166 ;; lambda keyword and the argument list or at the defun
10168 (setq tmpsymbol (if (eq char-after-ip ?{)
10170 'lambda-intro-cont)))
10171 (goto-char (cdr placeholder))
10172 (back-to-indentation)
10173 (c-add-stmt-syntax tmpsymbol nil t
10174 (c-most-enclosing-brace c-state-cache (point))
10176 (unless (eq (point) (cdr placeholder))
10177 (c-add-syntax (car placeholder))))
10179 ;; CASE 5: Line is inside a declaration level block or at top level.
10180 ((or containing-decl-open (null containing-sexp))
10183 ;; CASE 5A: we are looking at a defun, brace list, class,
10184 ;; or inline-inclass method opening brace
10185 ((setq special-brace-list
10186 (or (and c-special-brace-lists
10187 (c-looking-at-special-brace-list))
10188 (eq char-after-ip ?{)))
10191 ;; CASE 5A.1: Non-class declaration block open.
10194 (and (eq char-after-ip ?{)
10195 (setq tmp (c-looking-at-decl-block containing-sexp t))
10197 (setq placeholder (point))
10199 (looking-at c-symbol-key))
10201 (c-keyword-sym (setq keyword (match-string 0)))
10202 'c-other-block-decl-kwds))))
10203 (goto-char placeholder)
10205 (if (string-equal keyword "extern")
10206 ;; Special case for extern-lang-open.
10208 (intern (concat keyword "-open")))
10209 nil t containing-sexp paren-state))
10211 ;; CASE 5A.2: we are looking at a class opening brace
10213 (goto-char indent-point)
10214 (skip-chars-forward " \t")
10215 (and (eq (char-after) ?{)
10216 (c-looking-at-decl-block containing-sexp t)
10217 (setq placeholder (point))))
10218 (c-add-syntax 'class-open placeholder))
10220 ;; CASE 5A.3: brace list open
10222 (c-beginning-of-decl-1 lim)
10223 (while (looking-at c-specifier-key)
10224 (goto-char (match-end 1))
10225 (c-forward-syntactic-ws indent-point))
10226 (setq placeholder (c-point 'boi))
10227 (or (consp special-brace-list)
10228 (and (or (save-excursion
10229 (goto-char indent-point)
10230 (setq tmpsymbol nil)
10231 (while (and (> (point) placeholder)
10232 (zerop (c-backward-token-2 1 t))
10233 (not (looking-at "=\\([^=]\\|$\\)")))
10234 (and c-opt-inexpr-brace-list-key
10236 (looking-at c-opt-inexpr-brace-list-key)
10237 (setq tmpsymbol 'topmost-intro-cont)))
10238 (looking-at "=\\([^=]\\|$\\)"))
10239 (looking-at c-brace-list-key))
10241 (while (and (< (point) indent-point)
10242 (zerop (c-forward-token-2 1 t))
10243 (not (memq (char-after) '(?\; ?\()))))
10244 (not (memq (char-after) '(?\; ?\()))
10246 (if (and (not c-auto-newline-analysis)
10247 (c-major-mode-is 'java-mode)
10248 (eq tmpsymbol 'topmost-intro-cont))
10249 ;; We're in Java and have found that the open brace
10250 ;; belongs to a "new Foo[]" initialization list,
10251 ;; which means the brace list is part of an
10252 ;; expression and not a top level definition. We
10253 ;; therefore treat it as any topmost continuation
10254 ;; even though the semantically correct symbol still
10255 ;; is brace-list-open, on the same grounds as in
10258 (c-beginning-of-statement-1 lim)
10259 (c-add-syntax 'topmost-intro-cont (c-point 'boi)))
10260 (c-add-syntax 'brace-list-open placeholder)))
10262 ;; CASE 5A.4: inline defun open
10263 ((and containing-decl-open
10264 (not (c-keyword-member containing-decl-kwd
10265 'c-other-block-decl-kwds)))
10266 (c-add-syntax 'inline-open)
10267 (c-add-class-syntax 'inclass
10268 containing-decl-open
10269 containing-decl-start
10270 containing-decl-kwd
10273 ;; CASE 5A.5: ordinary defun open
10276 (c-beginning-of-decl-1 lim)
10277 (while (looking-at c-specifier-key)
10278 (goto-char (match-end 1))
10279 (c-forward-syntactic-ws indent-point))
10280 (c-add-syntax 'defun-open (c-point 'boi))
10281 ;; Bogus to use bol here, but it's the legacy. (Resolved,
10285 ;; CASE 5R: Member init list. (Used to be part of CASE 5B.1)
10286 ;; Note there is no limit on the backward search here, since member
10287 ;; init lists can, in practice, be very large.
10289 (when (and (c-major-mode-is 'c++-mode)
10290 (setq placeholder (c-back-over-member-initializers)))
10291 (setq tmp-pos (point))))
10292 (if (= (c-point 'bosws) (1+ tmp-pos))
10294 ;; There is no preceding member init clause.
10295 ;; Indent relative to the beginning of indentation
10296 ;; for the topmost-intro line that contains the
10297 ;; prototype's open paren.
10298 (goto-char placeholder)
10299 (c-add-syntax 'member-init-intro (c-point 'boi)))
10300 ;; Indent relative to the first member init clause.
10301 (goto-char (1+ tmp-pos))
10302 (c-forward-syntactic-ws)
10303 (c-add-syntax 'member-init-cont (point))))
10305 ;; CASE 5B: After a function header but before the body (or
10306 ;; the ending semicolon if there's no body).
10308 (when (setq placeholder (c-just-after-func-arglist-p
10309 (max lim (c-determine-limit 500))))
10310 (setq tmp-pos (point))))
10313 ;; CASE 5B.1: Member init list.
10314 ((eq (char-after tmp-pos) ?:)
10315 ;; There is no preceding member init clause.
10316 ;; Indent relative to the beginning of indentation
10317 ;; for the topmost-intro line that contains the
10318 ;; prototype's open paren.
10319 (goto-char placeholder)
10320 (c-add-syntax 'member-init-intro (c-point 'boi)))
10322 ;; CASE 5B.2: K&R arg decl intro
10323 ((and c-recognize-knr-p
10324 (c-in-knr-argdecl lim))
10325 (c-beginning-of-statement-1 lim)
10326 (c-add-syntax 'knr-argdecl-intro (c-point 'boi))
10327 (if containing-decl-open
10328 (c-add-class-syntax 'inclass
10329 containing-decl-open
10330 containing-decl-start
10331 containing-decl-kwd
10334 ;; CASE 5B.4: Nether region after a C++ or Java func
10335 ;; decl, which could include a `throws' declaration.
10337 (c-beginning-of-statement-1 lim)
10338 (c-add-syntax 'func-decl-cont (c-point 'boi))
10341 ;; CASE 5C: inheritance line. could be first inheritance
10342 ;; line, or continuation of a multiple inheritance
10343 ((or (and (c-major-mode-is 'c++-mode)
10345 (when (eq char-after-ip ?,)
10346 (skip-chars-forward " \t")
10348 (looking-at c-opt-postfix-decl-spec-key)))
10349 (and (or (eq char-before-ip ?:)
10350 ;; watch out for scope operator
10352 (and (eq char-after-ip ?:)
10353 (c-safe (forward-char 1) t)
10354 (not (eq (char-after) ?:))
10357 (c-beginning-of-statement-1 lim)
10358 (when (looking-at c-opt-<>-sexp-key)
10359 (goto-char (match-end 1))
10360 (c-forward-syntactic-ws)
10361 (c-forward-<>-arglist nil)
10362 (c-forward-syntactic-ws))
10363 (looking-at c-class-key)))
10365 (and (c-major-mode-is 'java-mode)
10366 (let ((fence (save-excursion
10367 (c-beginning-of-statement-1 lim)
10372 (cond ((looking-at c-opt-postfix-decl-spec-key)
10373 (setq injava-inher (cons cont (point))
10375 ((or (not (c-safe (c-forward-sexp -1) t))
10376 (<= (point) fence))
10381 (not (c-crosses-statement-barrier-p (cdr injava-inher)
10386 ;; CASE 5C.1: non-hanging colon on an inher intro
10387 ((eq char-after-ip ?:)
10388 (c-beginning-of-statement-1 lim)
10389 (c-add-syntax 'inher-intro (c-point 'boi))
10390 ;; don't add inclass symbol since relative point already
10391 ;; contains any class offset
10394 ;; CASE 5C.2: hanging colon on an inher intro
10395 ((eq char-before-ip ?:)
10396 (c-beginning-of-statement-1 lim)
10397 (c-add-syntax 'inher-intro (c-point 'boi))
10398 (if containing-decl-open
10399 (c-add-class-syntax 'inclass
10400 containing-decl-open
10401 containing-decl-start
10402 containing-decl-kwd
10405 ;; CASE 5C.3: in a Java implements/extends
10407 (let ((where (cdr injava-inher))
10408 (cont (car injava-inher)))
10410 (cond ((looking-at "throws\\>[^_]")
10411 (c-add-syntax 'func-decl-cont
10412 (progn (c-beginning-of-statement-1 lim)
10414 (cont (c-add-syntax 'inher-cont where))
10415 (t (c-add-syntax 'inher-intro
10416 (progn (goto-char (cdr injava-inher))
10417 (c-beginning-of-statement-1 lim)
10421 ;; CASE 5C.4: a continued inheritance line
10423 (c-beginning-of-inheritance-list lim)
10424 (c-add-syntax 'inher-cont (point))
10425 ;; don't add inclass symbol since relative point already
10426 ;; contains any class offset
10429 ;; CASE 5P: AWK pattern or function or continuation
10431 ((c-major-mode-is 'awk-mode)
10432 (setq placeholder (point))
10434 (if (and (eq (c-beginning-of-statement-1) 'same)
10435 (/= (point) placeholder))
10436 'topmost-intro-cont
10439 containing-sexp paren-state))
10441 ;; CASE 5D: this could be a top-level initialization, a
10442 ;; member init list continuation, or a template argument
10443 ;; list continuation.
10445 ;; Note: We use the fact that lim is always after any
10446 ;; preceding brace sexp.
10447 (if c-recognize-<>-arglists
10450 (c-syntactic-skip-backward "^;,=<>" lim t)
10453 (when c-overloadable-operators-regexp
10454 (when (setq placeholder (c-after-special-operator-id lim))
10455 (goto-char placeholder)
10458 ((eq (char-before) ?>)
10459 (or (c-backward-<>-arglist nil lim)
10462 ((eq (char-before) ?<)
10464 (if (save-excursion
10465 (c-forward-<>-arglist nil))
10466 (progn (forward-char)
10470 ;; NB: No c-after-special-operator-id stuff in this
10471 ;; clause - we assume only C++ needs it.
10472 (c-syntactic-skip-backward "^;,=" lim t))
10473 (memq (char-before) '(?, ?= ?<)))
10476 ;; CASE 5D.3: perhaps a template list continuation?
10477 ((and (c-major-mode-is 'c++-mode)
10480 (c-with-syntax-table c++-template-syntax-table
10481 (goto-char indent-point)
10482 (setq placeholder (c-up-list-backward))
10484 (eq (char-after placeholder) ?<))))))
10485 (c-with-syntax-table c++-template-syntax-table
10486 (goto-char placeholder)
10487 (c-beginning-of-statement-1 lim t))
10488 (if (save-excursion
10489 (c-backward-syntactic-ws lim)
10490 (eq (char-before) ?<))
10491 ;; In a nested template arglist.
10493 (goto-char placeholder)
10494 (c-syntactic-skip-backward "^,;" lim t)
10495 (c-forward-syntactic-ws))
10496 (back-to-indentation))
10497 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
10499 (c-add-syntax 'template-args-cont (point) placeholder))
10501 ;; CASE 5D.4: perhaps a multiple inheritance line?
10502 ((and (c-major-mode-is 'c++-mode)
10504 (c-beginning-of-statement-1 lim)
10505 (setq placeholder (point))
10506 (if (looking-at "static\\>[^_]")
10507 (c-forward-token-2 1 nil indent-point))
10508 (and (looking-at c-class-key)
10509 (zerop (c-forward-token-2 2 nil indent-point))
10510 (if (eq (char-after) ?<)
10511 (c-with-syntax-table c++-template-syntax-table
10512 (zerop (c-forward-token-2 1 t indent-point)))
10514 (eq (char-after) ?:))))
10515 (goto-char placeholder)
10516 (c-add-syntax 'inher-cont (c-point 'boi)))
10518 ;; CASE 5D.5: Continuation of the "expression part" of a
10519 ;; top level construct. Or, perhaps, an unrecognized construct.
10521 (while (and (setq placeholder (point))
10522 (eq (car (c-beginning-of-decl-1 containing-sexp)) ; Can't use `lim' here.
10525 (c-backward-syntactic-ws)
10526 (eq (char-before) ?}))
10527 (< (point) placeholder)))
10530 ((eq (point) placeholder) 'statement) ; unrecognized construct
10531 ;; A preceding comma at the top level means that a
10532 ;; new variable declaration starts here. Use
10533 ;; topmost-intro-cont for it, for consistency with
10534 ;; the first variable declaration. C.f. case 5N.
10535 ((eq char-before-ip ?,) 'topmost-intro-cont)
10536 (t 'statement-cont))
10537 nil nil containing-sexp paren-state))
10540 ;; CASE 5F: Close of a non-class declaration level block.
10541 ((and (eq char-after-ip ?})
10542 (c-keyword-member containing-decl-kwd
10543 'c-other-block-decl-kwds))
10544 ;; This is inconsistent: Should use `containing-decl-open'
10545 ;; here if it's at boi, like in case 5J.
10546 (goto-char containing-decl-start)
10548 (if (string-equal (symbol-name containing-decl-kwd) "extern")
10549 ;; Special case for compatibility with the
10550 ;; extern-lang syntactic symbols.
10552 (intern (concat (symbol-name containing-decl-kwd)
10555 (c-most-enclosing-brace paren-state (point))
10558 ;; CASE 5G: we are looking at the brace which closes the
10559 ;; enclosing nested class decl
10560 ((and containing-sexp
10561 (eq char-after-ip ?})
10562 (eq containing-decl-open containing-sexp))
10563 (c-add-class-syntax 'class-close
10564 containing-decl-open
10565 containing-decl-start
10566 containing-decl-kwd
10569 ;; CASE 5H: we could be looking at subsequent knr-argdecls
10570 ((and c-recognize-knr-p
10571 (not containing-sexp) ; can't be knr inside braces.
10572 (not (eq char-before-ip ?}))
10574 (setq placeholder (cdr (c-beginning-of-decl-1 lim)))
10576 ;; Do an extra check to avoid tripping up on
10577 ;; statements that occur in invalid contexts
10578 ;; (e.g. in macro bodies where we don't really
10579 ;; know the context of what we're looking at).
10580 (not (and c-opt-block-stmt-key
10581 (looking-at c-opt-block-stmt-key)))))
10582 (< placeholder indent-point))
10583 (goto-char placeholder)
10584 (c-add-syntax 'knr-argdecl (point)))
10586 ;; CASE 5I: ObjC method definition.
10587 ((and c-opt-method-key
10588 (looking-at c-opt-method-key))
10589 (c-beginning-of-statement-1 nil t)
10590 (if (= (point) indent-point)
10591 ;; Handle the case when it's the first (non-comment)
10592 ;; thing in the buffer. Can't look for a 'same return
10593 ;; value from cbos1 since ObjC directives currently
10594 ;; aren't recognized fully, so that we get 'same
10595 ;; instead of 'previous if it moved over a preceding
10597 (goto-char (point-min)))
10598 (c-add-syntax 'objc-method-intro (c-point 'boi)))
10600 ;; CASE 5N: At a variable declaration that follows a class
10601 ;; definition or some other block declaration that doesn't
10602 ;; end at the closing '}'. C.f. case 5D.5.
10604 (c-backward-syntactic-ws lim)
10605 (and (eq (char-before) ?})
10607 (let ((start (point)))
10608 (if (and c-state-cache
10609 (consp (car c-state-cache))
10610 (eq (cdar c-state-cache) (point)))
10611 ;; Speed up the backward search a bit.
10612 (goto-char (caar c-state-cache)))
10613 (c-beginning-of-decl-1 containing-sexp) ; Can't use `lim' here.
10614 (setq placeholder (point))
10615 (if (= start (point))
10616 ;; The '}' is unbalanced.
10619 (>= (point) indent-point))))))
10620 (goto-char placeholder)
10621 (c-add-stmt-syntax 'topmost-intro-cont nil nil
10622 containing-sexp paren-state))
10624 ;; NOTE: The point is at the end of the previous token here.
10626 ;; CASE 5J: we are at the topmost level, make
10627 ;; sure we skip back past any access specifiers
10629 ;; A macro continuation line is never at top level.
10630 (not (and macro-start
10631 (> indent-point macro-start)))
10633 (setq placeholder (point))
10634 (or (memq char-before-ip '(?\; ?{ ?} nil))
10635 (c-at-vsemi-p before-ws-ip)
10636 (when (and (eq char-before-ip ?:)
10637 (eq (c-beginning-of-statement-1 lim)
10639 (c-backward-syntactic-ws lim)
10640 (setq placeholder (point)))
10641 (and (c-major-mode-is 'objc-mode)
10642 (catch 'not-in-directive
10643 (c-beginning-of-statement-1 lim)
10644 (setq placeholder (point))
10645 (while (and (c-forward-objc-directive)
10646 (< (point) indent-point))
10647 (c-forward-syntactic-ws)
10648 (if (>= (point) indent-point)
10649 (throw 'not-in-directive t))
10650 (setq placeholder (point)))
10652 ;; For historic reasons we anchor at bol of the last
10653 ;; line of the previous declaration. That's clearly
10654 ;; highly bogus and useless, and it makes our lives hard
10655 ;; to remain compatible. :P
10656 (goto-char placeholder)
10657 (c-add-syntax 'topmost-intro (c-point 'bol))
10658 (if containing-decl-open
10659 (if (c-keyword-member containing-decl-kwd
10660 'c-other-block-decl-kwds)
10662 (goto-char (c-brace-anchor-point containing-decl-open))
10664 (if (string-equal (symbol-name containing-decl-kwd)
10666 ;; Special case for compatibility with the
10667 ;; extern-lang syntactic symbols.
10669 (intern (concat "in"
10670 (symbol-name containing-decl-kwd))))
10672 (c-most-enclosing-brace paren-state (point))
10674 (c-add-class-syntax 'inclass
10675 containing-decl-open
10676 containing-decl-start
10677 containing-decl-kwd
10679 (when (and c-syntactic-indentation-in-macros
10681 (/= macro-start (c-point 'boi indent-point)))
10682 (c-add-syntax 'cpp-define-intro)
10683 (setq macro-start nil)))
10685 ;; CASE 5K: we are at an ObjC method definition
10686 ;; continuation line.
10687 ((and c-opt-method-key
10689 (c-beginning-of-statement-1 lim)
10690 (beginning-of-line)
10691 (when (looking-at c-opt-method-key)
10692 (setq placeholder (point)))))
10693 (c-add-syntax 'objc-method-args-cont placeholder))
10695 ;; CASE 5L: we are at the first argument of a template
10696 ;; arglist that begins on the previous line.
10697 ((and c-recognize-<>-arglists
10698 (eq (char-before) ?<)
10699 (not (and c-overloadable-operators-regexp
10700 (c-after-special-operator-id lim))))
10701 (c-beginning-of-statement-1 (c-safe-position (point) paren-state))
10702 (c-add-syntax 'template-args-cont (c-point 'boi)))
10704 ;; CASE 5Q: we are at a statement within a macro.
10706 (c-beginning-of-statement-1 containing-sexp)
10707 (c-add-stmt-syntax 'statement nil t containing-sexp paren-state))
10709 ;;CASE 5N: We are at a topmost continuation line and the only
10710 ;;preceding items are annotations.
10711 ((and (c-major-mode-is 'java-mode)
10712 (setq placeholder (point))
10713 (c-beginning-of-statement-1)
10715 (while (and (c-forward-annotation))
10716 (c-forward-syntactic-ws))
10719 (>= (point) placeholder)
10720 (goto-char placeholder)))
10721 (c-add-syntax 'annotation-top-cont (c-point 'boi)))
10723 ;; CASE 5M: we are at a topmost continuation line
10725 (c-beginning-of-statement-1 (c-safe-position (point) paren-state))
10726 (when (c-major-mode-is 'objc-mode)
10727 (setq placeholder (point))
10728 (while (and (c-forward-objc-directive)
10729 (< (point) indent-point))
10730 (c-forward-syntactic-ws)
10731 (setq placeholder (point)))
10732 (goto-char placeholder))
10733 (c-add-syntax 'topmost-intro-cont (c-point 'boi)))
10736 ;; (CASE 6 has been removed.)
10738 ;; CASE 7: line is an expression, not a statement. Most
10739 ;; likely we are either in a function prototype or a function
10740 ;; call argument list
10741 ((not (or (and c-special-brace-lists
10743 (goto-char containing-sexp)
10744 (c-looking-at-special-brace-list)))
10745 (eq (char-after containing-sexp) ?{)))
10748 ;; CASE 7A: we are looking at the arglist closing paren.
10750 ((memq char-after-ip '(?\) ?\]))
10751 (goto-char containing-sexp)
10752 (setq placeholder (c-point 'boi))
10753 (if (and (c-safe (backward-up-list 1) t)
10754 (>= (point) placeholder))
10757 (skip-chars-forward " \t"))
10758 (goto-char placeholder))
10759 (c-add-stmt-syntax 'arglist-close (list containing-sexp) t
10760 (c-most-enclosing-brace paren-state (point))
10763 ;; CASE 7B: Looking at the opening brace of an
10764 ;; in-expression block or brace list. C.f. cases 4, 16A
10766 ((and (eq char-after-ip ?{)
10768 (setq placeholder (c-inside-bracelist-p (point)
10771 (setq tmpsymbol '(brace-list-open . inexpr-class))
10772 (setq tmpsymbol '(block-open . inexpr-statement)
10774 (cdr-safe (c-looking-at-inexpr-block
10775 (c-safe-position containing-sexp
10778 ;; placeholder is nil if it's a block directly in
10779 ;; a function arglist. That makes us skip out of
10782 (goto-char placeholder)
10783 (back-to-indentation)
10784 (c-add-stmt-syntax (car tmpsymbol) nil t
10785 (c-most-enclosing-brace paren-state (point))
10787 (if (/= (point) placeholder)
10788 (c-add-syntax (cdr tmpsymbol))))
10790 ;; CASE 7C: we are looking at the first argument in an empty
10791 ;; argument list. Use arglist-close if we're actually
10792 ;; looking at a close paren or bracket.
10793 ((memq char-before-ip '(?\( ?\[))
10794 (goto-char containing-sexp)
10795 (setq placeholder (c-point 'boi))
10796 (if (and (c-safe (backward-up-list 1) t)
10797 (>= (point) placeholder))
10800 (skip-chars-forward " \t"))
10801 (goto-char placeholder))
10802 (c-add-stmt-syntax 'arglist-intro (list containing-sexp) t
10803 (c-most-enclosing-brace paren-state (point))
10806 ;; CASE 7D: we are inside a conditional test clause. treat
10807 ;; these things as statements
10809 (goto-char containing-sexp)
10810 (and (c-safe (c-forward-sexp -1) t)
10811 (looking-at "\\<for\\>[^_]")))
10812 (goto-char (1+ containing-sexp))
10813 (c-forward-syntactic-ws indent-point)
10814 (if (eq char-before-ip ?\;)
10815 (c-add-syntax 'statement (point))
10816 (c-add-syntax 'statement-cont (point))
10819 ;; CASE 7E: maybe a continued ObjC method call. This is the
10820 ;; case when we are inside a [] bracketed exp, and what
10821 ;; precede the opening bracket is not an identifier.
10822 ((and c-opt-method-key
10823 (eq (char-after containing-sexp) ?\[)
10825 (goto-char (1- containing-sexp))
10826 (c-backward-syntactic-ws (c-point 'bod))
10827 (if (not (looking-at c-symbol-key))
10828 (c-add-syntax 'objc-method-call-cont containing-sexp))
10831 ;; CASE 7F: we are looking at an arglist continuation line,
10832 ;; but the preceding argument is on the same line as the
10833 ;; opening paren. This case includes multi-line
10834 ;; mathematical paren groupings, but we could be on a
10835 ;; for-list continuation line. C.f. case 7A.
10837 (goto-char (1+ containing-sexp))
10839 (c-forward-syntactic-ws)
10842 (goto-char containing-sexp) ; paren opening the arglist
10843 (setq placeholder (c-point 'boi))
10844 (if (and (c-safe (backward-up-list 1) t)
10845 (>= (point) placeholder))
10848 (skip-chars-forward " \t"))
10849 (goto-char placeholder))
10850 (c-add-stmt-syntax 'arglist-cont-nonempty (list containing-sexp) t
10851 (c-most-enclosing-brace c-state-cache (point))
10854 ;; CASE 7G: we are looking at just a normal arglist
10855 ;; continuation line
10856 (t (c-forward-syntactic-ws indent-point)
10857 (c-add-syntax 'arglist-cont (c-point 'boi)))
10860 ;; CASE 8: func-local multi-inheritance line
10861 ((and (c-major-mode-is 'c++-mode)
10863 (goto-char indent-point)
10864 (skip-chars-forward " \t")
10865 (looking-at c-opt-postfix-decl-spec-key)))
10866 (goto-char indent-point)
10867 (skip-chars-forward " \t")
10870 ;; CASE 8A: non-hanging colon on an inher intro
10871 ((eq char-after-ip ?:)
10872 (c-backward-syntactic-ws lim)
10873 (c-add-syntax 'inher-intro (c-point 'boi)))
10875 ;; CASE 8B: hanging colon on an inher intro
10876 ((eq char-before-ip ?:)
10877 (c-add-syntax 'inher-intro (c-point 'boi)))
10879 ;; CASE 8C: a continued inheritance line
10881 (c-beginning-of-inheritance-list lim)
10882 (c-add-syntax 'inher-cont (point))
10885 ;; CASE 9: we are inside a brace-list
10886 ((and (not (c-major-mode-is 'awk-mode)) ; Maybe this isn't needed (ACM, 2002/3/29)
10887 (setq special-brace-list
10888 (or (and c-special-brace-lists ;;;; ALWAYS NIL FOR AWK!!
10890 (goto-char containing-sexp)
10891 (c-looking-at-special-brace-list)))
10892 (c-inside-bracelist-p containing-sexp paren-state))))
10895 ;; CASE 9A: In the middle of a special brace list opener.
10896 ((and (consp special-brace-list)
10898 (goto-char containing-sexp)
10899 (eq (char-after) ?\())
10900 (eq char-after-ip (car (cdr special-brace-list))))
10901 (goto-char (car (car special-brace-list)))
10902 (skip-chars-backward " \t")
10904 (assoc 'statement-cont
10905 (setq placeholder (c-guess-basic-syntax))))
10906 (setq c-syntactic-context placeholder)
10907 (c-beginning-of-statement-1
10908 (c-safe-position (1- containing-sexp) paren-state))
10909 (c-forward-token-2 0)
10910 (while (looking-at c-specifier-key)
10911 (goto-char (match-end 1))
10912 (c-forward-syntactic-ws))
10913 (c-add-syntax 'brace-list-open (c-point 'boi))))
10915 ;; CASE 9B: brace-list-close brace
10916 ((if (consp special-brace-list)
10917 ;; Check special brace list closer.
10919 (goto-char (car (car special-brace-list)))
10921 (goto-char indent-point)
10922 (back-to-indentation)
10924 ;; We were between the special close char and the `)'.
10925 (and (eq (char-after) ?\))
10926 (eq (1+ (point)) (cdr (car special-brace-list))))
10927 ;; We were before the special close char.
10928 (and (eq (char-after) (cdr (cdr special-brace-list)))
10929 (zerop (c-forward-token-2))
10930 (eq (1+ (point)) (cdr (car special-brace-list)))))))
10931 ;; Normal brace list check.
10932 (and (eq char-after-ip ?})
10933 (c-safe (goto-char (c-up-list-backward (point))) t)
10934 (= (point) containing-sexp)))
10935 (if (eq (point) (c-point 'boi))
10936 (c-add-syntax 'brace-list-close (point))
10937 (setq lim (c-most-enclosing-brace c-state-cache (point)))
10938 (c-beginning-of-statement-1 lim nil nil t)
10939 (c-add-stmt-syntax 'brace-list-close nil t lim paren-state)))
10942 ;; Prepare for the rest of the cases below by going to the
10943 ;; token following the opening brace
10944 (if (consp special-brace-list)
10946 (goto-char (car (car special-brace-list)))
10947 (c-forward-token-2 1 nil indent-point))
10948 (goto-char containing-sexp))
10950 (let ((start (point)))
10951 (c-forward-syntactic-ws indent-point)
10952 (goto-char (max start (c-point 'bol))))
10953 (c-skip-ws-forward indent-point)
10956 ;; CASE 9C: we're looking at the first line in a brace-list
10957 ((= (point) indent-point)
10958 (if (consp special-brace-list)
10959 (goto-char (car (car special-brace-list)))
10960 (goto-char containing-sexp))
10961 (if (eq (point) (c-point 'boi))
10962 (c-add-syntax 'brace-list-intro (point))
10963 (setq lim (c-most-enclosing-brace c-state-cache (point)))
10964 (c-beginning-of-statement-1 lim)
10965 (c-add-stmt-syntax 'brace-list-intro nil t lim paren-state)))
10967 ;; CASE 9D: this is just a later brace-list-entry or
10968 ;; brace-entry-open
10969 (t (if (or (eq char-after-ip ?{)
10970 (and c-special-brace-lists
10972 (goto-char indent-point)
10973 (c-forward-syntactic-ws (c-point 'eol))
10974 (c-looking-at-special-brace-list (point)))))
10975 (c-add-syntax 'brace-entry-open (point))
10976 (c-add-syntax 'brace-list-entry (point))
10980 ;; CASE 10: A continued statement or top level construct.
10981 ((and (not (memq char-before-ip '(?\; ?:)))
10982 (not (c-at-vsemi-p before-ws-ip))
10983 (or (not (eq char-before-ip ?}))
10984 (c-looking-at-inexpr-block-backward c-state-cache))
10987 (c-beginning-of-statement-1 containing-sexp)
10988 (setq placeholder (point))))
10989 (/= placeholder containing-sexp))
10990 ;; This is shared with case 18.
10991 (c-guess-continued-construct indent-point
10997 ;; CASE 16: block close brace, possibly closing the defun or
10999 ((eq char-after-ip ?})
11000 ;; From here on we have the next containing sexp in lim.
11001 (setq lim (c-most-enclosing-brace paren-state))
11002 (goto-char containing-sexp)
11005 ;; CASE 16E: Closing a statement block? This catches
11006 ;; cases where it's preceded by a statement keyword,
11007 ;; which works even when used in an "invalid" context,
11008 ;; e.g. a macro argument.
11009 ((c-after-conditional)
11010 (c-backward-to-block-anchor lim)
11011 (c-add-stmt-syntax 'block-close nil t lim paren-state))
11013 ;; CASE 16A: closing a lambda defun or an in-expression
11014 ;; block? C.f. cases 4, 7B and 17E.
11015 ((setq placeholder (c-looking-at-inexpr-block
11016 (c-safe-position containing-sexp paren-state)
11018 (setq tmpsymbol (if (eq (car placeholder) 'inlambda)
11021 (goto-char containing-sexp)
11022 (back-to-indentation)
11023 (if (= containing-sexp (point))
11024 (c-add-syntax tmpsymbol (point))
11025 (goto-char (cdr placeholder))
11026 (back-to-indentation)
11027 (c-add-stmt-syntax tmpsymbol nil t
11028 (c-most-enclosing-brace paren-state (point))
11030 (if (/= (point) (cdr placeholder))
11031 (c-add-syntax (car placeholder)))))
11033 ;; CASE 16B: does this close an inline or a function in
11034 ;; a non-class declaration level block?
11039 (c-looking-at-decl-block
11040 (c-most-enclosing-brace paren-state lim)
11042 (setq placeholder (point))))
11043 (c-backward-to-decl-anchor lim)
11044 (back-to-indentation)
11045 (if (save-excursion
11046 (goto-char placeholder)
11047 (looking-at c-other-decl-block-key))
11048 (c-add-syntax 'defun-close (point))
11049 (c-add-syntax 'inline-close (point))))
11051 ;; CASE 16F: Can be a defun-close of a function declared
11052 ;; in a statement block, e.g. in Pike or when using gcc
11053 ;; extensions, but watch out for macros followed by
11054 ;; blocks. Let it through to be handled below.
11055 ;; C.f. cases B.3 and 17G.
11057 (and (not (c-at-statement-start-p))
11058 (eq (c-beginning-of-statement-1 lim nil nil t) 'same)
11059 (setq placeholder (point))
11060 (let ((c-recognize-typeless-decls nil))
11061 ;; Turn off recognition of constructs that
11062 ;; lacks a type in this case, since that's more
11063 ;; likely to be a macro followed by a block.
11064 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
11065 (back-to-indentation)
11066 (if (/= (point) containing-sexp)
11067 (goto-char placeholder))
11068 (c-add-stmt-syntax 'defun-close nil t lim paren-state))
11070 ;; CASE 16C: If there is an enclosing brace then this is
11071 ;; a block close since defun closes inside declaration
11072 ;; level blocks have been handled above.
11074 ;; If the block is preceded by a case/switch label on
11075 ;; the same line, we anchor at the first preceding label
11076 ;; at boi. The default handling in c-add-stmt-syntax
11077 ;; really fixes it better, but we do like this to keep
11078 ;; the indentation compatible with version 5.28 and
11079 ;; earlier. C.f. case 17H.
11080 (while (and (/= (setq placeholder (point)) (c-point 'boi))
11081 (eq (c-beginning-of-statement-1 lim) 'label)))
11082 (goto-char placeholder)
11083 (if (looking-at c-label-kwds-regexp)
11084 (c-add-syntax 'block-close (point))
11085 (goto-char containing-sexp)
11086 ;; c-backward-to-block-anchor not necessary here; those
11087 ;; situations are handled in case 16E above.
11088 (c-add-stmt-syntax 'block-close nil t lim paren-state)))
11090 ;; CASE 16D: Only top level defun close left.
11092 (goto-char containing-sexp)
11093 (c-backward-to-decl-anchor lim)
11094 (c-add-stmt-syntax 'defun-close nil nil
11095 (c-most-enclosing-brace paren-state)
11099 ;; CASE 19: line is an expression, not a statement, and is directly
11100 ;; contained by a template delimiter. Most likely, we are in a
11101 ;; template arglist within a statement. This case is based on CASE
11102 ;; 7. At some point in the future, we may wish to create more
11103 ;; syntactic symbols such as `template-intro',
11104 ;; `template-cont-nonempty', etc., and distinguish between them as we
11105 ;; do for `arglist-intro' etc. (2009-12-07).
11106 ((and c-recognize-<>-arglists
11107 (setq containing-< (c-up-list-backward indent-point containing-sexp))
11108 (eq (char-after containing-<) ?\<))
11109 (setq placeholder (c-point 'boi containing-<))
11110 (goto-char containing-sexp) ; Most nested Lbrace/Lparen (but not
11111 ; '<') before indent-point.
11112 (if (>= (point) placeholder)
11115 (skip-chars-forward " \t"))
11116 (goto-char placeholder))
11117 (c-add-stmt-syntax 'template-args-cont (list containing-<) t
11118 (c-most-enclosing-brace c-state-cache (point))
11121 ;; CASE 17: Statement or defun catchall.
11123 (goto-char indent-point)
11124 ;; Back up statements until we find one that starts at boi.
11125 (while (let* ((prev-point (point))
11126 (last-step-type (c-beginning-of-statement-1
11128 (if (= (point) prev-point)
11130 (setq step-type (or step-type last-step-type))
11132 (setq step-type last-step-type)
11133 (/= (point) (c-point 'boi)))))
11136 ;; CASE 17B: continued statement
11137 ((and (eq step-type 'same)
11138 (/= (point) indent-point))
11139 (c-add-stmt-syntax 'statement-cont nil nil
11140 containing-sexp paren-state))
11142 ;; CASE 17A: After a case/default label?
11144 (while (and (eq step-type 'label)
11145 (not (looking-at c-label-kwds-regexp)))
11147 (c-beginning-of-statement-1 containing-sexp)))
11148 (eq step-type 'label))
11149 (c-add-stmt-syntax (if (eq char-after-ip ?{)
11150 'statement-case-open
11151 'statement-case-intro)
11152 nil t containing-sexp paren-state))
11154 ;; CASE 17D: any old statement
11156 (while (eq step-type 'label)
11158 (c-beginning-of-statement-1 containing-sexp)))
11159 (eq step-type 'previous))
11160 (c-add-stmt-syntax 'statement nil t
11161 containing-sexp paren-state)
11162 (if (eq char-after-ip ?{)
11163 (c-add-syntax 'block-open)))
11165 ;; CASE 17I: Inside a substatement block.
11167 ;; The following tests are all based on containing-sexp.
11168 (goto-char containing-sexp)
11169 ;; From here on we have the next containing sexp in lim.
11170 (setq lim (c-most-enclosing-brace paren-state containing-sexp))
11171 (c-after-conditional))
11172 (c-backward-to-block-anchor lim)
11173 (c-add-stmt-syntax 'statement-block-intro nil t
11175 (if (eq char-after-ip ?{)
11176 (c-add-syntax 'block-open)))
11178 ;; CASE 17E: first statement in an in-expression block.
11179 ;; C.f. cases 4, 7B and 16A.
11180 ((setq placeholder (c-looking-at-inexpr-block
11181 (c-safe-position containing-sexp paren-state)
11183 (setq tmpsymbol (if (eq (car placeholder) 'inlambda)
11185 'statement-block-intro))
11186 (back-to-indentation)
11187 (if (= containing-sexp (point))
11188 (c-add-syntax tmpsymbol (point))
11189 (goto-char (cdr placeholder))
11190 (back-to-indentation)
11191 (c-add-stmt-syntax tmpsymbol nil t
11192 (c-most-enclosing-brace c-state-cache (point))
11194 (if (/= (point) (cdr placeholder))
11195 (c-add-syntax (car placeholder))))
11196 (if (eq char-after-ip ?{)
11197 (c-add-syntax 'block-open)))
11199 ;; CASE 17F: first statement in an inline, or first
11200 ;; statement in a top-level defun. we can tell this is it
11201 ;; if there are no enclosing braces that haven't been
11202 ;; narrowed out by a class (i.e. don't use bod here).
11204 (or (not (setq placeholder (c-most-enclosing-brace
11207 (goto-char placeholder)
11208 (eq (char-after) ?{))
11209 (c-looking-at-decl-block (c-most-enclosing-brace
11210 paren-state (point))
11212 (c-backward-to-decl-anchor lim)
11213 (back-to-indentation)
11214 (c-add-syntax 'defun-block-intro (point)))
11216 ;; CASE 17G: First statement in a function declared inside
11217 ;; a normal block. This can occur in Pike and with
11218 ;; e.g. the gcc extensions, but watch out for macros
11219 ;; followed by blocks. C.f. cases B.3 and 16F.
11221 (and (not (c-at-statement-start-p))
11222 (eq (c-beginning-of-statement-1 lim nil nil t) 'same)
11223 (setq placeholder (point))
11224 (let ((c-recognize-typeless-decls nil))
11225 ;; Turn off recognition of constructs that lacks
11226 ;; a type in this case, since that's more likely
11227 ;; to be a macro followed by a block.
11228 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
11229 (back-to-indentation)
11230 (if (/= (point) containing-sexp)
11231 (goto-char placeholder))
11232 (c-add-stmt-syntax 'defun-block-intro nil t
11235 ;; CASE 17H: First statement in a block.
11237 ;; If the block is preceded by a case/switch label on the
11238 ;; same line, we anchor at the first preceding label at
11239 ;; boi. The default handling in c-add-stmt-syntax is
11240 ;; really fixes it better, but we do like this to keep the
11241 ;; indentation compatible with version 5.28 and earlier.
11243 (while (and (/= (setq placeholder (point)) (c-point 'boi))
11244 (eq (c-beginning-of-statement-1 lim) 'label)))
11245 (goto-char placeholder)
11246 (if (looking-at c-label-kwds-regexp)
11247 (c-add-syntax 'statement-block-intro (point))
11248 (goto-char containing-sexp)
11249 ;; c-backward-to-block-anchor not necessary here; those
11250 ;; situations are handled in case 17I above.
11251 (c-add-stmt-syntax 'statement-block-intro nil t
11253 (if (eq char-after-ip ?{)
11254 (c-add-syntax 'block-open)))
11258 ;; now we need to look at any modifiers
11259 (goto-char indent-point)
11260 (skip-chars-forward " \t")
11262 ;; are we looking at a comment only line?
11263 (when (and (looking-at c-comment-start-regexp)
11264 (/= (c-forward-token-2 0 nil (c-point 'eol)) 0))
11265 (c-append-syntax 'comment-intro))
11267 ;; we might want to give additional offset to friends (in C++).
11268 (when (and c-opt-friend-key
11269 (looking-at c-opt-friend-key))
11270 (c-append-syntax 'friend))
11272 ;; Set syntactic-relpos.
11273 (let ((p c-syntactic-context))
11275 (if (integerp (c-langelem-pos (car p)))
11277 (setq syntactic-relpos (c-langelem-pos (car p)))
11282 ;; Start of or a continuation of a preprocessor directive?
11283 (if (and macro-start
11284 (eq macro-start (c-point 'boi))
11285 (not (and (c-major-mode-is 'pike-mode)
11286 (eq (char-after (1+ macro-start)) ?\"))))
11287 (c-append-syntax 'cpp-macro)
11288 (when (and c-syntactic-indentation-in-macros macro-start)
11291 (< syntactic-relpos macro-start)
11293 (assq 'arglist-intro c-syntactic-context)
11294 (assq 'arglist-cont c-syntactic-context)
11295 (assq 'arglist-cont-nonempty c-syntactic-context)
11296 (assq 'arglist-close c-syntactic-context))))
11297 ;; If inside a cpp expression, i.e. anywhere in a
11298 ;; cpp directive except a #define body, we only let
11299 ;; through the syntactic analysis that is internal
11300 ;; in the expression. That means the arglist
11301 ;; elements, if they are anchored inside the cpp
11303 (setq c-syntactic-context nil)
11304 (c-add-syntax 'cpp-macro-cont macro-start))
11305 (when (and (eq macro-start syntactic-relpos)
11306 (not (assq 'cpp-define-intro c-syntactic-context))
11308 (goto-char macro-start)
11309 (or (not (c-forward-to-cpp-define-body))
11310 (<= (point) (c-point 'boi indent-point)))))
11311 ;; Inside a #define body and the syntactic analysis is
11312 ;; anchored on the start of the #define. In this case
11313 ;; we add cpp-define-intro to get the extra
11314 ;; indentation of the #define body.
11315 (c-add-syntax 'cpp-define-intro)))))
11317 ;; return the syntax
11318 c-syntactic-context)))
11321 ;; Indentation calculation.
11323 (defun c-evaluate-offset (offset langelem symbol)
11324 ;; offset can be a number, a function, a variable, a list, or one of
11325 ;; the symbols + or -
11327 ;; This function might do hidden buffer changes.
11330 ((numberp offset) offset)
11331 ((vectorp offset) offset)
11332 ((null offset) nil)
11334 ((eq offset '+) c-basic-offset)
11335 ((eq offset '-) (- c-basic-offset))
11336 ((eq offset '++) (* 2 c-basic-offset))
11337 ((eq offset '--) (* 2 (- c-basic-offset)))
11338 ((eq offset '*) (/ c-basic-offset 2))
11339 ((eq offset '/) (/ (- c-basic-offset) 2))
11341 ((functionp offset)
11344 (cons (c-langelem-sym langelem)
11345 (c-langelem-pos langelem)))
11350 ((eq (car offset) 'quote)
11351 (c-benign-error "The offset %S for %s was mistakenly quoted"
11355 ((memq (car offset) '(min max))
11356 (let (res val (method (car offset)))
11357 (setq offset (cdr offset))
11359 (setq val (c-evaluate-offset (car offset) langelem symbol))
11367 Error evaluating offset %S for %s: \
11368 Cannot combine absolute offset %S with relative %S in `%s' method"
11369 (car offset) symbol res val method)
11370 (setq res (funcall method res val))))
11374 Error evaluating offset %S for %s: \
11375 Cannot combine relative offset %S with absolute %S in `%s' method"
11376 (car offset) symbol res val method)
11377 (setq res (vector (funcall method (aref res 0)
11379 (setq offset (cdr offset)))
11382 ((eq (car offset) 'add)
11384 (setq offset (cdr offset))
11386 (setq val (c-evaluate-offset (car offset) langelem symbol))
11393 (setq res (vector (+ (aref res 0) val)))
11394 (setq res (+ res val))))
11398 Error evaluating offset %S for %s: \
11399 Cannot combine absolute offsets %S and %S in `add' method"
11400 (car offset) symbol res val)
11401 (setq res val)))) ; Override.
11402 (setq offset (cdr offset)))
11407 (when (eq (car offset) 'first)
11408 (setq offset (cdr offset)))
11409 (while (and (not res) offset)
11410 (setq res (c-evaluate-offset (car offset) langelem symbol)
11411 offset (cdr offset)))
11414 ((and (symbolp offset) (boundp offset))
11415 (symbol-value offset))
11418 (c-benign-error "Unknown offset format %S for %s" offset symbol)
11421 (if (or (null res) (integerp res)
11422 (and (vectorp res) (= (length res) 1) (integerp (aref res 0))))
11424 (c-benign-error "Error evaluating offset %S for %s: Got invalid value %S"
11428 (defun c-calc-offset (langelem)
11429 ;; Get offset from LANGELEM which is a list beginning with the
11430 ;; syntactic symbol and followed by any analysis data it provides.
11431 ;; That data may be zero or more elements, but if at least one is
11432 ;; given then the first is the anchor position (or nil). The symbol
11433 ;; is matched against `c-offsets-alist' and the offset calculated
11434 ;; from that is returned.
11436 ;; This function might do hidden buffer changes.
11437 (let* ((symbol (c-langelem-sym langelem))
11438 (match (assq symbol c-offsets-alist))
11439 (offset (cdr-safe match)))
11441 (setq offset (c-evaluate-offset offset langelem symbol))
11442 (if c-strict-syntax-p
11443 (c-benign-error "No offset found for syntactic symbol %s" symbol))
11445 (if (vectorp offset)
11447 (or (and (numberp offset) offset)
11448 (and (symbolp offset) (symbol-value offset))
11452 (defun c-get-offset (langelem)
11453 ;; This is a compatibility wrapper for `c-calc-offset' in case
11454 ;; someone is calling it directly. It takes an old style syntactic
11455 ;; element on the form (SYMBOL . ANCHOR-POS) and converts it to the
11458 ;; This function might do hidden buffer changes.
11459 (if (c-langelem-pos langelem)
11460 (c-calc-offset (list (c-langelem-sym langelem)
11461 (c-langelem-pos langelem)))
11462 (c-calc-offset langelem)))
11464 (defun c-get-syntactic-indentation (langelems)
11465 ;; Calculate the syntactic indentation from a syntactic description
11466 ;; as returned by `c-guess-syntax'.
11468 ;; Note that topmost-intro always has an anchor position at bol, for
11469 ;; historical reasons. It's often used together with other symbols
11470 ;; that has more sane positions. Since we always use the first
11471 ;; found anchor position, we rely on that these other symbols always
11472 ;; precede topmost-intro in the LANGELEMS list.
11474 ;; This function might do hidden buffer changes.
11475 (let ((indent 0) anchor)
11478 (let* ((c-syntactic-element (car langelems))
11479 (res (c-calc-offset c-syntactic-element)))
11482 ;; Got an absolute column that overrides any indentation
11483 ;; we've collected so far, but not the relative
11484 ;; indentation we might get for the nested structures
11485 ;; further down the langelems list.
11486 (setq indent (elt res 0)
11487 anchor (point-min)) ; A position at column 0.
11489 ;; Got a relative change of the current calculated
11491 (setq indent (+ indent res))
11493 ;; Use the anchor position from the first syntactic
11494 ;; element with one.
11496 (setq anchor (c-langelem-pos (car langelems)))))
11498 (setq langelems (cdr langelems))))
11501 (+ indent (save-excursion
11507 (cc-provide 'cc-engine)
11509 ;; Local Variables:
11510 ;; indent-tabs-mode: t
11513 ;;; cc-engine.el ends here