1 ;;; cc-engine.el --- core syntax guessing engine for CC mode -*- coding: utf-8 -*-
3 ;; Copyright (C) 1985, 1987, 1992-2014 Free Software Foundation, Inc.
5 ;; Authors: 2001- Alan Mackenzie
6 ;; 1998- Martin Stjernholm
7 ;; 1992-1999 Barry A. Warsaw
10 ;; 1985 Richard M. Stallman
11 ;; Maintainer: bug-cc-mode@gnu.org
12 ;; Created: 22-Apr-1997 (split from cc-mode.el)
13 ;; Keywords: c languages
16 ;; This file is part of GNU Emacs.
18 ;; GNU Emacs is free software: you can redistribute it and/or modify
19 ;; it under the terms of the GNU General Public License as published by
20 ;; the Free Software Foundation, either version 3 of the License, or
21 ;; (at your option) any later version.
23 ;; GNU Emacs is distributed in the hope that it will be useful,
24 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
25 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 ;; GNU General Public License for more details.
28 ;; You should have received a copy of the GNU General Public License
29 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
33 ;; The functions which have docstring documentation can be considered
34 ;; part of an API which other packages can use in CC Mode buffers.
35 ;; Otoh, undocumented functions and functions with the documentation
36 ;; in comments are considered purely internal and can change semantics
37 ;; or even disappear in the future.
39 ;; (This policy applies to CC Mode as a whole, not just this file. It
40 ;; probably also applies to many other Emacs packages, but here it's
41 ;; clearly spelled out.)
43 ;; Hidden buffer changes
45 ;; Various functions in CC Mode use text properties for caching and
46 ;; syntactic markup purposes, and those of them that might modify such
47 ;; properties but still don't modify the buffer in a visible way are
48 ;; said to do "hidden buffer changes". They should be used within
49 ;; `c-save-buffer-state' or a similar function that saves and restores
50 ;; buffer modifiedness, disables buffer change hooks, etc.
52 ;; Interactive functions are assumed to not do hidden buffer changes,
53 ;; except in the specific parts of them that do real changes.
55 ;; Lineup functions are assumed to do hidden buffer changes. They
56 ;; must not do real changes, though.
58 ;; All other functions that do hidden buffer changes have that noted
59 ;; in their doc string or comment.
61 ;; The intention with this system is to avoid wrapping every leaf
62 ;; function that do hidden buffer changes inside
63 ;; `c-save-buffer-state'. It should be used as near the top of the
64 ;; interactive functions as possible.
66 ;; Functions called during font locking are allowed to do hidden
67 ;; buffer changes since the font-lock package run them in a context
68 ;; similar to `c-save-buffer-state' (in fact, that function is heavily
69 ;; inspired by `save-buffer-state' in the font-lock package).
71 ;; Use of text properties
73 ;; CC Mode uses several text properties internally to mark up various
74 ;; positions, e.g. to improve speed and to eliminate glitches in
75 ;; interactive refontification.
77 ;; Note: This doc is for internal use only. Other packages should not
78 ;; assume that these text properties are used as described here.
81 ;; Used for "indirection". With its help, some other property can
82 ;; be cheaply and easily switched on or off everywhere it occurs.
85 ;; Used to modify the syntax of some characters. It is used to
86 ;; mark the "<" and ">" of angle bracket parens with paren syntax, and
87 ;; to "hide" obtrusive characters in preprocessor lines.
89 ;; This property is used on single characters and is therefore
90 ;; always treated as front and rear nonsticky (or start and end open
91 ;; in XEmacs vocabulary). It's therefore installed on
92 ;; `text-property-default-nonsticky' if that variable exists (Emacs
95 ;; 'c-is-sws and 'c-in-sws
96 ;; Used by `c-forward-syntactic-ws' and `c-backward-syntactic-ws' to
97 ;; speed them up. See the comment blurb before `c-put-is-sws'
98 ;; below for further details.
101 ;; This property is used on single characters to mark positions with
102 ;; special syntactic relevance of various sorts. Its primary use is
103 ;; to avoid glitches when multiline constructs are refontified
104 ;; interactively (on font lock decoration level 3). It's cleared in
105 ;; a region before it's fontified and is then put on relevant chars
106 ;; in that region as they are encountered during the fontification.
107 ;; The value specifies the kind of position:
110 ;; Put on the last char of the token preceding each declaration
111 ;; inside a declaration style arglist (typically in a function
115 ;; Put on the last char of the token preceding a declaration.
116 ;; This is used in cases where declaration boundaries can't be
117 ;; recognized simply by looking for a token like ";" or "}".
118 ;; `c-type-decl-end-used' must be set if this is used (see also
119 ;; `c-find-decl-spots').
122 ;; Put on the commas that separate arguments in angle bracket
123 ;; arglists like C++ template arglists.
125 ;; 'c-decl-id-start and 'c-decl-type-start
126 ;; Put on the last char of the token preceding each declarator
127 ;; in the declarator list of a declaration. They are also used
128 ;; between the identifiers cases like enum declarations.
129 ;; 'c-decl-type-start is used when the declarators are types,
130 ;; 'c-decl-id-start otherwise.
133 ;; Used in AWK mode to mark the various kinds of newlines. See
140 (if (and (boundp 'byte-compile-dest-file)
141 (stringp byte-compile-dest-file))
142 (cons (file-name-directory byte-compile-dest-file) load-path)
144 (load "cc-bytecomp" nil t)))
146 (cc-require 'cc-defs)
147 (cc-require-when-compile 'cc-langs)
148 (cc-require 'cc-vars)
150 (eval-when-compile (require 'cl))
153 ;; Make declarations for all the `c-lang-defvar' variables in cc-langs.
155 (defmacro c-declare-lang-variables ()
157 ,@(mapcan (lambda (init)
159 `(defvar ,(car init) nil ,(elt init 2))
160 `(defvar ,(car init) nil))
161 (make-variable-buffer-local ',(car init))))
162 (cdr c-lang-variable-inits))))
163 (c-declare-lang-variables)
166 ;;; Internal state variables.
168 ;; Internal state of hungry delete key feature
169 (defvar c-hungry-delete-key nil)
170 (make-variable-buffer-local 'c-hungry-delete-key)
172 ;; The electric flag (toggled by `c-toggle-electric-state').
173 ;; If t, electric actions (like automatic reindentation, and (if
174 ;; c-auto-newline is also set) auto newlining) will happen when an electric
175 ;; key like `{' is pressed (or an electric keyword like `else').
176 (defvar c-electric-flag t)
177 (make-variable-buffer-local 'c-electric-flag)
179 ;; Internal state of auto newline feature.
180 (defvar c-auto-newline nil)
181 (make-variable-buffer-local 'c-auto-newline)
183 ;; Included in the mode line to indicate the active submodes.
184 ;; (defvar c-submode-indicators nil)
185 ;; (make-variable-buffer-local 'c-submode-indicators)
187 (defun c-calculate-state (arg prevstate)
188 ;; Calculate the new state of PREVSTATE, t or nil, based on arg. If
189 ;; arg is nil or zero, toggle the state. If arg is negative, turn
190 ;; the state off, and if arg is positive, turn the state on
192 (zerop (setq arg (prefix-numeric-value arg))))
197 ;; Basic handling of preprocessor directives.
199 ;; This is a dynamically bound cache used together with
200 ;; `c-query-macro-start' and `c-query-and-set-macro-start'. It only
201 ;; works as long as point doesn't cross a macro boundary.
202 (defvar c-macro-start 'unknown)
204 (defsubst c-query-and-set-macro-start ()
205 (if (symbolp c-macro-start)
206 (setq c-macro-start (save-excursion
207 (c-save-buffer-state ()
208 (and (c-beginning-of-macro)
212 (defsubst c-query-macro-start ()
213 (if (symbolp c-macro-start)
215 (c-save-buffer-state ()
216 (and (c-beginning-of-macro)
220 ;; One element macro cache to cope with continual movement within very large
222 (defvar c-macro-cache nil)
223 (make-variable-buffer-local 'c-macro-cache)
224 ;; Nil or cons of the bounds of the most recent CPP form probed by
225 ;; `c-beginning-of-macro', `c-end-of-macro' or `c-syntactic-end-of-macro'.
226 ;; The cdr will be nil if we know only the start of the CPP form.
227 (defvar c-macro-cache-start-pos nil)
228 (make-variable-buffer-local 'c-macro-cache-start-pos)
229 ;; The starting position from where we determined `c-macro-cache'.
230 (defvar c-macro-cache-syntactic nil)
231 (make-variable-buffer-local 'c-macro-cache-syntactic)
232 ;; non-nil iff `c-macro-cache' has both elements set AND the cdr is at a
233 ;; syntactic end of macro, not merely an apparent one.
235 (defun c-invalidate-macro-cache (beg end)
236 ;; Called from a before-change function. If the change region is before or
237 ;; in the macro characterized by `c-macro-cache' etc., nullify it
238 ;; appropriately. BEG and END are the standard before-change-functions
239 ;; parameters. END isn't used.
241 ((null c-macro-cache))
242 ((< beg (car c-macro-cache))
243 (setq c-macro-cache nil
244 c-macro-cache-start-pos nil
245 c-macro-cache-syntactic nil))
246 ((and (cdr c-macro-cache)
247 (< beg (cdr c-macro-cache)))
248 (setcdr c-macro-cache nil)
249 (setq c-macro-cache-start-pos beg
250 c-macro-cache-syntactic nil))))
252 (defun c-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
621 (format "No matching `%s' found for `%s' on line %d"
624 (1+ (count-lines (point-min)
625 (c-point 'bol (elt saved-pos 0))))))))
627 (defun c-beginning-of-statement-1 (&optional lim ignore-labels
629 "Move to the start of the current statement or declaration, or to
630 the previous one if already at the beginning of one. Only
631 statements/declarations on the same level are considered, i.e. don't
632 move into or out of sexps (not even normal expression parentheses).
634 If point is already at the earliest statement within braces or parens,
635 this function doesn't move back into any whitespace preceding it; it
636 returns 'same in this case.
638 Stop at statement continuation tokens like \"else\", \"catch\",
639 \"finally\" and the \"while\" in \"do ... while\" if the start point
640 is within the continuation. If starting at such a token, move to the
641 corresponding statement start. If at the beginning of a statement,
642 move to the closest containing statement if there is any. This might
643 also stop at a continuation clause.
645 Labels are treated as part of the following statements if
646 IGNORE-LABELS is non-nil. (FIXME: Doesn't work if we stop at a known
647 statement start keyword.) Otherwise, each label is treated as a
650 Macros are ignored \(i.e. skipped over) unless point is within one, in
651 which case the content of the macro is treated as normal code. Aside
652 from any normal statement starts found in it, stop at the first token
653 of the content in the macro, i.e. the expression of an \"#if\" or the
654 start of the definition in a \"#define\". Also stop at start of
655 macros before leaving them.
658 'label if stopped at a label or \"case...:\" or \"default:\";
659 'same if stopped at the beginning of the current statement;
660 'up if stepped to a containing statement;
661 'previous if stepped to a preceding statement;
662 'beginning if stepped from a statement continuation clause to
664 'macro if stepped to a macro start.
665 Note that 'same and not 'label is returned if stopped at the same
666 label without crossing the colon character.
668 LIM may be given to limit the search. If the search hits the limit,
669 point will be left at the closest following token, or at the start
670 position if that is less ('same is returned in this case).
672 NOERROR turns off error logging to `c-parsing-error'.
674 Normally only ';' and virtual semicolons are considered to delimit
675 statements, but if COMMA-DELIM is non-nil then ',' is treated
678 Note that this function might do hidden buffer changes. See the
679 comment at the start of cc-engine.el for more info."
681 ;; The bulk of this function is a pushdown automaton that looks at statement
682 ;; boundaries and the tokens (such as "while") in c-opt-block-stmt-key. Its
683 ;; purpose is to keep track of nested statements, ensuring that such
684 ;; statements are skipped over in their entirety (somewhat akin to what C-M-p
685 ;; does with nested braces/brackets/parentheses).
687 ;; Note: The position of a boundary is the following token.
689 ;; Beginning with the current token (the one following point), move back one
690 ;; sexp at a time (where a sexp is, more or less, either a token or the
691 ;; entire contents of a brace/bracket/paren pair). Each time a statement
692 ;; boundary is crossed or a "while"-like token is found, update the state of
693 ;; the PDA. Stop at the beginning of a statement when the stack (holding
694 ;; nested statement info) is empty and the position has been moved.
696 ;; The following variables constitute the PDA:
698 ;; sym: This is either the "while"-like token (e.g. 'for) we've just
699 ;; scanned back over, 'boundary if we've just gone back over a
700 ;; statement boundary, or nil otherwise.
701 ;; state: takes one of the values (nil else else-boundary while
702 ;; while-boundary catch catch-boundary).
703 ;; nil means "no "while"-like token yet scanned".
704 ;; 'else, for example, means "just gone back over an else".
705 ;; 'else-boundary means "just gone back over a statement boundary
706 ;; immediately after having gone back over an else".
707 ;; saved-pos: A vector of either saved positions (tok ptok pptok, etc.) or
708 ;; of error reporting information.
709 ;; stack: The stack onto which the PDA pushes its state. Each entry
710 ;; consists of a saved value of state and saved-pos. An entry is
711 ;; pushed when we move back over a "continuation" token (e.g. else)
712 ;; and popped when we encounter the corresponding opening token
716 ;; The following diagram briefly outlines the PDA.
719 ;; "else": Push state, goto state `else'.
720 ;; "while": Push state, goto state `while'.
721 ;; "catch" or "finally": Push state, goto state `catch'.
722 ;; boundary: Pop state.
723 ;; other: Do nothing special.
726 ;; boundary: Goto state `else-boundary'.
727 ;; other: Error, pop state, retry token.
729 ;; State `else-boundary':
731 ;; boundary: Error, pop state.
732 ;; other: See common state.
735 ;; boundary: Save position, goto state `while-boundary'.
736 ;; other: Pop state, retry token.
738 ;; State `while-boundary':
740 ;; boundary: Restore position if it's not at start, pop state. [*see below]
741 ;; other: See common state.
744 ;; boundary: Goto state `catch-boundary'.
745 ;; other: Error, pop state, retry token.
747 ;; State `catch-boundary':
749 ;; "catch": Goto state `catch'.
750 ;; boundary: Error, pop state.
751 ;; other: See common state.
753 ;; [*] In the `while-boundary' state, we had pushed a 'while state, and were
754 ;; searching for a "do" which would have opened a do-while. If we didn't
755 ;; find it, we discard the analysis done since the "while", go back to this
756 ;; token in the buffer and restart the scanning there, this time WITHOUT
757 ;; pushing the 'while state onto the stack.
759 ;; In addition to the above there is some special handling of labels
762 (let ((case-fold-search nil)
765 (delims (if comma-delim '(?\; ?,) '(?\;)))
766 (c-stmt-delim-chars (if comma-delim
767 c-stmt-delim-chars-with-comma
769 c-in-literal-cache c-maybe-labelp after-case:-pos saved
772 ;; Position of last stmt boundary character (e.g. ;).
774 ;; The position of the last sexp or bound that follows the
775 ;; first found colon, i.e. the start of the nonlabel part of
776 ;; the statement. It's `start' if a colon is found just after
779 ;; Like `after-labels-pos', but the first such position inside
780 ;; a label, i.e. the start of the last label before the start
781 ;; of the nonlabel part of the statement.
783 ;; The last position where a label is possible provided the
784 ;; statement started there. It's nil as long as no invalid
785 ;; label content has been found (according to
786 ;; `c-nonlabel-token-key'). It's `start' if no valid label
787 ;; content was found in the label. Note that we might still
788 ;; regard it a label if it starts with `c-label-kwds'.
790 ;; Putative positions of the components of a bitfield declaration,
791 ;; e.g. "int foo : NUM_FOO_BITS ;"
792 bitfield-type-pos bitfield-id-pos bitfield-size-pos
793 ;; Symbol just scanned back over (e.g. 'while or 'boundary).
796 ;; Current state in the automaton. See above.
798 ;; Current saved positions. See above.
800 ;; Stack of conses (state . saved-pos).
802 ;; Regexp which matches "for", "if", etc.
803 (cond-key (or c-opt-block-stmt-key
804 "\\<\\>")) ; Matches nothing.
807 ;; Positions of the last three sexps or bounds we've stopped at.
811 (if lim (narrow-to-region lim (point-max)))
814 (and (c-beginning-of-macro)
816 (setq macro-start (point)))
818 ;; Try to skip back over unary operator characters, to register
822 (c-backward-syntactic-ws)
823 ;; Protect post-++/-- operators just before a virtual semicolon.
824 (and (not (c-at-vsemi-p))
825 (/= (skip-chars-backward "-+!*&~@`#") 0))))
827 ;; Skip back over any semicolon here. If it was a bare semicolon, we're
828 ;; done. Later on we ignore the boundaries for statements that don't
829 ;; contain any sexp. The only thing that is affected is that the error
830 ;; checking is a little less strict, and we really don't bother.
831 (if (and (memq (char-before) delims)
832 (progn (forward-char -1)
834 (c-backward-syntactic-ws)
835 (or (memq (char-before) delims)
836 (memq (char-before) '(?: nil))
837 (eq (char-syntax (char-before)) ?\()
842 ;; Begin at start and not pos to detect macros if we stand
843 ;; directly after the #.
845 (if (looking-at "\\<\\|\\W")
846 ;; Record this as the first token if not starting inside it.
849 ;; The following while loop goes back one sexp (balanced parens,
850 ;; etc. with contents, or symbol or suchlike) each iteration. This
851 ;; movement is accomplished with a call to c-backward-sexp approx 170
854 ;; The loop is exited only by throwing nil to the (catch 'loop ...):
855 ;; 1. On reaching the start of a macro;
856 ;; 2. On having passed a stmt boundary with the PDA stack empty;
857 ;; 3. On reaching the start of an Objective C method def;
858 ;; 4. From macro `c-bos-pop-state'; when the stack is empty;
859 ;; 5. From macro `c-bos-pop-state-and-retry' when the stack is empty.
861 (catch 'loop ;; Throw nil to break, non-nil to continue.
863 ;; Are we in a macro, just after the opening #?
865 (and macro-start ; Always NIL for AWK.
866 (progn (skip-chars-backward " \t")
867 (eq (char-before) ?#))
868 (progn (setq saved (1- (point)))
870 (not (eq (char-before (1- (point))) ?\\)))
871 (looking-at c-opt-cpp-start)
872 (progn (skip-chars-forward " \t")
873 (eq (point) saved))))
875 (if (and (c-forward-to-cpp-define-body)
876 (progn (c-forward-syntactic-ws start)
878 ;; Stop at the first token in the content of the macro.
880 ignore-labels t) ; Avoid the label check on exit.
884 (throw 'loop nil)) ; 1. Start of macro.
886 ;; Do a round through the automaton if we've just passed a
887 ;; statement boundary or passed a "while"-like token.
889 (and (looking-at cond-key)
890 (setq sym (intern (match-string 1)))))
892 (when (and (< pos start) (null stack))
893 (throw 'loop nil)) ; 2. Statement boundary.
895 ;; The PDA state handling.
897 ;; Refer to the description of the PDA in the opening
898 ;; comments. In the following OR form, the first leaf
899 ;; attempts to handles one of the specific actions detailed
900 ;; (e.g., finding token "if" whilst in state `else-boundary').
901 ;; We drop through to the second leaf (which handles common
902 ;; state) if no specific handler is found in the first cond.
903 ;; If a parsing error is detected (e.g. an "else" with no
904 ;; preceding "if"), we throw to the enclosing catch.
906 ;; Note that the (eq state 'else) means
907 ;; "we've just passed an else", NOT "we're looking for an
911 (if (eq sym 'boundary)
912 (setq state 'else-boundary)
914 (c-bos-pop-state-and-retry)))
916 ((eq state 'else-boundary)
918 (c-bos-pop-state (setq ret 'beginning)))
924 (if (and (eq sym 'boundary)
925 ;; Since this can cause backtracking we do a
926 ;; little more careful analysis to avoid it:
927 ;; If there's a label in front of the while
928 ;; it can't be part of a do-while.
929 (not after-labels-pos))
930 (progn (c-bos-save-pos)
931 (setq state 'while-boundary))
932 (c-bos-pop-state-and-retry))) ; Can't be a do-while
934 ((eq state 'while-boundary)
936 (c-bos-pop-state (setq ret 'beginning)))
937 ((eq sym 'boundary) ; isn't a do-while
938 (c-bos-restore-pos) ; the position of the while
939 (c-bos-pop-state)))) ; no longer searching for do.
942 (if (eq sym 'boundary)
943 (setq state 'catch-boundary)
945 (c-bos-pop-state-and-retry)))
947 ((eq state 'catch-boundary)
950 (c-bos-pop-state (setq ret 'beginning)))
955 (c-bos-pop-state)))))
957 ;; This is state common. We get here when the previous
958 ;; cond statement found no particular state handler.
959 (cond ((eq sym 'boundary)
960 ;; If we have a boundary at the start
961 ;; position we push a frame to go to the
962 ;; previous statement.
968 (c-bos-save-error-info 'if 'else)
971 ;; Is this a real while, or a do-while?
972 ;; The next `when' triggers unless we are SURE that
973 ;; the `while' is not the tail end of a `do-while'.
974 (when (or (not pptok)
975 (memq (char-after pptok) delims)
976 ;; The following kludge is to prevent
977 ;; infinite recursion when called from
978 ;; c-awk-after-if-for-while-condition-p,
980 (and (eq (point) start)
981 (c-vsemi-status-unknown-p))
982 (c-at-vsemi-p pptok))
983 ;; Since this can cause backtracking we do a
984 ;; little more careful analysis to avoid it: If
985 ;; the while isn't followed by a (possibly
986 ;; virtual) semicolon it can't be a do-while.
988 (setq state 'while)))
989 ((memq sym '(catch finally))
991 (c-bos-save-error-info 'try sym)
992 (setq state 'catch))))
995 ;; We're either past a statement boundary or at the
996 ;; start of a statement, so throw away any label data
997 ;; for the previous one.
998 (setq after-labels-pos nil
1000 c-maybe-labelp nil))))
1002 ;; Step to the previous sexp, but not if we crossed a
1003 ;; boundary, since that doesn't consume an sexp.
1004 (if (eq sym 'boundary)
1005 (setq ret 'previous)
1007 ;; HERE IS THE SINGLE PLACE INSIDE THE PDA LOOP WHERE WE MOVE
1008 ;; BACKWARDS THROUGH THE SOURCE.
1010 (c-backward-syntactic-ws)
1011 (let ((before-sws-pos (point))
1012 ;; The end position of the area to search for statement
1013 ;; barriers in this round.
1014 (maybe-after-boundary-pos pos))
1016 ;; Go back over exactly one logical sexp, taking proper
1017 ;; account of macros and escaped EOLs.
1020 (unless (c-safe (c-backward-sexp) t)
1021 ;; Give up if we hit an unbalanced block. Since the
1022 ;; stack won't be empty the code below will report a
1026 ;; Have we moved into a macro?
1027 ((and (not macro-start)
1028 (c-beginning-of-macro))
1029 ;; Have we crossed a statement boundary? If not,
1030 ;; keep going back until we find one or a "real" sexp.
1034 (not (c-crosses-statement-barrier-p
1035 (point) maybe-after-boundary-pos)))
1036 (setq maybe-after-boundary-pos (point))))
1037 ;; Have we just gone back over an escaped NL? This
1038 ;; doesn't count as a sexp.
1039 ((looking-at "\\\\$")))))
1041 ;; Have we crossed a statement boundary?
1044 ;; Are we at a macro beginning?
1045 ((and (not macro-start)
1047 (looking-at c-opt-cpp-prefix))
1050 (c-crosses-statement-barrier-p
1051 (point) maybe-after-boundary-pos)))
1052 ;; Just gone back over a brace block?
1054 (eq (char-after) ?{)
1055 (not (c-looking-at-inexpr-block lim nil t))
1057 (c-backward-token-2 1 t nil)
1058 (not (looking-at "=\\([^=]\\|$\\)"))))
1060 (c-forward-sexp) (point)))
1061 ;; Just gone back over some paren block?
1062 ((looking-at "\\s\(")
1064 (goto-char (1+ (c-down-list-backward
1066 (c-crosses-statement-barrier-p
1067 (point) maybe-after-boundary-pos)))
1068 ;; Just gone back over an ordinary symbol of some sort?
1069 (t (c-crosses-statement-barrier-p
1070 (point) maybe-after-boundary-pos))))
1077 ;; Like a C "continue". Analyze the next sexp.
1081 (when (and c-opt-method-key
1082 (setq saved (c-in-method-def-p)))
1084 ignore-labels t) ; Avoid the label check on exit.
1085 (throw 'loop nil)) ; 3. ObjC method def.
1087 ;; Might we have a bitfield declaration, "<type> <id> : <size>"?
1090 ;; The : <size> and <id> fields?
1091 ((and (numberp c-maybe-labelp)
1092 (not bitfield-size-pos)
1094 (goto-char (or tok start))
1095 (not (looking-at c-keywords-regexp)))
1096 (not (looking-at c-keywords-regexp))
1097 (not (c-punctuation-in (point) c-maybe-labelp)))
1098 (setq bitfield-size-pos (or tok start)
1099 bitfield-id-pos (point)))
1100 ;; The <type> field?
1101 ((and bitfield-id-pos
1102 (not bitfield-type-pos))
1103 (if (and (looking-at c-symbol-key) ; Can only be an integer type. :-)
1104 (not (looking-at c-not-primitive-type-keywords-regexp))
1105 (not (c-punctuation-in (point) tok)))
1106 (setq bitfield-type-pos (point))
1107 (setq bitfield-size-pos nil
1108 bitfield-id-pos nil)))))
1111 (unless (eq ignore-labels t)
1112 (when (numberp c-maybe-labelp)
1113 ;; `c-crosses-statement-barrier-p' has found a colon, so we
1114 ;; might be in a label now. Have we got a real label
1115 ;; (including a case label) or something like C++'s "public:"?
1116 ;; A case label might use an expression rather than a token.
1117 (setq after-case:-pos (or tok start))
1118 (if (or (looking-at c-nonlabel-token-key) ; e.g. "while" or "'a'"
1119 ;; Catch C++'s inheritance construct "class foo : bar".
1122 (c-safe (c-backward-sexp) t)
1123 (looking-at c-nonlabel-token-2-key))))
1124 (setq c-maybe-labelp nil)
1125 (if after-labels-pos ; Have we already encountered a label?
1126 (if (not last-label-pos)
1127 (setq last-label-pos (or tok start)))
1128 (setq after-labels-pos (or tok start)))
1129 (setq c-maybe-labelp t
1130 label-good-pos nil))) ; bogus "label"
1132 (when (and (not label-good-pos) ; i.e. no invalid "label"'s yet
1134 (looking-at c-nonlabel-token-key)) ; e.g. "while :"
1135 ;; We're in a potential label and it's the first
1136 ;; time we've found something that isn't allowed in
1138 (setq label-good-pos (or tok start))))
1140 ;; We've moved back by a sexp, so update the token positions.
1145 pos tok) ; always non-nil
1146 ) ; end of (catch loop ....)
1147 ) ; end of sexp-at-a-time (while ....)
1149 ;; If the stack isn't empty there might be errors to report.
1151 (if (and (vectorp saved-pos) (eq (length saved-pos) 3))
1152 (c-bos-report-error))
1153 (setq saved-pos (cdr (car stack))
1156 (when (and (eq ret 'same)
1157 (not (memq sym '(boundary ignore nil))))
1158 ;; Need to investigate closer whether we've crossed
1159 ;; between a substatement and its containing statement.
1161 (cond ((and (looking-at c-block-stmt-1-2-key)
1162 (eq (char-after ptok) ?\())
1164 ((looking-at c-block-stmt-1-key)
1167 (cond ((> start saved) (setq pos saved))
1168 ((= start saved) (setq ret 'up)))))
1170 (when (and (not ignore-labels)
1171 (eq c-maybe-labelp t)
1172 (not (eq ret 'beginning))
1174 (not bitfield-type-pos) ; Bitfields take precedence over labels.
1175 (or (not label-good-pos)
1176 (<= label-good-pos pos)
1178 (goto-char (if (and last-label-pos
1179 (< last-label-pos start))
1182 (looking-at c-label-kwds-regexp))))
1183 ;; We're in a label. Maybe we should step to the statement
1185 (if (< after-labels-pos start)
1186 (setq pos after-labels-pos)
1188 (if (and last-label-pos (< last-label-pos start))
1189 ;; Might have jumped over several labels. Go to the last one.
1190 (setq pos last-label-pos)))))
1192 ;; Have we got "case <expression>:"?
1194 (when (and after-case:-pos
1195 (not (eq ret 'beginning))
1196 (looking-at c-case-kwds-regexp))
1197 (if (< after-case:-pos start)
1198 (setq pos after-case:-pos))
1202 ;; Skip over the unary operators that can start the statement.
1204 (c-backward-syntactic-ws)
1205 ;; protect AWK post-inc/decrement operators, etc.
1206 (and (not (c-at-vsemi-p (point)))
1207 (/= (skip-chars-backward "-+!*&~@`#") 0)))
1212 (defun c-punctuation-in (from to)
1213 "Return non-nil if there is a non-comment non-macro punctuation character
1214 between FROM and TO. FROM must not be in a string or comment. The returned
1215 value is the position of the first such character."
1218 (let ((pos (point)))
1219 (while (progn (skip-chars-forward c-symbol-chars to)
1220 (c-forward-syntactic-ws to)
1222 (setq pos (point))))
1223 (and (< (point) to) (point))))
1225 (defun c-crosses-statement-barrier-p (from to)
1226 "Return non-nil if buffer positions FROM to TO cross one or more
1227 statement or declaration boundaries. The returned value is actually
1228 the position of the earliest boundary char. FROM must not be within
1229 a string or comment.
1231 The variable `c-maybe-labelp' is set to the position of the first `:' that
1232 might start a label (i.e. not part of `::' and not preceded by `?'). If a
1233 single `?' is found, then `c-maybe-labelp' is cleared.
1235 For AWK, a statement which is terminated by an EOL (not a \; or a }) is
1236 regarded as having a \"virtual semicolon\" immediately after the last token on
1237 the line. If this virtual semicolon is _at_ from, the function recognizes it.
1239 Note that this function might do hidden buffer changes. See the
1240 comment at the start of cc-engine.el for more info."
1242 ;; If the current language has CPP macros, insert # into skip-chars.
1243 (if c-opt-cpp-symbol
1244 (concat (substring c-stmt-delim-chars 0 1) ; "^"
1245 c-opt-cpp-symbol ; usually "#"
1246 (substring c-stmt-delim-chars 1)) ; e.g. ";{}?:"
1247 c-stmt-delim-chars))
1249 (append (substring skip-chars 1) nil)) ; e.g. (?# ?\; ?{ ?} ?? ?:)
1250 lit-range vsemi-pos)
1256 (while (progn (skip-chars-forward
1258 (min to (c-point 'bonl)))
1261 ;; Virtual semicolon?
1265 (if (setq lit-range (c-literal-limits from)) ; Have we landed in a string/comment?
1266 (goto-char (car lit-range)))
1267 (c-backward-syntactic-ws) ; ? put a limit here, maybe?
1268 (setq vsemi-pos (point))
1270 (throw 'done vsemi-pos))
1271 ;; In a string/comment?
1272 ((setq lit-range (c-literal-limits from))
1273 (goto-char (cdr lit-range)))
1274 ((eq (char-after) ?:)
1276 (if (and (eq (char-after) ?:)
1278 ;; Ignore scope operators.
1280 (setq c-maybe-labelp (1- (point)))))
1281 ((eq (char-after) ??)
1282 ;; A question mark. Can't be a label, so stop
1283 ;; looking for more : and ?.
1284 (setq c-maybe-labelp nil
1285 skip-chars (substring c-stmt-delim-chars 0 -2)))
1286 ;; At a CPP construct or a "#" or "##" operator?
1287 ((and c-opt-cpp-symbol (looking-at c-opt-cpp-symbol))
1289 (skip-chars-backward " \t")
1292 (not (eq (char-before (1- (point))) ?\\)))))
1294 (skip-chars-forward c-opt-cpp-symbol)))
1295 ((memq (char-after) non-skip-list)
1296 (throw 'done (point)))))
1297 ;; In trailing space after an as yet undetected virtual semicolon?
1298 (c-backward-syntactic-ws from)
1299 (when (and (bolp) (not (bobp))) ; Can happen in AWK Mode with an
1300 ; unterminated string/regexp.
1302 (if (and (< (point) to)
1307 (defun c-at-statement-start-p ()
1308 "Return non-nil if the point is at the first token in a statement
1309 or somewhere in the syntactic whitespace before it.
1311 A \"statement\" here is not restricted to those inside code blocks.
1312 Any kind of declaration-like construct that occur outside function
1313 bodies is also considered a \"statement\".
1315 Note that this function might do hidden buffer changes. See the
1316 comment at the start of cc-engine.el for more info."
1321 (c-syntactic-skip-backward (substring c-stmt-delim-chars 1) nil t)
1323 (eq (char-before) ?})
1324 (and (eq (char-before) ?{)
1325 (not (and c-special-brace-lists
1326 (progn (backward-char)
1327 (c-looking-at-special-brace-list)))))
1328 (c-crosses-statement-barrier-p (point) end)))))
1330 (defun c-at-expression-start-p ()
1331 "Return non-nil if the point is at the first token in an expression or
1332 statement, or somewhere in the syntactic whitespace before it.
1334 An \"expression\" here is a bit different from the normal language
1335 grammar sense: It's any sequence of expression tokens except commas,
1336 unless they are enclosed inside parentheses of some kind. Also, an
1337 expression never continues past an enclosing parenthesis, but it might
1338 contain parenthesis pairs of any sort except braces.
1340 Since expressions never cross statement boundaries, this function also
1341 recognizes statement beginnings, just like `c-at-statement-start-p'.
1343 Note that this function might do hidden buffer changes. See the
1344 comment at the start of cc-engine.el for more info."
1348 (c-stmt-delim-chars c-stmt-delim-chars-with-comma)
1350 (c-syntactic-skip-backward (substring c-stmt-delim-chars 1) nil t)
1352 (memq (char-before) '(?{ ?}))
1353 (save-excursion (backward-char)
1354 (looking-at "\\s("))
1355 (c-crosses-statement-barrier-p (point) end)))))
1358 ;; A set of functions that covers various idiosyncrasies in
1359 ;; implementations of `forward-comment'.
1361 ;; Note: Some emacsen considers incorrectly that any line comment
1362 ;; ending with a backslash continues to the next line. I can't think
1363 ;; of any way to work around that in a reliable way without changing
1364 ;; the buffer, though. Suggestions welcome. ;) (No, temporarily
1365 ;; changing the syntax for backslash doesn't work since we must treat
1366 ;; escapes in string literals correctly.)
1368 (defun c-forward-single-comment ()
1369 "Move forward past whitespace and the closest following comment, if any.
1370 Return t if a comment was found, nil otherwise. In either case, the
1371 point is moved past the following whitespace. Line continuations,
1372 i.e. a backslashes followed by line breaks, are treated as whitespace.
1373 The line breaks that end line comments are considered to be the
1374 comment enders, so the point will be put on the beginning of the next
1375 line if it moved past a line comment.
1377 This function does not do any hidden buffer changes."
1379 (let ((start (point)))
1380 (when (looking-at "\\([ \t\n\r\f\v]\\|\\\\[\n\r]\\)+")
1381 (goto-char (match-end 0)))
1383 (when (forward-comment 1)
1385 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1389 ;; Emacs includes the ending newline in a b-style (c++)
1390 ;; comment, but XEmacs doesn't. We depend on the Emacs
1391 ;; behavior (which also is symmetric).
1392 (if (and (eolp) (elt (parse-partial-sexp start (point)) 7))
1393 (condition-case nil (forward-char 1)))
1397 (defsubst c-forward-comments ()
1398 "Move forward past all following whitespace and comments.
1399 Line continuations, i.e. a backslashes followed by line breaks, are
1400 treated as whitespace.
1402 Note that this function might do hidden buffer changes. See the
1403 comment at the start of cc-engine.el for more info."
1406 ;; If forward-comment in at least XEmacs 21 is given a large
1407 ;; positive value, it'll loop all the way through if it hits
1409 (and (forward-comment 5)
1410 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1414 (when (looking-at "\\\\[\n\r]")
1418 (defun c-backward-single-comment ()
1419 "Move backward past whitespace and the closest preceding comment, if any.
1420 Return t if a comment was found, nil otherwise. In either case, the
1421 point is moved past the preceding whitespace. Line continuations,
1422 i.e. a backslashes followed by line breaks, are treated as whitespace.
1423 The line breaks that end line comments are considered to be the
1424 comment enders, so the point cannot be at the end of the same line to
1425 move over a line comment.
1427 This function does not do any hidden buffer changes."
1429 (let ((start (point)))
1430 ;; When we got newline terminated comments, forward-comment in all
1431 ;; supported emacsen so far will stop at eol of each line not
1432 ;; ending with a comment when moving backwards. This corrects for
1433 ;; that, and at the same time handles line continuations.
1435 (skip-chars-backward " \t\n\r\f\v")
1436 (and (looking-at "[\n\r]")
1437 (eq (char-before) ?\\)))
1441 ;; Some emacsen (e.g. Emacs 19.34) return t when moving
1442 ;; backwards at bob.
1445 ;; Leave point after the closest following newline if we've
1446 ;; backed up over any above, since forward-comment won't move
1447 ;; backward over a line comment if point is at the end of the
1449 (re-search-forward "\\=\\s *[\n\r]" start t)
1451 (if (if (let (open-paren-in-column-0-is-defun-start) (forward-comment -1))
1453 ;; If forward-comment above succeeded and we're at eol
1454 ;; then the newline we moved over above didn't end a
1455 ;; line comment, so we give it another go.
1456 (let (open-paren-in-column-0-is-defun-start)
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 (open-paren-in-column-0-is-defun-start 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.
2280 (<= (setq npos (+ pos c-state-nonlit-pos-interval)) here)
2282 ;; Test for being in a literal. If so, go to after it.
2284 (setq lit (car (cddr (c-state-pp-to-literal pos npos))))
2286 (prog1 (<= (cdr lit) here)
2287 (setq npos (cdr lit)))))
2289 ;; Test for being in a macro. If so, go to after it.
2293 (and (c-beginning-of-macro) (/= (point) npos) (point)))
2295 (c-syntactic-end-of-macro)
2296 (or (eobp) (forward-char))
2297 (setq macro-end (point)))
2298 (or (null macro-beg)
2299 (prog1 (<= macro-end here)
2300 (setq npos macro-end)))))
2303 (setq c-state-nonlit-pos-cache (cons pos c-state-nonlit-pos-cache)))
2304 ;; Add one extra element above HERE so as to to avoid the previous
2305 ;; expensive calculation when the next call is close to the current
2306 ;; one. This is especially useful when inside a large macro.
2307 (setq c-state-nonlit-pos-cache (cons npos c-state-nonlit-pos-cache)))
2309 (if (> pos c-state-nonlit-pos-cache-limit)
2310 (setq c-state-nonlit-pos-cache-limit pos))
2313 (defun c-state-semi-safe-place (here)
2314 ;; Return a buffer position before HERE which is "safe", i.e. outside any
2315 ;; string or comment. It may be in a macro.
2319 (let ((c c-state-semi-nonlit-pos-cache)
2320 pos npos high-pos lit macro-beg macro-end)
2321 ;; Trim the cache to take account of buffer changes.
2322 (while (and c (> (car c) c-state-semi-nonlit-pos-cache-limit))
2324 (setq c-state-semi-nonlit-pos-cache c)
2326 (while (and c (> (car c) here))
2327 (setq high-pos (car c))
2329 (setq pos (or (car c) (point-min)))
2333 ;; Add an element to `c-state-semi-nonlit-pos-cache' each iteration.
2335 (<= (setq npos (+ pos c-state-nonlit-pos-interval)) here)
2337 ;; Test for being in a literal. If so, go to after it.
2339 (setq lit (car (cddr (c-state-pp-to-literal pos npos))))
2341 (prog1 (<= (cdr lit) here)
2342 (setq npos (cdr lit))))))
2345 (setq c-state-semi-nonlit-pos-cache
2346 (cons pos c-state-semi-nonlit-pos-cache))))
2348 (if (> pos c-state-semi-nonlit-pos-cache-limit)
2349 (setq c-state-semi-nonlit-pos-cache-limit pos))
2352 (defun c-state-literal-at (here)
2353 ;; If position HERE is inside a literal, return (START . END), the
2354 ;; boundaries of the literal (which may be outside the accessible bit of the
2355 ;; buffer). Otherwise, return nil.
2357 ;; This function is almost the same as `c-literal-limits'. Previously, it
2358 ;; differed in that it was a lower level function, and that it rigorously
2359 ;; followed the syntax from BOB. `c-literal-limits' is now (2011-12)
2360 ;; virtually identical to this function.
2364 (let ((pos (c-state-safe-place here)))
2365 (car (cddr (c-state-pp-to-literal pos here)))))))
2367 (defsubst c-state-lit-beg (pos)
2368 ;; Return the start of the literal containing POS, or POS itself.
2369 (or (car (c-state-literal-at pos))
2372 (defsubst c-state-cache-non-literal-place (pos state)
2373 ;; Return a position outside of a string/comment/macro at or before POS.
2374 ;; STATE is the parse-partial-sexp state at POS.
2375 (let ((res (if (or (nth 3 state) ; in a string?
2376 (nth 4 state)) ; in a comment?
2381 (if (c-beginning-of-macro)
2385 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2386 ;; Stuff to do with point-min, and coping with any literal there.
2387 (defvar c-state-point-min 1)
2388 (make-variable-buffer-local 'c-state-point-min)
2389 ;; This is (point-min) when `c-state-cache' was last calculated. A change of
2390 ;; narrowing is likely to affect the parens that are visible before the point.
2392 (defvar c-state-point-min-lit-type nil)
2393 (make-variable-buffer-local 'c-state-point-min-lit-type)
2394 (defvar c-state-point-min-lit-start nil)
2395 (make-variable-buffer-local 'c-state-point-min-lit-start)
2396 ;; These two variables define the literal, if any, containing point-min.
2397 ;; Their values are, respectively, 'string, c, or c++, and the start of the
2398 ;; literal. If there's no literal there, they're both nil.
2400 (defvar c-state-min-scan-pos 1)
2401 (make-variable-buffer-local 'c-state-min-scan-pos)
2402 ;; This is the earliest buffer-pos from which scanning can be done. It is
2403 ;; either the end of the literal containing point-min, or point-min itself.
2404 ;; It becomes nil if the buffer is changed earlier than this point.
2405 (defun c-state-get-min-scan-pos ()
2406 ;; Return the lowest valid scanning pos. This will be the end of the
2407 ;; literal enclosing point-min, or point-min itself.
2408 (or c-state-min-scan-pos
2412 (goto-char c-state-point-min-lit-start)
2413 (if (eq c-state-point-min-lit-type 'string)
2415 (forward-comment 1))
2416 (setq c-state-min-scan-pos (point))))))
2418 (defun c-state-mark-point-min-literal ()
2419 ;; Determine the properties of any literal containing POINT-MIN, setting the
2420 ;; variables `c-state-point-min-lit-type', `c-state-point-min-lit-start',
2421 ;; and `c-state-min-scan-pos' accordingly. The return value is meaningless.
2422 (let ((p-min (point-min))
2426 (setq lit (c-state-literal-at p-min))
2428 (setq c-state-point-min-lit-type
2430 (goto-char (car lit))
2432 ((looking-at c-block-comment-start-regexp) 'c)
2433 ((looking-at c-line-comment-starter) 'c++)
2435 c-state-point-min-lit-start (car lit)
2436 c-state-min-scan-pos (cdr lit))
2437 (setq c-state-point-min-lit-type nil
2438 c-state-point-min-lit-start nil
2439 c-state-min-scan-pos p-min)))))
2442 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2443 ;; A variable which signals a brace dessert - helpful for reducing the number
2444 ;; of fruitless backward scans.
2445 (defvar c-state-brace-pair-desert nil)
2446 (make-variable-buffer-local 'c-state-brace-pair-desert)
2447 ;; Used only in `c-append-lower-brace-pair-to-state-cache'. It is set when
2448 ;; that defun has searched backwards for a brace pair and not found one. Its
2449 ;; value is either nil or a cons (PA . FROM), where PA is the position of the
2450 ;; enclosing opening paren/brace/bracket which bounds the backwards search (or
2451 ;; nil when at top level) and FROM is where the backward search started. It
2452 ;; is reset to nil in `c-invalidate-state-cache'.
2455 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2456 ;; Lowish level functions/macros which work directly on `c-state-cache', or a
2457 ;; list of like structure.
2458 (defmacro c-state-cache-top-lparen (&optional cache)
2459 ;; Return the address of the top left brace/bracket/paren recorded in CACHE
2460 ;; (default `c-state-cache') (or nil).
2461 (let ((cash (or cache 'c-state-cache)))
2462 `(if (consp (car ,cash))
2466 (defmacro c-state-cache-top-paren (&optional cache)
2467 ;; Return the address of the latest brace/bracket/paren (whether left or
2468 ;; right) recorded in CACHE (default `c-state-cache') or nil.
2469 (let ((cash (or cache 'c-state-cache)))
2470 `(if (consp (car ,cash))
2474 (defmacro c-state-cache-after-top-paren (&optional cache)
2475 ;; Return the position just after the latest brace/bracket/paren (whether
2476 ;; left or right) recorded in CACHE (default `c-state-cache') or nil.
2477 (let ((cash (or cache 'c-state-cache)))
2478 `(if (consp (car ,cash))
2481 (1+ (car ,cash))))))
2483 (defun c-get-cache-scan-pos (here)
2484 ;; From the state-cache, determine the buffer position from which we might
2485 ;; scan forward to HERE to update this cache. This position will be just
2486 ;; after a paren/brace/bracket recorded in the cache, if possible, otherwise
2487 ;; return the earliest position in the accessible region which isn't within
2488 ;; a literal. If the visible portion of the buffer is entirely within a
2489 ;; literal, return NIL.
2490 (let ((c c-state-cache) elt)
2491 ;(while (>= (or (c-state-cache-top-lparen c) 1) here)
2493 (>= (c-state-cache-top-lparen c) here))
2499 (if (> (cdr elt) here)
2503 ((<= (c-state-get-min-scan-pos) here)
2504 (c-state-get-min-scan-pos))
2507 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2508 ;; Variables which keep track of preprocessor constructs.
2509 (defvar c-state-old-cpp-beg-marker nil)
2510 (make-variable-buffer-local 'c-state-old-cpp-beg-marker)
2511 (defvar c-state-old-cpp-beg nil)
2512 (make-variable-buffer-local 'c-state-old-cpp-beg)
2513 (defvar c-state-old-cpp-end-marker nil)
2514 (make-variable-buffer-local 'c-state-old-cpp-end-marker)
2515 (defvar c-state-old-cpp-end nil)
2516 (make-variable-buffer-local 'c-state-old-cpp-end)
2517 ;; These are the limits of the macro containing point at the previous call of
2518 ;; `c-parse-state', or nil.
2520 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2521 ;; Defuns which analyze the buffer, yet don't change `c-state-cache'.
2522 (defun c-state-balance-parens-backwards (here- here+ top)
2523 ;; Return the position of the opening paren/brace/bracket before HERE- which
2524 ;; matches the outermost close p/b/b between HERE+ and TOP. Except when
2525 ;; there's a macro, HERE- and HERE+ are the same. Like this:
2527 ;; ............................................
2529 ;; ( [ ( .........#macro.. ) ( ) ] )
2532 ;; return HERE- HERE+ TOP
2534 ;; If there aren't enough opening paren/brace/brackets, return the position
2535 ;; of the outermost one found, or HERE- if there are none. If there are no
2536 ;; closing p/b/bs between HERE+ and TOP, return HERE-. HERE-/+ and TOP
2537 ;; must not be inside literals. Only the accessible portion of the buffer
2540 ;; PART 1: scan from `here+' up to `top', accumulating ")"s which enclose
2541 ;; `here'. Go round the next loop each time we pass over such a ")". These
2542 ;; probably match "("s before `here-'.
2543 (let (pos pa ren+1 lonely-rens)
2546 (narrow-to-region (point-min) top) ; This can move point, sometimes.
2550 (setq ren+1 (c-sc-scan-lists pos 1 1)) ; might signal
2551 (setq lonely-rens (cons ren+1 lonely-rens)
2554 ;; PART 2: Scan back before `here-' searching for the "("s
2555 ;; matching/mismatching the ")"s found above. We only need to direct the
2556 ;; caller to scan when we've encountered unmatched right parens.
2561 (and lonely-rens ; actual values aren't used.
2562 (setq pa (c-sc-scan-lists pos -1 1)))
2564 (setq lonely-rens (cdr lonely-rens)))))
2567 (defun c-parse-state-get-strategy (here good-pos)
2568 ;; Determine the scanning strategy for adjusting `c-parse-state', attempting
2569 ;; to minimize the amount of scanning. HERE is the pertinent position in
2570 ;; the buffer, GOOD-POS is a position where `c-state-cache' (possibly with
2571 ;; its head trimmed) is known to be good, or nil if there is no such
2574 ;; The return value is a list, one of the following:
2576 ;; o - ('forward START-POINT) - scan forward from START-POINT,
2577 ;; which is not less than the highest position in `c-state-cache' below HERE,
2578 ;; which is after GOOD-POS.
2579 ;; o - ('backward nil) - scan backwards (from HERE).
2580 ;; o - ('back-and-forward START-POINT) - like 'forward, but when HERE is earlier
2582 ;; o - ('IN-LIT nil) - point is inside the literal containing point-min.
2583 (let ((cache-pos (c-get-cache-scan-pos here)) ; highest position below HERE in cache (or 1)
2584 strategy ; 'forward, 'backward, or 'IN-LIT.
2586 (setq good-pos (or good-pos (c-state-get-min-scan-pos)))
2588 ((< here (c-state-get-min-scan-pos))
2589 (setq strategy 'IN-LIT))
2591 (setq strategy 'forward
2592 start-point (max good-pos cache-pos)))
2593 ((< (- good-pos here) (- here cache-pos)) ; FIXME!!! ; apply some sort of weighting.
2594 (setq strategy 'backward))
2596 (setq strategy 'back-and-forward
2597 start-point cache-pos)))
2598 (list strategy start-point)))
2601 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2602 ;; Routines which change `c-state-cache' and associated values.
2603 (defun c-renarrow-state-cache ()
2604 ;; The region (more precisely, point-min) has changed since we
2605 ;; calculated `c-state-cache'. Amend `c-state-cache' accordingly.
2606 (if (< (point-min) c-state-point-min)
2607 ;; If point-min has MOVED BACKWARDS then we drop the state completely.
2608 ;; It would be possible to do a better job here and recalculate the top
2611 (c-state-mark-point-min-literal)
2612 (setq c-state-cache nil
2613 c-state-cache-good-pos c-state-min-scan-pos
2614 c-state-brace-pair-desert nil))
2616 ;; point-min has MOVED FORWARD.
2618 ;; Is the new point-min inside a (different) literal?
2619 (unless (and c-state-point-min-lit-start ; at prev. point-min
2620 (< (point-min) (c-state-get-min-scan-pos)))
2621 (c-state-mark-point-min-literal))
2623 ;; Cut off a bit of the tail from `c-state-cache'.
2624 (let ((ptr (cons nil c-state-cache))
2626 (while (and (setq pa (c-state-cache-top-lparen (cdr ptr)))
2627 (>= pa (point-min)))
2628 (setq ptr (cdr ptr)))
2631 (if (eq (cdr ptr) c-state-cache)
2632 (setq c-state-cache nil
2633 c-state-cache-good-pos c-state-min-scan-pos)
2635 (setq c-state-cache-good-pos (1+ (c-state-cache-top-lparen))))
2638 (setq c-state-point-min (point-min)))
2640 (defun c-append-lower-brace-pair-to-state-cache (from here &optional upper-lim)
2641 ;; If there is a brace pair preceding FROM in the buffer, at the same level
2642 ;; of nesting (not necessarily immediately preceding), push a cons onto
2643 ;; `c-state-cache' to represent it. FROM must not be inside a literal. If
2644 ;; UPPER-LIM is non-nil, we append the highest brace pair whose "}" is below
2647 ;; Return non-nil when this has been done.
2649 ;; The situation it copes with is this transformation:
2651 ;; OLD: { (.) {...........}
2655 ;; NEW: { {....} (.) {.........
2657 ;; LOWER BRACE PAIR HERE or HERE
2659 ;; This routine should be fast. Since it can get called a LOT, we maintain
2660 ;; `c-state-brace-pair-desert', a small cache of "failures", such that we
2661 ;; reduce the time wasted in repeated fruitless searches in brace deserts.
2665 (cache-pos (c-state-cache-top-lparen)) ; might be nil.
2666 (macro-start-or-from
2667 (progn (goto-char from)
2668 (c-beginning-of-macro)
2670 (bra ; Position of "{".
2671 ;; Don't start scanning in the middle of a CPP construct unless
2672 ;; it contains HERE - these constructs, in Emacs, are "commented
2673 ;; out" with category properties.
2674 (if (eq (c-get-char-property macro-start-or-from 'category)
2678 ce) ; Position of "}"
2679 (or upper-lim (setq upper-lim from))
2681 ;; If we're essentially repeating a fruitless search, just give up.
2682 (unless (and c-state-brace-pair-desert
2683 (eq cache-pos (car c-state-brace-pair-desert))
2684 (or (null (car c-state-brace-pair-desert))
2685 (> from (car c-state-brace-pair-desert)))
2686 (<= from (cdr c-state-brace-pair-desert)))
2687 ;; DESERT-LIM. Avoid repeated searching through the cached desert.
2689 (and c-state-brace-pair-desert
2690 (eq cache-pos (car c-state-brace-pair-desert))
2691 (>= from (cdr c-state-brace-pair-desert))
2692 (cdr c-state-brace-pair-desert)))
2693 ;; CACHE-LIM. This limit will be necessary when an opening
2694 ;; paren at `cache-pos' has just had its matching close paren
2695 ;; inserted into the buffer. `cache-pos' continues to be a
2696 ;; search bound, even though the algorithm below would skip
2697 ;; over the new paren pair.
2698 (cache-lim (and cache-pos (< cache-pos from) cache-pos)))
2701 ((and desert-lim cache-lim)
2702 (max desert-lim cache-lim))
2706 ;; The top limit is EOB to ensure that `bra' is inside the
2707 ;; accessible part of the buffer at the next scan operation.
2708 (1+ (buffer-size))))
2710 ;; In the next pair of nested loops, the inner one moves back past a
2711 ;; pair of (mis-)matching parens or brackets; the outer one moves
2712 ;; back over a sequence of unmatched close brace/paren/bracket each
2718 (and (setq ce (c-sc-scan-lists bra -1 -1)) ; back past )/]/}; might signal
2719 (setq bra (c-sc-scan-lists ce -1 1)) ; back past (/[/{; might signal
2720 (or (> bra here) ;(> ce here)
2723 (or (not (eq (char-after bra) ?\{))
2724 (and (goto-char bra)
2725 (c-beginning-of-macro)
2726 (< (point) macro-start-or-from))))))))
2727 (and ce (< ce bra)))
2728 (setq bra ce)) ; If we just backed over an unbalanced closing
2731 (if (and ce (< ce here) (< bra ce) (eq (char-after bra) ?\{))
2732 ;; We've found the desired brace-pair.
2734 (setq new-cons (cons bra (1+ ce)))
2736 ((consp (car c-state-cache))
2737 (setcar c-state-cache new-cons))
2738 ((and (numberp (car c-state-cache)) ; probably never happens
2739 (< ce (car c-state-cache)))
2740 (setcdr c-state-cache
2741 (cons new-cons (cdr c-state-cache))))
2742 (t (setq c-state-cache (cons new-cons c-state-cache)))))
2744 ;; We haven't found a brace pair. Record this in the cache.
2745 (setq c-state-brace-pair-desert
2746 (cons (if (and ce (< bra ce) (> ce here)) ; {..} straddling HERE?
2749 (min here from)))))))))
2751 (defsubst c-state-push-any-brace-pair (bra+1 macro-start-or-here)
2752 ;; If BRA+1 is nil, do nothing. Otherwise, BRA+1 is the buffer position
2753 ;; following a {, and that brace has a (mis-)matching } (or ]), and we
2754 ;; "push" "a" brace pair onto `c-state-cache'.
2756 ;; Here "push" means overwrite the top element if it's itself a brace-pair,
2757 ;; otherwise push it normally.
2759 ;; The brace pair we push is normally the one surrounding BRA+1, but if the
2760 ;; latter is inside a macro, not being a macro containing
2761 ;; MACRO-START-OR-HERE, we scan backwards through the buffer for a non-macro
2762 ;; base pair. This latter case is assumed to be rare.
2764 ;; Note: POINT is not preserved in this routine.
2766 (if (or (> bra+1 macro-start-or-here)
2767 (progn (goto-char bra+1)
2768 (not (c-beginning-of-macro))))
2770 (cons (cons (1- bra+1)
2771 (c-sc-scan-lists bra+1 1 1))
2772 (if (consp (car c-state-cache))
2775 ;; N.B. This defsubst codes one method for the simple, normal case,
2776 ;; and a more sophisticated, slower way for the general case. Don't
2777 ;; eliminate this defsubst - it's a speed optimization.
2778 (c-append-lower-brace-pair-to-state-cache (1- bra+1) (point-max)))))
2780 (defun c-append-to-state-cache (from here)
2781 ;; Scan the buffer from FROM to HERE, adding elements into `c-state-cache'
2782 ;; for braces etc. Return a candidate for `c-state-cache-good-pos'.
2784 ;; FROM must be after the latest brace/paren/bracket in `c-state-cache', if
2785 ;; any. Typically, it is immediately after it. It must not be inside a
2787 (let ((here-bol (c-point 'bol here))
2788 (macro-start-or-here
2789 (save-excursion (goto-char here)
2790 (if (c-beginning-of-macro)
2793 pa+1 ; pos just after an opening PAren (or brace).
2794 (ren+1 from) ; usually a pos just after an closing paREN etc.
2795 ; Is actually the pos. to scan for a (/{/[ from,
2796 ; which sometimes is after a silly )/}/].
2797 paren+1 ; Pos after some opening or closing paren.
2798 paren+1s ; A list of `paren+1's; used to determine a
2800 bra+1 ; just after L bra-ce.
2801 bra+1s ; list of OLD values of bra+1.
2802 mstart) ; start of a macro.
2806 (narrow-to-region (point-min) here)
2807 ;; Each time round the following loop, we enter a successively deeper
2808 ;; level of brace/paren nesting. (Except sometimes we "continue at
2809 ;; the existing level".) `pa+1' is a pos inside an opening
2810 ;; brace/paren/bracket, usually just after it.
2813 ;; Each time round the next loop moves forward over an opening then
2814 ;; a closing brace/bracket/paren. This loop is white hot, so it
2815 ;; plays ugly tricks to go fast. DON'T PUT ANYTHING INTO THIS
2816 ;; LOOP WHICH ISN'T ABSOLUTELY NECESSARY!!! It terminates when a
2817 ;; call of `scan-lists' signals an error, which happens when there
2818 ;; are no more b/b/p's to scan.
2821 (setq pa+1 (c-sc-scan-lists ren+1 1 -1) ; Into (/{/[; might signal
2822 paren+1s (cons pa+1 paren+1s))
2823 (setq ren+1 (c-sc-scan-lists pa+1 1 1)) ; Out of )/}/]; might signal
2824 (if (and (eq (char-before pa+1) ?{)) ; Check for a macro later.
2826 (setcar paren+1s ren+1)))
2828 (if (and pa+1 (> pa+1 ren+1))
2829 ;; We've just entered a deeper nesting level.
2831 ;; Insert the brace pair (if present) and the single open
2832 ;; paren/brace/bracket into `c-state-cache' It cannot be
2833 ;; inside a macro, except one around point, because of what
2834 ;; `c-neutralize-syntax-in-CPP' has done.
2835 (c-state-push-any-brace-pair bra+1 macro-start-or-here)
2836 ;; Insert the opening brace/bracket/paren position.
2837 (setq c-state-cache (cons (1- pa+1) c-state-cache))
2838 ;; Clear admin stuff for the next more nested part of the scan.
2839 (setq ren+1 pa+1 pa+1 nil bra+1 nil bra+1s nil)
2840 t) ; Carry on the loop
2842 ;; All open p/b/b's at this nesting level, if any, have probably
2843 ;; been closed by matching/mismatching ones. We're probably
2844 ;; finished - we just need to check for having found an
2845 ;; unmatched )/}/], which we ignore. Such a )/}/] can't be in a
2846 ;; macro, due the action of `c-neutralize-syntax-in-CPP'.
2847 (c-safe (setq ren+1 (c-sc-scan-lists ren+1 1 1)))))) ; acts as loop control.
2849 ;; Record the final, innermost, brace-pair if there is one.
2850 (c-state-push-any-brace-pair bra+1 macro-start-or-here)
2852 ;; Determine a good pos
2853 (while (and (setq paren+1 (car paren+1s))
2854 (> (if (> paren+1 macro-start-or-here)
2857 (setq mstart (and (c-beginning-of-macro)
2859 (or mstart paren+1))
2861 (setq paren+1s (cdr paren+1s)))
2863 ((and paren+1 mstart)
2864 (min paren+1 mstart))
2868 (defun c-remove-stale-state-cache (start-point here pps-point)
2869 ;; Remove stale entries from the `c-cache-state', i.e. those which will
2870 ;; not be in it when it is amended for position HERE. This may involve
2871 ;; replacing a CONS element for a brace pair containing HERE with its car.
2872 ;; Additionally, the "outermost" open-brace entry before HERE will be
2873 ;; converted to a cons if the matching close-brace is below HERE.
2875 ;; START-POINT is a "maximal" "safe position" - there must be no open
2876 ;; parens/braces/brackets between START-POINT and HERE.
2878 ;; As a second thing, calculate the result of parse-partial-sexp at
2879 ;; PPS-POINT, w.r.t. START-POINT. The motivation here is that
2880 ;; `c-state-cache-good-pos' may become PPS-POINT, but the caller may need to
2881 ;; adjust it to get outside a string/comment. (Sorry about this! The code
2882 ;; needs to be FAST).
2884 ;; Return a list (GOOD-POS SCAN-BACK-POS CONS-SEPARATED PPS-STATE), where
2885 ;; o - GOOD-POS is a position where the new value `c-state-cache' is known
2886 ;; to be good (we aim for this to be as high as possible);
2887 ;; o - SCAN-BACK-POS, if not nil, indicates there may be a brace pair
2888 ;; preceding POS which needs to be recorded in `c-state-cache'. It is a
2889 ;; position to scan backwards from. It is the position of the "{" of the
2890 ;; last element to be removed from `c-state-cache', when that elt is a
2891 ;; cons, otherwise nil.
2892 ;; o - CONS-SEPARATED is t when a cons element in `c-state-cache' has been
2893 ;; replaced by its car because HERE lies inside the brace pair represented
2895 ;; o - PPS-STATE is the parse-partial-sexp state at PPS-POINT.
2898 (narrow-to-region 1 (point-max))
2899 (let* ((in-macro-start ; start of macro containing HERE or nil.
2902 (and (c-beginning-of-macro)
2904 (start-point-actual-macro-start ; Start of macro containing
2905 ; start-point or nil
2906 (and (< start-point here)
2908 (goto-char start-point)
2909 (and (c-beginning-of-macro)
2911 (start-point-actual-macro-end ; End of this macro, (maybe
2913 (and start-point-actual-macro-start
2915 (goto-char start-point-actual-macro-start)
2918 pps-state ; Will be 9 or 10 elements long.
2920 upper-lim ; ,beyond which `c-state-cache' entries are removed
2923 pair-beg pps-point-state target-depth)
2925 ;; Remove entries beyond HERE. Also remove any entries inside
2926 ;; a macro, unless HERE is in the same macro.
2928 (if (or (null c-state-old-cpp-beg)
2929 (and (> here c-state-old-cpp-beg)
2930 (< here c-state-old-cpp-end)))
2932 (min here c-state-old-cpp-beg)))
2933 (while (and c-state-cache (>= (c-state-cache-top-lparen) upper-lim))
2934 (setq scan-back-pos (car-safe (car c-state-cache)))
2935 (setq c-state-cache (cdr c-state-cache)))
2937 ;; If `upper-lim' is inside the last recorded brace pair, remove its
2938 ;; RBrace and indicate we'll need to search backwards for a previous
2940 (when (and c-state-cache
2941 (consp (car c-state-cache))
2942 (> (cdar c-state-cache) upper-lim))
2943 (setcar c-state-cache (caar c-state-cache))
2944 (setq scan-back-pos (car c-state-cache)
2947 ;; The next loop jumps forward out of a nested level of parens each
2948 ;; time round; the corresponding elements in `c-state-cache' are
2949 ;; removed. `pos' is just after the brace-pair or the open paren at
2950 ;; (car c-state-cache). There can be no open parens/braces/brackets
2951 ;; between `start-point'/`start-point-actual-macro-start' and HERE,
2952 ;; due to the interface spec to this function.
2953 (setq pos (if (and start-point-actual-macro-end
2954 (not (eq start-point-actual-macro-start
2956 (1+ start-point-actual-macro-end) ; get outside the macro as
2957 ; marked by a `category' text property.
2960 (while (and c-state-cache
2961 (or (numberp (car c-state-cache)) ; Have we a { at all?
2962 (cdr c-state-cache))
2965 ((null pps-state) ; first time through
2966 (setq target-depth -1))
2967 ((eq (car pps-state) target-depth) ; found closing ),},]
2968 (setq target-depth (1- (car pps-state))))
2969 ;; Do nothing when we've merely reached pps-point.
2974 (c-sc-parse-partial-sexp
2975 (point) (if (< (point) pps-point) pps-point here)
2979 (if (= (point) pps-point)
2980 (setq pps-point-state pps-state))
2982 (when (eq (car pps-state) target-depth)
2983 (setq pos (point)) ; POS is now just after an R-paren/brace.
2985 ((and (consp (car c-state-cache))
2986 (eq (point) (cdar c-state-cache)))
2987 ;; We've just moved out of the paren pair containing the brace-pair
2988 ;; at (car c-state-cache). `pair-beg' is where the open paren is,
2989 ;; and is potentially where the open brace of a cons in
2990 ;; c-state-cache will be.
2991 (setq pair-beg (car-safe (cdr c-state-cache))
2992 c-state-cache (cdr-safe (cdr c-state-cache)))) ; remove {}pair + containing Lparen.
2993 ((numberp (car c-state-cache))
2994 (setq pair-beg (car c-state-cache)
2995 c-state-cache (cdr c-state-cache))) ; remove this
2997 ((numberp (cadr c-state-cache))
2998 (setq pair-beg (cadr c-state-cache)
2999 c-state-cache (cddr c-state-cache))) ; Remove a paren pair
3000 ; together with enclosed brace pair.
3001 ;; (t nil) ; Ignore an unmated Rparen.
3004 (if (< (point) pps-point)
3005 (setq pps-state (c-sc-parse-partial-sexp
3007 nil nil ; TARGETDEPTH, STOPBEFORE
3010 ;; If the last paren pair we moved out of was actually a brace pair,
3011 ;; insert it into `c-state-cache'.
3012 (when (and pair-beg (eq (char-after pair-beg) ?{))
3013 (if (consp (car-safe c-state-cache))
3014 (setq c-state-cache (cdr c-state-cache)))
3015 (setq c-state-cache (cons (cons pair-beg pos)
3018 (list pos scan-back-pos cons-separated pps-state)))))
3020 (defun c-remove-stale-state-cache-backwards (here)
3021 ;; Strip stale elements of `c-state-cache' by moving backwards through the
3022 ;; buffer, and inform the caller of the scenario detected.
3024 ;; HERE is the position we're setting `c-state-cache' for.
3025 ;; CACHE-POS (a locally bound variable) is just after the latest recorded
3026 ;; position in `c-state-cache' before HERE, or a position at or near
3027 ;; point-min which isn't in a literal.
3029 ;; This function must only be called only when (> `c-state-cache-good-pos'
3030 ;; HERE). Usually the gap between CACHE-POS and HERE is large. It is thus
3031 ;; optimized to eliminate (or minimize) scanning between these two
3034 ;; Return a three element list (GOOD-POS SCAN-BACK-POS FWD-FLAG), where:
3035 ;; o - GOOD-POS is a "good position", where `c-state-cache' is valid, or
3036 ;; could become so after missing elements are inserted into
3037 ;; `c-state-cache'. This is JUST AFTER an opening or closing
3038 ;; brace/paren/bracket which is already in `c-state-cache' or just before
3039 ;; one otherwise. exceptionally (when there's no such b/p/b handy) the BOL
3040 ;; before `here''s line, or the start of the literal containing it.
3041 ;; o - SCAN-BACK-POS, if non-nil, indicates there may be a brace pair
3042 ;; preceding POS which isn't recorded in `c-state-cache'. It is a position
3043 ;; to scan backwards from.
3044 ;; o - FWD-FLAG, if non-nil, indicates there may be parens/braces between
3045 ;; POS and HERE which aren't recorded in `c-state-cache'.
3047 ;; The comments in this defun use "paren" to mean parenthesis or square
3048 ;; bracket (as contrasted with a brace), and "(" and ")" likewise.
3050 ;; . {..} (..) (..) ( .. { } ) (...) ( .... . ..)
3052 ;; CP E here D C good
3053 (let ((cache-pos (c-get-cache-scan-pos here)) ; highest position below HERE in cache (or 1)
3054 (pos c-state-cache-good-pos)
3055 pa ren ; positions of "(" and ")"
3056 dropped-cons ; whether the last element dropped from `c-state-cache'
3057 ; was a cons (representing a brace-pair)
3058 good-pos ; see above.
3059 lit ; (START . END) of a literal containing some point.
3060 here-lit-start here-lit-end ; bounds of literal containing `here'
3062 here- here+ ; start/end of macro around HERE, or HERE
3063 (here-bol (c-point 'bol here))
3064 (too-far-back (max (- here c-state-cache-too-far) (point-min))))
3066 ;; Remove completely irrelevant entries from `c-state-cache'.
3067 (while (and c-state-cache
3068 (>= (setq pa (c-state-cache-top-lparen)) here))
3069 (setq dropped-cons (consp (car c-state-cache)))
3070 (setq c-state-cache (cdr c-state-cache))
3072 ;; At this stage, (> pos here);
3073 ;; (< (c-state-cache-top-lparen) here) (or is nil).
3076 ((and (consp (car c-state-cache))
3077 (> (cdar c-state-cache) here))
3078 ;; CASE 1: The top of the cache is a brace pair which now encloses
3079 ;; `here'. As good-pos, return the address. of the "{". Since we've no
3080 ;; knowledge of what's inside these braces, we have no alternative but
3081 ;; to direct the caller to scan the buffer from the opening brace.
3082 (setq pos (caar c-state-cache))
3083 (setcar c-state-cache pos)
3084 (list (1+ pos) pos t)) ; return value. We've just converted a brace pair
3085 ; entry into a { entry, so the caller needs to
3086 ; search for a brace pair before the {.
3088 ;; `here' might be inside a literal. Check for this.
3090 (setq lit (c-state-literal-at here)
3091 here-lit-start (or (car lit) here)
3092 here-lit-end (or (cdr lit) here))
3093 ;; Has `here' just "newly entered" a macro?
3095 (goto-char here-lit-start)
3096 (if (and (c-beginning-of-macro)
3097 (or (null c-state-old-cpp-beg)
3098 (not (= (point) c-state-old-cpp-beg))))
3100 (setq here- (point))
3102 (setq here+ (point)))
3103 (setq here- here-lit-start
3104 here+ here-lit-end)))
3106 ;; `here' might be nested inside any depth of parens (or brackets but
3107 ;; not braces). Scan backwards to find the outermost such opening
3108 ;; paren, if there is one. This will be the scan position to return.
3110 (narrow-to-region cache-pos (point-max))
3111 (setq pos (c-state-balance-parens-backwards here- here+ pos)))
3112 nil)) ; for the cond
3114 ((< pos here-lit-start)
3115 ;; CASE 2: Address of outermost ( or [ which now encloses `here', but
3116 ;; didn't enclose the (previous) `c-state-cache-good-pos'. If there is
3117 ;; a brace pair preceding this, it will already be in `c-state-cache',
3118 ;; unless there was a brace pair after it, i.e. there'll only be one to
3119 ;; scan for if we've just deleted one.
3120 (list pos (and dropped-cons pos) t)) ; Return value.
3122 ;; `here' isn't enclosed in a (previously unrecorded) bracket/paren.
3123 ;; Further forward scanning isn't needed, but we still need to find a
3124 ;; GOOD-POS. Step out of all enclosing "("s on HERE's line.
3127 (narrow-to-region here-bol (point-max))
3128 (setq pos here-lit-start)
3129 (c-safe (while (setq pa (c-sc-scan-lists pos -1 1))
3130 (setq pos pa)))) ; might signal
3131 nil)) ; for the cond
3134 (narrow-to-region too-far-back (point-max))
3135 (setq ren (c-safe (c-sc-scan-lists pos -1 -1))))
3137 ;; CASE 3: After a }/)/] before `here''s BOL.
3138 (list (1+ ren) (and dropped-cons pos) nil)) ; Return value
3141 ;; CASE 4; Best of a bad job: BOL before `here-bol', or beginning of
3142 ;; literal containing it.
3143 (setq good-pos (c-state-lit-beg (c-point 'bopl here-bol)))
3144 (list good-pos (and dropped-cons good-pos) nil)))))
3147 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3148 ;; Externally visible routines.
3150 (defun c-state-cache-init ()
3151 (setq c-state-cache nil
3152 c-state-cache-good-pos 1
3153 c-state-nonlit-pos-cache nil
3154 c-state-nonlit-pos-cache-limit 1
3155 c-state-semi-nonlit-pos-cache nil
3156 c-state-semi-nonlit-pos-cache-limit 1
3157 c-state-brace-pair-desert nil
3159 c-state-point-min-lit-type nil
3160 c-state-point-min-lit-start nil
3161 c-state-min-scan-pos 1
3162 c-state-old-cpp-beg nil
3163 c-state-old-cpp-end nil)
3164 (c-state-mark-point-min-literal))
3166 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3167 ;; Debugging routines to dump `c-state-cache' in a "replayable" form.
3168 ;; (defmacro c-sc-de (elt) ; "c-state-cache-dump-element"
3169 ;; `(format ,(concat "(setq " (symbol-name elt) " %s) ") ,elt))
3170 ;; (defmacro c-sc-qde (elt) ; "c-state-cache-quote-dump-element"
3171 ;; `(format ,(concat "(setq " (symbol-name elt) " '%s) ") ,elt))
3172 ;; (defun c-state-dump ()
3173 ;; ;; For debugging.
3176 ;; (c-sc-qde c-state-cache)
3177 ;; (c-sc-de c-state-cache-good-pos)
3178 ;; (c-sc-qde c-state-nonlit-pos-cache)
3179 ;; (c-sc-de c-state-nonlit-pos-cache-limit)
3180 ;; (c-sc-qde c-state-brace-pair-desert)
3181 ;; (c-sc-de c-state-point-min)
3182 ;; (c-sc-de c-state-point-min-lit-type)
3183 ;; (c-sc-de c-state-point-min-lit-start)
3184 ;; (c-sc-de c-state-min-scan-pos)
3185 ;; (c-sc-de c-state-old-cpp-beg)
3186 ;; (c-sc-de c-state-old-cpp-end)))
3187 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3189 (defun c-invalidate-state-cache-1 (here)
3190 ;; Invalidate all info on `c-state-cache' that applies to the buffer at HERE
3191 ;; or higher and set `c-state-cache-good-pos' accordingly. The cache is
3192 ;; left in a consistent state.
3194 ;; This is much like `c-whack-state-after', but it never changes a paren
3195 ;; pair element into an open paren element. Doing that would mean that the
3196 ;; new open paren wouldn't have the required preceding paren pair element.
3198 ;; This function is called from c-after-change.
3200 ;; The caches of non-literals:
3201 ;; Note that we use "<=" for the possibility of the second char of a two-char
3202 ;; comment opener being typed; this would invalidate any cache position at
3204 (if (<= here c-state-nonlit-pos-cache-limit)
3205 (setq c-state-nonlit-pos-cache-limit (1- here)))
3206 (if (<= here c-state-semi-nonlit-pos-cache-limit)
3207 (setq c-state-semi-nonlit-pos-cache-limit (1- here)))
3210 ;; Case 1: if `here' is in a literal containing point-min, everything
3211 ;; becomes (or is already) nil.
3212 (if (or (null c-state-cache-good-pos)
3213 (< here (c-state-get-min-scan-pos)))
3214 (setq c-state-cache nil
3215 c-state-cache-good-pos nil
3216 c-state-min-scan-pos nil)
3218 ;; Truncate `c-state-cache' and set `c-state-cache-good-pos' to a value
3219 ;; below `here'. To maintain its consistency, we may need to insert a new
3221 (let (open-paren-in-column-0-is-defun-start
3222 (here-bol (c-point 'bol here))
3223 too-high-pa ; recorded {/(/[ next above here, or nil.
3224 dropped-cons ; was the last removed element a brace pair?
3226 ;; The easy bit - knock over-the-top bits off `c-state-cache'.
3227 (while (and c-state-cache
3228 (>= (setq pa (c-state-cache-top-paren)) here))
3229 (setq dropped-cons (consp (car c-state-cache))
3230 too-high-pa (c-state-cache-top-lparen)
3231 c-state-cache (cdr c-state-cache)))
3233 ;; Do we need to add in an earlier brace pair, having lopped one off?
3234 (if (and dropped-cons
3235 (< too-high-pa (+ here c-state-cache-too-far)))
3236 (c-append-lower-brace-pair-to-state-cache too-high-pa here here-bol))
3237 (setq c-state-cache-good-pos (or (c-state-cache-after-top-paren)
3238 (c-state-get-min-scan-pos)))))
3240 ;; The brace-pair desert marker:
3241 (when (car c-state-brace-pair-desert)
3242 (if (< here (car c-state-brace-pair-desert))
3243 (setq c-state-brace-pair-desert nil)
3244 (if (< here (cdr c-state-brace-pair-desert))
3245 (setcdr c-state-brace-pair-desert here)))))
3247 (defun c-parse-state-1 ()
3248 ;; Find and record all noteworthy parens between some good point earlier in
3249 ;; the file and point. That good point is at least the beginning of the
3250 ;; top-level construct we are in, or the beginning of the preceding
3251 ;; top-level construct if we aren't in one.
3253 ;; The returned value is a list of the noteworthy parens with the last one
3254 ;; first. If an element in the list is an integer, it's the position of an
3255 ;; open paren (of any type) which has not been closed before the point. If
3256 ;; an element is a cons, it gives the position of a closed BRACE paren
3257 ;; pair[*]; the car is the start brace position and the cdr is the position
3258 ;; following the closing brace. Only the last closed brace paren pair
3259 ;; before each open paren and before the point is recorded, and thus the
3260 ;; state never contains two cons elements in succession. When a close brace
3261 ;; has no matching open brace (e.g., the matching brace is outside the
3262 ;; visible region), it is not represented in the returned value.
3264 ;; [*] N.B. The close "brace" might be a mismatching close bracket or paren.
3265 ;; This defun explicitly treats mismatching parens/braces/brackets as
3266 ;; matching. It is the open brace which makes it a "brace" pair.
3268 ;; If POINT is within a macro, open parens and brace pairs within
3269 ;; THIS macro MIGHT be recorded. This depends on whether their
3270 ;; syntactic properties have been suppressed by
3271 ;; `c-neutralize-syntax-in-CPP'. This might need fixing (2008-12-11).
3273 ;; Currently no characters which are given paren syntax with the
3274 ;; syntax-table property are recorded, i.e. angle bracket arglist
3275 ;; parens are never present here. Note that this might change.
3277 ;; BUG: This function doesn't cope entirely well with unbalanced
3278 ;; parens in macros. (2008-12-11: this has probably been resolved
3279 ;; by the function `c-neutralize-syntax-in-CPP'.) E.g. in the
3280 ;; following case the brace before the macro isn't balanced with the
3287 ;; Note to maintainers: this function DOES get called with point
3288 ;; within comments and strings, so don't assume it doesn't!
3290 ;; This function might do hidden buffer changes.
3291 (let* ((here (point))
3292 (here-bopl (c-point 'bopl))
3293 open-paren-in-column-0-is-defun-start
3294 strategy ; 'forward, 'backward etc..
3295 ;; Candidate positions to start scanning from:
3296 cache-pos ; highest position below HERE already existing in
3299 start-point ; (when scanning forward) a place below HERE where there
3300 ; are no open parens/braces between it and HERE.
3304 scan-backward-pos scan-forward-p) ; used for 'backward.
3305 ;; If POINT-MIN has changed, adjust the cache
3306 (unless (= (point-min) c-state-point-min)
3307 (c-renarrow-state-cache))
3310 (setq res (c-parse-state-get-strategy here c-state-cache-good-pos)
3312 start-point (cadr res))
3316 ((memq strategy '(forward back-and-forward))
3317 (setq res (c-remove-stale-state-cache start-point here here-bopl))
3318 (setq cache-pos (car res)
3319 scan-backward-pos (cadr res)
3320 cons-separated (car (cddr res))
3321 bopl-state (cadr (cddr res))) ; will be nil if (< here-bopl
3323 (if (and scan-backward-pos
3324 (or cons-separated (eq strategy 'forward))) ;scan-backward-pos
3325 (c-append-lower-brace-pair-to-state-cache scan-backward-pos here))
3327 (c-append-to-state-cache cache-pos here))
3328 (setq c-state-cache-good-pos
3330 (< good-pos (- here c-state-cache-too-far)))
3331 (c-state-cache-non-literal-place here-bopl bopl-state)
3334 ((eq strategy 'backward)
3335 (setq res (c-remove-stale-state-cache-backwards here)
3337 scan-backward-pos (cadr res)
3338 scan-forward-p (car (cddr res)))
3339 (if scan-backward-pos
3340 (c-append-lower-brace-pair-to-state-cache scan-backward-pos here))
3341 (setq c-state-cache-good-pos
3343 (c-append-to-state-cache good-pos here)
3346 (t ; (eq strategy 'IN-LIT)
3347 (setq c-state-cache nil
3348 c-state-cache-good-pos nil))))
3352 (defun c-invalidate-state-cache (here)
3353 ;; This is a wrapper over `c-invalidate-state-cache-1'.
3355 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3356 ;; of all parens in preprocessor constructs, except for any such construct
3357 ;; containing point. We can then call `c-invalidate-state-cache-1' without
3358 ;; worrying further about macros and template delimiters.
3359 (if (eval-when-compile (memq 'category-properties c-emacs-features))
3361 (c-with-<->-as-parens-suppressed
3362 (if (and c-state-old-cpp-beg
3363 (< c-state-old-cpp-beg here))
3364 (c-with-all-but-one-cpps-commented-out
3366 (min c-state-old-cpp-end here)
3367 (c-invalidate-state-cache-1 here))
3368 (c-with-cpps-commented-out
3369 (c-invalidate-state-cache-1 here))))
3371 (c-invalidate-state-cache-1 here)))
3373 (defmacro c-state-maybe-marker (place marker)
3374 ;; If PLACE is non-nil, return a marker marking it, otherwise nil.
3375 ;; We (re)use MARKER.
3377 (or ,marker (setq ,marker (make-marker)))
3378 (set-marker ,marker ,place)))
3380 (defun c-parse-state ()
3381 ;; This is a wrapper over `c-parse-state-1'. See that function for a
3382 ;; description of the functionality and return value.
3384 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3385 ;; of all parens in preprocessor constructs, except for any such construct
3386 ;; containing point. We can then call `c-parse-state-1' without worrying
3387 ;; further about macros and template delimiters.
3388 (let (here-cpp-beg here-cpp-end)
3390 (when (c-beginning-of-macro)
3391 (setq here-cpp-beg (point))
3393 (> (setq here-cpp-end (c-syntactic-end-of-macro))
3395 (setq here-cpp-beg nil here-cpp-end nil))))
3396 ;; FIXME!!! Put in a `condition-case' here to protect the integrity of the
3399 (if (eval-when-compile (memq 'category-properties c-emacs-features))
3401 (c-with-<->-as-parens-suppressed
3402 (if (and here-cpp-beg (> here-cpp-end here-cpp-beg))
3403 (c-with-all-but-one-cpps-commented-out
3404 here-cpp-beg here-cpp-end
3406 (c-with-cpps-commented-out
3407 (c-parse-state-1))))
3410 (setq c-state-old-cpp-beg
3411 (c-state-maybe-marker here-cpp-beg c-state-old-cpp-beg-marker)
3413 (c-state-maybe-marker here-cpp-end c-state-old-cpp-end-marker)))))
3415 ;; Debug tool to catch cache inconsistencies. This is called from
3417 (defvar c-debug-parse-state nil)
3418 (unless (fboundp 'c-real-parse-state)
3419 (fset 'c-real-parse-state (symbol-function 'c-parse-state)))
3420 (cc-bytecomp-defun c-real-parse-state)
3422 (defvar c-parse-state-point nil)
3423 (defvar c-parse-state-state nil)
3424 (make-variable-buffer-local 'c-parse-state-state)
3425 (defun c-record-parse-state-state ()
3426 (setq c-parse-state-point (point))
3427 (setq c-parse-state-state
3430 (let ((val (symbol-value arg)))
3432 (cond ((consp val) (copy-tree val))
3433 ((markerp val) (copy-marker val))
3436 c-state-cache-good-pos
3437 c-state-nonlit-pos-cache
3438 c-state-nonlit-pos-cache-limit
3439 c-state-semi-nonlit-pos-cache
3440 c-state-semi-nonlit-pos-cache-limit
3441 c-state-brace-pair-desert
3443 c-state-point-min-lit-type
3444 c-state-point-min-lit-start
3445 c-state-min-scan-pos
3448 c-parse-state-point))))
3449 (defun c-replay-parse-state-state ()
3454 (format "%s %s%s" (car arg)
3455 (if (atom (cdr arg)) "" "'")
3456 (if (markerp (cdr arg))
3457 (format "(copy-marker %s)" (marker-position (cdr arg)))
3459 c-parse-state-state " ")
3462 (defun c-debug-parse-state-double-cons (state)
3463 (let (state-car conses-not-ok)
3465 (setq state-car (car state)
3467 (if (and (consp state-car)
3468 (consp (car state)))
3469 (setq conses-not-ok t)))
3472 (defun c-debug-parse-state ()
3473 (let ((here (point)) (res1 (c-real-parse-state)) res2)
3474 (let ((c-state-cache nil)
3475 (c-state-cache-good-pos 1)
3476 (c-state-nonlit-pos-cache nil)
3477 (c-state-nonlit-pos-cache-limit 1)
3478 (c-state-brace-pair-desert nil)
3479 (c-state-point-min 1)
3480 (c-state-point-min-lit-type nil)
3481 (c-state-point-min-lit-start nil)
3482 (c-state-min-scan-pos 1)
3483 (c-state-old-cpp-beg nil)
3484 (c-state-old-cpp-end nil))
3485 (setq res2 (c-real-parse-state)))
3486 (unless (equal res1 res2)
3487 ;; The cache can actually go further back due to the ad-hoc way
3488 ;; the first paren is found, so try to whack off a bit of its
3489 ;; start before complaining.
3491 ;; (goto-char (or (c-least-enclosing-brace res2) (point)))
3492 ;; (c-beginning-of-defun-1)
3493 ;; (while (not (or (bobp) (eq (char-after) ?{)))
3494 ;; (c-beginning-of-defun-1))
3495 ;; (unless (equal (c-whack-state-before (point) res1) res2)
3496 ;; (message (concat "c-parse-state inconsistency at %s: "
3497 ;; "using cache: %s, from scratch: %s")
3498 ;; here res1 res2)))
3499 (message (concat "c-parse-state inconsistency at %s: "
3500 "using cache: %s, from scratch: %s")
3502 (message "Old state:")
3503 (c-replay-parse-state-state))
3505 (when (c-debug-parse-state-double-cons res1)
3506 (message "c-parse-state INVALIDITY at %s: %s"
3508 (message "Old state:")
3509 (c-replay-parse-state-state))
3511 (c-record-parse-state-state)
3512 res2 ; res1 correct a cascading series of errors ASAP
3515 (defun c-toggle-parse-state-debug (&optional arg)
3517 (setq c-debug-parse-state (c-calculate-state arg c-debug-parse-state))
3518 (fset 'c-parse-state (symbol-function (if c-debug-parse-state
3519 'c-debug-parse-state
3520 'c-real-parse-state)))
3521 (c-keep-region-active)
3522 (message "c-debug-parse-state %sabled"
3523 (if c-debug-parse-state "en" "dis")))
3524 (when c-debug-parse-state
3525 (c-toggle-parse-state-debug 1))
3528 (defun c-whack-state-before (bufpos paren-state)
3529 ;; Whack off any state information from PAREN-STATE which lies
3530 ;; before BUFPOS. Not destructive on PAREN-STATE.
3531 (let* ((newstate (list nil))
3535 (setq car (car paren-state)
3536 paren-state (cdr paren-state))
3537 (if (< (if (consp car) (car car) car) bufpos)
3538 (setq paren-state nil)
3539 (setcdr ptr (list car))
3540 (setq ptr (cdr ptr))))
3543 (defun c-whack-state-after (bufpos paren-state)
3544 ;; Whack off any state information from PAREN-STATE which lies at or
3545 ;; after BUFPOS. Not destructive on PAREN-STATE.
3548 (let ((car (car paren-state)))
3550 ;; just check the car, because in a balanced brace
3551 ;; expression, it must be impossible for the corresponding
3552 ;; close brace to be before point, but the open brace to
3554 (if (<= bufpos (car car))
3556 (if (< bufpos (cdr car))
3557 ;; its possible that the open brace is before
3558 ;; bufpos, but the close brace is after. In that
3559 ;; case, convert this to a non-cons element. The
3560 ;; rest of the state is before bufpos, so we're
3562 (throw 'done (cons (car car) (cdr paren-state)))
3563 ;; we know that both the open and close braces are
3564 ;; before bufpos, so we also know that everything else
3565 ;; on state is before bufpos.
3566 (throw 'done paren-state)))
3569 ;; it's before bufpos, so everything else should too.
3570 (throw 'done paren-state)))
3571 (setq paren-state (cdr paren-state)))
3574 (defun c-most-enclosing-brace (paren-state &optional bufpos)
3575 ;; Return the bufpos of the innermost enclosing open paren before
3576 ;; bufpos, or nil if none was found.
3578 (or bufpos (setq bufpos 134217727))
3580 (setq enclosingp (car paren-state)
3581 paren-state (cdr paren-state))
3582 (if (or (consp enclosingp)
3583 (>= enclosingp bufpos))
3584 (setq enclosingp nil)
3585 (setq paren-state nil)))
3588 (defun c-least-enclosing-brace (paren-state)
3589 ;; Return the bufpos of the outermost enclosing open paren, or nil
3590 ;; if none was found.
3593 (setq elem (car paren-state)
3594 paren-state (cdr paren-state))
3599 (defun c-safe-position (bufpos paren-state)
3600 ;; Return the closest "safe" position recorded on PAREN-STATE that
3601 ;; is higher up than BUFPOS. Return nil if PAREN-STATE doesn't
3602 ;; contain any. Return nil if BUFPOS is nil, which is useful to
3603 ;; find the closest limit before a given limit that might be nil.
3605 ;; A "safe" position is a position at or after a recorded open
3606 ;; paren, or after a recorded close paren. The returned position is
3607 ;; thus either the first position after a close brace, or the first
3608 ;; position after an enclosing paren, or at the enclosing paren in
3609 ;; case BUFPOS is immediately after it.
3614 (setq elem (car paren-state))
3616 (cond ((< (cdr elem) bufpos)
3617 (throw 'done (cdr elem)))
3618 ((< (car elem) bufpos)
3620 (throw 'done (min (1+ (car elem)) bufpos))))
3622 ;; elem is the position at and not after the opening paren, so
3623 ;; we can go forward one more step unless it's equal to
3624 ;; bufpos. This is useful in some cases avoid an extra paren
3625 ;; level between the safe position and bufpos.
3626 (throw 'done (min (1+ elem) bufpos))))
3627 (setq paren-state (cdr paren-state)))))))
3629 (defun c-beginning-of-syntax ()
3630 ;; This is used for `font-lock-beginning-of-syntax-function'. It
3631 ;; goes to the closest previous point that is known to be outside
3632 ;; any string literal or comment. `c-state-cache' is used if it has
3633 ;; a position in the vicinity.
3634 (let* ((paren-state c-state-cache)
3638 ;; Note: Similar code in `c-safe-position'. The
3639 ;; difference is that we accept a safe position at
3640 ;; the point and don't bother to go forward past open
3643 (setq elem (car paren-state))
3645 (cond ((<= (cdr elem) (point))
3646 (throw 'done (cdr elem)))
3647 ((<= (car elem) (point))
3648 (throw 'done (car elem))))
3649 (if (<= elem (point))
3650 (throw 'done elem)))
3651 (setq paren-state (cdr paren-state)))
3654 (if (> pos (- (point) 4000))
3656 ;; The position is far back. Try `c-beginning-of-defun-1'
3657 ;; (although we can't be entirely sure it will go to a position
3658 ;; outside a comment or string in current emacsen). FIXME:
3659 ;; Consult `syntax-ppss' here.
3660 (c-beginning-of-defun-1)
3665 ;; Tools for scanning identifiers and other tokens.
3667 (defun c-on-identifier ()
3668 "Return non-nil if the point is on or directly after an identifier.
3669 Keywords are recognized and not considered identifiers. If an
3670 identifier is detected, the returned value is its starting position.
3671 If an identifier ends at the point and another begins at it \(can only
3672 happen in Pike) then the point for the preceding one is returned.
3674 Note that this function might do hidden buffer changes. See the
3675 comment at the start of cc-engine.el for more info."
3677 ;; FIXME: Shouldn't this function handle "operator" in C++?
3680 (skip-syntax-backward "w_")
3684 ;; Check for a normal (non-keyword) identifier.
3685 (and (looking-at c-symbol-start)
3686 (not (looking-at c-keywords-regexp))
3689 (when (c-major-mode-is 'pike-mode)
3690 ;; Handle the `<operator> syntax in Pike.
3691 (let ((pos (point)))
3692 (skip-chars-backward "-!%&*+/<=>^|~[]()")
3693 (and (if (< (skip-chars-backward "`") 0)
3696 (eq (char-after) ?\`))
3697 (looking-at c-symbol-key)
3698 (>= (match-end 0) pos)
3701 ;; Handle the "operator +" syntax in C++.
3702 (when (and c-overloadable-operators-regexp
3703 (= (c-backward-token-2 0) 0))
3705 (cond ((and (looking-at c-overloadable-operators-regexp)
3706 (or (not c-opt-op-identifier-prefix)
3707 (and (= (c-backward-token-2 1) 0)
3708 (looking-at c-opt-op-identifier-prefix))))
3712 (and c-opt-op-identifier-prefix
3713 (looking-at c-opt-op-identifier-prefix)
3714 (= (c-forward-token-2 1) 0)
3715 (looking-at c-overloadable-operators-regexp)))
3720 (defsubst c-simple-skip-symbol-backward ()
3721 ;; If the point is at the end of a symbol then skip backward to the
3722 ;; beginning of it. Don't move otherwise. Return non-nil if point
3725 ;; This function might do hidden buffer changes.
3726 (or (< (skip-syntax-backward "w_") 0)
3727 (and (c-major-mode-is 'pike-mode)
3728 ;; Handle the `<operator> syntax in Pike.
3729 (let ((pos (point)))
3730 (if (and (< (skip-chars-backward "-!%&*+/<=>^|~[]()") 0)
3731 (< (skip-chars-backward "`") 0)
3732 (looking-at c-symbol-key)
3733 (>= (match-end 0) pos))
3738 (defun c-beginning-of-current-token (&optional back-limit)
3739 ;; Move to the beginning of the current token. Do not move if not
3740 ;; in the middle of one. BACK-LIMIT may be used to bound the
3741 ;; backward search; if given it's assumed to be at the boundary
3742 ;; between two tokens. Return non-nil if the point is moved, nil
3745 ;; This function might do hidden buffer changes.
3746 (let ((start (point)))
3747 (if (looking-at "\\w\\|\\s_")
3748 (skip-syntax-backward "w_" back-limit)
3749 (when (< (skip-syntax-backward ".()" back-limit) 0)
3750 (while (let ((pos (or (and (looking-at c-nonsymbol-token-regexp)
3752 ;; `c-nonsymbol-token-regexp' should always match
3753 ;; since we've skipped backward over punctuation
3754 ;; or paren syntax, but consume one char in case
3755 ;; it doesn't so that we don't leave point before
3756 ;; some earlier incorrect token.
3759 (goto-char pos))))))
3762 (defun c-end-of-current-token (&optional back-limit)
3763 ;; Move to the end of the current token. Do not move if not in the
3764 ;; middle of one. BACK-LIMIT may be used to bound the backward
3765 ;; search; if given it's assumed to be at the boundary between two
3766 ;; tokens. Return non-nil if the point is moved, nil otherwise.
3768 ;; This function might do hidden buffer changes.
3769 (let ((start (point)))
3770 (cond ((< (skip-syntax-backward "w_" (1- start)) 0)
3771 (skip-syntax-forward "w_"))
3772 ((< (skip-syntax-backward ".()" back-limit) 0)
3774 (if (looking-at c-nonsymbol-token-regexp)
3775 (goto-char (match-end 0))
3776 ;; `c-nonsymbol-token-regexp' should always match since
3777 ;; we've skipped backward over punctuation or paren
3778 ;; syntax, but move forward in case it doesn't so that
3779 ;; we don't leave point earlier than we started with.
3781 (< (point) start)))))
3784 (defconst c-jump-syntax-balanced
3785 (if (memq 'gen-string-delim c-emacs-features)
3786 "\\w\\|\\s_\\|\\s\(\\|\\s\)\\|\\s\"\\|\\s|"
3787 "\\w\\|\\s_\\|\\s\(\\|\\s\)\\|\\s\""))
3789 (defconst c-jump-syntax-unbalanced
3790 (if (memq 'gen-string-delim c-emacs-features)
3791 "\\w\\|\\s_\\|\\s\"\\|\\s|"
3792 "\\w\\|\\s_\\|\\s\""))
3794 (defun c-forward-token-2 (&optional count balanced limit)
3795 "Move forward by tokens.
3796 A token is defined as all symbols and identifiers which aren't
3797 syntactic whitespace \(note that multicharacter tokens like \"==\" are
3798 treated properly). Point is always either left at the beginning of a
3799 token or not moved at all. COUNT specifies the number of tokens to
3800 move; a negative COUNT moves in the opposite direction. A COUNT of 0
3801 moves to the next token beginning only if not already at one. If
3802 BALANCED is true, move over balanced parens, otherwise move into them.
3803 Also, if BALANCED is true, never move out of an enclosing paren.
3805 LIMIT sets the limit for the movement and defaults to the point limit.
3806 The case when LIMIT is set in the middle of a token, comment or macro
3807 is handled correctly, i.e. the point won't be left there.
3809 Return the number of tokens left to move \(positive or negative). If
3810 BALANCED is true, a move over a balanced paren counts as one. Note
3811 that if COUNT is 0 and no appropriate token beginning is found, 1 will
3812 be returned. Thus, a return value of 0 guarantees that point is at
3813 the requested position and a return value less \(without signs) than
3814 COUNT guarantees that point is at the beginning of some token.
3816 Note that this function might do hidden buffer changes. See the
3817 comment at the start of cc-engine.el for more info."
3819 (or count (setq count 1))
3821 (- (c-backward-token-2 (- count) balanced limit))
3823 (let ((jump-syntax (if balanced
3824 c-jump-syntax-balanced
3825 c-jump-syntax-unbalanced))
3830 ;; If count is zero we should jump if in the middle of a token.
3831 (c-end-of-current-token))
3834 (if limit (narrow-to-region (point-min) limit))
3836 (progn (c-forward-syntactic-ws) (point)))
3837 ;; Skip whitespace. Count this as a move if we did in
3839 (setq count (max (1- count) 0)))
3842 ;; Moved out of bounds. Make sure the returned count isn't zero.
3844 (if (zerop count) (setq count 1))
3847 ;; Use `condition-case' to avoid having the limit tests
3854 (cond ((looking-at jump-syntax)
3855 (goto-char (scan-sexps (point) 1))
3857 ((looking-at c-nonsymbol-token-regexp)
3858 (goto-char (match-end 0))
3860 ;; `c-nonsymbol-token-regexp' above should always
3861 ;; match if there are correct tokens. Try to
3862 ;; widen to see if the limit was set in the
3863 ;; middle of one, else fall back to treating
3864 ;; the offending thing as a one character token.
3868 (looking-at c-nonsymbol-token-regexp)))
3873 (c-forward-syntactic-ws)
3876 (error (goto-char last)))
3880 (setq count (1+ count)))))
3884 (defun c-backward-token-2 (&optional count balanced limit)
3885 "Move backward by tokens.
3886 See `c-forward-token-2' for details."
3888 (or count (setq count 1))
3890 (- (c-forward-token-2 (- count) balanced limit))
3892 (or limit (setq limit (point-min)))
3893 (let ((jump-syntax (if balanced
3894 c-jump-syntax-balanced
3895 c-jump-syntax-unbalanced))
3899 ;; The count is zero so try to skip to the beginning of the
3902 (progn (c-beginning-of-current-token) (point)))
3903 (if (< (point) limit)
3904 ;; The limit is inside the same token, so return 1.
3907 ;; We're not in the middle of a token. If there's
3908 ;; whitespace after the point then we must move backward,
3909 ;; so set count to 1 in that case.
3910 (and (looking-at c-syntactic-ws-start)
3911 ;; If we're looking at a '#' that might start a cpp
3912 ;; directive then we have to do a more elaborate check.
3913 (or (/= (char-after) ?#)
3914 (not c-opt-cpp-prefix)
3917 (progn (beginning-of-line)
3918 (looking-at "[ \t]*")
3921 (progn (backward-char)
3922 (not (eq (char-before) ?\\)))))))
3925 ;; Use `condition-case' to avoid having to check for buffer
3926 ;; limits in `backward-char', `scan-sexps' and `goto-char' below.
3931 (c-backward-syntactic-ws)
3933 (if (looking-at jump-syntax)
3934 (goto-char (scan-sexps (1+ (point)) -1))
3935 ;; This can be very inefficient if there's a long
3936 ;; sequence of operator tokens without any separation.
3937 ;; That doesn't happen in practice, anyway.
3938 (c-beginning-of-current-token))
3939 (>= (point) limit)))
3942 (error (goto-char last)))
3944 (if (< (point) limit)
3949 (defun c-forward-token-1 (&optional count balanced limit)
3950 "Like `c-forward-token-2' but doesn't treat multicharacter operator
3951 tokens like \"==\" as single tokens, i.e. all sequences of symbol
3952 characters are jumped over character by character. This function is
3953 for compatibility only; it's only a wrapper over `c-forward-token-2'."
3954 (let ((c-nonsymbol-token-regexp "\\s.\\|\\s\(\\|\\s\)"))
3955 (c-forward-token-2 count balanced limit)))
3957 (defun c-backward-token-1 (&optional count balanced limit)
3958 "Like `c-backward-token-2' but doesn't treat multicharacter operator
3959 tokens like \"==\" as single tokens, i.e. all sequences of symbol
3960 characters are jumped over character by character. This function is
3961 for compatibility only; it's only a wrapper over `c-backward-token-2'."
3962 (let ((c-nonsymbol-token-regexp "\\s.\\|\\s\(\\|\\s\)"))
3963 (c-backward-token-2 count balanced limit)))
3966 ;; Tools for doing searches restricted to syntactically relevant text.
3968 (defun c-syntactic-re-search-forward (regexp &optional bound noerror
3969 paren-level not-inside-token
3970 lookbehind-submatch)
3971 "Like `re-search-forward', but only report matches that are found
3972 in syntactically significant text. I.e. matches in comments, macros
3973 or string literals are ignored. The start point is assumed to be
3974 outside any comment, macro or string literal, or else the content of
3975 that region is taken as syntactically significant text.
3977 If PAREN-LEVEL is non-nil, an additional restriction is added to
3978 ignore matches in nested paren sexps. The search will also not go
3979 outside the current list sexp, which has the effect that if the point
3980 should be moved to BOUND when no match is found \(i.e. NOERROR is
3981 neither nil nor t), then it will be at the closing paren if the end of
3982 the current list sexp is encountered first.
3984 If NOT-INSIDE-TOKEN is non-nil, matches in the middle of tokens are
3985 ignored. Things like multicharacter operators and special symbols
3986 \(e.g. \"`()\" in Pike) are handled but currently not floating point
3989 If LOOKBEHIND-SUBMATCH is non-nil, it's taken as a number of a
3990 subexpression in REGEXP. The end of that submatch is used as the
3991 position to check for syntactic significance. If LOOKBEHIND-SUBMATCH
3992 isn't used or if that subexpression didn't match then the start
3993 position of the whole match is used instead. The \"look behind\"
3994 subexpression is never tested before the starting position, so it
3995 might be a good idea to include \\=\\= as a match alternative in it.
3997 Optimization note: Matches might be missed if the \"look behind\"
3998 subexpression can match the end of nonwhite syntactic whitespace,
3999 i.e. the end of comments or cpp directives. This since the function
4000 skips over such things before resuming the search. It's on the other
4001 hand not safe to assume that the \"look behind\" subexpression never
4002 matches syntactic whitespace.
4004 Bug: Unbalanced parens inside cpp directives are currently not handled
4005 correctly \(i.e. they don't get ignored as they should) when
4008 Note that this function might do hidden buffer changes. See the
4009 comment at the start of cc-engine.el for more info."
4011 (or bound (setq bound (point-max)))
4012 (if paren-level (setq paren-level -1))
4014 ;;(message "c-syntactic-re-search-forward %s %s %S" (point) bound regexp)
4016 (let ((start (point))
4018 ;; Start position for the last search.
4020 ;; The `parse-partial-sexp' state between the start position
4023 ;; The current position after the last state update. The next
4024 ;; `parse-partial-sexp' continues from here.
4026 ;; The position at which to check the state and the state
4027 ;; there. This is separate from `state-pos' since we might
4028 ;; need to back up before doing the next search round.
4029 check-pos check-state
4030 ;; Last position known to end a token.
4031 (last-token-end-pos (point-min))
4032 ;; Set when a valid match is found.
4039 (setq search-pos (point))
4040 (re-search-forward regexp bound noerror))
4043 (setq state (parse-partial-sexp
4044 state-pos (match-beginning 0) paren-level nil state)
4046 (if (setq check-pos (and lookbehind-submatch
4047 (or (not paren-level)
4049 (match-end lookbehind-submatch)))
4050 (setq check-state (parse-partial-sexp
4051 state-pos check-pos paren-level nil state))
4052 (setq check-pos state-pos
4055 ;; NOTE: If we got a look behind subexpression and get
4056 ;; an insignificant match in something that isn't
4057 ;; syntactic whitespace (i.e. strings or in nested
4058 ;; parentheses), then we can never skip more than a
4059 ;; single character from the match start position
4060 ;; (i.e. `state-pos' here) before continuing the
4061 ;; search. That since the look behind subexpression
4062 ;; might match the end of the insignificant region in
4066 ((elt check-state 7)
4067 ;; Match inside a line comment. Skip to eol. Use
4068 ;; `re-search-forward' instead of `skip-chars-forward' to get
4069 ;; the right bound behavior.
4070 (re-search-forward "[\n\r]" bound noerror))
4072 ((elt check-state 4)
4073 ;; Match inside a block comment. Skip to the '*/'.
4074 (search-forward "*/" bound noerror))
4076 ((and (not (elt check-state 5))
4077 (eq (char-before check-pos) ?/)
4078 (not (c-get-char-property (1- check-pos) 'syntax-table))
4079 (memq (char-after check-pos) '(?/ ?*)))
4080 ;; Match in the middle of the opener of a block or line
4082 (if (= (char-after check-pos) ?/)
4083 (re-search-forward "[\n\r]" bound noerror)
4084 (search-forward "*/" bound noerror)))
4086 ;; The last `parse-partial-sexp' above might have
4087 ;; stopped short of the real check position if the end
4088 ;; of the current sexp was encountered in paren-level
4089 ;; mode. The checks above are always false in that
4090 ;; case, and since they can do better skipping in
4091 ;; lookbehind-submatch mode, we do them before
4092 ;; checking the paren level.
4095 (/= (setq tmp (car check-state)) 0))
4096 ;; Check the paren level first since we're short of the
4097 ;; syntactic checking position if the end of the
4098 ;; current sexp was encountered by `parse-partial-sexp'.
4101 ;; Inside a nested paren sexp.
4102 (if lookbehind-submatch
4103 ;; See the NOTE above.
4104 (progn (goto-char state-pos) t)
4105 ;; Skip out of the paren quickly.
4106 (setq state (parse-partial-sexp state-pos bound 0 nil state)
4109 ;; Have exited the current paren sexp.
4112 ;; The last `parse-partial-sexp' call above
4113 ;; has left us just after the closing paren
4114 ;; in this case, so we can modify the bound
4115 ;; to leave the point at the right position
4117 (setq bound (1- (point)))
4119 (signal 'search-failed (list regexp)))))
4121 ((setq tmp (elt check-state 3))
4122 ;; Match inside a string.
4123 (if (or lookbehind-submatch
4124 (not (integerp tmp)))
4125 ;; See the NOTE above.
4126 (progn (goto-char state-pos) t)
4127 ;; Skip to the end of the string before continuing.
4128 (let ((ender (make-string 1 tmp)) (continue t))
4129 (while (if (search-forward ender bound noerror)
4131 (setq state (parse-partial-sexp
4132 state-pos (point) nil nil state)
4135 (setq continue nil)))
4140 (c-beginning-of-macro start)))
4141 ;; Match inside a macro. Skip to the end of it.
4143 (cond ((<= (point) bound) t)
4145 (t (signal 'search-failed (list regexp)))))
4147 ((and not-inside-token
4148 (or (< check-pos last-token-end-pos)
4151 (goto-char check-pos)
4153 (c-end-of-current-token last-token-end-pos))
4154 (setq last-token-end-pos (point))))))
4156 (if lookbehind-submatch
4157 ;; See the NOTE above.
4158 (goto-char state-pos)
4159 (goto-char (min last-token-end-pos bound))))
4166 ;; Should loop to search again, but take care to avoid
4167 ;; looping on the same spot.
4168 (or (/= search-pos (point))
4169 (if (= (point) bound)
4172 (signal 'search-failed (list regexp)))
4178 (signal (car err) (cdr err))))
4180 ;;(message "c-syntactic-re-search-forward done %s" (or (match-end 0) (point)))
4184 (goto-char (match-end 0))
4187 ;; Search failed. Set point as appropriate.
4193 (defvar safe-pos-list) ; bound in c-syntactic-skip-backward
4195 (defsubst c-ssb-lit-begin ()
4196 ;; Return the start of the literal point is in, or nil.
4197 ;; We read and write the variables `safe-pos', `safe-pos-list', `state'
4198 ;; bound in the caller.
4200 ;; Use `parse-partial-sexp' from a safe position down to the point to check
4201 ;; if it's outside comments and strings.
4203 (let ((pos (point)) safe-pos state)
4204 ;; Pick a safe position as close to the point as possible.
4206 ;; FIXME: Consult `syntax-ppss' here if our cache doesn't give a good
4209 (while (and safe-pos-list
4210 (> (car safe-pos-list) (point)))
4211 (setq safe-pos-list (cdr safe-pos-list)))
4212 (unless (setq safe-pos (car-safe safe-pos-list))
4213 (setq safe-pos (max (or (c-safe-position
4214 (point) (or c-state-cache
4218 safe-pos-list (list safe-pos)))
4220 ;; Cache positions along the way to use if we have to back up more. We
4221 ;; cache every closing paren on the same level. If the paren cache is
4222 ;; relevant in this region then we're typically already on the same
4223 ;; level as the target position. Note that we might cache positions
4224 ;; after opening parens in case safe-pos is in a nested list. That's
4225 ;; both uncommon and harmless.
4227 (setq state (parse-partial-sexp
4230 (setq safe-pos (point)
4231 safe-pos-list (cons safe-pos safe-pos-list)))
4233 ;; If the state contains the start of the containing sexp we cache that
4234 ;; position too, so that parse-partial-sexp in the next run has a bigger
4235 ;; chance of starting at the same level as the target position and thus
4236 ;; will get more good safe positions into the list.
4238 (setq safe-pos (1+ (elt state 1))
4239 safe-pos-list (cons safe-pos safe-pos-list)))
4241 (if (or (elt state 3) (elt state 4))
4242 ;; Inside string or comment. Continue search at the
4246 (defun c-syntactic-skip-backward (skip-chars &optional limit paren-level)
4247 "Like `skip-chars-backward' but only look at syntactically relevant chars,
4248 i.e. don't stop at positions inside syntactic whitespace or string
4249 literals. Preprocessor directives are also ignored, with the exception
4250 of the one that the point starts within, if any. If LIMIT is given,
4251 it's assumed to be at a syntactically relevant position.
4253 If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4254 sexps, and the search will also not go outside the current paren sexp.
4255 However, if LIMIT or the buffer limit is reached inside a nested paren
4256 then the point will be left at the limit.
4258 Non-nil is returned if the point moved, nil otherwise.
4260 Note that this function might do hidden buffer changes. See the
4261 comment at the start of cc-engine.el for more info."
4263 (let ((start (point))
4265 ;; A list of syntactically relevant positions in descending
4266 ;; order. It's used to avoid scanning repeatedly over
4267 ;; potentially large regions with `parse-partial-sexp' to verify
4268 ;; each position. Used in `c-ssb-lit-begin'
4270 ;; The result from `c-beginning-of-macro' at the start position or the
4271 ;; start position itself if it isn't within a macro. Evaluated on
4274 ;; The earliest position after the current one with the same paren
4275 ;; level. Used only when `paren-level' is set.
4277 (paren-level-pos (point)))
4281 ;; The next loop "tries" to find the end point each time round,
4282 ;; loops when it hasn't succeeded.
4285 (let ((pos (point)))
4287 (< (skip-chars-backward skip-chars limit) 0)
4288 ;; Don't stop inside a literal.
4289 (when (setq lit-beg (c-ssb-lit-begin))
4294 (let ((pos (point)) state-2 pps-end-pos)
4299 (setq state-2 (parse-partial-sexp
4300 pos paren-level-pos -1)
4301 pps-end-pos (point))
4302 (/= (car state-2) 0)))
4303 ;; Not at the right level.
4305 (if (and (< (car state-2) 0)
4306 ;; We stop above if we go out of a paren.
4307 ;; Now check whether it precedes or is
4308 ;; nested in the starting sexp.
4312 pps-end-pos paren-level-pos
4314 (< (car state-2) 0)))
4316 ;; We've stopped short of the starting position
4317 ;; so the hit was inside a nested list. Go up
4318 ;; until we are at the right level.
4321 (goto-char (scan-lists pos -1
4323 (setq paren-level-pos (point))
4324 (if (and limit (>= limit paren-level-pos))
4330 (goto-char (or limit (point-min)))
4333 ;; The hit was outside the list at the start
4334 ;; position. Go to the start of the list and exit.
4335 (goto-char (1+ (elt state-2 1)))
4338 ((c-beginning-of-macro limit)
4342 (setq start-macro-beg
4345 (c-beginning-of-macro limit)
4349 ;; It's inside the same macro we started in so it's
4350 ;; a relevant match.
4356 ;; Skip syntactic ws afterwards so that we don't stop at the
4357 ;; end of a comment if `skip-chars' is something like "^/".
4358 (c-backward-syntactic-ws)
4361 ;; We might want to extend this with more useful return values in
4363 (/= (point) start)))
4365 ;; The following is an alternative implementation of
4366 ;; `c-syntactic-skip-backward' that uses backward movement to keep
4367 ;; track of the syntactic context. It turned out to be generally
4368 ;; slower than the one above which uses forward checks from earlier
4371 ;;(defconst c-ssb-stop-re
4372 ;; ;; The regexp matching chars `c-syntactic-skip-backward' needs to
4373 ;; ;; stop at to avoid going into comments and literals.
4375 ;; ;; Match comment end syntax and string literal syntax. Also match
4376 ;; ;; '/' for block comment endings (not covered by comment end
4378 ;; "\\s>\\|/\\|\\s\""
4379 ;; (if (memq 'gen-string-delim c-emacs-features)
4382 ;; (if (memq 'gen-comment-delim c-emacs-features)
4386 ;;(defconst c-ssb-stop-paren-re
4387 ;; ;; Like `c-ssb-stop-re' but also stops at paren chars.
4388 ;; (concat c-ssb-stop-re "\\|\\s(\\|\\s)"))
4390 ;;(defconst c-ssb-sexp-end-re
4391 ;; ;; Regexp matching the ending syntax of a complex sexp.
4392 ;; (concat c-string-limit-regexp "\\|\\s)"))
4394 ;;(defun c-syntactic-skip-backward (skip-chars &optional limit paren-level)
4395 ;; "Like `skip-chars-backward' but only look at syntactically relevant chars,
4396 ;;i.e. don't stop at positions inside syntactic whitespace or string
4397 ;;literals. Preprocessor directives are also ignored. However, if the
4398 ;;point is within a comment, string literal or preprocessor directory to
4399 ;;begin with, its contents is treated as syntactically relevant chars.
4400 ;;If LIMIT is given, it limits the backward search and the point will be
4401 ;;left there if no earlier position is found.
4403 ;;If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4404 ;;sexps, and the search will also not go outside the current paren sexp.
4405 ;;However, if LIMIT or the buffer limit is reached inside a nested paren
4406 ;;then the point will be left at the limit.
4408 ;;Non-nil is returned if the point moved, nil otherwise.
4410 ;;Note that this function might do hidden buffer changes. See the
4411 ;;comment at the start of cc-engine.el for more info."
4413 ;; (save-restriction
4415 ;; (narrow-to-region limit (point-max)))
4417 ;; (let ((start (point)))
4419 ;; (while (let ((last-pos (point))
4421 ;; (skip-chars-backward skip-chars)
4424 ;; ;; Skip back over the same region as
4425 ;; ;; `skip-chars-backward' above, but keep to
4426 ;; ;; syntactically relevant positions.
4427 ;; (goto-char last-pos)
4429 ;; ;; `re-search-backward' with a single char regexp
4430 ;; ;; should be fast.
4431 ;; (re-search-backward
4432 ;; (if paren-level c-ssb-stop-paren-re c-ssb-stop-re)
4437 ;; ((looking-at "\\s(")
4438 ;; ;; `paren-level' is set and we've found the
4439 ;; ;; start of the containing paren.
4443 ;; ((looking-at c-ssb-sexp-end-re)
4444 ;; ;; We're at the end of a string literal or paren
4445 ;; ;; sexp (if `paren-level' is set).
4447 ;; (condition-case nil
4448 ;; (c-backward-sexp)
4450 ;; (goto-char limit)
4451 ;; (throw 'done t))))
4455 ;; ;; At the end of some syntactic ws or possibly
4456 ;; ;; after a plain '/' operator.
4457 ;; (let ((pos (point)))
4458 ;; (c-backward-syntactic-ws)
4459 ;; (if (= pos (point))
4460 ;; ;; Was a plain '/' operator. Go past it.
4461 ;; (backward-char)))))
4463 ;; (> (point) stop-pos))))
4465 ;; ;; Now the point is either at `stop-pos' or at some
4466 ;; ;; position further back if `stop-pos' was at a
4467 ;; ;; syntactically irrelevant place.
4469 ;; ;; Skip additional syntactic ws so that we don't stop
4470 ;; ;; at the end of a comment if `skip-chars' is
4471 ;; ;; something like "^/".
4472 ;; (c-backward-syntactic-ws)
4474 ;; (< (point) stop-pos))))
4476 ;; ;; We might want to extend this with more useful return values
4477 ;; ;; in the future.
4478 ;; (/= (point) start))))
4481 ;; Tools for handling comments and string literals.
4483 (defun c-in-literal (&optional lim detect-cpp)
4484 "Return the type of literal point is in, if any.
4485 The return value is `c' if in a C-style comment, `c++' if in a C++
4486 style comment, `string' if in a string literal, `pound' if DETECT-CPP
4487 is non-nil and in a preprocessor line, or nil if somewhere else.
4488 Optional LIM is used as the backward limit of the search. If omitted,
4489 or nil, `c-beginning-of-defun' is used.
4491 The last point calculated is cached if the cache is enabled, i.e. if
4492 `c-in-literal-cache' is bound to a two element vector.
4494 Note that this function might do hidden buffer changes. See the
4495 comment at the start of cc-engine.el for more info."
4498 (let* ((safe-place (c-state-semi-safe-place (point)))
4499 (lit (c-state-pp-to-literal safe-place (point))))
4502 (save-excursion (c-beginning-of-macro))
4505 (defun c-literal-limits (&optional lim near not-in-delimiter)
4506 "Return a cons of the beginning and end positions of the comment or
4507 string surrounding point (including both delimiters), or nil if point
4508 isn't in one. If LIM is non-nil, it's used as the \"safe\" position
4509 to start parsing from. If NEAR is non-nil, then the limits of any
4510 literal next to point is returned. \"Next to\" means there's only
4511 spaces and tabs between point and the literal. The search for such a
4512 literal is done first in forward direction. If NOT-IN-DELIMITER is
4513 non-nil, the case when point is inside a starting delimiter won't be
4514 recognized. This only has effect for comments which have starting
4515 delimiters with more than one character.
4517 Note that this function might do hidden buffer changes. See the
4518 comment at the start of cc-engine.el for more info."
4521 (let* ((pos (point))
4522 (lim (or lim (c-state-semi-safe-place pos)))
4523 (pp-to-lit (save-restriction
4525 (c-state-pp-to-literal lim pos not-in-delimiter)))
4526 (state (car pp-to-lit))
4527 (lit-limits (car (cddr pp-to-lit))))
4534 ;; Search forward for a literal.
4535 (skip-chars-forward " \t")
4537 ((looking-at c-string-limit-regexp) ; String.
4538 (cons (point) (or (c-safe (c-forward-sexp 1) (point))
4541 ((looking-at c-comment-start-regexp) ; Line or block comment.
4542 (cons (point) (progn (c-forward-single-comment) (point))))
4546 (skip-chars-backward " \t")
4548 (let ((end (point)) beg)
4551 (< (skip-syntax-backward c-string-syntax) 0)) ; String.
4552 (setq beg (c-safe (c-backward-sexp 1) (point))))
4554 ((and (c-safe (forward-char -2) t)
4556 ;; Block comment. Due to the nature of line
4557 ;; comments, they will always be covered by the
4558 ;; normal case above.
4560 (c-backward-single-comment)
4561 ;; If LIM is bogus, beg will be bogus.
4562 (setq beg (point))))
4564 (if beg (cons beg end))))))
4567 ;; In case external callers use this; it did have a docstring.
4568 (defalias 'c-literal-limits-fast 'c-literal-limits)
4570 (defun c-collect-line-comments (range)
4571 "If the argument is a cons of two buffer positions (such as returned by
4572 `c-literal-limits'), and that range contains a C++ style line comment,
4573 then an extended range is returned that contains all adjacent line
4574 comments (i.e. all comments that starts in the same column with no
4575 empty lines or non-whitespace characters between them). Otherwise the
4576 argument is returned.
4578 Note that this function might do hidden buffer changes. See the
4579 comment at the start of cc-engine.el for more info."
4583 (if (and (consp range) (progn
4584 (goto-char (car range))
4585 (looking-at c-line-comment-starter)))
4586 (let ((col (current-column))
4588 (bopl (c-point 'bopl))
4590 ;; Got to take care in the backward direction to handle
4591 ;; comments which are preceded by code.
4592 (while (and (c-backward-single-comment)
4594 (looking-at c-line-comment-starter)
4595 (= col (current-column)))
4597 bopl (c-point 'bopl)))
4599 (while (and (progn (skip-chars-forward " \t")
4600 (looking-at c-line-comment-starter))
4601 (= col (current-column))
4602 (prog1 (zerop (forward-line 1))
4603 (setq end (point)))))
4608 (defun c-literal-type (range)
4609 "Convenience function that given the result of `c-literal-limits',
4610 returns nil or the type of literal that the range surrounds, one
4611 of the symbols 'c, 'c++ or 'string. It's much faster than using
4612 `c-in-literal' and is intended to be used when you need both the
4613 type of a literal and its limits.
4615 Note that this function might do hidden buffer changes. See the
4616 comment at the start of cc-engine.el for more info."
4620 (goto-char (car range))
4621 (cond ((looking-at c-string-limit-regexp) 'string)
4622 ((or (looking-at "//") ; c++ line comment
4623 (and (looking-at "\\s<") ; comment starter
4624 (looking-at "#"))) ; awk comment.
4626 (t 'c))) ; Assuming the range is valid.
4629 (defsubst c-determine-limit-get-base (start try-size)
4630 ;; Get a "safe place" approximately TRY-SIZE characters before START.
4631 ;; This doesn't preserve point.
4632 (let* ((pos (max (- start try-size) (point-min)))
4633 (base (c-state-semi-safe-place pos))
4634 (s (parse-partial-sexp base pos)))
4635 (if (or (nth 4 s) (nth 3 s)) ; comment or string
4639 (defun c-determine-limit (how-far-back &optional start try-size)
4640 ;; Return a buffer position HOW-FAR-BACK non-literal characters from START
4641 ;; (default point). This is done by going back further in the buffer then
4642 ;; searching forward for literals. The position found won't be in a
4643 ;; literal. We start searching for the sought position TRY-SIZE (default
4644 ;; twice HOW-FAR-BACK) bytes back from START. This function must be fast.
4647 (let* ((start (or start (point)))
4648 (try-size (or try-size (* 2 how-far-back)))
4649 (base (c-determine-limit-get-base start try-size))
4652 (s (parse-partial-sexp pos pos)) ; null state.
4655 (while (< pos start)
4656 ;; Move forward one literal each time round this loop.
4657 ;; Move forward to the start of a comment or string.
4658 (setq s (parse-partial-sexp
4664 'syntax-table)) ; stop-comment
4666 ;; Gather details of the non-literal-bit - starting pos and size.
4667 (setq size (- (if (or (nth 4 s) (nth 3 s))
4672 (setq stack (cons (cons pos size) stack)))
4674 ;; Move forward to the end of the comment/string.
4675 (if (or (nth 4 s) (nth 3 s))
4676 (setq s (parse-partial-sexp
4682 'syntax-table))) ; stop-comment
4685 ;; Now try and find enough non-literal characters recorded on the stack.
4686 ;; Go back one recorded literal each time round this loop.
4687 (while (and (< count how-far-back)
4689 (setq elt (car stack)
4691 (setq count (+ count (cdr elt))))
4693 ;; Have we found enough yet?
4695 ((>= count how-far-back)
4696 (+ (car elt) (- count how-far-back)))
4697 ((eq base (point-min))
4700 (c-determine-limit (- how-far-back count) base try-size))))))
4702 (defun c-determine-+ve-limit (how-far &optional start-pos)
4703 ;; Return a buffer position about HOW-FAR non-literal characters forward
4704 ;; from START-POS (default point), which must not be inside a literal.
4706 (let ((pos (or start-pos (point)))
4708 (s (parse-partial-sexp (point) (point)))) ; null state
4709 (while (and (not (eobp))
4711 ;; Scan over counted characters.
4712 (setq s (parse-partial-sexp
4714 (min (+ pos count) (point-max))
4718 'syntax-table)) ; stop-comment
4719 (setq count (- count (- (point) pos) 1)
4721 ;; Scan over literal characters.
4723 (setq s (parse-partial-sexp
4729 'syntax-table) ; stop-comment
4734 ;; `c-find-decl-spots' and accompanying stuff.
4736 ;; Variables used in `c-find-decl-spots' to cache the search done for
4737 ;; the first declaration in the last call. When that function starts,
4738 ;; it needs to back up over syntactic whitespace to look at the last
4739 ;; token before the region being searched. That can sometimes cause
4740 ;; moves back and forth over a quite large region of comments and
4741 ;; macros, which would be repeated for each changed character when
4742 ;; we're called during fontification, since font-lock refontifies the
4743 ;; current line for each change. Thus it's worthwhile to cache the
4746 ;; `c-find-decl-syntactic-pos' is a syntactically relevant position in
4747 ;; the syntactic whitespace less or equal to some start position.
4748 ;; There's no cached value if it's nil.
4750 ;; `c-find-decl-match-pos' is the match position if
4751 ;; `c-find-decl-prefix-search' matched before the syntactic whitespace
4752 ;; at `c-find-decl-syntactic-pos', or nil if there's no such match.
4753 (defvar c-find-decl-syntactic-pos nil)
4754 (make-variable-buffer-local 'c-find-decl-syntactic-pos)
4755 (defvar c-find-decl-match-pos nil)
4756 (make-variable-buffer-local 'c-find-decl-match-pos)
4758 (defsubst c-invalidate-find-decl-cache (change-min-pos)
4759 (and c-find-decl-syntactic-pos
4760 (< change-min-pos c-find-decl-syntactic-pos)
4761 (setq c-find-decl-syntactic-pos nil)))
4763 ; (defface c-debug-decl-spot-face
4764 ; '((t (:background "Turquoise")))
4765 ; "Debug face to mark the spots where `c-find-decl-spots' stopped.")
4766 ; (defface c-debug-decl-sws-face
4767 ; '((t (:background "Khaki")))
4768 ; "Debug face to mark the syntactic whitespace between the declaration
4769 ; spots and the preceding token end.")
4771 (defmacro c-debug-put-decl-spot-faces (match-pos decl-pos)
4772 (when (facep 'c-debug-decl-spot-face)
4773 `(c-save-buffer-state ((match-pos ,match-pos) (decl-pos ,decl-pos))
4774 (c-debug-add-face (max match-pos (point-min)) decl-pos
4775 'c-debug-decl-sws-face)
4776 (c-debug-add-face decl-pos (min (1+ decl-pos) (point-max))
4777 'c-debug-decl-spot-face))))
4778 (defmacro c-debug-remove-decl-spot-faces (beg end)
4779 (when (facep 'c-debug-decl-spot-face)
4780 `(c-save-buffer-state ()
4781 (c-debug-remove-face ,beg ,end 'c-debug-decl-spot-face)
4782 (c-debug-remove-face ,beg ,end 'c-debug-decl-sws-face))))
4784 (defmacro c-find-decl-prefix-search ()
4785 ;; Macro used inside `c-find-decl-spots'. It ought to be a defun,
4786 ;; but it contains lots of free variables that refer to things
4787 ;; inside `c-find-decl-spots'. The point is left at `cfd-match-pos'
4788 ;; if there is a match, otherwise at `cfd-limit'.
4790 ;; The macro moves point forward to the next putative start of a declaration
4791 ;; or cfd-limit. This decl start is the next token after a "declaration
4792 ;; prefix". The declaration prefix is the earlier of `cfd-prop-match' and
4793 ;; `cfd-re-match'. `cfd-match-pos' is set to the decl prefix.
4795 ;; This macro might do hidden buffer changes.
4798 ;; Find the next property match position if we haven't got one already.
4799 (unless cfd-prop-match
4802 (goto-char (c-next-single-property-change
4803 (point) 'c-type nil cfd-limit))
4804 (and (< (point) cfd-limit)
4805 (not (eq (c-get-char-property (1- (point)) 'c-type)
4807 (setq cfd-prop-match (point))))
4809 ;; Find the next `c-decl-prefix-or-start-re' match if we haven't
4811 (unless cfd-re-match
4813 (if (> cfd-re-match-end (point))
4814 (goto-char cfd-re-match-end))
4816 ;; Each time round, the next `while' moves forward over a pseudo match
4817 ;; of `c-decl-prefix-or-start-re' which is either inside a literal, or
4818 ;; is a ":" not preceded by "public", etc.. `cfd-re-match' and
4819 ;; `cfd-re-match-end' get set.
4822 (setq cfd-re-match-end (re-search-forward c-decl-prefix-or-start-re
4825 ((null cfd-re-match-end)
4826 ;; No match. Finish up and exit the loop.
4827 (setq cfd-re-match cfd-limit)
4830 (if (setq cfd-re-match (match-end 1))
4831 ;; Matched the end of a token preceding a decl spot.
4833 (goto-char cfd-re-match)
4835 ;; Matched a token that start a decl spot.
4836 (goto-char (match-beginning 0))
4839 ;; Pseudo match inside a comment or string literal. Skip out
4840 ;; of comments and string literals.
4842 (goto-char (c-next-single-property-change
4843 (point) 'face nil cfd-limit))
4844 (and (< (point) cfd-limit)
4845 (c-got-face-at (point) c-literal-faces))))
4846 t) ; Continue the loop over pseudo matches.
4847 ((and (match-string 1)
4848 (string= (match-string 1) ":")
4850 (or (/= (c-backward-token-2 2) 0) ; no search limit. :-(
4851 (not (looking-at c-decl-start-colon-kwd-re)))))
4852 ;; Found a ":" which isn't part of "public:", etc.
4854 (t nil)))) ;; Found a real match. Exit the pseudo-match loop.
4856 ;; If our match was at the decl start, we have to back up over the
4857 ;; preceding syntactic ws to set `cfd-match-pos' and to catch
4858 ;; any decl spots in the syntactic ws.
4859 (unless cfd-re-match
4860 (c-backward-syntactic-ws)
4861 (setq cfd-re-match (point))))
4863 ;; Choose whichever match is closer to the start.
4864 (if (< cfd-re-match cfd-prop-match)
4865 (setq cfd-match-pos cfd-re-match
4867 (setq cfd-match-pos cfd-prop-match
4868 cfd-prop-match nil))
4870 (goto-char cfd-match-pos)
4872 (when (< cfd-match-pos cfd-limit)
4873 ;; Skip forward past comments only so we don't skip macros.
4874 (c-forward-comments)
4875 ;; Set the position to continue at. We can avoid going over
4876 ;; the comments skipped above a second time, but it's possible
4877 ;; that the comment skipping has taken us past `cfd-prop-match'
4878 ;; since the property might be used inside comments.
4879 (setq cfd-continue-pos (if cfd-prop-match
4880 (min cfd-prop-match (point))
4883 (defun c-find-decl-spots (cfd-limit cfd-decl-re cfd-face-checklist cfd-fun)
4884 ;; Call CFD-FUN for each possible spot for a declaration, cast or
4885 ;; label from the point to CFD-LIMIT.
4887 ;; CFD-FUN is called with point at the start of the spot. It's passed two
4888 ;; arguments: The first is the end position of the token preceding the spot,
4889 ;; or 0 for the implicit match at bob. The second is a flag that is t when
4890 ;; the match is inside a macro. Point should be moved forward by at least
4893 ;; If CFD-FUN adds `c-decl-end' properties somewhere below the current spot,
4894 ;; it should return non-nil to ensure that the next search will find them.
4897 ;; o The first token after bob.
4898 ;; o The first token after the end of submatch 1 in
4899 ;; `c-decl-prefix-or-start-re' when that submatch matches. This
4900 ;; submatch is typically a (L or R) brace or paren, a ;, or a ,.
4901 ;; o The start of each `c-decl-prefix-or-start-re' match when
4902 ;; submatch 1 doesn't match. This is, for example, the keyword
4904 ;; o The start of a previously recognized declaration; "recognized"
4905 ;; means that the last char of the previous token has a `c-type'
4906 ;; text property with the value `c-decl-end'; this only holds
4907 ;; when `c-type-decl-end-used' is set.
4909 ;; Only a spot that match CFD-DECL-RE and whose face is in the
4910 ;; CFD-FACE-CHECKLIST list causes CFD-FUN to be called. The face
4911 ;; check is disabled if CFD-FACE-CHECKLIST is nil.
4913 ;; If the match is inside a macro then the buffer is narrowed to the
4914 ;; end of it, so that CFD-FUN can investigate the following tokens
4915 ;; without matching something that begins inside a macro and ends
4916 ;; outside it. It's to avoid this work that the CFD-DECL-RE and
4917 ;; CFD-FACE-CHECKLIST checks exist.
4919 ;; The spots are visited approximately in order from top to bottom.
4920 ;; It's however the positions where `c-decl-prefix-or-start-re'
4921 ;; matches and where `c-decl-end' properties are found that are in
4922 ;; order. Since the spots often are at the following token, they
4923 ;; might be visited out of order insofar as more spots are reported
4924 ;; later on within the syntactic whitespace between the match
4925 ;; positions and their spots.
4927 ;; It's assumed that comments and strings are fontified in the
4930 ;; This is mainly used in fontification, and so has an elaborate
4931 ;; cache to handle repeated calls from the same start position; see
4932 ;; the variables above.
4934 ;; All variables in this function begin with `cfd-' to avoid name
4935 ;; collision with the (dynamically bound) variables used in CFD-FUN.
4937 ;; This function might do hidden buffer changes.
4939 (let ((cfd-start-pos (point)) ; never changed
4940 (cfd-buffer-end (point-max))
4941 ;; The end of the token preceding the decl spot last found
4942 ;; with `c-decl-prefix-or-start-re'. `cfd-limit' if there's
4945 ;; The end position of the last `c-decl-prefix-or-start-re'
4946 ;; match. If this is greater than `cfd-continue-pos', the
4947 ;; next regexp search is started here instead.
4948 (cfd-re-match-end (point-min))
4949 ;; The end of the last `c-decl-end' found by
4950 ;; `c-find-decl-prefix-search'. `cfd-limit' if there's no
4951 ;; match. If searching for the property isn't needed then we
4952 ;; disable it by setting it to `cfd-limit' directly.
4953 (cfd-prop-match (unless c-type-decl-end-used cfd-limit))
4954 ;; The end of the token preceding the decl spot last found by
4955 ;; `c-find-decl-prefix-search'. 0 for the implicit match at
4956 ;; bob. `cfd-limit' if there's no match. In other words,
4957 ;; this is the minimum of `cfd-re-match' and `cfd-prop-match'.
4958 (cfd-match-pos cfd-limit)
4959 ;; The position to continue searching at.
4961 ;; The position of the last "real" token we've stopped at.
4962 ;; This can be greater than `cfd-continue-pos' when we get
4963 ;; hits inside macros or at `c-decl-end' positions inside
4966 ;; The end position of the last entered macro.
4969 ;; Initialize by finding a syntactically relevant start position
4970 ;; before the point, and do the first `c-decl-prefix-or-start-re'
4971 ;; search unless we're at bob.
4973 (let (start-in-literal start-in-macro syntactic-pos)
4974 ;; Must back up a bit since we look for the end of the previous
4975 ;; statement or declaration, which is earlier than the first
4978 ;; This `cond' moves back over any literals or macros. It has special
4979 ;; handling for when the region being searched is entirely within a
4980 ;; macro. It sets `cfd-continue-pos' (unless we've reached
4983 ;; First we need to move to a syntactically relevant position.
4984 ;; Begin by backing out of comment or string literals.
4986 ;; This arm of the cond actually triggers if we're in a literal,
4987 ;; and cfd-limit is at most at BONL.
4989 ;; This arm of the `and' moves backwards out of a literal when
4990 ;; the face at point is a literal face. In this case, its value
4991 ;; is always non-nil.
4992 (when (c-got-face-at (point) c-literal-faces)
4993 ;; Try to use the faces to back up to the start of the
4994 ;; literal. FIXME: What if the point is on a declaration
4995 ;; inside a comment?
4996 (while (and (not (bobp))
4997 (c-got-face-at (1- (point)) c-literal-faces))
4998 (goto-char (previous-single-property-change
4999 (point) 'face nil (point-min))))
5001 ;; XEmacs doesn't fontify the quotes surrounding string
5003 (and (featurep 'xemacs)
5004 (eq (get-text-property (point) 'face)
5005 'font-lock-string-face)
5007 (progn (backward-char)
5008 (not (looking-at c-string-limit-regexp)))
5011 ;; Don't trust the literal to contain only literal faces
5012 ;; (the font lock package might not have fontified the
5013 ;; start of it at all, for instance) so check that we have
5014 ;; arrived at something that looks like a start or else
5015 ;; resort to `c-literal-limits'.
5016 (unless (looking-at c-literal-start-regexp)
5017 (let ((range (c-literal-limits)))
5018 (if range (goto-char (car range)))))
5020 (setq start-in-literal (point))) ; end of `and' arm.
5022 ;; The start is in a literal. If the limit is in the same
5023 ;; one we don't have to find a syntactic position etc. We
5024 ;; only check that if the limit is at or before bonl to save
5025 ;; time; it covers the by far most common case when font-lock
5026 ;; refontifies the current line only.
5027 (<= cfd-limit (c-point 'bonl cfd-start-pos))
5029 (goto-char cfd-start-pos)
5031 (goto-char (c-next-single-property-change
5032 (point) 'face nil cfd-limit))
5033 (and (< (point) cfd-limit)
5034 (c-got-face-at (point) c-literal-faces))))
5035 (= (point) cfd-limit))) ; end of `cond' arm condition
5037 ;; Completely inside a literal. Set up variables to trig the
5038 ;; (< cfd-continue-pos cfd-start-pos) case below and it'll
5039 ;; find a suitable start position.
5040 (setq cfd-continue-pos start-in-literal)) ; end of `cond' arm
5042 ;; Check if the region might be completely inside a macro, to
5043 ;; optimize that like the completely-inside-literal above.
5045 (and (= (forward-line 1) 0)
5046 (bolp) ; forward-line has funny behavior at eob.
5047 (>= (point) cfd-limit)
5048 (progn (backward-char)
5049 (eq (char-before) ?\\))))
5050 ;; (Maybe) completely inside a macro. Only need to trig the
5051 ;; (< cfd-continue-pos cfd-start-pos) case below to make it
5053 (setq cfd-continue-pos (1- cfd-start-pos)
5056 ;; The default arm of the `cond' moves back over any macro we're in
5057 ;; and over any syntactic WS. It sets `c-find-decl-syntactic-pos'.
5059 ;; Back out of any macro so we don't miss any declaration
5060 ;; that could follow after it.
5061 (when (c-beginning-of-macro)
5062 (setq start-in-macro t))
5064 ;; Now we're at a proper syntactically relevant position so we
5065 ;; can use the cache. But first clear it if it applied
5067 (c-invalidate-find-decl-cache cfd-start-pos)
5069 (setq syntactic-pos (point))
5070 (unless (eq syntactic-pos c-find-decl-syntactic-pos)
5071 ;; Don't have to do this if the cache is relevant here,
5072 ;; typically if the same line is refontified again. If
5073 ;; we're just some syntactic whitespace further down we can
5074 ;; still use the cache to limit the skipping.
5075 (c-backward-syntactic-ws c-find-decl-syntactic-pos))
5077 ;; If we hit `c-find-decl-syntactic-pos' and
5078 ;; `c-find-decl-match-pos' is set then we install the cached
5079 ;; values. If we hit `c-find-decl-syntactic-pos' and
5080 ;; `c-find-decl-match-pos' is nil then we know there's no decl
5081 ;; prefix in the whitespace before `c-find-decl-syntactic-pos'
5082 ;; and so we can continue the search from this point. If we
5083 ;; didn't hit `c-find-decl-syntactic-pos' then we're now in
5084 ;; the right spot to begin searching anyway.
5085 (if (and (eq (point) c-find-decl-syntactic-pos)
5086 c-find-decl-match-pos)
5087 (setq cfd-match-pos c-find-decl-match-pos
5088 cfd-continue-pos syntactic-pos)
5090 (setq c-find-decl-syntactic-pos syntactic-pos)
5093 ;; Always consider bob a match to get the first
5094 ;; declaration in the file. Do this separately instead of
5095 ;; letting `c-decl-prefix-or-start-re' match bob, so that
5096 ;; regexp always can consume at least one character to
5097 ;; ensure that we won't get stuck in an infinite loop.
5098 (setq cfd-re-match 0)
5100 (c-beginning-of-current-token)
5101 (< (point) cfd-limit))
5102 ;; Do an initial search now. In the bob case above it's
5103 ;; only done to search for a `c-decl-end' spot.
5104 (c-find-decl-prefix-search)) ; sets cfd-continue-pos
5106 (setq c-find-decl-match-pos (and (< cfd-match-pos cfd-start-pos)
5107 cfd-match-pos))))) ; end of `cond'
5109 ;; Advance `cfd-continue-pos' if it's before the start position.
5110 ;; The closest continue position that might have effect at or
5111 ;; after the start depends on what we started in. This also
5112 ;; finds a suitable start position in the special cases when the
5113 ;; region is completely within a literal or macro.
5114 (when (and cfd-continue-pos (< cfd-continue-pos cfd-start-pos))
5118 ;; If we're in a macro then it's the closest preceding token
5119 ;; in the macro. Check this before `start-in-literal',
5120 ;; since if we're inside a literal in a macro, the preceding
5121 ;; token is earlier than any `c-decl-end' spot inside the
5122 ;; literal (comment).
5123 (goto-char (or start-in-literal cfd-start-pos))
5124 ;; The only syntactic ws in macros are comments.
5125 (c-backward-comments)
5127 (c-beginning-of-current-token))
5130 ;; If we're in a comment it can only be the closest
5131 ;; preceding `c-decl-end' position within that comment, if
5132 ;; any. Go back to the beginning of such a property so that
5133 ;; `c-find-decl-prefix-search' will find the end of it.
5134 ;; (Can't stop at the end and install it directly on
5135 ;; `cfd-prop-match' since that variable might be cleared
5136 ;; after `cfd-fun' below.)
5138 ;; Note that if the literal is a string then the property
5139 ;; search will simply skip to the beginning of it right
5141 (if (not c-type-decl-end-used)
5142 (goto-char start-in-literal)
5143 (goto-char cfd-start-pos)
5145 (goto-char (previous-single-property-change
5146 (point) 'c-type nil start-in-literal))
5147 (and (> (point) start-in-literal)
5148 (not (eq (c-get-char-property (point) 'c-type)
5151 (when (= (point) start-in-literal)
5152 ;; Didn't find any property inside the comment, so we can
5153 ;; skip it entirely. (This won't skip past a string, but
5154 ;; that'll be handled quickly by the next
5155 ;; `c-find-decl-prefix-search' anyway.)
5156 (c-forward-single-comment)
5157 (if (> (point) cfd-limit)
5158 (goto-char cfd-limit))))
5161 ;; If we started in normal code, the only match that might
5162 ;; apply before the start is what we already got in
5163 ;; `cfd-match-pos' so we can continue at the start position.
5164 ;; (Note that we don't get here if the first match is below
5166 (goto-char cfd-start-pos))) ; end of `cond'
5168 ;; Delete found matches if they are before our new continue
5169 ;; position, so that `c-find-decl-prefix-search' won't back up
5170 ;; to them later on.
5171 (setq cfd-continue-pos (point))
5172 (when (and cfd-re-match (< cfd-re-match cfd-continue-pos))
5173 (setq cfd-re-match nil))
5174 (when (and cfd-prop-match (< cfd-prop-match cfd-continue-pos))
5175 (setq cfd-prop-match nil))) ; end of `when'
5178 ;; This is the normal case and we got a proper syntactic
5179 ;; position. If there's a match then it's always outside
5180 ;; macros and comments, so advance to the next token and set
5181 ;; `cfd-token-pos'. The loop below will later go back using
5182 ;; `cfd-continue-pos' to fix declarations inside the
5184 (when (and cfd-match-pos (< cfd-match-pos syntactic-pos))
5185 (goto-char syntactic-pos)
5186 (c-forward-syntactic-ws)
5187 (and cfd-continue-pos
5188 (< cfd-continue-pos (point))
5189 (setq cfd-token-pos (point))))
5191 ;; Have one of the special cases when the region is completely
5192 ;; within a literal or macro. `cfd-continue-pos' is set to a
5193 ;; good start position for the search, so do it.
5194 (c-find-decl-prefix-search)))
5196 ;; Now loop, one decl spot per iteration. We already have the first
5197 ;; match in `cfd-match-pos'.
5199 ;; Go forward over "false matches", one per iteration.
5201 (< cfd-match-pos cfd-limit)
5204 ;; Kludge to filter out matches on the "<" that
5205 ;; aren't open parens, for the sake of languages
5206 ;; that got `c-recognize-<>-arglists' set.
5207 (and (eq (char-before cfd-match-pos) ?<)
5208 (not (c-get-char-property (1- cfd-match-pos)
5211 ;; If `cfd-continue-pos' is less or equal to
5212 ;; `cfd-token-pos', we've got a hit inside a macro
5213 ;; that's in the syntactic whitespace before the last
5214 ;; "real" declaration we've checked. If they're equal
5215 ;; we've arrived at the declaration a second time, so
5216 ;; there's nothing to do.
5217 (= cfd-continue-pos cfd-token-pos)
5220 ;; If `cfd-continue-pos' is less than `cfd-token-pos'
5221 ;; we're still searching for declarations embedded in
5222 ;; the syntactic whitespace. In that case we need
5223 ;; only to skip comments and not macros, since they
5224 ;; can't be nested, and that's already been done in
5225 ;; `c-find-decl-prefix-search'.
5226 (when (> cfd-continue-pos cfd-token-pos)
5227 (c-forward-syntactic-ws)
5228 (setq cfd-token-pos (point)))
5230 ;; Continue if the following token fails the
5231 ;; CFD-DECL-RE and CFD-FACE-CHECKLIST checks.
5232 (when (or (>= (point) cfd-limit)
5233 (not (looking-at cfd-decl-re))
5234 (and cfd-face-checklist
5236 (point) cfd-face-checklist))))
5237 (goto-char cfd-continue-pos)
5240 (< (point) cfd-limit)) ; end of "false matches" condition
5241 (c-find-decl-prefix-search)) ; end of "false matches" loop
5243 (< (point) cfd-limit)) ; end of condition for "decl-spot" while
5246 (>= (point) cfd-start-pos)
5249 ;; Narrow to the end of the macro if we got a hit inside
5250 ;; one, to avoid recognizing things that start inside the
5251 ;; macro and end outside it.
5252 (when (> cfd-match-pos cfd-macro-end)
5253 ;; Not in the same macro as in the previous round.
5255 (goto-char cfd-match-pos)
5257 (if (save-excursion (and (c-beginning-of-macro)
5258 (< (point) cfd-match-pos)))
5259 (progn (c-end-of-macro)
5263 (if (zerop cfd-macro-end)
5265 (if (> cfd-macro-end (point))
5266 (progn (narrow-to-region (point-min) cfd-macro-end)
5268 ;; The matched token was the last thing in the macro,
5269 ;; so the whole match is bogus.
5270 (setq cfd-macro-end 0)
5271 nil)))) ; end of when condition
5273 (c-debug-put-decl-spot-faces cfd-match-pos (point))
5274 (if (funcall cfd-fun cfd-match-pos (/= cfd-macro-end 0))
5275 (setq cfd-prop-match nil))
5277 (when (/= cfd-macro-end 0)
5278 ;; Restore limits if we did macro narrowing above.
5279 (narrow-to-region (point-min) cfd-buffer-end)))
5281 (goto-char cfd-continue-pos)
5282 (if (= cfd-continue-pos cfd-limit)
5283 (setq cfd-match-pos cfd-limit)
5284 (c-find-decl-prefix-search))))) ; Moves point, sets cfd-continue-pos,
5285 ; cfd-match-pos, etc.
5288 ;; A cache for found types.
5290 ;; Buffer local variable that contains an obarray with the types we've
5291 ;; found. If a declaration is recognized somewhere we record the
5292 ;; fully qualified identifier in it to recognize it as a type
5293 ;; elsewhere in the file too. This is not accurate since we do not
5294 ;; bother with the scoping rules of the languages, but in practice the
5295 ;; same name is seldom used as both a type and something else in a
5296 ;; file, and we only use this as a last resort in ambiguous cases (see
5297 ;; `c-forward-decl-or-cast-1').
5299 ;; Not every type need be in this cache. However, things which have
5300 ;; ceased to be types must be removed from it.
5302 ;; Template types in C++ are added here too but with the template
5303 ;; arglist replaced with "<>" in references or "<" for the one in the
5304 ;; primary type. E.g. the type "Foo<A,B>::Bar<C>" is stored as
5305 ;; "Foo<>::Bar<". This avoids storing very long strings (since C++
5306 ;; template specs can be fairly sized programs in themselves) and
5307 ;; improves the hit ratio (it's a type regardless of the template
5308 ;; args; it's just not the same type, but we're only interested in
5309 ;; recognizing types, not telling distinct types apart). Note that
5310 ;; template types in references are added here too; from the example
5311 ;; above there will also be an entry "Foo<".
5312 (defvar c-found-types nil)
5313 (make-variable-buffer-local 'c-found-types)
5315 (defsubst c-clear-found-types ()
5316 ;; Clears `c-found-types'.
5317 (setq c-found-types (make-vector 53 0)))
5319 (defun c-add-type (from to)
5320 ;; Add the given region as a type in `c-found-types'. If the region
5321 ;; doesn't match an existing type but there is a type which is equal
5322 ;; to the given one except that the last character is missing, then
5323 ;; the shorter type is removed. That's done to avoid adding all
5324 ;; prefixes of a type as it's being entered and font locked. This
5325 ;; doesn't cover cases like when characters are removed from a type
5326 ;; or added in the middle. We'd need the position of point when the
5327 ;; font locking is invoked to solve this well.
5329 ;; This function might do hidden buffer changes.
5330 (let ((type (c-syntactic-content from to c-recognize-<>-arglists)))
5331 (unless (intern-soft type c-found-types)
5332 (unintern (substring type 0 -1) c-found-types)
5333 (intern type c-found-types))))
5335 (defun c-unfind-type (name)
5336 ;; Remove the "NAME" from c-found-types, if present.
5337 (unintern name c-found-types))
5339 (defsubst c-check-type (from to)
5340 ;; Return non-nil if the given region contains a type in
5343 ;; This function might do hidden buffer changes.
5344 (intern-soft (c-syntactic-content from to c-recognize-<>-arglists)
5347 (defun c-list-found-types ()
5348 ;; Return all the types in `c-found-types' as a sorted list of
5351 (mapatoms (lambda (type)
5352 (setq type-list (cons (symbol-name type)
5355 (sort type-list 'string-lessp)))
5357 ;; Shut up the byte compiler.
5358 (defvar c-maybe-stale-found-type)
5360 (defun c-trim-found-types (beg end old-len)
5361 ;; An after change function which, in conjunction with the info in
5362 ;; c-maybe-stale-found-type (set in c-before-change), removes a type
5363 ;; from `c-found-types', should this type have become stale. For
5364 ;; example, this happens to "foo" when "foo \n bar();" becomes
5365 ;; "foo(); \n bar();". Such stale types, if not removed, foul up
5366 ;; the fontification.
5368 ;; Have we, perhaps, added non-ws characters to the front/back of a found
5372 (when (< end (point-max))
5374 (if (and (c-beginning-of-current-token) ; only moves when we started in the middle
5375 (progn (goto-char end)
5376 (c-end-of-current-token)))
5377 (c-unfind-type (buffer-substring-no-properties
5379 (when (> beg (point-min))
5381 (if (and (c-end-of-current-token) ; only moves when we started in the middle
5382 (progn (goto-char beg)
5383 (c-beginning-of-current-token)))
5384 (c-unfind-type (buffer-substring-no-properties
5387 (if c-maybe-stale-found-type ; e.g. (c-decl-id-start "foo" 97 107 " (* ooka) " "o")
5389 ;; Changing the amount of (already existing) whitespace - don't do anything.
5390 ((and (c-partial-ws-p beg end)
5391 (or (= beg end) ; removal of WS
5392 (string-match "^[ \t\n\r\f\v]*$" (nth 5 c-maybe-stale-found-type)))))
5394 ;; The syntactic relationship which defined a "found type" has been
5396 ((eq (car c-maybe-stale-found-type) 'c-decl-id-start)
5397 (c-unfind-type (cadr c-maybe-stale-found-type)))
5398 ;; ((eq (car c-maybe-stale-found-type) 'c-decl-type-start) FIXME!!!
5402 ;; Setting and removing syntax properties on < and > in languages (C++
5403 ;; and Java) where they can be template/generic delimiters as well as
5404 ;; their normal meaning of "less/greater than".
5406 ;; Normally, < and > have syntax 'punctuation'. When they are found to
5407 ;; be delimiters, they are marked as such with the category properties
5408 ;; c-<-as-paren-syntax, c->-as-paren-syntax respectively.
5412 ;; It is impossible to determine with certainty whether a <..> pair in
5413 ;; C++ is two comparison operators or is template delimiters, unless
5414 ;; one duplicates a lot of a C++ compiler. For example, the following
5417 ;; foo (a < b, c > d) ;
5419 ;; could be a function call with two integer parameters (each a
5420 ;; relational expression), or it could be a constructor for class foo
5421 ;; taking one parameter d of templated type "a < b, c >". They are
5422 ;; somewhat easier to distinguish in Java.
5424 ;; The strategy now (2010-01) adopted is to mark and unmark < and
5425 ;; > IN MATCHING PAIRS ONLY. [Previously, they were marked
5426 ;; individually when their context so indicated. This gave rise to
5427 ;; intractable problems when one of a matching pair was deleted, or
5428 ;; pulled into a literal.]
5430 ;; At each buffer change, the syntax-table properties are removed in a
5431 ;; before-change function and reapplied, when needed, in an
5432 ;; after-change function. It is far more important that the
5433 ;; properties get removed when they they are spurious than that they
5434 ;; be present when wanted.
5435 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
5436 (defun c-clear-<-pair-props (&optional pos)
5437 ;; POS (default point) is at a < character. If it is marked with
5438 ;; open paren syntax-table text property, remove the property,
5439 ;; together with the close paren property on the matching > (if
5445 (when (equal (c-get-char-property (point) 'syntax-table)
5446 c-<-as-paren-syntax)
5447 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5448 (c-go-list-forward))
5449 (when (equal (c-get-char-property (1- (point)) 'syntax-table)
5450 c->-as-paren-syntax) ; should always be true.
5451 (c-unmark-<->-as-paren (1- (point))))
5452 (c-unmark-<->-as-paren pos))))
5454 (defun c-clear->-pair-props (&optional pos)
5455 ;; POS (default point) is at a > character. If it is marked with
5456 ;; close paren syntax-table property, remove the property, together
5457 ;; with the open paren property on the matching < (if any).
5462 (when (equal (c-get-char-property (point) 'syntax-table)
5463 c->-as-paren-syntax)
5464 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5465 (c-go-up-list-backward))
5466 (when (equal (c-get-char-property (point) 'syntax-table)
5467 c-<-as-paren-syntax) ; should always be true.
5468 (c-unmark-<->-as-paren (point)))
5469 (c-unmark-<->-as-paren pos))))
5471 (defun c-clear-<>-pair-props (&optional pos)
5472 ;; POS (default point) is at a < or > character. If it has an
5473 ;; open/close paren syntax-table property, remove this property both
5474 ;; from the current character and its partner (which will also be
5477 ((eq (char-after) ?\<)
5478 (c-clear-<-pair-props pos))
5479 ((eq (char-after) ?\>)
5480 (c-clear->-pair-props pos))
5482 "c-clear-<>-pair-props called from wrong position"))))
5484 (defun c-clear-<-pair-props-if-match-after (lim &optional pos)
5485 ;; POS (default point) is at a < character. If it is both marked
5486 ;; with open/close paren syntax-table property, and has a matching >
5487 ;; (also marked) which is after LIM, remove the property both from
5488 ;; the current > and its partner. Return t when this happens, nil
5494 (when (equal (c-get-char-property (point) 'syntax-table)
5495 c-<-as-paren-syntax)
5496 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5497 (c-go-list-forward))
5498 (when (and (>= (point) lim)
5499 (equal (c-get-char-property (1- (point)) 'syntax-table)
5500 c->-as-paren-syntax)) ; should always be true.
5501 (c-unmark-<->-as-paren (1- (point)))
5502 (c-unmark-<->-as-paren pos))
5505 (defun c-clear->-pair-props-if-match-before (lim &optional pos)
5506 ;; POS (default point) is at a > character. If it is both marked
5507 ;; with open/close paren syntax-table property, and has a matching <
5508 ;; (also marked) which is before LIM, remove the property both from
5509 ;; the current < and its partner. Return t when this happens, nil
5515 (when (equal (c-get-char-property (point) 'syntax-table)
5516 c->-as-paren-syntax)
5517 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5518 (c-go-up-list-backward))
5519 (when (and (<= (point) lim)
5520 (equal (c-get-char-property (point) 'syntax-table)
5521 c-<-as-paren-syntax)) ; should always be true.
5522 (c-unmark-<->-as-paren (point))
5523 (c-unmark-<->-as-paren pos))
5526 ;; Set by c-common-init in cc-mode.el.
5530 (defun c-before-change-check-<>-operators (beg end)
5531 ;; Unmark certain pairs of "< .... >" which are currently marked as
5532 ;; template/generic delimiters. (This marking is via syntax-table
5533 ;; text properties).
5535 ;; These pairs are those which are in the current "statement" (i.e.,
5536 ;; the region between the {, }, or ; before BEG and the one after
5537 ;; END), and which enclose any part of the interval (BEG END).
5539 ;; Note that in C++ (?and Java), template/generic parens cannot
5540 ;; enclose a brace or semicolon, so we use these as bounds on the
5541 ;; region we must work on.
5543 ;; This function is called from before-change-functions (via
5544 ;; c-get-state-before-change-functions). Thus the buffer is widened,
5545 ;; and point is undefined, both at entry and exit.
5547 ;; FIXME!!! This routine ignores the possibility of macros entirely.
5550 (let ((beg-lit-limits (progn (goto-char beg) (c-literal-limits)))
5551 (end-lit-limits (progn (goto-char end) (c-literal-limits)))
5552 new-beg new-end need-new-beg need-new-end)
5553 ;; Locate the barrier before the changed region
5554 (goto-char (if beg-lit-limits (car beg-lit-limits) beg))
5555 (c-syntactic-skip-backward "^;{}" (c-determine-limit 512))
5556 (setq new-beg (point))
5558 ;; Remove the syntax-table/category properties from each pertinent <...>
5559 ;; pair. Firsly, the ones with the < before beg and > after beg.
5561 (c-search-forward-char-property 'syntax-table c-<-as-paren-syntax beg)
5562 (if (c-clear-<-pair-props-if-match-after beg (1- (point)))
5563 (setq need-new-beg t)))
5565 ;; Locate the barrier after END.
5566 (goto-char (if end-lit-limits (cdr end-lit-limits) end))
5567 (c-syntactic-re-search-forward "[;{}]" (c-determine-+ve-limit 512) 'end)
5568 (setq new-end (point))
5570 ;; Remove syntax-table properties from the remaining pertinent <...>
5571 ;; pairs, those with a > after end and < before end.
5572 (while (c-search-backward-char-property 'syntax-table c->-as-paren-syntax end)
5573 (if (c-clear->-pair-props-if-match-before end)
5574 (setq need-new-end t)))
5576 ;; Extend the fontification region, if needed.
5579 (c-forward-syntactic-ws)
5580 (and (< (point) c-new-BEG) (setq c-new-BEG (point))))
5583 (and (> new-end c-new-END) (setq c-new-END new-end))))))
5585 (defun c-after-change-check-<>-operators (beg end)
5586 ;; This is called from `after-change-functions' when
5587 ;; c-recognize-<>-arglists' is set. It ensures that no "<" or ">"
5588 ;; chars with paren syntax become part of another operator like "<<"
5591 ;; This function might do hidden buffer changes.
5595 (when (or (looking-at "[<>]")
5596 (< (skip-chars-backward "<>") 0))
5599 (c-beginning-of-current-token)
5600 (when (and (< (point) beg)
5601 (looking-at c-<>-multichar-token-regexp)
5602 (< beg (setq beg (match-end 0))))
5603 (while (progn (skip-chars-forward "^<>" beg)
5605 (c-clear-<>-pair-props)
5610 (when (or (looking-at "[<>]")
5611 (< (skip-chars-backward "<>") 0))
5614 (c-beginning-of-current-token)
5615 (when (and (< (point) end)
5616 (looking-at c-<>-multichar-token-regexp)
5617 (< end (setq end (match-end 0))))
5618 (while (progn (skip-chars-forward "^<>" end)
5620 (c-clear-<>-pair-props)
5621 (forward-char)))))))
5625 ;; Handling of small scale constructs like types and names.
5627 ;; Dynamically bound variable that instructs `c-forward-type' to also
5628 ;; treat possible types (i.e. those that it normally returns 'maybe or
5629 ;; 'found for) as actual types (and always return 'found for them).
5630 ;; This means that it records them in `c-record-type-identifiers' if
5631 ;; that is set, and that it adds them to `c-found-types'.
5632 (defvar c-promote-possible-types nil)
5634 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5635 ;; mark up successfully parsed arglists with paren syntax properties on
5636 ;; the surrounding angle brackets and with `c-<>-arg-sep' in the
5637 ;; `c-type' property of each argument separating comma.
5639 ;; Setting this variable also makes `c-forward-<>-arglist' recurse into
5640 ;; all arglists for side effects (i.e. recording types), otherwise it
5641 ;; exploits any existing paren syntax properties to quickly jump to the
5642 ;; end of already parsed arglists.
5644 ;; Marking up the arglists is not the default since doing that correctly
5645 ;; depends on a proper value for `c-restricted-<>-arglists'.
5646 (defvar c-parse-and-markup-<>-arglists nil)
5648 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5649 ;; not accept arglists that contain binary operators.
5651 ;; This is primarily used to handle C++ template arglists. C++
5652 ;; disambiguates them by checking whether the preceding name is a
5653 ;; template or not. We can't do that, so we assume it is a template
5654 ;; if it can be parsed as one. That usually works well since
5655 ;; comparison expressions on the forms "a < b > c" or "a < b, c > d"
5656 ;; in almost all cases would be pointless.
5658 ;; However, in function arglists, e.g. in "foo (a < b, c > d)", we
5659 ;; should let the comma separate the function arguments instead. And
5660 ;; in a context where the value of the expression is taken, e.g. in
5661 ;; "if (a < b || c > d)", it's probably not a template.
5662 (defvar c-restricted-<>-arglists nil)
5664 ;; Dynamically bound variables that instructs
5665 ;; `c-forward-keyword-clause', `c-forward-<>-arglist',
5666 ;; `c-forward-name', `c-forward-type', `c-forward-decl-or-cast-1', and
5667 ;; `c-forward-label' to record the ranges of all the type and
5668 ;; reference identifiers they encounter. They will build lists on
5669 ;; these variables where each element is a cons of the buffer
5670 ;; positions surrounding each identifier. This recording is only
5671 ;; activated when `c-record-type-identifiers' is non-nil.
5673 ;; All known types that can't be identifiers are recorded, and also
5674 ;; other possible types if `c-promote-possible-types' is set.
5675 ;; Recording is however disabled inside angle bracket arglists that
5676 ;; are encountered inside names and other angle bracket arglists.
5677 ;; Such occurrences are taken care of by `c-font-lock-<>-arglists'
5680 ;; Only the names in C++ template style references (e.g. "tmpl" in
5681 ;; "tmpl<a,b>::foo") are recorded as references, other references
5682 ;; aren't handled here.
5684 ;; `c-forward-label' records the label identifier(s) on
5685 ;; `c-record-ref-identifiers'.
5686 (defvar c-record-type-identifiers nil)
5687 (defvar c-record-ref-identifiers nil)
5689 ;; This variable will receive a cons cell of the range of the last
5690 ;; single identifier symbol stepped over by `c-forward-name' if it's
5691 ;; successful. This is the range that should be put on one of the
5692 ;; record lists above by the caller. It's assigned nil if there's no
5693 ;; such symbol in the name.
5694 (defvar c-last-identifier-range nil)
5696 (defmacro c-record-type-id (range)
5697 (if (eq (car-safe range) 'cons)
5699 `(setq c-record-type-identifiers
5700 (cons ,range c-record-type-identifiers))
5701 `(let ((range ,range))
5703 (setq c-record-type-identifiers
5704 (cons range c-record-type-identifiers))))))
5706 (defmacro c-record-ref-id (range)
5707 (if (eq (car-safe range) 'cons)
5709 `(setq c-record-ref-identifiers
5710 (cons ,range c-record-ref-identifiers))
5711 `(let ((range ,range))
5713 (setq c-record-ref-identifiers
5714 (cons range c-record-ref-identifiers))))))
5716 ;; Dynamically bound variable that instructs `c-forward-type' to
5717 ;; record the ranges of types that only are found. Behaves otherwise
5718 ;; like `c-record-type-identifiers'.
5719 (defvar c-record-found-types nil)
5721 (defmacro c-forward-keyword-prefixed-id (type)
5722 ;; Used internally in `c-forward-keyword-clause' to move forward
5723 ;; over a type (if TYPE is 'type) or a name (otherwise) which
5724 ;; possibly is prefixed by keywords and their associated clauses.
5725 ;; Try with a type/name first to not trip up on those that begin
5726 ;; with a keyword. Return t if a known or found type is moved
5727 ;; over. The point is clobbered if nil is returned. If range
5728 ;; recording is enabled, the identifier is recorded on as a type
5729 ;; if TYPE is 'type or as a reference if TYPE is 'ref.
5731 ;; This macro might do hidden buffer changes.
5733 (while (if (setq res ,(if (eq type 'type)
5737 (and (looking-at c-keywords-regexp)
5738 (c-forward-keyword-clause 1))))
5739 (when (memq res '(t known found prefix))
5740 ,(when (eq type 'ref)
5741 `(when c-record-type-identifiers
5742 (c-record-ref-id c-last-identifier-range)))
5745 (defmacro c-forward-id-comma-list (type update-safe-pos)
5746 ;; Used internally in `c-forward-keyword-clause' to move forward
5747 ;; over a comma separated list of types or names using
5748 ;; `c-forward-keyword-prefixed-id'.
5750 ;; This macro might do hidden buffer changes.
5752 ,(when update-safe-pos
5753 `(setq safe-pos (point)))
5754 (eq (char-after) ?,))
5757 (c-forward-syntactic-ws)
5758 (c-forward-keyword-prefixed-id ,type)))))
5760 (defun c-forward-keyword-clause (match)
5761 ;; Submatch MATCH in the current match data is assumed to surround a
5762 ;; token. If it's a keyword, move over it and any immediately
5763 ;; following clauses associated with it, stopping at the start of
5764 ;; the next token. t is returned in that case, otherwise the point
5765 ;; stays and nil is returned. The kind of clauses that are
5766 ;; recognized are those specified by `c-type-list-kwds',
5767 ;; `c-ref-list-kwds', `c-colon-type-list-kwds',
5768 ;; `c-paren-nontype-kwds', `c-paren-type-kwds', `c-<>-type-kwds',
5769 ;; and `c-<>-arglist-kwds'.
5771 ;; This function records identifier ranges on
5772 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5773 ;; `c-record-type-identifiers' is non-nil.
5775 ;; Note that for `c-colon-type-list-kwds', which doesn't necessary
5776 ;; apply directly after the keyword, the type list is moved over
5777 ;; only when there is no unaccounted token before it (i.e. a token
5778 ;; that isn't moved over due to some other keyword list). The
5779 ;; identifier ranges in the list are still recorded if that should
5782 ;; This function might do hidden buffer changes.
5784 (let ((kwd-sym (c-keyword-sym (match-string match))) safe-pos pos
5785 ;; The call to `c-forward-<>-arglist' below is made after
5786 ;; `c-<>-sexp-kwds' keywords, so we're certain they actually
5787 ;; are angle bracket arglists and `c-restricted-<>-arglists'
5788 ;; should therefore be nil.
5789 (c-parse-and-markup-<>-arglists t)
5790 c-restricted-<>-arglists)
5793 (goto-char (match-end match))
5794 (c-forward-syntactic-ws)
5795 (setq safe-pos (point))
5798 ((and (c-keyword-member kwd-sym 'c-type-list-kwds)
5799 (c-forward-keyword-prefixed-id type))
5800 ;; There's a type directly after a keyword in `c-type-list-kwds'.
5801 (c-forward-id-comma-list type t))
5803 ((and (c-keyword-member kwd-sym 'c-ref-list-kwds)
5804 (c-forward-keyword-prefixed-id ref))
5805 ;; There's a name directly after a keyword in `c-ref-list-kwds'.
5806 (c-forward-id-comma-list ref t))
5808 ((and (c-keyword-member kwd-sym 'c-paren-any-kwds)
5809 (eq (char-after) ?\())
5810 ;; There's an open paren after a keyword in `c-paren-any-kwds'.
5813 (when (and (setq pos (c-up-list-forward))
5814 (eq (char-before pos) ?\)))
5815 (when (and c-record-type-identifiers
5816 (c-keyword-member kwd-sym 'c-paren-type-kwds))
5817 ;; Use `c-forward-type' on every identifier we can find
5818 ;; inside the paren, to record the types.
5819 (while (c-syntactic-re-search-forward c-symbol-start pos t)
5820 (goto-char (match-beginning 0))
5821 (unless (c-forward-type)
5822 (looking-at c-symbol-key) ; Always matches.
5823 (goto-char (match-end 0)))))
5826 (c-forward-syntactic-ws)
5827 (setq safe-pos (point))))
5829 ((and (c-keyword-member kwd-sym 'c-<>-sexp-kwds)
5830 (eq (char-after) ?<)
5831 (c-forward-<>-arglist (c-keyword-member kwd-sym 'c-<>-type-kwds)))
5832 (c-forward-syntactic-ws)
5833 (setq safe-pos (point)))
5835 ((and (c-keyword-member kwd-sym 'c-nonsymbol-sexp-kwds)
5836 (not (looking-at c-symbol-start))
5837 (c-safe (c-forward-sexp) t))
5838 (c-forward-syntactic-ws)
5839 (setq safe-pos (point))))
5841 (when (c-keyword-member kwd-sym 'c-colon-type-list-kwds)
5842 (if (eq (char-after) ?:)
5843 ;; If we are at the colon already, we move over the type
5847 (c-forward-syntactic-ws)
5848 (when (c-forward-keyword-prefixed-id type)
5849 (c-forward-id-comma-list type t)))
5850 ;; Not at the colon, so stop here. But the identifier
5851 ;; ranges in the type list later on should still be
5853 (and c-record-type-identifiers
5855 ;; If a keyword matched both one of the types above and
5856 ;; this one, we match `c-colon-type-list-re' after the
5857 ;; clause matched above.
5858 (goto-char safe-pos)
5859 (looking-at c-colon-type-list-re))
5861 (goto-char (match-end 0))
5862 (c-forward-syntactic-ws)
5863 (c-forward-keyword-prefixed-id type))
5864 ;; There's a type after the `c-colon-type-list-re' match
5865 ;; after a keyword in `c-colon-type-list-kwds'.
5866 (c-forward-id-comma-list type nil))))
5868 (goto-char safe-pos)
5871 ;; cc-mode requires cc-fonts.
5872 (declare-function c-fontify-recorded-types-and-refs "cc-fonts" ())
5874 (defun c-forward-<>-arglist (all-types)
5875 ;; The point is assumed to be at a "<". Try to treat it as the open
5876 ;; paren of an angle bracket arglist and move forward to the
5877 ;; corresponding ">". If successful, the point is left after the
5878 ;; ">" and t is returned, otherwise the point isn't moved and nil is
5879 ;; returned. If ALL-TYPES is t then all encountered arguments in
5880 ;; the arglist that might be types are treated as found types.
5882 ;; The variable `c-parse-and-markup-<>-arglists' controls how this
5883 ;; function handles text properties on the angle brackets and argument
5884 ;; separating commas.
5886 ;; `c-restricted-<>-arglists' controls how lenient the template
5887 ;; arglist recognition should be.
5889 ;; This function records identifier ranges on
5890 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5891 ;; `c-record-type-identifiers' is non-nil.
5893 ;; This function might do hidden buffer changes.
5895 (let ((start (point))
5896 ;; If `c-record-type-identifiers' is set then activate
5897 ;; recording of any found types that constitute an argument in
5899 (c-record-found-types (if c-record-type-identifiers t)))
5900 (if (catch 'angle-bracket-arglist-escape
5901 (setq c-record-found-types
5902 (c-forward-<>-arglist-recur all-types)))
5904 (when (consp c-record-found-types)
5905 (setq c-record-type-identifiers
5906 ;; `nconc' doesn't mind that the tail of
5907 ;; `c-record-found-types' is t.
5908 (nconc c-record-found-types c-record-type-identifiers)))
5909 (if (c-major-mode-is 'java-mode) (c-fontify-recorded-types-and-refs))
5915 (defun c-forward-<>-arglist-recur (all-types)
5916 ;; Recursive part of `c-forward-<>-arglist'.
5918 ;; This function might do hidden buffer changes.
5919 (let ((start (point)) res pos tmp
5920 ;; Cover this so that any recorded found type ranges are
5921 ;; automatically lost if it turns out to not be an angle
5922 ;; bracket arglist. It's propagated through the return value
5923 ;; on successful completion.
5924 (c-record-found-types c-record-found-types)
5925 ;; List that collects the positions after the argument
5926 ;; separating ',' in the arglist.
5928 ;; If the '<' has paren open syntax then we've marked it as an angle
5929 ;; bracket arglist before, so skip to the end.
5930 (if (and (not c-parse-and-markup-<>-arglists)
5931 (c-get-char-property (point) 'syntax-table))
5935 (if (and (c-go-up-list-forward)
5936 (eq (char-before) ?>))
5938 ;; Got unmatched paren angle brackets. We don't clear the paren
5939 ;; syntax properties and retry, on the basis that it's very
5940 ;; unlikely that paren angle brackets become operators by code
5941 ;; manipulation. It's far more likely that it doesn't match due
5942 ;; to narrowing or some temporary change.
5946 (forward-char) ; Forward over the opening '<'.
5948 (unless (looking-at c-<-op-cont-regexp)
5949 ;; go forward one non-alphanumeric character (group) per iteration of
5953 (c-forward-syntactic-ws)
5954 (when (or (and c-record-type-identifiers all-types)
5955 (c-major-mode-is 'java-mode))
5956 ;; All encountered identifiers are types, so set the
5957 ;; promote flag and parse the type.
5959 (c-forward-syntactic-ws)
5960 (if (looking-at "\\?")
5962 (when (looking-at c-identifier-start)
5963 (let ((c-promote-possible-types t)
5964 (c-record-found-types t))
5967 (c-forward-syntactic-ws)
5969 (when (or (looking-at "extends")
5970 (looking-at "super"))
5972 (c-forward-syntactic-ws)
5973 (let ((c-promote-possible-types t)
5974 (c-record-found-types t))
5976 (c-forward-syntactic-ws)))))
5978 (setq pos (point)) ; e.g. first token inside the '<'
5980 ;; Note: These regexps exploit the match order in \| so
5981 ;; that "<>" is matched by "<" rather than "[^>:-]>".
5982 (c-syntactic-re-search-forward
5983 ;; Stop on ',', '|', '&', '+' and '-' to catch
5984 ;; common binary operators that could be between
5985 ;; two comparison expressions "a<b" and "c>d".
5986 "[<;{},|+&-]\\|[>)]"
5990 ((eq (char-before) ?>)
5991 ;; Either an operator starting with '>' or the end of
5992 ;; the angle bracket arglist.
5994 (if (looking-at c->-op-without->-cont-regexp)
5996 (goto-char (match-end 0))
5997 t) ; Continue the loop.
5999 ;; The angle bracket arglist is finished.
6000 (when c-parse-and-markup-<>-arglists
6001 (while arg-start-pos
6002 (c-put-c-type-property (1- (car arg-start-pos))
6004 (setq arg-start-pos (cdr arg-start-pos)))
6005 (c-mark-<-as-paren start)
6006 (c-mark->-as-paren (1- (point))))
6008 nil)) ; Exit the loop.
6010 ((eq (char-before) ?<)
6011 ;; Either an operator starting with '<' or a nested arglist.
6013 (let (id-start id-end subres keyword-match)
6015 ;; The '<' begins a multi-char operator.
6016 ((looking-at c-<-op-cont-regexp)
6017 (setq tmp (match-end 0))
6018 (goto-char (match-end 0)))
6019 ;; We're at a nested <.....>
6022 (backward-char) ; to the '<'
6025 ;; There's always an identifier before an angle
6026 ;; bracket arglist, or a keyword in `c-<>-type-kwds'
6027 ;; or `c-<>-arglist-kwds'.
6028 (c-backward-syntactic-ws)
6029 (setq id-end (point))
6030 (c-simple-skip-symbol-backward)
6031 (when (or (setq keyword-match
6032 (looking-at c-opt-<>-sexp-key))
6033 (not (looking-at c-keywords-regexp)))
6034 (setq id-start (point))))
6036 (let ((c-promote-possible-types t)
6037 (c-record-found-types t))
6038 (c-forward-<>-arglist-recur
6041 (c-keyword-sym (match-string 1))
6042 'c-<>-type-kwds)))))))
6043 ;; It was an angle bracket arglist.
6044 (setq c-record-found-types subres)
6046 ;; Record the identifier before the template as a type
6047 ;; or reference depending on whether the arglist is last
6048 ;; in a qualified identifier.
6049 (when (and c-record-type-identifiers
6050 (not keyword-match))
6051 (if (and c-opt-identifier-concat-key
6053 (c-forward-syntactic-ws)
6054 (looking-at c-opt-identifier-concat-key)))
6055 (c-record-ref-id (cons id-start id-end))
6056 (c-record-type-id (cons id-start id-end)))))
6058 ;; At a "less than" operator.
6062 t) ; carry on looping.
6064 ((and (not c-restricted-<>-arglists)
6065 (or (and (eq (char-before) ?&)
6066 (not (eq (char-after) ?&)))
6067 (eq (char-before) ?,)))
6068 ;; Just another argument. Record the position. The
6069 ;; type check stuff that made us stop at it is at
6070 ;; the top of the loop.
6071 (setq arg-start-pos (cons (point) arg-start-pos)))
6074 ;; Got a character that can't be in an angle bracket
6075 ;; arglist argument. Abort using `throw', since
6076 ;; it's useless to try to find a surrounding arglist
6078 (throw 'angle-bracket-arglist-escape nil))))))
6080 (or c-record-found-types t)))))
6082 (defun c-backward-<>-arglist (all-types &optional limit)
6083 ;; The point is assumed to be directly after a ">". Try to treat it
6084 ;; as the close paren of an angle bracket arglist and move back to
6085 ;; the corresponding "<". If successful, the point is left at
6086 ;; the "<" and t is returned, otherwise the point isn't moved and
6087 ;; nil is returned. ALL-TYPES is passed on to
6088 ;; `c-forward-<>-arglist'.
6090 ;; If the optional LIMIT is given, it bounds the backward search.
6091 ;; It's then assumed to be at a syntactically relevant position.
6093 ;; This is a wrapper around `c-forward-<>-arglist'. See that
6094 ;; function for more details.
6096 (let ((start (point)))
6098 (if (and (not c-parse-and-markup-<>-arglists)
6099 (c-get-char-property (point) 'syntax-table))
6101 (if (and (c-go-up-list-backward)
6102 (eq (char-after) ?<))
6104 ;; See corresponding note in `c-forward-<>-arglist'.
6109 (c-syntactic-skip-backward "^<;{}" limit t)
6112 (if (eq (char-before) ?<)
6114 ;; Stopped at bob or a char that isn't allowed in an
6115 ;; arglist, so we've failed.
6120 (progn (c-beginning-of-current-token)
6122 ;; If we moved then the "<" was part of some
6123 ;; multicharacter token.
6127 (let ((beg-pos (point)))
6128 (if (c-forward-<>-arglist all-types)
6129 (cond ((= (point) start)
6130 ;; Matched the arglist. Break the while.
6134 ;; We started from a non-paren ">" inside an
6139 ;; Matched a shorter arglist. Can be a nested
6140 ;; one so continue looking.
6145 (/= (point) start))))
6147 (defun c-forward-name ()
6148 ;; Move forward over a complete name if at the beginning of one,
6149 ;; stopping at the next following token. A keyword, as such,
6150 ;; doesn't count as a name. If the point is not at something that
6151 ;; is recognized as a name then it stays put.
6153 ;; A name could be something as simple as "foo" in C or something as
6154 ;; complex as "X<Y<class A<int>::B, BIT_MAX >> b>, ::operator<> ::
6155 ;; Z<(a>b)> :: operator const X<&foo>::T Q::G<unsigned short
6156 ;; int>::*volatile const" in C++ (this function is actually little
6157 ;; more than a `looking-at' call in all modes except those that,
6158 ;; like C++, have `c-recognize-<>-arglists' set).
6161 ;; o - nil if no name is found;
6162 ;; o - 'template if it's an identifier ending with an angle bracket
6164 ;; o - 'operator of it's an operator identifier;
6165 ;; o - t if it's some other kind of name.
6167 ;; This function records identifier ranges on
6168 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6169 ;; `c-record-type-identifiers' is non-nil.
6171 ;; This function might do hidden buffer changes.
6173 (let ((pos (point)) (start (point)) res id-start id-end
6174 ;; Turn off `c-promote-possible-types' here since we might
6175 ;; call `c-forward-<>-arglist' and we don't want it to promote
6176 ;; every suspect thing in the arglist to a type. We're
6177 ;; typically called from `c-forward-type' in this case, and
6178 ;; the caller only wants the top level type that it finds to
6180 c-promote-possible-types)
6183 (looking-at c-identifier-key)
6186 ;; Check for keyword. We go to the last symbol in
6187 ;; `c-identifier-key' first.
6188 (goto-char (setq id-end (match-end 0)))
6189 (c-simple-skip-symbol-backward)
6190 (setq id-start (point))
6192 (if (looking-at c-keywords-regexp)
6193 (when (and (c-major-mode-is 'c++-mode)
6195 (cc-eval-when-compile
6196 (concat "\\(operator\\|\\(template\\)\\)"
6197 "\\(" (c-lang-const c-nonsymbol-key c++)
6199 (if (match-beginning 2)
6200 ;; "template" is only valid inside an
6201 ;; identifier if preceded by "::".
6203 (c-backward-syntactic-ws)
6204 (and (c-safe (backward-char 2) t)
6208 ;; Handle a C++ operator or template identifier.
6210 (c-forward-syntactic-ws)
6211 (cond ((eq (char-before id-end) ?e)
6212 ;; Got "... ::template".
6213 (let ((subres (c-forward-name)))
6218 ((looking-at c-identifier-start)
6219 ;; Got a cast operator.
6220 (when (c-forward-type)
6223 ;; Now we should match a sequence of either
6224 ;; '*', '&' or a name followed by ":: *",
6225 ;; where each can be followed by a sequence
6226 ;; of `c-opt-type-modifier-key'.
6227 (while (cond ((looking-at "[*&]")
6228 (goto-char (match-end 0))
6230 ((looking-at c-identifier-start)
6231 (and (c-forward-name)
6234 (goto-char (match-end 0))
6235 (c-forward-syntactic-ws)
6236 (eq (char-after) ?*))
6241 (c-forward-syntactic-ws)
6243 (looking-at c-opt-type-modifier-key))
6244 (goto-char (match-end 1))))))
6246 ((looking-at c-overloadable-operators-regexp)
6247 ;; Got some other operator.
6248 (setq c-last-identifier-range
6249 (cons (point) (match-end 0)))
6250 (goto-char (match-end 0))
6251 (c-forward-syntactic-ws)
6257 ;; `id-start' is equal to `id-end' if we've jumped over
6258 ;; an identifier that doesn't end with a symbol token.
6259 ;; That can occur e.g. for Java import directives on the
6260 ;; form "foo.bar.*".
6261 (when (and id-start (/= id-start id-end))
6262 (setq c-last-identifier-range
6263 (cons id-start id-end)))
6265 (c-forward-syntactic-ws)
6271 (when (or c-opt-identifier-concat-key
6272 c-recognize-<>-arglists)
6275 ((and c-opt-identifier-concat-key
6276 (looking-at c-opt-identifier-concat-key))
6277 ;; Got a concatenated identifier. This handles the
6278 ;; cases with tricky syntactic whitespace that aren't
6279 ;; covered in `c-identifier-key'.
6280 (goto-char (match-end 0))
6281 (c-forward-syntactic-ws)
6284 ((and c-recognize-<>-arglists
6285 (eq (char-after) ?<))
6286 ;; Maybe an angle bracket arglist.
6287 (when (let ((c-record-type-identifiers t)
6288 (c-record-found-types t))
6289 (c-forward-<>-arglist nil))
6291 (c-add-type start (1+ pos))
6292 (c-forward-syntactic-ws)
6294 c-last-identifier-range nil)
6296 (if (and c-opt-identifier-concat-key
6297 (looking-at c-opt-identifier-concat-key))
6299 ;; Continue if there's an identifier concatenation
6300 ;; operator after the template argument.
6302 (when (and c-record-type-identifiers id-start)
6303 (c-record-ref-id (cons id-start id-end)))
6305 (c-forward-syntactic-ws)
6308 (when (and c-record-type-identifiers id-start)
6309 (c-record-type-id (cons id-start id-end)))
6310 (setq res 'template)
6317 (defun c-forward-type (&optional brace-block-too)
6318 ;; Move forward over a type spec if at the beginning of one,
6319 ;; stopping at the next following token. The keyword "typedef"
6320 ;; isn't part of a type spec here.
6322 ;; BRACE-BLOCK-TOO, when non-nil, means move over the brace block in
6323 ;; constructs like "struct foo {...} bar ;" or "struct {...} bar;".
6324 ;; The current (2009-03-10) intention is to convert all uses of
6325 ;; `c-forward-type' to call with this parameter set, then to
6329 ;; o - t if it's a known type that can't be a name or other
6331 ;; o - 'known if it's an otherwise known type (according to
6332 ;; `*-font-lock-extra-types');
6333 ;; o - 'prefix if it's a known prefix of a type;
6334 ;; o - 'found if it's a type that matches one in `c-found-types';
6335 ;; o - 'maybe if it's an identifier that might be a type;
6336 ;; o - 'decltype if it's a decltype(variable) declaration; - or
6337 ;; o - nil if it can't be a type (the point isn't moved then).
6339 ;; The point is assumed to be at the beginning of a token.
6341 ;; Note that this function doesn't skip past the brace definition
6342 ;; that might be considered part of the type, e.g.
6343 ;; "enum {a, b, c} foo".
6345 ;; This function records identifier ranges on
6346 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6347 ;; `c-record-type-identifiers' is non-nil.
6349 ;; This function might do hidden buffer changes.
6350 (when (and c-recognize-<>-arglists
6352 (c-forward-<>-arglist t)
6353 (c-forward-syntactic-ws))
6355 (let ((start (point)) pos res name-res id-start id-end id-range)
6357 ;; Skip leading type modifiers. If any are found we know it's a
6358 ;; prefix of a type.
6359 (when c-opt-type-modifier-key ; e.g. "const" "volatile", but NOT "typedef"
6360 (while (looking-at c-opt-type-modifier-key)
6361 (goto-char (match-end 1))
6362 (c-forward-syntactic-ws)
6363 (setq res 'prefix)))
6366 ((looking-at c-typeof-key) ; e.g. C++'s "decltype".
6367 (goto-char (match-end 1))
6368 (c-forward-syntactic-ws)
6369 (setq res (and (eq (char-after) ?\()
6370 (c-safe (c-forward-sexp))
6373 (c-forward-syntactic-ws)
6376 ((looking-at c-type-prefix-key) ; e.g. "struct", "class", but NOT
6378 (goto-char (match-end 1))
6379 (c-forward-syntactic-ws)
6382 (setq name-res (c-forward-name))
6383 (setq res (not (null name-res)))
6384 (when (eq name-res t)
6385 ;; In many languages the name can be used without the
6386 ;; prefix, so we add it to `c-found-types'.
6387 (c-add-type pos (point))
6388 (when (and c-record-type-identifiers
6389 c-last-identifier-range)
6390 (c-record-type-id c-last-identifier-range)))
6391 (when (and brace-block-too
6393 (eq (char-after) ?\{)
6396 (progn (c-forward-sexp)
6397 (c-forward-syntactic-ws)
6398 (setq pos (point))))))
6401 (unless res (goto-char start))) ; invalid syntax
6405 (if (looking-at c-identifier-start)
6407 (setq id-start (point)
6408 name-res (c-forward-name))
6410 (setq id-end (point)
6411 id-range c-last-identifier-range))))
6412 (and (cond ((looking-at c-primitive-type-key)
6414 ((c-with-syntax-table c-identifier-syntax-table
6415 (looking-at c-known-type-key))
6420 (goto-char (match-end 1))
6421 (c-forward-syntactic-ws)
6422 (setq pos (point))))
6425 ;; Looking at a primitive or known type identifier. We've
6426 ;; checked for a name first so that we don't go here if the
6427 ;; known type match only is a prefix of another name.
6429 (setq id-end (match-end 1))
6431 (when (and c-record-type-identifiers
6432 (or c-promote-possible-types (eq res t)))
6433 (c-record-type-id (cons (match-beginning 1) (match-end 1))))
6435 (if (and c-opt-type-component-key
6437 (looking-at c-opt-type-component-key)))
6438 ;; There might be more keywords for the type.
6440 (c-forward-keyword-clause 1)
6442 (setq safe-pos (point))
6443 (looking-at c-opt-type-component-key))
6444 (when (and c-record-type-identifiers
6445 (looking-at c-primitive-type-key))
6446 (c-record-type-id (cons (match-beginning 1)
6448 (c-forward-keyword-clause 1))
6449 (if (looking-at c-primitive-type-key)
6451 (when c-record-type-identifiers
6452 (c-record-type-id (cons (match-beginning 1)
6454 (c-forward-keyword-clause 1)
6456 (goto-char safe-pos)
6457 (setq res 'prefix)))
6458 (unless (save-match-data (c-forward-keyword-clause 1))
6461 (goto-char (match-end 1))
6462 (c-forward-syntactic-ws)))))
6465 (cond ((eq name-res t)
6466 ;; A normal identifier.
6468 (if (or res c-promote-possible-types)
6470 (c-add-type id-start id-end)
6471 (when (and c-record-type-identifiers id-range)
6472 (c-record-type-id id-range))
6475 (setq res (if (c-check-type id-start id-end)
6476 ;; It's an identifier that has been used as
6477 ;; a type somewhere else.
6479 ;; It's an identifier that might be a type.
6481 ((eq name-res 'template)
6482 ;; A template is a type.
6486 ;; Otherwise it's an operator identifier, which is not a type.
6491 ;; Skip trailing type modifiers. If any are found we know it's
6493 (when c-opt-type-modifier-key
6494 (while (looking-at c-opt-type-modifier-key) ; e.g. "const", "volatile"
6495 (goto-char (match-end 1))
6496 (c-forward-syntactic-ws)
6499 ;; Step over any type suffix operator. Do not let the existence
6500 ;; of these alter the classification of the found type, since
6501 ;; these operators typically are allowed in normal expressions
6503 (when c-opt-type-suffix-key ; e.g. "..."
6504 (while (looking-at c-opt-type-suffix-key)
6505 (goto-char (match-end 1))
6506 (c-forward-syntactic-ws)))
6508 (when c-opt-type-concat-key ; Only/mainly for pike.
6509 ;; Look for a trailing operator that concatenates the type
6510 ;; with a following one, and if so step past that one through
6511 ;; a recursive call. Note that we don't record concatenated
6512 ;; types in `c-found-types' - it's the component types that
6513 ;; are recorded when appropriate.
6515 (let* ((c-promote-possible-types (or (memq res '(t known))
6516 c-promote-possible-types))
6517 ;; If we can't promote then set `c-record-found-types' so that
6518 ;; we can merge in the types from the second part afterwards if
6519 ;; it turns out to be a known type there.
6520 (c-record-found-types (and c-record-type-identifiers
6521 (not c-promote-possible-types)))
6523 (if (and (looking-at c-opt-type-concat-key)
6526 (goto-char (match-end 1))
6527 (c-forward-syntactic-ws)
6528 (setq subres (c-forward-type))))
6531 ;; If either operand certainly is a type then both are, but we
6532 ;; don't let the existence of the operator itself promote two
6533 ;; uncertain types to a certain one.
6536 (unless (eq name-res 'template)
6537 (c-add-type id-start id-end))
6538 (when (and c-record-type-identifiers id-range)
6539 (c-record-type-id id-range))
6550 (when (and (eq res t)
6551 (consp c-record-found-types))
6552 ;; Merge in the ranges of any types found by the second
6553 ;; `c-forward-type'.
6554 (setq c-record-type-identifiers
6555 ;; `nconc' doesn't mind that the tail of
6556 ;; `c-record-found-types' is t.
6557 (nconc c-record-found-types
6558 c-record-type-identifiers))))
6562 (when (and c-record-found-types (memq res '(known found)) id-range)
6563 (setq c-record-found-types
6564 (cons id-range c-record-found-types))))
6566 ;;(message "c-forward-type %s -> %s: %s" start (point) res)
6570 (defun c-forward-annotation ()
6571 ;; Used for Java code only at the moment. Assumes point is on the
6572 ;; @, moves forward an annotation. returns nil if there is no
6573 ;; annotation at point.
6574 (and (looking-at "@")
6575 (progn (forward-char) t)
6577 (progn (c-forward-syntactic-ws) t)
6578 (if (looking-at "(")
6582 (defmacro c-pull-open-brace (ps)
6583 ;; Pull the next open brace from PS (which has the form of paren-state),
6584 ;; skipping over any brace pairs. Returns NIL when PS is exhausted.
6586 (while (consp (car ,ps))
6587 (setq ,ps (cdr ,ps)))
6589 (setq ,ps (cdr ,ps)))))
6591 (defun c-back-over-member-initializers ()
6592 ;; Test whether we are in a C++ member initializer list, and if so, go back
6593 ;; to the introducing ":", returning the position of the opening paren of
6594 ;; the function's arglist. Otherwise return nil, leaving point unchanged.
6595 (let ((here (point))
6596 (paren-state (c-parse-state))
6601 (if (not (c-at-toplevel-p))
6603 (while (not (c-at-toplevel-p))
6604 (goto-char (c-pull-open-brace paren-state)))
6605 (c-backward-syntactic-ws)
6606 (when (not (c-simple-skip-symbol-backward))
6608 (c-backward-syntactic-ws))
6609 (c-backward-syntactic-ws)
6610 (when (memq (char-before) '(?\) ?}))
6611 (when (not (c-go-list-backward))
6613 (c-backward-syntactic-ws))
6614 (when (c-simple-skip-symbol-backward)
6615 (c-backward-syntactic-ws)))
6617 (while (eq (char-before) ?,)
6619 (c-backward-syntactic-ws)
6621 (when (not (memq (char-before) '(?\) ?})))
6623 (when (not (c-go-list-backward))
6625 (c-backward-syntactic-ws)
6626 (when (not (c-simple-skip-symbol-backward))
6628 (c-backward-syntactic-ws))
6631 (eq (char-before) ?:)
6632 (c-just-after-func-arglist-p))))
6634 (or res (goto-char here))
6638 ;; Handling of large scale constructs like statements and declarations.
6640 ;; Macro used inside `c-forward-decl-or-cast-1'. It ought to be a
6641 ;; defsubst or perhaps even a defun, but it contains lots of free
6642 ;; variables that refer to things inside `c-forward-decl-or-cast-1'.
6643 (defmacro c-fdoc-shift-type-backward (&optional short)
6644 ;; `c-forward-decl-or-cast-1' can consume an arbitrary length list
6645 ;; of types when parsing a declaration, which means that it
6646 ;; sometimes consumes the identifier in the declaration as a type.
6647 ;; This is used to "backtrack" and make the last type be treated as
6648 ;; an identifier instead.
6651 ;; These identifiers are bound only in the inner let.
6652 '(setq identifier-type at-type
6653 identifier-start type-start
6657 got-suffix-after-parens id-start
6660 (if (setq at-type (if (eq backup-at-type 'prefix)
6663 (setq type-start backup-type-start
6664 id-start backup-id-start)
6665 (setq type-start start-pos
6666 id-start start-pos))
6668 ;; When these flags already are set we've found specifiers that
6669 ;; unconditionally signal these attributes - backtracking doesn't
6670 ;; change that. So keep them set in that case.
6672 (setq at-type-decl backup-at-type-decl))
6674 (setq maybe-typeless backup-maybe-typeless))
6677 ;; This identifier is bound only in the inner let.
6678 '(setq start id-start))))
6680 (defun c-forward-decl-or-cast-1 (preceding-token-end context last-cast-end)
6681 ;; Move forward over a declaration or a cast if at the start of one.
6682 ;; The point is assumed to be at the start of some token. Nil is
6683 ;; returned if no declaration or cast is recognized, and the point
6684 ;; is clobbered in that case.
6686 ;; If a declaration is parsed:
6688 ;; The point is left at the first token after the first complete
6689 ;; declarator, if there is one. The return value is a cons where
6690 ;; the car is the position of the first token in the declarator. (See
6691 ;; below for the cdr.)
6694 ;; void foo (int a, char *b) stuff ...
6698 ;; unsigned int a = c_style_initializer, b;
6700 ;; unsigned int a (cplusplus_style_initializer), b;
6701 ;; car ^ ^ point (might change)
6702 ;; class Foo : public Bar {}
6704 ;; class PikeClass (int a, string b) stuff ...
6710 ;; void cplusplus_function (int x) throw (Bad);
6712 ;; Foo::Foo (int b) : Base (b) {}
6717 ;; auto cplusplus_11 (int a, char *b) -> decltype (bar):
6722 ;; The cdr of the return value is non-nil when a
6723 ;; `c-typedef-decl-kwds' specifier is found in the declaration.
6724 ;; Specifically it is a dotted pair (A . B) where B is t when a
6725 ;; `c-typedef-kwds' ("typedef") is present, and A is t when some
6726 ;; other `c-typedef-decl-kwds' (e.g. class, struct, enum)
6727 ;; specifier is present. I.e., (some of) the declared
6728 ;; identifier(s) are types.
6730 ;; If a cast is parsed:
6732 ;; The point is left at the first token after the closing paren of
6733 ;; the cast. The return value is `cast'. Note that the start
6734 ;; position must be at the first token inside the cast parenthesis
6737 ;; PRECEDING-TOKEN-END is the first position after the preceding
6738 ;; token, i.e. on the other side of the syntactic ws from the point.
6739 ;; Use a value less than or equal to (point-min) if the point is at
6740 ;; the first token in (the visible part of) the buffer.
6742 ;; CONTEXT is a symbol that describes the context at the point:
6743 ;; 'decl In a comma-separated declaration context (typically
6744 ;; inside a function declaration arglist).
6745 ;; '<> In an angle bracket arglist.
6746 ;; 'arglist Some other type of arglist.
6747 ;; nil Some other context or unknown context. Includes
6748 ;; within the parens of an if, for, ... construct.
6750 ;; LAST-CAST-END is the first token after the closing paren of a
6751 ;; preceding cast, or nil if none is known. If
6752 ;; `c-forward-decl-or-cast-1' is used in succession, it should be
6753 ;; the position after the closest preceding call where a cast was
6754 ;; matched. In that case it's used to discover chains of casts like
6757 ;; This function records identifier ranges on
6758 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6759 ;; `c-record-type-identifiers' is non-nil.
6761 ;; This function might do hidden buffer changes.
6763 (let (;; `start-pos' is used below to point to the start of the
6764 ;; first type, i.e. after any leading specifiers. It might
6765 ;; also point at the beginning of the preceding syntactic
6768 ;; Set to the result of `c-forward-type'.
6770 ;; The position of the first token in what we currently
6771 ;; believe is the type in the declaration or cast, after any
6772 ;; specifiers and their associated clauses.
6774 ;; The position of the first token in what we currently
6775 ;; believe is the declarator for the first identifier. Set
6776 ;; when the type is found, and moved forward over any
6777 ;; `c-decl-hangon-kwds' and their associated clauses that
6778 ;; occurs after the type.
6780 ;; These store `at-type', `type-start' and `id-start' of the
6781 ;; identifier before the one in those variables. The previous
6782 ;; identifier might turn out to be the real type in a
6783 ;; declaration if the last one has to be the declarator in it.
6784 ;; If `backup-at-type' is nil then the other variables have
6785 ;; undefined values.
6786 backup-at-type backup-type-start backup-id-start
6787 ;; This stores `kwd-sym' of the symbol before the current one.
6788 ;; This is needed to distinguish the C++11 version of "auto" from
6789 ;; the pre C++11 meaning.
6791 ;; Set if we've found a specifier (apart from "typedef") that makes
6792 ;; the defined identifier(s) types.
6794 ;; Set if we've a "typedef" keyword.
6796 ;; Set if we've found a specifier that can start a declaration
6797 ;; where there's no type.
6799 ;; Save the value of kwd-sym between loops of the "Check for a
6800 ;; type" loop. Needed to distinguish a C++11 "auto" from a pre
6803 ;; If a specifier is found that also can be a type prefix,
6804 ;; these flags are set instead of those above. If we need to
6805 ;; back up an identifier, they are copied to the real flag
6806 ;; variables. Thus they only take effect if we fail to
6807 ;; interpret it as a type.
6808 backup-at-type-decl backup-maybe-typeless
6809 ;; Whether we've found a declaration or a cast. We might know
6810 ;; this before we've found the type in it. It's 'ids if we've
6811 ;; found two consecutive identifiers (usually a sure sign, but
6812 ;; we should allow that in labels too), and t if we've found a
6813 ;; specifier keyword (a 100% sure sign).
6815 ;; Set when we need to back up to parse this as a declaration
6816 ;; but not as a cast.
6818 ;; For casts, the return position.
6820 ;; Have we got a new-style C++11 "auto"?
6822 ;; Save `c-record-type-identifiers' and
6823 ;; `c-record-ref-identifiers' since ranges are recorded
6824 ;; speculatively and should be thrown away if it turns out
6825 ;; that it isn't a declaration or cast.
6826 (save-rec-type-ids c-record-type-identifiers)
6827 (save-rec-ref-ids c-record-ref-identifiers))
6829 (while (c-forward-annotation)
6830 (c-forward-syntactic-ws))
6832 ;; Check for a type. Unknown symbols are treated as possible
6833 ;; types, but they could also be specifiers disguised through
6834 ;; macros like __INLINE__, so we recognize both types and known
6835 ;; specifiers after them too.
6837 (let* ((start (point)) kwd-sym kwd-clause-end found-type)
6839 ;; Look for a specifier keyword clause.
6840 (when (or (looking-at c-prefix-spec-kwds-re) ;FIXME!!! includes auto
6841 (and (c-major-mode-is 'java-mode)
6842 (looking-at "@[A-Za-z0-9]+")))
6844 (if (looking-at c-typedef-key)
6845 (setq at-typedef t)))
6846 (setq kwd-sym (c-keyword-sym (match-string 1)))
6848 (c-forward-keyword-clause 1)
6849 (setq kwd-clause-end (point))))
6851 (when (setq found-type (c-forward-type t)) ; brace-block-too
6852 ;; Found a known or possible type or a prefix of a known type.
6853 (when (and (c-major-mode-is 'c++-mode) ; C++11 style "auto"?
6854 (eq prev-kwd-sym (c-keyword-sym "auto"))
6855 (looking-at "[=(]")) ; FIXME!!! proper regexp.
6856 (setq new-style-auto t)
6857 (setq found-type nil)
6858 (goto-char start)) ; position of foo in "auto foo"
6861 ;; Got two identifiers with nothing but whitespace
6862 ;; between them. That can only happen in declarations.
6863 (setq at-decl-or-cast 'ids)
6865 (when (eq at-type 'found)
6866 ;; If the previous identifier is a found type we
6867 ;; record it as a real one; it might be some sort of
6868 ;; alias for a prefix like "unsigned".
6870 (goto-char type-start)
6871 (let ((c-promote-possible-types t))
6872 (c-forward-type)))))
6874 (setq backup-at-type at-type
6875 backup-type-start type-start
6876 backup-id-start id-start
6877 backup-kwd-sym kwd-sym
6881 ;; The previous ambiguous specifier/type turned out
6882 ;; to be a type since we've parsed another one after
6883 ;; it, so clear these backup flags.
6884 backup-at-type-decl nil
6885 backup-maybe-typeless nil))
6889 ;; Handle known specifier keywords and
6890 ;; `c-decl-hangon-kwds' which can occur after known
6893 (if (c-keyword-member kwd-sym 'c-decl-hangon-kwds)
6894 ;; It's a hang-on keyword that can occur anywhere.
6896 (setq at-decl-or-cast t)
6898 ;; Move the identifier start position if
6899 ;; we've passed a type.
6900 (setq id-start kwd-clause-end)
6901 ;; Otherwise treat this as a specifier and
6902 ;; move the fallback position.
6903 (setq start-pos kwd-clause-end))
6904 (goto-char kwd-clause-end))
6906 ;; It's an ordinary specifier so we know that
6907 ;; anything before this can't be the type.
6908 (setq backup-at-type nil
6909 start-pos kwd-clause-end)
6912 ;; It's ambiguous whether this keyword is a
6913 ;; specifier or a type prefix, so set the backup
6914 ;; flags. (It's assumed that `c-forward-type'
6915 ;; moved further than `c-forward-keyword-clause'.)
6917 (when (c-keyword-member kwd-sym 'c-typedef-decl-kwds)
6918 (setq backup-at-type-decl t))
6919 (when (c-keyword-member kwd-sym 'c-typeless-decl-kwds)
6920 (setq backup-maybe-typeless t)))
6922 (when (c-keyword-member kwd-sym 'c-typedef-decl-kwds)
6923 ;; This test only happens after we've scanned a type.
6924 ;; So, with valid syntax, kwd-sym can't be 'typedef.
6925 (setq at-type-decl t))
6926 (when (c-keyword-member kwd-sym 'c-typeless-decl-kwds)
6927 (setq maybe-typeless t))
6929 ;; Haven't matched a type so it's an unambiguous
6930 ;; specifier keyword and we know we're in a
6932 (setq at-decl-or-cast t)
6933 (setq prev-kwd-sym kwd-sym)
6935 (goto-char kwd-clause-end))))
6937 ;; If the type isn't known we continue so that we'll jump
6938 ;; over all specifiers and type identifiers. The reason
6939 ;; to do this for a known type prefix is to make things
6940 ;; like "unsigned INT16" work.
6941 (and found-type (not (eq found-type t))))))
6945 ;; If a known type was found, we still need to skip over any
6946 ;; hangon keyword clauses after it. Otherwise it has already
6947 ;; been done in the loop above.
6948 (while (looking-at c-decl-hangon-key)
6949 (c-forward-keyword-clause 1))
6950 (setq id-start (point)))
6952 ((eq at-type 'prefix)
6953 ;; A prefix type is itself a primitive type when it's not
6954 ;; followed by another type.
6958 ;; Got no type but set things up to continue anyway to handle
6959 ;; the various cases when a declaration doesn't start with a
6961 (setq id-start start-pos))
6963 ((and (eq at-type 'maybe)
6964 (c-major-mode-is 'c++-mode))
6965 ;; If it's C++ then check if the last "type" ends on the form
6966 ;; "foo::foo" or "foo::~foo", i.e. if it's the name of a
6967 ;; (con|de)structor.
6969 (let (name end-2 end-1)
6970 (goto-char id-start)
6971 (c-backward-syntactic-ws)
6972 (setq end-2 (point))
6974 (c-simple-skip-symbol-backward)
6977 (buffer-substring-no-properties (point) end-2))
6978 ;; Cheating in the handling of syntactic ws below.
6979 (< (skip-chars-backward ":~ \t\n\r\v\f") 0))
6981 (setq end-1 (point))
6982 (c-simple-skip-symbol-backward))
6983 (>= (point) type-start)
6984 (equal (buffer-substring-no-properties (point) end-1)
6986 ;; It is a (con|de)structor name. In that case the
6987 ;; declaration is typeless so zap out any preceding
6988 ;; identifier(s) that we might have taken as types.
6989 (goto-char type-start)
6992 id-start type-start))))))
6994 ;; Check for and step over a type decl expression after the thing
6995 ;; that is or might be a type. This can't be skipped since we
6996 ;; need the correct end position of the declarator for
6997 ;; `max-type-decl-end-*'.
6998 (let ((start (point)) (paren-depth 0) pos
6999 ;; True if there's a non-open-paren match of
7000 ;; `c-type-decl-prefix-key'.
7002 ;; True if the declarator is surrounded by a parenthesis pair.
7004 ;; True if there is an identifier in the declarator.
7006 ;; True if there's a non-close-paren match of
7007 ;; `c-type-decl-suffix-key'.
7009 ;; True if there's a prefix match outside the outermost
7010 ;; paren pair that surrounds the declarator.
7011 got-prefix-before-parens
7012 ;; True if there's a suffix match outside the outermost
7013 ;; paren pair that surrounds the declarator. The value is
7014 ;; the position of the first suffix match.
7015 got-suffix-after-parens
7016 ;; True if we've parsed the type decl to a token that is
7017 ;; known to end declarations in this context.
7019 ;; The earlier values of `at-type' and `type-start' if we've
7020 ;; shifted the type backwards.
7021 identifier-type identifier-start
7022 ;; If `c-parse-and-markup-<>-arglists' is set we need to
7023 ;; turn it off during the name skipping below to avoid
7024 ;; getting `c-type' properties that might be bogus. That
7025 ;; can happen since we don't know if
7026 ;; `c-restricted-<>-arglists' will be correct inside the
7027 ;; arglist paren that gets entered.
7028 c-parse-and-markup-<>-arglists
7029 ;; Start of the identifier for which `got-identifier' was set.
7032 (goto-char id-start)
7034 ;; Skip over type decl prefix operators. (Note similar code in
7035 ;; `c-font-lock-declarators'.)
7036 (if (and c-recognize-typeless-decls
7037 (equal c-type-decl-prefix-key "\\<\\>"))
7038 (when (eq (char-after) ?\()
7040 (setq paren-depth (1+ paren-depth))
7042 (while (and (looking-at c-type-decl-prefix-key)
7043 (if (and (c-major-mode-is 'c++-mode)
7044 (match-beginning 3))
7045 ;; If the third submatch matches in C++ then
7046 ;; we're looking at an identifier that's a
7047 ;; prefix only if it specifies a member pointer.
7048 (when (progn (setq pos (point))
7049 (setq got-identifier (c-forward-name)))
7050 (setq name-start pos)
7051 (if (looking-at "\\(::\\)")
7052 ;; We only check for a trailing "::" and
7053 ;; let the "*" that should follow be
7054 ;; matched in the next round.
7055 (progn (setq got-identifier nil) t)
7056 ;; It turned out to be the real identifier,
7061 (if (eq (char-after) ?\()
7063 (setq paren-depth (1+ paren-depth))
7065 (unless got-prefix-before-parens
7066 (setq got-prefix-before-parens (= paren-depth 0)))
7068 (goto-char (match-end 1)))
7069 (c-forward-syntactic-ws)))
7071 (setq got-parens (> paren-depth 0))
7073 ;; Skip over an identifier.
7075 (and (looking-at c-identifier-start)
7077 (setq got-identifier (c-forward-name))
7078 (setq name-start pos)))
7080 ;; Skip over type decl suffix operators.
7081 (while (if (looking-at c-type-decl-suffix-key)
7083 (if (eq (char-after) ?\))
7084 (when (> paren-depth 0)
7085 (setq paren-depth (1- paren-depth))
7088 (when (if (save-match-data (looking-at "\\s\("))
7089 (c-safe (c-forward-sexp 1) t)
7090 (goto-char (match-end 1))
7092 (when (and (not got-suffix-after-parens)
7094 (setq got-suffix-after-parens (match-beginning 0)))
7095 (setq got-suffix t)))
7097 ;; No suffix matched. We might have matched the
7098 ;; identifier as a type and the open paren of a
7099 ;; function arglist as a type decl prefix. In that
7100 ;; case we should "backtrack": Reinterpret the last
7101 ;; type as the identifier, move out of the arglist and
7102 ;; continue searching for suffix operators.
7104 ;; Do this even if there's no preceding type, to cope
7105 ;; with old style function declarations in K&R C,
7106 ;; (con|de)structors in C++ and `c-typeless-decl-kwds'
7107 ;; style declarations. That isn't applicable in an
7108 ;; arglist context, though.
7109 (when (and (= paren-depth 1)
7110 (not got-prefix-before-parens)
7111 (not (eq at-type t))
7114 backup-maybe-typeless
7115 (when c-recognize-typeless-decls
7117 (setq pos (c-up-list-forward (point)))
7118 (eq (char-before pos) ?\)))
7119 (c-fdoc-shift-type-backward)
7123 (c-forward-syntactic-ws))
7125 (when (or (and new-style-auto
7126 (looking-at c-auto-ops-re))
7127 (and (or maybe-typeless backup-maybe-typeless)
7128 (not got-identifier)
7131 ;; Have found no identifier but `c-typeless-decl-kwds' has
7132 ;; matched so we know we're inside a declaration. The
7133 ;; preceding type must be the identifier instead.
7134 (c-fdoc-shift-type-backward))
7136 ;; Prepare the "-> type;" for fontification later on.
7137 (when (and new-style-auto
7138 (looking-at c-haskell-op-re))
7140 (goto-char (match-end 0))
7141 (c-forward-syntactic-ws)
7142 (setq type-start (point))
7143 (setq at-type (c-forward-type))))
7147 (catch 'at-decl-or-cast
7150 (when (> paren-depth 0)
7151 ;; Encountered something inside parens that isn't matched by
7152 ;; the `c-type-decl-*' regexps, so it's not a type decl
7153 ;; expression. Try to skip out to the same paren depth to
7154 ;; not confuse the cast check below.
7155 (c-safe (goto-char (scan-lists (point) 1 paren-depth)))
7156 ;; If we've found a specifier keyword then it's a
7157 ;; declaration regardless.
7158 (throw 'at-decl-or-cast (eq at-decl-or-cast t)))
7161 (looking-at (cond ((eq context '<>) "[,>]")
7165 ;; Now we've collected info about various characteristics of
7166 ;; the construct we're looking at. Below follows a decision
7167 ;; tree based on that. It's ordered to check more certain
7168 ;; signs before less certain ones.
7174 (when (and (or at-type maybe-typeless)
7175 (not (or got-prefix got-parens)))
7176 ;; Got another identifier directly after the type, so it's a
7178 (throw 'at-decl-or-cast t))
7180 (when (and got-parens
7182 ;; (not got-suffix-after-parens)
7185 backup-maybe-typeless
7186 (eq at-decl-or-cast t)
7188 (goto-char name-start)
7189 (not (memq (c-forward-type) '(nil maybe))))))
7190 ;; Got a declaration of the form "foo bar (gnu);" or "bar
7191 ;; (gnu);" where we've recognized "bar" as the type and "gnu"
7192 ;; as the declarator. In this case it's however more likely
7193 ;; that "bar" is the declarator and "gnu" a function argument
7194 ;; or initializer (if `c-recognize-paren-inits' is set),
7195 ;; since the parens around "gnu" would be superfluous if it's
7196 ;; a declarator. Shift the type one step backward.
7197 (c-fdoc-shift-type-backward)))
7199 ;; Found no identifier.
7205 (when (= (point) start)
7206 ;; Got a plain list of identifiers. If a colon follows it's
7207 ;; a valid label, or maybe a bitfield. Otherwise the last
7208 ;; one probably is the declared identifier and we should
7209 ;; back up to the previous type, providing it isn't a cast.
7210 (if (and (eq (char-after) ?:)
7211 (not (c-major-mode-is 'java-mode)))
7213 ;; If we've found a specifier keyword then it's a
7214 ;; declaration regardless.
7215 ((eq at-decl-or-cast t)
7216 (throw 'at-decl-or-cast t))
7217 ((and c-has-bitfields
7218 (eq at-decl-or-cast 'ids)) ; bitfield.
7219 (setq backup-if-not-cast t)
7220 (throw 'at-decl-or-cast t)))
7222 (setq backup-if-not-cast t)
7223 (throw 'at-decl-or-cast t)))
7226 (when (and got-suffix
7229 ;; Got a plain list of identifiers followed by some suffix.
7230 ;; If this isn't a cast then the last identifier probably is
7231 ;; the declared one and we should back up to the previous
7233 (setq backup-if-not-cast t)
7234 (throw 'at-decl-or-cast t)))
7237 (when (eq at-type t)
7238 ;; If the type is known we know that there can't be any
7239 ;; identifier somewhere else, and it's only in declarations in
7240 ;; e.g. function prototypes and in casts that the identifier may
7242 (throw 'at-decl-or-cast t))
7244 (when (= (point) start)
7245 ;; Only got a single identifier (parsed as a type so far).
7248 ;; Check that the identifier isn't at the start of an
7253 ;; Inside an arglist that contains declarations. If K&R
7254 ;; style declarations and parenthesis style initializers
7255 ;; aren't allowed then the single identifier must be a
7256 ;; type, else we require that it's known or found
7257 ;; (primitive types are handled above).
7258 (or (and (not c-recognize-knr-p)
7259 (not c-recognize-paren-inits))
7260 (memq at-type '(known found))))
7262 ;; Inside a template arglist. Accept known and found
7263 ;; types; other identifiers could just as well be
7264 ;; constants in C++.
7265 (memq at-type '(known found)))))
7266 (throw 'at-decl-or-cast t)
7268 ;; Can't be a valid declaration or cast, but if we've found a
7269 ;; specifier it can't be anything else either, so treat it as
7270 ;; an invalid/unfinished declaration or cast.
7271 (throw 'at-decl-or-cast at-decl-or-cast))))
7276 (not (eq at-type t))
7279 backup-maybe-typeless
7280 (when c-recognize-typeless-decls
7281 (or (not got-suffix)
7283 c-after-suffixed-type-maybe-decl-key))))))
7284 ;; Got an empty paren pair and a preceding type that probably
7285 ;; really is the identifier. Shift the type backwards to make
7286 ;; the last one the identifier. This is analogous to the
7287 ;; "backtracking" done inside the `c-type-decl-suffix-key' loop
7290 ;; Exception: In addition to the conditions in that
7291 ;; "backtracking" code, do not shift backward if we're not
7292 ;; looking at either `c-after-suffixed-type-decl-key' or "[;,]".
7293 ;; Since there's no preceding type, the shift would mean that
7294 ;; the declaration is typeless. But if the regexp doesn't match
7295 ;; then we will simply fall through in the tests below and not
7296 ;; recognize it at all, so it's better to try it as an abstract
7297 ;; declarator instead.
7298 (c-fdoc-shift-type-backward)
7300 ;; Still no identifier.
7302 (when (and got-prefix (or got-parens got-suffix))
7303 ;; Require `got-prefix' together with either `got-parens' or
7304 ;; `got-suffix' to recognize it as an abstract declarator:
7305 ;; `got-parens' only is probably an empty function call.
7306 ;; `got-suffix' only can build an ordinary expression together
7307 ;; with the preceding identifier which we've taken as a type.
7308 ;; We could actually accept on `got-prefix' only, but that can
7309 ;; easily occur temporarily while writing an expression so we
7310 ;; avoid that case anyway. We could do a better job if we knew
7311 ;; the point when the fontification was invoked.
7312 (throw 'at-decl-or-cast t))
7318 got-suffix-after-parens
7319 (eq (char-after got-suffix-after-parens) ?\())
7320 ;; Got a type, no declarator but a paren suffix. I.e. it's a
7321 ;; normal function call after all (or perhaps a C++ style object
7322 ;; instantiation expression).
7323 (throw 'at-decl-or-cast nil))))
7326 (when at-decl-or-cast
7327 ;; By now we've located the type in the declaration that we know
7329 (throw 'at-decl-or-cast t))
7332 (when (and got-identifier
7334 (looking-at c-after-suffixed-type-decl-key)
7338 (not (eq at-type t)))
7339 ;; Shift the type backward in the case that there's a
7340 ;; single identifier inside parens. That can only
7341 ;; occur in K&R style function declarations so it's
7342 ;; more likely that it really is a function call.
7343 ;; Therefore we only do this after
7344 ;; `c-after-suffixed-type-decl-key' has matched.
7345 (progn (c-fdoc-shift-type-backward) t)
7346 got-suffix-after-parens))
7347 ;; A declaration according to `c-after-suffixed-type-decl-key'.
7348 (throw 'at-decl-or-cast t))
7351 (when (and (or got-prefix (not got-parens))
7352 (memq at-type '(t known)))
7353 ;; It's a declaration if a known type precedes it and it can't be a
7355 (throw 'at-decl-or-cast t))
7357 ;; If we get here we can't tell if this is a type decl or a normal
7358 ;; expression by looking at it alone. (That's under the assumption
7359 ;; that normal expressions always can look like type decl expressions,
7360 ;; which isn't really true but the cases where it doesn't hold are so
7361 ;; uncommon (e.g. some placements of "const" in C++) it's not worth
7362 ;; the effort to look for them.)
7364 ;;; 2008-04-16: commented out the next form, to allow the function to recognize
7365 ;;; "foo (int bar)" in CC (an implicit type (in class foo) without a semicolon)
7366 ;;; as a(n almost complete) declaration, enabling it to be fontified.
7368 ;; (unless (or at-decl-end (looking-at "=[^=]"))
7369 ;; If this is a declaration it should end here or its initializer(*)
7370 ;; should start here, so check for allowed separation tokens. Note
7371 ;; that this rule doesn't work e.g. with a K&R arglist after a
7374 ;; *) Don't check for C++ style initializers using parens
7375 ;; since those already have been matched as suffixes.
7377 ;; If `at-decl-or-cast' is then we've found some other sign that
7378 ;; it's a declaration or cast, so then it's probably an
7379 ;; invalid/unfinished one.
7380 ;; (throw 'at-decl-or-cast at-decl-or-cast))
7382 ;; Below are tests that only should be applied when we're certain to
7383 ;; not have parsed halfway through an expression.
7386 (when (memq at-type '(t known))
7387 ;; The expression starts with a known type so treat it as a
7389 (throw 'at-decl-or-cast t))
7392 (when (and (c-major-mode-is 'c++-mode)
7393 ;; In C++ we check if the identifier is a known type, since
7394 ;; (con|de)structors use the class name as identifier.
7395 ;; We've always shifted over the identifier as a type and
7396 ;; then backed up again in this case.
7398 (or (memq identifier-type '(found known))
7399 (and (eq (char-after identifier-start) ?~)
7400 ;; `at-type' probably won't be 'found for
7401 ;; destructors since the "~" is then part of the
7402 ;; type name being checked against the list of
7403 ;; known types, so do a check without that
7406 (goto-char (1+ identifier-start))
7407 (c-forward-syntactic-ws)
7408 (c-with-syntax-table
7409 c-identifier-syntax-table
7410 (looking-at c-known-type-key)))
7412 (goto-char (1+ identifier-start))
7413 ;; We have already parsed the type earlier,
7414 ;; so it'd be possible to cache the end
7415 ;; position instead of redoing it here, but
7416 ;; then we'd need to keep track of another
7417 ;; position everywhere.
7418 (c-check-type (point)
7419 (progn (c-forward-type)
7421 (throw 'at-decl-or-cast t))
7426 (when (and got-prefix-before-parens
7428 (or at-decl-end (looking-at "=[^=]"))
7431 ;; Got something like "foo * bar;". Since we're not inside an
7432 ;; arglist it would be a meaningless expression because the
7433 ;; result isn't used. We therefore choose to recognize it as
7434 ;; a declaration. Do not allow a suffix since it could then
7435 ;; be a function call.
7436 (throw 'at-decl-or-cast t))
7439 (when (and (or got-suffix-after-parens
7440 (looking-at "=[^=]"))
7442 (not (eq context 'arglist)))
7443 ;; Got something like "a (*b) (c);" or "a (b) = c;". It could
7444 ;; be an odd expression or it could be a declaration. Treat
7445 ;; it as a declaration if "a" has been used as a type
7446 ;; somewhere else (if it's a known type we won't get here).
7447 (throw 'at-decl-or-cast t)))
7452 (and (eq context 'decl)
7453 (not c-recognize-paren-inits)
7454 (or got-parens got-suffix))))
7455 ;; Got a type followed by an abstract declarator. If `got-prefix'
7456 ;; is set it's something like "a *" without anything after it. If
7457 ;; `got-parens' or `got-suffix' is set it's "a()", "a[]", "a()[]",
7458 ;; or similar, which we accept only if the context rules out
7460 (throw 'at-decl-or-cast t)))
7462 ;; If we had a complete symbol table here (which rules out
7463 ;; `c-found-types') we should return t due to the disambiguation rule
7464 ;; (in at least C++) that anything that can be parsed as a declaration
7465 ;; is a declaration. Now we're being more defensive and prefer to
7466 ;; highlight things like "foo (bar);" as a declaration only if we're
7467 ;; inside an arglist that contains declarations.
7469 (eq context 'decl))))
7471 ;; The point is now after the type decl expression.
7474 ;; Check for a cast.
7479 ;; Should be the first type/identifier in a cast paren.
7480 (> preceding-token-end (point-min))
7481 (memq (char-before preceding-token-end) c-cast-parens)
7483 ;; The closing paren should follow.
7485 (c-forward-syntactic-ws)
7486 (looking-at "\\s\)"))
7488 ;; There should be a primary expression after it.
7491 (c-forward-syntactic-ws)
7492 (setq cast-end (point))
7493 (and (looking-at c-primary-expr-regexp)
7495 (setq pos (match-end 0))
7497 ;; Check if the expression begins with a prefix keyword.
7499 (if (match-beginning 1)
7500 ;; Expression begins with an ambiguous operator. Treat
7501 ;; it as a cast if it's a type decl or if we've
7502 ;; recognized the type somewhere else.
7504 (memq at-type '(t known found)))
7505 ;; Unless it's a keyword, it's the beginning of a primary
7507 (not (looking-at c-keywords-regexp)))))
7508 ;; If `c-primary-expr-regexp' matched a nonsymbol token, check
7509 ;; that it matched a whole one so that we don't e.g. confuse
7510 ;; the operator '-' with '->'. It's ok if it matches further,
7511 ;; though, since it e.g. can match the float '.5' while the
7512 ;; operator regexp only matches '.'.
7513 (or (not (looking-at c-nonsymbol-token-regexp))
7514 (<= (match-end 0) pos))))
7516 ;; There should either be a cast before it or something that isn't an
7517 ;; identifier or close paren.
7518 (> preceding-token-end (point-min))
7520 (goto-char (1- preceding-token-end))
7521 (or (eq (point) last-cast-end)
7523 (c-backward-syntactic-ws)
7524 (if (< (skip-syntax-backward "w_") 0)
7525 ;; It's a symbol. Accept it only if it's one of the
7526 ;; keywords that can precede an expression (without
7527 ;; surrounding parens).
7528 (looking-at c-simple-stmt-key)
7530 ;; Check that it isn't a close paren (block close is ok,
7532 (not (memq (char-before) '(?\) ?\])))
7533 ;; Check that it isn't a nonsymbol identifier.
7534 (not (c-on-identifier)))))))))
7537 (when (and c-record-type-identifiers at-type (not (eq at-type t)))
7538 (let ((c-promote-possible-types t))
7539 (goto-char type-start)
7542 (goto-char cast-end)
7546 ;; We're at a declaration. Highlight the type and the following
7549 (when backup-if-not-cast
7550 (c-fdoc-shift-type-backward t))
7552 (when (and (eq context 'decl) (looking-at ","))
7553 ;; Make sure to propagate the `c-decl-arg-start' property to
7554 ;; the next argument if it's set in this one, to cope with
7555 ;; interactive refontification.
7556 (c-put-c-type-property (point) 'c-decl-arg-start))
7558 ;; Record the type's coordinates in `c-record-type-identifiers' for
7559 ;; later fontification.
7560 (when (and c-record-type-identifiers at-type ;; (not (eq at-type t))
7561 ;; There seems no reason to exclude a token from
7562 ;; fontification just because it's "a known type that can't
7563 ;; be a name or other expression". 2013-09-18.
7565 (let ((c-promote-possible-types t))
7567 (goto-char type-start)
7571 (and (or at-type-decl at-typedef)
7572 (cons at-type-decl at-typedef))))
7575 ;; False alarm. Restore the recorded ranges.
7576 (setq c-record-type-identifiers save-rec-type-ids
7577 c-record-ref-identifiers save-rec-ref-ids)
7580 (defun c-forward-label (&optional assume-markup preceding-token-end limit)
7581 ;; Assuming that point is at the beginning of a token, check if it starts a
7582 ;; label and if so move over it and return non-nil (t in default situations,
7583 ;; specific symbols (see below) for interesting situations), otherwise don't
7584 ;; move and return nil. "Label" here means "most things with a colon".
7586 ;; More precisely, a "label" is regarded as one of:
7587 ;; (i) a goto target like "foo:" - returns the symbol `goto-target';
7588 ;; (ii) A case label - either the entire construct "case FOO:", or just the
7589 ;; bare "case", should the colon be missing. We return t;
7590 ;; (iii) a keyword which needs a colon, like "default:" or "private:"; We
7592 ;; (iv) One of QT's "extended" C++ variants of
7593 ;; "private:"/"protected:"/"public:"/"more:" looking like "public slots:".
7594 ;; Returns the symbol `qt-2kwds-colon'.
7595 ;; (v) QT's construct "signals:". Returns the symbol `qt-1kwd-colon'.
7596 ;; (vi) One of the keywords matched by `c-opt-extra-label-key' (without any
7597 ;; colon). Currently (2006-03), this applies only to Objective C's
7598 ;; keywords "@private", "@protected", and "@public". Returns t.
7600 ;; One of the things which will NOT be recognized as a label is a bit-field
7601 ;; element of a struct, something like "int foo:5".
7603 ;; The end of the label is taken to be just after the colon, or the end of
7604 ;; the first submatch in `c-opt-extra-label-key'. The point is directly
7605 ;; after the end on return. The terminating char gets marked with
7606 ;; `c-decl-end' to improve recognition of the following declaration or
7609 ;; If ASSUME-MARKUP is non-nil, it's assumed that the preceding
7610 ;; label, if any, has already been marked up like that.
7612 ;; If PRECEDING-TOKEN-END is given, it should be the first position
7613 ;; after the preceding token, i.e. on the other side of the
7614 ;; syntactic ws from the point. Use a value less than or equal to
7615 ;; (point-min) if the point is at the first token in (the visible
7616 ;; part of) the buffer.
7618 ;; The optional LIMIT limits the forward scan for the colon.
7620 ;; This function records the ranges of the label symbols on
7621 ;; `c-record-ref-identifiers' if `c-record-type-identifiers' (!) is
7624 ;; This function might do hidden buffer changes.
7626 (let ((start (point))
7629 macro-start ; if we're in one.
7633 ;; "case" or "default" (Doesn't apply to AWK).
7634 ((looking-at c-label-kwds-regexp)
7635 (let ((kwd-end (match-end 1)))
7636 ;; Record only the keyword itself for fontification, since in
7637 ;; case labels the following is a constant expression and not
7639 (when c-record-type-identifiers
7640 (c-record-ref-id (cons (match-beginning 1) kwd-end)))
7642 ;; Find the label end.
7645 (if (and (c-syntactic-re-search-forward
7646 ;; Stop on chars that aren't allowed in expressions,
7647 ;; and on operator chars that would be meaningless
7648 ;; there. FIXME: This doesn't cope with ?: operators.
7649 "[;{=,@]\\|\\(\\=\\|[^:]\\):\\([^:]\\|\\'\\)"
7651 (match-beginning 2))
7653 (progn ; there's a proper :
7654 (goto-char (match-beginning 2)) ; just after the :
7655 (c-put-c-type-property (1- (point)) 'c-decl-end)
7658 ;; It's an unfinished label. We consider the keyword enough
7659 ;; to recognize it as a label, so that it gets fontified.
7660 ;; Leave the point at the end of it, but don't put any
7661 ;; `c-decl-end' marker.
7665 ;; @private, @protected, @public, in Objective C, or similar.
7666 ((and c-opt-extra-label-key
7667 (looking-at c-opt-extra-label-key))
7668 ;; For a `c-opt-extra-label-key' match, we record the whole
7669 ;; thing for fontification. That's to get the leading '@' in
7670 ;; Objective-C protection labels fontified.
7671 (goto-char (match-end 1))
7672 (when c-record-type-identifiers
7673 (c-record-ref-id (cons (match-beginning 1) (point))))
7674 (c-put-c-type-property (1- (point)) 'c-decl-end)
7675 (setq label-type t))
7677 ;; All other cases of labels.
7678 ((and c-recognize-colon-labels ; nil for AWK and IDL, otherwise t.
7680 ;; A colon label must have something before the colon.
7681 (not (eq (char-after) ?:))
7683 ;; Check that we're not after a token that can't precede a label.
7685 ;; Trivially succeeds when there's no preceding token.
7686 ;; Succeeds when we're at a virtual semicolon.
7687 (if preceding-token-end
7688 (<= preceding-token-end (point-min))
7690 (c-backward-syntactic-ws)
7691 (setq preceding-token-end (point))
7695 ;; Check if we're after a label, if we're after a closing
7696 ;; paren that belong to statement, and with
7697 ;; `c-label-prefix-re'. It's done in different order
7698 ;; depending on `assume-markup' since the checks have
7699 ;; different expensiveness.
7702 (eq (c-get-char-property (1- preceding-token-end) 'c-type)
7706 (goto-char (1- preceding-token-end))
7707 (c-beginning-of-current-token)
7708 (or (looking-at c-label-prefix-re)
7709 (looking-at c-block-stmt-1-key)))
7711 (and (eq (char-before preceding-token-end) ?\))
7712 (c-after-conditional)))
7716 (goto-char (1- preceding-token-end))
7717 (c-beginning-of-current-token)
7718 (or (looking-at c-label-prefix-re)
7719 (looking-at c-block-stmt-1-key)))
7722 ((eq (char-before preceding-token-end) ?\))
7723 (c-after-conditional))
7725 ((eq (char-before preceding-token-end) ?:)
7726 ;; Might be after another label, so check it recursively.
7729 (goto-char (1- preceding-token-end))
7730 ;; Essentially the same as the
7731 ;; `c-syntactic-re-search-forward' regexp below.
7733 (save-excursion (and (c-beginning-of-macro)
7735 (if macro-start (narrow-to-region macro-start (point-max)))
7736 (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+" nil t)
7737 ;; Note: the following should work instead of the
7738 ;; narrow-to-region above. Investigate why not,
7739 ;; sometime. ACM, 2006-03-31.
7740 ;; (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+"
7743 ;; If the caller turned on recording for us,
7744 ;; it shouldn't apply when we check the
7746 c-record-type-identifiers)
7747 ;; A label can't start at a cpp directive. Check for
7748 ;; this, since c-forward-syntactic-ws would foul up on it.
7749 (unless (and c-opt-cpp-prefix (looking-at c-opt-cpp-prefix))
7750 (c-forward-syntactic-ws)
7751 (c-forward-label nil pte start))))))))))
7753 ;; Point is still at the beginning of the possible label construct.
7755 ;; Check that the next nonsymbol token is ":", or that we're in one
7756 ;; of QT's "slots" declarations. Allow '(' for the sake of macro
7757 ;; arguments. FIXME: Should build this regexp from the language
7760 ;; public: protected: private:
7762 (c-major-mode-is 'c++-mode)
7763 (search-forward-regexp
7764 "\\=p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\>[^_]" nil t)
7765 (progn (backward-char)
7766 (c-forward-syntactic-ws limit)
7767 (looking-at ":\\([^:]\\|\\'\\)"))) ; A single colon.
7769 (setq label-type t))
7770 ;; QT double keyword like "protected slots:" or goto target.
7771 ((progn (goto-char start) nil))
7772 ((when (c-syntactic-re-search-forward
7773 "[ \t\n[:?;{=*/%&|,<>!@+-]" limit t t) ; not at EOB
7775 (setq label-end (point))
7777 (and (c-major-mode-is 'c++-mode)
7779 "\\(p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\|more\\)\\>"
7780 (buffer-substring start (point)))))
7781 (c-forward-syntactic-ws limit)
7783 ((looking-at ":\\([^:]\\|\\'\\)") ; A single colon.
7786 (if (or (string= "signals" ; Special QT macro
7787 (setq kwd (buffer-substring-no-properties start label-end)))
7788 (string= "Q_SIGNALS" kwd))
7792 (search-forward-regexp "\\=\\(slots\\|Q_SLOTS\\)\\>" limit t)
7793 (progn (c-forward-syntactic-ws limit)
7794 (looking-at ":\\([^:]\\|\\'\\)"))) ; A single colon
7796 (setq label-type 'qt-2kwds-colon)))))))
7799 (narrow-to-region start (point))
7801 ;; Check that `c-nonlabel-token-key' doesn't match anywhere.
7805 (when (looking-at c-nonlabel-token-key)
7807 (setq label-type nil)
7808 (throw 'check-label nil))
7809 (and (c-safe (c-forward-sexp)
7810 (c-forward-syntactic-ws)
7814 ;; Record the identifiers in the label for fontification, unless
7815 ;; it begins with `c-label-kwds' in which case the following
7816 ;; identifiers are part of a (constant) expression that
7817 ;; shouldn't be fontified.
7818 (when (and c-record-type-identifiers
7819 (progn (goto-char start)
7820 (not (looking-at c-label-kwds-regexp))))
7821 (while (c-syntactic-re-search-forward c-symbol-key nil t)
7822 (c-record-ref-id (cons (match-beginning 0)
7825 (c-put-c-type-property (1- (point-max)) 'c-decl-end)
7826 (goto-char (point-max)))))
7833 (defun c-forward-objc-directive ()
7834 ;; Assuming the point is at the beginning of a token, try to move
7835 ;; forward to the end of the Objective-C directive that starts
7836 ;; there. Return t if a directive was fully recognized, otherwise
7837 ;; the point is moved as far as one could be successfully parsed and
7840 ;; This function records identifier ranges on
7841 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
7842 ;; `c-record-type-identifiers' is non-nil.
7844 ;; This function might do hidden buffer changes.
7846 (let ((start (point))
7848 (c-promote-possible-types t)
7850 ;; Turn off recognition of angle bracket arglists while parsing
7851 ;; types here since the protocol reference list might then be
7852 ;; considered part of the preceding name or superclass-name.
7853 c-recognize-<>-arglists)
7858 (c-make-keywords-re t
7859 (append (c-lang-const c-protection-kwds objc)
7862 (goto-char (match-end 1))
7868 (c-make-keywords-re t
7869 '("@interface" "@implementation" "@protocol")
7872 ;; Handle the name of the class itself.
7874 ;; (c-forward-token-2) ; 2006/1/13 This doesn't move if the token's
7876 (goto-char (match-end 0))
7882 ;; Look for ": superclass-name" or "( category-name )".
7883 (when (looking-at "[:\(]")
7884 (setq start-char (char-after))
7886 (c-forward-syntactic-ws)
7887 (unless (c-forward-type) (throw 'break nil))
7888 (when (eq start-char ?\()
7889 (unless (eq (char-after) ?\)) (throw 'break nil))
7891 (c-forward-syntactic-ws)))
7893 ;; Look for a protocol reference list.
7894 (if (eq (char-after) ?<)
7895 (let ((c-recognize-<>-arglists t)
7896 (c-parse-and-markup-<>-arglists t)
7897 c-restricted-<>-arglists)
7898 (c-forward-<>-arglist t))
7902 (c-backward-syntactic-ws lim)
7903 (c-clear-c-type-property start (1- (point)) 'c-decl-end)
7904 (c-put-c-type-property (1- (point)) 'c-decl-end)
7907 (c-clear-c-type-property start (point) 'c-decl-end)
7910 (defun c-beginning-of-inheritance-list (&optional lim)
7911 ;; Go to the first non-whitespace after the colon that starts a
7912 ;; multiple inheritance introduction. Optional LIM is the farthest
7913 ;; back we should search.
7915 ;; This function might do hidden buffer changes.
7916 (c-with-syntax-table c++-template-syntax-table
7917 (c-backward-token-2 0 t lim)
7918 (while (and (or (looking-at c-symbol-start)
7919 (looking-at "[<,]\\|::"))
7920 (zerop (c-backward-token-2 1 t lim))))))
7922 (defun c-in-method-def-p ()
7923 ;; Return nil if we aren't in a method definition, otherwise the
7924 ;; position of the initial [+-].
7926 ;; This function might do hidden buffer changes.
7929 (and c-opt-method-key
7930 (looking-at c-opt-method-key)
7934 ;; Contributed by Kevin Ryde <user42@zip.com.au>.
7935 (defun c-in-gcc-asm-p ()
7936 ;; Return non-nil if point is within a gcc \"asm\" block.
7938 ;; This should be called with point inside an argument list.
7940 ;; Only one level of enclosing parentheses is considered, so for
7941 ;; instance `nil' is returned when in a function call within an asm
7944 ;; This function might do hidden buffer changes.
7946 (and c-opt-asm-stmt-key
7949 (backward-up-list 1)
7950 (c-beginning-of-statement-1 (point-min) nil t)
7951 (looking-at c-opt-asm-stmt-key))))
7953 (defun c-at-toplevel-p ()
7954 "Return a determination as to whether point is \"at the top level\".
7955 Informally, \"at the top level\" is anywhere where you can write
7958 More precisely, being at the top-level means that point is either
7959 outside any enclosing block (such as a function definition), or
7960 directly inside a class, namespace or other block that contains
7961 another declaration level.
7963 If point is not at the top-level (e.g. it is inside a method
7964 definition), then nil is returned. Otherwise, if point is at a
7965 top-level not enclosed within a class definition, t is returned.
7966 Otherwise, a 2-vector is returned where the zeroth element is the
7967 buffer position of the start of the class declaration, and the first
7968 element is the buffer position of the enclosing class's opening
7971 Note that this function might do hidden buffer changes. See the
7972 comment at the start of cc-engine.el for more info."
7973 (let ((paren-state (c-parse-state)))
7974 (or (not (c-most-enclosing-brace paren-state))
7975 (c-search-uplist-for-classkey paren-state))))
7977 (defun c-just-after-func-arglist-p (&optional lim)
7978 ;; Return non-nil if the point is in the region after the argument
7979 ;; list of a function and its opening brace (or semicolon in case it
7980 ;; got no body). If there are K&R style argument declarations in
7981 ;; that region, the point has to be inside the first one for this
7982 ;; function to recognize it.
7984 ;; If successful, the point is moved to the first token after the
7985 ;; function header (see `c-forward-decl-or-cast-1' for details) and
7986 ;; the position of the opening paren of the function arglist is
7989 ;; The point is clobbered if not successful.
7991 ;; LIM is used as bound for backward buffer searches.
7993 ;; This function might do hidden buffer changes.
7995 (let ((beg (point)) id-start)
7997 (eq (c-beginning-of-statement-1 lim) 'same)
7999 (not (and (c-major-mode-is 'objc-mode)
8000 (c-forward-objc-directive)))
8003 (car-safe (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil)))
8006 ;; There should not be a '=' or ',' between beg and the
8007 ;; start of the declaration since that means we were in the
8008 ;; "expression part" of the declaration.
8010 (not (looking-at "[=,]")))
8013 ;; Check that there's an arglist paren in the
8015 (goto-char id-start)
8016 (cond ((eq (char-after) ?\()
8017 ;; The declarator is a paren expression, so skip past it
8018 ;; so that we don't get stuck on that instead of the
8019 ;; function arglist.
8021 ((and c-opt-op-identifier-prefix
8022 (looking-at c-opt-op-identifier-prefix))
8023 ;; Don't trip up on "operator ()".
8024 (c-forward-token-2 2 t)))
8025 (and (< (point) beg)
8026 (c-syntactic-re-search-forward "(" beg t t)
8029 (defun c-in-knr-argdecl (&optional lim)
8030 ;; Return the position of the first argument declaration if point is
8031 ;; inside a K&R style argument declaration list, nil otherwise.
8032 ;; `c-recognize-knr-p' is not checked. If LIM is non-nil, it's a
8033 ;; position that bounds the backward search for the argument list.
8035 ;; Point must be within a possible K&R region, e.g. just before a top-level
8036 ;; "{". It must be outside of parens and brackets. The test can return
8037 ;; false positives otherwise.
8039 ;; This function might do hidden buffer changes.
8043 ;; If we're in a macro, our search range is restricted to it. Narrow to
8044 ;; the searchable range.
8045 (let* ((macro-start (save-excursion (and (c-beginning-of-macro) (point))))
8046 (macro-end (save-excursion (and macro-start (c-end-of-macro) (point))))
8047 (low-lim (max (or lim (point-min)) (or macro-start (point-min))))
8048 before-lparen after-rparen
8049 (pp-count-out 20)) ; Max number of paren/brace constructs before
8051 (narrow-to-region low-lim (or macro-end (point-max)))
8053 ;; Search backwards for the defun's argument list. We give up if we
8054 ;; encounter a "}" (end of a previous defun) an "=" (which can't be in
8055 ;; a knr region) or BOB.
8057 ;; The criterion for a paren structure being the arg list is:
8058 ;; o - there is non-WS stuff after it but before any "{"; AND
8059 ;; o - the token after it isn't a ";" AND
8060 ;; o - it is preceded by either an identifier (the function name) or
8061 ;; a macro expansion like "DEFUN (...)"; AND
8062 ;; o - its content is a non-empty comma-separated list of identifiers
8063 ;; (an empty arg list won't have a knr region).
8065 ;; The following snippet illustrates these rules:
8066 ;; int foo (bar, baz, yuk)
8068 ;; int (*baz) (my_type) ;
8069 ;; int (*) (void) (*yuk) (void) ;
8073 (while (> pp-count-out 0) ; go back one paren/bracket pair each time.
8074 (setq pp-count-out (1- pp-count-out))
8075 (c-syntactic-skip-backward "^)]}=")
8076 (cond ((eq (char-before) ?\))
8077 (setq after-rparen (point)))
8078 ((eq (char-before) ?\])
8079 (setq after-rparen nil))
8080 (t ; either } (hit previous defun) or = or no more
8085 ;; We're inside a paren. Could it be our argument list....?
8089 (goto-char after-rparen)
8090 (unless (c-go-list-backward) (throw 'knr nil)) ;
8091 ;; FIXME!!! What about macros between the parens? 2007/01/20
8092 (setq before-lparen (point)))
8094 ;; It can't be the arg list if next token is ; or {
8095 (progn (goto-char after-rparen)
8096 (c-forward-syntactic-ws)
8097 (not (memq (char-after) '(?\; ?\{ ?\=))))
8099 ;; Is the thing preceding the list an identifier (the
8100 ;; function name), or a macro expansion?
8102 (goto-char before-lparen)
8103 (eq (c-backward-token-2) 0)
8104 (or (eq (c-on-identifier) (point))
8105 (and (eq (char-after) ?\))
8106 (c-go-up-list-backward)
8107 (eq (c-backward-token-2) 0)
8108 (eq (c-on-identifier) (point)))))
8110 ;; Have we got a non-empty list of comma-separated
8113 (goto-char before-lparen)
8114 (c-forward-token-2) ; to first token inside parens
8119 (while (eq (char-after) ?\,)
8121 (unless (c-on-identifier) (throw 'id-list nil))
8122 (c-forward-token-2))
8123 (eq (char-after) ?\))))))
8125 ;; ...Yes. We've identified the function's argument list.
8127 (progn (goto-char after-rparen)
8128 (c-forward-syntactic-ws)
8131 ;; ...No. The current parens aren't the function's arg list.
8132 (goto-char before-lparen))
8134 (or (c-go-list-backward) ; backwards over [ .... ]
8135 (throw 'knr nil)))))))))
8137 (defun c-skip-conditional ()
8138 ;; skip forward over conditional at point, including any predicate
8139 ;; statements in parentheses. No error checking is performed.
8141 ;; This function might do hidden buffer changes.
8142 (c-forward-sexp (cond
8144 ((looking-at (concat "\\<else"
8145 "\\([ \t\n]\\|\\\\\n\\)+"
8146 "if\\>\\([^_]\\|$\\)"))
8148 ;; do, else, try, finally
8149 ((looking-at (concat "\\<\\("
8150 "do\\|else\\|try\\|finally"
8151 "\\)\\>\\([^_]\\|$\\)"))
8153 ;; for, if, while, switch, catch, synchronized, foreach
8156 (defun c-after-conditional (&optional lim)
8157 ;; If looking at the token after a conditional then return the
8158 ;; position of its start, otherwise return nil.
8160 ;; This function might do hidden buffer changes.
8162 (and (zerop (c-backward-token-2 1 t lim))
8163 (or (looking-at c-block-stmt-1-key)
8164 (and (eq (char-after) ?\()
8165 (zerop (c-backward-token-2 1 t lim))
8166 (or (looking-at c-block-stmt-2-key)
8167 (looking-at c-block-stmt-1-2-key))))
8170 (defun c-after-special-operator-id (&optional lim)
8171 ;; If the point is after an operator identifier that isn't handled
8172 ;; like an ordinary symbol (i.e. like "operator =" in C++) then the
8173 ;; position of the start of that identifier is returned. nil is
8174 ;; returned otherwise. The point may be anywhere in the syntactic
8175 ;; whitespace after the last token of the operator identifier.
8177 ;; This function might do hidden buffer changes.
8179 (and c-overloadable-operators-regexp
8180 (zerop (c-backward-token-2 1 nil lim))
8181 (looking-at c-overloadable-operators-regexp)
8182 (or (not c-opt-op-identifier-prefix)
8184 (zerop (c-backward-token-2 1 nil lim))
8185 (looking-at c-opt-op-identifier-prefix)))
8188 (defsubst c-backward-to-block-anchor (&optional lim)
8189 ;; Assuming point is at a brace that opens a statement block of some
8190 ;; kind, move to the proper anchor point for that block. It might
8191 ;; need to be adjusted further by c-add-stmt-syntax, but the
8192 ;; position at return is suitable as start position for that
8195 ;; This function might do hidden buffer changes.
8196 (unless (= (point) (c-point 'boi))
8197 (let ((start (c-after-conditional lim)))
8199 (goto-char start)))))
8201 (defsubst c-backward-to-decl-anchor (&optional lim)
8202 ;; Assuming point is at a brace that opens the block of a top level
8203 ;; declaration of some kind, move to the proper anchor point for
8206 ;; This function might do hidden buffer changes.
8207 (unless (= (point) (c-point 'boi))
8208 (c-beginning-of-statement-1 lim)))
8210 (defun c-search-decl-header-end ()
8211 ;; Search forward for the end of the "header" of the current
8212 ;; declaration. That's the position where the definition body
8213 ;; starts, or the first variable initializer, or the ending
8214 ;; semicolon. I.e. search forward for the closest following
8215 ;; (syntactically relevant) '{', '=' or ';' token. Point is left
8216 ;; _after_ the first found token, or at point-max if none is found.
8218 ;; This function might do hidden buffer changes.
8220 (let ((base (point)))
8221 (if (c-major-mode-is 'c++-mode)
8223 ;; In C++ we need to take special care to handle operator
8224 ;; tokens and those pesky template brackets.
8226 (c-syntactic-re-search-forward "[;{<=]" nil 'move t t)
8228 (c-end-of-current-token base)
8229 ;; Handle operator identifiers, i.e. ignore any
8230 ;; operator token preceded by "operator".
8232 (and (c-safe (c-backward-sexp) t)
8233 (looking-at c-opt-op-identifier-prefix)))
8234 (and (eq (char-before) ?<)
8235 (c-with-syntax-table c++-template-syntax-table
8236 (if (c-safe (goto-char (c-up-list-forward (point))))
8238 (goto-char (point-max))
8240 (setq base (point)))
8243 (c-syntactic-re-search-forward "[;{=]" nil 'move t t)
8244 (c-end-of-current-token base))
8245 (setq base (point))))))
8247 (defun c-beginning-of-decl-1 (&optional lim)
8248 ;; Go to the beginning of the current declaration, or the beginning
8249 ;; of the previous one if already at the start of it. Point won't
8250 ;; be moved out of any surrounding paren. Return a cons cell of the
8251 ;; form (MOVE . KNR-POS). MOVE is like the return value from
8252 ;; `c-beginning-of-statement-1'. If point skipped over some K&R
8253 ;; style argument declarations (and they are to be recognized) then
8254 ;; KNR-POS is set to the start of the first such argument
8255 ;; declaration, otherwise KNR-POS is nil. If LIM is non-nil, it's a
8256 ;; position that bounds the backward search.
8258 ;; NB: Cases where the declaration continues after the block, as in
8259 ;; "struct foo { ... } bar;", are currently recognized as two
8260 ;; declarations, e.g. "struct foo { ... }" and "bar;" in this case.
8262 ;; This function might do hidden buffer changes.
8264 (let* ((start (point))
8265 (last-stmt-start (point))
8266 (move (c-beginning-of-statement-1 lim nil t)))
8268 ;; `c-beginning-of-statement-1' stops at a block start, but we
8269 ;; want to continue if the block doesn't begin a top level
8270 ;; construct, i.e. if it isn't preceded by ';', '}', ':', bob,
8271 ;; or an open paren.
8272 (let ((beg (point)) tentative-move)
8273 ;; Go back one "statement" each time round the loop until we're just
8274 ;; after a ;, }, or :, or at BOB or the start of a macro or start of
8275 ;; an ObjC method. This will move over a multiple declaration whose
8276 ;; components are comma separated.
8278 ;; Must check with c-opt-method-key in ObjC mode.
8279 (not (and c-opt-method-key
8280 (looking-at c-opt-method-key)))
8281 (/= last-stmt-start (point))
8283 (c-backward-syntactic-ws lim)
8284 (not (memq (char-before) '(?\; ?} ?: nil))))
8287 (not (looking-at "\\s(")))
8288 ;; Check that we don't move from the first thing in a
8289 ;; macro to its header.
8290 (not (eq (setq tentative-move
8291 (c-beginning-of-statement-1 lim nil t))
8293 (setq last-stmt-start beg
8295 move tentative-move))
8298 (when c-recognize-knr-p
8299 (let ((fallback-pos (point)) knr-argdecl-start)
8300 ;; Handle K&R argdecls. Back up after the "statement" jumped
8301 ;; over by `c-beginning-of-statement-1', unless it was the
8302 ;; function body, in which case we're sitting on the opening
8303 ;; brace now. Then test if we're in a K&R argdecl region and
8304 ;; that we started at the other side of the first argdecl in
8306 (unless (eq (char-after) ?{)
8307 (goto-char last-stmt-start))
8308 (if (and (setq knr-argdecl-start (c-in-knr-argdecl lim))
8309 (< knr-argdecl-start start)
8311 (goto-char knr-argdecl-start)
8312 (not (eq (c-beginning-of-statement-1 lim nil t) 'macro))))
8314 (cons (if (eq (char-after fallback-pos) ?{)
8318 (goto-char fallback-pos))))
8320 ;; `c-beginning-of-statement-1' counts each brace block as a separate
8321 ;; statement, so the result will be 'previous if we've moved over any.
8322 ;; So change our result back to 'same if necessary.
8324 ;; If they were brace list initializers we might not have moved over a
8325 ;; declaration boundary though, so change it to 'same if we've moved
8326 ;; past a '=' before '{', but not ';'. (This ought to be integrated
8327 ;; into `c-beginning-of-statement-1', so we avoid this extra pass which
8328 ;; potentially can search over a large amount of text.). Take special
8329 ;; pains not to get mislead by C++'s "operator=", and the like.
8330 (if (and (eq move 'previous)
8331 (c-with-syntax-table (if (c-major-mode-is 'c++-mode)
8332 c++-template-syntax-table
8337 (while ; keep going back to "[;={"s until we either find
8338 ; no more, or get to one which isn't an "operator ="
8339 (and (c-syntactic-re-search-forward "[;={]" start t t t)
8340 (eq (char-before) ?=)
8341 c-overloadable-operators-regexp
8342 c-opt-op-identifier-prefix
8344 (eq (c-backward-token-2) 0)
8345 (looking-at c-overloadable-operators-regexp)
8346 (eq (c-backward-token-2) 0)
8347 (looking-at c-opt-op-identifier-prefix))))
8348 (eq (char-before) ?=))
8349 (c-syntactic-re-search-forward "[;{]" start t t)
8350 (eq (char-before) ?{)
8351 (c-safe (goto-char (c-up-list-forward (point))) t)
8352 (not (c-syntactic-re-search-forward ";" start t t))))))
8356 (defun c-end-of-decl-1 ()
8357 ;; Assuming point is at the start of a declaration (as detected by
8358 ;; e.g. `c-beginning-of-decl-1'), go to the end of it. Unlike
8359 ;; `c-beginning-of-decl-1', this function handles the case when a
8360 ;; block is followed by identifiers in e.g. struct declarations in C
8361 ;; or C++. If a proper end was found then t is returned, otherwise
8362 ;; point is moved as far as possible within the current sexp and nil
8363 ;; is returned. This function doesn't handle macros; use
8364 ;; `c-end-of-macro' instead in those cases.
8366 ;; This function might do hidden buffer changes.
8367 (let ((start (point))
8368 (decl-syntax-table (if (c-major-mode-is 'c++-mode)
8369 c++-template-syntax-table
8372 (c-search-decl-header-end)
8374 (when (and c-recognize-knr-p
8375 (eq (char-before) ?\;)
8376 (c-in-knr-argdecl start))
8377 ;; Stopped at the ';' in a K&R argdecl section which is
8378 ;; detected using the same criteria as in
8379 ;; `c-beginning-of-decl-1'. Move to the following block
8381 (c-syntactic-re-search-forward "{" nil 'move t))
8383 (when (eq (char-before) ?{)
8384 ;; Encountered a block in the declaration. Jump over it.
8386 (goto-char (c-up-list-forward (point)))
8387 (error (goto-char (point-max))
8388 (throw 'return nil)))
8389 (if (or (not c-opt-block-decls-with-vars-key)
8391 (c-with-syntax-table decl-syntax-table
8392 (let ((lim (point)))
8395 ;; Check for `c-opt-block-decls-with-vars-key'
8396 ;; before the first paren.
8397 (c-syntactic-re-search-forward
8398 (concat "[;=\(\[{]\\|\\("
8399 c-opt-block-decls-with-vars-key
8403 (not (eq (char-before) ?_))
8404 ;; Check that the first following paren is
8406 (c-syntactic-re-search-forward "[;=\(\[{]"
8408 (eq (char-before) ?{)))))))
8409 ;; The declaration doesn't have any of the
8410 ;; `c-opt-block-decls-with-vars' keywords in the
8411 ;; beginning, so it ends here at the end of the block.
8414 (c-with-syntax-table decl-syntax-table
8416 (if (eq (char-before) ?\;)
8418 (c-syntactic-re-search-forward ";" nil 'move t))))
8421 (defun c-looking-at-decl-block (containing-sexp goto-start &optional limit)
8422 ;; Assuming the point is at an open brace, check if it starts a
8423 ;; block that contains another declaration level, i.e. that isn't a
8424 ;; statement block or a brace list, and if so return non-nil.
8426 ;; If the check is successful, the return value is the start of the
8427 ;; keyword that tells what kind of construct it is, i.e. typically
8428 ;; what `c-decl-block-key' matched. Also, if GOTO-START is set then
8429 ;; the point will be at the start of the construct, before any
8430 ;; leading specifiers, otherwise it's at the returned position.
8432 ;; The point is clobbered if the check is unsuccessful.
8434 ;; CONTAINING-SEXP is the position of the open of the surrounding
8435 ;; paren, or nil if none.
8437 ;; The optional LIMIT limits the backward search for the start of
8438 ;; the construct. It's assumed to be at a syntactically relevant
8441 ;; If any template arglists are found in the searched region before
8442 ;; the open brace, they get marked with paren syntax.
8444 ;; This function might do hidden buffer changes.
8446 (let ((open-brace (point)) kwd-start first-specifier-pos)
8447 (c-syntactic-skip-backward c-block-prefix-charset limit t)
8449 (when (and c-recognize-<>-arglists
8450 (eq (char-before) ?>))
8451 ;; Could be at the end of a template arglist.
8452 (let ((c-parse-and-markup-<>-arglists t))
8454 (c-backward-<>-arglist nil limit)
8456 (c-syntactic-skip-backward c-block-prefix-charset limit t)
8457 (eq (char-before) ?>))))))
8459 ;; Note: Can't get bogus hits inside template arglists below since they
8460 ;; have gotten paren syntax above.
8462 ;; If `goto-start' is set we begin by searching for the
8463 ;; first possible position of a leading specifier list.
8464 ;; The `c-decl-block-key' search continues from there since
8465 ;; we know it can't match earlier.
8467 (when (c-syntactic-re-search-forward c-symbol-start
8469 (goto-char (setq first-specifier-pos (match-beginning 0)))
8474 ((c-syntactic-re-search-forward c-decl-block-key open-brace t t t)
8475 (goto-char (setq kwd-start (match-beginning 0)))
8477 ;; Exclude cases where we matched what would ordinarily
8478 ;; be a block declaration keyword, except where it's not
8479 ;; legal because it's part of a "compound keyword" like
8480 ;; "enum class". Of course, if c-after-brace-list-key
8481 ;; is nil, we can skip the test.
8482 (or (equal c-after-brace-list-key "\\<\\>")
8487 (looking-at c-after-brace-list-key)
8488 (= (c-backward-token-2 1 t) 0)
8489 (looking-at c-brace-list-key))))))
8491 ;; Found a keyword that can't be a type?
8494 ;; Can be a type too, in which case it's the return type of a
8495 ;; function (under the assumption that no declaration level
8496 ;; block construct starts with a type).
8497 (not (c-forward-type))
8499 ;; Jumped over a type, but it could be a declaration keyword
8500 ;; followed by the declared identifier that we've jumped over
8501 ;; instead (e.g. in "class Foo {"). If it indeed is a type
8502 ;; then we should be at the declarator now, so check for a
8503 ;; valid declarator start.
8505 ;; Note: This doesn't cope with the case when a declared
8506 ;; identifier is followed by e.g. '(' in a language where '('
8507 ;; also might be part of a declarator expression. Currently
8508 ;; there's no such language.
8509 (not (or (looking-at c-symbol-start)
8510 (looking-at c-type-decl-prefix-key))))))
8512 ;; In Pike a list of modifiers may be followed by a brace
8513 ;; to make them apply to many identifiers. Note that the
8514 ;; match data will be empty on return in this case.
8515 ((and (c-major-mode-is 'pike-mode)
8517 (goto-char open-brace)
8518 (= (c-backward-token-2) 0))
8519 (looking-at c-specifier-key)
8520 ;; Use this variant to avoid yet another special regexp.
8521 (c-keyword-member (c-keyword-sym (match-string 1))
8523 (setq kwd-start (point))
8529 ;; Back up over any preceding specifiers and their clauses
8530 ;; by going forward from `first-specifier-pos', which is the
8531 ;; earliest possible position where the specifier list can
8534 (goto-char first-specifier-pos)
8536 (while (< (point) kwd-start)
8537 (if (looking-at c-symbol-key)
8538 ;; Accept any plain symbol token on the ground that
8539 ;; it's a specifier masked through a macro (just
8540 ;; like `c-forward-decl-or-cast-1' skip forward over
8543 ;; Could be more restrictive wrt invalid keywords,
8544 ;; but that'd only occur in invalid code so there's
8545 ;; no use spending effort on it.
8546 (let ((end (match-end 0)))
8547 (unless (c-forward-keyword-clause 0)
8549 (c-forward-syntactic-ws)))
8551 ;; Can't parse a declaration preamble and is still
8552 ;; before `kwd-start'. That means `first-specifier-pos'
8553 ;; was in some earlier construct. Search again.
8554 (if (c-syntactic-re-search-forward c-symbol-start
8556 (goto-char (setq first-specifier-pos (match-beginning 0)))
8557 ;; Got no preamble before the block declaration keyword.
8558 (setq first-specifier-pos kwd-start))))
8560 (goto-char first-specifier-pos))
8561 (goto-char kwd-start))
8565 (defun c-search-uplist-for-classkey (paren-state)
8566 ;; Check if the closest containing paren sexp is a declaration
8567 ;; block, returning a 2 element vector in that case. Aref 0
8568 ;; contains the bufpos at boi of the class key line, and aref 1
8569 ;; contains the bufpos of the open brace. This function is an
8570 ;; obsolete wrapper for `c-looking-at-decl-block'.
8572 ;; This function might do hidden buffer changes.
8573 (let ((open-paren-pos (c-most-enclosing-brace paren-state)))
8574 (when open-paren-pos
8576 (goto-char open-paren-pos)
8577 (when (and (eq (char-after) ?{)
8578 (c-looking-at-decl-block
8579 (c-safe-position open-paren-pos paren-state)
8581 (back-to-indentation)
8582 (vector (point) open-paren-pos))))))
8584 (defun c-most-enclosing-decl-block (paren-state)
8585 ;; Return the buffer position of the most enclosing decl-block brace (in the
8586 ;; sense of c-looking-at-decl-block) in the PAREN-STATE structure, or nil if
8588 (let* ((open-brace (c-pull-open-brace paren-state))
8589 (next-open-brace (c-pull-open-brace paren-state)))
8590 (while (and open-brace
8592 (goto-char open-brace)
8593 (not (c-looking-at-decl-block next-open-brace nil))))
8594 (setq open-brace next-open-brace
8595 next-open-brace (c-pull-open-brace paren-state)))
8598 (defun c-cheap-inside-bracelist-p (paren-state)
8599 ;; Return the position of the L-brace if point is inside a brace list
8600 ;; initialization of an array, etc. This is an approximate function,
8601 ;; designed for speed over accuracy. It will not find every bracelist, but
8602 ;; a non-nil result is reliable. We simply search for "= {" (naturally with
8603 ;; syntactic whitespace allowed). PAREN-STATE is the normal thing that it
8604 ;; is everywhere else.
8608 (and (setq b-pos (c-pull-open-brace paren-state))
8609 (progn (goto-char b-pos)
8611 (c-backward-token-2)
8612 (not (looking-at "=")))))
8615 (defun c-backward-colon-prefixed-type ()
8616 ;; We're at the token after what might be a type prefixed with a colon. Try
8617 ;; moving backward over this type and the colon. On success, return t and
8618 ;; leave point before colon; on failure, leave point unchanged. Will clobber
8620 (let ((here (point))
8624 (and (eql (c-backward-token-2) 0)
8625 (or (not (looking-at "\\s)"))
8626 (c-go-up-list-backward))
8628 ((eql (char-after) ?:)
8629 (setq colon-pos (point))
8631 (c-forward-syntactic-ws)
8632 (or (and (c-forward-type)
8633 (progn (c-forward-syntactic-ws)
8635 (setq colon-pos nil))
8637 ((eql (char-after) ?\()
8639 ((looking-at c-symbol-key)
8643 (goto-char colon-pos)
8646 (defun c-backward-over-enum-header ()
8647 ;; We're at a "{". Move back to the enum-like keyword that starts this
8648 ;; declaration and return t, otherwise don't move and return nil.
8649 (let ((here (point))
8650 up-sexp-pos before-identifier)
8651 (when c-recognize-post-brace-list-type-p
8652 (c-backward-colon-prefixed-type))
8655 (eq (c-backward-token-2) 0)
8656 (or (not (looking-at "\\s)"))
8657 (c-go-up-list-backward))
8659 ((and (looking-at c-symbol-key) (c-on-identifier)
8660 (not before-identifier))
8661 (setq before-identifier t))
8662 ((and before-identifier
8663 (or (eql (char-after) ?,)
8664 (looking-at c-postfix-decl-spec-key)))
8665 (setq before-identifier nil)
8667 ((looking-at c-after-brace-list-key) t)
8668 ((looking-at c-brace-list-key) nil)
8669 ((and c-recognize-<>-arglists
8670 (eq (char-after) ?<)
8671 (looking-at "\\s("))
8674 (or (looking-at c-brace-list-key)
8675 (progn (goto-char here) nil))))
8677 (defun c-inside-bracelist-p (containing-sexp paren-state)
8678 ;; return the buffer position of the beginning of the brace list
8679 ;; statement if we're inside a brace list, otherwise return nil.
8680 ;; CONTAINING-SEXP is the buffer pos of the innermost containing
8681 ;; paren. PAREN-STATE is the remainder of the state of enclosing
8684 ;; N.B.: This algorithm can potentially get confused by cpp macros
8685 ;; placed in inconvenient locations. It's a trade-off we make for
8688 ;; This function might do hidden buffer changes.
8690 ;; This will pick up brace list declarations.
8692 (goto-char containing-sexp)
8693 (c-backward-over-enum-header))
8694 ;; this will pick up array/aggregate init lists, even if they are nested.
8697 ;; Pike can have class definitions anywhere, so we must
8698 ;; check for the class key here.
8699 (and (c-major-mode-is 'pike-mode)
8701 bufpos braceassignp lim next-containing macro-start)
8702 (while (and (not bufpos)
8705 (if (consp (car paren-state))
8706 (setq lim (cdr (car paren-state))
8707 paren-state (cdr paren-state))
8708 (setq lim (car paren-state)))
8710 (setq next-containing (car paren-state)
8711 paren-state (cdr paren-state))))
8712 (goto-char containing-sexp)
8713 (if (c-looking-at-inexpr-block next-containing next-containing)
8714 ;; We're in an in-expression block of some kind. Do not
8715 ;; check nesting. We deliberately set the limit to the
8716 ;; containing sexp, so that c-looking-at-inexpr-block
8717 ;; doesn't check for an identifier before it.
8718 (setq containing-sexp nil)
8719 ;; see if the open brace is preceded by = or [...] in
8720 ;; this statement, but watch out for operator=
8721 (setq braceassignp 'dontknow)
8722 (c-backward-token-2 1 t lim)
8723 ;; Checks to do only on the first sexp before the brace.
8724 (when (and c-opt-inexpr-brace-list-key
8725 (eq (char-after) ?\[))
8726 ;; In Java, an initialization brace list may follow
8727 ;; directly after "new Foo[]", so check for a "new"
8729 (while (eq braceassignp 'dontknow)
8731 (cond ((/= (c-backward-token-2 1 t lim) 0) nil)
8732 ((looking-at c-opt-inexpr-brace-list-key) t)
8733 ((looking-at "\\sw\\|\\s_\\|[.[]")
8734 ;; Carry on looking if this is an
8735 ;; identifier (may contain "." in Java)
8736 ;; or another "[]" sexp.
8739 ;; Checks to do on all sexps before the brace, up to the
8740 ;; beginning of the statement.
8741 (while (eq braceassignp 'dontknow)
8742 (cond ((eq (char-after) ?\;)
8743 (setq braceassignp nil))
8745 (looking-at class-key))
8746 (setq braceassignp nil))
8747 ((eq (char-after) ?=)
8748 ;; We've seen a =, but must check earlier tokens so
8749 ;; that it isn't something that should be ignored.
8750 (setq braceassignp 'maybe)
8751 (while (and (eq braceassignp 'maybe)
8752 (zerop (c-backward-token-2 1 t lim)))
8755 ;; Check for operator =
8756 ((and c-opt-op-identifier-prefix
8757 (looking-at c-opt-op-identifier-prefix))
8759 ;; Check for `<opchar>= in Pike.
8760 ((and (c-major-mode-is 'pike-mode)
8761 (or (eq (char-after) ?`)
8762 ;; Special case for Pikes
8763 ;; `[]=, since '[' is not in
8764 ;; the punctuation class.
8765 (and (eq (char-after) ?\[)
8766 (eq (char-before) ?`))))
8768 ((looking-at "\\s.") 'maybe)
8769 ;; make sure we're not in a C++ template
8770 ;; argument assignment
8772 (c-major-mode-is 'c++-mode)
8774 (let ((here (point))
8776 (skip-chars-backward "^<>")
8778 (and (eq (char-before) ?<)
8779 (not (c-crosses-statement-barrier-p
8781 (not (c-in-literal))
8785 (if (and (eq braceassignp 'dontknow)
8786 (/= (c-backward-token-2 1 t lim) 0))
8787 (setq braceassignp nil)))
8790 ;; We've hit the beginning of the aggregate list.
8791 (c-beginning-of-statement-1
8792 (c-most-enclosing-brace paren-state))
8793 (setq bufpos (point)))
8794 ((eq (char-after) ?\;)
8795 ;; Brace lists can't contain a semicolon, so we're done.
8796 (setq containing-sexp nil))
8797 ((and (setq macro-start (point))
8798 (c-forward-to-cpp-define-body)
8799 (eq (point) containing-sexp))
8800 ;; We've a macro whose expansion starts with the '{'.
8801 ;; Heuristically, if we have a ';' in it we've not got a
8802 ;; brace list, otherwise we have.
8803 (let ((macro-end (progn (c-end-of-macro) (point))))
8804 (goto-char containing-sexp)
8806 (if (and (c-syntactic-re-search-forward "[;,]" macro-end t t)
8807 (eq (char-before) ?\;))
8809 containing-sexp nil)
8810 (setq bufpos macro-start))))
8813 (setq containing-sexp next-containing
8815 next-containing nil)))))
8820 (defun c-looking-at-special-brace-list (&optional lim)
8821 ;; If we're looking at the start of a pike-style list, i.e., `({Â })',
8822 ;; `([Â ])', `(<Â >)', etc., a cons of a cons of its starting and ending
8823 ;; positions and its entry in c-special-brace-lists is returned, nil
8824 ;; otherwise. The ending position is nil if the list is still open.
8825 ;; LIM is the limit for forward search. The point may either be at
8826 ;; the `(' or at the following paren character. Tries to check the
8827 ;; matching closer, but assumes it's correct if no balanced paren is
8828 ;; found (i.e. the case `({ ... } ... )' is detected as _not_ being
8829 ;; a special brace list).
8831 ;; This function might do hidden buffer changes.
8832 (if c-special-brace-lists
8837 (c-forward-syntactic-ws)
8838 (if (eq (char-after) ?\()
8841 (c-forward-syntactic-ws)
8842 (setq inner-beg (point))
8843 (setq type (assq (char-after) c-special-brace-lists)))
8844 (if (setq type (assq (char-after) c-special-brace-lists))
8846 (setq inner-beg (point))
8847 (c-backward-syntactic-ws)
8849 (setq beg (if (eq (char-after) ?\()
8857 (= (char-before) ?\)))
8859 (goto-char inner-beg)
8860 (if (looking-at "\\s(")
8861 ;; Check balancing of the inner paren
8866 ;; If the inner char isn't a paren then
8867 ;; we can't check balancing, so just
8868 ;; check the char before the outer
8872 (c-backward-syntactic-ws)
8873 (= (char-before) (cdr type)))))
8874 (if (or (/= (char-syntax (char-before)) ?\))
8876 (c-forward-syntactic-ws)
8879 (cons (cons beg end) type))
8880 (cons (list beg) type)))))
8883 (defun c-looking-at-bos (&optional lim)
8884 ;; Return non-nil if between two statements or declarations, assuming
8885 ;; point is not inside a literal or comment.
8887 ;; Obsolete - `c-at-statement-start-p' or `c-at-expression-start-p'
8888 ;; are recommended instead.
8890 ;; This function might do hidden buffer changes.
8891 (c-at-statement-start-p))
8892 (make-obsolete 'c-looking-at-bos 'c-at-statement-start-p "22.1")
8894 (defun c-looking-at-inexpr-block (lim containing-sexp &optional check-at-end)
8895 ;; Return non-nil if we're looking at the beginning of a block
8896 ;; inside an expression. The value returned is actually a cons of
8897 ;; either 'inlambda, 'inexpr-statement or 'inexpr-class and the
8898 ;; position of the beginning of the construct.
8900 ;; LIM limits the backward search. CONTAINING-SEXP is the start
8901 ;; position of the closest containing list. If it's nil, the
8902 ;; containing paren isn't used to decide whether we're inside an
8903 ;; expression or not. If both LIM and CONTAINING-SEXP are used, LIM
8904 ;; needs to be farther back.
8906 ;; If CHECK-AT-END is non-nil then extra checks at the end of the
8907 ;; brace block might be done. It should only be used when the
8908 ;; construct can be assumed to be complete, i.e. when the original
8909 ;; starting position was further down than that.
8911 ;; This function might do hidden buffer changes.
8914 (let ((res 'maybe) passed-paren
8915 (closest-lim (or containing-sexp lim (point-min)))
8916 ;; Look at the character after point only as a last resort
8917 ;; when we can't disambiguate.
8918 (block-follows (and (eq (char-after) ?{) (point))))
8920 (while (and (eq res 'maybe)
8921 (progn (c-backward-syntactic-ws)
8922 (> (point) closest-lim))
8924 (progn (backward-char)
8925 (looking-at "[\]\).]\\|\\w\\|\\s_"))
8926 (c-safe (forward-char)
8927 (goto-char (scan-sexps (point) -1))))
8930 (if (looking-at c-keywords-regexp)
8931 (let ((kw-sym (c-keyword-sym (match-string 1))))
8934 (c-keyword-member kw-sym 'c-inexpr-class-kwds))
8935 (and (not (eq passed-paren ?\[))
8936 (or (not (looking-at c-class-key))
8937 ;; If the class definition is at the start of
8938 ;; a statement, we don't consider it an
8939 ;; in-expression class.
8940 (let ((prev (point)))
8942 (= (c-backward-token-2 1 nil closest-lim) 0)
8943 (eq (char-syntax (char-after)) ?w))
8944 (setq prev (point)))
8946 (not (c-at-statement-start-p)))
8947 ;; Also, in Pike we treat it as an
8948 ;; in-expression class if it's used in an
8949 ;; object clone expression.
8952 (c-major-mode-is 'pike-mode)
8953 (progn (goto-char block-follows)
8954 (zerop (c-forward-token-2 1 t)))
8955 (eq (char-after) ?\())))
8956 (cons 'inexpr-class (point))))
8957 ((c-keyword-member kw-sym 'c-inexpr-block-kwds)
8958 (when (not passed-paren)
8959 (cons 'inexpr-statement (point))))
8960 ((c-keyword-member kw-sym 'c-lambda-kwds)
8961 (when (or (not passed-paren)
8962 (eq passed-paren ?\())
8963 (cons 'inlambda (point))))
8964 ((c-keyword-member kw-sym 'c-block-stmt-kwds)
8969 (if (looking-at "\\s(")
8971 (if (and (eq passed-paren ?\[)
8972 (eq (char-after) ?\[))
8973 ;; Accept several square bracket sexps for
8974 ;; Java array initializations.
8976 (setq passed-paren (char-after))
8981 (when (and c-recognize-paren-inexpr-blocks
8984 (eq (char-after containing-sexp) ?\())
8985 (goto-char containing-sexp)
8986 (if (or (save-excursion
8987 (c-backward-syntactic-ws lim)
8988 (and (> (point) (or lim (point-min)))
8990 (and c-special-brace-lists
8991 (c-looking-at-special-brace-list)))
8993 (cons 'inexpr-statement (point))))
8997 (defun c-looking-at-inexpr-block-backward (paren-state)
8998 ;; Returns non-nil if we're looking at the end of an in-expression
8999 ;; block, otherwise the same as `c-looking-at-inexpr-block'.
9000 ;; PAREN-STATE is the paren state relevant at the current position.
9002 ;; This function might do hidden buffer changes.
9004 ;; We currently only recognize a block.
9005 (let ((here (point))
9006 (elem (car-safe paren-state))
9008 (when (and (consp elem)
9009 (progn (goto-char (cdr elem))
9010 (c-forward-syntactic-ws here)
9012 (goto-char (car elem))
9013 (if (setq paren-state (cdr paren-state))
9014 (setq containing-sexp (car-safe paren-state)))
9015 (c-looking-at-inexpr-block (c-safe-position containing-sexp
9017 containing-sexp)))))
9019 (defun c-at-macro-vsemi-p (&optional pos)
9020 ;; Is there a "virtual semicolon" at POS or point?
9021 ;; (See cc-defs.el for full details of "virtual semicolons".)
9023 ;; This is true when point is at the last non syntactic WS position on the
9024 ;; line, there is a macro call last on the line, and this particular macro's
9025 ;; name is defined by the regexp `c-vs-macro-regexp' as not needing a
9034 c-macro-with-semi-re
9035 (eq (skip-chars-backward " \t") 0)
9037 ;; Check we've got nothing after this except comments and empty lines
9038 ;; joined by escaped EOLs.
9039 (skip-chars-forward " \t") ; always returns non-nil.
9041 (while ; go over 1 block comment per iteration.
9043 (looking-at "\\(\\\\[\n\r][ \t]*\\)*")
9044 (goto-char (match-end 0))
9046 ((looking-at c-block-comment-start-regexp)
9047 (and (forward-comment 1)
9048 (skip-chars-forward " \t"))) ; always returns non-nil
9049 ((looking-at c-line-comment-start-regexp)
9056 (progn (c-backward-syntactic-ws)
9059 ;; Check for one of the listed macros being before point.
9060 (or (not (eq (char-before) ?\)))
9061 (when (c-go-list-backward)
9062 (c-backward-syntactic-ws)
9064 (c-simple-skip-symbol-backward)
9065 (looking-at c-macro-with-semi-re)
9067 (not (c-in-literal)))))) ; The most expensive check last.
9069 (defun c-macro-vsemi-status-unknown-p () t) ; See cc-defs.el.
9072 ;; `c-guess-basic-syntax' and the functions that precedes it below
9073 ;; implements the main decision tree for determining the syntactic
9074 ;; analysis of the current line of code.
9076 ;; Dynamically bound to t when `c-guess-basic-syntax' is called during
9077 ;; auto newline analysis.
9078 (defvar c-auto-newline-analysis nil)
9080 (defun c-brace-anchor-point (bracepos)
9081 ;; BRACEPOS is the position of a brace in a construct like "namespace
9082 ;; Bar {". Return the anchor point in this construct; this is the
9083 ;; earliest symbol on the brace's line which isn't earlier than
9086 ;; Currently (2007-08-17), "like namespace" means "matches
9087 ;; c-other-block-decl-kwds". It doesn't work with "class" or "struct"
9088 ;; or anything like that.
9090 (let ((boi (c-point 'boi bracepos)))
9091 (goto-char bracepos)
9092 (while (and (> (point) boi)
9093 (not (looking-at c-other-decl-block-key)))
9094 (c-backward-token-2))
9095 (if (> (point) boi) (point) boi))))
9097 (defsubst c-add-syntax (symbol &rest args)
9098 ;; A simple function to prepend a new syntax element to
9099 ;; `c-syntactic-context'. Using `setq' on it is unsafe since it
9100 ;; should always be dynamically bound but since we read it first
9101 ;; we'll fail properly anyway if this function is misused.
9102 (setq c-syntactic-context (cons (cons symbol args)
9103 c-syntactic-context)))
9105 (defsubst c-append-syntax (symbol &rest args)
9106 ;; Like `c-add-syntax' but appends to the end of the syntax list.
9107 ;; (Normally not necessary.)
9108 (setq c-syntactic-context (nconc c-syntactic-context
9109 (list (cons symbol args)))))
9111 (defun c-add-stmt-syntax (syntax-symbol
9116 ;; Add the indicated SYNTAX-SYMBOL to `c-syntactic-context', extending it as
9117 ;; needed with further syntax elements of the types `substatement',
9118 ;; `inexpr-statement', `arglist-cont-nonempty', `statement-block-intro', and
9119 ;; `defun-block-intro'.
9121 ;; Do the generic processing to anchor the given syntax symbol on
9122 ;; the preceding statement: Skip over any labels and containing
9123 ;; statements on the same line, and then search backward until we
9124 ;; find a statement or block start that begins at boi without a
9125 ;; label or comment.
9127 ;; Point is assumed to be at the prospective anchor point for the
9128 ;; given SYNTAX-SYMBOL. More syntax entries are added if we need to
9129 ;; skip past open parens and containing statements. Most of the added
9130 ;; syntax elements will get the same anchor point - the exception is
9131 ;; for an anchor in a construct like "namespace"[*] - this is as early
9132 ;; as possible in the construct but on the same line as the {.
9134 ;; [*] i.e. with a keyword matching c-other-block-decl-kwds.
9136 ;; SYNTAX-EXTRA-ARGS are a list of the extra arguments for the
9137 ;; syntax symbol. They are appended after the anchor point.
9139 ;; If STOP-AT-BOI-ONLY is nil, we can stop in the middle of the line
9140 ;; if the current statement starts there.
9142 ;; Note: It's not a problem if PAREN-STATE "overshoots"
9143 ;; CONTAINING-SEXP, i.e. contains info about parens further down.
9145 ;; This function might do hidden buffer changes.
9147 (if (= (point) (c-point 'boi))
9148 ;; This is by far the most common case, so let's give it special
9150 (apply 'c-add-syntax syntax-symbol (point) syntax-extra-args)
9152 (let ((syntax-last c-syntactic-context)
9153 (boi (c-point 'boi))
9154 ;; Set when we're on a label, so that we don't stop there.
9155 ;; FIXME: To be complete we should check if we're on a label
9156 ;; now at the start.
9159 ;; Use point as the anchor point for "namespace", "extern", etc.
9160 (apply 'c-add-syntax syntax-symbol
9161 (if (rassq syntax-symbol c-other-decl-block-key-in-symbols-alist)
9165 ;; Loop while we have to back out of containing blocks.
9168 (catch 'back-up-block
9170 ;; Loop while we have to back up statements.
9171 (while (or (/= (point) boi)
9173 (looking-at c-comment-start-regexp))
9175 ;; Skip past any comments that stands between the
9176 ;; statement start and boi.
9177 (let ((savepos (point)))
9178 (while (and (/= savepos boi)
9179 (c-backward-single-comment))
9180 (setq savepos (point)
9181 boi (c-point 'boi)))
9182 (goto-char savepos))
9184 ;; Skip to the beginning of this statement or backward
9186 (let ((old-pos (point))
9188 (step-type (c-beginning-of-statement-1 containing-sexp)))
9189 (setq boi (c-point 'boi)
9190 on-label (eq step-type 'label))
9192 (cond ((= (point) old-pos)
9193 ;; If we didn't move we're at the start of a block and
9194 ;; have to continue outside it.
9195 (throw 'back-up-block t))
9197 ((and (eq step-type 'up)
9198 (>= (point) old-boi)
9199 (looking-at "else\\>[^_]")
9202 (looking-at "if\\>[^_]")))
9203 ;; Special case to avoid deeper and deeper indentation
9204 ;; of "else if" clauses.
9207 ((and (not stop-at-boi-only)
9208 (/= old-pos old-boi)
9209 (memq step-type '(up previous)))
9210 ;; If stop-at-boi-only is nil, we shouldn't back up
9211 ;; over previous or containing statements to try to
9212 ;; reach boi, so go back to the last position and
9215 (throw 'back-up-block nil))
9218 (if (and (not stop-at-boi-only)
9219 (memq step-type '(up previous beginning)))
9220 ;; If we've moved into another statement then we
9221 ;; should no longer try to stop in the middle of a
9223 (setq stop-at-boi-only t))
9225 ;; Record this as a substatement if we skipped up one
9227 (when (eq step-type 'up)
9228 (c-add-syntax 'substatement nil))))
9233 ;; Now we have to go out of this block.
9234 (goto-char containing-sexp)
9236 ;; Don't stop in the middle of a special brace list opener
9238 (when c-special-brace-lists
9239 (let ((special-list (c-looking-at-special-brace-list)))
9240 (when (and special-list
9241 (< (car (car special-list)) (point)))
9242 (setq containing-sexp (car (car special-list)))
9243 (goto-char containing-sexp))))
9245 (setq paren-state (c-whack-state-after containing-sexp paren-state)
9246 containing-sexp (c-most-enclosing-brace paren-state)
9249 ;; Analyze the construct in front of the block we've stepped out
9250 ;; from and add the right syntactic element for it.
9251 (let ((paren-pos (point))
9252 (paren-char (char-after))
9255 (if (eq paren-char ?\()
9256 ;; Stepped out of a parenthesis block, so we're in an
9259 (when (/= paren-pos boi)
9260 (if (and c-recognize-paren-inexpr-blocks
9262 (c-backward-syntactic-ws containing-sexp)
9263 (or (not (looking-at "\\>"))
9264 (not (c-on-identifier))))
9266 (goto-char (1+ paren-pos))
9267 (c-forward-syntactic-ws)
9268 (eq (char-after) ?{)))
9269 ;; Stepped out of an in-expression statement. This
9270 ;; syntactic element won't get an anchor pos.
9271 (c-add-syntax 'inexpr-statement)
9273 ;; A parenthesis normally belongs to an arglist.
9274 (c-add-syntax 'arglist-cont-nonempty nil paren-pos)))
9278 (1+ containing-sexp)
9280 (setq step-type 'same
9283 ;; Stepped out of a brace block.
9284 (setq step-type (c-beginning-of-statement-1 containing-sexp)
9285 on-label (eq step-type 'label))
9287 (if (and (eq step-type 'same)
9288 (/= paren-pos (point)))
9292 (goto-char paren-pos)
9293 (setq inexpr (c-looking-at-inexpr-block
9294 (c-safe-position containing-sexp paren-state)
9296 (c-add-syntax (if (eq (car inexpr) 'inlambda)
9298 'statement-block-intro)
9300 ((looking-at c-other-decl-block-key)
9302 (cdr (assoc (match-string 1)
9303 c-other-decl-block-key-in-symbols-alist))
9304 (max (c-point 'boi paren-pos) (point))))
9305 (t (c-add-syntax 'defun-block-intro nil))))
9307 (c-add-syntax 'statement-block-intro nil)))
9309 (if (= paren-pos boi)
9310 ;; Always done if the open brace was at boi. The
9311 ;; c-beginning-of-statement-1 call above is necessary
9312 ;; anyway, to decide the type of block-intro to add.
9313 (goto-char paren-pos)
9314 (setq boi (c-point 'boi)))
9317 ;; Fill in the current point as the anchor for all the symbols
9319 (let ((p c-syntactic-context) q)
9320 (while (not (eq p syntax-last))
9321 (setq q (cdr (car p))) ; e.g. (nil 28) [from (arglist-cont-nonempty nil 28)]
9329 (defun c-add-class-syntax (symbol
9330 containing-decl-open
9331 containing-decl-start
9334 ;; The inclass and class-close syntactic symbols are added in
9335 ;; several places and some work is needed to fix everything.
9336 ;; Therefore it's collected here.
9338 ;; This function might do hidden buffer changes.
9339 (goto-char containing-decl-open)
9340 (if (and (eq symbol 'inclass) (= (point) (c-point 'boi)))
9342 (c-add-syntax symbol containing-decl-open)
9343 containing-decl-open)
9344 (goto-char containing-decl-start)
9345 ;; Ought to use `c-add-stmt-syntax' instead of backing up to boi
9346 ;; here, but we have to do like this for compatibility.
9347 (back-to-indentation)
9348 (c-add-syntax symbol (point))
9349 (if (and (c-keyword-member containing-decl-kwd
9350 'c-inexpr-class-kwds)
9351 (/= containing-decl-start (c-point 'boi containing-decl-start)))
9352 (c-add-syntax 'inexpr-class))
9355 (defun c-guess-continued-construct (indent-point
9357 beg-of-same-or-containing-stmt
9360 ;; This function contains the decision tree reached through both
9361 ;; cases 18 and 10. It's a continued statement or top level
9362 ;; construct of some kind.
9364 ;; This function might do hidden buffer changes.
9366 (let (special-brace-list placeholder)
9367 (goto-char indent-point)
9368 (skip-chars-forward " \t")
9371 ;; (CASE A removed.)
9372 ;; CASE B: open braces for class or brace-lists
9373 ((setq special-brace-list
9374 (or (and c-special-brace-lists
9375 (c-looking-at-special-brace-list))
9376 (eq char-after-ip ?{)))
9379 ;; CASE B.1: class-open
9381 (and (eq (char-after) ?{)
9382 (c-looking-at-decl-block containing-sexp t)
9383 (setq beg-of-same-or-containing-stmt (point))))
9384 (c-add-syntax 'class-open beg-of-same-or-containing-stmt))
9386 ;; CASE B.2: brace-list-open
9387 ((or (consp special-brace-list)
9389 (goto-char beg-of-same-or-containing-stmt)
9390 (c-syntactic-re-search-forward "=\\([^=]\\|$\\)"
9391 indent-point t t t)))
9392 ;; The most semantically accurate symbol here is
9393 ;; brace-list-open, but we normally report it simply as a
9394 ;; statement-cont. The reason is that one normally adjusts
9395 ;; brace-list-open for brace lists as top-level constructs,
9396 ;; and brace lists inside statements is a completely different
9397 ;; context. C.f. case 5A.3.
9398 (c-beginning-of-statement-1 containing-sexp)
9399 (c-add-stmt-syntax (if c-auto-newline-analysis
9400 ;; Turn off the dwim above when we're
9401 ;; analyzing the nature of the brace
9402 ;; for the auto newline feature.
9406 containing-sexp paren-state))
9408 ;; CASE B.3: The body of a function declared inside a normal
9409 ;; block. Can occur e.g. in Pike and when using gcc
9410 ;; extensions, but watch out for macros followed by blocks.
9411 ;; C.f. cases E, 16F and 17G.
9412 ((and (not (c-at-statement-start-p))
9413 (eq (c-beginning-of-statement-1 containing-sexp nil nil t)
9416 (let ((c-recognize-typeless-decls nil))
9417 ;; Turn off recognition of constructs that lacks a
9418 ;; type in this case, since that's more likely to be
9419 ;; a macro followed by a block.
9420 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
9421 (c-add-stmt-syntax 'defun-open nil t
9422 containing-sexp paren-state))
9424 ;; CASE B.4: Continued statement with block open. The most
9425 ;; accurate analysis is perhaps `statement-cont' together with
9426 ;; `block-open' but we play DWIM and use `substatement-open'
9427 ;; instead. The rationale is that this typically is a macro
9428 ;; followed by a block which makes it very similar to a
9429 ;; statement with a substatement block.
9431 (c-add-stmt-syntax 'substatement-open nil nil
9432 containing-sexp paren-state))
9435 ;; CASE C: iostream insertion or extraction operator
9436 ((and (looking-at "\\(<<\\|>>\\)\\([^=]\\|$\\)")
9438 (goto-char beg-of-same-or-containing-stmt)
9439 ;; If there is no preceding streamop in the statement
9440 ;; then indent this line as a normal statement-cont.
9441 (when (c-syntactic-re-search-forward
9442 "\\(<<\\|>>\\)\\([^=]\\|$\\)" indent-point 'move t t)
9443 (c-add-syntax 'stream-op (c-point 'boi))
9446 ;; CASE E: In the "K&R region" of a function declared inside a
9447 ;; normal block. C.f. case B.3.
9448 ((and (save-excursion
9449 ;; Check that the next token is a '{'. This works as
9450 ;; long as no language that allows nested function
9451 ;; definitions allows stuff like member init lists, K&R
9452 ;; declarations or throws clauses there.
9454 ;; Note that we do a forward search for something ahead
9455 ;; of the indentation line here. That's not good since
9456 ;; the user might not have typed it yet. Unfortunately
9457 ;; it's exceedingly tricky to recognize a function
9458 ;; prototype in a code block without resorting to this.
9459 (c-forward-syntactic-ws)
9460 (eq (char-after) ?{))
9461 (not (c-at-statement-start-p))
9462 (eq (c-beginning-of-statement-1 containing-sexp nil nil t)
9465 (let ((c-recognize-typeless-decls nil))
9466 ;; Turn off recognition of constructs that lacks a
9467 ;; type in this case, since that's more likely to be
9468 ;; a macro followed by a block.
9469 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
9470 (c-add-stmt-syntax 'func-decl-cont nil t
9471 containing-sexp paren-state))
9473 ;;CASE F: continued statement and the only preceding items are
9475 ((and (c-major-mode-is 'java-mode)
9476 (setq placeholder (point))
9477 (c-beginning-of-statement-1)
9479 (while (and (c-forward-annotation)
9480 (< (point) placeholder))
9481 (c-forward-syntactic-ws))
9484 (>= (point) placeholder)
9485 (goto-char placeholder)))
9486 (c-beginning-of-statement-1 containing-sexp)
9487 (c-add-syntax 'annotation-var-cont (point)))
9489 ;; CASE G: a template list continuation?
9490 ;; Mostly a duplication of case 5D.3 to fix templates-19:
9491 ((and (c-major-mode-is 'c++-mode)
9493 (goto-char indent-point)
9494 (c-with-syntax-table c++-template-syntax-table
9495 (setq placeholder (c-up-list-backward)))
9497 (eq (char-after placeholder) ?<)
9498 (/= (char-before placeholder) ?<)
9500 (goto-char (1+ placeholder))
9501 (not (looking-at c-<-op-cont-regexp))))))
9502 (c-with-syntax-table c++-template-syntax-table
9503 (goto-char placeholder)
9504 (c-beginning-of-statement-1 containing-sexp t))
9506 (c-backward-syntactic-ws containing-sexp)
9507 (eq (char-before) ?<))
9508 ;; In a nested template arglist.
9510 (goto-char placeholder)
9511 (c-syntactic-skip-backward "^,;" containing-sexp t)
9512 (c-forward-syntactic-ws))
9513 (back-to-indentation))
9514 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
9516 (c-add-syntax 'template-args-cont (point) placeholder))
9518 ;; CASE D: continued statement.
9520 (c-beginning-of-statement-1 containing-sexp)
9521 (c-add-stmt-syntax 'statement-cont nil nil
9522 containing-sexp paren-state))
9525 ;; The next autoload was added by RMS on 2005/8/9 - don't know why (ACM,
9528 (defun c-guess-basic-syntax ()
9529 "Return the syntactic context of the current line."
9532 (c-save-buffer-state
9533 ((indent-point (point))
9534 (case-fold-search nil)
9535 open-paren-in-column-0-is-defun-start
9536 ;; A whole ugly bunch of various temporary variables. Have
9537 ;; to declare them here since it's not possible to declare
9538 ;; a variable with only the scope of a cond test and the
9539 ;; following result clauses, and most of this function is a
9540 ;; single gigantic cond. :P
9541 literal char-before-ip before-ws-ip char-after-ip macro-start
9542 in-macro-expr c-syntactic-context placeholder c-in-literal-cache
9543 step-type tmpsymbol keyword injava-inher special-brace-list tmp-pos
9545 ;; The following record some positions for the containing
9546 ;; declaration block if we're directly within one:
9547 ;; `containing-decl-open' is the position of the open
9548 ;; brace. `containing-decl-start' is the start of the
9549 ;; declaration. `containing-decl-kwd' is the keyword
9550 ;; symbol of the keyword that tells what kind of block it
9552 containing-decl-open
9553 containing-decl-start
9555 ;; The open paren of the closest surrounding sexp or nil if
9558 ;; The position after the closest preceding brace sexp
9559 ;; (nested sexps are ignored), or the position after
9560 ;; `containing-sexp' if there is none, or (point-min) if
9561 ;; `containing-sexp' is nil.
9563 ;; The paren state outside `containing-sexp', or at
9564 ;; `indent-point' if `containing-sexp' is nil.
9565 (paren-state (c-parse-state))
9566 ;; There's always at most one syntactic element which got
9567 ;; an anchor pos. It's stored in syntactic-relpos.
9569 (c-stmt-delim-chars c-stmt-delim-chars))
9571 ;; Check if we're directly inside an enclosing declaration
9573 (when (and (setq containing-sexp
9574 (c-most-enclosing-brace paren-state))
9576 (goto-char containing-sexp)
9577 (eq (char-after) ?{))
9579 (c-looking-at-decl-block
9580 (c-most-enclosing-brace paren-state
9583 (setq containing-decl-open containing-sexp
9584 containing-decl-start (point)
9585 containing-sexp nil)
9586 (goto-char placeholder)
9587 (setq containing-decl-kwd (and (looking-at c-keywords-regexp)
9588 (c-keyword-sym (match-string 1)))))
9590 ;; Init some position variables.
9593 (setq containing-sexp (car paren-state)
9594 paren-state (cdr paren-state))
9595 (if (consp containing-sexp)
9597 (setq lim (cdr containing-sexp))
9598 (if (cdr c-state-cache)
9599 ;; Ignore balanced paren. The next entry
9600 ;; can't be another one.
9601 (setq containing-sexp (car (cdr c-state-cache))
9602 paren-state (cdr paren-state))
9603 ;; If there is no surrounding open paren then
9604 ;; put the last balanced pair back on paren-state.
9605 (setq paren-state (cons containing-sexp paren-state)
9606 containing-sexp nil)))
9607 (setq lim (1+ containing-sexp))))
9608 (setq lim (point-min)))
9610 ;; If we're in a parenthesis list then ',' delimits the
9611 ;; "statements" rather than being an operator (with the
9612 ;; exception of the "for" clause). This difference is
9613 ;; typically only noticeable when statements are used in macro
9615 (when (and containing-sexp
9616 (eq (char-after containing-sexp) ?\())
9617 (setq c-stmt-delim-chars c-stmt-delim-chars-with-comma))
9618 ;; cache char before and after indent point, and move point to
9619 ;; the most likely position to perform the majority of tests
9620 (goto-char indent-point)
9621 (c-backward-syntactic-ws lim)
9622 (setq before-ws-ip (point)
9623 char-before-ip (char-before))
9624 (goto-char indent-point)
9625 (skip-chars-forward " \t")
9626 (setq char-after-ip (char-after))
9628 ;; are we in a literal?
9629 (setq literal (c-in-literal lim))
9631 ;; now figure out syntactic qualities of the current line
9634 ;; CASE 1: in a string.
9635 ((eq literal 'string)
9636 (c-add-syntax 'string (c-point 'bopl)))
9638 ;; CASE 2: in a C or C++ style comment.
9639 ((and (memq literal '(c c++))
9640 ;; This is a kludge for XEmacs where we use
9641 ;; `buffer-syntactic-context', which doesn't correctly
9642 ;; recognize "\*/" to end a block comment.
9643 ;; `parse-partial-sexp' which is used by
9644 ;; `c-literal-limits' will however do that in most
9645 ;; versions, which results in that we get nil from
9646 ;; `c-literal-limits' even when `c-in-literal' claims
9647 ;; we're inside a comment.
9648 (setq placeholder (c-literal-limits lim)))
9649 (c-add-syntax literal (car placeholder)))
9651 ;; CASE 3: in a cpp preprocessor macro continuation.
9652 ((and (save-excursion
9653 (when (c-beginning-of-macro)
9654 (setq macro-start (point))))
9655 (/= macro-start (c-point 'boi))
9657 (setq tmpsymbol 'cpp-macro-cont)
9658 (or (not c-syntactic-indentation-in-macros)
9660 (goto-char macro-start)
9661 ;; If at the beginning of the body of a #define
9662 ;; directive then analyze as cpp-define-intro
9663 ;; only. Go on with the syntactic analysis
9664 ;; otherwise. in-macro-expr is set if we're in a
9665 ;; cpp expression, i.e. before the #define body
9666 ;; or anywhere in a non-#define directive.
9667 (if (c-forward-to-cpp-define-body)
9668 (let ((indent-boi (c-point 'boi indent-point)))
9669 (setq in-macro-expr (> (point) indent-boi)
9670 tmpsymbol 'cpp-define-intro)
9671 (= (point) indent-boi))
9672 (setq in-macro-expr t)
9674 (c-add-syntax tmpsymbol macro-start)
9675 (setq macro-start nil))
9677 ;; CASE 11: an else clause?
9678 ((looking-at "else\\>[^_]")
9679 (c-beginning-of-statement-1 containing-sexp)
9680 (c-add-stmt-syntax 'else-clause nil t
9681 containing-sexp paren-state))
9683 ;; CASE 12: while closure of a do/while construct?
9684 ((and (looking-at "while\\>[^_]")
9686 (prog1 (eq (c-beginning-of-statement-1 containing-sexp)
9688 (setq placeholder (point)))))
9689 (goto-char placeholder)
9690 (c-add-stmt-syntax 'do-while-closure nil t
9691 containing-sexp paren-state))
9693 ;; CASE 13: A catch or finally clause? This case is simpler
9694 ;; than if-else and do-while, because a block is required
9695 ;; after every try, catch and finally.
9697 (and (cond ((c-major-mode-is 'c++-mode)
9698 (looking-at "catch\\>[^_]"))
9699 ((c-major-mode-is 'java-mode)
9700 (looking-at "\\(catch\\|finally\\)\\>[^_]")))
9701 (and (c-safe (c-backward-syntactic-ws)
9704 (eq (char-after) ?{)
9705 (c-safe (c-backward-syntactic-ws)
9708 (if (eq (char-after) ?\()
9709 (c-safe (c-backward-sexp) t)
9711 (looking-at "\\(try\\|catch\\)\\>[^_]")
9712 (setq placeholder (point))))
9713 (goto-char placeholder)
9714 (c-add-stmt-syntax 'catch-clause nil t
9715 containing-sexp paren-state))
9717 ;; CASE 18: A substatement we can recognize by keyword.
9719 (and c-opt-block-stmt-key
9720 (not (eq char-before-ip ?\;))
9721 (not (c-at-vsemi-p before-ws-ip))
9722 (not (memq char-after-ip '(?\) ?\] ?,)))
9723 (or (not (eq char-before-ip ?}))
9724 (c-looking-at-inexpr-block-backward c-state-cache))
9727 ;; Ought to cache the result from the
9728 ;; c-beginning-of-statement-1 calls here.
9729 (setq placeholder (point))
9730 (while (eq (setq step-type
9731 (c-beginning-of-statement-1 lim))
9733 (if (eq step-type 'previous)
9734 (goto-char placeholder)
9735 (setq placeholder (point))
9736 (if (and (eq step-type 'same)
9737 (not (looking-at c-opt-block-stmt-key)))
9738 ;; Step up to the containing statement if we
9739 ;; stayed in the same one.
9743 (c-beginning-of-statement-1 lim))
9746 (setq placeholder (point))
9747 ;; There was no containing statement after all.
9748 (goto-char placeholder)))))
9750 (if (looking-at c-block-stmt-2-key)
9751 ;; Require a parenthesis after these keywords.
9752 ;; Necessary to catch e.g. synchronized in Java,
9753 ;; which can be used both as statement and
9755 (and (zerop (c-forward-token-2 1 nil))
9756 (eq (char-after) ?\())
9757 (looking-at c-opt-block-stmt-key))))
9759 (if (eq step-type 'up)
9760 ;; CASE 18A: Simple substatement.
9762 (goto-char placeholder)
9764 ((eq char-after-ip ?{)
9765 (c-add-stmt-syntax 'substatement-open nil nil
9766 containing-sexp paren-state))
9768 (goto-char indent-point)
9769 (back-to-indentation)
9771 (c-add-stmt-syntax 'substatement-label nil nil
9772 containing-sexp paren-state))
9774 (c-add-stmt-syntax 'substatement nil nil
9775 containing-sexp paren-state))))
9777 ;; CASE 18B: Some other substatement. This is shared
9779 (c-guess-continued-construct indent-point
9785 ;; CASE 14: A case or default label
9786 ((looking-at c-label-kwds-regexp)
9789 (goto-char containing-sexp)
9790 (setq lim (c-most-enclosing-brace c-state-cache
9792 (c-backward-to-block-anchor lim)
9793 (c-add-stmt-syntax 'case-label nil t lim paren-state))
9794 ;; Got a bogus label at the top level. In lack of better
9795 ;; alternatives, anchor it on (point-min).
9796 (c-add-syntax 'case-label (point-min))))
9798 ;; CASE 15: any other label
9800 (back-to-indentation)
9801 (and (not (looking-at c-syntactic-ws-start))
9803 (cond (containing-decl-open
9804 (setq placeholder (c-add-class-syntax 'inclass
9805 containing-decl-open
9806 containing-decl-start
9809 ;; Append access-label with the same anchor point as
9811 (c-append-syntax 'access-label placeholder))
9814 (goto-char containing-sexp)
9815 (setq lim (c-most-enclosing-brace c-state-cache
9819 (if (and (eq (c-beginning-of-statement-1 lim) 'up)
9820 (looking-at "switch\\>[^_]"))
9821 ;; If the surrounding statement is a switch then
9822 ;; let's analyze all labels as switch labels, so
9823 ;; that they get lined up consistently.
9826 (c-backward-to-block-anchor lim)
9827 (c-add-stmt-syntax tmpsymbol nil t lim paren-state))
9830 ;; A label on the top level. Treat it as a class
9831 ;; context. (point-min) is the closest we get to the
9832 ;; class open brace.
9833 (c-add-syntax 'access-label (point-min)))))
9835 ;; CASE 4: In-expression statement. C.f. cases 7B, 16A and
9837 ((setq placeholder (c-looking-at-inexpr-block
9838 (c-safe-position containing-sexp paren-state)
9840 ;; Have to turn on the heuristics after
9841 ;; the point even though it doesn't work
9842 ;; very well. C.f. test case class-16.pike.
9844 (setq tmpsymbol (assq (car placeholder)
9845 '((inexpr-class . class-open)
9846 (inexpr-statement . block-open))))
9848 ;; It's a statement block or an anonymous class.
9849 (setq tmpsymbol (cdr tmpsymbol))
9850 ;; It's a Pike lambda. Check whether we are between the
9851 ;; lambda keyword and the argument list or at the defun
9853 (setq tmpsymbol (if (eq char-after-ip ?{)
9855 'lambda-intro-cont)))
9856 (goto-char (cdr placeholder))
9857 (back-to-indentation)
9858 (c-add-stmt-syntax tmpsymbol nil t
9859 (c-most-enclosing-brace c-state-cache (point))
9861 (unless (eq (point) (cdr placeholder))
9862 (c-add-syntax (car placeholder))))
9864 ;; CASE 5: Line is inside a declaration level block or at top level.
9865 ((or containing-decl-open (null containing-sexp))
9868 ;; CASE 5A: we are looking at a defun, brace list, class,
9869 ;; or inline-inclass method opening brace
9870 ((setq special-brace-list
9871 (or (and c-special-brace-lists
9872 (c-looking-at-special-brace-list))
9873 (eq char-after-ip ?{)))
9876 ;; CASE 5A.1: Non-class declaration block open.
9879 (and (eq char-after-ip ?{)
9880 (setq tmp (c-looking-at-decl-block containing-sexp t))
9882 (setq placeholder (point))
9884 (looking-at c-symbol-key))
9886 (c-keyword-sym (setq keyword (match-string 0)))
9887 'c-other-block-decl-kwds))))
9888 (goto-char placeholder)
9890 (if (string-equal keyword "extern")
9891 ;; Special case for extern-lang-open.
9893 (intern (concat keyword "-open")))
9894 nil t containing-sexp paren-state))
9896 ;; CASE 5A.2: we are looking at a class opening brace
9898 (goto-char indent-point)
9899 (skip-chars-forward " \t")
9900 (and (eq (char-after) ?{)
9901 (c-looking-at-decl-block containing-sexp t)
9902 (setq placeholder (point))))
9903 (c-add-syntax 'class-open placeholder))
9905 ;; CASE 5A.3: brace list open
9907 (c-beginning-of-decl-1 lim)
9908 (while (looking-at c-specifier-key)
9909 (goto-char (match-end 1))
9910 (c-forward-syntactic-ws indent-point))
9911 (setq placeholder (c-point 'boi))
9912 (or (consp special-brace-list)
9913 (and (or (save-excursion
9914 (goto-char indent-point)
9915 (setq tmpsymbol nil)
9916 (while (and (> (point) placeholder)
9917 (zerop (c-backward-token-2 1 t))
9918 (not (looking-at "=\\([^=]\\|$\\)")))
9919 (and c-opt-inexpr-brace-list-key
9921 (looking-at c-opt-inexpr-brace-list-key)
9922 (setq tmpsymbol 'topmost-intro-cont)))
9923 (looking-at "=\\([^=]\\|$\\)"))
9924 (looking-at c-brace-list-key))
9926 (while (and (< (point) indent-point)
9927 (zerop (c-forward-token-2 1 t))
9928 (not (memq (char-after) '(?\; ?\()))))
9929 (not (memq (char-after) '(?\; ?\()))
9931 (if (and (not c-auto-newline-analysis)
9932 (c-major-mode-is 'java-mode)
9933 (eq tmpsymbol 'topmost-intro-cont))
9934 ;; We're in Java and have found that the open brace
9935 ;; belongs to a "new Foo[]" initialization list,
9936 ;; which means the brace list is part of an
9937 ;; expression and not a top level definition. We
9938 ;; therefore treat it as any topmost continuation
9939 ;; even though the semantically correct symbol still
9940 ;; is brace-list-open, on the same grounds as in
9943 (c-beginning-of-statement-1 lim)
9944 (c-add-syntax 'topmost-intro-cont (c-point 'boi)))
9945 (c-add-syntax 'brace-list-open placeholder)))
9947 ;; CASE 5A.4: inline defun open
9948 ((and containing-decl-open
9949 (not (c-keyword-member containing-decl-kwd
9950 'c-other-block-decl-kwds)))
9951 (c-add-syntax 'inline-open)
9952 (c-add-class-syntax 'inclass
9953 containing-decl-open
9954 containing-decl-start
9958 ;; CASE 5A.5: ordinary defun open
9961 (c-beginning-of-decl-1 lim)
9962 (while (looking-at c-specifier-key)
9963 (goto-char (match-end 1))
9964 (c-forward-syntactic-ws indent-point))
9965 (c-add-syntax 'defun-open (c-point 'boi))
9966 ;; Bogus to use bol here, but it's the legacy. (Resolved,
9970 ;; CASE 5R: Member init list. (Used to be part of CASE 5B.1)
9971 ;; Note there is no limit on the backward search here, since member
9972 ;; init lists can, in practice, be very large.
9974 (when (setq placeholder (c-back-over-member-initializers))
9975 (setq tmp-pos (point))))
9976 (if (= (c-point 'bosws) (1+ tmp-pos))
9978 ;; There is no preceding member init clause.
9979 ;; Indent relative to the beginning of indentation
9980 ;; for the topmost-intro line that contains the
9981 ;; prototype's open paren.
9982 (goto-char placeholder)
9983 (c-add-syntax 'member-init-intro (c-point 'boi)))
9984 ;; Indent relative to the first member init clause.
9985 (goto-char (1+ tmp-pos))
9986 (c-forward-syntactic-ws)
9987 (c-add-syntax 'member-init-cont (point))))
9989 ;; CASE 5B: After a function header but before the body (or
9990 ;; the ending semicolon if there's no body).
9992 (when (setq placeholder (c-just-after-func-arglist-p
9993 (max lim (c-determine-limit 500))))
9994 (setq tmp-pos (point))))
9997 ;; CASE 5B.1: Member init list.
9998 ((eq (char-after tmp-pos) ?:)
9999 ;; There is no preceding member init clause.
10000 ;; Indent relative to the beginning of indentation
10001 ;; for the topmost-intro line that contains the
10002 ;; prototype's open paren.
10003 (goto-char placeholder)
10004 (c-add-syntax 'member-init-intro (c-point 'boi)))
10006 ;; CASE 5B.2: K&R arg decl intro
10007 ((and c-recognize-knr-p
10008 (c-in-knr-argdecl lim))
10009 (c-beginning-of-statement-1 lim)
10010 (c-add-syntax 'knr-argdecl-intro (c-point 'boi))
10011 (if containing-decl-open
10012 (c-add-class-syntax 'inclass
10013 containing-decl-open
10014 containing-decl-start
10015 containing-decl-kwd
10018 ;; CASE 5B.4: Nether region after a C++ or Java func
10019 ;; decl, which could include a `throws' declaration.
10021 (c-beginning-of-statement-1 lim)
10022 (c-add-syntax 'func-decl-cont (c-point 'boi))
10025 ;; CASE 5C: inheritance line. could be first inheritance
10026 ;; line, or continuation of a multiple inheritance
10027 ((or (and (c-major-mode-is 'c++-mode)
10029 (when (eq char-after-ip ?,)
10030 (skip-chars-forward " \t")
10032 (looking-at c-opt-postfix-decl-spec-key)))
10033 (and (or (eq char-before-ip ?:)
10034 ;; watch out for scope operator
10036 (and (eq char-after-ip ?:)
10037 (c-safe (forward-char 1) t)
10038 (not (eq (char-after) ?:))
10041 (c-beginning-of-statement-1 lim)
10042 (when (looking-at c-opt-<>-sexp-key)
10043 (goto-char (match-end 1))
10044 (c-forward-syntactic-ws)
10045 (c-forward-<>-arglist nil)
10046 (c-forward-syntactic-ws))
10047 (looking-at c-class-key)))
10049 (and (c-major-mode-is 'java-mode)
10050 (let ((fence (save-excursion
10051 (c-beginning-of-statement-1 lim)
10056 (cond ((looking-at c-opt-postfix-decl-spec-key)
10057 (setq injava-inher (cons cont (point))
10059 ((or (not (c-safe (c-forward-sexp -1) t))
10060 (<= (point) fence))
10065 (not (c-crosses-statement-barrier-p (cdr injava-inher)
10070 ;; CASE 5C.1: non-hanging colon on an inher intro
10071 ((eq char-after-ip ?:)
10072 (c-beginning-of-statement-1 lim)
10073 (c-add-syntax 'inher-intro (c-point 'boi))
10074 ;; don't add inclass symbol since relative point already
10075 ;; contains any class offset
10078 ;; CASE 5C.2: hanging colon on an inher intro
10079 ((eq char-before-ip ?:)
10080 (c-beginning-of-statement-1 lim)
10081 (c-add-syntax 'inher-intro (c-point 'boi))
10082 (if containing-decl-open
10083 (c-add-class-syntax 'inclass
10084 containing-decl-open
10085 containing-decl-start
10086 containing-decl-kwd
10089 ;; CASE 5C.3: in a Java implements/extends
10091 (let ((where (cdr injava-inher))
10092 (cont (car injava-inher)))
10094 (cond ((looking-at "throws\\>[^_]")
10095 (c-add-syntax 'func-decl-cont
10096 (progn (c-beginning-of-statement-1 lim)
10098 (cont (c-add-syntax 'inher-cont where))
10099 (t (c-add-syntax 'inher-intro
10100 (progn (goto-char (cdr injava-inher))
10101 (c-beginning-of-statement-1 lim)
10105 ;; CASE 5C.4: a continued inheritance line
10107 (c-beginning-of-inheritance-list lim)
10108 (c-add-syntax 'inher-cont (point))
10109 ;; don't add inclass symbol since relative point already
10110 ;; contains any class offset
10113 ;; CASE 5P: AWK pattern or function or continuation
10115 ((c-major-mode-is 'awk-mode)
10116 (setq placeholder (point))
10118 (if (and (eq (c-beginning-of-statement-1) 'same)
10119 (/= (point) placeholder))
10120 'topmost-intro-cont
10123 containing-sexp paren-state))
10125 ;; CASE 5D: this could be a top-level initialization, a
10126 ;; member init list continuation, or a template argument
10127 ;; list continuation.
10129 ;; Note: We use the fact that lim is always after any
10130 ;; preceding brace sexp.
10131 (if c-recognize-<>-arglists
10134 (c-syntactic-skip-backward "^;,=<>" lim t)
10137 (when c-overloadable-operators-regexp
10138 (when (setq placeholder (c-after-special-operator-id lim))
10139 (goto-char placeholder)
10142 ((eq (char-before) ?>)
10143 (or (c-backward-<>-arglist nil lim)
10146 ((eq (char-before) ?<)
10148 (if (save-excursion
10149 (c-forward-<>-arglist nil))
10150 (progn (forward-char)
10154 ;; NB: No c-after-special-operator-id stuff in this
10155 ;; clause - we assume only C++ needs it.
10156 (c-syntactic-skip-backward "^;,=" lim t))
10157 (memq (char-before) '(?, ?= ?<)))
10160 ;; CASE 5D.3: perhaps a template list continuation?
10161 ((and (c-major-mode-is 'c++-mode)
10164 (c-with-syntax-table c++-template-syntax-table
10165 (goto-char indent-point)
10166 (setq placeholder (c-up-list-backward))
10168 (eq (char-after placeholder) ?<))))))
10169 (c-with-syntax-table c++-template-syntax-table
10170 (goto-char placeholder)
10171 (c-beginning-of-statement-1 lim t))
10172 (if (save-excursion
10173 (c-backward-syntactic-ws lim)
10174 (eq (char-before) ?<))
10175 ;; In a nested template arglist.
10177 (goto-char placeholder)
10178 (c-syntactic-skip-backward "^,;" lim t)
10179 (c-forward-syntactic-ws))
10180 (back-to-indentation))
10181 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
10183 (c-add-syntax 'template-args-cont (point) placeholder))
10185 ;; CASE 5D.4: perhaps a multiple inheritance line?
10186 ((and (c-major-mode-is 'c++-mode)
10188 (c-beginning-of-statement-1 lim)
10189 (setq placeholder (point))
10190 (if (looking-at "static\\>[^_]")
10191 (c-forward-token-2 1 nil indent-point))
10192 (and (looking-at c-class-key)
10193 (zerop (c-forward-token-2 2 nil indent-point))
10194 (if (eq (char-after) ?<)
10195 (c-with-syntax-table c++-template-syntax-table
10196 (zerop (c-forward-token-2 1 t indent-point)))
10198 (eq (char-after) ?:))))
10199 (goto-char placeholder)
10200 (c-add-syntax 'inher-cont (c-point 'boi)))
10202 ;; CASE 5D.5: Continuation of the "expression part" of a
10203 ;; top level construct. Or, perhaps, an unrecognized construct.
10205 (while (and (setq placeholder (point))
10206 (eq (car (c-beginning-of-decl-1 containing-sexp)) ; Can't use `lim' here.
10209 (c-backward-syntactic-ws)
10210 (eq (char-before) ?}))
10211 (< (point) placeholder)))
10214 ((eq (point) placeholder) 'statement) ; unrecognized construct
10215 ;; A preceding comma at the top level means that a
10216 ;; new variable declaration starts here. Use
10217 ;; topmost-intro-cont for it, for consistency with
10218 ;; the first variable declaration. C.f. case 5N.
10219 ((eq char-before-ip ?,) 'topmost-intro-cont)
10220 (t 'statement-cont))
10221 nil nil containing-sexp paren-state))
10224 ;; CASE 5F: Close of a non-class declaration level block.
10225 ((and (eq char-after-ip ?})
10226 (c-keyword-member containing-decl-kwd
10227 'c-other-block-decl-kwds))
10228 ;; This is inconsistent: Should use `containing-decl-open'
10229 ;; here if it's at boi, like in case 5J.
10230 (goto-char containing-decl-start)
10232 (if (string-equal (symbol-name containing-decl-kwd) "extern")
10233 ;; Special case for compatibility with the
10234 ;; extern-lang syntactic symbols.
10236 (intern (concat (symbol-name containing-decl-kwd)
10239 (c-most-enclosing-brace paren-state (point))
10242 ;; CASE 5G: we are looking at the brace which closes the
10243 ;; enclosing nested class decl
10244 ((and containing-sexp
10245 (eq char-after-ip ?})
10246 (eq containing-decl-open containing-sexp))
10247 (c-add-class-syntax 'class-close
10248 containing-decl-open
10249 containing-decl-start
10250 containing-decl-kwd
10253 ;; CASE 5H: we could be looking at subsequent knr-argdecls
10254 ((and c-recognize-knr-p
10255 (not containing-sexp) ; can't be knr inside braces.
10256 (not (eq char-before-ip ?}))
10258 (setq placeholder (cdr (c-beginning-of-decl-1 lim)))
10260 ;; Do an extra check to avoid tripping up on
10261 ;; statements that occur in invalid contexts
10262 ;; (e.g. in macro bodies where we don't really
10263 ;; know the context of what we're looking at).
10264 (not (and c-opt-block-stmt-key
10265 (looking-at c-opt-block-stmt-key)))))
10266 (< placeholder indent-point))
10267 (goto-char placeholder)
10268 (c-add-syntax 'knr-argdecl (point)))
10270 ;; CASE 5I: ObjC method definition.
10271 ((and c-opt-method-key
10272 (looking-at c-opt-method-key))
10273 (c-beginning-of-statement-1 nil t)
10274 (if (= (point) indent-point)
10275 ;; Handle the case when it's the first (non-comment)
10276 ;; thing in the buffer. Can't look for a 'same return
10277 ;; value from cbos1 since ObjC directives currently
10278 ;; aren't recognized fully, so that we get 'same
10279 ;; instead of 'previous if it moved over a preceding
10281 (goto-char (point-min)))
10282 (c-add-syntax 'objc-method-intro (c-point 'boi)))
10284 ;; CASE 5N: At a variable declaration that follows a class
10285 ;; definition or some other block declaration that doesn't
10286 ;; end at the closing '}'. C.f. case 5D.5.
10288 (c-backward-syntactic-ws lim)
10289 (and (eq (char-before) ?})
10291 (let ((start (point)))
10292 (if (and c-state-cache
10293 (consp (car c-state-cache))
10294 (eq (cdar c-state-cache) (point)))
10295 ;; Speed up the backward search a bit.
10296 (goto-char (caar c-state-cache)))
10297 (c-beginning-of-decl-1 containing-sexp) ; Can't use `lim' here.
10298 (setq placeholder (point))
10299 (if (= start (point))
10300 ;; The '}' is unbalanced.
10303 (>= (point) indent-point))))))
10304 (goto-char placeholder)
10305 (c-add-stmt-syntax 'topmost-intro-cont nil nil
10306 containing-sexp paren-state))
10308 ;; NOTE: The point is at the end of the previous token here.
10310 ;; CASE 5J: we are at the topmost level, make
10311 ;; sure we skip back past any access specifiers
10313 ;; A macro continuation line is never at top level.
10314 (not (and macro-start
10315 (> indent-point macro-start)))
10317 (setq placeholder (point))
10318 (or (memq char-before-ip '(?\; ?{ ?} nil))
10319 (c-at-vsemi-p before-ws-ip)
10320 (when (and (eq char-before-ip ?:)
10321 (eq (c-beginning-of-statement-1 lim)
10323 (c-backward-syntactic-ws lim)
10324 (setq placeholder (point)))
10325 (and (c-major-mode-is 'objc-mode)
10326 (catch 'not-in-directive
10327 (c-beginning-of-statement-1 lim)
10328 (setq placeholder (point))
10329 (while (and (c-forward-objc-directive)
10330 (< (point) indent-point))
10331 (c-forward-syntactic-ws)
10332 (if (>= (point) indent-point)
10333 (throw 'not-in-directive t))
10334 (setq placeholder (point)))
10336 ;; For historic reasons we anchor at bol of the last
10337 ;; line of the previous declaration. That's clearly
10338 ;; highly bogus and useless, and it makes our lives hard
10339 ;; to remain compatible. :P
10340 (goto-char placeholder)
10341 (c-add-syntax 'topmost-intro (c-point 'bol))
10342 (if containing-decl-open
10343 (if (c-keyword-member containing-decl-kwd
10344 'c-other-block-decl-kwds)
10346 (goto-char (c-brace-anchor-point containing-decl-open))
10348 (if (string-equal (symbol-name containing-decl-kwd)
10350 ;; Special case for compatibility with the
10351 ;; extern-lang syntactic symbols.
10353 (intern (concat "in"
10354 (symbol-name containing-decl-kwd))))
10356 (c-most-enclosing-brace paren-state (point))
10358 (c-add-class-syntax 'inclass
10359 containing-decl-open
10360 containing-decl-start
10361 containing-decl-kwd
10363 (when (and c-syntactic-indentation-in-macros
10365 (/= macro-start (c-point 'boi indent-point)))
10366 (c-add-syntax 'cpp-define-intro)
10367 (setq macro-start nil)))
10369 ;; CASE 5K: we are at an ObjC method definition
10370 ;; continuation line.
10371 ((and c-opt-method-key
10373 (c-beginning-of-statement-1 lim)
10374 (beginning-of-line)
10375 (when (looking-at c-opt-method-key)
10376 (setq placeholder (point)))))
10377 (c-add-syntax 'objc-method-args-cont placeholder))
10379 ;; CASE 5L: we are at the first argument of a template
10380 ;; arglist that begins on the previous line.
10381 ((and c-recognize-<>-arglists
10382 (eq (char-before) ?<)
10383 (not (and c-overloadable-operators-regexp
10384 (c-after-special-operator-id lim))))
10385 (c-beginning-of-statement-1 (c-safe-position (point) paren-state))
10386 (c-add-syntax 'template-args-cont (c-point 'boi)))
10388 ;; CASE 5Q: we are at a statement within a macro.
10390 (c-beginning-of-statement-1 containing-sexp)
10391 (c-add-stmt-syntax 'statement nil t containing-sexp paren-state))
10393 ;;CASE 5N: We are at a topmost continuation line and the only
10394 ;;preceding items are annotations.
10395 ((and (c-major-mode-is 'java-mode)
10396 (setq placeholder (point))
10397 (c-beginning-of-statement-1)
10399 (while (and (c-forward-annotation))
10400 (c-forward-syntactic-ws))
10403 (>= (point) placeholder)
10404 (goto-char placeholder)))
10405 (c-add-syntax 'annotation-top-cont (c-point 'boi)))
10407 ;; CASE 5M: we are at a topmost continuation line
10409 (c-beginning-of-statement-1 (c-safe-position (point) paren-state))
10410 (when (c-major-mode-is 'objc-mode)
10411 (setq placeholder (point))
10412 (while (and (c-forward-objc-directive)
10413 (< (point) indent-point))
10414 (c-forward-syntactic-ws)
10415 (setq placeholder (point)))
10416 (goto-char placeholder))
10417 (c-add-syntax 'topmost-intro-cont (c-point 'boi)))
10420 ;; (CASE 6 has been removed.)
10422 ;; CASE 7: line is an expression, not a statement. Most
10423 ;; likely we are either in a function prototype or a function
10424 ;; call argument list
10425 ((not (or (and c-special-brace-lists
10427 (goto-char containing-sexp)
10428 (c-looking-at-special-brace-list)))
10429 (eq (char-after containing-sexp) ?{)))
10432 ;; CASE 7A: we are looking at the arglist closing paren.
10434 ((memq char-after-ip '(?\) ?\]))
10435 (goto-char containing-sexp)
10436 (setq placeholder (c-point 'boi))
10437 (if (and (c-safe (backward-up-list 1) t)
10438 (>= (point) placeholder))
10441 (skip-chars-forward " \t"))
10442 (goto-char placeholder))
10443 (c-add-stmt-syntax 'arglist-close (list containing-sexp) t
10444 (c-most-enclosing-brace paren-state (point))
10447 ;; CASE 7B: Looking at the opening brace of an
10448 ;; in-expression block or brace list. C.f. cases 4, 16A
10450 ((and (eq char-after-ip ?{)
10452 (setq placeholder (c-inside-bracelist-p (point)
10455 (setq tmpsymbol '(brace-list-open . inexpr-class))
10456 (setq tmpsymbol '(block-open . inexpr-statement)
10458 (cdr-safe (c-looking-at-inexpr-block
10459 (c-safe-position containing-sexp
10462 ;; placeholder is nil if it's a block directly in
10463 ;; a function arglist. That makes us skip out of
10466 (goto-char placeholder)
10467 (back-to-indentation)
10468 (c-add-stmt-syntax (car tmpsymbol) nil t
10469 (c-most-enclosing-brace paren-state (point))
10471 (if (/= (point) placeholder)
10472 (c-add-syntax (cdr tmpsymbol))))
10474 ;; CASE 7C: we are looking at the first argument in an empty
10475 ;; argument list. Use arglist-close if we're actually
10476 ;; looking at a close paren or bracket.
10477 ((memq char-before-ip '(?\( ?\[))
10478 (goto-char containing-sexp)
10479 (setq placeholder (c-point 'boi))
10480 (if (and (c-safe (backward-up-list 1) t)
10481 (>= (point) placeholder))
10484 (skip-chars-forward " \t"))
10485 (goto-char placeholder))
10486 (c-add-stmt-syntax 'arglist-intro (list containing-sexp) t
10487 (c-most-enclosing-brace paren-state (point))
10490 ;; CASE 7D: we are inside a conditional test clause. treat
10491 ;; these things as statements
10493 (goto-char containing-sexp)
10494 (and (c-safe (c-forward-sexp -1) t)
10495 (looking-at "\\<for\\>[^_]")))
10496 (goto-char (1+ containing-sexp))
10497 (c-forward-syntactic-ws indent-point)
10498 (if (eq char-before-ip ?\;)
10499 (c-add-syntax 'statement (point))
10500 (c-add-syntax 'statement-cont (point))
10503 ;; CASE 7E: maybe a continued ObjC method call. This is the
10504 ;; case when we are inside a [] bracketed exp, and what
10505 ;; precede the opening bracket is not an identifier.
10506 ((and c-opt-method-key
10507 (eq (char-after containing-sexp) ?\[)
10509 (goto-char (1- containing-sexp))
10510 (c-backward-syntactic-ws (c-point 'bod))
10511 (if (not (looking-at c-symbol-key))
10512 (c-add-syntax 'objc-method-call-cont containing-sexp))
10515 ;; CASE 7F: we are looking at an arglist continuation line,
10516 ;; but the preceding argument is on the same line as the
10517 ;; opening paren. This case includes multi-line
10518 ;; mathematical paren groupings, but we could be on a
10519 ;; for-list continuation line. C.f. case 7A.
10521 (goto-char (1+ containing-sexp))
10523 (c-forward-syntactic-ws)
10526 (goto-char containing-sexp) ; paren opening the arglist
10527 (setq placeholder (c-point 'boi))
10528 (if (and (c-safe (backward-up-list 1) t)
10529 (>= (point) placeholder))
10532 (skip-chars-forward " \t"))
10533 (goto-char placeholder))
10534 (c-add-stmt-syntax 'arglist-cont-nonempty (list containing-sexp) t
10535 (c-most-enclosing-brace c-state-cache (point))
10538 ;; CASE 7G: we are looking at just a normal arglist
10539 ;; continuation line
10540 (t (c-forward-syntactic-ws indent-point)
10541 (c-add-syntax 'arglist-cont (c-point 'boi)))
10544 ;; CASE 8: func-local multi-inheritance line
10545 ((and (c-major-mode-is 'c++-mode)
10547 (goto-char indent-point)
10548 (skip-chars-forward " \t")
10549 (looking-at c-opt-postfix-decl-spec-key)))
10550 (goto-char indent-point)
10551 (skip-chars-forward " \t")
10554 ;; CASE 8A: non-hanging colon on an inher intro
10555 ((eq char-after-ip ?:)
10556 (c-backward-syntactic-ws lim)
10557 (c-add-syntax 'inher-intro (c-point 'boi)))
10559 ;; CASE 8B: hanging colon on an inher intro
10560 ((eq char-before-ip ?:)
10561 (c-add-syntax 'inher-intro (c-point 'boi)))
10563 ;; CASE 8C: a continued inheritance line
10565 (c-beginning-of-inheritance-list lim)
10566 (c-add-syntax 'inher-cont (point))
10569 ;; CASE 9: we are inside a brace-list
10570 ((and (not (c-major-mode-is 'awk-mode)) ; Maybe this isn't needed (ACM, 2002/3/29)
10571 (setq special-brace-list
10572 (or (and c-special-brace-lists ;;;; ALWAYS NIL FOR AWK!!
10574 (goto-char containing-sexp)
10575 (c-looking-at-special-brace-list)))
10576 (c-inside-bracelist-p containing-sexp paren-state))))
10579 ;; CASE 9A: In the middle of a special brace list opener.
10580 ((and (consp special-brace-list)
10582 (goto-char containing-sexp)
10583 (eq (char-after) ?\())
10584 (eq char-after-ip (car (cdr special-brace-list))))
10585 (goto-char (car (car special-brace-list)))
10586 (skip-chars-backward " \t")
10588 (assoc 'statement-cont
10589 (setq placeholder (c-guess-basic-syntax))))
10590 (setq c-syntactic-context placeholder)
10591 (c-beginning-of-statement-1
10592 (c-safe-position (1- containing-sexp) paren-state))
10593 (c-forward-token-2 0)
10594 (while (looking-at c-specifier-key)
10595 (goto-char (match-end 1))
10596 (c-forward-syntactic-ws))
10597 (c-add-syntax 'brace-list-open (c-point 'boi))))
10599 ;; CASE 9B: brace-list-close brace
10600 ((if (consp special-brace-list)
10601 ;; Check special brace list closer.
10603 (goto-char (car (car special-brace-list)))
10605 (goto-char indent-point)
10606 (back-to-indentation)
10608 ;; We were between the special close char and the `)'.
10609 (and (eq (char-after) ?\))
10610 (eq (1+ (point)) (cdr (car special-brace-list))))
10611 ;; We were before the special close char.
10612 (and (eq (char-after) (cdr (cdr special-brace-list)))
10613 (zerop (c-forward-token-2))
10614 (eq (1+ (point)) (cdr (car special-brace-list)))))))
10615 ;; Normal brace list check.
10616 (and (eq char-after-ip ?})
10617 (c-safe (goto-char (c-up-list-backward (point))) t)
10618 (= (point) containing-sexp)))
10619 (if (eq (point) (c-point 'boi))
10620 (c-add-syntax 'brace-list-close (point))
10621 (setq lim (c-most-enclosing-brace c-state-cache (point)))
10622 (c-beginning-of-statement-1 lim nil nil t)
10623 (c-add-stmt-syntax 'brace-list-close nil t lim paren-state)))
10626 ;; Prepare for the rest of the cases below by going to the
10627 ;; token following the opening brace
10628 (if (consp special-brace-list)
10630 (goto-char (car (car special-brace-list)))
10631 (c-forward-token-2 1 nil indent-point))
10632 (goto-char containing-sexp))
10634 (let ((start (point)))
10635 (c-forward-syntactic-ws indent-point)
10636 (goto-char (max start (c-point 'bol))))
10637 (c-skip-ws-forward indent-point)
10640 ;; CASE 9C: we're looking at the first line in a brace-list
10641 ((= (point) indent-point)
10642 (if (consp special-brace-list)
10643 (goto-char (car (car special-brace-list)))
10644 (goto-char containing-sexp))
10645 (if (eq (point) (c-point 'boi))
10646 (c-add-syntax 'brace-list-intro (point))
10647 (setq lim (c-most-enclosing-brace c-state-cache (point)))
10648 (c-beginning-of-statement-1 lim)
10649 (c-add-stmt-syntax 'brace-list-intro nil t lim paren-state)))
10651 ;; CASE 9D: this is just a later brace-list-entry or
10652 ;; brace-entry-open
10653 (t (if (or (eq char-after-ip ?{)
10654 (and c-special-brace-lists
10656 (goto-char indent-point)
10657 (c-forward-syntactic-ws (c-point 'eol))
10658 (c-looking-at-special-brace-list (point)))))
10659 (c-add-syntax 'brace-entry-open (point))
10660 (c-add-syntax 'brace-list-entry (point))
10664 ;; CASE 10: A continued statement or top level construct.
10665 ((and (not (memq char-before-ip '(?\; ?:)))
10666 (not (c-at-vsemi-p before-ws-ip))
10667 (or (not (eq char-before-ip ?}))
10668 (c-looking-at-inexpr-block-backward c-state-cache))
10671 (c-beginning-of-statement-1 containing-sexp)
10672 (setq placeholder (point))))
10673 (/= placeholder containing-sexp))
10674 ;; This is shared with case 18.
10675 (c-guess-continued-construct indent-point
10681 ;; CASE 16: block close brace, possibly closing the defun or
10683 ((eq char-after-ip ?})
10684 ;; From here on we have the next containing sexp in lim.
10685 (setq lim (c-most-enclosing-brace paren-state))
10686 (goto-char containing-sexp)
10689 ;; CASE 16E: Closing a statement block? This catches
10690 ;; cases where it's preceded by a statement keyword,
10691 ;; which works even when used in an "invalid" context,
10692 ;; e.g. a macro argument.
10693 ((c-after-conditional)
10694 (c-backward-to-block-anchor lim)
10695 (c-add-stmt-syntax 'block-close nil t lim paren-state))
10697 ;; CASE 16A: closing a lambda defun or an in-expression
10698 ;; block? C.f. cases 4, 7B and 17E.
10699 ((setq placeholder (c-looking-at-inexpr-block
10700 (c-safe-position containing-sexp paren-state)
10702 (setq tmpsymbol (if (eq (car placeholder) 'inlambda)
10705 (goto-char containing-sexp)
10706 (back-to-indentation)
10707 (if (= containing-sexp (point))
10708 (c-add-syntax tmpsymbol (point))
10709 (goto-char (cdr placeholder))
10710 (back-to-indentation)
10711 (c-add-stmt-syntax tmpsymbol nil t
10712 (c-most-enclosing-brace paren-state (point))
10714 (if (/= (point) (cdr placeholder))
10715 (c-add-syntax (car placeholder)))))
10717 ;; CASE 16B: does this close an inline or a function in
10718 ;; a non-class declaration level block?
10723 (c-looking-at-decl-block
10724 (c-most-enclosing-brace paren-state lim)
10726 (setq placeholder (point))))
10727 (c-backward-to-decl-anchor lim)
10728 (back-to-indentation)
10729 (if (save-excursion
10730 (goto-char placeholder)
10731 (looking-at c-other-decl-block-key))
10732 (c-add-syntax 'defun-close (point))
10733 (c-add-syntax 'inline-close (point))))
10735 ;; CASE 16F: Can be a defun-close of a function declared
10736 ;; in a statement block, e.g. in Pike or when using gcc
10737 ;; extensions, but watch out for macros followed by
10738 ;; blocks. Let it through to be handled below.
10739 ;; C.f. cases B.3 and 17G.
10741 (and (not (c-at-statement-start-p))
10742 (eq (c-beginning-of-statement-1 lim nil nil t) 'same)
10743 (setq placeholder (point))
10744 (let ((c-recognize-typeless-decls nil))
10745 ;; Turn off recognition of constructs that
10746 ;; lacks a type in this case, since that's more
10747 ;; likely to be a macro followed by a block.
10748 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
10749 (back-to-indentation)
10750 (if (/= (point) containing-sexp)
10751 (goto-char placeholder))
10752 (c-add-stmt-syntax 'defun-close nil t lim paren-state))
10754 ;; CASE 16C: If there is an enclosing brace then this is
10755 ;; a block close since defun closes inside declaration
10756 ;; level blocks have been handled above.
10758 ;; If the block is preceded by a case/switch label on
10759 ;; the same line, we anchor at the first preceding label
10760 ;; at boi. The default handling in c-add-stmt-syntax
10761 ;; really fixes it better, but we do like this to keep
10762 ;; the indentation compatible with version 5.28 and
10763 ;; earlier. C.f. case 17H.
10764 (while (and (/= (setq placeholder (point)) (c-point 'boi))
10765 (eq (c-beginning-of-statement-1 lim) 'label)))
10766 (goto-char placeholder)
10767 (if (looking-at c-label-kwds-regexp)
10768 (c-add-syntax 'block-close (point))
10769 (goto-char containing-sexp)
10770 ;; c-backward-to-block-anchor not necessary here; those
10771 ;; situations are handled in case 16E above.
10772 (c-add-stmt-syntax 'block-close nil t lim paren-state)))
10774 ;; CASE 16D: Only top level defun close left.
10776 (goto-char containing-sexp)
10777 (c-backward-to-decl-anchor lim)
10778 (c-add-stmt-syntax 'defun-close nil nil
10779 (c-most-enclosing-brace paren-state)
10783 ;; CASE 19: line is an expression, not a statement, and is directly
10784 ;; contained by a template delimiter. Most likely, we are in a
10785 ;; template arglist within a statement. This case is based on CASE
10786 ;; 7. At some point in the future, we may wish to create more
10787 ;; syntactic symbols such as `template-intro',
10788 ;; `template-cont-nonempty', etc., and distinguish between them as we
10789 ;; do for `arglist-intro' etc. (2009-12-07).
10790 ((and c-recognize-<>-arglists
10791 (setq containing-< (c-up-list-backward indent-point containing-sexp))
10792 (eq (char-after containing-<) ?\<))
10793 (setq placeholder (c-point 'boi containing-<))
10794 (goto-char containing-sexp) ; Most nested Lbrace/Lparen (but not
10795 ; '<') before indent-point.
10796 (if (>= (point) placeholder)
10799 (skip-chars-forward " \t"))
10800 (goto-char placeholder))
10801 (c-add-stmt-syntax 'template-args-cont (list containing-<) t
10802 (c-most-enclosing-brace c-state-cache (point))
10805 ;; CASE 17: Statement or defun catchall.
10807 (goto-char indent-point)
10808 ;; Back up statements until we find one that starts at boi.
10809 (while (let* ((prev-point (point))
10810 (last-step-type (c-beginning-of-statement-1
10812 (if (= (point) prev-point)
10814 (setq step-type (or step-type last-step-type))
10816 (setq step-type last-step-type)
10817 (/= (point) (c-point 'boi)))))
10820 ;; CASE 17B: continued statement
10821 ((and (eq step-type 'same)
10822 (/= (point) indent-point))
10823 (c-add-stmt-syntax 'statement-cont nil nil
10824 containing-sexp paren-state))
10826 ;; CASE 17A: After a case/default label?
10828 (while (and (eq step-type 'label)
10829 (not (looking-at c-label-kwds-regexp)))
10831 (c-beginning-of-statement-1 containing-sexp)))
10832 (eq step-type 'label))
10833 (c-add-stmt-syntax (if (eq char-after-ip ?{)
10834 'statement-case-open
10835 'statement-case-intro)
10836 nil t containing-sexp paren-state))
10838 ;; CASE 17D: any old statement
10840 (while (eq step-type 'label)
10842 (c-beginning-of-statement-1 containing-sexp)))
10843 (eq step-type 'previous))
10844 (c-add-stmt-syntax 'statement nil t
10845 containing-sexp paren-state)
10846 (if (eq char-after-ip ?{)
10847 (c-add-syntax 'block-open)))
10849 ;; CASE 17I: Inside a substatement block.
10851 ;; The following tests are all based on containing-sexp.
10852 (goto-char containing-sexp)
10853 ;; From here on we have the next containing sexp in lim.
10854 (setq lim (c-most-enclosing-brace paren-state containing-sexp))
10855 (c-after-conditional))
10856 (c-backward-to-block-anchor lim)
10857 (c-add-stmt-syntax 'statement-block-intro nil t
10859 (if (eq char-after-ip ?{)
10860 (c-add-syntax 'block-open)))
10862 ;; CASE 17E: first statement in an in-expression block.
10863 ;; C.f. cases 4, 7B and 16A.
10864 ((setq placeholder (c-looking-at-inexpr-block
10865 (c-safe-position containing-sexp paren-state)
10867 (setq tmpsymbol (if (eq (car placeholder) 'inlambda)
10869 'statement-block-intro))
10870 (back-to-indentation)
10871 (if (= containing-sexp (point))
10872 (c-add-syntax tmpsymbol (point))
10873 (goto-char (cdr placeholder))
10874 (back-to-indentation)
10875 (c-add-stmt-syntax tmpsymbol nil t
10876 (c-most-enclosing-brace c-state-cache (point))
10878 (if (/= (point) (cdr placeholder))
10879 (c-add-syntax (car placeholder))))
10880 (if (eq char-after-ip ?{)
10881 (c-add-syntax 'block-open)))
10883 ;; CASE 17F: first statement in an inline, or first
10884 ;; statement in a top-level defun. we can tell this is it
10885 ;; if there are no enclosing braces that haven't been
10886 ;; narrowed out by a class (i.e. don't use bod here).
10888 (or (not (setq placeholder (c-most-enclosing-brace
10891 (goto-char placeholder)
10892 (eq (char-after) ?{))
10893 (c-looking-at-decl-block (c-most-enclosing-brace
10894 paren-state (point))
10896 (c-backward-to-decl-anchor lim)
10897 (back-to-indentation)
10898 (c-add-syntax 'defun-block-intro (point)))
10900 ;; CASE 17G: First statement in a function declared inside
10901 ;; a normal block. This can occur in Pike and with
10902 ;; e.g. the gcc extensions, but watch out for macros
10903 ;; followed by blocks. C.f. cases B.3 and 16F.
10905 (and (not (c-at-statement-start-p))
10906 (eq (c-beginning-of-statement-1 lim nil nil t) 'same)
10907 (setq placeholder (point))
10908 (let ((c-recognize-typeless-decls nil))
10909 ;; Turn off recognition of constructs that lacks
10910 ;; a type in this case, since that's more likely
10911 ;; to be a macro followed by a block.
10912 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
10913 (back-to-indentation)
10914 (if (/= (point) containing-sexp)
10915 (goto-char placeholder))
10916 (c-add-stmt-syntax 'defun-block-intro nil t
10919 ;; CASE 17H: First statement in a block.
10921 ;; If the block is preceded by a case/switch label on the
10922 ;; same line, we anchor at the first preceding label at
10923 ;; boi. The default handling in c-add-stmt-syntax is
10924 ;; really fixes it better, but we do like this to keep the
10925 ;; indentation compatible with version 5.28 and earlier.
10927 (while (and (/= (setq placeholder (point)) (c-point 'boi))
10928 (eq (c-beginning-of-statement-1 lim) 'label)))
10929 (goto-char placeholder)
10930 (if (looking-at c-label-kwds-regexp)
10931 (c-add-syntax 'statement-block-intro (point))
10932 (goto-char containing-sexp)
10933 ;; c-backward-to-block-anchor not necessary here; those
10934 ;; situations are handled in case 17I above.
10935 (c-add-stmt-syntax 'statement-block-intro nil t
10937 (if (eq char-after-ip ?{)
10938 (c-add-syntax 'block-open)))
10942 ;; now we need to look at any modifiers
10943 (goto-char indent-point)
10944 (skip-chars-forward " \t")
10946 ;; are we looking at a comment only line?
10947 (when (and (looking-at c-comment-start-regexp)
10948 (/= (c-forward-token-2 0 nil (c-point 'eol)) 0))
10949 (c-append-syntax 'comment-intro))
10951 ;; we might want to give additional offset to friends (in C++).
10952 (when (and c-opt-friend-key
10953 (looking-at c-opt-friend-key))
10954 (c-append-syntax 'friend))
10956 ;; Set syntactic-relpos.
10957 (let ((p c-syntactic-context))
10959 (if (integerp (c-langelem-pos (car p)))
10961 (setq syntactic-relpos (c-langelem-pos (car p)))
10966 ;; Start of or a continuation of a preprocessor directive?
10967 (if (and macro-start
10968 (eq macro-start (c-point 'boi))
10969 (not (and (c-major-mode-is 'pike-mode)
10970 (eq (char-after (1+ macro-start)) ?\"))))
10971 (c-append-syntax 'cpp-macro)
10972 (when (and c-syntactic-indentation-in-macros macro-start)
10975 (< syntactic-relpos macro-start)
10977 (assq 'arglist-intro c-syntactic-context)
10978 (assq 'arglist-cont c-syntactic-context)
10979 (assq 'arglist-cont-nonempty c-syntactic-context)
10980 (assq 'arglist-close c-syntactic-context))))
10981 ;; If inside a cpp expression, i.e. anywhere in a
10982 ;; cpp directive except a #define body, we only let
10983 ;; through the syntactic analysis that is internal
10984 ;; in the expression. That means the arglist
10985 ;; elements, if they are anchored inside the cpp
10987 (setq c-syntactic-context nil)
10988 (c-add-syntax 'cpp-macro-cont macro-start))
10989 (when (and (eq macro-start syntactic-relpos)
10990 (not (assq 'cpp-define-intro c-syntactic-context))
10992 (goto-char macro-start)
10993 (or (not (c-forward-to-cpp-define-body))
10994 (<= (point) (c-point 'boi indent-point)))))
10995 ;; Inside a #define body and the syntactic analysis is
10996 ;; anchored on the start of the #define. In this case
10997 ;; we add cpp-define-intro to get the extra
10998 ;; indentation of the #define body.
10999 (c-add-syntax 'cpp-define-intro)))))
11001 ;; return the syntax
11002 c-syntactic-context)))
11005 ;; Indentation calculation.
11007 (defun c-evaluate-offset (offset langelem symbol)
11008 ;; offset can be a number, a function, a variable, a list, or one of
11009 ;; the symbols + or -
11011 ;; This function might do hidden buffer changes.
11014 ((numberp offset) offset)
11015 ((vectorp offset) offset)
11016 ((null offset) nil)
11018 ((eq offset '+) c-basic-offset)
11019 ((eq offset '-) (- c-basic-offset))
11020 ((eq offset '++) (* 2 c-basic-offset))
11021 ((eq offset '--) (* 2 (- c-basic-offset)))
11022 ((eq offset '*) (/ c-basic-offset 2))
11023 ((eq offset '/) (/ (- c-basic-offset) 2))
11025 ((functionp offset)
11028 (cons (c-langelem-sym langelem)
11029 (c-langelem-pos langelem)))
11034 ((eq (car offset) 'quote)
11035 (c-benign-error "The offset %S for %s was mistakenly quoted"
11039 ((memq (car offset) '(min max))
11040 (let (res val (method (car offset)))
11041 (setq offset (cdr offset))
11043 (setq val (c-evaluate-offset (car offset) langelem symbol))
11051 Error evaluating offset %S for %s: \
11052 Cannot combine absolute offset %S with relative %S in `%s' method"
11053 (car offset) symbol res val method)
11054 (setq res (funcall method res val))))
11058 Error evaluating offset %S for %s: \
11059 Cannot combine relative offset %S with absolute %S in `%s' method"
11060 (car offset) symbol res val method)
11061 (setq res (vector (funcall method (aref res 0)
11063 (setq offset (cdr offset)))
11066 ((eq (car offset) 'add)
11068 (setq offset (cdr offset))
11070 (setq val (c-evaluate-offset (car offset) langelem symbol))
11077 (setq res (vector (+ (aref res 0) val)))
11078 (setq res (+ res val))))
11082 Error evaluating offset %S for %s: \
11083 Cannot combine absolute offsets %S and %S in `add' method"
11084 (car offset) symbol res val)
11085 (setq res val)))) ; Override.
11086 (setq offset (cdr offset)))
11091 (when (eq (car offset) 'first)
11092 (setq offset (cdr offset)))
11093 (while (and (not res) offset)
11094 (setq res (c-evaluate-offset (car offset) langelem symbol)
11095 offset (cdr offset)))
11098 ((and (symbolp offset) (boundp offset))
11099 (symbol-value offset))
11102 (c-benign-error "Unknown offset format %S for %s" offset symbol)
11105 (if (or (null res) (integerp res)
11106 (and (vectorp res) (= (length res) 1) (integerp (aref res 0))))
11108 (c-benign-error "Error evaluating offset %S for %s: Got invalid value %S"
11112 (defun c-calc-offset (langelem)
11113 ;; Get offset from LANGELEM which is a list beginning with the
11114 ;; syntactic symbol and followed by any analysis data it provides.
11115 ;; That data may be zero or more elements, but if at least one is
11116 ;; given then the first is the anchor position (or nil). The symbol
11117 ;; is matched against `c-offsets-alist' and the offset calculated
11118 ;; from that is returned.
11120 ;; This function might do hidden buffer changes.
11121 (let* ((symbol (c-langelem-sym langelem))
11122 (match (assq symbol c-offsets-alist))
11123 (offset (cdr-safe match)))
11125 (setq offset (c-evaluate-offset offset langelem symbol))
11126 (if c-strict-syntax-p
11127 (c-benign-error "No offset found for syntactic symbol %s" symbol))
11129 (if (vectorp offset)
11131 (or (and (numberp offset) offset)
11132 (and (symbolp offset) (symbol-value offset))
11136 (defun c-get-offset (langelem)
11137 ;; This is a compatibility wrapper for `c-calc-offset' in case
11138 ;; someone is calling it directly. It takes an old style syntactic
11139 ;; element on the form (SYMBOL . ANCHOR-POS) and converts it to the
11142 ;; This function might do hidden buffer changes.
11143 (if (c-langelem-pos langelem)
11144 (c-calc-offset (list (c-langelem-sym langelem)
11145 (c-langelem-pos langelem)))
11146 (c-calc-offset langelem)))
11148 (defun c-get-syntactic-indentation (langelems)
11149 ;; Calculate the syntactic indentation from a syntactic description
11150 ;; as returned by `c-guess-syntax'.
11152 ;; Note that topmost-intro always has an anchor position at bol, for
11153 ;; historical reasons. It's often used together with other symbols
11154 ;; that has more sane positions. Since we always use the first
11155 ;; found anchor position, we rely on that these other symbols always
11156 ;; precede topmost-intro in the LANGELEMS list.
11158 ;; This function might do hidden buffer changes.
11159 (let ((indent 0) anchor)
11162 (let* ((c-syntactic-element (car langelems))
11163 (res (c-calc-offset c-syntactic-element)))
11166 ;; Got an absolute column that overrides any indentation
11167 ;; we've collected so far, but not the relative
11168 ;; indentation we might get for the nested structures
11169 ;; further down the langelems list.
11170 (setq indent (elt res 0)
11171 anchor (point-min)) ; A position at column 0.
11173 ;; Got a relative change of the current calculated
11175 (setq indent (+ indent res))
11177 ;; Use the anchor position from the first syntactic
11178 ;; element with one.
11180 (setq anchor (c-langelem-pos (car langelems)))))
11182 (setq langelems (cdr langelems))))
11185 (+ indent (save-excursion
11191 (cc-provide 'cc-engine)
11193 ;;; Local Variables:
11194 ;;; indent-tabs-mode: t
11197 ;;; cc-engine.el ends here