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)
151 ;; Make declarations for all the `c-lang-defvar' variables in cc-langs.
153 (defmacro c-declare-lang-variables ()
156 (mapcar (lambda (init)
158 `(defvar ,(car init) nil ,(elt init 2))
159 `(defvar ,(car init) nil))
160 (make-variable-buffer-local ',(car init))))
161 (cdr c-lang-variable-inits)))))
162 (c-declare-lang-variables)
165 ;;; Internal state variables.
167 ;; Internal state of hungry delete key feature
168 (defvar c-hungry-delete-key nil)
169 (make-variable-buffer-local 'c-hungry-delete-key)
171 ;; The electric flag (toggled by `c-toggle-electric-state').
172 ;; If t, electric actions (like automatic reindentation, and (if
173 ;; c-auto-newline is also set) auto newlining) will happen when an electric
174 ;; key like `{' is pressed (or an electric keyword like `else').
175 (defvar c-electric-flag t)
176 (make-variable-buffer-local 'c-electric-flag)
178 ;; Internal state of auto newline feature.
179 (defvar c-auto-newline nil)
180 (make-variable-buffer-local 'c-auto-newline)
182 ;; Included in the mode line to indicate the active submodes.
183 ;; (defvar c-submode-indicators nil)
184 ;; (make-variable-buffer-local 'c-submode-indicators)
186 (defun c-calculate-state (arg prevstate)
187 ;; Calculate the new state of PREVSTATE, t or nil, based on arg. If
188 ;; arg is nil or zero, toggle the state. If arg is negative, turn
189 ;; the state off, and if arg is positive, turn the state on
191 (zerop (setq arg (prefix-numeric-value arg))))
196 ;; Basic handling of preprocessor directives.
198 ;; This is a dynamically bound cache used together with
199 ;; `c-query-macro-start' and `c-query-and-set-macro-start'. It only
200 ;; works as long as point doesn't cross a macro boundary.
201 (defvar c-macro-start 'unknown)
203 (defsubst c-query-and-set-macro-start ()
204 (if (symbolp c-macro-start)
205 (setq c-macro-start (save-excursion
206 (c-save-buffer-state ()
207 (and (c-beginning-of-macro)
211 (defsubst c-query-macro-start ()
212 (if (symbolp c-macro-start)
214 (c-save-buffer-state ()
215 (and (c-beginning-of-macro)
219 ;; One element macro cache to cope with continual movement within very large
221 (defvar c-macro-cache nil)
222 (make-variable-buffer-local 'c-macro-cache)
223 ;; Nil or cons of the bounds of the most recent CPP form probed by
224 ;; `c-beginning-of-macro', `c-end-of-macro' or `c-syntactic-end-of-macro'.
225 ;; The cdr will be nil if we know only the start of the CPP form.
226 (defvar c-macro-cache-start-pos nil)
227 (make-variable-buffer-local 'c-macro-cache-start-pos)
228 ;; The starting position from where we determined `c-macro-cache'.
229 (defvar c-macro-cache-syntactic nil)
230 (make-variable-buffer-local 'c-macro-cache-syntactic)
231 ;; non-nil iff `c-macro-cache' has both elements set AND the cdr is at a
232 ;; syntactic end of macro, not merely an apparent one.
234 (defun c-invalidate-macro-cache (beg end)
235 ;; Called from a before-change function. If the change region is before or
236 ;; in the macro characterized by `c-macro-cache' etc., nullify it
237 ;; appropriately. BEG and END are the standard before-change-functions
238 ;; parameters. END isn't used.
240 ((null c-macro-cache))
241 ((< beg (car c-macro-cache))
242 (setq c-macro-cache nil
243 c-macro-cache-start-pos nil
244 c-macro-cache-syntactic nil))
245 ((and (cdr c-macro-cache)
246 (< beg (cdr c-macro-cache)))
247 (setcdr c-macro-cache nil)
248 (setq c-macro-cache-start-pos beg
249 c-macro-cache-syntactic nil))))
251 (defun c-beginning-of-macro (&optional lim)
252 "Go to the beginning of a preprocessor directive.
253 Leave point at the beginning of the directive and return t if in one,
254 otherwise return nil and leave point unchanged.
256 Note that this function might do hidden buffer changes. See the
257 comment at the start of cc-engine.el for more info."
258 (let ((here (point)))
259 (when c-opt-cpp-prefix
260 (if (and (car c-macro-cache)
261 (>= (point) (car c-macro-cache))
262 (or (and (cdr c-macro-cache)
263 (<= (point) (cdr c-macro-cache)))
264 (<= (point) c-macro-cache-start-pos)))
265 (unless (< (car c-macro-cache) (or lim (point-min)))
266 (progn (goto-char (max (or lim (point-min)) (car c-macro-cache)))
267 (setq c-macro-cache-start-pos
268 (max c-macro-cache-start-pos here))
270 (setq c-macro-cache nil
271 c-macro-cache-start-pos nil
272 c-macro-cache-syntactic nil)
275 (if lim (narrow-to-region lim (point-max)))
277 (while (eq (char-before (1- (point))) ?\\)
279 (back-to-indentation)
280 (if (and (<= (point) here)
281 (looking-at c-opt-cpp-start))
283 (setq c-macro-cache (cons (point) nil)
284 c-macro-cache-start-pos here)
289 (defun c-end-of-macro ()
290 "Go to the end of a preprocessor directive.
291 More accurately, move the point to the end of the closest following
292 line that doesn't end with a line continuation backslash - no check is
293 done that the point is inside a cpp directive to begin with.
295 Note that this function might do hidden buffer changes. See the
296 comment at the start of cc-engine.el for more info."
297 (if (and (cdr c-macro-cache)
298 (<= (point) (cdr c-macro-cache))
299 (>= (point) (car c-macro-cache)))
300 (goto-char (cdr c-macro-cache))
301 (unless (and (car c-macro-cache)
302 (<= (point) c-macro-cache-start-pos)
303 (>= (point) (car c-macro-cache)))
304 (setq c-macro-cache nil
305 c-macro-cache-start-pos nil
306 c-macro-cache-syntactic nil))
309 (when (and (eq (char-before) ?\\)
313 (when (car c-macro-cache)
314 (setcdr c-macro-cache (point)))))
316 (defun c-syntactic-end-of-macro ()
317 ;; Go to the end of a CPP directive, or a "safe" pos just before.
319 ;; This is normally the end of the next non-escaped line. A "safe"
320 ;; position is one not within a string or comment. (The EOL on a line
321 ;; comment is NOT "safe").
323 ;; This function must only be called from the beginning of a CPP construct.
325 ;; Note that this function might do hidden buffer changes. See the comment
326 ;; at the start of cc-engine.el for more info.
327 (let* ((here (point))
328 (there (progn (c-end-of-macro) (point)))
330 (unless c-macro-cache-syntactic
331 (setq s (parse-partial-sexp here there))
332 (while (and (or (nth 3 s) ; in a string
333 (nth 4 s)) ; in a comment (maybe at end of line comment)
334 (> there here)) ; No infinite loops, please.
335 (setq there (1- (nth 8 s)))
336 (setq s (parse-partial-sexp here there)))
337 (setq c-macro-cache-syntactic (car c-macro-cache)))
340 (defun c-forward-over-cpp-define-id ()
341 ;; Assuming point is at the "#" that introduces a preprocessor
342 ;; directive, it's moved forward to the end of the identifier which is
343 ;; "#define"d (or whatever c-opt-cpp-macro-define specifies). Non-nil
344 ;; is returned in this case, in all other cases nil is returned and
345 ;; point isn't moved.
347 ;; This function might do hidden buffer changes.
348 (when (and c-opt-cpp-macro-define-id
349 (looking-at c-opt-cpp-macro-define-id))
350 (goto-char (match-end 0))))
352 (defun c-forward-to-cpp-define-body ()
353 ;; Assuming point is at the "#" that introduces a preprocessor
354 ;; directive, it's moved forward to the start of the definition body
355 ;; if it's a "#define" (or whatever c-opt-cpp-macro-define
356 ;; specifies). Non-nil is returned in this case, in all other cases
357 ;; nil is returned and point isn't moved.
359 ;; This function might do hidden buffer changes.
360 (when (and c-opt-cpp-macro-define-start
361 (looking-at c-opt-cpp-macro-define-start)
362 (not (= (match-end 0) (c-point 'eol))))
363 (goto-char (match-end 0))))
366 ;;; Basic utility functions.
368 (defun c-syntactic-content (from to paren-level)
369 ;; Return the given region as a string where all syntactic
370 ;; whitespace is removed or, where necessary, replaced with a single
371 ;; space. If PAREN-LEVEL is given then all parens in the region are
372 ;; collapsed to "()", "[]" etc.
374 ;; This function might do hidden buffer changes.
378 (narrow-to-region from to)
380 (let* ((parts (list nil)) (tail parts) pos in-paren)
382 (while (re-search-forward c-syntactic-ws-start to t)
383 (goto-char (setq pos (match-beginning 0)))
384 (c-forward-syntactic-ws)
390 (setq in-paren (= (car (parse-partial-sexp from pos 1)) 1)
393 (if (and (> pos from)
395 (looking-at "\\w\\|\\s_")
398 (looking-at "\\w\\|\\s_")))
400 (setcdr tail (list (buffer-substring-no-properties from pos)
402 (setq tail (cddr tail)))
403 (setcdr tail (list (buffer-substring-no-properties from pos)))
404 (setq tail (cdr tail)))
407 (when (= (car (parse-partial-sexp pos to -1)) -1)
408 (setcdr tail (list (buffer-substring-no-properties
409 (1- (point)) (point))))
410 (setq tail (cdr tail))))
412 (setq from (point))))
414 (setcdr tail (list (buffer-substring-no-properties from to)))
415 (apply 'concat (cdr parts))))))
417 (defun c-shift-line-indentation (shift-amt)
418 ;; Shift the indentation of the current line with the specified
419 ;; amount (positive inwards). The buffer is modified only if
420 ;; SHIFT-AMT isn't equal to zero.
421 (let ((pos (- (point-max) (point)))
422 (c-macro-start c-macro-start)
424 (if (zerop shift-amt)
426 ;; If we're on an empty line inside a macro, we take the point
427 ;; to be at the current indentation and shift it to the
428 ;; appropriate column. This way we don't treat the extra
429 ;; whitespace out to the line continuation as indentation.
430 (when (and (c-query-and-set-macro-start)
431 (looking-at "[ \t]*\\\\$")
433 (skip-chars-backward " \t")
437 (setq tmp-char-inserted t))
439 (let ((col (current-indentation)))
440 (delete-region (c-point 'bol) (c-point 'boi))
442 (indent-to (+ col shift-amt)))
443 (when tmp-char-inserted
445 ;; If initial point was within line's indentation and we're not on
446 ;; a line with a line continuation in a macro, position after the
447 ;; indentation. Else stay at same point in text.
448 (if (and (< (point) (c-point 'boi))
449 (not tmp-char-inserted))
450 (back-to-indentation)
451 (if (> (- (point-max) pos) (point))
452 (goto-char (- (point-max) pos))))))
454 (defsubst c-keyword-sym (keyword)
455 ;; Return non-nil if the string KEYWORD is a known keyword. More
456 ;; precisely, the value is the symbol for the keyword in
457 ;; `c-keywords-obarray'.
458 (intern-soft keyword c-keywords-obarray))
460 (defsubst c-keyword-member (keyword-sym lang-constant)
461 ;; Return non-nil if the symbol KEYWORD-SYM, as returned by
462 ;; `c-keyword-sym', is a member of LANG-CONSTANT, which is the name
463 ;; of a language constant that ends with "-kwds". If KEYWORD-SYM is
464 ;; nil then the result is nil.
465 (get keyword-sym lang-constant))
467 ;; String syntax chars, suitable for skip-syntax-(forward|backward).
468 (defconst c-string-syntax (if (memq 'gen-string-delim c-emacs-features)
472 ;; Regexp matching string limit syntax.
473 (defconst c-string-limit-regexp (if (memq 'gen-string-delim c-emacs-features)
477 ;; Regexp matching WS followed by string limit syntax.
478 (defconst c-ws*-string-limit-regexp
479 (concat "[ \t]*\\(" c-string-limit-regexp "\\)"))
481 ;; Holds formatted error strings for the few cases where parse errors
483 (defvar c-parsing-error nil)
484 (make-variable-buffer-local 'c-parsing-error)
486 (defun c-echo-parsing-error (&optional quiet)
487 (when (and c-report-syntactic-errors c-parsing-error (not quiet))
488 (c-benign-error "%s" c-parsing-error))
491 ;; Faces given to comments and string literals. This is used in some
492 ;; situations to speed up recognition; it isn't mandatory that font
493 ;; locking is in use. This variable is extended with the face in
494 ;; `c-doc-face-name' when fontification is activated in cc-fonts.el.
495 (defvar c-literal-faces
496 (append '(font-lock-comment-face font-lock-string-face)
497 (when (facep 'font-lock-comment-delimiter-face)
499 '(font-lock-comment-delimiter-face))))
501 (defsubst c-put-c-type-property (pos value)
502 ;; Put a c-type property with the given value at POS.
503 (c-put-char-property pos 'c-type value))
505 (defun c-clear-c-type-property (from to value)
506 ;; Remove all occurrences of the c-type property that has the given
507 ;; value in the region between FROM and TO. VALUE is assumed to not
510 ;; Note: This assumes that c-type is put on single chars only; it's
511 ;; very inefficient if matching properties cover large regions.
515 (when (eq (get-text-property (point) 'c-type) value)
516 (c-clear-char-property (point) 'c-type))
517 (goto-char (next-single-property-change (point) 'c-type nil to))
521 ;; Some debug tools to visualize various special positions. This
522 ;; debug code isn't as portable as the rest of CC Mode.
524 (cc-bytecomp-defun overlays-in)
525 (cc-bytecomp-defun overlay-get)
526 (cc-bytecomp-defun overlay-start)
527 (cc-bytecomp-defun overlay-end)
528 (cc-bytecomp-defun delete-overlay)
529 (cc-bytecomp-defun overlay-put)
530 (cc-bytecomp-defun make-overlay)
532 (defun c-debug-add-face (beg end face)
533 (c-save-buffer-state ((overlays (overlays-in beg end)) overlay)
535 (setq overlay (car overlays)
536 overlays (cdr overlays))
537 (when (eq (overlay-get overlay 'face) face)
538 (setq beg (min beg (overlay-start overlay))
539 end (max end (overlay-end overlay)))
540 (delete-overlay overlay)))
541 (overlay-put (make-overlay beg end) 'face face)))
543 (defun c-debug-remove-face (beg end face)
544 (c-save-buffer-state ((overlays (overlays-in beg end)) overlay
545 (ol-beg beg) (ol-end end))
547 (setq overlay (car overlays)
548 overlays (cdr overlays))
549 (when (eq (overlay-get overlay 'face) face)
550 (setq ol-beg (min ol-beg (overlay-start overlay))
551 ol-end (max ol-end (overlay-end overlay)))
552 (delete-overlay overlay)))
554 (overlay-put (make-overlay ol-beg beg) 'face face))
556 (overlay-put (make-overlay end ol-end) 'face face))))
559 ;; `c-beginning-of-statement-1' and accompanying stuff.
561 ;; KLUDGE ALERT: c-maybe-labelp is used to pass information between
562 ;; c-crosses-statement-barrier-p and c-beginning-of-statement-1. A
563 ;; better way should be implemented, but this will at least shut up
564 ;; the byte compiler.
565 (defvar c-maybe-labelp)
567 ;; New awk-compatible version of c-beginning-of-statement-1, ACM 2002/6/22
569 ;; Macros used internally in c-beginning-of-statement-1 for the
570 ;; automaton actions.
571 (defmacro c-bos-push-state ()
572 '(setq stack (cons (cons state saved-pos)
574 (defmacro c-bos-pop-state (&optional do-if-done)
575 `(if (setq state (car (car stack))
576 saved-pos (cdr (car stack))
581 (defmacro c-bos-pop-state-and-retry ()
582 '(throw 'loop (setq state (car (car stack))
583 saved-pos (cdr (car stack))
584 ;; Throw nil if stack is empty, else throw non-nil.
586 (defmacro c-bos-save-pos ()
587 '(setq saved-pos (vector pos tok ptok pptok)))
588 (defmacro c-bos-restore-pos ()
589 '(unless (eq (elt saved-pos 0) start)
590 (setq pos (elt saved-pos 0)
591 tok (elt saved-pos 1)
592 ptok (elt saved-pos 2)
593 pptok (elt saved-pos 3))
596 (defmacro c-bos-save-error-info (missing got)
597 `(setq saved-pos (vector pos ,missing ,got)))
598 (defmacro c-bos-report-error ()
600 (setq c-parsing-error
601 (format "No matching `%s' found for `%s' on line %d"
604 (1+ (count-lines (point-min)
605 (c-point 'bol (elt saved-pos 0))))))))
607 (defun c-beginning-of-statement-1 (&optional lim ignore-labels
609 "Move to the start of the current statement or declaration, or to
610 the previous one if already at the beginning of one. Only
611 statements/declarations on the same level are considered, i.e. don't
612 move into or out of sexps (not even normal expression parentheses).
614 If point is already at the earliest statement within braces or parens,
615 this function doesn't move back into any whitespace preceding it; it
616 returns 'same in this case.
618 Stop at statement continuation tokens like \"else\", \"catch\",
619 \"finally\" and the \"while\" in \"do ... while\" if the start point
620 is within the continuation. If starting at such a token, move to the
621 corresponding statement start. If at the beginning of a statement,
622 move to the closest containing statement if there is any. This might
623 also stop at a continuation clause.
625 Labels are treated as part of the following statements if
626 IGNORE-LABELS is non-nil. (FIXME: Doesn't work if we stop at a known
627 statement start keyword.) Otherwise, each label is treated as a
630 Macros are ignored \(i.e. skipped over) unless point is within one, in
631 which case the content of the macro is treated as normal code. Aside
632 from any normal statement starts found in it, stop at the first token
633 of the content in the macro, i.e. the expression of an \"#if\" or the
634 start of the definition in a \"#define\". Also stop at start of
635 macros before leaving them.
638 'label if stopped at a label or \"case...:\" or \"default:\";
639 'same if stopped at the beginning of the current statement;
640 'up if stepped to a containing statement;
641 'previous if stepped to a preceding statement;
642 'beginning if stepped from a statement continuation clause to
644 'macro if stepped to a macro start.
645 Note that 'same and not 'label is returned if stopped at the same
646 label without crossing the colon character.
648 LIM may be given to limit the search. If the search hits the limit,
649 point will be left at the closest following token, or at the start
650 position if that is less ('same is returned in this case).
652 NOERROR turns off error logging to `c-parsing-error'.
654 Normally only ';' and virtual semicolons are considered to delimit
655 statements, but if COMMA-DELIM is non-nil then ',' is treated
658 Note that this function might do hidden buffer changes. See the
659 comment at the start of cc-engine.el for more info."
661 ;; The bulk of this function is a pushdown automaton that looks at statement
662 ;; boundaries and the tokens (such as "while") in c-opt-block-stmt-key. Its
663 ;; purpose is to keep track of nested statements, ensuring that such
664 ;; statements are skipped over in their entirety (somewhat akin to what C-M-p
665 ;; does with nested braces/brackets/parentheses).
667 ;; Note: The position of a boundary is the following token.
669 ;; Beginning with the current token (the one following point), move back one
670 ;; sexp at a time (where a sexp is, more or less, either a token or the
671 ;; entire contents of a brace/bracket/paren pair). Each time a statement
672 ;; boundary is crossed or a "while"-like token is found, update the state of
673 ;; the PDA. Stop at the beginning of a statement when the stack (holding
674 ;; nested statement info) is empty and the position has been moved.
676 ;; The following variables constitute the PDA:
678 ;; sym: This is either the "while"-like token (e.g. 'for) we've just
679 ;; scanned back over, 'boundary if we've just gone back over a
680 ;; statement boundary, or nil otherwise.
681 ;; state: takes one of the values (nil else else-boundary while
682 ;; while-boundary catch catch-boundary).
683 ;; nil means "no "while"-like token yet scanned".
684 ;; 'else, for example, means "just gone back over an else".
685 ;; 'else-boundary means "just gone back over a statement boundary
686 ;; immediately after having gone back over an else".
687 ;; saved-pos: A vector of either saved positions (tok ptok pptok, etc.) or
688 ;; of error reporting information.
689 ;; stack: The stack onto which the PDA pushes its state. Each entry
690 ;; consists of a saved value of state and saved-pos. An entry is
691 ;; pushed when we move back over a "continuation" token (e.g. else)
692 ;; and popped when we encounter the corresponding opening token
696 ;; The following diagram briefly outlines the PDA.
699 ;; "else": Push state, goto state `else'.
700 ;; "while": Push state, goto state `while'.
701 ;; "catch" or "finally": Push state, goto state `catch'.
702 ;; boundary: Pop state.
703 ;; other: Do nothing special.
706 ;; boundary: Goto state `else-boundary'.
707 ;; other: Error, pop state, retry token.
709 ;; State `else-boundary':
711 ;; boundary: Error, pop state.
712 ;; other: See common state.
715 ;; boundary: Save position, goto state `while-boundary'.
716 ;; other: Pop state, retry token.
718 ;; State `while-boundary':
720 ;; boundary: Restore position if it's not at start, pop state. [*see below]
721 ;; other: See common state.
724 ;; boundary: Goto state `catch-boundary'.
725 ;; other: Error, pop state, retry token.
727 ;; State `catch-boundary':
729 ;; "catch": Goto state `catch'.
730 ;; boundary: Error, pop state.
731 ;; other: See common state.
733 ;; [*] In the `while-boundary' state, we had pushed a 'while state, and were
734 ;; searching for a "do" which would have opened a do-while. If we didn't
735 ;; find it, we discard the analysis done since the "while", go back to this
736 ;; token in the buffer and restart the scanning there, this time WITHOUT
737 ;; pushing the 'while state onto the stack.
739 ;; In addition to the above there is some special handling of labels
742 (let ((case-fold-search nil)
745 (delims (if comma-delim '(?\; ?,) '(?\;)))
746 (c-stmt-delim-chars (if comma-delim
747 c-stmt-delim-chars-with-comma
749 c-in-literal-cache c-maybe-labelp after-case:-pos saved
752 ;; Position of last stmt boundary character (e.g. ;).
754 ;; The position of the last sexp or bound that follows the
755 ;; first found colon, i.e. the start of the nonlabel part of
756 ;; the statement. It's `start' if a colon is found just after
759 ;; Like `after-labels-pos', but the first such position inside
760 ;; a label, i.e. the start of the last label before the start
761 ;; of the nonlabel part of the statement.
763 ;; The last position where a label is possible provided the
764 ;; statement started there. It's nil as long as no invalid
765 ;; label content has been found (according to
766 ;; `c-nonlabel-token-key'). It's `start' if no valid label
767 ;; content was found in the label. Note that we might still
768 ;; regard it a label if it starts with `c-label-kwds'.
770 ;; Putative positions of the components of a bitfield declaration,
771 ;; e.g. "int foo : NUM_FOO_BITS ;"
772 bitfield-type-pos bitfield-id-pos bitfield-size-pos
773 ;; Symbol just scanned back over (e.g. 'while or 'boundary).
776 ;; Current state in the automaton. See above.
778 ;; Current saved positions. See above.
780 ;; Stack of conses (state . saved-pos).
782 ;; Regexp which matches "for", "if", etc.
783 (cond-key (or c-opt-block-stmt-key
784 "\\<\\>")) ; Matches nothing.
787 ;; Positions of the last three sexps or bounds we've stopped at.
791 (if lim (narrow-to-region lim (point-max)))
794 (and (c-beginning-of-macro)
796 (setq macro-start (point)))
798 ;; Try to skip back over unary operator characters, to register
802 (c-backward-syntactic-ws)
803 ;; Protect post-++/-- operators just before a virtual semicolon.
804 (and (not (c-at-vsemi-p))
805 (/= (skip-chars-backward "-+!*&~@`#") 0))))
807 ;; Skip back over any semicolon here. If it was a bare semicolon, we're
808 ;; done. Later on we ignore the boundaries for statements that don't
809 ;; contain any sexp. The only thing that is affected is that the error
810 ;; checking is a little less strict, and we really don't bother.
811 (if (and (memq (char-before) delims)
812 (progn (forward-char -1)
814 (c-backward-syntactic-ws)
815 (or (memq (char-before) delims)
816 (memq (char-before) '(?: nil))
817 (eq (char-syntax (char-before)) ?\()
822 ;; Begin at start and not pos to detect macros if we stand
823 ;; directly after the #.
825 (if (looking-at "\\<\\|\\W")
826 ;; Record this as the first token if not starting inside it.
830 ;; The following while loop goes back one sexp (balanced parens,
831 ;; etc. with contents, or symbol or suchlike) each iteration. This
832 ;; movement is accomplished with a call to c-backward-sexp approx 170
835 ;; The loop is exited only by throwing nil to the (catch 'loop ...):
836 ;; 1. On reaching the start of a macro;
837 ;; 2. On having passed a stmt boundary with the PDA stack empty;
838 ;; 3. On reaching the start of an Objective C method def;
839 ;; 4. From macro `c-bos-pop-state'; when the stack is empty;
840 ;; 5. From macro `c-bos-pop-state-and-retry' when the stack is empty.
842 (catch 'loop ;; Throw nil to break, non-nil to continue.
844 ;; Are we in a macro, just after the opening #?
846 (and macro-start ; Always NIL for AWK.
847 (progn (skip-chars-backward " \t")
848 (eq (char-before) ?#))
849 (progn (setq saved (1- (point)))
851 (not (eq (char-before (1- (point))) ?\\)))
852 (looking-at c-opt-cpp-start)
853 (progn (skip-chars-forward " \t")
854 (eq (point) saved))))
856 (if (and (c-forward-to-cpp-define-body)
857 (progn (c-forward-syntactic-ws start)
859 ;; Stop at the first token in the content of the macro.
861 ignore-labels t) ; Avoid the label check on exit.
865 (throw 'loop nil)) ; 1. Start of macro.
867 ;; Do a round through the automaton if we've just passed a
868 ;; statement boundary or passed a "while"-like token.
870 (and (looking-at cond-key)
871 (setq sym (intern (match-string 1)))))
873 (when (and (< pos start) (null stack))
874 (throw 'loop nil)) ; 2. Statement boundary.
876 ;; The PDA state handling.
878 ;; Refer to the description of the PDA in the opening
879 ;; comments. In the following OR form, the first leaf
880 ;; attempts to handles one of the specific actions detailed
881 ;; (e.g., finding token "if" whilst in state `else-boundary').
882 ;; We drop through to the second leaf (which handles common
883 ;; state) if no specific handler is found in the first cond.
884 ;; If a parsing error is detected (e.g. an "else" with no
885 ;; preceding "if"), we throw to the enclosing catch.
887 ;; Note that the (eq state 'else) means
888 ;; "we've just passed an else", NOT "we're looking for an
892 (if (eq sym 'boundary)
893 (setq state 'else-boundary)
895 (c-bos-pop-state-and-retry)))
897 ((eq state 'else-boundary)
899 (c-bos-pop-state (setq ret 'beginning)))
905 (if (and (eq sym 'boundary)
906 ;; Since this can cause backtracking we do a
907 ;; little more careful analysis to avoid it:
908 ;; If there's a label in front of the while
909 ;; it can't be part of a do-while.
910 (not after-labels-pos))
911 (progn (c-bos-save-pos)
912 (setq state 'while-boundary))
913 (c-bos-pop-state-and-retry))) ; Can't be a do-while
915 ((eq state 'while-boundary)
917 (c-bos-pop-state (setq ret 'beginning)))
918 ((eq sym 'boundary) ; isn't a do-while
919 (c-bos-restore-pos) ; the position of the while
920 (c-bos-pop-state)))) ; no longer searching for do.
923 (if (eq sym 'boundary)
924 (setq state 'catch-boundary)
926 (c-bos-pop-state-and-retry)))
928 ((eq state 'catch-boundary)
931 (c-bos-pop-state (setq ret 'beginning)))
936 (c-bos-pop-state)))))
938 ;; This is state common. We get here when the previous
939 ;; cond statement found no particular state handler.
940 (cond ((eq sym 'boundary)
941 ;; If we have a boundary at the start
942 ;; position we push a frame to go to the
943 ;; previous statement.
949 (c-bos-save-error-info 'if 'else)
952 ;; Is this a real while, or a do-while?
953 ;; The next `when' triggers unless we are SURE that
954 ;; the `while' is not the tail end of a `do-while'.
955 (when (or (not pptok)
956 (memq (char-after pptok) delims)
957 ;; The following kludge is to prevent
958 ;; infinite recursion when called from
959 ;; c-awk-after-if-for-while-condition-p,
961 (and (eq (point) start)
962 (c-vsemi-status-unknown-p))
963 (c-at-vsemi-p pptok))
964 ;; Since this can cause backtracking we do a
965 ;; little more careful analysis to avoid it: If
966 ;; the while isn't followed by a (possibly
967 ;; virtual) semicolon it can't be a do-while.
969 (setq state 'while)))
970 ((memq sym '(catch finally))
972 (c-bos-save-error-info 'try sym)
973 (setq state 'catch))))
976 ;; We're either past a statement boundary or at the
977 ;; start of a statement, so throw away any label data
978 ;; for the previous one.
979 (setq after-labels-pos nil
981 c-maybe-labelp nil))))
983 ;; Step to the previous sexp, but not if we crossed a
984 ;; boundary, since that doesn't consume an sexp.
985 (if (eq sym 'boundary)
988 ;; HERE IS THE SINGLE PLACE INSIDE THE PDA LOOP WHERE WE MOVE
989 ;; BACKWARDS THROUGH THE SOURCE.
991 (c-backward-syntactic-ws)
992 (let ((before-sws-pos (point))
993 ;; The end position of the area to search for statement
994 ;; barriers in this round.
995 (maybe-after-boundary-pos pos))
997 ;; Go back over exactly one logical sexp, taking proper
998 ;; account of macros and escaped EOLs.
1001 (unless (c-safe (c-backward-sexp) t)
1002 ;; Give up if we hit an unbalanced block. Since the
1003 ;; stack won't be empty the code below will report a
1007 ;; Have we moved into a macro?
1008 ((and (not macro-start)
1009 (c-beginning-of-macro))
1010 ;; Have we crossed a statement boundary? If not,
1011 ;; keep going back until we find one or a "real" sexp.
1015 (not (c-crosses-statement-barrier-p
1016 (point) maybe-after-boundary-pos)))
1017 (setq maybe-after-boundary-pos (point))))
1018 ;; Have we just gone back over an escaped NL? This
1019 ;; doesn't count as a sexp.
1020 ((looking-at "\\\\$")))))
1022 ;; Have we crossed a statement boundary?
1025 ;; Are we at a macro beginning?
1026 ((and (not macro-start)
1028 (looking-at c-opt-cpp-prefix))
1031 (c-crosses-statement-barrier-p
1032 (point) maybe-after-boundary-pos)))
1033 ;; Just gone back over a brace block?
1035 (eq (char-after) ?{)
1036 (not (c-looking-at-inexpr-block lim nil t)))
1038 (c-forward-sexp) (point)))
1039 ;; Just gone back over some paren block?
1040 ((looking-at "\\s\(")
1042 (goto-char (1+ (c-down-list-backward
1044 (c-crosses-statement-barrier-p
1045 (point) maybe-after-boundary-pos)))
1046 ;; Just gone back over an ordinary symbol of some sort?
1047 (t (c-crosses-statement-barrier-p
1048 (point) maybe-after-boundary-pos))))
1055 ;; Like a C "continue". Analyze the next sexp.
1059 (when (and c-opt-method-key
1060 (setq saved (c-in-method-def-p)))
1062 ignore-labels t) ; Avoid the label check on exit.
1063 (throw 'loop nil)) ; 3. ObjC method def.
1065 ;; Might we have a bitfield declaration, "<type> <id> : <size>"?
1068 ;; The : <size> and <id> fields?
1069 ((and (numberp c-maybe-labelp)
1070 (not bitfield-size-pos)
1072 (goto-char (or tok start))
1073 (not (looking-at c-keywords-regexp)))
1074 (not (looking-at c-keywords-regexp))
1075 (not (c-punctuation-in (point) c-maybe-labelp)))
1076 (setq bitfield-size-pos (or tok start)
1077 bitfield-id-pos (point)))
1078 ;; The <type> field?
1079 ((and bitfield-id-pos
1080 (not bitfield-type-pos))
1081 (if (and (looking-at c-symbol-key) ; Can only be an integer type. :-)
1082 (not (looking-at c-not-primitive-type-keywords-regexp))
1083 (not (c-punctuation-in (point) tok)))
1084 (setq bitfield-type-pos (point))
1085 (setq bitfield-size-pos nil
1086 bitfield-id-pos nil)))))
1089 (unless (eq ignore-labels t)
1090 (when (numberp c-maybe-labelp)
1091 ;; `c-crosses-statement-barrier-p' has found a colon, so we
1092 ;; might be in a label now. Have we got a real label
1093 ;; (including a case label) or something like C++'s "public:"?
1094 ;; A case label might use an expression rather than a token.
1095 (setq after-case:-pos (or tok start))
1096 (if (or (looking-at c-nonlabel-token-key) ; e.g. "while" or "'a'"
1097 ;; Catch C++'s inheritance construct "class foo : bar".
1100 (c-safe (c-backward-sexp) t)
1101 (looking-at c-nonlabel-token-2-key))))
1102 (setq c-maybe-labelp nil)
1103 (if after-labels-pos ; Have we already encountered a label?
1104 (if (not last-label-pos)
1105 (setq last-label-pos (or tok start)))
1106 (setq after-labels-pos (or tok start)))
1107 (setq c-maybe-labelp t
1108 label-good-pos nil))) ; bogus "label"
1110 (when (and (not label-good-pos) ; i.e. no invalid "label"'s yet
1112 (looking-at c-nonlabel-token-key)) ; e.g. "while :"
1113 ;; We're in a potential label and it's the first
1114 ;; time we've found something that isn't allowed in
1116 (setq label-good-pos (or tok start))))
1118 ;; We've moved back by a sexp, so update the token positions.
1123 pos tok) ; always non-nil
1124 ) ; end of (catch loop ....)
1125 ) ; end of sexp-at-a-time (while ....)
1127 ;; If the stack isn't empty there might be errors to report.
1129 (if (and (vectorp saved-pos) (eq (length saved-pos) 3))
1130 (c-bos-report-error))
1131 (setq saved-pos (cdr (car stack))
1134 (when (and (eq ret 'same)
1135 (not (memq sym '(boundary ignore nil))))
1136 ;; Need to investigate closer whether we've crossed
1137 ;; between a substatement and its containing statement.
1139 (cond ((and (looking-at c-block-stmt-1-2-key)
1140 (eq (char-after ptok) ?\())
1142 ((looking-at c-block-stmt-1-key)
1145 (cond ((> start saved) (setq pos saved))
1146 ((= start saved) (setq ret 'up)))))
1148 (when (and (not ignore-labels)
1149 (eq c-maybe-labelp t)
1150 (not (eq ret 'beginning))
1152 (not bitfield-type-pos) ; Bitfields take precedence over labels.
1153 (or (not label-good-pos)
1154 (<= label-good-pos pos)
1156 (goto-char (if (and last-label-pos
1157 (< last-label-pos start))
1160 (looking-at c-label-kwds-regexp))))
1161 ;; We're in a label. Maybe we should step to the statement
1163 (if (< after-labels-pos start)
1164 (setq pos after-labels-pos)
1166 (if (and last-label-pos (< last-label-pos start))
1167 ;; Might have jumped over several labels. Go to the last one.
1168 (setq pos last-label-pos)))))
1170 ;; Have we got "case <expression>:"?
1172 (when (and after-case:-pos
1173 (not (eq ret 'beginning))
1174 (looking-at c-case-kwds-regexp))
1175 (if (< after-case:-pos start)
1176 (setq pos after-case:-pos))
1180 ;; Skip over the unary operators that can start the statement.
1182 (c-backward-syntactic-ws)
1183 ;; protect AWK post-inc/decrement operators, etc.
1184 (and (not (c-at-vsemi-p (point)))
1185 (/= (skip-chars-backward "-+!*&~@`#") 0)))
1190 (defun c-punctuation-in (from to)
1191 "Return non-nil if there is a non-comment non-macro punctuation character
1192 between FROM and TO. FROM must not be in a string or comment. The returned
1193 value is the position of the first such character."
1196 (let ((pos (point)))
1197 (while (progn (skip-chars-forward c-symbol-chars to)
1198 (c-forward-syntactic-ws to)
1200 (setq pos (point))))
1201 (and (< (point) to) (point))))
1203 (defun c-crosses-statement-barrier-p (from to)
1204 "Return non-nil if buffer positions FROM to TO cross one or more
1205 statement or declaration boundaries. The returned value is actually
1206 the position of the earliest boundary char. FROM must not be within
1207 a string or comment.
1209 The variable `c-maybe-labelp' is set to the position of the first `:' that
1210 might start a label (i.e. not part of `::' and not preceded by `?'). If a
1211 single `?' is found, then `c-maybe-labelp' is cleared.
1213 For AWK, a statement which is terminated by an EOL (not a \; or a }) is
1214 regarded as having a \"virtual semicolon\" immediately after the last token on
1215 the line. If this virtual semicolon is _at_ from, the function recognizes it.
1217 Note that this function might do hidden buffer changes. See the
1218 comment at the start of cc-engine.el for more info."
1220 ;; If the current language has CPP macros, insert # into skip-chars.
1221 (if c-opt-cpp-symbol
1222 (concat (substring c-stmt-delim-chars 0 1) ; "^"
1223 c-opt-cpp-symbol ; usually "#"
1224 (substring c-stmt-delim-chars 1)) ; e.g. ";{}?:"
1225 c-stmt-delim-chars))
1227 (append (substring skip-chars 1) nil)) ; e.g. (?# ?\; ?{ ?} ?? ?:)
1228 lit-range vsemi-pos)
1234 (while (progn (skip-chars-forward
1236 (min to (c-point 'bonl)))
1239 ;; Virtual semicolon?
1243 (if (setq lit-range (c-literal-limits from)) ; Have we landed in a string/comment?
1244 (goto-char (car lit-range)))
1245 (c-backward-syntactic-ws) ; ? put a limit here, maybe?
1246 (setq vsemi-pos (point))
1248 (throw 'done vsemi-pos))
1249 ;; In a string/comment?
1250 ((setq lit-range (c-literal-limits from))
1251 (goto-char (cdr lit-range)))
1252 ((eq (char-after) ?:)
1254 (if (and (eq (char-after) ?:)
1256 ;; Ignore scope operators.
1258 (setq c-maybe-labelp (1- (point)))))
1259 ((eq (char-after) ??)
1260 ;; A question mark. Can't be a label, so stop
1261 ;; looking for more : and ?.
1262 (setq c-maybe-labelp nil
1263 skip-chars (substring c-stmt-delim-chars 0 -2)))
1264 ;; At a CPP construct or a "#" or "##" operator?
1265 ((and c-opt-cpp-symbol (looking-at c-opt-cpp-symbol))
1267 (skip-chars-backward " \t")
1270 (not (eq (char-before (1- (point))) ?\\)))))
1272 (skip-chars-forward c-opt-cpp-symbol)))
1273 ((memq (char-after) non-skip-list)
1274 (throw 'done (point)))))
1275 ;; In trailing space after an as yet undetected virtual semicolon?
1276 (c-backward-syntactic-ws from)
1277 (when (and (bolp) (not (bobp))) ; Can happen in AWK Mode with an
1278 ; unterminated string/regexp.
1280 (if (and (< (point) to)
1285 (defun c-at-statement-start-p ()
1286 "Return non-nil if the point is at the first token in a statement
1287 or somewhere in the syntactic whitespace before it.
1289 A \"statement\" here is not restricted to those inside code blocks.
1290 Any kind of declaration-like construct that occur outside function
1291 bodies is also considered a \"statement\".
1293 Note that this function might do hidden buffer changes. See the
1294 comment at the start of cc-engine.el for more info."
1299 (c-syntactic-skip-backward (substring c-stmt-delim-chars 1) nil t)
1301 (eq (char-before) ?})
1302 (and (eq (char-before) ?{)
1303 (not (and c-special-brace-lists
1304 (progn (backward-char)
1305 (c-looking-at-special-brace-list)))))
1306 (c-crosses-statement-barrier-p (point) end)))))
1308 (defun c-at-expression-start-p ()
1309 "Return non-nil if the point is at the first token in an expression or
1310 statement, or somewhere in the syntactic whitespace before it.
1312 An \"expression\" here is a bit different from the normal language
1313 grammar sense: It's any sequence of expression tokens except commas,
1314 unless they are enclosed inside parentheses of some kind. Also, an
1315 expression never continues past an enclosing parenthesis, but it might
1316 contain parenthesis pairs of any sort except braces.
1318 Since expressions never cross statement boundaries, this function also
1319 recognizes statement beginnings, just like `c-at-statement-start-p'.
1321 Note that this function might do hidden buffer changes. See the
1322 comment at the start of cc-engine.el for more info."
1326 (c-stmt-delim-chars c-stmt-delim-chars-with-comma)
1328 (c-syntactic-skip-backward (substring c-stmt-delim-chars 1) nil t)
1330 (memq (char-before) '(?{ ?}))
1331 (save-excursion (backward-char)
1332 (looking-at "\\s("))
1333 (c-crosses-statement-barrier-p (point) end)))))
1336 ;; A set of functions that covers various idiosyncrasies in
1337 ;; implementations of `forward-comment'.
1339 ;; Note: Some emacsen considers incorrectly that any line comment
1340 ;; ending with a backslash continues to the next line. I can't think
1341 ;; of any way to work around that in a reliable way without changing
1342 ;; the buffer, though. Suggestions welcome. ;) (No, temporarily
1343 ;; changing the syntax for backslash doesn't work since we must treat
1344 ;; escapes in string literals correctly.)
1346 (defun c-forward-single-comment ()
1347 "Move forward past whitespace and the closest following comment, if any.
1348 Return t if a comment was found, nil otherwise. In either case, the
1349 point is moved past the following whitespace. Line continuations,
1350 i.e. a backslashes followed by line breaks, are treated as whitespace.
1351 The line breaks that end line comments are considered to be the
1352 comment enders, so the point will be put on the beginning of the next
1353 line if it moved past a line comment.
1355 This function does not do any hidden buffer changes."
1357 (let ((start (point)))
1358 (when (looking-at "\\([ \t\n\r\f\v]\\|\\\\[\n\r]\\)+")
1359 (goto-char (match-end 0)))
1361 (when (forward-comment 1)
1363 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1367 ;; Emacs includes the ending newline in a b-style (c++)
1368 ;; comment, but XEmacs doesn't. We depend on the Emacs
1369 ;; behavior (which also is symmetric).
1370 (if (and (eolp) (elt (parse-partial-sexp start (point)) 7))
1371 (condition-case nil (forward-char 1)))
1375 (defsubst c-forward-comments ()
1376 "Move forward past all following whitespace and comments.
1377 Line continuations, i.e. a backslashes followed by line breaks, are
1378 treated as whitespace.
1380 Note that this function might do hidden buffer changes. See the
1381 comment at the start of cc-engine.el for more info."
1384 ;; If forward-comment in at least XEmacs 21 is given a large
1385 ;; positive value, it'll loop all the way through if it hits
1387 (and (forward-comment 5)
1388 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1392 (when (looking-at "\\\\[\n\r]")
1396 (defun c-backward-single-comment ()
1397 "Move backward past whitespace and the closest preceding comment, if any.
1398 Return t if a comment was found, nil otherwise. In either case, the
1399 point is moved past the preceding whitespace. Line continuations,
1400 i.e. a backslashes followed by line breaks, are treated as whitespace.
1401 The line breaks that end line comments are considered to be the
1402 comment enders, so the point cannot be at the end of the same line to
1403 move over a line comment.
1405 This function does not do any hidden buffer changes."
1407 (let ((start (point)))
1408 ;; When we got newline terminated comments, forward-comment in all
1409 ;; supported emacsen so far will stop at eol of each line not
1410 ;; ending with a comment when moving backwards. This corrects for
1411 ;; that, and at the same time handles line continuations.
1413 (skip-chars-backward " \t\n\r\f\v")
1414 (and (looking-at "[\n\r]")
1415 (eq (char-before) ?\\)))
1419 ;; Some emacsen (e.g. Emacs 19.34) return t when moving
1420 ;; backwards at bob.
1423 ;; Leave point after the closest following newline if we've
1424 ;; backed up over any above, since forward-comment won't move
1425 ;; backward over a line comment if point is at the end of the
1427 (re-search-forward "\\=\\s *[\n\r]" start t)
1429 (if (if (let (open-paren-in-column-0-is-defun-start) (forward-comment -1))
1431 ;; If forward-comment above succeeded and we're at eol
1432 ;; then the newline we moved over above didn't end a
1433 ;; line comment, so we give it another go.
1434 (let (open-paren-in-column-0-is-defun-start)
1435 (forward-comment -1))
1438 ;; Emacs <= 20 and XEmacs move back over the closer of a
1439 ;; block comment that lacks an opener.
1440 (if (looking-at "\\*/")
1441 (progn (forward-char 2) nil)
1444 (defsubst c-backward-comments ()
1445 "Move backward past all preceding whitespace and comments.
1446 Line continuations, i.e. a backslashes followed by line breaks, are
1447 treated as whitespace. The line breaks that end line comments are
1448 considered to be the comment enders, so the point cannot be at the end
1449 of the same line to move over a line comment. Unlike
1450 c-backward-syntactic-ws, this function doesn't move back over
1451 preprocessor directives.
1453 Note that this function might do hidden buffer changes. See the
1454 comment at the start of cc-engine.el for more info."
1456 (let ((start (point)))
1458 ;; `forward-comment' in some emacsen (e.g. XEmacs 21.4)
1459 ;; return t when moving backwards at bob.
1462 (if (let (open-paren-in-column-0-is-defun-start moved-comment)
1464 (and (not (setq moved-comment (forward-comment -1)))
1465 ;; Cope specifically with ^M^J here -
1466 ;; forward-comment sometimes gets stuck after ^Ms,
1467 ;; sometimes after ^M^J.
1469 (when (eq (char-before) ?\r)
1472 (when (and (eq (char-before) ?\n)
1473 (eq (char-before (1- (point))) ?\r))
1477 (if (looking-at "\\*/")
1478 ;; Emacs <= 20 and XEmacs move back over the
1479 ;; closer of a block comment that lacks an opener.
1480 (progn (forward-char 2) nil)
1483 ;; XEmacs treats line continuations as whitespace but
1484 ;; only in the backward direction, which seems a bit
1485 ;; odd. Anyway, this is necessary for Emacs.
1486 (when (and (looking-at "[\n\r]")
1487 (eq (char-before) ?\\)
1493 ;; Tools for skipping over syntactic whitespace.
1495 ;; The following functions use text properties to cache searches over
1496 ;; large regions of syntactic whitespace. It works as follows:
1498 ;; o If a syntactic whitespace region contains anything but simple
1499 ;; whitespace (i.e. space, tab and line breaks), the text property
1500 ;; `c-in-sws' is put over it. At places where we have stopped
1501 ;; within that region there's also a `c-is-sws' text property.
1502 ;; That since there typically are nested whitespace inside that
1503 ;; must be handled separately, e.g. whitespace inside a comment or
1504 ;; cpp directive. Thus, from one point with `c-is-sws' it's safe
1505 ;; to jump to another point with that property within the same
1506 ;; `c-in-sws' region. It can be likened to a ladder where
1507 ;; `c-in-sws' marks the bars and `c-is-sws' the rungs.
1509 ;; o The `c-is-sws' property is put on the simple whitespace chars at
1510 ;; a "rung position" and also maybe on the first following char.
1511 ;; As many characters as can be conveniently found in this range
1512 ;; are marked, but no assumption can be made that the whole range
1513 ;; is marked (it could be clobbered by later changes, for
1516 ;; Note that some part of the beginning of a sequence of simple
1517 ;; whitespace might be part of the end of a preceding line comment
1518 ;; or cpp directive and must not be considered part of the "rung".
1519 ;; Such whitespace is some amount of horizontal whitespace followed
1520 ;; by a newline. In the case of cpp directives it could also be
1521 ;; two newlines with horizontal whitespace between them.
1523 ;; The reason to include the first following char is to cope with
1524 ;; "rung positions" that doesn't have any ordinary whitespace. If
1525 ;; `c-is-sws' is put on a token character it does not have
1526 ;; `c-in-sws' set simultaneously. That's the only case when that
1527 ;; can occur, and the reason for not extending the `c-in-sws'
1528 ;; region to cover it is that the `c-in-sws' region could then be
1529 ;; accidentally merged with a following one if the token is only
1530 ;; one character long.
1532 ;; o On buffer changes the `c-in-sws' and `c-is-sws' properties are
1533 ;; removed in the changed region. If the change was inside
1534 ;; syntactic whitespace that means that the "ladder" is broken, but
1535 ;; a later call to `c-forward-sws' or `c-backward-sws' will use the
1536 ;; parts on either side and use an ordinary search only to "repair"
1539 ;; Special care needs to be taken if a region is removed: If there
1540 ;; are `c-in-sws' on both sides of it which do not connect inside
1541 ;; the region then they can't be joined. If e.g. a marked macro is
1542 ;; broken, syntactic whitespace inside the new text might be
1543 ;; marked. If those marks would become connected with the old
1544 ;; `c-in-sws' range around the macro then we could get a ladder
1545 ;; with one end outside the macro and the other at some whitespace
1548 ;; The main motivation for this system is to increase the speed in
1549 ;; skipping over the large whitespace regions that can occur at the
1550 ;; top level in e.g. header files that contain a lot of comments and
1551 ;; cpp directives. For small comments inside code it's probably
1552 ;; slower than using `forward-comment' straightforwardly, but speed is
1553 ;; not a significant factor there anyway.
1555 ; (defface c-debug-is-sws-face
1556 ; '((t (:background "GreenYellow")))
1557 ; "Debug face to mark the `c-is-sws' property.")
1558 ; (defface c-debug-in-sws-face
1559 ; '((t (:underline t)))
1560 ; "Debug face to mark the `c-in-sws' property.")
1562 ; (defun c-debug-put-sws-faces ()
1563 ; ;; Put the sws debug faces on all the `c-is-sws' and `c-in-sws'
1564 ; ;; properties in the buffer.
1567 ; (c-save-buffer-state (in-face)
1568 ; (goto-char (point-min))
1569 ; (setq in-face (if (get-text-property (point) 'c-is-sws)
1572 ; (goto-char (next-single-property-change
1573 ; (point) 'c-is-sws nil (point-max)))
1576 ; (c-debug-add-face in-face (point) 'c-debug-is-sws-face)
1577 ; (setq in-face nil))
1578 ; (setq in-face (point)))
1580 ; (goto-char (point-min))
1581 ; (setq in-face (if (get-text-property (point) 'c-in-sws)
1584 ; (goto-char (next-single-property-change
1585 ; (point) 'c-in-sws nil (point-max)))
1588 ; (c-debug-add-face in-face (point) 'c-debug-in-sws-face)
1589 ; (setq in-face nil))
1590 ; (setq in-face (point)))
1593 (defmacro c-debug-sws-msg (&rest args)
1597 (defmacro c-put-is-sws (beg end)
1598 ;; This macro does a hidden buffer change.
1599 `(let ((beg ,beg) (end ,end))
1600 (put-text-property beg end 'c-is-sws t)
1601 ,@(when (facep 'c-debug-is-sws-face)
1602 `((c-debug-add-face beg end 'c-debug-is-sws-face)))))
1604 (defmacro c-put-in-sws (beg end)
1605 ;; This macro does a hidden buffer change.
1606 `(let ((beg ,beg) (end ,end))
1607 (put-text-property beg end 'c-in-sws t)
1608 ,@(when (facep 'c-debug-is-sws-face)
1609 `((c-debug-add-face beg end 'c-debug-in-sws-face)))))
1611 (defmacro c-remove-is-sws (beg end)
1612 ;; This macro does a hidden buffer change.
1613 `(let ((beg ,beg) (end ,end))
1614 (remove-text-properties beg end '(c-is-sws nil))
1615 ,@(when (facep 'c-debug-is-sws-face)
1616 `((c-debug-remove-face beg end 'c-debug-is-sws-face)))))
1618 (defmacro c-remove-in-sws (beg end)
1619 ;; This macro does a hidden buffer change.
1620 `(let ((beg ,beg) (end ,end))
1621 (remove-text-properties beg end '(c-in-sws nil))
1622 ,@(when (facep 'c-debug-is-sws-face)
1623 `((c-debug-remove-face beg end 'c-debug-in-sws-face)))))
1625 (defmacro c-remove-is-and-in-sws (beg end)
1626 ;; This macro does a hidden buffer change.
1627 `(let ((beg ,beg) (end ,end))
1628 (remove-text-properties beg end '(c-is-sws nil c-in-sws nil))
1629 ,@(when (facep 'c-debug-is-sws-face)
1630 `((c-debug-remove-face beg end 'c-debug-is-sws-face)
1631 (c-debug-remove-face beg end 'c-debug-in-sws-face)))))
1633 (defsubst c-invalidate-sws-region-after (beg end)
1634 ;; Called from `after-change-functions'. Note that if
1635 ;; `c-forward-sws' or `c-backward-sws' are used outside
1636 ;; `c-save-buffer-state' or similar then this will remove the cache
1637 ;; properties right after they're added.
1639 ;; This function does hidden buffer changes.
1642 ;; Adjust the end to remove the properties in any following simple
1643 ;; ws up to and including the next line break, if there is any
1644 ;; after the changed region. This is necessary e.g. when a rung
1645 ;; marked empty line is converted to a line comment by inserting
1646 ;; "//" before the line break. In that case the line break would
1647 ;; keep the rung mark which could make a later `c-backward-sws'
1648 ;; move into the line comment instead of over it.
1650 (skip-chars-forward " \t\f\v")
1651 (when (and (eolp) (not (eobp)))
1652 (setq end (1+ (point)))))
1654 (when (and (= beg end)
1655 (get-text-property beg 'c-in-sws)
1657 (get-text-property (1- beg) 'c-in-sws))
1658 ;; Ensure that an `c-in-sws' range gets broken. Note that it isn't
1659 ;; safe to keep a range that was continuous before the change. E.g:
1665 ;; There can be a "ladder" between "#" and "b". Now, if the newline
1666 ;; after "foo" is removed then "bar" will become part of the cpp
1667 ;; directive instead of a syntactically relevant token. In that
1668 ;; case there's no longer syntactic ws from "#" to "b".
1669 (setq beg (1- beg)))
1671 (c-debug-sws-msg "c-invalidate-sws-region-after [%s..%s]" beg end)
1672 (c-remove-is-and-in-sws beg end))
1674 (defun c-forward-sws ()
1675 ;; Used by `c-forward-syntactic-ws' to implement the unbounded search.
1677 ;; This function might do hidden buffer changes.
1679 (let (;; `rung-pos' is set to a position as early as possible in the
1680 ;; unmarked part of the simple ws region.
1681 (rung-pos (point)) next-rung-pos rung-end-pos last-put-in-sws-pos
1682 rung-is-marked next-rung-is-marked simple-ws-end
1683 ;; `safe-start' is set when it's safe to cache the start position.
1684 ;; It's not set if we've initially skipped over comments and line
1685 ;; continuations since we might have gone out through the end of a
1686 ;; macro then. This provision makes `c-forward-sws' not populate the
1687 ;; cache in the majority of cases, but otoh is `c-backward-sws' by far
1691 ;; Skip simple ws and do a quick check on the following character to see
1692 ;; if it's anything that can't start syntactic ws, so we can bail out
1693 ;; early in the majority of cases when there just are a few ws chars.
1694 (skip-chars-forward " \t\n\r\f\v")
1695 (when (looking-at c-syntactic-ws-start)
1697 (setq rung-end-pos (min (1+ (point)) (point-max)))
1698 (if (setq rung-is-marked (text-property-any rung-pos rung-end-pos
1700 ;; Find the last rung position to avoid setting properties in all
1701 ;; the cases when the marked rung is complete.
1702 ;; (`next-single-property-change' is certain to move at least one
1704 (setq rung-pos (1- (next-single-property-change
1705 rung-is-marked 'c-is-sws nil rung-end-pos)))
1706 ;; Got no marked rung here. Since the simple ws might have started
1707 ;; inside a line comment or cpp directive we must set `rung-pos' as
1708 ;; high as possible.
1709 (setq rung-pos (point)))
1711 (with-silent-modifications
1715 (when (and rung-is-marked
1716 (get-text-property (point) 'c-in-sws))
1718 ;; The following search is the main reason that `c-in-sws'
1719 ;; and `c-is-sws' aren't combined to one property.
1720 (goto-char (next-single-property-change
1721 (point) 'c-in-sws nil (point-max)))
1722 (unless (get-text-property (point) 'c-is-sws)
1723 ;; If the `c-in-sws' region extended past the last
1724 ;; `c-is-sws' char we have to go back a bit.
1725 (or (get-text-property (1- (point)) 'c-is-sws)
1726 (goto-char (previous-single-property-change
1727 (point) 'c-is-sws)))
1731 "c-forward-sws cached move %s -> %s (max %s)"
1732 rung-pos (point) (point-max))
1734 (setq rung-pos (point))
1735 (and (> (skip-chars-forward " \t\n\r\f\v") 0)
1738 ;; We'll loop here if there is simple ws after the last rung.
1739 ;; That means that there's been some change in it and it's
1740 ;; possible that we've stepped into another ladder, so extend
1741 ;; the previous one to join with it if there is one, and try to
1742 ;; use the cache again.
1744 "c-forward-sws extending rung with [%s..%s] (max %s)"
1745 (1+ rung-pos) (1+ (point)) (point-max))
1746 (unless (get-text-property (point) 'c-is-sws)
1747 ;; Remove any `c-in-sws' property from the last char of
1748 ;; the rung before we mark it with `c-is-sws', so that we
1749 ;; won't connect with the remains of a broken "ladder".
1750 (c-remove-in-sws (point) (1+ (point))))
1751 (c-put-is-sws (1+ rung-pos)
1753 (c-put-in-sws rung-pos
1754 (setq rung-pos (point)
1755 last-put-in-sws-pos rung-pos)))
1757 (setq simple-ws-end (point))
1758 (c-forward-comments)
1761 ((/= (point) simple-ws-end)
1762 ;; Skipped over comments. Don't cache at eob in case the buffer
1767 (and c-opt-cpp-prefix
1768 (looking-at c-opt-cpp-start)
1769 (progn (skip-chars-backward " \t")
1772 (progn (backward-char)
1773 (not (eq (char-before) ?\\))))))
1774 ;; Skip a preprocessor directive.
1776 (while (and (eq (char-before) ?\\)
1777 (= (forward-line 1) 0))
1781 ;; Don't cache at eob in case the buffer is narrowed.
1784 ;; We've searched over a piece of non-white syntactic ws. See if this
1786 (setq next-rung-pos (point))
1787 (skip-chars-forward " \t\n\r\f\v")
1788 (setq rung-end-pos (min (1+ (point)) (point-max)))
1791 ;; Cache if we haven't skipped comments only, and if we started
1792 ;; either from a marked rung or from a completely uncached
1796 (not (get-text-property simple-ws-end 'c-in-sws))))
1798 ;; See if there's a marked rung in the encountered simple ws. If
1799 ;; so then we can cache, unless `safe-start' is nil. Even then
1800 ;; we need to do this to check if the cache can be used for the
1802 (and (setq next-rung-is-marked
1803 (text-property-any next-rung-pos rung-end-pos
1809 "c-forward-sws caching [%s..%s] - [%s..%s] (max %s)"
1810 rung-pos (1+ simple-ws-end) next-rung-pos rung-end-pos
1813 ;; Remove the properties for any nested ws that might be cached.
1814 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
1816 (c-remove-is-sws (1+ simple-ws-end) next-rung-pos)
1817 (unless (and rung-is-marked (= rung-pos simple-ws-end))
1818 (c-put-is-sws rung-pos
1820 (setq rung-is-marked t))
1821 (c-put-in-sws rung-pos
1822 (setq rung-pos (point)
1823 last-put-in-sws-pos rung-pos))
1824 (unless (get-text-property (1- rung-end-pos) 'c-is-sws)
1825 ;; Remove any `c-in-sws' property from the last char of
1826 ;; the rung before we mark it with `c-is-sws', so that we
1827 ;; won't connect with the remains of a broken "ladder".
1828 (c-remove-in-sws (1- rung-end-pos) rung-end-pos))
1829 (c-put-is-sws next-rung-pos
1833 "c-forward-sws not caching [%s..%s] - [%s..%s] (max %s)"
1834 rung-pos (1+ simple-ws-end) next-rung-pos rung-end-pos
1837 ;; Set `rung-pos' for the next rung. It's the same thing here as
1838 ;; initially, except that the rung position is set as early as
1839 ;; possible since we can't be in the ending ws of a line comment or
1840 ;; cpp directive now.
1841 (if (setq rung-is-marked next-rung-is-marked)
1842 (setq rung-pos (1- (next-single-property-change
1843 rung-is-marked 'c-is-sws nil rung-end-pos)))
1844 (setq rung-pos next-rung-pos))
1845 (setq safe-start t)))
1847 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
1848 ;; another one after the point (which might occur when editing inside a
1849 ;; comment or macro).
1850 (when (eq last-put-in-sws-pos (point))
1851 (cond ((< last-put-in-sws-pos (point-max))
1853 "c-forward-sws clearing at %s for cache separation"
1854 last-put-in-sws-pos)
1855 (c-remove-in-sws last-put-in-sws-pos
1856 (1+ last-put-in-sws-pos)))
1858 ;; If at eob we have to clear the last character before the end
1859 ;; instead since the buffer might be narrowed and there might
1860 ;; be a `c-in-sws' after (point-max). In this case it's
1861 ;; necessary to clear both properties.
1863 "c-forward-sws clearing thoroughly at %s for cache separation"
1864 (1- last-put-in-sws-pos))
1865 (c-remove-is-and-in-sws (1- last-put-in-sws-pos)
1866 last-put-in-sws-pos))))
1869 (defun c-backward-sws ()
1870 ;; Used by `c-backward-syntactic-ws' to implement the unbounded search.
1872 ;; This function might do hidden buffer changes.
1874 (let (;; `rung-pos' is set to a position as late as possible in the unmarked
1875 ;; part of the simple ws region.
1876 (rung-pos (point)) next-rung-pos last-put-in-sws-pos
1877 rung-is-marked simple-ws-beg cmt-skip-pos)
1879 ;; Skip simple horizontal ws and do a quick check on the preceding
1880 ;; character to see if it's anything that can't end syntactic ws, so we can
1881 ;; bail out early in the majority of cases when there just are a few ws
1882 ;; chars. Newlines are complicated in the backward direction, so we can't
1884 (skip-chars-backward " \t\f")
1885 (when (and (not (bobp))
1888 (looking-at c-syntactic-ws-end)))
1890 ;; Try to find a rung position in the simple ws preceding point, so that
1891 ;; we can get a cache hit even if the last bit of the simple ws has
1892 ;; changed recently.
1893 (setq simple-ws-beg (point))
1894 (skip-chars-backward " \t\n\r\f\v")
1895 (if (setq rung-is-marked (text-property-any
1896 (point) (min (1+ rung-pos) (point-max))
1898 ;; `rung-pos' will be the earliest marked position, which means that
1899 ;; there might be later unmarked parts in the simple ws region.
1900 ;; It's not worth the effort to fix that; the last part of the
1901 ;; simple ws is also typically edited often, so it could be wasted.
1902 (goto-char (setq rung-pos rung-is-marked))
1903 (goto-char simple-ws-beg))
1905 (with-silent-modifications
1909 (when (and rung-is-marked
1911 (get-text-property (1- (point)) 'c-in-sws))
1913 ;; The following search is the main reason that `c-in-sws'
1914 ;; and `c-is-sws' aren't combined to one property.
1915 (goto-char (previous-single-property-change
1916 (point) 'c-in-sws nil (point-min)))
1917 (unless (get-text-property (point) 'c-is-sws)
1918 ;; If the `c-in-sws' region extended past the first
1919 ;; `c-is-sws' char we have to go forward a bit.
1920 (goto-char (next-single-property-change
1921 (point) 'c-is-sws)))
1924 "c-backward-sws cached move %s <- %s (min %s)"
1925 (point) rung-pos (point-min))
1927 (setq rung-pos (point))
1928 (if (and (< (min (skip-chars-backward " \t\f\v")
1930 (setq simple-ws-beg (point))
1931 (skip-chars-backward " \t\n\r\f\v")))
1933 (setq rung-is-marked
1934 (text-property-any (point) rung-pos
1937 (goto-char simple-ws-beg)
1940 ;; We'll loop here if there is simple ws before the first rung.
1941 ;; That means that there's been some change in it and it's
1942 ;; possible that we've stepped into another ladder, so extend
1943 ;; the previous one to join with it if there is one, and try to
1944 ;; use the cache again.
1946 "c-backward-sws extending rung with [%s..%s] (min %s)"
1947 rung-is-marked rung-pos (point-min))
1948 (unless (get-text-property (1- rung-pos) 'c-is-sws)
1949 ;; Remove any `c-in-sws' property from the last char of
1950 ;; the rung before we mark it with `c-is-sws', so that we
1951 ;; won't connect with the remains of a broken "ladder".
1952 (c-remove-in-sws (1- rung-pos) rung-pos))
1953 (c-put-is-sws rung-is-marked
1955 (c-put-in-sws rung-is-marked
1957 (setq rung-pos rung-is-marked
1958 last-put-in-sws-pos rung-pos))
1960 (c-backward-comments)
1961 (setq cmt-skip-pos (point))
1964 ((and c-opt-cpp-prefix
1965 (/= cmt-skip-pos simple-ws-beg)
1966 (c-beginning-of-macro))
1967 ;; Inside a cpp directive. See if it should be skipped over.
1968 (let ((cpp-beg (point)))
1970 ;; Move back over all line continuations in the region skipped
1971 ;; over by `c-backward-comments'. If we go past it then we
1972 ;; started inside the cpp directive.
1973 (goto-char simple-ws-beg)
1975 (while (and (> (point) cmt-skip-pos)
1976 (progn (backward-char)
1977 (eq (char-before) ?\\)))
1978 (beginning-of-line))
1980 (if (< (point) cmt-skip-pos)
1981 ;; Don't move past the cpp directive if we began inside
1982 ;; it. Note that the position at the end of the last line
1983 ;; of the macro is also considered to be within it.
1984 (progn (goto-char cmt-skip-pos)
1987 ;; It's worthwhile to spend a little bit of effort on finding
1988 ;; the end of the macro, to get a good `simple-ws-beg'
1989 ;; position for the cache. Note that `c-backward-comments'
1990 ;; could have stepped over some comments before going into
1991 ;; the macro, and then `simple-ws-beg' must be kept on the
1992 ;; same side of those comments.
1993 (goto-char simple-ws-beg)
1994 (skip-chars-backward " \t\n\r\f\v")
1995 (if (eq (char-before) ?\\)
1998 (if (< (point) simple-ws-beg)
1999 ;; Might happen if comments after the macro were skipped
2001 (setq simple-ws-beg (point)))
2006 ((/= (save-excursion
2007 (skip-chars-forward " \t\n\r\f\v" simple-ws-beg)
2008 (setq next-rung-pos (point)))
2010 ;; Skipped over comments. Must put point at the end of
2011 ;; the simple ws at point since we might be after a line
2012 ;; comment or cpp directive that's been partially
2013 ;; narrowed out, and we can't risk marking the simple ws
2014 ;; at the end of it.
2015 (goto-char next-rung-pos)
2018 ;; We've searched over a piece of non-white syntactic ws. See if this
2020 (setq next-rung-pos (point))
2021 (skip-chars-backward " \t\f\v")
2024 ;; Cache if we started either from a marked rung or from a
2025 ;; completely uncached position.
2027 (not (get-text-property (1- simple-ws-beg) 'c-in-sws))
2029 ;; Cache if there's a marked rung in the encountered simple ws.
2031 (skip-chars-backward " \t\n\r\f\v")
2032 (text-property-any (point) (min (1+ next-rung-pos) (point-max))
2037 "c-backward-sws caching [%s..%s] - [%s..%s] (min %s)"
2038 (point) (1+ next-rung-pos)
2039 simple-ws-beg (min (1+ rung-pos) (point-max))
2042 ;; Remove the properties for any nested ws that might be cached.
2043 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
2045 (c-remove-is-sws (1+ next-rung-pos) simple-ws-beg)
2046 (unless (and rung-is-marked (= simple-ws-beg rung-pos))
2047 (let ((rung-end-pos (min (1+ rung-pos) (point-max))))
2048 (unless (get-text-property (1- rung-end-pos) 'c-is-sws)
2049 ;; Remove any `c-in-sws' property from the last char of
2050 ;; the rung before we mark it with `c-is-sws', so that we
2051 ;; won't connect with the remains of a broken "ladder".
2052 (c-remove-in-sws (1- rung-end-pos) rung-end-pos))
2053 (c-put-is-sws simple-ws-beg
2055 (setq rung-is-marked t)))
2056 (c-put-in-sws (setq simple-ws-beg (point)
2057 last-put-in-sws-pos simple-ws-beg)
2059 (c-put-is-sws (setq rung-pos simple-ws-beg)
2060 (1+ next-rung-pos)))
2063 "c-backward-sws not caching [%s..%s] - [%s..%s] (min %s)"
2064 (point) (1+ next-rung-pos)
2065 simple-ws-beg (min (1+ rung-pos) (point-max))
2067 (setq rung-pos next-rung-pos
2068 simple-ws-beg (point))
2071 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
2072 ;; another one before the point (which might occur when editing inside a
2073 ;; comment or macro).
2074 (when (eq last-put-in-sws-pos (point))
2075 (cond ((< (point-min) last-put-in-sws-pos)
2077 "c-backward-sws clearing at %s for cache separation"
2078 (1- last-put-in-sws-pos))
2079 (c-remove-in-sws (1- last-put-in-sws-pos)
2080 last-put-in-sws-pos))
2082 ;; If at bob and the buffer is narrowed, we have to clear the
2083 ;; character we're standing on instead since there might be a
2084 ;; `c-in-sws' before (point-min). In this case it's necessary
2085 ;; to clear both properties.
2087 "c-backward-sws clearing thoroughly at %s for cache separation"
2088 last-put-in-sws-pos)
2089 (c-remove-is-and-in-sws last-put-in-sws-pos
2090 (1+ last-put-in-sws-pos)))))
2094 ;; Other whitespace tools
2095 (defun c-partial-ws-p (beg end)
2096 ;; Is the region (beg end) WS, and is there WS (or BOB/EOB) next to the
2097 ;; region? This is a "heuristic" function. .....
2099 ;; The motivation for the second bit is to check whether removing this
2100 ;; region would coalesce two symbols.
2102 ;; FIXME!!! This function doesn't check virtual semicolons in any way. Be
2103 ;; careful about using this function for, e.g. AWK. (2007/3/7)
2105 (let ((end+1 (min (1+ end) (point-max))))
2106 (or (progn (goto-char (max (point-min) (1- beg)))
2107 (c-skip-ws-forward end)
2109 (progn (goto-char beg)
2110 (c-skip-ws-forward end+1)
2111 (eq (point) end+1))))))
2113 ;; A system for finding noteworthy parens before the point.
2115 (defconst c-state-cache-too-far 5000)
2116 ;; A maximum comfortable scanning distance, e.g. between
2117 ;; `c-state-cache-good-pos' and "HERE" (where we call c-parse-state). When
2118 ;; this distance is exceeded, we take "emergency measures", e.g. by clearing
2119 ;; the cache and starting again from point-min or a beginning of defun. This
2120 ;; value can be tuned for efficiency or set to a lower value for testing.
2122 (defvar c-state-cache nil)
2123 (make-variable-buffer-local 'c-state-cache)
2124 ;; The state cache used by `c-parse-state' to cut down the amount of
2125 ;; searching. It's the result from some earlier `c-parse-state' call. See
2126 ;; `c-parse-state''s doc string for details of its structure.
2128 ;; The use of the cached info is more effective if the next
2129 ;; `c-parse-state' call is on a line close by the one the cached state
2130 ;; was made at; the cache can actually slow down a little if the
2131 ;; cached state was made very far back in the buffer. The cache is
2132 ;; most effective if `c-parse-state' is used on each line while moving
2135 (defvar c-state-cache-good-pos 1)
2136 (make-variable-buffer-local 'c-state-cache-good-pos)
2137 ;; This is a position where `c-state-cache' is known to be correct, or
2138 ;; nil (see below). It's a position inside one of the recorded unclosed
2139 ;; parens or the top level, but not further nested inside any literal or
2140 ;; subparen that is closed before the last recorded position.
2142 ;; The exact position is chosen to try to be close to yet earlier than
2143 ;; the position where `c-state-cache' will be called next. Right now
2144 ;; the heuristic is to set it to the position after the last found
2145 ;; closing paren (of any type) before the line on which
2146 ;; `c-parse-state' was called. That is chosen primarily to work well
2147 ;; with refontification of the current line.
2149 ;; 2009-07-28: When `c-state-point-min' and the last position where
2150 ;; `c-parse-state' or for which `c-invalidate-state-cache' was called, are
2151 ;; both in the same literal, there is no such "good position", and
2152 ;; c-state-cache-good-pos is then nil. This is the ONLY circumstance in which
2153 ;; it can be nil. In this case, `c-state-point-min-literal' will be non-nil.
2155 ;; 2009-06-12: In a brace desert, c-state-cache-good-pos may also be in
2156 ;; the middle of the desert, as long as it is not within a brace pair
2157 ;; recorded in `c-state-cache' or a paren/bracket pair.
2160 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2161 ;; We maintain a simple cache of positions which aren't in a literal, so as to
2162 ;; speed up testing for non-literality.
2163 (defconst c-state-nonlit-pos-interval 3000)
2164 ;; The approximate interval between entries in `c-state-nonlit-pos-cache'.
2166 (defvar c-state-nonlit-pos-cache nil)
2167 (make-variable-buffer-local 'c-state-nonlit-pos-cache)
2168 ;; A list of buffer positions which are known not to be in a literal or a cpp
2169 ;; construct. This is ordered with higher positions at the front of the list.
2170 ;; Only those which are less than `c-state-nonlit-pos-cache-limit' are valid.
2172 (defvar c-state-nonlit-pos-cache-limit 1)
2173 (make-variable-buffer-local 'c-state-nonlit-pos-cache-limit)
2174 ;; An upper limit on valid entries in `c-state-nonlit-pos-cache'. This is
2175 ;; reduced by buffer changes, and increased by invocations of
2176 ;; `c-state-literal-at'.
2178 (defvar c-state-semi-nonlit-pos-cache nil)
2179 (make-variable-buffer-local 'c-state-semi-nonlit-pos-cache)
2180 ;; A list of buffer positions which are known not to be in a literal. This is
2181 ;; ordered with higher positions at the front of the list. Only those which
2182 ;; are less than `c-state-semi-nonlit-pos-cache-limit' are valid.
2184 (defvar c-state-semi-nonlit-pos-cache-limit 1)
2185 (make-variable-buffer-local 'c-state-semi-nonlit-pos-cache-limit)
2186 ;; An upper limit on valid entries in `c-state-semi-nonlit-pos-cache'. This is
2187 ;; reduced by buffer changes, and increased by invocations of
2188 ;; `c-state-literal-at'. FIXME!!!
2190 (defsubst c-state-pp-to-literal (from to &optional not-in-delimiter)
2191 ;; Do a parse-partial-sexp from FROM to TO, returning either
2192 ;; (STATE TYPE (BEG . END)) if TO is in a literal; or
2193 ;; (STATE) otherwise,
2194 ;; where STATE is the parsing state at TO, TYPE is the type of the literal
2195 ;; (one of 'c, 'c++, 'string) and (BEG . END) is the boundaries of the literal.
2197 ;; Unless NOT-IN-DELIMITER is non-nil, when TO is inside a two-character
2198 ;; comment opener, this is recognized as being in a comment literal.
2200 ;; Only elements 3 (in a string), 4 (in a comment), 5 (following a quote),
2201 ;; 7 (comment type) and 8 (start of comment/string) (and possibly 9) of
2204 (let ((s (parse-partial-sexp from to))
2207 ((or (nth 3 s) (nth 4 s)) ; in a string or comment
2212 (parse-partial-sexp (point) (point-max)
2216 'syntax-table) ; stop at end of literal
2217 `(,s ,ty (,(nth 8 s) . ,(point))))
2219 ((and (not not-in-delimiter) ; inside a comment starter
2221 (progn (backward-char)
2222 (looking-at c-comment-start-regexp)))
2223 (setq ty (if (looking-at c-block-comment-start-regexp) 'c 'c++)
2226 `(,s ,ty (,co-st . ,(point))))
2230 (defun c-state-safe-place (here)
2231 ;; Return a buffer position before HERE which is "safe", i.e. outside any
2232 ;; string, comment, or macro.
2234 ;; NOTE: This function manipulates `c-state-nonlit-pos-cache'. This cache
2235 ;; MAY NOT contain any positions within macros, since macros are frequently
2236 ;; turned into comments by use of the `c-cpp-delimiter' category properties.
2237 ;; We cannot rely on this mechanism whilst determining a cache pos since
2238 ;; this function is also called from outwith `c-parse-state'.
2242 (let ((c c-state-nonlit-pos-cache)
2243 pos npos high-pos lit macro-beg macro-end)
2244 ;; Trim the cache to take account of buffer changes.
2245 (while (and c (> (car c) c-state-nonlit-pos-cache-limit))
2247 (setq c-state-nonlit-pos-cache c)
2249 (while (and c (> (car c) here))
2250 (setq high-pos (car c))
2252 (setq pos (or (car c) (point-min)))
2256 ;; Add an element to `c-state-nonlit-pos-cache' each iteration.
2258 (<= (setq npos (+ pos c-state-nonlit-pos-interval)) here)
2260 ;; Test for being in a literal. If so, go to after it.
2262 (setq lit (car (cddr (c-state-pp-to-literal pos npos))))
2264 (prog1 (<= (cdr lit) here)
2265 (setq npos (cdr lit)))))
2267 ;; Test for being in a macro. If so, go to after it.
2271 (and (c-beginning-of-macro) (/= (point) npos) (point)))
2273 (c-syntactic-end-of-macro)
2274 (or (eobp) (forward-char))
2275 (setq macro-end (point)))
2276 (or (null macro-beg)
2277 (prog1 (<= macro-end here)
2278 (setq npos macro-end)))))
2281 (setq c-state-nonlit-pos-cache (cons pos c-state-nonlit-pos-cache)))
2282 ;; Add one extra element above HERE so as to to avoid the previous
2283 ;; expensive calculation when the next call is close to the current
2284 ;; one. This is especially useful when inside a large macro.
2285 (setq c-state-nonlit-pos-cache (cons npos c-state-nonlit-pos-cache)))
2287 (if (> pos c-state-nonlit-pos-cache-limit)
2288 (setq c-state-nonlit-pos-cache-limit pos))
2291 (defun c-state-semi-safe-place (here)
2292 ;; Return a buffer position before HERE which is "safe", i.e. outside any
2293 ;; string or comment. It may be in a macro.
2297 (let ((c c-state-semi-nonlit-pos-cache)
2298 pos npos high-pos lit macro-beg macro-end)
2299 ;; Trim the cache to take account of buffer changes.
2300 (while (and c (> (car c) c-state-semi-nonlit-pos-cache-limit))
2302 (setq c-state-semi-nonlit-pos-cache c)
2304 (while (and c (> (car c) here))
2305 (setq high-pos (car c))
2307 (setq pos (or (car c) (point-min)))
2311 ;; Add an element to `c-state-semi-nonlit-pos-cache' each iteration.
2313 (<= (setq npos (+ pos c-state-nonlit-pos-interval)) here)
2315 ;; Test for being in a literal. If so, go to after it.
2317 (setq lit (car (cddr (c-state-pp-to-literal pos npos))))
2319 (prog1 (<= (cdr lit) here)
2320 (setq npos (cdr lit))))))
2323 (setq c-state-semi-nonlit-pos-cache
2324 (cons pos c-state-semi-nonlit-pos-cache))))
2326 (if (> pos c-state-semi-nonlit-pos-cache-limit)
2327 (setq c-state-semi-nonlit-pos-cache-limit pos))
2330 (defun c-state-literal-at (here)
2331 ;; If position HERE is inside a literal, return (START . END), the
2332 ;; boundaries of the literal (which may be outside the accessible bit of the
2333 ;; buffer). Otherwise, return nil.
2335 ;; This function is almost the same as `c-literal-limits'. Previously, it
2336 ;; differed in that it was a lower level function, and that it rigorously
2337 ;; followed the syntax from BOB. `c-literal-limits' is now (2011-12)
2338 ;; virtually identical to this function.
2342 (let ((pos (c-state-safe-place here)))
2343 (car (cddr (c-state-pp-to-literal pos here)))))))
2345 (defsubst c-state-lit-beg (pos)
2346 ;; Return the start of the literal containing POS, or POS itself.
2347 (or (car (c-state-literal-at pos))
2350 (defsubst c-state-cache-non-literal-place (pos state)
2351 ;; Return a position outside of a string/comment/macro at or before POS.
2352 ;; STATE is the parse-partial-sexp state at POS.
2353 (let ((res (if (or (nth 3 state) ; in a string?
2354 (nth 4 state)) ; in a comment?
2359 (if (c-beginning-of-macro)
2363 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2364 ;; Stuff to do with point-min, and coping with any literal there.
2365 (defvar c-state-point-min 1)
2366 (make-variable-buffer-local 'c-state-point-min)
2367 ;; This is (point-min) when `c-state-cache' was last calculated. A change of
2368 ;; narrowing is likely to affect the parens that are visible before the point.
2370 (defvar c-state-point-min-lit-type nil)
2371 (make-variable-buffer-local 'c-state-point-min-lit-type)
2372 (defvar c-state-point-min-lit-start nil)
2373 (make-variable-buffer-local 'c-state-point-min-lit-start)
2374 ;; These two variables define the literal, if any, containing point-min.
2375 ;; Their values are, respectively, 'string, c, or c++, and the start of the
2376 ;; literal. If there's no literal there, they're both nil.
2378 (defvar c-state-min-scan-pos 1)
2379 (make-variable-buffer-local 'c-state-min-scan-pos)
2380 ;; This is the earliest buffer-pos from which scanning can be done. It is
2381 ;; either the end of the literal containing point-min, or point-min itself.
2382 ;; It becomes nil if the buffer is changed earlier than this point.
2383 (defun c-state-get-min-scan-pos ()
2384 ;; Return the lowest valid scanning pos. This will be the end of the
2385 ;; literal enclosing point-min, or point-min itself.
2386 (or c-state-min-scan-pos
2390 (goto-char c-state-point-min-lit-start)
2391 (if (eq c-state-point-min-lit-type 'string)
2393 (forward-comment 1))
2394 (setq c-state-min-scan-pos (point))))))
2396 (defun c-state-mark-point-min-literal ()
2397 ;; Determine the properties of any literal containing POINT-MIN, setting the
2398 ;; variables `c-state-point-min-lit-type', `c-state-point-min-lit-start',
2399 ;; and `c-state-min-scan-pos' accordingly. The return value is meaningless.
2400 (let ((p-min (point-min))
2404 (setq lit (c-state-literal-at p-min))
2406 (setq c-state-point-min-lit-type
2408 (goto-char (car lit))
2410 ((looking-at c-block-comment-start-regexp) 'c)
2411 ((looking-at c-line-comment-starter) 'c++)
2413 c-state-point-min-lit-start (car lit)
2414 c-state-min-scan-pos (cdr lit))
2415 (setq c-state-point-min-lit-type nil
2416 c-state-point-min-lit-start nil
2417 c-state-min-scan-pos p-min)))))
2420 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2421 ;; A variable which signals a brace dessert - helpful for reducing the number
2422 ;; of fruitless backward scans.
2423 (defvar c-state-brace-pair-desert nil)
2424 (make-variable-buffer-local 'c-state-brace-pair-desert)
2425 ;; Used only in `c-append-lower-brace-pair-to-state-cache'. It is set when
2426 ;; that defun has searched backwards for a brace pair and not found one. Its
2427 ;; value is either nil or a cons (PA . FROM), where PA is the position of the
2428 ;; enclosing opening paren/brace/bracket which bounds the backwards search (or
2429 ;; nil when at top level) and FROM is where the backward search started. It
2430 ;; is reset to nil in `c-invalidate-state-cache'.
2433 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2434 ;; Lowish level functions/macros which work directly on `c-state-cache', or a
2435 ;; list of like structure.
2436 (defmacro c-state-cache-top-lparen (&optional cache)
2437 ;; Return the address of the top left brace/bracket/paren recorded in CACHE
2438 ;; (default `c-state-cache') (or nil).
2439 (let ((cash (or cache 'c-state-cache)))
2440 `(if (consp (car ,cash))
2444 (defmacro c-state-cache-top-paren (&optional cache)
2445 ;; Return the address of the latest brace/bracket/paren (whether left or
2446 ;; right) recorded in CACHE (default `c-state-cache') or nil.
2447 (let ((cash (or cache 'c-state-cache)))
2448 `(if (consp (car ,cash))
2452 (defmacro c-state-cache-after-top-paren (&optional cache)
2453 ;; Return the position just after the latest brace/bracket/paren (whether
2454 ;; left or right) recorded in CACHE (default `c-state-cache') or nil.
2455 (let ((cash (or cache 'c-state-cache)))
2456 `(if (consp (car ,cash))
2459 (1+ (car ,cash))))))
2461 (defun c-get-cache-scan-pos (here)
2462 ;; From the state-cache, determine the buffer position from which we might
2463 ;; scan forward to HERE to update this cache. This position will be just
2464 ;; after a paren/brace/bracket recorded in the cache, if possible, otherwise
2465 ;; return the earliest position in the accessible region which isn't within
2466 ;; a literal. If the visible portion of the buffer is entirely within a
2467 ;; literal, return NIL.
2468 (let ((c c-state-cache) elt)
2469 ;(while (>= (or (c-state-cache-top-lparen c) 1) here)
2471 (>= (c-state-cache-top-lparen c) here))
2477 (if (> (cdr elt) here)
2481 ((<= (c-state-get-min-scan-pos) here)
2482 (c-state-get-min-scan-pos))
2485 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2486 ;; Variables which keep track of preprocessor constructs.
2487 (defvar c-state-old-cpp-beg-marker nil)
2488 (make-variable-buffer-local 'c-state-old-cpp-beg-marker)
2489 (defvar c-state-old-cpp-beg nil)
2490 (make-variable-buffer-local 'c-state-old-cpp-beg)
2491 (defvar c-state-old-cpp-end-marker nil)
2492 (make-variable-buffer-local 'c-state-old-cpp-end-marker)
2493 (defvar c-state-old-cpp-end nil)
2494 (make-variable-buffer-local 'c-state-old-cpp-end)
2495 ;; These are the limits of the macro containing point at the previous call of
2496 ;; `c-parse-state', or nil.
2498 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2499 ;; Defuns which analyze the buffer, yet don't change `c-state-cache'.
2500 (defun c-state-balance-parens-backwards (here- here+ top)
2501 ;; Return the position of the opening paren/brace/bracket before HERE- which
2502 ;; matches the outermost close p/b/b between HERE+ and TOP. Except when
2503 ;; there's a macro, HERE- and HERE+ are the same. Like this:
2505 ;; ............................................
2507 ;; ( [ ( .........#macro.. ) ( ) ] )
2510 ;; return HERE- HERE+ TOP
2512 ;; If there aren't enough opening paren/brace/brackets, return the position
2513 ;; of the outermost one found, or HERE- if there are none. If there are no
2514 ;; closing p/b/bs between HERE+ and TOP, return HERE-. HERE-/+ and TOP
2515 ;; must not be inside literals. Only the accessible portion of the buffer
2518 ;; PART 1: scan from `here+' up to `top', accumulating ")"s which enclose
2519 ;; `here'. Go round the next loop each time we pass over such a ")". These
2520 ;; probably match "("s before `here-'.
2521 (let (pos pa ren+1 lonely-rens)
2524 (narrow-to-region (point-min) top) ; This can move point, sometimes.
2528 (setq ren+1 (scan-lists pos 1 1)) ; might signal
2529 (setq lonely-rens (cons ren+1 lonely-rens)
2532 ;; PART 2: Scan back before `here-' searching for the "("s
2533 ;; matching/mismatching the ")"s found above. We only need to direct the
2534 ;; caller to scan when we've encountered unmatched right parens.
2539 (and lonely-rens ; actual values aren't used.
2540 (setq pa (scan-lists pos -1 1)))
2542 (setq lonely-rens (cdr lonely-rens)))))
2545 (defun c-parse-state-get-strategy (here good-pos)
2546 ;; Determine the scanning strategy for adjusting `c-parse-state', attempting
2547 ;; to minimize the amount of scanning. HERE is the pertinent position in
2548 ;; the buffer, GOOD-POS is a position where `c-state-cache' (possibly with
2549 ;; its head trimmed) is known to be good, or nil if there is no such
2552 ;; The return value is a list, one of the following:
2554 ;; o - ('forward START-POINT) - scan forward from START-POINT,
2555 ;; which is not less than the highest position in `c-state-cache' below here.
2556 ;; o - ('backward nil) - scan backwards (from HERE).
2557 ;; o - ('IN-LIT nil) - point is inside the literal containing point-min.
2558 (let ((cache-pos (c-get-cache-scan-pos here)) ; highest position below HERE in cache (or 1)
2559 strategy ; 'forward, 'backward, or 'IN-LIT.
2561 (setq good-pos (or good-pos (c-state-get-min-scan-pos)))
2563 ((< here (c-state-get-min-scan-pos))
2564 (setq strategy 'IN-LIT))
2566 (setq strategy 'forward
2567 start-point (max good-pos cache-pos)))
2568 ((< (- good-pos here) (- here cache-pos)) ; FIXME!!! ; apply some sort of weighting.
2569 (setq strategy 'backward))
2571 (setq strategy 'forward
2572 start-point cache-pos)))
2573 (list strategy (and (eq strategy 'forward) start-point))))
2576 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2577 ;; Routines which change `c-state-cache' and associated values.
2578 (defun c-renarrow-state-cache ()
2579 ;; The region (more precisely, point-min) has changed since we
2580 ;; calculated `c-state-cache'. Amend `c-state-cache' accordingly.
2581 (if (< (point-min) c-state-point-min)
2582 ;; If point-min has MOVED BACKWARDS then we drop the state completely.
2583 ;; It would be possible to do a better job here and recalculate the top
2586 (c-state-mark-point-min-literal)
2587 (setq c-state-cache nil
2588 c-state-cache-good-pos c-state-min-scan-pos
2589 c-state-brace-pair-desert nil))
2591 ;; point-min has MOVED FORWARD.
2593 ;; Is the new point-min inside a (different) literal?
2594 (unless (and c-state-point-min-lit-start ; at prev. point-min
2595 (< (point-min) (c-state-get-min-scan-pos)))
2596 (c-state-mark-point-min-literal))
2598 ;; Cut off a bit of the tail from `c-state-cache'.
2599 (let ((ptr (cons nil c-state-cache))
2601 (while (and (setq pa (c-state-cache-top-lparen (cdr ptr)))
2602 (>= pa (point-min)))
2603 (setq ptr (cdr ptr)))
2606 (if (eq (cdr ptr) c-state-cache)
2607 (setq c-state-cache nil
2608 c-state-cache-good-pos c-state-min-scan-pos)
2610 (setq c-state-cache-good-pos (1+ (c-state-cache-top-lparen))))
2613 (setq c-state-point-min (point-min)))
2615 (defun c-append-lower-brace-pair-to-state-cache (from here &optional upper-lim)
2616 ;; If there is a brace pair preceding FROM in the buffer, at the same level
2617 ;; of nesting (not necessarily immediately preceding), push a cons onto
2618 ;; `c-state-cache' to represent it. FROM must not be inside a literal. If
2619 ;; UPPER-LIM is non-nil, we append the highest brace pair whose "}" is below
2622 ;; Return non-nil when this has been done.
2624 ;; The situation it copes with is this transformation:
2626 ;; OLD: { (.) {...........}
2630 ;; NEW: { {....} (.) {.........
2632 ;; LOWER BRACE PAIR HERE or HERE
2634 ;; This routine should be fast. Since it can get called a LOT, we maintain
2635 ;; `c-state-brace-pair-desert', a small cache of "failures", such that we
2636 ;; reduce the time wasted in repeated fruitless searches in brace deserts.
2640 (cache-pos (c-state-cache-top-lparen)) ; might be nil.
2641 (macro-start-or-from
2642 (progn (goto-char from)
2643 (c-beginning-of-macro)
2645 (bra ; Position of "{".
2646 ;; Don't start scanning in the middle of a CPP construct unless
2647 ;; it contains HERE - these constructs, in Emacs, are "commented
2648 ;; out" with category properties.
2649 (if (eq (c-get-char-property macro-start-or-from 'category)
2653 ce) ; Position of "}"
2654 (or upper-lim (setq upper-lim from))
2656 ;; If we're essentially repeating a fruitless search, just give up.
2657 (unless (and c-state-brace-pair-desert
2658 (eq cache-pos (car c-state-brace-pair-desert))
2659 (or (null (car c-state-brace-pair-desert))
2660 (> from (car c-state-brace-pair-desert)))
2661 (<= from (cdr c-state-brace-pair-desert)))
2662 ;; DESERT-LIM. Avoid repeated searching through the cached desert.
2664 (and c-state-brace-pair-desert
2665 (eq cache-pos (car c-state-brace-pair-desert))
2666 (>= from (cdr c-state-brace-pair-desert))
2667 (cdr c-state-brace-pair-desert)))
2668 ;; CACHE-LIM. This limit will be necessary when an opening
2669 ;; paren at `cache-pos' has just had its matching close paren
2670 ;; inserted into the buffer. `cache-pos' continues to be a
2671 ;; search bound, even though the algorithm below would skip
2672 ;; over the new paren pair.
2673 (cache-lim (and cache-pos (< cache-pos from) cache-pos)))
2676 ((and desert-lim cache-lim)
2677 (max desert-lim cache-lim))
2681 ;; The top limit is EOB to ensure that `bra' is inside the
2682 ;; accessible part of the buffer at the next scan operation.
2683 (1+ (buffer-size))))
2685 ;; In the next pair of nested loops, the inner one moves back past a
2686 ;; pair of (mis-)matching parens or brackets; the outer one moves
2687 ;; back over a sequence of unmatched close brace/paren/bracket each
2693 (and (setq ce (scan-lists bra -1 -1)) ; back past )/]/}; might signal
2694 (setq bra (scan-lists ce -1 1)) ; back past (/[/{; might signal
2695 (or (> bra here) ;(> ce here)
2698 (or (not (eq (char-after bra) ?\{))
2699 (and (goto-char bra)
2700 (c-beginning-of-macro)
2701 (< (point) macro-start-or-from))))))))
2702 (and ce (< ce bra)))
2703 (setq bra ce)) ; If we just backed over an unbalanced closing
2706 (if (and ce (< ce here) (< bra ce) (eq (char-after bra) ?\{))
2707 ;; We've found the desired brace-pair.
2709 (setq new-cons (cons bra (1+ ce)))
2711 ((consp (car c-state-cache))
2712 (setcar c-state-cache new-cons))
2713 ((and (numberp (car c-state-cache)) ; probably never happens
2714 (< ce (car c-state-cache)))
2715 (setcdr c-state-cache
2716 (cons new-cons (cdr c-state-cache))))
2717 (t (setq c-state-cache (cons new-cons c-state-cache)))))
2719 ;; We haven't found a brace pair. Record this in the cache.
2720 (setq c-state-brace-pair-desert
2721 (cons (if (and ce (< bra ce) (> ce here)) ; {..} straddling HERE?
2724 (min here from)))))))))
2726 (defsubst c-state-push-any-brace-pair (bra+1 macro-start-or-here)
2727 ;; If BRA+1 is nil, do nothing. Otherwise, BRA+1 is the buffer position
2728 ;; following a {, and that brace has a (mis-)matching } (or ]), and we
2729 ;; "push" "a" brace pair onto `c-state-cache'.
2731 ;; Here "push" means overwrite the top element if it's itself a brace-pair,
2732 ;; otherwise push it normally.
2734 ;; The brace pair we push is normally the one surrounding BRA+1, but if the
2735 ;; latter is inside a macro, not being a macro containing
2736 ;; MACRO-START-OR-HERE, we scan backwards through the buffer for a non-macro
2737 ;; base pair. This latter case is assumed to be rare.
2739 ;; Note: POINT is not preserved in this routine.
2741 (if (or (> bra+1 macro-start-or-here)
2742 (progn (goto-char bra+1)
2743 (not (c-beginning-of-macro))))
2745 (cons (cons (1- bra+1)
2746 (scan-lists bra+1 1 1))
2747 (if (consp (car c-state-cache))
2750 ;; N.B. This defsubst codes one method for the simple, normal case,
2751 ;; and a more sophisticated, slower way for the general case. Don't
2752 ;; eliminate this defsubst - it's a speed optimization.
2753 (c-append-lower-brace-pair-to-state-cache (1- bra+1) (point-max)))))
2755 (defun c-append-to-state-cache (from here)
2756 ;; Scan the buffer from FROM to HERE, adding elements into `c-state-cache'
2757 ;; for braces etc. Return a candidate for `c-state-cache-good-pos'.
2759 ;; FROM must be after the latest brace/paren/bracket in `c-state-cache', if
2760 ;; any. Typically, it is immediately after it. It must not be inside a
2762 (let ((here-bol (c-point 'bol here))
2763 (macro-start-or-here
2764 (save-excursion (goto-char here)
2765 (if (c-beginning-of-macro)
2768 pa+1 ; pos just after an opening PAren (or brace).
2769 (ren+1 from) ; usually a pos just after an closing paREN etc.
2770 ; Is actually the pos. to scan for a (/{/[ from,
2771 ; which sometimes is after a silly )/}/].
2772 paren+1 ; Pos after some opening or closing paren.
2773 paren+1s ; A list of `paren+1's; used to determine a
2775 bra+1 ce+1 ; just after L/R bra-ces.
2776 bra+1s ; list of OLD values of bra+1.
2777 mstart) ; start of a macro.
2781 (narrow-to-region (point-min) here)
2782 ;; Each time round the following loop, we enter a successively deeper
2783 ;; level of brace/paren nesting. (Except sometimes we "continue at
2784 ;; the existing level".) `pa+1' is a pos inside an opening
2785 ;; brace/paren/bracket, usually just after it.
2788 ;; Each time round the next loop moves forward over an opening then
2789 ;; a closing brace/bracket/paren. This loop is white hot, so it
2790 ;; plays ugly tricks to go fast. DON'T PUT ANYTHING INTO THIS
2791 ;; LOOP WHICH ISN'T ABSOLUTELY NECESSARY!!! It terminates when a
2792 ;; call of `scan-lists' signals an error, which happens when there
2793 ;; are no more b/b/p's to scan.
2796 (setq pa+1 (scan-lists ren+1 1 -1) ; Into (/{/[; might signal
2797 paren+1s (cons pa+1 paren+1s))
2798 (setq ren+1 (scan-lists pa+1 1 1)) ; Out of )/}/]; might signal
2799 (if (and (eq (char-before pa+1) ?{)) ; Check for a macro later.
2801 (setcar paren+1s ren+1)))
2803 (if (and pa+1 (> pa+1 ren+1))
2804 ;; We've just entered a deeper nesting level.
2806 ;; Insert the brace pair (if present) and the single open
2807 ;; paren/brace/bracket into `c-state-cache' It cannot be
2808 ;; inside a macro, except one around point, because of what
2809 ;; `c-neutralize-syntax-in-CPP' has done.
2810 (c-state-push-any-brace-pair bra+1 macro-start-or-here)
2811 ;; Insert the opening brace/bracket/paren position.
2812 (setq c-state-cache (cons (1- pa+1) c-state-cache))
2813 ;; Clear admin stuff for the next more nested part of the scan.
2814 (setq ren+1 pa+1 pa+1 nil bra+1 nil bra+1s nil)
2815 t) ; Carry on the loop
2817 ;; All open p/b/b's at this nesting level, if any, have probably
2818 ;; been closed by matching/mismatching ones. We're probably
2819 ;; finished - we just need to check for having found an
2820 ;; unmatched )/}/], which we ignore. Such a )/}/] can't be in a
2821 ;; macro, due the action of `c-neutralize-syntax-in-CPP'.
2822 (c-safe (setq ren+1 (scan-lists ren+1 1 1)))))) ; acts as loop control.
2824 ;; Record the final, innermost, brace-pair if there is one.
2825 (c-state-push-any-brace-pair bra+1 macro-start-or-here)
2827 ;; Determine a good pos
2828 (while (and (setq paren+1 (car paren+1s))
2829 (> (if (> paren+1 macro-start-or-here)
2832 (setq mstart (and (c-beginning-of-macro)
2834 (or mstart paren+1))
2836 (setq paren+1s (cdr paren+1s)))
2838 ((and paren+1 mstart)
2839 (min paren+1 mstart))
2843 (defun c-remove-stale-state-cache (start-point here pps-point)
2844 ;; Remove stale entries from the `c-cache-state', i.e. those which will
2845 ;; not be in it when it is amended for position HERE. Additionally, the
2846 ;; "outermost" open-brace entry before HERE will be converted to a cons if
2847 ;; the matching close-brace is scanned.
2849 ;; START-POINT is a "maximal" "safe position" - there must be no open
2850 ;; parens/braces/brackets between START-POINT and HERE.
2852 ;; As a second thing, calculate the result of parse-partial-sexp at
2853 ;; PPS-POINT, w.r.t. START-POINT. The motivation here is that
2854 ;; `c-state-cache-good-pos' may become PPS-POINT, but the caller may need to
2855 ;; adjust it to get outside a string/comment. (Sorry about this! The code
2856 ;; needs to be FAST).
2858 ;; Return a list (GOOD-POS SCAN-BACK-POS PPS-STATE), where
2859 ;; o - GOOD-POS is a position where the new value `c-state-cache' is known
2860 ;; to be good (we aim for this to be as high as possible);
2861 ;; o - SCAN-BACK-POS, if not nil, indicates there may be a brace pair
2862 ;; preceding POS which needs to be recorded in `c-state-cache'. It is a
2863 ;; position to scan backwards from. It is the position of the "{" of the
2864 ;; last element to be removed from `c-state-cache', when that elt is a
2865 ;; cons, otherwise nil.
2866 ;; o - PPS-STATE is the parse-partial-sexp state at PPS-POINT.
2869 (narrow-to-region 1 (point-max))
2870 (let* ((in-macro-start ; start of macro containing HERE or nil.
2873 (and (c-beginning-of-macro)
2875 (start-point-actual-macro-start ; Start of macro containing
2876 ; start-point or nil
2877 (and (< start-point here)
2879 (goto-char start-point)
2880 (and (c-beginning-of-macro)
2882 (start-point-actual-macro-end ; End of this macro, (maybe
2884 (and start-point-actual-macro-start
2886 (goto-char start-point-actual-macro-start)
2889 pps-state ; Will be 9 or 10 elements long.
2891 upper-lim ; ,beyond which `c-state-cache' entries are removed
2893 pair-beg pps-point-state target-depth)
2895 ;; Remove entries beyond HERE. Also remove any entries inside
2896 ;; a macro, unless HERE is in the same macro.
2898 (if (or (null c-state-old-cpp-beg)
2899 (and (> here c-state-old-cpp-beg)
2900 (< here c-state-old-cpp-end)))
2902 (min here c-state-old-cpp-beg)))
2903 (while (and c-state-cache (>= (c-state-cache-top-lparen) upper-lim))
2904 (setq scan-back-pos (car-safe (car c-state-cache)))
2905 (setq c-state-cache (cdr c-state-cache)))
2907 ;; If `upper-lim' is inside the last recorded brace pair, remove its
2908 ;; RBrace and indicate we'll need to search backwards for a previous
2910 (when (and c-state-cache
2911 (consp (car c-state-cache))
2912 (> (cdar c-state-cache) upper-lim))
2913 (setcar c-state-cache (caar c-state-cache))
2914 (setq scan-back-pos (car c-state-cache)))
2916 ;; The next loop jumps forward out of a nested level of parens each
2917 ;; time round; the corresponding elements in `c-state-cache' are
2918 ;; removed. `pos' is just after the brace-pair or the open paren at
2919 ;; (car c-state-cache). There can be no open parens/braces/brackets
2920 ;; between `start-point'/`start-point-actual-macro-start' and HERE,
2921 ;; due to the interface spec to this function.
2922 (setq pos (if (and start-point-actual-macro-end
2923 (not (eq start-point-actual-macro-start
2925 (1+ start-point-actual-macro-end) ; get outside the macro as
2926 ; marked by a `category' text property.
2929 (while (and c-state-cache
2930 (or (numberp (car c-state-cache)) ; Have we a { at all?
2931 (cdr c-state-cache))
2934 ((null pps-state) ; first time through
2935 (setq target-depth -1))
2936 ((eq (car pps-state) target-depth) ; found closing ),},]
2937 (setq target-depth (1- (car pps-state))))
2938 ;; Do nothing when we've merely reached pps-point.
2944 (point) (if (< (point) pps-point) pps-point here)
2948 (if (= (point) pps-point)
2949 (setq pps-point-state pps-state))
2951 (when (eq (car pps-state) target-depth)
2952 (setq pos (point)) ; POS is now just after an R-paren/brace.
2954 ((and (consp (car c-state-cache))
2955 (eq (point) (cdar c-state-cache)))
2956 ;; We've just moved out of the paren pair containing the brace-pair
2957 ;; at (car c-state-cache). `pair-beg' is where the open paren is,
2958 ;; and is potentially where the open brace of a cons in
2959 ;; c-state-cache will be.
2960 (setq pair-beg (car-safe (cdr c-state-cache))
2961 c-state-cache (cdr-safe (cdr c-state-cache)))) ; remove {}pair + containing Lparen.
2962 ((numberp (car c-state-cache))
2963 (setq pair-beg (car c-state-cache)
2964 c-state-cache (cdr c-state-cache))) ; remove this
2966 ((numberp (cadr c-state-cache))
2967 (setq pair-beg (cadr c-state-cache)
2968 c-state-cache (cddr c-state-cache))) ; Remove a paren pair
2969 ; together with enclosed brace pair.
2970 ;; (t nil) ; Ignore an unmated Rparen.
2973 (if (< (point) pps-point)
2974 (setq pps-state (parse-partial-sexp (point) pps-point
2975 nil nil ; TARGETDEPTH, STOPBEFORE
2978 ;; If the last paren pair we moved out of was actually a brace pair,
2979 ;; insert it into `c-state-cache'.
2980 (when (and pair-beg (eq (char-after pair-beg) ?{))
2981 (if (consp (car-safe c-state-cache))
2982 (setq c-state-cache (cdr c-state-cache)))
2983 (setq c-state-cache (cons (cons pair-beg pos)
2986 (list pos scan-back-pos pps-state)))))
2988 (defun c-remove-stale-state-cache-backwards (here)
2989 ;; Strip stale elements of `c-state-cache' by moving backwards through the
2990 ;; buffer, and inform the caller of the scenario detected.
2992 ;; HERE is the position we're setting `c-state-cache' for.
2993 ;; CACHE-POS (a locally bound variable) is just after the latest recorded
2994 ;; position in `c-state-cache' before HERE, or a position at or near
2995 ;; point-min which isn't in a literal.
2997 ;; This function must only be called only when (> `c-state-cache-good-pos'
2998 ;; HERE). Usually the gap between CACHE-POS and HERE is large. It is thus
2999 ;; optimized to eliminate (or minimize) scanning between these two
3002 ;; Return a three element list (GOOD-POS SCAN-BACK-POS FWD-FLAG), where:
3003 ;; o - GOOD-POS is a "good position", where `c-state-cache' is valid, or
3004 ;; could become so after missing elements are inserted into
3005 ;; `c-state-cache'. This is JUST AFTER an opening or closing
3006 ;; brace/paren/bracket which is already in `c-state-cache' or just before
3007 ;; one otherwise. exceptionally (when there's no such b/p/b handy) the BOL
3008 ;; before `here''s line, or the start of the literal containing it.
3009 ;; o - SCAN-BACK-POS, if non-nil, indicates there may be a brace pair
3010 ;; preceding POS which isn't recorded in `c-state-cache'. It is a position
3011 ;; to scan backwards from.
3012 ;; o - FWD-FLAG, if non-nil, indicates there may be parens/braces between
3013 ;; POS and HERE which aren't recorded in `c-state-cache'.
3015 ;; The comments in this defun use "paren" to mean parenthesis or square
3016 ;; bracket (as contrasted with a brace), and "(" and ")" likewise.
3018 ;; . {..} (..) (..) ( .. { } ) (...) ( .... . ..)
3020 ;; CP E here D C good
3021 (let ((cache-pos (c-get-cache-scan-pos here)) ; highest position below HERE in cache (or 1)
3022 (pos c-state-cache-good-pos)
3023 pa ren ; positions of "(" and ")"
3024 dropped-cons ; whether the last element dropped from `c-state-cache'
3025 ; was a cons (representing a brace-pair)
3026 good-pos ; see above.
3027 lit ; (START . END) of a literal containing some point.
3028 here-lit-start here-lit-end ; bounds of literal containing `here'
3030 here- here+ ; start/end of macro around HERE, or HERE
3031 (here-bol (c-point 'bol here))
3032 (too-far-back (max (- here c-state-cache-too-far) (point-min))))
3034 ;; Remove completely irrelevant entries from `c-state-cache'.
3035 (while (and c-state-cache
3036 (>= (setq pa (c-state-cache-top-lparen)) here))
3037 (setq dropped-cons (consp (car c-state-cache)))
3038 (setq c-state-cache (cdr c-state-cache))
3040 ;; At this stage, (> pos here);
3041 ;; (< (c-state-cache-top-lparen) here) (or is nil).
3044 ((and (consp (car c-state-cache))
3045 (> (cdar c-state-cache) here))
3046 ;; CASE 1: The top of the cache is a brace pair which now encloses
3047 ;; `here'. As good-pos, return the address. of the "{". Since we've no
3048 ;; knowledge of what's inside these braces, we have no alternative but
3049 ;; to direct the caller to scan the buffer from the opening brace.
3050 (setq pos (caar c-state-cache))
3051 (setcar c-state-cache pos)
3052 (list (1+ pos) pos t)) ; return value. We've just converted a brace pair
3053 ; entry into a { entry, so the caller needs to
3054 ; search for a brace pair before the {.
3056 ;; `here' might be inside a literal. Check for this.
3058 (setq lit (c-state-literal-at here)
3059 here-lit-start (or (car lit) here)
3060 here-lit-end (or (cdr lit) here))
3061 ;; Has `here' just "newly entered" a macro?
3063 (goto-char here-lit-start)
3064 (if (and (c-beginning-of-macro)
3065 (or (null c-state-old-cpp-beg)
3066 (not (= (point) c-state-old-cpp-beg))))
3068 (setq here- (point))
3070 (setq here+ (point)))
3071 (setq here- here-lit-start
3072 here+ here-lit-end)))
3074 ;; `here' might be nested inside any depth of parens (or brackets but
3075 ;; not braces). Scan backwards to find the outermost such opening
3076 ;; paren, if there is one. This will be the scan position to return.
3078 (narrow-to-region cache-pos (point-max))
3079 (setq pos (c-state-balance-parens-backwards here- here+ pos)))
3080 nil)) ; for the cond
3082 ((< pos here-lit-start)
3083 ;; CASE 2: Address of outermost ( or [ which now encloses `here', but
3084 ;; didn't enclose the (previous) `c-state-cache-good-pos'. If there is
3085 ;; a brace pair preceding this, it will already be in `c-state-cache',
3086 ;; unless there was a brace pair after it, i.e. there'll only be one to
3087 ;; scan for if we've just deleted one.
3088 (list pos (and dropped-cons pos) t)) ; Return value.
3090 ;; `here' isn't enclosed in a (previously unrecorded) bracket/paren.
3091 ;; Further forward scanning isn't needed, but we still need to find a
3092 ;; GOOD-POS. Step out of all enclosing "("s on HERE's line.
3095 (narrow-to-region here-bol (point-max))
3096 (setq pos here-lit-start)
3097 (c-safe (while (setq pa (scan-lists pos -1 1))
3098 (setq pos pa)))) ; might signal
3099 nil)) ; for the cond
3101 ((setq ren (c-safe-scan-lists pos -1 -1 too-far-back))
3102 ;; CASE 3: After a }/)/] before `here''s BOL.
3103 (list (1+ ren) (and dropped-cons pos) nil)) ; Return value
3106 ;; CASE 4; Best of a bad job: BOL before `here-bol', or beginning of
3107 ;; literal containing it.
3108 (setq good-pos (c-state-lit-beg (c-point 'bopl here-bol)))
3109 (list good-pos (and dropped-cons good-pos) nil)))))
3112 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3113 ;; Externally visible routines.
3115 (defun c-state-cache-init ()
3116 (setq c-state-cache nil
3117 c-state-cache-good-pos 1
3118 c-state-nonlit-pos-cache nil
3119 c-state-nonlit-pos-cache-limit 1
3120 c-state-semi-nonlit-pos-cache nil
3121 c-state-semi-nonlit-pos-cache-limit 1
3122 c-state-brace-pair-desert nil
3124 c-state-point-min-lit-type nil
3125 c-state-point-min-lit-start nil
3126 c-state-min-scan-pos 1
3127 c-state-old-cpp-beg nil
3128 c-state-old-cpp-end nil)
3129 (c-state-mark-point-min-literal))
3131 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3132 ;; Debugging routines to dump `c-state-cache' in a "replayable" form.
3133 ;; (defmacro c-sc-de (elt) ; "c-state-cache-dump-element"
3134 ;; `(format ,(concat "(setq " (symbol-name elt) " %s) ") ,elt))
3135 ;; (defmacro c-sc-qde (elt) ; "c-state-cache-quote-dump-element"
3136 ;; `(format ,(concat "(setq " (symbol-name elt) " '%s) ") ,elt))
3137 ;; (defun c-state-dump ()
3138 ;; ;; For debugging.
3141 ;; (c-sc-qde c-state-cache)
3142 ;; (c-sc-de c-state-cache-good-pos)
3143 ;; (c-sc-qde c-state-nonlit-pos-cache)
3144 ;; (c-sc-de c-state-nonlit-pos-cache-limit)
3145 ;; (c-sc-qde c-state-brace-pair-desert)
3146 ;; (c-sc-de c-state-point-min)
3147 ;; (c-sc-de c-state-point-min-lit-type)
3148 ;; (c-sc-de c-state-point-min-lit-start)
3149 ;; (c-sc-de c-state-min-scan-pos)
3150 ;; (c-sc-de c-state-old-cpp-beg)
3151 ;; (c-sc-de c-state-old-cpp-end)))
3152 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3154 (defun c-invalidate-state-cache-1 (here)
3155 ;; Invalidate all info on `c-state-cache' that applies to the buffer at HERE
3156 ;; or higher and set `c-state-cache-good-pos' accordingly. The cache is
3157 ;; left in a consistent state.
3159 ;; This is much like `c-whack-state-after', but it never changes a paren
3160 ;; pair element into an open paren element. Doing that would mean that the
3161 ;; new open paren wouldn't have the required preceding paren pair element.
3163 ;; This function is called from c-after-change.
3165 ;; The caches of non-literals:
3166 ;; Note that we use "<=" for the possibility of the second char of a two-char
3167 ;; comment opener being typed; this would invalidate any cache position at
3169 (if (<= here c-state-nonlit-pos-cache-limit)
3170 (setq c-state-nonlit-pos-cache-limit (1- here)))
3171 (if (<= here c-state-semi-nonlit-pos-cache-limit)
3172 (setq c-state-semi-nonlit-pos-cache-limit (1- here)))
3175 ;; Case 1: if `here' is in a literal containing point-min, everything
3176 ;; becomes (or is already) nil.
3177 (if (or (null c-state-cache-good-pos)
3178 (< here (c-state-get-min-scan-pos)))
3179 (setq c-state-cache nil
3180 c-state-cache-good-pos nil
3181 c-state-min-scan-pos nil)
3183 ;; Truncate `c-state-cache' and set `c-state-cache-good-pos' to a value
3184 ;; below `here'. To maintain its consistency, we may need to insert a new
3186 (let (open-paren-in-column-0-is-defun-start
3187 (here-bol (c-point 'bol here))
3188 too-high-pa ; recorded {/(/[ next above here, or nil.
3189 dropped-cons ; was the last removed element a brace pair?
3191 ;; The easy bit - knock over-the-top bits off `c-state-cache'.
3192 (while (and c-state-cache
3193 (>= (setq pa (c-state-cache-top-paren)) here))
3194 (setq dropped-cons (consp (car c-state-cache))
3195 too-high-pa (c-state-cache-top-lparen)
3196 c-state-cache (cdr c-state-cache)))
3198 ;; Do we need to add in an earlier brace pair, having lopped one off?
3199 (if (and dropped-cons
3200 (< too-high-pa (+ here c-state-cache-too-far)))
3201 (c-append-lower-brace-pair-to-state-cache too-high-pa here here-bol))
3202 (setq c-state-cache-good-pos (or (c-state-cache-after-top-paren)
3203 (c-state-get-min-scan-pos)))))
3205 ;; The brace-pair desert marker:
3206 (when (car c-state-brace-pair-desert)
3207 (if (< here (car c-state-brace-pair-desert))
3208 (setq c-state-brace-pair-desert nil)
3209 (if (< here (cdr c-state-brace-pair-desert))
3210 (setcdr c-state-brace-pair-desert here)))))
3212 (defun c-parse-state-1 ()
3213 ;; Find and record all noteworthy parens between some good point earlier in
3214 ;; the file and point. That good point is at least the beginning of the
3215 ;; top-level construct we are in, or the beginning of the preceding
3216 ;; top-level construct if we aren't in one.
3218 ;; The returned value is a list of the noteworthy parens with the last one
3219 ;; first. If an element in the list is an integer, it's the position of an
3220 ;; open paren (of any type) which has not been closed before the point. If
3221 ;; an element is a cons, it gives the position of a closed BRACE paren
3222 ;; pair[*]; the car is the start brace position and the cdr is the position
3223 ;; following the closing brace. Only the last closed brace paren pair
3224 ;; before each open paren and before the point is recorded, and thus the
3225 ;; state never contains two cons elements in succession. When a close brace
3226 ;; has no matching open brace (e.g., the matching brace is outside the
3227 ;; visible region), it is not represented in the returned value.
3229 ;; [*] N.B. The close "brace" might be a mismatching close bracket or paren.
3230 ;; This defun explicitly treats mismatching parens/braces/brackets as
3231 ;; matching. It is the open brace which makes it a "brace" pair.
3233 ;; If POINT is within a macro, open parens and brace pairs within
3234 ;; THIS macro MIGHT be recorded. This depends on whether their
3235 ;; syntactic properties have been suppressed by
3236 ;; `c-neutralize-syntax-in-CPP'. This might need fixing (2008-12-11).
3238 ;; Currently no characters which are given paren syntax with the
3239 ;; syntax-table property are recorded, i.e. angle bracket arglist
3240 ;; parens are never present here. Note that this might change.
3242 ;; BUG: This function doesn't cope entirely well with unbalanced
3243 ;; parens in macros. (2008-12-11: this has probably been resolved
3244 ;; by the function `c-neutralize-syntax-in-CPP'.) E.g. in the
3245 ;; following case the brace before the macro isn't balanced with the
3252 ;; Note to maintainers: this function DOES get called with point
3253 ;; within comments and strings, so don't assume it doesn't!
3255 ;; This function might do hidden buffer changes.
3256 (let* ((here (point))
3257 (here-bopl (c-point 'bopl))
3258 open-paren-in-column-0-is-defun-start
3259 strategy ; 'forward, 'backward etc..
3260 ;; Candidate positions to start scanning from:
3261 cache-pos ; highest position below HERE already existing in
3264 start-point ; (when scanning forward) a place below HERE where there
3265 ; are no open parens/braces between it and HERE.
3268 scan-backward-pos scan-forward-p) ; used for 'backward.
3269 ;; If POINT-MIN has changed, adjust the cache
3270 (unless (= (point-min) c-state-point-min)
3271 (c-renarrow-state-cache))
3274 (setq res (c-parse-state-get-strategy here c-state-cache-good-pos)
3276 start-point (cadr res))
3280 ((eq strategy 'forward)
3281 (setq res (c-remove-stale-state-cache start-point here here-bopl))
3282 (setq cache-pos (car res)
3283 scan-backward-pos (cadr res)
3284 bopl-state (car (cddr res))) ; will be nil if (< here-bopl
3286 (if scan-backward-pos
3287 (c-append-lower-brace-pair-to-state-cache scan-backward-pos here))
3289 (c-append-to-state-cache cache-pos here))
3290 (setq c-state-cache-good-pos
3292 (< good-pos (- here c-state-cache-too-far)))
3293 (c-state-cache-non-literal-place here-bopl bopl-state)
3296 ((eq strategy 'backward)
3297 (setq res (c-remove-stale-state-cache-backwards here)
3299 scan-backward-pos (cadr res)
3300 scan-forward-p (car (cddr res)))
3301 (if scan-backward-pos
3302 (c-append-lower-brace-pair-to-state-cache scan-backward-pos here))
3303 (setq c-state-cache-good-pos
3305 (c-append-to-state-cache good-pos here)
3308 (t ; (eq strategy 'IN-LIT)
3309 (setq c-state-cache nil
3310 c-state-cache-good-pos nil))))
3314 (defun c-invalidate-state-cache (here)
3315 ;; This is a wrapper over `c-invalidate-state-cache-1'.
3317 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3318 ;; of all parens in preprocessor constructs, except for any such construct
3319 ;; containing point. We can then call `c-invalidate-state-cache-1' without
3320 ;; worrying further about macros and template delimiters.
3321 (c-with-<->-as-parens-suppressed
3322 (if (and c-state-old-cpp-beg
3323 (< c-state-old-cpp-beg here))
3324 (c-with-all-but-one-cpps-commented-out
3326 (min c-state-old-cpp-end here)
3327 (c-invalidate-state-cache-1 here))
3328 (c-with-cpps-commented-out
3329 (c-invalidate-state-cache-1 here)))))
3331 (defmacro c-state-maybe-marker (place marker)
3332 ;; If PLACE is non-nil, return a marker marking it, otherwise nil.
3333 ;; We (re)use MARKER.
3335 (or ,marker (setq ,marker (make-marker)))
3336 (set-marker ,marker ,place)))
3338 (defun c-parse-state ()
3339 ;; This is a wrapper over `c-parse-state-1'. See that function for a
3340 ;; description of the functionality and return value.
3342 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3343 ;; of all parens in preprocessor constructs, except for any such construct
3344 ;; containing point. We can then call `c-parse-state-1' without worrying
3345 ;; further about macros and template delimiters.
3346 (let (here-cpp-beg here-cpp-end)
3348 (when (c-beginning-of-macro)
3349 (setq here-cpp-beg (point))
3351 (> (setq here-cpp-end (c-syntactic-end-of-macro))
3353 (setq here-cpp-beg nil here-cpp-end nil))))
3354 ;; FIXME!!! Put in a `condition-case' here to protect the integrity of the
3357 (c-with-<->-as-parens-suppressed
3358 (if (and here-cpp-beg (> here-cpp-end here-cpp-beg))
3359 (c-with-all-but-one-cpps-commented-out
3360 here-cpp-beg here-cpp-end
3362 (c-with-cpps-commented-out
3363 (c-parse-state-1))))
3364 (setq c-state-old-cpp-beg
3365 (c-state-maybe-marker here-cpp-beg c-state-old-cpp-beg-marker)
3367 (c-state-maybe-marker here-cpp-end c-state-old-cpp-end-marker)))))
3369 ;; Debug tool to catch cache inconsistencies. This is called from
3371 (defvar c-debug-parse-state nil)
3372 (unless (fboundp 'c-real-parse-state)
3373 (fset 'c-real-parse-state (symbol-function 'c-parse-state)))
3374 (cc-bytecomp-defun c-real-parse-state)
3376 (defvar c-parse-state-point nil)
3377 (defvar c-parse-state-state nil)
3378 (defun c-record-parse-state-state ()
3379 (setq c-parse-state-point (point))
3380 (setq c-parse-state-state
3383 (let ((val (symbol-value arg)))
3389 c-state-cache-good-pos
3390 c-state-nonlit-pos-cache
3391 c-state-nonlit-pos-cache-limit
3392 c-state-semi-nonlit-pos-cache
3393 c-state-semi-nonlit-pos-cache-limit
3394 c-state-brace-pair-desert
3396 c-state-point-min-lit-type
3397 c-state-point-min-lit-start
3398 c-state-min-scan-pos
3401 c-parse-state-point))))
3402 (defun c-replay-parse-state-state ()
3407 (format "%s %s%s" (car arg) (if (atom (cdr arg)) "" "'") (cdr arg)))
3408 c-parse-state-state " ")
3411 (defun c-debug-parse-state-double-cons (state)
3412 (let (state-car conses-not-ok)
3414 (setq state-car (car state)
3416 (if (and (consp state-car)
3417 (consp (car state)))
3418 (setq conses-not-ok t)))
3421 (defun c-debug-parse-state ()
3422 (let ((here (point)) (res1 (c-real-parse-state)) res2)
3423 (let ((c-state-cache nil)
3424 (c-state-cache-good-pos 1)
3425 (c-state-nonlit-pos-cache nil)
3426 (c-state-nonlit-pos-cache-limit 1)
3427 (c-state-brace-pair-desert nil)
3428 (c-state-point-min 1)
3429 (c-state-point-min-lit-type nil)
3430 (c-state-point-min-lit-start nil)
3431 (c-state-min-scan-pos 1)
3432 (c-state-old-cpp-beg nil)
3433 (c-state-old-cpp-end nil))
3434 (setq res2 (c-real-parse-state)))
3435 (unless (equal res1 res2)
3436 ;; The cache can actually go further back due to the ad-hoc way
3437 ;; the first paren is found, so try to whack off a bit of its
3438 ;; start before complaining.
3440 ;; (goto-char (or (c-least-enclosing-brace res2) (point)))
3441 ;; (c-beginning-of-defun-1)
3442 ;; (while (not (or (bobp) (eq (char-after) ?{)))
3443 ;; (c-beginning-of-defun-1))
3444 ;; (unless (equal (c-whack-state-before (point) res1) res2)
3445 ;; (message (concat "c-parse-state inconsistency at %s: "
3446 ;; "using cache: %s, from scratch: %s")
3447 ;; here res1 res2)))
3448 (message (concat "c-parse-state inconsistency at %s: "
3449 "using cache: %s, from scratch: %s")
3451 (message "Old state:")
3452 (c-replay-parse-state-state))
3454 (when (c-debug-parse-state-double-cons res1)
3455 (message "c-parse-state INVALIDITY at %s: %s"
3457 (message "Old state:")
3458 (c-replay-parse-state-state))
3460 (c-record-parse-state-state)
3461 res2 ; res1 correct a cascading series of errors ASAP
3464 (defun c-toggle-parse-state-debug (&optional arg)
3466 (setq c-debug-parse-state (c-calculate-state arg c-debug-parse-state))
3467 (fset 'c-parse-state (symbol-function (if c-debug-parse-state
3468 'c-debug-parse-state
3469 'c-real-parse-state)))
3470 (c-keep-region-active)
3471 (message "c-debug-parse-state %sabled"
3472 (if c-debug-parse-state "en" "dis")))
3473 (when c-debug-parse-state
3474 (c-toggle-parse-state-debug 1))
3477 (defun c-whack-state-before (bufpos paren-state)
3478 ;; Whack off any state information from PAREN-STATE which lies
3479 ;; before BUFPOS. Not destructive on PAREN-STATE.
3480 (let* ((newstate (list nil))
3484 (setq car (car paren-state)
3485 paren-state (cdr paren-state))
3486 (if (< (if (consp car) (car car) car) bufpos)
3487 (setq paren-state nil)
3488 (setcdr ptr (list car))
3489 (setq ptr (cdr ptr))))
3492 (defun c-whack-state-after (bufpos paren-state)
3493 ;; Whack off any state information from PAREN-STATE which lies at or
3494 ;; after BUFPOS. Not destructive on PAREN-STATE.
3497 (let ((car (car paren-state)))
3499 ;; just check the car, because in a balanced brace
3500 ;; expression, it must be impossible for the corresponding
3501 ;; close brace to be before point, but the open brace to
3503 (if (<= bufpos (car car))
3505 (if (< bufpos (cdr car))
3506 ;; its possible that the open brace is before
3507 ;; bufpos, but the close brace is after. In that
3508 ;; case, convert this to a non-cons element. The
3509 ;; rest of the state is before bufpos, so we're
3511 (throw 'done (cons (car car) (cdr paren-state)))
3512 ;; we know that both the open and close braces are
3513 ;; before bufpos, so we also know that everything else
3514 ;; on state is before bufpos.
3515 (throw 'done paren-state)))
3518 ;; it's before bufpos, so everything else should too.
3519 (throw 'done paren-state)))
3520 (setq paren-state (cdr paren-state)))
3523 (defun c-most-enclosing-brace (paren-state &optional bufpos)
3524 ;; Return the bufpos of the innermost enclosing open paren before
3525 ;; bufpos, or nil if none was found.
3527 (or bufpos (setq bufpos 134217727))
3529 (setq enclosingp (car paren-state)
3530 paren-state (cdr paren-state))
3531 (if (or (consp enclosingp)
3532 (>= enclosingp bufpos))
3533 (setq enclosingp nil)
3534 (setq paren-state nil)))
3537 (defun c-least-enclosing-brace (paren-state)
3538 ;; Return the bufpos of the outermost enclosing open paren, or nil
3539 ;; if none was found.
3542 (setq elem (car paren-state)
3543 paren-state (cdr paren-state))
3548 (defun c-safe-position (bufpos paren-state)
3549 ;; Return the closest "safe" position recorded on PAREN-STATE that
3550 ;; is higher up than BUFPOS. Return nil if PAREN-STATE doesn't
3551 ;; contain any. Return nil if BUFPOS is nil, which is useful to
3552 ;; find the closest limit before a given limit that might be nil.
3554 ;; A "safe" position is a position at or after a recorded open
3555 ;; paren, or after a recorded close paren. The returned position is
3556 ;; thus either the first position after a close brace, or the first
3557 ;; position after an enclosing paren, or at the enclosing paren in
3558 ;; case BUFPOS is immediately after it.
3563 (setq elem (car paren-state))
3565 (cond ((< (cdr elem) bufpos)
3566 (throw 'done (cdr elem)))
3567 ((< (car elem) bufpos)
3569 (throw 'done (min (1+ (car elem)) bufpos))))
3571 ;; elem is the position at and not after the opening paren, so
3572 ;; we can go forward one more step unless it's equal to
3573 ;; bufpos. This is useful in some cases avoid an extra paren
3574 ;; level between the safe position and bufpos.
3575 (throw 'done (min (1+ elem) bufpos))))
3576 (setq paren-state (cdr paren-state)))))))
3578 (defun c-beginning-of-syntax ()
3579 ;; This is used for `font-lock-beginning-of-syntax-function'. It
3580 ;; goes to the closest previous point that is known to be outside
3581 ;; any string literal or comment. `c-state-cache' is used if it has
3582 ;; a position in the vicinity.
3583 (let* ((paren-state c-state-cache)
3587 ;; Note: Similar code in `c-safe-position'. The
3588 ;; difference is that we accept a safe position at
3589 ;; the point and don't bother to go forward past open
3592 (setq elem (car paren-state))
3594 (cond ((<= (cdr elem) (point))
3595 (throw 'done (cdr elem)))
3596 ((<= (car elem) (point))
3597 (throw 'done (car elem))))
3598 (if (<= elem (point))
3599 (throw 'done elem)))
3600 (setq paren-state (cdr paren-state)))
3603 (if (> pos (- (point) 4000))
3605 ;; The position is far back. Try `c-beginning-of-defun-1'
3606 ;; (although we can't be entirely sure it will go to a position
3607 ;; outside a comment or string in current emacsen). FIXME:
3608 ;; Consult `syntax-ppss' here.
3609 (c-beginning-of-defun-1)
3614 ;; Tools for scanning identifiers and other tokens.
3616 (defun c-on-identifier ()
3617 "Return non-nil if the point is on or directly after an identifier.
3618 Keywords are recognized and not considered identifiers. If an
3619 identifier is detected, the returned value is its starting position.
3620 If an identifier ends at the point and another begins at it \(can only
3621 happen in Pike) then the point for the preceding one is returned.
3623 Note that this function might do hidden buffer changes. See the
3624 comment at the start of cc-engine.el for more info."
3626 ;; FIXME: Shouldn't this function handle "operator" in C++?
3629 (skip-syntax-backward "w_")
3633 ;; Check for a normal (non-keyword) identifier.
3634 (and (looking-at c-symbol-start)
3635 (not (looking-at c-keywords-regexp))
3638 (when (c-major-mode-is 'pike-mode)
3639 ;; Handle the `<operator> syntax in Pike.
3640 (let ((pos (point)))
3641 (skip-chars-backward "-!%&*+/<=>^|~[]()")
3642 (and (if (< (skip-chars-backward "`") 0)
3645 (eq (char-after) ?\`))
3646 (looking-at c-symbol-key)
3647 (>= (match-end 0) pos)
3650 ;; Handle the "operator +" syntax in C++.
3651 (when (and c-overloadable-operators-regexp
3652 (= (c-backward-token-2 0) 0))
3654 (cond ((and (looking-at c-overloadable-operators-regexp)
3655 (or (not c-opt-op-identifier-prefix)
3656 (and (= (c-backward-token-2 1) 0)
3657 (looking-at c-opt-op-identifier-prefix))))
3661 (and c-opt-op-identifier-prefix
3662 (looking-at c-opt-op-identifier-prefix)
3663 (= (c-forward-token-2 1) 0)
3664 (looking-at c-overloadable-operators-regexp)))
3669 (defsubst c-simple-skip-symbol-backward ()
3670 ;; If the point is at the end of a symbol then skip backward to the
3671 ;; beginning of it. Don't move otherwise. Return non-nil if point
3674 ;; This function might do hidden buffer changes.
3675 (or (< (skip-syntax-backward "w_") 0)
3676 (and (c-major-mode-is 'pike-mode)
3677 ;; Handle the `<operator> syntax in Pike.
3678 (let ((pos (point)))
3679 (if (and (< (skip-chars-backward "-!%&*+/<=>^|~[]()") 0)
3680 (< (skip-chars-backward "`") 0)
3681 (looking-at c-symbol-key)
3682 (>= (match-end 0) pos))
3687 (defun c-beginning-of-current-token (&optional back-limit)
3688 ;; Move to the beginning of the current token. Do not move if not
3689 ;; in the middle of one. BACK-LIMIT may be used to bound the
3690 ;; backward search; if given it's assumed to be at the boundary
3691 ;; between two tokens. Return non-nil if the point is moved, nil
3694 ;; This function might do hidden buffer changes.
3695 (let ((start (point)))
3696 (if (looking-at "\\w\\|\\s_")
3697 (skip-syntax-backward "w_" back-limit)
3698 (when (< (skip-syntax-backward ".()" back-limit) 0)
3699 (while (let ((pos (or (and (looking-at c-nonsymbol-token-regexp)
3701 ;; `c-nonsymbol-token-regexp' should always match
3702 ;; since we've skipped backward over punctuation
3703 ;; or paren syntax, but consume one char in case
3704 ;; it doesn't so that we don't leave point before
3705 ;; some earlier incorrect token.
3708 (goto-char pos))))))
3711 (defun c-end-of-current-token (&optional back-limit)
3712 ;; Move to the end of the current token. Do not move if not in the
3713 ;; middle of one. BACK-LIMIT may be used to bound the backward
3714 ;; search; if given it's assumed to be at the boundary between two
3715 ;; tokens. Return non-nil if the point is moved, nil otherwise.
3717 ;; This function might do hidden buffer changes.
3718 (let ((start (point)))
3719 (cond ((< (skip-syntax-backward "w_" (1- start)) 0)
3720 (skip-syntax-forward "w_"))
3721 ((< (skip-syntax-backward ".()" back-limit) 0)
3723 (if (looking-at c-nonsymbol-token-regexp)
3724 (goto-char (match-end 0))
3725 ;; `c-nonsymbol-token-regexp' should always match since
3726 ;; we've skipped backward over punctuation or paren
3727 ;; syntax, but move forward in case it doesn't so that
3728 ;; we don't leave point earlier than we started with.
3730 (< (point) start)))))
3733 (defconst c-jump-syntax-balanced
3734 (if (memq 'gen-string-delim c-emacs-features)
3735 "\\w\\|\\s_\\|\\s\(\\|\\s\)\\|\\s\"\\|\\s|"
3736 "\\w\\|\\s_\\|\\s\(\\|\\s\)\\|\\s\""))
3738 (defconst c-jump-syntax-unbalanced
3739 (if (memq 'gen-string-delim c-emacs-features)
3740 "\\w\\|\\s_\\|\\s\"\\|\\s|"
3741 "\\w\\|\\s_\\|\\s\""))
3743 (defun c-forward-token-2 (&optional count balanced limit)
3744 "Move forward by tokens.
3745 A token is defined as all symbols and identifiers which aren't
3746 syntactic whitespace \(note that multicharacter tokens like \"==\" are
3747 treated properly). Point is always either left at the beginning of a
3748 token or not moved at all. COUNT specifies the number of tokens to
3749 move; a negative COUNT moves in the opposite direction. A COUNT of 0
3750 moves to the next token beginning only if not already at one. If
3751 BALANCED is true, move over balanced parens, otherwise move into them.
3752 Also, if BALANCED is true, never move out of an enclosing paren.
3754 LIMIT sets the limit for the movement and defaults to the point limit.
3755 The case when LIMIT is set in the middle of a token, comment or macro
3756 is handled correctly, i.e. the point won't be left there.
3758 Return the number of tokens left to move \(positive or negative). If
3759 BALANCED is true, a move over a balanced paren counts as one. Note
3760 that if COUNT is 0 and no appropriate token beginning is found, 1 will
3761 be returned. Thus, a return value of 0 guarantees that point is at
3762 the requested position and a return value less \(without signs) than
3763 COUNT guarantees that point is at the beginning of some token.
3765 Note that this function might do hidden buffer changes. See the
3766 comment at the start of cc-engine.el for more info."
3768 (or count (setq count 1))
3770 (- (c-backward-token-2 (- count) balanced limit))
3772 (let ((jump-syntax (if balanced
3773 c-jump-syntax-balanced
3774 c-jump-syntax-unbalanced))
3779 ;; If count is zero we should jump if in the middle of a token.
3780 (c-end-of-current-token))
3783 (if limit (narrow-to-region (point-min) limit))
3785 (progn (c-forward-syntactic-ws) (point)))
3786 ;; Skip whitespace. Count this as a move if we did in
3788 (setq count (max (1- count) 0)))
3791 ;; Moved out of bounds. Make sure the returned count isn't zero.
3793 (if (zerop count) (setq count 1))
3796 ;; Use `condition-case' to avoid having the limit tests
3803 (cond ((looking-at jump-syntax)
3804 (goto-char (scan-sexps (point) 1))
3806 ((looking-at c-nonsymbol-token-regexp)
3807 (goto-char (match-end 0))
3809 ;; `c-nonsymbol-token-regexp' above should always
3810 ;; match if there are correct tokens. Try to
3811 ;; widen to see if the limit was set in the
3812 ;; middle of one, else fall back to treating
3813 ;; the offending thing as a one character token.
3817 (looking-at c-nonsymbol-token-regexp)))
3822 (c-forward-syntactic-ws)
3825 (error (goto-char last)))
3829 (setq count (1+ count)))))
3833 (defun c-backward-token-2 (&optional count balanced limit)
3834 "Move backward by tokens.
3835 See `c-forward-token-2' for details."
3837 (or count (setq count 1))
3839 (- (c-forward-token-2 (- count) balanced limit))
3841 (or limit (setq limit (point-min)))
3842 (let ((jump-syntax (if balanced
3843 c-jump-syntax-balanced
3844 c-jump-syntax-unbalanced))
3848 ;; The count is zero so try to skip to the beginning of the
3851 (progn (c-beginning-of-current-token) (point)))
3852 (if (< (point) limit)
3853 ;; The limit is inside the same token, so return 1.
3856 ;; We're not in the middle of a token. If there's
3857 ;; whitespace after the point then we must move backward,
3858 ;; so set count to 1 in that case.
3859 (and (looking-at c-syntactic-ws-start)
3860 ;; If we're looking at a '#' that might start a cpp
3861 ;; directive then we have to do a more elaborate check.
3862 (or (/= (char-after) ?#)
3863 (not c-opt-cpp-prefix)
3866 (progn (beginning-of-line)
3867 (looking-at "[ \t]*")
3870 (progn (backward-char)
3871 (not (eq (char-before) ?\\)))))))
3874 ;; Use `condition-case' to avoid having to check for buffer
3875 ;; limits in `backward-char', `scan-sexps' and `goto-char' below.
3880 (c-backward-syntactic-ws)
3882 (if (looking-at jump-syntax)
3883 (goto-char (scan-sexps (1+ (point)) -1))
3884 ;; This can be very inefficient if there's a long
3885 ;; sequence of operator tokens without any separation.
3886 ;; That doesn't happen in practice, anyway.
3887 (c-beginning-of-current-token))
3888 (>= (point) limit)))
3891 (error (goto-char last)))
3893 (if (< (point) limit)
3898 (defun c-forward-token-1 (&optional count balanced limit)
3899 "Like `c-forward-token-2' but doesn't treat multicharacter operator
3900 tokens like \"==\" as single tokens, i.e. all sequences of symbol
3901 characters are jumped over character by character. This function is
3902 for compatibility only; it's only a wrapper over `c-forward-token-2'."
3903 (let ((c-nonsymbol-token-regexp "\\s.\\|\\s\(\\|\\s\)"))
3904 (c-forward-token-2 count balanced limit)))
3906 (defun c-backward-token-1 (&optional count balanced limit)
3907 "Like `c-backward-token-2' but doesn't treat multicharacter operator
3908 tokens like \"==\" as single tokens, i.e. all sequences of symbol
3909 characters are jumped over character by character. This function is
3910 for compatibility only; it's only a wrapper over `c-backward-token-2'."
3911 (let ((c-nonsymbol-token-regexp "\\s.\\|\\s\(\\|\\s\)"))
3912 (c-backward-token-2 count balanced limit)))
3915 ;; Tools for doing searches restricted to syntactically relevant text.
3917 (defun c-syntactic-re-search-forward (regexp &optional bound noerror
3918 paren-level not-inside-token
3919 lookbehind-submatch)
3920 "Like `re-search-forward', but only report matches that are found
3921 in syntactically significant text. I.e. matches in comments, macros
3922 or string literals are ignored. The start point is assumed to be
3923 outside any comment, macro or string literal, or else the content of
3924 that region is taken as syntactically significant text.
3926 If PAREN-LEVEL is non-nil, an additional restriction is added to
3927 ignore matches in nested paren sexps. The search will also not go
3928 outside the current list sexp, which has the effect that if the point
3929 should be moved to BOUND when no match is found \(i.e. NOERROR is
3930 neither nil nor t), then it will be at the closing paren if the end of
3931 the current list sexp is encountered first.
3933 If NOT-INSIDE-TOKEN is non-nil, matches in the middle of tokens are
3934 ignored. Things like multicharacter operators and special symbols
3935 \(e.g. \"`()\" in Pike) are handled but currently not floating point
3938 If LOOKBEHIND-SUBMATCH is non-nil, it's taken as a number of a
3939 subexpression in REGEXP. The end of that submatch is used as the
3940 position to check for syntactic significance. If LOOKBEHIND-SUBMATCH
3941 isn't used or if that subexpression didn't match then the start
3942 position of the whole match is used instead. The \"look behind\"
3943 subexpression is never tested before the starting position, so it
3944 might be a good idea to include \\=\\= as a match alternative in it.
3946 Optimization note: Matches might be missed if the \"look behind\"
3947 subexpression can match the end of nonwhite syntactic whitespace,
3948 i.e. the end of comments or cpp directives. This since the function
3949 skips over such things before resuming the search. It's on the other
3950 hand not safe to assume that the \"look behind\" subexpression never
3951 matches syntactic whitespace.
3953 Bug: Unbalanced parens inside cpp directives are currently not handled
3954 correctly \(i.e. they don't get ignored as they should) when
3957 Note that this function might do hidden buffer changes. See the
3958 comment at the start of cc-engine.el for more info."
3960 (or bound (setq bound (point-max)))
3961 (if paren-level (setq paren-level -1))
3963 ;;(message "c-syntactic-re-search-forward %s %s %S" (point) bound regexp)
3965 (let ((start (point))
3967 ;; Start position for the last search.
3969 ;; The `parse-partial-sexp' state between the start position
3972 ;; The current position after the last state update. The next
3973 ;; `parse-partial-sexp' continues from here.
3975 ;; The position at which to check the state and the state
3976 ;; there. This is separate from `state-pos' since we might
3977 ;; need to back up before doing the next search round.
3978 check-pos check-state
3979 ;; Last position known to end a token.
3980 (last-token-end-pos (point-min))
3981 ;; Set when a valid match is found.
3988 (setq search-pos (point))
3989 (re-search-forward regexp bound noerror))
3992 (setq state (parse-partial-sexp
3993 state-pos (match-beginning 0) paren-level nil state)
3995 (if (setq check-pos (and lookbehind-submatch
3996 (or (not paren-level)
3998 (match-end lookbehind-submatch)))
3999 (setq check-state (parse-partial-sexp
4000 state-pos check-pos paren-level nil state))
4001 (setq check-pos state-pos
4004 ;; NOTE: If we got a look behind subexpression and get
4005 ;; an insignificant match in something that isn't
4006 ;; syntactic whitespace (i.e. strings or in nested
4007 ;; parentheses), then we can never skip more than a
4008 ;; single character from the match start position
4009 ;; (i.e. `state-pos' here) before continuing the
4010 ;; search. That since the look behind subexpression
4011 ;; might match the end of the insignificant region in
4015 ((elt check-state 7)
4016 ;; Match inside a line comment. Skip to eol. Use
4017 ;; `re-search-forward' instead of `skip-chars-forward' to get
4018 ;; the right bound behavior.
4019 (re-search-forward "[\n\r]" bound noerror))
4021 ((elt check-state 4)
4022 ;; Match inside a block comment. Skip to the '*/'.
4023 (search-forward "*/" bound noerror))
4025 ((and (not (elt check-state 5))
4026 (eq (char-before check-pos) ?/)
4027 (not (c-get-char-property (1- check-pos) 'syntax-table))
4028 (memq (char-after check-pos) '(?/ ?*)))
4029 ;; Match in the middle of the opener of a block or line
4031 (if (= (char-after check-pos) ?/)
4032 (re-search-forward "[\n\r]" bound noerror)
4033 (search-forward "*/" bound noerror)))
4035 ;; The last `parse-partial-sexp' above might have
4036 ;; stopped short of the real check position if the end
4037 ;; of the current sexp was encountered in paren-level
4038 ;; mode. The checks above are always false in that
4039 ;; case, and since they can do better skipping in
4040 ;; lookbehind-submatch mode, we do them before
4041 ;; checking the paren level.
4044 (/= (setq tmp (car check-state)) 0))
4045 ;; Check the paren level first since we're short of the
4046 ;; syntactic checking position if the end of the
4047 ;; current sexp was encountered by `parse-partial-sexp'.
4050 ;; Inside a nested paren sexp.
4051 (if lookbehind-submatch
4052 ;; See the NOTE above.
4053 (progn (goto-char state-pos) t)
4054 ;; Skip out of the paren quickly.
4055 (setq state (parse-partial-sexp state-pos bound 0 nil state)
4058 ;; Have exited the current paren sexp.
4061 ;; The last `parse-partial-sexp' call above
4062 ;; has left us just after the closing paren
4063 ;; in this case, so we can modify the bound
4064 ;; to leave the point at the right position
4066 (setq bound (1- (point)))
4068 (signal 'search-failed (list regexp)))))
4070 ((setq tmp (elt check-state 3))
4071 ;; Match inside a string.
4072 (if (or lookbehind-submatch
4073 (not (integerp tmp)))
4074 ;; See the NOTE above.
4075 (progn (goto-char state-pos) t)
4076 ;; Skip to the end of the string before continuing.
4077 (let ((ender (make-string 1 tmp)) (continue t))
4078 (while (if (search-forward ender bound noerror)
4080 (setq state (parse-partial-sexp
4081 state-pos (point) nil nil state)
4084 (setq continue nil)))
4089 (c-beginning-of-macro start)))
4090 ;; Match inside a macro. Skip to the end of it.
4092 (cond ((<= (point) bound) t)
4094 (t (signal 'search-failed (list regexp)))))
4096 ((and not-inside-token
4097 (or (< check-pos last-token-end-pos)
4100 (goto-char check-pos)
4102 (c-end-of-current-token last-token-end-pos))
4103 (setq last-token-end-pos (point))))))
4105 (if lookbehind-submatch
4106 ;; See the NOTE above.
4107 (goto-char state-pos)
4108 (goto-char (min last-token-end-pos bound))))
4115 ;; Should loop to search again, but take care to avoid
4116 ;; looping on the same spot.
4117 (or (/= search-pos (point))
4118 (if (= (point) bound)
4121 (signal 'search-failed (list regexp)))
4127 (signal (car err) (cdr err))))
4129 ;;(message "c-syntactic-re-search-forward done %s" (or (match-end 0) (point)))
4133 (goto-char (match-end 0))
4136 ;; Search failed. Set point as appropriate.
4142 (defvar safe-pos-list) ; bound in c-syntactic-skip-backward
4144 (defsubst c-ssb-lit-begin ()
4145 ;; Return the start of the literal point is in, or nil.
4146 ;; We read and write the variables `safe-pos', `safe-pos-list', `state'
4147 ;; bound in the caller.
4149 ;; Use `parse-partial-sexp' from a safe position down to the point to check
4150 ;; if it's outside comments and strings.
4152 (let ((pos (point)) safe-pos state pps-end-pos)
4153 ;; Pick a safe position as close to the point as possible.
4155 ;; FIXME: Consult `syntax-ppss' here if our cache doesn't give a good
4158 (while (and safe-pos-list
4159 (> (car safe-pos-list) (point)))
4160 (setq safe-pos-list (cdr safe-pos-list)))
4161 (unless (setq safe-pos (car-safe safe-pos-list))
4162 (setq safe-pos (max (or (c-safe-position
4163 (point) (or c-state-cache
4167 safe-pos-list (list safe-pos)))
4169 ;; Cache positions along the way to use if we have to back up more. We
4170 ;; cache every closing paren on the same level. If the paren cache is
4171 ;; relevant in this region then we're typically already on the same
4172 ;; level as the target position. Note that we might cache positions
4173 ;; after opening parens in case safe-pos is in a nested list. That's
4174 ;; both uncommon and harmless.
4176 (setq state (parse-partial-sexp
4179 (setq safe-pos (point)
4180 safe-pos-list (cons safe-pos safe-pos-list)))
4182 ;; If the state contains the start of the containing sexp we cache that
4183 ;; position too, so that parse-partial-sexp in the next run has a bigger
4184 ;; chance of starting at the same level as the target position and thus
4185 ;; will get more good safe positions into the list.
4187 (setq safe-pos (1+ (elt state 1))
4188 safe-pos-list (cons safe-pos safe-pos-list)))
4190 (if (or (elt state 3) (elt state 4))
4191 ;; Inside string or comment. Continue search at the
4195 (defun c-syntactic-skip-backward (skip-chars &optional limit paren-level)
4196 "Like `skip-chars-backward' but only look at syntactically relevant chars,
4197 i.e. don't stop at positions inside syntactic whitespace or string
4198 literals. Preprocessor directives are also ignored, with the exception
4199 of the one that the point starts within, if any. If LIMIT is given,
4200 it's assumed to be at a syntactically relevant position.
4202 If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4203 sexps, and the search will also not go outside the current paren sexp.
4204 However, if LIMIT or the buffer limit is reached inside a nested paren
4205 then the point will be left at the limit.
4207 Non-nil is returned if the point moved, nil otherwise.
4209 Note that this function might do hidden buffer changes. See the
4210 comment at the start of cc-engine.el for more info."
4212 (let ((start (point))
4214 ;; A list of syntactically relevant positions in descending
4215 ;; order. It's used to avoid scanning repeatedly over
4216 ;; potentially large regions with `parse-partial-sexp' to verify
4217 ;; each position. Used in `c-ssb-lit-begin'
4219 ;; The result from `c-beginning-of-macro' at the start position or the
4220 ;; start position itself if it isn't within a macro. Evaluated on
4223 ;; The earliest position after the current one with the same paren
4224 ;; level. Used only when `paren-level' is set.
4226 (paren-level-pos (point)))
4230 ;; The next loop "tries" to find the end point each time round,
4231 ;; loops when it hasn't succeeded.
4234 (< (skip-chars-backward skip-chars limit) 0)
4236 (let ((pos (point)) state-2 pps-end-pos)
4239 ;; Don't stop inside a literal
4240 ((setq lit-beg (c-ssb-lit-begin))
4246 (setq state-2 (parse-partial-sexp
4247 pos paren-level-pos -1)
4248 pps-end-pos (point))
4249 (/= (car state-2) 0)))
4250 ;; Not at the right level.
4252 (if (and (< (car state-2) 0)
4253 ;; We stop above if we go out of a paren.
4254 ;; Now check whether it precedes or is
4255 ;; nested in the starting sexp.
4259 pps-end-pos paren-level-pos
4261 (< (car state-2) 0)))
4263 ;; We've stopped short of the starting position
4264 ;; so the hit was inside a nested list. Go up
4265 ;; until we are at the right level.
4268 (goto-char (scan-lists pos -1
4270 (setq paren-level-pos (point))
4271 (if (and limit (>= limit paren-level-pos))
4277 (goto-char (or limit (point-min)))
4280 ;; The hit was outside the list at the start
4281 ;; position. Go to the start of the list and exit.
4282 (goto-char (1+ (elt state-2 1)))
4285 ((c-beginning-of-macro limit)
4289 (setq start-macro-beg
4292 (c-beginning-of-macro limit)
4296 ;; It's inside the same macro we started in so it's
4297 ;; a relevant match.
4303 ;; Skip syntactic ws afterwards so that we don't stop at the
4304 ;; end of a comment if `skip-chars' is something like "^/".
4305 (c-backward-syntactic-ws)
4308 ;; We might want to extend this with more useful return values in
4310 (/= (point) start)))
4312 ;; The following is an alternative implementation of
4313 ;; `c-syntactic-skip-backward' that uses backward movement to keep
4314 ;; track of the syntactic context. It turned out to be generally
4315 ;; slower than the one above which uses forward checks from earlier
4318 ;;(defconst c-ssb-stop-re
4319 ;; ;; The regexp matching chars `c-syntactic-skip-backward' needs to
4320 ;; ;; stop at to avoid going into comments and literals.
4322 ;; ;; Match comment end syntax and string literal syntax. Also match
4323 ;; ;; '/' for block comment endings (not covered by comment end
4325 ;; "\\s>\\|/\\|\\s\""
4326 ;; (if (memq 'gen-string-delim c-emacs-features)
4329 ;; (if (memq 'gen-comment-delim c-emacs-features)
4333 ;;(defconst c-ssb-stop-paren-re
4334 ;; ;; Like `c-ssb-stop-re' but also stops at paren chars.
4335 ;; (concat c-ssb-stop-re "\\|\\s(\\|\\s)"))
4337 ;;(defconst c-ssb-sexp-end-re
4338 ;; ;; Regexp matching the ending syntax of a complex sexp.
4339 ;; (concat c-string-limit-regexp "\\|\\s)"))
4341 ;;(defun c-syntactic-skip-backward (skip-chars &optional limit paren-level)
4342 ;; "Like `skip-chars-backward' but only look at syntactically relevant chars,
4343 ;;i.e. don't stop at positions inside syntactic whitespace or string
4344 ;;literals. Preprocessor directives are also ignored. However, if the
4345 ;;point is within a comment, string literal or preprocessor directory to
4346 ;;begin with, its contents is treated as syntactically relevant chars.
4347 ;;If LIMIT is given, it limits the backward search and the point will be
4348 ;;left there if no earlier position is found.
4350 ;;If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4351 ;;sexps, and the search will also not go outside the current paren sexp.
4352 ;;However, if LIMIT or the buffer limit is reached inside a nested paren
4353 ;;then the point will be left at the limit.
4355 ;;Non-nil is returned if the point moved, nil otherwise.
4357 ;;Note that this function might do hidden buffer changes. See the
4358 ;;comment at the start of cc-engine.el for more info."
4360 ;; (save-restriction
4362 ;; (narrow-to-region limit (point-max)))
4364 ;; (let ((start (point)))
4366 ;; (while (let ((last-pos (point))
4368 ;; (skip-chars-backward skip-chars)
4371 ;; ;; Skip back over the same region as
4372 ;; ;; `skip-chars-backward' above, but keep to
4373 ;; ;; syntactically relevant positions.
4374 ;; (goto-char last-pos)
4376 ;; ;; `re-search-backward' with a single char regexp
4377 ;; ;; should be fast.
4378 ;; (re-search-backward
4379 ;; (if paren-level c-ssb-stop-paren-re c-ssb-stop-re)
4384 ;; ((looking-at "\\s(")
4385 ;; ;; `paren-level' is set and we've found the
4386 ;; ;; start of the containing paren.
4390 ;; ((looking-at c-ssb-sexp-end-re)
4391 ;; ;; We're at the end of a string literal or paren
4392 ;; ;; sexp (if `paren-level' is set).
4394 ;; (condition-case nil
4395 ;; (c-backward-sexp)
4397 ;; (goto-char limit)
4398 ;; (throw 'done t))))
4402 ;; ;; At the end of some syntactic ws or possibly
4403 ;; ;; after a plain '/' operator.
4404 ;; (let ((pos (point)))
4405 ;; (c-backward-syntactic-ws)
4406 ;; (if (= pos (point))
4407 ;; ;; Was a plain '/' operator. Go past it.
4408 ;; (backward-char)))))
4410 ;; (> (point) stop-pos))))
4412 ;; ;; Now the point is either at `stop-pos' or at some
4413 ;; ;; position further back if `stop-pos' was at a
4414 ;; ;; syntactically irrelevant place.
4416 ;; ;; Skip additional syntactic ws so that we don't stop
4417 ;; ;; at the end of a comment if `skip-chars' is
4418 ;; ;; something like "^/".
4419 ;; (c-backward-syntactic-ws)
4421 ;; (< (point) stop-pos))))
4423 ;; ;; We might want to extend this with more useful return values
4424 ;; ;; in the future.
4425 ;; (/= (point) start))))
4428 ;; Tools for handling comments and string literals.
4430 (defun c-in-literal (&optional lim detect-cpp)
4431 "Return the type of literal point is in, if any.
4432 The return value is `c' if in a C-style comment, `c++' if in a C++
4433 style comment, `string' if in a string literal, `pound' if DETECT-CPP
4434 is non-nil and in a preprocessor line, or nil if somewhere else.
4435 Optional LIM is used as the backward limit of the search. If omitted,
4436 or nil, `c-beginning-of-defun' is used.
4438 The last point calculated is cached if the cache is enabled, i.e. if
4439 `c-in-literal-cache' is bound to a two element vector.
4441 Note that this function might do hidden buffer changes. See the
4442 comment at the start of cc-engine.el for more info."
4445 (let* ((safe-place (c-state-semi-safe-place (point)))
4446 (lit (c-state-pp-to-literal safe-place (point))))
4449 (save-excursion (c-beginning-of-macro))
4452 (defun c-literal-limits (&optional lim near not-in-delimiter)
4453 "Return a cons of the beginning and end positions of the comment or
4454 string surrounding point (including both delimiters), or nil if point
4455 isn't in one. If LIM is non-nil, it's used as the \"safe\" position
4456 to start parsing from. If NEAR is non-nil, then the limits of any
4457 literal next to point is returned. \"Next to\" means there's only
4458 spaces and tabs between point and the literal. The search for such a
4459 literal is done first in forward direction. If NOT-IN-DELIMITER is
4460 non-nil, the case when point is inside a starting delimiter won't be
4461 recognized. This only has effect for comments which have starting
4462 delimiters with more than one character.
4464 Note that this function might do hidden buffer changes. See the
4465 comment at the start of cc-engine.el for more info."
4468 (let* ((pos (point))
4469 (lim (or lim (c-state-semi-safe-place pos)))
4470 (pp-to-lit (save-restriction
4472 (c-state-pp-to-literal lim pos not-in-delimiter)))
4473 (state (car pp-to-lit))
4474 (lit-limits (car (cddr pp-to-lit))))
4481 ;; Search forward for a literal.
4482 (skip-chars-forward " \t")
4484 ((looking-at c-string-limit-regexp) ; String.
4485 (cons (point) (or (c-safe (c-forward-sexp 1) (point))
4488 ((looking-at c-comment-start-regexp) ; Line or block comment.
4489 (cons (point) (progn (c-forward-single-comment) (point))))
4493 (skip-chars-backward " \t")
4495 (let ((end (point)) beg)
4498 (< (skip-syntax-backward c-string-syntax) 0)) ; String.
4499 (setq beg (c-safe (c-backward-sexp 1) (point))))
4501 ((and (c-safe (forward-char -2) t)
4503 ;; Block comment. Due to the nature of line
4504 ;; comments, they will always be covered by the
4505 ;; normal case above.
4507 (c-backward-single-comment)
4508 ;; If LIM is bogus, beg will be bogus.
4509 (setq beg (point))))
4511 (if beg (cons beg end))))))
4514 ;; In case external callers use this; it did have a docstring.
4515 (defalias 'c-literal-limits-fast 'c-literal-limits)
4517 (defun c-collect-line-comments (range)
4518 "If the argument is a cons of two buffer positions (such as returned by
4519 `c-literal-limits'), and that range contains a C++ style line comment,
4520 then an extended range is returned that contains all adjacent line
4521 comments (i.e. all comments that starts in the same column with no
4522 empty lines or non-whitespace characters between them). Otherwise the
4523 argument is returned.
4525 Note that this function might do hidden buffer changes. See the
4526 comment at the start of cc-engine.el for more info."
4530 (if (and (consp range) (progn
4531 (goto-char (car range))
4532 (looking-at c-line-comment-starter)))
4533 (let ((col (current-column))
4535 (bopl (c-point 'bopl))
4537 ;; Got to take care in the backward direction to handle
4538 ;; comments which are preceded by code.
4539 (while (and (c-backward-single-comment)
4541 (looking-at c-line-comment-starter)
4542 (= col (current-column)))
4544 bopl (c-point 'bopl)))
4546 (while (and (progn (skip-chars-forward " \t")
4547 (looking-at c-line-comment-starter))
4548 (= col (current-column))
4549 (prog1 (zerop (forward-line 1))
4550 (setq end (point)))))
4555 (defun c-literal-type (range)
4556 "Convenience function that given the result of `c-literal-limits',
4557 returns nil or the type of literal that the range surrounds, one
4558 of the symbols 'c, 'c++ or 'string. It's much faster than using
4559 `c-in-literal' and is intended to be used when you need both the
4560 type of a literal and its limits.
4562 Note that this function might do hidden buffer changes. See the
4563 comment at the start of cc-engine.el for more info."
4567 (goto-char (car range))
4568 (cond ((looking-at c-string-limit-regexp) 'string)
4569 ((or (looking-at "//") ; c++ line comment
4570 (and (looking-at "\\s<") ; comment starter
4571 (looking-at "#"))) ; awk comment.
4573 (t 'c))) ; Assuming the range is valid.
4576 (defsubst c-determine-limit-get-base (start try-size)
4577 ;; Get a "safe place" approximately TRY-SIZE characters before START.
4578 ;; This doesn't preserve point.
4579 (let* ((pos (max (- start try-size) (point-min)))
4580 (base (c-state-semi-safe-place pos))
4581 (s (parse-partial-sexp base pos)))
4582 (if (or (nth 4 s) (nth 3 s)) ; comment or string
4586 (defun c-determine-limit (how-far-back &optional start try-size)
4587 ;; Return a buffer position HOW-FAR-BACK non-literal characters from START
4588 ;; (default point). This is done by going back further in the buffer then
4589 ;; searching forward for literals. The position found won't be in a
4590 ;; literal. We start searching for the sought position TRY-SIZE (default
4591 ;; twice HOW-FAR-BACK) bytes back from START. This function must be fast.
4594 (let* ((start (or start (point)))
4595 (try-size (or try-size (* 2 how-far-back)))
4596 (base (c-determine-limit-get-base start try-size))
4599 (s (parse-partial-sexp pos pos)) ; null state.
4602 (while (< pos start)
4603 ;; Move forward one literal each time round this loop.
4604 ;; Move forward to the start of a comment or string.
4605 (setq s (parse-partial-sexp
4611 'syntax-table)) ; stop-comment
4613 ;; Gather details of the non-literal-bit - starting pos and size.
4614 (setq size (- (if (or (nth 4 s) (nth 3 s))
4619 (setq stack (cons (cons pos size) stack)))
4621 ;; Move forward to the end of the comment/string.
4622 (if (or (nth 4 s) (nth 3 s))
4623 (setq s (parse-partial-sexp
4629 'syntax-table))) ; stop-comment
4632 ;; Now try and find enough non-literal characters recorded on the stack.
4633 ;; Go back one recorded literal each time round this loop.
4634 (while (and (< count how-far-back)
4636 (setq elt (car stack)
4638 (setq count (+ count (cdr elt))))
4640 ;; Have we found enough yet?
4642 ((>= count how-far-back)
4643 (+ (car elt) (- count how-far-back)))
4644 ((eq base (point-min))
4647 (c-determine-limit (- how-far-back count) base try-size))))))
4649 (defun c-determine-+ve-limit (how-far &optional start-pos)
4650 ;; Return a buffer position about HOW-FAR non-literal characters forward
4651 ;; from START-POS (default point), which must not be inside a literal.
4653 (let ((pos (or start-pos (point)))
4655 (s (parse-partial-sexp (point) (point)))) ; null state
4656 (while (and (not (eobp))
4658 ;; Scan over counted characters.
4659 (setq s (parse-partial-sexp
4661 (min (+ pos count) (point-max))
4665 'syntax-table)) ; stop-comment
4666 (setq count (- count (- (point) pos) 1)
4668 ;; Scan over literal characters.
4670 (setq s (parse-partial-sexp
4676 'syntax-table) ; stop-comment
4681 ;; `c-find-decl-spots' and accompanying stuff.
4683 ;; Variables used in `c-find-decl-spots' to cache the search done for
4684 ;; the first declaration in the last call. When that function starts,
4685 ;; it needs to back up over syntactic whitespace to look at the last
4686 ;; token before the region being searched. That can sometimes cause
4687 ;; moves back and forth over a quite large region of comments and
4688 ;; macros, which would be repeated for each changed character when
4689 ;; we're called during fontification, since font-lock refontifies the
4690 ;; current line for each change. Thus it's worthwhile to cache the
4693 ;; `c-find-decl-syntactic-pos' is a syntactically relevant position in
4694 ;; the syntactic whitespace less or equal to some start position.
4695 ;; There's no cached value if it's nil.
4697 ;; `c-find-decl-match-pos' is the match position if
4698 ;; `c-find-decl-prefix-search' matched before the syntactic whitespace
4699 ;; at `c-find-decl-syntactic-pos', or nil if there's no such match.
4700 (defvar c-find-decl-syntactic-pos nil)
4701 (make-variable-buffer-local 'c-find-decl-syntactic-pos)
4702 (defvar c-find-decl-match-pos nil)
4703 (make-variable-buffer-local 'c-find-decl-match-pos)
4705 (defsubst c-invalidate-find-decl-cache (change-min-pos)
4706 (and c-find-decl-syntactic-pos
4707 (< change-min-pos c-find-decl-syntactic-pos)
4708 (setq c-find-decl-syntactic-pos nil)))
4710 ; (defface c-debug-decl-spot-face
4711 ; '((t (:background "Turquoise")))
4712 ; "Debug face to mark the spots where `c-find-decl-spots' stopped.")
4713 ; (defface c-debug-decl-sws-face
4714 ; '((t (:background "Khaki")))
4715 ; "Debug face to mark the syntactic whitespace between the declaration
4716 ; spots and the preceding token end.")
4718 (defmacro c-debug-put-decl-spot-faces (match-pos decl-pos)
4719 (when (facep 'c-debug-decl-spot-face)
4720 `(c-save-buffer-state ((match-pos ,match-pos) (decl-pos ,decl-pos))
4721 (c-debug-add-face (max match-pos (point-min)) decl-pos
4722 'c-debug-decl-sws-face)
4723 (c-debug-add-face decl-pos (min (1+ decl-pos) (point-max))
4724 'c-debug-decl-spot-face))))
4725 (defmacro c-debug-remove-decl-spot-faces (beg end)
4726 (when (facep 'c-debug-decl-spot-face)
4727 `(c-save-buffer-state ()
4728 (c-debug-remove-face ,beg ,end 'c-debug-decl-spot-face)
4729 (c-debug-remove-face ,beg ,end 'c-debug-decl-sws-face))))
4731 (defmacro c-find-decl-prefix-search ()
4732 ;; Macro used inside `c-find-decl-spots'. It ought to be a defun,
4733 ;; but it contains lots of free variables that refer to things
4734 ;; inside `c-find-decl-spots'. The point is left at `cfd-match-pos'
4735 ;; if there is a match, otherwise at `cfd-limit'.
4737 ;; The macro moves point forward to the next putative start of a declaration
4738 ;; or cfd-limit. This decl start is the next token after a "declaration
4739 ;; prefix". The declaration prefix is the earlier of `cfd-prop-match' and
4740 ;; `cfd-re-match'. `cfd-match-pos' is set to the decl prefix.
4742 ;; This macro might do hidden buffer changes.
4745 ;; Find the next property match position if we haven't got one already.
4746 (unless cfd-prop-match
4749 (goto-char (next-single-property-change
4750 (point) 'c-type nil cfd-limit))
4751 (and (< (point) cfd-limit)
4752 (not (eq (c-get-char-property (1- (point)) 'c-type)
4754 (setq cfd-prop-match (point))))
4756 ;; Find the next `c-decl-prefix-or-start-re' match if we haven't
4758 (unless cfd-re-match
4760 (if (> cfd-re-match-end (point))
4761 (goto-char cfd-re-match-end))
4763 ;; Each time round, the next `while' moves forward over a pseudo match
4764 ;; of `c-decl-prefix-or-start-re' which is either inside a literal, or
4765 ;; is a ":" not preceded by "public", etc.. `cfd-re-match' and
4766 ;; `cfd-re-match-end' get set.
4769 (setq cfd-re-match-end (re-search-forward c-decl-prefix-or-start-re
4772 ((null cfd-re-match-end)
4773 ;; No match. Finish up and exit the loop.
4774 (setq cfd-re-match cfd-limit)
4777 (if (setq cfd-re-match (match-end 1))
4778 ;; Matched the end of a token preceding a decl spot.
4780 (goto-char cfd-re-match)
4782 ;; Matched a token that start a decl spot.
4783 (goto-char (match-beginning 0))
4786 ;; Pseudo match inside a comment or string literal. Skip out
4787 ;; of comments and string literals.
4789 (goto-char (next-single-property-change
4790 (point) 'face nil cfd-limit))
4791 (and (< (point) cfd-limit)
4792 (c-got-face-at (point) c-literal-faces))))
4793 t) ; Continue the loop over pseudo matches.
4794 ((and (match-string 1)
4795 (string= (match-string 1) ":")
4797 (or (/= (c-backward-token-2 2) 0) ; no search limit. :-(
4798 (not (looking-at c-decl-start-colon-kwd-re)))))
4799 ;; Found a ":" which isn't part of "public:", etc.
4801 (t nil)))) ;; Found a real match. Exit the pseudo-match loop.
4803 ;; If our match was at the decl start, we have to back up over the
4804 ;; preceding syntactic ws to set `cfd-match-pos' and to catch
4805 ;; any decl spots in the syntactic ws.
4806 (unless cfd-re-match
4807 (c-backward-syntactic-ws)
4808 (setq cfd-re-match (point))))
4810 ;; Choose whichever match is closer to the start.
4811 (if (< cfd-re-match cfd-prop-match)
4812 (setq cfd-match-pos cfd-re-match
4814 (setq cfd-match-pos cfd-prop-match
4815 cfd-prop-match nil))
4817 (goto-char cfd-match-pos)
4819 (when (< cfd-match-pos cfd-limit)
4820 ;; Skip forward past comments only so we don't skip macros.
4821 (c-forward-comments)
4822 ;; Set the position to continue at. We can avoid going over
4823 ;; the comments skipped above a second time, but it's possible
4824 ;; that the comment skipping has taken us past `cfd-prop-match'
4825 ;; since the property might be used inside comments.
4826 (setq cfd-continue-pos (if cfd-prop-match
4827 (min cfd-prop-match (point))
4830 (defun c-find-decl-spots (cfd-limit cfd-decl-re cfd-face-checklist cfd-fun)
4831 ;; Call CFD-FUN for each possible spot for a declaration, cast or
4832 ;; label from the point to CFD-LIMIT.
4834 ;; CFD-FUN is called with point at the start of the spot. It's passed two
4835 ;; arguments: The first is the end position of the token preceding the spot,
4836 ;; or 0 for the implicit match at bob. The second is a flag that is t when
4837 ;; the match is inside a macro. Point should be moved forward by at least
4840 ;; If CFD-FUN adds `c-decl-end' properties somewhere below the current spot,
4841 ;; it should return non-nil to ensure that the next search will find them.
4844 ;; o The first token after bob.
4845 ;; o The first token after the end of submatch 1 in
4846 ;; `c-decl-prefix-or-start-re' when that submatch matches.
4847 ;; o The start of each `c-decl-prefix-or-start-re' match when
4848 ;; submatch 1 doesn't match.
4849 ;; o The first token after the end of each occurrence of the
4850 ;; `c-type' text property with the value `c-decl-end', provided
4851 ;; `c-type-decl-end-used' is set.
4853 ;; Only a spot that match CFD-DECL-RE and whose face is in the
4854 ;; CFD-FACE-CHECKLIST list causes CFD-FUN to be called. The face
4855 ;; check is disabled if CFD-FACE-CHECKLIST is nil.
4857 ;; If the match is inside a macro then the buffer is narrowed to the
4858 ;; end of it, so that CFD-FUN can investigate the following tokens
4859 ;; without matching something that begins inside a macro and ends
4860 ;; outside it. It's to avoid this work that the CFD-DECL-RE and
4861 ;; CFD-FACE-CHECKLIST checks exist.
4863 ;; The spots are visited approximately in order from top to bottom.
4864 ;; It's however the positions where `c-decl-prefix-or-start-re'
4865 ;; matches and where `c-decl-end' properties are found that are in
4866 ;; order. Since the spots often are at the following token, they
4867 ;; might be visited out of order insofar as more spots are reported
4868 ;; later on within the syntactic whitespace between the match
4869 ;; positions and their spots.
4871 ;; It's assumed that comments and strings are fontified in the
4874 ;; This is mainly used in fontification, and so has an elaborate
4875 ;; cache to handle repeated calls from the same start position; see
4876 ;; the variables above.
4878 ;; All variables in this function begin with `cfd-' to avoid name
4879 ;; collision with the (dynamically bound) variables used in CFD-FUN.
4881 ;; This function might do hidden buffer changes.
4883 (let ((cfd-start-pos (point))
4884 (cfd-buffer-end (point-max))
4885 ;; The end of the token preceding the decl spot last found
4886 ;; with `c-decl-prefix-or-start-re'. `cfd-limit' if there's
4889 ;; The end position of the last `c-decl-prefix-or-start-re'
4890 ;; match. If this is greater than `cfd-continue-pos', the
4891 ;; next regexp search is started here instead.
4892 (cfd-re-match-end (point-min))
4893 ;; The end of the last `c-decl-end' found by
4894 ;; `c-find-decl-prefix-search'. `cfd-limit' if there's no
4895 ;; match. If searching for the property isn't needed then we
4896 ;; disable it by setting it to `cfd-limit' directly.
4897 (cfd-prop-match (unless c-type-decl-end-used cfd-limit))
4898 ;; The end of the token preceding the decl spot last found by
4899 ;; `c-find-decl-prefix-search'. 0 for the implicit match at
4900 ;; bob. `cfd-limit' if there's no match. In other words,
4901 ;; this is the minimum of `cfd-re-match' and `cfd-prop-match'.
4902 (cfd-match-pos cfd-limit)
4903 ;; The position to continue searching at.
4905 ;; The position of the last "real" token we've stopped at.
4906 ;; This can be greater than `cfd-continue-pos' when we get
4907 ;; hits inside macros or at `c-decl-end' positions inside
4910 ;; The end position of the last entered macro.
4913 ;; Initialize by finding a syntactically relevant start position
4914 ;; before the point, and do the first `c-decl-prefix-or-start-re'
4915 ;; search unless we're at bob.
4917 (let (start-in-literal start-in-macro syntactic-pos)
4918 ;; Must back up a bit since we look for the end of the previous
4919 ;; statement or declaration, which is earlier than the first
4923 ;; First we need to move to a syntactically relevant position.
4924 ;; Begin by backing out of comment or string literals.
4926 (when (c-got-face-at (point) c-literal-faces)
4927 ;; Try to use the faces to back up to the start of the
4928 ;; literal. FIXME: What if the point is on a declaration
4929 ;; inside a comment?
4930 (while (and (not (bobp))
4931 (c-got-face-at (1- (point)) c-literal-faces))
4932 (goto-char (previous-single-property-change
4933 (point) 'face nil (point-min))))
4935 ;; XEmacs doesn't fontify the quotes surrounding string
4937 (and (featurep 'xemacs)
4938 (eq (get-text-property (point) 'face)
4939 'font-lock-string-face)
4941 (progn (backward-char)
4942 (not (looking-at c-string-limit-regexp)))
4945 ;; Don't trust the literal to contain only literal faces
4946 ;; (the font lock package might not have fontified the
4947 ;; start of it at all, for instance) so check that we have
4948 ;; arrived at something that looks like a start or else
4949 ;; resort to `c-literal-limits'.
4950 (unless (looking-at c-literal-start-regexp)
4951 (let ((range (c-literal-limits)))
4952 (if range (goto-char (car range)))))
4954 (setq start-in-literal (point)))
4956 ;; The start is in a literal. If the limit is in the same
4957 ;; one we don't have to find a syntactic position etc. We
4958 ;; only check that if the limit is at or before bonl to save
4959 ;; time; it covers the by far most common case when font-lock
4960 ;; refontifies the current line only.
4961 (<= cfd-limit (c-point 'bonl cfd-start-pos))
4963 (goto-char cfd-start-pos)
4965 (goto-char (next-single-property-change
4966 (point) 'face nil cfd-limit))
4967 (and (< (point) cfd-limit)
4968 (c-got-face-at (point) c-literal-faces))))
4969 (= (point) cfd-limit)))
4971 ;; Completely inside a literal. Set up variables to trig the
4972 ;; (< cfd-continue-pos cfd-start-pos) case below and it'll
4973 ;; find a suitable start position.
4974 (setq cfd-continue-pos start-in-literal))
4976 ;; Check if the region might be completely inside a macro, to
4977 ;; optimize that like the completely-inside-literal above.
4979 (and (= (forward-line 1) 0)
4980 (bolp) ; forward-line has funny behavior at eob.
4981 (>= (point) cfd-limit)
4982 (progn (backward-char)
4983 (eq (char-before) ?\\))))
4984 ;; (Maybe) completely inside a macro. Only need to trig the
4985 ;; (< cfd-continue-pos cfd-start-pos) case below to make it
4987 (setq cfd-continue-pos (1- cfd-start-pos)
4991 ;; Back out of any macro so we don't miss any declaration
4992 ;; that could follow after it.
4993 (when (c-beginning-of-macro)
4994 (setq start-in-macro t))
4996 ;; Now we're at a proper syntactically relevant position so we
4997 ;; can use the cache. But first clear it if it applied
4999 (c-invalidate-find-decl-cache cfd-start-pos)
5001 (setq syntactic-pos (point))
5002 (unless (eq syntactic-pos c-find-decl-syntactic-pos)
5003 ;; Don't have to do this if the cache is relevant here,
5004 ;; typically if the same line is refontified again. If
5005 ;; we're just some syntactic whitespace further down we can
5006 ;; still use the cache to limit the skipping.
5007 (c-backward-syntactic-ws c-find-decl-syntactic-pos))
5009 ;; If we hit `c-find-decl-syntactic-pos' and
5010 ;; `c-find-decl-match-pos' is set then we install the cached
5011 ;; values. If we hit `c-find-decl-syntactic-pos' and
5012 ;; `c-find-decl-match-pos' is nil then we know there's no decl
5013 ;; prefix in the whitespace before `c-find-decl-syntactic-pos'
5014 ;; and so we can continue the search from this point. If we
5015 ;; didn't hit `c-find-decl-syntactic-pos' then we're now in
5016 ;; the right spot to begin searching anyway.
5017 (if (and (eq (point) c-find-decl-syntactic-pos)
5018 c-find-decl-match-pos)
5019 (setq cfd-match-pos c-find-decl-match-pos
5020 cfd-continue-pos syntactic-pos)
5022 (setq c-find-decl-syntactic-pos syntactic-pos)
5025 ;; Always consider bob a match to get the first
5026 ;; declaration in the file. Do this separately instead of
5027 ;; letting `c-decl-prefix-or-start-re' match bob, so that
5028 ;; regexp always can consume at least one character to
5029 ;; ensure that we won't get stuck in an infinite loop.
5030 (setq cfd-re-match 0)
5032 (c-beginning-of-current-token)
5033 (< (point) cfd-limit))
5034 ;; Do an initial search now. In the bob case above it's
5035 ;; only done to search for a `c-decl-end' spot.
5036 (c-find-decl-prefix-search))
5038 (setq c-find-decl-match-pos (and (< cfd-match-pos cfd-start-pos)
5041 ;; Advance `cfd-continue-pos' if it's before the start position.
5042 ;; The closest continue position that might have effect at or
5043 ;; after the start depends on what we started in. This also
5044 ;; finds a suitable start position in the special cases when the
5045 ;; region is completely within a literal or macro.
5046 (when (and cfd-continue-pos (< cfd-continue-pos cfd-start-pos))
5050 ;; If we're in a macro then it's the closest preceding token
5051 ;; in the macro. Check this before `start-in-literal',
5052 ;; since if we're inside a literal in a macro, the preceding
5053 ;; token is earlier than any `c-decl-end' spot inside the
5054 ;; literal (comment).
5055 (goto-char (or start-in-literal cfd-start-pos))
5056 ;; The only syntactic ws in macros are comments.
5057 (c-backward-comments)
5059 (c-beginning-of-current-token))
5062 ;; If we're in a comment it can only be the closest
5063 ;; preceding `c-decl-end' position within that comment, if
5064 ;; any. Go back to the beginning of such a property so that
5065 ;; `c-find-decl-prefix-search' will find the end of it.
5066 ;; (Can't stop at the end and install it directly on
5067 ;; `cfd-prop-match' since that variable might be cleared
5068 ;; after `cfd-fun' below.)
5070 ;; Note that if the literal is a string then the property
5071 ;; search will simply skip to the beginning of it right
5073 (if (not c-type-decl-end-used)
5074 (goto-char start-in-literal)
5075 (goto-char cfd-start-pos)
5077 (goto-char (previous-single-property-change
5078 (point) 'c-type nil start-in-literal))
5079 (and (> (point) start-in-literal)
5080 (not (eq (c-get-char-property (point) 'c-type)
5083 (when (= (point) start-in-literal)
5084 ;; Didn't find any property inside the comment, so we can
5085 ;; skip it entirely. (This won't skip past a string, but
5086 ;; that'll be handled quickly by the next
5087 ;; `c-find-decl-prefix-search' anyway.)
5088 (c-forward-single-comment)
5089 (if (> (point) cfd-limit)
5090 (goto-char cfd-limit))))
5093 ;; If we started in normal code, the only match that might
5094 ;; apply before the start is what we already got in
5095 ;; `cfd-match-pos' so we can continue at the start position.
5096 ;; (Note that we don't get here if the first match is below
5098 (goto-char cfd-start-pos)))
5100 ;; Delete found matches if they are before our new continue
5101 ;; position, so that `c-find-decl-prefix-search' won't back up
5102 ;; to them later on.
5103 (setq cfd-continue-pos (point))
5104 (when (and cfd-re-match (< cfd-re-match cfd-continue-pos))
5105 (setq cfd-re-match nil))
5106 (when (and cfd-prop-match (< cfd-prop-match cfd-continue-pos))
5107 (setq cfd-prop-match nil)))
5110 ;; This is the normal case and we got a proper syntactic
5111 ;; position. If there's a match then it's always outside
5112 ;; macros and comments, so advance to the next token and set
5113 ;; `cfd-token-pos'. The loop below will later go back using
5114 ;; `cfd-continue-pos' to fix declarations inside the
5116 (when (and cfd-match-pos (< cfd-match-pos syntactic-pos))
5117 (goto-char syntactic-pos)
5118 (c-forward-syntactic-ws)
5119 (and cfd-continue-pos
5120 (< cfd-continue-pos (point))
5121 (setq cfd-token-pos (point))))
5123 ;; Have one of the special cases when the region is completely
5124 ;; within a literal or macro. `cfd-continue-pos' is set to a
5125 ;; good start position for the search, so do it.
5126 (c-find-decl-prefix-search)))
5128 ;; Now loop. Round what? (ACM, 2006/7/5). We already got the first match.
5132 (< cfd-match-pos cfd-limit)
5135 ;; Kludge to filter out matches on the "<" that
5136 ;; aren't open parens, for the sake of languages
5137 ;; that got `c-recognize-<>-arglists' set.
5138 (and (eq (char-before cfd-match-pos) ?<)
5139 (not (c-get-char-property (1- cfd-match-pos)
5142 ;; If `cfd-continue-pos' is less or equal to
5143 ;; `cfd-token-pos', we've got a hit inside a macro
5144 ;; that's in the syntactic whitespace before the last
5145 ;; "real" declaration we've checked. If they're equal
5146 ;; we've arrived at the declaration a second time, so
5147 ;; there's nothing to do.
5148 (= cfd-continue-pos cfd-token-pos)
5151 ;; If `cfd-continue-pos' is less than `cfd-token-pos'
5152 ;; we're still searching for declarations embedded in
5153 ;; the syntactic whitespace. In that case we need
5154 ;; only to skip comments and not macros, since they
5155 ;; can't be nested, and that's already been done in
5156 ;; `c-find-decl-prefix-search'.
5157 (when (> cfd-continue-pos cfd-token-pos)
5158 (c-forward-syntactic-ws)
5159 (setq cfd-token-pos (point)))
5161 ;; Continue if the following token fails the
5162 ;; CFD-DECL-RE and CFD-FACE-CHECKLIST checks.
5163 (when (or (>= (point) cfd-limit)
5164 (not (looking-at cfd-decl-re))
5165 (and cfd-face-checklist
5167 (point) cfd-face-checklist))))
5168 (goto-char cfd-continue-pos)
5171 (< (point) cfd-limit))
5172 (c-find-decl-prefix-search))
5174 (< (point) cfd-limit))
5177 (>= (point) cfd-start-pos)
5180 ;; Narrow to the end of the macro if we got a hit inside
5181 ;; one, to avoid recognizing things that start inside the
5182 ;; macro and end outside it.
5183 (when (> cfd-match-pos cfd-macro-end)
5184 ;; Not in the same macro as in the previous round.
5186 (goto-char cfd-match-pos)
5188 (if (save-excursion (and (c-beginning-of-macro)
5189 (< (point) cfd-match-pos)))
5190 (progn (c-end-of-macro)
5194 (if (zerop cfd-macro-end)
5196 (if (> cfd-macro-end (point))
5197 (progn (narrow-to-region (point-min) cfd-macro-end)
5199 ;; The matched token was the last thing in the macro,
5200 ;; so the whole match is bogus.
5201 (setq cfd-macro-end 0)
5204 (c-debug-put-decl-spot-faces cfd-match-pos (point))
5205 (if (funcall cfd-fun cfd-match-pos (/= cfd-macro-end 0))
5206 (setq cfd-prop-match nil))
5208 (when (/= cfd-macro-end 0)
5209 ;; Restore limits if we did macro narrowing above.
5210 (narrow-to-region (point-min) cfd-buffer-end)))
5212 (goto-char cfd-continue-pos)
5213 (if (= cfd-continue-pos cfd-limit)
5214 (setq cfd-match-pos cfd-limit)
5215 (c-find-decl-prefix-search))))) ; Moves point, sets cfd-continue-pos,
5216 ; cfd-match-pos, etc.
5219 ;; A cache for found types.
5221 ;; Buffer local variable that contains an obarray with the types we've
5222 ;; found. If a declaration is recognized somewhere we record the
5223 ;; fully qualified identifier in it to recognize it as a type
5224 ;; elsewhere in the file too. This is not accurate since we do not
5225 ;; bother with the scoping rules of the languages, but in practice the
5226 ;; same name is seldom used as both a type and something else in a
5227 ;; file, and we only use this as a last resort in ambiguous cases (see
5228 ;; `c-forward-decl-or-cast-1').
5230 ;; Not every type need be in this cache. However, things which have
5231 ;; ceased to be types must be removed from it.
5233 ;; Template types in C++ are added here too but with the template
5234 ;; arglist replaced with "<>" in references or "<" for the one in the
5235 ;; primary type. E.g. the type "Foo<A,B>::Bar<C>" is stored as
5236 ;; "Foo<>::Bar<". This avoids storing very long strings (since C++
5237 ;; template specs can be fairly sized programs in themselves) and
5238 ;; improves the hit ratio (it's a type regardless of the template
5239 ;; args; it's just not the same type, but we're only interested in
5240 ;; recognizing types, not telling distinct types apart). Note that
5241 ;; template types in references are added here too; from the example
5242 ;; above there will also be an entry "Foo<".
5243 (defvar c-found-types nil)
5244 (make-variable-buffer-local 'c-found-types)
5246 (defsubst c-clear-found-types ()
5247 ;; Clears `c-found-types'.
5248 (setq c-found-types (make-vector 53 0)))
5250 (defun c-add-type (from to)
5251 ;; Add the given region as a type in `c-found-types'. If the region
5252 ;; doesn't match an existing type but there is a type which is equal
5253 ;; to the given one except that the last character is missing, then
5254 ;; the shorter type is removed. That's done to avoid adding all
5255 ;; prefixes of a type as it's being entered and font locked. This
5256 ;; doesn't cover cases like when characters are removed from a type
5257 ;; or added in the middle. We'd need the position of point when the
5258 ;; font locking is invoked to solve this well.
5260 ;; This function might do hidden buffer changes.
5261 (let ((type (c-syntactic-content from to c-recognize-<>-arglists)))
5262 (unless (intern-soft type c-found-types)
5263 (unintern (substring type 0 -1) c-found-types)
5264 (intern type c-found-types))))
5266 (defun c-unfind-type (name)
5267 ;; Remove the "NAME" from c-found-types, if present.
5268 (unintern name c-found-types))
5270 (defsubst c-check-type (from to)
5271 ;; Return non-nil if the given region contains a type in
5274 ;; This function might do hidden buffer changes.
5275 (intern-soft (c-syntactic-content from to c-recognize-<>-arglists)
5278 (defun c-list-found-types ()
5279 ;; Return all the types in `c-found-types' as a sorted list of
5282 (mapatoms (lambda (type)
5283 (setq type-list (cons (symbol-name type)
5286 (sort type-list 'string-lessp)))
5288 ;; Shut up the byte compiler.
5289 (defvar c-maybe-stale-found-type)
5291 (defun c-trim-found-types (beg end old-len)
5292 ;; An after change function which, in conjunction with the info in
5293 ;; c-maybe-stale-found-type (set in c-before-change), removes a type
5294 ;; from `c-found-types', should this type have become stale. For
5295 ;; example, this happens to "foo" when "foo \n bar();" becomes
5296 ;; "foo(); \n bar();". Such stale types, if not removed, foul up
5297 ;; the fontification.
5299 ;; Have we, perhaps, added non-ws characters to the front/back of a found
5303 (when (< end (point-max))
5305 (if (and (c-beginning-of-current-token) ; only moves when we started in the middle
5306 (progn (goto-char end)
5307 (c-end-of-current-token)))
5308 (c-unfind-type (buffer-substring-no-properties
5310 (when (> beg (point-min))
5312 (if (and (c-end-of-current-token) ; only moves when we started in the middle
5313 (progn (goto-char beg)
5314 (c-beginning-of-current-token)))
5315 (c-unfind-type (buffer-substring-no-properties
5318 (if c-maybe-stale-found-type ; e.g. (c-decl-id-start "foo" 97 107 " (* ooka) " "o")
5320 ;; Changing the amount of (already existing) whitespace - don't do anything.
5321 ((and (c-partial-ws-p beg end)
5322 (or (= beg end) ; removal of WS
5323 (string-match "^[ \t\n\r\f\v]*$" (nth 5 c-maybe-stale-found-type)))))
5325 ;; The syntactic relationship which defined a "found type" has been
5327 ((eq (car c-maybe-stale-found-type) 'c-decl-id-start)
5328 (c-unfind-type (cadr c-maybe-stale-found-type)))
5329 ;; ((eq (car c-maybe-stale-found-type) 'c-decl-type-start) FIXME!!!
5333 ;; Setting and removing syntax properties on < and > in languages (C++
5334 ;; and Java) where they can be template/generic delimiters as well as
5335 ;; their normal meaning of "less/greater than".
5337 ;; Normally, < and > have syntax 'punctuation'. When they are found to
5338 ;; be delimiters, they are marked as such with the category properties
5339 ;; c-<-as-paren-syntax, c->-as-paren-syntax respectively.
5343 ;; It is impossible to determine with certainty whether a <..> pair in
5344 ;; C++ is two comparison operators or is template delimiters, unless
5345 ;; one duplicates a lot of a C++ compiler. For example, the following
5348 ;; foo (a < b, c > d) ;
5350 ;; could be a function call with two integer parameters (each a
5351 ;; relational expression), or it could be a constructor for class foo
5352 ;; taking one parameter d of templated type "a < b, c >". They are
5353 ;; somewhat easier to distinguish in Java.
5355 ;; The strategy now (2010-01) adopted is to mark and unmark < and
5356 ;; > IN MATCHING PAIRS ONLY. [Previously, they were marked
5357 ;; individually when their context so indicated. This gave rise to
5358 ;; intractable problems when one of a matching pair was deleted, or
5359 ;; pulled into a literal.]
5361 ;; At each buffer change, the syntax-table properties are removed in a
5362 ;; before-change function and reapplied, when needed, in an
5363 ;; after-change function. It is far more important that the
5364 ;; properties get removed when they they are spurious than that they
5365 ;; be present when wanted.
5366 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
5367 (defun c-clear-<-pair-props (&optional pos)
5368 ;; POS (default point) is at a < character. If it is marked with
5369 ;; open paren syntax-table text property, remove the property,
5370 ;; together with the close paren property on the matching > (if
5376 (when (equal (c-get-char-property (point) 'syntax-table)
5377 c-<-as-paren-syntax)
5378 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5379 (c-go-list-forward))
5380 (when (equal (c-get-char-property (1- (point)) 'syntax-table)
5381 c->-as-paren-syntax) ; should always be true.
5382 (c-clear-char-property (1- (point)) 'category))
5383 (c-clear-char-property pos 'category))))
5385 (defun c-clear->-pair-props (&optional pos)
5386 ;; POS (default point) is at a > character. If it is marked with
5387 ;; close paren syntax-table property, remove the property, together
5388 ;; with the open paren property on the matching < (if any).
5393 (when (equal (c-get-char-property (point) 'syntax-table)
5394 c->-as-paren-syntax)
5395 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5396 (c-go-up-list-backward))
5397 (when (equal (c-get-char-property (point) 'syntax-table)
5398 c-<-as-paren-syntax) ; should always be true.
5399 (c-clear-char-property (point) 'category))
5400 (c-clear-char-property pos 'category))))
5402 (defun c-clear-<>-pair-props (&optional pos)
5403 ;; POS (default point) is at a < or > character. If it has an
5404 ;; open/close paren syntax-table property, remove this property both
5405 ;; from the current character and its partner (which will also be
5408 ((eq (char-after) ?\<)
5409 (c-clear-<-pair-props pos))
5410 ((eq (char-after) ?\>)
5411 (c-clear->-pair-props pos))
5413 "c-clear-<>-pair-props called from wrong position"))))
5415 (defun c-clear-<-pair-props-if-match-after (lim &optional pos)
5416 ;; POS (default point) is at a < character. If it is both marked
5417 ;; with open/close paren syntax-table property, and has a matching >
5418 ;; (also marked) which is after LIM, remove the property both from
5419 ;; the current > and its partner. Return t when this happens, nil
5425 (when (equal (c-get-char-property (point) 'syntax-table)
5426 c-<-as-paren-syntax)
5427 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5428 (c-go-list-forward))
5429 (when (and (>= (point) lim)
5430 (equal (c-get-char-property (1- (point)) 'syntax-table)
5431 c->-as-paren-syntax)) ; should always be true.
5432 (c-unmark-<->-as-paren (1- (point)))
5433 (c-unmark-<->-as-paren pos))
5436 (defun c-clear->-pair-props-if-match-before (lim &optional pos)
5437 ;; POS (default point) is at a > character. If it is both marked
5438 ;; with open/close paren syntax-table property, and has a matching <
5439 ;; (also marked) which is before LIM, remove the property both from
5440 ;; the current < and its partner. Return t when this happens, nil
5446 (when (equal (c-get-char-property (point) 'syntax-table)
5447 c->-as-paren-syntax)
5448 (with-syntax-table c-no-parens-syntax-table ; ignore unbalanced [,{,(,..
5449 (c-go-up-list-backward))
5450 (when (and (<= (point) lim)
5451 (equal (c-get-char-property (point) 'syntax-table)
5452 c-<-as-paren-syntax)) ; should always be true.
5453 (c-unmark-<->-as-paren (point))
5454 (c-unmark-<->-as-paren pos))
5457 ;; Set by c-common-init in cc-mode.el.
5461 (defun c-before-change-check-<>-operators (beg end)
5462 ;; Unmark certain pairs of "< .... >" which are currently marked as
5463 ;; template/generic delimiters. (This marking is via syntax-table
5464 ;; text properties).
5466 ;; These pairs are those which are in the current "statement" (i.e.,
5467 ;; the region between the {, }, or ; before BEG and the one after
5468 ;; END), and which enclose any part of the interval (BEG END).
5470 ;; Note that in C++ (?and Java), template/generic parens cannot
5471 ;; enclose a brace or semicolon, so we use these as bounds on the
5472 ;; region we must work on.
5474 ;; This function is called from before-change-functions (via
5475 ;; c-get-state-before-change-functions). Thus the buffer is widened,
5476 ;; and point is undefined, both at entry and exit.
5478 ;; FIXME!!! This routine ignores the possibility of macros entirely.
5481 (let ((beg-lit-limits (progn (goto-char beg) (c-literal-limits)))
5482 (end-lit-limits (progn (goto-char end) (c-literal-limits)))
5483 new-beg new-end need-new-beg need-new-end)
5484 ;; Locate the barrier before the changed region
5485 (goto-char (if beg-lit-limits (car beg-lit-limits) beg))
5486 (c-syntactic-skip-backward "^;{}" (c-determine-limit 512))
5487 (setq new-beg (point))
5489 ;; Remove the syntax-table properties from each pertinent <...> pair.
5490 ;; Firsly, the ones with the < before beg and > after beg.
5491 (while (c-search-forward-char-property 'category 'c-<-as-paren-syntax beg)
5492 (if (c-clear-<-pair-props-if-match-after beg (1- (point)))
5493 (setq need-new-beg t)))
5495 ;; Locate the barrier after END.
5496 (goto-char (if end-lit-limits (cdr end-lit-limits) end))
5497 (c-syntactic-re-search-forward "[;{}]" (c-determine-+ve-limit 512) 'end)
5498 (setq new-end (point))
5500 ;; Remove syntax-table properties from the remaining pertinent <...>
5501 ;; pairs, those with a > after end and < before end.
5502 (while (c-search-backward-char-property 'category 'c->-as-paren-syntax end)
5503 (if (c-clear->-pair-props-if-match-before end)
5504 (setq need-new-end t)))
5506 ;; Extend the fontification region, if needed.
5509 (c-forward-syntactic-ws)
5510 (and (< (point) c-new-BEG) (setq c-new-BEG (point))))
5513 (and (> new-end c-new-END) (setq c-new-END new-end))))))
5517 (defun c-after-change-check-<>-operators (beg end)
5518 ;; This is called from `after-change-functions' when
5519 ;; c-recognize-<>-arglists' is set. It ensures that no "<" or ">"
5520 ;; chars with paren syntax become part of another operator like "<<"
5523 ;; This function might do hidden buffer changes.
5527 (when (or (looking-at "[<>]")
5528 (< (skip-chars-backward "<>") 0))
5531 (c-beginning-of-current-token)
5532 (when (and (< (point) beg)
5533 (looking-at c-<>-multichar-token-regexp)
5534 (< beg (setq beg (match-end 0))))
5535 (while (progn (skip-chars-forward "^<>" beg)
5537 (c-clear-<>-pair-props)
5542 (when (or (looking-at "[<>]")
5543 (< (skip-chars-backward "<>") 0))
5546 (c-beginning-of-current-token)
5547 (when (and (< (point) end)
5548 (looking-at c-<>-multichar-token-regexp)
5549 (< end (setq end (match-end 0))))
5550 (while (progn (skip-chars-forward "^<>" end)
5552 (c-clear-<>-pair-props)
5553 (forward-char)))))))
5557 ;; Handling of small scale constructs like types and names.
5559 ;; Dynamically bound variable that instructs `c-forward-type' to also
5560 ;; treat possible types (i.e. those that it normally returns 'maybe or
5561 ;; 'found for) as actual types (and always return 'found for them).
5562 ;; This means that it records them in `c-record-type-identifiers' if
5563 ;; that is set, and that it adds them to `c-found-types'.
5564 (defvar c-promote-possible-types nil)
5566 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5567 ;; mark up successfully parsed arglists with paren syntax properties on
5568 ;; the surrounding angle brackets and with `c-<>-arg-sep' in the
5569 ;; `c-type' property of each argument separating comma.
5571 ;; Setting this variable also makes `c-forward-<>-arglist' recurse into
5572 ;; all arglists for side effects (i.e. recording types), otherwise it
5573 ;; exploits any existing paren syntax properties to quickly jump to the
5574 ;; end of already parsed arglists.
5576 ;; Marking up the arglists is not the default since doing that correctly
5577 ;; depends on a proper value for `c-restricted-<>-arglists'.
5578 (defvar c-parse-and-markup-<>-arglists nil)
5580 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5581 ;; not accept arglists that contain binary operators.
5583 ;; This is primarily used to handle C++ template arglists. C++
5584 ;; disambiguates them by checking whether the preceding name is a
5585 ;; template or not. We can't do that, so we assume it is a template
5586 ;; if it can be parsed as one. That usually works well since
5587 ;; comparison expressions on the forms "a < b > c" or "a < b, c > d"
5588 ;; in almost all cases would be pointless.
5590 ;; However, in function arglists, e.g. in "foo (a < b, c > d)", we
5591 ;; should let the comma separate the function arguments instead. And
5592 ;; in a context where the value of the expression is taken, e.g. in
5593 ;; "if (a < b || c > d)", it's probably not a template.
5594 (defvar c-restricted-<>-arglists nil)
5596 ;; Dynamically bound variables that instructs
5597 ;; `c-forward-keyword-clause', `c-forward-<>-arglist',
5598 ;; `c-forward-name', `c-forward-type', `c-forward-decl-or-cast-1', and
5599 ;; `c-forward-label' to record the ranges of all the type and
5600 ;; reference identifiers they encounter. They will build lists on
5601 ;; these variables where each element is a cons of the buffer
5602 ;; positions surrounding each identifier. This recording is only
5603 ;; activated when `c-record-type-identifiers' is non-nil.
5605 ;; All known types that can't be identifiers are recorded, and also
5606 ;; other possible types if `c-promote-possible-types' is set.
5607 ;; Recording is however disabled inside angle bracket arglists that
5608 ;; are encountered inside names and other angle bracket arglists.
5609 ;; Such occurrences are taken care of by `c-font-lock-<>-arglists'
5612 ;; Only the names in C++ template style references (e.g. "tmpl" in
5613 ;; "tmpl<a,b>::foo") are recorded as references, other references
5614 ;; aren't handled here.
5616 ;; `c-forward-label' records the label identifier(s) on
5617 ;; `c-record-ref-identifiers'.
5618 (defvar c-record-type-identifiers nil)
5619 (defvar c-record-ref-identifiers nil)
5621 ;; This variable will receive a cons cell of the range of the last
5622 ;; single identifier symbol stepped over by `c-forward-name' if it's
5623 ;; successful. This is the range that should be put on one of the
5624 ;; record lists above by the caller. It's assigned nil if there's no
5625 ;; such symbol in the name.
5626 (defvar c-last-identifier-range nil)
5628 (defmacro c-record-type-id (range)
5629 (if (eq (car-safe range) 'cons)
5631 `(setq c-record-type-identifiers
5632 (cons ,range c-record-type-identifiers))
5633 `(let ((range ,range))
5635 (setq c-record-type-identifiers
5636 (cons range c-record-type-identifiers))))))
5638 (defmacro c-record-ref-id (range)
5639 (if (eq (car-safe range) 'cons)
5641 `(setq c-record-ref-identifiers
5642 (cons ,range c-record-ref-identifiers))
5643 `(let ((range ,range))
5645 (setq c-record-ref-identifiers
5646 (cons range c-record-ref-identifiers))))))
5648 ;; Dynamically bound variable that instructs `c-forward-type' to
5649 ;; record the ranges of types that only are found. Behaves otherwise
5650 ;; like `c-record-type-identifiers'.
5651 (defvar c-record-found-types nil)
5653 (defmacro c-forward-keyword-prefixed-id (type)
5654 ;; Used internally in `c-forward-keyword-clause' to move forward
5655 ;; over a type (if TYPE is 'type) or a name (otherwise) which
5656 ;; possibly is prefixed by keywords and their associated clauses.
5657 ;; Try with a type/name first to not trip up on those that begin
5658 ;; with a keyword. Return t if a known or found type is moved
5659 ;; over. The point is clobbered if nil is returned. If range
5660 ;; recording is enabled, the identifier is recorded on as a type
5661 ;; if TYPE is 'type or as a reference if TYPE is 'ref.
5663 ;; This macro might do hidden buffer changes.
5665 (while (if (setq res ,(if (eq type 'type)
5669 (and (looking-at c-keywords-regexp)
5670 (c-forward-keyword-clause 1))))
5671 (when (memq res '(t known found prefix))
5672 ,(when (eq type 'ref)
5673 `(when c-record-type-identifiers
5674 (c-record-ref-id c-last-identifier-range)))
5677 (defmacro c-forward-id-comma-list (type update-safe-pos)
5678 ;; Used internally in `c-forward-keyword-clause' to move forward
5679 ;; over a comma separated list of types or names using
5680 ;; `c-forward-keyword-prefixed-id'.
5682 ;; This macro might do hidden buffer changes.
5684 ,(when update-safe-pos
5685 `(setq safe-pos (point)))
5686 (eq (char-after) ?,))
5689 (c-forward-syntactic-ws)
5690 (c-forward-keyword-prefixed-id ,type)))))
5692 (defun c-forward-keyword-clause (match)
5693 ;; Submatch MATCH in the current match data is assumed to surround a
5694 ;; token. If it's a keyword, move over it and any immediately
5695 ;; following clauses associated with it, stopping at the start of
5696 ;; the next token. t is returned in that case, otherwise the point
5697 ;; stays and nil is returned. The kind of clauses that are
5698 ;; recognized are those specified by `c-type-list-kwds',
5699 ;; `c-ref-list-kwds', `c-colon-type-list-kwds',
5700 ;; `c-paren-nontype-kwds', `c-paren-type-kwds', `c-<>-type-kwds',
5701 ;; and `c-<>-arglist-kwds'.
5703 ;; This function records identifier ranges on
5704 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5705 ;; `c-record-type-identifiers' is non-nil.
5707 ;; Note that for `c-colon-type-list-kwds', which doesn't necessary
5708 ;; apply directly after the keyword, the type list is moved over
5709 ;; only when there is no unaccounted token before it (i.e. a token
5710 ;; that isn't moved over due to some other keyword list). The
5711 ;; identifier ranges in the list are still recorded if that should
5714 ;; This function might do hidden buffer changes.
5716 (let ((kwd-sym (c-keyword-sym (match-string match))) safe-pos pos
5717 ;; The call to `c-forward-<>-arglist' below is made after
5718 ;; `c-<>-sexp-kwds' keywords, so we're certain they actually
5719 ;; are angle bracket arglists and `c-restricted-<>-arglists'
5720 ;; should therefore be nil.
5721 (c-parse-and-markup-<>-arglists t)
5722 c-restricted-<>-arglists)
5725 (goto-char (match-end match))
5726 (c-forward-syntactic-ws)
5727 (setq safe-pos (point))
5730 ((and (c-keyword-member kwd-sym 'c-type-list-kwds)
5731 (c-forward-keyword-prefixed-id type))
5732 ;; There's a type directly after a keyword in `c-type-list-kwds'.
5733 (c-forward-id-comma-list type t))
5735 ((and (c-keyword-member kwd-sym 'c-ref-list-kwds)
5736 (c-forward-keyword-prefixed-id ref))
5737 ;; There's a name directly after a keyword in `c-ref-list-kwds'.
5738 (c-forward-id-comma-list ref t))
5740 ((and (c-keyword-member kwd-sym 'c-paren-any-kwds)
5741 (eq (char-after) ?\())
5742 ;; There's an open paren after a keyword in `c-paren-any-kwds'.
5745 (when (and (setq pos (c-up-list-forward))
5746 (eq (char-before pos) ?\)))
5747 (when (and c-record-type-identifiers
5748 (c-keyword-member kwd-sym 'c-paren-type-kwds))
5749 ;; Use `c-forward-type' on every identifier we can find
5750 ;; inside the paren, to record the types.
5751 (while (c-syntactic-re-search-forward c-symbol-start pos t)
5752 (goto-char (match-beginning 0))
5753 (unless (c-forward-type)
5754 (looking-at c-symbol-key) ; Always matches.
5755 (goto-char (match-end 0)))))
5758 (c-forward-syntactic-ws)
5759 (setq safe-pos (point))))
5761 ((and (c-keyword-member kwd-sym 'c-<>-sexp-kwds)
5762 (eq (char-after) ?<)
5763 (c-forward-<>-arglist (c-keyword-member kwd-sym 'c-<>-type-kwds)))
5764 (c-forward-syntactic-ws)
5765 (setq safe-pos (point)))
5767 ((and (c-keyword-member kwd-sym 'c-nonsymbol-sexp-kwds)
5768 (not (looking-at c-symbol-start))
5769 (c-safe (c-forward-sexp) t))
5770 (c-forward-syntactic-ws)
5771 (setq safe-pos (point))))
5773 (when (c-keyword-member kwd-sym 'c-colon-type-list-kwds)
5774 (if (eq (char-after) ?:)
5775 ;; If we are at the colon already, we move over the type
5779 (c-forward-syntactic-ws)
5780 (when (c-forward-keyword-prefixed-id type)
5781 (c-forward-id-comma-list type t)))
5782 ;; Not at the colon, so stop here. But the identifier
5783 ;; ranges in the type list later on should still be
5785 (and c-record-type-identifiers
5787 ;; If a keyword matched both one of the types above and
5788 ;; this one, we match `c-colon-type-list-re' after the
5789 ;; clause matched above.
5790 (goto-char safe-pos)
5791 (looking-at c-colon-type-list-re))
5793 (goto-char (match-end 0))
5794 (c-forward-syntactic-ws)
5795 (c-forward-keyword-prefixed-id type))
5796 ;; There's a type after the `c-colon-type-list-re' match
5797 ;; after a keyword in `c-colon-type-list-kwds'.
5798 (c-forward-id-comma-list type nil))))
5800 (goto-char safe-pos)
5803 ;; cc-mode requires cc-fonts.
5804 (declare-function c-fontify-recorded-types-and-refs "cc-fonts" ())
5806 (defun c-forward-<>-arglist (all-types)
5807 ;; The point is assumed to be at a "<". Try to treat it as the open
5808 ;; paren of an angle bracket arglist and move forward to the
5809 ;; corresponding ">". If successful, the point is left after the
5810 ;; ">" and t is returned, otherwise the point isn't moved and nil is
5811 ;; returned. If ALL-TYPES is t then all encountered arguments in
5812 ;; the arglist that might be types are treated as found types.
5814 ;; The variable `c-parse-and-markup-<>-arglists' controls how this
5815 ;; function handles text properties on the angle brackets and argument
5816 ;; separating commas.
5818 ;; `c-restricted-<>-arglists' controls how lenient the template
5819 ;; arglist recognition should be.
5821 ;; This function records identifier ranges on
5822 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5823 ;; `c-record-type-identifiers' is non-nil.
5825 ;; This function might do hidden buffer changes.
5827 (let ((start (point))
5828 ;; If `c-record-type-identifiers' is set then activate
5829 ;; recording of any found types that constitute an argument in
5831 (c-record-found-types (if c-record-type-identifiers t)))
5832 (if (catch 'angle-bracket-arglist-escape
5833 (setq c-record-found-types
5834 (c-forward-<>-arglist-recur all-types)))
5836 (when (consp c-record-found-types)
5837 (setq c-record-type-identifiers
5838 ;; `nconc' doesn't mind that the tail of
5839 ;; `c-record-found-types' is t.
5840 (nconc c-record-found-types c-record-type-identifiers)))
5841 (if (c-major-mode-is 'java-mode) (c-fontify-recorded-types-and-refs))
5847 (defun c-forward-<>-arglist-recur (all-types)
5848 ;; Recursive part of `c-forward-<>-arglist'.
5850 ;; This function might do hidden buffer changes.
5852 (let ((start (point)) res pos tmp
5853 ;; Cover this so that any recorded found type ranges are
5854 ;; automatically lost if it turns out to not be an angle
5855 ;; bracket arglist. It's propagated through the return value
5856 ;; on successful completion.
5857 (c-record-found-types c-record-found-types)
5858 ;; List that collects the positions after the argument
5859 ;; separating ',' in the arglist.
5861 ;; If the '<' has paren open syntax then we've marked it as an angle
5862 ;; bracket arglist before, so skip to the end.
5863 (if (and (not c-parse-and-markup-<>-arglists)
5864 (c-get-char-property (point) 'syntax-table))
5868 (if (and (c-go-up-list-forward)
5869 (eq (char-before) ?>))
5871 ;; Got unmatched paren angle brackets. We don't clear the paren
5872 ;; syntax properties and retry, on the basis that it's very
5873 ;; unlikely that paren angle brackets become operators by code
5874 ;; manipulation. It's far more likely that it doesn't match due
5875 ;; to narrowing or some temporary change.
5879 (forward-char) ; Forward over the opening '<'.
5881 (unless (looking-at c-<-op-cont-regexp)
5882 ;; go forward one non-alphanumeric character (group) per iteration of
5886 (c-forward-syntactic-ws)
5887 (let ((orig-record-found-types c-record-found-types))
5888 (when (or (and c-record-type-identifiers all-types)
5889 (c-major-mode-is 'java-mode))
5890 ;; All encountered identifiers are types, so set the
5891 ;; promote flag and parse the type.
5893 (c-forward-syntactic-ws)
5894 (if (looking-at "\\?")
5896 (when (looking-at c-identifier-start)
5897 (let ((c-promote-possible-types t)
5898 (c-record-found-types t))
5901 (c-forward-syntactic-ws)
5903 (when (or (looking-at "extends")
5904 (looking-at "super"))
5906 (c-forward-syntactic-ws)
5907 (let ((c-promote-possible-types t)
5908 (c-record-found-types t))
5910 (c-forward-syntactic-ws))))))
5912 (setq pos (point)) ; e.g. first token inside the '<'
5914 ;; Note: These regexps exploit the match order in \| so
5915 ;; that "<>" is matched by "<" rather than "[^>:-]>".
5916 (c-syntactic-re-search-forward
5917 ;; Stop on ',', '|', '&', '+' and '-' to catch
5918 ;; common binary operators that could be between
5919 ;; two comparison expressions "a<b" and "c>d".
5920 "[<;{},|+&-]\\|[>)]"
5924 ((eq (char-before) ?>)
5925 ;; Either an operator starting with '>' or the end of
5926 ;; the angle bracket arglist.
5928 (if (looking-at c->-op-cont-regexp)
5930 (goto-char (match-end 0))
5931 t) ; Continue the loop.
5933 ;; The angle bracket arglist is finished.
5934 (when c-parse-and-markup-<>-arglists
5935 (while arg-start-pos
5936 (c-put-c-type-property (1- (car arg-start-pos))
5938 (setq arg-start-pos (cdr arg-start-pos)))
5939 (c-mark-<-as-paren start)
5940 (c-mark->-as-paren (1- (point))))
5942 nil)) ; Exit the loop.
5944 ((eq (char-before) ?<)
5945 ;; Either an operator starting with '<' or a nested arglist.
5947 (let (id-start id-end subres keyword-match)
5949 ;; The '<' begins a multi-char operator.
5950 ((looking-at c-<-op-cont-regexp)
5951 (setq tmp (match-end 0))
5952 (goto-char (match-end 0)))
5953 ;; We're at a nested <.....>
5956 (backward-char) ; to the '<'
5959 ;; There's always an identifier before an angle
5960 ;; bracket arglist, or a keyword in `c-<>-type-kwds'
5961 ;; or `c-<>-arglist-kwds'.
5962 (c-backward-syntactic-ws)
5963 (setq id-end (point))
5964 (c-simple-skip-symbol-backward)
5965 (when (or (setq keyword-match
5966 (looking-at c-opt-<>-sexp-key))
5967 (not (looking-at c-keywords-regexp)))
5968 (setq id-start (point))))
5970 (let ((c-promote-possible-types t)
5971 (c-record-found-types t))
5972 (c-forward-<>-arglist-recur
5975 (c-keyword-sym (match-string 1))
5976 'c-<>-type-kwds)))))))
5978 ;; It was an angle bracket arglist.
5979 (setq c-record-found-types subres)
5981 ;; Record the identifier before the template as a type
5982 ;; or reference depending on whether the arglist is last
5983 ;; in a qualified identifier.
5984 (when (and c-record-type-identifiers
5985 (not keyword-match))
5986 (if (and c-opt-identifier-concat-key
5988 (c-forward-syntactic-ws)
5989 (looking-at c-opt-identifier-concat-key)))
5990 (c-record-ref-id (cons id-start id-end))
5991 (c-record-type-id (cons id-start id-end)))))
5993 ;; At a "less than" operator.
5997 t) ; carry on looping.
5999 ((and (not c-restricted-<>-arglists)
6000 (or (and (eq (char-before) ?&)
6001 (not (eq (char-after) ?&)))
6002 (eq (char-before) ?,)))
6003 ;; Just another argument. Record the position. The
6004 ;; type check stuff that made us stop at it is at
6005 ;; the top of the loop.
6006 (setq arg-start-pos (cons (point) arg-start-pos)))
6009 ;; Got a character that can't be in an angle bracket
6010 ;; arglist argument. Abort using `throw', since
6011 ;; it's useless to try to find a surrounding arglist
6013 (throw 'angle-bracket-arglist-escape nil))))))
6015 (or c-record-found-types t)))))
6017 (defun c-backward-<>-arglist (all-types &optional limit)
6018 ;; The point is assumed to be directly after a ">". Try to treat it
6019 ;; as the close paren of an angle bracket arglist and move back to
6020 ;; the corresponding "<". If successful, the point is left at
6021 ;; the "<" and t is returned, otherwise the point isn't moved and
6022 ;; nil is returned. ALL-TYPES is passed on to
6023 ;; `c-forward-<>-arglist'.
6025 ;; If the optional LIMIT is given, it bounds the backward search.
6026 ;; It's then assumed to be at a syntactically relevant position.
6028 ;; This is a wrapper around `c-forward-<>-arglist'. See that
6029 ;; function for more details.
6031 (let ((start (point)))
6033 (if (and (not c-parse-and-markup-<>-arglists)
6034 (c-get-char-property (point) 'syntax-table))
6036 (if (and (c-go-up-list-backward)
6037 (eq (char-after) ?<))
6039 ;; See corresponding note in `c-forward-<>-arglist'.
6044 (c-syntactic-skip-backward "^<;{}" limit t)
6047 (if (eq (char-before) ?<)
6049 ;; Stopped at bob or a char that isn't allowed in an
6050 ;; arglist, so we've failed.
6055 (progn (c-beginning-of-current-token)
6057 ;; If we moved then the "<" was part of some
6058 ;; multicharacter token.
6062 (let ((beg-pos (point)))
6063 (if (c-forward-<>-arglist all-types)
6064 (cond ((= (point) start)
6065 ;; Matched the arglist. Break the while.
6069 ;; We started from a non-paren ">" inside an
6074 ;; Matched a shorter arglist. Can be a nested
6075 ;; one so continue looking.
6080 (/= (point) start))))
6082 (defun c-forward-name ()
6083 ;; Move forward over a complete name if at the beginning of one,
6084 ;; stopping at the next following token. A keyword, as such,
6085 ;; doesn't count as a name. If the point is not at something that
6086 ;; is recognized as a name then it stays put.
6088 ;; A name could be something as simple as "foo" in C or something as
6089 ;; complex as "X<Y<class A<int>::B, BIT_MAX >> b>, ::operator<> ::
6090 ;; Z<(a>b)> :: operator const X<&foo>::T Q::G<unsigned short
6091 ;; int>::*volatile const" in C++ (this function is actually little
6092 ;; more than a `looking-at' call in all modes except those that,
6093 ;; like C++, have `c-recognize-<>-arglists' set).
6096 ;; o - nil if no name is found;
6097 ;; o - 'template if it's an identifier ending with an angle bracket
6099 ;; o - 'operator of it's an operator identifier;
6100 ;; o - t if it's some other kind of name.
6102 ;; This function records identifier ranges on
6103 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6104 ;; `c-record-type-identifiers' is non-nil.
6106 ;; This function might do hidden buffer changes.
6108 (let ((pos (point)) (start (point)) res id-start id-end
6109 ;; Turn off `c-promote-possible-types' here since we might
6110 ;; call `c-forward-<>-arglist' and we don't want it to promote
6111 ;; every suspect thing in the arglist to a type. We're
6112 ;; typically called from `c-forward-type' in this case, and
6113 ;; the caller only wants the top level type that it finds to
6115 c-promote-possible-types)
6118 (looking-at c-identifier-key)
6121 ;; Check for keyword. We go to the last symbol in
6122 ;; `c-identifier-key' first.
6123 (goto-char (setq id-end (match-end 0)))
6124 (c-simple-skip-symbol-backward)
6125 (setq id-start (point))
6127 (if (looking-at c-keywords-regexp)
6128 (when (and (c-major-mode-is 'c++-mode)
6130 (cc-eval-when-compile
6131 (concat "\\(operator\\|\\(template\\)\\)"
6132 "\\(" (c-lang-const c-nonsymbol-key c++)
6134 (if (match-beginning 2)
6135 ;; "template" is only valid inside an
6136 ;; identifier if preceded by "::".
6138 (c-backward-syntactic-ws)
6139 (and (c-safe (backward-char 2) t)
6143 ;; Handle a C++ operator or template identifier.
6145 (c-forward-syntactic-ws)
6146 (cond ((eq (char-before id-end) ?e)
6147 ;; Got "... ::template".
6148 (let ((subres (c-forward-name)))
6153 ((looking-at c-identifier-start)
6154 ;; Got a cast operator.
6155 (when (c-forward-type)
6158 ;; Now we should match a sequence of either
6159 ;; '*', '&' or a name followed by ":: *",
6160 ;; where each can be followed by a sequence
6161 ;; of `c-opt-type-modifier-key'.
6162 (while (cond ((looking-at "[*&]")
6163 (goto-char (match-end 0))
6165 ((looking-at c-identifier-start)
6166 (and (c-forward-name)
6169 (goto-char (match-end 0))
6170 (c-forward-syntactic-ws)
6171 (eq (char-after) ?*))
6176 (c-forward-syntactic-ws)
6178 (looking-at c-opt-type-modifier-key))
6179 (goto-char (match-end 1))))))
6181 ((looking-at c-overloadable-operators-regexp)
6182 ;; Got some other operator.
6183 (setq c-last-identifier-range
6184 (cons (point) (match-end 0)))
6185 (goto-char (match-end 0))
6186 (c-forward-syntactic-ws)
6192 ;; `id-start' is equal to `id-end' if we've jumped over
6193 ;; an identifier that doesn't end with a symbol token.
6194 ;; That can occur e.g. for Java import directives on the
6195 ;; form "foo.bar.*".
6196 (when (and id-start (/= id-start id-end))
6197 (setq c-last-identifier-range
6198 (cons id-start id-end)))
6200 (c-forward-syntactic-ws)
6206 (when (or c-opt-identifier-concat-key
6207 c-recognize-<>-arglists)
6210 ((and c-opt-identifier-concat-key
6211 (looking-at c-opt-identifier-concat-key))
6212 ;; Got a concatenated identifier. This handles the
6213 ;; cases with tricky syntactic whitespace that aren't
6214 ;; covered in `c-identifier-key'.
6215 (goto-char (match-end 0))
6216 (c-forward-syntactic-ws)
6219 ((and c-recognize-<>-arglists
6220 (eq (char-after) ?<))
6221 ;; Maybe an angle bracket arglist.
6222 (when (let ((c-record-type-identifiers t)
6223 (c-record-found-types t))
6224 (c-forward-<>-arglist nil))
6226 (c-add-type start (1+ pos))
6227 (c-forward-syntactic-ws)
6229 c-last-identifier-range nil)
6231 (if (and c-opt-identifier-concat-key
6232 (looking-at c-opt-identifier-concat-key))
6234 ;; Continue if there's an identifier concatenation
6235 ;; operator after the template argument.
6237 (when (and c-record-type-identifiers id-start)
6238 (c-record-ref-id (cons id-start id-end)))
6240 (c-forward-syntactic-ws)
6243 (when (and c-record-type-identifiers id-start)
6244 (c-record-type-id (cons id-start id-end)))
6245 (setq res 'template)
6252 (defun c-forward-type (&optional brace-block-too)
6253 ;; Move forward over a type spec if at the beginning of one,
6254 ;; stopping at the next following token. The keyword "typedef"
6255 ;; isn't part of a type spec here.
6257 ;; BRACE-BLOCK-TOO, when non-nil, means move over the brace block in
6258 ;; constructs like "struct foo {...} bar ;" or "struct {...} bar;".
6259 ;; The current (2009-03-10) intention is to convert all uses of
6260 ;; `c-forward-type' to call with this parameter set, then to
6264 ;; o - t if it's a known type that can't be a name or other
6266 ;; o - 'known if it's an otherwise known type (according to
6267 ;; `*-font-lock-extra-types');
6268 ;; o - 'prefix if it's a known prefix of a type;
6269 ;; o - 'found if it's a type that matches one in `c-found-types';
6270 ;; o - 'maybe if it's an identifier that might be a type; or
6271 ;; o - nil if it can't be a type (the point isn't moved then).
6273 ;; The point is assumed to be at the beginning of a token.
6275 ;; Note that this function doesn't skip past the brace definition
6276 ;; that might be considered part of the type, e.g.
6277 ;; "enum {a, b, c} foo".
6279 ;; This function records identifier ranges on
6280 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6281 ;; `c-record-type-identifiers' is non-nil.
6283 ;; This function might do hidden buffer changes.
6284 (when (and c-recognize-<>-arglists
6286 (c-forward-<>-arglist t)
6287 (c-forward-syntactic-ws))
6289 (let ((start (point)) pos res name-res id-start id-end id-range)
6291 ;; Skip leading type modifiers. If any are found we know it's a
6292 ;; prefix of a type.
6293 (when c-opt-type-modifier-key ; e.g. "const" "volatile", but NOT "typedef"
6294 (while (looking-at c-opt-type-modifier-key)
6295 (goto-char (match-end 1))
6296 (c-forward-syntactic-ws)
6297 (setq res 'prefix)))
6300 ((looking-at c-type-prefix-key) ; e.g. "struct", "class", but NOT
6302 (goto-char (match-end 1))
6303 (c-forward-syntactic-ws)
6306 (setq name-res (c-forward-name))
6307 (setq res (not (null name-res)))
6308 (when (eq name-res t)
6309 ;; In many languages the name can be used without the
6310 ;; prefix, so we add it to `c-found-types'.
6311 (c-add-type pos (point))
6312 (when (and c-record-type-identifiers
6313 c-last-identifier-range)
6314 (c-record-type-id c-last-identifier-range)))
6315 (when (and brace-block-too
6317 (eq (char-after) ?\{)
6320 (progn (c-forward-sexp)
6321 (c-forward-syntactic-ws)
6322 (setq pos (point))))))
6325 (unless res (goto-char start))) ; invalid syntax
6329 (if (looking-at c-identifier-start)
6331 (setq id-start (point)
6332 name-res (c-forward-name))
6334 (setq id-end (point)
6335 id-range c-last-identifier-range))))
6336 (and (cond ((looking-at c-primitive-type-key)
6338 ((c-with-syntax-table c-identifier-syntax-table
6339 (looking-at c-known-type-key))
6344 (goto-char (match-end 1))
6345 (c-forward-syntactic-ws)
6346 (setq pos (point))))
6349 ;; Looking at a primitive or known type identifier. We've
6350 ;; checked for a name first so that we don't go here if the
6351 ;; known type match only is a prefix of another name.
6353 (setq id-end (match-end 1))
6355 (when (and c-record-type-identifiers
6356 (or c-promote-possible-types (eq res t)))
6357 (c-record-type-id (cons (match-beginning 1) (match-end 1))))
6359 (if (and c-opt-type-component-key
6361 (looking-at c-opt-type-component-key)))
6362 ;; There might be more keywords for the type.
6364 (c-forward-keyword-clause 1)
6366 (setq safe-pos (point))
6367 (looking-at c-opt-type-component-key))
6368 (when (and c-record-type-identifiers
6369 (looking-at c-primitive-type-key))
6370 (c-record-type-id (cons (match-beginning 1)
6372 (c-forward-keyword-clause 1))
6373 (if (looking-at c-primitive-type-key)
6375 (when c-record-type-identifiers
6376 (c-record-type-id (cons (match-beginning 1)
6378 (c-forward-keyword-clause 1)
6380 (goto-char safe-pos)
6381 (setq res 'prefix)))
6382 (unless (save-match-data (c-forward-keyword-clause 1))
6385 (goto-char (match-end 1))
6386 (c-forward-syntactic-ws)))))
6389 (cond ((eq name-res t)
6390 ;; A normal identifier.
6392 (if (or res c-promote-possible-types)
6394 (c-add-type id-start id-end)
6395 (when (and c-record-type-identifiers id-range)
6396 (c-record-type-id id-range))
6399 (setq res (if (c-check-type id-start id-end)
6400 ;; It's an identifier that has been used as
6401 ;; a type somewhere else.
6403 ;; It's an identifier that might be a type.
6405 ((eq name-res 'template)
6406 ;; A template is a type.
6410 ;; Otherwise it's an operator identifier, which is not a type.
6415 ;; Skip trailing type modifiers. If any are found we know it's
6417 (when c-opt-type-modifier-key
6418 (while (looking-at c-opt-type-modifier-key) ; e.g. "const", "volatile"
6419 (goto-char (match-end 1))
6420 (c-forward-syntactic-ws)
6422 ;; Step over any type suffix operator. Do not let the existence
6423 ;; of these alter the classification of the found type, since
6424 ;; these operators typically are allowed in normal expressions
6426 (when c-opt-type-suffix-key
6427 (while (looking-at c-opt-type-suffix-key)
6428 (goto-char (match-end 1))
6429 (c-forward-syntactic-ws)))
6431 (when c-opt-type-concat-key ; Only/mainly for pike.
6432 ;; Look for a trailing operator that concatenates the type
6433 ;; with a following one, and if so step past that one through
6434 ;; a recursive call. Note that we don't record concatenated
6435 ;; types in `c-found-types' - it's the component types that
6436 ;; are recorded when appropriate.
6438 (let* ((c-promote-possible-types (or (memq res '(t known))
6439 c-promote-possible-types))
6440 ;; If we can't promote then set `c-record-found-types' so that
6441 ;; we can merge in the types from the second part afterwards if
6442 ;; it turns out to be a known type there.
6443 (c-record-found-types (and c-record-type-identifiers
6444 (not c-promote-possible-types)))
6446 (if (and (looking-at c-opt-type-concat-key)
6449 (goto-char (match-end 1))
6450 (c-forward-syntactic-ws)
6451 (setq subres (c-forward-type))))
6454 ;; If either operand certainly is a type then both are, but we
6455 ;; don't let the existence of the operator itself promote two
6456 ;; uncertain types to a certain one.
6459 (unless (eq name-res 'template)
6460 (c-add-type id-start id-end))
6461 (when (and c-record-type-identifiers id-range)
6462 (c-record-type-id id-range))
6473 (when (and (eq res t)
6474 (consp c-record-found-types))
6475 ;; Merge in the ranges of any types found by the second
6476 ;; `c-forward-type'.
6477 (setq c-record-type-identifiers
6478 ;; `nconc' doesn't mind that the tail of
6479 ;; `c-record-found-types' is t.
6480 (nconc c-record-found-types
6481 c-record-type-identifiers))))
6485 (when (and c-record-found-types (memq res '(known found)) id-range)
6486 (setq c-record-found-types
6487 (cons id-range c-record-found-types))))
6489 ;;(message "c-forward-type %s -> %s: %s" start (point) res)
6493 (defun c-forward-annotation ()
6494 ;; Used for Java code only at the moment. Assumes point is on the
6495 ;; @, moves forward an annotation. returns nil if there is no
6496 ;; annotation at point.
6497 (and (looking-at "@")
6498 (progn (forward-char) t)
6500 (progn (c-forward-syntactic-ws) t)
6501 (if (looking-at "(")
6505 (defmacro c-pull-open-brace (ps)
6506 ;; Pull the next open brace from PS (which has the form of paren-state),
6507 ;; skipping over any brace pairs. Returns NIL when PS is exhausted.
6509 (while (consp (car ,ps))
6510 (setq ,ps (cdr ,ps)))
6512 (setq ,ps (cdr ,ps)))))
6514 (defun c-back-over-member-initializers ()
6515 ;; Test whether we are in a C++ member initializer list, and if so, go back
6516 ;; to the introducing ":", returning the position of the opening paren of
6517 ;; the function's arglist. Otherwise return nil, leaving point unchanged.
6518 (let ((here (point))
6519 (paren-state (c-parse-state))
6524 (if (not (c-at-toplevel-p))
6526 (while (not (c-at-toplevel-p))
6527 (goto-char (c-pull-open-brace paren-state)))
6528 (c-backward-syntactic-ws)
6529 (when (not (c-simple-skip-symbol-backward))
6531 (c-backward-syntactic-ws))
6532 (c-backward-syntactic-ws)
6533 (when (memq (char-before) '(?\) ?}))
6534 (when (not (c-go-list-backward))
6536 (c-backward-syntactic-ws))
6537 (when (c-simple-skip-symbol-backward)
6538 (c-backward-syntactic-ws)))
6540 (while (eq (char-before) ?,)
6542 (c-backward-syntactic-ws)
6544 (when (not (memq (char-before) '(?\) ?})))
6546 (when (not (c-go-list-backward))
6548 (c-backward-syntactic-ws)
6549 (when (not (c-simple-skip-symbol-backward))
6551 (c-backward-syntactic-ws))
6554 (eq (char-before) ?:)
6555 (c-just-after-func-arglist-p))))
6557 (or res (goto-char here))
6561 ;; Handling of large scale constructs like statements and declarations.
6563 ;; Macro used inside `c-forward-decl-or-cast-1'. It ought to be a
6564 ;; defsubst or perhaps even a defun, but it contains lots of free
6565 ;; variables that refer to things inside `c-forward-decl-or-cast-1'.
6566 (defmacro c-fdoc-shift-type-backward (&optional short)
6567 ;; `c-forward-decl-or-cast-1' can consume an arbitrary length list
6568 ;; of types when parsing a declaration, which means that it
6569 ;; sometimes consumes the identifier in the declaration as a type.
6570 ;; This is used to "backtrack" and make the last type be treated as
6571 ;; an identifier instead.
6574 ;; These identifiers are bound only in the inner let.
6575 '(setq identifier-type at-type
6576 identifier-start type-start
6580 got-suffix-after-parens id-start
6583 (if (setq at-type (if (eq backup-at-type 'prefix)
6586 (setq type-start backup-type-start
6587 id-start backup-id-start)
6588 (setq type-start start-pos
6589 id-start start-pos))
6591 ;; When these flags already are set we've found specifiers that
6592 ;; unconditionally signal these attributes - backtracking doesn't
6593 ;; change that. So keep them set in that case.
6595 (setq at-type-decl backup-at-type-decl))
6597 (setq maybe-typeless backup-maybe-typeless))
6600 ;; This identifier is bound only in the inner let.
6601 '(setq start id-start))))
6603 (defun c-forward-decl-or-cast-1 (preceding-token-end context last-cast-end)
6604 ;; Move forward over a declaration or a cast if at the start of one.
6605 ;; The point is assumed to be at the start of some token. Nil is
6606 ;; returned if no declaration or cast is recognized, and the point
6607 ;; is clobbered in that case.
6609 ;; If a declaration is parsed:
6611 ;; The point is left at the first token after the first complete
6612 ;; declarator, if there is one. The return value is a cons where
6613 ;; the car is the position of the first token in the declarator. (See
6614 ;; below for the cdr.)
6617 ;; void foo (int a, char *b) stuff ...
6621 ;; unsigned int a = c_style_initializer, b;
6623 ;; unsigned int a (cplusplus_style_initializer), b;
6624 ;; car ^ ^ point (might change)
6625 ;; class Foo : public Bar {}
6627 ;; class PikeClass (int a, string b) stuff ...
6633 ;; void cplusplus_function (int x) throw (Bad);
6635 ;; Foo::Foo (int b) : Base (b) {}
6638 ;; The cdr of the return value is non-nil when a
6639 ;; `c-typedef-decl-kwds' specifier is found in the declaration.
6640 ;; Specifically it is a dotted pair (A . B) where B is t when a
6641 ;; `c-typedef-kwds' ("typedef") is present, and A is t when some
6642 ;; other `c-typedef-decl-kwds' (e.g. class, struct, enum)
6643 ;; specifier is present. I.e., (some of) the declared
6644 ;; identifier(s) are types.
6646 ;; If a cast is parsed:
6648 ;; The point is left at the first token after the closing paren of
6649 ;; the cast. The return value is `cast'. Note that the start
6650 ;; position must be at the first token inside the cast parenthesis
6653 ;; PRECEDING-TOKEN-END is the first position after the preceding
6654 ;; token, i.e. on the other side of the syntactic ws from the point.
6655 ;; Use a value less than or equal to (point-min) if the point is at
6656 ;; the first token in (the visible part of) the buffer.
6658 ;; CONTEXT is a symbol that describes the context at the point:
6659 ;; 'decl In a comma-separated declaration context (typically
6660 ;; inside a function declaration arglist).
6661 ;; '<> In an angle bracket arglist.
6662 ;; 'arglist Some other type of arglist.
6663 ;; nil Some other context or unknown context. Includes
6664 ;; within the parens of an if, for, ... construct.
6666 ;; LAST-CAST-END is the first token after the closing paren of a
6667 ;; preceding cast, or nil if none is known. If
6668 ;; `c-forward-decl-or-cast-1' is used in succession, it should be
6669 ;; the position after the closest preceding call where a cast was
6670 ;; matched. In that case it's used to discover chains of casts like
6673 ;; This function records identifier ranges on
6674 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6675 ;; `c-record-type-identifiers' is non-nil.
6677 ;; This function might do hidden buffer changes.
6679 (let (;; `start-pos' is used below to point to the start of the
6680 ;; first type, i.e. after any leading specifiers. It might
6681 ;; also point at the beginning of the preceding syntactic
6684 ;; Set to the result of `c-forward-type'.
6686 ;; The position of the first token in what we currently
6687 ;; believe is the type in the declaration or cast, after any
6688 ;; specifiers and their associated clauses.
6690 ;; The position of the first token in what we currently
6691 ;; believe is the declarator for the first identifier. Set
6692 ;; when the type is found, and moved forward over any
6693 ;; `c-decl-hangon-kwds' and their associated clauses that
6694 ;; occurs after the type.
6696 ;; These store `at-type', `type-start' and `id-start' of the
6697 ;; identifier before the one in those variables. The previous
6698 ;; identifier might turn out to be the real type in a
6699 ;; declaration if the last one has to be the declarator in it.
6700 ;; If `backup-at-type' is nil then the other variables have
6701 ;; undefined values.
6702 backup-at-type backup-type-start backup-id-start
6703 ;; Set if we've found a specifier (apart from "typedef") that makes
6704 ;; the defined identifier(s) types.
6706 ;; Set if we've a "typedef" keyword.
6708 ;; Set if we've found a specifier that can start a declaration
6709 ;; where there's no type.
6711 ;; If a specifier is found that also can be a type prefix,
6712 ;; these flags are set instead of those above. If we need to
6713 ;; back up an identifier, they are copied to the real flag
6714 ;; variables. Thus they only take effect if we fail to
6715 ;; interpret it as a type.
6716 backup-at-type-decl backup-maybe-typeless
6717 ;; Whether we've found a declaration or a cast. We might know
6718 ;; this before we've found the type in it. It's 'ids if we've
6719 ;; found two consecutive identifiers (usually a sure sign, but
6720 ;; we should allow that in labels too), and t if we've found a
6721 ;; specifier keyword (a 100% sure sign).
6723 ;; Set when we need to back up to parse this as a declaration
6724 ;; but not as a cast.
6726 ;; For casts, the return position.
6728 ;; Save `c-record-type-identifiers' and
6729 ;; `c-record-ref-identifiers' since ranges are recorded
6730 ;; speculatively and should be thrown away if it turns out
6731 ;; that it isn't a declaration or cast.
6732 (save-rec-type-ids c-record-type-identifiers)
6733 (save-rec-ref-ids c-record-ref-identifiers))
6735 (while (c-forward-annotation)
6736 (c-forward-syntactic-ws))
6738 ;; Check for a type. Unknown symbols are treated as possible
6739 ;; types, but they could also be specifiers disguised through
6740 ;; macros like __INLINE__, so we recognize both types and known
6741 ;; specifiers after them too.
6743 (let* ((start (point)) kwd-sym kwd-clause-end found-type)
6745 ;; Look for a specifier keyword clause.
6746 (when (or (looking-at c-prefix-spec-kwds-re)
6747 (and (c-major-mode-is 'java-mode)
6748 (looking-at "@[A-Za-z0-9]+")))
6749 (if (looking-at c-typedef-key)
6750 (setq at-typedef t))
6751 (setq kwd-sym (c-keyword-sym (match-string 1)))
6753 (c-forward-keyword-clause 1)
6754 (setq kwd-clause-end (point))))
6756 (when (setq found-type (c-forward-type t)) ; brace-block-too
6757 ;; Found a known or possible type or a prefix of a known type.
6760 ;; Got two identifiers with nothing but whitespace
6761 ;; between them. That can only happen in declarations.
6762 (setq at-decl-or-cast 'ids)
6764 (when (eq at-type 'found)
6765 ;; If the previous identifier is a found type we
6766 ;; record it as a real one; it might be some sort of
6767 ;; alias for a prefix like "unsigned".
6769 (goto-char type-start)
6770 (let ((c-promote-possible-types t))
6771 (c-forward-type)))))
6773 (setq backup-at-type at-type
6774 backup-type-start type-start
6775 backup-id-start id-start
6779 ;; The previous ambiguous specifier/type turned out
6780 ;; to be a type since we've parsed another one after
6781 ;; it, so clear these backup flags.
6782 backup-at-type-decl nil
6783 backup-maybe-typeless nil))
6787 ;; Handle known specifier keywords and
6788 ;; `c-decl-hangon-kwds' which can occur after known
6791 (if (c-keyword-member kwd-sym 'c-decl-hangon-kwds)
6792 ;; It's a hang-on keyword that can occur anywhere.
6794 (setq at-decl-or-cast t)
6796 ;; Move the identifier start position if
6797 ;; we've passed a type.
6798 (setq id-start kwd-clause-end)
6799 ;; Otherwise treat this as a specifier and
6800 ;; move the fallback position.
6801 (setq start-pos kwd-clause-end))
6802 (goto-char kwd-clause-end))
6804 ;; It's an ordinary specifier so we know that
6805 ;; anything before this can't be the type.
6806 (setq backup-at-type nil
6807 start-pos kwd-clause-end)
6810 ;; It's ambiguous whether this keyword is a
6811 ;; specifier or a type prefix, so set the backup
6812 ;; flags. (It's assumed that `c-forward-type'
6813 ;; moved further than `c-forward-keyword-clause'.)
6815 (when (c-keyword-member kwd-sym 'c-typedef-decl-kwds)
6816 (setq backup-at-type-decl t))
6817 (when (c-keyword-member kwd-sym 'c-typeless-decl-kwds)
6818 (setq backup-maybe-typeless t)))
6820 (when (c-keyword-member kwd-sym 'c-typedef-decl-kwds)
6821 ;; This test only happens after we've scanned a type.
6822 ;; So, with valid syntax, kwd-sym can't be 'typedef.
6823 (setq at-type-decl t))
6824 (when (c-keyword-member kwd-sym 'c-typeless-decl-kwds)
6825 (setq maybe-typeless t))
6827 ;; Haven't matched a type so it's an unambiguous
6828 ;; specifier keyword and we know we're in a
6830 (setq at-decl-or-cast t)
6832 (goto-char kwd-clause-end))))
6834 ;; If the type isn't known we continue so that we'll jump
6835 ;; over all specifiers and type identifiers. The reason
6836 ;; to do this for a known type prefix is to make things
6837 ;; like "unsigned INT16" work.
6838 (and found-type (not (eq found-type t))))))
6842 ;; If a known type was found, we still need to skip over any
6843 ;; hangon keyword clauses after it. Otherwise it has already
6844 ;; been done in the loop above.
6845 (while (looking-at c-decl-hangon-key)
6846 (c-forward-keyword-clause 1))
6847 (setq id-start (point)))
6849 ((eq at-type 'prefix)
6850 ;; A prefix type is itself a primitive type when it's not
6851 ;; followed by another type.
6855 ;; Got no type but set things up to continue anyway to handle
6856 ;; the various cases when a declaration doesn't start with a
6858 (setq id-start start-pos))
6860 ((and (eq at-type 'maybe)
6861 (c-major-mode-is 'c++-mode))
6862 ;; If it's C++ then check if the last "type" ends on the form
6863 ;; "foo::foo" or "foo::~foo", i.e. if it's the name of a
6864 ;; (con|de)structor.
6866 (let (name end-2 end-1)
6867 (goto-char id-start)
6868 (c-backward-syntactic-ws)
6869 (setq end-2 (point))
6871 (c-simple-skip-symbol-backward)
6874 (buffer-substring-no-properties (point) end-2))
6875 ;; Cheating in the handling of syntactic ws below.
6876 (< (skip-chars-backward ":~ \t\n\r\v\f") 0))
6878 (setq end-1 (point))
6879 (c-simple-skip-symbol-backward))
6880 (>= (point) type-start)
6881 (equal (buffer-substring-no-properties (point) end-1)
6883 ;; It is a (con|de)structor name. In that case the
6884 ;; declaration is typeless so zap out any preceding
6885 ;; identifier(s) that we might have taken as types.
6886 (goto-char type-start)
6889 id-start type-start))))))
6891 ;; Check for and step over a type decl expression after the thing
6892 ;; that is or might be a type. This can't be skipped since we
6893 ;; need the correct end position of the declarator for
6894 ;; `max-type-decl-end-*'.
6895 (let ((start (point)) (paren-depth 0) pos
6896 ;; True if there's a non-open-paren match of
6897 ;; `c-type-decl-prefix-key'.
6899 ;; True if the declarator is surrounded by a parenthesis pair.
6901 ;; True if there is an identifier in the declarator.
6903 ;; True if there's a non-close-paren match of
6904 ;; `c-type-decl-suffix-key'.
6906 ;; True if there's a prefix match outside the outermost
6907 ;; paren pair that surrounds the declarator.
6908 got-prefix-before-parens
6909 ;; True if there's a suffix match outside the outermost
6910 ;; paren pair that surrounds the declarator. The value is
6911 ;; the position of the first suffix match.
6912 got-suffix-after-parens
6913 ;; True if we've parsed the type decl to a token that is
6914 ;; known to end declarations in this context.
6916 ;; The earlier values of `at-type' and `type-start' if we've
6917 ;; shifted the type backwards.
6918 identifier-type identifier-start
6919 ;; If `c-parse-and-markup-<>-arglists' is set we need to
6920 ;; turn it off during the name skipping below to avoid
6921 ;; getting `c-type' properties that might be bogus. That
6922 ;; can happen since we don't know if
6923 ;; `c-restricted-<>-arglists' will be correct inside the
6924 ;; arglist paren that gets entered.
6925 c-parse-and-markup-<>-arglists
6926 ;; Start of the identifier for which `got-identifier' was set.
6929 (goto-char id-start)
6931 ;; Skip over type decl prefix operators. (Note similar code in
6932 ;; `c-font-lock-declarators'.)
6933 (if (and c-recognize-typeless-decls
6934 (equal c-type-decl-prefix-key "\\<\\>"))
6935 (when (eq (char-after) ?\()
6937 (setq paren-depth (1+ paren-depth))
6939 (while (and (looking-at c-type-decl-prefix-key)
6940 (if (and (c-major-mode-is 'c++-mode)
6941 (match-beginning 3))
6942 ;; If the third submatch matches in C++ then
6943 ;; we're looking at an identifier that's a
6944 ;; prefix only if it specifies a member pointer.
6945 (when (progn (setq pos (point))
6946 (setq got-identifier (c-forward-name)))
6947 (setq name-start pos)
6948 (if (looking-at "\\(::\\)")
6949 ;; We only check for a trailing "::" and
6950 ;; let the "*" that should follow be
6951 ;; matched in the next round.
6952 (progn (setq got-identifier nil) t)
6953 ;; It turned out to be the real identifier,
6958 (if (eq (char-after) ?\()
6960 (setq paren-depth (1+ paren-depth))
6962 (unless got-prefix-before-parens
6963 (setq got-prefix-before-parens (= paren-depth 0)))
6965 (goto-char (match-end 1)))
6966 (c-forward-syntactic-ws)))
6968 (setq got-parens (> paren-depth 0))
6970 ;; Skip over an identifier.
6972 (and (looking-at c-identifier-start)
6974 (setq got-identifier (c-forward-name))
6975 (setq name-start pos)))
6977 ;; Skip over type decl suffix operators.
6978 (while (if (looking-at c-type-decl-suffix-key)
6980 (if (eq (char-after) ?\))
6981 (when (> paren-depth 0)
6982 (setq paren-depth (1- paren-depth))
6985 (when (if (save-match-data (looking-at "\\s\("))
6986 (c-safe (c-forward-sexp 1) t)
6987 (goto-char (match-end 1))
6989 (when (and (not got-suffix-after-parens)
6991 (setq got-suffix-after-parens (match-beginning 0)))
6992 (setq got-suffix t)))
6994 ;; No suffix matched. We might have matched the
6995 ;; identifier as a type and the open paren of a
6996 ;; function arglist as a type decl prefix. In that
6997 ;; case we should "backtrack": Reinterpret the last
6998 ;; type as the identifier, move out of the arglist and
6999 ;; continue searching for suffix operators.
7001 ;; Do this even if there's no preceding type, to cope
7002 ;; with old style function declarations in K&R C,
7003 ;; (con|de)structors in C++ and `c-typeless-decl-kwds'
7004 ;; style declarations. That isn't applicable in an
7005 ;; arglist context, though.
7006 (when (and (= paren-depth 1)
7007 (not got-prefix-before-parens)
7008 (not (eq at-type t))
7011 backup-maybe-typeless
7012 (when c-recognize-typeless-decls
7014 (setq pos (c-up-list-forward (point)))
7015 (eq (char-before pos) ?\)))
7016 (c-fdoc-shift-type-backward)
7020 (c-forward-syntactic-ws))
7022 (when (and (or maybe-typeless backup-maybe-typeless)
7023 (not got-identifier)
7026 ;; Have found no identifier but `c-typeless-decl-kwds' has
7027 ;; matched so we know we're inside a declaration. The
7028 ;; preceding type must be the identifier instead.
7029 (c-fdoc-shift-type-backward))
7033 (catch 'at-decl-or-cast
7036 (when (> paren-depth 0)
7037 ;; Encountered something inside parens that isn't matched by
7038 ;; the `c-type-decl-*' regexps, so it's not a type decl
7039 ;; expression. Try to skip out to the same paren depth to
7040 ;; not confuse the cast check below.
7041 (c-safe (goto-char (scan-lists (point) 1 paren-depth)))
7042 ;; If we've found a specifier keyword then it's a
7043 ;; declaration regardless.
7044 (throw 'at-decl-or-cast (eq at-decl-or-cast t)))
7047 (looking-at (cond ((eq context '<>) "[,>]")
7051 ;; Now we've collected info about various characteristics of
7052 ;; the construct we're looking at. Below follows a decision
7053 ;; tree based on that. It's ordered to check more certain
7054 ;; signs before less certain ones.
7060 (when (and (or at-type maybe-typeless)
7061 (not (or got-prefix got-parens)))
7062 ;; Got another identifier directly after the type, so it's a
7064 (throw 'at-decl-or-cast t))
7067 (when (and got-parens
7069 ;; (not got-suffix-after-parens)
7072 backup-maybe-typeless
7073 (eq at-decl-or-cast t)
7075 (goto-char name-start)
7076 (not (memq (c-forward-type) '(nil maybe))))))
7077 ;; Got a declaration of the form "foo bar (gnu);" or "bar
7078 ;; (gnu);" where we've recognized "bar" as the type and "gnu"
7079 ;; as the declarator. In this case it's however more likely
7080 ;; that "bar" is the declarator and "gnu" a function argument
7081 ;; or initializer (if `c-recognize-paren-inits' is set),
7082 ;; since the parens around "gnu" would be superfluous if it's
7083 ;; a declarator. Shift the type one step backward.
7084 (c-fdoc-shift-type-backward)))
7086 ;; Found no identifier.
7092 (when (= (point) start)
7093 ;; Got a plain list of identifiers. If a colon follows it's
7094 ;; a valid label, or maybe a bitfield. Otherwise the last
7095 ;; one probably is the declared identifier and we should
7096 ;; back up to the previous type, providing it isn't a cast.
7097 (if (and (eq (char-after) ?:)
7098 (not (c-major-mode-is 'java-mode)))
7100 ;; If we've found a specifier keyword then it's a
7101 ;; declaration regardless.
7102 ((eq at-decl-or-cast t)
7103 (throw 'at-decl-or-cast t))
7104 ((and c-has-bitfields
7105 (eq at-decl-or-cast 'ids)) ; bitfield.
7106 (setq backup-if-not-cast t)
7107 (throw 'at-decl-or-cast t)))
7109 (setq backup-if-not-cast t)
7110 (throw 'at-decl-or-cast t)))
7113 (when (and got-suffix
7116 ;; Got a plain list of identifiers followed by some suffix.
7117 ;; If this isn't a cast then the last identifier probably is
7118 ;; the declared one and we should back up to the previous
7120 (setq backup-if-not-cast t)
7121 (throw 'at-decl-or-cast t)))
7124 (when (eq at-type t)
7125 ;; If the type is known we know that there can't be any
7126 ;; identifier somewhere else, and it's only in declarations in
7127 ;; e.g. function prototypes and in casts that the identifier may
7129 (throw 'at-decl-or-cast t))
7131 (when (= (point) start)
7132 ;; Only got a single identifier (parsed as a type so far).
7135 ;; Check that the identifier isn't at the start of an
7140 ;; Inside an arglist that contains declarations. If K&R
7141 ;; style declarations and parenthesis style initializers
7142 ;; aren't allowed then the single identifier must be a
7143 ;; type, else we require that it's known or found
7144 ;; (primitive types are handled above).
7145 (or (and (not c-recognize-knr-p)
7146 (not c-recognize-paren-inits))
7147 (memq at-type '(known found))))
7149 ;; Inside a template arglist. Accept known and found
7150 ;; types; other identifiers could just as well be
7151 ;; constants in C++.
7152 (memq at-type '(known found)))))
7153 (throw 'at-decl-or-cast t)
7155 ;; Can't be a valid declaration or cast, but if we've found a
7156 ;; specifier it can't be anything else either, so treat it as
7157 ;; an invalid/unfinished declaration or cast.
7158 (throw 'at-decl-or-cast at-decl-or-cast))))
7163 (not (eq at-type t))
7166 backup-maybe-typeless
7167 (when c-recognize-typeless-decls
7168 (or (not got-suffix)
7170 c-after-suffixed-type-maybe-decl-key))))))
7171 ;; Got an empty paren pair and a preceding type that probably
7172 ;; really is the identifier. Shift the type backwards to make
7173 ;; the last one the identifier. This is analogous to the
7174 ;; "backtracking" done inside the `c-type-decl-suffix-key' loop
7177 ;; Exception: In addition to the conditions in that
7178 ;; "backtracking" code, do not shift backward if we're not
7179 ;; looking at either `c-after-suffixed-type-decl-key' or "[;,]".
7180 ;; Since there's no preceding type, the shift would mean that
7181 ;; the declaration is typeless. But if the regexp doesn't match
7182 ;; then we will simply fall through in the tests below and not
7183 ;; recognize it at all, so it's better to try it as an abstract
7184 ;; declarator instead.
7185 (c-fdoc-shift-type-backward)
7187 ;; Still no identifier.
7189 (when (and got-prefix (or got-parens got-suffix))
7190 ;; Require `got-prefix' together with either `got-parens' or
7191 ;; `got-suffix' to recognize it as an abstract declarator:
7192 ;; `got-parens' only is probably an empty function call.
7193 ;; `got-suffix' only can build an ordinary expression together
7194 ;; with the preceding identifier which we've taken as a type.
7195 ;; We could actually accept on `got-prefix' only, but that can
7196 ;; easily occur temporarily while writing an expression so we
7197 ;; avoid that case anyway. We could do a better job if we knew
7198 ;; the point when the fontification was invoked.
7199 (throw 'at-decl-or-cast t))
7205 got-suffix-after-parens
7206 (eq (char-after got-suffix-after-parens) ?\())
7207 ;; Got a type, no declarator but a paren suffix. I.e. it's a
7208 ;; normal function call after all (or perhaps a C++ style object
7209 ;; instantiation expression).
7210 (throw 'at-decl-or-cast nil))))
7213 (when at-decl-or-cast
7214 ;; By now we've located the type in the declaration that we know
7216 (throw 'at-decl-or-cast t))
7219 (when (and got-identifier
7221 (looking-at c-after-suffixed-type-decl-key)
7225 (not (eq at-type t)))
7226 ;; Shift the type backward in the case that there's a
7227 ;; single identifier inside parens. That can only
7228 ;; occur in K&R style function declarations so it's
7229 ;; more likely that it really is a function call.
7230 ;; Therefore we only do this after
7231 ;; `c-after-suffixed-type-decl-key' has matched.
7232 (progn (c-fdoc-shift-type-backward) t)
7233 got-suffix-after-parens))
7234 ;; A declaration according to `c-after-suffixed-type-decl-key'.
7235 (throw 'at-decl-or-cast t))
7238 (when (and (or got-prefix (not got-parens))
7239 (memq at-type '(t known)))
7240 ;; It's a declaration if a known type precedes it and it can't be a
7242 (throw 'at-decl-or-cast t))
7244 ;; If we get here we can't tell if this is a type decl or a normal
7245 ;; expression by looking at it alone. (That's under the assumption
7246 ;; that normal expressions always can look like type decl expressions,
7247 ;; which isn't really true but the cases where it doesn't hold are so
7248 ;; uncommon (e.g. some placements of "const" in C++) it's not worth
7249 ;; the effort to look for them.)
7251 ;;; 2008-04-16: commented out the next form, to allow the function to recognize
7252 ;;; "foo (int bar)" in CC (an implicit type (in class foo) without a semicolon)
7253 ;;; as a(n almost complete) declaration, enabling it to be fontified.
7255 ;; (unless (or at-decl-end (looking-at "=[^=]"))
7256 ;; If this is a declaration it should end here or its initializer(*)
7257 ;; should start here, so check for allowed separation tokens. Note
7258 ;; that this rule doesn't work e.g. with a K&R arglist after a
7261 ;; *) Don't check for C++ style initializers using parens
7262 ;; since those already have been matched as suffixes.
7264 ;; If `at-decl-or-cast' is then we've found some other sign that
7265 ;; it's a declaration or cast, so then it's probably an
7266 ;; invalid/unfinished one.
7267 ;; (throw 'at-decl-or-cast at-decl-or-cast))
7269 ;; Below are tests that only should be applied when we're certain to
7270 ;; not have parsed halfway through an expression.
7273 (when (memq at-type '(t known))
7274 ;; The expression starts with a known type so treat it as a
7276 (throw 'at-decl-or-cast t))
7279 (when (and (c-major-mode-is 'c++-mode)
7280 ;; In C++ we check if the identifier is a known type, since
7281 ;; (con|de)structors use the class name as identifier.
7282 ;; We've always shifted over the identifier as a type and
7283 ;; then backed up again in this case.
7285 (or (memq identifier-type '(found known))
7286 (and (eq (char-after identifier-start) ?~)
7287 ;; `at-type' probably won't be 'found for
7288 ;; destructors since the "~" is then part of the
7289 ;; type name being checked against the list of
7290 ;; known types, so do a check without that
7293 (goto-char (1+ identifier-start))
7294 (c-forward-syntactic-ws)
7295 (c-with-syntax-table
7296 c-identifier-syntax-table
7297 (looking-at c-known-type-key)))
7299 (goto-char (1+ identifier-start))
7300 ;; We have already parsed the type earlier,
7301 ;; so it'd be possible to cache the end
7302 ;; position instead of redoing it here, but
7303 ;; then we'd need to keep track of another
7304 ;; position everywhere.
7305 (c-check-type (point)
7306 (progn (c-forward-type)
7308 (throw 'at-decl-or-cast t))
7313 (when (and got-prefix-before-parens
7315 (or at-decl-end (looking-at "=[^=]"))
7318 ;; Got something like "foo * bar;". Since we're not inside an
7319 ;; arglist it would be a meaningless expression because the
7320 ;; result isn't used. We therefore choose to recognize it as
7321 ;; a declaration. Do not allow a suffix since it could then
7322 ;; be a function call.
7323 (throw 'at-decl-or-cast t))
7326 (when (and (or got-suffix-after-parens
7327 (looking-at "=[^=]"))
7329 (not (eq context 'arglist)))
7330 ;; Got something like "a (*b) (c);" or "a (b) = c;". It could
7331 ;; be an odd expression or it could be a declaration. Treat
7332 ;; it as a declaration if "a" has been used as a type
7333 ;; somewhere else (if it's a known type we won't get here).
7334 (throw 'at-decl-or-cast t)))
7339 (and (eq context 'decl)
7340 (not c-recognize-paren-inits)
7341 (or got-parens got-suffix))))
7342 ;; Got a type followed by an abstract declarator. If `got-prefix'
7343 ;; is set it's something like "a *" without anything after it. If
7344 ;; `got-parens' or `got-suffix' is set it's "a()", "a[]", "a()[]",
7345 ;; or similar, which we accept only if the context rules out
7347 (throw 'at-decl-or-cast t)))
7349 ;; If we had a complete symbol table here (which rules out
7350 ;; `c-found-types') we should return t due to the disambiguation rule
7351 ;; (in at least C++) that anything that can be parsed as a declaration
7352 ;; is a declaration. Now we're being more defensive and prefer to
7353 ;; highlight things like "foo (bar);" as a declaration only if we're
7354 ;; inside an arglist that contains declarations.
7355 (eq context 'decl))))
7357 ;; The point is now after the type decl expression.
7360 ;; Check for a cast.
7365 ;; Should be the first type/identifier in a cast paren.
7366 (> preceding-token-end (point-min))
7367 (memq (char-before preceding-token-end) c-cast-parens)
7369 ;; The closing paren should follow.
7371 (c-forward-syntactic-ws)
7372 (looking-at "\\s\)"))
7374 ;; There should be a primary expression after it.
7377 (c-forward-syntactic-ws)
7378 (setq cast-end (point))
7379 (and (looking-at c-primary-expr-regexp)
7381 (setq pos (match-end 0))
7383 ;; Check if the expression begins with a prefix keyword.
7385 (if (match-beginning 1)
7386 ;; Expression begins with an ambiguous operator. Treat
7387 ;; it as a cast if it's a type decl or if we've
7388 ;; recognized the type somewhere else.
7390 (memq at-type '(t known found)))
7391 ;; Unless it's a keyword, it's the beginning of a primary
7393 (not (looking-at c-keywords-regexp)))))
7394 ;; If `c-primary-expr-regexp' matched a nonsymbol token, check
7395 ;; that it matched a whole one so that we don't e.g. confuse
7396 ;; the operator '-' with '->'. It's ok if it matches further,
7397 ;; though, since it e.g. can match the float '.5' while the
7398 ;; operator regexp only matches '.'.
7399 (or (not (looking-at c-nonsymbol-token-regexp))
7400 (<= (match-end 0) pos))))
7402 ;; There should either be a cast before it or something that isn't an
7403 ;; identifier or close paren.
7404 (> preceding-token-end (point-min))
7406 (goto-char (1- preceding-token-end))
7407 (or (eq (point) last-cast-end)
7409 (c-backward-syntactic-ws)
7410 (if (< (skip-syntax-backward "w_") 0)
7411 ;; It's a symbol. Accept it only if it's one of the
7412 ;; keywords that can precede an expression (without
7413 ;; surrounding parens).
7414 (looking-at c-simple-stmt-key)
7416 ;; Check that it isn't a close paren (block close is ok,
7418 (not (memq (char-before) '(?\) ?\])))
7419 ;; Check that it isn't a nonsymbol identifier.
7420 (not (c-on-identifier)))))))))
7423 (when (and c-record-type-identifiers at-type (not (eq at-type t)))
7424 (let ((c-promote-possible-types t))
7425 (goto-char type-start)
7428 (goto-char cast-end)
7432 ;; We're at a declaration. Highlight the type and the following
7435 (when backup-if-not-cast
7436 (c-fdoc-shift-type-backward t))
7438 (when (and (eq context 'decl) (looking-at ","))
7439 ;; Make sure to propagate the `c-decl-arg-start' property to
7440 ;; the next argument if it's set in this one, to cope with
7441 ;; interactive refontification.
7442 (c-put-c-type-property (point) 'c-decl-arg-start))
7444 (when (and c-record-type-identifiers at-type ;; (not (eq at-type t))
7445 ;; There seems no reason to exclude a token from
7446 ;; fontification just because it's "a known type that can't
7447 ;; be a name or other expression". 2013-09-18.
7449 (let ((c-promote-possible-types t))
7451 (goto-char type-start)
7455 (and (or at-type-decl at-typedef)
7456 (cons at-type-decl at-typedef))))
7459 ;; False alarm. Restore the recorded ranges.
7460 (setq c-record-type-identifiers save-rec-type-ids
7461 c-record-ref-identifiers save-rec-ref-ids)
7464 (defun c-forward-label (&optional assume-markup preceding-token-end limit)
7465 ;; Assuming that point is at the beginning of a token, check if it starts a
7466 ;; label and if so move over it and return non-nil (t in default situations,
7467 ;; specific symbols (see below) for interesting situations), otherwise don't
7468 ;; move and return nil. "Label" here means "most things with a colon".
7470 ;; More precisely, a "label" is regarded as one of:
7471 ;; (i) a goto target like "foo:" - returns the symbol `goto-target';
7472 ;; (ii) A case label - either the entire construct "case FOO:", or just the
7473 ;; bare "case", should the colon be missing. We return t;
7474 ;; (iii) a keyword which needs a colon, like "default:" or "private:"; We
7476 ;; (iv) One of QT's "extended" C++ variants of
7477 ;; "private:"/"protected:"/"public:"/"more:" looking like "public slots:".
7478 ;; Returns the symbol `qt-2kwds-colon'.
7479 ;; (v) QT's construct "signals:". Returns the symbol `qt-1kwd-colon'.
7480 ;; (vi) One of the keywords matched by `c-opt-extra-label-key' (without any
7481 ;; colon). Currently (2006-03), this applies only to Objective C's
7482 ;; keywords "@private", "@protected", and "@public". Returns t.
7484 ;; One of the things which will NOT be recognized as a label is a bit-field
7485 ;; element of a struct, something like "int foo:5".
7487 ;; The end of the label is taken to be just after the colon, or the end of
7488 ;; the first submatch in `c-opt-extra-label-key'. The point is directly
7489 ;; after the end on return. The terminating char gets marked with
7490 ;; `c-decl-end' to improve recognition of the following declaration or
7493 ;; If ASSUME-MARKUP is non-nil, it's assumed that the preceding
7494 ;; label, if any, has already been marked up like that.
7496 ;; If PRECEDING-TOKEN-END is given, it should be the first position
7497 ;; after the preceding token, i.e. on the other side of the
7498 ;; syntactic ws from the point. Use a value less than or equal to
7499 ;; (point-min) if the point is at the first token in (the visible
7500 ;; part of) the buffer.
7502 ;; The optional LIMIT limits the forward scan for the colon.
7504 ;; This function records the ranges of the label symbols on
7505 ;; `c-record-ref-identifiers' if `c-record-type-identifiers' (!) is
7508 ;; This function might do hidden buffer changes.
7510 (let ((start (point))
7513 macro-start ; if we're in one.
7517 ;; "case" or "default" (Doesn't apply to AWK).
7518 ((looking-at c-label-kwds-regexp)
7519 (let ((kwd-end (match-end 1)))
7520 ;; Record only the keyword itself for fontification, since in
7521 ;; case labels the following is a constant expression and not
7523 (when c-record-type-identifiers
7524 (c-record-ref-id (cons (match-beginning 1) kwd-end)))
7526 ;; Find the label end.
7529 (if (and (c-syntactic-re-search-forward
7530 ;; Stop on chars that aren't allowed in expressions,
7531 ;; and on operator chars that would be meaningless
7532 ;; there. FIXME: This doesn't cope with ?: operators.
7533 "[;{=,@]\\|\\(\\=\\|[^:]\\):\\([^:]\\|\\'\\)"
7535 (match-beginning 2))
7537 (progn ; there's a proper :
7538 (goto-char (match-beginning 2)) ; just after the :
7539 (c-put-c-type-property (1- (point)) 'c-decl-end)
7542 ;; It's an unfinished label. We consider the keyword enough
7543 ;; to recognize it as a label, so that it gets fontified.
7544 ;; Leave the point at the end of it, but don't put any
7545 ;; `c-decl-end' marker.
7549 ;; @private, @protected, @public, in Objective C, or similar.
7550 ((and c-opt-extra-label-key
7551 (looking-at c-opt-extra-label-key))
7552 ;; For a `c-opt-extra-label-key' match, we record the whole
7553 ;; thing for fontification. That's to get the leading '@' in
7554 ;; Objective-C protection labels fontified.
7555 (goto-char (match-end 1))
7556 (when c-record-type-identifiers
7557 (c-record-ref-id (cons (match-beginning 1) (point))))
7558 (c-put-c-type-property (1- (point)) 'c-decl-end)
7559 (setq label-type t))
7561 ;; All other cases of labels.
7562 ((and c-recognize-colon-labels ; nil for AWK and IDL, otherwise t.
7564 ;; A colon label must have something before the colon.
7565 (not (eq (char-after) ?:))
7567 ;; Check that we're not after a token that can't precede a label.
7569 ;; Trivially succeeds when there's no preceding token.
7570 ;; Succeeds when we're at a virtual semicolon.
7571 (if preceding-token-end
7572 (<= preceding-token-end (point-min))
7574 (c-backward-syntactic-ws)
7575 (setq preceding-token-end (point))
7579 ;; Check if we're after a label, if we're after a closing
7580 ;; paren that belong to statement, and with
7581 ;; `c-label-prefix-re'. It's done in different order
7582 ;; depending on `assume-markup' since the checks have
7583 ;; different expensiveness.
7586 (eq (c-get-char-property (1- preceding-token-end) 'c-type)
7590 (goto-char (1- preceding-token-end))
7591 (c-beginning-of-current-token)
7592 (or (looking-at c-label-prefix-re)
7593 (looking-at c-block-stmt-1-key)))
7595 (and (eq (char-before preceding-token-end) ?\))
7596 (c-after-conditional)))
7600 (goto-char (1- preceding-token-end))
7601 (c-beginning-of-current-token)
7602 (or (looking-at c-label-prefix-re)
7603 (looking-at c-block-stmt-1-key)))
7606 ((eq (char-before preceding-token-end) ?\))
7607 (c-after-conditional))
7609 ((eq (char-before preceding-token-end) ?:)
7610 ;; Might be after another label, so check it recursively.
7613 (goto-char (1- preceding-token-end))
7614 ;; Essentially the same as the
7615 ;; `c-syntactic-re-search-forward' regexp below.
7617 (save-excursion (and (c-beginning-of-macro)
7619 (if macro-start (narrow-to-region macro-start (point-max)))
7620 (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+" nil t)
7621 ;; Note: the following should work instead of the
7622 ;; narrow-to-region above. Investigate why not,
7623 ;; sometime. ACM, 2006-03-31.
7624 ;; (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+"
7627 ;; If the caller turned on recording for us,
7628 ;; it shouldn't apply when we check the
7630 c-record-type-identifiers)
7631 ;; A label can't start at a cpp directive. Check for
7632 ;; this, since c-forward-syntactic-ws would foul up on it.
7633 (unless (and c-opt-cpp-prefix (looking-at c-opt-cpp-prefix))
7634 (c-forward-syntactic-ws)
7635 (c-forward-label nil pte start))))))))))
7637 ;; Point is still at the beginning of the possible label construct.
7639 ;; Check that the next nonsymbol token is ":", or that we're in one
7640 ;; of QT's "slots" declarations. Allow '(' for the sake of macro
7641 ;; arguments. FIXME: Should build this regexp from the language
7644 ;; public: protected: private:
7646 (c-major-mode-is 'c++-mode)
7647 (search-forward-regexp
7648 "\\=p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\>[^_]" nil t)
7649 (progn (backward-char)
7650 (c-forward-syntactic-ws limit)
7651 (looking-at ":\\([^:]\\|\\'\\)"))) ; A single colon.
7653 (setq label-type t))
7654 ;; QT double keyword like "protected slots:" or goto target.
7655 ((progn (goto-char start) nil))
7656 ((when (c-syntactic-re-search-forward
7657 "[ \t\n[:?;{=*/%&|,<>!@+-]" limit t t) ; not at EOB
7659 (setq label-end (point))
7661 (and (c-major-mode-is 'c++-mode)
7663 "\\(p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\|more\\)\\>"
7664 (buffer-substring start (point)))))
7665 (c-forward-syntactic-ws limit)
7667 ((looking-at ":\\([^:]\\|\\'\\)") ; A single colon.
7670 (if (or (string= "signals" ; Special QT macro
7671 (setq kwd (buffer-substring-no-properties start label-end)))
7672 (string= "Q_SIGNALS" kwd))
7676 (search-forward-regexp "\\=\\(slots\\|Q_SLOTS\\)\\>" limit t)
7677 (progn (c-forward-syntactic-ws limit)
7678 (looking-at ":\\([^:]\\|\\'\\)"))) ; A single colon
7680 (setq label-type 'qt-2kwds-colon)))))))
7683 (narrow-to-region start (point))
7685 ;; Check that `c-nonlabel-token-key' doesn't match anywhere.
7689 (when (looking-at c-nonlabel-token-key)
7691 (setq label-type nil)
7692 (throw 'check-label nil))
7693 (and (c-safe (c-forward-sexp)
7694 (c-forward-syntactic-ws)
7698 ;; Record the identifiers in the label for fontification, unless
7699 ;; it begins with `c-label-kwds' in which case the following
7700 ;; identifiers are part of a (constant) expression that
7701 ;; shouldn't be fontified.
7702 (when (and c-record-type-identifiers
7703 (progn (goto-char start)
7704 (not (looking-at c-label-kwds-regexp))))
7705 (while (c-syntactic-re-search-forward c-symbol-key nil t)
7706 (c-record-ref-id (cons (match-beginning 0)
7709 (c-put-c-type-property (1- (point-max)) 'c-decl-end)
7710 (goto-char (point-max)))))
7717 (defun c-forward-objc-directive ()
7718 ;; Assuming the point is at the beginning of a token, try to move
7719 ;; forward to the end of the Objective-C directive that starts
7720 ;; there. Return t if a directive was fully recognized, otherwise
7721 ;; the point is moved as far as one could be successfully parsed and
7724 ;; This function records identifier ranges on
7725 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
7726 ;; `c-record-type-identifiers' is non-nil.
7728 ;; This function might do hidden buffer changes.
7730 (let ((start (point))
7732 (c-promote-possible-types t)
7734 ;; Turn off recognition of angle bracket arglists while parsing
7735 ;; types here since the protocol reference list might then be
7736 ;; considered part of the preceding name or superclass-name.
7737 c-recognize-<>-arglists)
7742 (c-make-keywords-re t
7743 (append (c-lang-const c-protection-kwds objc)
7746 (goto-char (match-end 1))
7752 (c-make-keywords-re t
7753 '("@interface" "@implementation" "@protocol")
7756 ;; Handle the name of the class itself.
7758 ; (c-forward-token-2) ; 2006/1/13 This doesn't move if the token's
7760 (goto-char (match-end 0))
7766 ;; Look for ": superclass-name" or "( category-name )".
7767 (when (looking-at "[:\(]")
7768 (setq start-char (char-after))
7770 (c-forward-syntactic-ws)
7771 (unless (c-forward-type) (throw 'break nil))
7772 (when (eq start-char ?\()
7773 (unless (eq (char-after) ?\)) (throw 'break nil))
7775 (c-forward-syntactic-ws)))
7777 ;; Look for a protocol reference list.
7778 (if (eq (char-after) ?<)
7779 (let ((c-recognize-<>-arglists t)
7780 (c-parse-and-markup-<>-arglists t)
7781 c-restricted-<>-arglists)
7782 (c-forward-<>-arglist t))
7786 (c-backward-syntactic-ws lim)
7787 (c-clear-c-type-property start (1- (point)) 'c-decl-end)
7788 (c-put-c-type-property (1- (point)) 'c-decl-end)
7791 (c-clear-c-type-property start (point) 'c-decl-end)
7794 (defun c-beginning-of-inheritance-list (&optional lim)
7795 ;; Go to the first non-whitespace after the colon that starts a
7796 ;; multiple inheritance introduction. Optional LIM is the farthest
7797 ;; back we should search.
7799 ;; This function might do hidden buffer changes.
7800 (c-with-syntax-table c++-template-syntax-table
7801 (c-backward-token-2 0 t lim)
7802 (while (and (or (looking-at c-symbol-start)
7803 (looking-at "[<,]\\|::"))
7804 (zerop (c-backward-token-2 1 t lim))))))
7806 (defun c-in-method-def-p ()
7807 ;; Return nil if we aren't in a method definition, otherwise the
7808 ;; position of the initial [+-].
7810 ;; This function might do hidden buffer changes.
7813 (and c-opt-method-key
7814 (looking-at c-opt-method-key)
7818 ;; Contributed by Kevin Ryde <user42@zip.com.au>.
7819 (defun c-in-gcc-asm-p ()
7820 ;; Return non-nil if point is within a gcc \"asm\" block.
7822 ;; This should be called with point inside an argument list.
7824 ;; Only one level of enclosing parentheses is considered, so for
7825 ;; instance `nil' is returned when in a function call within an asm
7828 ;; This function might do hidden buffer changes.
7830 (and c-opt-asm-stmt-key
7833 (backward-up-list 1)
7834 (c-beginning-of-statement-1 (point-min) nil t)
7835 (looking-at c-opt-asm-stmt-key))))
7837 (defun c-at-toplevel-p ()
7838 "Return a determination as to whether point is \"at the top level\".
7839 Informally, \"at the top level\" is anywhere where you can write
7842 More precisely, being at the top-level means that point is either
7843 outside any enclosing block (such as a function definition), or
7844 directly inside a class, namespace or other block that contains
7845 another declaration level.
7847 If point is not at the top-level (e.g. it is inside a method
7848 definition), then nil is returned. Otherwise, if point is at a
7849 top-level not enclosed within a class definition, t is returned.
7850 Otherwise, a 2-vector is returned where the zeroth element is the
7851 buffer position of the start of the class declaration, and the first
7852 element is the buffer position of the enclosing class's opening
7855 Note that this function might do hidden buffer changes. See the
7856 comment at the start of cc-engine.el for more info."
7857 (let ((paren-state (c-parse-state)))
7858 (or (not (c-most-enclosing-brace paren-state))
7859 (c-search-uplist-for-classkey paren-state))))
7861 (defun c-just-after-func-arglist-p (&optional lim)
7862 ;; Return non-nil if the point is in the region after the argument
7863 ;; list of a function and its opening brace (or semicolon in case it
7864 ;; got no body). If there are K&R style argument declarations in
7865 ;; that region, the point has to be inside the first one for this
7866 ;; function to recognize it.
7868 ;; If successful, the point is moved to the first token after the
7869 ;; function header (see `c-forward-decl-or-cast-1' for details) and
7870 ;; the position of the opening paren of the function arglist is
7873 ;; The point is clobbered if not successful.
7875 ;; LIM is used as bound for backward buffer searches.
7877 ;; This function might do hidden buffer changes.
7879 (let ((beg (point)) end id-start)
7881 (eq (c-beginning-of-statement-1 lim) 'same)
7883 (not (and (c-major-mode-is 'objc-mode)
7884 (c-forward-objc-directive)))
7887 (car-safe (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil)))
7890 ;; There should not be a '=' or ',' between beg and the
7891 ;; start of the declaration since that means we were in the
7892 ;; "expression part" of the declaration.
7894 (not (looking-at "[=,]")))
7897 ;; Check that there's an arglist paren in the
7899 (goto-char id-start)
7900 (cond ((eq (char-after) ?\()
7901 ;; The declarator is a paren expression, so skip past it
7902 ;; so that we don't get stuck on that instead of the
7903 ;; function arglist.
7905 ((and c-opt-op-identifier-prefix
7906 (looking-at c-opt-op-identifier-prefix))
7907 ;; Don't trip up on "operator ()".
7908 (c-forward-token-2 2 t)))
7909 (and (< (point) beg)
7910 (c-syntactic-re-search-forward "(" beg t t)
7913 (defun c-in-knr-argdecl (&optional lim)
7914 ;; Return the position of the first argument declaration if point is
7915 ;; inside a K&R style argument declaration list, nil otherwise.
7916 ;; `c-recognize-knr-p' is not checked. If LIM is non-nil, it's a
7917 ;; position that bounds the backward search for the argument list.
7919 ;; Point must be within a possible K&R region, e.g. just before a top-level
7920 ;; "{". It must be outside of parens and brackets. The test can return
7921 ;; false positives otherwise.
7923 ;; This function might do hidden buffer changes.
7927 ;; If we're in a macro, our search range is restricted to it. Narrow to
7928 ;; the searchable range.
7929 (let* ((macro-start (save-excursion (and (c-beginning-of-macro) (point))))
7930 (macro-end (save-excursion (and macro-start (c-end-of-macro) (point))))
7931 (low-lim (max (or lim (point-min)) (or macro-start (point-min))))
7932 before-lparen after-rparen
7933 (pp-count-out 20)) ; Max number of paren/brace constructs before
7935 (narrow-to-region low-lim (or macro-end (point-max)))
7937 ;; Search backwards for the defun's argument list. We give up if we
7938 ;; encounter a "}" (end of a previous defun) an "=" (which can't be in
7939 ;; a knr region) or BOB.
7941 ;; The criterion for a paren structure being the arg list is:
7942 ;; o - there is non-WS stuff after it but before any "{"; AND
7943 ;; o - the token after it isn't a ";" AND
7944 ;; o - it is preceded by either an identifier (the function name) or
7945 ;; a macro expansion like "DEFUN (...)"; AND
7946 ;; o - its content is a non-empty comma-separated list of identifiers
7947 ;; (an empty arg list won't have a knr region).
7949 ;; The following snippet illustrates these rules:
7950 ;; int foo (bar, baz, yuk)
7952 ;; int (*baz) (my_type) ;
7953 ;; int (*) (void) (*yuk) (void) ;
7957 (while (> pp-count-out 0) ; go back one paren/bracket pair each time.
7958 (setq pp-count-out (1- pp-count-out))
7959 (c-syntactic-skip-backward "^)]}=")
7960 (cond ((eq (char-before) ?\))
7961 (setq after-rparen (point)))
7962 ((eq (char-before) ?\])
7963 (setq after-rparen nil))
7964 (t ; either } (hit previous defun) or = or no more
7969 ;; We're inside a paren. Could it be our argument list....?
7973 (goto-char after-rparen)
7974 (unless (c-go-list-backward) (throw 'knr nil)) ;
7975 ;; FIXME!!! What about macros between the parens? 2007/01/20
7976 (setq before-lparen (point)))
7978 ;; It can't be the arg list if next token is ; or {
7979 (progn (goto-char after-rparen)
7980 (c-forward-syntactic-ws)
7981 (not (memq (char-after) '(?\; ?\{ ?\=))))
7983 ;; Is the thing preceding the list an identifier (the
7984 ;; function name), or a macro expansion?
7986 (goto-char before-lparen)
7987 (eq (c-backward-token-2) 0)
7988 (or (eq (c-on-identifier) (point))
7989 (and (eq (char-after) ?\))
7990 (c-go-up-list-backward)
7991 (eq (c-backward-token-2) 0)
7992 (eq (c-on-identifier) (point)))))
7994 ;; Have we got a non-empty list of comma-separated
7997 (goto-char before-lparen)
7998 (c-forward-token-2) ; to first token inside parens
8003 (while (eq (char-after) ?\,)
8005 (unless (c-on-identifier) (throw 'id-list nil))
8006 (c-forward-token-2))
8007 (eq (char-after) ?\))))))
8009 ;; ...Yes. We've identified the function's argument list.
8011 (progn (goto-char after-rparen)
8012 (c-forward-syntactic-ws)
8015 ;; ...No. The current parens aren't the function's arg list.
8016 (goto-char before-lparen))
8018 (or (c-go-list-backward) ; backwards over [ .... ]
8019 (throw 'knr nil)))))))))
8021 (defun c-skip-conditional ()
8022 ;; skip forward over conditional at point, including any predicate
8023 ;; statements in parentheses. No error checking is performed.
8025 ;; This function might do hidden buffer changes.
8026 (c-forward-sexp (cond
8028 ((looking-at (concat "\\<else"
8029 "\\([ \t\n]\\|\\\\\n\\)+"
8030 "if\\>\\([^_]\\|$\\)"))
8032 ;; do, else, try, finally
8033 ((looking-at (concat "\\<\\("
8034 "do\\|else\\|try\\|finally"
8035 "\\)\\>\\([^_]\\|$\\)"))
8037 ;; for, if, while, switch, catch, synchronized, foreach
8040 (defun c-after-conditional (&optional lim)
8041 ;; If looking at the token after a conditional then return the
8042 ;; position of its start, otherwise return nil.
8044 ;; This function might do hidden buffer changes.
8046 (and (zerop (c-backward-token-2 1 t lim))
8047 (or (looking-at c-block-stmt-1-key)
8048 (and (eq (char-after) ?\()
8049 (zerop (c-backward-token-2 1 t lim))
8050 (or (looking-at c-block-stmt-2-key)
8051 (looking-at c-block-stmt-1-2-key))))
8054 (defun c-after-special-operator-id (&optional lim)
8055 ;; If the point is after an operator identifier that isn't handled
8056 ;; like an ordinary symbol (i.e. like "operator =" in C++) then the
8057 ;; position of the start of that identifier is returned. nil is
8058 ;; returned otherwise. The point may be anywhere in the syntactic
8059 ;; whitespace after the last token of the operator identifier.
8061 ;; This function might do hidden buffer changes.
8063 (and c-overloadable-operators-regexp
8064 (zerop (c-backward-token-2 1 nil lim))
8065 (looking-at c-overloadable-operators-regexp)
8066 (or (not c-opt-op-identifier-prefix)
8068 (zerop (c-backward-token-2 1 nil lim))
8069 (looking-at c-opt-op-identifier-prefix)))
8072 (defsubst c-backward-to-block-anchor (&optional lim)
8073 ;; Assuming point is at a brace that opens a statement block of some
8074 ;; kind, move to the proper anchor point for that block. It might
8075 ;; need to be adjusted further by c-add-stmt-syntax, but the
8076 ;; position at return is suitable as start position for that
8079 ;; This function might do hidden buffer changes.
8080 (unless (= (point) (c-point 'boi))
8081 (let ((start (c-after-conditional lim)))
8083 (goto-char start)))))
8085 (defsubst c-backward-to-decl-anchor (&optional lim)
8086 ;; Assuming point is at a brace that opens the block of a top level
8087 ;; declaration of some kind, move to the proper anchor point for
8090 ;; This function might do hidden buffer changes.
8091 (unless (= (point) (c-point 'boi))
8092 (c-beginning-of-statement-1 lim)))
8094 (defun c-search-decl-header-end ()
8095 ;; Search forward for the end of the "header" of the current
8096 ;; declaration. That's the position where the definition body
8097 ;; starts, or the first variable initializer, or the ending
8098 ;; semicolon. I.e. search forward for the closest following
8099 ;; (syntactically relevant) '{', '=' or ';' token. Point is left
8100 ;; _after_ the first found token, or at point-max if none is found.
8102 ;; This function might do hidden buffer changes.
8104 (let ((base (point)))
8105 (if (c-major-mode-is 'c++-mode)
8107 ;; In C++ we need to take special care to handle operator
8108 ;; tokens and those pesky template brackets.
8110 (c-syntactic-re-search-forward "[;{<=]" nil 'move t t)
8112 (c-end-of-current-token base)
8113 ;; Handle operator identifiers, i.e. ignore any
8114 ;; operator token preceded by "operator".
8116 (and (c-safe (c-backward-sexp) t)
8117 (looking-at c-opt-op-identifier-prefix)))
8118 (and (eq (char-before) ?<)
8119 (c-with-syntax-table c++-template-syntax-table
8120 (if (c-safe (goto-char (c-up-list-forward (point))))
8122 (goto-char (point-max))
8124 (setq base (point)))
8127 (c-syntactic-re-search-forward "[;{=]" nil 'move t t)
8128 (c-end-of-current-token base))
8129 (setq base (point))))))
8131 (defun c-beginning-of-decl-1 (&optional lim)
8132 ;; Go to the beginning of the current declaration, or the beginning
8133 ;; of the previous one if already at the start of it. Point won't
8134 ;; be moved out of any surrounding paren. Return a cons cell of the
8135 ;; form (MOVE . KNR-POS). MOVE is like the return value from
8136 ;; `c-beginning-of-statement-1'. If point skipped over some K&R
8137 ;; style argument declarations (and they are to be recognized) then
8138 ;; KNR-POS is set to the start of the first such argument
8139 ;; declaration, otherwise KNR-POS is nil. If LIM is non-nil, it's a
8140 ;; position that bounds the backward search.
8142 ;; NB: Cases where the declaration continues after the block, as in
8143 ;; "struct foo { ... } bar;", are currently recognized as two
8144 ;; declarations, e.g. "struct foo { ... }" and "bar;" in this case.
8146 ;; This function might do hidden buffer changes.
8148 (let* ((start (point))
8149 (last-stmt-start (point))
8150 (move (c-beginning-of-statement-1 lim nil t)))
8152 ;; `c-beginning-of-statement-1' stops at a block start, but we
8153 ;; want to continue if the block doesn't begin a top level
8154 ;; construct, i.e. if it isn't preceded by ';', '}', ':', bob,
8155 ;; or an open paren.
8156 (let ((beg (point)) tentative-move)
8157 ;; Go back one "statement" each time round the loop until we're just
8158 ;; after a ;, }, or :, or at BOB or the start of a macro or start of
8159 ;; an ObjC method. This will move over a multiple declaration whose
8160 ;; components are comma separated.
8162 ;; Must check with c-opt-method-key in ObjC mode.
8163 (not (and c-opt-method-key
8164 (looking-at c-opt-method-key)))
8165 (/= last-stmt-start (point))
8167 (c-backward-syntactic-ws lim)
8168 (not (memq (char-before) '(?\; ?} ?: nil))))
8171 (not (looking-at "\\s(")))
8172 ;; Check that we don't move from the first thing in a
8173 ;; macro to its header.
8174 (not (eq (setq tentative-move
8175 (c-beginning-of-statement-1 lim nil t))
8177 (setq last-stmt-start beg
8179 move tentative-move))
8182 (when c-recognize-knr-p
8183 (let ((fallback-pos (point)) knr-argdecl-start)
8184 ;; Handle K&R argdecls. Back up after the "statement" jumped
8185 ;; over by `c-beginning-of-statement-1', unless it was the
8186 ;; function body, in which case we're sitting on the opening
8187 ;; brace now. Then test if we're in a K&R argdecl region and
8188 ;; that we started at the other side of the first argdecl in
8190 (unless (eq (char-after) ?{)
8191 (goto-char last-stmt-start))
8192 (if (and (setq knr-argdecl-start (c-in-knr-argdecl lim))
8193 (< knr-argdecl-start start)
8195 (goto-char knr-argdecl-start)
8196 (not (eq (c-beginning-of-statement-1 lim nil t) 'macro))))
8198 (cons (if (eq (char-after fallback-pos) ?{)
8202 (goto-char fallback-pos))))
8204 ;; `c-beginning-of-statement-1' counts each brace block as a separate
8205 ;; statement, so the result will be 'previous if we've moved over any.
8206 ;; So change our result back to 'same if necessary.
8208 ;; If they were brace list initializers we might not have moved over a
8209 ;; declaration boundary though, so change it to 'same if we've moved
8210 ;; past a '=' before '{', but not ';'. (This ought to be integrated
8211 ;; into `c-beginning-of-statement-1', so we avoid this extra pass which
8212 ;; potentially can search over a large amount of text.). Take special
8213 ;; pains not to get mislead by C++'s "operator=", and the like.
8214 (if (and (eq move 'previous)
8215 (c-with-syntax-table (if (c-major-mode-is 'c++-mode)
8216 c++-template-syntax-table
8221 (while ; keep going back to "[;={"s until we either find
8222 ; no more, or get to one which isn't an "operator ="
8223 (and (c-syntactic-re-search-forward "[;={]" start t t t)
8224 (eq (char-before) ?=)
8225 c-overloadable-operators-regexp
8226 c-opt-op-identifier-prefix
8228 (eq (c-backward-token-2) 0)
8229 (looking-at c-overloadable-operators-regexp)
8230 (eq (c-backward-token-2) 0)
8231 (looking-at c-opt-op-identifier-prefix))))
8232 (eq (char-before) ?=))
8233 (c-syntactic-re-search-forward "[;{]" start t t)
8234 (eq (char-before) ?{)
8235 (c-safe (goto-char (c-up-list-forward (point))) t)
8236 (not (c-syntactic-re-search-forward ";" start t t))))))
8240 (defun c-end-of-decl-1 ()
8241 ;; Assuming point is at the start of a declaration (as detected by
8242 ;; e.g. `c-beginning-of-decl-1'), go to the end of it. Unlike
8243 ;; `c-beginning-of-decl-1', this function handles the case when a
8244 ;; block is followed by identifiers in e.g. struct declarations in C
8245 ;; or C++. If a proper end was found then t is returned, otherwise
8246 ;; point is moved as far as possible within the current sexp and nil
8247 ;; is returned. This function doesn't handle macros; use
8248 ;; `c-end-of-macro' instead in those cases.
8250 ;; This function might do hidden buffer changes.
8251 (let ((start (point))
8252 (decl-syntax-table (if (c-major-mode-is 'c++-mode)
8253 c++-template-syntax-table
8256 (c-search-decl-header-end)
8258 (when (and c-recognize-knr-p
8259 (eq (char-before) ?\;)
8260 (c-in-knr-argdecl start))
8261 ;; Stopped at the ';' in a K&R argdecl section which is
8262 ;; detected using the same criteria as in
8263 ;; `c-beginning-of-decl-1'. Move to the following block
8265 (c-syntactic-re-search-forward "{" nil 'move t))
8267 (when (eq (char-before) ?{)
8268 ;; Encountered a block in the declaration. Jump over it.
8270 (goto-char (c-up-list-forward (point)))
8271 (error (goto-char (point-max))
8272 (throw 'return nil)))
8273 (if (or (not c-opt-block-decls-with-vars-key)
8275 (c-with-syntax-table decl-syntax-table
8276 (let ((lim (point)))
8279 ;; Check for `c-opt-block-decls-with-vars-key'
8280 ;; before the first paren.
8281 (c-syntactic-re-search-forward
8282 (concat "[;=\(\[{]\\|\\("
8283 c-opt-block-decls-with-vars-key
8287 (not (eq (char-before) ?_))
8288 ;; Check that the first following paren is
8290 (c-syntactic-re-search-forward "[;=\(\[{]"
8292 (eq (char-before) ?{)))))))
8293 ;; The declaration doesn't have any of the
8294 ;; `c-opt-block-decls-with-vars' keywords in the
8295 ;; beginning, so it ends here at the end of the block.
8298 (c-with-syntax-table decl-syntax-table
8300 (if (eq (char-before) ?\;)
8302 (c-syntactic-re-search-forward ";" nil 'move t))))
8305 (defun c-looking-at-decl-block (containing-sexp goto-start &optional limit)
8306 ;; Assuming the point is at an open brace, check if it starts a
8307 ;; block that contains another declaration level, i.e. that isn't a
8308 ;; statement block or a brace list, and if so return non-nil.
8310 ;; If the check is successful, the return value is the start of the
8311 ;; keyword that tells what kind of construct it is, i.e. typically
8312 ;; what `c-decl-block-key' matched. Also, if GOTO-START is set then
8313 ;; the point will be at the start of the construct, before any
8314 ;; leading specifiers, otherwise it's at the returned position.
8316 ;; The point is clobbered if the check is unsuccessful.
8318 ;; CONTAINING-SEXP is the position of the open of the surrounding
8319 ;; paren, or nil if none.
8321 ;; The optional LIMIT limits the backward search for the start of
8322 ;; the construct. It's assumed to be at a syntactically relevant
8325 ;; If any template arglists are found in the searched region before
8326 ;; the open brace, they get marked with paren syntax.
8328 ;; This function might do hidden buffer changes.
8330 (let ((open-brace (point)) kwd-start first-specifier-pos)
8331 (c-syntactic-skip-backward c-block-prefix-charset limit t)
8333 (when (and c-recognize-<>-arglists
8334 (eq (char-before) ?>))
8335 ;; Could be at the end of a template arglist.
8336 (let ((c-parse-and-markup-<>-arglists t)
8337 (c-disallow-comma-in-<>-arglists
8338 (and containing-sexp
8339 (not (eq (char-after containing-sexp) ?{)))))
8341 (c-backward-<>-arglist nil limit)
8343 (c-syntactic-skip-backward c-block-prefix-charset limit t)
8344 (eq (char-before) ?>))))))
8346 ;; Note: Can't get bogus hits inside template arglists below since they
8347 ;; have gotten paren syntax above.
8349 ;; If `goto-start' is set we begin by searching for the
8350 ;; first possible position of a leading specifier list.
8351 ;; The `c-decl-block-key' search continues from there since
8352 ;; we know it can't match earlier.
8354 (when (c-syntactic-re-search-forward c-symbol-start
8356 (goto-char (setq first-specifier-pos (match-beginning 0)))
8361 ((c-syntactic-re-search-forward c-decl-block-key open-brace t t t)
8362 (goto-char (setq kwd-start (match-beginning 0)))
8365 ;; Found a keyword that can't be a type?
8368 ;; Can be a type too, in which case it's the return type of a
8369 ;; function (under the assumption that no declaration level
8370 ;; block construct starts with a type).
8371 (not (c-forward-type))
8373 ;; Jumped over a type, but it could be a declaration keyword
8374 ;; followed by the declared identifier that we've jumped over
8375 ;; instead (e.g. in "class Foo {"). If it indeed is a type
8376 ;; then we should be at the declarator now, so check for a
8377 ;; valid declarator start.
8379 ;; Note: This doesn't cope with the case when a declared
8380 ;; identifier is followed by e.g. '(' in a language where '('
8381 ;; also might be part of a declarator expression. Currently
8382 ;; there's no such language.
8383 (not (or (looking-at c-symbol-start)
8384 (looking-at c-type-decl-prefix-key)))))
8386 ;; In Pike a list of modifiers may be followed by a brace
8387 ;; to make them apply to many identifiers. Note that the
8388 ;; match data will be empty on return in this case.
8389 ((and (c-major-mode-is 'pike-mode)
8391 (goto-char open-brace)
8392 (= (c-backward-token-2) 0))
8393 (looking-at c-specifier-key)
8394 ;; Use this variant to avoid yet another special regexp.
8395 (c-keyword-member (c-keyword-sym (match-string 1))
8397 (setq kwd-start (point))
8403 ;; Back up over any preceding specifiers and their clauses
8404 ;; by going forward from `first-specifier-pos', which is the
8405 ;; earliest possible position where the specifier list can
8408 (goto-char first-specifier-pos)
8410 (while (< (point) kwd-start)
8411 (if (looking-at c-symbol-key)
8412 ;; Accept any plain symbol token on the ground that
8413 ;; it's a specifier masked through a macro (just
8414 ;; like `c-forward-decl-or-cast-1' skip forward over
8417 ;; Could be more restrictive wrt invalid keywords,
8418 ;; but that'd only occur in invalid code so there's
8419 ;; no use spending effort on it.
8420 (let ((end (match-end 0)))
8421 (unless (c-forward-keyword-clause 0)
8423 (c-forward-syntactic-ws)))
8425 ;; Can't parse a declaration preamble and is still
8426 ;; before `kwd-start'. That means `first-specifier-pos'
8427 ;; was in some earlier construct. Search again.
8428 (if (c-syntactic-re-search-forward c-symbol-start
8430 (goto-char (setq first-specifier-pos (match-beginning 0)))
8431 ;; Got no preamble before the block declaration keyword.
8432 (setq first-specifier-pos kwd-start))))
8434 (goto-char first-specifier-pos))
8435 (goto-char kwd-start))
8439 (defun c-search-uplist-for-classkey (paren-state)
8440 ;; Check if the closest containing paren sexp is a declaration
8441 ;; block, returning a 2 element vector in that case. Aref 0
8442 ;; contains the bufpos at boi of the class key line, and aref 1
8443 ;; contains the bufpos of the open brace. This function is an
8444 ;; obsolete wrapper for `c-looking-at-decl-block'.
8446 ;; This function might do hidden buffer changes.
8447 (let ((open-paren-pos (c-most-enclosing-brace paren-state)))
8448 (when open-paren-pos
8450 (goto-char open-paren-pos)
8451 (when (and (eq (char-after) ?{)
8452 (c-looking-at-decl-block
8453 (c-safe-position open-paren-pos paren-state)
8455 (back-to-indentation)
8456 (vector (point) open-paren-pos))))))
8458 (defun c-most-enclosing-decl-block (paren-state)
8459 ;; Return the buffer position of the most enclosing decl-block brace (in the
8460 ;; sense of c-looking-at-decl-block) in the PAREN-STATE structure, or nil if
8462 (let* ((open-brace (c-pull-open-brace paren-state))
8463 (next-open-brace (c-pull-open-brace paren-state)))
8464 (while (and open-brace
8466 (goto-char open-brace)
8467 (not (c-looking-at-decl-block next-open-brace nil))))
8468 (setq open-brace next-open-brace
8469 next-open-brace (c-pull-open-brace paren-state)))
8472 (defun c-cheap-inside-bracelist-p (paren-state)
8473 ;; Return the position of the L-brace if point is inside a brace list
8474 ;; initialization of an array, etc. This is an approximate function,
8475 ;; designed for speed over accuracy. It will not find every bracelist, but
8476 ;; a non-nil result is reliable. We simply search for "= {" (naturally with
8477 ;; syntactic whitespace allowed). PAREN-STATE is the normal thing that it
8478 ;; is everywhere else.
8482 (and (setq b-pos (c-pull-open-brace paren-state))
8483 (progn (goto-char b-pos)
8485 (c-backward-token-2)
8486 (not (looking-at "=")))))
8489 (defun c-backward-over-enum-header ()
8490 ;; We're at a "{". Move back to the enum-like keyword that starts this
8491 ;; declaration and return t, otherwise don't move and return nil.
8492 (let ((here (point))
8493 up-sexp-pos before-identifier)
8496 (eq (c-backward-token-2) 0)
8497 (or (not (looking-at "\\s)"))
8498 (c-go-up-list-backward))
8500 ((and (looking-at c-symbol-key) (c-on-identifier)
8501 (not before-identifier))
8502 (setq before-identifier t))
8503 ((and before-identifier
8504 (or (eq (char-after) ?,)
8505 (looking-at c-postfix-decl-spec-key)))
8506 (setq before-identifier nil)
8508 ((looking-at c-brace-list-key) nil)
8509 ((and c-recognize-<>-arglists
8510 (eq (char-after) ?<)
8511 (looking-at "\\s("))
8514 (or (looking-at c-brace-list-key)
8515 (progn (goto-char here) nil))))
8517 (defun c-inside-bracelist-p (containing-sexp paren-state)
8518 ;; return the buffer position of the beginning of the brace list
8519 ;; statement if we're inside a brace list, otherwise return nil.
8520 ;; CONTAINING-SEXP is the buffer pos of the innermost containing
8521 ;; paren. PAREN-STATE is the remainder of the state of enclosing
8524 ;; N.B.: This algorithm can potentially get confused by cpp macros
8525 ;; placed in inconvenient locations. It's a trade-off we make for
8528 ;; This function might do hidden buffer changes.
8530 ;; This will pick up brace list declarations.
8532 (goto-char containing-sexp)
8533 (c-backward-over-enum-header))
8534 ;; this will pick up array/aggregate init lists, even if they are nested.
8537 ;; Pike can have class definitions anywhere, so we must
8538 ;; check for the class key here.
8539 (and (c-major-mode-is 'pike-mode)
8541 bufpos braceassignp lim next-containing macro-start)
8542 (while (and (not bufpos)
8545 (if (consp (car paren-state))
8546 (setq lim (cdr (car paren-state))
8547 paren-state (cdr paren-state))
8548 (setq lim (car paren-state)))
8550 (setq next-containing (car paren-state)
8551 paren-state (cdr paren-state))))
8552 (goto-char containing-sexp)
8553 (if (c-looking-at-inexpr-block next-containing next-containing)
8554 ;; We're in an in-expression block of some kind. Do not
8555 ;; check nesting. We deliberately set the limit to the
8556 ;; containing sexp, so that c-looking-at-inexpr-block
8557 ;; doesn't check for an identifier before it.
8558 (setq containing-sexp nil)
8559 ;; see if the open brace is preceded by = or [...] in
8560 ;; this statement, but watch out for operator=
8561 (setq braceassignp 'dontknow)
8562 (c-backward-token-2 1 t lim)
8563 ;; Checks to do only on the first sexp before the brace.
8564 (when (and c-opt-inexpr-brace-list-key
8565 (eq (char-after) ?\[))
8566 ;; In Java, an initialization brace list may follow
8567 ;; directly after "new Foo[]", so check for a "new"
8569 (while (eq braceassignp 'dontknow)
8571 (cond ((/= (c-backward-token-2 1 t lim) 0) nil)
8572 ((looking-at c-opt-inexpr-brace-list-key) t)
8573 ((looking-at "\\sw\\|\\s_\\|[.[]")
8574 ;; Carry on looking if this is an
8575 ;; identifier (may contain "." in Java)
8576 ;; or another "[]" sexp.
8579 ;; Checks to do on all sexps before the brace, up to the
8580 ;; beginning of the statement.
8581 (while (eq braceassignp 'dontknow)
8582 (cond ((eq (char-after) ?\;)
8583 (setq braceassignp nil))
8585 (looking-at class-key))
8586 (setq braceassignp nil))
8587 ((eq (char-after) ?=)
8588 ;; We've seen a =, but must check earlier tokens so
8589 ;; that it isn't something that should be ignored.
8590 (setq braceassignp 'maybe)
8591 (while (and (eq braceassignp 'maybe)
8592 (zerop (c-backward-token-2 1 t lim)))
8595 ;; Check for operator =
8596 ((and c-opt-op-identifier-prefix
8597 (looking-at c-opt-op-identifier-prefix))
8599 ;; Check for `<opchar>= in Pike.
8600 ((and (c-major-mode-is 'pike-mode)
8601 (or (eq (char-after) ?`)
8602 ;; Special case for Pikes
8603 ;; `[]=, since '[' is not in
8604 ;; the punctuation class.
8605 (and (eq (char-after) ?\[)
8606 (eq (char-before) ?`))))
8608 ((looking-at "\\s.") 'maybe)
8609 ;; make sure we're not in a C++ template
8610 ;; argument assignment
8612 (c-major-mode-is 'c++-mode)
8614 (let ((here (point))
8616 (skip-chars-backward "^<>")
8618 (and (eq (char-before) ?<)
8619 (not (c-crosses-statement-barrier-p
8621 (not (c-in-literal))
8625 (if (and (eq braceassignp 'dontknow)
8626 (/= (c-backward-token-2 1 t lim) 0))
8627 (setq braceassignp nil)))
8630 ;; We've hit the beginning of the aggregate list.
8631 (c-beginning-of-statement-1
8632 (c-most-enclosing-brace paren-state))
8633 (setq bufpos (point)))
8634 ((eq (char-after) ?\;)
8635 ;; Brace lists can't contain a semicolon, so we're done.
8636 (setq containing-sexp nil))
8637 ((and (setq macro-start (point))
8638 (c-forward-to-cpp-define-body)
8639 (eq (point) containing-sexp))
8640 ;; We've a macro whose expansion starts with the '{'.
8641 ;; Heuristically, if we have a ';' in it we've not got a
8642 ;; brace list, otherwise we have.
8643 (let ((macro-end (progn (c-end-of-macro) (point))))
8644 (goto-char containing-sexp)
8646 (if (and (c-syntactic-re-search-forward "[;,]" macro-end t t)
8647 (eq (char-before) ?\;))
8649 containing-sexp nil)
8650 (setq bufpos macro-start))))
8653 (setq containing-sexp next-containing
8655 next-containing nil)))))
8660 (defun c-looking-at-special-brace-list (&optional lim)
8661 ;; If we're looking at the start of a pike-style list, i.e., `({Â })',
8662 ;; `([Â ])', `(<Â >)', etc., a cons of a cons of its starting and ending
8663 ;; positions and its entry in c-special-brace-lists is returned, nil
8664 ;; otherwise. The ending position is nil if the list is still open.
8665 ;; LIM is the limit for forward search. The point may either be at
8666 ;; the `(' or at the following paren character. Tries to check the
8667 ;; matching closer, but assumes it's correct if no balanced paren is
8668 ;; found (i.e. the case `({ ... } ... )' is detected as _not_ being
8669 ;; a special brace list).
8671 ;; This function might do hidden buffer changes.
8672 (if c-special-brace-lists
8677 (c-forward-syntactic-ws)
8678 (if (eq (char-after) ?\()
8681 (c-forward-syntactic-ws)
8682 (setq inner-beg (point))
8683 (setq type (assq (char-after) c-special-brace-lists)))
8684 (if (setq type (assq (char-after) c-special-brace-lists))
8686 (setq inner-beg (point))
8687 (c-backward-syntactic-ws)
8689 (setq beg (if (eq (char-after) ?\()
8697 (= (char-before) ?\)))
8699 (goto-char inner-beg)
8700 (if (looking-at "\\s(")
8701 ;; Check balancing of the inner paren
8706 ;; If the inner char isn't a paren then
8707 ;; we can't check balancing, so just
8708 ;; check the char before the outer
8712 (c-backward-syntactic-ws)
8713 (= (char-before) (cdr type)))))
8714 (if (or (/= (char-syntax (char-before)) ?\))
8716 (c-forward-syntactic-ws)
8719 (cons (cons beg end) type))
8720 (cons (list beg) type)))))
8723 (defun c-looking-at-bos (&optional lim)
8724 ;; Return non-nil if between two statements or declarations, assuming
8725 ;; point is not inside a literal or comment.
8727 ;; Obsolete - `c-at-statement-start-p' or `c-at-expression-start-p'
8728 ;; are recommended instead.
8730 ;; This function might do hidden buffer changes.
8731 (c-at-statement-start-p))
8732 (make-obsolete 'c-looking-at-bos 'c-at-statement-start-p "22.1")
8734 (defun c-looking-at-inexpr-block (lim containing-sexp &optional check-at-end)
8735 ;; Return non-nil if we're looking at the beginning of a block
8736 ;; inside an expression. The value returned is actually a cons of
8737 ;; either 'inlambda, 'inexpr-statement or 'inexpr-class and the
8738 ;; position of the beginning of the construct.
8740 ;; LIM limits the backward search. CONTAINING-SEXP is the start
8741 ;; position of the closest containing list. If it's nil, the
8742 ;; containing paren isn't used to decide whether we're inside an
8743 ;; expression or not. If both LIM and CONTAINING-SEXP are used, LIM
8744 ;; needs to be farther back.
8746 ;; If CHECK-AT-END is non-nil then extra checks at the end of the
8747 ;; brace block might be done. It should only be used when the
8748 ;; construct can be assumed to be complete, i.e. when the original
8749 ;; starting position was further down than that.
8751 ;; This function might do hidden buffer changes.
8754 (let ((res 'maybe) passed-paren
8755 (closest-lim (or containing-sexp lim (point-min)))
8756 ;; Look at the character after point only as a last resort
8757 ;; when we can't disambiguate.
8758 (block-follows (and (eq (char-after) ?{) (point))))
8760 (while (and (eq res 'maybe)
8761 (progn (c-backward-syntactic-ws)
8762 (> (point) closest-lim))
8764 (progn (backward-char)
8765 (looking-at "[\]\).]\\|\\w\\|\\s_"))
8766 (c-safe (forward-char)
8767 (goto-char (scan-sexps (point) -1))))
8770 (if (looking-at c-keywords-regexp)
8771 (let ((kw-sym (c-keyword-sym (match-string 1))))
8774 (c-keyword-member kw-sym 'c-inexpr-class-kwds))
8775 (and (not (eq passed-paren ?\[))
8776 (or (not (looking-at c-class-key))
8777 ;; If the class definition is at the start of
8778 ;; a statement, we don't consider it an
8779 ;; in-expression class.
8780 (let ((prev (point)))
8782 (= (c-backward-token-2 1 nil closest-lim) 0)
8783 (eq (char-syntax (char-after)) ?w))
8784 (setq prev (point)))
8786 (not (c-at-statement-start-p)))
8787 ;; Also, in Pike we treat it as an
8788 ;; in-expression class if it's used in an
8789 ;; object clone expression.
8792 (c-major-mode-is 'pike-mode)
8793 (progn (goto-char block-follows)
8794 (zerop (c-forward-token-2 1 t)))
8795 (eq (char-after) ?\())))
8796 (cons 'inexpr-class (point))))
8797 ((c-keyword-member kw-sym 'c-inexpr-block-kwds)
8798 (when (not passed-paren)
8799 (cons 'inexpr-statement (point))))
8800 ((c-keyword-member kw-sym 'c-lambda-kwds)
8801 (when (or (not passed-paren)
8802 (eq passed-paren ?\())
8803 (cons 'inlambda (point))))
8804 ((c-keyword-member kw-sym 'c-block-stmt-kwds)
8809 (if (looking-at "\\s(")
8811 (if (and (eq passed-paren ?\[)
8812 (eq (char-after) ?\[))
8813 ;; Accept several square bracket sexps for
8814 ;; Java array initializations.
8816 (setq passed-paren (char-after))
8821 (when (and c-recognize-paren-inexpr-blocks
8824 (eq (char-after containing-sexp) ?\())
8825 (goto-char containing-sexp)
8826 (if (or (save-excursion
8827 (c-backward-syntactic-ws lim)
8828 (and (> (point) (or lim (point-min)))
8830 (and c-special-brace-lists
8831 (c-looking-at-special-brace-list)))
8833 (cons 'inexpr-statement (point))))
8837 (defun c-looking-at-inexpr-block-backward (paren-state)
8838 ;; Returns non-nil if we're looking at the end of an in-expression
8839 ;; block, otherwise the same as `c-looking-at-inexpr-block'.
8840 ;; PAREN-STATE is the paren state relevant at the current position.
8842 ;; This function might do hidden buffer changes.
8844 ;; We currently only recognize a block.
8845 (let ((here (point))
8846 (elem (car-safe paren-state))
8848 (when (and (consp elem)
8849 (progn (goto-char (cdr elem))
8850 (c-forward-syntactic-ws here)
8852 (goto-char (car elem))
8853 (if (setq paren-state (cdr paren-state))
8854 (setq containing-sexp (car-safe paren-state)))
8855 (c-looking-at-inexpr-block (c-safe-position containing-sexp
8857 containing-sexp)))))
8859 (defun c-at-macro-vsemi-p (&optional pos)
8860 ;; Is there a "virtual semicolon" at POS or point?
8861 ;; (See cc-defs.el for full details of "virtual semicolons".)
8863 ;; This is true when point is at the last non syntactic WS position on the
8864 ;; line, there is a macro call last on the line, and this particular macro's
8865 ;; name is defined by the regexp `c-vs-macro-regexp' as not needing a
8874 c-macro-with-semi-re
8875 (eq (skip-chars-backward " \t") 0)
8877 ;; Check we've got nothing after this except comments and empty lines
8878 ;; joined by escaped EOLs.
8879 (skip-chars-forward " \t") ; always returns non-nil.
8881 (while ; go over 1 block comment per iteration.
8883 (looking-at "\\(\\\\[\n\r][ \t]*\\)*")
8884 (goto-char (match-end 0))
8886 ((looking-at c-block-comment-start-regexp)
8887 (and (forward-comment 1)
8888 (skip-chars-forward " \t"))) ; always returns non-nil
8889 ((looking-at c-line-comment-start-regexp)
8896 (progn (c-backward-syntactic-ws)
8899 ;; Check for one of the listed macros being before point.
8900 (or (not (eq (char-before) ?\)))
8901 (when (c-go-list-backward)
8902 (c-backward-syntactic-ws)
8904 (c-simple-skip-symbol-backward)
8905 (looking-at c-macro-with-semi-re)
8907 (not (c-in-literal)))))) ; The most expensive check last.
8909 (defun c-macro-vsemi-status-unknown-p () t) ; See cc-defs.el.
8912 ;; `c-guess-basic-syntax' and the functions that precedes it below
8913 ;; implements the main decision tree for determining the syntactic
8914 ;; analysis of the current line of code.
8916 ;; Dynamically bound to t when `c-guess-basic-syntax' is called during
8917 ;; auto newline analysis.
8918 (defvar c-auto-newline-analysis nil)
8920 (defun c-brace-anchor-point (bracepos)
8921 ;; BRACEPOS is the position of a brace in a construct like "namespace
8922 ;; Bar {". Return the anchor point in this construct; this is the
8923 ;; earliest symbol on the brace's line which isn't earlier than
8926 ;; Currently (2007-08-17), "like namespace" means "matches
8927 ;; c-other-block-decl-kwds". It doesn't work with "class" or "struct"
8928 ;; or anything like that.
8930 (let ((boi (c-point 'boi bracepos)))
8931 (goto-char bracepos)
8932 (while (and (> (point) boi)
8933 (not (looking-at c-other-decl-block-key)))
8934 (c-backward-token-2))
8935 (if (> (point) boi) (point) boi))))
8937 (defsubst c-add-syntax (symbol &rest args)
8938 ;; A simple function to prepend a new syntax element to
8939 ;; `c-syntactic-context'. Using `setq' on it is unsafe since it
8940 ;; should always be dynamically bound but since we read it first
8941 ;; we'll fail properly anyway if this function is misused.
8942 (setq c-syntactic-context (cons (cons symbol args)
8943 c-syntactic-context)))
8945 (defsubst c-append-syntax (symbol &rest args)
8946 ;; Like `c-add-syntax' but appends to the end of the syntax list.
8947 ;; (Normally not necessary.)
8948 (setq c-syntactic-context (nconc c-syntactic-context
8949 (list (cons symbol args)))))
8951 (defun c-add-stmt-syntax (syntax-symbol
8956 ;; Add the indicated SYNTAX-SYMBOL to `c-syntactic-context', extending it as
8957 ;; needed with further syntax elements of the types `substatement',
8958 ;; `inexpr-statement', `arglist-cont-nonempty', `statement-block-intro', and
8959 ;; `defun-block-intro'.
8961 ;; Do the generic processing to anchor the given syntax symbol on
8962 ;; the preceding statement: Skip over any labels and containing
8963 ;; statements on the same line, and then search backward until we
8964 ;; find a statement or block start that begins at boi without a
8965 ;; label or comment.
8967 ;; Point is assumed to be at the prospective anchor point for the
8968 ;; given SYNTAX-SYMBOL. More syntax entries are added if we need to
8969 ;; skip past open parens and containing statements. Most of the added
8970 ;; syntax elements will get the same anchor point - the exception is
8971 ;; for an anchor in a construct like "namespace"[*] - this is as early
8972 ;; as possible in the construct but on the same line as the {.
8974 ;; [*] i.e. with a keyword matching c-other-block-decl-kwds.
8976 ;; SYNTAX-EXTRA-ARGS are a list of the extra arguments for the
8977 ;; syntax symbol. They are appended after the anchor point.
8979 ;; If STOP-AT-BOI-ONLY is nil, we can stop in the middle of the line
8980 ;; if the current statement starts there.
8982 ;; Note: It's not a problem if PAREN-STATE "overshoots"
8983 ;; CONTAINING-SEXP, i.e. contains info about parens further down.
8985 ;; This function might do hidden buffer changes.
8987 (if (= (point) (c-point 'boi))
8988 ;; This is by far the most common case, so let's give it special
8990 (apply 'c-add-syntax syntax-symbol (point) syntax-extra-args)
8992 (let ((syntax-last c-syntactic-context)
8993 (boi (c-point 'boi))
8994 ;; Set when we're on a label, so that we don't stop there.
8995 ;; FIXME: To be complete we should check if we're on a label
8996 ;; now at the start.
8999 ;; Use point as the anchor point for "namespace", "extern", etc.
9000 (apply 'c-add-syntax syntax-symbol
9001 (if (rassq syntax-symbol c-other-decl-block-key-in-symbols-alist)
9005 ;; Loop while we have to back out of containing blocks.
9008 (catch 'back-up-block
9010 ;; Loop while we have to back up statements.
9011 (while (or (/= (point) boi)
9013 (looking-at c-comment-start-regexp))
9015 ;; Skip past any comments that stands between the
9016 ;; statement start and boi.
9017 (let ((savepos (point)))
9018 (while (and (/= savepos boi)
9019 (c-backward-single-comment))
9020 (setq savepos (point)
9021 boi (c-point 'boi)))
9022 (goto-char savepos))
9024 ;; Skip to the beginning of this statement or backward
9026 (let ((old-pos (point))
9028 (step-type (c-beginning-of-statement-1 containing-sexp)))
9029 (setq boi (c-point 'boi)
9030 on-label (eq step-type 'label))
9032 (cond ((= (point) old-pos)
9033 ;; If we didn't move we're at the start of a block and
9034 ;; have to continue outside it.
9035 (throw 'back-up-block t))
9037 ((and (eq step-type 'up)
9038 (>= (point) old-boi)
9039 (looking-at "else\\>[^_]")
9042 (looking-at "if\\>[^_]")))
9043 ;; Special case to avoid deeper and deeper indentation
9044 ;; of "else if" clauses.
9047 ((and (not stop-at-boi-only)
9048 (/= old-pos old-boi)
9049 (memq step-type '(up previous)))
9050 ;; If stop-at-boi-only is nil, we shouldn't back up
9051 ;; over previous or containing statements to try to
9052 ;; reach boi, so go back to the last position and
9055 (throw 'back-up-block nil))
9058 (if (and (not stop-at-boi-only)
9059 (memq step-type '(up previous beginning)))
9060 ;; If we've moved into another statement then we
9061 ;; should no longer try to stop in the middle of a
9063 (setq stop-at-boi-only t))
9065 ;; Record this as a substatement if we skipped up one
9067 (when (eq step-type 'up)
9068 (c-add-syntax 'substatement nil))))
9073 ;; Now we have to go out of this block.
9074 (goto-char containing-sexp)
9076 ;; Don't stop in the middle of a special brace list opener
9078 (when c-special-brace-lists
9079 (let ((special-list (c-looking-at-special-brace-list)))
9080 (when (and special-list
9081 (< (car (car special-list)) (point)))
9082 (setq containing-sexp (car (car special-list)))
9083 (goto-char containing-sexp))))
9085 (setq paren-state (c-whack-state-after containing-sexp paren-state)
9086 containing-sexp (c-most-enclosing-brace paren-state)
9089 ;; Analyze the construct in front of the block we've stepped out
9090 ;; from and add the right syntactic element for it.
9091 (let ((paren-pos (point))
9092 (paren-char (char-after))
9095 (if (eq paren-char ?\()
9096 ;; Stepped out of a parenthesis block, so we're in an
9099 (when (/= paren-pos boi)
9100 (if (and c-recognize-paren-inexpr-blocks
9102 (c-backward-syntactic-ws containing-sexp)
9103 (or (not (looking-at "\\>"))
9104 (not (c-on-identifier))))
9106 (goto-char (1+ paren-pos))
9107 (c-forward-syntactic-ws)
9108 (eq (char-after) ?{)))
9109 ;; Stepped out of an in-expression statement. This
9110 ;; syntactic element won't get an anchor pos.
9111 (c-add-syntax 'inexpr-statement)
9113 ;; A parenthesis normally belongs to an arglist.
9114 (c-add-syntax 'arglist-cont-nonempty nil paren-pos)))
9118 (1+ containing-sexp)
9120 (setq step-type 'same
9123 ;; Stepped out of a brace block.
9124 (setq step-type (c-beginning-of-statement-1 containing-sexp)
9125 on-label (eq step-type 'label))
9127 (if (and (eq step-type 'same)
9128 (/= paren-pos (point)))
9132 (goto-char paren-pos)
9133 (setq inexpr (c-looking-at-inexpr-block
9134 (c-safe-position containing-sexp paren-state)
9136 (c-add-syntax (if (eq (car inexpr) 'inlambda)
9138 'statement-block-intro)
9140 ((looking-at c-other-decl-block-key)
9142 (cdr (assoc (match-string 1)
9143 c-other-decl-block-key-in-symbols-alist))
9144 (max (c-point 'boi paren-pos) (point))))
9145 (t (c-add-syntax 'defun-block-intro nil))))
9147 (c-add-syntax 'statement-block-intro nil)))
9149 (if (= paren-pos boi)
9150 ;; Always done if the open brace was at boi. The
9151 ;; c-beginning-of-statement-1 call above is necessary
9152 ;; anyway, to decide the type of block-intro to add.
9153 (goto-char paren-pos)
9154 (setq boi (c-point 'boi)))
9157 ;; Fill in the current point as the anchor for all the symbols
9159 (let ((p c-syntactic-context) q)
9160 (while (not (eq p syntax-last))
9161 (setq q (cdr (car p))) ; e.g. (nil 28) [from (arglist-cont-nonempty nil 28)]
9169 (defun c-add-class-syntax (symbol
9170 containing-decl-open
9171 containing-decl-start
9174 ;; The inclass and class-close syntactic symbols are added in
9175 ;; several places and some work is needed to fix everything.
9176 ;; Therefore it's collected here.
9178 ;; This function might do hidden buffer changes.
9179 (goto-char containing-decl-open)
9180 (if (and (eq symbol 'inclass) (= (point) (c-point 'boi)))
9182 (c-add-syntax symbol containing-decl-open)
9183 containing-decl-open)
9184 (goto-char containing-decl-start)
9185 ;; Ought to use `c-add-stmt-syntax' instead of backing up to boi
9186 ;; here, but we have to do like this for compatibility.
9187 (back-to-indentation)
9188 (c-add-syntax symbol (point))
9189 (if (and (c-keyword-member containing-decl-kwd
9190 'c-inexpr-class-kwds)
9191 (/= containing-decl-start (c-point 'boi containing-decl-start)))
9192 (c-add-syntax 'inexpr-class))
9195 (defun c-guess-continued-construct (indent-point
9197 beg-of-same-or-containing-stmt
9200 ;; This function contains the decision tree reached through both
9201 ;; cases 18 and 10. It's a continued statement or top level
9202 ;; construct of some kind.
9204 ;; This function might do hidden buffer changes.
9206 (let (special-brace-list placeholder)
9207 (goto-char indent-point)
9208 (skip-chars-forward " \t")
9211 ;; (CASE A removed.)
9212 ;; CASE B: open braces for class or brace-lists
9213 ((setq special-brace-list
9214 (or (and c-special-brace-lists
9215 (c-looking-at-special-brace-list))
9216 (eq char-after-ip ?{)))
9219 ;; CASE B.1: class-open
9221 (and (eq (char-after) ?{)
9222 (c-looking-at-decl-block containing-sexp t)
9223 (setq beg-of-same-or-containing-stmt (point))))
9224 (c-add-syntax 'class-open beg-of-same-or-containing-stmt))
9226 ;; CASE B.2: brace-list-open
9227 ((or (consp special-brace-list)
9229 (goto-char beg-of-same-or-containing-stmt)
9230 (c-syntactic-re-search-forward "=\\([^=]\\|$\\)"
9231 indent-point t t t)))
9232 ;; The most semantically accurate symbol here is
9233 ;; brace-list-open, but we normally report it simply as a
9234 ;; statement-cont. The reason is that one normally adjusts
9235 ;; brace-list-open for brace lists as top-level constructs,
9236 ;; and brace lists inside statements is a completely different
9237 ;; context. C.f. case 5A.3.
9238 (c-beginning-of-statement-1 containing-sexp)
9239 (c-add-stmt-syntax (if c-auto-newline-analysis
9240 ;; Turn off the dwim above when we're
9241 ;; analyzing the nature of the brace
9242 ;; for the auto newline feature.
9246 containing-sexp paren-state))
9248 ;; CASE B.3: The body of a function declared inside a normal
9249 ;; block. Can occur e.g. in Pike and when using gcc
9250 ;; extensions, but watch out for macros followed by blocks.
9251 ;; C.f. cases E, 16F and 17G.
9252 ((and (not (c-at-statement-start-p))
9253 (eq (c-beginning-of-statement-1 containing-sexp nil nil t)
9256 (let ((c-recognize-typeless-decls nil))
9257 ;; Turn off recognition of constructs that lacks a
9258 ;; type in this case, since that's more likely to be
9259 ;; a macro followed by a block.
9260 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
9261 (c-add-stmt-syntax 'defun-open nil t
9262 containing-sexp paren-state))
9264 ;; CASE B.4: Continued statement with block open. The most
9265 ;; accurate analysis is perhaps `statement-cont' together with
9266 ;; `block-open' but we play DWIM and use `substatement-open'
9267 ;; instead. The rationale is that this typically is a macro
9268 ;; followed by a block which makes it very similar to a
9269 ;; statement with a substatement block.
9271 (c-add-stmt-syntax 'substatement-open nil nil
9272 containing-sexp paren-state))
9275 ;; CASE C: iostream insertion or extraction operator
9276 ((and (looking-at "\\(<<\\|>>\\)\\([^=]\\|$\\)")
9278 (goto-char beg-of-same-or-containing-stmt)
9279 ;; If there is no preceding streamop in the statement
9280 ;; then indent this line as a normal statement-cont.
9281 (when (c-syntactic-re-search-forward
9282 "\\(<<\\|>>\\)\\([^=]\\|$\\)" indent-point 'move t t)
9283 (c-add-syntax 'stream-op (c-point 'boi))
9286 ;; CASE E: In the "K&R region" of a function declared inside a
9287 ;; normal block. C.f. case B.3.
9288 ((and (save-excursion
9289 ;; Check that the next token is a '{'. This works as
9290 ;; long as no language that allows nested function
9291 ;; definitions allows stuff like member init lists, K&R
9292 ;; declarations or throws clauses there.
9294 ;; Note that we do a forward search for something ahead
9295 ;; of the indentation line here. That's not good since
9296 ;; the user might not have typed it yet. Unfortunately
9297 ;; it's exceedingly tricky to recognize a function
9298 ;; prototype in a code block without resorting to this.
9299 (c-forward-syntactic-ws)
9300 (eq (char-after) ?{))
9301 (not (c-at-statement-start-p))
9302 (eq (c-beginning-of-statement-1 containing-sexp nil nil t)
9305 (let ((c-recognize-typeless-decls nil))
9306 ;; Turn off recognition of constructs that lacks a
9307 ;; type in this case, since that's more likely to be
9308 ;; a macro followed by a block.
9309 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
9310 (c-add-stmt-syntax 'func-decl-cont nil t
9311 containing-sexp paren-state))
9313 ;;CASE F: continued statement and the only preceding items are
9315 ((and (c-major-mode-is 'java-mode)
9316 (setq placeholder (point))
9317 (c-beginning-of-statement-1)
9319 (while (and (c-forward-annotation)
9320 (< (point) placeholder))
9321 (c-forward-syntactic-ws))
9324 (>= (point) placeholder)
9325 (goto-char placeholder)))
9326 (c-beginning-of-statement-1 containing-sexp)
9327 (c-add-syntax 'annotation-var-cont (point)))
9329 ;; CASE G: a template list continuation?
9330 ;; Mostly a duplication of case 5D.3 to fix templates-19:
9331 ((and (c-major-mode-is 'c++-mode)
9333 (goto-char indent-point)
9334 (c-with-syntax-table c++-template-syntax-table
9335 (setq placeholder (c-up-list-backward)))
9337 (eq (char-after placeholder) ?<)
9338 (/= (char-before placeholder) ?<)
9340 (goto-char (1+ placeholder))
9341 (not (looking-at c-<-op-cont-regexp))))))
9342 (c-with-syntax-table c++-template-syntax-table
9343 (goto-char placeholder)
9344 (c-beginning-of-statement-1 containing-sexp t)
9346 (c-backward-syntactic-ws containing-sexp)
9347 (eq (char-before) ?<))
9348 ;; In a nested template arglist.
9350 (goto-char placeholder)
9351 (c-syntactic-skip-backward "^,;" containing-sexp t)
9352 (c-forward-syntactic-ws))
9353 (back-to-indentation)))
9354 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
9356 (c-add-syntax 'template-args-cont (point) placeholder))
9358 ;; CASE D: continued statement.
9360 (c-beginning-of-statement-1 containing-sexp)
9361 (c-add-stmt-syntax 'statement-cont nil nil
9362 containing-sexp paren-state))
9365 ;; The next autoload was added by RMS on 2005/8/9 - don't know why (ACM,
9368 (defun c-guess-basic-syntax ()
9369 "Return the syntactic context of the current line."
9372 (c-save-buffer-state
9373 ((indent-point (point))
9374 (case-fold-search nil)
9375 open-paren-in-column-0-is-defun-start
9376 ;; A whole ugly bunch of various temporary variables. Have
9377 ;; to declare them here since it's not possible to declare
9378 ;; a variable with only the scope of a cond test and the
9379 ;; following result clauses, and most of this function is a
9380 ;; single gigantic cond. :P
9381 literal char-before-ip before-ws-ip char-after-ip macro-start
9382 in-macro-expr c-syntactic-context placeholder c-in-literal-cache
9383 step-type tmpsymbol keyword injava-inher special-brace-list tmp-pos
9385 ;; The following record some positions for the containing
9386 ;; declaration block if we're directly within one:
9387 ;; `containing-decl-open' is the position of the open
9388 ;; brace. `containing-decl-start' is the start of the
9389 ;; declaration. `containing-decl-kwd' is the keyword
9390 ;; symbol of the keyword that tells what kind of block it
9392 containing-decl-open
9393 containing-decl-start
9395 ;; The open paren of the closest surrounding sexp or nil if
9398 ;; The position after the closest preceding brace sexp
9399 ;; (nested sexps are ignored), or the position after
9400 ;; `containing-sexp' if there is none, or (point-min) if
9401 ;; `containing-sexp' is nil.
9403 ;; The paren state outside `containing-sexp', or at
9404 ;; `indent-point' if `containing-sexp' is nil.
9405 (paren-state (c-parse-state))
9406 ;; There's always at most one syntactic element which got
9407 ;; an anchor pos. It's stored in syntactic-relpos.
9409 (c-stmt-delim-chars c-stmt-delim-chars))
9411 ;; Check if we're directly inside an enclosing declaration
9413 (when (and (setq containing-sexp
9414 (c-most-enclosing-brace paren-state))
9416 (goto-char containing-sexp)
9417 (eq (char-after) ?{))
9419 (c-looking-at-decl-block
9420 (c-most-enclosing-brace paren-state
9423 (setq containing-decl-open containing-sexp
9424 containing-decl-start (point)
9425 containing-sexp nil)
9426 (goto-char placeholder)
9427 (setq containing-decl-kwd (and (looking-at c-keywords-regexp)
9428 (c-keyword-sym (match-string 1)))))
9430 ;; Init some position variables.
9433 (setq containing-sexp (car paren-state)
9434 paren-state (cdr paren-state))
9435 (if (consp containing-sexp)
9437 (setq lim (cdr containing-sexp))
9438 (if (cdr c-state-cache)
9439 ;; Ignore balanced paren. The next entry
9440 ;; can't be another one.
9441 (setq containing-sexp (car (cdr c-state-cache))
9442 paren-state (cdr paren-state))
9443 ;; If there is no surrounding open paren then
9444 ;; put the last balanced pair back on paren-state.
9445 (setq paren-state (cons containing-sexp paren-state)
9446 containing-sexp nil)))
9447 (setq lim (1+ containing-sexp))))
9448 (setq lim (point-min)))
9450 ;; If we're in a parenthesis list then ',' delimits the
9451 ;; "statements" rather than being an operator (with the
9452 ;; exception of the "for" clause). This difference is
9453 ;; typically only noticeable when statements are used in macro
9455 (when (and containing-sexp
9456 (eq (char-after containing-sexp) ?\())
9457 (setq c-stmt-delim-chars c-stmt-delim-chars-with-comma))
9458 ;; cache char before and after indent point, and move point to
9459 ;; the most likely position to perform the majority of tests
9460 (goto-char indent-point)
9461 (c-backward-syntactic-ws lim)
9462 (setq before-ws-ip (point)
9463 char-before-ip (char-before))
9464 (goto-char indent-point)
9465 (skip-chars-forward " \t")
9466 (setq char-after-ip (char-after))
9468 ;; are we in a literal?
9469 (setq literal (c-in-literal lim))
9471 ;; now figure out syntactic qualities of the current line
9474 ;; CASE 1: in a string.
9475 ((eq literal 'string)
9476 (c-add-syntax 'string (c-point 'bopl)))
9478 ;; CASE 2: in a C or C++ style comment.
9479 ((and (memq literal '(c c++))
9480 ;; This is a kludge for XEmacs where we use
9481 ;; `buffer-syntactic-context', which doesn't correctly
9482 ;; recognize "\*/" to end a block comment.
9483 ;; `parse-partial-sexp' which is used by
9484 ;; `c-literal-limits' will however do that in most
9485 ;; versions, which results in that we get nil from
9486 ;; `c-literal-limits' even when `c-in-literal' claims
9487 ;; we're inside a comment.
9488 (setq placeholder (c-literal-limits lim)))
9489 (c-add-syntax literal (car placeholder)))
9491 ;; CASE 3: in a cpp preprocessor macro continuation.
9492 ((and (save-excursion
9493 (when (c-beginning-of-macro)
9494 (setq macro-start (point))))
9495 (/= macro-start (c-point 'boi))
9497 (setq tmpsymbol 'cpp-macro-cont)
9498 (or (not c-syntactic-indentation-in-macros)
9500 (goto-char macro-start)
9501 ;; If at the beginning of the body of a #define
9502 ;; directive then analyze as cpp-define-intro
9503 ;; only. Go on with the syntactic analysis
9504 ;; otherwise. in-macro-expr is set if we're in a
9505 ;; cpp expression, i.e. before the #define body
9506 ;; or anywhere in a non-#define directive.
9507 (if (c-forward-to-cpp-define-body)
9508 (let ((indent-boi (c-point 'boi indent-point)))
9509 (setq in-macro-expr (> (point) indent-boi)
9510 tmpsymbol 'cpp-define-intro)
9511 (= (point) indent-boi))
9512 (setq in-macro-expr t)
9514 (c-add-syntax tmpsymbol macro-start)
9515 (setq macro-start nil))
9517 ;; CASE 11: an else clause?
9518 ((looking-at "else\\>[^_]")
9519 (c-beginning-of-statement-1 containing-sexp)
9520 (c-add-stmt-syntax 'else-clause nil t
9521 containing-sexp paren-state))
9523 ;; CASE 12: while closure of a do/while construct?
9524 ((and (looking-at "while\\>[^_]")
9526 (prog1 (eq (c-beginning-of-statement-1 containing-sexp)
9528 (setq placeholder (point)))))
9529 (goto-char placeholder)
9530 (c-add-stmt-syntax 'do-while-closure nil t
9531 containing-sexp paren-state))
9533 ;; CASE 13: A catch or finally clause? This case is simpler
9534 ;; than if-else and do-while, because a block is required
9535 ;; after every try, catch and finally.
9537 (and (cond ((c-major-mode-is 'c++-mode)
9538 (looking-at "catch\\>[^_]"))
9539 ((c-major-mode-is 'java-mode)
9540 (looking-at "\\(catch\\|finally\\)\\>[^_]")))
9541 (and (c-safe (c-backward-syntactic-ws)
9544 (eq (char-after) ?{)
9545 (c-safe (c-backward-syntactic-ws)
9548 (if (eq (char-after) ?\()
9549 (c-safe (c-backward-sexp) t)
9551 (looking-at "\\(try\\|catch\\)\\>[^_]")
9552 (setq placeholder (point))))
9553 (goto-char placeholder)
9554 (c-add-stmt-syntax 'catch-clause nil t
9555 containing-sexp paren-state))
9557 ;; CASE 18: A substatement we can recognize by keyword.
9559 (and c-opt-block-stmt-key
9560 (not (eq char-before-ip ?\;))
9561 (not (c-at-vsemi-p before-ws-ip))
9562 (not (memq char-after-ip '(?\) ?\] ?,)))
9563 (or (not (eq char-before-ip ?}))
9564 (c-looking-at-inexpr-block-backward c-state-cache))
9567 ;; Ought to cache the result from the
9568 ;; c-beginning-of-statement-1 calls here.
9569 (setq placeholder (point))
9570 (while (eq (setq step-type
9571 (c-beginning-of-statement-1 lim))
9573 (if (eq step-type 'previous)
9574 (goto-char placeholder)
9575 (setq placeholder (point))
9576 (if (and (eq step-type 'same)
9577 (not (looking-at c-opt-block-stmt-key)))
9578 ;; Step up to the containing statement if we
9579 ;; stayed in the same one.
9583 (c-beginning-of-statement-1 lim))
9586 (setq placeholder (point))
9587 ;; There was no containing statement after all.
9588 (goto-char placeholder)))))
9590 (if (looking-at c-block-stmt-2-key)
9591 ;; Require a parenthesis after these keywords.
9592 ;; Necessary to catch e.g. synchronized in Java,
9593 ;; which can be used both as statement and
9595 (and (zerop (c-forward-token-2 1 nil))
9596 (eq (char-after) ?\())
9597 (looking-at c-opt-block-stmt-key))))
9599 (if (eq step-type 'up)
9600 ;; CASE 18A: Simple substatement.
9602 (goto-char placeholder)
9604 ((eq char-after-ip ?{)
9605 (c-add-stmt-syntax 'substatement-open nil nil
9606 containing-sexp paren-state))
9608 (goto-char indent-point)
9609 (back-to-indentation)
9611 (c-add-stmt-syntax 'substatement-label nil nil
9612 containing-sexp paren-state))
9614 (c-add-stmt-syntax 'substatement nil nil
9615 containing-sexp paren-state))))
9617 ;; CASE 18B: Some other substatement. This is shared
9619 (c-guess-continued-construct indent-point
9625 ;; CASE 14: A case or default label
9626 ((looking-at c-label-kwds-regexp)
9629 (goto-char containing-sexp)
9630 (setq lim (c-most-enclosing-brace c-state-cache
9632 (c-backward-to-block-anchor lim)
9633 (c-add-stmt-syntax 'case-label nil t lim paren-state))
9634 ;; Got a bogus label at the top level. In lack of better
9635 ;; alternatives, anchor it on (point-min).
9636 (c-add-syntax 'case-label (point-min))))
9638 ;; CASE 15: any other label
9640 (back-to-indentation)
9641 (and (not (looking-at c-syntactic-ws-start))
9643 (cond (containing-decl-open
9644 (setq placeholder (c-add-class-syntax 'inclass
9645 containing-decl-open
9646 containing-decl-start
9649 ;; Append access-label with the same anchor point as
9651 (c-append-syntax 'access-label placeholder))
9654 (goto-char containing-sexp)
9655 (setq lim (c-most-enclosing-brace c-state-cache
9659 (if (and (eq (c-beginning-of-statement-1 lim) 'up)
9660 (looking-at "switch\\>[^_]"))
9661 ;; If the surrounding statement is a switch then
9662 ;; let's analyze all labels as switch labels, so
9663 ;; that they get lined up consistently.
9666 (c-backward-to-block-anchor lim)
9667 (c-add-stmt-syntax tmpsymbol nil t lim paren-state))
9670 ;; A label on the top level. Treat it as a class
9671 ;; context. (point-min) is the closest we get to the
9672 ;; class open brace.
9673 (c-add-syntax 'access-label (point-min)))))
9675 ;; CASE 4: In-expression statement. C.f. cases 7B, 16A and
9677 ((setq placeholder (c-looking-at-inexpr-block
9678 (c-safe-position containing-sexp paren-state)
9680 ;; Have to turn on the heuristics after
9681 ;; the point even though it doesn't work
9682 ;; very well. C.f. test case class-16.pike.
9684 (setq tmpsymbol (assq (car placeholder)
9685 '((inexpr-class . class-open)
9686 (inexpr-statement . block-open))))
9688 ;; It's a statement block or an anonymous class.
9689 (setq tmpsymbol (cdr tmpsymbol))
9690 ;; It's a Pike lambda. Check whether we are between the
9691 ;; lambda keyword and the argument list or at the defun
9693 (setq tmpsymbol (if (eq char-after-ip ?{)
9695 'lambda-intro-cont)))
9696 (goto-char (cdr placeholder))
9697 (back-to-indentation)
9698 (c-add-stmt-syntax tmpsymbol nil t
9699 (c-most-enclosing-brace c-state-cache (point))
9701 (unless (eq (point) (cdr placeholder))
9702 (c-add-syntax (car placeholder))))
9704 ;; CASE 5: Line is inside a declaration level block or at top level.
9705 ((or containing-decl-open (null containing-sexp))
9708 ;; CASE 5A: we are looking at a defun, brace list, class,
9709 ;; or inline-inclass method opening brace
9710 ((setq special-brace-list
9711 (or (and c-special-brace-lists
9712 (c-looking-at-special-brace-list))
9713 (eq char-after-ip ?{)))
9716 ;; CASE 5A.1: Non-class declaration block open.
9719 (and (eq char-after-ip ?{)
9720 (setq tmp (c-looking-at-decl-block containing-sexp t))
9722 (setq placeholder (point))
9724 (looking-at c-symbol-key))
9726 (c-keyword-sym (setq keyword (match-string 0)))
9727 'c-other-block-decl-kwds))))
9728 (goto-char placeholder)
9730 (if (string-equal keyword "extern")
9731 ;; Special case for extern-lang-open.
9733 (intern (concat keyword "-open")))
9734 nil t containing-sexp paren-state))
9736 ;; CASE 5A.2: we are looking at a class opening brace
9738 (goto-char indent-point)
9739 (skip-chars-forward " \t")
9740 (and (eq (char-after) ?{)
9741 (c-looking-at-decl-block containing-sexp t)
9742 (setq placeholder (point))))
9743 (c-add-syntax 'class-open placeholder))
9745 ;; CASE 5A.3: brace list open
9747 (c-beginning-of-decl-1 lim)
9748 (while (looking-at c-specifier-key)
9749 (goto-char (match-end 1))
9750 (c-forward-syntactic-ws indent-point))
9751 (setq placeholder (c-point 'boi))
9752 (or (consp special-brace-list)
9753 (and (or (save-excursion
9754 (goto-char indent-point)
9755 (setq tmpsymbol nil)
9756 (while (and (> (point) placeholder)
9757 (zerop (c-backward-token-2 1 t))
9758 (not (looking-at "=\\([^=]\\|$\\)")))
9759 (and c-opt-inexpr-brace-list-key
9761 (looking-at c-opt-inexpr-brace-list-key)
9762 (setq tmpsymbol 'topmost-intro-cont)))
9763 (looking-at "=\\([^=]\\|$\\)"))
9764 (looking-at c-brace-list-key))
9766 (while (and (< (point) indent-point)
9767 (zerop (c-forward-token-2 1 t))
9768 (not (memq (char-after) '(?\; ?\()))))
9769 (not (memq (char-after) '(?\; ?\()))
9771 (if (and (not c-auto-newline-analysis)
9772 (c-major-mode-is 'java-mode)
9773 (eq tmpsymbol 'topmost-intro-cont))
9774 ;; We're in Java and have found that the open brace
9775 ;; belongs to a "new Foo[]" initialization list,
9776 ;; which means the brace list is part of an
9777 ;; expression and not a top level definition. We
9778 ;; therefore treat it as any topmost continuation
9779 ;; even though the semantically correct symbol still
9780 ;; is brace-list-open, on the same grounds as in
9783 (c-beginning-of-statement-1 lim)
9784 (c-add-syntax 'topmost-intro-cont (c-point 'boi)))
9785 (c-add-syntax 'brace-list-open placeholder)))
9787 ;; CASE 5A.4: inline defun open
9788 ((and containing-decl-open
9789 (not (c-keyword-member containing-decl-kwd
9790 'c-other-block-decl-kwds)))
9791 (c-add-syntax 'inline-open)
9792 (c-add-class-syntax 'inclass
9793 containing-decl-open
9794 containing-decl-start
9798 ;; CASE 5A.5: ordinary defun open
9801 (c-beginning-of-decl-1 lim)
9802 (while (looking-at c-specifier-key)
9803 (goto-char (match-end 1))
9804 (c-forward-syntactic-ws indent-point))
9805 (c-add-syntax 'defun-open (c-point 'boi))
9806 ;; Bogus to use bol here, but it's the legacy. (Resolved,
9810 ;; CASE 5R: Member init list. (Used to be part of CASE 5B.1)
9811 ;; Note there is no limit on the backward search here, since member
9812 ;; init lists can, in practice, be very large.
9814 (when (setq placeholder (c-back-over-member-initializers))
9815 (setq tmp-pos (point))))
9816 (if (= (c-point 'bosws) (1+ tmp-pos))
9818 ;; There is no preceding member init clause.
9819 ;; Indent relative to the beginning of indentation
9820 ;; for the topmost-intro line that contains the
9821 ;; prototype's open paren.
9822 (goto-char placeholder)
9823 (c-add-syntax 'member-init-intro (c-point 'boi)))
9824 ;; Indent relative to the first member init clause.
9825 (goto-char (1+ tmp-pos))
9826 (c-forward-syntactic-ws)
9827 (c-add-syntax 'member-init-cont (point))))
9829 ;; CASE 5B: After a function header but before the body (or
9830 ;; the ending semicolon if there's no body).
9832 (when (setq placeholder (c-just-after-func-arglist-p
9833 (max lim (c-determine-limit 500))))
9834 (setq tmp-pos (point))))
9837 ;; CASE 5B.1: Member init list.
9838 ((eq (char-after tmp-pos) ?:)
9839 ;; There is no preceding member init clause.
9840 ;; Indent relative to the beginning of indentation
9841 ;; for the topmost-intro line that contains the
9842 ;; prototype's open paren.
9843 (goto-char placeholder)
9844 (c-add-syntax 'member-init-intro (c-point 'boi)))
9846 ;; CASE 5B.2: K&R arg decl intro
9847 ((and c-recognize-knr-p
9848 (c-in-knr-argdecl lim))
9849 (c-beginning-of-statement-1 lim)
9850 (c-add-syntax 'knr-argdecl-intro (c-point 'boi))
9851 (if containing-decl-open
9852 (c-add-class-syntax 'inclass
9853 containing-decl-open
9854 containing-decl-start
9858 ;; CASE 5B.4: Nether region after a C++ or Java func
9859 ;; decl, which could include a `throws' declaration.
9861 (c-beginning-of-statement-1 lim)
9862 (c-add-syntax 'func-decl-cont (c-point 'boi))
9865 ;; CASE 5C: inheritance line. could be first inheritance
9866 ;; line, or continuation of a multiple inheritance
9867 ((or (and (c-major-mode-is 'c++-mode)
9869 (when (eq char-after-ip ?,)
9870 (skip-chars-forward " \t")
9872 (looking-at c-opt-postfix-decl-spec-key)))
9873 (and (or (eq char-before-ip ?:)
9874 ;; watch out for scope operator
9876 (and (eq char-after-ip ?:)
9877 (c-safe (forward-char 1) t)
9878 (not (eq (char-after) ?:))
9881 (c-beginning-of-statement-1 lim)
9882 (when (looking-at c-opt-<>-sexp-key)
9883 (goto-char (match-end 1))
9884 (c-forward-syntactic-ws)
9885 (c-forward-<>-arglist nil)
9886 (c-forward-syntactic-ws))
9887 (looking-at c-class-key)))
9889 (and (c-major-mode-is 'java-mode)
9890 (let ((fence (save-excursion
9891 (c-beginning-of-statement-1 lim)
9896 (cond ((looking-at c-opt-postfix-decl-spec-key)
9897 (setq injava-inher (cons cont (point))
9899 ((or (not (c-safe (c-forward-sexp -1) t))
9905 (not (c-crosses-statement-barrier-p (cdr injava-inher)
9910 ;; CASE 5C.1: non-hanging colon on an inher intro
9911 ((eq char-after-ip ?:)
9912 (c-beginning-of-statement-1 lim)
9913 (c-add-syntax 'inher-intro (c-point 'boi))
9914 ;; don't add inclass symbol since relative point already
9915 ;; contains any class offset
9918 ;; CASE 5C.2: hanging colon on an inher intro
9919 ((eq char-before-ip ?:)
9920 (c-beginning-of-statement-1 lim)
9921 (c-add-syntax 'inher-intro (c-point 'boi))
9922 (if containing-decl-open
9923 (c-add-class-syntax 'inclass
9924 containing-decl-open
9925 containing-decl-start
9929 ;; CASE 5C.3: in a Java implements/extends
9931 (let ((where (cdr injava-inher))
9932 (cont (car injava-inher)))
9934 (cond ((looking-at "throws\\>[^_]")
9935 (c-add-syntax 'func-decl-cont
9936 (progn (c-beginning-of-statement-1 lim)
9938 (cont (c-add-syntax 'inher-cont where))
9939 (t (c-add-syntax 'inher-intro
9940 (progn (goto-char (cdr injava-inher))
9941 (c-beginning-of-statement-1 lim)
9945 ;; CASE 5C.4: a continued inheritance line
9947 (c-beginning-of-inheritance-list lim)
9948 (c-add-syntax 'inher-cont (point))
9949 ;; don't add inclass symbol since relative point already
9950 ;; contains any class offset
9953 ;; CASE 5P: AWK pattern or function or continuation
9955 ((c-major-mode-is 'awk-mode)
9956 (setq placeholder (point))
9958 (if (and (eq (c-beginning-of-statement-1) 'same)
9959 (/= (point) placeholder))
9963 containing-sexp paren-state))
9965 ;; CASE 5D: this could be a top-level initialization, a
9966 ;; member init list continuation, or a template argument
9967 ;; list continuation.
9969 ;; Note: We use the fact that lim is always after any
9970 ;; preceding brace sexp.
9971 (if c-recognize-<>-arglists
9974 (c-syntactic-skip-backward "^;,=<>" lim t)
9977 (when c-overloadable-operators-regexp
9978 (when (setq placeholder (c-after-special-operator-id lim))
9979 (goto-char placeholder)
9982 ((eq (char-before) ?>)
9983 (or (c-backward-<>-arglist nil lim)
9986 ((eq (char-before) ?<)
9989 (c-forward-<>-arglist nil))
9990 (progn (forward-char)
9994 ;; NB: No c-after-special-operator-id stuff in this
9995 ;; clause - we assume only C++ needs it.
9996 (c-syntactic-skip-backward "^;,=" lim t))
9997 (memq (char-before) '(?, ?= ?<)))
10000 ;; CASE 5D.3: perhaps a template list continuation?
10001 ((and (c-major-mode-is 'c++-mode)
10004 (c-with-syntax-table c++-template-syntax-table
10005 (goto-char indent-point)
10006 (setq placeholder (c-up-list-backward))
10008 (eq (char-after placeholder) ?<))))))
10009 (c-with-syntax-table c++-template-syntax-table
10010 (goto-char placeholder)
10011 (c-beginning-of-statement-1 lim t)
10012 (if (save-excursion
10013 (c-backward-syntactic-ws lim)
10014 (eq (char-before) ?<))
10015 ;; In a nested template arglist.
10017 (goto-char placeholder)
10018 (c-syntactic-skip-backward "^,;" lim t)
10019 (c-forward-syntactic-ws))
10020 (back-to-indentation)))
10021 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
10023 (c-add-syntax 'template-args-cont (point) placeholder))
10025 ;; CASE 5D.4: perhaps a multiple inheritance line?
10026 ((and (c-major-mode-is 'c++-mode)
10028 (c-beginning-of-statement-1 lim)
10029 (setq placeholder (point))
10030 (if (looking-at "static\\>[^_]")
10031 (c-forward-token-2 1 nil indent-point))
10032 (and (looking-at c-class-key)
10033 (zerop (c-forward-token-2 2 nil indent-point))
10034 (if (eq (char-after) ?<)
10035 (c-with-syntax-table c++-template-syntax-table
10036 (zerop (c-forward-token-2 1 t indent-point)))
10038 (eq (char-after) ?:))))
10039 (goto-char placeholder)
10040 (c-add-syntax 'inher-cont (c-point 'boi)))
10042 ;; CASE 5D.5: Continuation of the "expression part" of a
10043 ;; top level construct. Or, perhaps, an unrecognized construct.
10045 (while (and (setq placeholder (point))
10046 (eq (car (c-beginning-of-decl-1 containing-sexp)) ; Can't use `lim' here.
10049 (c-backward-syntactic-ws)
10050 (eq (char-before) ?}))
10051 (< (point) placeholder)))
10054 ((eq (point) placeholder) 'statement) ; unrecognized construct
10055 ;; A preceding comma at the top level means that a
10056 ;; new variable declaration starts here. Use
10057 ;; topmost-intro-cont for it, for consistency with
10058 ;; the first variable declaration. C.f. case 5N.
10059 ((eq char-before-ip ?,) 'topmost-intro-cont)
10060 (t 'statement-cont))
10061 nil nil containing-sexp paren-state))
10064 ;; CASE 5F: Close of a non-class declaration level block.
10065 ((and (eq char-after-ip ?})
10066 (c-keyword-member containing-decl-kwd
10067 'c-other-block-decl-kwds))
10068 ;; This is inconsistent: Should use `containing-decl-open'
10069 ;; here if it's at boi, like in case 5J.
10070 (goto-char containing-decl-start)
10072 (if (string-equal (symbol-name containing-decl-kwd) "extern")
10073 ;; Special case for compatibility with the
10074 ;; extern-lang syntactic symbols.
10076 (intern (concat (symbol-name containing-decl-kwd)
10079 (c-most-enclosing-brace paren-state (point))
10082 ;; CASE 5G: we are looking at the brace which closes the
10083 ;; enclosing nested class decl
10084 ((and containing-sexp
10085 (eq char-after-ip ?})
10086 (eq containing-decl-open containing-sexp))
10087 (c-add-class-syntax 'class-close
10088 containing-decl-open
10089 containing-decl-start
10090 containing-decl-kwd
10093 ;; CASE 5H: we could be looking at subsequent knr-argdecls
10094 ((and c-recognize-knr-p
10095 (not containing-sexp) ; can't be knr inside braces.
10096 (not (eq char-before-ip ?}))
10098 (setq placeholder (cdr (c-beginning-of-decl-1 lim)))
10100 ;; Do an extra check to avoid tripping up on
10101 ;; statements that occur in invalid contexts
10102 ;; (e.g. in macro bodies where we don't really
10103 ;; know the context of what we're looking at).
10104 (not (and c-opt-block-stmt-key
10105 (looking-at c-opt-block-stmt-key)))))
10106 (< placeholder indent-point))
10107 (goto-char placeholder)
10108 (c-add-syntax 'knr-argdecl (point)))
10110 ;; CASE 5I: ObjC method definition.
10111 ((and c-opt-method-key
10112 (looking-at c-opt-method-key))
10113 (c-beginning-of-statement-1 nil t)
10114 (if (= (point) indent-point)
10115 ;; Handle the case when it's the first (non-comment)
10116 ;; thing in the buffer. Can't look for a 'same return
10117 ;; value from cbos1 since ObjC directives currently
10118 ;; aren't recognized fully, so that we get 'same
10119 ;; instead of 'previous if it moved over a preceding
10121 (goto-char (point-min)))
10122 (c-add-syntax 'objc-method-intro (c-point 'boi)))
10124 ;; CASE 5N: At a variable declaration that follows a class
10125 ;; definition or some other block declaration that doesn't
10126 ;; end at the closing '}'. C.f. case 5D.5.
10128 (c-backward-syntactic-ws lim)
10129 (and (eq (char-before) ?})
10131 (let ((start (point)))
10132 (if (and c-state-cache
10133 (consp (car c-state-cache))
10134 (eq (cdar c-state-cache) (point)))
10135 ;; Speed up the backward search a bit.
10136 (goto-char (caar c-state-cache)))
10137 (c-beginning-of-decl-1 containing-sexp) ; Can't use `lim' here.
10138 (setq placeholder (point))
10139 (if (= start (point))
10140 ;; The '}' is unbalanced.
10143 (>= (point) indent-point))))))
10144 (goto-char placeholder)
10145 (c-add-stmt-syntax 'topmost-intro-cont nil nil
10146 containing-sexp paren-state))
10148 ;; NOTE: The point is at the end of the previous token here.
10150 ;; CASE 5J: we are at the topmost level, make
10151 ;; sure we skip back past any access specifiers
10153 ;; A macro continuation line is never at top level.
10154 (not (and macro-start
10155 (> indent-point macro-start)))
10157 (setq placeholder (point))
10158 (or (memq char-before-ip '(?\; ?{ ?} nil))
10159 (c-at-vsemi-p before-ws-ip)
10160 (when (and (eq char-before-ip ?:)
10161 (eq (c-beginning-of-statement-1 lim)
10163 (c-backward-syntactic-ws lim)
10164 (setq placeholder (point)))
10165 (and (c-major-mode-is 'objc-mode)
10166 (catch 'not-in-directive
10167 (c-beginning-of-statement-1 lim)
10168 (setq placeholder (point))
10169 (while (and (c-forward-objc-directive)
10170 (< (point) indent-point))
10171 (c-forward-syntactic-ws)
10172 (if (>= (point) indent-point)
10173 (throw 'not-in-directive t))
10174 (setq placeholder (point)))
10176 ;; For historic reasons we anchor at bol of the last
10177 ;; line of the previous declaration. That's clearly
10178 ;; highly bogus and useless, and it makes our lives hard
10179 ;; to remain compatible. :P
10180 (goto-char placeholder)
10181 (c-add-syntax 'topmost-intro (c-point 'bol))
10182 (if containing-decl-open
10183 (if (c-keyword-member containing-decl-kwd
10184 'c-other-block-decl-kwds)
10186 (goto-char (c-brace-anchor-point containing-decl-open))
10188 (if (string-equal (symbol-name containing-decl-kwd)
10190 ;; Special case for compatibility with the
10191 ;; extern-lang syntactic symbols.
10193 (intern (concat "in"
10194 (symbol-name containing-decl-kwd))))
10196 (c-most-enclosing-brace paren-state (point))
10198 (c-add-class-syntax 'inclass
10199 containing-decl-open
10200 containing-decl-start
10201 containing-decl-kwd
10203 (when (and c-syntactic-indentation-in-macros
10205 (/= macro-start (c-point 'boi indent-point)))
10206 (c-add-syntax 'cpp-define-intro)
10207 (setq macro-start nil)))
10209 ;; CASE 5K: we are at an ObjC method definition
10210 ;; continuation line.
10211 ((and c-opt-method-key
10213 (c-beginning-of-statement-1 lim)
10214 (beginning-of-line)
10215 (when (looking-at c-opt-method-key)
10216 (setq placeholder (point)))))
10217 (c-add-syntax 'objc-method-args-cont placeholder))
10219 ;; CASE 5L: we are at the first argument of a template
10220 ;; arglist that begins on the previous line.
10221 ((and c-recognize-<>-arglists
10222 (eq (char-before) ?<)
10223 (not (and c-overloadable-operators-regexp
10224 (c-after-special-operator-id lim))))
10225 (c-beginning-of-statement-1 (c-safe-position (point) paren-state))
10226 (c-add-syntax 'template-args-cont (c-point 'boi)))
10228 ;; CASE 5Q: we are at a statement within a macro.
10230 (c-beginning-of-statement-1 containing-sexp)
10231 (c-add-stmt-syntax 'statement nil t containing-sexp paren-state))
10233 ;;CASE 5N: We are at a topmost continuation line and the only
10234 ;;preceding items are annotations.
10235 ((and (c-major-mode-is 'java-mode)
10236 (setq placeholder (point))
10237 (c-beginning-of-statement-1)
10239 (while (and (c-forward-annotation))
10240 (c-forward-syntactic-ws))
10243 (>= (point) placeholder)
10244 (goto-char placeholder)))
10245 (c-add-syntax 'annotation-top-cont (c-point 'boi)))
10247 ;; CASE 5M: we are at a topmost continuation line
10249 (c-beginning-of-statement-1 (c-safe-position (point) paren-state))
10250 (when (c-major-mode-is 'objc-mode)
10251 (setq placeholder (point))
10252 (while (and (c-forward-objc-directive)
10253 (< (point) indent-point))
10254 (c-forward-syntactic-ws)
10255 (setq placeholder (point)))
10256 (goto-char placeholder))
10257 (c-add-syntax 'topmost-intro-cont (c-point 'boi)))
10261 ;; (CASE 6 has been removed.)
10263 ;; CASE 7: line is an expression, not a statement. Most
10264 ;; likely we are either in a function prototype or a function
10265 ;; call argument list
10266 ((not (or (and c-special-brace-lists
10268 (goto-char containing-sexp)
10269 (c-looking-at-special-brace-list)))
10270 (eq (char-after containing-sexp) ?{)))
10273 ;; CASE 7A: we are looking at the arglist closing paren.
10275 ((memq char-after-ip '(?\) ?\]))
10276 (goto-char containing-sexp)
10277 (setq placeholder (c-point 'boi))
10278 (if (and (c-safe (backward-up-list 1) t)
10279 (>= (point) placeholder))
10282 (skip-chars-forward " \t"))
10283 (goto-char placeholder))
10284 (c-add-stmt-syntax 'arglist-close (list containing-sexp) t
10285 (c-most-enclosing-brace paren-state (point))
10288 ;; CASE 7B: Looking at the opening brace of an
10289 ;; in-expression block or brace list. C.f. cases 4, 16A
10291 ((and (eq char-after-ip ?{)
10293 (setq placeholder (c-inside-bracelist-p (point)
10296 (setq tmpsymbol '(brace-list-open . inexpr-class))
10297 (setq tmpsymbol '(block-open . inexpr-statement)
10299 (cdr-safe (c-looking-at-inexpr-block
10300 (c-safe-position containing-sexp
10303 ;; placeholder is nil if it's a block directly in
10304 ;; a function arglist. That makes us skip out of
10307 (goto-char placeholder)
10308 (back-to-indentation)
10309 (c-add-stmt-syntax (car tmpsymbol) nil t
10310 (c-most-enclosing-brace paren-state (point))
10312 (if (/= (point) placeholder)
10313 (c-add-syntax (cdr tmpsymbol))))
10315 ;; CASE 7C: we are looking at the first argument in an empty
10316 ;; argument list. Use arglist-close if we're actually
10317 ;; looking at a close paren or bracket.
10318 ((memq char-before-ip '(?\( ?\[))
10319 (goto-char containing-sexp)
10320 (setq placeholder (c-point 'boi))
10321 (if (and (c-safe (backward-up-list 1) t)
10322 (>= (point) placeholder))
10325 (skip-chars-forward " \t"))
10326 (goto-char placeholder))
10327 (c-add-stmt-syntax 'arglist-intro (list containing-sexp) t
10328 (c-most-enclosing-brace paren-state (point))
10331 ;; CASE 7D: we are inside a conditional test clause. treat
10332 ;; these things as statements
10334 (goto-char containing-sexp)
10335 (and (c-safe (c-forward-sexp -1) t)
10336 (looking-at "\\<for\\>[^_]")))
10337 (goto-char (1+ containing-sexp))
10338 (c-forward-syntactic-ws indent-point)
10339 (if (eq char-before-ip ?\;)
10340 (c-add-syntax 'statement (point))
10341 (c-add-syntax 'statement-cont (point))
10344 ;; CASE 7E: maybe a continued ObjC method call. This is the
10345 ;; case when we are inside a [] bracketed exp, and what
10346 ;; precede the opening bracket is not an identifier.
10347 ((and c-opt-method-key
10348 (eq (char-after containing-sexp) ?\[)
10350 (goto-char (1- containing-sexp))
10351 (c-backward-syntactic-ws (c-point 'bod))
10352 (if (not (looking-at c-symbol-key))
10353 (c-add-syntax 'objc-method-call-cont containing-sexp))
10356 ;; CASE 7F: we are looking at an arglist continuation line,
10357 ;; but the preceding argument is on the same line as the
10358 ;; opening paren. This case includes multi-line
10359 ;; mathematical paren groupings, but we could be on a
10360 ;; for-list continuation line. C.f. case 7A.
10362 (goto-char (1+ containing-sexp))
10364 (c-forward-syntactic-ws)
10367 (goto-char containing-sexp) ; paren opening the arglist
10368 (setq placeholder (c-point 'boi))
10369 (if (and (c-safe (backward-up-list 1) t)
10370 (>= (point) placeholder))
10373 (skip-chars-forward " \t"))
10374 (goto-char placeholder))
10375 (c-add-stmt-syntax 'arglist-cont-nonempty (list containing-sexp) t
10376 (c-most-enclosing-brace c-state-cache (point))
10379 ;; CASE 7G: we are looking at just a normal arglist
10380 ;; continuation line
10381 (t (c-forward-syntactic-ws indent-point)
10382 (c-add-syntax 'arglist-cont (c-point 'boi)))
10385 ;; CASE 8: func-local multi-inheritance line
10386 ((and (c-major-mode-is 'c++-mode)
10388 (goto-char indent-point)
10389 (skip-chars-forward " \t")
10390 (looking-at c-opt-postfix-decl-spec-key)))
10391 (goto-char indent-point)
10392 (skip-chars-forward " \t")
10395 ;; CASE 8A: non-hanging colon on an inher intro
10396 ((eq char-after-ip ?:)
10397 (c-backward-syntactic-ws lim)
10398 (c-add-syntax 'inher-intro (c-point 'boi)))
10400 ;; CASE 8B: hanging colon on an inher intro
10401 ((eq char-before-ip ?:)
10402 (c-add-syntax 'inher-intro (c-point 'boi)))
10404 ;; CASE 8C: a continued inheritance line
10406 (c-beginning-of-inheritance-list lim)
10407 (c-add-syntax 'inher-cont (point))
10410 ;; CASE 9: we are inside a brace-list
10411 ((and (not (c-major-mode-is 'awk-mode)) ; Maybe this isn't needed (ACM, 2002/3/29)
10412 (setq special-brace-list
10413 (or (and c-special-brace-lists ;;;; ALWAYS NIL FOR AWK!!
10415 (goto-char containing-sexp)
10416 (c-looking-at-special-brace-list)))
10417 (c-inside-bracelist-p containing-sexp paren-state))))
10420 ;; CASE 9A: In the middle of a special brace list opener.
10421 ((and (consp special-brace-list)
10423 (goto-char containing-sexp)
10424 (eq (char-after) ?\())
10425 (eq char-after-ip (car (cdr special-brace-list))))
10426 (goto-char (car (car special-brace-list)))
10427 (skip-chars-backward " \t")
10429 (assoc 'statement-cont
10430 (setq placeholder (c-guess-basic-syntax))))
10431 (setq c-syntactic-context placeholder)
10432 (c-beginning-of-statement-1
10433 (c-safe-position (1- containing-sexp) paren-state))
10434 (c-forward-token-2 0)
10435 (while (looking-at c-specifier-key)
10436 (goto-char (match-end 1))
10437 (c-forward-syntactic-ws))
10438 (c-add-syntax 'brace-list-open (c-point 'boi))))
10440 ;; CASE 9B: brace-list-close brace
10441 ((if (consp special-brace-list)
10442 ;; Check special brace list closer.
10444 (goto-char (car (car special-brace-list)))
10446 (goto-char indent-point)
10447 (back-to-indentation)
10449 ;; We were between the special close char and the `)'.
10450 (and (eq (char-after) ?\))
10451 (eq (1+ (point)) (cdr (car special-brace-list))))
10452 ;; We were before the special close char.
10453 (and (eq (char-after) (cdr (cdr special-brace-list)))
10454 (zerop (c-forward-token-2))
10455 (eq (1+ (point)) (cdr (car special-brace-list)))))))
10456 ;; Normal brace list check.
10457 (and (eq char-after-ip ?})
10458 (c-safe (goto-char (c-up-list-backward (point))) t)
10459 (= (point) containing-sexp)))
10460 (if (eq (point) (c-point 'boi))
10461 (c-add-syntax 'brace-list-close (point))
10462 (setq lim (c-most-enclosing-brace c-state-cache (point)))
10463 (c-beginning-of-statement-1 lim)
10464 (c-add-stmt-syntax 'brace-list-close nil t lim paren-state)))
10467 ;; Prepare for the rest of the cases below by going to the
10468 ;; token following the opening brace
10469 (if (consp special-brace-list)
10471 (goto-char (car (car special-brace-list)))
10472 (c-forward-token-2 1 nil indent-point))
10473 (goto-char containing-sexp))
10475 (let ((start (point)))
10476 (c-forward-syntactic-ws indent-point)
10477 (goto-char (max start (c-point 'bol))))
10478 (c-skip-ws-forward indent-point)
10481 ;; CASE 9C: we're looking at the first line in a brace-list
10482 ((= (point) indent-point)
10483 (if (consp special-brace-list)
10484 (goto-char (car (car special-brace-list)))
10485 (goto-char containing-sexp))
10486 (if (eq (point) (c-point 'boi))
10487 (c-add-syntax 'brace-list-intro (point))
10488 (setq lim (c-most-enclosing-brace c-state-cache (point)))
10489 (c-beginning-of-statement-1 lim)
10490 (c-add-stmt-syntax 'brace-list-intro nil t lim paren-state)))
10492 ;; CASE 9D: this is just a later brace-list-entry or
10493 ;; brace-entry-open
10494 (t (if (or (eq char-after-ip ?{)
10495 (and c-special-brace-lists
10497 (goto-char indent-point)
10498 (c-forward-syntactic-ws (c-point 'eol))
10499 (c-looking-at-special-brace-list (point)))))
10500 (c-add-syntax 'brace-entry-open (point))
10501 (c-add-syntax 'brace-list-entry (point))
10505 ;; CASE 10: A continued statement or top level construct.
10506 ((and (not (memq char-before-ip '(?\; ?:)))
10507 (not (c-at-vsemi-p before-ws-ip))
10508 (or (not (eq char-before-ip ?}))
10509 (c-looking-at-inexpr-block-backward c-state-cache))
10512 (c-beginning-of-statement-1 containing-sexp)
10513 (setq placeholder (point))))
10514 (/= placeholder containing-sexp))
10515 ;; This is shared with case 18.
10516 (c-guess-continued-construct indent-point
10522 ;; CASE 16: block close brace, possibly closing the defun or
10524 ((eq char-after-ip ?})
10525 ;; From here on we have the next containing sexp in lim.
10526 (setq lim (c-most-enclosing-brace paren-state))
10527 (goto-char containing-sexp)
10530 ;; CASE 16E: Closing a statement block? This catches
10531 ;; cases where it's preceded by a statement keyword,
10532 ;; which works even when used in an "invalid" context,
10533 ;; e.g. a macro argument.
10534 ((c-after-conditional)
10535 (c-backward-to-block-anchor lim)
10536 (c-add-stmt-syntax 'block-close nil t lim paren-state))
10538 ;; CASE 16A: closing a lambda defun or an in-expression
10539 ;; block? C.f. cases 4, 7B and 17E.
10540 ((setq placeholder (c-looking-at-inexpr-block
10541 (c-safe-position containing-sexp paren-state)
10543 (setq tmpsymbol (if (eq (car placeholder) 'inlambda)
10546 (goto-char containing-sexp)
10547 (back-to-indentation)
10548 (if (= containing-sexp (point))
10549 (c-add-syntax tmpsymbol (point))
10550 (goto-char (cdr placeholder))
10551 (back-to-indentation)
10552 (c-add-stmt-syntax tmpsymbol nil t
10553 (c-most-enclosing-brace paren-state (point))
10555 (if (/= (point) (cdr placeholder))
10556 (c-add-syntax (car placeholder)))))
10558 ;; CASE 16B: does this close an inline or a function in
10559 ;; a non-class declaration level block?
10564 (c-looking-at-decl-block
10565 (c-most-enclosing-brace paren-state lim)
10567 (setq placeholder (point))))
10568 (c-backward-to-decl-anchor lim)
10569 (back-to-indentation)
10570 (if (save-excursion
10571 (goto-char placeholder)
10572 (looking-at c-other-decl-block-key))
10573 (c-add-syntax 'defun-close (point))
10574 (c-add-syntax 'inline-close (point))))
10576 ;; CASE 16F: Can be a defun-close of a function declared
10577 ;; in a statement block, e.g. in Pike or when using gcc
10578 ;; extensions, but watch out for macros followed by
10579 ;; blocks. Let it through to be handled below.
10580 ;; C.f. cases B.3 and 17G.
10582 (and (not (c-at-statement-start-p))
10583 (eq (c-beginning-of-statement-1 lim nil nil t) 'same)
10584 (setq placeholder (point))
10585 (let ((c-recognize-typeless-decls nil))
10586 ;; Turn off recognition of constructs that
10587 ;; lacks a type in this case, since that's more
10588 ;; likely to be a macro followed by a block.
10589 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
10590 (back-to-indentation)
10591 (if (/= (point) containing-sexp)
10592 (goto-char placeholder))
10593 (c-add-stmt-syntax 'defun-close nil t lim paren-state))
10595 ;; CASE 16C: If there is an enclosing brace then this is
10596 ;; a block close since defun closes inside declaration
10597 ;; level blocks have been handled above.
10599 ;; If the block is preceded by a case/switch label on
10600 ;; the same line, we anchor at the first preceding label
10601 ;; at boi. The default handling in c-add-stmt-syntax
10602 ;; really fixes it better, but we do like this to keep
10603 ;; the indentation compatible with version 5.28 and
10604 ;; earlier. C.f. case 17H.
10605 (while (and (/= (setq placeholder (point)) (c-point 'boi))
10606 (eq (c-beginning-of-statement-1 lim) 'label)))
10607 (goto-char placeholder)
10608 (if (looking-at c-label-kwds-regexp)
10609 (c-add-syntax 'block-close (point))
10610 (goto-char containing-sexp)
10611 ;; c-backward-to-block-anchor not necessary here; those
10612 ;; situations are handled in case 16E above.
10613 (c-add-stmt-syntax 'block-close nil t lim paren-state)))
10615 ;; CASE 16D: Only top level defun close left.
10617 (goto-char containing-sexp)
10618 (c-backward-to-decl-anchor lim)
10619 (c-add-stmt-syntax 'defun-close nil nil
10620 (c-most-enclosing-brace paren-state)
10624 ;; CASE 19: line is an expression, not a statement, and is directly
10625 ;; contained by a template delimiter. Most likely, we are in a
10626 ;; template arglist within a statement. This case is based on CASE
10627 ;; 7. At some point in the future, we may wish to create more
10628 ;; syntactic symbols such as `template-intro',
10629 ;; `template-cont-nonempty', etc., and distinguish between them as we
10630 ;; do for `arglist-intro' etc. (2009-12-07).
10631 ((and c-recognize-<>-arglists
10632 (setq containing-< (c-up-list-backward indent-point containing-sexp))
10633 (eq (char-after containing-<) ?\<))
10634 (setq placeholder (c-point 'boi containing-<))
10635 (goto-char containing-sexp) ; Most nested Lbrace/Lparen (but not
10636 ; '<') before indent-point.
10637 (if (>= (point) placeholder)
10640 (skip-chars-forward " \t"))
10641 (goto-char placeholder))
10642 (c-add-stmt-syntax 'template-args-cont (list containing-<) t
10643 (c-most-enclosing-brace c-state-cache (point))
10646 ;; CASE 17: Statement or defun catchall.
10648 (goto-char indent-point)
10649 ;; Back up statements until we find one that starts at boi.
10650 (while (let* ((prev-point (point))
10651 (last-step-type (c-beginning-of-statement-1
10653 (if (= (point) prev-point)
10655 (setq step-type (or step-type last-step-type))
10657 (setq step-type last-step-type)
10658 (/= (point) (c-point 'boi)))))
10661 ;; CASE 17B: continued statement
10662 ((and (eq step-type 'same)
10663 (/= (point) indent-point))
10664 (c-add-stmt-syntax 'statement-cont nil nil
10665 containing-sexp paren-state))
10667 ;; CASE 17A: After a case/default label?
10669 (while (and (eq step-type 'label)
10670 (not (looking-at c-label-kwds-regexp)))
10672 (c-beginning-of-statement-1 containing-sexp)))
10673 (eq step-type 'label))
10674 (c-add-stmt-syntax (if (eq char-after-ip ?{)
10675 'statement-case-open
10676 'statement-case-intro)
10677 nil t containing-sexp paren-state))
10679 ;; CASE 17D: any old statement
10681 (while (eq step-type 'label)
10683 (c-beginning-of-statement-1 containing-sexp)))
10684 (eq step-type 'previous))
10685 (c-add-stmt-syntax 'statement nil t
10686 containing-sexp paren-state)
10687 (if (eq char-after-ip ?{)
10688 (c-add-syntax 'block-open)))
10690 ;; CASE 17I: Inside a substatement block.
10692 ;; The following tests are all based on containing-sexp.
10693 (goto-char containing-sexp)
10694 ;; From here on we have the next containing sexp in lim.
10695 (setq lim (c-most-enclosing-brace paren-state containing-sexp))
10696 (c-after-conditional))
10697 (c-backward-to-block-anchor lim)
10698 (c-add-stmt-syntax 'statement-block-intro nil t
10700 (if (eq char-after-ip ?{)
10701 (c-add-syntax 'block-open)))
10703 ;; CASE 17E: first statement in an in-expression block.
10704 ;; C.f. cases 4, 7B and 16A.
10705 ((setq placeholder (c-looking-at-inexpr-block
10706 (c-safe-position containing-sexp paren-state)
10708 (setq tmpsymbol (if (eq (car placeholder) 'inlambda)
10710 'statement-block-intro))
10711 (back-to-indentation)
10712 (if (= containing-sexp (point))
10713 (c-add-syntax tmpsymbol (point))
10714 (goto-char (cdr placeholder))
10715 (back-to-indentation)
10716 (c-add-stmt-syntax tmpsymbol nil t
10717 (c-most-enclosing-brace c-state-cache (point))
10719 (if (/= (point) (cdr placeholder))
10720 (c-add-syntax (car placeholder))))
10721 (if (eq char-after-ip ?{)
10722 (c-add-syntax 'block-open)))
10724 ;; CASE 17F: first statement in an inline, or first
10725 ;; statement in a top-level defun. we can tell this is it
10726 ;; if there are no enclosing braces that haven't been
10727 ;; narrowed out by a class (i.e. don't use bod here).
10729 (or (not (setq placeholder (c-most-enclosing-brace
10732 (goto-char placeholder)
10733 (eq (char-after) ?{))
10734 (c-looking-at-decl-block (c-most-enclosing-brace
10735 paren-state (point))
10737 (c-backward-to-decl-anchor lim)
10738 (back-to-indentation)
10739 (c-add-syntax 'defun-block-intro (point)))
10741 ;; CASE 17G: First statement in a function declared inside
10742 ;; a normal block. This can occur in Pike and with
10743 ;; e.g. the gcc extensions, but watch out for macros
10744 ;; followed by blocks. C.f. cases B.3 and 16F.
10746 (and (not (c-at-statement-start-p))
10747 (eq (c-beginning-of-statement-1 lim nil nil t) 'same)
10748 (setq placeholder (point))
10749 (let ((c-recognize-typeless-decls nil))
10750 ;; Turn off recognition of constructs that lacks
10751 ;; a type in this case, since that's more likely
10752 ;; to be a macro followed by a block.
10753 (c-forward-decl-or-cast-1 (c-point 'bosws) nil nil))))
10754 (back-to-indentation)
10755 (if (/= (point) containing-sexp)
10756 (goto-char placeholder))
10757 (c-add-stmt-syntax 'defun-block-intro nil t
10760 ;; CASE 17H: First statement in a block.
10762 ;; If the block is preceded by a case/switch label on the
10763 ;; same line, we anchor at the first preceding label at
10764 ;; boi. The default handling in c-add-stmt-syntax is
10765 ;; really fixes it better, but we do like this to keep the
10766 ;; indentation compatible with version 5.28 and earlier.
10768 (while (and (/= (setq placeholder (point)) (c-point 'boi))
10769 (eq (c-beginning-of-statement-1 lim) 'label)))
10770 (goto-char placeholder)
10771 (if (looking-at c-label-kwds-regexp)
10772 (c-add-syntax 'statement-block-intro (point))
10773 (goto-char containing-sexp)
10774 ;; c-backward-to-block-anchor not necessary here; those
10775 ;; situations are handled in case 17I above.
10776 (c-add-stmt-syntax 'statement-block-intro nil t
10778 (if (eq char-after-ip ?{)
10779 (c-add-syntax 'block-open)))
10783 ;; now we need to look at any modifiers
10784 (goto-char indent-point)
10785 (skip-chars-forward " \t")
10787 ;; are we looking at a comment only line?
10788 (when (and (looking-at c-comment-start-regexp)
10789 (/= (c-forward-token-2 0 nil (c-point 'eol)) 0))
10790 (c-append-syntax 'comment-intro))
10792 ;; we might want to give additional offset to friends (in C++).
10793 (when (and c-opt-friend-key
10794 (looking-at c-opt-friend-key))
10795 (c-append-syntax 'friend))
10797 ;; Set syntactic-relpos.
10798 (let ((p c-syntactic-context))
10800 (if (integerp (c-langelem-pos (car p)))
10802 (setq syntactic-relpos (c-langelem-pos (car p)))
10807 ;; Start of or a continuation of a preprocessor directive?
10808 (if (and macro-start
10809 (eq macro-start (c-point 'boi))
10810 (not (and (c-major-mode-is 'pike-mode)
10811 (eq (char-after (1+ macro-start)) ?\"))))
10812 (c-append-syntax 'cpp-macro)
10813 (when (and c-syntactic-indentation-in-macros macro-start)
10816 (< syntactic-relpos macro-start)
10818 (assq 'arglist-intro c-syntactic-context)
10819 (assq 'arglist-cont c-syntactic-context)
10820 (assq 'arglist-cont-nonempty c-syntactic-context)
10821 (assq 'arglist-close c-syntactic-context))))
10822 ;; If inside a cpp expression, i.e. anywhere in a
10823 ;; cpp directive except a #define body, we only let
10824 ;; through the syntactic analysis that is internal
10825 ;; in the expression. That means the arglist
10826 ;; elements, if they are anchored inside the cpp
10828 (setq c-syntactic-context nil)
10829 (c-add-syntax 'cpp-macro-cont macro-start))
10830 (when (and (eq macro-start syntactic-relpos)
10831 (not (assq 'cpp-define-intro c-syntactic-context))
10833 (goto-char macro-start)
10834 (or (not (c-forward-to-cpp-define-body))
10835 (<= (point) (c-point 'boi indent-point)))))
10836 ;; Inside a #define body and the syntactic analysis is
10837 ;; anchored on the start of the #define. In this case
10838 ;; we add cpp-define-intro to get the extra
10839 ;; indentation of the #define body.
10840 (c-add-syntax 'cpp-define-intro)))))
10842 ;; return the syntax
10843 c-syntactic-context)))
10846 ;; Indentation calculation.
10848 (defun c-evaluate-offset (offset langelem symbol)
10849 ;; offset can be a number, a function, a variable, a list, or one of
10850 ;; the symbols + or -
10852 ;; This function might do hidden buffer changes.
10855 ((numberp offset) offset)
10856 ((vectorp offset) offset)
10857 ((null offset) nil)
10859 ((eq offset '+) c-basic-offset)
10860 ((eq offset '-) (- c-basic-offset))
10861 ((eq offset '++) (* 2 c-basic-offset))
10862 ((eq offset '--) (* 2 (- c-basic-offset)))
10863 ((eq offset '*) (/ c-basic-offset 2))
10864 ((eq offset '/) (/ (- c-basic-offset) 2))
10866 ((functionp offset)
10869 (cons (c-langelem-sym langelem)
10870 (c-langelem-pos langelem)))
10875 ((eq (car offset) 'quote)
10876 (c-benign-error "The offset %S for %s was mistakenly quoted"
10880 ((memq (car offset) '(min max))
10881 (let (res val (method (car offset)))
10882 (setq offset (cdr offset))
10884 (setq val (c-evaluate-offset (car offset) langelem symbol))
10892 Error evaluating offset %S for %s: \
10893 Cannot combine absolute offset %S with relative %S in `%s' method"
10894 (car offset) symbol res val method)
10895 (setq res (funcall method res val))))
10899 Error evaluating offset %S for %s: \
10900 Cannot combine relative offset %S with absolute %S in `%s' method"
10901 (car offset) symbol res val method)
10902 (setq res (vector (funcall method (aref res 0)
10904 (setq offset (cdr offset)))
10907 ((eq (car offset) 'add)
10909 (setq offset (cdr offset))
10911 (setq val (c-evaluate-offset (car offset) langelem symbol))
10918 (setq res (vector (+ (aref res 0) val)))
10919 (setq res (+ res val))))
10923 Error evaluating offset %S for %s: \
10924 Cannot combine absolute offsets %S and %S in `add' method"
10925 (car offset) symbol res val)
10926 (setq res val)))) ; Override.
10927 (setq offset (cdr offset)))
10932 (when (eq (car offset) 'first)
10933 (setq offset (cdr offset)))
10934 (while (and (not res) offset)
10935 (setq res (c-evaluate-offset (car offset) langelem symbol)
10936 offset (cdr offset)))
10939 ((and (symbolp offset) (boundp offset))
10940 (symbol-value offset))
10943 (c-benign-error "Unknown offset format %S for %s" offset symbol)
10946 (if (or (null res) (integerp res)
10947 (and (vectorp res) (= (length res) 1) (integerp (aref res 0))))
10949 (c-benign-error "Error evaluating offset %S for %s: Got invalid value %S"
10953 (defun c-calc-offset (langelem)
10954 ;; Get offset from LANGELEM which is a list beginning with the
10955 ;; syntactic symbol and followed by any analysis data it provides.
10956 ;; That data may be zero or more elements, but if at least one is
10957 ;; given then the first is the anchor position (or nil). The symbol
10958 ;; is matched against `c-offsets-alist' and the offset calculated
10959 ;; from that is returned.
10961 ;; This function might do hidden buffer changes.
10962 (let* ((symbol (c-langelem-sym langelem))
10963 (match (assq symbol c-offsets-alist))
10964 (offset (cdr-safe match)))
10966 (setq offset (c-evaluate-offset offset langelem symbol))
10967 (if c-strict-syntax-p
10968 (c-benign-error "No offset found for syntactic symbol %s" symbol))
10970 (if (vectorp offset)
10972 (or (and (numberp offset) offset)
10973 (and (symbolp offset) (symbol-value offset))
10977 (defun c-get-offset (langelem)
10978 ;; This is a compatibility wrapper for `c-calc-offset' in case
10979 ;; someone is calling it directly. It takes an old style syntactic
10980 ;; element on the form (SYMBOL . ANCHOR-POS) and converts it to the
10983 ;; This function might do hidden buffer changes.
10984 (if (c-langelem-pos langelem)
10985 (c-calc-offset (list (c-langelem-sym langelem)
10986 (c-langelem-pos langelem)))
10987 (c-calc-offset langelem)))
10989 (defun c-get-syntactic-indentation (langelems)
10990 ;; Calculate the syntactic indentation from a syntactic description
10991 ;; as returned by `c-guess-syntax'.
10993 ;; Note that topmost-intro always has an anchor position at bol, for
10994 ;; historical reasons. It's often used together with other symbols
10995 ;; that has more sane positions. Since we always use the first
10996 ;; found anchor position, we rely on that these other symbols always
10997 ;; precede topmost-intro in the LANGELEMS list.
10999 ;; This function might do hidden buffer changes.
11000 (let ((indent 0) anchor)
11003 (let* ((c-syntactic-element (car langelems))
11004 (res (c-calc-offset c-syntactic-element)))
11007 ;; Got an absolute column that overrides any indentation
11008 ;; we've collected so far, but not the relative
11009 ;; indentation we might get for the nested structures
11010 ;; further down the langelems list.
11011 (setq indent (elt res 0)
11012 anchor (point-min)) ; A position at column 0.
11014 ;; Got a relative change of the current calculated
11016 (setq indent (+ indent res))
11018 ;; Use the anchor position from the first syntactic
11019 ;; element with one.
11021 (setq anchor (c-langelem-pos (car langelems)))))
11023 (setq langelems (cdr langelems))))
11026 (+ indent (save-excursion
11032 (cc-provide 'cc-engine)
11034 ;;; cc-engine.el ends here