1 ;;; cc-engine.el --- core syntax guessing engine for CC mode -*- coding: utf-8 -*-
3 ;; Copyright (C) 1985, 1987, 1992-2013 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.
1138 (if (setq saved
(if (looking-at c-block-stmt-1-key
)
1141 (cond ((> start saved
) (setq pos saved
))
1142 ((= start saved
) (setq ret
'up
)))))
1144 (when (and (not ignore-labels
)
1145 (eq c-maybe-labelp t
)
1146 (not (eq ret
'beginning
))
1148 (not bitfield-type-pos
) ; Bitfields take precedence over labels.
1149 (or (not label-good-pos
)
1150 (<= label-good-pos pos
)
1152 (goto-char (if (and last-label-pos
1153 (< last-label-pos start
))
1156 (looking-at c-label-kwds-regexp
))))
1157 ;; We're in a label. Maybe we should step to the statement
1159 (if (< after-labels-pos start
)
1160 (setq pos after-labels-pos
)
1162 (if (and last-label-pos
(< last-label-pos start
))
1163 ;; Might have jumped over several labels. Go to the last one.
1164 (setq pos last-label-pos
)))))
1166 ;; Have we got "case <expression>:"?
1168 (when (and after-case
:-pos
1169 (not (eq ret
'beginning
))
1170 (looking-at c-case-kwds-regexp
))
1171 (if (< after-case
:-pos start
)
1172 (setq pos after-case
:-pos
))
1176 ;; Skip over the unary operators that can start the statement.
1178 (c-backward-syntactic-ws)
1179 ;; protect AWK post-inc/decrement operators, etc.
1180 (and (not (c-at-vsemi-p (point)))
1181 (/= (skip-chars-backward "-+!*&~@`#") 0)))
1186 (defun c-punctuation-in (from to
)
1187 "Return non-nil if there is a non-comment non-macro punctuation character
1188 between FROM and TO. FROM must not be in a string or comment. The returned
1189 value is the position of the first such character."
1192 (let ((pos (point)))
1193 (while (progn (skip-chars-forward c-symbol-chars to
)
1194 (c-forward-syntactic-ws to
)
1196 (setq pos
(point))))
1197 (and (< (point) to
) (point))))
1199 (defun c-crosses-statement-barrier-p (from to
)
1200 "Return non-nil if buffer positions FROM to TO cross one or more
1201 statement or declaration boundaries. The returned value is actually
1202 the position of the earliest boundary char. FROM must not be within
1203 a string or comment.
1205 The variable `c-maybe-labelp' is set to the position of the first `:' that
1206 might start a label (i.e. not part of `::' and not preceded by `?'). If a
1207 single `?' is found, then `c-maybe-labelp' is cleared.
1209 For AWK, a statement which is terminated by an EOL (not a \; or a }) is
1210 regarded as having a \"virtual semicolon\" immediately after the last token on
1211 the line. If this virtual semicolon is _at_ from, the function recognizes it.
1213 Note that this function might do hidden buffer changes. See the
1214 comment at the start of cc-engine.el for more info."
1216 ;; If the current language has CPP macros, insert # into skip-chars.
1217 (if c-opt-cpp-symbol
1218 (concat (substring c-stmt-delim-chars
0 1) ; "^"
1219 c-opt-cpp-symbol
; usually "#"
1220 (substring c-stmt-delim-chars
1)) ; e.g. ";{}?:"
1221 c-stmt-delim-chars
))
1223 (append (substring skip-chars
1) nil
)) ; e.g. (?# ?\; ?{ ?} ?? ?:)
1224 lit-range vsemi-pos
)
1230 (while (progn (skip-chars-forward
1232 (min to
(c-point 'bonl
)))
1235 ;; Virtual semicolon?
1239 (if (setq lit-range
(c-literal-limits from
)) ; Have we landed in a string/comment?
1240 (goto-char (car lit-range
)))
1241 (c-backward-syntactic-ws) ; ? put a limit here, maybe?
1242 (setq vsemi-pos
(point))
1244 (throw 'done vsemi-pos
))
1245 ;; In a string/comment?
1246 ((setq lit-range
(c-literal-limits from
))
1247 (goto-char (cdr lit-range
)))
1248 ((eq (char-after) ?
:)
1250 (if (and (eq (char-after) ?
:)
1252 ;; Ignore scope operators.
1254 (setq c-maybe-labelp
(1- (point)))))
1255 ((eq (char-after) ??
)
1256 ;; A question mark. Can't be a label, so stop
1257 ;; looking for more : and ?.
1258 (setq c-maybe-labelp nil
1259 skip-chars
(substring c-stmt-delim-chars
0 -
2)))
1260 ;; At a CPP construct?
1261 ((and c-opt-cpp-symbol
(looking-at c-opt-cpp-symbol
)
1264 (looking-at c-opt-cpp-prefix
)))
1266 ((memq (char-after) non-skip-list
)
1267 (throw 'done
(point)))))
1268 ;; In trailing space after an as yet undetected virtual semicolon?
1269 (c-backward-syntactic-ws from
)
1270 (if (and (< (point) to
)
1275 (defun c-at-statement-start-p ()
1276 "Return non-nil if the point is at the first token in a statement
1277 or somewhere in the syntactic whitespace before it.
1279 A \"statement\" here is not restricted to those inside code blocks.
1280 Any kind of declaration-like construct that occur outside function
1281 bodies is also considered a \"statement\".
1283 Note that this function might do hidden buffer changes. See the
1284 comment at the start of cc-engine.el for more info."
1289 (c-syntactic-skip-backward (substring c-stmt-delim-chars
1) nil t
)
1291 (eq (char-before) ?
})
1292 (and (eq (char-before) ?
{)
1293 (not (and c-special-brace-lists
1294 (progn (backward-char)
1295 (c-looking-at-special-brace-list)))))
1296 (c-crosses-statement-barrier-p (point) end
)))))
1298 (defun c-at-expression-start-p ()
1299 "Return non-nil if the point is at the first token in an expression or
1300 statement, or somewhere in the syntactic whitespace before it.
1302 An \"expression\" here is a bit different from the normal language
1303 grammar sense: It's any sequence of expression tokens except commas,
1304 unless they are enclosed inside parentheses of some kind. Also, an
1305 expression never continues past an enclosing parenthesis, but it might
1306 contain parenthesis pairs of any sort except braces.
1308 Since expressions never cross statement boundaries, this function also
1309 recognizes statement beginnings, just like `c-at-statement-start-p'.
1311 Note that this function might do hidden buffer changes. See the
1312 comment at the start of cc-engine.el for more info."
1316 (c-stmt-delim-chars c-stmt-delim-chars-with-comma
)
1318 (c-syntactic-skip-backward (substring c-stmt-delim-chars
1) nil t
)
1320 (memq (char-before) '(?
{ ?
}))
1321 (save-excursion (backward-char)
1322 (looking-at "\\s("))
1323 (c-crosses-statement-barrier-p (point) end
)))))
1326 ;; A set of functions that covers various idiosyncrasies in
1327 ;; implementations of `forward-comment'.
1329 ;; Note: Some emacsen considers incorrectly that any line comment
1330 ;; ending with a backslash continues to the next line. I can't think
1331 ;; of any way to work around that in a reliable way without changing
1332 ;; the buffer, though. Suggestions welcome. ;) (No, temporarily
1333 ;; changing the syntax for backslash doesn't work since we must treat
1334 ;; escapes in string literals correctly.)
1336 (defun c-forward-single-comment ()
1337 "Move forward past whitespace and the closest following comment, if any.
1338 Return t if a comment was found, nil otherwise. In either case, the
1339 point is moved past the following whitespace. Line continuations,
1340 i.e. a backslashes followed by line breaks, are treated as whitespace.
1341 The line breaks that end line comments are considered to be the
1342 comment enders, so the point will be put on the beginning of the next
1343 line if it moved past a line comment.
1345 This function does not do any hidden buffer changes."
1347 (let ((start (point)))
1348 (when (looking-at "\\([ \t\n\r\f\v]\\|\\\\[\n\r]\\)+")
1349 (goto-char (match-end 0)))
1351 (when (forward-comment 1)
1353 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1357 ;; Emacs includes the ending newline in a b-style (c++)
1358 ;; comment, but XEmacs doesn't. We depend on the Emacs
1359 ;; behavior (which also is symmetric).
1360 (if (and (eolp) (elt (parse-partial-sexp start
(point)) 7))
1361 (condition-case nil
(forward-char 1)))
1365 (defsubst c-forward-comments
()
1366 "Move forward past all following whitespace and comments.
1367 Line continuations, i.e. a backslashes followed by line breaks, are
1368 treated as whitespace.
1370 Note that this function might do hidden buffer changes. See the
1371 comment at the start of cc-engine.el for more info."
1374 ;; If forward-comment in at least XEmacs 21 is given a large
1375 ;; positive value, it'll loop all the way through if it hits
1377 (and (forward-comment 5)
1378 ;; Some emacsen (e.g. XEmacs 21) return t when moving
1382 (when (looking-at "\\\\[\n\r]")
1386 (defun c-backward-single-comment ()
1387 "Move backward past whitespace and the closest preceding comment, if any.
1388 Return t if a comment was found, nil otherwise. In either case, the
1389 point is moved past the preceding whitespace. Line continuations,
1390 i.e. a backslashes followed by line breaks, are treated as whitespace.
1391 The line breaks that end line comments are considered to be the
1392 comment enders, so the point cannot be at the end of the same line to
1393 move over a line comment.
1395 This function does not do any hidden buffer changes."
1397 (let ((start (point)))
1398 ;; When we got newline terminated comments, forward-comment in all
1399 ;; supported emacsen so far will stop at eol of each line not
1400 ;; ending with a comment when moving backwards. This corrects for
1401 ;; that, and at the same time handles line continuations.
1403 (skip-chars-backward " \t\n\r\f\v")
1404 (and (looking-at "[\n\r]")
1405 (eq (char-before) ?
\\)))
1409 ;; Some emacsen (e.g. Emacs 19.34) return t when moving
1410 ;; backwards at bob.
1413 ;; Leave point after the closest following newline if we've
1414 ;; backed up over any above, since forward-comment won't move
1415 ;; backward over a line comment if point is at the end of the
1417 (re-search-forward "\\=\\s *[\n\r]" start t
)
1419 (if (if (let (open-paren-in-column-0-is-defun-start) (forward-comment -
1))
1421 ;; If forward-comment above succeeded and we're at eol
1422 ;; then the newline we moved over above didn't end a
1423 ;; line comment, so we give it another go.
1424 (let (open-paren-in-column-0-is-defun-start)
1425 (forward-comment -
1))
1428 ;; Emacs <= 20 and XEmacs move back over the closer of a
1429 ;; block comment that lacks an opener.
1430 (if (looking-at "\\*/")
1431 (progn (forward-char 2) nil
)
1434 (defsubst c-backward-comments
()
1435 "Move backward past all preceding whitespace and comments.
1436 Line continuations, i.e. a backslashes followed by line breaks, are
1437 treated as whitespace. The line breaks that end line comments are
1438 considered to be the comment enders, so the point cannot be at the end
1439 of the same line to move over a line comment. Unlike
1440 c-backward-syntactic-ws, this function doesn't move back over
1441 preprocessor directives.
1443 Note that this function might do hidden buffer changes. See the
1444 comment at the start of cc-engine.el for more info."
1446 (let ((start (point)))
1448 ;; `forward-comment' in some emacsen (e.g. XEmacs 21.4)
1449 ;; return t when moving backwards at bob.
1452 (if (let (open-paren-in-column-0-is-defun-start moved-comment
)
1454 (and (not (setq moved-comment
(forward-comment -
1)))
1455 ;; Cope specifically with ^M^J here -
1456 ;; forward-comment sometimes gets stuck after ^Ms,
1457 ;; sometimes after ^M^J.
1459 (when (eq (char-before) ?
\r)
1462 (when (and (eq (char-before) ?
\n)
1463 (eq (char-before (1- (point))) ?
\r))
1467 (if (looking-at "\\*/")
1468 ;; Emacs <= 20 and XEmacs move back over the
1469 ;; closer of a block comment that lacks an opener.
1470 (progn (forward-char 2) nil
)
1473 ;; XEmacs treats line continuations as whitespace but
1474 ;; only in the backward direction, which seems a bit
1475 ;; odd. Anyway, this is necessary for Emacs.
1476 (when (and (looking-at "[\n\r]")
1477 (eq (char-before) ?
\\)
1483 ;; Tools for skipping over syntactic whitespace.
1485 ;; The following functions use text properties to cache searches over
1486 ;; large regions of syntactic whitespace. It works as follows:
1488 ;; o If a syntactic whitespace region contains anything but simple
1489 ;; whitespace (i.e. space, tab and line breaks), the text property
1490 ;; `c-in-sws' is put over it. At places where we have stopped
1491 ;; within that region there's also a `c-is-sws' text property.
1492 ;; That since there typically are nested whitespace inside that
1493 ;; must be handled separately, e.g. whitespace inside a comment or
1494 ;; cpp directive. Thus, from one point with `c-is-sws' it's safe
1495 ;; to jump to another point with that property within the same
1496 ;; `c-in-sws' region. It can be likened to a ladder where
1497 ;; `c-in-sws' marks the bars and `c-is-sws' the rungs.
1499 ;; o The `c-is-sws' property is put on the simple whitespace chars at
1500 ;; a "rung position" and also maybe on the first following char.
1501 ;; As many characters as can be conveniently found in this range
1502 ;; are marked, but no assumption can be made that the whole range
1503 ;; is marked (it could be clobbered by later changes, for
1506 ;; Note that some part of the beginning of a sequence of simple
1507 ;; whitespace might be part of the end of a preceding line comment
1508 ;; or cpp directive and must not be considered part of the "rung".
1509 ;; Such whitespace is some amount of horizontal whitespace followed
1510 ;; by a newline. In the case of cpp directives it could also be
1511 ;; two newlines with horizontal whitespace between them.
1513 ;; The reason to include the first following char is to cope with
1514 ;; "rung positions" that doesn't have any ordinary whitespace. If
1515 ;; `c-is-sws' is put on a token character it does not have
1516 ;; `c-in-sws' set simultaneously. That's the only case when that
1517 ;; can occur, and the reason for not extending the `c-in-sws'
1518 ;; region to cover it is that the `c-in-sws' region could then be
1519 ;; accidentally merged with a following one if the token is only
1520 ;; one character long.
1522 ;; o On buffer changes the `c-in-sws' and `c-is-sws' properties are
1523 ;; removed in the changed region. If the change was inside
1524 ;; syntactic whitespace that means that the "ladder" is broken, but
1525 ;; a later call to `c-forward-sws' or `c-backward-sws' will use the
1526 ;; parts on either side and use an ordinary search only to "repair"
1529 ;; Special care needs to be taken if a region is removed: If there
1530 ;; are `c-in-sws' on both sides of it which do not connect inside
1531 ;; the region then they can't be joined. If e.g. a marked macro is
1532 ;; broken, syntactic whitespace inside the new text might be
1533 ;; marked. If those marks would become connected with the old
1534 ;; `c-in-sws' range around the macro then we could get a ladder
1535 ;; with one end outside the macro and the other at some whitespace
1538 ;; The main motivation for this system is to increase the speed in
1539 ;; skipping over the large whitespace regions that can occur at the
1540 ;; top level in e.g. header files that contain a lot of comments and
1541 ;; cpp directives. For small comments inside code it's probably
1542 ;; slower than using `forward-comment' straightforwardly, but speed is
1543 ;; not a significant factor there anyway.
1545 ; (defface c-debug-is-sws-face
1546 ; '((t (:background "GreenYellow")))
1547 ; "Debug face to mark the `c-is-sws' property.")
1548 ; (defface c-debug-in-sws-face
1549 ; '((t (:underline t)))
1550 ; "Debug face to mark the `c-in-sws' property.")
1552 ; (defun c-debug-put-sws-faces ()
1553 ; ;; Put the sws debug faces on all the `c-is-sws' and `c-in-sws'
1554 ; ;; properties in the buffer.
1557 ; (c-save-buffer-state (in-face)
1558 ; (goto-char (point-min))
1559 ; (setq in-face (if (get-text-property (point) 'c-is-sws)
1562 ; (goto-char (next-single-property-change
1563 ; (point) 'c-is-sws nil (point-max)))
1566 ; (c-debug-add-face in-face (point) 'c-debug-is-sws-face)
1567 ; (setq in-face nil))
1568 ; (setq in-face (point)))
1570 ; (goto-char (point-min))
1571 ; (setq in-face (if (get-text-property (point) 'c-in-sws)
1574 ; (goto-char (next-single-property-change
1575 ; (point) 'c-in-sws nil (point-max)))
1578 ; (c-debug-add-face in-face (point) 'c-debug-in-sws-face)
1579 ; (setq in-face nil))
1580 ; (setq in-face (point)))
1583 (defmacro c-debug-sws-msg
(&rest args
)
1587 (defmacro c-put-is-sws
(beg end
)
1588 ;; This macro does a hidden buffer change.
1589 `(let ((beg ,beg
) (end ,end
))
1590 (put-text-property beg end
'c-is-sws t
)
1591 ,@(when (facep 'c-debug-is-sws-face
)
1592 `((c-debug-add-face beg end
'c-debug-is-sws-face
)))))
1594 (defmacro c-put-in-sws
(beg end
)
1595 ;; This macro does a hidden buffer change.
1596 `(let ((beg ,beg
) (end ,end
))
1597 (put-text-property beg end
'c-in-sws t
)
1598 ,@(when (facep 'c-debug-is-sws-face
)
1599 `((c-debug-add-face beg end
'c-debug-in-sws-face
)))))
1601 (defmacro c-remove-is-sws
(beg end
)
1602 ;; This macro does a hidden buffer change.
1603 `(let ((beg ,beg
) (end ,end
))
1604 (remove-text-properties beg end
'(c-is-sws nil
))
1605 ,@(when (facep 'c-debug-is-sws-face
)
1606 `((c-debug-remove-face beg end
'c-debug-is-sws-face
)))))
1608 (defmacro c-remove-in-sws
(beg end
)
1609 ;; This macro does a hidden buffer change.
1610 `(let ((beg ,beg
) (end ,end
))
1611 (remove-text-properties beg end
'(c-in-sws nil
))
1612 ,@(when (facep 'c-debug-is-sws-face
)
1613 `((c-debug-remove-face beg end
'c-debug-in-sws-face
)))))
1615 (defmacro c-remove-is-and-in-sws
(beg end
)
1616 ;; This macro does a hidden buffer change.
1617 `(let ((beg ,beg
) (end ,end
))
1618 (remove-text-properties beg end
'(c-is-sws nil c-in-sws nil
))
1619 ,@(when (facep 'c-debug-is-sws-face
)
1620 `((c-debug-remove-face beg end
'c-debug-is-sws-face
)
1621 (c-debug-remove-face beg end
'c-debug-in-sws-face
)))))
1623 (defsubst c-invalidate-sws-region-after
(beg end
)
1624 ;; Called from `after-change-functions'. Note that if
1625 ;; `c-forward-sws' or `c-backward-sws' are used outside
1626 ;; `c-save-buffer-state' or similar then this will remove the cache
1627 ;; properties right after they're added.
1629 ;; This function does hidden buffer changes.
1632 ;; Adjust the end to remove the properties in any following simple
1633 ;; ws up to and including the next line break, if there is any
1634 ;; after the changed region. This is necessary e.g. when a rung
1635 ;; marked empty line is converted to a line comment by inserting
1636 ;; "//" before the line break. In that case the line break would
1637 ;; keep the rung mark which could make a later `c-backward-sws'
1638 ;; move into the line comment instead of over it.
1640 (skip-chars-forward " \t\f\v")
1641 (when (and (eolp) (not (eobp)))
1642 (setq end
(1+ (point)))))
1644 (when (and (= beg end
)
1645 (get-text-property beg
'c-in-sws
)
1647 (get-text-property (1- beg
) 'c-in-sws
))
1648 ;; Ensure that an `c-in-sws' range gets broken. Note that it isn't
1649 ;; safe to keep a range that was continuous before the change. E.g:
1655 ;; There can be a "ladder" between "#" and "b". Now, if the newline
1656 ;; after "foo" is removed then "bar" will become part of the cpp
1657 ;; directive instead of a syntactically relevant token. In that
1658 ;; case there's no longer syntactic ws from "#" to "b".
1659 (setq beg
(1- beg
)))
1661 (c-debug-sws-msg "c-invalidate-sws-region-after [%s..%s]" beg end
)
1662 (c-remove-is-and-in-sws beg end
))
1664 (defun c-forward-sws ()
1665 ;; Used by `c-forward-syntactic-ws' to implement the unbounded search.
1667 ;; This function might do hidden buffer changes.
1669 (let (;; `rung-pos' is set to a position as early as possible in the
1670 ;; unmarked part of the simple ws region.
1671 (rung-pos (point)) next-rung-pos rung-end-pos last-put-in-sws-pos
1672 rung-is-marked next-rung-is-marked simple-ws-end
1673 ;; `safe-start' is set when it's safe to cache the start position.
1674 ;; It's not set if we've initially skipped over comments and line
1675 ;; continuations since we might have gone out through the end of a
1676 ;; macro then. This provision makes `c-forward-sws' not populate the
1677 ;; cache in the majority of cases, but otoh is `c-backward-sws' by far
1681 ;; Skip simple ws and do a quick check on the following character to see
1682 ;; if it's anything that can't start syntactic ws, so we can bail out
1683 ;; early in the majority of cases when there just are a few ws chars.
1684 (skip-chars-forward " \t\n\r\f\v")
1685 (when (looking-at c-syntactic-ws-start
)
1687 (setq rung-end-pos
(min (1+ (point)) (point-max)))
1688 (if (setq rung-is-marked
(text-property-any rung-pos rung-end-pos
1690 ;; Find the last rung position to avoid setting properties in all
1691 ;; the cases when the marked rung is complete.
1692 ;; (`next-single-property-change' is certain to move at least one
1694 (setq rung-pos
(1- (next-single-property-change
1695 rung-is-marked
'c-is-sws nil rung-end-pos
)))
1696 ;; Got no marked rung here. Since the simple ws might have started
1697 ;; inside a line comment or cpp directive we must set `rung-pos' as
1698 ;; high as possible.
1699 (setq rung-pos
(point)))
1701 (with-silent-modifications
1705 (when (and rung-is-marked
1706 (get-text-property (point) 'c-in-sws
))
1708 ;; The following search is the main reason that `c-in-sws'
1709 ;; and `c-is-sws' aren't combined to one property.
1710 (goto-char (next-single-property-change
1711 (point) 'c-in-sws nil
(point-max)))
1712 (unless (get-text-property (point) 'c-is-sws
)
1713 ;; If the `c-in-sws' region extended past the last
1714 ;; `c-is-sws' char we have to go back a bit.
1715 (or (get-text-property (1- (point)) 'c-is-sws
)
1716 (goto-char (previous-single-property-change
1717 (point) 'c-is-sws
)))
1721 "c-forward-sws cached move %s -> %s (max %s)"
1722 rung-pos
(point) (point-max))
1724 (setq rung-pos
(point))
1725 (and (> (skip-chars-forward " \t\n\r\f\v") 0)
1728 ;; We'll loop here if there is simple ws after the last rung.
1729 ;; That means that there's been some change in it and it's
1730 ;; possible that we've stepped into another ladder, so extend
1731 ;; the previous one to join with it if there is one, and try to
1732 ;; use the cache again.
1734 "c-forward-sws extending rung with [%s..%s] (max %s)"
1735 (1+ rung-pos
) (1+ (point)) (point-max))
1736 (unless (get-text-property (point) 'c-is-sws
)
1737 ;; Remove any `c-in-sws' property from the last char of
1738 ;; the rung before we mark it with `c-is-sws', so that we
1739 ;; won't connect with the remains of a broken "ladder".
1740 (c-remove-in-sws (point) (1+ (point))))
1741 (c-put-is-sws (1+ rung-pos
)
1743 (c-put-in-sws rung-pos
1744 (setq rung-pos
(point)
1745 last-put-in-sws-pos rung-pos
)))
1747 (setq simple-ws-end
(point))
1748 (c-forward-comments)
1751 ((/= (point) simple-ws-end
)
1752 ;; Skipped over comments. Don't cache at eob in case the buffer
1757 (and c-opt-cpp-prefix
1758 (looking-at c-opt-cpp-start
)
1759 (progn (skip-chars-backward " \t")
1762 (progn (backward-char)
1763 (not (eq (char-before) ?
\\))))))
1764 ;; Skip a preprocessor directive.
1766 (while (and (eq (char-before) ?
\\)
1767 (= (forward-line 1) 0))
1771 ;; Don't cache at eob in case the buffer is narrowed.
1774 ;; We've searched over a piece of non-white syntactic ws. See if this
1776 (setq next-rung-pos
(point))
1777 (skip-chars-forward " \t\n\r\f\v")
1778 (setq rung-end-pos
(min (1+ (point)) (point-max)))
1781 ;; Cache if we haven't skipped comments only, and if we started
1782 ;; either from a marked rung or from a completely uncached
1786 (not (get-text-property simple-ws-end
'c-in-sws
))))
1788 ;; See if there's a marked rung in the encountered simple ws. If
1789 ;; so then we can cache, unless `safe-start' is nil. Even then
1790 ;; we need to do this to check if the cache can be used for the
1792 (and (setq next-rung-is-marked
1793 (text-property-any next-rung-pos rung-end-pos
1799 "c-forward-sws caching [%s..%s] - [%s..%s] (max %s)"
1800 rung-pos
(1+ simple-ws-end
) next-rung-pos rung-end-pos
1803 ;; Remove the properties for any nested ws that might be cached.
1804 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
1806 (c-remove-is-sws (1+ simple-ws-end
) next-rung-pos
)
1807 (unless (and rung-is-marked
(= rung-pos simple-ws-end
))
1808 (c-put-is-sws rung-pos
1810 (setq rung-is-marked t
))
1811 (c-put-in-sws rung-pos
1812 (setq rung-pos
(point)
1813 last-put-in-sws-pos rung-pos
))
1814 (unless (get-text-property (1- rung-end-pos
) 'c-is-sws
)
1815 ;; Remove any `c-in-sws' property from the last char of
1816 ;; the rung before we mark it with `c-is-sws', so that we
1817 ;; won't connect with the remains of a broken "ladder".
1818 (c-remove-in-sws (1- rung-end-pos
) rung-end-pos
))
1819 (c-put-is-sws next-rung-pos
1823 "c-forward-sws not caching [%s..%s] - [%s..%s] (max %s)"
1824 rung-pos
(1+ simple-ws-end
) next-rung-pos rung-end-pos
1827 ;; Set `rung-pos' for the next rung. It's the same thing here as
1828 ;; initially, except that the rung position is set as early as
1829 ;; possible since we can't be in the ending ws of a line comment or
1830 ;; cpp directive now.
1831 (if (setq rung-is-marked next-rung-is-marked
)
1832 (setq rung-pos
(1- (next-single-property-change
1833 rung-is-marked
'c-is-sws nil rung-end-pos
)))
1834 (setq rung-pos next-rung-pos
))
1835 (setq safe-start t
)))
1837 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
1838 ;; another one after the point (which might occur when editing inside a
1839 ;; comment or macro).
1840 (when (eq last-put-in-sws-pos
(point))
1841 (cond ((< last-put-in-sws-pos
(point-max))
1843 "c-forward-sws clearing at %s for cache separation"
1844 last-put-in-sws-pos
)
1845 (c-remove-in-sws last-put-in-sws-pos
1846 (1+ last-put-in-sws-pos
)))
1848 ;; If at eob we have to clear the last character before the end
1849 ;; instead since the buffer might be narrowed and there might
1850 ;; be a `c-in-sws' after (point-max). In this case it's
1851 ;; necessary to clear both properties.
1853 "c-forward-sws clearing thoroughly at %s for cache separation"
1854 (1- last-put-in-sws-pos
))
1855 (c-remove-is-and-in-sws (1- last-put-in-sws-pos
)
1856 last-put-in-sws-pos
))))
1859 (defun c-backward-sws ()
1860 ;; Used by `c-backward-syntactic-ws' to implement the unbounded search.
1862 ;; This function might do hidden buffer changes.
1864 (let (;; `rung-pos' is set to a position as late as possible in the unmarked
1865 ;; part of the simple ws region.
1866 (rung-pos (point)) next-rung-pos last-put-in-sws-pos
1867 rung-is-marked simple-ws-beg cmt-skip-pos
)
1869 ;; Skip simple horizontal ws and do a quick check on the preceding
1870 ;; character to see if it's anything that can't end syntactic ws, so we can
1871 ;; bail out early in the majority of cases when there just are a few ws
1872 ;; chars. Newlines are complicated in the backward direction, so we can't
1874 (skip-chars-backward " \t\f")
1875 (when (and (not (bobp))
1878 (looking-at c-syntactic-ws-end
)))
1880 ;; Try to find a rung position in the simple ws preceding point, so that
1881 ;; we can get a cache hit even if the last bit of the simple ws has
1882 ;; changed recently.
1883 (setq simple-ws-beg
(point))
1884 (skip-chars-backward " \t\n\r\f\v")
1885 (if (setq rung-is-marked
(text-property-any
1886 (point) (min (1+ rung-pos
) (point-max))
1888 ;; `rung-pos' will be the earliest marked position, which means that
1889 ;; there might be later unmarked parts in the simple ws region.
1890 ;; It's not worth the effort to fix that; the last part of the
1891 ;; simple ws is also typically edited often, so it could be wasted.
1892 (goto-char (setq rung-pos rung-is-marked
))
1893 (goto-char simple-ws-beg
))
1895 (with-silent-modifications
1899 (when (and rung-is-marked
1901 (get-text-property (1- (point)) 'c-in-sws
))
1903 ;; The following search is the main reason that `c-in-sws'
1904 ;; and `c-is-sws' aren't combined to one property.
1905 (goto-char (previous-single-property-change
1906 (point) 'c-in-sws nil
(point-min)))
1907 (unless (get-text-property (point) 'c-is-sws
)
1908 ;; If the `c-in-sws' region extended past the first
1909 ;; `c-is-sws' char we have to go forward a bit.
1910 (goto-char (next-single-property-change
1911 (point) 'c-is-sws
)))
1914 "c-backward-sws cached move %s <- %s (min %s)"
1915 (point) rung-pos
(point-min))
1917 (setq rung-pos
(point))
1918 (if (and (< (min (skip-chars-backward " \t\f\v")
1920 (setq simple-ws-beg
(point))
1921 (skip-chars-backward " \t\n\r\f\v")))
1923 (setq rung-is-marked
1924 (text-property-any (point) rung-pos
1927 (goto-char simple-ws-beg
)
1930 ;; We'll loop here if there is simple ws before the first rung.
1931 ;; That means that there's been some change in it and it's
1932 ;; possible that we've stepped into another ladder, so extend
1933 ;; the previous one to join with it if there is one, and try to
1934 ;; use the cache again.
1936 "c-backward-sws extending rung with [%s..%s] (min %s)"
1937 rung-is-marked rung-pos
(point-min))
1938 (unless (get-text-property (1- rung-pos
) 'c-is-sws
)
1939 ;; Remove any `c-in-sws' property from the last char of
1940 ;; the rung before we mark it with `c-is-sws', so that we
1941 ;; won't connect with the remains of a broken "ladder".
1942 (c-remove-in-sws (1- rung-pos
) rung-pos
))
1943 (c-put-is-sws rung-is-marked
1945 (c-put-in-sws rung-is-marked
1947 (setq rung-pos rung-is-marked
1948 last-put-in-sws-pos rung-pos
))
1950 (c-backward-comments)
1951 (setq cmt-skip-pos
(point))
1954 ((and c-opt-cpp-prefix
1955 (/= cmt-skip-pos simple-ws-beg
)
1956 (c-beginning-of-macro))
1957 ;; Inside a cpp directive. See if it should be skipped over.
1958 (let ((cpp-beg (point)))
1960 ;; Move back over all line continuations in the region skipped
1961 ;; over by `c-backward-comments'. If we go past it then we
1962 ;; started inside the cpp directive.
1963 (goto-char simple-ws-beg
)
1965 (while (and (> (point) cmt-skip-pos
)
1966 (progn (backward-char)
1967 (eq (char-before) ?
\\)))
1968 (beginning-of-line))
1970 (if (< (point) cmt-skip-pos
)
1971 ;; Don't move past the cpp directive if we began inside
1972 ;; it. Note that the position at the end of the last line
1973 ;; of the macro is also considered to be within it.
1974 (progn (goto-char cmt-skip-pos
)
1977 ;; It's worthwhile to spend a little bit of effort on finding
1978 ;; the end of the macro, to get a good `simple-ws-beg'
1979 ;; position for the cache. Note that `c-backward-comments'
1980 ;; could have stepped over some comments before going into
1981 ;; the macro, and then `simple-ws-beg' must be kept on the
1982 ;; same side of those comments.
1983 (goto-char simple-ws-beg
)
1984 (skip-chars-backward " \t\n\r\f\v")
1985 (if (eq (char-before) ?
\\)
1988 (if (< (point) simple-ws-beg
)
1989 ;; Might happen if comments after the macro were skipped
1991 (setq simple-ws-beg
(point)))
1996 ((/= (save-excursion
1997 (skip-chars-forward " \t\n\r\f\v" simple-ws-beg
)
1998 (setq next-rung-pos
(point)))
2000 ;; Skipped over comments. Must put point at the end of
2001 ;; the simple ws at point since we might be after a line
2002 ;; comment or cpp directive that's been partially
2003 ;; narrowed out, and we can't risk marking the simple ws
2004 ;; at the end of it.
2005 (goto-char next-rung-pos
)
2008 ;; We've searched over a piece of non-white syntactic ws. See if this
2010 (setq next-rung-pos
(point))
2011 (skip-chars-backward " \t\f\v")
2014 ;; Cache if we started either from a marked rung or from a
2015 ;; completely uncached position.
2017 (not (get-text-property (1- simple-ws-beg
) 'c-in-sws
))
2019 ;; Cache if there's a marked rung in the encountered simple ws.
2021 (skip-chars-backward " \t\n\r\f\v")
2022 (text-property-any (point) (min (1+ next-rung-pos
) (point-max))
2027 "c-backward-sws caching [%s..%s] - [%s..%s] (min %s)"
2028 (point) (1+ next-rung-pos
)
2029 simple-ws-beg
(min (1+ rung-pos
) (point-max))
2032 ;; Remove the properties for any nested ws that might be cached.
2033 ;; Only necessary for `c-is-sws' since `c-in-sws' will be set
2035 (c-remove-is-sws (1+ next-rung-pos
) simple-ws-beg
)
2036 (unless (and rung-is-marked
(= simple-ws-beg rung-pos
))
2037 (let ((rung-end-pos (min (1+ rung-pos
) (point-max))))
2038 (unless (get-text-property (1- rung-end-pos
) 'c-is-sws
)
2039 ;; Remove any `c-in-sws' property from the last char of
2040 ;; the rung before we mark it with `c-is-sws', so that we
2041 ;; won't connect with the remains of a broken "ladder".
2042 (c-remove-in-sws (1- rung-end-pos
) rung-end-pos
))
2043 (c-put-is-sws simple-ws-beg
2045 (setq rung-is-marked t
)))
2046 (c-put-in-sws (setq simple-ws-beg
(point)
2047 last-put-in-sws-pos simple-ws-beg
)
2049 (c-put-is-sws (setq rung-pos simple-ws-beg
)
2050 (1+ next-rung-pos
)))
2053 "c-backward-sws not caching [%s..%s] - [%s..%s] (min %s)"
2054 (point) (1+ next-rung-pos
)
2055 simple-ws-beg
(min (1+ rung-pos
) (point-max))
2057 (setq rung-pos next-rung-pos
2058 simple-ws-beg
(point))
2061 ;; Make sure that the newly marked `c-in-sws' region doesn't connect to
2062 ;; another one before the point (which might occur when editing inside a
2063 ;; comment or macro).
2064 (when (eq last-put-in-sws-pos
(point))
2065 (cond ((< (point-min) last-put-in-sws-pos
)
2067 "c-backward-sws clearing at %s for cache separation"
2068 (1- last-put-in-sws-pos
))
2069 (c-remove-in-sws (1- last-put-in-sws-pos
)
2070 last-put-in-sws-pos
))
2072 ;; If at bob and the buffer is narrowed, we have to clear the
2073 ;; character we're standing on instead since there might be a
2074 ;; `c-in-sws' before (point-min). In this case it's necessary
2075 ;; to clear both properties.
2077 "c-backward-sws clearing thoroughly at %s for cache separation"
2078 last-put-in-sws-pos
)
2079 (c-remove-is-and-in-sws last-put-in-sws-pos
2080 (1+ last-put-in-sws-pos
)))))
2084 ;; Other whitespace tools
2085 (defun c-partial-ws-p (beg end
)
2086 ;; Is the region (beg end) WS, and is there WS (or BOB/EOB) next to the
2087 ;; region? This is a "heuristic" function. .....
2089 ;; The motivation for the second bit is to check whether removing this
2090 ;; region would coalesce two symbols.
2092 ;; FIXME!!! This function doesn't check virtual semicolons in any way. Be
2093 ;; careful about using this function for, e.g. AWK. (2007/3/7)
2095 (let ((end+1 (min (1+ end
) (point-max))))
2096 (or (progn (goto-char (max (point-min) (1- beg
)))
2097 (c-skip-ws-forward end
)
2099 (progn (goto-char beg
)
2100 (c-skip-ws-forward end
+1)
2101 (eq (point) end
+1))))))
2103 ;; A system for finding noteworthy parens before the point.
2105 (defconst c-state-cache-too-far
5000)
2106 ;; A maximum comfortable scanning distance, e.g. between
2107 ;; `c-state-cache-good-pos' and "HERE" (where we call c-parse-state). When
2108 ;; this distance is exceeded, we take "emergency measures", e.g. by clearing
2109 ;; the cache and starting again from point-min or a beginning of defun. This
2110 ;; value can be tuned for efficiency or set to a lower value for testing.
2112 (defvar c-state-cache nil
)
2113 (make-variable-buffer-local 'c-state-cache
)
2114 ;; The state cache used by `c-parse-state' to cut down the amount of
2115 ;; searching. It's the result from some earlier `c-parse-state' call. See
2116 ;; `c-parse-state''s doc string for details of its structure.
2118 ;; The use of the cached info is more effective if the next
2119 ;; `c-parse-state' call is on a line close by the one the cached state
2120 ;; was made at; the cache can actually slow down a little if the
2121 ;; cached state was made very far back in the buffer. The cache is
2122 ;; most effective if `c-parse-state' is used on each line while moving
2125 (defvar c-state-cache-good-pos
1)
2126 (make-variable-buffer-local 'c-state-cache-good-pos
)
2127 ;; This is a position where `c-state-cache' is known to be correct, or
2128 ;; nil (see below). It's a position inside one of the recorded unclosed
2129 ;; parens or the top level, but not further nested inside any literal or
2130 ;; subparen that is closed before the last recorded position.
2132 ;; The exact position is chosen to try to be close to yet earlier than
2133 ;; the position where `c-state-cache' will be called next. Right now
2134 ;; the heuristic is to set it to the position after the last found
2135 ;; closing paren (of any type) before the line on which
2136 ;; `c-parse-state' was called. That is chosen primarily to work well
2137 ;; with refontification of the current line.
2139 ;; 2009-07-28: When `c-state-point-min' and the last position where
2140 ;; `c-parse-state' or for which `c-invalidate-state-cache' was called, are
2141 ;; both in the same literal, there is no such "good position", and
2142 ;; c-state-cache-good-pos is then nil. This is the ONLY circumstance in which
2143 ;; it can be nil. In this case, `c-state-point-min-literal' will be non-nil.
2145 ;; 2009-06-12: In a brace desert, c-state-cache-good-pos may also be in
2146 ;; the middle of the desert, as long as it is not within a brace pair
2147 ;; recorded in `c-state-cache' or a paren/bracket pair.
2150 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2151 ;; We maintain a simple cache of positions which aren't in a literal, so as to
2152 ;; speed up testing for non-literality.
2153 (defconst c-state-nonlit-pos-interval
3000)
2154 ;; The approximate interval between entries in `c-state-nonlit-pos-cache'.
2156 (defvar c-state-nonlit-pos-cache nil
)
2157 (make-variable-buffer-local 'c-state-nonlit-pos-cache
)
2158 ;; A list of buffer positions which are known not to be in a literal or a cpp
2159 ;; construct. This is ordered with higher positions at the front of the list.
2160 ;; Only those which are less than `c-state-nonlit-pos-cache-limit' are valid.
2162 (defvar c-state-nonlit-pos-cache-limit
1)
2163 (make-variable-buffer-local 'c-state-nonlit-pos-cache-limit
)
2164 ;; An upper limit on valid entries in `c-state-nonlit-pos-cache'. This is
2165 ;; reduced by buffer changes, and increased by invocations of
2166 ;; `c-state-literal-at'.
2168 (defvar c-state-semi-nonlit-pos-cache nil
)
2169 (make-variable-buffer-local 'c-state-semi-nonlit-pos-cache
)
2170 ;; A list of buffer positions which are known not to be in a literal. This is
2171 ;; ordered with higher positions at the front of the list. Only those which
2172 ;; are less than `c-state-semi-nonlit-pos-cache-limit' are valid.
2174 (defvar c-state-semi-nonlit-pos-cache-limit
1)
2175 (make-variable-buffer-local 'c-state-semi-nonlit-pos-cache-limit
)
2176 ;; An upper limit on valid entries in `c-state-semi-nonlit-pos-cache'. This is
2177 ;; reduced by buffer changes, and increased by invocations of
2178 ;; `c-state-literal-at'. FIXME!!!
2180 (defsubst c-state-pp-to-literal
(from to
&optional not-in-delimiter
)
2181 ;; Do a parse-partial-sexp from FROM to TO, returning either
2182 ;; (STATE TYPE (BEG . END)) if TO is in a literal; or
2183 ;; (STATE) otherwise,
2184 ;; where STATE is the parsing state at TO, TYPE is the type of the literal
2185 ;; (one of 'c, 'c++, 'string) and (BEG . END) is the boundaries of the literal.
2187 ;; Unless NOT-IN-DELIMITER is non-nil, when TO is inside a two-character
2188 ;; comment opener, this is recognized as being in a comment literal.
2190 ;; Only elements 3 (in a string), 4 (in a comment), 5 (following a quote),
2191 ;; 7 (comment type) and 8 (start of comment/string) (and possibly 9) of
2194 (let ((s (parse-partial-sexp from to
))
2197 ((or (nth 3 s
) (nth 4 s
)) ; in a string or comment
2202 (parse-partial-sexp (point) (point-max)
2206 'syntax-table
) ; stop at end of literal
2207 `(,s
,ty
(,(nth 8 s
) .
,(point))))
2209 ((and (not not-in-delimiter
) ; inside a comment starter
2211 (progn (backward-char)
2212 (looking-at c-comment-start-regexp
)))
2213 (setq ty
(if (looking-at c-block-comment-start-regexp
) 'c
'c
++)
2216 `(,s
,ty
(,co-st .
,(point))))
2220 (defun c-state-safe-place (here)
2221 ;; Return a buffer position before HERE which is "safe", i.e. outside any
2222 ;; string, comment, or macro.
2224 ;; NOTE: This function manipulates `c-state-nonlit-pos-cache'. This cache
2225 ;; MAY NOT contain any positions within macros, since macros are frequently
2226 ;; turned into comments by use of the `c-cpp-delimiter' category properties.
2227 ;; We cannot rely on this mechanism whilst determining a cache pos since
2228 ;; this function is also called from outwith `c-parse-state'.
2232 (let ((c c-state-nonlit-pos-cache
)
2233 pos npos high-pos lit macro-beg macro-end
)
2234 ;; Trim the cache to take account of buffer changes.
2235 (while (and c
(> (car c
) c-state-nonlit-pos-cache-limit
))
2237 (setq c-state-nonlit-pos-cache c
)
2239 (while (and c
(> (car c
) here
))
2240 (setq high-pos
(car c
))
2242 (setq pos
(or (car c
) (point-min)))
2246 ;; Add an element to `c-state-nonlit-pos-cache' each iteration.
2248 (<= (setq npos
(+ pos c-state-nonlit-pos-interval
)) here
)
2250 ;; Test for being in a literal. If so, go to after it.
2252 (setq lit
(car (cddr (c-state-pp-to-literal pos npos
))))
2254 (prog1 (<= (cdr lit
) here
)
2255 (setq npos
(cdr lit
)))))
2257 ;; Test for being in a macro. If so, go to after it.
2261 (and (c-beginning-of-macro) (/= (point) npos
) (point)))
2263 (c-syntactic-end-of-macro)
2264 (or (eobp) (forward-char))
2265 (setq macro-end
(point)))
2266 (or (null macro-beg
)
2267 (prog1 (<= macro-end here
)
2268 (setq npos macro-end
)))))
2271 (setq c-state-nonlit-pos-cache
(cons pos c-state-nonlit-pos-cache
)))
2272 ;; Add one extra element above HERE so as to to avoid the previous
2273 ;; expensive calculation when the next call is close to the current
2274 ;; one. This is especially useful when inside a large macro.
2275 (setq c-state-nonlit-pos-cache
(cons npos c-state-nonlit-pos-cache
)))
2277 (if (> pos c-state-nonlit-pos-cache-limit
)
2278 (setq c-state-nonlit-pos-cache-limit pos
))
2281 (defun c-state-semi-safe-place (here)
2282 ;; Return a buffer position before HERE which is "safe", i.e. outside any
2283 ;; string or comment. It may be in a macro.
2287 (let ((c c-state-semi-nonlit-pos-cache
)
2288 pos npos high-pos lit macro-beg macro-end
)
2289 ;; Trim the cache to take account of buffer changes.
2290 (while (and c
(> (car c
) c-state-semi-nonlit-pos-cache-limit
))
2292 (setq c-state-semi-nonlit-pos-cache c
)
2294 (while (and c
(> (car c
) here
))
2295 (setq high-pos
(car c
))
2297 (setq pos
(or (car c
) (point-min)))
2301 ;; Add an element to `c-state-semi-nonlit-pos-cache' each iteration.
2303 (<= (setq npos
(+ pos c-state-nonlit-pos-interval
)) here
)
2305 ;; Test for being in a literal. If so, go to after it.
2307 (setq lit
(car (cddr (c-state-pp-to-literal pos npos
))))
2309 (prog1 (<= (cdr lit
) here
)
2310 (setq npos
(cdr lit
))))))
2313 (setq c-state-semi-nonlit-pos-cache
2314 (cons pos c-state-semi-nonlit-pos-cache
))))
2316 (if (> pos c-state-semi-nonlit-pos-cache-limit
)
2317 (setq c-state-semi-nonlit-pos-cache-limit pos
))
2320 (defun c-state-literal-at (here)
2321 ;; If position HERE is inside a literal, return (START . END), the
2322 ;; boundaries of the literal (which may be outside the accessible bit of the
2323 ;; buffer). Otherwise, return nil.
2325 ;; This function is almost the same as `c-literal-limits'. Previously, it
2326 ;; differed in that it was a lower level function, and that it rigorously
2327 ;; followed the syntax from BOB. `c-literal-limits' is now (2011-12)
2328 ;; virtually identical to this function.
2332 (let ((pos (c-state-safe-place here
)))
2333 (car (cddr (c-state-pp-to-literal pos here
)))))))
2335 (defsubst c-state-lit-beg
(pos)
2336 ;; Return the start of the literal containing POS, or POS itself.
2337 (or (car (c-state-literal-at pos
))
2340 (defsubst c-state-cache-non-literal-place
(pos state
)
2341 ;; Return a position outside of a string/comment/macro at or before POS.
2342 ;; STATE is the parse-partial-sexp state at POS.
2343 (let ((res (if (or (nth 3 state
) ; in a string?
2344 (nth 4 state
)) ; in a comment?
2349 (if (c-beginning-of-macro)
2353 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2354 ;; Stuff to do with point-min, and coping with any literal there.
2355 (defvar c-state-point-min
1)
2356 (make-variable-buffer-local 'c-state-point-min
)
2357 ;; This is (point-min) when `c-state-cache' was last calculated. A change of
2358 ;; narrowing is likely to affect the parens that are visible before the point.
2360 (defvar c-state-point-min-lit-type nil
)
2361 (make-variable-buffer-local 'c-state-point-min-lit-type
)
2362 (defvar c-state-point-min-lit-start nil
)
2363 (make-variable-buffer-local 'c-state-point-min-lit-start
)
2364 ;; These two variables define the literal, if any, containing point-min.
2365 ;; Their values are, respectively, 'string, c, or c++, and the start of the
2366 ;; literal. If there's no literal there, they're both nil.
2368 (defvar c-state-min-scan-pos
1)
2369 (make-variable-buffer-local 'c-state-min-scan-pos
)
2370 ;; This is the earliest buffer-pos from which scanning can be done. It is
2371 ;; either the end of the literal containing point-min, or point-min itself.
2372 ;; It becomes nil if the buffer is changed earlier than this point.
2373 (defun c-state-get-min-scan-pos ()
2374 ;; Return the lowest valid scanning pos. This will be the end of the
2375 ;; literal enclosing point-min, or point-min itself.
2376 (or c-state-min-scan-pos
2380 (goto-char c-state-point-min-lit-start
)
2381 (if (eq c-state-point-min-lit-type
'string
)
2383 (forward-comment 1))
2384 (setq c-state-min-scan-pos
(point))))))
2386 (defun c-state-mark-point-min-literal ()
2387 ;; Determine the properties of any literal containing POINT-MIN, setting the
2388 ;; variables `c-state-point-min-lit-type', `c-state-point-min-lit-start',
2389 ;; and `c-state-min-scan-pos' accordingly. The return value is meaningless.
2390 (let ((p-min (point-min))
2394 (setq lit
(c-state-literal-at p-min
))
2396 (setq c-state-point-min-lit-type
2398 (goto-char (car lit
))
2400 ((looking-at c-block-comment-start-regexp
) 'c
)
2401 ((looking-at c-line-comment-starter
) 'c
++)
2403 c-state-point-min-lit-start
(car lit
)
2404 c-state-min-scan-pos
(cdr lit
))
2405 (setq c-state-point-min-lit-type nil
2406 c-state-point-min-lit-start nil
2407 c-state-min-scan-pos p-min
)))))
2410 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2411 ;; A variable which signals a brace dessert - helpful for reducing the number
2412 ;; of fruitless backward scans.
2413 (defvar c-state-brace-pair-desert nil
)
2414 (make-variable-buffer-local 'c-state-brace-pair-desert
)
2415 ;; Used only in `c-append-lower-brace-pair-to-state-cache'. It is set when
2416 ;; that defun has searched backwards for a brace pair and not found one. Its
2417 ;; value is either nil or a cons (PA . FROM), where PA is the position of the
2418 ;; enclosing opening paren/brace/bracket which bounds the backwards search (or
2419 ;; nil when at top level) and FROM is where the backward search started. It
2420 ;; is reset to nil in `c-invalidate-state-cache'.
2423 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2424 ;; Lowish level functions/macros which work directly on `c-state-cache', or a
2425 ;; list of like structure.
2426 (defmacro c-state-cache-top-lparen
(&optional cache
)
2427 ;; Return the address of the top left brace/bracket/paren recorded in CACHE
2428 ;; (default `c-state-cache') (or nil).
2429 (let ((cash (or cache
'c-state-cache
)))
2430 `(if (consp (car ,cash
))
2434 (defmacro c-state-cache-top-paren
(&optional cache
)
2435 ;; Return the address of the latest brace/bracket/paren (whether left or
2436 ;; right) recorded in CACHE (default `c-state-cache') or nil.
2437 (let ((cash (or cache
'c-state-cache
)))
2438 `(if (consp (car ,cash
))
2442 (defmacro c-state-cache-after-top-paren
(&optional cache
)
2443 ;; Return the position just after the latest brace/bracket/paren (whether
2444 ;; left or right) recorded in CACHE (default `c-state-cache') or nil.
2445 (let ((cash (or cache
'c-state-cache
)))
2446 `(if (consp (car ,cash
))
2449 (1+ (car ,cash
))))))
2451 (defun c-get-cache-scan-pos (here)
2452 ;; From the state-cache, determine the buffer position from which we might
2453 ;; scan forward to HERE to update this cache. This position will be just
2454 ;; after a paren/brace/bracket recorded in the cache, if possible, otherwise
2455 ;; return the earliest position in the accessible region which isn't within
2456 ;; a literal. If the visible portion of the buffer is entirely within a
2457 ;; literal, return NIL.
2458 (let ((c c-state-cache
) elt
)
2459 ;(while (>= (or (c-state-cache-top-lparen c) 1) here)
2461 (>= (c-state-cache-top-lparen c
) here
))
2467 (if (> (cdr elt
) here
)
2471 ((<= (c-state-get-min-scan-pos) here
)
2472 (c-state-get-min-scan-pos))
2475 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2476 ;; Variables which keep track of preprocessor constructs.
2477 (defvar c-state-old-cpp-beg-marker nil
)
2478 (make-variable-buffer-local 'c-state-old-cpp-beg-marker
)
2479 (defvar c-state-old-cpp-beg nil
)
2480 (make-variable-buffer-local 'c-state-old-cpp-beg
)
2481 (defvar c-state-old-cpp-end-marker nil
)
2482 (make-variable-buffer-local 'c-state-old-cpp-end-marker
)
2483 (defvar c-state-old-cpp-end nil
)
2484 (make-variable-buffer-local 'c-state-old-cpp-end
)
2485 ;; These are the limits of the macro containing point at the previous call of
2486 ;; `c-parse-state', or nil.
2488 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2489 ;; Defuns which analyze the buffer, yet don't change `c-state-cache'.
2490 (defun c-state-balance-parens-backwards (here- here
+ top
)
2491 ;; Return the position of the opening paren/brace/bracket before HERE- which
2492 ;; matches the outermost close p/b/b between HERE+ and TOP. Except when
2493 ;; there's a macro, HERE- and HERE+ are the same. Like this:
2495 ;; ............................................
2497 ;; ( [ ( .........#macro.. ) ( ) ] )
2500 ;; return HERE- HERE+ TOP
2502 ;; If there aren't enough opening paren/brace/brackets, return the position
2503 ;; of the outermost one found, or HERE- if there are none. If there are no
2504 ;; closing p/b/bs between HERE+ and TOP, return HERE-. HERE-/+ and TOP
2505 ;; must not be inside literals. Only the accessible portion of the buffer
2508 ;; PART 1: scan from `here+' up to `top', accumulating ")"s which enclose
2509 ;; `here'. Go round the next loop each time we pass over such a ")". These
2510 ;; probably match "("s before `here-'.
2511 (let (pos pa ren
+1 lonely-rens
)
2514 (narrow-to-region (point-min) top
) ; This can move point, sometimes.
2518 (setq ren
+1 (scan-lists pos
1 1)) ; might signal
2519 (setq lonely-rens
(cons ren
+1 lonely-rens
)
2522 ;; PART 2: Scan back before `here-' searching for the "("s
2523 ;; matching/mismatching the ")"s found above. We only need to direct the
2524 ;; caller to scan when we've encountered unmatched right parens.
2529 (and lonely-rens
; actual values aren't used.
2530 (setq pa
(scan-lists pos -
1 1)))
2532 (setq lonely-rens
(cdr lonely-rens
)))))
2535 (defun c-parse-state-get-strategy (here good-pos
)
2536 ;; Determine the scanning strategy for adjusting `c-parse-state', attempting
2537 ;; to minimize the amount of scanning. HERE is the pertinent position in
2538 ;; the buffer, GOOD-POS is a position where `c-state-cache' (possibly with
2539 ;; its head trimmed) is known to be good, or nil if there is no such
2542 ;; The return value is a list, one of the following:
2544 ;; o - ('forward START-POINT) - scan forward from START-POINT,
2545 ;; which is not less than the highest position in `c-state-cache' below here.
2546 ;; o - ('backward nil) - scan backwards (from HERE).
2547 ;; o - ('IN-LIT nil) - point is inside the literal containing point-min.
2548 (let ((cache-pos (c-get-cache-scan-pos here
)) ; highest position below HERE in cache (or 1)
2549 strategy
; 'forward, 'backward, or 'IN-LIT.
2551 (setq good-pos
(or good-pos
(c-state-get-min-scan-pos)))
2553 ((< here
(c-state-get-min-scan-pos))
2554 (setq strategy
'IN-LIT
))
2556 (setq strategy
'forward
2557 start-point
(max good-pos cache-pos
)))
2558 ((< (- good-pos here
) (- here cache-pos
)) ; FIXME!!! ; apply some sort of weighting.
2559 (setq strategy
'backward
))
2561 (setq strategy
'forward
2562 start-point cache-pos
)))
2563 (list strategy
(and (eq strategy
'forward
) start-point
))))
2566 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2567 ;; Routines which change `c-state-cache' and associated values.
2568 (defun c-renarrow-state-cache ()
2569 ;; The region (more precisely, point-min) has changed since we
2570 ;; calculated `c-state-cache'. Amend `c-state-cache' accordingly.
2571 (if (< (point-min) c-state-point-min
)
2572 ;; If point-min has MOVED BACKWARDS then we drop the state completely.
2573 ;; It would be possible to do a better job here and recalculate the top
2576 (c-state-mark-point-min-literal)
2577 (setq c-state-cache nil
2578 c-state-cache-good-pos c-state-min-scan-pos
2579 c-state-brace-pair-desert nil
))
2581 ;; point-min has MOVED FORWARD.
2583 ;; Is the new point-min inside a (different) literal?
2584 (unless (and c-state-point-min-lit-start
; at prev. point-min
2585 (< (point-min) (c-state-get-min-scan-pos)))
2586 (c-state-mark-point-min-literal))
2588 ;; Cut off a bit of the tail from `c-state-cache'.
2589 (let ((ptr (cons nil c-state-cache
))
2591 (while (and (setq pa
(c-state-cache-top-lparen (cdr ptr
)))
2592 (>= pa
(point-min)))
2593 (setq ptr
(cdr ptr
)))
2596 (if (eq (cdr ptr
) c-state-cache
)
2597 (setq c-state-cache nil
2598 c-state-cache-good-pos c-state-min-scan-pos
)
2600 (setq c-state-cache-good-pos
(1+ (c-state-cache-top-lparen))))
2603 (setq c-state-point-min
(point-min)))
2605 (defun c-append-lower-brace-pair-to-state-cache (from here
&optional upper-lim
)
2606 ;; If there is a brace pair preceding FROM in the buffer, at the same level
2607 ;; of nesting (not necessarily immediately preceding), push a cons onto
2608 ;; `c-state-cache' to represent it. FROM must not be inside a literal. If
2609 ;; UPPER-LIM is non-nil, we append the highest brace pair whose "}" is below
2612 ;; Return non-nil when this has been done.
2614 ;; The situation it copes with is this transformation:
2616 ;; OLD: { (.) {...........}
2620 ;; NEW: { {....} (.) {.........
2622 ;; LOWER BRACE PAIR HERE or HERE
2624 ;; This routine should be fast. Since it can get called a LOT, we maintain
2625 ;; `c-state-brace-pair-desert', a small cache of "failures", such that we
2626 ;; reduce the time wasted in repeated fruitless searches in brace deserts.
2630 (cache-pos (c-state-cache-top-lparen)) ; might be nil.
2631 (macro-start-or-from
2632 (progn (goto-char from
)
2633 (c-beginning-of-macro)
2635 (bra ; Position of "{".
2636 ;; Don't start scanning in the middle of a CPP construct unless
2637 ;; it contains HERE - these constructs, in Emacs, are "commented
2638 ;; out" with category properties.
2639 (if (eq (c-get-char-property macro-start-or-from
'category
)
2643 ce
) ; Position of "}"
2644 (or upper-lim
(setq upper-lim from
))
2646 ;; If we're essentially repeating a fruitless search, just give up.
2647 (unless (and c-state-brace-pair-desert
2648 (eq cache-pos
(car c-state-brace-pair-desert
))
2649 (or (null (car c-state-brace-pair-desert
))
2650 (> from
(car c-state-brace-pair-desert
)))
2651 (<= from
(cdr c-state-brace-pair-desert
)))
2652 ;; DESERT-LIM. Avoid repeated searching through the cached desert.
2654 (and c-state-brace-pair-desert
2655 (eq cache-pos
(car c-state-brace-pair-desert
))
2656 (>= from
(cdr c-state-brace-pair-desert
))
2657 (cdr c-state-brace-pair-desert
)))
2658 ;; CACHE-LIM. This limit will be necessary when an opening
2659 ;; paren at `cache-pos' has just had its matching close paren
2660 ;; inserted into the buffer. `cache-pos' continues to be a
2661 ;; search bound, even though the algorithm below would skip
2662 ;; over the new paren pair.
2663 (cache-lim (and cache-pos
(< cache-pos from
) cache-pos
)))
2666 ((and desert-lim cache-lim
)
2667 (max desert-lim cache-lim
))
2671 ;; The top limit is EOB to ensure that `bra' is inside the
2672 ;; accessible part of the buffer at the next scan operation.
2673 (1+ (buffer-size))))
2675 ;; In the next pair of nested loops, the inner one moves back past a
2676 ;; pair of (mis-)matching parens or brackets; the outer one moves
2677 ;; back over a sequence of unmatched close brace/paren/bracket each
2683 (and (setq ce
(scan-lists bra -
1 -
1)) ; back past )/]/}; might signal
2684 (setq bra
(scan-lists ce -
1 1)) ; back past (/[/{; might signal
2685 (or (> bra here
) ;(> ce here)
2688 (or (not (eq (char-after bra
) ?\
{))
2689 (and (goto-char bra
)
2690 (c-beginning-of-macro)
2691 (< (point) macro-start-or-from
))))))))
2692 (and ce
(< ce bra
)))
2693 (setq bra ce
)) ; If we just backed over an unbalanced closing
2696 (if (and ce
(< ce here
) (< bra ce
) (eq (char-after bra
) ?\
{))
2697 ;; We've found the desired brace-pair.
2699 (setq new-cons
(cons bra
(1+ ce
)))
2701 ((consp (car c-state-cache
))
2702 (setcar c-state-cache new-cons
))
2703 ((and (numberp (car c-state-cache
)) ; probably never happens
2704 (< ce
(car c-state-cache
)))
2705 (setcdr c-state-cache
2706 (cons new-cons
(cdr c-state-cache
))))
2707 (t (setq c-state-cache
(cons new-cons c-state-cache
)))))
2709 ;; We haven't found a brace pair. Record this in the cache.
2710 (setq c-state-brace-pair-desert
2711 (cons (if (and ce
(< bra ce
) (> ce here
)) ; {..} straddling HERE?
2714 (min here from
)))))))))
2716 (defsubst c-state-push-any-brace-pair
(bra+1 macro-start-or-here
)
2717 ;; If BRA+1 is nil, do nothing. Otherwise, BRA+1 is the buffer position
2718 ;; following a {, and that brace has a (mis-)matching } (or ]), and we
2719 ;; "push" "a" brace pair onto `c-state-cache'.
2721 ;; Here "push" means overwrite the top element if it's itself a brace-pair,
2722 ;; otherwise push it normally.
2724 ;; The brace pair we push is normally the one surrounding BRA+1, but if the
2725 ;; latter is inside a macro, not being a macro containing
2726 ;; MACRO-START-OR-HERE, we scan backwards through the buffer for a non-macro
2727 ;; base pair. This latter case is assumed to be rare.
2729 ;; Note: POINT is not preserved in this routine.
2731 (if (or (> bra
+1 macro-start-or-here
)
2732 (progn (goto-char bra
+1)
2733 (not (c-beginning-of-macro))))
2735 (cons (cons (1- bra
+1)
2736 (scan-lists bra
+1 1 1))
2737 (if (consp (car c-state-cache
))
2740 ;; N.B. This defsubst codes one method for the simple, normal case,
2741 ;; and a more sophisticated, slower way for the general case. Don't
2742 ;; eliminate this defsubst - it's a speed optimization.
2743 (c-append-lower-brace-pair-to-state-cache (1- bra
+1) (point-max)))))
2745 (defun c-append-to-state-cache (from here
)
2746 ;; Scan the buffer from FROM to HERE, adding elements into `c-state-cache'
2747 ;; for braces etc. Return a candidate for `c-state-cache-good-pos'.
2749 ;; FROM must be after the latest brace/paren/bracket in `c-state-cache', if
2750 ;; any. Typically, it is immediately after it. It must not be inside a
2752 (let ((here-bol (c-point 'bol here
))
2753 (macro-start-or-here
2754 (save-excursion (goto-char here
)
2755 (if (c-beginning-of-macro)
2758 pa
+1 ; pos just after an opening PAren (or brace).
2759 (ren+1 from
) ; usually a pos just after an closing paREN etc.
2760 ; Is actually the pos. to scan for a (/{/[ from,
2761 ; which sometimes is after a silly )/}/].
2762 paren
+1 ; Pos after some opening or closing paren.
2763 paren
+1s
; A list of `paren+1's; used to determine a
2765 bra
+1 ce
+1 ; just after L/R bra-ces.
2766 bra
+1s
; list of OLD values of bra+1.
2767 mstart
) ; start of a macro.
2771 (narrow-to-region (point-min) here
)
2772 ;; Each time round the following loop, we enter a successively deeper
2773 ;; level of brace/paren nesting. (Except sometimes we "continue at
2774 ;; the existing level".) `pa+1' is a pos inside an opening
2775 ;; brace/paren/bracket, usually just after it.
2778 ;; Each time round the next loop moves forward over an opening then
2779 ;; a closing brace/bracket/paren. This loop is white hot, so it
2780 ;; plays ugly tricks to go fast. DON'T PUT ANYTHING INTO THIS
2781 ;; LOOP WHICH ISN'T ABSOLUTELY NECESSARY!!! It terminates when a
2782 ;; call of `scan-lists' signals an error, which happens when there
2783 ;; are no more b/b/p's to scan.
2786 (setq pa
+1 (scan-lists ren
+1 1 -
1) ; Into (/{/[; might signal
2787 paren
+1s
(cons pa
+1 paren
+1s
))
2788 (setq ren
+1 (scan-lists pa
+1 1 1)) ; Out of )/}/]; might signal
2789 (if (and (eq (char-before pa
+1) ?
{)) ; Check for a macro later.
2791 (setcar paren
+1s ren
+1)))
2793 (if (and pa
+1 (> pa
+1 ren
+1))
2794 ;; We've just entered a deeper nesting level.
2796 ;; Insert the brace pair (if present) and the single open
2797 ;; paren/brace/bracket into `c-state-cache' It cannot be
2798 ;; inside a macro, except one around point, because of what
2799 ;; `c-neutralize-syntax-in-CPP' has done.
2800 (c-state-push-any-brace-pair bra
+1 macro-start-or-here
)
2801 ;; Insert the opening brace/bracket/paren position.
2802 (setq c-state-cache
(cons (1- pa
+1) c-state-cache
))
2803 ;; Clear admin stuff for the next more nested part of the scan.
2804 (setq ren
+1 pa
+1 pa
+1 nil bra
+1 nil bra
+1s nil
)
2805 t
) ; Carry on the loop
2807 ;; All open p/b/b's at this nesting level, if any, have probably
2808 ;; been closed by matching/mismatching ones. We're probably
2809 ;; finished - we just need to check for having found an
2810 ;; unmatched )/}/], which we ignore. Such a )/}/] can't be in a
2811 ;; macro, due the action of `c-neutralize-syntax-in-CPP'.
2812 (c-safe (setq ren
+1 (scan-lists ren
+1 1 1)))))) ; acts as loop control.
2814 ;; Record the final, innermost, brace-pair if there is one.
2815 (c-state-push-any-brace-pair bra
+1 macro-start-or-here
)
2817 ;; Determine a good pos
2818 (while (and (setq paren
+1 (car paren
+1s
))
2819 (> (if (> paren
+1 macro-start-or-here
)
2822 (setq mstart
(and (c-beginning-of-macro)
2824 (or mstart paren
+1))
2826 (setq paren
+1s
(cdr paren
+1s
)))
2828 ((and paren
+1 mstart
)
2829 (min paren
+1 mstart
))
2833 (defun c-remove-stale-state-cache (start-point here pps-point
)
2834 ;; Remove stale entries from the `c-cache-state', i.e. those which will
2835 ;; not be in it when it is amended for position HERE. Additionally, the
2836 ;; "outermost" open-brace entry before HERE will be converted to a cons if
2837 ;; the matching close-brace is scanned.
2839 ;; START-POINT is a "maximal" "safe position" - there must be no open
2840 ;; parens/braces/brackets between START-POINT and HERE.
2842 ;; As a second thing, calculate the result of parse-partial-sexp at
2843 ;; PPS-POINT, w.r.t. START-POINT. The motivation here is that
2844 ;; `c-state-cache-good-pos' may become PPS-POINT, but the caller may need to
2845 ;; adjust it to get outside a string/comment. (Sorry about this! The code
2846 ;; needs to be FAST).
2848 ;; Return a list (GOOD-POS SCAN-BACK-POS PPS-STATE), where
2849 ;; o - GOOD-POS is a position where the new value `c-state-cache' is known
2850 ;; to be good (we aim for this to be as high as possible);
2851 ;; o - SCAN-BACK-POS, if not nil, indicates there may be a brace pair
2852 ;; preceding POS which needs to be recorded in `c-state-cache'. It is a
2853 ;; position to scan backwards from. It is the position of the "{" of the
2854 ;; last element to be removed from `c-state-cache', when that elt is a
2855 ;; cons, otherwise nil.
2856 ;; o - PPS-STATE is the parse-partial-sexp state at PPS-POINT.
2859 (narrow-to-region 1 (point-max))
2860 (let* ((in-macro-start ; start of macro containing HERE or nil.
2863 (and (c-beginning-of-macro)
2865 (start-point-actual-macro-start ; Start of macro containing
2866 ; start-point or nil
2867 (and (< start-point here
)
2869 (goto-char start-point
)
2870 (and (c-beginning-of-macro)
2872 (start-point-actual-macro-end ; End of this macro, (maybe
2874 (and start-point-actual-macro-start
2876 (goto-char start-point-actual-macro-start
)
2879 pps-state
; Will be 9 or 10 elements long.
2881 upper-lim
; ,beyond which `c-state-cache' entries are removed
2883 pair-beg pps-point-state target-depth
)
2885 ;; Remove entries beyond HERE. Also remove any entries inside
2886 ;; a macro, unless HERE is in the same macro.
2888 (if (or (null c-state-old-cpp-beg
)
2889 (and (> here c-state-old-cpp-beg
)
2890 (< here c-state-old-cpp-end
)))
2892 (min here c-state-old-cpp-beg
)))
2893 (while (and c-state-cache
(>= (c-state-cache-top-lparen) upper-lim
))
2894 (setq scan-back-pos
(car-safe (car c-state-cache
)))
2895 (setq c-state-cache
(cdr c-state-cache
)))
2897 ;; If `upper-lim' is inside the last recorded brace pair, remove its
2898 ;; RBrace and indicate we'll need to search backwards for a previous
2900 (when (and c-state-cache
2901 (consp (car c-state-cache
))
2902 (> (cdar c-state-cache
) upper-lim
))
2903 (setcar c-state-cache
(caar c-state-cache
))
2904 (setq scan-back-pos
(car c-state-cache
)))
2906 ;; The next loop jumps forward out of a nested level of parens each
2907 ;; time round; the corresponding elements in `c-state-cache' are
2908 ;; removed. `pos' is just after the brace-pair or the open paren at
2909 ;; (car c-state-cache). There can be no open parens/braces/brackets
2910 ;; between `start-point'/`start-point-actual-macro-start' and HERE,
2911 ;; due to the interface spec to this function.
2912 (setq pos
(if (and start-point-actual-macro-end
2913 (not (eq start-point-actual-macro-start
2915 (1+ start-point-actual-macro-end
) ; get outside the macro as
2916 ; marked by a `category' text property.
2919 (while (and c-state-cache
2920 (or (numberp (car c-state-cache
)) ; Have we a { at all?
2921 (cdr c-state-cache
))
2924 ((null pps-state
) ; first time through
2925 (setq target-depth -
1))
2926 ((eq (car pps-state
) target-depth
) ; found closing ),},]
2927 (setq target-depth
(1- (car pps-state
))))
2928 ;; Do nothing when we've merely reached pps-point.
2934 (point) (if (< (point) pps-point
) pps-point here
)
2938 (if (= (point) pps-point
)
2939 (setq pps-point-state pps-state
))
2941 (when (eq (car pps-state
) target-depth
)
2942 (setq pos
(point)) ; POS is now just after an R-paren/brace.
2944 ((and (consp (car c-state-cache
))
2945 (eq (point) (cdar c-state-cache
)))
2946 ;; We've just moved out of the paren pair containing the brace-pair
2947 ;; at (car c-state-cache). `pair-beg' is where the open paren is,
2948 ;; and is potentially where the open brace of a cons in
2949 ;; c-state-cache will be.
2950 (setq pair-beg
(car-safe (cdr c-state-cache
))
2951 c-state-cache
(cdr-safe (cdr c-state-cache
)))) ; remove {}pair + containing Lparen.
2952 ((numberp (car c-state-cache
))
2953 (setq pair-beg
(car c-state-cache
)
2954 c-state-cache
(cdr c-state-cache
))) ; remove this
2956 ((numberp (cadr c-state-cache
))
2957 (setq pair-beg
(cadr c-state-cache
)
2958 c-state-cache
(cddr c-state-cache
))) ; Remove a paren pair
2959 ; together with enclosed brace pair.
2960 ;; (t nil) ; Ignore an unmated Rparen.
2963 (if (< (point) pps-point
)
2964 (setq pps-state
(parse-partial-sexp (point) pps-point
2965 nil nil
; TARGETDEPTH, STOPBEFORE
2968 ;; If the last paren pair we moved out of was actually a brace pair,
2969 ;; insert it into `c-state-cache'.
2970 (when (and pair-beg
(eq (char-after pair-beg
) ?
{))
2971 (if (consp (car-safe c-state-cache
))
2972 (setq c-state-cache
(cdr c-state-cache
)))
2973 (setq c-state-cache
(cons (cons pair-beg pos
)
2976 (list pos scan-back-pos pps-state
)))))
2978 (defun c-remove-stale-state-cache-backwards (here)
2979 ;; Strip stale elements of `c-state-cache' by moving backwards through the
2980 ;; buffer, and inform the caller of the scenario detected.
2982 ;; HERE is the position we're setting `c-state-cache' for.
2983 ;; CACHE-POS (a locally bound variable) is just after the latest recorded
2984 ;; position in `c-state-cache' before HERE, or a position at or near
2985 ;; point-min which isn't in a literal.
2987 ;; This function must only be called only when (> `c-state-cache-good-pos'
2988 ;; HERE). Usually the gap between CACHE-POS and HERE is large. It is thus
2989 ;; optimized to eliminate (or minimize) scanning between these two
2992 ;; Return a three element list (GOOD-POS SCAN-BACK-POS FWD-FLAG), where:
2993 ;; o - GOOD-POS is a "good position", where `c-state-cache' is valid, or
2994 ;; could become so after missing elements are inserted into
2995 ;; `c-state-cache'. This is JUST AFTER an opening or closing
2996 ;; brace/paren/bracket which is already in `c-state-cache' or just before
2997 ;; one otherwise. exceptionally (when there's no such b/p/b handy) the BOL
2998 ;; before `here''s line, or the start of the literal containing it.
2999 ;; o - SCAN-BACK-POS, if non-nil, indicates there may be a brace pair
3000 ;; preceding POS which isn't recorded in `c-state-cache'. It is a position
3001 ;; to scan backwards from.
3002 ;; o - FWD-FLAG, if non-nil, indicates there may be parens/braces between
3003 ;; POS and HERE which aren't recorded in `c-state-cache'.
3005 ;; The comments in this defun use "paren" to mean parenthesis or square
3006 ;; bracket (as contrasted with a brace), and "(" and ")" likewise.
3008 ;; . {..} (..) (..) ( .. { } ) (...) ( .... . ..)
3010 ;; CP E here D C good
3011 (let ((cache-pos (c-get-cache-scan-pos here
)) ; highest position below HERE in cache (or 1)
3012 (pos c-state-cache-good-pos
)
3013 pa ren
; positions of "(" and ")"
3014 dropped-cons
; whether the last element dropped from `c-state-cache'
3015 ; was a cons (representing a brace-pair)
3016 good-pos
; see above.
3017 lit
; (START . END) of a literal containing some point.
3018 here-lit-start here-lit-end
; bounds of literal containing `here'
3020 here- here
+ ; start/end of macro around HERE, or HERE
3021 (here-bol (c-point 'bol here
))
3022 (too-far-back (max (- here c-state-cache-too-far
) (point-min))))
3024 ;; Remove completely irrelevant entries from `c-state-cache'.
3025 (while (and c-state-cache
3026 (>= (setq pa
(c-state-cache-top-lparen)) here
))
3027 (setq dropped-cons
(consp (car c-state-cache
)))
3028 (setq c-state-cache
(cdr c-state-cache
))
3030 ;; At this stage, (> pos here);
3031 ;; (< (c-state-cache-top-lparen) here) (or is nil).
3034 ((and (consp (car c-state-cache
))
3035 (> (cdar c-state-cache
) here
))
3036 ;; CASE 1: The top of the cache is a brace pair which now encloses
3037 ;; `here'. As good-pos, return the address. of the "{". Since we've no
3038 ;; knowledge of what's inside these braces, we have no alternative but
3039 ;; to direct the caller to scan the buffer from the opening brace.
3040 (setq pos
(caar c-state-cache
))
3041 (setcar c-state-cache pos
)
3042 (list (1+ pos
) pos t
)) ; return value. We've just converted a brace pair
3043 ; entry into a { entry, so the caller needs to
3044 ; search for a brace pair before the {.
3046 ;; `here' might be inside a literal. Check for this.
3048 (setq lit
(c-state-literal-at here
)
3049 here-lit-start
(or (car lit
) here
)
3050 here-lit-end
(or (cdr lit
) here
))
3051 ;; Has `here' just "newly entered" a macro?
3053 (goto-char here-lit-start
)
3054 (if (and (c-beginning-of-macro)
3055 (or (null c-state-old-cpp-beg
)
3056 (not (= (point) c-state-old-cpp-beg
))))
3058 (setq here-
(point))
3060 (setq here
+ (point)))
3061 (setq here- here-lit-start
3062 here
+ here-lit-end
)))
3064 ;; `here' might be nested inside any depth of parens (or brackets but
3065 ;; not braces). Scan backwards to find the outermost such opening
3066 ;; paren, if there is one. This will be the scan position to return.
3068 (narrow-to-region cache-pos
(point-max))
3069 (setq pos
(c-state-balance-parens-backwards here- here
+ pos
)))
3070 nil
)) ; for the cond
3072 ((< pos here-lit-start
)
3073 ;; CASE 2: Address of outermost ( or [ which now encloses `here', but
3074 ;; didn't enclose the (previous) `c-state-cache-good-pos'. If there is
3075 ;; a brace pair preceding this, it will already be in `c-state-cache',
3076 ;; unless there was a brace pair after it, i.e. there'll only be one to
3077 ;; scan for if we've just deleted one.
3078 (list pos
(and dropped-cons pos
) t
)) ; Return value.
3080 ;; `here' isn't enclosed in a (previously unrecorded) bracket/paren.
3081 ;; Further forward scanning isn't needed, but we still need to find a
3082 ;; GOOD-POS. Step out of all enclosing "("s on HERE's line.
3085 (narrow-to-region here-bol
(point-max))
3086 (setq pos here-lit-start
)
3087 (c-safe (while (setq pa
(scan-lists pos -
1 1))
3088 (setq pos pa
)))) ; might signal
3089 nil
)) ; for the cond
3091 ((setq ren
(c-safe-scan-lists pos -
1 -
1 too-far-back
))
3092 ;; CASE 3: After a }/)/] before `here''s BOL.
3093 (list (1+ ren
) (and dropped-cons pos
) nil
)) ; Return value
3096 ;; CASE 4; Best of a bad job: BOL before `here-bol', or beginning of
3097 ;; literal containing it.
3098 (setq good-pos
(c-state-lit-beg (c-point 'bopl here-bol
)))
3099 (list good-pos
(and dropped-cons good-pos
) nil
)))))
3102 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3103 ;; Externally visible routines.
3105 (defun c-state-cache-init ()
3106 (setq c-state-cache nil
3107 c-state-cache-good-pos
1
3108 c-state-nonlit-pos-cache nil
3109 c-state-nonlit-pos-cache-limit
1
3110 c-state-semi-nonlit-pos-cache nil
3111 c-state-semi-nonlit-pos-cache-limit
1
3112 c-state-brace-pair-desert nil
3114 c-state-point-min-lit-type nil
3115 c-state-point-min-lit-start nil
3116 c-state-min-scan-pos
1
3117 c-state-old-cpp-beg nil
3118 c-state-old-cpp-end nil
)
3119 (c-state-mark-point-min-literal))
3121 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3122 ;; Debugging routines to dump `c-state-cache' in a "replayable" form.
3123 ;; (defmacro c-sc-de (elt) ; "c-state-cache-dump-element"
3124 ;; `(format ,(concat "(setq " (symbol-name elt) " %s) ") ,elt))
3125 ;; (defmacro c-sc-qde (elt) ; "c-state-cache-quote-dump-element"
3126 ;; `(format ,(concat "(setq " (symbol-name elt) " '%s) ") ,elt))
3127 ;; (defun c-state-dump ()
3128 ;; ;; For debugging.
3131 ;; (c-sc-qde c-state-cache)
3132 ;; (c-sc-de c-state-cache-good-pos)
3133 ;; (c-sc-qde c-state-nonlit-pos-cache)
3134 ;; (c-sc-de c-state-nonlit-pos-cache-limit)
3135 ;; (c-sc-qde c-state-brace-pair-desert)
3136 ;; (c-sc-de c-state-point-min)
3137 ;; (c-sc-de c-state-point-min-lit-type)
3138 ;; (c-sc-de c-state-point-min-lit-start)
3139 ;; (c-sc-de c-state-min-scan-pos)
3140 ;; (c-sc-de c-state-old-cpp-beg)
3141 ;; (c-sc-de c-state-old-cpp-end)))
3142 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3144 (defun c-invalidate-state-cache-1 (here)
3145 ;; Invalidate all info on `c-state-cache' that applies to the buffer at HERE
3146 ;; or higher and set `c-state-cache-good-pos' accordingly. The cache is
3147 ;; left in a consistent state.
3149 ;; This is much like `c-whack-state-after', but it never changes a paren
3150 ;; pair element into an open paren element. Doing that would mean that the
3151 ;; new open paren wouldn't have the required preceding paren pair element.
3153 ;; This function is called from c-after-change.
3155 ;; The caches of non-literals:
3156 ;; Note that we use "<=" for the possibility of the second char of a two-char
3157 ;; comment opener being typed; this would invalidate any cache position at
3159 (if (<= here c-state-nonlit-pos-cache-limit
)
3160 (setq c-state-nonlit-pos-cache-limit
(1- here
)))
3161 (if (<= here c-state-semi-nonlit-pos-cache-limit
)
3162 (setq c-state-semi-nonlit-pos-cache-limit
(1- here
)))
3165 ;; Case 1: if `here' is in a literal containing point-min, everything
3166 ;; becomes (or is already) nil.
3167 (if (or (null c-state-cache-good-pos
)
3168 (< here
(c-state-get-min-scan-pos)))
3169 (setq c-state-cache nil
3170 c-state-cache-good-pos nil
3171 c-state-min-scan-pos nil
)
3173 ;; Truncate `c-state-cache' and set `c-state-cache-good-pos' to a value
3174 ;; below `here'. To maintain its consistency, we may need to insert a new
3176 (let ((here-bol (c-point 'bol here
))
3177 too-high-pa
; recorded {/(/[ next above here, or nil.
3178 dropped-cons
; was the last removed element a brace pair?
3180 ;; The easy bit - knock over-the-top bits off `c-state-cache'.
3181 (while (and c-state-cache
3182 (>= (setq pa
(c-state-cache-top-paren)) here
))
3183 (setq dropped-cons
(consp (car c-state-cache
))
3184 too-high-pa
(c-state-cache-top-lparen)
3185 c-state-cache
(cdr c-state-cache
)))
3187 ;; Do we need to add in an earlier brace pair, having lopped one off?
3188 (if (and dropped-cons
3189 (< too-high-pa
(+ here c-state-cache-too-far
)))
3190 (c-append-lower-brace-pair-to-state-cache too-high-pa here here-bol
))
3191 (setq c-state-cache-good-pos
(or (c-state-cache-after-top-paren)
3192 (c-state-get-min-scan-pos)))))
3194 ;; The brace-pair desert marker:
3195 (when (car c-state-brace-pair-desert
)
3196 (if (< here
(car c-state-brace-pair-desert
))
3197 (setq c-state-brace-pair-desert nil
)
3198 (if (< here
(cdr c-state-brace-pair-desert
))
3199 (setcdr c-state-brace-pair-desert here
)))))
3201 (defun c-parse-state-1 ()
3202 ;; Find and record all noteworthy parens between some good point earlier in
3203 ;; the file and point. That good point is at least the beginning of the
3204 ;; top-level construct we are in, or the beginning of the preceding
3205 ;; top-level construct if we aren't in one.
3207 ;; The returned value is a list of the noteworthy parens with the last one
3208 ;; first. If an element in the list is an integer, it's the position of an
3209 ;; open paren (of any type) which has not been closed before the point. If
3210 ;; an element is a cons, it gives the position of a closed BRACE paren
3211 ;; pair[*]; the car is the start brace position and the cdr is the position
3212 ;; following the closing brace. Only the last closed brace paren pair
3213 ;; before each open paren and before the point is recorded, and thus the
3214 ;; state never contains two cons elements in succession. When a close brace
3215 ;; has no matching open brace (e.g., the matching brace is outside the
3216 ;; visible region), it is not represented in the returned value.
3218 ;; [*] N.B. The close "brace" might be a mismatching close bracket or paren.
3219 ;; This defun explicitly treats mismatching parens/braces/brackets as
3220 ;; matching. It is the open brace which makes it a "brace" pair.
3222 ;; If POINT is within a macro, open parens and brace pairs within
3223 ;; THIS macro MIGHT be recorded. This depends on whether their
3224 ;; syntactic properties have been suppressed by
3225 ;; `c-neutralize-syntax-in-CPP'. This might need fixing (2008-12-11).
3227 ;; Currently no characters which are given paren syntax with the
3228 ;; syntax-table property are recorded, i.e. angle bracket arglist
3229 ;; parens are never present here. Note that this might change.
3231 ;; BUG: This function doesn't cope entirely well with unbalanced
3232 ;; parens in macros. (2008-12-11: this has probably been resolved
3233 ;; by the function `c-neutralize-syntax-in-CPP'.) E.g. in the
3234 ;; following case the brace before the macro isn't balanced with the
3241 ;; Note to maintainers: this function DOES get called with point
3242 ;; within comments and strings, so don't assume it doesn't!
3244 ;; This function might do hidden buffer changes.
3245 (let* ((here (point))
3246 (here-bopl (c-point 'bopl
))
3247 strategy
; 'forward, 'backward etc..
3248 ;; Candidate positions to start scanning from:
3249 cache-pos
; highest position below HERE already existing in
3252 start-point
; (when scanning forward) a place below HERE where there
3253 ; are no open parens/braces between it and HERE.
3256 scan-backward-pos scan-forward-p
) ; used for 'backward.
3257 ;; If POINT-MIN has changed, adjust the cache
3258 (unless (= (point-min) c-state-point-min
)
3259 (c-renarrow-state-cache))
3262 (setq res
(c-parse-state-get-strategy here c-state-cache-good-pos
)
3264 start-point
(cadr res
))
3268 ((eq strategy
'forward
)
3269 (setq res
(c-remove-stale-state-cache start-point here here-bopl
))
3270 (setq cache-pos
(car res
)
3271 scan-backward-pos
(cadr res
)
3272 bopl-state
(car (cddr res
))) ; will be nil if (< here-bopl
3274 (if scan-backward-pos
3275 (c-append-lower-brace-pair-to-state-cache scan-backward-pos here
))
3277 (c-append-to-state-cache cache-pos here
))
3278 (setq c-state-cache-good-pos
3280 (< good-pos
(- here c-state-cache-too-far
)))
3281 (c-state-cache-non-literal-place here-bopl bopl-state
)
3284 ((eq strategy
'backward
)
3285 (setq res
(c-remove-stale-state-cache-backwards here
)
3287 scan-backward-pos
(cadr res
)
3288 scan-forward-p
(car (cddr res
)))
3289 (if scan-backward-pos
3290 (c-append-lower-brace-pair-to-state-cache scan-backward-pos here
))
3291 (setq c-state-cache-good-pos
3293 (c-append-to-state-cache good-pos here
)
3296 (t ; (eq strategy 'IN-LIT)
3297 (setq c-state-cache nil
3298 c-state-cache-good-pos nil
))))
3302 (defun c-invalidate-state-cache (here)
3303 ;; This is a wrapper over `c-invalidate-state-cache-1'.
3305 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3306 ;; of all parens in preprocessor constructs, except for any such construct
3307 ;; containing point. We can then call `c-invalidate-state-cache-1' without
3308 ;; worrying further about macros and template delimiters.
3309 (c-with-<-
>-as-parens-suppressed
3310 (if (and c-state-old-cpp-beg
3311 (< c-state-old-cpp-beg here
))
3312 (c-with-all-but-one-cpps-commented-out
3314 (min c-state-old-cpp-end here
)
3315 (c-invalidate-state-cache-1 here
))
3316 (c-with-cpps-commented-out
3317 (c-invalidate-state-cache-1 here
)))))
3319 (defmacro c-state-maybe-marker
(place marker
)
3320 ;; If PLACE is non-nil, return a marker marking it, otherwise nil.
3321 ;; We (re)use MARKER.
3323 (or ,marker
(setq ,marker
(make-marker)))
3324 (set-marker ,marker
,place
)))
3326 (defun c-parse-state ()
3327 ;; This is a wrapper over `c-parse-state-1'. See that function for a
3328 ;; description of the functionality and return value.
3330 ;; It suppresses the syntactic effect of the < and > (template) brackets and
3331 ;; of all parens in preprocessor constructs, except for any such construct
3332 ;; containing point. We can then call `c-parse-state-1' without worrying
3333 ;; further about macros and template delimiters.
3334 (let (here-cpp-beg here-cpp-end
)
3336 (when (c-beginning-of-macro)
3337 (setq here-cpp-beg
(point))
3339 (> (setq here-cpp-end
(c-syntactic-end-of-macro))
3341 (setq here-cpp-beg nil here-cpp-end nil
))))
3342 ;; FIXME!!! Put in a `condition-case' here to protect the integrity of the
3345 (c-with-<-
>-as-parens-suppressed
3346 (if (and here-cpp-beg
(> here-cpp-end here-cpp-beg
))
3347 (c-with-all-but-one-cpps-commented-out
3348 here-cpp-beg here-cpp-end
3350 (c-with-cpps-commented-out
3351 (c-parse-state-1))))
3352 (setq c-state-old-cpp-beg
3353 (c-state-maybe-marker here-cpp-beg c-state-old-cpp-beg-marker
)
3355 (c-state-maybe-marker here-cpp-end c-state-old-cpp-end-marker
)))))
3357 ;; Debug tool to catch cache inconsistencies. This is called from
3359 (defvar c-debug-parse-state nil
)
3360 (unless (fboundp 'c-real-parse-state
)
3361 (fset 'c-real-parse-state
(symbol-function 'c-parse-state
)))
3362 (cc-bytecomp-defun c-real-parse-state)
3364 (defvar c-parse-state-point nil
)
3365 (defvar c-parse-state-state nil
)
3366 (defun c-record-parse-state-state ()
3367 (setq c-parse-state-point
(point))
3368 (setq c-parse-state-state
3371 (let ((val (symbol-value arg
)))
3377 c-state-cache-good-pos
3378 c-state-nonlit-pos-cache
3379 c-state-nonlit-pos-cache-limit
3380 c-state-semi-nonlit-pos-cache
3381 c-state-semi-nonlit-pos-cache-limit
3382 c-state-brace-pair-desert
3384 c-state-point-min-lit-type
3385 c-state-point-min-lit-start
3386 c-state-min-scan-pos
3389 c-parse-state-point
))))
3390 (defun c-replay-parse-state-state ()
3395 (format "%s %s%s" (car arg
) (if (atom (cdr arg
)) "" "'") (cdr arg
)))
3396 c-parse-state-state
" ")
3399 (defun c-debug-parse-state-double-cons (state)
3400 (let (state-car conses-not-ok
)
3402 (setq state-car
(car state
)
3404 (if (and (consp state-car
)
3405 (consp (car state
)))
3406 (setq conses-not-ok t
)))
3409 (defun c-debug-parse-state ()
3410 (let ((here (point)) (res1 (c-real-parse-state)) res2
)
3411 (let ((c-state-cache nil
)
3412 (c-state-cache-good-pos 1)
3413 (c-state-nonlit-pos-cache nil
)
3414 (c-state-nonlit-pos-cache-limit 1)
3415 (c-state-brace-pair-desert nil
)
3416 (c-state-point-min 1)
3417 (c-state-point-min-lit-type nil
)
3418 (c-state-point-min-lit-start nil
)
3419 (c-state-min-scan-pos 1)
3420 (c-state-old-cpp-beg nil
)
3421 (c-state-old-cpp-end nil
))
3422 (setq res2
(c-real-parse-state)))
3423 (unless (equal res1 res2
)
3424 ;; The cache can actually go further back due to the ad-hoc way
3425 ;; the first paren is found, so try to whack off a bit of its
3426 ;; start before complaining.
3428 ;; (goto-char (or (c-least-enclosing-brace res2) (point)))
3429 ;; (c-beginning-of-defun-1)
3430 ;; (while (not (or (bobp) (eq (char-after) ?{)))
3431 ;; (c-beginning-of-defun-1))
3432 ;; (unless (equal (c-whack-state-before (point) res1) res2)
3433 ;; (message (concat "c-parse-state inconsistency at %s: "
3434 ;; "using cache: %s, from scratch: %s")
3435 ;; here res1 res2)))
3436 (message (concat "c-parse-state inconsistency at %s: "
3437 "using cache: %s, from scratch: %s")
3439 (message "Old state:")
3440 (c-replay-parse-state-state))
3442 (when (c-debug-parse-state-double-cons res1
)
3443 (message "c-parse-state INVALIDITY at %s: %s"
3445 (message "Old state:")
3446 (c-replay-parse-state-state))
3448 (c-record-parse-state-state)
3449 res2
; res1 correct a cascading series of errors ASAP
3452 (defun c-toggle-parse-state-debug (&optional arg
)
3454 (setq c-debug-parse-state
(c-calculate-state arg c-debug-parse-state
))
3455 (fset 'c-parse-state
(symbol-function (if c-debug-parse-state
3456 'c-debug-parse-state
3457 'c-real-parse-state
)))
3458 (c-keep-region-active)
3459 (message "c-debug-parse-state %sabled"
3460 (if c-debug-parse-state
"en" "dis")))
3461 (when c-debug-parse-state
3462 (c-toggle-parse-state-debug 1))
3465 (defun c-whack-state-before (bufpos paren-state
)
3466 ;; Whack off any state information from PAREN-STATE which lies
3467 ;; before BUFPOS. Not destructive on PAREN-STATE.
3468 (let* ((newstate (list nil
))
3472 (setq car
(car paren-state
)
3473 paren-state
(cdr paren-state
))
3474 (if (< (if (consp car
) (car car
) car
) bufpos
)
3475 (setq paren-state nil
)
3476 (setcdr ptr
(list car
))
3477 (setq ptr
(cdr ptr
))))
3480 (defun c-whack-state-after (bufpos paren-state
)
3481 ;; Whack off any state information from PAREN-STATE which lies at or
3482 ;; after BUFPOS. Not destructive on PAREN-STATE.
3485 (let ((car (car paren-state
)))
3487 ;; just check the car, because in a balanced brace
3488 ;; expression, it must be impossible for the corresponding
3489 ;; close brace to be before point, but the open brace to
3491 (if (<= bufpos
(car car
))
3493 (if (< bufpos
(cdr car
))
3494 ;; its possible that the open brace is before
3495 ;; bufpos, but the close brace is after. In that
3496 ;; case, convert this to a non-cons element. The
3497 ;; rest of the state is before bufpos, so we're
3499 (throw 'done
(cons (car car
) (cdr paren-state
)))
3500 ;; we know that both the open and close braces are
3501 ;; before bufpos, so we also know that everything else
3502 ;; on state is before bufpos.
3503 (throw 'done paren-state
)))
3506 ;; it's before bufpos, so everything else should too.
3507 (throw 'done paren-state
)))
3508 (setq paren-state
(cdr paren-state
)))
3511 (defun c-most-enclosing-brace (paren-state &optional bufpos
)
3512 ;; Return the bufpos of the innermost enclosing open paren before
3513 ;; bufpos, or nil if none was found.
3515 (or bufpos
(setq bufpos
134217727))
3517 (setq enclosingp
(car paren-state
)
3518 paren-state
(cdr paren-state
))
3519 (if (or (consp enclosingp
)
3520 (>= enclosingp bufpos
))
3521 (setq enclosingp nil
)
3522 (setq paren-state nil
)))
3525 (defun c-least-enclosing-brace (paren-state)
3526 ;; Return the bufpos of the outermost enclosing open paren, or nil
3527 ;; if none was found.
3530 (setq elem
(car paren-state
)
3531 paren-state
(cdr paren-state
))
3536 (defun c-safe-position (bufpos paren-state
)
3537 ;; Return the closest "safe" position recorded on PAREN-STATE that
3538 ;; is higher up than BUFPOS. Return nil if PAREN-STATE doesn't
3539 ;; contain any. Return nil if BUFPOS is nil, which is useful to
3540 ;; find the closest limit before a given limit that might be nil.
3542 ;; A "safe" position is a position at or after a recorded open
3543 ;; paren, or after a recorded close paren. The returned position is
3544 ;; thus either the first position after a close brace, or the first
3545 ;; position after an enclosing paren, or at the enclosing paren in
3546 ;; case BUFPOS is immediately after it.
3551 (setq elem
(car paren-state
))
3553 (cond ((< (cdr elem
) bufpos
)
3554 (throw 'done
(cdr elem
)))
3555 ((< (car elem
) bufpos
)
3557 (throw 'done
(min (1+ (car elem
)) bufpos
))))
3559 ;; elem is the position at and not after the opening paren, so
3560 ;; we can go forward one more step unless it's equal to
3561 ;; bufpos. This is useful in some cases avoid an extra paren
3562 ;; level between the safe position and bufpos.
3563 (throw 'done
(min (1+ elem
) bufpos
))))
3564 (setq paren-state
(cdr paren-state
)))))))
3566 (defun c-beginning-of-syntax ()
3567 ;; This is used for `font-lock-beginning-of-syntax-function'. It
3568 ;; goes to the closest previous point that is known to be outside
3569 ;; any string literal or comment. `c-state-cache' is used if it has
3570 ;; a position in the vicinity.
3571 (let* ((paren-state c-state-cache
)
3575 ;; Note: Similar code in `c-safe-position'. The
3576 ;; difference is that we accept a safe position at
3577 ;; the point and don't bother to go forward past open
3580 (setq elem
(car paren-state
))
3582 (cond ((<= (cdr elem
) (point))
3583 (throw 'done
(cdr elem
)))
3584 ((<= (car elem
) (point))
3585 (throw 'done
(car elem
))))
3586 (if (<= elem
(point))
3587 (throw 'done elem
)))
3588 (setq paren-state
(cdr paren-state
)))
3591 (if (> pos
(- (point) 4000))
3593 ;; The position is far back. Try `c-beginning-of-defun-1'
3594 ;; (although we can't be entirely sure it will go to a position
3595 ;; outside a comment or string in current emacsen). FIXME:
3596 ;; Consult `syntax-ppss' here.
3597 (c-beginning-of-defun-1)
3602 ;; Tools for scanning identifiers and other tokens.
3604 (defun c-on-identifier ()
3605 "Return non-nil if the point is on or directly after an identifier.
3606 Keywords are recognized and not considered identifiers. If an
3607 identifier is detected, the returned value is its starting position.
3608 If an identifier ends at the point and another begins at it \(can only
3609 happen in Pike) then the point for the preceding one is returned.
3611 Note that this function might do hidden buffer changes. See the
3612 comment at the start of cc-engine.el for more info."
3614 ;; FIXME: Shouldn't this function handle "operator" in C++?
3617 (skip-syntax-backward "w_")
3621 ;; Check for a normal (non-keyword) identifier.
3622 (and (looking-at c-symbol-start
)
3623 (not (looking-at c-keywords-regexp
))
3626 (when (c-major-mode-is 'pike-mode
)
3627 ;; Handle the `<operator> syntax in Pike.
3628 (let ((pos (point)))
3629 (skip-chars-backward "-!%&*+/<=>^|~[]()")
3630 (and (if (< (skip-chars-backward "`") 0)
3633 (eq (char-after) ?\
`))
3634 (looking-at c-symbol-key
)
3635 (>= (match-end 0) pos
)
3638 ;; Handle the "operator +" syntax in C++.
3639 (when (and c-overloadable-operators-regexp
3640 (= (c-backward-token-2 0) 0))
3642 (cond ((and (looking-at c-overloadable-operators-regexp
)
3643 (or (not c-opt-op-identifier-prefix
)
3644 (and (= (c-backward-token-2 1) 0)
3645 (looking-at c-opt-op-identifier-prefix
))))
3649 (and c-opt-op-identifier-prefix
3650 (looking-at c-opt-op-identifier-prefix
)
3651 (= (c-forward-token-2 1) 0)
3652 (looking-at c-overloadable-operators-regexp
)))
3657 (defsubst c-simple-skip-symbol-backward
()
3658 ;; If the point is at the end of a symbol then skip backward to the
3659 ;; beginning of it. Don't move otherwise. Return non-nil if point
3662 ;; This function might do hidden buffer changes.
3663 (or (< (skip-syntax-backward "w_") 0)
3664 (and (c-major-mode-is 'pike-mode
)
3665 ;; Handle the `<operator> syntax in Pike.
3666 (let ((pos (point)))
3667 (if (and (< (skip-chars-backward "-!%&*+/<=>^|~[]()") 0)
3668 (< (skip-chars-backward "`") 0)
3669 (looking-at c-symbol-key
)
3670 (>= (match-end 0) pos
))
3675 (defun c-beginning-of-current-token (&optional back-limit
)
3676 ;; Move to the beginning of the current token. Do not move if not
3677 ;; in the middle of one. BACK-LIMIT may be used to bound the
3678 ;; backward search; if given it's assumed to be at the boundary
3679 ;; between two tokens. Return non-nil if the point is moved, nil
3682 ;; This function might do hidden buffer changes.
3683 (let ((start (point)))
3684 (if (looking-at "\\w\\|\\s_")
3685 (skip-syntax-backward "w_" back-limit
)
3686 (when (< (skip-syntax-backward ".()" back-limit
) 0)
3687 (while (let ((pos (or (and (looking-at c-nonsymbol-token-regexp
)
3689 ;; `c-nonsymbol-token-regexp' should always match
3690 ;; since we've skipped backward over punctuator
3691 ;; or paren syntax, but consume one char in case
3692 ;; it doesn't so that we don't leave point before
3693 ;; some earlier incorrect token.
3696 (goto-char pos
))))))
3699 (defun c-end-of-current-token (&optional back-limit
)
3700 ;; Move to the end of the current token. Do not move if not in the
3701 ;; middle of one. BACK-LIMIT may be used to bound the backward
3702 ;; search; if given it's assumed to be at the boundary between two
3703 ;; tokens. Return non-nil if the point is moved, nil otherwise.
3705 ;; This function might do hidden buffer changes.
3706 (let ((start (point)))
3707 (cond ((< (skip-syntax-backward "w_" (1- start
)) 0)
3708 (skip-syntax-forward "w_"))
3709 ((< (skip-syntax-backward ".()" back-limit
) 0)
3711 (if (looking-at c-nonsymbol-token-regexp
)
3712 (goto-char (match-end 0))
3713 ;; `c-nonsymbol-token-regexp' should always match since
3714 ;; we've skipped backward over punctuator or paren
3715 ;; syntax, but move forward in case it doesn't so that
3716 ;; we don't leave point earlier than we started with.
3718 (< (point) start
)))))
3721 (defconst c-jump-syntax-balanced
3722 (if (memq 'gen-string-delim c-emacs-features
)
3723 "\\w\\|\\s_\\|\\s\(\\|\\s\)\\|\\s\"\\|\\s|"
3724 "\\w\\|\\s_\\|\\s\(\\|\\s\)\\|\\s\""))
3726 (defconst c-jump-syntax-unbalanced
3727 (if (memq 'gen-string-delim c-emacs-features
)
3728 "\\w\\|\\s_\\|\\s\"\\|\\s|"
3729 "\\w\\|\\s_\\|\\s\""))
3731 (defun c-forward-token-2 (&optional count balanced limit
)
3732 "Move forward by tokens.
3733 A token is defined as all symbols and identifiers which aren't
3734 syntactic whitespace \(note that multicharacter tokens like \"==\" are
3735 treated properly). Point is always either left at the beginning of a
3736 token or not moved at all. COUNT specifies the number of tokens to
3737 move; a negative COUNT moves in the opposite direction. A COUNT of 0
3738 moves to the next token beginning only if not already at one. If
3739 BALANCED is true, move over balanced parens, otherwise move into them.
3740 Also, if BALANCED is true, never move out of an enclosing paren.
3742 LIMIT sets the limit for the movement and defaults to the point limit.
3743 The case when LIMIT is set in the middle of a token, comment or macro
3744 is handled correctly, i.e. the point won't be left there.
3746 Return the number of tokens left to move \(positive or negative). If
3747 BALANCED is true, a move over a balanced paren counts as one. Note
3748 that if COUNT is 0 and no appropriate token beginning is found, 1 will
3749 be returned. Thus, a return value of 0 guarantees that point is at
3750 the requested position and a return value less \(without signs) than
3751 COUNT guarantees that point is at the beginning of some token.
3753 Note that this function might do hidden buffer changes. See the
3754 comment at the start of cc-engine.el for more info."
3756 (or count
(setq count
1))
3758 (- (c-backward-token-2 (- count
) balanced limit
))
3760 (let ((jump-syntax (if balanced
3761 c-jump-syntax-balanced
3762 c-jump-syntax-unbalanced
))
3767 ;; If count is zero we should jump if in the middle of a token.
3768 (c-end-of-current-token))
3771 (if limit
(narrow-to-region (point-min) limit
))
3773 (progn (c-forward-syntactic-ws) (point)))
3774 ;; Skip whitespace. Count this as a move if we did in
3776 (setq count
(max (1- count
) 0)))
3779 ;; Moved out of bounds. Make sure the returned count isn't zero.
3781 (if (zerop count
) (setq count
1))
3784 ;; Use `condition-case' to avoid having the limit tests
3791 (cond ((looking-at jump-syntax
)
3792 (goto-char (scan-sexps (point) 1))
3794 ((looking-at c-nonsymbol-token-regexp
)
3795 (goto-char (match-end 0))
3797 ;; `c-nonsymbol-token-regexp' above should always
3798 ;; match if there are correct tokens. Try to
3799 ;; widen to see if the limit was set in the
3800 ;; middle of one, else fall back to treating
3801 ;; the offending thing as a one character token.
3805 (looking-at c-nonsymbol-token-regexp
)))
3810 (c-forward-syntactic-ws)
3813 (error (goto-char last
)))
3817 (setq count
(1+ count
)))))
3821 (defun c-backward-token-2 (&optional count balanced limit
)
3822 "Move backward by tokens.
3823 See `c-forward-token-2' for details."
3825 (or count
(setq count
1))
3827 (- (c-forward-token-2 (- count
) balanced limit
))
3829 (or limit
(setq limit
(point-min)))
3830 (let ((jump-syntax (if balanced
3831 c-jump-syntax-balanced
3832 c-jump-syntax-unbalanced
))
3836 ;; The count is zero so try to skip to the beginning of the
3839 (progn (c-beginning-of-current-token) (point)))
3840 (if (< (point) limit
)
3841 ;; The limit is inside the same token, so return 1.
3844 ;; We're not in the middle of a token. If there's
3845 ;; whitespace after the point then we must move backward,
3846 ;; so set count to 1 in that case.
3847 (and (looking-at c-syntactic-ws-start
)
3848 ;; If we're looking at a '#' that might start a cpp
3849 ;; directive then we have to do a more elaborate check.
3850 (or (/= (char-after) ?
#)
3851 (not c-opt-cpp-prefix
)
3854 (progn (beginning-of-line)
3855 (looking-at "[ \t]*")
3858 (progn (backward-char)
3859 (not (eq (char-before) ?
\\)))))))
3862 ;; Use `condition-case' to avoid having to check for buffer
3863 ;; limits in `backward-char', `scan-sexps' and `goto-char' below.
3868 (c-backward-syntactic-ws)
3870 (if (looking-at jump-syntax
)
3871 (goto-char (scan-sexps (1+ (point)) -
1))
3872 ;; This can be very inefficient if there's a long
3873 ;; sequence of operator tokens without any separation.
3874 ;; That doesn't happen in practice, anyway.
3875 (c-beginning-of-current-token))
3876 (>= (point) limit
)))
3879 (error (goto-char last
)))
3881 (if (< (point) limit
)
3886 (defun c-forward-token-1 (&optional count balanced limit
)
3887 "Like `c-forward-token-2' but doesn't treat multicharacter operator
3888 tokens like \"==\" as single tokens, i.e. all sequences of symbol
3889 characters are jumped over character by character. This function is
3890 for compatibility only; it's only a wrapper over `c-forward-token-2'."
3891 (let ((c-nonsymbol-token-regexp "\\s.\\|\\s\(\\|\\s\)"))
3892 (c-forward-token-2 count balanced limit
)))
3894 (defun c-backward-token-1 (&optional count balanced limit
)
3895 "Like `c-backward-token-2' but doesn't treat multicharacter operator
3896 tokens like \"==\" as single tokens, i.e. all sequences of symbol
3897 characters are jumped over character by character. This function is
3898 for compatibility only; it's only a wrapper over `c-backward-token-2'."
3899 (let ((c-nonsymbol-token-regexp "\\s.\\|\\s\(\\|\\s\)"))
3900 (c-backward-token-2 count balanced limit
)))
3903 ;; Tools for doing searches restricted to syntactically relevant text.
3905 (defun c-syntactic-re-search-forward (regexp &optional bound noerror
3906 paren-level not-inside-token
3907 lookbehind-submatch
)
3908 "Like `re-search-forward', but only report matches that are found
3909 in syntactically significant text. I.e. matches in comments, macros
3910 or string literals are ignored. The start point is assumed to be
3911 outside any comment, macro or string literal, or else the content of
3912 that region is taken as syntactically significant text.
3914 If PAREN-LEVEL is non-nil, an additional restriction is added to
3915 ignore matches in nested paren sexps. The search will also not go
3916 outside the current list sexp, which has the effect that if the point
3917 should be moved to BOUND when no match is found \(i.e. NOERROR is
3918 neither nil nor t), then it will be at the closing paren if the end of
3919 the current list sexp is encountered first.
3921 If NOT-INSIDE-TOKEN is non-nil, matches in the middle of tokens are
3922 ignored. Things like multicharacter operators and special symbols
3923 \(e.g. \"`()\" in Pike) are handled but currently not floating point
3926 If LOOKBEHIND-SUBMATCH is non-nil, it's taken as a number of a
3927 subexpression in REGEXP. The end of that submatch is used as the
3928 position to check for syntactic significance. If LOOKBEHIND-SUBMATCH
3929 isn't used or if that subexpression didn't match then the start
3930 position of the whole match is used instead. The \"look behind\"
3931 subexpression is never tested before the starting position, so it
3932 might be a good idea to include \\=\\= as a match alternative in it.
3934 Optimization note: Matches might be missed if the \"look behind\"
3935 subexpression can match the end of nonwhite syntactic whitespace,
3936 i.e. the end of comments or cpp directives. This since the function
3937 skips over such things before resuming the search. It's on the other
3938 hand not safe to assume that the \"look behind\" subexpression never
3939 matches syntactic whitespace.
3941 Bug: Unbalanced parens inside cpp directives are currently not handled
3942 correctly \(i.e. they don't get ignored as they should) when
3945 Note that this function might do hidden buffer changes. See the
3946 comment at the start of cc-engine.el for more info."
3948 (or bound
(setq bound
(point-max)))
3949 (if paren-level
(setq paren-level -
1))
3951 ;;(message "c-syntactic-re-search-forward %s %s %S" (point) bound regexp)
3953 (let ((start (point))
3955 ;; Start position for the last search.
3957 ;; The `parse-partial-sexp' state between the start position
3960 ;; The current position after the last state update. The next
3961 ;; `parse-partial-sexp' continues from here.
3963 ;; The position at which to check the state and the state
3964 ;; there. This is separate from `state-pos' since we might
3965 ;; need to back up before doing the next search round.
3966 check-pos check-state
3967 ;; Last position known to end a token.
3968 (last-token-end-pos (point-min))
3969 ;; Set when a valid match is found.
3976 (setq search-pos
(point))
3977 (re-search-forward regexp bound noerror
))
3980 (setq state
(parse-partial-sexp
3981 state-pos
(match-beginning 0) paren-level nil state
)
3983 (if (setq check-pos
(and lookbehind-submatch
3984 (or (not paren-level
)
3986 (match-end lookbehind-submatch
)))
3987 (setq check-state
(parse-partial-sexp
3988 state-pos check-pos paren-level nil state
))
3989 (setq check-pos state-pos
3992 ;; NOTE: If we got a look behind subexpression and get
3993 ;; an insignificant match in something that isn't
3994 ;; syntactic whitespace (i.e. strings or in nested
3995 ;; parentheses), then we can never skip more than a
3996 ;; single character from the match start position
3997 ;; (i.e. `state-pos' here) before continuing the
3998 ;; search. That since the look behind subexpression
3999 ;; might match the end of the insignificant region in
4003 ((elt check-state
7)
4004 ;; Match inside a line comment. Skip to eol. Use
4005 ;; `re-search-forward' instead of `skip-chars-forward' to get
4006 ;; the right bound behavior.
4007 (re-search-forward "[\n\r]" bound noerror
))
4009 ((elt check-state
4)
4010 ;; Match inside a block comment. Skip to the '*/'.
4011 (search-forward "*/" bound noerror
))
4013 ((and (not (elt check-state
5))
4014 (eq (char-before check-pos
) ?
/)
4015 (not (c-get-char-property (1- check-pos
) 'syntax-table
))
4016 (memq (char-after check-pos
) '(?
/ ?
*)))
4017 ;; Match in the middle of the opener of a block or line
4019 (if (= (char-after check-pos
) ?
/)
4020 (re-search-forward "[\n\r]" bound noerror
)
4021 (search-forward "*/" bound noerror
)))
4023 ;; The last `parse-partial-sexp' above might have
4024 ;; stopped short of the real check position if the end
4025 ;; of the current sexp was encountered in paren-level
4026 ;; mode. The checks above are always false in that
4027 ;; case, and since they can do better skipping in
4028 ;; lookbehind-submatch mode, we do them before
4029 ;; checking the paren level.
4032 (/= (setq tmp
(car check-state
)) 0))
4033 ;; Check the paren level first since we're short of the
4034 ;; syntactic checking position if the end of the
4035 ;; current sexp was encountered by `parse-partial-sexp'.
4038 ;; Inside a nested paren sexp.
4039 (if lookbehind-submatch
4040 ;; See the NOTE above.
4041 (progn (goto-char state-pos
) t
)
4042 ;; Skip out of the paren quickly.
4043 (setq state
(parse-partial-sexp state-pos bound
0 nil state
)
4046 ;; Have exited the current paren sexp.
4049 ;; The last `parse-partial-sexp' call above
4050 ;; has left us just after the closing paren
4051 ;; in this case, so we can modify the bound
4052 ;; to leave the point at the right position
4054 (setq bound
(1- (point)))
4056 (signal 'search-failed
(list regexp
)))))
4058 ((setq tmp
(elt check-state
3))
4059 ;; Match inside a string.
4060 (if (or lookbehind-submatch
4061 (not (integerp tmp
)))
4062 ;; See the NOTE above.
4063 (progn (goto-char state-pos
) t
)
4064 ;; Skip to the end of the string before continuing.
4065 (let ((ender (make-string 1 tmp
)) (continue t
))
4066 (while (if (search-forward ender bound noerror
)
4068 (setq state
(parse-partial-sexp
4069 state-pos
(point) nil nil state
)
4072 (setq continue nil
)))
4077 (c-beginning-of-macro start
)))
4078 ;; Match inside a macro. Skip to the end of it.
4080 (cond ((<= (point) bound
) t
)
4082 (t (signal 'search-failed
(list regexp
)))))
4084 ((and not-inside-token
4085 (or (< check-pos last-token-end-pos
)
4088 (goto-char check-pos
)
4090 (c-end-of-current-token last-token-end-pos
))
4091 (setq last-token-end-pos
(point))))))
4093 (if lookbehind-submatch
4094 ;; See the NOTE above.
4095 (goto-char state-pos
)
4096 (goto-char (min last-token-end-pos bound
))))
4103 ;; Should loop to search again, but take care to avoid
4104 ;; looping on the same spot.
4105 (or (/= search-pos
(point))
4106 (if (= (point) bound
)
4109 (signal 'search-failed
(list regexp
)))
4115 (signal (car err
) (cdr err
))))
4117 ;;(message "c-syntactic-re-search-forward done %s" (or (match-end 0) (point)))
4121 (goto-char (match-end 0))
4124 ;; Search failed. Set point as appropriate.
4130 (defvar safe-pos-list
) ; bound in c-syntactic-skip-backward
4132 (defsubst c-ssb-lit-begin
()
4133 ;; Return the start of the literal point is in, or nil.
4134 ;; We read and write the variables `safe-pos', `safe-pos-list', `state'
4135 ;; bound in the caller.
4137 ;; Use `parse-partial-sexp' from a safe position down to the point to check
4138 ;; if it's outside comments and strings.
4140 (let ((pos (point)) safe-pos state pps-end-pos
)
4141 ;; Pick a safe position as close to the point as possible.
4143 ;; FIXME: Consult `syntax-ppss' here if our cache doesn't give a good
4146 (while (and safe-pos-list
4147 (> (car safe-pos-list
) (point)))
4148 (setq safe-pos-list
(cdr safe-pos-list
)))
4149 (unless (setq safe-pos
(car-safe safe-pos-list
))
4150 (setq safe-pos
(max (or (c-safe-position
4151 (point) (or c-state-cache
4155 safe-pos-list
(list safe-pos
)))
4157 ;; Cache positions along the way to use if we have to back up more. We
4158 ;; cache every closing paren on the same level. If the paren cache is
4159 ;; relevant in this region then we're typically already on the same
4160 ;; level as the target position. Note that we might cache positions
4161 ;; after opening parens in case safe-pos is in a nested list. That's
4162 ;; both uncommon and harmless.
4164 (setq state
(parse-partial-sexp
4167 (setq safe-pos
(point)
4168 safe-pos-list
(cons safe-pos safe-pos-list
)))
4170 ;; If the state contains the start of the containing sexp we cache that
4171 ;; position too, so that parse-partial-sexp in the next run has a bigger
4172 ;; chance of starting at the same level as the target position and thus
4173 ;; will get more good safe positions into the list.
4175 (setq safe-pos
(1+ (elt state
1))
4176 safe-pos-list
(cons safe-pos safe-pos-list
)))
4178 (if (or (elt state
3) (elt state
4))
4179 ;; Inside string or comment. Continue search at the
4183 (defun c-syntactic-skip-backward (skip-chars &optional limit paren-level
)
4184 "Like `skip-chars-backward' but only look at syntactically relevant chars,
4185 i.e. don't stop at positions inside syntactic whitespace or string
4186 literals. Preprocessor directives are also ignored, with the exception
4187 of the one that the point starts within, if any. If LIMIT is given,
4188 it's assumed to be at a syntactically relevant position.
4190 If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4191 sexps, and the search will also not go outside the current paren sexp.
4192 However, if LIMIT or the buffer limit is reached inside a nested paren
4193 then the point will be left at the limit.
4195 Non-nil is returned if the point moved, nil otherwise.
4197 Note that this function might do hidden buffer changes. See the
4198 comment at the start of cc-engine.el for more info."
4200 (let ((start (point))
4202 ;; A list of syntactically relevant positions in descending
4203 ;; order. It's used to avoid scanning repeatedly over
4204 ;; potentially large regions with `parse-partial-sexp' to verify
4205 ;; each position. Used in `c-ssb-lit-begin'
4207 ;; The result from `c-beginning-of-macro' at the start position or the
4208 ;; start position itself if it isn't within a macro. Evaluated on
4211 ;; The earliest position after the current one with the same paren
4212 ;; level. Used only when `paren-level' is set.
4214 (paren-level-pos (point)))
4218 ;; The next loop "tries" to find the end point each time round,
4219 ;; loops when it hasn't succeeded.
4222 (< (skip-chars-backward skip-chars limit
) 0)
4224 (let ((pos (point)) state-2 pps-end-pos
)
4227 ;; Don't stop inside a literal
4228 ((setq lit-beg
(c-ssb-lit-begin))
4234 (setq state-2
(parse-partial-sexp
4235 pos paren-level-pos -
1)
4236 pps-end-pos
(point))
4237 (/= (car state-2
) 0)))
4238 ;; Not at the right level.
4240 (if (and (< (car state-2
) 0)
4241 ;; We stop above if we go out of a paren.
4242 ;; Now check whether it precedes or is
4243 ;; nested in the starting sexp.
4247 pps-end-pos paren-level-pos
4249 (< (car state-2
) 0)))
4251 ;; We've stopped short of the starting position
4252 ;; so the hit was inside a nested list. Go up
4253 ;; until we are at the right level.
4256 (goto-char (scan-lists pos -
1
4258 (setq paren-level-pos
(point))
4259 (if (and limit
(>= limit paren-level-pos
))
4265 (goto-char (or limit
(point-min)))
4268 ;; The hit was outside the list at the start
4269 ;; position. Go to the start of the list and exit.
4270 (goto-char (1+ (elt state-2
1)))
4273 ((c-beginning-of-macro limit
)
4277 (setq start-macro-beg
4280 (c-beginning-of-macro limit
)
4284 ;; It's inside the same macro we started in so it's
4285 ;; a relevant match.
4291 ;; Skip syntactic ws afterwards so that we don't stop at the
4292 ;; end of a comment if `skip-chars' is something like "^/".
4293 (c-backward-syntactic-ws)
4296 ;; We might want to extend this with more useful return values in
4298 (/= (point) start
)))
4300 ;; The following is an alternative implementation of
4301 ;; `c-syntactic-skip-backward' that uses backward movement to keep
4302 ;; track of the syntactic context. It turned out to be generally
4303 ;; slower than the one above which uses forward checks from earlier
4306 ;;(defconst c-ssb-stop-re
4307 ;; ;; The regexp matching chars `c-syntactic-skip-backward' needs to
4308 ;; ;; stop at to avoid going into comments and literals.
4310 ;; ;; Match comment end syntax and string literal syntax. Also match
4311 ;; ;; '/' for block comment endings (not covered by comment end
4313 ;; "\\s>\\|/\\|\\s\""
4314 ;; (if (memq 'gen-string-delim c-emacs-features)
4317 ;; (if (memq 'gen-comment-delim c-emacs-features)
4321 ;;(defconst c-ssb-stop-paren-re
4322 ;; ;; Like `c-ssb-stop-re' but also stops at paren chars.
4323 ;; (concat c-ssb-stop-re "\\|\\s(\\|\\s)"))
4325 ;;(defconst c-ssb-sexp-end-re
4326 ;; ;; Regexp matching the ending syntax of a complex sexp.
4327 ;; (concat c-string-limit-regexp "\\|\\s)"))
4329 ;;(defun c-syntactic-skip-backward (skip-chars &optional limit paren-level)
4330 ;; "Like `skip-chars-backward' but only look at syntactically relevant chars,
4331 ;;i.e. don't stop at positions inside syntactic whitespace or string
4332 ;;literals. Preprocessor directives are also ignored. However, if the
4333 ;;point is within a comment, string literal or preprocessor directory to
4334 ;;begin with, its contents is treated as syntactically relevant chars.
4335 ;;If LIMIT is given, it limits the backward search and the point will be
4336 ;;left there if no earlier position is found.
4338 ;;If PAREN-LEVEL is non-nil, the function won't stop in nested paren
4339 ;;sexps, and the search will also not go outside the current paren sexp.
4340 ;;However, if LIMIT or the buffer limit is reached inside a nested paren
4341 ;;then the point will be left at the limit.
4343 ;;Non-nil is returned if the point moved, nil otherwise.
4345 ;;Note that this function might do hidden buffer changes. See the
4346 ;;comment at the start of cc-engine.el for more info."
4348 ;; (save-restriction
4350 ;; (narrow-to-region limit (point-max)))
4352 ;; (let ((start (point)))
4354 ;; (while (let ((last-pos (point))
4356 ;; (skip-chars-backward skip-chars)
4359 ;; ;; Skip back over the same region as
4360 ;; ;; `skip-chars-backward' above, but keep to
4361 ;; ;; syntactically relevant positions.
4362 ;; (goto-char last-pos)
4364 ;; ;; `re-search-backward' with a single char regexp
4365 ;; ;; should be fast.
4366 ;; (re-search-backward
4367 ;; (if paren-level c-ssb-stop-paren-re c-ssb-stop-re)
4372 ;; ((looking-at "\\s(")
4373 ;; ;; `paren-level' is set and we've found the
4374 ;; ;; start of the containing paren.
4378 ;; ((looking-at c-ssb-sexp-end-re)
4379 ;; ;; We're at the end of a string literal or paren
4380 ;; ;; sexp (if `paren-level' is set).
4382 ;; (condition-case nil
4383 ;; (c-backward-sexp)
4385 ;; (goto-char limit)
4386 ;; (throw 'done t))))
4390 ;; ;; At the end of some syntactic ws or possibly
4391 ;; ;; after a plain '/' operator.
4392 ;; (let ((pos (point)))
4393 ;; (c-backward-syntactic-ws)
4394 ;; (if (= pos (point))
4395 ;; ;; Was a plain '/' operator. Go past it.
4396 ;; (backward-char)))))
4398 ;; (> (point) stop-pos))))
4400 ;; ;; Now the point is either at `stop-pos' or at some
4401 ;; ;; position further back if `stop-pos' was at a
4402 ;; ;; syntactically irrelevant place.
4404 ;; ;; Skip additional syntactic ws so that we don't stop
4405 ;; ;; at the end of a comment if `skip-chars' is
4406 ;; ;; something like "^/".
4407 ;; (c-backward-syntactic-ws)
4409 ;; (< (point) stop-pos))))
4411 ;; ;; We might want to extend this with more useful return values
4412 ;; ;; in the future.
4413 ;; (/= (point) start))))
4416 ;; Tools for handling comments and string literals.
4418 (defun c-in-literal (&optional lim detect-cpp
)
4419 "Return the type of literal point is in, if any.
4420 The return value is `c' if in a C-style comment, `c++' if in a C++
4421 style comment, `string' if in a string literal, `pound' if DETECT-CPP
4422 is non-nil and in a preprocessor line, or nil if somewhere else.
4423 Optional LIM is used as the backward limit of the search. If omitted,
4424 or nil, `c-beginning-of-defun' is used.
4426 The last point calculated is cached if the cache is enabled, i.e. if
4427 `c-in-literal-cache' is bound to a two element vector.
4429 Note that this function might do hidden buffer changes. See the
4430 comment at the start of cc-engine.el for more info."
4433 (let* ((safe-place (c-state-semi-safe-place (point)))
4434 (lit (c-state-pp-to-literal safe-place
(point))))
4437 (save-excursion (c-beginning-of-macro))
4440 (defun c-literal-limits (&optional lim near not-in-delimiter
)
4441 "Return a cons of the beginning and end positions of the comment or
4442 string surrounding point (including both delimiters), or nil if point
4443 isn't in one. If LIM is non-nil, it's used as the \"safe\" position
4444 to start parsing from. If NEAR is non-nil, then the limits of any
4445 literal next to point is returned. \"Next to\" means there's only
4446 spaces and tabs between point and the literal. The search for such a
4447 literal is done first in forward direction. If NOT-IN-DELIMITER is
4448 non-nil, the case when point is inside a starting delimiter won't be
4449 recognized. This only has effect for comments which have starting
4450 delimiters with more than one character.
4452 Note that this function might do hidden buffer changes. See the
4453 comment at the start of cc-engine.el for more info."
4456 (let* ((pos (point))
4457 (lim (or lim
(c-state-semi-safe-place pos
)))
4458 (pp-to-lit (save-restriction
4460 (c-state-pp-to-literal lim pos not-in-delimiter
)))
4461 (state (car pp-to-lit
))
4462 (lit-limits (car (cddr pp-to-lit
))))
4469 ;; Search forward for a literal.
4470 (skip-chars-forward " \t")
4472 ((looking-at c-string-limit-regexp
) ; String.
4473 (cons (point) (or (c-safe (c-forward-sexp 1) (point))
4476 ((looking-at c-comment-start-regexp
) ; Line or block comment.
4477 (cons (point) (progn (c-forward-single-comment) (point))))
4481 (skip-chars-backward " \t")
4483 (let ((end (point)) beg
)
4486 (< (skip-syntax-backward c-string-syntax
) 0)) ; String.
4487 (setq beg
(c-safe (c-backward-sexp 1) (point))))
4489 ((and (c-safe (forward-char -
2) t
)
4491 ;; Block comment. Due to the nature of line
4492 ;; comments, they will always be covered by the
4493 ;; normal case above.
4495 (c-backward-single-comment)
4496 ;; If LIM is bogus, beg will be bogus.
4497 (setq beg
(point))))
4499 (if beg
(cons beg end
))))))
4502 ;; In case external callers use this; it did have a docstring.
4503 (defalias 'c-literal-limits-fast
'c-literal-limits
)
4505 (defun c-collect-line-comments (range)
4506 "If the argument is a cons of two buffer positions (such as returned by
4507 `c-literal-limits'), and that range contains a C++ style line comment,
4508 then an extended range is returned that contains all adjacent line
4509 comments (i.e. all comments that starts in the same column with no
4510 empty lines or non-whitespace characters between them). Otherwise the
4511 argument is returned.
4513 Note that this function might do hidden buffer changes. See the
4514 comment at the start of cc-engine.el for more info."
4518 (if (and (consp range
) (progn
4519 (goto-char (car range
))
4520 (looking-at c-line-comment-starter
)))
4521 (let ((col (current-column))
4523 (bopl (c-point 'bopl
))
4525 ;; Got to take care in the backward direction to handle
4526 ;; comments which are preceded by code.
4527 (while (and (c-backward-single-comment)
4529 (looking-at c-line-comment-starter
)
4530 (= col
(current-column)))
4532 bopl
(c-point 'bopl
)))
4534 (while (and (progn (skip-chars-forward " \t")
4535 (looking-at c-line-comment-starter
))
4536 (= col
(current-column))
4537 (prog1 (zerop (forward-line 1))
4538 (setq end
(point)))))
4543 (defun c-literal-type (range)
4544 "Convenience function that given the result of `c-literal-limits',
4545 returns nil or the type of literal that the range surrounds, one
4546 of the symbols 'c, 'c++ or 'string. It's much faster than using
4547 `c-in-literal' and is intended to be used when you need both the
4548 type of a literal and its limits.
4550 Note that this function might do hidden buffer changes. See the
4551 comment at the start of cc-engine.el for more info."
4555 (goto-char (car range
))
4556 (cond ((looking-at c-string-limit-regexp
) 'string
)
4557 ((or (looking-at "//") ; c++ line comment
4558 (and (looking-at "\\s<") ; comment starter
4559 (looking-at "#"))) ; awk comment.
4561 (t 'c
))) ; Assuming the range is valid.
4564 (defsubst c-determine-limit-get-base
(start try-size
)
4565 ;; Get a "safe place" approximately TRY-SIZE characters before START.
4566 ;; This doesn't preserve point.
4567 (let* ((pos (max (- start try-size
) (point-min)))
4568 (base (c-state-semi-safe-place pos
))
4569 (s (parse-partial-sexp base pos
)))
4570 (if (or (nth 4 s
) (nth 3 s
)) ; comment or string
4574 (defun c-determine-limit (how-far-back &optional start try-size
)
4575 ;; Return a buffer position HOW-FAR-BACK non-literal characters from START
4576 ;; (default point). This is done by going back further in the buffer then
4577 ;; searching forward for literals. The position found won't be in a
4578 ;; literal. We start searching for the sought position TRY-SIZE (default
4579 ;; twice HOW-FAR-BACK) bytes back from START. This function must be fast.
4582 (let* ((start (or start
(point)))
4583 (try-size (or try-size
(* 2 how-far-back
)))
4584 (base (c-determine-limit-get-base start try-size
))
4587 (s (parse-partial-sexp pos pos
)) ; null state.
4590 (while (< pos start
)
4591 ;; Move forward one literal each time round this loop.
4592 ;; Move forward to the start of a comment or string.
4593 (setq s
(parse-partial-sexp
4599 'syntax-table
)) ; stop-comment
4601 ;; Gather details of the non-literal-bit - starting pos and size.
4602 (setq size
(- (if (or (nth 4 s
) (nth 3 s
))
4607 (setq stack
(cons (cons pos size
) stack
)))
4609 ;; Move forward to the end of the comment/string.
4610 (if (or (nth 4 s
) (nth 3 s
))
4611 (setq s
(parse-partial-sexp
4617 'syntax-table
))) ; stop-comment
4620 ;; Now try and find enough non-literal characters recorded on the stack.
4621 ;; Go back one recorded literal each time round this loop.
4622 (while (and (< count how-far-back
)
4624 (setq elt
(car stack
)
4626 (setq count
(+ count
(cdr elt
))))
4628 ;; Have we found enough yet?
4630 ((>= count how-far-back
)
4631 (+ (car elt
) (- count how-far-back
)))
4632 ((eq base
(point-min))
4635 (c-determine-limit (- how-far-back count
) base try-size
))))))
4637 (defun c-determine-+ve-limit
(how-far &optional start-pos
)
4638 ;; Return a buffer position about HOW-FAR non-literal characters forward
4639 ;; from START-POS (default point), which must not be inside a literal.
4641 (let ((pos (or start-pos
(point)))
4643 (s (parse-partial-sexp (point) (point)))) ; null state
4644 (while (and (not (eobp))
4646 ;; Scan over counted characters.
4647 (setq s
(parse-partial-sexp
4649 (min (+ pos count
) (point-max))
4653 'syntax-table
)) ; stop-comment
4654 (setq count
(- count
(- (point) pos
) 1)
4656 ;; Scan over literal characters.
4658 (setq s
(parse-partial-sexp
4664 'syntax-table
) ; stop-comment
4669 ;; `c-find-decl-spots' and accompanying stuff.
4671 ;; Variables used in `c-find-decl-spots' to cache the search done for
4672 ;; the first declaration in the last call. When that function starts,
4673 ;; it needs to back up over syntactic whitespace to look at the last
4674 ;; token before the region being searched. That can sometimes cause
4675 ;; moves back and forth over a quite large region of comments and
4676 ;; macros, which would be repeated for each changed character when
4677 ;; we're called during fontification, since font-lock refontifies the
4678 ;; current line for each change. Thus it's worthwhile to cache the
4681 ;; `c-find-decl-syntactic-pos' is a syntactically relevant position in
4682 ;; the syntactic whitespace less or equal to some start position.
4683 ;; There's no cached value if it's nil.
4685 ;; `c-find-decl-match-pos' is the match position if
4686 ;; `c-find-decl-prefix-search' matched before the syntactic whitespace
4687 ;; at `c-find-decl-syntactic-pos', or nil if there's no such match.
4688 (defvar c-find-decl-syntactic-pos nil
)
4689 (make-variable-buffer-local 'c-find-decl-syntactic-pos
)
4690 (defvar c-find-decl-match-pos nil
)
4691 (make-variable-buffer-local 'c-find-decl-match-pos
)
4693 (defsubst c-invalidate-find-decl-cache
(change-min-pos)
4694 (and c-find-decl-syntactic-pos
4695 (< change-min-pos c-find-decl-syntactic-pos
)
4696 (setq c-find-decl-syntactic-pos nil
)))
4698 ; (defface c-debug-decl-spot-face
4699 ; '((t (:background "Turquoise")))
4700 ; "Debug face to mark the spots where `c-find-decl-spots' stopped.")
4701 ; (defface c-debug-decl-sws-face
4702 ; '((t (:background "Khaki")))
4703 ; "Debug face to mark the syntactic whitespace between the declaration
4704 ; spots and the preceding token end.")
4706 (defmacro c-debug-put-decl-spot-faces
(match-pos decl-pos
)
4707 (when (facep 'c-debug-decl-spot-face
)
4708 `(c-save-buffer-state ((match-pos ,match-pos
) (decl-pos ,decl-pos
))
4709 (c-debug-add-face (max match-pos
(point-min)) decl-pos
4710 'c-debug-decl-sws-face
)
4711 (c-debug-add-face decl-pos
(min (1+ decl-pos
) (point-max))
4712 'c-debug-decl-spot-face
))))
4713 (defmacro c-debug-remove-decl-spot-faces
(beg end
)
4714 (when (facep 'c-debug-decl-spot-face
)
4715 `(c-save-buffer-state ()
4716 (c-debug-remove-face ,beg
,end
'c-debug-decl-spot-face
)
4717 (c-debug-remove-face ,beg
,end
'c-debug-decl-sws-face
))))
4719 (defmacro c-find-decl-prefix-search
()
4720 ;; Macro used inside `c-find-decl-spots'. It ought to be a defun,
4721 ;; but it contains lots of free variables that refer to things
4722 ;; inside `c-find-decl-spots'. The point is left at `cfd-match-pos'
4723 ;; if there is a match, otherwise at `cfd-limit'.
4725 ;; This macro might do hidden buffer changes.
4728 ;; Find the next property match position if we haven't got one already.
4729 (unless cfd-prop-match
4732 (goto-char (next-single-property-change
4733 (point) 'c-type nil cfd-limit
))
4734 (and (< (point) cfd-limit
)
4735 (not (eq (c-get-char-property (1- (point)) 'c-type
)
4737 (setq cfd-prop-match
(point))))
4739 ;; Find the next `c-decl-prefix-or-start-re' match if we haven't
4741 (unless cfd-re-match
4743 (if (> cfd-re-match-end
(point))
4744 (goto-char cfd-re-match-end
))
4746 (while (if (setq cfd-re-match-end
4747 (re-search-forward c-decl-prefix-or-start-re
4750 ;; Match. Check if it's inside a comment or string literal.
4752 (if (setq cfd-re-match
(match-end 1))
4753 ;; Matched the end of a token preceding a decl spot.
4755 (goto-char cfd-re-match
)
4757 ;; Matched a token that start a decl spot.
4758 (goto-char (match-beginning 0))
4762 ;; No match. Finish up and exit the loop.
4763 (setq cfd-re-match cfd-limit
)
4766 ;; Skip out of comments and string literals.
4768 (goto-char (next-single-property-change
4769 (point) 'face nil cfd-limit
))
4770 (and (< (point) cfd-limit
)
4771 (c-got-face-at (point) c-literal-faces
)))))
4773 ;; If we matched at the decl start, we have to back up over the
4774 ;; preceding syntactic ws to set `cfd-match-pos' and to catch
4775 ;; any decl spots in the syntactic ws.
4776 (unless cfd-re-match
4777 (c-backward-syntactic-ws)
4778 (setq cfd-re-match
(point))))
4780 ;; Choose whichever match is closer to the start.
4781 (if (< cfd-re-match cfd-prop-match
)
4782 (setq cfd-match-pos cfd-re-match
4784 (setq cfd-match-pos cfd-prop-match
4785 cfd-prop-match nil
))
4787 (goto-char cfd-match-pos
)
4789 (when (< cfd-match-pos cfd-limit
)
4790 ;; Skip forward past comments only so we don't skip macros.
4791 (c-forward-comments)
4792 ;; Set the position to continue at. We can avoid going over
4793 ;; the comments skipped above a second time, but it's possible
4794 ;; that the comment skipping has taken us past `cfd-prop-match'
4795 ;; since the property might be used inside comments.
4796 (setq cfd-continue-pos
(if cfd-prop-match
4797 (min cfd-prop-match
(point))
4800 (defun c-find-decl-spots (cfd-limit cfd-decl-re cfd-face-checklist cfd-fun
)
4801 ;; Call CFD-FUN for each possible spot for a declaration, cast or
4802 ;; label from the point to CFD-LIMIT.
4804 ;; CFD-FUN is called with point at the start of the spot. It's passed two
4805 ;; arguments: The first is the end position of the token preceding the spot,
4806 ;; or 0 for the implicit match at bob. The second is a flag that is t when
4807 ;; the match is inside a macro. Point should be moved forward by at least
4810 ;; If CFD-FUN adds `c-decl-end' properties somewhere below the current spot,
4811 ;; it should return non-nil to ensure that the next search will find them.
4814 ;; o The first token after bob.
4815 ;; o The first token after the end of submatch 1 in
4816 ;; `c-decl-prefix-or-start-re' when that submatch matches.
4817 ;; o The start of each `c-decl-prefix-or-start-re' match when
4818 ;; submatch 1 doesn't match.
4819 ;; o The first token after the end of each occurrence of the
4820 ;; `c-type' text property with the value `c-decl-end', provided
4821 ;; `c-type-decl-end-used' is set.
4823 ;; Only a spot that match CFD-DECL-RE and whose face is in the
4824 ;; CFD-FACE-CHECKLIST list causes CFD-FUN to be called. The face
4825 ;; check is disabled if CFD-FACE-CHECKLIST is nil.
4827 ;; If the match is inside a macro then the buffer is narrowed to the
4828 ;; end of it, so that CFD-FUN can investigate the following tokens
4829 ;; without matching something that begins inside a macro and ends
4830 ;; outside it. It's to avoid this work that the CFD-DECL-RE and
4831 ;; CFD-FACE-CHECKLIST checks exist.
4833 ;; The spots are visited approximately in order from top to bottom.
4834 ;; It's however the positions where `c-decl-prefix-or-start-re'
4835 ;; matches and where `c-decl-end' properties are found that are in
4836 ;; order. Since the spots often are at the following token, they
4837 ;; might be visited out of order insofar as more spots are reported
4838 ;; later on within the syntactic whitespace between the match
4839 ;; positions and their spots.
4841 ;; It's assumed that comments and strings are fontified in the
4844 ;; This is mainly used in fontification, and so has an elaborate
4845 ;; cache to handle repeated calls from the same start position; see
4846 ;; the variables above.
4848 ;; All variables in this function begin with `cfd-' to avoid name
4849 ;; collision with the (dynamically bound) variables used in CFD-FUN.
4851 ;; This function might do hidden buffer changes.
4853 (let ((cfd-start-pos (point))
4854 (cfd-buffer-end (point-max))
4855 ;; The end of the token preceding the decl spot last found
4856 ;; with `c-decl-prefix-or-start-re'. `cfd-limit' if there's
4859 ;; The end position of the last `c-decl-prefix-or-start-re'
4860 ;; match. If this is greater than `cfd-continue-pos', the
4861 ;; next regexp search is started here instead.
4862 (cfd-re-match-end (point-min))
4863 ;; The end of the last `c-decl-end' found by
4864 ;; `c-find-decl-prefix-search'. `cfd-limit' if there's no
4865 ;; match. If searching for the property isn't needed then we
4866 ;; disable it by setting it to `cfd-limit' directly.
4867 (cfd-prop-match (unless c-type-decl-end-used cfd-limit
))
4868 ;; The end of the token preceding the decl spot last found by
4869 ;; `c-find-decl-prefix-search'. 0 for the implicit match at
4870 ;; bob. `cfd-limit' if there's no match. In other words,
4871 ;; this is the minimum of `cfd-re-match' and `cfd-prop-match'.
4872 (cfd-match-pos cfd-limit
)
4873 ;; The position to continue searching at.
4875 ;; The position of the last "real" token we've stopped at.
4876 ;; This can be greater than `cfd-continue-pos' when we get
4877 ;; hits inside macros or at `c-decl-end' positions inside
4880 ;; The end position of the last entered macro.
4883 ;; Initialize by finding a syntactically relevant start position
4884 ;; before the point, and do the first `c-decl-prefix-or-start-re'
4885 ;; search unless we're at bob.
4887 (let (start-in-literal start-in-macro syntactic-pos
)
4888 ;; Must back up a bit since we look for the end of the previous
4889 ;; statement or declaration, which is earlier than the first
4893 ;; First we need to move to a syntactically relevant position.
4894 ;; Begin by backing out of comment or string literals.
4896 (when (c-got-face-at (point) c-literal-faces
)
4897 ;; Try to use the faces to back up to the start of the
4898 ;; literal. FIXME: What if the point is on a declaration
4899 ;; inside a comment?
4900 (while (and (not (bobp))
4901 (c-got-face-at (1- (point)) c-literal-faces
))
4902 (goto-char (previous-single-property-change
4903 (point) 'face nil
(point-min))))
4905 ;; XEmacs doesn't fontify the quotes surrounding string
4907 (and (featurep 'xemacs
)
4908 (eq (get-text-property (point) 'face
)
4909 'font-lock-string-face
)
4911 (progn (backward-char)
4912 (not (looking-at c-string-limit-regexp
)))
4915 ;; Don't trust the literal to contain only literal faces
4916 ;; (the font lock package might not have fontified the
4917 ;; start of it at all, for instance) so check that we have
4918 ;; arrived at something that looks like a start or else
4919 ;; resort to `c-literal-limits'.
4920 (unless (looking-at c-literal-start-regexp
)
4921 (let ((range (c-literal-limits)))
4922 (if range
(goto-char (car range
)))))
4924 (setq start-in-literal
(point)))
4926 ;; The start is in a literal. If the limit is in the same
4927 ;; one we don't have to find a syntactic position etc. We
4928 ;; only check that if the limit is at or before bonl to save
4929 ;; time; it covers the by far most common case when font-lock
4930 ;; refontifies the current line only.
4931 (<= cfd-limit
(c-point 'bonl cfd-start-pos
))
4933 (goto-char cfd-start-pos
)
4935 (goto-char (next-single-property-change
4936 (point) 'face nil cfd-limit
))
4937 (and (< (point) cfd-limit
)
4938 (c-got-face-at (point) c-literal-faces
))))
4939 (= (point) cfd-limit
)))
4941 ;; Completely inside a literal. Set up variables to trig the
4942 ;; (< cfd-continue-pos cfd-start-pos) case below and it'll
4943 ;; find a suitable start position.
4944 (setq cfd-continue-pos start-in-literal
))
4946 ;; Check if the region might be completely inside a macro, to
4947 ;; optimize that like the completely-inside-literal above.
4949 (and (= (forward-line 1) 0)
4950 (bolp) ; forward-line has funny behavior at eob.
4951 (>= (point) cfd-limit
)
4952 (progn (backward-char)
4953 (eq (char-before) ?
\\))))
4954 ;; (Maybe) completely inside a macro. Only need to trig the
4955 ;; (< cfd-continue-pos cfd-start-pos) case below to make it
4957 (setq cfd-continue-pos
(1- cfd-start-pos
)
4961 ;; Back out of any macro so we don't miss any declaration
4962 ;; that could follow after it.
4963 (when (c-beginning-of-macro)
4964 (setq start-in-macro t
))
4966 ;; Now we're at a proper syntactically relevant position so we
4967 ;; can use the cache. But first clear it if it applied
4969 (c-invalidate-find-decl-cache cfd-start-pos
)
4971 (setq syntactic-pos
(point))
4972 (unless (eq syntactic-pos c-find-decl-syntactic-pos
)
4973 ;; Don't have to do this if the cache is relevant here,
4974 ;; typically if the same line is refontified again. If
4975 ;; we're just some syntactic whitespace further down we can
4976 ;; still use the cache to limit the skipping.
4977 (c-backward-syntactic-ws c-find-decl-syntactic-pos
))
4979 ;; If we hit `c-find-decl-syntactic-pos' and
4980 ;; `c-find-decl-match-pos' is set then we install the cached
4981 ;; values. If we hit `c-find-decl-syntactic-pos' and
4982 ;; `c-find-decl-match-pos' is nil then we know there's no decl
4983 ;; prefix in the whitespace before `c-find-decl-syntactic-pos'
4984 ;; and so we can continue the search from this point. If we
4985 ;; didn't hit `c-find-decl-syntactic-pos' then we're now in
4986 ;; the right spot to begin searching anyway.
4987 (if (and (eq (point) c-find-decl-syntactic-pos
)
4988 c-find-decl-match-pos
)
4989 (setq cfd-match-pos c-find-decl-match-pos
4990 cfd-continue-pos syntactic-pos
)
4992 (setq c-find-decl-syntactic-pos syntactic-pos
)
4995 ;; Always consider bob a match to get the first
4996 ;; declaration in the file. Do this separately instead of
4997 ;; letting `c-decl-prefix-or-start-re' match bob, so that
4998 ;; regexp always can consume at least one character to
4999 ;; ensure that we won't get stuck in an infinite loop.
5000 (setq cfd-re-match
0)
5002 (c-beginning-of-current-token)
5003 (< (point) cfd-limit
))
5004 ;; Do an initial search now. In the bob case above it's
5005 ;; only done to search for a `c-decl-end' spot.
5006 (c-find-decl-prefix-search))
5008 (setq c-find-decl-match-pos
(and (< cfd-match-pos cfd-start-pos
)
5011 ;; Advance `cfd-continue-pos' if it's before the start position.
5012 ;; The closest continue position that might have effect at or
5013 ;; after the start depends on what we started in. This also
5014 ;; finds a suitable start position in the special cases when the
5015 ;; region is completely within a literal or macro.
5016 (when (and cfd-continue-pos
(< cfd-continue-pos cfd-start-pos
))
5020 ;; If we're in a macro then it's the closest preceding token
5021 ;; in the macro. Check this before `start-in-literal',
5022 ;; since if we're inside a literal in a macro, the preceding
5023 ;; token is earlier than any `c-decl-end' spot inside the
5024 ;; literal (comment).
5025 (goto-char (or start-in-literal cfd-start-pos
))
5026 ;; The only syntactic ws in macros are comments.
5027 (c-backward-comments)
5029 (c-beginning-of-current-token))
5032 ;; If we're in a comment it can only be the closest
5033 ;; preceding `c-decl-end' position within that comment, if
5034 ;; any. Go back to the beginning of such a property so that
5035 ;; `c-find-decl-prefix-search' will find the end of it.
5036 ;; (Can't stop at the end and install it directly on
5037 ;; `cfd-prop-match' since that variable might be cleared
5038 ;; after `cfd-fun' below.)
5040 ;; Note that if the literal is a string then the property
5041 ;; search will simply skip to the beginning of it right
5043 (if (not c-type-decl-end-used
)
5044 (goto-char start-in-literal
)
5045 (goto-char cfd-start-pos
)
5047 (goto-char (previous-single-property-change
5048 (point) 'c-type nil start-in-literal
))
5049 (and (> (point) start-in-literal
)
5050 (not (eq (c-get-char-property (point) 'c-type
)
5053 (when (= (point) start-in-literal
)
5054 ;; Didn't find any property inside the comment, so we can
5055 ;; skip it entirely. (This won't skip past a string, but
5056 ;; that'll be handled quickly by the next
5057 ;; `c-find-decl-prefix-search' anyway.)
5058 (c-forward-single-comment)
5059 (if (> (point) cfd-limit
)
5060 (goto-char cfd-limit
))))
5063 ;; If we started in normal code, the only match that might
5064 ;; apply before the start is what we already got in
5065 ;; `cfd-match-pos' so we can continue at the start position.
5066 ;; (Note that we don't get here if the first match is below
5068 (goto-char cfd-start-pos
)))
5070 ;; Delete found matches if they are before our new continue
5071 ;; position, so that `c-find-decl-prefix-search' won't back up
5072 ;; to them later on.
5073 (setq cfd-continue-pos
(point))
5074 (when (and cfd-re-match
(< cfd-re-match cfd-continue-pos
))
5075 (setq cfd-re-match nil
))
5076 (when (and cfd-prop-match
(< cfd-prop-match cfd-continue-pos
))
5077 (setq cfd-prop-match nil
)))
5080 ;; This is the normal case and we got a proper syntactic
5081 ;; position. If there's a match then it's always outside
5082 ;; macros and comments, so advance to the next token and set
5083 ;; `cfd-token-pos'. The loop below will later go back using
5084 ;; `cfd-continue-pos' to fix declarations inside the
5086 (when (and cfd-match-pos
(< cfd-match-pos syntactic-pos
))
5087 (goto-char syntactic-pos
)
5088 (c-forward-syntactic-ws)
5089 (and cfd-continue-pos
5090 (< cfd-continue-pos
(point))
5091 (setq cfd-token-pos
(point))))
5093 ;; Have one of the special cases when the region is completely
5094 ;; within a literal or macro. `cfd-continue-pos' is set to a
5095 ;; good start position for the search, so do it.
5096 (c-find-decl-prefix-search)))
5098 ;; Now loop. Round what? (ACM, 2006/7/5). We already got the first match.
5102 (< cfd-match-pos cfd-limit
)
5105 ;; Kludge to filter out matches on the "<" that
5106 ;; aren't open parens, for the sake of languages
5107 ;; that got `c-recognize-<>-arglists' set.
5108 (and (eq (char-before cfd-match-pos
) ?
<)
5109 (not (c-get-char-property (1- cfd-match-pos
)
5112 ;; If `cfd-continue-pos' is less or equal to
5113 ;; `cfd-token-pos', we've got a hit inside a macro
5114 ;; that's in the syntactic whitespace before the last
5115 ;; "real" declaration we've checked. If they're equal
5116 ;; we've arrived at the declaration a second time, so
5117 ;; there's nothing to do.
5118 (= cfd-continue-pos cfd-token-pos
)
5121 ;; If `cfd-continue-pos' is less than `cfd-token-pos'
5122 ;; we're still searching for declarations embedded in
5123 ;; the syntactic whitespace. In that case we need
5124 ;; only to skip comments and not macros, since they
5125 ;; can't be nested, and that's already been done in
5126 ;; `c-find-decl-prefix-search'.
5127 (when (> cfd-continue-pos cfd-token-pos
)
5128 (c-forward-syntactic-ws)
5129 (setq cfd-token-pos
(point)))
5131 ;; Continue if the following token fails the
5132 ;; CFD-DECL-RE and CFD-FACE-CHECKLIST checks.
5133 (when (or (>= (point) cfd-limit
)
5134 (not (looking-at cfd-decl-re
))
5135 (and cfd-face-checklist
5137 (point) cfd-face-checklist
))))
5138 (goto-char cfd-continue-pos
)
5141 (< (point) cfd-limit
))
5142 (c-find-decl-prefix-search))
5144 (< (point) cfd-limit
))
5147 (>= (point) cfd-start-pos
)
5150 ;; Narrow to the end of the macro if we got a hit inside
5151 ;; one, to avoid recognizing things that start inside the
5152 ;; macro and end outside it.
5153 (when (> cfd-match-pos cfd-macro-end
)
5154 ;; Not in the same macro as in the previous round.
5156 (goto-char cfd-match-pos
)
5158 (if (save-excursion (and (c-beginning-of-macro)
5159 (< (point) cfd-match-pos
)))
5160 (progn (c-end-of-macro)
5164 (if (zerop cfd-macro-end
)
5166 (if (> cfd-macro-end
(point))
5167 (progn (narrow-to-region (point-min) cfd-macro-end
)
5169 ;; The matched token was the last thing in the macro,
5170 ;; so the whole match is bogus.
5171 (setq cfd-macro-end
0)
5174 (c-debug-put-decl-spot-faces cfd-match-pos
(point))
5175 (if (funcall cfd-fun cfd-match-pos
(/= cfd-macro-end
0))
5176 (setq cfd-prop-match nil
))
5178 (when (/= cfd-macro-end
0)
5179 ;; Restore limits if we did macro narrowing above.
5180 (narrow-to-region (point-min) cfd-buffer-end
)))
5182 (goto-char cfd-continue-pos
)
5183 (if (= cfd-continue-pos cfd-limit
)
5184 (setq cfd-match-pos cfd-limit
)
5185 (c-find-decl-prefix-search))))) ; Moves point, sets cfd-continue-pos,
5186 ; cfd-match-pos, etc.
5189 ;; A cache for found types.
5191 ;; Buffer local variable that contains an obarray with the types we've
5192 ;; found. If a declaration is recognized somewhere we record the
5193 ;; fully qualified identifier in it to recognize it as a type
5194 ;; elsewhere in the file too. This is not accurate since we do not
5195 ;; bother with the scoping rules of the languages, but in practice the
5196 ;; same name is seldom used as both a type and something else in a
5197 ;; file, and we only use this as a last resort in ambiguous cases (see
5198 ;; `c-forward-decl-or-cast-1').
5200 ;; Not every type need be in this cache. However, things which have
5201 ;; ceased to be types must be removed from it.
5203 ;; Template types in C++ are added here too but with the template
5204 ;; arglist replaced with "<>" in references or "<" for the one in the
5205 ;; primary type. E.g. the type "Foo<A,B>::Bar<C>" is stored as
5206 ;; "Foo<>::Bar<". This avoids storing very long strings (since C++
5207 ;; template specs can be fairly sized programs in themselves) and
5208 ;; improves the hit ratio (it's a type regardless of the template
5209 ;; args; it's just not the same type, but we're only interested in
5210 ;; recognizing types, not telling distinct types apart). Note that
5211 ;; template types in references are added here too; from the example
5212 ;; above there will also be an entry "Foo<".
5213 (defvar c-found-types nil
)
5214 (make-variable-buffer-local 'c-found-types
)
5216 (defsubst c-clear-found-types
()
5217 ;; Clears `c-found-types'.
5218 (setq c-found-types
(make-vector 53 0)))
5220 (defun c-add-type (from to
)
5221 ;; Add the given region as a type in `c-found-types'. If the region
5222 ;; doesn't match an existing type but there is a type which is equal
5223 ;; to the given one except that the last character is missing, then
5224 ;; the shorter type is removed. That's done to avoid adding all
5225 ;; prefixes of a type as it's being entered and font locked. This
5226 ;; doesn't cover cases like when characters are removed from a type
5227 ;; or added in the middle. We'd need the position of point when the
5228 ;; font locking is invoked to solve this well.
5230 ;; This function might do hidden buffer changes.
5231 (let ((type (c-syntactic-content from to c-recognize-
<>-arglists
)))
5232 (unless (intern-soft type c-found-types
)
5233 (unintern (substring type
0 -
1) c-found-types
)
5234 (intern type c-found-types
))))
5236 (defun c-unfind-type (name)
5237 ;; Remove the "NAME" from c-found-types, if present.
5238 (unintern name c-found-types
))
5240 (defsubst c-check-type
(from to
)
5241 ;; Return non-nil if the given region contains a type in
5244 ;; This function might do hidden buffer changes.
5245 (intern-soft (c-syntactic-content from to c-recognize-
<>-arglists
)
5248 (defun c-list-found-types ()
5249 ;; Return all the types in `c-found-types' as a sorted list of
5252 (mapatoms (lambda (type)
5253 (setq type-list
(cons (symbol-name type
)
5256 (sort type-list
'string-lessp
)))
5258 ;; Shut up the byte compiler.
5259 (defvar c-maybe-stale-found-type
)
5261 (defun c-trim-found-types (beg end old-len
)
5262 ;; An after change function which, in conjunction with the info in
5263 ;; c-maybe-stale-found-type (set in c-before-change), removes a type
5264 ;; from `c-found-types', should this type have become stale. For
5265 ;; example, this happens to "foo" when "foo \n bar();" becomes
5266 ;; "foo(); \n bar();". Such stale types, if not removed, foul up
5267 ;; the fontification.
5269 ;; Have we, perhaps, added non-ws characters to the front/back of a found
5273 (when (< end
(point-max))
5275 (if (and (c-beginning-of-current-token) ; only moves when we started in the middle
5276 (progn (goto-char end
)
5277 (c-end-of-current-token)))
5278 (c-unfind-type (buffer-substring-no-properties
5280 (when (> beg
(point-min))
5282 (if (and (c-end-of-current-token) ; only moves when we started in the middle
5283 (progn (goto-char beg
)
5284 (c-beginning-of-current-token)))
5285 (c-unfind-type (buffer-substring-no-properties
5288 (if c-maybe-stale-found-type
; e.g. (c-decl-id-start "foo" 97 107 " (* ooka) " "o")
5290 ;; Changing the amount of (already existing) whitespace - don't do anything.
5291 ((and (c-partial-ws-p beg end
)
5292 (or (= beg end
) ; removal of WS
5293 (string-match "^[ \t\n\r\f\v]*$" (nth 5 c-maybe-stale-found-type
)))))
5295 ;; The syntactic relationship which defined a "found type" has been
5297 ((eq (car c-maybe-stale-found-type
) 'c-decl-id-start
)
5298 (c-unfind-type (cadr c-maybe-stale-found-type
)))
5299 ;; ((eq (car c-maybe-stale-found-type) 'c-decl-type-start) FIXME!!!
5303 ;; Setting and removing syntax properties on < and > in languages (C++
5304 ;; and Java) where they can be template/generic delimiters as well as
5305 ;; their normal meaning of "less/greater than".
5307 ;; Normally, < and > have syntax 'punctuation'. When they are found to
5308 ;; be delimiters, they are marked as such with the category properties
5309 ;; c-<-as-paren-syntax, c->-as-paren-syntax respectively.
5313 ;; It is impossible to determine with certainty whether a <..> pair in
5314 ;; C++ is two comparison operators or is template delimiters, unless
5315 ;; one duplicates a lot of a C++ compiler. For example, the following
5318 ;; foo (a < b, c > d) ;
5320 ;; could be a function call with two integer parameters (each a
5321 ;; relational expression), or it could be a constructor for class foo
5322 ;; taking one parameter d of templated type "a < b, c >". They are
5323 ;; somewhat easier to distinguish in Java.
5325 ;; The strategy now (2010-01) adopted is to mark and unmark < and
5326 ;; > IN MATCHING PAIRS ONLY. [Previously, they were marked
5327 ;; individually when their context so indicated. This gave rise to
5328 ;; intractable problems when one of a matching pair was deleted, or
5329 ;; pulled into a literal.]
5331 ;; At each buffer change, the syntax-table properties are removed in a
5332 ;; before-change function and reapplied, when needed, in an
5333 ;; after-change function. It is far more important that the
5334 ;; properties get removed when they they are spurious than that they
5335 ;; be present when wanted.
5336 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
5337 (defun c-clear-<-pair-props
(&optional pos
)
5338 ;; POS (default point) is at a < character. If it is marked with
5339 ;; open paren syntax-table text property, remove the property,
5340 ;; together with the close paren property on the matching > (if
5346 (when (equal (c-get-char-property (point) 'syntax-table
)
5347 c-
<-as-paren-syntax
)
5348 (with-syntax-table c-no-parens-syntax-table
; ignore unbalanced [,{,(,..
5349 (c-go-list-forward))
5350 (when (equal (c-get-char-property (1- (point)) 'syntax-table
)
5351 c-
>-as-paren-syntax
) ; should always be true.
5352 (c-clear-char-property (1- (point)) 'category
))
5353 (c-clear-char-property pos
'category
))))
5355 (defun c-clear->-pair-props
(&optional pos
)
5356 ;; POS (default point) is at a > character. If it is marked with
5357 ;; close paren syntax-table property, remove the property, together
5358 ;; with the open paren property on the matching < (if any).
5363 (when (equal (c-get-char-property (point) 'syntax-table
)
5364 c-
>-as-paren-syntax
)
5365 (with-syntax-table c-no-parens-syntax-table
; ignore unbalanced [,{,(,..
5366 (c-go-up-list-backward))
5367 (when (equal (c-get-char-property (point) 'syntax-table
)
5368 c-
<-as-paren-syntax
) ; should always be true.
5369 (c-clear-char-property (point) 'category
))
5370 (c-clear-char-property pos
'category
))))
5372 (defun c-clear-<>-pair-props
(&optional pos
)
5373 ;; POS (default point) is at a < or > character. If it has an
5374 ;; open/close paren syntax-table property, remove this property both
5375 ;; from the current character and its partner (which will also be
5378 ((eq (char-after) ?\
<)
5379 (c-clear-<-pair-props pos
))
5380 ((eq (char-after) ?\
>)
5381 (c-clear->-pair-props pos
))
5383 "c-clear-<>-pair-props called from wrong position"))))
5385 (defun c-clear-<-pair-props-if-match-after
(lim &optional pos
)
5386 ;; POS (default point) is at a < character. If it is both marked
5387 ;; with open/close paren syntax-table property, and has a matching >
5388 ;; (also marked) which is after LIM, remove the property both from
5389 ;; the current > and its partner. Return t when this happens, nil
5395 (when (equal (c-get-char-property (point) 'syntax-table
)
5396 c-
<-as-paren-syntax
)
5397 (with-syntax-table c-no-parens-syntax-table
; ignore unbalanced [,{,(,..
5398 (c-go-list-forward))
5399 (when (and (>= (point) lim
)
5400 (equal (c-get-char-property (1- (point)) 'syntax-table
)
5401 c-
>-as-paren-syntax
)) ; should always be true.
5402 (c-unmark-<-
>-as-paren
(1- (point)))
5403 (c-unmark-<-
>-as-paren pos
))
5406 (defun c-clear->-pair-props-if-match-before
(lim &optional pos
)
5407 ;; POS (default point) is at a > character. If it is both marked
5408 ;; with open/close paren syntax-table property, and has a matching <
5409 ;; (also marked) which is before LIM, remove the property both from
5410 ;; the current < and its partner. Return t when this happens, nil
5416 (when (equal (c-get-char-property (point) 'syntax-table
)
5417 c-
>-as-paren-syntax
)
5418 (with-syntax-table c-no-parens-syntax-table
; ignore unbalanced [,{,(,..
5419 (c-go-up-list-backward))
5420 (when (and (<= (point) lim
)
5421 (equal (c-get-char-property (point) 'syntax-table
)
5422 c-
<-as-paren-syntax
)) ; should always be true.
5423 (c-unmark-<-
>-as-paren
(point))
5424 (c-unmark-<-
>-as-paren pos
))
5427 ;; Set by c-common-init in cc-mode.el.
5431 (defun c-before-change-check-<>-operators
(beg end
)
5432 ;; Unmark certain pairs of "< .... >" which are currently marked as
5433 ;; template/generic delimiters. (This marking is via syntax-table
5434 ;; text properties).
5436 ;; These pairs are those which are in the current "statement" (i.e.,
5437 ;; the region between the {, }, or ; before BEG and the one after
5438 ;; END), and which enclose any part of the interval (BEG END).
5440 ;; Note that in C++ (?and Java), template/generic parens cannot
5441 ;; enclose a brace or semicolon, so we use these as bounds on the
5442 ;; region we must work on.
5444 ;; This function is called from before-change-functions (via
5445 ;; c-get-state-before-change-functions). Thus the buffer is widened,
5446 ;; and point is undefined, both at entry and exit.
5448 ;; FIXME!!! This routine ignores the possibility of macros entirely.
5451 (let ((beg-lit-limits (progn (goto-char beg
) (c-literal-limits)))
5452 (end-lit-limits (progn (goto-char end
) (c-literal-limits)))
5453 new-beg new-end need-new-beg need-new-end
)
5454 ;; Locate the barrier before the changed region
5455 (goto-char (if beg-lit-limits
(car beg-lit-limits
) beg
))
5456 (c-syntactic-skip-backward "^;{}" (c-determine-limit 512))
5457 (setq new-beg
(point))
5459 ;; Remove the syntax-table properties from each pertinent <...> pair.
5460 ;; Firsly, the ones with the < before beg and > after beg.
5461 (while (c-search-forward-char-property 'category
'c-
<-as-paren-syntax beg
)
5462 (if (c-clear-<-pair-props-if-match-after beg
(1- (point)))
5463 (setq need-new-beg t
)))
5465 ;; Locate the barrier after END.
5466 (goto-char (if end-lit-limits
(cdr end-lit-limits
) end
))
5467 (c-syntactic-re-search-forward "[;{}]" (c-determine-+ve-limit
512) 'end
)
5468 (setq new-end
(point))
5470 ;; Remove syntax-table properties from the remaining pertinent <...>
5471 ;; pairs, those with a > after end and < before end.
5472 (while (c-search-backward-char-property 'category
'c-
>-as-paren-syntax end
)
5473 (if (c-clear->-pair-props-if-match-before end
)
5474 (setq need-new-end t
)))
5476 ;; Extend the fontification region, if needed.
5479 (c-forward-syntactic-ws)
5480 (and (< (point) c-new-BEG
) (setq c-new-BEG
(point))))
5483 (and (> new-end c-new-END
) (setq c-new-END new-end
))))))
5487 (defun c-after-change-check-<>-operators
(beg end
)
5488 ;; This is called from `after-change-functions' when
5489 ;; c-recognize-<>-arglists' is set. It ensures that no "<" or ">"
5490 ;; chars with paren syntax become part of another operator like "<<"
5493 ;; This function might do hidden buffer changes.
5497 (when (or (looking-at "[<>]")
5498 (< (skip-chars-backward "<>") 0))
5501 (c-beginning-of-current-token)
5502 (when (and (< (point) beg
)
5503 (looking-at c-
<>-multichar-token-regexp
)
5504 (< beg
(setq beg
(match-end 0))))
5505 (while (progn (skip-chars-forward "^<>" beg
)
5507 (c-clear-<>-pair-props
)
5512 (when (or (looking-at "[<>]")
5513 (< (skip-chars-backward "<>") 0))
5516 (c-beginning-of-current-token)
5517 (when (and (< (point) end
)
5518 (looking-at c-
<>-multichar-token-regexp
)
5519 (< end
(setq end
(match-end 0))))
5520 (while (progn (skip-chars-forward "^<>" end
)
5522 (c-clear-<>-pair-props
)
5523 (forward-char)))))))
5527 ;; Handling of small scale constructs like types and names.
5529 ;; Dynamically bound variable that instructs `c-forward-type' to also
5530 ;; treat possible types (i.e. those that it normally returns 'maybe or
5531 ;; 'found for) as actual types (and always return 'found for them).
5532 ;; This means that it records them in `c-record-type-identifiers' if
5533 ;; that is set, and that it adds them to `c-found-types'.
5534 (defvar c-promote-possible-types nil
)
5536 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5537 ;; mark up successfully parsed arglists with paren syntax properties on
5538 ;; the surrounding angle brackets and with `c-<>-arg-sep' in the
5539 ;; `c-type' property of each argument separating comma.
5541 ;; Setting this variable also makes `c-forward-<>-arglist' recurse into
5542 ;; all arglists for side effects (i.e. recording types), otherwise it
5543 ;; exploits any existing paren syntax properties to quickly jump to the
5544 ;; end of already parsed arglists.
5546 ;; Marking up the arglists is not the default since doing that correctly
5547 ;; depends on a proper value for `c-restricted-<>-arglists'.
5548 (defvar c-parse-and-markup-
<>-arglists nil
)
5550 ;; Dynamically bound variable that instructs `c-forward-<>-arglist' to
5551 ;; not accept arglists that contain binary operators.
5553 ;; This is primarily used to handle C++ template arglists. C++
5554 ;; disambiguates them by checking whether the preceding name is a
5555 ;; template or not. We can't do that, so we assume it is a template
5556 ;; if it can be parsed as one. That usually works well since
5557 ;; comparison expressions on the forms "a < b > c" or "a < b, c > d"
5558 ;; in almost all cases would be pointless.
5560 ;; However, in function arglists, e.g. in "foo (a < b, c > d)", we
5561 ;; should let the comma separate the function arguments instead. And
5562 ;; in a context where the value of the expression is taken, e.g. in
5563 ;; "if (a < b || c > d)", it's probably not a template.
5564 (defvar c-restricted-
<>-arglists nil
)
5566 ;; Dynamically bound variables that instructs
5567 ;; `c-forward-keyword-clause', `c-forward-<>-arglist',
5568 ;; `c-forward-name', `c-forward-type', `c-forward-decl-or-cast-1', and
5569 ;; `c-forward-label' to record the ranges of all the type and
5570 ;; reference identifiers they encounter. They will build lists on
5571 ;; these variables where each element is a cons of the buffer
5572 ;; positions surrounding each identifier. This recording is only
5573 ;; activated when `c-record-type-identifiers' is non-nil.
5575 ;; All known types that can't be identifiers are recorded, and also
5576 ;; other possible types if `c-promote-possible-types' is set.
5577 ;; Recording is however disabled inside angle bracket arglists that
5578 ;; are encountered inside names and other angle bracket arglists.
5579 ;; Such occurrences are taken care of by `c-font-lock-<>-arglists'
5582 ;; Only the names in C++ template style references (e.g. "tmpl" in
5583 ;; "tmpl<a,b>::foo") are recorded as references, other references
5584 ;; aren't handled here.
5586 ;; `c-forward-label' records the label identifier(s) on
5587 ;; `c-record-ref-identifiers'.
5588 (defvar c-record-type-identifiers nil
)
5589 (defvar c-record-ref-identifiers nil
)
5591 ;; This variable will receive a cons cell of the range of the last
5592 ;; single identifier symbol stepped over by `c-forward-name' if it's
5593 ;; successful. This is the range that should be put on one of the
5594 ;; record lists above by the caller. It's assigned nil if there's no
5595 ;; such symbol in the name.
5596 (defvar c-last-identifier-range nil
)
5598 (defmacro c-record-type-id
(range)
5599 (if (eq (car-safe range
) 'cons
)
5601 `(setq c-record-type-identifiers
5602 (cons ,range c-record-type-identifiers
))
5603 `(let ((range ,range
))
5605 (setq c-record-type-identifiers
5606 (cons range c-record-type-identifiers
))))))
5608 (defmacro c-record-ref-id
(range)
5609 (if (eq (car-safe range
) 'cons
)
5611 `(setq c-record-ref-identifiers
5612 (cons ,range c-record-ref-identifiers
))
5613 `(let ((range ,range
))
5615 (setq c-record-ref-identifiers
5616 (cons range c-record-ref-identifiers
))))))
5618 ;; Dynamically bound variable that instructs `c-forward-type' to
5619 ;; record the ranges of types that only are found. Behaves otherwise
5620 ;; like `c-record-type-identifiers'.
5621 (defvar c-record-found-types nil
)
5623 (defmacro c-forward-keyword-prefixed-id
(type)
5624 ;; Used internally in `c-forward-keyword-clause' to move forward
5625 ;; over a type (if TYPE is 'type) or a name (otherwise) which
5626 ;; possibly is prefixed by keywords and their associated clauses.
5627 ;; Try with a type/name first to not trip up on those that begin
5628 ;; with a keyword. Return t if a known or found type is moved
5629 ;; over. The point is clobbered if nil is returned. If range
5630 ;; recording is enabled, the identifier is recorded on as a type
5631 ;; if TYPE is 'type or as a reference if TYPE is 'ref.
5633 ;; This macro might do hidden buffer changes.
5635 (while (if (setq res
,(if (eq type
'type
)
5639 (and (looking-at c-keywords-regexp
)
5640 (c-forward-keyword-clause 1))))
5641 (when (memq res
'(t known found prefix
))
5642 ,(when (eq type
'ref
)
5643 `(when c-record-type-identifiers
5644 (c-record-ref-id c-last-identifier-range
)))
5647 (defmacro c-forward-id-comma-list
(type update-safe-pos
)
5648 ;; Used internally in `c-forward-keyword-clause' to move forward
5649 ;; over a comma separated list of types or names using
5650 ;; `c-forward-keyword-prefixed-id'.
5652 ;; This macro might do hidden buffer changes.
5654 ,(when update-safe-pos
5655 `(setq safe-pos
(point)))
5656 (eq (char-after) ?
,))
5659 (c-forward-syntactic-ws)
5660 (c-forward-keyword-prefixed-id ,type
)))))
5662 (defun c-forward-keyword-clause (match)
5663 ;; Submatch MATCH in the current match data is assumed to surround a
5664 ;; token. If it's a keyword, move over it and any immediately
5665 ;; following clauses associated with it, stopping at the start of
5666 ;; the next token. t is returned in that case, otherwise the point
5667 ;; stays and nil is returned. The kind of clauses that are
5668 ;; recognized are those specified by `c-type-list-kwds',
5669 ;; `c-ref-list-kwds', `c-colon-type-list-kwds',
5670 ;; `c-paren-nontype-kwds', `c-paren-type-kwds', `c-<>-type-kwds',
5671 ;; and `c-<>-arglist-kwds'.
5673 ;; This function records identifier ranges on
5674 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5675 ;; `c-record-type-identifiers' is non-nil.
5677 ;; Note that for `c-colon-type-list-kwds', which doesn't necessary
5678 ;; apply directly after the keyword, the type list is moved over
5679 ;; only when there is no unaccounted token before it (i.e. a token
5680 ;; that isn't moved over due to some other keyword list). The
5681 ;; identifier ranges in the list are still recorded if that should
5684 ;; This function might do hidden buffer changes.
5686 (let ((kwd-sym (c-keyword-sym (match-string match
))) safe-pos pos
5687 ;; The call to `c-forward-<>-arglist' below is made after
5688 ;; `c-<>-sexp-kwds' keywords, so we're certain they actually
5689 ;; are angle bracket arglists and `c-restricted-<>-arglists'
5690 ;; should therefore be nil.
5691 (c-parse-and-markup-<>-arglists t
)
5692 c-restricted-
<>-arglists
)
5695 (goto-char (match-end match
))
5696 (c-forward-syntactic-ws)
5697 (setq safe-pos
(point))
5700 ((and (c-keyword-member kwd-sym
'c-type-list-kwds
)
5701 (c-forward-keyword-prefixed-id type
))
5702 ;; There's a type directly after a keyword in `c-type-list-kwds'.
5703 (c-forward-id-comma-list type t
))
5705 ((and (c-keyword-member kwd-sym
'c-ref-list-kwds
)
5706 (c-forward-keyword-prefixed-id ref
))
5707 ;; There's a name directly after a keyword in `c-ref-list-kwds'.
5708 (c-forward-id-comma-list ref t
))
5710 ((and (c-keyword-member kwd-sym
'c-paren-any-kwds
)
5711 (eq (char-after) ?\
())
5712 ;; There's an open paren after a keyword in `c-paren-any-kwds'.
5715 (when (and (setq pos
(c-up-list-forward))
5716 (eq (char-before pos
) ?\
)))
5717 (when (and c-record-type-identifiers
5718 (c-keyword-member kwd-sym
'c-paren-type-kwds
))
5719 ;; Use `c-forward-type' on every identifier we can find
5720 ;; inside the paren, to record the types.
5721 (while (c-syntactic-re-search-forward c-symbol-start pos t
)
5722 (goto-char (match-beginning 0))
5723 (unless (c-forward-type)
5724 (looking-at c-symbol-key
) ; Always matches.
5725 (goto-char (match-end 0)))))
5728 (c-forward-syntactic-ws)
5729 (setq safe-pos
(point))))
5731 ((and (c-keyword-member kwd-sym
'c-
<>-sexp-kwds
)
5732 (eq (char-after) ?
<)
5733 (c-forward-<>-arglist
(c-keyword-member kwd-sym
'c-
<>-type-kwds
)))
5734 (c-forward-syntactic-ws)
5735 (setq safe-pos
(point)))
5737 ((and (c-keyword-member kwd-sym
'c-nonsymbol-sexp-kwds
)
5738 (not (looking-at c-symbol-start
))
5739 (c-safe (c-forward-sexp) t
))
5740 (c-forward-syntactic-ws)
5741 (setq safe-pos
(point))))
5743 (when (c-keyword-member kwd-sym
'c-colon-type-list-kwds
)
5744 (if (eq (char-after) ?
:)
5745 ;; If we are at the colon already, we move over the type
5749 (c-forward-syntactic-ws)
5750 (when (c-forward-keyword-prefixed-id type
)
5751 (c-forward-id-comma-list type t
)))
5752 ;; Not at the colon, so stop here. But the identifier
5753 ;; ranges in the type list later on should still be
5755 (and c-record-type-identifiers
5757 ;; If a keyword matched both one of the types above and
5758 ;; this one, we match `c-colon-type-list-re' after the
5759 ;; clause matched above.
5760 (goto-char safe-pos
)
5761 (looking-at c-colon-type-list-re
))
5763 (goto-char (match-end 0))
5764 (c-forward-syntactic-ws)
5765 (c-forward-keyword-prefixed-id type
))
5766 ;; There's a type after the `c-colon-type-list-re' match
5767 ;; after a keyword in `c-colon-type-list-kwds'.
5768 (c-forward-id-comma-list type nil
))))
5770 (goto-char safe-pos
)
5773 ;; cc-mode requires cc-fonts.
5774 (declare-function c-fontify-recorded-types-and-refs
"cc-fonts" ())
5776 (defun c-forward-<>-arglist
(all-types)
5777 ;; The point is assumed to be at a "<". Try to treat it as the open
5778 ;; paren of an angle bracket arglist and move forward to the
5779 ;; corresponding ">". If successful, the point is left after the
5780 ;; ">" and t is returned, otherwise the point isn't moved and nil is
5781 ;; returned. If ALL-TYPES is t then all encountered arguments in
5782 ;; the arglist that might be types are treated as found types.
5784 ;; The variable `c-parse-and-markup-<>-arglists' controls how this
5785 ;; function handles text properties on the angle brackets and argument
5786 ;; separating commas.
5788 ;; `c-restricted-<>-arglists' controls how lenient the template
5789 ;; arglist recognition should be.
5791 ;; This function records identifier ranges on
5792 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
5793 ;; `c-record-type-identifiers' is non-nil.
5795 ;; This function might do hidden buffer changes.
5797 (let ((start (point))
5798 ;; If `c-record-type-identifiers' is set then activate
5799 ;; recording of any found types that constitute an argument in
5801 (c-record-found-types (if c-record-type-identifiers t
)))
5802 (if (catch 'angle-bracket-arglist-escape
5803 (setq c-record-found-types
5804 (c-forward-<>-arglist-recur all-types
)))
5806 (when (consp c-record-found-types
)
5807 (setq c-record-type-identifiers
5808 ;; `nconc' doesn't mind that the tail of
5809 ;; `c-record-found-types' is t.
5810 (nconc c-record-found-types c-record-type-identifiers
)))
5811 (if (c-major-mode-is 'java-mode
) (c-fontify-recorded-types-and-refs))
5817 (defun c-forward-<>-arglist-recur
(all-types)
5818 ;; Recursive part of `c-forward-<>-arglist'.
5820 ;; This function might do hidden buffer changes.
5822 (let ((start (point)) res pos tmp
5823 ;; Cover this so that any recorded found type ranges are
5824 ;; automatically lost if it turns out to not be an angle
5825 ;; bracket arglist. It's propagated through the return value
5826 ;; on successful completion.
5827 (c-record-found-types c-record-found-types
)
5828 ;; List that collects the positions after the argument
5829 ;; separating ',' in the arglist.
5831 ;; If the '<' has paren open syntax then we've marked it as an angle
5832 ;; bracket arglist before, so skip to the end.
5833 (if (and (not c-parse-and-markup-
<>-arglists
)
5834 (c-get-char-property (point) 'syntax-table
))
5838 (if (and (c-go-up-list-forward)
5839 (eq (char-before) ?
>))
5841 ;; Got unmatched paren angle brackets. We don't clear the paren
5842 ;; syntax properties and retry, on the basis that it's very
5843 ;; unlikely that paren angle brackets become operators by code
5844 ;; manipulation. It's far more likely that it doesn't match due
5845 ;; to narrowing or some temporary change.
5849 (forward-char) ; Forward over the opening '<'.
5851 (unless (looking-at c-
<-op-cont-regexp
)
5852 ;; go forward one non-alphanumeric character (group) per iteration of
5856 (c-forward-syntactic-ws)
5857 (let ((orig-record-found-types c-record-found-types
))
5858 (when (or (and c-record-type-identifiers all-types
)
5859 (c-major-mode-is 'java-mode
))
5860 ;; All encountered identifiers are types, so set the
5861 ;; promote flag and parse the type.
5863 (c-forward-syntactic-ws)
5864 (if (looking-at "\\?")
5866 (when (looking-at c-identifier-start
)
5867 (let ((c-promote-possible-types t
)
5868 (c-record-found-types t
))
5871 (c-forward-syntactic-ws)
5873 (when (or (looking-at "extends")
5874 (looking-at "super"))
5876 (c-forward-syntactic-ws)
5877 (let ((c-promote-possible-types t
)
5878 (c-record-found-types t
))
5880 (c-forward-syntactic-ws))))))
5882 (setq pos
(point)) ; e.g. first token inside the '<'
5884 ;; Note: These regexps exploit the match order in \| so
5885 ;; that "<>" is matched by "<" rather than "[^>:-]>".
5886 (c-syntactic-re-search-forward
5887 ;; Stop on ',', '|', '&', '+' and '-' to catch
5888 ;; common binary operators that could be between
5889 ;; two comparison expressions "a<b" and "c>d".
5890 "[<;{},|+&-]\\|[>)]"
5894 ((eq (char-before) ?
>)
5895 ;; Either an operator starting with '>' or the end of
5896 ;; the angle bracket arglist.
5898 (if (looking-at c-
>-op-cont-regexp
)
5900 (goto-char (match-end 0))
5901 t
) ; Continue the loop.
5903 ;; The angle bracket arglist is finished.
5904 (when c-parse-and-markup-
<>-arglists
5905 (while arg-start-pos
5906 (c-put-c-type-property (1- (car arg-start-pos
))
5908 (setq arg-start-pos
(cdr arg-start-pos
)))
5909 (c-mark-<-as-paren start
)
5910 (c-mark->-as-paren
(1- (point))))
5912 nil
)) ; Exit the loop.
5914 ((eq (char-before) ?
<)
5915 ;; Either an operator starting with '<' or a nested arglist.
5917 (let (id-start id-end subres keyword-match
)
5919 ;; The '<' begins a multi-char operator.
5920 ((looking-at c-
<-op-cont-regexp
)
5921 (setq tmp
(match-end 0))
5922 (goto-char (match-end 0)))
5923 ;; We're at a nested <.....>
5926 (backward-char) ; to the '<'
5929 ;; There's always an identifier before an angle
5930 ;; bracket arglist, or a keyword in `c-<>-type-kwds'
5931 ;; or `c-<>-arglist-kwds'.
5932 (c-backward-syntactic-ws)
5933 (setq id-end
(point))
5934 (c-simple-skip-symbol-backward)
5935 (when (or (setq keyword-match
5936 (looking-at c-opt-
<>-sexp-key
))
5937 (not (looking-at c-keywords-regexp
)))
5938 (setq id-start
(point))))
5940 (let ((c-promote-possible-types t
)
5941 (c-record-found-types t
))
5942 (c-forward-<>-arglist-recur
5945 (c-keyword-sym (match-string 1))
5946 'c-
<>-type-kwds
)))))))
5948 ;; It was an angle bracket arglist.
5949 (setq c-record-found-types subres
)
5951 ;; Record the identifier before the template as a type
5952 ;; or reference depending on whether the arglist is last
5953 ;; in a qualified identifier.
5954 (when (and c-record-type-identifiers
5955 (not keyword-match
))
5956 (if (and c-opt-identifier-concat-key
5958 (c-forward-syntactic-ws)
5959 (looking-at c-opt-identifier-concat-key
)))
5960 (c-record-ref-id (cons id-start id-end
))
5961 (c-record-type-id (cons id-start id-end
)))))
5963 ;; At a "less than" operator.
5967 t
) ; carry on looping.
5969 ((and (not c-restricted-
<>-arglists
)
5970 (or (and (eq (char-before) ?
&)
5971 (not (eq (char-after) ?
&)))
5972 (eq (char-before) ?
,)))
5973 ;; Just another argument. Record the position. The
5974 ;; type check stuff that made us stop at it is at
5975 ;; the top of the loop.
5976 (setq arg-start-pos
(cons (point) arg-start-pos
)))
5979 ;; Got a character that can't be in an angle bracket
5980 ;; arglist argument. Abort using `throw', since
5981 ;; it's useless to try to find a surrounding arglist
5983 (throw 'angle-bracket-arglist-escape nil
))))))
5985 (or c-record-found-types t
)))))
5987 (defun c-backward-<>-arglist
(all-types &optional limit
)
5988 ;; The point is assumed to be directly after a ">". Try to treat it
5989 ;; as the close paren of an angle bracket arglist and move back to
5990 ;; the corresponding "<". If successful, the point is left at
5991 ;; the "<" and t is returned, otherwise the point isn't moved and
5992 ;; nil is returned. ALL-TYPES is passed on to
5993 ;; `c-forward-<>-arglist'.
5995 ;; If the optional LIMIT is given, it bounds the backward search.
5996 ;; It's then assumed to be at a syntactically relevant position.
5998 ;; This is a wrapper around `c-forward-<>-arglist'. See that
5999 ;; function for more details.
6001 (let ((start (point)))
6003 (if (and (not c-parse-and-markup-
<>-arglists
)
6004 (c-get-char-property (point) 'syntax-table
))
6006 (if (and (c-go-up-list-backward)
6007 (eq (char-after) ?
<))
6009 ;; See corresponding note in `c-forward-<>-arglist'.
6014 (c-syntactic-skip-backward "^<;{}" limit t
)
6017 (if (eq (char-before) ?
<)
6019 ;; Stopped at bob or a char that isn't allowed in an
6020 ;; arglist, so we've failed.
6025 (progn (c-beginning-of-current-token)
6027 ;; If we moved then the "<" was part of some
6028 ;; multicharacter token.
6032 (let ((beg-pos (point)))
6033 (if (c-forward-<>-arglist all-types
)
6034 (cond ((= (point) start
)
6035 ;; Matched the arglist. Break the while.
6039 ;; We started from a non-paren ">" inside an
6044 ;; Matched a shorter arglist. Can be a nested
6045 ;; one so continue looking.
6050 (/= (point) start
))))
6052 (defun c-forward-name ()
6053 ;; Move forward over a complete name if at the beginning of one,
6054 ;; stopping at the next following token. A keyword, as such,
6055 ;; doesn't count as a name. If the point is not at something that
6056 ;; is recognized as a name then it stays put.
6058 ;; A name could be something as simple as "foo" in C or something as
6059 ;; complex as "X<Y<class A<int>::B, BIT_MAX >> b>, ::operator<> ::
6060 ;; Z<(a>b)> :: operator const X<&foo>::T Q::G<unsigned short
6061 ;; int>::*volatile const" in C++ (this function is actually little
6062 ;; more than a `looking-at' call in all modes except those that,
6063 ;; like C++, have `c-recognize-<>-arglists' set).
6066 ;; o - nil if no name is found;
6067 ;; o - 'template if it's an identifier ending with an angle bracket
6069 ;; o - 'operator of it's an operator identifier;
6070 ;; o - t if it's some other kind of name.
6072 ;; This function records identifier ranges on
6073 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6074 ;; `c-record-type-identifiers' is non-nil.
6076 ;; This function might do hidden buffer changes.
6078 (let ((pos (point)) (start (point)) res id-start id-end
6079 ;; Turn off `c-promote-possible-types' here since we might
6080 ;; call `c-forward-<>-arglist' and we don't want it to promote
6081 ;; every suspect thing in the arglist to a type. We're
6082 ;; typically called from `c-forward-type' in this case, and
6083 ;; the caller only wants the top level type that it finds to
6085 c-promote-possible-types
)
6088 (looking-at c-identifier-key
)
6091 ;; Check for keyword. We go to the last symbol in
6092 ;; `c-identifier-key' first.
6093 (goto-char (setq id-end
(match-end 0)))
6094 (c-simple-skip-symbol-backward)
6095 (setq id-start
(point))
6097 (if (looking-at c-keywords-regexp
)
6098 (when (and (c-major-mode-is 'c
++-mode
)
6100 (cc-eval-when-compile
6101 (concat "\\(operator\\|\\(template\\)\\)"
6102 "\\(" (c-lang-const c-nonsymbol-key c
++)
6104 (if (match-beginning 2)
6105 ;; "template" is only valid inside an
6106 ;; identifier if preceded by "::".
6108 (c-backward-syntactic-ws)
6109 (and (c-safe (backward-char 2) t
)
6113 ;; Handle a C++ operator or template identifier.
6115 (c-forward-syntactic-ws)
6116 (cond ((eq (char-before id-end
) ?e
)
6117 ;; Got "... ::template".
6118 (let ((subres (c-forward-name)))
6123 ((looking-at c-identifier-start
)
6124 ;; Got a cast operator.
6125 (when (c-forward-type)
6128 ;; Now we should match a sequence of either
6129 ;; '*', '&' or a name followed by ":: *",
6130 ;; where each can be followed by a sequence
6131 ;; of `c-opt-type-modifier-key'.
6132 (while (cond ((looking-at "[*&]")
6133 (goto-char (match-end 0))
6135 ((looking-at c-identifier-start
)
6136 (and (c-forward-name)
6139 (goto-char (match-end 0))
6140 (c-forward-syntactic-ws)
6141 (eq (char-after) ?
*))
6146 (c-forward-syntactic-ws)
6148 (looking-at c-opt-type-modifier-key
))
6149 (goto-char (match-end 1))))))
6151 ((looking-at c-overloadable-operators-regexp
)
6152 ;; Got some other operator.
6153 (setq c-last-identifier-range
6154 (cons (point) (match-end 0)))
6155 (goto-char (match-end 0))
6156 (c-forward-syntactic-ws)
6162 ;; `id-start' is equal to `id-end' if we've jumped over
6163 ;; an identifier that doesn't end with a symbol token.
6164 ;; That can occur e.g. for Java import directives on the
6165 ;; form "foo.bar.*".
6166 (when (and id-start
(/= id-start id-end
))
6167 (setq c-last-identifier-range
6168 (cons id-start id-end
)))
6170 (c-forward-syntactic-ws)
6176 (when (or c-opt-identifier-concat-key
6177 c-recognize-
<>-arglists
)
6180 ((and c-opt-identifier-concat-key
6181 (looking-at c-opt-identifier-concat-key
))
6182 ;; Got a concatenated identifier. This handles the
6183 ;; cases with tricky syntactic whitespace that aren't
6184 ;; covered in `c-identifier-key'.
6185 (goto-char (match-end 0))
6186 (c-forward-syntactic-ws)
6189 ((and c-recognize-
<>-arglists
6190 (eq (char-after) ?
<))
6191 ;; Maybe an angle bracket arglist.
6192 (when (let ((c-record-type-identifiers t
)
6193 (c-record-found-types t
))
6194 (c-forward-<>-arglist nil
))
6196 (c-add-type start
(1+ pos
))
6197 (c-forward-syntactic-ws)
6199 c-last-identifier-range nil
)
6201 (if (and c-opt-identifier-concat-key
6202 (looking-at c-opt-identifier-concat-key
))
6204 ;; Continue if there's an identifier concatenation
6205 ;; operator after the template argument.
6207 (when (and c-record-type-identifiers id-start
)
6208 (c-record-ref-id (cons id-start id-end
)))
6210 (c-forward-syntactic-ws)
6213 (when (and c-record-type-identifiers id-start
)
6214 (c-record-type-id (cons id-start id-end
)))
6215 (setq res
'template
)
6222 (defun c-forward-type (&optional brace-block-too
)
6223 ;; Move forward over a type spec if at the beginning of one,
6224 ;; stopping at the next following token. The keyword "typedef"
6225 ;; isn't part of a type spec here.
6227 ;; BRACE-BLOCK-TOO, when non-nil, means move over the brace block in
6228 ;; constructs like "struct foo {...} bar ;" or "struct {...} bar;".
6229 ;; The current (2009-03-10) intention is to convert all uses of
6230 ;; `c-forward-type' to call with this parameter set, then to
6234 ;; o - t if it's a known type that can't be a name or other
6236 ;; o - 'known if it's an otherwise known type (according to
6237 ;; `*-font-lock-extra-types');
6238 ;; o - 'prefix if it's a known prefix of a type;
6239 ;; o - 'found if it's a type that matches one in `c-found-types';
6240 ;; o - 'maybe if it's an identifier that might be a type; or
6241 ;; o - nil if it can't be a type (the point isn't moved then).
6243 ;; The point is assumed to be at the beginning of a token.
6245 ;; Note that this function doesn't skip past the brace definition
6246 ;; that might be considered part of the type, e.g.
6247 ;; "enum {a, b, c} foo".
6249 ;; This function records identifier ranges on
6250 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6251 ;; `c-record-type-identifiers' is non-nil.
6253 ;; This function might do hidden buffer changes.
6254 (when (and c-recognize-
<>-arglists
6256 (c-forward-<>-arglist t
)
6257 (c-forward-syntactic-ws))
6259 (let ((start (point)) pos res name-res id-start id-end id-range
)
6261 ;; Skip leading type modifiers. If any are found we know it's a
6262 ;; prefix of a type.
6263 (when c-opt-type-modifier-key
; e.g. "const" "volatile", but NOT "typedef"
6264 (while (looking-at c-opt-type-modifier-key
)
6265 (goto-char (match-end 1))
6266 (c-forward-syntactic-ws)
6267 (setq res
'prefix
)))
6270 ((looking-at c-type-prefix-key
) ; e.g. "struct", "class", but NOT
6272 (goto-char (match-end 1))
6273 (c-forward-syntactic-ws)
6276 (setq name-res
(c-forward-name))
6277 (setq res
(not (null name-res
)))
6278 (when (eq name-res t
)
6279 ;; In many languages the name can be used without the
6280 ;; prefix, so we add it to `c-found-types'.
6281 (c-add-type pos
(point))
6282 (when (and c-record-type-identifiers
6283 c-last-identifier-range
)
6284 (c-record-type-id c-last-identifier-range
)))
6285 (when (and brace-block-too
6287 (eq (char-after) ?\
{)
6290 (progn (c-forward-sexp)
6291 (c-forward-syntactic-ws)
6292 (setq pos
(point))))))
6295 (unless res
(goto-char start
))) ; invalid syntax
6299 (if (looking-at c-identifier-start
)
6301 (setq id-start
(point)
6302 name-res
(c-forward-name))
6304 (setq id-end
(point)
6305 id-range c-last-identifier-range
))))
6306 (and (cond ((looking-at c-primitive-type-key
)
6308 ((c-with-syntax-table c-identifier-syntax-table
6309 (looking-at c-known-type-key
))
6314 (goto-char (match-end 1))
6315 (c-forward-syntactic-ws)
6316 (setq pos
(point))))
6319 ;; Looking at a primitive or known type identifier. We've
6320 ;; checked for a name first so that we don't go here if the
6321 ;; known type match only is a prefix of another name.
6323 (setq id-end
(match-end 1))
6325 (when (and c-record-type-identifiers
6326 (or c-promote-possible-types
(eq res t
)))
6327 (c-record-type-id (cons (match-beginning 1) (match-end 1))))
6329 (if (and c-opt-type-component-key
6331 (looking-at c-opt-type-component-key
)))
6332 ;; There might be more keywords for the type.
6334 (c-forward-keyword-clause 1)
6336 (setq safe-pos
(point))
6337 (looking-at c-opt-type-component-key
))
6338 (when (and c-record-type-identifiers
6339 (looking-at c-primitive-type-key
))
6340 (c-record-type-id (cons (match-beginning 1)
6342 (c-forward-keyword-clause 1))
6343 (if (looking-at c-primitive-type-key
)
6345 (when c-record-type-identifiers
6346 (c-record-type-id (cons (match-beginning 1)
6348 (c-forward-keyword-clause 1)
6350 (goto-char safe-pos
)
6351 (setq res
'prefix
)))
6352 (unless (save-match-data (c-forward-keyword-clause 1))
6355 (goto-char (match-end 1))
6356 (c-forward-syntactic-ws)))))
6359 (cond ((eq name-res t
)
6360 ;; A normal identifier.
6362 (if (or res c-promote-possible-types
)
6364 (c-add-type id-start id-end
)
6365 (when (and c-record-type-identifiers id-range
)
6366 (c-record-type-id id-range
))
6369 (setq res
(if (c-check-type id-start id-end
)
6370 ;; It's an identifier that has been used as
6371 ;; a type somewhere else.
6373 ;; It's an identifier that might be a type.
6375 ((eq name-res
'template
)
6376 ;; A template is a type.
6380 ;; Otherwise it's an operator identifier, which is not a type.
6385 ;; Skip trailing type modifiers. If any are found we know it's
6387 (when c-opt-type-modifier-key
6388 (while (looking-at c-opt-type-modifier-key
) ; e.g. "const", "volatile"
6389 (goto-char (match-end 1))
6390 (c-forward-syntactic-ws)
6392 ;; Step over any type suffix operator. Do not let the existence
6393 ;; of these alter the classification of the found type, since
6394 ;; these operators typically are allowed in normal expressions
6396 (when c-opt-type-suffix-key
6397 (while (looking-at c-opt-type-suffix-key
)
6398 (goto-char (match-end 1))
6399 (c-forward-syntactic-ws)))
6401 (when c-opt-type-concat-key
; Only/mainly for pike.
6402 ;; Look for a trailing operator that concatenates the type
6403 ;; with a following one, and if so step past that one through
6404 ;; a recursive call. Note that we don't record concatenated
6405 ;; types in `c-found-types' - it's the component types that
6406 ;; are recorded when appropriate.
6408 (let* ((c-promote-possible-types (or (memq res
'(t known
))
6409 c-promote-possible-types
))
6410 ;; If we can't promote then set `c-record-found-types' so that
6411 ;; we can merge in the types from the second part afterwards if
6412 ;; it turns out to be a known type there.
6413 (c-record-found-types (and c-record-type-identifiers
6414 (not c-promote-possible-types
)))
6416 (if (and (looking-at c-opt-type-concat-key
)
6419 (goto-char (match-end 1))
6420 (c-forward-syntactic-ws)
6421 (setq subres
(c-forward-type))))
6424 ;; If either operand certainly is a type then both are, but we
6425 ;; don't let the existence of the operator itself promote two
6426 ;; uncertain types to a certain one.
6429 (unless (eq name-res
'template
)
6430 (c-add-type id-start id-end
))
6431 (when (and c-record-type-identifiers id-range
)
6432 (c-record-type-id id-range
))
6443 (when (and (eq res t
)
6444 (consp c-record-found-types
))
6445 ;; Merge in the ranges of any types found by the second
6446 ;; `c-forward-type'.
6447 (setq c-record-type-identifiers
6448 ;; `nconc' doesn't mind that the tail of
6449 ;; `c-record-found-types' is t.
6450 (nconc c-record-found-types
6451 c-record-type-identifiers
))))
6455 (when (and c-record-found-types
(memq res
'(known found
)) id-range
)
6456 (setq c-record-found-types
6457 (cons id-range c-record-found-types
))))
6459 ;;(message "c-forward-type %s -> %s: %s" start (point) res)
6463 (defun c-forward-annotation ()
6464 ;; Used for Java code only at the moment. Assumes point is on the
6465 ;; @, moves forward an annotation. returns nil if there is no
6466 ;; annotation at point.
6467 (and (looking-at "@")
6468 (progn (forward-char) t
)
6470 (progn (c-forward-syntactic-ws) t
)
6471 (if (looking-at "(")
6475 (defun c-back-over-member-initializers ()
6476 ;; Test whether we are in a C++ member initializer list, and if so, go back
6477 ;; to the introducing ":", returning the position of the opening paren of
6478 ;; the function's arglist. Otherwise return nil, leaving point unchanged.
6479 (let ((here (point))
6480 (paren-state (c-parse-state))
6485 (if (not (c-at-toplevel-p))
6487 (while (not (c-at-toplevel-p))
6488 (goto-char (c-pull-open-brace paren-state
)))
6489 (c-backward-syntactic-ws)
6490 (when (not (c-simple-skip-symbol-backward))
6492 (c-backward-syntactic-ws))
6493 (c-backward-syntactic-ws)
6494 (when (memq (char-before) '(?\
) ?
}))
6495 (when (not (c-go-list-backward))
6497 (c-backward-syntactic-ws))
6498 (when (c-simple-skip-symbol-backward)
6499 (c-backward-syntactic-ws)))
6501 (while (eq (char-before) ?
,)
6503 (c-backward-syntactic-ws)
6505 (when (not (memq (char-before) '(?\
) ?
})))
6507 (when (not (c-go-list-backward))
6509 (c-backward-syntactic-ws)
6510 (when (not (c-simple-skip-symbol-backward))
6512 (c-backward-syntactic-ws))
6515 (eq (char-before) ?
:)
6516 (c-just-after-func-arglist-p))))
6518 (or res
(goto-char here
))
6522 ;; Handling of large scale constructs like statements and declarations.
6524 ;; Macro used inside `c-forward-decl-or-cast-1'. It ought to be a
6525 ;; defsubst or perhaps even a defun, but it contains lots of free
6526 ;; variables that refer to things inside `c-forward-decl-or-cast-1'.
6527 (defmacro c-fdoc-shift-type-backward
(&optional short
)
6528 ;; `c-forward-decl-or-cast-1' can consume an arbitrary length list
6529 ;; of types when parsing a declaration, which means that it
6530 ;; sometimes consumes the identifier in the declaration as a type.
6531 ;; This is used to "backtrack" and make the last type be treated as
6532 ;; an identifier instead.
6535 ;; These identifiers are bound only in the inner let.
6536 '(setq identifier-type at-type
6537 identifier-start type-start
6541 got-suffix-after-parens id-start
6544 (if (setq at-type
(if (eq backup-at-type
'prefix
)
6547 (setq type-start backup-type-start
6548 id-start backup-id-start
)
6549 (setq type-start start-pos
6550 id-start start-pos
))
6552 ;; When these flags already are set we've found specifiers that
6553 ;; unconditionally signal these attributes - backtracking doesn't
6554 ;; change that. So keep them set in that case.
6556 (setq at-type-decl backup-at-type-decl
))
6558 (setq maybe-typeless backup-maybe-typeless
))
6561 ;; This identifier is bound only in the inner let.
6562 '(setq start id-start
))))
6564 (defun c-forward-decl-or-cast-1 (preceding-token-end context last-cast-end
)
6565 ;; Move forward over a declaration or a cast if at the start of one.
6566 ;; The point is assumed to be at the start of some token. Nil is
6567 ;; returned if no declaration or cast is recognized, and the point
6568 ;; is clobbered in that case.
6570 ;; If a declaration is parsed:
6572 ;; The point is left at the first token after the first complete
6573 ;; declarator, if there is one. The return value is a cons where
6574 ;; the car is the position of the first token in the declarator. (See
6575 ;; below for the cdr.)
6578 ;; void foo (int a, char *b) stuff ...
6582 ;; unsigned int a = c_style_initializer, b;
6584 ;; unsigned int a (cplusplus_style_initializer), b;
6585 ;; car ^ ^ point (might change)
6586 ;; class Foo : public Bar {}
6588 ;; class PikeClass (int a, string b) stuff ...
6594 ;; void cplusplus_function (int x) throw (Bad);
6596 ;; Foo::Foo (int b) : Base (b) {}
6599 ;; The cdr of the return value is non-nil when a
6600 ;; `c-typedef-decl-kwds' specifier is found in the declaration.
6601 ;; Specifically it is a dotted pair (A . B) where B is t when a
6602 ;; `c-typedef-kwds' ("typedef") is present, and A is t when some
6603 ;; other `c-typedef-decl-kwds' (e.g. class, struct, enum)
6604 ;; specifier is present. I.e., (some of) the declared
6605 ;; identifier(s) are types.
6607 ;; If a cast is parsed:
6609 ;; The point is left at the first token after the closing paren of
6610 ;; the cast. The return value is `cast'. Note that the start
6611 ;; position must be at the first token inside the cast parenthesis
6614 ;; PRECEDING-TOKEN-END is the first position after the preceding
6615 ;; token, i.e. on the other side of the syntactic ws from the point.
6616 ;; Use a value less than or equal to (point-min) if the point is at
6617 ;; the first token in (the visible part of) the buffer.
6619 ;; CONTEXT is a symbol that describes the context at the point:
6620 ;; 'decl In a comma-separated declaration context (typically
6621 ;; inside a function declaration arglist).
6622 ;; '<> In an angle bracket arglist.
6623 ;; 'arglist Some other type of arglist.
6624 ;; nil Some other context or unknown context. Includes
6625 ;; within the parens of an if, for, ... construct.
6627 ;; LAST-CAST-END is the first token after the closing paren of a
6628 ;; preceding cast, or nil if none is known. If
6629 ;; `c-forward-decl-or-cast-1' is used in succession, it should be
6630 ;; the position after the closest preceding call where a cast was
6631 ;; matched. In that case it's used to discover chains of casts like
6634 ;; This function records identifier ranges on
6635 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
6636 ;; `c-record-type-identifiers' is non-nil.
6638 ;; This function might do hidden buffer changes.
6640 (let (;; `start-pos' is used below to point to the start of the
6641 ;; first type, i.e. after any leading specifiers. It might
6642 ;; also point at the beginning of the preceding syntactic
6645 ;; Set to the result of `c-forward-type'.
6647 ;; The position of the first token in what we currently
6648 ;; believe is the type in the declaration or cast, after any
6649 ;; specifiers and their associated clauses.
6651 ;; The position of the first token in what we currently
6652 ;; believe is the declarator for the first identifier. Set
6653 ;; when the type is found, and moved forward over any
6654 ;; `c-decl-hangon-kwds' and their associated clauses that
6655 ;; occurs after the type.
6657 ;; These store `at-type', `type-start' and `id-start' of the
6658 ;; identifier before the one in those variables. The previous
6659 ;; identifier might turn out to be the real type in a
6660 ;; declaration if the last one has to be the declarator in it.
6661 ;; If `backup-at-type' is nil then the other variables have
6662 ;; undefined values.
6663 backup-at-type backup-type-start backup-id-start
6664 ;; Set if we've found a specifier (apart from "typedef") that makes
6665 ;; the defined identifier(s) types.
6667 ;; Set if we've a "typedef" keyword.
6669 ;; Set if we've found a specifier that can start a declaration
6670 ;; where there's no type.
6672 ;; If a specifier is found that also can be a type prefix,
6673 ;; these flags are set instead of those above. If we need to
6674 ;; back up an identifier, they are copied to the real flag
6675 ;; variables. Thus they only take effect if we fail to
6676 ;; interpret it as a type.
6677 backup-at-type-decl backup-maybe-typeless
6678 ;; Whether we've found a declaration or a cast. We might know
6679 ;; this before we've found the type in it. It's 'ids if we've
6680 ;; found two consecutive identifiers (usually a sure sign, but
6681 ;; we should allow that in labels too), and t if we've found a
6682 ;; specifier keyword (a 100% sure sign).
6684 ;; Set when we need to back up to parse this as a declaration
6685 ;; but not as a cast.
6687 ;; For casts, the return position.
6689 ;; Save `c-record-type-identifiers' and
6690 ;; `c-record-ref-identifiers' since ranges are recorded
6691 ;; speculatively and should be thrown away if it turns out
6692 ;; that it isn't a declaration or cast.
6693 (save-rec-type-ids c-record-type-identifiers
)
6694 (save-rec-ref-ids c-record-ref-identifiers
))
6696 (while (c-forward-annotation)
6697 (c-forward-syntactic-ws))
6699 ;; Check for a type. Unknown symbols are treated as possible
6700 ;; types, but they could also be specifiers disguised through
6701 ;; macros like __INLINE__, so we recognize both types and known
6702 ;; specifiers after them too.
6704 (let* ((start (point)) kwd-sym kwd-clause-end found-type
)
6706 ;; Look for a specifier keyword clause.
6707 (when (or (looking-at c-prefix-spec-kwds-re
)
6708 (and (c-major-mode-is 'java-mode
)
6709 (looking-at "@[A-Za-z0-9]+")))
6710 (if (looking-at c-typedef-key
)
6711 (setq at-typedef t
))
6712 (setq kwd-sym
(c-keyword-sym (match-string 1)))
6714 (c-forward-keyword-clause 1)
6715 (setq kwd-clause-end
(point))))
6717 (when (setq found-type
(c-forward-type t
)) ; brace-block-too
6718 ;; Found a known or possible type or a prefix of a known type.
6721 ;; Got two identifiers with nothing but whitespace
6722 ;; between them. That can only happen in declarations.
6723 (setq at-decl-or-cast
'ids
)
6725 (when (eq at-type
'found
)
6726 ;; If the previous identifier is a found type we
6727 ;; record it as a real one; it might be some sort of
6728 ;; alias for a prefix like "unsigned".
6730 (goto-char type-start
)
6731 (let ((c-promote-possible-types t
))
6732 (c-forward-type)))))
6734 (setq backup-at-type at-type
6735 backup-type-start type-start
6736 backup-id-start id-start
6740 ;; The previous ambiguous specifier/type turned out
6741 ;; to be a type since we've parsed another one after
6742 ;; it, so clear these backup flags.
6743 backup-at-type-decl nil
6744 backup-maybe-typeless nil
))
6748 ;; Handle known specifier keywords and
6749 ;; `c-decl-hangon-kwds' which can occur after known
6752 (if (c-keyword-member kwd-sym
'c-decl-hangon-kwds
)
6753 ;; It's a hang-on keyword that can occur anywhere.
6755 (setq at-decl-or-cast t
)
6757 ;; Move the identifier start position if
6758 ;; we've passed a type.
6759 (setq id-start kwd-clause-end
)
6760 ;; Otherwise treat this as a specifier and
6761 ;; move the fallback position.
6762 (setq start-pos kwd-clause-end
))
6763 (goto-char kwd-clause-end
))
6765 ;; It's an ordinary specifier so we know that
6766 ;; anything before this can't be the type.
6767 (setq backup-at-type nil
6768 start-pos kwd-clause-end
)
6771 ;; It's ambiguous whether this keyword is a
6772 ;; specifier or a type prefix, so set the backup
6773 ;; flags. (It's assumed that `c-forward-type'
6774 ;; moved further than `c-forward-keyword-clause'.)
6776 (when (c-keyword-member kwd-sym
'c-typedef-decl-kwds
)
6777 (setq backup-at-type-decl t
))
6778 (when (c-keyword-member kwd-sym
'c-typeless-decl-kwds
)
6779 (setq backup-maybe-typeless t
)))
6781 (when (c-keyword-member kwd-sym
'c-typedef-decl-kwds
)
6782 ;; This test only happens after we've scanned a type.
6783 ;; So, with valid syntax, kwd-sym can't be 'typedef.
6784 (setq at-type-decl t
))
6785 (when (c-keyword-member kwd-sym
'c-typeless-decl-kwds
)
6786 (setq maybe-typeless t
))
6788 ;; Haven't matched a type so it's an unambiguous
6789 ;; specifier keyword and we know we're in a
6791 (setq at-decl-or-cast t
)
6793 (goto-char kwd-clause-end
))))
6795 ;; If the type isn't known we continue so that we'll jump
6796 ;; over all specifiers and type identifiers. The reason
6797 ;; to do this for a known type prefix is to make things
6798 ;; like "unsigned INT16" work.
6799 (and found-type
(not (eq found-type t
))))))
6803 ;; If a known type was found, we still need to skip over any
6804 ;; hangon keyword clauses after it. Otherwise it has already
6805 ;; been done in the loop above.
6806 (while (looking-at c-decl-hangon-key
)
6807 (c-forward-keyword-clause 1))
6808 (setq id-start
(point)))
6810 ((eq at-type
'prefix
)
6811 ;; A prefix type is itself a primitive type when it's not
6812 ;; followed by another type.
6816 ;; Got no type but set things up to continue anyway to handle
6817 ;; the various cases when a declaration doesn't start with a
6819 (setq id-start start-pos
))
6821 ((and (eq at-type
'maybe
)
6822 (c-major-mode-is 'c
++-mode
))
6823 ;; If it's C++ then check if the last "type" ends on the form
6824 ;; "foo::foo" or "foo::~foo", i.e. if it's the name of a
6825 ;; (con|de)structor.
6827 (let (name end-2 end-1
)
6828 (goto-char id-start
)
6829 (c-backward-syntactic-ws)
6830 (setq end-2
(point))
6832 (c-simple-skip-symbol-backward)
6835 (buffer-substring-no-properties (point) end-2
))
6836 ;; Cheating in the handling of syntactic ws below.
6837 (< (skip-chars-backward ":~ \t\n\r\v\f") 0))
6839 (setq end-1
(point))
6840 (c-simple-skip-symbol-backward))
6841 (>= (point) type-start
)
6842 (equal (buffer-substring-no-properties (point) end-1
)
6844 ;; It is a (con|de)structor name. In that case the
6845 ;; declaration is typeless so zap out any preceding
6846 ;; identifier(s) that we might have taken as types.
6847 (goto-char type-start
)
6850 id-start type-start
))))))
6852 ;; Check for and step over a type decl expression after the thing
6853 ;; that is or might be a type. This can't be skipped since we
6854 ;; need the correct end position of the declarator for
6855 ;; `max-type-decl-end-*'.
6856 (let ((start (point)) (paren-depth 0) pos
6857 ;; True if there's a non-open-paren match of
6858 ;; `c-type-decl-prefix-key'.
6860 ;; True if the declarator is surrounded by a parenthesis pair.
6862 ;; True if there is an identifier in the declarator.
6864 ;; True if there's a non-close-paren match of
6865 ;; `c-type-decl-suffix-key'.
6867 ;; True if there's a prefix match outside the outermost
6868 ;; paren pair that surrounds the declarator.
6869 got-prefix-before-parens
6870 ;; True if there's a suffix match outside the outermost
6871 ;; paren pair that surrounds the declarator. The value is
6872 ;; the position of the first suffix match.
6873 got-suffix-after-parens
6874 ;; True if we've parsed the type decl to a token that is
6875 ;; known to end declarations in this context.
6877 ;; The earlier values of `at-type' and `type-start' if we've
6878 ;; shifted the type backwards.
6879 identifier-type identifier-start
6880 ;; If `c-parse-and-markup-<>-arglists' is set we need to
6881 ;; turn it off during the name skipping below to avoid
6882 ;; getting `c-type' properties that might be bogus. That
6883 ;; can happen since we don't know if
6884 ;; `c-restricted-<>-arglists' will be correct inside the
6885 ;; arglist paren that gets entered.
6886 c-parse-and-markup-
<>-arglists
)
6888 (goto-char id-start
)
6890 ;; Skip over type decl prefix operators. (Note similar code in
6891 ;; `c-font-lock-declarators'.)
6892 (while (and (looking-at c-type-decl-prefix-key
)
6893 (if (and (c-major-mode-is 'c
++-mode
)
6894 (match-beginning 3))
6895 ;; If the second submatch matches in C++ then
6896 ;; we're looking at an identifier that's a
6897 ;; prefix only if it specifies a member pointer.
6898 (when (setq got-identifier
(c-forward-name))
6899 (if (looking-at "\\(::\\)")
6900 ;; We only check for a trailing "::" and
6901 ;; let the "*" that should follow be
6902 ;; matched in the next round.
6903 (progn (setq got-identifier nil
) t
)
6904 ;; It turned out to be the real identifier,
6909 (if (eq (char-after) ?\
()
6911 (setq paren-depth
(1+ paren-depth
))
6913 (unless got-prefix-before-parens
6914 (setq got-prefix-before-parens
(= paren-depth
0)))
6916 (goto-char (match-end 1)))
6917 (c-forward-syntactic-ws))
6919 (setq got-parens
(> paren-depth
0))
6921 ;; Skip over an identifier.
6923 (and (looking-at c-identifier-start
)
6924 (setq got-identifier
(c-forward-name))))
6926 ;; Skip over type decl suffix operators.
6927 (while (if (looking-at c-type-decl-suffix-key
)
6929 (if (eq (char-after) ?\
))
6930 (when (> paren-depth
0)
6931 (setq paren-depth
(1- paren-depth
))
6934 (when (if (save-match-data (looking-at "\\s\("))
6935 (c-safe (c-forward-sexp 1) t
)
6936 (goto-char (match-end 1))
6938 (when (and (not got-suffix-after-parens
)
6940 (setq got-suffix-after-parens
(match-beginning 0)))
6941 (setq got-suffix t
)))
6943 ;; No suffix matched. We might have matched the
6944 ;; identifier as a type and the open paren of a
6945 ;; function arglist as a type decl prefix. In that
6946 ;; case we should "backtrack": Reinterpret the last
6947 ;; type as the identifier, move out of the arglist and
6948 ;; continue searching for suffix operators.
6950 ;; Do this even if there's no preceding type, to cope
6951 ;; with old style function declarations in K&R C,
6952 ;; (con|de)structors in C++ and `c-typeless-decl-kwds'
6953 ;; style declarations. That isn't applicable in an
6954 ;; arglist context, though.
6955 (when (and (= paren-depth
1)
6956 (not got-prefix-before-parens
)
6957 (not (eq at-type t
))
6960 backup-maybe-typeless
6961 (when c-recognize-typeless-decls
6963 (setq pos
(c-up-list-forward (point)))
6964 (eq (char-before pos
) ?\
)))
6965 (c-fdoc-shift-type-backward)
6969 (c-forward-syntactic-ws))
6971 (when (and (or maybe-typeless backup-maybe-typeless
)
6972 (not got-identifier
)
6975 ;; Have found no identifier but `c-typeless-decl-kwds' has
6976 ;; matched so we know we're inside a declaration. The
6977 ;; preceding type must be the identifier instead.
6978 (c-fdoc-shift-type-backward))
6982 (catch 'at-decl-or-cast
6985 (when (> paren-depth
0)
6986 ;; Encountered something inside parens that isn't matched by
6987 ;; the `c-type-decl-*' regexps, so it's not a type decl
6988 ;; expression. Try to skip out to the same paren depth to
6989 ;; not confuse the cast check below.
6990 (c-safe (goto-char (scan-lists (point) 1 paren-depth
)))
6991 ;; If we've found a specifier keyword then it's a
6992 ;; declaration regardless.
6993 (throw 'at-decl-or-cast
(eq at-decl-or-cast t
)))
6996 (looking-at (cond ((eq context
'<>) "[,>]")
7000 ;; Now we've collected info about various characteristics of
7001 ;; the construct we're looking at. Below follows a decision
7002 ;; tree based on that. It's ordered to check more certain
7003 ;; signs before less certain ones.
7009 (when (and (or at-type maybe-typeless
)
7010 (not (or got-prefix got-parens
)))
7011 ;; Got another identifier directly after the type, so it's a
7013 (throw 'at-decl-or-cast t
))
7015 (when (and got-parens
7017 (not got-suffix-after-parens
)
7020 backup-maybe-typeless
))
7021 ;; Got a declaration of the form "foo bar (gnu);" where we've
7022 ;; recognized "bar" as the type and "gnu" as the declarator.
7023 ;; In this case it's however more likely that "bar" is the
7024 ;; declarator and "gnu" a function argument or initializer (if
7025 ;; `c-recognize-paren-inits' is set), since the parens around
7026 ;; "gnu" would be superfluous if it's a declarator. Shift the
7027 ;; type one step backward.
7028 (c-fdoc-shift-type-backward)))
7030 ;; Found no identifier.
7037 (when (= (point) start
)
7038 ;; Got a plain list of identifiers. If a colon follows it's
7039 ;; a valid label, or maybe a bitfield. Otherwise the last
7040 ;; one probably is the declared identifier and we should
7041 ;; back up to the previous type, providing it isn't a cast.
7042 (if (and (eq (char-after) ?
:)
7043 (not (c-major-mode-is 'java-mode
)))
7045 ;; If we've found a specifier keyword then it's a
7046 ;; declaration regardless.
7047 ((eq at-decl-or-cast t
)
7048 (throw 'at-decl-or-cast t
))
7049 ((and c-has-bitfields
7050 (eq at-decl-or-cast
'ids
)) ; bitfield.
7051 (setq backup-if-not-cast t
)
7052 (throw 'at-decl-or-cast t
)))
7054 (setq backup-if-not-cast t
)
7055 (throw 'at-decl-or-cast t
)))
7058 (when (and got-suffix
7061 ;; Got a plain list of identifiers followed by some suffix.
7062 ;; If this isn't a cast then the last identifier probably is
7063 ;; the declared one and we should back up to the previous
7065 (setq backup-if-not-cast t
)
7066 (throw 'at-decl-or-cast t
)))
7069 (when (eq at-type t
)
7070 ;; If the type is known we know that there can't be any
7071 ;; identifier somewhere else, and it's only in declarations in
7072 ;; e.g. function prototypes and in casts that the identifier may
7074 (throw 'at-decl-or-cast t
))
7076 (when (= (point) start
)
7077 ;; Only got a single identifier (parsed as a type so far).
7080 ;; Check that the identifier isn't at the start of an
7085 ;; Inside an arglist that contains declarations. If K&R
7086 ;; style declarations and parenthesis style initializers
7087 ;; aren't allowed then the single identifier must be a
7088 ;; type, else we require that it's known or found
7089 ;; (primitive types are handled above).
7090 (or (and (not c-recognize-knr-p
)
7091 (not c-recognize-paren-inits
))
7092 (memq at-type
'(known found
))))
7094 ;; Inside a template arglist. Accept known and found
7095 ;; types; other identifiers could just as well be
7096 ;; constants in C++.
7097 (memq at-type
'(known found
)))))
7098 (throw 'at-decl-or-cast t
)
7100 ;; Can't be a valid declaration or cast, but if we've found a
7101 ;; specifier it can't be anything else either, so treat it as
7102 ;; an invalid/unfinished declaration or cast.
7103 (throw 'at-decl-or-cast at-decl-or-cast
))))
7108 (not (eq at-type t
))
7111 backup-maybe-typeless
7112 (when c-recognize-typeless-decls
7113 (or (not got-suffix
)
7115 c-after-suffixed-type-maybe-decl-key
))))))
7116 ;; Got an empty paren pair and a preceding type that probably
7117 ;; really is the identifier. Shift the type backwards to make
7118 ;; the last one the identifier. This is analogous to the
7119 ;; "backtracking" done inside the `c-type-decl-suffix-key' loop
7122 ;; Exception: In addition to the conditions in that
7123 ;; "backtracking" code, do not shift backward if we're not
7124 ;; looking at either `c-after-suffixed-type-decl-key' or "[;,]".
7125 ;; Since there's no preceding type, the shift would mean that
7126 ;; the declaration is typeless. But if the regexp doesn't match
7127 ;; then we will simply fall through in the tests below and not
7128 ;; recognize it at all, so it's better to try it as an abstract
7129 ;; declarator instead.
7130 (c-fdoc-shift-type-backward)
7132 ;; Still no identifier.
7134 (when (and got-prefix
(or got-parens got-suffix
))
7135 ;; Require `got-prefix' together with either `got-parens' or
7136 ;; `got-suffix' to recognize it as an abstract declarator:
7137 ;; `got-parens' only is probably an empty function call.
7138 ;; `got-suffix' only can build an ordinary expression together
7139 ;; with the preceding identifier which we've taken as a type.
7140 ;; We could actually accept on `got-prefix' only, but that can
7141 ;; easily occur temporarily while writing an expression so we
7142 ;; avoid that case anyway. We could do a better job if we knew
7143 ;; the point when the fontification was invoked.
7144 (throw 'at-decl-or-cast t
))
7150 got-suffix-after-parens
7151 (eq (char-after got-suffix-after-parens
) ?\
())
7152 ;; Got a type, no declarator but a paren suffix. I.e. it's a
7153 ;; normal function call after all (or perhaps a C++ style object
7154 ;; instantiation expression).
7155 (throw 'at-decl-or-cast nil
))))
7158 (when at-decl-or-cast
7159 ;; By now we've located the type in the declaration that we know
7161 (throw 'at-decl-or-cast t
))
7164 (when (and got-identifier
7166 (looking-at c-after-suffixed-type-decl-key
)
7170 (not (eq at-type t
)))
7171 ;; Shift the type backward in the case that there's a
7172 ;; single identifier inside parens. That can only
7173 ;; occur in K&R style function declarations so it's
7174 ;; more likely that it really is a function call.
7175 ;; Therefore we only do this after
7176 ;; `c-after-suffixed-type-decl-key' has matched.
7177 (progn (c-fdoc-shift-type-backward) t
)
7178 got-suffix-after-parens
))
7179 ;; A declaration according to `c-after-suffixed-type-decl-key'.
7180 (throw 'at-decl-or-cast t
))
7183 (when (and (or got-prefix
(not got-parens
))
7184 (memq at-type
'(t known
)))
7185 ;; It's a declaration if a known type precedes it and it can't be a
7187 (throw 'at-decl-or-cast t
))
7189 ;; If we get here we can't tell if this is a type decl or a normal
7190 ;; expression by looking at it alone. (That's under the assumption
7191 ;; that normal expressions always can look like type decl expressions,
7192 ;; which isn't really true but the cases where it doesn't hold are so
7193 ;; uncommon (e.g. some placements of "const" in C++) it's not worth
7194 ;; the effort to look for them.)
7196 (unless (or at-decl-end
(looking-at "=[^=]"))
7197 ;; If this is a declaration it should end here or its initializer(*)
7198 ;; should start here, so check for allowed separation tokens. Note
7199 ;; that this rule doesn't work e.g. with a K&R arglist after a
7202 ;; *) Don't check for C++ style initializers using parens
7203 ;; since those already have been matched as suffixes.
7205 ;; If `at-decl-or-cast' is then we've found some other sign that
7206 ;; it's a declaration or cast, so then it's probably an
7207 ;; invalid/unfinished one.
7208 (throw 'at-decl-or-cast at-decl-or-cast
))
7210 ;; Below are tests that only should be applied when we're certain to
7211 ;; not have parsed halfway through an expression.
7214 (when (memq at-type
'(t known
))
7215 ;; The expression starts with a known type so treat it as a
7217 (throw 'at-decl-or-cast t
))
7220 (when (and (c-major-mode-is 'c
++-mode
)
7221 ;; In C++ we check if the identifier is a known type, since
7222 ;; (con|de)structors use the class name as identifier.
7223 ;; We've always shifted over the identifier as a type and
7224 ;; then backed up again in this case.
7226 (or (memq identifier-type
'(found known
))
7227 (and (eq (char-after identifier-start
) ?~
)
7228 ;; `at-type' probably won't be 'found for
7229 ;; destructors since the "~" is then part of the
7230 ;; type name being checked against the list of
7231 ;; known types, so do a check without that
7234 (goto-char (1+ identifier-start
))
7235 (c-forward-syntactic-ws)
7236 (c-with-syntax-table
7237 c-identifier-syntax-table
7238 (looking-at c-known-type-key
)))
7240 (goto-char (1+ identifier-start
))
7241 ;; We have already parsed the type earlier,
7242 ;; so it'd be possible to cache the end
7243 ;; position instead of redoing it here, but
7244 ;; then we'd need to keep track of another
7245 ;; position everywhere.
7246 (c-check-type (point)
7247 (progn (c-forward-type)
7249 (throw 'at-decl-or-cast t
))
7254 (when (and got-prefix-before-parens
7256 (or at-decl-end
(looking-at "=[^=]"))
7259 ;; Got something like "foo * bar;". Since we're not inside an
7260 ;; arglist it would be a meaningless expression because the
7261 ;; result isn't used. We therefore choose to recognize it as
7262 ;; a declaration. Do not allow a suffix since it could then
7263 ;; be a function call.
7264 (throw 'at-decl-or-cast t
))
7267 (when (and (or got-suffix-after-parens
7268 (looking-at "=[^=]"))
7270 (not (eq context
'arglist
)))
7271 ;; Got something like "a (*b) (c);" or "a (b) = c;". It could
7272 ;; be an odd expression or it could be a declaration. Treat
7273 ;; it as a declaration if "a" has been used as a type
7274 ;; somewhere else (if it's a known type we won't get here).
7275 (throw 'at-decl-or-cast t
)))
7280 (and (eq context
'decl
)
7281 (not c-recognize-paren-inits
)
7282 (or got-parens got-suffix
))))
7283 ;; Got a type followed by an abstract declarator. If `got-prefix'
7284 ;; is set it's something like "a *" without anything after it. If
7285 ;; `got-parens' or `got-suffix' is set it's "a()", "a[]", "a()[]",
7286 ;; or similar, which we accept only if the context rules out
7288 (throw 'at-decl-or-cast t
)))
7290 ;; If we had a complete symbol table here (which rules out
7291 ;; `c-found-types') we should return t due to the disambiguation rule
7292 ;; (in at least C++) that anything that can be parsed as a declaration
7293 ;; is a declaration. Now we're being more defensive and prefer to
7294 ;; highlight things like "foo (bar);" as a declaration only if we're
7295 ;; inside an arglist that contains declarations.
7296 (eq context
'decl
))))
7298 ;; The point is now after the type decl expression.
7301 ;; Check for a cast.
7306 ;; Should be the first type/identifier in a cast paren.
7307 (> preceding-token-end
(point-min))
7308 (memq (char-before preceding-token-end
) c-cast-parens
)
7310 ;; The closing paren should follow.
7312 (c-forward-syntactic-ws)
7313 (looking-at "\\s\)"))
7315 ;; There should be a primary expression after it.
7318 (c-forward-syntactic-ws)
7319 (setq cast-end
(point))
7320 (and (looking-at c-primary-expr-regexp
)
7322 (setq pos
(match-end 0))
7324 ;; Check if the expression begins with a prefix keyword.
7326 (if (match-beginning 1)
7327 ;; Expression begins with an ambiguous operator. Treat
7328 ;; it as a cast if it's a type decl or if we've
7329 ;; recognized the type somewhere else.
7331 (memq at-type
'(t known found
)))
7332 ;; Unless it's a keyword, it's the beginning of a primary
7334 (not (looking-at c-keywords-regexp
)))))
7335 ;; If `c-primary-expr-regexp' matched a nonsymbol token, check
7336 ;; that it matched a whole one so that we don't e.g. confuse
7337 ;; the operator '-' with '->'. It's ok if it matches further,
7338 ;; though, since it e.g. can match the float '.5' while the
7339 ;; operator regexp only matches '.'.
7340 (or (not (looking-at c-nonsymbol-token-regexp
))
7341 (<= (match-end 0) pos
))))
7343 ;; There should either be a cast before it or something that isn't an
7344 ;; identifier or close paren.
7345 (> preceding-token-end
(point-min))
7347 (goto-char (1- preceding-token-end
))
7348 (or (eq (point) last-cast-end
)
7350 (c-backward-syntactic-ws)
7351 (if (< (skip-syntax-backward "w_") 0)
7352 ;; It's a symbol. Accept it only if it's one of the
7353 ;; keywords that can precede an expression (without
7354 ;; surrounding parens).
7355 (looking-at c-simple-stmt-key
)
7357 ;; Check that it isn't a close paren (block close is ok,
7359 (not (memq (char-before) '(?\
) ?\
])))
7360 ;; Check that it isn't a nonsymbol identifier.
7361 (not (c-on-identifier)))))))))
7364 (when (and c-record-type-identifiers at-type
(not (eq at-type t
)))
7365 (let ((c-promote-possible-types t
))
7366 (goto-char type-start
)
7369 (goto-char cast-end
)
7373 ;; We're at a declaration. Highlight the type and the following
7376 (when backup-if-not-cast
7377 (c-fdoc-shift-type-backward t
))
7379 (when (and (eq context
'decl
) (looking-at ","))
7380 ;; Make sure to propagate the `c-decl-arg-start' property to
7381 ;; the next argument if it's set in this one, to cope with
7382 ;; interactive refontification.
7383 (c-put-c-type-property (point) 'c-decl-arg-start
))
7385 (when (and c-record-type-identifiers at-type
(not (eq at-type t
)))
7386 (let ((c-promote-possible-types t
))
7388 (goto-char type-start
)
7392 (and (or at-type-decl at-typedef
)
7393 (cons at-type-decl at-typedef
))))
7396 ;; False alarm. Restore the recorded ranges.
7397 (setq c-record-type-identifiers save-rec-type-ids
7398 c-record-ref-identifiers save-rec-ref-ids
)
7401 (defun c-forward-label (&optional assume-markup preceding-token-end limit
)
7402 ;; Assuming that point is at the beginning of a token, check if it starts a
7403 ;; label and if so move over it and return non-nil (t in default situations,
7404 ;; specific symbols (see below) for interesting situations), otherwise don't
7405 ;; move and return nil. "Label" here means "most things with a colon".
7407 ;; More precisely, a "label" is regarded as one of:
7408 ;; (i) a goto target like "foo:" - returns the symbol `goto-target';
7409 ;; (ii) A case label - either the entire construct "case FOO:", or just the
7410 ;; bare "case", should the colon be missing. We return t;
7411 ;; (iii) a keyword which needs a colon, like "default:" or "private:"; We
7413 ;; (iv) One of QT's "extended" C++ variants of
7414 ;; "private:"/"protected:"/"public:"/"more:" looking like "public slots:".
7415 ;; Returns the symbol `qt-2kwds-colon'.
7416 ;; (v) QT's construct "signals:". Returns the symbol `qt-1kwd-colon'.
7417 ;; (vi) One of the keywords matched by `c-opt-extra-label-key' (without any
7418 ;; colon). Currently (2006-03), this applies only to Objective C's
7419 ;; keywords "@private", "@protected", and "@public". Returns t.
7421 ;; One of the things which will NOT be recognized as a label is a bit-field
7422 ;; element of a struct, something like "int foo:5".
7424 ;; The end of the label is taken to be just after the colon, or the end of
7425 ;; the first submatch in `c-opt-extra-label-key'. The point is directly
7426 ;; after the end on return. The terminating char gets marked with
7427 ;; `c-decl-end' to improve recognition of the following declaration or
7430 ;; If ASSUME-MARKUP is non-nil, it's assumed that the preceding
7431 ;; label, if any, has already been marked up like that.
7433 ;; If PRECEDING-TOKEN-END is given, it should be the first position
7434 ;; after the preceding token, i.e. on the other side of the
7435 ;; syntactic ws from the point. Use a value less than or equal to
7436 ;; (point-min) if the point is at the first token in (the visible
7437 ;; part of) the buffer.
7439 ;; The optional LIMIT limits the forward scan for the colon.
7441 ;; This function records the ranges of the label symbols on
7442 ;; `c-record-ref-identifiers' if `c-record-type-identifiers' (!) is
7445 ;; This function might do hidden buffer changes.
7447 (let ((start (point))
7450 macro-start
; if we're in one.
7454 ;; "case" or "default" (Doesn't apply to AWK).
7455 ((looking-at c-label-kwds-regexp
)
7456 (let ((kwd-end (match-end 1)))
7457 ;; Record only the keyword itself for fontification, since in
7458 ;; case labels the following is a constant expression and not
7460 (when c-record-type-identifiers
7461 (c-record-ref-id (cons (match-beginning 1) kwd-end
)))
7463 ;; Find the label end.
7466 (if (and (c-syntactic-re-search-forward
7467 ;; Stop on chars that aren't allowed in expressions,
7468 ;; and on operator chars that would be meaningless
7469 ;; there. FIXME: This doesn't cope with ?: operators.
7470 "[;{=,@]\\|\\(\\=\\|[^:]\\):\\([^:]\\|\\'\\)"
7472 (match-beginning 2))
7474 (progn ; there's a proper :
7475 (goto-char (match-beginning 2)) ; just after the :
7476 (c-put-c-type-property (1- (point)) 'c-decl-end
)
7479 ;; It's an unfinished label. We consider the keyword enough
7480 ;; to recognize it as a label, so that it gets fontified.
7481 ;; Leave the point at the end of it, but don't put any
7482 ;; `c-decl-end' marker.
7486 ;; @private, @protected, @public, in Objective C, or similar.
7487 ((and c-opt-extra-label-key
7488 (looking-at c-opt-extra-label-key
))
7489 ;; For a `c-opt-extra-label-key' match, we record the whole
7490 ;; thing for fontification. That's to get the leading '@' in
7491 ;; Objective-C protection labels fontified.
7492 (goto-char (match-end 1))
7493 (when c-record-type-identifiers
7494 (c-record-ref-id (cons (match-beginning 1) (point))))
7495 (c-put-c-type-property (1- (point)) 'c-decl-end
)
7496 (setq label-type t
))
7498 ;; All other cases of labels.
7499 ((and c-recognize-colon-labels
; nil for AWK and IDL, otherwise t.
7501 ;; A colon label must have something before the colon.
7502 (not (eq (char-after) ?
:))
7504 ;; Check that we're not after a token that can't precede a label.
7506 ;; Trivially succeeds when there's no preceding token.
7507 ;; Succeeds when we're at a virtual semicolon.
7508 (if preceding-token-end
7509 (<= preceding-token-end
(point-min))
7511 (c-backward-syntactic-ws)
7512 (setq preceding-token-end
(point))
7516 ;; Check if we're after a label, if we're after a closing
7517 ;; paren that belong to statement, and with
7518 ;; `c-label-prefix-re'. It's done in different order
7519 ;; depending on `assume-markup' since the checks have
7520 ;; different expensiveness.
7523 (eq (c-get-char-property (1- preceding-token-end
) 'c-type
)
7527 (goto-char (1- preceding-token-end
))
7528 (c-beginning-of-current-token)
7529 (or (looking-at c-label-prefix-re
)
7530 (looking-at c-block-stmt-1-key
)))
7532 (and (eq (char-before preceding-token-end
) ?\
))
7533 (c-after-conditional)))
7537 (goto-char (1- preceding-token-end
))
7538 (c-beginning-of-current-token)
7539 (or (looking-at c-label-prefix-re
)
7540 (looking-at c-block-stmt-1-key
)))
7543 ((eq (char-before preceding-token-end
) ?\
))
7544 (c-after-conditional))
7546 ((eq (char-before preceding-token-end
) ?
:)
7547 ;; Might be after another label, so check it recursively.
7550 (goto-char (1- preceding-token-end
))
7551 ;; Essentially the same as the
7552 ;; `c-syntactic-re-search-forward' regexp below.
7554 (save-excursion (and (c-beginning-of-macro)
7556 (if macro-start
(narrow-to-region macro-start
(point-max)))
7557 (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+" nil t
)
7558 ;; Note: the following should work instead of the
7559 ;; narrow-to-region above. Investigate why not,
7560 ;; sometime. ACM, 2006-03-31.
7561 ;; (c-syntactic-skip-backward "^-]:?;}=*/%&|,<>!@+"
7564 ;; If the caller turned on recording for us,
7565 ;; it shouldn't apply when we check the
7567 c-record-type-identifiers
)
7568 ;; A label can't start at a cpp directive. Check for
7569 ;; this, since c-forward-syntactic-ws would foul up on it.
7570 (unless (and c-opt-cpp-prefix
(looking-at c-opt-cpp-prefix
))
7571 (c-forward-syntactic-ws)
7572 (c-forward-label nil pte start
))))))))))
7574 ;; Point is still at the beginning of the possible label construct.
7576 ;; Check that the next nonsymbol token is ":", or that we're in one
7577 ;; of QT's "slots" declarations. Allow '(' for the sake of macro
7578 ;; arguments. FIXME: Should build this regexp from the language
7581 ;; public: protected: private:
7583 (c-major-mode-is 'c
++-mode
)
7584 (search-forward-regexp
7585 "\\=p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\>[^_]" nil t
)
7586 (progn (backward-char)
7587 (c-forward-syntactic-ws limit
)
7588 (looking-at ":\\([^:]\\|\\'\\)"))) ; A single colon.
7590 (setq label-type t
))
7591 ;; QT double keyword like "protected slots:" or goto target.
7592 ((progn (goto-char start
) nil
))
7593 ((when (c-syntactic-re-search-forward
7594 "[ \t\n[:?;{=*/%&|,<>!@+-]" limit t t
) ; not at EOB
7596 (setq label-end
(point))
7598 (and (c-major-mode-is 'c
++-mode
)
7600 "\\(p\\(r\\(ivate\\|otected\\)\\|ublic\\)\\|more\\)\\>"
7601 (buffer-substring start
(point)))))
7602 (c-forward-syntactic-ws limit
)
7604 ((looking-at ":\\([^:]\\|\\'\\)") ; A single colon.
7607 (if (or (string= "signals" ; Special QT macro
7608 (setq kwd
(buffer-substring-no-properties start label-end
)))
7609 (string= "Q_SIGNALS" kwd
))
7613 (search-forward-regexp "\\=\\(slots\\|Q_SLOTS\\)\\>" limit t
)
7614 (progn (c-forward-syntactic-ws limit
)
7615 (looking-at ":\\([^:]\\|\\'\\)"))) ; A single colon
7617 (setq label-type
'qt-2kwds-colon
)))))))
7620 (narrow-to-region start
(point))
7622 ;; Check that `c-nonlabel-token-key' doesn't match anywhere.
7626 (when (looking-at c-nonlabel-token-key
)
7628 (setq label-type nil
)
7629 (throw 'check-label nil
))
7630 (and (c-safe (c-forward-sexp)
7631 (c-forward-syntactic-ws)
7635 ;; Record the identifiers in the label for fontification, unless
7636 ;; it begins with `c-label-kwds' in which case the following
7637 ;; identifiers are part of a (constant) expression that
7638 ;; shouldn't be fontified.
7639 (when (and c-record-type-identifiers
7640 (progn (goto-char start
)
7641 (not (looking-at c-label-kwds-regexp
))))
7642 (while (c-syntactic-re-search-forward c-symbol-key nil t
)
7643 (c-record-ref-id (cons (match-beginning 0)
7646 (c-put-c-type-property (1- (point-max)) 'c-decl-end
)
7647 (goto-char (point-max)))))
7654 (defun c-forward-objc-directive ()
7655 ;; Assuming the point is at the beginning of a token, try to move
7656 ;; forward to the end of the Objective-C directive that starts
7657 ;; there. Return t if a directive was fully recognized, otherwise
7658 ;; the point is moved as far as one could be successfully parsed and
7661 ;; This function records identifier ranges on
7662 ;; `c-record-type-identifiers' and `c-record-ref-identifiers' if
7663 ;; `c-record-type-identifiers' is non-nil.
7665 ;; This function might do hidden buffer changes.
7667 (let ((start (point))
7669 (c-promote-possible-types t
)
7671 ;; Turn off recognition of angle bracket arglists while parsing
7672 ;; types here since the protocol reference list might then be
7673 ;; considered part of the preceding name or superclass-name.
7674 c-recognize-
<>-arglists
)
7679 (c-make-keywords-re t
7680 (append (c-lang-const c-protection-kwds objc
)
7683 (goto-char (match-end 1))
7689 (c-make-keywords-re t
7690 '("@interface" "@implementation" "@protocol")
7693 ;; Handle the name of the class itself.
7695 ; (c-forward-token-2) ; 2006/1/13 This doesn't move if the token's
7697 (goto-char (match-end 0))
7703 ;; Look for ": superclass-name" or "( category-name )".
7704 (when (looking-at "[:\(]")
7705 (setq start-char
(char-after))
7707 (c-forward-syntactic-ws)
7708 (unless (c-forward-type) (throw 'break nil
))
7709 (when (eq start-char ?\
()
7710 (unless (eq (char-after) ?\
)) (throw 'break nil
))
7712 (c-forward-syntactic-ws)))
7714 ;; Look for a protocol reference list.
7715 (if (eq (char-after) ?
<)
7716 (let ((c-recognize-<>-arglists t
)
7717 (c-parse-and-markup-<>-arglists t
)
7718 c-restricted-
<>-arglists
)
7719 (c-forward-<>-arglist t
))
7723 (c-backward-syntactic-ws lim
)
7724 (c-clear-c-type-property start
(1- (point)) 'c-decl-end
)
7725 (c-put-c-type-property (1- (point)) 'c-decl-end
)
7728 (c-clear-c-type-property start
(point) 'c-decl-end
)
7731 (defun c-beginning-of-inheritance-list (&optional lim
)
7732 ;; Go to the first non-whitespace after the colon that starts a
7733 ;; multiple inheritance introduction. Optional LIM is the farthest
7734 ;; back we should search.
7736 ;; This function might do hidden buffer changes.
7737 (c-with-syntax-table c
++-template-syntax-table
7738 (c-backward-token-2 0 t lim
)
7739 (while (and (or (looking-at c-symbol-start
)
7740 (looking-at "[<,]\\|::"))
7741 (zerop (c-backward-token-2 1 t lim
))))))
7743 (defun c-in-method-def-p ()
7744 ;; Return nil if we aren't in a method definition, otherwise the
7745 ;; position of the initial [+-].
7747 ;; This function might do hidden buffer changes.
7750 (and c-opt-method-key
7751 (looking-at c-opt-method-key
)
7755 ;; Contributed by Kevin Ryde <user42@zip.com.au>.
7756 (defun c-in-gcc-asm-p ()
7757 ;; Return non-nil if point is within a gcc \"asm\" block.
7759 ;; This should be called with point inside an argument list.
7761 ;; Only one level of enclosing parentheses is considered, so for
7762 ;; instance `nil' is returned when in a function call within an asm
7765 ;; This function might do hidden buffer changes.
7767 (and c-opt-asm-stmt-key
7770 (backward-up-list 1)
7771 (c-beginning-of-statement-1 (point-min) nil t
)
7772 (looking-at c-opt-asm-stmt-key
))))
7774 (defun c-at-toplevel-p ()
7775 "Return a determination as to whether point is \"at the top level\".
7776 Informally, \"at the top level\" is anywhere where you can write
7779 More precisely, being at the top-level means that point is either
7780 outside any enclosing block (such as a function definition), or
7781 directly inside a class, namespace or other block that contains
7782 another declaration level.
7784 If point is not at the top-level (e.g. it is inside a method
7785 definition), then nil is returned. Otherwise, if point is at a
7786 top-level not enclosed within a class definition, t is returned.
7787 Otherwise, a 2-vector is returned where the zeroth element is the
7788 buffer position of the start of the class declaration, and the first
7789 element is the buffer position of the enclosing class's opening
7792 Note that this function might do hidden buffer changes. See the
7793 comment at the start of cc-engine.el for more info."
7794 (let ((paren-state (c-parse-state)))
7795 (or (not (c-most-enclosing-brace paren-state
))
7796 (c-search-uplist-for-classkey paren-state
))))
7798 (defun c-just-after-func-arglist-p (&optional lim
)
7799 ;; Return non-nil if the point is in the region after the argument
7800 ;; list of a function and its opening brace (or semicolon in case it
7801 ;; got no body). If there are K&R style argument declarations in
7802 ;; that region, the point has to be inside the first one for this
7803 ;; function to recognize it.
7805 ;; If successful, the point is moved to the first token after the
7806 ;; function header (see `c-forward-decl-or-cast-1' for details) and
7807 ;; the position of the opening paren of the function arglist is
7810 ;; The point is clobbered if not successful.
7812 ;; LIM is used as bound for backward buffer searches.
7814 ;; This function might do hidden buffer changes.
7816 (let ((beg (point)) end id-start
)
7818 (eq (c-beginning-of-statement-1 lim
) 'same
)
7820 (not (and (c-major-mode-is 'objc-mode
)
7821 (c-forward-objc-directive)))
7824 (car-safe (c-forward-decl-or-cast-1 (c-point 'bosws
) nil nil
)))
7827 ;; There should not be a '=' or ',' between beg and the
7828 ;; start of the declaration since that means we were in the
7829 ;; "expression part" of the declaration.
7831 (not (looking-at "[=,]")))
7834 ;; Check that there's an arglist paren in the
7836 (goto-char id-start
)
7837 (cond ((eq (char-after) ?\
()
7838 ;; The declarator is a paren expression, so skip past it
7839 ;; so that we don't get stuck on that instead of the
7840 ;; function arglist.
7842 ((and c-opt-op-identifier-prefix
7843 (looking-at c-opt-op-identifier-prefix
))
7844 ;; Don't trip up on "operator ()".
7845 (c-forward-token-2 2 t
)))
7846 (and (< (point) beg
)
7847 (c-syntactic-re-search-forward "(" beg t t
)
7850 (defun c-in-knr-argdecl (&optional lim
)
7851 ;; Return the position of the first argument declaration if point is
7852 ;; inside a K&R style argument declaration list, nil otherwise.
7853 ;; `c-recognize-knr-p' is not checked. If LIM is non-nil, it's a
7854 ;; position that bounds the backward search for the argument list.
7856 ;; Point must be within a possible K&R region, e.g. just before a top-level
7857 ;; "{". It must be outside of parens and brackets. The test can return
7858 ;; false positives otherwise.
7860 ;; This function might do hidden buffer changes.
7864 ;; If we're in a macro, our search range is restricted to it. Narrow to
7865 ;; the searchable range.
7866 (let* ((macro-start (save-excursion (and (c-beginning-of-macro) (point))))
7867 (macro-end (save-excursion (and macro-start
(c-end-of-macro) (point))))
7868 (low-lim (max (or lim
(point-min)) (or macro-start
(point-min))))
7869 before-lparen after-rparen
7870 (pp-count-out 20)) ; Max number of paren/brace constructs before
7872 (narrow-to-region low-lim
(or macro-end
(point-max)))
7874 ;; Search backwards for the defun's argument list. We give up if we
7875 ;; encounter a "}" (end of a previous defun) an "=" (which can't be in
7876 ;; a knr region) or BOB.
7878 ;; The criterion for a paren structure being the arg list is:
7879 ;; o - there is non-WS stuff after it but before any "{"; AND
7880 ;; o - the token after it isn't a ";" AND
7881 ;; o - it is preceded by either an identifier (the function name) or
7882 ;; a macro expansion like "DEFUN (...)"; AND
7883 ;; o - its content is a non-empty comma-separated list of identifiers
7884 ;; (an empty arg list won't have a knr region).
7886 ;; The following snippet illustrates these rules:
7887 ;; int foo (bar, baz, yuk)
7889 ;; int (*baz) (my_type) ;
7890 ;; int (*) (void) (*yuk) (void) ;
7894 (while (> pp-count-out
0) ; go back one paren/bracket pair each time.
7895 (setq pp-count-out
(1- pp-count-out
))
7896 (c-syntactic-skip-backward "^)]}=")
7897 (cond ((eq (char-before) ?\
))
7898 (setq after-rparen
(point)))
7899 ((eq (char-before) ?\
])
7900 (setq after-rparen nil
))
7901 (t ; either } (hit previous defun) or = or no more
7906 ;; We're inside a paren. Could it be our argument list....?
7910 (goto-char after-rparen
)
7911 (unless (c-go-list-backward) (throw 'knr nil
)) ;
7912 ;; FIXME!!! What about macros between the parens? 2007/01/20
7913 (setq before-lparen
(point)))
7915 ;; It can't be the arg list if next token is ; or {
7916 (progn (goto-char after-rparen
)
7917 (c-forward-syntactic-ws)
7918 (not (memq (char-after) '(?\
; ?\{ ?\=))))
7920 ;; Is the thing preceding the list an identifier (the
7921 ;; function name), or a macro expansion?
7923 (goto-char before-lparen
)
7924 (eq (c-backward-token-2) 0)
7925 (or (eq (c-on-identifier) (point))
7926 (and (eq (char-after) ?\
))
7927 (c-go-up-list-backward)
7928 (eq (c-backward-token-2) 0)
7929 (eq (c-on-identifier) (point)))))
7931 ;; Have we got a non-empty list of comma-separated
7934 (goto-char before-lparen
)
7935 (c-forward-token-2) ; to first token inside parens
7940 (while (eq (char-after) ?\
,)
7942 (unless (c-on-identifier) (throw 'id-list nil
))
7943 (c-forward-token-2))
7944 (eq (char-after) ?\
))))))
7946 ;; ...Yes. We've identified the function's argument list.
7948 (progn (goto-char after-rparen
)
7949 (c-forward-syntactic-ws)
7952 ;; ...No. The current parens aren't the function's arg list.
7953 (goto-char before-lparen
))
7955 (or (c-go-list-backward) ; backwards over [ .... ]
7956 (throw 'knr nil
)))))))))
7958 (defun c-skip-conditional ()
7959 ;; skip forward over conditional at point, including any predicate
7960 ;; statements in parentheses. No error checking is performed.
7962 ;; This function might do hidden buffer changes.
7963 (c-forward-sexp (cond
7965 ((looking-at (concat "\\<else"
7966 "\\([ \t\n]\\|\\\\\n\\)+"
7967 "if\\>\\([^_]\\|$\\)"))
7969 ;; do, else, try, finally
7970 ((looking-at (concat "\\<\\("
7971 "do\\|else\\|try\\|finally"
7972 "\\)\\>\\([^_]\\|$\\)"))
7974 ;; for, if, while, switch, catch, synchronized, foreach
7977 (defun c-after-conditional (&optional lim
)
7978 ;; If looking at the token after a conditional then return the
7979 ;; position of its start, otherwise return nil.
7981 ;; This function might do hidden buffer changes.
7983 (and (zerop (c-backward-token-2 1 t lim
))
7984 (or (looking-at c-block-stmt-1-key
)
7985 (and (eq (char-after) ?\
()
7986 (zerop (c-backward-token-2 1 t lim
))
7987 (looking-at c-block-stmt-2-key
)))
7990 (defun c-after-special-operator-id (&optional lim
)
7991 ;; If the point is after an operator identifier that isn't handled
7992 ;; like an ordinary symbol (i.e. like "operator =" in C++) then the
7993 ;; position of the start of that identifier is returned. nil is
7994 ;; returned otherwise. The point may be anywhere in the syntactic
7995 ;; whitespace after the last token of the operator identifier.
7997 ;; This function might do hidden buffer changes.
7999 (and c-overloadable-operators-regexp
8000 (zerop (c-backward-token-2 1 nil lim
))
8001 (looking-at c-overloadable-operators-regexp
)
8002 (or (not c-opt-op-identifier-prefix
)
8004 (zerop (c-backward-token-2 1 nil lim
))
8005 (looking-at c-opt-op-identifier-prefix
)))
8008 (defsubst c-backward-to-block-anchor
(&optional lim
)
8009 ;; Assuming point is at a brace that opens a statement block of some
8010 ;; kind, move to the proper anchor point for that block. It might
8011 ;; need to be adjusted further by c-add-stmt-syntax, but the
8012 ;; position at return is suitable as start position for that
8015 ;; This function might do hidden buffer changes.
8016 (unless (= (point) (c-point 'boi
))
8017 (let ((start (c-after-conditional lim
)))
8019 (goto-char start
)))))
8021 (defsubst c-backward-to-decl-anchor
(&optional lim
)
8022 ;; Assuming point is at a brace that opens the block of a top level
8023 ;; declaration of some kind, move to the proper anchor point for
8026 ;; This function might do hidden buffer changes.
8027 (unless (= (point) (c-point 'boi
))
8028 (c-beginning-of-statement-1 lim
)))
8030 (defun c-search-decl-header-end ()
8031 ;; Search forward for the end of the "header" of the current
8032 ;; declaration. That's the position where the definition body
8033 ;; starts, or the first variable initializer, or the ending
8034 ;; semicolon. I.e. search forward for the closest following
8035 ;; (syntactically relevant) '{', '=' or ';' token. Point is left
8036 ;; _after_ the first found token, or at point-max if none is found.
8038 ;; This function might do hidden buffer changes.
8040 (let ((base (point)))
8041 (if (c-major-mode-is 'c
++-mode
)
8043 ;; In C++ we need to take special care to handle operator
8044 ;; tokens and those pesky template brackets.
8046 (c-syntactic-re-search-forward "[;{<=]" nil
'move t t
)
8048 (c-end-of-current-token base
)
8049 ;; Handle operator identifiers, i.e. ignore any
8050 ;; operator token preceded by "operator".
8052 (and (c-safe (c-backward-sexp) t
)
8053 (looking-at c-opt-op-identifier-prefix
)))
8054 (and (eq (char-before) ?
<)
8055 (c-with-syntax-table c
++-template-syntax-table
8056 (if (c-safe (goto-char (c-up-list-forward (point))))
8058 (goto-char (point-max))
8060 (setq base
(point)))
8063 (c-syntactic-re-search-forward "[;{=]" nil
'move t t
)
8064 (c-end-of-current-token base
))
8065 (setq base
(point))))))
8067 (defun c-beginning-of-decl-1 (&optional lim
)
8068 ;; Go to the beginning of the current declaration, or the beginning
8069 ;; of the previous one if already at the start of it. Point won't
8070 ;; be moved out of any surrounding paren. Return a cons cell of the
8071 ;; form (MOVE . KNR-POS). MOVE is like the return value from
8072 ;; `c-beginning-of-statement-1'. If point skipped over some K&R
8073 ;; style argument declarations (and they are to be recognized) then
8074 ;; KNR-POS is set to the start of the first such argument
8075 ;; declaration, otherwise KNR-POS is nil. If LIM is non-nil, it's a
8076 ;; position that bounds the backward search.
8078 ;; NB: Cases where the declaration continues after the block, as in
8079 ;; "struct foo { ... } bar;", are currently recognized as two
8080 ;; declarations, e.g. "struct foo { ... }" and "bar;" in this case.
8082 ;; This function might do hidden buffer changes.
8084 (let* ((start (point))
8085 (last-stmt-start (point))
8086 (move (c-beginning-of-statement-1 lim nil t
)))
8088 ;; `c-beginning-of-statement-1' stops at a block start, but we
8089 ;; want to continue if the block doesn't begin a top level
8090 ;; construct, i.e. if it isn't preceded by ';', '}', ':', bob,
8091 ;; or an open paren.
8092 (let ((beg (point)) tentative-move
)
8093 ;; Go back one "statement" each time round the loop until we're just
8094 ;; after a ;, }, or :, or at BOB or the start of a macro or start of
8095 ;; an ObjC method. This will move over a multiple declaration whose
8096 ;; components are comma separated.
8098 ;; Must check with c-opt-method-key in ObjC mode.
8099 (not (and c-opt-method-key
8100 (looking-at c-opt-method-key
)))
8101 (/= last-stmt-start
(point))
8103 (c-backward-syntactic-ws lim
)
8104 (not (memq (char-before) '(?\
; ?} ?: nil))))
8107 (not (looking-at "\\s(")))
8108 ;; Check that we don't move from the first thing in a
8109 ;; macro to its header.
8110 (not (eq (setq tentative-move
8111 (c-beginning-of-statement-1 lim nil t
))
8113 (setq last-stmt-start beg
8115 move tentative-move
))
8118 (when c-recognize-knr-p
8119 (let ((fallback-pos (point)) knr-argdecl-start
)
8120 ;; Handle K&R argdecls. Back up after the "statement" jumped
8121 ;; over by `c-beginning-of-statement-1', unless it was the
8122 ;; function body, in which case we're sitting on the opening
8123 ;; brace now. Then test if we're in a K&R argdecl region and
8124 ;; that we started at the other side of the first argdecl in
8126 (unless (eq (char-after) ?
{)
8127 (goto-char last-stmt-start
))
8128 (if (and (setq knr-argdecl-start
(c-in-knr-argdecl lim
))
8129 (< knr-argdecl-start start
)
8131 (goto-char knr-argdecl-start
)
8132 (not (eq (c-beginning-of-statement-1 lim nil t
) 'macro
))))
8134 (cons (if (eq (char-after fallback-pos
) ?
{)
8138 (goto-char fallback-pos
))))
8140 ;; `c-beginning-of-statement-1' counts each brace block as a separate
8141 ;; statement, so the result will be 'previous if we've moved over any.
8142 ;; So change our result back to 'same if necessary.
8144 ;; If they were brace list initializers we might not have moved over a
8145 ;; declaration boundary though, so change it to 'same if we've moved
8146 ;; past a '=' before '{', but not ';'. (This ought to be integrated
8147 ;; into `c-beginning-of-statement-1', so we avoid this extra pass which
8148 ;; potentially can search over a large amount of text.). Take special
8149 ;; pains not to get mislead by C++'s "operator=", and the like.
8150 (if (and (eq move
'previous
)
8151 (c-with-syntax-table (if (c-major-mode-is 'c
++-mode
)
8152 c
++-template-syntax-table
8157 (while ; keep going back to "[;={"s until we either find
8158 ; no more, or get to one which isn't an "operator ="
8159 (and (c-syntactic-re-search-forward "[;={]" start t t t
)
8160 (eq (char-before) ?
=)
8161 c-overloadable-operators-regexp
8162 c-opt-op-identifier-prefix
8164 (eq (c-backward-token-2) 0)
8165 (looking-at c-overloadable-operators-regexp
)
8166 (eq (c-backward-token-2) 0)
8167 (looking-at c-opt-op-identifier-prefix
))))
8168 (eq (char-before) ?
=))
8169 (c-syntactic-re-search-forward "[;{]" start t t
)
8170 (eq (char-before) ?
{)
8171 (c-safe (goto-char (c-up-list-forward (point))) t
)
8172 (not (c-syntactic-re-search-forward ";" start t t
))))))
8176 (defun c-end-of-decl-1 ()
8177 ;; Assuming point is at the start of a declaration (as detected by
8178 ;; e.g. `c-beginning-of-decl-1'), go to the end of it. Unlike
8179 ;; `c-beginning-of-decl-1', this function handles the case when a
8180 ;; block is followed by identifiers in e.g. struct declarations in C
8181 ;; or C++. If a proper end was found then t is returned, otherwise
8182 ;; point is moved as far as possible within the current sexp and nil
8183 ;; is returned. This function doesn't handle macros; use
8184 ;; `c-end-of-macro' instead in those cases.
8186 ;; This function might do hidden buffer changes.
8187 (let ((start (point))
8188 (decl-syntax-table (if (c-major-mode-is 'c
++-mode
)
8189 c
++-template-syntax-table
8192 (c-search-decl-header-end)
8194 (when (and c-recognize-knr-p
8195 (eq (char-before) ?\
;)
8196 (c-in-knr-argdecl start
))
8197 ;; Stopped at the ';' in a K&R argdecl section which is
8198 ;; detected using the same criteria as in
8199 ;; `c-beginning-of-decl-1'. Move to the following block
8201 (c-syntactic-re-search-forward "{" nil
'move t
))
8203 (when (eq (char-before) ?
{)
8204 ;; Encountered a block in the declaration. Jump over it.
8206 (goto-char (c-up-list-forward (point)))
8207 (error (goto-char (point-max))
8208 (throw 'return nil
)))
8209 (if (or (not c-opt-block-decls-with-vars-key
)
8211 (c-with-syntax-table decl-syntax-table
8212 (let ((lim (point)))
8215 ;; Check for `c-opt-block-decls-with-vars-key'
8216 ;; before the first paren.
8217 (c-syntactic-re-search-forward
8218 (concat "[;=\(\[{]\\|\\("
8219 c-opt-block-decls-with-vars-key
8223 (not (eq (char-before) ?_
))
8224 ;; Check that the first following paren is
8226 (c-syntactic-re-search-forward "[;=\(\[{]"
8228 (eq (char-before) ?
{)))))))
8229 ;; The declaration doesn't have any of the
8230 ;; `c-opt-block-decls-with-vars' keywords in the
8231 ;; beginning, so it ends here at the end of the block.
8234 (c-with-syntax-table decl-syntax-table
8236 (if (eq (char-before) ?\
;)
8238 (c-syntactic-re-search-forward ";" nil
'move t
))))
8241 (defun c-looking-at-decl-block (containing-sexp goto-start
&optional limit
)
8242 ;; Assuming the point is at an open brace, check if it starts a
8243 ;; block that contains another declaration level, i.e. that isn't a
8244 ;; statement block or a brace list, and if so return non-nil.
8246 ;; If the check is successful, the return value is the start of the
8247 ;; keyword that tells what kind of construct it is, i.e. typically
8248 ;; what `c-decl-block-key' matched. Also, if GOTO-START is set then
8249 ;; the point will be at the start of the construct, before any
8250 ;; leading specifiers, otherwise it's at the returned position.
8252 ;; The point is clobbered if the check is unsuccessful.
8254 ;; CONTAINING-SEXP is the position of the open of the surrounding
8255 ;; paren, or nil if none.
8257 ;; The optional LIMIT limits the backward search for the start of
8258 ;; the construct. It's assumed to be at a syntactically relevant
8261 ;; If any template arglists are found in the searched region before
8262 ;; the open brace, they get marked with paren syntax.
8264 ;; This function might do hidden buffer changes.
8266 (let ((open-brace (point)) kwd-start first-specifier-pos
)
8267 (c-syntactic-skip-backward c-block-prefix-charset limit t
)
8269 (when (and c-recognize-
<>-arglists
8270 (eq (char-before) ?
>))
8271 ;; Could be at the end of a template arglist.
8272 (let ((c-parse-and-markup-<>-arglists t
)
8273 (c-disallow-comma-in-<>-arglists
8274 (and containing-sexp
8275 (not (eq (char-after containing-sexp
) ?
{)))))
8277 (c-backward-<>-arglist nil limit
)
8279 (c-syntactic-skip-backward c-block-prefix-charset limit t
)
8280 (eq (char-before) ?
>))))))
8282 ;; Note: Can't get bogus hits inside template arglists below since they
8283 ;; have gotten paren syntax above.
8285 ;; If `goto-start' is set we begin by searching for the
8286 ;; first possible position of a leading specifier list.
8287 ;; The `c-decl-block-key' search continues from there since
8288 ;; we know it can't match earlier.
8290 (when (c-syntactic-re-search-forward c-symbol-start
8292 (goto-char (setq first-specifier-pos
(match-beginning 0)))
8297 ((c-syntactic-re-search-forward c-decl-block-key open-brace t t t
)
8298 (goto-char (setq kwd-start
(match-beginning 0)))
8301 ;; Found a keyword that can't be a type?
8304 ;; Can be a type too, in which case it's the return type of a
8305 ;; function (under the assumption that no declaration level
8306 ;; block construct starts with a type).
8307 (not (c-forward-type))
8309 ;; Jumped over a type, but it could be a declaration keyword
8310 ;; followed by the declared identifier that we've jumped over
8311 ;; instead (e.g. in "class Foo {"). If it indeed is a type
8312 ;; then we should be at the declarator now, so check for a
8313 ;; valid declarator start.
8315 ;; Note: This doesn't cope with the case when a declared
8316 ;; identifier is followed by e.g. '(' in a language where '('
8317 ;; also might be part of a declarator expression. Currently
8318 ;; there's no such language.
8319 (not (or (looking-at c-symbol-start
)
8320 (looking-at c-type-decl-prefix-key
)))))
8322 ;; In Pike a list of modifiers may be followed by a brace
8323 ;; to make them apply to many identifiers. Note that the
8324 ;; match data will be empty on return in this case.
8325 ((and (c-major-mode-is 'pike-mode
)
8327 (goto-char open-brace
)
8328 (= (c-backward-token-2) 0))
8329 (looking-at c-specifier-key
)
8330 ;; Use this variant to avoid yet another special regexp.
8331 (c-keyword-member (c-keyword-sym (match-string 1))
8333 (setq kwd-start
(point))
8339 ;; Back up over any preceding specifiers and their clauses
8340 ;; by going forward from `first-specifier-pos', which is the
8341 ;; earliest possible position where the specifier list can
8344 (goto-char first-specifier-pos
)
8346 (while (< (point) kwd-start
)
8347 (if (looking-at c-symbol-key
)
8348 ;; Accept any plain symbol token on the ground that
8349 ;; it's a specifier masked through a macro (just
8350 ;; like `c-forward-decl-or-cast-1' skip forward over
8353 ;; Could be more restrictive wrt invalid keywords,
8354 ;; but that'd only occur in invalid code so there's
8355 ;; no use spending effort on it.
8356 (let ((end (match-end 0)))
8357 (unless (c-forward-keyword-clause 0)
8359 (c-forward-syntactic-ws)))
8361 ;; Can't parse a declaration preamble and is still
8362 ;; before `kwd-start'. That means `first-specifier-pos'
8363 ;; was in some earlier construct. Search again.
8364 (if (c-syntactic-re-search-forward c-symbol-start
8366 (goto-char (setq first-specifier-pos
(match-beginning 0)))
8367 ;; Got no preamble before the block declaration keyword.
8368 (setq first-specifier-pos kwd-start
))))
8370 (goto-char first-specifier-pos
))
8371 (goto-char kwd-start
))
8375 (defun c-search-uplist-for-classkey (paren-state)
8376 ;; Check if the closest containing paren sexp is a declaration
8377 ;; block, returning a 2 element vector in that case. Aref 0
8378 ;; contains the bufpos at boi of the class key line, and aref 1
8379 ;; contains the bufpos of the open brace. This function is an
8380 ;; obsolete wrapper for `c-looking-at-decl-block'.
8382 ;; This function might do hidden buffer changes.
8383 (let ((open-paren-pos (c-most-enclosing-brace paren-state
)))
8384 (when open-paren-pos
8386 (goto-char open-paren-pos
)
8387 (when (and (eq (char-after) ?
{)
8388 (c-looking-at-decl-block
8389 (c-safe-position open-paren-pos paren-state
)
8391 (back-to-indentation)
8392 (vector (point) open-paren-pos
))))))
8394 (defmacro c-pull-open-brace
(ps)
8395 ;; Pull the next open brace from PS (which has the form of paren-state),
8396 ;; skipping over any brace pairs. Returns NIL when PS is exhausted.
8398 (while (consp (car ,ps
))
8399 (setq ,ps
(cdr ,ps
)))
8401 (setq ,ps
(cdr ,ps
)))))
8403 (defun c-most-enclosing-decl-block (paren-state)
8404 ;; Return the buffer position of the most enclosing decl-block brace (in the
8405 ;; sense of c-looking-at-decl-block) in the PAREN-STATE structure, or nil if
8407 (let* ((open-brace (c-pull-open-brace paren-state
))
8408 (next-open-brace (c-pull-open-brace paren-state
)))
8409 (while (and open-brace
8411 (goto-char open-brace
)
8412 (not (c-looking-at-decl-block next-open-brace nil
))))
8413 (setq open-brace next-open-brace
8414 next-open-brace
(c-pull-open-brace paren-state
)))
8417 (defun c-cheap-inside-bracelist-p (paren-state)
8418 ;; Return the position of the L-brace if point is inside a brace list
8419 ;; initialization of an array, etc. This is an approximate function,
8420 ;; designed for speed over accuracy. It will not find every bracelist, but
8421 ;; a non-nil result is reliable. We simply search for "= {" (naturally with
8422 ;; syntactic whitespace allowed). PAREN-STATE is the normal thing that it
8423 ;; is everywhere else.
8427 (and (setq b-pos
(c-pull-open-brace paren-state
))
8428 (progn (goto-char b-pos
)
8430 (c-backward-token-2)
8431 (not (looking-at "=")))))
8434 (defun c-inside-bracelist-p (containing-sexp paren-state
)
8435 ;; return the buffer position of the beginning of the brace list
8436 ;; statement if we're inside a brace list, otherwise return nil.
8437 ;; CONTAINING-SEXP is the buffer pos of the innermost containing
8438 ;; paren. PAREN-STATE is the remainder of the state of enclosing
8441 ;; N.B.: This algorithm can potentially get confused by cpp macros
8442 ;; placed in inconvenient locations. It's a trade-off we make for
8445 ;; This function might do hidden buffer changes.
8447 ;; This will pick up brace list declarations.
8450 (goto-char containing-sexp
)
8453 (if (and (or (looking-at c-brace-list-key
)
8454 (progn (c-forward-sexp -
1)
8455 (looking-at c-brace-list-key
)))
8456 (setq bracepos
(c-down-list-forward (point)))
8457 (not (c-crosses-statement-barrier-p (point)
8460 ;; this will pick up array/aggregate init lists, even if they are nested.
8463 ;; Pike can have class definitions anywhere, so we must
8464 ;; check for the class key here.
8465 (and (c-major-mode-is 'pike-mode
)
8467 bufpos braceassignp lim next-containing
)
8468 (while (and (not bufpos
)
8471 (if (consp (car paren-state
))
8472 (setq lim
(cdr (car paren-state
))
8473 paren-state
(cdr paren-state
))
8474 (setq lim
(car paren-state
)))
8476 (setq next-containing
(car paren-state
)
8477 paren-state
(cdr paren-state
))))
8478 (goto-char containing-sexp
)
8479 (if (c-looking-at-inexpr-block next-containing next-containing
)
8480 ;; We're in an in-expression block of some kind. Do not
8481 ;; check nesting. We deliberately set the limit to the
8482 ;; containing sexp, so that c-looking-at-inexpr-block
8483 ;; doesn't check for an identifier before it.
8484 (setq containing-sexp nil
)
8485 ;; see if the open brace is preceded by = or [...] in
8486 ;; this statement, but watch out for operator=
8487 (setq braceassignp
'dontknow
)
8488 (c-backward-token-2 1 t lim
)
8489 ;; Checks to do only on the first sexp before the brace.
8490 (when (and c-opt-inexpr-brace-list-key
8491 (eq (char-after) ?\
[))
8492 ;; In Java, an initialization brace list may follow
8493 ;; directly after "new Foo[]", so check for a "new"
8495 (while (eq braceassignp
'dontknow
)
8497 (cond ((/= (c-backward-token-2 1 t lim
) 0) nil
)
8498 ((looking-at c-opt-inexpr-brace-list-key
) t
)
8499 ((looking-at "\\sw\\|\\s_\\|[.[]")
8500 ;; Carry on looking if this is an
8501 ;; identifier (may contain "." in Java)
8502 ;; or another "[]" sexp.
8505 ;; Checks to do on all sexps before the brace, up to the
8506 ;; beginning of the statement.
8507 (while (eq braceassignp
'dontknow
)
8508 (cond ((eq (char-after) ?\
;)
8509 (setq braceassignp nil
))
8511 (looking-at class-key
))
8512 (setq braceassignp nil
))
8513 ((eq (char-after) ?
=)
8514 ;; We've seen a =, but must check earlier tokens so
8515 ;; that it isn't something that should be ignored.
8516 (setq braceassignp
'maybe
)
8517 (while (and (eq braceassignp
'maybe
)
8518 (zerop (c-backward-token-2 1 t lim
)))
8521 ;; Check for operator =
8522 ((and c-opt-op-identifier-prefix
8523 (looking-at c-opt-op-identifier-prefix
))
8525 ;; Check for `<opchar>= in Pike.
8526 ((and (c-major-mode-is 'pike-mode
)
8527 (or (eq (char-after) ?
`)
8528 ;; Special case for Pikes
8529 ;; `[]=, since '[' is not in
8530 ;; the punctuation class.
8531 (and (eq (char-after) ?\
[)
8532 (eq (char-before) ?
`))))
8534 ((looking-at "\\s.") 'maybe
)
8535 ;; make sure we're not in a C++ template
8536 ;; argument assignment
8538 (c-major-mode-is 'c
++-mode
)
8540 (let ((here (point))
8542 (skip-chars-backward "^<>")
8544 (and (eq (char-before) ?
<)
8545 (not (c-crosses-statement-barrier-p
8547 (not (c-in-literal))
8551 (if (and (eq braceassignp
'dontknow
)
8552 (/= (c-backward-token-2 1 t lim
) 0))
8553 (setq braceassignp nil
)))
8554 (if (not braceassignp
)
8555 (if (eq (char-after) ?\
;)
8556 ;; Brace lists can't contain a semicolon, so we're done.
8557 (setq containing-sexp nil
)
8559 (setq containing-sexp next-containing
8561 next-containing nil
))
8562 ;; we've hit the beginning of the aggregate list
8563 (c-beginning-of-statement-1
8564 (c-most-enclosing-brace paren-state
))
8565 (setq bufpos
(point))))
8570 (defun c-looking-at-special-brace-list (&optional lim
)
8571 ;; If we're looking at the start of a pike-style list, i.e., `({Â })',
8572 ;; `([Â ])', `(<Â >)', etc., a cons of a cons of its starting and ending
8573 ;; positions and its entry in c-special-brace-lists is returned, nil
8574 ;; otherwise. The ending position is nil if the list is still open.
8575 ;; LIM is the limit for forward search. The point may either be at
8576 ;; the `(' or at the following paren character. Tries to check the
8577 ;; matching closer, but assumes it's correct if no balanced paren is
8578 ;; found (i.e. the case `({ ... } ... )' is detected as _not_ being
8579 ;; a special brace list).
8581 ;; This function might do hidden buffer changes.
8582 (if c-special-brace-lists
8587 (c-forward-syntactic-ws)
8588 (if (eq (char-after) ?\
()
8591 (c-forward-syntactic-ws)
8592 (setq inner-beg
(point))
8593 (setq type
(assq (char-after) c-special-brace-lists
)))
8594 (if (setq type
(assq (char-after) c-special-brace-lists
))
8596 (setq inner-beg
(point))
8597 (c-backward-syntactic-ws)
8599 (setq beg
(if (eq (char-after) ?\
()
8607 (= (char-before) ?\
)))
8609 (goto-char inner-beg
)
8610 (if (looking-at "\\s(")
8611 ;; Check balancing of the inner paren
8616 ;; If the inner char isn't a paren then
8617 ;; we can't check balancing, so just
8618 ;; check the char before the outer
8622 (c-backward-syntactic-ws)
8623 (= (char-before) (cdr type
)))))
8624 (if (or (/= (char-syntax (char-before)) ?\
))
8626 (c-forward-syntactic-ws)
8629 (cons (cons beg end
) type
))
8630 (cons (list beg
) type
)))))
8633 (defun c-looking-at-bos (&optional lim
)
8634 ;; Return non-nil if between two statements or declarations, assuming
8635 ;; point is not inside a literal or comment.
8637 ;; Obsolete - `c-at-statement-start-p' or `c-at-expression-start-p'
8638 ;; are recommended instead.
8640 ;; This function might do hidden buffer changes.
8641 (c-at-statement-start-p))
8642 (make-obsolete 'c-looking-at-bos
'c-at-statement-start-p
"22.1")
8644 (defun c-looking-at-inexpr-block (lim containing-sexp
&optional check-at-end
)
8645 ;; Return non-nil if we're looking at the beginning of a block
8646 ;; inside an expression. The value returned is actually a cons of
8647 ;; either 'inlambda, 'inexpr-statement or 'inexpr-class and the
8648 ;; position of the beginning of the construct.
8650 ;; LIM limits the backward search. CONTAINING-SEXP is the start
8651 ;; position of the closest containing list. If it's nil, the
8652 ;; containing paren isn't used to decide whether we're inside an
8653 ;; expression or not. If both LIM and CONTAINING-SEXP are used, LIM
8654 ;; needs to be farther back.
8656 ;; If CHECK-AT-END is non-nil then extra checks at the end of the
8657 ;; brace block might be done. It should only be used when the
8658 ;; construct can be assumed to be complete, i.e. when the original
8659 ;; starting position was further down than that.
8661 ;; This function might do hidden buffer changes.
8664 (let ((res 'maybe
) passed-paren
8665 (closest-lim (or containing-sexp lim
(point-min)))
8666 ;; Look at the character after point only as a last resort
8667 ;; when we can't disambiguate.
8668 (block-follows (and (eq (char-after) ?
{) (point))))
8670 (while (and (eq res
'maybe
)
8671 (progn (c-backward-syntactic-ws)
8672 (> (point) closest-lim
))
8674 (progn (backward-char)
8675 (looking-at "[\]\).]\\|\\w\\|\\s_"))
8676 (c-safe (forward-char)
8677 (goto-char (scan-sexps (point) -
1))))
8680 (if (looking-at c-keywords-regexp
)
8681 (let ((kw-sym (c-keyword-sym (match-string 1))))
8684 (c-keyword-member kw-sym
'c-inexpr-class-kwds
))
8685 (and (not (eq passed-paren ?\
[))
8686 (or (not (looking-at c-class-key
))
8687 ;; If the class definition is at the start of
8688 ;; a statement, we don't consider it an
8689 ;; in-expression class.
8690 (let ((prev (point)))
8692 (= (c-backward-token-2 1 nil closest-lim
) 0)
8693 (eq (char-syntax (char-after)) ?w
))
8694 (setq prev
(point)))
8696 (not (c-at-statement-start-p)))
8697 ;; Also, in Pike we treat it as an
8698 ;; in-expression class if it's used in an
8699 ;; object clone expression.
8702 (c-major-mode-is 'pike-mode
)
8703 (progn (goto-char block-follows
)
8704 (zerop (c-forward-token-2 1 t
)))
8705 (eq (char-after) ?\
())))
8706 (cons 'inexpr-class
(point))))
8707 ((c-keyword-member kw-sym
'c-inexpr-block-kwds
)
8708 (when (not passed-paren
)
8709 (cons 'inexpr-statement
(point))))
8710 ((c-keyword-member kw-sym
'c-lambda-kwds
)
8711 (when (or (not passed-paren
)
8712 (eq passed-paren ?\
())
8713 (cons 'inlambda
(point))))
8714 ((c-keyword-member kw-sym
'c-block-stmt-kwds
)
8719 (if (looking-at "\\s(")
8721 (if (and (eq passed-paren ?\
[)
8722 (eq (char-after) ?\
[))
8723 ;; Accept several square bracket sexps for
8724 ;; Java array initializations.
8726 (setq passed-paren
(char-after))
8731 (when (and c-recognize-paren-inexpr-blocks
8734 (eq (char-after containing-sexp
) ?\
())
8735 (goto-char containing-sexp
)
8736 (if (or (save-excursion
8737 (c-backward-syntactic-ws lim
)
8738 (and (> (point) (or lim
(point-min)))
8740 (and c-special-brace-lists
8741 (c-looking-at-special-brace-list)))
8743 (cons 'inexpr-statement
(point))))
8747 (defun c-looking-at-inexpr-block-backward (paren-state)
8748 ;; Returns non-nil if we're looking at the end of an in-expression
8749 ;; block, otherwise the same as `c-looking-at-inexpr-block'.
8750 ;; PAREN-STATE is the paren state relevant at the current position.
8752 ;; This function might do hidden buffer changes.
8754 ;; We currently only recognize a block.
8755 (let ((here (point))
8756 (elem (car-safe paren-state
))
8758 (when (and (consp elem
)
8759 (progn (goto-char (cdr elem
))
8760 (c-forward-syntactic-ws here
)
8762 (goto-char (car elem
))
8763 (if (setq paren-state
(cdr paren-state
))
8764 (setq containing-sexp
(car-safe paren-state
)))
8765 (c-looking-at-inexpr-block (c-safe-position containing-sexp
8767 containing-sexp
)))))
8769 (defun c-at-macro-vsemi-p (&optional pos
)
8770 ;; Is there a "virtual semicolon" at POS or point?
8771 ;; (See cc-defs.el for full details of "virtual semicolons".)
8773 ;; This is true when point is at the last non syntactic WS position on the
8774 ;; line, there is a macro call last on the line, and this particular macro's
8775 ;; name is defined by the regexp `c-vs-macro-regexp' as not needing a
8784 c-macro-with-semi-re
8785 (eq (skip-chars-backward " \t") 0)
8787 ;; Check we've got nothing after this except comments and empty lines
8788 ;; joined by escaped EOLs.
8789 (skip-chars-forward " \t") ; always returns non-nil.
8791 (while ; go over 1 block comment per iteration.
8793 (looking-at "\\(\\\\[\n\r][ \t]*\\)*")
8794 (goto-char (match-end 0))
8796 ((looking-at c-block-comment-start-regexp
)
8797 (and (forward-comment 1)
8798 (skip-chars-forward " \t"))) ; always returns non-nil
8799 ((looking-at c-line-comment-start-regexp
)
8806 (progn (c-backward-syntactic-ws)
8809 ;; Check for one of the listed macros being before point.
8810 (or (not (eq (char-before) ?\
)))
8811 (when (c-go-list-backward)
8812 (c-backward-syntactic-ws)
8814 (c-simple-skip-symbol-backward)
8815 (looking-at c-macro-with-semi-re
)
8817 (not (c-in-literal)))))) ; The most expensive check last.
8819 (defun c-macro-vsemi-status-unknown-p () t
) ; See cc-defs.el.
8822 ;; `c-guess-basic-syntax' and the functions that precedes it below
8823 ;; implements the main decision tree for determining the syntactic
8824 ;; analysis of the current line of code.
8826 ;; Dynamically bound to t when `c-guess-basic-syntax' is called during
8827 ;; auto newline analysis.
8828 (defvar c-auto-newline-analysis nil
)
8830 (defun c-brace-anchor-point (bracepos)
8831 ;; BRACEPOS is the position of a brace in a construct like "namespace
8832 ;; Bar {". Return the anchor point in this construct; this is the
8833 ;; earliest symbol on the brace's line which isn't earlier than
8836 ;; Currently (2007-08-17), "like namespace" means "matches
8837 ;; c-other-block-decl-kwds". It doesn't work with "class" or "struct"
8838 ;; or anything like that.
8840 (let ((boi (c-point 'boi bracepos
)))
8841 (goto-char bracepos
)
8842 (while (and (> (point) boi
)
8843 (not (looking-at c-other-decl-block-key
)))
8844 (c-backward-token-2))
8845 (if (> (point) boi
) (point) boi
))))
8847 (defsubst c-add-syntax
(symbol &rest args
)
8848 ;; A simple function to prepend a new syntax element to
8849 ;; `c-syntactic-context'. Using `setq' on it is unsafe since it
8850 ;; should always be dynamically bound but since we read it first
8851 ;; we'll fail properly anyway if this function is misused.
8852 (setq c-syntactic-context
(cons (cons symbol args
)
8853 c-syntactic-context
)))
8855 (defsubst c-append-syntax
(symbol &rest args
)
8856 ;; Like `c-add-syntax' but appends to the end of the syntax list.
8857 ;; (Normally not necessary.)
8858 (setq c-syntactic-context
(nconc c-syntactic-context
8859 (list (cons symbol args
)))))
8861 (defun c-add-stmt-syntax (syntax-symbol
8866 ;; Add the indicated SYNTAX-SYMBOL to `c-syntactic-context', extending it as
8867 ;; needed with further syntax elements of the types `substatement',
8868 ;; `inexpr-statement', `arglist-cont-nonempty', `statement-block-intro', and
8869 ;; `defun-block-intro'.
8871 ;; Do the generic processing to anchor the given syntax symbol on
8872 ;; the preceding statement: Skip over any labels and containing
8873 ;; statements on the same line, and then search backward until we
8874 ;; find a statement or block start that begins at boi without a
8875 ;; label or comment.
8877 ;; Point is assumed to be at the prospective anchor point for the
8878 ;; given SYNTAX-SYMBOL. More syntax entries are added if we need to
8879 ;; skip past open parens and containing statements. Most of the added
8880 ;; syntax elements will get the same anchor point - the exception is
8881 ;; for an anchor in a construct like "namespace"[*] - this is as early
8882 ;; as possible in the construct but on the same line as the {.
8884 ;; [*] i.e. with a keyword matching c-other-block-decl-kwds.
8886 ;; SYNTAX-EXTRA-ARGS are a list of the extra arguments for the
8887 ;; syntax symbol. They are appended after the anchor point.
8889 ;; If STOP-AT-BOI-ONLY is nil, we can stop in the middle of the line
8890 ;; if the current statement starts there.
8892 ;; Note: It's not a problem if PAREN-STATE "overshoots"
8893 ;; CONTAINING-SEXP, i.e. contains info about parens further down.
8895 ;; This function might do hidden buffer changes.
8897 (if (= (point) (c-point 'boi
))
8898 ;; This is by far the most common case, so let's give it special
8900 (apply 'c-add-syntax syntax-symbol
(point) syntax-extra-args
)
8902 (let ((syntax-last c-syntactic-context
)
8903 (boi (c-point 'boi
))
8904 ;; Set when we're on a label, so that we don't stop there.
8905 ;; FIXME: To be complete we should check if we're on a label
8906 ;; now at the start.
8909 ;; Use point as the anchor point for "namespace", "extern", etc.
8910 (apply 'c-add-syntax syntax-symbol
8911 (if (rassq syntax-symbol c-other-decl-block-key-in-symbols-alist
)
8915 ;; Loop while we have to back out of containing blocks.
8918 (catch 'back-up-block
8920 ;; Loop while we have to back up statements.
8921 (while (or (/= (point) boi
)
8923 (looking-at c-comment-start-regexp
))
8925 ;; Skip past any comments that stands between the
8926 ;; statement start and boi.
8927 (let ((savepos (point)))
8928 (while (and (/= savepos boi
)
8929 (c-backward-single-comment))
8930 (setq savepos
(point)
8931 boi
(c-point 'boi
)))
8932 (goto-char savepos
))
8934 ;; Skip to the beginning of this statement or backward
8936 (let ((old-pos (point))
8938 (step-type (c-beginning-of-statement-1 containing-sexp
)))
8939 (setq boi
(c-point 'boi
)
8940 on-label
(eq step-type
'label
))
8942 (cond ((= (point) old-pos
)
8943 ;; If we didn't move we're at the start of a block and
8944 ;; have to continue outside it.
8945 (throw 'back-up-block t
))
8947 ((and (eq step-type
'up
)
8948 (>= (point) old-boi
)
8949 (looking-at "else\\>[^_]")
8952 (looking-at "if\\>[^_]")))
8953 ;; Special case to avoid deeper and deeper indentation
8954 ;; of "else if" clauses.
8957 ((and (not stop-at-boi-only
)
8958 (/= old-pos old-boi
)
8959 (memq step-type
'(up previous
)))
8960 ;; If stop-at-boi-only is nil, we shouldn't back up
8961 ;; over previous or containing statements to try to
8962 ;; reach boi, so go back to the last position and
8965 (throw 'back-up-block nil
))
8968 (if (and (not stop-at-boi-only
)
8969 (memq step-type
'(up previous beginning
)))
8970 ;; If we've moved into another statement then we
8971 ;; should no longer try to stop in the middle of a
8973 (setq stop-at-boi-only t
))
8975 ;; Record this as a substatement if we skipped up one
8977 (when (eq step-type
'up
)
8978 (c-add-syntax 'substatement nil
))))
8983 ;; Now we have to go out of this block.
8984 (goto-char containing-sexp
)
8986 ;; Don't stop in the middle of a special brace list opener
8988 (when c-special-brace-lists
8989 (let ((special-list (c-looking-at-special-brace-list)))
8990 (when (and special-list
8991 (< (car (car special-list
)) (point)))
8992 (setq containing-sexp
(car (car special-list
)))
8993 (goto-char containing-sexp
))))
8995 (setq paren-state
(c-whack-state-after containing-sexp paren-state
)
8996 containing-sexp
(c-most-enclosing-brace paren-state
)
8999 ;; Analyze the construct in front of the block we've stepped out
9000 ;; from and add the right syntactic element for it.
9001 (let ((paren-pos (point))
9002 (paren-char (char-after))
9005 (if (eq paren-char ?\
()
9006 ;; Stepped out of a parenthesis block, so we're in an
9009 (when (/= paren-pos boi
)
9010 (if (and c-recognize-paren-inexpr-blocks
9012 (c-backward-syntactic-ws containing-sexp
)
9013 (or (not (looking-at "\\>"))
9014 (not (c-on-identifier))))
9016 (goto-char (1+ paren-pos
))
9017 (c-forward-syntactic-ws)
9018 (eq (char-after) ?
{)))
9019 ;; Stepped out of an in-expression statement. This
9020 ;; syntactic element won't get an anchor pos.
9021 (c-add-syntax 'inexpr-statement
)
9023 ;; A parenthesis normally belongs to an arglist.
9024 (c-add-syntax 'arglist-cont-nonempty nil paren-pos
)))
9028 (1+ containing-sexp
)
9030 (setq step-type
'same
9033 ;; Stepped out of a brace block.
9034 (setq step-type
(c-beginning-of-statement-1 containing-sexp
)
9035 on-label
(eq step-type
'label
))
9037 (if (and (eq step-type
'same
)
9038 (/= paren-pos
(point)))
9042 (goto-char paren-pos
)
9043 (setq inexpr
(c-looking-at-inexpr-block
9044 (c-safe-position containing-sexp paren-state
)
9046 (c-add-syntax (if (eq (car inexpr
) 'inlambda
)
9048 'statement-block-intro
)
9050 ((looking-at c-other-decl-block-key
)
9052 (cdr (assoc (match-string 1)
9053 c-other-decl-block-key-in-symbols-alist
))
9054 (max (c-point 'boi paren-pos
) (point))))
9055 (t (c-add-syntax 'defun-block-intro nil
))))
9057 (c-add-syntax 'statement-block-intro nil
)))
9059 (if (= paren-pos boi
)
9060 ;; Always done if the open brace was at boi. The
9061 ;; c-beginning-of-statement-1 call above is necessary
9062 ;; anyway, to decide the type of block-intro to add.
9063 (goto-char paren-pos
)
9064 (setq boi
(c-point 'boi
)))
9067 ;; Fill in the current point as the anchor for all the symbols
9069 (let ((p c-syntactic-context
) q
)
9070 (while (not (eq p syntax-last
))
9071 (setq q
(cdr (car p
))) ; e.g. (nil 28) [from (arglist-cont-nonempty nil 28)]
9079 (defun c-add-class-syntax (symbol
9080 containing-decl-open
9081 containing-decl-start
9084 ;; The inclass and class-close syntactic symbols are added in
9085 ;; several places and some work is needed to fix everything.
9086 ;; Therefore it's collected here.
9088 ;; This function might do hidden buffer changes.
9089 (goto-char containing-decl-open
)
9090 (if (and (eq symbol
'inclass
) (= (point) (c-point 'boi
)))
9092 (c-add-syntax symbol containing-decl-open
)
9093 containing-decl-open
)
9094 (goto-char containing-decl-start
)
9095 ;; Ought to use `c-add-stmt-syntax' instead of backing up to boi
9096 ;; here, but we have to do like this for compatibility.
9097 (back-to-indentation)
9098 (c-add-syntax symbol
(point))
9099 (if (and (c-keyword-member containing-decl-kwd
9100 'c-inexpr-class-kwds
)
9101 (/= containing-decl-start
(c-point 'boi containing-decl-start
)))
9102 (c-add-syntax 'inexpr-class
))
9105 (defun c-guess-continued-construct (indent-point
9107 beg-of-same-or-containing-stmt
9110 ;; This function contains the decision tree reached through both
9111 ;; cases 18 and 10. It's a continued statement or top level
9112 ;; construct of some kind.
9114 ;; This function might do hidden buffer changes.
9116 (let (special-brace-list placeholder
)
9117 (goto-char indent-point
)
9118 (skip-chars-forward " \t")
9121 ;; (CASE A removed.)
9122 ;; CASE B: open braces for class or brace-lists
9123 ((setq special-brace-list
9124 (or (and c-special-brace-lists
9125 (c-looking-at-special-brace-list))
9126 (eq char-after-ip ?
{)))
9129 ;; CASE B.1: class-open
9131 (and (eq (char-after) ?
{)
9132 (c-looking-at-decl-block containing-sexp t
)
9133 (setq beg-of-same-or-containing-stmt
(point))))
9134 (c-add-syntax 'class-open beg-of-same-or-containing-stmt
))
9136 ;; CASE B.2: brace-list-open
9137 ((or (consp special-brace-list
)
9139 (goto-char beg-of-same-or-containing-stmt
)
9140 (c-syntactic-re-search-forward "=\\([^=]\\|$\\)"
9141 indent-point t t t
)))
9142 ;; The most semantically accurate symbol here is
9143 ;; brace-list-open, but we normally report it simply as a
9144 ;; statement-cont. The reason is that one normally adjusts
9145 ;; brace-list-open for brace lists as top-level constructs,
9146 ;; and brace lists inside statements is a completely different
9147 ;; context. C.f. case 5A.3.
9148 (c-beginning-of-statement-1 containing-sexp
)
9149 (c-add-stmt-syntax (if c-auto-newline-analysis
9150 ;; Turn off the dwim above when we're
9151 ;; analyzing the nature of the brace
9152 ;; for the auto newline feature.
9156 containing-sexp paren-state
))
9158 ;; CASE B.3: The body of a function declared inside a normal
9159 ;; block. Can occur e.g. in Pike and when using gcc
9160 ;; extensions, but watch out for macros followed by blocks.
9161 ;; C.f. cases E, 16F and 17G.
9162 ((and (not (c-at-statement-start-p))
9163 (eq (c-beginning-of-statement-1 containing-sexp nil nil t
)
9166 (let ((c-recognize-typeless-decls nil
))
9167 ;; Turn off recognition of constructs that lacks a
9168 ;; type in this case, since that's more likely to be
9169 ;; a macro followed by a block.
9170 (c-forward-decl-or-cast-1 (c-point 'bosws
) nil nil
))))
9171 (c-add-stmt-syntax 'defun-open nil t
9172 containing-sexp paren-state
))
9174 ;; CASE B.4: Continued statement with block open. The most
9175 ;; accurate analysis is perhaps `statement-cont' together with
9176 ;; `block-open' but we play DWIM and use `substatement-open'
9177 ;; instead. The rationale is that this typically is a macro
9178 ;; followed by a block which makes it very similar to a
9179 ;; statement with a substatement block.
9181 (c-add-stmt-syntax 'substatement-open nil nil
9182 containing-sexp paren-state
))
9185 ;; CASE C: iostream insertion or extraction operator
9186 ((and (looking-at "\\(<<\\|>>\\)\\([^=]\\|$\\)")
9188 (goto-char beg-of-same-or-containing-stmt
)
9189 ;; If there is no preceding streamop in the statement
9190 ;; then indent this line as a normal statement-cont.
9191 (when (c-syntactic-re-search-forward
9192 "\\(<<\\|>>\\)\\([^=]\\|$\\)" indent-point
'move t t
)
9193 (c-add-syntax 'stream-op
(c-point 'boi
))
9196 ;; CASE E: In the "K&R region" of a function declared inside a
9197 ;; normal block. C.f. case B.3.
9198 ((and (save-excursion
9199 ;; Check that the next token is a '{'. This works as
9200 ;; long as no language that allows nested function
9201 ;; definitions allows stuff like member init lists, K&R
9202 ;; declarations or throws clauses there.
9204 ;; Note that we do a forward search for something ahead
9205 ;; of the indentation line here. That's not good since
9206 ;; the user might not have typed it yet. Unfortunately
9207 ;; it's exceedingly tricky to recognize a function
9208 ;; prototype in a code block without resorting to this.
9209 (c-forward-syntactic-ws)
9210 (eq (char-after) ?
{))
9211 (not (c-at-statement-start-p))
9212 (eq (c-beginning-of-statement-1 containing-sexp nil nil t
)
9215 (let ((c-recognize-typeless-decls nil
))
9216 ;; Turn off recognition of constructs that lacks a
9217 ;; type in this case, since that's more likely to be
9218 ;; a macro followed by a block.
9219 (c-forward-decl-or-cast-1 (c-point 'bosws
) nil nil
))))
9220 (c-add-stmt-syntax 'func-decl-cont nil t
9221 containing-sexp paren-state
))
9223 ;;CASE F: continued statement and the only preceding items are
9225 ((and (c-major-mode-is 'java-mode
)
9226 (setq placeholder
(point))
9227 (c-beginning-of-statement-1)
9229 (while (and (c-forward-annotation)
9230 (< (point) placeholder
))
9231 (c-forward-syntactic-ws))
9234 (>= (point) placeholder
)
9235 (goto-char placeholder
)))
9236 (c-beginning-of-statement-1 containing-sexp
)
9237 (c-add-syntax 'annotation-var-cont
(point)))
9239 ;; CASE G: a template list continuation?
9240 ;; Mostly a duplication of case 5D.3 to fix templates-19:
9241 ((and (c-major-mode-is 'c
++-mode
)
9243 (goto-char indent-point
)
9244 (c-with-syntax-table c
++-template-syntax-table
9245 (setq placeholder
(c-up-list-backward)))
9247 (eq (char-after placeholder
) ?
<)
9248 (/= (char-before placeholder
) ?
<)
9250 (goto-char (1+ placeholder
))
9251 (not (looking-at c-
<-op-cont-regexp
))))))
9252 (c-with-syntax-table c
++-template-syntax-table
9253 (goto-char placeholder
)
9254 (c-beginning-of-statement-1 containing-sexp t
)
9256 (c-backward-syntactic-ws containing-sexp
)
9257 (eq (char-before) ?
<))
9258 ;; In a nested template arglist.
9260 (goto-char placeholder
)
9261 (c-syntactic-skip-backward "^,;" containing-sexp t
)
9262 (c-forward-syntactic-ws))
9263 (back-to-indentation)))
9264 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
9266 (c-add-syntax 'template-args-cont
(point) placeholder
))
9268 ;; CASE D: continued statement.
9270 (c-beginning-of-statement-1 containing-sexp
)
9271 (c-add-stmt-syntax 'statement-cont nil nil
9272 containing-sexp paren-state
))
9275 ;; The next autoload was added by RMS on 2005/8/9 - don't know why (ACM,
9278 (defun c-guess-basic-syntax ()
9279 "Return the syntactic context of the current line."
9282 (c-save-buffer-state
9283 ((indent-point (point))
9284 (case-fold-search nil
)
9285 ;; A whole ugly bunch of various temporary variables. Have
9286 ;; to declare them here since it's not possible to declare
9287 ;; a variable with only the scope of a cond test and the
9288 ;; following result clauses, and most of this function is a
9289 ;; single gigantic cond. :P
9290 literal char-before-ip before-ws-ip char-after-ip macro-start
9291 in-macro-expr c-syntactic-context placeholder c-in-literal-cache
9292 step-type tmpsymbol keyword injava-inher special-brace-list tmp-pos
9294 ;; The following record some positions for the containing
9295 ;; declaration block if we're directly within one:
9296 ;; `containing-decl-open' is the position of the open
9297 ;; brace. `containing-decl-start' is the start of the
9298 ;; declaration. `containing-decl-kwd' is the keyword
9299 ;; symbol of the keyword that tells what kind of block it
9301 containing-decl-open
9302 containing-decl-start
9304 ;; The open paren of the closest surrounding sexp or nil if
9307 ;; The position after the closest preceding brace sexp
9308 ;; (nested sexps are ignored), or the position after
9309 ;; `containing-sexp' if there is none, or (point-min) if
9310 ;; `containing-sexp' is nil.
9312 ;; The paren state outside `containing-sexp', or at
9313 ;; `indent-point' if `containing-sexp' is nil.
9314 (paren-state (c-parse-state))
9315 ;; There's always at most one syntactic element which got
9316 ;; an anchor pos. It's stored in syntactic-relpos.
9318 (c-stmt-delim-chars c-stmt-delim-chars
))
9320 ;; Check if we're directly inside an enclosing declaration
9322 (when (and (setq containing-sexp
9323 (c-most-enclosing-brace paren-state
))
9325 (goto-char containing-sexp
)
9326 (eq (char-after) ?
{))
9328 (c-looking-at-decl-block
9329 (c-most-enclosing-brace paren-state
9332 (setq containing-decl-open containing-sexp
9333 containing-decl-start
(point)
9334 containing-sexp nil
)
9335 (goto-char placeholder
)
9336 (setq containing-decl-kwd
(and (looking-at c-keywords-regexp
)
9337 (c-keyword-sym (match-string 1)))))
9339 ;; Init some position variables.
9342 (setq containing-sexp
(car paren-state
)
9343 paren-state
(cdr paren-state
))
9344 (if (consp containing-sexp
)
9346 (setq lim
(cdr containing-sexp
))
9347 (if (cdr c-state-cache
)
9348 ;; Ignore balanced paren. The next entry
9349 ;; can't be another one.
9350 (setq containing-sexp
(car (cdr c-state-cache
))
9351 paren-state
(cdr paren-state
))
9352 ;; If there is no surrounding open paren then
9353 ;; put the last balanced pair back on paren-state.
9354 (setq paren-state
(cons containing-sexp paren-state
)
9355 containing-sexp nil
)))
9356 (setq lim
(1+ containing-sexp
))))
9357 (setq lim
(point-min)))
9359 ;; If we're in a parenthesis list then ',' delimits the
9360 ;; "statements" rather than being an operator (with the
9361 ;; exception of the "for" clause). This difference is
9362 ;; typically only noticeable when statements are used in macro
9364 (when (and containing-sexp
9365 (eq (char-after containing-sexp
) ?\
())
9366 (setq c-stmt-delim-chars c-stmt-delim-chars-with-comma
))
9367 ;; cache char before and after indent point, and move point to
9368 ;; the most likely position to perform the majority of tests
9369 (goto-char indent-point
)
9370 (c-backward-syntactic-ws lim
)
9371 (setq before-ws-ip
(point)
9372 char-before-ip
(char-before))
9373 (goto-char indent-point
)
9374 (skip-chars-forward " \t")
9375 (setq char-after-ip
(char-after))
9377 ;; are we in a literal?
9378 (setq literal
(c-in-literal lim
))
9380 ;; now figure out syntactic qualities of the current line
9383 ;; CASE 1: in a string.
9384 ((eq literal
'string
)
9385 (c-add-syntax 'string
(c-point 'bopl
)))
9387 ;; CASE 2: in a C or C++ style comment.
9388 ((and (memq literal
'(c c
++))
9389 ;; This is a kludge for XEmacs where we use
9390 ;; `buffer-syntactic-context', which doesn't correctly
9391 ;; recognize "\*/" to end a block comment.
9392 ;; `parse-partial-sexp' which is used by
9393 ;; `c-literal-limits' will however do that in most
9394 ;; versions, which results in that we get nil from
9395 ;; `c-literal-limits' even when `c-in-literal' claims
9396 ;; we're inside a comment.
9397 (setq placeholder
(c-literal-limits lim
)))
9398 (c-add-syntax literal
(car placeholder
)))
9400 ;; CASE 3: in a cpp preprocessor macro continuation.
9401 ((and (save-excursion
9402 (when (c-beginning-of-macro)
9403 (setq macro-start
(point))))
9404 (/= macro-start
(c-point 'boi
))
9406 (setq tmpsymbol
'cpp-macro-cont
)
9407 (or (not c-syntactic-indentation-in-macros
)
9409 (goto-char macro-start
)
9410 ;; If at the beginning of the body of a #define
9411 ;; directive then analyze as cpp-define-intro
9412 ;; only. Go on with the syntactic analysis
9413 ;; otherwise. in-macro-expr is set if we're in a
9414 ;; cpp expression, i.e. before the #define body
9415 ;; or anywhere in a non-#define directive.
9416 (if (c-forward-to-cpp-define-body)
9417 (let ((indent-boi (c-point 'boi indent-point
)))
9418 (setq in-macro-expr
(> (point) indent-boi
)
9419 tmpsymbol
'cpp-define-intro
)
9420 (= (point) indent-boi
))
9421 (setq in-macro-expr t
)
9423 (c-add-syntax tmpsymbol macro-start
)
9424 (setq macro-start nil
))
9426 ;; CASE 11: an else clause?
9427 ((looking-at "else\\>[^_]")
9428 (c-beginning-of-statement-1 containing-sexp
)
9429 (c-add-stmt-syntax 'else-clause nil t
9430 containing-sexp paren-state
))
9432 ;; CASE 12: while closure of a do/while construct?
9433 ((and (looking-at "while\\>[^_]")
9435 (prog1 (eq (c-beginning-of-statement-1 containing-sexp
)
9437 (setq placeholder
(point)))))
9438 (goto-char placeholder
)
9439 (c-add-stmt-syntax 'do-while-closure nil t
9440 containing-sexp paren-state
))
9442 ;; CASE 13: A catch or finally clause? This case is simpler
9443 ;; than if-else and do-while, because a block is required
9444 ;; after every try, catch and finally.
9446 (and (cond ((c-major-mode-is 'c
++-mode
)
9447 (looking-at "catch\\>[^_]"))
9448 ((c-major-mode-is 'java-mode
)
9449 (looking-at "\\(catch\\|finally\\)\\>[^_]")))
9450 (and (c-safe (c-backward-syntactic-ws)
9453 (eq (char-after) ?
{)
9454 (c-safe (c-backward-syntactic-ws)
9457 (if (eq (char-after) ?\
()
9458 (c-safe (c-backward-sexp) t
)
9460 (looking-at "\\(try\\|catch\\)\\>[^_]")
9461 (setq placeholder
(point))))
9462 (goto-char placeholder
)
9463 (c-add-stmt-syntax 'catch-clause nil t
9464 containing-sexp paren-state
))
9466 ;; CASE 18: A substatement we can recognize by keyword.
9468 (and c-opt-block-stmt-key
9469 (not (eq char-before-ip ?\
;))
9470 (not (c-at-vsemi-p before-ws-ip
))
9471 (not (memq char-after-ip
'(?\
) ?\
] ?
,)))
9472 (or (not (eq char-before-ip ?
}))
9473 (c-looking-at-inexpr-block-backward c-state-cache
))
9476 ;; Ought to cache the result from the
9477 ;; c-beginning-of-statement-1 calls here.
9478 (setq placeholder
(point))
9479 (while (eq (setq step-type
9480 (c-beginning-of-statement-1 lim
))
9482 (if (eq step-type
'previous
)
9483 (goto-char placeholder
)
9484 (setq placeholder
(point))
9485 (if (and (eq step-type
'same
)
9486 (not (looking-at c-opt-block-stmt-key
)))
9487 ;; Step up to the containing statement if we
9488 ;; stayed in the same one.
9492 (c-beginning-of-statement-1 lim
))
9495 (setq placeholder
(point))
9496 ;; There was no containing statement after all.
9497 (goto-char placeholder
)))))
9499 (if (looking-at c-block-stmt-2-key
)
9500 ;; Require a parenthesis after these keywords.
9501 ;; Necessary to catch e.g. synchronized in Java,
9502 ;; which can be used both as statement and
9504 (and (zerop (c-forward-token-2 1 nil
))
9505 (eq (char-after) ?\
())
9506 (looking-at c-opt-block-stmt-key
))))
9508 (if (eq step-type
'up
)
9509 ;; CASE 18A: Simple substatement.
9511 (goto-char placeholder
)
9513 ((eq char-after-ip ?
{)
9514 (c-add-stmt-syntax 'substatement-open nil nil
9515 containing-sexp paren-state
))
9517 (goto-char indent-point
)
9518 (back-to-indentation)
9520 (c-add-stmt-syntax 'substatement-label nil nil
9521 containing-sexp paren-state
))
9523 (c-add-stmt-syntax 'substatement nil nil
9524 containing-sexp paren-state
))))
9526 ;; CASE 18B: Some other substatement. This is shared
9528 (c-guess-continued-construct indent-point
9534 ;; CASE 14: A case or default label
9535 ((looking-at c-label-kwds-regexp
)
9538 (goto-char containing-sexp
)
9539 (setq lim
(c-most-enclosing-brace c-state-cache
9541 (c-backward-to-block-anchor lim
)
9542 (c-add-stmt-syntax 'case-label nil t lim paren-state
))
9543 ;; Got a bogus label at the top level. In lack of better
9544 ;; alternatives, anchor it on (point-min).
9545 (c-add-syntax 'case-label
(point-min))))
9547 ;; CASE 15: any other label
9549 (back-to-indentation)
9550 (and (not (looking-at c-syntactic-ws-start
))
9552 (cond (containing-decl-open
9553 (setq placeholder
(c-add-class-syntax 'inclass
9554 containing-decl-open
9555 containing-decl-start
9558 ;; Append access-label with the same anchor point as
9560 (c-append-syntax 'access-label placeholder
))
9563 (goto-char containing-sexp
)
9564 (setq lim
(c-most-enclosing-brace c-state-cache
9568 (if (and (eq (c-beginning-of-statement-1 lim
) 'up
)
9569 (looking-at "switch\\>[^_]"))
9570 ;; If the surrounding statement is a switch then
9571 ;; let's analyze all labels as switch labels, so
9572 ;; that they get lined up consistently.
9575 (c-backward-to-block-anchor lim
)
9576 (c-add-stmt-syntax tmpsymbol nil t lim paren-state
))
9579 ;; A label on the top level. Treat it as a class
9580 ;; context. (point-min) is the closest we get to the
9581 ;; class open brace.
9582 (c-add-syntax 'access-label
(point-min)))))
9584 ;; CASE 4: In-expression statement. C.f. cases 7B, 16A and
9586 ((setq placeholder
(c-looking-at-inexpr-block
9587 (c-safe-position containing-sexp paren-state
)
9589 ;; Have to turn on the heuristics after
9590 ;; the point even though it doesn't work
9591 ;; very well. C.f. test case class-16.pike.
9593 (setq tmpsymbol
(assq (car placeholder
)
9594 '((inexpr-class . class-open
)
9595 (inexpr-statement . block-open
))))
9597 ;; It's a statement block or an anonymous class.
9598 (setq tmpsymbol
(cdr tmpsymbol
))
9599 ;; It's a Pike lambda. Check whether we are between the
9600 ;; lambda keyword and the argument list or at the defun
9602 (setq tmpsymbol
(if (eq char-after-ip ?
{)
9604 'lambda-intro-cont
)))
9605 (goto-char (cdr placeholder
))
9606 (back-to-indentation)
9607 (c-add-stmt-syntax tmpsymbol nil t
9608 (c-most-enclosing-brace c-state-cache
(point))
9610 (unless (eq (point) (cdr placeholder
))
9611 (c-add-syntax (car placeholder
))))
9613 ;; CASE 5: Line is inside a declaration level block or at top level.
9614 ((or containing-decl-open
(null containing-sexp
))
9617 ;; CASE 5A: we are looking at a defun, brace list, class,
9618 ;; or inline-inclass method opening brace
9619 ((setq special-brace-list
9620 (or (and c-special-brace-lists
9621 (c-looking-at-special-brace-list))
9622 (eq char-after-ip ?
{)))
9625 ;; CASE 5A.1: Non-class declaration block open.
9628 (and (eq char-after-ip ?
{)
9629 (setq tmp
(c-looking-at-decl-block containing-sexp t
))
9631 (setq placeholder
(point))
9633 (looking-at c-symbol-key
))
9635 (c-keyword-sym (setq keyword
(match-string 0)))
9636 'c-other-block-decl-kwds
))))
9637 (goto-char placeholder
)
9639 (if (string-equal keyword
"extern")
9640 ;; Special case for extern-lang-open.
9642 (intern (concat keyword
"-open")))
9643 nil t containing-sexp paren-state
))
9645 ;; CASE 5A.2: we are looking at a class opening brace
9647 (goto-char indent-point
)
9648 (skip-chars-forward " \t")
9649 (and (eq (char-after) ?
{)
9650 (c-looking-at-decl-block containing-sexp t
)
9651 (setq placeholder
(point))))
9652 (c-add-syntax 'class-open placeholder
))
9654 ;; CASE 5A.3: brace list open
9656 (c-beginning-of-decl-1 lim
)
9657 (while (looking-at c-specifier-key
)
9658 (goto-char (match-end 1))
9659 (c-forward-syntactic-ws indent-point
))
9660 (setq placeholder
(c-point 'boi
))
9661 (or (consp special-brace-list
)
9662 (and (or (save-excursion
9663 (goto-char indent-point
)
9664 (setq tmpsymbol nil
)
9665 (while (and (> (point) placeholder
)
9666 (zerop (c-backward-token-2 1 t
))
9667 (not (looking-at "=\\([^=]\\|$\\)")))
9668 (and c-opt-inexpr-brace-list-key
9670 (looking-at c-opt-inexpr-brace-list-key
)
9671 (setq tmpsymbol
'topmost-intro-cont
)))
9672 (looking-at "=\\([^=]\\|$\\)"))
9673 (looking-at c-brace-list-key
))
9675 (while (and (< (point) indent-point
)
9676 (zerop (c-forward-token-2 1 t
))
9677 (not (memq (char-after) '(?\
; ?\()))))
9678 (not (memq (char-after) '(?\
; ?\()))
9680 (if (and (not c-auto-newline-analysis
)
9681 (c-major-mode-is 'java-mode
)
9682 (eq tmpsymbol
'topmost-intro-cont
))
9683 ;; We're in Java and have found that the open brace
9684 ;; belongs to a "new Foo[]" initialization list,
9685 ;; which means the brace list is part of an
9686 ;; expression and not a top level definition. We
9687 ;; therefore treat it as any topmost continuation
9688 ;; even though the semantically correct symbol still
9689 ;; is brace-list-open, on the same grounds as in
9692 (c-beginning-of-statement-1 lim
)
9693 (c-add-syntax 'topmost-intro-cont
(c-point 'boi
)))
9694 (c-add-syntax 'brace-list-open placeholder
)))
9696 ;; CASE 5A.4: inline defun open
9697 ((and containing-decl-open
9698 (not (c-keyword-member containing-decl-kwd
9699 'c-other-block-decl-kwds
)))
9700 (c-add-syntax 'inline-open
)
9701 (c-add-class-syntax 'inclass
9702 containing-decl-open
9703 containing-decl-start
9707 ;; CASE 5A.5: ordinary defun open
9710 (c-beginning-of-decl-1 lim
)
9711 (while (looking-at c-specifier-key
)
9712 (goto-char (match-end 1))
9713 (c-forward-syntactic-ws indent-point
))
9714 (c-add-syntax 'defun-open
(c-point 'boi
))
9715 ;; Bogus to use bol here, but it's the legacy. (Resolved,
9719 ;; CASE 5R: Member init list. (Used to be part of CASE 5B.1)
9720 ;; Note there is no limit on the backward search here, since member
9721 ;; init lists can, in practice, be very large.
9723 (when (setq placeholder
(c-back-over-member-initializers))
9724 (setq tmp-pos
(point))))
9725 (if (= (c-point 'bosws
) (1+ tmp-pos
))
9727 ;; There is no preceding member init clause.
9728 ;; Indent relative to the beginning of indentation
9729 ;; for the topmost-intro line that contains the
9730 ;; prototype's open paren.
9731 (goto-char placeholder
)
9732 (c-add-syntax 'member-init-intro
(c-point 'boi
)))
9733 ;; Indent relative to the first member init clause.
9734 (goto-char (1+ tmp-pos
))
9735 (c-forward-syntactic-ws)
9736 (c-add-syntax 'member-init-cont
(point))))
9738 ;; CASE 5B: After a function header but before the body (or
9739 ;; the ending semicolon if there's no body).
9741 (when (setq placeholder
(c-just-after-func-arglist-p
9742 (max lim
(c-determine-limit 500))))
9743 (setq tmp-pos
(point))))
9746 ;; CASE 5B.1: Member init list.
9747 ((eq (char-after tmp-pos
) ?
:)
9748 ;; There is no preceding member init clause.
9749 ;; Indent relative to the beginning of indentation
9750 ;; for the topmost-intro line that contains the
9751 ;; prototype's open paren.
9752 (goto-char placeholder
)
9753 (c-add-syntax 'member-init-intro
(c-point 'boi
)))
9755 ;; CASE 5B.2: K&R arg decl intro
9756 ((and c-recognize-knr-p
9757 (c-in-knr-argdecl lim
))
9758 (c-beginning-of-statement-1 lim
)
9759 (c-add-syntax 'knr-argdecl-intro
(c-point 'boi
))
9760 (if containing-decl-open
9761 (c-add-class-syntax 'inclass
9762 containing-decl-open
9763 containing-decl-start
9767 ;; CASE 5B.4: Nether region after a C++ or Java func
9768 ;; decl, which could include a `throws' declaration.
9770 (c-beginning-of-statement-1 lim
)
9771 (c-add-syntax 'func-decl-cont
(c-point 'boi
))
9774 ;; CASE 5C: inheritance line. could be first inheritance
9775 ;; line, or continuation of a multiple inheritance
9776 ((or (and (c-major-mode-is 'c
++-mode
)
9778 (when (eq char-after-ip ?
,)
9779 (skip-chars-forward " \t")
9781 (looking-at c-opt-postfix-decl-spec-key
)))
9782 (and (or (eq char-before-ip ?
:)
9783 ;; watch out for scope operator
9785 (and (eq char-after-ip ?
:)
9786 (c-safe (forward-char 1) t
)
9787 (not (eq (char-after) ?
:))
9790 (c-backward-syntactic-ws lim
)
9791 (if (eq char-before-ip ?
:)
9794 (c-backward-syntactic-ws lim
)))
9795 (back-to-indentation)
9796 (looking-at c-class-key
)))
9798 (and (c-major-mode-is 'java-mode
)
9799 (let ((fence (save-excursion
9800 (c-beginning-of-statement-1 lim
)
9805 (cond ((looking-at c-opt-postfix-decl-spec-key
)
9806 (setq injava-inher
(cons cont
(point))
9808 ((or (not (c-safe (c-forward-sexp -
1) t
))
9814 (not (c-crosses-statement-barrier-p (cdr injava-inher
)
9819 ;; CASE 5C.1: non-hanging colon on an inher intro
9820 ((eq char-after-ip ?
:)
9821 (c-beginning-of-statement-1 lim
)
9822 (c-add-syntax 'inher-intro
(c-point 'boi
))
9823 ;; don't add inclass symbol since relative point already
9824 ;; contains any class offset
9827 ;; CASE 5C.2: hanging colon on an inher intro
9828 ((eq char-before-ip ?
:)
9829 (c-beginning-of-statement-1 lim
)
9830 (c-add-syntax 'inher-intro
(c-point 'boi
))
9831 (if containing-decl-open
9832 (c-add-class-syntax 'inclass
9833 containing-decl-open
9834 containing-decl-start
9838 ;; CASE 5C.3: in a Java implements/extends
9840 (let ((where (cdr injava-inher
))
9841 (cont (car injava-inher
)))
9843 (cond ((looking-at "throws\\>[^_]")
9844 (c-add-syntax 'func-decl-cont
9845 (progn (c-beginning-of-statement-1 lim
)
9847 (cont (c-add-syntax 'inher-cont where
))
9848 (t (c-add-syntax 'inher-intro
9849 (progn (goto-char (cdr injava-inher
))
9850 (c-beginning-of-statement-1 lim
)
9854 ;; CASE 5C.4: a continued inheritance line
9856 (c-beginning-of-inheritance-list lim
)
9857 (c-add-syntax 'inher-cont
(point))
9858 ;; don't add inclass symbol since relative point already
9859 ;; contains any class offset
9862 ;; CASE 5P: AWK pattern or function or continuation
9864 ((c-major-mode-is 'awk-mode
)
9865 (setq placeholder
(point))
9867 (if (and (eq (c-beginning-of-statement-1) 'same
)
9868 (/= (point) placeholder
))
9872 containing-sexp paren-state
))
9874 ;; CASE 5D: this could be a top-level initialization, a
9875 ;; member init list continuation, or a template argument
9876 ;; list continuation.
9878 ;; Note: We use the fact that lim is always after any
9879 ;; preceding brace sexp.
9880 (if c-recognize-
<>-arglists
9883 (c-syntactic-skip-backward "^;,=<>" lim t
)
9886 (when c-overloadable-operators-regexp
9887 (when (setq placeholder
(c-after-special-operator-id lim
))
9888 (goto-char placeholder
)
9891 ((eq (char-before) ?
>)
9892 (or (c-backward-<>-arglist nil lim
)
9895 ((eq (char-before) ?
<)
9898 (c-forward-<>-arglist nil
))
9899 (progn (forward-char)
9903 ;; NB: No c-after-special-operator-id stuff in this
9904 ;; clause - we assume only C++ needs it.
9905 (c-syntactic-skip-backward "^;,=" lim t
))
9906 (memq (char-before) '(?
, ?
= ?
<)))
9909 ;; CASE 5D.3: perhaps a template list continuation?
9910 ((and (c-major-mode-is 'c
++-mode
)
9913 (c-with-syntax-table c
++-template-syntax-table
9914 (goto-char indent-point
)
9915 (setq placeholder
(c-up-list-backward))
9917 (eq (char-after placeholder
) ?
<))))))
9918 (c-with-syntax-table c
++-template-syntax-table
9919 (goto-char placeholder
)
9920 (c-beginning-of-statement-1 lim t
)
9922 (c-backward-syntactic-ws lim
)
9923 (eq (char-before) ?
<))
9924 ;; In a nested template arglist.
9926 (goto-char placeholder
)
9927 (c-syntactic-skip-backward "^,;" lim t
)
9928 (c-forward-syntactic-ws))
9929 (back-to-indentation)))
9930 ;; FIXME: Should use c-add-stmt-syntax, but it's not yet
9932 (c-add-syntax 'template-args-cont
(point) placeholder
))
9934 ;; CASE 5D.4: perhaps a multiple inheritance line?
9935 ((and (c-major-mode-is 'c
++-mode
)
9937 (c-beginning-of-statement-1 lim
)
9938 (setq placeholder
(point))
9939 (if (looking-at "static\\>[^_]")
9940 (c-forward-token-2 1 nil indent-point
))
9941 (and (looking-at c-class-key
)
9942 (zerop (c-forward-token-2 2 nil indent-point
))
9943 (if (eq (char-after) ?
<)
9944 (c-with-syntax-table c
++-template-syntax-table
9945 (zerop (c-forward-token-2 1 t indent-point
)))
9947 (eq (char-after) ?
:))))
9948 (goto-char placeholder
)
9949 (c-add-syntax 'inher-cont
(c-point 'boi
)))
9951 ;; CASE 5D.5: Continuation of the "expression part" of a
9952 ;; top level construct. Or, perhaps, an unrecognized construct.
9954 (while (and (setq placeholder
(point))
9955 (eq (car (c-beginning-of-decl-1 containing-sexp
)) ; Can't use `lim' here.
9958 (c-backward-syntactic-ws)
9959 (eq (char-before) ?
}))
9960 (< (point) placeholder
)))
9963 ((eq (point) placeholder
) 'statement
) ; unrecognized construct
9964 ;; A preceding comma at the top level means that a
9965 ;; new variable declaration starts here. Use
9966 ;; topmost-intro-cont for it, for consistency with
9967 ;; the first variable declaration. C.f. case 5N.
9968 ((eq char-before-ip ?
,) 'topmost-intro-cont
)
9969 (t 'statement-cont
))
9970 nil nil containing-sexp paren-state
))
9973 ;; CASE 5F: Close of a non-class declaration level block.
9974 ((and (eq char-after-ip ?
})
9975 (c-keyword-member containing-decl-kwd
9976 'c-other-block-decl-kwds
))
9977 ;; This is inconsistent: Should use `containing-decl-open'
9978 ;; here if it's at boi, like in case 5J.
9979 (goto-char containing-decl-start
)
9981 (if (string-equal (symbol-name containing-decl-kwd
) "extern")
9982 ;; Special case for compatibility with the
9983 ;; extern-lang syntactic symbols.
9985 (intern (concat (symbol-name containing-decl-kwd
)
9988 (c-most-enclosing-brace paren-state
(point))
9991 ;; CASE 5G: we are looking at the brace which closes the
9992 ;; enclosing nested class decl
9993 ((and containing-sexp
9994 (eq char-after-ip ?
})
9995 (eq containing-decl-open containing-sexp
))
9996 (c-add-class-syntax 'class-close
9997 containing-decl-open
9998 containing-decl-start
10002 ;; CASE 5H: we could be looking at subsequent knr-argdecls
10003 ((and c-recognize-knr-p
10004 (not containing-sexp
) ; can't be knr inside braces.
10005 (not (eq char-before-ip ?
}))
10007 (setq placeholder
(cdr (c-beginning-of-decl-1 lim
)))
10009 ;; Do an extra check to avoid tripping up on
10010 ;; statements that occur in invalid contexts
10011 ;; (e.g. in macro bodies where we don't really
10012 ;; know the context of what we're looking at).
10013 (not (and c-opt-block-stmt-key
10014 (looking-at c-opt-block-stmt-key
)))))
10015 (< placeholder indent-point
))
10016 (goto-char placeholder
)
10017 (c-add-syntax 'knr-argdecl
(point)))
10019 ;; CASE 5I: ObjC method definition.
10020 ((and c-opt-method-key
10021 (looking-at c-opt-method-key
))
10022 (c-beginning-of-statement-1 nil t
)
10023 (if (= (point) indent-point
)
10024 ;; Handle the case when it's the first (non-comment)
10025 ;; thing in the buffer. Can't look for a 'same return
10026 ;; value from cbos1 since ObjC directives currently
10027 ;; aren't recognized fully, so that we get 'same
10028 ;; instead of 'previous if it moved over a preceding
10030 (goto-char (point-min)))
10031 (c-add-syntax 'objc-method-intro
(c-point 'boi
)))
10033 ;; CASE 5N: At a variable declaration that follows a class
10034 ;; definition or some other block declaration that doesn't
10035 ;; end at the closing '}'. C.f. case 5D.5.
10037 (c-backward-syntactic-ws lim
)
10038 (and (eq (char-before) ?
})
10040 (let ((start (point)))
10041 (if (and c-state-cache
10042 (consp (car c-state-cache
))
10043 (eq (cdar c-state-cache
) (point)))
10044 ;; Speed up the backward search a bit.
10045 (goto-char (caar c-state-cache
)))
10046 (c-beginning-of-decl-1 containing-sexp
) ; Can't use `lim' here.
10047 (setq placeholder
(point))
10048 (if (= start
(point))
10049 ;; The '}' is unbalanced.
10052 (>= (point) indent-point
))))))
10053 (goto-char placeholder
)
10054 (c-add-stmt-syntax 'topmost-intro-cont nil nil
10055 containing-sexp paren-state
))
10057 ;; NOTE: The point is at the end of the previous token here.
10059 ;; CASE 5J: we are at the topmost level, make
10060 ;; sure we skip back past any access specifiers
10062 ;; A macro continuation line is never at top level.
10063 (not (and macro-start
10064 (> indent-point macro-start
)))
10066 (setq placeholder
(point))
10067 (or (memq char-before-ip
'(?\
; ?{ ?} nil))
10068 (c-at-vsemi-p before-ws-ip
)
10069 (when (and (eq char-before-ip ?
:)
10070 (eq (c-beginning-of-statement-1 lim
)
10072 (c-backward-syntactic-ws lim
)
10073 (setq placeholder
(point)))
10074 (and (c-major-mode-is 'objc-mode
)
10075 (catch 'not-in-directive
10076 (c-beginning-of-statement-1 lim
)
10077 (setq placeholder
(point))
10078 (while (and (c-forward-objc-directive)
10079 (< (point) indent-point
))
10080 (c-forward-syntactic-ws)
10081 (if (>= (point) indent-point
)
10082 (throw 'not-in-directive t
))
10083 (setq placeholder
(point)))
10085 ;; For historic reasons we anchor at bol of the last
10086 ;; line of the previous declaration. That's clearly
10087 ;; highly bogus and useless, and it makes our lives hard
10088 ;; to remain compatible. :P
10089 (goto-char placeholder
)
10090 (c-add-syntax 'topmost-intro
(c-point 'bol
))
10091 (if containing-decl-open
10092 (if (c-keyword-member containing-decl-kwd
10093 'c-other-block-decl-kwds
)
10095 (goto-char (c-brace-anchor-point containing-decl-open
))
10097 (if (string-equal (symbol-name containing-decl-kwd
)
10099 ;; Special case for compatibility with the
10100 ;; extern-lang syntactic symbols.
10102 (intern (concat "in"
10103 (symbol-name containing-decl-kwd
))))
10105 (c-most-enclosing-brace paren-state
(point))
10107 (c-add-class-syntax 'inclass
10108 containing-decl-open
10109 containing-decl-start
10110 containing-decl-kwd
10112 (when (and c-syntactic-indentation-in-macros
10114 (/= macro-start
(c-point 'boi indent-point
)))
10115 (c-add-syntax 'cpp-define-intro
)
10116 (setq macro-start nil
)))
10118 ;; CASE 5K: we are at an ObjC method definition
10119 ;; continuation line.
10120 ((and c-opt-method-key
10122 (c-beginning-of-statement-1 lim
)
10123 (beginning-of-line)
10124 (when (looking-at c-opt-method-key
)
10125 (setq placeholder
(point)))))
10126 (c-add-syntax 'objc-method-args-cont placeholder
))
10128 ;; CASE 5L: we are at the first argument of a template
10129 ;; arglist that begins on the previous line.
10130 ((and c-recognize-
<>-arglists
10131 (eq (char-before) ?
<)
10132 (not (and c-overloadable-operators-regexp
10133 (c-after-special-operator-id lim
))))
10134 (c-beginning-of-statement-1 (c-safe-position (point) paren-state
))
10135 (c-add-syntax 'template-args-cont
(c-point 'boi
)))
10137 ;; CASE 5Q: we are at a statement within a macro.
10139 (c-beginning-of-statement-1 containing-sexp
)
10140 (c-add-stmt-syntax 'statement nil t containing-sexp paren-state
))
10142 ;;CASE 5N: We are at a topmost continuation line and the only
10143 ;;preceding items are annotations.
10144 ((and (c-major-mode-is 'java-mode
)
10145 (setq placeholder
(point))
10146 (c-beginning-of-statement-1)
10148 (while (and (c-forward-annotation))
10149 (c-forward-syntactic-ws))
10152 (>= (point) placeholder
)
10153 (goto-char placeholder
)))
10154 (c-add-syntax 'annotation-top-cont
(c-point 'boi
)))
10156 ;; CASE 5M: we are at a topmost continuation line
10158 (c-beginning-of-statement-1 (c-safe-position (point) paren-state
))
10159 (when (c-major-mode-is 'objc-mode
)
10160 (setq placeholder
(point))
10161 (while (and (c-forward-objc-directive)
10162 (< (point) indent-point
))
10163 (c-forward-syntactic-ws)
10164 (setq placeholder
(point)))
10165 (goto-char placeholder
))
10166 (c-add-syntax 'topmost-intro-cont
(c-point 'boi
)))
10170 ;; (CASE 6 has been removed.)
10172 ;; CASE 7: line is an expression, not a statement. Most
10173 ;; likely we are either in a function prototype or a function
10174 ;; call argument list
10175 ((not (or (and c-special-brace-lists
10177 (goto-char containing-sexp
)
10178 (c-looking-at-special-brace-list)))
10179 (eq (char-after containing-sexp
) ?
{)))
10182 ;; CASE 7A: we are looking at the arglist closing paren.
10184 ((memq char-after-ip
'(?\
) ?\
]))
10185 (goto-char containing-sexp
)
10186 (setq placeholder
(c-point 'boi
))
10187 (if (and (c-safe (backward-up-list 1) t
)
10188 (>= (point) placeholder
))
10191 (skip-chars-forward " \t"))
10192 (goto-char placeholder
))
10193 (c-add-stmt-syntax 'arglist-close
(list containing-sexp
) t
10194 (c-most-enclosing-brace paren-state
(point))
10197 ;; CASE 7B: Looking at the opening brace of an
10198 ;; in-expression block or brace list. C.f. cases 4, 16A
10200 ((and (eq char-after-ip ?
{)
10202 (setq placeholder
(c-inside-bracelist-p (point)
10205 (setq tmpsymbol
'(brace-list-open . inexpr-class
))
10206 (setq tmpsymbol
'(block-open . inexpr-statement
)
10208 (cdr-safe (c-looking-at-inexpr-block
10209 (c-safe-position containing-sexp
10212 ;; placeholder is nil if it's a block directly in
10213 ;; a function arglist. That makes us skip out of
10216 (goto-char placeholder
)
10217 (back-to-indentation)
10218 (c-add-stmt-syntax (car tmpsymbol
) nil t
10219 (c-most-enclosing-brace paren-state
(point))
10221 (if (/= (point) placeholder
)
10222 (c-add-syntax (cdr tmpsymbol
))))
10224 ;; CASE 7C: we are looking at the first argument in an empty
10225 ;; argument list. Use arglist-close if we're actually
10226 ;; looking at a close paren or bracket.
10227 ((memq char-before-ip
'(?\
( ?\
[))
10228 (goto-char containing-sexp
)
10229 (setq placeholder
(c-point 'boi
))
10230 (if (and (c-safe (backward-up-list 1) t
)
10231 (>= (point) placeholder
))
10234 (skip-chars-forward " \t"))
10235 (goto-char placeholder
))
10236 (c-add-stmt-syntax 'arglist-intro
(list containing-sexp
) t
10237 (c-most-enclosing-brace paren-state
(point))
10240 ;; CASE 7D: we are inside a conditional test clause. treat
10241 ;; these things as statements
10243 (goto-char containing-sexp
)
10244 (and (c-safe (c-forward-sexp -
1) t
)
10245 (looking-at "\\<for\\>[^_]")))
10246 (goto-char (1+ containing-sexp
))
10247 (c-forward-syntactic-ws indent-point
)
10248 (if (eq char-before-ip ?\
;)
10249 (c-add-syntax 'statement
(point))
10250 (c-add-syntax 'statement-cont
(point))
10253 ;; CASE 7E: maybe a continued ObjC method call. This is the
10254 ;; case when we are inside a [] bracketed exp, and what
10255 ;; precede the opening bracket is not an identifier.
10256 ((and c-opt-method-key
10257 (eq (char-after containing-sexp
) ?\
[)
10259 (goto-char (1- containing-sexp
))
10260 (c-backward-syntactic-ws (c-point 'bod
))
10261 (if (not (looking-at c-symbol-key
))
10262 (c-add-syntax 'objc-method-call-cont containing-sexp
))
10265 ;; CASE 7F: we are looking at an arglist continuation line,
10266 ;; but the preceding argument is on the same line as the
10267 ;; opening paren. This case includes multi-line
10268 ;; mathematical paren groupings, but we could be on a
10269 ;; for-list continuation line. C.f. case 7A.
10271 (goto-char (1+ containing-sexp
))
10273 (c-forward-syntactic-ws)
10276 (goto-char containing-sexp
) ; paren opening the arglist
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-cont-nonempty
(list containing-sexp
) t
10285 (c-most-enclosing-brace c-state-cache
(point))
10288 ;; CASE 7G: we are looking at just a normal arglist
10289 ;; continuation line
10290 (t (c-forward-syntactic-ws indent-point
)
10291 (c-add-syntax 'arglist-cont
(c-point 'boi
)))
10294 ;; CASE 8: func-local multi-inheritance line
10295 ((and (c-major-mode-is 'c
++-mode
)
10297 (goto-char indent-point
)
10298 (skip-chars-forward " \t")
10299 (looking-at c-opt-postfix-decl-spec-key
)))
10300 (goto-char indent-point
)
10301 (skip-chars-forward " \t")
10304 ;; CASE 8A: non-hanging colon on an inher intro
10305 ((eq char-after-ip ?
:)
10306 (c-backward-syntactic-ws lim
)
10307 (c-add-syntax 'inher-intro
(c-point 'boi
)))
10309 ;; CASE 8B: hanging colon on an inher intro
10310 ((eq char-before-ip ?
:)
10311 (c-add-syntax 'inher-intro
(c-point 'boi
)))
10313 ;; CASE 8C: a continued inheritance line
10315 (c-beginning-of-inheritance-list lim
)
10316 (c-add-syntax 'inher-cont
(point))
10319 ;; CASE 9: we are inside a brace-list
10320 ((and (not (c-major-mode-is 'awk-mode
)) ; Maybe this isn't needed (ACM, 2002/3/29)
10321 (setq special-brace-list
10322 (or (and c-special-brace-lists
;;;; ALWAYS NIL FOR AWK!!
10324 (goto-char containing-sexp
)
10325 (c-looking-at-special-brace-list)))
10326 (c-inside-bracelist-p containing-sexp paren-state
))))
10329 ;; CASE 9A: In the middle of a special brace list opener.
10330 ((and (consp special-brace-list
)
10332 (goto-char containing-sexp
)
10333 (eq (char-after) ?\
())
10334 (eq char-after-ip
(car (cdr special-brace-list
))))
10335 (goto-char (car (car special-brace-list
)))
10336 (skip-chars-backward " \t")
10338 (assoc 'statement-cont
10339 (setq placeholder
(c-guess-basic-syntax))))
10340 (setq c-syntactic-context placeholder
)
10341 (c-beginning-of-statement-1
10342 (c-safe-position (1- containing-sexp
) paren-state
))
10343 (c-forward-token-2 0)
10344 (while (looking-at c-specifier-key
)
10345 (goto-char (match-end 1))
10346 (c-forward-syntactic-ws))
10347 (c-add-syntax 'brace-list-open
(c-point 'boi
))))
10349 ;; CASE 9B: brace-list-close brace
10350 ((if (consp special-brace-list
)
10351 ;; Check special brace list closer.
10353 (goto-char (car (car special-brace-list
)))
10355 (goto-char indent-point
)
10356 (back-to-indentation)
10358 ;; We were between the special close char and the `)'.
10359 (and (eq (char-after) ?\
))
10360 (eq (1+ (point)) (cdr (car special-brace-list
))))
10361 ;; We were before the special close char.
10362 (and (eq (char-after) (cdr (cdr special-brace-list
)))
10363 (zerop (c-forward-token-2))
10364 (eq (1+ (point)) (cdr (car special-brace-list
)))))))
10365 ;; Normal brace list check.
10366 (and (eq char-after-ip ?
})
10367 (c-safe (goto-char (c-up-list-backward (point))) t
)
10368 (= (point) containing-sexp
)))
10369 (if (eq (point) (c-point 'boi
))
10370 (c-add-syntax 'brace-list-close
(point))
10371 (setq lim
(c-most-enclosing-brace c-state-cache
(point)))
10372 (c-beginning-of-statement-1 lim
)
10373 (c-add-stmt-syntax 'brace-list-close nil t lim paren-state
)))
10376 ;; Prepare for the rest of the cases below by going to the
10377 ;; token following the opening brace
10378 (if (consp special-brace-list
)
10380 (goto-char (car (car special-brace-list
)))
10381 (c-forward-token-2 1 nil indent-point
))
10382 (goto-char containing-sexp
))
10384 (let ((start (point)))
10385 (c-forward-syntactic-ws indent-point
)
10386 (goto-char (max start
(c-point 'bol
))))
10387 (c-skip-ws-forward indent-point
)
10390 ;; CASE 9C: we're looking at the first line in a brace-list
10391 ((= (point) indent-point
)
10392 (if (consp special-brace-list
)
10393 (goto-char (car (car special-brace-list
)))
10394 (goto-char containing-sexp
))
10395 (if (eq (point) (c-point 'boi
))
10396 (c-add-syntax 'brace-list-intro
(point))
10397 (setq lim
(c-most-enclosing-brace c-state-cache
(point)))
10398 (c-beginning-of-statement-1 lim
)
10399 (c-add-stmt-syntax 'brace-list-intro nil t lim paren-state
)))
10401 ;; CASE 9D: this is just a later brace-list-entry or
10402 ;; brace-entry-open
10403 (t (if (or (eq char-after-ip ?
{)
10404 (and c-special-brace-lists
10406 (goto-char indent-point
)
10407 (c-forward-syntactic-ws (c-point 'eol
))
10408 (c-looking-at-special-brace-list (point)))))
10409 (c-add-syntax 'brace-entry-open
(point))
10410 (c-add-syntax 'brace-list-entry
(point))
10414 ;; CASE 10: A continued statement or top level construct.
10415 ((and (not (memq char-before-ip
'(?\
; ?:)))
10416 (not (c-at-vsemi-p before-ws-ip
))
10417 (or (not (eq char-before-ip ?
}))
10418 (c-looking-at-inexpr-block-backward c-state-cache
))
10421 (c-beginning-of-statement-1 containing-sexp
)
10422 (setq placeholder
(point))))
10423 (/= placeholder containing-sexp
))
10424 ;; This is shared with case 18.
10425 (c-guess-continued-construct indent-point
10431 ;; CASE 16: block close brace, possibly closing the defun or
10433 ((eq char-after-ip ?
})
10434 ;; From here on we have the next containing sexp in lim.
10435 (setq lim
(c-most-enclosing-brace paren-state
))
10436 (goto-char containing-sexp
)
10439 ;; CASE 16E: Closing a statement block? This catches
10440 ;; cases where it's preceded by a statement keyword,
10441 ;; which works even when used in an "invalid" context,
10442 ;; e.g. a macro argument.
10443 ((c-after-conditional)
10444 (c-backward-to-block-anchor lim
)
10445 (c-add-stmt-syntax 'block-close nil t lim paren-state
))
10447 ;; CASE 16A: closing a lambda defun or an in-expression
10448 ;; block? C.f. cases 4, 7B and 17E.
10449 ((setq placeholder
(c-looking-at-inexpr-block
10450 (c-safe-position containing-sexp paren-state
)
10452 (setq tmpsymbol
(if (eq (car placeholder
) 'inlambda
)
10455 (goto-char containing-sexp
)
10456 (back-to-indentation)
10457 (if (= containing-sexp
(point))
10458 (c-add-syntax tmpsymbol
(point))
10459 (goto-char (cdr placeholder
))
10460 (back-to-indentation)
10461 (c-add-stmt-syntax tmpsymbol nil t
10462 (c-most-enclosing-brace paren-state
(point))
10464 (if (/= (point) (cdr placeholder
))
10465 (c-add-syntax (car placeholder
)))))
10467 ;; CASE 16B: does this close an inline or a function in
10468 ;; a non-class declaration level block?
10473 (c-looking-at-decl-block
10474 (c-most-enclosing-brace paren-state lim
)
10476 (setq placeholder
(point))))
10477 (c-backward-to-decl-anchor lim
)
10478 (back-to-indentation)
10479 (if (save-excursion
10480 (goto-char placeholder
)
10481 (looking-at c-other-decl-block-key
))
10482 (c-add-syntax 'defun-close
(point))
10483 (c-add-syntax 'inline-close
(point))))
10485 ;; CASE 16F: Can be a defun-close of a function declared
10486 ;; in a statement block, e.g. in Pike or when using gcc
10487 ;; extensions, but watch out for macros followed by
10488 ;; blocks. Let it through to be handled below.
10489 ;; C.f. cases B.3 and 17G.
10491 (and (not (c-at-statement-start-p))
10492 (eq (c-beginning-of-statement-1 lim nil nil t
) 'same
)
10493 (setq placeholder
(point))
10494 (let ((c-recognize-typeless-decls nil
))
10495 ;; Turn off recognition of constructs that
10496 ;; lacks a type in this case, since that's more
10497 ;; likely to be a macro followed by a block.
10498 (c-forward-decl-or-cast-1 (c-point 'bosws
) nil nil
))))
10499 (back-to-indentation)
10500 (if (/= (point) containing-sexp
)
10501 (goto-char placeholder
))
10502 (c-add-stmt-syntax 'defun-close nil t lim paren-state
))
10504 ;; CASE 16C: If there is an enclosing brace then this is
10505 ;; a block close since defun closes inside declaration
10506 ;; level blocks have been handled above.
10508 ;; If the block is preceded by a case/switch label on
10509 ;; the same line, we anchor at the first preceding label
10510 ;; at boi. The default handling in c-add-stmt-syntax
10511 ;; really fixes it better, but we do like this to keep
10512 ;; the indentation compatible with version 5.28 and
10513 ;; earlier. C.f. case 17H.
10514 (while (and (/= (setq placeholder
(point)) (c-point 'boi
))
10515 (eq (c-beginning-of-statement-1 lim
) 'label
)))
10516 (goto-char placeholder
)
10517 (if (looking-at c-label-kwds-regexp
)
10518 (c-add-syntax 'block-close
(point))
10519 (goto-char containing-sexp
)
10520 ;; c-backward-to-block-anchor not necessary here; those
10521 ;; situations are handled in case 16E above.
10522 (c-add-stmt-syntax 'block-close nil t lim paren-state
)))
10524 ;; CASE 16D: Only top level defun close left.
10526 (goto-char containing-sexp
)
10527 (c-backward-to-decl-anchor lim
)
10528 (c-add-stmt-syntax 'defun-close nil nil
10529 (c-most-enclosing-brace paren-state
)
10533 ;; CASE 19: line is an expression, not a statement, and is directly
10534 ;; contained by a template delimiter. Most likely, we are in a
10535 ;; template arglist within a statement. This case is based on CASE
10536 ;; 7. At some point in the future, we may wish to create more
10537 ;; syntactic symbols such as `template-intro',
10538 ;; `template-cont-nonempty', etc., and distinguish between them as we
10539 ;; do for `arglist-intro' etc. (2009-12-07).
10540 ((and c-recognize-
<>-arglists
10541 (setq containing-
< (c-up-list-backward indent-point containing-sexp
))
10542 (eq (char-after containing-
<) ?\
<))
10543 (setq placeholder
(c-point 'boi containing-
<))
10544 (goto-char containing-sexp
) ; Most nested Lbrace/Lparen (but not
10545 ; '<') before indent-point.
10546 (if (>= (point) placeholder
)
10549 (skip-chars-forward " \t"))
10550 (goto-char placeholder
))
10551 (c-add-stmt-syntax 'template-args-cont
(list containing-
<) t
10552 (c-most-enclosing-brace c-state-cache
(point))
10555 ;; CASE 17: Statement or defun catchall.
10557 (goto-char indent-point
)
10558 ;; Back up statements until we find one that starts at boi.
10559 (while (let* ((prev-point (point))
10560 (last-step-type (c-beginning-of-statement-1
10562 (if (= (point) prev-point
)
10564 (setq step-type
(or step-type last-step-type
))
10566 (setq step-type last-step-type
)
10567 (/= (point) (c-point 'boi
)))))
10570 ;; CASE 17B: continued statement
10571 ((and (eq step-type
'same
)
10572 (/= (point) indent-point
))
10573 (c-add-stmt-syntax 'statement-cont nil nil
10574 containing-sexp paren-state
))
10576 ;; CASE 17A: After a case/default label?
10578 (while (and (eq step-type
'label
)
10579 (not (looking-at c-label-kwds-regexp
)))
10581 (c-beginning-of-statement-1 containing-sexp
)))
10582 (eq step-type
'label
))
10583 (c-add-stmt-syntax (if (eq char-after-ip ?
{)
10584 'statement-case-open
10585 'statement-case-intro
)
10586 nil t containing-sexp paren-state
))
10588 ;; CASE 17D: any old statement
10590 (while (eq step-type
'label
)
10592 (c-beginning-of-statement-1 containing-sexp
)))
10593 (eq step-type
'previous
))
10594 (c-add-stmt-syntax 'statement nil t
10595 containing-sexp paren-state
)
10596 (if (eq char-after-ip ?
{)
10597 (c-add-syntax 'block-open
)))
10599 ;; CASE 17I: Inside a substatement block.
10601 ;; The following tests are all based on containing-sexp.
10602 (goto-char containing-sexp
)
10603 ;; From here on we have the next containing sexp in lim.
10604 (setq lim
(c-most-enclosing-brace paren-state containing-sexp
))
10605 (c-after-conditional))
10606 (c-backward-to-block-anchor lim
)
10607 (c-add-stmt-syntax 'statement-block-intro nil t
10609 (if (eq char-after-ip ?
{)
10610 (c-add-syntax 'block-open
)))
10612 ;; CASE 17E: first statement in an in-expression block.
10613 ;; C.f. cases 4, 7B and 16A.
10614 ((setq placeholder
(c-looking-at-inexpr-block
10615 (c-safe-position containing-sexp paren-state
)
10617 (setq tmpsymbol
(if (eq (car placeholder
) 'inlambda
)
10619 'statement-block-intro
))
10620 (back-to-indentation)
10621 (if (= containing-sexp
(point))
10622 (c-add-syntax tmpsymbol
(point))
10623 (goto-char (cdr placeholder
))
10624 (back-to-indentation)
10625 (c-add-stmt-syntax tmpsymbol nil t
10626 (c-most-enclosing-brace c-state-cache
(point))
10628 (if (/= (point) (cdr placeholder
))
10629 (c-add-syntax (car placeholder
))))
10630 (if (eq char-after-ip ?
{)
10631 (c-add-syntax 'block-open
)))
10633 ;; CASE 17F: first statement in an inline, or first
10634 ;; statement in a top-level defun. we can tell this is it
10635 ;; if there are no enclosing braces that haven't been
10636 ;; narrowed out by a class (i.e. don't use bod here).
10638 (or (not (setq placeholder
(c-most-enclosing-brace
10641 (goto-char placeholder
)
10642 (eq (char-after) ?
{))
10643 (c-looking-at-decl-block (c-most-enclosing-brace
10644 paren-state
(point))
10646 (c-backward-to-decl-anchor lim
)
10647 (back-to-indentation)
10648 (c-add-syntax 'defun-block-intro
(point)))
10650 ;; CASE 17G: First statement in a function declared inside
10651 ;; a normal block. This can occur in Pike and with
10652 ;; e.g. the gcc extensions, but watch out for macros
10653 ;; followed by blocks. C.f. cases B.3 and 16F.
10655 (and (not (c-at-statement-start-p))
10656 (eq (c-beginning-of-statement-1 lim nil nil t
) 'same
)
10657 (setq placeholder
(point))
10658 (let ((c-recognize-typeless-decls nil
))
10659 ;; Turn off recognition of constructs that lacks
10660 ;; a type in this case, since that's more likely
10661 ;; to be a macro followed by a block.
10662 (c-forward-decl-or-cast-1 (c-point 'bosws
) nil nil
))))
10663 (back-to-indentation)
10664 (if (/= (point) containing-sexp
)
10665 (goto-char placeholder
))
10666 (c-add-stmt-syntax 'defun-block-intro nil t
10669 ;; CASE 17H: First statement in a block.
10671 ;; If the block is preceded by a case/switch label on the
10672 ;; same line, we anchor at the first preceding label at
10673 ;; boi. The default handling in c-add-stmt-syntax is
10674 ;; really fixes it better, but we do like this to keep the
10675 ;; indentation compatible with version 5.28 and earlier.
10677 (while (and (/= (setq placeholder
(point)) (c-point 'boi
))
10678 (eq (c-beginning-of-statement-1 lim
) 'label
)))
10679 (goto-char placeholder
)
10680 (if (looking-at c-label-kwds-regexp
)
10681 (c-add-syntax 'statement-block-intro
(point))
10682 (goto-char containing-sexp
)
10683 ;; c-backward-to-block-anchor not necessary here; those
10684 ;; situations are handled in case 17I above.
10685 (c-add-stmt-syntax 'statement-block-intro nil t
10687 (if (eq char-after-ip ?
{)
10688 (c-add-syntax 'block-open
)))
10692 ;; now we need to look at any modifiers
10693 (goto-char indent-point
)
10694 (skip-chars-forward " \t")
10696 ;; are we looking at a comment only line?
10697 (when (and (looking-at c-comment-start-regexp
)
10698 (/= (c-forward-token-2 0 nil
(c-point 'eol
)) 0))
10699 (c-append-syntax 'comment-intro
))
10701 ;; we might want to give additional offset to friends (in C++).
10702 (when (and c-opt-friend-key
10703 (looking-at c-opt-friend-key
))
10704 (c-append-syntax 'friend
))
10706 ;; Set syntactic-relpos.
10707 (let ((p c-syntactic-context
))
10709 (if (integerp (c-langelem-pos (car p
)))
10711 (setq syntactic-relpos
(c-langelem-pos (car p
)))
10716 ;; Start of or a continuation of a preprocessor directive?
10717 (if (and macro-start
10718 (eq macro-start
(c-point 'boi
))
10719 (not (and (c-major-mode-is 'pike-mode
)
10720 (eq (char-after (1+ macro-start
)) ?
\"))))
10721 (c-append-syntax 'cpp-macro
)
10722 (when (and c-syntactic-indentation-in-macros macro-start
)
10725 (< syntactic-relpos macro-start
)
10727 (assq 'arglist-intro c-syntactic-context
)
10728 (assq 'arglist-cont c-syntactic-context
)
10729 (assq 'arglist-cont-nonempty c-syntactic-context
)
10730 (assq 'arglist-close c-syntactic-context
))))
10731 ;; If inside a cpp expression, i.e. anywhere in a
10732 ;; cpp directive except a #define body, we only let
10733 ;; through the syntactic analysis that is internal
10734 ;; in the expression. That means the arglist
10735 ;; elements, if they are anchored inside the cpp
10737 (setq c-syntactic-context nil
)
10738 (c-add-syntax 'cpp-macro-cont macro-start
))
10739 (when (and (eq macro-start syntactic-relpos
)
10740 (not (assq 'cpp-define-intro c-syntactic-context
))
10742 (goto-char macro-start
)
10743 (or (not (c-forward-to-cpp-define-body))
10744 (<= (point) (c-point 'boi indent-point
)))))
10745 ;; Inside a #define body and the syntactic analysis is
10746 ;; anchored on the start of the #define. In this case
10747 ;; we add cpp-define-intro to get the extra
10748 ;; indentation of the #define body.
10749 (c-add-syntax 'cpp-define-intro
)))))
10751 ;; return the syntax
10752 c-syntactic-context
)))
10755 ;; Indentation calculation.
10757 (defun c-evaluate-offset (offset langelem symbol
)
10758 ;; offset can be a number, a function, a variable, a list, or one of
10759 ;; the symbols + or -
10761 ;; This function might do hidden buffer changes.
10764 ((numberp offset
) offset
)
10765 ((vectorp offset
) offset
)
10766 ((null offset
) nil
)
10768 ((eq offset
'+) c-basic-offset
)
10769 ((eq offset
'-
) (- c-basic-offset
))
10770 ((eq offset
'++) (* 2 c-basic-offset
))
10771 ((eq offset
'--
) (* 2 (- c-basic-offset
)))
10772 ((eq offset
'*) (/ c-basic-offset
2))
10773 ((eq offset
'/) (/ (- c-basic-offset
) 2))
10775 ((functionp offset
)
10778 (cons (c-langelem-sym langelem
)
10779 (c-langelem-pos langelem
)))
10784 ((eq (car offset
) 'quote
)
10785 (c-benign-error "The offset %S for %s was mistakenly quoted"
10789 ((memq (car offset
) '(min max
))
10790 (let (res val
(method (car offset
)))
10791 (setq offset
(cdr offset
))
10793 (setq val
(c-evaluate-offset (car offset
) langelem symbol
))
10801 Error evaluating offset %S for %s: \
10802 Cannot combine absolute offset %S with relative %S in `%s' method"
10803 (car offset
) symbol res val method
)
10804 (setq res
(funcall method res val
))))
10808 Error evaluating offset %S for %s: \
10809 Cannot combine relative offset %S with absolute %S in `%s' method"
10810 (car offset
) symbol res val method
)
10811 (setq res
(vector (funcall method
(aref res
0)
10813 (setq offset
(cdr offset
)))
10816 ((eq (car offset
) 'add
)
10818 (setq offset
(cdr offset
))
10820 (setq val
(c-evaluate-offset (car offset
) langelem symbol
))
10827 (setq res
(vector (+ (aref res
0) val
)))
10828 (setq res
(+ res val
))))
10832 Error evaluating offset %S for %s: \
10833 Cannot combine absolute offsets %S and %S in `add' method"
10834 (car offset
) symbol res val
)
10835 (setq res val
)))) ; Override.
10836 (setq offset
(cdr offset
)))
10841 (when (eq (car offset
) 'first
)
10842 (setq offset
(cdr offset
)))
10843 (while (and (not res
) offset
)
10844 (setq res
(c-evaluate-offset (car offset
) langelem symbol
)
10845 offset
(cdr offset
)))
10848 ((and (symbolp offset
) (boundp offset
))
10849 (symbol-value offset
))
10852 (c-benign-error "Unknown offset format %S for %s" offset symbol
)
10855 (if (or (null res
) (integerp res
)
10856 (and (vectorp res
) (= (length res
) 1) (integerp (aref res
0))))
10858 (c-benign-error "Error evaluating offset %S for %s: Got invalid value %S"
10862 (defun c-calc-offset (langelem)
10863 ;; Get offset from LANGELEM which is a list beginning with the
10864 ;; syntactic symbol and followed by any analysis data it provides.
10865 ;; That data may be zero or more elements, but if at least one is
10866 ;; given then the first is the anchor position (or nil). The symbol
10867 ;; is matched against `c-offsets-alist' and the offset calculated
10868 ;; from that is returned.
10870 ;; This function might do hidden buffer changes.
10871 (let* ((symbol (c-langelem-sym langelem
))
10872 (match (assq symbol c-offsets-alist
))
10873 (offset (cdr-safe match
)))
10875 (setq offset
(c-evaluate-offset offset langelem symbol
))
10876 (if c-strict-syntax-p
10877 (c-benign-error "No offset found for syntactic symbol %s" symbol
))
10879 (if (vectorp offset
)
10881 (or (and (numberp offset
) offset
)
10882 (and (symbolp offset
) (symbol-value offset
))
10886 (defun c-get-offset (langelem)
10887 ;; This is a compatibility wrapper for `c-calc-offset' in case
10888 ;; someone is calling it directly. It takes an old style syntactic
10889 ;; element on the form (SYMBOL . ANCHOR-POS) and converts it to the
10892 ;; This function might do hidden buffer changes.
10893 (if (c-langelem-pos langelem
)
10894 (c-calc-offset (list (c-langelem-sym langelem
)
10895 (c-langelem-pos langelem
)))
10896 (c-calc-offset langelem
)))
10898 (defun c-get-syntactic-indentation (langelems)
10899 ;; Calculate the syntactic indentation from a syntactic description
10900 ;; as returned by `c-guess-syntax'.
10902 ;; Note that topmost-intro always has an anchor position at bol, for
10903 ;; historical reasons. It's often used together with other symbols
10904 ;; that has more sane positions. Since we always use the first
10905 ;; found anchor position, we rely on that these other symbols always
10906 ;; precede topmost-intro in the LANGELEMS list.
10908 ;; This function might do hidden buffer changes.
10909 (let ((indent 0) anchor
)
10912 (let* ((c-syntactic-element (car langelems
))
10913 (res (c-calc-offset c-syntactic-element
)))
10916 ;; Got an absolute column that overrides any indentation
10917 ;; we've collected so far, but not the relative
10918 ;; indentation we might get for the nested structures
10919 ;; further down the langelems list.
10920 (setq indent
(elt res
0)
10921 anchor
(point-min)) ; A position at column 0.
10923 ;; Got a relative change of the current calculated
10925 (setq indent
(+ indent res
))
10927 ;; Use the anchor position from the first syntactic
10928 ;; element with one.
10930 (setq anchor
(c-langelem-pos (car langelems
)))))
10932 (setq langelems
(cdr langelems
))))
10935 (+ indent
(save-excursion
10941 (cc-provide 'cc-engine
)
10943 ;;; cc-engine.el ends here
HCoop / bpt / emacs.git / blob